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-08-17 13:54+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:574 ../src/guestfs-actions.pod:582
932 #: ../src/guestfs-actions.pod:589 ../src/guestfs-actions.pod:596
933 #: ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593
934 #: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601
935 #: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613
936 #: ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627
937 #: ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635
938 #: ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777
939 #: ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787
940 #: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852
941 #: ../src/guestfs-actions.pod:1857 ../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:378
945 #: ../fish/guestfish-actions.pod:386 ../fish/guestfish-actions.pod:393
946 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:1067
947 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
948 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
949 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
950 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
951 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
952 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
953 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
954 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
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"
3103 #: ../src/guestfs.pod:1394
3106 " typedef void (*guestfs_abort_cb) (void);\n"
3107 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
3108 " guestfs_abort_cb);\n"
3114 #: ../src/guestfs.pod:1398
3116 "The callback C<cb> will be called if there is an out of memory situation. "
3117 "I<Note this callback must not return>."
3122 #: ../src/guestfs.pod:1401
3123 msgid "The default is to call L<abort(3)>."
3128 #: ../src/guestfs.pod:1403
3130 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
3135 #: ../src/guestfs.pod:1406
3136 msgid "guestfs_get_out_of_memory_handler"
3141 #: ../src/guestfs.pod:1408
3144 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
3150 #: ../src/guestfs.pod:1410
3151 msgid "This returns the current out of memory handler."
3156 #: ../src/guestfs.pod:1412
3162 #: ../src/guestfs.pod:1414 ../fish/guestfish.pod:969
3168 #: ../src/guestfs.pod:1416
3174 #: ../src/guestfs.pod:1418
3180 #: ../src/guestfs.pod:1420
3181 msgid "AVAILABILITY"
3186 #: ../src/guestfs.pod:1422
3187 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
3192 #: ../src/guestfs.pod:1424
3194 "Using L</guestfs_available> you can test availability of the following "
3195 "groups of functions. This test queries the appliance to see if the "
3196 "appliance you are currently using supports the functionality."
3201 #: ../src/guestfs.pod:1429
3202 msgid "@AVAILABILITY@"
3207 #: ../src/guestfs.pod:1431
3208 msgid "GUESTFISH supported COMMAND"
3213 #: ../src/guestfs.pod:1433
3215 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
3216 "prints out the available groups and whether they are supported by this build "
3217 "of libguestfs. Note however that you have to do C<run> first."
3222 #: ../src/guestfs.pod:1438
3223 msgid "SINGLE CALLS AT COMPILE TIME"
3228 #: ../src/guestfs.pod:1440
3230 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3231 "function, such as:"
3236 #: ../src/guestfs.pod:1443
3239 " #define LIBGUESTFS_HAVE_DD 1\n"
3245 #: ../src/guestfs.pod:1445
3246 msgid "if L</guestfs_dd> is available."
3251 #: ../src/guestfs.pod:1447
3253 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3254 "function is available at compile time, we recommended using build tools such "
3255 "as autoconf or cmake. For example in autotools you could use:"
3260 #: ../src/guestfs.pod:1452
3263 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3264 " AC_CHECK_FUNCS([guestfs_dd])\n"
3270 #: ../src/guestfs.pod:1455
3272 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
3278 #: ../src/guestfs.pod:1458
3279 msgid "SINGLE CALLS AT RUN TIME"
3284 #: ../src/guestfs.pod:1460
3286 "Testing at compile time doesn't guarantee that a function really exists in "
3287 "the library. The reason is that you might be dynamically linked against a "
3288 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3289 "This situation unfortunately results in a segmentation fault, which is a "
3290 "shortcoming of the C dynamic linking system itself."
3295 #: ../src/guestfs.pod:1467
3297 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3298 "in this example program (note that you still need the compile time check as "
3304 #: ../src/guestfs.pod:1471
3307 " #include <stdio.h>\n"
3308 " #include <stdlib.h>\n"
3309 " #include <unistd.h>\n"
3310 " #include <dlfcn.h>\n"
3311 " #include <guestfs.h>\n"
3317 #: ../src/guestfs.pod:1477
3322 " #ifdef LIBGUESTFS_HAVE_DD\n"
3324 " int has_function;\n"
3330 #: ../src/guestfs.pod:1483
3333 " /* Test if the function guestfs_dd is really available. */\n"
3334 " dl = dlopen (NULL, RTLD_LAZY);\n"
3336 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3337 " exit (EXIT_FAILURE);\n"
3339 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3346 #: ../src/guestfs.pod:1492
3349 " if (!has_function)\n"
3350 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3352 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3353 " /* Now it's safe to call\n"
3354 " guestfs_dd (g, \"foo\", \"bar\");\n"
3358 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3366 #: ../src/guestfs.pod:1505
3368 "You may think the above is an awful lot of hassle, and it is. There are "
3369 "other ways outside of the C linking system to ensure that this kind of "
3370 "incompatibility never arises, such as using package versioning:"
3375 #: ../src/guestfs.pod:1510
3378 " Requires: libguestfs >= 1.0.80\n"
3384 #: ../src/guestfs.pod:1512
3385 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3390 #: ../src/guestfs.pod:1514
3392 "A recent feature of the API is the introduction of calls which take optional "
3393 "arguments. In C these are declared 3 ways. The main way is as a call which "
3394 "takes variable arguments (ie. C<...>), as in this example:"
3399 #: ../src/guestfs.pod:1519
3402 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3408 #: ../src/guestfs.pod:1521
3410 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3411 "call with no optional arguments specified:"
3416 #: ../src/guestfs.pod:1524
3419 " guestfs_add_drive_opts (g, filename, -1);\n"
3425 #: ../src/guestfs.pod:1526
3426 msgid "With a single optional argument:"
3431 #: ../src/guestfs.pod:1528
3434 " guestfs_add_drive_opts (g, filename,\n"
3435 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3442 #: ../src/guestfs.pod:1532
3448 #: ../src/guestfs.pod:1534
3451 " guestfs_add_drive_opts (g, filename,\n"
3452 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3453 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3460 #: ../src/guestfs.pod:1539
3462 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3468 #: ../src/guestfs.pod:1542
3469 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3474 #: ../src/guestfs.pod:1544
3476 "The second variant has the same name with the suffix C<_va>, which works the "
3477 "same way but takes a C<va_list>. See the C manual for details. For the "
3478 "example function, this is declared:"
3483 #: ../src/guestfs.pod:1548
3486 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3493 #: ../src/guestfs.pod:1551
3494 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3499 #: ../src/guestfs.pod:1553
3501 "The third variant is useful where you need to construct these calls. You "
3502 "pass in a structure where you fill in the optional fields. The structure "
3503 "has a bitmask as the first element which you must set to indicate which "
3504 "fields you have filled in. For our example function the structure and call "
3510 #: ../src/guestfs.pod:1559
3513 " struct guestfs_add_drive_opts_argv {\n"
3514 " uint64_t bitmask;\n"
3516 " const char *format;\n"
3519 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3520 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3526 #: ../src/guestfs.pod:1568
3527 msgid "You could call it like this:"
3532 #: ../src/guestfs.pod:1570
3535 " struct guestfs_add_drive_opts_argv optargs = {\n"
3536 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3537 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3539 " .format = \"qcow2\"\n"
3546 #: ../src/guestfs.pod:1577
3549 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3555 #: ../src/guestfs.pod:1579 ../src/guestfs-actions.pod:11
3556 #: ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9
3557 #: ../fish/guestfish-actions.pod:1255 ../tools/virt-win-reg.pl:532
3563 #: ../src/guestfs.pod:1585
3564 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3569 #: ../src/guestfs.pod:1590
3570 msgid "You do not need to fill in all fields of the structure."
3575 #: ../src/guestfs.pod:1594
3577 "There must be a one-to-one correspondence between fields of the structure "
3578 "that are filled in, and bits set in the bitmask."
3583 #: ../src/guestfs.pod:1599
3584 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3589 #: ../src/guestfs.pod:1601
3591 "In other languages, optional arguments are expressed in the way that is "
3592 "natural for that language. We refer you to the language-specific "
3593 "documentation for more details on that."
3598 #: ../src/guestfs.pod:1605
3599 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3604 #: ../src/guestfs.pod:1607
3605 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3610 #: ../src/guestfs.pod:1609
3612 "The child process generates events in some situations. Current events "
3613 "include: receiving a log message, the child process exits."
3618 #: ../src/guestfs.pod:1612
3620 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3626 #: ../src/guestfs.pod:1615
3628 "Only I<one callback of each type> can be registered for each handle. "
3629 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3630 "that type. Cancel all callbacks of this type by calling this function with "
3631 "C<cb> set to C<NULL>."
3636 #: ../src/guestfs.pod:1620
3637 msgid "guestfs_set_log_message_callback"
3642 #: ../src/guestfs.pod:1622
3645 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3646 " char *buf, int len);\n"
3647 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3648 " guestfs_log_message_cb cb,\n"
3655 #: ../src/guestfs.pod:1628
3657 "The callback function C<cb> will be called whenever qemu or the guest writes "
3658 "anything to the console."
3663 #: ../src/guestfs.pod:1631
3664 msgid "Use this function to capture kernel messages and similar."
3669 #: ../src/guestfs.pod:1633
3671 "Normally there is no log message handler, and log messages are just "
3677 #: ../src/guestfs.pod:1636
3678 msgid "guestfs_set_subprocess_quit_callback"
3683 #: ../src/guestfs.pod:1638
3686 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3687 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3688 " guestfs_subprocess_quit_cb cb,\n"
3695 #: ../src/guestfs.pod:1643
3697 "The callback function C<cb> will be called when the child process quits, "
3698 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3699 "corresponds to a transition from any state to the CONFIG state)."
3704 #: ../src/guestfs.pod:1648
3705 msgid "guestfs_set_launch_done_callback"
3710 #: ../src/guestfs.pod:1650
3713 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3714 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3715 " guestfs_launch_done_cb cb,\n"
3722 #: ../src/guestfs.pod:1655
3724 "The callback function C<cb> will be called when the child process becomes "
3725 "ready first time after it has been launched. (This corresponds to a "
3726 "transition from LAUNCHING to the READY state)."
3731 #: ../src/guestfs.pod:1659
3732 msgid "guestfs_set_close_callback"
3737 #: ../src/guestfs.pod:1661
3740 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3741 " void guestfs_set_close_callback (guestfs_h *g,\n"
3742 " guestfs_close_cb cb,\n"
3749 #: ../src/guestfs.pod:1666
3751 "The callback function C<cb> will be called while the handle is being closed "
3752 "(synchronously from L</guestfs_close>)."
3757 #: ../src/guestfs.pod:1669
3759 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3760 "handles that are open when the program exits. This means that this callback "
3761 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3762 "problems in higher-level languages (eg. if your HLL interpreter has already "
3763 "been cleaned up by the time this is called, and if your callback then jumps "
3764 "into some HLL function)."
3769 #: ../src/guestfs.pod:1677
3770 msgid "guestfs_set_progress_callback"
3775 #: ../src/guestfs.pod:1679
3778 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3779 " int proc_nr, int serial,\n"
3780 " uint64_t position, uint64_t total);\n"
3781 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3782 " guestfs_progress_cb cb,\n"
3789 #: ../src/guestfs.pod:1686
3791 "Some long-running operations can generate progress messages. If this "
3792 "callback is registered, then it will be called each time a progress message "
3793 "is generated (usually two seconds after the operation started, and three "
3794 "times per second thereafter until it completes, although the frequency may "
3795 "change in future versions)."
3800 #: ../src/guestfs.pod:1692
3802 "The callback receives two numbers: C<position> and C<total>. The units of "
3803 "C<total> are not defined, although for some operations C<total> may relate "
3804 "in some way to the amount of data to be transferred (eg. in bytes or "
3805 "megabytes), and C<position> may be the portion which has been transferred."
3810 #: ../src/guestfs.pod:1698
3811 msgid "The only defined and stable parts of the API are:"
3816 #: ../src/guestfs.pod:1704
3818 "The callback can display to the user some type of progress bar or indicator "
3819 "which shows the ratio of C<position>:C<total>."
3824 #: ../src/guestfs.pod:1709
3825 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3829 #: ../src/guestfs.pod:1713
3831 "If any progress notification is sent during a call, then a final progress "
3832 "notification is always sent when C<position> = C<total> (I<unless> the call "
3833 "fails with an error)."
3838 #: ../src/guestfs.pod:1717
3840 "This is to simplify caller code, so callers can easily set the progress "
3841 "indicator to \"100%\" at the end of the operation, without requiring special "
3842 "code to detect this case."
3847 #: ../src/guestfs.pod:1723
3849 "The callback also receives the procedure number and serial number of the "
3850 "call. These are only useful for debugging protocol issues, and the callback "
3851 "can normally ignore them. The callback may want to print these numbers in "
3852 "error messages or debugging messages."
3857 #: ../src/guestfs.pod:1728
3858 msgid "PRIVATE DATA AREA"
3863 #: ../src/guestfs.pod:1730
3865 "You can attach named pieces of private data to the libguestfs handle, and "
3866 "fetch them by name for the lifetime of the handle. This is called the "
3867 "private data area and is only available from the C API."
3872 #: ../src/guestfs.pod:1734
3873 msgid "To attach a named piece of data, use the following call:"
3878 #: ../src/guestfs.pod:1736
3881 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3887 #: ../src/guestfs.pod:1738
3889 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3890 "pointer (which can be C<NULL>). Any previous item with the same name is "
3896 #: ../src/guestfs.pod:1742
3898 "You can use any C<key> you want, but names beginning with an underscore "
3899 "character are reserved for internal libguestfs purposes (for implementing "
3900 "language bindings). It is recommended to prefix the name with some unique "
3901 "string to avoid collisions with other users."
3906 #: ../src/guestfs.pod:1747
3907 msgid "To retrieve the pointer, use:"
3912 #: ../src/guestfs.pod:1749
3915 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3921 #: ../src/guestfs.pod:1751
3923 "This function returns C<NULL> if either no data is found associated with "
3924 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3930 #: ../src/guestfs.pod:1755
3932 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3933 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3934 "all. In particular, libguestfs does I<not> try to free the data when the "
3935 "handle is closed. If the data must be freed, then the caller must either "
3936 "free it before calling L</guestfs_close> or must set up a close callback to "
3937 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3938 "can be registered for a handle)."
3943 #: ../src/guestfs.pod:1763
3945 "The private data area is implemented using a hash table, and should be "
3946 "reasonably efficient for moderate numbers of keys."
3951 #: ../src/guestfs.pod:1766 ../src/guestfs.pod:1771
3957 #: ../src/guestfs.pod:1768
3959 "<!-- old anchor for the next section --> <a name="
3960 "\"state_machine_and_low_level_event_api\"/>"
3965 #: ../src/guestfs.pod:1773
3966 msgid "ARCHITECTURE"
3971 #: ../src/guestfs.pod:1775
3973 "Internally, libguestfs is implemented by running an appliance (a special "
3974 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3975 "process of the main program."
3980 #: ../src/guestfs.pod:1779
3983 " ___________________\n"
3985 " | main program |\n"
3987 " | | child process / appliance\n"
3988 " | | __________________________\n"
3990 " +-------------------+ RPC | +-----------------+ |\n"
3991 " | libguestfs <--------------------> guestfsd | |\n"
3992 " | | | +-----------------+ |\n"
3993 " \\___________________/ | | Linux kernel | |\n"
3994 " | +--^--------------+ |\n"
3995 " \\_________|________________/\n"
4001 " \\______________/\n"
4007 #: ../src/guestfs.pod:1799
4009 "The library, linked to the main program, creates the child process and hence "
4010 "the appliance in the L</guestfs_launch> function."
4015 #: ../src/guestfs.pod:1802
4017 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4018 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4019 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4020 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
4021 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4022 "attached to the qemu process which translates device access by the "
4023 "appliance's Linux kernel into accesses to the image."
4028 #: ../src/guestfs.pod:1811
4030 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
4031 "Although the disk image you are attached to might also be used by some "
4032 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4033 "care if both libguestfs's qemu process and your virtual machine are trying "
4034 "to update the disk image at the same time, since these usually results in "
4035 "massive disk corruption)."
4040 #: ../src/guestfs.pod:1818
4041 msgid "STATE MACHINE"
4046 #: ../src/guestfs.pod:1820
4047 msgid "libguestfs uses a state machine to model the child process:"
4052 #: ../src/guestfs.pod:1822
4064 " / | \\ \\ guestfs_launch\n"
4065 " / | _\\__V______\n"
4067 " / | | LAUNCHING |\n"
4068 " / | \\___________/\n"
4070 " / | guestfs_launch\n"
4072 " ______ / __|____V\n"
4073 " / \\ ------> / \\\n"
4074 " | BUSY | | READY |\n"
4075 " \\______/ <------ \\________/\n"
4081 #: ../src/guestfs.pod:1844
4083 "The normal transitions are (1) CONFIG (when the handle is created, but there "
4084 "is no child process), (2) LAUNCHING (when the child process is booting up), "
4085 "(3) alternating between READY and BUSY as commands are issued to, and "
4086 "carried out by, the child process."
4091 #: ../src/guestfs.pod:1849
4093 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4094 "asynchronously at any time (eg. due to some internal error), and that causes "
4095 "the state to transition back to CONFIG."
4100 #: ../src/guestfs.pod:1853
4102 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4103 "issued when in the CONFIG state."
4108 #: ../src/guestfs.pod:1856
4110 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4111 "L</guestfs_launch> blocks until the child process is READY to accept "
4112 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4113 "moves the state from CONFIG to LAUNCHING while it is running."
4118 #: ../src/guestfs.pod:1862
4120 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4121 "state. These API calls block waiting for the command to be carried out (ie. "
4122 "the state to transition to BUSY and then back to READY). There are no non-"
4123 "blocking versions, and no way to issue more than one command per handle at "
4129 #: ../src/guestfs.pod:1868
4131 "Finally, the child process sends asynchronous messages back to the main "
4132 "program, such as kernel log messages. You can register a callback to "
4133 "receive these messages."
4138 #: ../src/guestfs.pod:1872
4144 #: ../src/guestfs.pod:1874
4145 msgid "COMMUNICATION PROTOCOL"
4150 #: ../src/guestfs.pod:1876
4152 "Don't rely on using this protocol directly. This section documents how it "
4153 "currently works, but it may change at any time."
4158 #: ../src/guestfs.pod:1879
4160 "The protocol used to talk between the library and the daemon running inside "
4161 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4162 "1014, RFC 1832, RFC 4506)."
4167 #: ../src/guestfs.pod:1883
4169 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4170 "this file is automatically generated)."
4175 #: ../src/guestfs.pod:1886
4177 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4178 "and C<FileOut> parameters, which are handled with very simple request/reply "
4179 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4180 "parameters, which use the same request and reply messages, but they may also "
4181 "be followed by files sent using a chunked encoding."
4186 #: ../src/guestfs.pod:1893
4187 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4192 #: ../src/guestfs.pod:1895
4193 msgid "For ordinary functions, the request message is:"
4198 #: ../src/guestfs.pod:1897
4201 " total length (header + arguments,\n"
4202 " but not including the length word itself)\n"
4203 " struct guestfs_message_header (encoded as XDR)\n"
4204 " struct guestfs_<foo>_args (encoded as XDR)\n"
4210 #: ../src/guestfs.pod:1902
4212 "The total length field allows the daemon to allocate a fixed size buffer "
4213 "into which it slurps the rest of the message. As a result, the total length "
4214 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
4215 "effective size of any request is limited to somewhere under this size."
4220 #: ../src/guestfs.pod:1908
4222 "Note also that many functions don't take any arguments, in which case the "
4223 "C<guestfs_I<foo>_args> is completely omitted."
4228 #: ../src/guestfs.pod:1911
4230 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4231 "receiver knows what type of args structure to expect, or none at all."
4236 #: ../src/guestfs.pod:1915
4238 "For functions that take optional arguments, the optional arguments are "
4239 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4240 "arguments. A bitmask in the header indicates which optional arguments are "
4241 "meaningful. The bitmask is also checked to see if it contains bits set "
4242 "which the daemon does not know about (eg. if more optional arguments were "
4243 "added in a later version of the library), and this causes the call to be "
4249 #: ../src/guestfs.pod:1923
4250 msgid "The reply message for ordinary functions is:"
4255 #: ../src/guestfs.pod:1925
4258 " total length (header + ret,\n"
4259 " but not including the length word itself)\n"
4260 " struct guestfs_message_header (encoded as XDR)\n"
4261 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4267 #: ../src/guestfs.pod:1930
4269 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4270 "functions that return no formal return values."
4275 #: ../src/guestfs.pod:1933
4277 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4282 #: ../src/guestfs.pod:1936
4284 "In the case of an error, a flag is set in the header, and the reply message "
4285 "is slightly changed:"
4290 #: ../src/guestfs.pod:1939
4293 " total length (header + error,\n"
4294 " but not including the length word itself)\n"
4295 " struct guestfs_message_header (encoded as XDR)\n"
4296 " struct guestfs_message_error (encoded as XDR)\n"
4302 #: ../src/guestfs.pod:1944
4304 "The C<guestfs_message_error> structure contains the error message as a "
4310 #: ../src/guestfs.pod:1947
4311 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4316 #: ../src/guestfs.pod:1949
4318 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4319 "The normal request message is sent (see above). However this is followed by "
4320 "a sequence of file chunks."
4325 #: ../src/guestfs.pod:1953
4328 " total length (header + arguments,\n"
4329 " but not including the length word itself,\n"
4330 " and not including the chunks)\n"
4331 " struct guestfs_message_header (encoded as XDR)\n"
4332 " struct guestfs_<foo>_args (encoded as XDR)\n"
4333 " sequence of chunks for FileIn param #0\n"
4334 " sequence of chunks for FileIn param #1 etc.\n"
4340 #: ../src/guestfs.pod:1961
4341 msgid "The \"sequence of chunks\" is:"
4346 #: ../src/guestfs.pod:1963
4349 " length of chunk (not including length word itself)\n"
4350 " struct guestfs_chunk (encoded as XDR)\n"
4351 " length of chunk\n"
4352 " struct guestfs_chunk (encoded as XDR)\n"
4354 " length of chunk\n"
4355 " struct guestfs_chunk (with data.data_len == 0)\n"
4361 #: ../src/guestfs.pod:1971
4363 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4364 "is set in the final chunk to indicate either successful completion or early "
4370 #: ../src/guestfs.pod:1975
4372 "At time of writing there are no functions that have more than one FileIn "
4373 "parameter. However this is (theoretically) supported, by sending the "
4374 "sequence of chunks for each FileIn parameter one after another (from left to "
4380 #: ../src/guestfs.pod:1980
4382 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4383 "transfer. The library does this by sending a chunk with a special flag set "
4384 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4385 "RPC, does I<not> send any reply, and goes back to reading the next request."
4390 #: ../src/guestfs.pod:1986
4392 "The daemon may also cancel. It does this by writing a special word "
4393 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4394 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4395 "cancel chunk). The special word is chosen so that even if cancellation "
4396 "happens right at the end of the transfer (after the library has finished "
4397 "writing and has started listening for the reply), the \"spurious\" cancel "
4398 "flag will not be confused with the reply message."
4403 #: ../src/guestfs.pod:1995
4405 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4406 "limit), and also files where the size is not known in advance (eg. from "
4407 "pipes or sockets). However the chunks are rather small "
4408 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
4409 "to keep much in memory."
4414 #: ../src/guestfs.pod:2001
4415 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4420 #: ../src/guestfs.pod:2003
4422 "The protocol for FileOut parameters is exactly the same as for FileIn "
4423 "parameters, but with the roles of daemon and library reversed."
4428 #: ../src/guestfs.pod:2006
4431 " total length (header + ret,\n"
4432 " but not including the length word itself,\n"
4433 " and not including the chunks)\n"
4434 " struct guestfs_message_header (encoded as XDR)\n"
4435 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4436 " sequence of chunks for FileOut param #0\n"
4437 " sequence of chunks for FileOut param #1 etc.\n"
4443 #: ../src/guestfs.pod:2014
4444 msgid "INITIAL MESSAGE"
4449 #: ../src/guestfs.pod:2016
4451 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4452 "which indicates that the guest and daemon is alive. This is what L</"
4453 "guestfs_launch> waits for."
4458 #: ../src/guestfs.pod:2020
4459 msgid "PROGRESS NOTIFICATION MESSAGES"
4464 #: ../src/guestfs.pod:2022
4466 "The daemon may send progress notification messages at any time. These are "
4467 "distinguished by the normal length word being replaced by "
4468 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4473 #: ../src/guestfs.pod:2026
4475 "The library turns them into progress callbacks (see "
4476 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
4477 "discards them if not."
4482 #: ../src/guestfs.pod:2030
4484 "The daemon self-limits the frequency of progress messages it sends (see "
4485 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4491 #: ../src/guestfs.pod:2034
4492 msgid "LIBGUESTFS VERSION NUMBERS"
4497 #: ../src/guestfs.pod:2036
4499 "Since April 2010, libguestfs has started to make separate development and "
4500 "stable releases, along with corresponding branches in our git repository. "
4501 "These separate releases can be identified by version number:"
4506 #: ../src/guestfs.pod:2041
4509 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4510 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4516 " | `-------- sub-version\n"
4518 " `------ always '1' because we don't change the ABI\n"
4524 #: ../src/guestfs.pod:2052
4525 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4530 #: ../src/guestfs.pod:2054
4532 "As time passes we cherry pick fixes from the development branch and backport "
4533 "those into the stable branch, the effect being that the stable branch should "
4534 "get more stable and less buggy over time. So the stable releases are ideal "
4535 "for people who don't need new features but would just like the software to "
4541 #: ../src/guestfs.pod:2060
4542 msgid "Our criteria for backporting changes are:"
4547 #: ../src/guestfs.pod:2066
4549 "Documentation changes which don't affect any code are backported unless the "
4550 "documentation refers to a future feature which is not in stable."
4555 #: ../src/guestfs.pod:2072
4557 "Bug fixes which are not controversial, fix obvious problems, and have been "
4558 "well tested are backported."
4563 #: ../src/guestfs.pod:2077
4565 "Simple rearrangements of code which shouldn't affect how it works get "
4566 "backported. This is so that the code in the two branches doesn't get too "
4567 "far out of step, allowing us to backport future fixes more easily."
4572 #: ../src/guestfs.pod:2083
4574 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4575 "exceptional case: the new feature is required in order to implement an "
4576 "important bug fix."
4581 #: ../src/guestfs.pod:2089
4583 "A new stable branch starts when we think the new features in development are "
4584 "substantial and compelling enough over the current stable branch to warrant "
4585 "it. When that happens we create new stable and development versions 1.N.0 "
4586 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4587 "stable at this point, but by backporting fixes from development, that branch "
4588 "will stabilize over time."
4592 #: ../src/guestfs.pod:2097
4593 msgid "EXTENDING LIBGUESTFS"
4597 #: ../src/guestfs.pod:2099
4598 msgid "ADDING A NEW API ACTION"
4602 #: ../src/guestfs.pod:2101
4604 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4605 "documentation) are generated, and this makes it easy to extend the "
4610 #: ../src/guestfs.pod:2105
4611 msgid "To add a new API action there are two changes:"
4615 #: ../src/guestfs.pod:2111
4617 "You need to add a description of the call (name, parameters, return type, "
4618 "tests, documentation) to C<generator/generator_actions.ml>."
4622 #: ../src/guestfs.pod:2114
4624 "There are two sorts of API action, depending on whether the call goes "
4625 "through to the daemon in the appliance, or is serviced entirely by the "
4626 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
4627 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4628 "an example of the latter, since a trace flag is maintained in the handle and "
4629 "all tracing is done on the library side."
4633 #: ../src/guestfs.pod:2122
4635 "Most new actions are of the first type, and get added to the "
4636 "C<daemon_functions> list. Each function has a unique procedure number used "
4637 "in the RPC protocol which is assigned to that action when we publish "
4638 "libguestfs and cannot be reused. Take the latest procedure number and "
4643 #: ../src/guestfs.pod:2128
4645 "For library-only actions of the second type, add to the "
4646 "C<non_daemon_functions> list. Since these functions are serviced by the "
4647 "library and do not travel over the RPC mechanism to the daemon, these "
4648 "functions do not need a procedure number, and so the procedure number is set "
4653 #: ../src/guestfs.pod:2136
4654 msgid "Implement the action (in C):"
4658 #: ../src/guestfs.pod:2138
4660 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4661 "C<daemon/> directory."
4665 #: ../src/guestfs.pod:2141
4667 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4668 "(note: double underscore) in the C<src/> directory."
4672 #: ../src/guestfs.pod:2144
4673 msgid "In either case, use another function as an example of what to do."
4677 #: ../src/guestfs.pod:2148
4678 msgid "After making these changes, use C<make> to compile."
4682 #: ../src/guestfs.pod:2150
4684 "Note that you don't need to implement the RPC, language bindings, manual "
4685 "pages or anything else. It's all automatically generated from the OCaml "
4690 #: ../src/guestfs.pod:2154
4691 msgid "ADDING TESTS FOR AN API ACTION"
4695 #: ../src/guestfs.pod:2156
4697 "You can supply zero or as many tests as you want per API call. The tests "
4698 "can either be added as part of the API description (C<generator/"
4699 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
4700 "into C<regressions/>. Note that adding a script to C<regressions/> is "
4701 "slower, so if possible use the first method."
4705 #: ../src/guestfs.pod:2162
4707 "The following describes the test environment used when you add an API test "
4708 "in C<generator_actions.ml>."
4712 #: ../src/guestfs.pod:2165
4713 msgid "The test environment has 4 block devices:"
4717 #: ../src/guestfs.pod:2169
4718 msgid "C</dev/sda> 500MB"
4722 #: ../src/guestfs.pod:2171
4723 msgid "General block device for testing."
4727 #: ../src/guestfs.pod:2173
4728 msgid "C</dev/sdb> 50MB"
4732 #: ../src/guestfs.pod:2175
4734 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4739 #: ../src/guestfs.pod:2178
4740 msgid "C</dev/sdc> 10MB"
4744 #: ../src/guestfs.pod:2180
4745 msgid "Used in a few tests where two block devices are needed."
4749 #: ../src/guestfs.pod:2182
4754 #: ../src/guestfs.pod:2184
4755 msgid "ISO with fixed content (see C<images/test.iso>)."
4759 #: ../src/guestfs.pod:2188
4761 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4762 "appliance and block devices are reused between tests. So don't try testing "
4763 "L</guestfs_kill_subprocess> :-x"
4767 #: ../src/guestfs.pod:2192
4769 "Each test starts with an initial scenario, selected using one of the "
4770 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4771 "initialize the disks mentioned above in a particular way as documented in "
4772 "C<generator_types.ml>. You should not assume anything about the previous "
4773 "contents of other disks that are not initialized."
4777 #: ../src/guestfs.pod:2198
4779 "You can add a prerequisite clause to any individual test. This is a run-"
4780 "time check, which, if it fails, causes the test to be skipped. Useful if "
4781 "testing a command which might not work on all variations of libguestfs "
4782 "builds. A test that has prerequisite of C<Always> means to run "
4787 #: ../src/guestfs.pod:2204
4789 "In addition, packagers can skip individual tests by setting environment "
4790 "variables before running C<make check>."
4794 #: ../src/guestfs.pod:2207
4797 " SKIP_TEST_<CMD>_<NUM>=1\n"
4802 #: ../src/guestfs.pod:2209
4803 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4807 #: ../src/guestfs.pod:2211
4812 #: ../src/guestfs.pod:2213
4815 " SKIP_TEST_<CMD>=1\n"
4820 #: ../src/guestfs.pod:2215
4821 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4825 #: ../src/guestfs.pod:2217
4826 msgid "Packagers can run only certain tests by setting for example:"
4830 #: ../src/guestfs.pod:2219
4833 " TEST_ONLY=\"vfs_type zerofree\"\n"
4838 #: ../src/guestfs.pod:2221
4840 "See C<capitests/tests.c> for more details of how these environment variables "
4845 #: ../src/guestfs.pod:2224
4846 msgid "DEBUGGING NEW API ACTIONS"
4850 #: ../src/guestfs.pod:2226
4851 msgid "Test new actions work before submitting them."
4855 #: ../src/guestfs.pod:2228
4856 msgid "You can use guestfish to try out new commands."
4860 #: ../src/guestfs.pod:2230
4862 "Debugging the daemon is a problem because it runs inside a minimal "
4863 "environment. However you can fprintf messages in the daemon to stderr, and "
4864 "they will show up if you use C<guestfish -v>."
4868 #: ../src/guestfs.pod:2234
4869 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
4873 #: ../src/guestfs.pod:2236
4875 "Our C source code generally adheres to some basic code-formatting "
4876 "conventions. The existing code base is not totally consistent on this "
4877 "front, but we do prefer that contributed code be formatted similarly. In "
4878 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
4879 "indentation level, and other than that, follow the K&R style."
4883 #: ../src/guestfs.pod:2242
4885 "If you use Emacs, add the following to one of one of your start-up files (e."
4886 "g., ~/.emacs), to help ensure that you get indentation right:"
4890 #: ../src/guestfs.pod:2245
4893 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
4894 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
4895 " (add-hook 'find-file-hook\n"
4896 " '(lambda () (if (and buffer-file-name\n"
4897 " (string-match \"/libguestfs\\\\>\"\n"
4898 " (buffer-file-name))\n"
4899 " (not (string-equal mode-name \"Change Log\"))\n"
4900 " (not (string-equal mode-name \"Makefile\")))\n"
4901 " (setq indent-tabs-mode nil))))\n"
4906 #: ../src/guestfs.pod:2255
4909 " ;;; When editing C sources in libguestfs, use this style.\n"
4910 " (defun libguestfs-c-mode ()\n"
4911 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
4913 " (c-set-style \"K&R\")\n"
4914 " (setq c-indent-level 2)\n"
4915 " (setq c-basic-offset 2))\n"
4916 " (add-hook 'c-mode-hook\n"
4917 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
4918 " (buffer-file-name))\n"
4919 " (libguestfs-c-mode))))\n"
4924 #: ../src/guestfs.pod:2267
4925 msgid "Enable warnings when compiling (and fix any problems this finds):"
4929 #: ../src/guestfs.pod:2270
4932 " ./configure --enable-gcc-warnings\n"
4937 #: ../src/guestfs.pod:2272
4938 msgid "Useful targets are:"
4942 #: ../src/guestfs.pod:2274
4945 " make syntax-check # checks the syntax of the C code\n"
4946 " make check # runs the test suite\n"
4951 #: ../src/guestfs.pod:2277
4952 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
4956 #: ../src/guestfs.pod:2279
4958 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
4959 "which are used to do shell quoting."
4963 #: ../src/guestfs.pod:2284
4968 #: ../src/guestfs.pod:2286
4970 "Simple shell quoted string. Any spaces or other shell characters are "
4975 #: ../src/guestfs.pod:2289
4980 #: ../src/guestfs.pod:2291
4982 "Same as C<%Q> except the string is treated as a path which is prefixed by "
4988 #: ../src/guestfs.pod:2296 ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
4989 msgid "For example:"
4993 #: ../src/guestfs.pod:2298
4996 " asprintf (&cmd, \"cat %R\", path);\n"
5001 #: ../src/guestfs.pod:2300
5002 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5006 #: ../src/guestfs.pod:2302
5008 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
5009 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
5010 "they are not passed via the shell (instead, straight to exec). You probably "
5011 "want to use the C<sysroot_path()> function however."
5015 #: ../src/guestfs.pod:2308
5016 msgid "SUBMITTING YOUR NEW API ACTIONS"
5020 #: ../src/guestfs.pod:2310
5022 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
5023 "libguestfs> and CC to L<rjones@redhat.com>."
5027 #: ../src/guestfs.pod:2314
5028 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5032 #: ../src/guestfs.pod:2316
5033 msgid "We support i18n (gettext anyhow) in the library."
5037 #: ../src/guestfs.pod:2318
5039 "However many messages come from the daemon, and we don't translate those at "
5040 "the moment. One reason is that the appliance generally has all locale files "
5041 "removed from it, because they take up a lot of space. So we'd have to readd "
5042 "some of those, as well as copying our PO files into the appliance."
5046 #: ../src/guestfs.pod:2324
5048 "Debugging messages are never translated, since they are intended for the "
5053 #: ../src/guestfs.pod:2327
5054 msgid "SOURCE CODE SUBDIRECTORIES"
5058 #: ../src/guestfs.pod:2331
5059 msgid "C<appliance>"
5063 #: ../src/guestfs.pod:2333
5064 msgid "The libguestfs appliance, build scripts and so on."
5068 #: ../src/guestfs.pod:2335
5069 msgid "C<capitests>"
5073 #: ../src/guestfs.pod:2337
5074 msgid "Automated tests of the C API."
5078 #: ../src/guestfs.pod:2339
5083 #: ../src/guestfs.pod:2341
5085 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5090 #: ../src/guestfs.pod:2344
5095 #: ../src/guestfs.pod:2346
5097 "Safety and liveness tests of components that libguestfs depends upon (not of "
5098 "libguestfs itself). Mainly this is for qemu and the kernel."
5102 #: ../src/guestfs.pod:2349
5107 #: ../src/guestfs.pod:2351
5108 msgid "Outside contributions, experimental parts."
5112 #: ../src/guestfs.pod:2353
5117 #: ../src/guestfs.pod:2355
5119 "The daemon that runs inside the libguestfs appliance and carries out actions."
5123 #: ../src/guestfs.pod:2358
5128 #: ../src/guestfs.pod:2360
5129 msgid "L<virt-df(1)> command and documentation."
5133 #: ../src/guestfs.pod:2362
5138 #: ../src/guestfs.pod:2364
5139 msgid "C API example code."
5143 #: ../src/guestfs.pod:2366
5148 #: ../src/guestfs.pod:2368
5149 msgid "L<guestfish(1)>, the command-line shell."
5153 #: ../src/guestfs.pod:2370
5158 #: ../src/guestfs.pod:2372
5160 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5164 #: ../src/guestfs.pod:2374
5165 msgid "C<generator>"
5169 #: ../src/guestfs.pod:2376
5171 "The crucially important generator, used to automatically generate large "
5172 "amounts of boilerplate C code for things like RPC and bindings."
5176 #: ../src/guestfs.pod:2379
5181 #: ../src/guestfs.pod:2381
5182 msgid "Files used by the test suite."
5186 #: ../src/guestfs.pod:2383
5187 msgid "Some \"phony\" guest images which we test against."
5191 #: ../src/guestfs.pod:2385
5192 msgid "C<inspector>"
5196 #: ../src/guestfs.pod:2387
5197 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5201 #: ../src/guestfs.pod:2389
5206 #: ../src/guestfs.pod:2391
5207 msgid "M4 macros used by autoconf."
5211 #: ../src/guestfs.pod:2393
5216 #: ../src/guestfs.pod:2395
5217 msgid "Translations of simple gettext strings."
5221 #: ../src/guestfs.pod:2397
5226 #: ../src/guestfs.pod:2399
5228 "The build infrastructure and PO files for translations of manpages and POD "
5229 "files. Eventually this will be combined with the C<po> directory, but that "
5230 "is rather complicated."
5234 #: ../src/guestfs.pod:2403
5235 msgid "C<regressions>"
5239 #: ../src/guestfs.pod:2405
5240 msgid "Regression tests."
5244 #: ../src/guestfs.pod:2407
5249 #: ../src/guestfs.pod:2409
5250 msgid "L<virt-rescue(1)> command and documentation."
5254 #: ../src/guestfs.pod:2411
5259 #: ../src/guestfs.pod:2413
5260 msgid "Source code to the C library."
5264 #: ../src/guestfs.pod:2415
5269 #: ../src/guestfs.pod:2417
5270 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5274 #: ../src/guestfs.pod:2419
5275 msgid "C<test-tool>"
5279 #: ../src/guestfs.pod:2421
5281 "Test tool for end users to test if their qemu/kernel combination will work "
5286 #: ../src/guestfs.pod:2424
5291 #: ../src/guestfs.pod:2426
5296 #: ../src/guestfs.pod:2428
5301 #: ../src/guestfs.pod:2430
5306 #: ../src/guestfs.pod:2432
5311 #: ../src/guestfs.pod:2434
5316 #: ../src/guestfs.pod:2436
5321 #: ../src/guestfs.pod:2438
5326 #: ../src/guestfs.pod:2440
5327 msgid "Language bindings."
5332 #: ../src/guestfs.pod:2444 ../fish/guestfish.pod:976
5333 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:375
5334 msgid "ENVIRONMENT VARIABLES"
5339 #: ../src/guestfs.pod:2448 ../fish/guestfish.pod:1002
5340 msgid "LIBGUESTFS_APPEND"
5345 #: ../src/guestfs.pod:2450 ../fish/guestfish.pod:1004
5346 msgid "Pass additional options to the guest kernel."
5351 #: ../src/guestfs.pod:2452 ../fish/guestfish.pod:1006
5352 msgid "LIBGUESTFS_DEBUG"
5357 #: ../src/guestfs.pod:2454
5359 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5360 "effect as calling C<guestfs_set_verbose (g, 1)>."
5365 #: ../src/guestfs.pod:2457 ../fish/guestfish.pod:1011
5366 msgid "LIBGUESTFS_MEMSIZE"
5371 #: ../src/guestfs.pod:2459 ../fish/guestfish.pod:1013
5373 "Set the memory allocated to the qemu process, in megabytes. For example:"
5378 #: ../src/guestfs.pod:2462 ../fish/guestfish.pod:1016
5381 " LIBGUESTFS_MEMSIZE=700\n"
5387 #: ../src/guestfs.pod:2464 ../fish/guestfish.pod:1018
5388 msgid "LIBGUESTFS_PATH"
5392 #: ../src/guestfs.pod:2466
5394 "Set the path that libguestfs uses to search for a supermin appliance. See "
5395 "the discussion of paths in section L</PATH> above."
5400 #: ../src/guestfs.pod:2469 ../fish/guestfish.pod:1023
5401 msgid "LIBGUESTFS_QEMU"
5406 #: ../src/guestfs.pod:2471 ../fish/guestfish.pod:1025
5408 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
5409 "which was found at compile time by the configure script is used."
5414 #: ../src/guestfs.pod:2475
5415 msgid "See also L</QEMU WRAPPERS> above."
5420 #: ../src/guestfs.pod:2477 ../fish/guestfish.pod:1029
5421 msgid "LIBGUESTFS_TRACE"
5426 #: ../src/guestfs.pod:2479
5428 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5429 "effect as calling C<guestfs_set_trace (g, 1)>."
5434 #: ../src/guestfs.pod:2482 ../fish/guestfish.pod:1038
5440 #: ../src/guestfs.pod:2484 ../fish/guestfish.pod:1040
5441 msgid "Location of temporary directory, defaults to C</tmp>."
5446 #: ../src/guestfs.pod:2486 ../fish/guestfish.pod:1042
5448 "If libguestfs was compiled to use the supermin appliance then the real "
5449 "appliance is cached in this directory, shared between all handles belonging "
5450 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5451 "use in case C</tmp> is not large enough."
5456 #: ../src/guestfs.pod:2494 ../fish/guestfish.pod:1100
5457 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
5458 #: ../tools/virt-edit.pl:395 ../tools/virt-win-reg.pl:572
5459 #: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189
5460 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:539
5461 #: ../tools/virt-list-partitions.pl:257
5467 #: ../src/guestfs.pod:2496
5469 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
5470 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
5471 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
5472 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
5473 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
5474 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
5479 #: ../src/guestfs.pod:2519
5481 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
5482 "(8)>, L<disktype(1)>."
5487 #: ../src/guestfs.pod:2526 ../tools/virt-win-reg.pl:587
5488 #: ../tools/virt-make-fs.pl:553
5494 #: ../src/guestfs.pod:2528
5495 msgid "To get a list of bugs against libguestfs use this link:"
5500 #: ../src/guestfs.pod:2530
5502 "L<https://bugzilla.redhat.com/buglist.cgi?"
5503 "component=libguestfs&product=Virtualization+Tools>"
5508 #: ../src/guestfs.pod:2532
5509 msgid "To report a new bug against libguestfs use this link:"
5514 #: ../src/guestfs.pod:2534
5516 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
5517 "component=libguestfs&product=Virtualization+Tools>"
5522 #: ../src/guestfs.pod:2536
5523 msgid "When reporting a bug, please check:"
5528 #: ../src/guestfs.pod:2542
5529 msgid "That the bug hasn't been reported already."
5534 #: ../src/guestfs.pod:2546
5535 msgid "That you are testing a recent version."
5540 #: ../src/guestfs.pod:2550
5541 msgid "Describe the bug accurately, and give a way to reproduce it."
5546 #: ../src/guestfs.pod:2554
5548 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
5554 #: ../src/guestfs.pod:2559 ../fish/guestfish.pod:1119
5555 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
5561 #: ../src/guestfs.pod:2561 ../fish/guestfish.pod:1121
5562 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
5563 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5568 #: ../src/guestfs.pod:2563 ../fish/guestfish.pod:1123
5569 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
5570 #: ../tools/virt-edit.pl:411 ../tools/virt-win-reg.pl:602
5571 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206
5572 #: ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:568
5573 #: ../tools/virt-list-partitions.pl:273
5579 #: ../src/guestfs.pod:2565 ../fish/guestfish.pod:1125
5580 #: ../fuse/guestmount.pod:250
5581 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
5586 #: ../src/guestfs.pod:2568
5588 "This library is free software; you can redistribute it and/or modify it "
5589 "under the terms of the GNU Lesser General Public License as published by the "
5590 "Free Software Foundation; either version 2 of the License, or (at your "
5591 "option) any later version."
5596 #: ../src/guestfs.pod:2573
5598 "This library is distributed in the hope that it will be useful, but WITHOUT "
5599 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5600 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
5606 #: ../src/guestfs.pod:2578
5608 "You should have received a copy of the GNU Lesser General Public License "
5609 "along with this library; if not, write to the Free Software Foundation, "
5610 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5615 #: ../src/guestfs-actions.pod:1
5616 msgid "guestfs_add_cdrom"
5621 #: ../src/guestfs-actions.pod:3
5625 " guestfs_add_cdrom (guestfs_h *g,\n"
5626 " const char *filename);\n"
5632 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5633 msgid "This function adds a virtual CD-ROM disk image to the guest."
5638 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5639 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
5644 #: ../src/guestfs-actions.pod:17
5646 "This call checks for the existence of C<filename>. This stops you from "
5647 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5648 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
5654 #: ../src/guestfs-actions.pod:24
5656 "If you just want to add an ISO file (often you use this as an efficient way "
5657 "to transfer large files into the guest), then you should probably use "
5658 "C<guestfs_add_drive_ro> instead."
5663 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
5664 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
5665 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
5666 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
5667 #: ../src/guestfs-actions.pod:413 ../src/guestfs-actions.pod:433
5668 #: ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:492
5669 #: ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:538
5670 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:638
5671 #: ../src/guestfs-actions.pod:652 ../src/guestfs-actions.pod:667
5672 #: ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:784
5673 #: ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:812
5674 #: ../src/guestfs-actions.pod:973 ../src/guestfs-actions.pod:993
5675 #: ../src/guestfs-actions.pod:1011 ../src/guestfs-actions.pod:1095
5676 #: ../src/guestfs-actions.pod:1113 ../src/guestfs-actions.pod:1132
5677 #: ../src/guestfs-actions.pod:1146 ../src/guestfs-actions.pod:1166
5678 #: ../src/guestfs-actions.pod:1236 ../src/guestfs-actions.pod:1267
5679 #: ../src/guestfs-actions.pod:1292 ../src/guestfs-actions.pod:1329
5680 #: ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1469
5681 #: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706
5682 #: ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2245
5683 #: ../src/guestfs-actions.pod:2389 ../src/guestfs-actions.pod:2450
5684 #: ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:3228
5685 #: ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:3263
5686 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3432
5687 #: ../src/guestfs-actions.pod:3445 ../src/guestfs-actions.pod:3459
5688 #: ../src/guestfs-actions.pod:3474 ../src/guestfs-actions.pod:3510
5689 #: ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:3602
5690 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3642
5691 #: ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:3697
5692 #: ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:3735
5693 #: ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3782
5694 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3834
5695 #: ../src/guestfs-actions.pod:3847 ../src/guestfs-actions.pod:3862
5696 #: ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3972
5697 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4005
5698 #: ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4074
5699 #: ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4108
5700 #: ../src/guestfs-actions.pod:4122 ../src/guestfs-actions.pod:4136
5701 #: ../src/guestfs-actions.pod:4153 ../src/guestfs-actions.pod:4168
5702 #: ../src/guestfs-actions.pod:4188 ../src/guestfs-actions.pod:4234
5703 #: ../src/guestfs-actions.pod:4307 ../src/guestfs-actions.pod:4338
5704 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4376
5705 #: ../src/guestfs-actions.pod:4388 ../src/guestfs-actions.pod:4405
5706 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:4433
5707 #: ../src/guestfs-actions.pod:4448 ../src/guestfs-actions.pod:4483
5708 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4518
5709 #: ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4549
5710 #: ../src/guestfs-actions.pod:4598 ../src/guestfs-actions.pod:4644
5711 #: ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4686
5712 #: ../src/guestfs-actions.pod:4703 ../src/guestfs-actions.pod:4721
5713 #: ../src/guestfs-actions.pod:4855 ../src/guestfs-actions.pod:4912
5714 #: ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4952
5715 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5050
5716 #: ../src/guestfs-actions.pod:5067 ../src/guestfs-actions.pod:5080
5717 #: ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5383
5718 #: ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5416
5719 #: ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5442
5720 #: ../src/guestfs-actions.pod:5454 ../src/guestfs-actions.pod:5468
5721 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5505
5722 #: ../src/guestfs-actions.pod:5524 ../src/guestfs-actions.pod:5543
5723 #: ../src/guestfs-actions.pod:5561 ../src/guestfs-actions.pod:5584
5724 #: ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5621
5725 #: ../src/guestfs-actions.pod:5642 ../src/guestfs-actions.pod:5661
5726 #: ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:5706
5727 #: ../src/guestfs-actions.pod:5730 ../src/guestfs-actions.pod:5749
5728 #: ../src/guestfs-actions.pod:5773 ../src/guestfs-actions.pod:5788
5729 #: ../src/guestfs-actions.pod:5803 ../src/guestfs-actions.pod:5822
5730 #: ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:5882
5731 #: ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:6016
5732 #: ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6149
5733 #: ../src/guestfs-actions.pod:6162 ../src/guestfs-actions.pod:6175
5734 #: ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6210
5735 #: ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6236
5736 #: ../src/guestfs-actions.pod:6251 ../src/guestfs-actions.pod:6310
5737 #: ../src/guestfs-actions.pod:6327 ../src/guestfs-actions.pod:6343
5738 #: ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6376
5739 #: ../src/guestfs-actions.pod:6389 ../src/guestfs-actions.pod:6409
5740 #: ../src/guestfs-actions.pod:6445 ../src/guestfs-actions.pod:6459
5741 #: ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:6513
5742 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6565
5743 #: ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6720
5744 #: ../src/guestfs-actions.pod:6738 ../src/guestfs-actions.pod:6752
5745 #: ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6820
5746 #: ../src/guestfs-actions.pod:6865 ../src/guestfs-actions.pod:6898
5747 #: ../src/guestfs-actions.pod:6952 ../src/guestfs-actions.pod:6978
5748 #: ../src/guestfs-actions.pod:7044 ../src/guestfs-actions.pod:7063
5749 #: ../src/guestfs-actions.pod:7092
5750 msgid "This function returns 0 on success or -1 on error."
5754 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
5755 #: ../src/guestfs-actions.pod:261
5757 "This function is deprecated. In new code, use the L</"
5758 "guestfs_add_drive_opts> call instead."
5763 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
5764 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1440
5765 #: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944
5766 #: ../src/guestfs-actions.pod:4193 ../src/guestfs-actions.pod:6986
5767 #: ../src/guestfs-actions.pod:7155 ../fish/guestfish-actions.pod:31
5768 #: ../fish/guestfish-actions.pod:154 ../fish/guestfish-actions.pod:168
5769 #: ../fish/guestfish-actions.pod:954 ../fish/guestfish-actions.pod:1308
5770 #: ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2822
5771 #: ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4732
5773 "Deprecated functions will not be removed from the API, but the fact that "
5774 "they are deprecated indicates that there are problems with correct use of "
5780 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
5781 #: ../src/guestfs-actions.pod:1097 ../src/guestfs-actions.pod:1895
5782 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096
5783 #: ../src/guestfs-actions.pod:3230 ../src/guestfs-actions.pod:3245
5784 #: ../src/guestfs-actions.pod:4485 ../src/guestfs-actions.pod:5563
5785 #: ../src/guestfs-actions.pod:5680 ../src/guestfs-actions.pod:5790
5786 #: ../src/guestfs-actions.pod:6253 ../src/guestfs-actions.pod:6378
5787 #: ../src/guestfs-actions.pod:6900
5788 msgid "(Added in 0.3)"
5793 #: ../src/guestfs-actions.pod:41
5794 msgid "guestfs_add_domain"
5799 #: ../src/guestfs-actions.pod:43
5803 " guestfs_add_domain (guestfs_h *g,\n"
5804 " const char *dom,\n"
5811 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
5812 #: ../src/guestfs-actions.pod:4207
5814 "You may supply a list of optional arguments to this call. Use zero or more "
5815 "of the following pairs of parameters, and terminate the list with C<-1> on "
5816 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
5821 #: ../src/guestfs-actions.pod:53
5824 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
5825 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
5826 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
5832 #: ../src/guestfs-actions.pod:57
5834 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5835 "It works by connecting to libvirt, requesting the domain and domain XML from "
5836 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
5842 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
5844 "The number of disks added is returned. This operation is atomic: if an "
5845 "error is returned, then no disks are added."
5850 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
5852 "This function does some minimal checks to make sure the libvirt domain is "
5853 "not running (unless C<readonly> is true). In a future version we will try "
5854 "to acquire the libvirt lock on each disk."
5859 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
5861 "Disks must be accessible locally. This often means that adding disks from a "
5862 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5863 "unless those disks are accessible via the same device path locally too."
5867 #: ../src/guestfs-actions.pod:74 ../fish/guestfish-actions.pod:58
5869 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5870 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5871 "libvirt URI (or one set through an environment variable, see the libvirt "
5872 "documentation for full details)."
5877 #: ../src/guestfs-actions.pod:80
5879 "The other optional parameters are passed directly through to "
5880 "C<guestfs_add_drive_opts>."
5885 #: ../src/guestfs-actions.pod:83 ../src/guestfs-actions.pod:336
5886 #: ../src/guestfs-actions.pod:506 ../src/guestfs-actions.pod:684
5887 #: ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:733
5888 #: ../src/guestfs-actions.pod:752 ../src/guestfs-actions.pod:1312
5889 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866
5890 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005
5891 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083
5892 #: ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2664
5893 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:4621
5894 #: ../src/guestfs-actions.pod:4758 ../src/guestfs-actions.pod:5164
5895 #: ../src/guestfs-actions.pod:5190 ../src/guestfs-actions.pod:6486
5896 #: ../src/guestfs-actions.pod:6911 ../src/guestfs-actions.pod:6924
5897 #: ../src/guestfs-actions.pod:6937
5898 msgid "On error this function returns -1."
5903 #: ../src/guestfs-actions.pod:85
5904 msgid "(Added in 1.7.4)"
5909 #: ../src/guestfs-actions.pod:87
5910 msgid "guestfs_add_domain_va"
5915 #: ../src/guestfs-actions.pod:89
5919 " guestfs_add_domain_va (guestfs_h *g,\n"
5920 " const char *dom,\n"
5927 #: ../src/guestfs-actions.pod:94
5928 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
5933 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
5934 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
5935 #: ../src/guestfs-actions.pod:4248 ../src/guestfs-actions.pod:4260
5936 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
5941 #: ../src/guestfs-actions.pod:98
5942 msgid "guestfs_add_domain_argv"
5947 #: ../src/guestfs-actions.pod:100
5951 " guestfs_add_domain_argv (guestfs_h *g,\n"
5952 " const char *dom,\n"
5953 " const struct guestfs_add_domain_argv *optargs);\n"
5959 #: ../src/guestfs-actions.pod:105
5960 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
5965 #: ../src/guestfs-actions.pod:109
5966 msgid "guestfs_add_drive"
5971 #: ../src/guestfs-actions.pod:111
5975 " guestfs_add_drive (guestfs_h *g,\n"
5976 " const char *filename);\n"
5982 #: ../src/guestfs-actions.pod:115
5984 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
5985 "optional parameters, so the disk is added writable, with the format being "
5986 "detected automatically."
5991 #: ../src/guestfs-actions.pod:119
5993 "Automatic detection of the format opens you up to a potential security hole "
5994 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5995 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5996 "you should think about replacing calls to this function with calls to "
5997 "C<guestfs_add_drive_opts>, and specifying the format."
6002 #: ../src/guestfs-actions.pod:130
6003 msgid "guestfs_add_drive_opts"
6008 #: ../src/guestfs-actions.pod:132
6012 " guestfs_add_drive_opts (guestfs_h *g,\n"
6013 " const char *filename,\n"
6020 #: ../src/guestfs-actions.pod:142
6023 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6024 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6025 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6031 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:90
6033 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6034 "The first time you call this function, the disk appears as C</dev/sda>, the "
6035 "second time as C</dev/sdb>, and so on."
6040 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:95
6042 "You don't necessarily need to be root when using libguestfs. However you "
6043 "obviously do need sufficient permissions to access the filename for whatever "
6044 "operations you want to perform (ie. read access if you just want to read the "
6045 "image or write access if you want to modify the image)."
6050 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:101
6051 msgid "This call checks that C<filename> exists."
6056 #: ../src/guestfs-actions.pod:159 ../src/guestfs-actions.pod:4217
6057 #: ../fish/guestfish-actions.pod:103 ../fish/guestfish-actions.pod:2833
6058 msgid "The optional arguments are:"
6063 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:107
6069 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
6071 "If true then the image is treated as read-only. Writes are still allowed, "
6072 "but they are stored in a temporary snapshot overlay which is discarded at "
6073 "the end. The disk that you add is not modified."
6078 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:113
6084 #: ../src/guestfs-actions.pod:171
6086 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
6087 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6088 "Possible formats include C<raw> and C<qcow2>."
6093 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:119
6095 "Automatic detection of the format opens you up to a potential security hole "
6096 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6097 "RHBZ#642934. Specifying the format closes this security hole."
6102 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:124
6108 #: ../src/guestfs-actions.pod:182
6110 "This rarely-used option lets you emulate the behaviour of the deprecated "
6111 "C<guestfs_add_drive_with_if> call (q.v.)"
6116 #: ../src/guestfs-actions.pod:189
6117 msgid "(Added in 1.5.23)"
6122 #: ../src/guestfs-actions.pod:191
6123 msgid "guestfs_add_drive_opts_va"
6128 #: ../src/guestfs-actions.pod:193
6132 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6133 " const char *filename,\n"
6140 #: ../src/guestfs-actions.pod:198
6141 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6146 #: ../src/guestfs-actions.pod:202
6147 msgid "guestfs_add_drive_opts_argv"
6152 #: ../src/guestfs-actions.pod:204
6156 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6157 " const char *filename,\n"
6158 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6164 #: ../src/guestfs-actions.pod:209
6165 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6170 #: ../src/guestfs-actions.pod:213
6171 msgid "guestfs_add_drive_ro"
6176 #: ../src/guestfs-actions.pod:215
6180 " guestfs_add_drive_ro (guestfs_h *g,\n"
6181 " const char *filename);\n"
6187 #: ../src/guestfs-actions.pod:219
6189 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6190 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6191 "disk is added read-only, with the format being detected automatically."
6196 #: ../src/guestfs-actions.pod:226
6197 msgid "(Added in 1.0.38)"
6202 #: ../src/guestfs-actions.pod:228
6203 msgid "guestfs_add_drive_ro_with_if"
6208 #: ../src/guestfs-actions.pod:230
6212 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6213 " const char *filename,\n"
6214 " const char *iface);\n"
6220 #: ../src/guestfs-actions.pod:235
6222 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
6223 "QEMU interface emulation to use at run time."
6228 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
6229 #: ../src/guestfs-actions.pod:2335
6230 msgid "(Added in 1.0.84)"
6235 #: ../src/guestfs-actions.pod:249
6236 msgid "guestfs_add_drive_with_if"
6241 #: ../src/guestfs-actions.pod:251
6245 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6246 " const char *filename,\n"
6247 " const char *iface);\n"
6253 #: ../src/guestfs-actions.pod:256
6255 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6256 "QEMU interface emulation to use at run time."
6261 #: ../src/guestfs-actions.pod:270
6262 msgid "guestfs_aug_clear"
6267 #: ../src/guestfs-actions.pod:272
6271 " guestfs_aug_clear (guestfs_h *g,\n"
6272 " const char *augpath);\n"
6278 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:176
6280 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6281 "L<augtool(1)> C<clear> command."
6286 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2085
6287 msgid "(Added in 1.3.4)"
6292 #: ../src/guestfs-actions.pod:283
6293 msgid "guestfs_aug_close"
6298 #: ../src/guestfs-actions.pod:285
6302 " guestfs_aug_close (guestfs_h *g);\n"
6308 #: ../src/guestfs-actions.pod:288
6310 "Close the current Augeas handle and free up any resources used by it. After "
6311 "calling this, you have to call C<guestfs_aug_init> again before you can use "
6312 "any other Augeas functions."
6317 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
6318 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
6319 #: ../src/guestfs-actions.pod:415 ../src/guestfs-actions.pod:435
6320 #: ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:480
6321 #: ../src/guestfs-actions.pod:494 ../src/guestfs-actions.pod:508
6322 #: ../src/guestfs-actions.pod:522 ../src/guestfs-actions.pod:540
6323 #: ../src/guestfs-actions.pod:5241
6324 msgid "(Added in 0.7)"
6329 #: ../src/guestfs-actions.pod:297
6330 msgid "guestfs_aug_defnode"
6335 #: ../src/guestfs-actions.pod:299
6338 " struct guestfs_int_bool *\n"
6339 " guestfs_aug_defnode (guestfs_h *g,\n"
6340 " const char *name,\n"
6341 " const char *expr,\n"
6342 " const char *val);\n"
6348 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:192
6350 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6355 #: ../src/guestfs-actions.pod:308
6357 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6358 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6359 "containing that single node."
6364 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:199
6366 "On success this returns a pair containing the number of nodes in the "
6367 "nodeset, and a boolean flag if a node was created."
6372 #: ../src/guestfs-actions.pod:316
6374 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6375 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6380 #: ../src/guestfs-actions.pod:322
6381 msgid "guestfs_aug_defvar"
6386 #: ../src/guestfs-actions.pod:324
6390 " guestfs_aug_defvar (guestfs_h *g,\n"
6391 " const char *name,\n"
6392 " const char *expr);\n"
6398 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:207
6400 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6401 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6406 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:211
6408 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6409 "evaluates to something which is not a nodeset."
6414 #: ../src/guestfs-actions.pod:340
6415 msgid "guestfs_aug_get"
6420 #: ../src/guestfs-actions.pod:342
6424 " guestfs_aug_get (guestfs_h *g,\n"
6425 " const char *augpath);\n"
6431 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:218
6433 "Look up the value associated with C<path>. If C<path> matches exactly one "
6434 "node, the C<value> is returned."
6439 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:854
6440 #: ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:932
6441 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1051
6442 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198
6443 #: ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1346
6444 #: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646
6445 #: ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826
6446 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938
6447 #: ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2300
6448 #: ../src/guestfs-actions.pod:2507 ../src/guestfs-actions.pod:2588
6449 #: ../src/guestfs-actions.pod:2636 ../src/guestfs-actions.pod:2750
6450 #: ../src/guestfs-actions.pod:2781 ../src/guestfs-actions.pod:2805
6451 #: ../src/guestfs-actions.pod:2867 ../src/guestfs-actions.pod:2890
6452 #: ../src/guestfs-actions.pod:3404 ../src/guestfs-actions.pod:3754
6453 #: ../src/guestfs-actions.pod:3924 ../src/guestfs-actions.pod:4034
6454 #: ../src/guestfs-actions.pod:4776 ../src/guestfs-actions.pod:4969
6455 #: ../src/guestfs-actions.pod:5139 ../src/guestfs-actions.pod:5317
6456 #: ../src/guestfs-actions.pod:5366 ../src/guestfs-actions.pod:5929
6457 #: ../src/guestfs-actions.pod:5945 ../src/guestfs-actions.pod:5962
6458 #: ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:6660
6459 #: ../src/guestfs-actions.pod:6679 ../src/guestfs-actions.pod:6697
6460 #: ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:7149
6462 "This function returns a string, or NULL on error. I<The caller must free "
6463 "the returned string after use>."
6468 #: ../src/guestfs-actions.pod:354
6469 msgid "guestfs_aug_init"
6474 #: ../src/guestfs-actions.pod:356
6478 " guestfs_aug_init (guestfs_h *g,\n"
6479 " const char *root,\n"
6486 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:225
6488 "Create a new Augeas handle for editing configuration files. If there was "
6489 "any previous Augeas handle associated with this guestfs session, then it is "
6495 #: ../src/guestfs-actions.pod:365
6496 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6501 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:232
6503 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6508 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:235
6510 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6511 "logical I<or> of the following integers:"
6516 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:241
6517 msgid "C<AUG_SAVE_BACKUP> = 1"
6522 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
6523 msgid "Keep the original file with a C<.augsave> extension."
6528 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
6529 msgid "C<AUG_SAVE_NEWFILE> = 2"
6534 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
6536 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6537 "original. Overrides C<AUG_SAVE_BACKUP>."
6542 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:250
6543 msgid "C<AUG_TYPE_CHECK> = 4"
6547 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
6548 msgid "Typecheck lenses."
6552 #: ../src/guestfs-actions.pod:390
6554 "This option is only useful when debugging Augeas lenses. Use of this option "
6555 "may require additional memory for the libguestfs appliance. You may need to "
6556 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
6557 "C<guestfs_set_memsize>."
6562 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:259
6563 msgid "C<AUG_NO_STDINC> = 8"
6568 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:261
6569 msgid "Do not use standard load path for modules."
6574 #: ../src/guestfs-actions.pod:399 ../fish/guestfish-actions.pod:263
6575 msgid "C<AUG_SAVE_NOOP> = 16"
6580 #: ../src/guestfs-actions.pod:401 ../fish/guestfish-actions.pod:265
6581 msgid "Make save a no-op, just record what would have been changed."
6586 #: ../src/guestfs-actions.pod:403 ../fish/guestfish-actions.pod:267
6587 msgid "C<AUG_NO_LOAD> = 32"
6592 #: ../src/guestfs-actions.pod:405
6593 msgid "Do not load the tree in C<guestfs_aug_init>."
6598 #: ../src/guestfs-actions.pod:409
6599 msgid "To close the handle, you can call C<guestfs_aug_close>."
6604 #: ../src/guestfs-actions.pod:411 ../fish/guestfish-actions.pod:275
6605 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6610 #: ../src/guestfs-actions.pod:417
6611 msgid "guestfs_aug_insert"
6616 #: ../src/guestfs-actions.pod:419
6620 " guestfs_aug_insert (guestfs_h *g,\n"
6621 " const char *augpath,\n"
6622 " const char *label,\n"
6629 #: ../src/guestfs-actions.pod:425 ../fish/guestfish-actions.pod:281
6631 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
6632 "or after C<path> (depending on the boolean flag C<before>)."
6637 #: ../src/guestfs-actions.pod:429 ../fish/guestfish-actions.pod:285
6639 "C<path> must match exactly one existing node in the tree, and C<label> must "
6640 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6645 #: ../src/guestfs-actions.pod:437
6646 msgid "guestfs_aug_load"
6651 #: ../src/guestfs-actions.pod:439
6655 " guestfs_aug_load (guestfs_h *g);\n"
6661 #: ../src/guestfs-actions.pod:442 ../fish/guestfish-actions.pod:293
6662 msgid "Load files into the tree."
6667 #: ../src/guestfs-actions.pod:444 ../fish/guestfish-actions.pod:295
6668 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6673 #: ../src/guestfs-actions.pod:451
6674 msgid "guestfs_aug_ls"
6679 #: ../src/guestfs-actions.pod:453
6683 " guestfs_aug_ls (guestfs_h *g,\n"
6684 " const char *augpath);\n"
6690 #: ../src/guestfs-actions.pod:457
6692 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6693 "sorting the resulting nodes into alphabetical order."
6698 #: ../src/guestfs-actions.pod:460 ../src/guestfs-actions.pod:476
6699 #: ../src/guestfs-actions.pod:622 ../src/guestfs-actions.pod:1070
6700 #: ../src/guestfs-actions.pod:1361 ../src/guestfs-actions.pod:1380
6701 #: ../src/guestfs-actions.pod:1483 ../src/guestfs-actions.pod:1502
6702 #: ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2180
6703 #: ../src/guestfs-actions.pod:2196 ../src/guestfs-actions.pod:2215
6704 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:2282
6705 #: ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:2402
6706 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2824
6707 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3324
6708 #: ../src/guestfs-actions.pod:3386 ../src/guestfs-actions.pod:3491
6709 #: ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:4582
6710 #: ../src/guestfs-actions.pod:5111 ../src/guestfs-actions.pod:5237
6711 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:6002
6712 #: ../src/guestfs-actions.pod:6063 ../src/guestfs-actions.pod:6118
6713 #: ../src/guestfs-actions.pod:6264 ../src/guestfs-actions.pod:6288
6714 #: ../src/guestfs-actions.pod:6770 ../src/guestfs-actions.pod:6790
6715 #: ../src/guestfs-actions.pod:6837 ../src/guestfs-actions.pod:7002
6716 #: ../src/guestfs-actions.pod:7021 ../src/guestfs-actions.pod:7106
6717 #: ../src/guestfs-actions.pod:7125 ../src/guestfs-actions.pod:7171
6718 #: ../src/guestfs-actions.pod:7190
6720 "This function returns a NULL-terminated array of strings (like L<environ(3)"
6721 ">), or NULL if there was an error. I<The caller must free the strings and "
6722 "the array after use>."
6727 #: ../src/guestfs-actions.pod:464 ../src/guestfs-actions.pod:995
6728 #: ../src/guestfs-actions.pod:1013 ../src/guestfs-actions.pod:1418
6729 #: ../src/guestfs-actions.pod:3117 ../src/guestfs-actions.pod:3148
6730 #: ../src/guestfs-actions.pod:3737 ../src/guestfs-actions.pod:3787
6731 #: ../src/guestfs-actions.pod:3974 ../src/guestfs-actions.pod:4007
6732 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4586
6733 #: ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:5430
6734 #: ../src/guestfs-actions.pod:5444 ../src/guestfs-actions.pod:5456
6735 #: ../src/guestfs-actions.pod:5864 ../src/guestfs-actions.pod:6502
6736 #: ../src/guestfs-actions.pod:6515 ../src/guestfs-actions.pod:6754
6737 #: ../src/guestfs-actions.pod:6990
6738 msgid "(Added in 0.8)"
6743 #: ../src/guestfs-actions.pod:466
6744 msgid "guestfs_aug_match"
6749 #: ../src/guestfs-actions.pod:468
6753 " guestfs_aug_match (guestfs_h *g,\n"
6754 " const char *augpath);\n"
6760 #: ../src/guestfs-actions.pod:472 ../fish/guestfish-actions.pod:309
6762 "Returns a list of paths which match the path expression C<path>. The "
6763 "returned paths are sufficiently qualified so that they match exactly one "
6764 "node in the current tree."
6769 #: ../src/guestfs-actions.pod:482
6770 msgid "guestfs_aug_mv"
6775 #: ../src/guestfs-actions.pod:484
6779 " guestfs_aug_mv (guestfs_h *g,\n"
6780 " const char *src,\n"
6781 " const char *dest);\n"
6787 #: ../src/guestfs-actions.pod:489 ../fish/guestfish-actions.pod:317
6789 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6790 "C<dest> is overwritten if it exists."
6795 #: ../src/guestfs-actions.pod:496
6796 msgid "guestfs_aug_rm"
6801 #: ../src/guestfs-actions.pod:498
6805 " guestfs_aug_rm (guestfs_h *g,\n"
6806 " const char *augpath);\n"
6812 #: ../src/guestfs-actions.pod:502 ../fish/guestfish-actions.pod:324
6813 msgid "Remove C<path> and all of its children."
6818 #: ../src/guestfs-actions.pod:504 ../fish/guestfish-actions.pod:326
6819 msgid "On success this returns the number of entries which were removed."
6824 #: ../src/guestfs-actions.pod:510
6825 msgid "guestfs_aug_save"
6830 #: ../src/guestfs-actions.pod:512
6834 " guestfs_aug_save (guestfs_h *g);\n"
6840 #: ../src/guestfs-actions.pod:515 ../fish/guestfish-actions.pod:332
6841 msgid "This writes all pending changes to disk."
6846 #: ../src/guestfs-actions.pod:517
6848 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
6854 #: ../src/guestfs-actions.pod:524
6855 msgid "guestfs_aug_set"
6860 #: ../src/guestfs-actions.pod:526
6864 " guestfs_aug_set (guestfs_h *g,\n"
6865 " const char *augpath,\n"
6866 " const char *val);\n"
6872 #: ../src/guestfs-actions.pod:531 ../fish/guestfish-actions.pod:341
6873 msgid "Set the value associated with C<path> to C<val>."
6878 #: ../src/guestfs-actions.pod:533
6880 "In the Augeas API, it is possible to clear a node by setting the value to "
6881 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6882 "this call. Instead you must use the C<guestfs_aug_clear> call."
6887 #: ../src/guestfs-actions.pod:542
6888 msgid "guestfs_available"
6893 #: ../src/guestfs-actions.pod:544
6897 " guestfs_available (guestfs_h *g,\n"
6898 " char *const *groups);\n"
6904 #: ../src/guestfs-actions.pod:548 ../fish/guestfish-actions.pod:352
6906 "This command is used to check the availability of some groups of "
6907 "functionality in the appliance, which not all builds of the libguestfs "
6908 "appliance will be able to provide."
6913 #: ../src/guestfs-actions.pod:552
6915 "The libguestfs groups, and the functions that those groups correspond to, "
6916 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6917 "runtime by calling C<guestfs_available_all_groups>."
6922 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:361
6924 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6925 "\"]> would check for the availability of the Linux inotify functions and "
6926 "Augeas (configuration file editing) functions."
6931 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:366
6932 msgid "The command returns no error if I<all> requested groups are available."
6937 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
6939 "It fails with an error if one or more of the requested groups is unavailable "
6945 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
6947 "If an unknown group name is included in the list of groups then an error is "
6953 #: ../src/guestfs-actions.pod:570 ../fish/guestfish-actions.pod:374
6959 #: ../src/guestfs-actions.pod:576
6960 msgid "You must call C<guestfs_launch> before calling this function."
6965 #: ../src/guestfs-actions.pod:578 ../fish/guestfish-actions.pod:382
6967 "The reason is because we don't know what groups are supported by the "
6968 "appliance/daemon until it is running and can be queried."
6973 #: ../src/guestfs-actions.pod:584 ../fish/guestfish-actions.pod:388
6975 "If a group of functions is available, this does not necessarily mean that "
6976 "they will work. You still have to check for errors when calling individual "
6977 "API functions even if they are available."
6982 #: ../src/guestfs-actions.pod:591 ../fish/guestfish-actions.pod:395
6984 "It is usually the job of distro packagers to build complete functionality "
6985 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6986 "with all requirements satisfied, will support everything."
6991 #: ../src/guestfs-actions.pod:598
6993 "This call was added in version C<1.0.80>. In previous versions of "
6994 "libguestfs all you could do would be to speculatively execute a command to "
6995 "find out if the daemon implemented it. See also C<guestfs_version>."
7000 #: ../src/guestfs-actions.pod:607 ../src/guestfs-actions.pod:1168
7001 msgid "(Added in 1.0.80)"
7006 #: ../src/guestfs-actions.pod:609
7007 msgid "guestfs_available_all_groups"
7012 #: ../src/guestfs-actions.pod:611
7016 " guestfs_available_all_groups (guestfs_h *g);\n"
7022 #: ../src/guestfs-actions.pod:614
7024 "This command returns a list of all optional groups that this daemon knows "
7025 "about. Note this returns both supported and unsupported groups. To find "
7026 "out which ones the daemon can actually support you have to call "
7027 "C<guestfs_available> on each member of the returned list."
7032 #: ../src/guestfs-actions.pod:620
7033 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7038 #: ../src/guestfs-actions.pod:626
7039 msgid "(Added in 1.3.15)"
7044 #: ../src/guestfs-actions.pod:628
7045 msgid "guestfs_base64_in"
7050 #: ../src/guestfs-actions.pod:630
7054 " guestfs_base64_in (guestfs_h *g,\n"
7055 " const char *base64file,\n"
7056 " const char *filename);\n"
7062 #: ../src/guestfs-actions.pod:635 ../fish/guestfish-actions.pod:425
7064 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7069 #: ../src/guestfs-actions.pod:640 ../src/guestfs-actions.pod:654
7070 msgid "(Added in 1.3.5)"
7075 #: ../src/guestfs-actions.pod:642
7076 msgid "guestfs_base64_out"
7081 #: ../src/guestfs-actions.pod:644
7085 " guestfs_base64_out (guestfs_h *g,\n"
7086 " const char *filename,\n"
7087 " const char *base64file);\n"
7093 #: ../src/guestfs-actions.pod:649 ../fish/guestfish-actions.pod:434
7095 "This command downloads the contents of C<filename>, writing it out to local "
7096 "file C<base64file> encoded as base64."
7101 #: ../src/guestfs-actions.pod:656
7102 msgid "guestfs_blockdev_flushbufs"
7107 #: ../src/guestfs-actions.pod:658
7111 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7112 " const char *device);\n"
7118 #: ../src/guestfs-actions.pod:662 ../fish/guestfish-actions.pod:443
7120 "This tells the kernel to flush internal buffers associated with C<device>."
7125 #: ../src/guestfs-actions.pod:665 ../src/guestfs-actions.pod:682
7126 #: ../src/guestfs-actions.pod:697 ../src/guestfs-actions.pod:713
7127 #: ../src/guestfs-actions.pod:731 ../src/guestfs-actions.pod:750
7128 #: ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:782
7129 #: ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810
7130 #: ../fish/guestfish-actions.pod:446 ../fish/guestfish-actions.pod:457
7131 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:476
7132 #: ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:501
7133 #: ../fish/guestfish-actions.pod:509 ../fish/guestfish-actions.pod:520
7134 #: ../fish/guestfish-actions.pod:528 ../fish/guestfish-actions.pod:536
7135 msgid "This uses the L<blockdev(8)> command."
7140 #: ../src/guestfs-actions.pod:669 ../src/guestfs-actions.pod:686
7141 #: ../src/guestfs-actions.pod:701 ../src/guestfs-actions.pod:717
7142 #: ../src/guestfs-actions.pod:735 ../src/guestfs-actions.pod:754
7143 #: ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:786
7144 #: ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:814
7145 msgid "(Added in 0.9.3)"
7150 #: ../src/guestfs-actions.pod:671
7151 msgid "guestfs_blockdev_getbsz"
7156 #: ../src/guestfs-actions.pod:673
7160 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7161 " const char *device);\n"
7167 #: ../src/guestfs-actions.pod:677 ../fish/guestfish-actions.pod:452
7168 msgid "This returns the block size of a device."
7173 #: ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:779
7174 #: ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:517
7176 "(Note this is different from both I<size in blocks> and I<filesystem block "
7182 #: ../src/guestfs-actions.pod:688
7183 msgid "guestfs_blockdev_getro"
7188 #: ../src/guestfs-actions.pod:690
7192 " guestfs_blockdev_getro (guestfs_h *g,\n"
7193 " const char *device);\n"
7199 #: ../src/guestfs-actions.pod:694 ../fish/guestfish-actions.pod:463
7201 "Returns a boolean indicating if the block device is read-only (true if read-"
7202 "only, false if not)."
7207 #: ../src/guestfs-actions.pod:699 ../src/guestfs-actions.pod:1401
7208 #: ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:1893
7209 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976
7210 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046
7211 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094
7212 #: ../src/guestfs-actions.pod:3056 ../src/guestfs-actions.pod:3070
7213 #: ../src/guestfs-actions.pod:3085 ../src/guestfs-actions.pod:3099
7214 #: ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3130
7215 #: ../src/guestfs-actions.pod:3146 ../src/guestfs-actions.pod:3160
7216 #: ../src/guestfs-actions.pod:3173 ../src/guestfs-actions.pod:3187
7217 #: ../src/guestfs-actions.pod:3202 ../src/guestfs-actions.pod:3217
7218 #: ../src/guestfs-actions.pod:4740
7219 msgid "This function returns a C truth value on success or -1 on error."
7224 #: ../src/guestfs-actions.pod:703
7225 msgid "guestfs_blockdev_getsize64"
7230 #: ../src/guestfs-actions.pod:705
7234 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7235 " const char *device);\n"
7241 #: ../src/guestfs-actions.pod:709 ../fish/guestfish-actions.pod:472
7242 msgid "This returns the size of the device in bytes."
7247 #: ../src/guestfs-actions.pod:711
7248 msgid "See also C<guestfs_blockdev_getsz>."
7253 #: ../src/guestfs-actions.pod:719
7254 msgid "guestfs_blockdev_getss"
7259 #: ../src/guestfs-actions.pod:721
7263 " guestfs_blockdev_getss (guestfs_h *g,\n"
7264 " const char *device);\n"
7270 #: ../src/guestfs-actions.pod:725 ../fish/guestfish-actions.pod:482
7272 "This returns the size of sectors on a block device. Usually 512, but can be "
7273 "larger for modern devices."
7278 #: ../src/guestfs-actions.pod:728
7280 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7286 #: ../src/guestfs-actions.pod:737
7287 msgid "guestfs_blockdev_getsz"
7292 #: ../src/guestfs-actions.pod:739
7296 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7297 " const char *device);\n"
7303 #: ../src/guestfs-actions.pod:743 ../fish/guestfish-actions.pod:494
7305 "This returns the size of the device in units of 512-byte sectors (even if "
7306 "the sectorsize isn't 512 bytes ... weird)."
7311 #: ../src/guestfs-actions.pod:746
7313 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7314 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7319 #: ../src/guestfs-actions.pod:756
7320 msgid "guestfs_blockdev_rereadpt"
7325 #: ../src/guestfs-actions.pod:758
7329 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7330 " const char *device);\n"
7336 #: ../src/guestfs-actions.pod:762 ../fish/guestfish-actions.pod:507
7337 msgid "Reread the partition table on C<device>."
7342 #: ../src/guestfs-actions.pod:770
7343 msgid "guestfs_blockdev_setbsz"
7348 #: ../src/guestfs-actions.pod:772
7352 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7353 " const char *device,\n"
7354 " int blocksize);\n"
7360 #: ../src/guestfs-actions.pod:777 ../fish/guestfish-actions.pod:515
7361 msgid "This sets the block size of a device."
7366 #: ../src/guestfs-actions.pod:788
7367 msgid "guestfs_blockdev_setro"
7372 #: ../src/guestfs-actions.pod:790
7376 " guestfs_blockdev_setro (guestfs_h *g,\n"
7377 " const char *device);\n"
7383 #: ../src/guestfs-actions.pod:794 ../fish/guestfish-actions.pod:526
7384 msgid "Sets the block device named C<device> to read-only."
7389 #: ../src/guestfs-actions.pod:802
7390 msgid "guestfs_blockdev_setrw"
7395 #: ../src/guestfs-actions.pod:804
7399 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7400 " const char *device);\n"
7406 #: ../src/guestfs-actions.pod:808 ../fish/guestfish-actions.pod:534
7407 msgid "Sets the block device named C<device> to read-write."
7412 #: ../src/guestfs-actions.pod:816
7413 msgid "guestfs_case_sensitive_path"
7418 #: ../src/guestfs-actions.pod:818
7422 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7423 " const char *path);\n"
7429 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:542
7431 "This can be used to resolve case insensitive paths on a filesystem which is "
7432 "case sensitive. The use case is to resolve paths which you have read from "
7433 "Windows configuration files or the Windows Registry, to the true path."
7438 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:547
7440 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7441 "(and probably others), which is that although the underlying filesystem is "
7442 "case-insensitive, the driver exports the filesystem to Linux as case-"
7448 #: ../src/guestfs-actions.pod:832 ../fish/guestfish-actions.pod:552
7450 "One consequence of this is that special directories such as C<c:\\windows> "
7451 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7452 "precise details of how they were created. In Windows itself this would not "
7458 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
7460 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
7466 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:561
7468 "This function resolves the true case of each element in the path and returns "
7469 "the case-sensitive path."
7474 #: ../src/guestfs-actions.pod:844
7476 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
7477 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7478 "how the directories were originally created under Windows)."
7483 #: ../src/guestfs-actions.pod:849 ../fish/guestfish-actions.pod:569
7484 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7489 #: ../src/guestfs-actions.pod:852
7490 msgid "See also C<guestfs_realpath>."
7495 #: ../src/guestfs-actions.pod:857 ../src/guestfs-actions.pod:6682
7496 msgid "(Added in 1.0.75)"
7501 #: ../src/guestfs-actions.pod:859
7507 #: ../src/guestfs-actions.pod:861
7511 " guestfs_cat (guestfs_h *g,\n"
7512 " const char *path);\n"
7518 #: ../src/guestfs-actions.pod:865 ../src/guestfs-actions.pod:5227
7519 #: ../fish/guestfish-actions.pod:578 ../fish/guestfish-actions.pod:3479
7520 msgid "Return the contents of the file named C<path>."
7525 #: ../src/guestfs-actions.pod:867
7527 "Note that this function cannot correctly handle binary files (specifically, "
7528 "files containing C<\\0> character which is treated as end of string). For "
7529 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7530 "functions which have a more complex interface."
7535 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:1054
7536 #: ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1365
7537 #: ../src/guestfs-actions.pod:1384 ../src/guestfs-actions.pod:1487
7538 #: ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:1752
7539 #: ../src/guestfs-actions.pod:2200 ../src/guestfs-actions.pod:2219
7540 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:2286
7541 #: ../src/guestfs-actions.pod:2303 ../src/guestfs-actions.pod:2332
7542 #: ../src/guestfs-actions.pod:5009 ../src/guestfs-actions.pod:5035
7543 #: ../src/guestfs-actions.pod:5166 ../src/guestfs-actions.pod:5192
7544 #: ../src/guestfs-actions.pod:5216 ../src/guestfs-actions.pod:6067
7545 #: ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6268
7546 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6954
7547 #: ../src/guestfs-actions.pod:6980 ../src/guestfs-actions.pod:7006
7548 #: ../src/guestfs-actions.pod:7025 ../src/guestfs-actions.pod:7110
7549 #: ../src/guestfs-actions.pod:7129 ../src/guestfs-actions.pod:7175
7550 #: ../src/guestfs-actions.pod:7194 ../fish/guestfish-actions.pod:585
7551 #: ../fish/guestfish-actions.pod:720 ../fish/guestfish-actions.pod:732
7552 #: ../fish/guestfish-actions.pod:908 ../fish/guestfish-actions.pod:918
7553 #: ../fish/guestfish-actions.pod:985 ../fish/guestfish-actions.pod:995
7554 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1482
7555 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:1520
7556 #: ../fish/guestfish-actions.pod:1535 ../fish/guestfish-actions.pod:1545
7557 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:3349
7558 #: ../fish/guestfish-actions.pod:3364 ../fish/guestfish-actions.pod:3440
7559 #: ../fish/guestfish-actions.pod:3457 ../fish/guestfish-actions.pod:3472
7560 #: ../fish/guestfish-actions.pod:4055 ../fish/guestfish-actions.pod:4101
7561 #: ../fish/guestfish-actions.pod:4186 ../fish/guestfish-actions.pod:4201
7562 #: ../fish/guestfish-actions.pod:4611 ../fish/guestfish-actions.pod:4629
7563 #: ../fish/guestfish-actions.pod:4646 ../fish/guestfish-actions.pod:4656
7564 #: ../fish/guestfish-actions.pod:4704 ../fish/guestfish-actions.pod:4714
7565 #: ../fish/guestfish-actions.pod:4743 ../fish/guestfish-actions.pod:4753
7567 "Because of the message protocol, there is a transfer limit of somewhere "
7568 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7573 #: ../src/guestfs-actions.pod:878 ../src/guestfs-actions.pod:3328
7574 #: ../src/guestfs-actions.pod:3390 ../src/guestfs-actions.pod:3407
7575 #: ../src/guestfs-actions.pod:3495 ../src/guestfs-actions.pod:3900
7576 #: ../src/guestfs-actions.pod:3914 ../src/guestfs-actions.pod:5115
7577 #: ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:6841
7578 #: ../src/guestfs-actions.pod:6855
7579 msgid "(Added in 0.4)"
7584 #: ../src/guestfs-actions.pod:880
7585 msgid "guestfs_checksum"
7590 #: ../src/guestfs-actions.pod:882
7594 " guestfs_checksum (guestfs_h *g,\n"
7595 " const char *csumtype,\n"
7596 " const char *path);\n"
7602 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
7604 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7609 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:595
7611 "The type of checksum to compute is given by the C<csumtype> parameter which "
7612 "must have one of the following values:"
7617 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:600
7623 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
7625 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7631 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:605
7637 #: ../src/guestfs-actions.pod:902 ../fish/guestfish-actions.pod:607
7638 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7643 #: ../src/guestfs-actions.pod:904 ../fish/guestfish-actions.pod:609
7649 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:611
7650 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7655 #: ../src/guestfs-actions.pod:908 ../fish/guestfish-actions.pod:613
7661 #: ../src/guestfs-actions.pod:910 ../fish/guestfish-actions.pod:615
7662 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7667 #: ../src/guestfs-actions.pod:912 ../fish/guestfish-actions.pod:617
7673 #: ../src/guestfs-actions.pod:914 ../fish/guestfish-actions.pod:619
7674 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7679 #: ../src/guestfs-actions.pod:916 ../fish/guestfish-actions.pod:621
7685 #: ../src/guestfs-actions.pod:918 ../fish/guestfish-actions.pod:623
7686 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7691 #: ../src/guestfs-actions.pod:920 ../fish/guestfish-actions.pod:625
7697 #: ../src/guestfs-actions.pod:922 ../fish/guestfish-actions.pod:627
7698 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7703 #: ../src/guestfs-actions.pod:926 ../fish/guestfish-actions.pod:631
7704 msgid "The checksum is returned as a printable string."
7709 #: ../src/guestfs-actions.pod:928
7710 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7715 #: ../src/guestfs-actions.pod:930
7716 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7721 #: ../src/guestfs-actions.pod:935 ../src/guestfs-actions.pod:1243
7722 #: ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3072
7723 #: ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3162
7724 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:6538
7725 msgid "(Added in 1.0.2)"
7730 #: ../src/guestfs-actions.pod:937
7731 msgid "guestfs_checksum_device"
7736 #: ../src/guestfs-actions.pod:939
7740 " guestfs_checksum_device (guestfs_h *g,\n"
7741 " const char *csumtype,\n"
7742 " const char *device);\n"
7748 #: ../src/guestfs-actions.pod:944
7750 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7751 "device named C<device>. For the types of checksums supported see the "
7752 "C<guestfs_checksum> command."
7757 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:4646
7758 #: ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4742
7759 #: ../src/guestfs-actions.pod:4760 ../src/guestfs-actions.pod:4936
7760 #: ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6461
7761 #: ../src/guestfs-actions.pod:6867
7762 msgid "(Added in 1.3.2)"
7767 #: ../src/guestfs-actions.pod:953
7768 msgid "guestfs_checksums_out"
7773 #: ../src/guestfs-actions.pod:955
7777 " guestfs_checksums_out (guestfs_h *g,\n"
7778 " const char *csumtype,\n"
7779 " const char *directory,\n"
7780 " const char *sumsfile);\n"
7786 #: ../src/guestfs-actions.pod:961 ../fish/guestfish-actions.pod:649
7788 "This command computes the checksums of all regular files in C<directory> and "
7789 "then emits a list of those checksums to the local output file C<sumsfile>."
7794 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:653
7796 "This can be used for verifying the integrity of a virtual machine. However "
7797 "to be properly secure you should pay attention to the output of the checksum "
7798 "command (it uses the ones from GNU coreutils). In particular when the "
7799 "filename is not printable, coreutils uses a special backslash syntax. For "
7800 "more information, see the GNU coreutils info file."
7805 #: ../src/guestfs-actions.pod:975
7806 msgid "(Added in 1.3.7)"
7811 #: ../src/guestfs-actions.pod:977
7812 msgid "guestfs_chmod"
7817 #: ../src/guestfs-actions.pod:979
7821 " guestfs_chmod (guestfs_h *g,\n"
7823 " const char *path);\n"
7829 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
7831 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7837 #: ../src/guestfs-actions.pod:987 ../fish/guestfish-actions.pod:670
7839 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7840 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7846 #: ../src/guestfs-actions.pod:991 ../src/guestfs-actions.pod:4151
7847 #: ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4355
7848 #: ../src/guestfs-actions.pod:4374 ../fish/guestfish-actions.pod:674
7849 #: ../fish/guestfish-actions.pod:2797 ../fish/guestfish-actions.pod:2915
7850 #: ../fish/guestfish-actions.pod:2925 ../fish/guestfish-actions.pod:2935
7851 msgid "The mode actually set is affected by the umask."
7856 #: ../src/guestfs-actions.pod:997
7857 msgid "guestfs_chown"
7862 #: ../src/guestfs-actions.pod:999
7866 " guestfs_chown (guestfs_h *g,\n"
7869 " const char *path);\n"
7875 #: ../src/guestfs-actions.pod:1005 ../fish/guestfish-actions.pod:680
7876 msgid "Change the file owner to C<owner> and group to C<group>."
7881 #: ../src/guestfs-actions.pod:1007 ../src/guestfs-actions.pod:3259
7882 #: ../fish/guestfish-actions.pod:682 ../fish/guestfish-actions.pod:2255
7884 "Only numeric uid and gid are supported. If you want to use names, you will "
7885 "need to locate and parse the password file yourself (Augeas support makes "
7886 "this relatively easy)."
7891 #: ../src/guestfs-actions.pod:1015
7892 msgid "guestfs_command"
7897 #: ../src/guestfs-actions.pod:1017
7901 " guestfs_command (guestfs_h *g,\n"
7902 " char *const *arguments);\n"
7908 #: ../src/guestfs-actions.pod:1021 ../fish/guestfish-actions.pod:690
7910 "This call runs a command from the guest filesystem. The filesystem must be "
7911 "mounted, and must contain a compatible operating system (ie. something "
7912 "Linux, with the same or compatible processor architecture)."
7917 #: ../src/guestfs-actions.pod:1026
7919 "The single parameter is an argv-style list of arguments. The first element "
7920 "is the name of the program to run. Subsequent elements are parameters. The "
7921 "list must be non-empty (ie. must contain a program name). Note that the "
7922 "command runs directly, and is I<not> invoked via the shell (see "
7928 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
7929 msgid "The return value is anything printed to I<stdout> by the command."
7934 #: ../src/guestfs-actions.pod:1036 ../fish/guestfish-actions.pod:705
7936 "If the command returns a non-zero exit status, then this function returns an "
7937 "error message. The error message string is the content of I<stderr> from "
7943 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:709
7945 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7946 "bin>. If you require a program from another location, you should provide "
7947 "the full path in the first parameter."
7952 #: ../src/guestfs-actions.pod:1045 ../fish/guestfish-actions.pod:714
7954 "Shared libraries and data files required by the program must be available on "
7955 "filesystems which are mounted in the correct places. It is the caller's "
7956 "responsibility to ensure all filesystems that are needed are mounted at the "
7962 #: ../src/guestfs-actions.pod:1057 ../src/guestfs-actions.pod:1077
7963 #: ../src/guestfs-actions.pod:1537
7964 msgid "(Added in 0.9.1)"
7969 #: ../src/guestfs-actions.pod:1059
7970 msgid "guestfs_command_lines"
7975 #: ../src/guestfs-actions.pod:1061
7979 " guestfs_command_lines (guestfs_h *g,\n"
7980 " char *const *arguments);\n"
7986 #: ../src/guestfs-actions.pod:1065
7988 "This is the same as C<guestfs_command>, but splits the result into a list of "
7994 #: ../src/guestfs-actions.pod:1068
7995 msgid "See also: C<guestfs_sh_lines>"
8000 #: ../src/guestfs-actions.pod:1079
8001 msgid "guestfs_config"
8006 #: ../src/guestfs-actions.pod:1081
8010 " guestfs_config (guestfs_h *g,\n"
8011 " const char *qemuparam,\n"
8012 " const char *qemuvalue);\n"
8018 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:739
8020 "This can be used to add arbitrary qemu command line parameters of the form "
8021 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
8022 "setting some parameters which would interfere with parameters that we use."
8027 #: ../src/guestfs-actions.pod:1091 ../fish/guestfish-actions.pod:744
8028 msgid "The first character of C<param> string must be a C<-> (dash)."
8033 #: ../src/guestfs-actions.pod:1093 ../fish/guestfish-actions.pod:746
8034 msgid "C<value> can be NULL."
8039 #: ../src/guestfs-actions.pod:1099
8040 msgid "guestfs_copy_size"
8045 #: ../src/guestfs-actions.pod:1101
8049 " guestfs_copy_size (guestfs_h *g,\n"
8050 " const char *src,\n"
8051 " const char *dest,\n"
8058 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
8060 "This command copies exactly C<size> bytes from one source device or file "
8061 "C<src> to another destination device or file C<dest>."
8066 #: ../src/guestfs-actions.pod:1110 ../fish/guestfish-actions.pod:755
8068 "Note this will fail if the source is too short or if the destination is not "
8074 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:1238
8075 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:1686
8076 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6533
8077 #: ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:7046
8078 #: ../src/guestfs-actions.pod:7065
8080 "This long-running command can generate progress notification messages so "
8081 "that the caller can display a progress bar or indicator. To receive these "
8082 "messages, the caller must register a progress callback. See L<guestfs(3)/"
8083 "guestfs_set_progress_callback>."
8088 #: ../src/guestfs-actions.pod:1120 ../src/guestfs-actions.pod:3927
8089 #: ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:6774
8090 #: ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6880
8091 msgid "(Added in 1.0.87)"
8096 #: ../src/guestfs-actions.pod:1122
8102 #: ../src/guestfs-actions.pod:1124
8106 " guestfs_cp (guestfs_h *g,\n"
8107 " const char *src,\n"
8108 " const char *dest);\n"
8114 #: ../src/guestfs-actions.pod:1129 ../fish/guestfish-actions.pod:762
8116 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8117 "destination filename or destination directory."
8122 #: ../src/guestfs-actions.pod:1134 ../src/guestfs-actions.pod:1148
8123 #: ../src/guestfs-actions.pod:1220 ../src/guestfs-actions.pod:1294
8124 #: ../src/guestfs-actions.pod:1403 ../src/guestfs-actions.pod:4600
8125 #: ../src/guestfs-actions.pod:4986
8126 msgid "(Added in 1.0.18)"
8131 #: ../src/guestfs-actions.pod:1136
8132 msgid "guestfs_cp_a"
8137 #: ../src/guestfs-actions.pod:1138
8141 " guestfs_cp_a (guestfs_h *g,\n"
8142 " const char *src,\n"
8143 " const char *dest);\n"
8149 #: ../src/guestfs-actions.pod:1143 ../fish/guestfish-actions.pod:769
8151 "This copies a file or directory from C<src> to C<dest> recursively using the "
8157 #: ../src/guestfs-actions.pod:1150
8163 #: ../src/guestfs-actions.pod:1152
8167 " guestfs_dd (guestfs_h *g,\n"
8168 " const char *src,\n"
8169 " const char *dest);\n"
8175 #: ../src/guestfs-actions.pod:1157 ../fish/guestfish-actions.pod:776
8177 "This command copies from one source device or file C<src> to another "
8178 "destination device or file C<dest>. Normally you would use this to copy to "
8179 "or from a device or partition, for example to duplicate a filesystem."
8184 #: ../src/guestfs-actions.pod:1162
8186 "If the destination is a device, it must be as large or larger than the "
8187 "source file or device, otherwise the copy will fail. This command cannot do "
8188 "partial copies (see C<guestfs_copy_size>)."
8193 #: ../src/guestfs-actions.pod:1170
8199 #: ../src/guestfs-actions.pod:1172
8203 " guestfs_df (guestfs_h *g);\n"
8209 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:789
8210 msgid "This command runs the C<df> command to report disk space used."
8215 #: ../src/guestfs-actions.pod:1177 ../src/guestfs-actions.pod:1194
8217 "This command is mostly useful for interactive sessions. It is I<not> "
8218 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8224 #: ../src/guestfs-actions.pod:1184 ../src/guestfs-actions.pod:1201
8225 #: ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:2265
8226 #: ../src/guestfs-actions.pod:2289 ../src/guestfs-actions.pod:2357
8227 #: ../src/guestfs-actions.pod:4037 ../src/guestfs-actions.pod:4500
8228 #: ../src/guestfs-actions.pod:6271 ../src/guestfs-actions.pod:6295
8229 #: ../src/guestfs-actions.pod:6913 ../src/guestfs-actions.pod:6926
8230 #: ../src/guestfs-actions.pod:6939
8231 msgid "(Added in 1.0.54)"
8236 #: ../src/guestfs-actions.pod:1186
8237 msgid "guestfs_df_h"
8242 #: ../src/guestfs-actions.pod:1188
8246 " guestfs_df_h (guestfs_h *g);\n"
8252 #: ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:799
8254 "This command runs the C<df -h> command to report disk space used in human-"
8260 #: ../src/guestfs-actions.pod:1203
8261 msgid "guestfs_dmesg"
8266 #: ../src/guestfs-actions.pod:1205
8270 " guestfs_dmesg (guestfs_h *g);\n"
8276 #: ../src/guestfs-actions.pod:1208 ../fish/guestfish-actions.pod:810
8278 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8279 "This is sometimes useful for extended debugging of problems."
8284 #: ../src/guestfs-actions.pod:1212
8286 "Another way to get the same information is to enable verbose messages with "
8287 "C<guestfs_set_verbose> or by setting the environment variable "
8288 "C<LIBGUESTFS_DEBUG=1> before running the program."
8293 #: ../src/guestfs-actions.pod:1222
8294 msgid "guestfs_download"
8299 #: ../src/guestfs-actions.pod:1224
8303 " guestfs_download (guestfs_h *g,\n"
8304 " const char *remotefilename,\n"
8305 " const char *filename);\n"
8311 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:1254
8312 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:836
8314 "Download file C<remotefilename> and save it as C<filename> on the local "
8320 #: ../src/guestfs-actions.pod:1232 ../src/guestfs-actions.pod:6527
8321 #: ../fish/guestfish-actions.pod:826 ../fish/guestfish-actions.pod:4359
8322 msgid "C<filename> can also be a named pipe."
8327 #: ../src/guestfs-actions.pod:1234
8328 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8333 #: ../src/guestfs-actions.pod:1245
8334 msgid "guestfs_download_offset"
8339 #: ../src/guestfs-actions.pod:1247
8343 " guestfs_download_offset (guestfs_h *g,\n"
8344 " const char *remotefilename,\n"
8345 " const char *filename,\n"
8346 " int64_t offset,\n"
8353 #: ../src/guestfs-actions.pod:1257 ../fish/guestfish-actions.pod:839
8355 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8356 "region must be within the file or device)."
8361 #: ../src/guestfs-actions.pod:1260
8363 "Note that there is no limit on the amount of data that can be downloaded "
8364 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
8365 "full amount unless an error occurs."
8370 #: ../src/guestfs-actions.pod:1265
8371 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8376 #: ../src/guestfs-actions.pod:1274 ../src/guestfs-actions.pod:6572
8377 msgid "(Added in 1.5.17)"
8382 #: ../src/guestfs-actions.pod:1276
8383 msgid "guestfs_drop_caches"
8388 #: ../src/guestfs-actions.pod:1278
8392 " guestfs_drop_caches (guestfs_h *g,\n"
8393 " int whattodrop);\n"
8399 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:855
8401 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8402 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8403 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8408 #: ../src/guestfs-actions.pod:1287 ../fish/guestfish-actions.pod:860
8409 msgid "Setting C<whattodrop> to 3 should drop everything."
8414 #: ../src/guestfs-actions.pod:1289 ../fish/guestfish-actions.pod:862
8416 "This automatically calls L<sync(2)> before the operation, so that the "
8417 "maximum guest memory is freed."
8422 #: ../src/guestfs-actions.pod:1296
8428 #: ../src/guestfs-actions.pod:1298
8432 " guestfs_du (guestfs_h *g,\n"
8433 " const char *path);\n"
8439 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
8441 "This command runs the C<du -s> command to estimate file space usage for "
8447 #: ../src/guestfs-actions.pod:1305 ../fish/guestfish-actions.pod:872
8449 "C<path> can be a file or a directory. If C<path> is a directory then the "
8450 "estimate includes the contents of the directory and all subdirectories "
8456 #: ../src/guestfs-actions.pod:1309 ../fish/guestfish-actions.pod:876
8458 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8463 #: ../src/guestfs-actions.pod:1316
8464 msgid "guestfs_e2fsck_f"
8469 #: ../src/guestfs-actions.pod:1318
8473 " guestfs_e2fsck_f (guestfs_h *g,\n"
8474 " const char *device);\n"
8480 #: ../src/guestfs-actions.pod:1322 ../fish/guestfish-actions.pod:883
8482 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8483 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
8489 #: ../src/guestfs-actions.pod:1326
8491 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8492 "Normally you should use C<guestfs_fsck>."
8497 #: ../src/guestfs-actions.pod:1331
8498 msgid "(Added in 1.0.29)"
8503 #: ../src/guestfs-actions.pod:1333
8504 msgid "guestfs_echo_daemon"
8509 #: ../src/guestfs-actions.pod:1335
8513 " guestfs_echo_daemon (guestfs_h *g,\n"
8514 " char *const *words);\n"
8520 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
8522 "This command concatenates the list of C<words> passed with single spaces "
8523 "between them and returns the resulting string."
8528 #: ../src/guestfs-actions.pod:1342 ../fish/guestfish-actions.pod:897
8529 msgid "You can use this command to test the connection through to the daemon."
8534 #: ../src/guestfs-actions.pod:1344
8535 msgid "See also C<guestfs_ping_daemon>."
8540 #: ../src/guestfs-actions.pod:1349 ../src/guestfs-actions.pod:2073
8541 #: ../src/guestfs-actions.pod:5775
8542 msgid "(Added in 1.0.69)"
8547 #: ../src/guestfs-actions.pod:1351
8548 msgid "guestfs_egrep"
8553 #: ../src/guestfs-actions.pod:1353
8557 " guestfs_egrep (guestfs_h *g,\n"
8558 " const char *regex,\n"
8559 " const char *path);\n"
8565 #: ../src/guestfs-actions.pod:1358 ../fish/guestfish-actions.pod:905
8567 "This calls the external C<egrep> program and returns the matching lines."
8572 #: ../src/guestfs-actions.pod:1368 ../src/guestfs-actions.pod:1387
8573 #: ../src/guestfs-actions.pod:1444 ../src/guestfs-actions.pod:1490
8574 #: ../src/guestfs-actions.pod:1509 ../src/guestfs-actions.pod:2203
8575 #: ../src/guestfs-actions.pod:2222 ../src/guestfs-actions.pod:2378
8576 #: ../src/guestfs-actions.pod:2391 ../src/guestfs-actions.pod:2406
8577 #: ../src/guestfs-actions.pod:2452 ../src/guestfs-actions.pod:2474
8578 #: ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:3420
8579 #: ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3447
8580 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:4435
8581 #: ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5369
8582 #: ../src/guestfs-actions.pod:6139 ../src/guestfs-actions.pod:6151
8583 #: ../src/guestfs-actions.pod:6164 ../src/guestfs-actions.pod:6177
8584 #: ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6212
8585 #: ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6238
8586 #: ../src/guestfs-actions.pod:7009 ../src/guestfs-actions.pod:7028
8587 #: ../src/guestfs-actions.pod:7113 ../src/guestfs-actions.pod:7132
8588 #: ../src/guestfs-actions.pod:7178 ../src/guestfs-actions.pod:7197
8589 msgid "(Added in 1.0.66)"
8594 #: ../src/guestfs-actions.pod:1370
8595 msgid "guestfs_egrepi"
8600 #: ../src/guestfs-actions.pod:1372
8604 " guestfs_egrepi (guestfs_h *g,\n"
8605 " const char *regex,\n"
8606 " const char *path);\n"
8612 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:915
8614 "This calls the external C<egrep -i> program and returns the matching lines."
8619 #: ../src/guestfs-actions.pod:1389
8620 msgid "guestfs_equal"
8625 #: ../src/guestfs-actions.pod:1391
8629 " guestfs_equal (guestfs_h *g,\n"
8630 " const char *file1,\n"
8631 " const char *file2);\n"
8637 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
8639 "This compares the two files C<file1> and C<file2> and returns true if their "
8640 "content is exactly equal, or false otherwise."
8645 #: ../src/guestfs-actions.pod:1399 ../fish/guestfish-actions.pod:928
8646 msgid "The external L<cmp(1)> program is used for the comparison."
8651 #: ../src/guestfs-actions.pod:1405
8652 msgid "guestfs_exists"
8657 #: ../src/guestfs-actions.pod:1407
8661 " guestfs_exists (guestfs_h *g,\n"
8662 " const char *path);\n"
8668 #: ../src/guestfs-actions.pod:1411 ../fish/guestfish-actions.pod:934
8670 "This returns C<true> if and only if there is a file, directory (or anything) "
8671 "with the given C<path> name."
8676 #: ../src/guestfs-actions.pod:1414
8677 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8682 #: ../src/guestfs-actions.pod:1420
8683 msgid "guestfs_fallocate"
8688 #: ../src/guestfs-actions.pod:1422
8692 " guestfs_fallocate (guestfs_h *g,\n"
8693 " const char *path,\n"
8700 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:1453
8701 #: ../fish/guestfish-actions.pod:943 ../fish/guestfish-actions.pod:962
8703 "This command preallocates a file (containing zero bytes) named C<path> of "
8704 "size C<len> bytes. If the file exists already, it is overwritten."
8709 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:947
8711 "Do not confuse this with the guestfish-specific C<alloc> command which "
8712 "allocates a file in the host and attaches it as a device."
8716 #: ../src/guestfs-actions.pod:1437
8718 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
8724 #: ../src/guestfs-actions.pod:1446
8725 msgid "guestfs_fallocate64"
8730 #: ../src/guestfs-actions.pod:1448
8734 " guestfs_fallocate64 (guestfs_h *g,\n"
8735 " const char *path,\n"
8742 #: ../src/guestfs-actions.pod:1457
8744 "Note that this call allocates disk blocks for the file. To create a sparse "
8745 "file use C<guestfs_truncate_size> instead."
8750 #: ../src/guestfs-actions.pod:1460
8752 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8753 "oversight it only allowed 30 bit lengths to be specified, effectively "
8754 "limiting the maximum size of files created through that call to 1GB."
8759 #: ../src/guestfs-actions.pod:1465 ../fish/guestfish-actions.pod:974
8761 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8762 "commands which create a file in the host and attach it as a device."
8767 #: ../src/guestfs-actions.pod:1471
8768 msgid "(Added in 1.3.17)"
8773 #: ../src/guestfs-actions.pod:1473
8774 msgid "guestfs_fgrep"
8779 #: ../src/guestfs-actions.pod:1475
8783 " guestfs_fgrep (guestfs_h *g,\n"
8784 " const char *pattern,\n"
8785 " const char *path);\n"
8791 #: ../src/guestfs-actions.pod:1480 ../fish/guestfish-actions.pod:982
8793 "This calls the external C<fgrep> program and returns the matching lines."
8798 #: ../src/guestfs-actions.pod:1492
8799 msgid "guestfs_fgrepi"
8804 #: ../src/guestfs-actions.pod:1494
8808 " guestfs_fgrepi (guestfs_h *g,\n"
8809 " const char *pattern,\n"
8810 " const char *path);\n"
8816 #: ../src/guestfs-actions.pod:1499 ../fish/guestfish-actions.pod:992
8818 "This calls the external C<fgrep -i> program and returns the matching lines."
8823 #: ../src/guestfs-actions.pod:1511
8824 msgid "guestfs_file"
8829 #: ../src/guestfs-actions.pod:1513
8833 " guestfs_file (guestfs_h *g,\n"
8834 " const char *path);\n"
8840 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
8842 "This call uses the standard L<file(1)> command to determine the type or "
8843 "contents of the file."
8848 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
8850 "This call will also transparently look inside various types of compressed "
8856 #: ../src/guestfs-actions.pod:1523 ../fish/guestfish-actions.pod:1008
8858 "The exact command which runs is C<file -zb path>. Note in particular that "
8859 "the filename is not prepended to the output (the C<-b> option)."
8863 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1012
8865 "The output depends on the output of the underlying L<file(1)> command and it "
8866 "can change in future in ways beyond our control. In other words, the output "
8867 "is not guaranteed by the ABI."
8871 #: ../src/guestfs-actions.pod:1531
8873 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8874 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc)."
8879 #: ../src/guestfs-actions.pod:1539
8880 msgid "guestfs_file_architecture"
8885 #: ../src/guestfs-actions.pod:1541
8889 " guestfs_file_architecture (guestfs_h *g,\n"
8890 " const char *filename);\n"
8896 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
8898 "This detects the architecture of the binary C<filename>, and returns it if "
8904 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
8905 msgid "Currently defined architectures are:"
8910 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
8916 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
8918 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8919 "irrespective of the precise processor requirements of the binary."
8924 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
8930 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
8931 msgid "64 bit x86-64."
8936 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
8942 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
8943 msgid "32 bit SPARC."
8948 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
8954 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
8955 msgid "64 bit SPARC V9 and above."
8960 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
8966 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
8967 msgid "Intel Itanium."
8972 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
8978 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
8979 msgid "32 bit Power PC."
8984 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
8990 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
8991 msgid "64 bit Power PC."
8996 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
8997 msgid "Libguestfs may return other architecture strings in future."
9002 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
9003 msgid "The function works on at least the following types of files:"
9008 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
9009 msgid "many types of Un*x and Linux binary"
9014 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
9015 msgid "many types of Un*x and Linux shared library"
9020 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
9021 msgid "Windows Win32 and Win64 binaries"
9026 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
9027 msgid "Windows Win32 and Win64 DLLs"
9032 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
9033 msgid "Win32 binaries and DLLs return C<i386>."
9038 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
9039 msgid "Win64 binaries and DLLs return C<x86_64>."
9044 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
9045 msgid "Linux kernel modules"
9050 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
9051 msgid "Linux new-style initrd images"
9056 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
9057 msgid "some non-x86 Linux vmlinuz kernels"
9062 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
9063 msgid "What it can't do currently:"
9068 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
9069 msgid "static libraries (libfoo.a)"
9074 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
9075 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9080 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
9081 msgid "x86 Linux vmlinuz kernels"
9086 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
9088 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9089 "compressed code, and are horribly hard to unpack. If you want to find the "
9090 "architecture of a kernel, use the architecture of the associated initrd or "
9091 "kernel module(s) instead."
9096 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812
9097 #: ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2510
9098 #: ../src/guestfs-actions.pod:2591 ../src/guestfs-actions.pod:2617
9099 #: ../src/guestfs-actions.pod:2666 ../src/guestfs-actions.pod:2687
9100 #: ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:2808
9101 #: ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:3043
9102 #: ../src/guestfs-actions.pod:3175
9103 msgid "(Added in 1.5.3)"
9108 #: ../src/guestfs-actions.pod:1651
9109 msgid "guestfs_filesize"
9114 #: ../src/guestfs-actions.pod:1653
9118 " guestfs_filesize (guestfs_h *g,\n"
9119 " const char *file);\n"
9125 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
9126 msgid "This command returns the size of C<file> in bytes."
9131 #: ../src/guestfs-actions.pod:1659
9133 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9134 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9135 "devices, use C<guestfs_blockdev_getsize64>."
9140 #: ../src/guestfs-actions.pod:1665
9141 msgid "(Added in 1.0.82)"
9146 #: ../src/guestfs-actions.pod:1667
9147 msgid "guestfs_fill"
9152 #: ../src/guestfs-actions.pod:1669
9156 " guestfs_fill (guestfs_h *g,\n"
9159 " const char *path);\n"
9165 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
9167 "This command creates a new file called C<path>. The initial content of the "
9168 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
9174 #: ../src/guestfs-actions.pod:1679
9176 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9177 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9178 "bytes use C<guestfs_fill_pattern>."
9183 #: ../src/guestfs-actions.pod:1691
9184 msgid "(Added in 1.0.79)"
9189 #: ../src/guestfs-actions.pod:1693
9190 msgid "guestfs_fill_pattern"
9195 #: ../src/guestfs-actions.pod:1695
9199 " guestfs_fill_pattern (guestfs_h *g,\n"
9200 " const char *pattern,\n"
9202 " const char *path);\n"
9208 #: ../src/guestfs-actions.pod:1701
9210 "This function is like C<guestfs_fill> except that it creates a new file of "
9211 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9212 "pattern is truncated if necessary to ensure the length of the file is "
9213 "exactly C<len> bytes."
9218 #: ../src/guestfs-actions.pod:1713
9219 msgid "(Added in 1.3.12)"
9224 #: ../src/guestfs-actions.pod:1715
9225 msgid "guestfs_find"
9230 #: ../src/guestfs-actions.pod:1717
9234 " guestfs_find (guestfs_h *g,\n"
9235 " const char *directory);\n"
9241 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
9243 "This command lists out all files and directories, recursively, starting at "
9244 "C<directory>. It is essentially equivalent to running the shell command "
9245 "C<find directory -print> but some post-processing happens on the output, "
9251 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
9253 "This returns a list of strings I<without any prefix>. Thus if the directory "
9259 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
9270 #: ../src/guestfs-actions.pod:1733
9272 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9277 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
9289 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
9290 msgid "If C<directory> is not a directory, then this command returns an error."
9295 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
9296 msgid "The returned list is sorted."
9301 #: ../src/guestfs-actions.pod:1746
9302 msgid "See also C<guestfs_find0>."
9307 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3864
9308 #: ../src/guestfs-actions.pod:5404
9309 msgid "(Added in 1.0.27)"
9314 #: ../src/guestfs-actions.pod:1757
9315 msgid "guestfs_find0"
9320 #: ../src/guestfs-actions.pod:1759
9324 " guestfs_find0 (guestfs_h *g,\n"
9325 " const char *directory,\n"
9326 " const char *files);\n"
9332 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
9334 "This command lists out all files and directories, recursively, starting at "
9335 "C<directory>, placing the resulting list in the external file called "
9341 #: ../src/guestfs-actions.pod:1768
9343 "This command works the same way as C<guestfs_find> with the following "
9349 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
9350 msgid "The resulting list is written to an external file."
9355 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
9357 "Items (filenames) in the result are separated by C<\\0> characters. See "
9358 "L<find(1)> option I<-print0>."
9363 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
9364 msgid "This command is not limited in the number of names that it can return."
9369 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
9370 msgid "The result list is not sorted."
9375 #: ../src/guestfs-actions.pod:1795
9376 msgid "(Added in 1.0.74)"
9381 #: ../src/guestfs-actions.pod:1797
9382 msgid "guestfs_findfs_label"
9387 #: ../src/guestfs-actions.pod:1799
9391 " guestfs_findfs_label (guestfs_h *g,\n"
9392 " const char *label);\n"
9398 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
9400 "This command searches the filesystems and returns the one which has the "
9401 "given label. An error is returned if no such filesystem can be found."
9406 #: ../src/guestfs-actions.pod:1807
9407 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9412 #: ../src/guestfs-actions.pod:1814
9413 msgid "guestfs_findfs_uuid"
9418 #: ../src/guestfs-actions.pod:1816
9422 " guestfs_findfs_uuid (guestfs_h *g,\n"
9423 " const char *uuid);\n"
9429 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
9431 "This command searches the filesystems and returns the one which has the "
9432 "given UUID. An error is returned if no such filesystem can be found."
9437 #: ../src/guestfs-actions.pod:1824
9438 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9443 #: ../src/guestfs-actions.pod:1831
9444 msgid "guestfs_fsck"
9449 #: ../src/guestfs-actions.pod:1833
9453 " guestfs_fsck (guestfs_h *g,\n"
9454 " const char *fstype,\n"
9455 " const char *device);\n"
9461 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
9463 "This runs the filesystem checker (fsck) on C<device> which should have "
9464 "filesystem type C<fstype>."
9469 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
9471 "The returned integer is the status. See L<fsck(8)> for the list of status "
9472 "codes from C<fsck>."
9477 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
9478 msgid "Multiple status codes can be summed together."
9483 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
9485 "A non-zero return code can mean \"success\", for example if errors have been "
9486 "corrected on the filesystem."
9491 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
9492 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9497 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
9499 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9504 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:7051
9505 msgid "(Added in 1.0.16)"
9510 #: ../src/guestfs-actions.pod:1870
9511 msgid "guestfs_get_append"
9516 #: ../src/guestfs-actions.pod:1872
9520 " guestfs_get_append (guestfs_h *g);\n"
9526 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
9528 "Return the additional kernel options which are added to the guest kernel "
9534 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
9535 msgid "If C<NULL> then no options are added."
9540 #: ../src/guestfs-actions.pod:1880
9542 "This function returns a string which may be NULL. There is no way to return "
9543 "an error from this function. The string is owned by the guest handle and "
9544 "must I<not> be freed."
9549 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:5082
9550 #: ../src/guestfs-actions.pod:5545 ../src/guestfs-actions.pod:5913
9551 #: ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:5948
9552 #: ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6722
9553 #: ../src/guestfs-actions.pod:6740 ../src/guestfs-actions.pod:7094
9554 msgid "(Added in 1.0.26)"
9559 #: ../src/guestfs-actions.pod:1886
9560 msgid "guestfs_get_autosync"
9565 #: ../src/guestfs-actions.pod:1888
9569 " guestfs_get_autosync (guestfs_h *g);\n"
9575 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
9576 msgid "Get the autosync flag."
9581 #: ../src/guestfs-actions.pod:1897
9582 msgid "guestfs_get_direct"
9587 #: ../src/guestfs-actions.pod:1899
9591 " guestfs_get_direct (guestfs_h *g);\n"
9597 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
9598 msgid "Return the direct appliance mode flag."
9603 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5586
9604 msgid "(Added in 1.0.72)"
9609 #: ../src/guestfs-actions.pod:1908
9610 msgid "guestfs_get_e2label"
9615 #: ../src/guestfs-actions.pod:1910
9619 " guestfs_get_e2label (guestfs_h *g,\n"
9620 " const char *device);\n"
9626 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
9628 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9632 #: ../src/guestfs-actions.pod:1920
9634 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
9640 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948
9641 #: ../src/guestfs-actions.pod:5604 ../src/guestfs-actions.pod:5623
9642 msgid "(Added in 1.0.15)"
9647 #: ../src/guestfs-actions.pod:1929
9648 msgid "guestfs_get_e2uuid"
9653 #: ../src/guestfs-actions.pod:1931
9657 " guestfs_get_e2uuid (guestfs_h *g,\n"
9658 " const char *device);\n"
9664 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
9666 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9670 #: ../src/guestfs-actions.pod:1941
9672 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
9678 #: ../src/guestfs-actions.pod:1950
9679 msgid "guestfs_get_memsize"
9684 #: ../src/guestfs-actions.pod:1952
9688 " guestfs_get_memsize (guestfs_h *g);\n"
9694 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
9696 "This gets the memory size in megabytes allocated to the qemu subprocess."
9701 #: ../src/guestfs-actions.pod:1958
9703 "If C<guestfs_set_memsize> was not called on this handle, and if "
9704 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9705 "value for memsize."
9710 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043
9711 #: ../src/guestfs-actions.pod:5639 ../src/guestfs-actions.pod:5746
9712 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
9713 #: ../fish/guestfish-actions.pod:3766 ../fish/guestfish-actions.pod:3853
9715 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9720 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4155
9721 #: ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4359
9722 #: ../src/guestfs-actions.pod:4378 ../src/guestfs-actions.pod:4390
9723 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4420
9724 #: ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5644
9725 #: ../src/guestfs-actions.pod:5887 ../src/guestfs-actions.pod:6488
9726 msgid "(Added in 1.0.55)"
9731 #: ../src/guestfs-actions.pod:1969
9732 msgid "guestfs_get_network"
9737 #: ../src/guestfs-actions.pod:1971
9741 " guestfs_get_network (guestfs_h *g);\n"
9747 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
9748 msgid "This returns the enable network flag."
9753 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5663
9754 msgid "(Added in 1.5.4)"
9759 #: ../src/guestfs-actions.pod:1980
9760 msgid "guestfs_get_path"
9765 #: ../src/guestfs-actions.pod:1982
9769 " guestfs_get_path (guestfs_h *g);\n"
9775 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
9776 msgid "Return the current search path."
9781 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
9783 "This is always non-NULL. If it wasn't set already, then this will return "
9789 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
9791 "This function returns a string, or NULL on error. The string is owned by "
9792 "the guest handle and must I<not> be freed."
9797 #: ../src/guestfs-actions.pod:1995
9798 msgid "guestfs_get_pid"
9803 #: ../src/guestfs-actions.pod:1997
9807 " guestfs_get_pid (guestfs_h *g);\n"
9813 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
9815 "Return the process ID of the qemu subprocess. If there is no qemu "
9816 "subprocess, then this will return an error."
9821 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
9822 msgid "This is an internal call used for debugging and testing."
9827 #: ../src/guestfs-actions.pod:2007
9828 msgid "(Added in 1.0.56)"
9833 #: ../src/guestfs-actions.pod:2009
9834 msgid "guestfs_get_qemu"
9839 #: ../src/guestfs-actions.pod:2011
9843 " guestfs_get_qemu (guestfs_h *g);\n"
9849 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
9850 msgid "Return the current qemu binary."
9855 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
9857 "This is always non-NULL. If it wasn't set already, then this will return "
9858 "the default qemu binary name."
9863 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5708
9864 msgid "(Added in 1.0.6)"
9869 #: ../src/guestfs-actions.pod:2024
9870 msgid "guestfs_get_recovery_proc"
9875 #: ../src/guestfs-actions.pod:2026
9879 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9885 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
9886 msgid "Return the recovery process enabled flag."
9891 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3265
9892 #: ../src/guestfs-actions.pod:3562 ../src/guestfs-actions.pod:3962
9893 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:5012
9894 #: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5732
9895 #: ../src/guestfs-actions.pod:6391 ../src/guestfs-actions.pod:6411
9896 #: ../src/guestfs-actions.pod:6603
9897 msgid "(Added in 1.0.77)"
9902 #: ../src/guestfs-actions.pod:2035
9903 msgid "guestfs_get_selinux"
9908 #: ../src/guestfs-actions.pod:2037
9912 " guestfs_get_selinux (guestfs_h *g);\n"
9918 #: ../src/guestfs-actions.pod:2040
9920 "This returns the current setting of the selinux flag which is passed to the "
9921 "appliance at boot time. See C<guestfs_set_selinux>."
9926 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111
9927 #: ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5805
9928 msgid "(Added in 1.0.67)"
9933 #: ../src/guestfs-actions.pod:2050
9934 msgid "guestfs_get_state"
9939 #: ../src/guestfs-actions.pod:2052
9943 " guestfs_get_state (guestfs_h *g);\n"
9949 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
9951 "This returns the current state as an opaque integer. This is only useful "
9952 "for printing debug and internal error messages."
9957 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3068
9958 #: ../src/guestfs-actions.pod:3097 ../src/guestfs-actions.pod:3158
9959 #: ../src/guestfs-actions.pod:3185 ../fish/guestfish-actions.pod:1398
9960 #: ../fish/guestfish-actions.pod:2137 ../fish/guestfish-actions.pod:2155
9961 #: ../fish/guestfish-actions.pod:2193 ../fish/guestfish-actions.pod:2209
9962 msgid "For more information on states, see L<guestfs(3)>."
9967 #: ../src/guestfs-actions.pod:2064
9968 msgid "guestfs_get_trace"
9973 #: ../src/guestfs-actions.pod:2066
9977 " guestfs_get_trace (guestfs_h *g);\n"
9983 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
9984 msgid "Return the command trace flag."
9989 #: ../src/guestfs-actions.pod:2075
9990 msgid "guestfs_get_umask"
9995 #: ../src/guestfs-actions.pod:2077
9999 " guestfs_get_umask (guestfs_h *g);\n"
10005 #: ../src/guestfs-actions.pod:2080
10007 "Return the current umask. By default the umask is C<022> unless it has been "
10008 "set by calling C<guestfs_umask>."
10013 #: ../src/guestfs-actions.pod:2087
10014 msgid "guestfs_get_verbose"
10019 #: ../src/guestfs-actions.pod:2089
10023 " guestfs_get_verbose (guestfs_h *g);\n"
10029 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
10030 msgid "This returns the verbose messages flag."
10035 #: ../src/guestfs-actions.pod:2098
10036 msgid "guestfs_getcon"
10041 #: ../src/guestfs-actions.pod:2100
10045 " guestfs_getcon (guestfs_h *g);\n"
10051 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
10052 msgid "This gets the SELinux security context of the daemon."
10057 #: ../src/guestfs-actions.pod:2105
10059 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10064 #: ../src/guestfs-actions.pod:2113
10065 msgid "guestfs_getxattr"
10070 #: ../src/guestfs-actions.pod:2115
10074 " guestfs_getxattr (guestfs_h *g,\n"
10075 " const char *path,\n"
10076 " const char *name,\n"
10077 " size_t *size_r);\n"
10083 #: ../src/guestfs-actions.pod:2121
10085 "Get a single extended attribute from file C<path> named C<name>. This call "
10086 "follows symlinks. If you want to lookup an extended attribute for the "
10087 "symlink itself, use C<guestfs_lgetxattr>."
10092 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3279
10094 "Normally it is better to get all extended attributes from a file in one go "
10095 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10096 "implementations are buggy and do not provide a way to list out attributes. "
10097 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10098 "extended attributes you want in advance and call this function."
10103 #: ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:3286
10104 #: ../fish/guestfish-actions.pod:1443 ../fish/guestfish-actions.pod:2274
10106 "Extended attribute values are blobs of binary data. If there is no extended "
10107 "attribute named C<name>, this returns an error."
10112 #: ../src/guestfs-actions.pod:2135
10113 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10118 #: ../src/guestfs-actions.pod:2137 ../src/guestfs-actions.pod:2328
10119 #: ../src/guestfs-actions.pod:3291 ../src/guestfs-actions.pod:5005
10120 #: ../src/guestfs-actions.pod:5031 ../src/guestfs-actions.pod:5212
10122 "This function returns a buffer, or NULL on error. The size of the returned "
10123 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
10128 #: ../src/guestfs-actions.pod:2141 ../src/guestfs-actions.pod:3295
10129 msgid "(Added in 1.7.24)"
10134 #: ../src/guestfs-actions.pod:2143
10135 msgid "guestfs_getxattrs"
10140 #: ../src/guestfs-actions.pod:2145
10143 " struct guestfs_xattr_list *\n"
10144 " guestfs_getxattrs (guestfs_h *g,\n"
10145 " const char *path);\n"
10151 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1452
10153 "This call lists the extended attributes of the file or directory C<path>."
10158 #: ../src/guestfs-actions.pod:2152 ../fish/guestfish-actions.pod:1455
10160 "At the system call level, this is a combination of the L<listxattr(2)> and "
10161 "L<getxattr(2)> calls."
10166 #: ../src/guestfs-actions.pod:2155
10167 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10172 #: ../src/guestfs-actions.pod:2157 ../src/guestfs-actions.pod:3307
10173 #: ../src/guestfs-actions.pod:3958
10175 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
10176 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10181 #: ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:3311
10182 #: ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3512
10183 #: ../src/guestfs-actions.pod:5385 ../src/guestfs-actions.pod:5824
10184 #: ../src/guestfs-actions.pod:7159
10185 msgid "(Added in 1.0.59)"
10190 #: ../src/guestfs-actions.pod:2163
10191 msgid "guestfs_glob_expand"
10196 #: ../src/guestfs-actions.pod:2165
10200 " guestfs_glob_expand (guestfs_h *g,\n"
10201 " const char *pattern);\n"
10207 #: ../src/guestfs-actions.pod:2169 ../fish/guestfish-actions.pod:1464
10209 "This command searches for all the pathnames matching C<pattern> according to "
10210 "the wildcard expansion rules used by the shell."
10215 #: ../src/guestfs-actions.pod:2173 ../fish/guestfish-actions.pod:1468
10217 "If no paths match, then this returns an empty list (note: not an error)."
10222 #: ../src/guestfs-actions.pod:2176 ../fish/guestfish-actions.pod:1471
10224 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
10225 "GLOB_BRACE>. See that manual page for more details."
10230 #: ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:5989
10231 #: ../src/guestfs-actions.pod:6006
10232 msgid "(Added in 1.0.50)"
10237 #: ../src/guestfs-actions.pod:2186
10238 msgid "guestfs_grep"
10243 #: ../src/guestfs-actions.pod:2188
10247 " guestfs_grep (guestfs_h *g,\n"
10248 " const char *regex,\n"
10249 " const char *path);\n"
10255 #: ../src/guestfs-actions.pod:2193 ../fish/guestfish-actions.pod:1479
10256 msgid "This calls the external C<grep> program and returns the matching lines."
10261 #: ../src/guestfs-actions.pod:2205
10262 msgid "guestfs_grepi"
10267 #: ../src/guestfs-actions.pod:2207
10271 " guestfs_grepi (guestfs_h *g,\n"
10272 " const char *regex,\n"
10273 " const char *path);\n"
10279 #: ../src/guestfs-actions.pod:2212 ../fish/guestfish-actions.pod:1489
10281 "This calls the external C<grep -i> program and returns the matching lines."
10286 #: ../src/guestfs-actions.pod:2224
10287 msgid "guestfs_grub_install"
10292 #: ../src/guestfs-actions.pod:2226
10296 " guestfs_grub_install (guestfs_h *g,\n"
10297 " const char *root,\n"
10298 " const char *device);\n"
10304 #: ../src/guestfs-actions.pod:2231 ../fish/guestfish-actions.pod:1499
10306 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
10307 "the root directory being C<root>."
10312 #: ../src/guestfs-actions.pod:2234 ../fish/guestfish-actions.pod:1502
10314 "Note: If grub-install reports the error \"No suitable drive was found in the "
10315 "generated device map.\" it may be that you need to create a C</boot/grub/"
10316 "device.map> file first that contains the mapping between grub device names "
10317 "and Linux device names. It is usually sufficient to create a file "
10323 #: ../src/guestfs-actions.pod:2241 ../fish/guestfish-actions.pod:1509
10326 " (hd0) /dev/vda\n"
10332 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1511
10333 msgid "replacing C</dev/vda> with the name of the installation device."
10338 #: ../src/guestfs-actions.pod:2247
10339 msgid "(Added in 1.0.17)"
10344 #: ../src/guestfs-actions.pod:2249
10345 msgid "guestfs_head"
10350 #: ../src/guestfs-actions.pod:2251
10354 " guestfs_head (guestfs_h *g,\n"
10355 " const char *path);\n"
10361 #: ../src/guestfs-actions.pod:2255 ../fish/guestfish-actions.pod:1517
10363 "This command returns up to the first 10 lines of a file as a list of strings."
10368 #: ../src/guestfs-actions.pod:2267
10369 msgid "guestfs_head_n"
10374 #: ../src/guestfs-actions.pod:2269
10378 " guestfs_head_n (guestfs_h *g,\n"
10380 " const char *path);\n"
10386 #: ../src/guestfs-actions.pod:2274 ../fish/guestfish-actions.pod:1527
10388 "If the parameter C<nrlines> is a positive number, this returns the first "
10389 "C<nrlines> lines of the file C<path>."
10394 #: ../src/guestfs-actions.pod:2277 ../fish/guestfish-actions.pod:1530
10396 "If the parameter C<nrlines> is a negative number, this returns lines from "
10397 "the file C<path>, excluding the last C<nrlines> lines."
10402 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:6286
10403 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:4199
10404 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10409 #: ../src/guestfs-actions.pod:2291
10410 msgid "guestfs_hexdump"
10415 #: ../src/guestfs-actions.pod:2293
10419 " guestfs_hexdump (guestfs_h *g,\n"
10420 " const char *path);\n"
10426 #: ../src/guestfs-actions.pod:2297 ../fish/guestfish-actions.pod:1542
10428 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10429 "readable, canonical hex dump of the file."
10434 #: ../src/guestfs-actions.pod:2306 ../src/guestfs-actions.pod:6070
10435 #: ../src/guestfs-actions.pod:6125
10436 msgid "(Added in 1.0.22)"
10441 #: ../src/guestfs-actions.pod:2308
10442 msgid "guestfs_initrd_cat"
10447 #: ../src/guestfs-actions.pod:2310
10451 " guestfs_initrd_cat (guestfs_h *g,\n"
10452 " const char *initrdpath,\n"
10453 " const char *filename,\n"
10454 " size_t *size_r);\n"
10460 #: ../src/guestfs-actions.pod:2316 ../fish/guestfish-actions.pod:1552
10462 "This command unpacks the file C<filename> from the initrd file called "
10463 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10469 #: ../src/guestfs-actions.pod:2320 ../fish/guestfish-actions.pod:1556
10471 "For example, in guestfish you could use the following command to examine the "
10472 "boot script (usually called C</init>) contained in a Linux initrd or "
10478 #: ../src/guestfs-actions.pod:2324 ../fish/guestfish-actions.pod:1560
10481 " initrd-cat /boot/initrd-<version>.img init\n"
10487 #: ../src/guestfs-actions.pod:2326
10488 msgid "See also C<guestfs_initrd_list>."
10493 #: ../src/guestfs-actions.pod:2337
10494 msgid "guestfs_initrd_list"
10499 #: ../src/guestfs-actions.pod:2339
10503 " guestfs_initrd_list (guestfs_h *g,\n"
10504 " const char *path);\n"
10510 #: ../src/guestfs-actions.pod:2343 ../fish/guestfish-actions.pod:1571
10511 msgid "This command lists out files contained in an initrd."
10516 #: ../src/guestfs-actions.pod:2345 ../fish/guestfish-actions.pod:1573
10518 "The files are listed without any initial C</> character. The files are "
10519 "listed in the order they appear (not necessarily alphabetical). Directory "
10520 "names are listed as separate items."
10525 #: ../src/guestfs-actions.pod:2349 ../fish/guestfish-actions.pod:1577
10527 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10528 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10534 #: ../src/guestfs-actions.pod:2359
10535 msgid "guestfs_inotify_add_watch"
10540 #: ../src/guestfs-actions.pod:2361
10544 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10545 " const char *path,\n"
10552 #: ../src/guestfs-actions.pod:2366 ../fish/guestfish-actions.pod:1585
10553 msgid "Watch C<path> for the events listed in C<mask>."
10558 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1587
10560 "Note that if C<path> is a directory then events within that directory are "
10561 "watched, but this does I<not> happen recursively (in subdirectories)."
10566 #: ../src/guestfs-actions.pod:2372 ../fish/guestfish-actions.pod:1591
10568 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10569 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10574 #: ../src/guestfs-actions.pod:2380
10575 msgid "guestfs_inotify_close"
10580 #: ../src/guestfs-actions.pod:2382
10584 " guestfs_inotify_close (guestfs_h *g);\n"
10590 #: ../src/guestfs-actions.pod:2385 ../fish/guestfish-actions.pod:1599
10592 "This closes the inotify handle which was previously opened by inotify_init. "
10593 "It removes all watches, throws away any pending events, and deallocates all "
10599 #: ../src/guestfs-actions.pod:2393
10600 msgid "guestfs_inotify_files"
10605 #: ../src/guestfs-actions.pod:2395
10609 " guestfs_inotify_files (guestfs_h *g);\n"
10615 #: ../src/guestfs-actions.pod:2398
10617 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
10618 "returns a list of pathnames of objects that were touched. The returned "
10619 "pathnames are sorted and deduplicated."
10624 #: ../src/guestfs-actions.pod:2408
10625 msgid "guestfs_inotify_init"
10630 #: ../src/guestfs-actions.pod:2410
10634 " guestfs_inotify_init (guestfs_h *g,\n"
10635 " int maxevents);\n"
10641 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1615
10643 "This command creates a new inotify handle. The inotify subsystem can be "
10644 "used to notify events which happen to objects in the guest filesystem."
10649 #: ../src/guestfs-actions.pod:2418
10651 "C<maxevents> is the maximum number of events which will be queued up between "
10652 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10653 "passed as C<0>, then the kernel (or previously set) default is used. For "
10654 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10655 "throws away events, but records the fact that it threw them away by setting "
10656 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10657 "C<guestfs_inotify_read>)."
10662 #: ../src/guestfs-actions.pod:2428
10664 "Before any events are generated, you have to add some watches to the "
10665 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10666 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10671 #: ../src/guestfs-actions.pod:2434
10673 "Queued up events should be read periodically by calling "
10674 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
10675 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10676 "often enough then you risk the internal queue overflowing."
10681 #: ../src/guestfs-actions.pod:2441
10683 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10684 "This also removes any watches automatically."
10689 #: ../src/guestfs-actions.pod:2445 ../fish/guestfish-actions.pod:1646
10691 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10692 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10693 "that there is one global inotify handle per libguestfs instance."
10698 #: ../src/guestfs-actions.pod:2454
10699 msgid "guestfs_inotify_read"
10704 #: ../src/guestfs-actions.pod:2456
10707 " struct guestfs_inotify_event_list *\n"
10708 " guestfs_inotify_read (guestfs_h *g);\n"
10714 #: ../src/guestfs-actions.pod:2459 ../fish/guestfish-actions.pod:1655
10716 "Return the complete queue of events that have happened since the previous "
10722 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1658
10723 msgid "If no events have happened, this returns an empty list."
10728 #: ../src/guestfs-actions.pod:2464 ../fish/guestfish-actions.pod:1660
10730 "I<Note>: In order to make sure that all events have been read, you must call "
10731 "this function repeatedly until it returns an empty list. The reason is that "
10732 "the call will read events up to the maximum appliance-to-host message size "
10733 "and leave remaining events in the queue."
10738 #: ../src/guestfs-actions.pod:2470
10740 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10741 "there was an error. I<The caller must call "
10742 "C<guestfs_free_inotify_event_list> after use>."
10747 #: ../src/guestfs-actions.pod:2476
10748 msgid "guestfs_inotify_rm_watch"
10753 #: ../src/guestfs-actions.pod:2478
10757 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10764 #: ../src/guestfs-actions.pod:2482
10766 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
10771 #: ../src/guestfs-actions.pod:2489
10772 msgid "guestfs_inspect_get_arch"
10777 #: ../src/guestfs-actions.pod:2491
10781 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10782 " const char *root);\n"
10788 #: ../src/guestfs-actions.pod:2495 ../src/guestfs-actions.pod:2518
10789 #: ../src/guestfs-actions.pod:2599 ../src/guestfs-actions.pod:2625
10790 #: ../src/guestfs-actions.pod:2647 ../src/guestfs-actions.pod:2674
10791 #: ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2732
10792 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2792
10793 #: ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:2878
10794 #: ../src/guestfs-actions.pod:2901
10796 "This function should only be called with a root device string as returned by "
10797 "C<guestfs_inspect_os>."
10802 #: ../src/guestfs-actions.pod:2498
10804 "This returns the architecture of the inspected operating system. The "
10805 "possible return values are listed under C<guestfs_file_architecture>."
10810 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1684
10812 "If the architecture could not be determined, then the string C<unknown> is "
10818 #: ../src/guestfs-actions.pod:2505 ../src/guestfs-actions.pod:2586
10819 #: ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2662
10820 #: ../src/guestfs-actions.pod:2748 ../src/guestfs-actions.pod:2779
10821 #: ../src/guestfs-actions.pod:2803 ../src/guestfs-actions.pod:2822
10822 #: ../src/guestfs-actions.pod:2865 ../src/guestfs-actions.pod:2888
10823 #: ../src/guestfs-actions.pod:2994 ../src/guestfs-actions.pod:3035
10824 #: ../fish/guestfish-actions.pod:1687 ../fish/guestfish-actions.pod:1761
10825 #: ../fish/guestfish-actions.pod:1794 ../fish/guestfish-actions.pod:1815
10826 #: ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1903
10827 #: ../fish/guestfish-actions.pod:1920 ../fish/guestfish-actions.pod:1933
10828 #: ../fish/guestfish-actions.pod:1968 ../fish/guestfish-actions.pod:1984
10829 #: ../fish/guestfish-actions.pod:2083 ../fish/guestfish-actions.pod:2117
10830 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10835 #: ../src/guestfs-actions.pod:2512
10836 msgid "guestfs_inspect_get_distro"
10841 #: ../src/guestfs-actions.pod:2514
10845 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10846 " const char *root);\n"
10852 #: ../src/guestfs-actions.pod:2521 ../fish/guestfish-actions.pod:1696
10854 "This returns the distro (distribution) of the inspected operating system."
10859 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1699
10860 msgid "Currently defined distros are:"
10865 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1703
10866 msgid "\"archlinux\""
10871 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1705
10872 msgid "Arch Linux."
10877 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1707
10883 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1709
10889 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1711
10895 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1713
10901 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1715
10907 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1717
10913 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1719
10914 msgid "\"linuxmint\""
10919 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1721
10920 msgid "Linux Mint."
10925 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1723
10926 msgid "\"mandriva\""
10931 #: ../src/guestfs-actions.pod:2550 ../fish/guestfish-actions.pod:1725
10937 #: ../src/guestfs-actions.pod:2552 ../fish/guestfish-actions.pod:1727
10943 #: ../src/guestfs-actions.pod:2554 ../fish/guestfish-actions.pod:1729
10949 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1731
10955 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1733
10961 #: ../src/guestfs-actions.pod:2560 ../fish/guestfish-actions.pod:1735
10962 msgid "\"redhat-based\""
10967 #: ../src/guestfs-actions.pod:2562 ../fish/guestfish-actions.pod:1737
10968 msgid "Some Red Hat-derived distro."
10973 #: ../src/guestfs-actions.pod:2564 ../fish/guestfish-actions.pod:1739
10979 #: ../src/guestfs-actions.pod:2566 ../fish/guestfish-actions.pod:1741
10980 msgid "Red Hat Enterprise Linux and some derivatives."
10985 #: ../src/guestfs-actions.pod:2568 ../fish/guestfish-actions.pod:1743
10991 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1745
10997 #: ../src/guestfs-actions.pod:2572 ../src/guestfs-actions.pod:2856
10998 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1959
10999 msgid "\"unknown\""
11004 #: ../src/guestfs-actions.pod:2574 ../fish/guestfish-actions.pod:1749
11005 msgid "The distro could not be determined."
11010 #: ../src/guestfs-actions.pod:2576 ../src/guestfs-actions.pod:2848
11011 #: ../fish/guestfish-actions.pod:1751 ../fish/guestfish-actions.pod:1951
11012 msgid "\"windows\""
11017 #: ../src/guestfs-actions.pod:2578 ../fish/guestfish-actions.pod:1753
11019 "Windows does not have distributions. This string is returned if the OS type "
11025 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2862
11026 #: ../fish/guestfish-actions.pod:1758 ../fish/guestfish-actions.pod:1965
11028 "Future versions of libguestfs may return other strings here. The caller "
11029 "should be prepared to handle any string."
11034 #: ../src/guestfs-actions.pod:2593
11035 msgid "guestfs_inspect_get_filesystems"
11040 #: ../src/guestfs-actions.pod:2595
11044 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11045 " const char *root);\n"
11051 #: ../src/guestfs-actions.pod:2602 ../fish/guestfish-actions.pod:1770
11053 "This returns a list of all the filesystems that we think are associated with "
11054 "this operating system. This includes the root filesystem, other ordinary "
11055 "filesystems, and non-mounted devices like swap partitions."
11060 #: ../src/guestfs-actions.pod:2607 ../fish/guestfish-actions.pod:1775
11062 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
11063 "to be shared between operating systems."
11068 #: ../src/guestfs-actions.pod:2610
11070 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11071 "C<guestfs_inspect_get_mountpoints>."
11076 #: ../src/guestfs-actions.pod:2619
11077 msgid "guestfs_inspect_get_hostname"
11082 #: ../src/guestfs-actions.pod:2621
11086 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11087 " const char *root);\n"
11093 #: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:1788
11095 "This function returns the hostname of the operating system as found by "
11096 "inspection of the guest's configuration files."
11101 #: ../src/guestfs-actions.pod:2631 ../fish/guestfish-actions.pod:1791
11103 "If the hostname could not be determined, then the string C<unknown> is "
11109 #: ../src/guestfs-actions.pod:2639
11110 msgid "(Added in 1.7.9)"
11115 #: ../src/guestfs-actions.pod:2641
11116 msgid "guestfs_inspect_get_major_version"
11121 #: ../src/guestfs-actions.pod:2643
11125 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11126 " const char *root);\n"
11132 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1803
11134 "This returns the major version number of the inspected operating system."
11139 #: ../src/guestfs-actions.pod:2653 ../fish/guestfish-actions.pod:1806
11141 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
11142 "popular public names used by the operating system. Notably the operating "
11143 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11144 "1). You can find out the real versions corresponding to releases of Windows "
11145 "by consulting Wikipedia or MSDN."
11150 #: ../src/guestfs-actions.pod:2660 ../src/guestfs-actions.pod:2680
11151 #: ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1827
11152 msgid "If the version could not be determined, then C<0> is returned."
11157 #: ../src/guestfs-actions.pod:2668
11158 msgid "guestfs_inspect_get_minor_version"
11163 #: ../src/guestfs-actions.pod:2670
11167 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11168 " const char *root);\n"
11174 #: ../src/guestfs-actions.pod:2677 ../fish/guestfish-actions.pod:1824
11176 "This returns the minor version number of the inspected operating system."
11181 #: ../src/guestfs-actions.pod:2682
11183 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11184 "C<guestfs_inspect_get_major_version>."
11189 #: ../src/guestfs-actions.pod:2689
11190 msgid "guestfs_inspect_get_mountpoints"
11195 #: ../src/guestfs-actions.pod:2691
11199 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11200 " const char *root);\n"
11205 #: ../src/guestfs-actions.pod:2698 ../fish/guestfish-actions.pod:1839
11207 "This returns a hash of where we think the filesystems associated with this "
11208 "operating system should be mounted. Callers should note that this is at "
11209 "best an educated guess made by reading configuration files such as C</etc/"
11210 "fstab>. I<In particular note> that this may return filesystems which are "
11211 "non-existent or not mountable and callers should be prepared to handle or "
11212 "ignore failures if they try to mount them."
11217 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
11219 "Each element in the returned hashtable has a key which is the path of the "
11220 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11221 "mounted there (eg. C</dev/sda1>)."
11226 #: ../src/guestfs-actions.pod:2712 ../fish/guestfish-actions.pod:1853
11228 "Non-mounted devices such as swap devices are I<not> returned in this list."
11233 #: ../src/guestfs-actions.pod:2715
11235 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11236 "C<guestfs_inspect_get_filesystems>."
11241 #: ../src/guestfs-actions.pod:2718 ../src/guestfs-actions.pod:3364
11242 #: ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:6427
11244 "This function returns a NULL-terminated array of strings, or NULL if there "
11245 "was an error. The array of strings will always have length C<2n+1>, where "
11246 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11247 "caller must free the strings and the array after use>."
11252 #: ../src/guestfs-actions.pod:2726
11253 msgid "guestfs_inspect_get_package_format"
11258 #: ../src/guestfs-actions.pod:2728
11262 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11263 " const char *root);\n"
11269 #: ../src/guestfs-actions.pod:2735
11271 "This function and C<guestfs_inspect_get_package_management> return the "
11272 "package format and package management tool used by the inspected operating "
11273 "system. For example for Fedora these functions would return C<rpm> (package "
11274 "format) and C<yum> (package management)."
11279 #: ../src/guestfs-actions.pod:2741 ../fish/guestfish-actions.pod:1872
11281 "This returns the string C<unknown> if we could not determine the package "
11282 "format I<or> if the operating system does not have a real packaging system "
11288 #: ../src/guestfs-actions.pod:2745 ../fish/guestfish-actions.pod:1876
11290 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11291 "Future versions of libguestfs may return other strings."
11296 #: ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:2784
11297 msgid "(Added in 1.7.5)"
11302 #: ../src/guestfs-actions.pod:2755
11303 msgid "guestfs_inspect_get_package_management"
11308 #: ../src/guestfs-actions.pod:2757
11312 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11313 " const char *root);\n"
11319 #: ../src/guestfs-actions.pod:2764
11321 "C<guestfs_inspect_get_package_format> and this function return the package "
11322 "format and package management tool used by the inspected operating system. "
11323 "For example for Fedora these functions would return C<rpm> (package format) "
11324 "and C<yum> (package management)."
11329 #: ../src/guestfs-actions.pod:2770 ../fish/guestfish-actions.pod:1894
11331 "This returns the string C<unknown> if we could not determine the package "
11332 "management tool I<or> if the operating system does not have a real packaging "
11333 "system (eg. Windows)."
11338 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1898
11340 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11341 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11342 "libguestfs may return other strings."
11347 #: ../src/guestfs-actions.pod:2786
11348 msgid "guestfs_inspect_get_product_name"
11353 #: ../src/guestfs-actions.pod:2788
11357 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11358 " const char *root);\n"
11364 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1912
11366 "This returns the product name of the inspected operating system. The "
11367 "product name is generally some freeform string which can be displayed to the "
11368 "user, but should not be parsed by programs."
11373 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1917
11375 "If the product name could not be determined, then the string C<unknown> is "
11381 #: ../src/guestfs-actions.pod:2810
11382 msgid "guestfs_inspect_get_roots"
11387 #: ../src/guestfs-actions.pod:2812
11391 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11397 #: ../src/guestfs-actions.pod:2815
11399 "This function is a convenient way to get the list of root devices, as "
11400 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11401 "the whole inspection process."
11406 #: ../src/guestfs-actions.pod:2819
11408 "This returns an empty list if either no root devices were found or the "
11409 "caller has not called C<guestfs_inspect_os>."
11414 #: ../src/guestfs-actions.pod:2828
11415 msgid "(Added in 1.7.3)"
11420 #: ../src/guestfs-actions.pod:2830
11421 msgid "guestfs_inspect_get_type"
11426 #: ../src/guestfs-actions.pod:2832
11430 " guestfs_inspect_get_type (guestfs_h *g,\n"
11431 " const char *root);\n"
11437 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1942
11439 "This returns the type of the inspected operating system. Currently defined "
11445 #: ../src/guestfs-actions.pod:2844 ../fish/guestfish-actions.pod:1947
11451 #: ../src/guestfs-actions.pod:2846 ../fish/guestfish-actions.pod:1949
11452 msgid "Any Linux-based operating system."
11457 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1953
11458 msgid "Any Microsoft Windows operating system."
11463 #: ../src/guestfs-actions.pod:2852 ../fish/guestfish-actions.pod:1955
11464 msgid "\"freebsd\""
11469 #: ../src/guestfs-actions.pod:2854 ../fish/guestfish-actions.pod:1957
11475 #: ../src/guestfs-actions.pod:2858 ../fish/guestfish-actions.pod:1961
11476 msgid "The operating system type could not be determined."
11481 #: ../src/guestfs-actions.pod:2872
11482 msgid "guestfs_inspect_get_windows_systemroot"
11487 #: ../src/guestfs-actions.pod:2874
11491 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11492 " const char *root);\n"
11498 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1977
11500 "This returns the Windows systemroot of the inspected guest. The systemroot "
11501 "is a directory path such as C</WINDOWS>."
11506 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1980
11508 "This call assumes that the guest is Windows and that the systemroot could be "
11509 "determined by inspection. If this is not the case then an error is returned."
11514 #: ../src/guestfs-actions.pod:2893
11515 msgid "(Added in 1.5.25)"
11520 #: ../src/guestfs-actions.pod:2895
11521 msgid "guestfs_inspect_list_applications"
11526 #: ../src/guestfs-actions.pod:2897
11529 " struct guestfs_application_list *\n"
11530 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11531 " const char *root);\n"
11537 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:1993
11538 msgid "Return the list of applications installed in the operating system."
11543 #: ../src/guestfs-actions.pod:2906
11545 "I<Note:> This call works differently from other parts of the inspection "
11546 "API. You have to call C<guestfs_inspect_os>, then "
11547 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11548 "this. Listing applications is a significantly more difficult operation "
11549 "which requires access to the full filesystem. Also note that unlike the "
11550 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
11551 "the libguestfs handle, this call actually reads parts of the mounted "
11552 "filesystems during the call."
11557 #: ../src/guestfs-actions.pod:2916 ../fish/guestfish-actions.pod:2005
11559 "This returns an empty list if the inspection code was not able to determine "
11560 "the list of applications."
11565 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2008
11566 msgid "The application structure contains the following fields:"
11571 #: ../src/guestfs-actions.pod:2923 ../fish/guestfish-actions.pod:2012
11572 msgid "C<app_name>"
11577 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2014
11579 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11580 "guests, this is the package name."
11585 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2017
11586 msgid "C<app_display_name>"
11591 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2019
11593 "The display name of the application, sometimes localized to the install "
11594 "language of the guest operating system."
11599 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2022
11601 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11602 "to display something can use C<app_name> instead."
11607 #: ../src/guestfs-actions.pod:2936 ../fish/guestfish-actions.pod:2025
11608 msgid "C<app_epoch>"
11613 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2027
11615 "For package managers which use epochs, this contains the epoch of the "
11616 "package (an integer). If unavailable, this is returned as C<0>."
11621 #: ../src/guestfs-actions.pod:2941 ../fish/guestfish-actions.pod:2030
11622 msgid "C<app_version>"
11627 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2032
11629 "The version string of the application or package. If unavailable this is "
11630 "returned as an empty string C<\"\">."
11635 #: ../src/guestfs-actions.pod:2946 ../fish/guestfish-actions.pod:2035
11636 msgid "C<app_release>"
11641 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2037
11643 "The release string of the application or package, for package managers that "
11644 "use this. If unavailable this is returned as an empty string C<\"\">."
11649 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:2041
11650 msgid "C<app_install_path>"
11655 #: ../src/guestfs-actions.pod:2954 ../fish/guestfish-actions.pod:2043
11657 "The installation path of the application (on operating systems such as "
11658 "Windows which use installation paths). This path is in the format used by "
11659 "the guest operating system, it is not a libguestfs path."
11664 #: ../src/guestfs-actions.pod:2959 ../fish/guestfish-actions.pod:2048
11665 msgid "If unavailable this is returned as an empty string C<\"\">."
11670 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2050
11671 msgid "C<app_trans_path>"
11676 #: ../src/guestfs-actions.pod:2963 ../fish/guestfish-actions.pod:2052
11678 "The install path translated into a libguestfs path. If unavailable this is "
11679 "returned as an empty string C<\"\">."
11684 #: ../src/guestfs-actions.pod:2966 ../fish/guestfish-actions.pod:2055
11685 msgid "C<app_publisher>"
11690 #: ../src/guestfs-actions.pod:2968 ../fish/guestfish-actions.pod:2057
11692 "The name of the publisher of the application, for package managers that use "
11693 "this. If unavailable this is returned as an empty string C<\"\">."
11698 #: ../src/guestfs-actions.pod:2972 ../fish/guestfish-actions.pod:2061
11704 #: ../src/guestfs-actions.pod:2974 ../fish/guestfish-actions.pod:2063
11706 "The URL (eg. upstream URL) of the application. If unavailable this is "
11707 "returned as an empty string C<\"\">."
11712 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2066
11713 msgid "C<app_source_package>"
11718 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2068
11720 "For packaging systems which support this, the name of the source package. "
11721 "If unavailable this is returned as an empty string C<\"\">."
11726 #: ../src/guestfs-actions.pod:2982 ../fish/guestfish-actions.pod:2071
11727 msgid "C<app_summary>"
11732 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2073
11734 "A short (usually one line) description of the application or package. If "
11735 "unavailable this is returned as an empty string C<\"\">."
11740 #: ../src/guestfs-actions.pod:2987 ../fish/guestfish-actions.pod:2076
11741 msgid "C<app_description>"
11746 #: ../src/guestfs-actions.pod:2989 ../fish/guestfish-actions.pod:2078
11748 "A longer description of the application or package. If unavailable this is "
11749 "returned as an empty string C<\"\">."
11754 #: ../src/guestfs-actions.pod:2996
11756 "This function returns a C<struct guestfs_application_list *>, or NULL if "
11757 "there was an error. I<The caller must call C<guestfs_free_application_list> "
11763 #: ../src/guestfs-actions.pod:3000
11764 msgid "(Added in 1.7.8)"
11769 #: ../src/guestfs-actions.pod:3002
11770 msgid "guestfs_inspect_os"
11775 #: ../src/guestfs-actions.pod:3004
11779 " guestfs_inspect_os (guestfs_h *g);\n"
11785 #: ../src/guestfs-actions.pod:3007 ../fish/guestfish-actions.pod:2089
11787 "This function uses other libguestfs functions and certain heuristics to "
11788 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11789 "for operating systems."
11794 #: ../src/guestfs-actions.pod:3011 ../fish/guestfish-actions.pod:2093
11795 msgid "The list returned is empty if no operating systems were found."
11800 #: ../src/guestfs-actions.pod:3013 ../fish/guestfish-actions.pod:2095
11802 "If one operating system was found, then this returns a list with a single "
11803 "element, which is the name of the root filesystem of this operating system. "
11804 "It is also possible for this function to return a list containing more than "
11805 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11806 "element being the root filesystem of one of the operating systems."
11811 #: ../src/guestfs-actions.pod:3020
11813 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
11814 "functions in order to query further information about each operating system, "
11815 "such as the name and version."
11820 #: ../src/guestfs-actions.pod:3025
11822 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
11823 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
11824 "the contents. This should be called with no disks currently mounted. The "
11825 "function may also use Augeas, so any existing Augeas handle will be closed."
11830 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2113
11832 "This function cannot decrypt encrypted disks. The caller must do that first "
11833 "(supplying the necessary keys) if the disk is encrypted."
11838 #: ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3322
11839 #: ../src/guestfs-actions.pod:3384
11840 msgid "See also C<guestfs_list_filesystems>."
11845 #: ../src/guestfs-actions.pod:3045
11846 msgid "guestfs_is_blockdev"
11851 #: ../src/guestfs-actions.pod:3047
11855 " guestfs_is_blockdev (guestfs_h *g,\n"
11856 " const char *path);\n"
11862 #: ../src/guestfs-actions.pod:3051 ../fish/guestfish-actions.pod:2125
11864 "This returns C<true> if and only if there is a block device with the given "
11870 #: ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3083
11871 #: ../src/guestfs-actions.pod:3113 ../src/guestfs-actions.pod:3128
11872 #: ../src/guestfs-actions.pod:3144 ../src/guestfs-actions.pod:3200
11873 #: ../src/guestfs-actions.pod:3215
11874 msgid "See also C<guestfs_stat>."
11879 #: ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3087
11880 #: ../src/guestfs-actions.pod:3132 ../src/guestfs-actions.pod:3204
11881 #: ../src/guestfs-actions.pod:3219
11882 msgid "(Added in 1.5.10)"
11887 #: ../src/guestfs-actions.pod:3060
11888 msgid "guestfs_is_busy"
11893 #: ../src/guestfs-actions.pod:3062
11897 " guestfs_is_busy (guestfs_h *g);\n"
11903 #: ../src/guestfs-actions.pod:3065 ../fish/guestfish-actions.pod:2134
11905 "This returns true iff this handle is busy processing a command (in the "
11911 #: ../src/guestfs-actions.pod:3074
11912 msgid "guestfs_is_chardev"
11917 #: ../src/guestfs-actions.pod:3076
11921 " guestfs_is_chardev (guestfs_h *g,\n"
11922 " const char *path);\n"
11928 #: ../src/guestfs-actions.pod:3080 ../fish/guestfish-actions.pod:2143
11930 "This returns C<true> if and only if there is a character device with the "
11931 "given C<path> name."
11936 #: ../src/guestfs-actions.pod:3089
11937 msgid "guestfs_is_config"
11942 #: ../src/guestfs-actions.pod:3091
11946 " guestfs_is_config (guestfs_h *g);\n"
11952 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2152
11954 "This returns true iff this handle is being configured (in the C<CONFIG> "
11960 #: ../src/guestfs-actions.pod:3103
11961 msgid "guestfs_is_dir"
11966 #: ../src/guestfs-actions.pod:3105
11970 " guestfs_is_dir (guestfs_h *g,\n"
11971 " const char *path);\n"
11977 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2161
11979 "This returns C<true> if and only if there is a directory with the given "
11980 "C<path> name. Note that it returns false for other objects like files."
11985 #: ../src/guestfs-actions.pod:3119
11986 msgid "guestfs_is_fifo"
11991 #: ../src/guestfs-actions.pod:3121
11995 " guestfs_is_fifo (guestfs_h *g,\n"
11996 " const char *path);\n"
12002 #: ../src/guestfs-actions.pod:3125 ../fish/guestfish-actions.pod:2171
12004 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12005 "given C<path> name."
12010 #: ../src/guestfs-actions.pod:3134
12011 msgid "guestfs_is_file"
12016 #: ../src/guestfs-actions.pod:3136
12020 " guestfs_is_file (guestfs_h *g,\n"
12021 " const char *path);\n"
12027 #: ../src/guestfs-actions.pod:3140 ../fish/guestfish-actions.pod:2180
12029 "This returns C<true> if and only if there is a regular file with the given "
12030 "C<path> name. Note that it returns false for other objects like directories."
12035 #: ../src/guestfs-actions.pod:3150
12036 msgid "guestfs_is_launching"
12041 #: ../src/guestfs-actions.pod:3152
12045 " guestfs_is_launching (guestfs_h *g);\n"
12051 #: ../src/guestfs-actions.pod:3155 ../fish/guestfish-actions.pod:2190
12053 "This returns true iff this handle is launching the subprocess (in the "
12054 "C<LAUNCHING> state)."
12059 #: ../src/guestfs-actions.pod:3164
12060 msgid "guestfs_is_lv"
12065 #: ../src/guestfs-actions.pod:3166
12069 " guestfs_is_lv (guestfs_h *g,\n"
12070 " const char *device);\n"
12076 #: ../src/guestfs-actions.pod:3170 ../fish/guestfish-actions.pod:2199
12078 "This command tests whether C<device> is a logical volume, and returns true "
12079 "iff this is the case."
12084 #: ../src/guestfs-actions.pod:3177
12085 msgid "guestfs_is_ready"
12090 #: ../src/guestfs-actions.pod:3179
12094 " guestfs_is_ready (guestfs_h *g);\n"
12100 #: ../src/guestfs-actions.pod:3182 ../fish/guestfish-actions.pod:2206
12102 "This returns true iff this handle is ready to accept commands (in the "
12108 #: ../src/guestfs-actions.pod:3191
12109 msgid "guestfs_is_socket"
12114 #: ../src/guestfs-actions.pod:3193
12118 " guestfs_is_socket (guestfs_h *g,\n"
12119 " const char *path);\n"
12125 #: ../src/guestfs-actions.pod:3197 ../fish/guestfish-actions.pod:2215
12127 "This returns C<true> if and only if there is a Unix domain socket with the "
12128 "given C<path> name."
12133 #: ../src/guestfs-actions.pod:3206
12134 msgid "guestfs_is_symlink"
12139 #: ../src/guestfs-actions.pod:3208
12143 " guestfs_is_symlink (guestfs_h *g,\n"
12144 " const char *path);\n"
12150 #: ../src/guestfs-actions.pod:3212 ../fish/guestfish-actions.pod:2224
12152 "This returns C<true> if and only if there is a symbolic link with the given "
12158 #: ../src/guestfs-actions.pod:3221
12159 msgid "guestfs_kill_subprocess"
12164 #: ../src/guestfs-actions.pod:3223
12168 " guestfs_kill_subprocess (guestfs_h *g);\n"
12174 #: ../src/guestfs-actions.pod:3226 ../fish/guestfish-actions.pod:2233
12175 msgid "This kills the qemu subprocess. You should never need to call this."
12180 #: ../src/guestfs-actions.pod:3232
12181 msgid "guestfs_launch"
12186 #: ../src/guestfs-actions.pod:3234
12190 " guestfs_launch (guestfs_h *g);\n"
12196 #: ../src/guestfs-actions.pod:3237 ../fish/guestfish-actions.pod:2241
12198 "Internally libguestfs is implemented by running a virtual machine using "
12204 #: ../src/guestfs-actions.pod:3240 ../fish/guestfish-actions.pod:2244
12206 "You should call this after configuring the handle (eg. adding drives) but "
12207 "before performing any actions."
12212 #: ../src/guestfs-actions.pod:3247
12213 msgid "guestfs_lchown"
12218 #: ../src/guestfs-actions.pod:3249
12222 " guestfs_lchown (guestfs_h *g,\n"
12225 " const char *path);\n"
12231 #: ../src/guestfs-actions.pod:3255
12233 "Change the file owner to C<owner> and group to C<group>. This is like "
12234 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12235 "changed, not the target."
12240 #: ../src/guestfs-actions.pod:3267
12241 msgid "guestfs_lgetxattr"
12246 #: ../src/guestfs-actions.pod:3269
12250 " guestfs_lgetxattr (guestfs_h *g,\n"
12251 " const char *path,\n"
12252 " const char *name,\n"
12253 " size_t *size_r);\n"
12259 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2263
12261 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12262 "is a symlink, then this call returns an extended attribute from the symlink."
12267 #: ../src/guestfs-actions.pod:3289
12268 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12273 #: ../src/guestfs-actions.pod:3297
12274 msgid "guestfs_lgetxattrs"
12279 #: ../src/guestfs-actions.pod:3299
12282 " struct guestfs_xattr_list *\n"
12283 " guestfs_lgetxattrs (guestfs_h *g,\n"
12284 " const char *path);\n"
12290 #: ../src/guestfs-actions.pod:3303
12292 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
12293 "then it returns the extended attributes of the link itself."
12298 #: ../src/guestfs-actions.pod:3313
12299 msgid "guestfs_list_devices"
12304 #: ../src/guestfs-actions.pod:3315
12308 " guestfs_list_devices (guestfs_h *g);\n"
12314 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2291
12315 msgid "List all the block devices."
12320 #: ../src/guestfs-actions.pod:3320 ../fish/guestfish-actions.pod:2293
12321 msgid "The full block device names are returned, eg. C</dev/sda>."
12326 #: ../src/guestfs-actions.pod:3330
12327 msgid "guestfs_list_filesystems"
12332 #: ../src/guestfs-actions.pod:3332
12336 " guestfs_list_filesystems (guestfs_h *g);\n"
12342 #: ../src/guestfs-actions.pod:3335 ../fish/guestfish-actions.pod:2301
12344 "This inspection command looks for filesystems on partitions, block devices "
12345 "and logical volumes, returning a list of devices containing filesystems and "
12351 #: ../src/guestfs-actions.pod:3339 ../fish/guestfish-actions.pod:2305
12353 "The return value is a hash, where the keys are the devices containing "
12354 "filesystems, and the values are the filesystem types. For example:"
12359 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2309
12362 " \"/dev/sda1\" => \"ntfs\"\n"
12363 " \"/dev/sda2\" => \"ext2\"\n"
12364 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12365 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12371 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2314
12373 "The value can have the special value \"unknown\", meaning the content of the "
12374 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12379 #: ../src/guestfs-actions.pod:3352
12381 "This command runs other libguestfs commands, which might include "
12382 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12383 "soon after launch and only when nothing is mounted."
12388 #: ../src/guestfs-actions.pod:3356
12390 "Not all of the filesystems returned will be mountable. In particular, swap "
12391 "partitions are returned in the list. Also this command does not check that "
12392 "each filesystem found is valid and mountable, and some filesystems might be "
12393 "mountable but require special options. Filesystems may not all belong to a "
12394 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
12399 #: ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:4972
12400 msgid "(Added in 1.5.15)"
12405 #: ../src/guestfs-actions.pod:3372
12406 msgid "guestfs_list_partitions"
12411 #: ../src/guestfs-actions.pod:3374
12415 " guestfs_list_partitions (guestfs_h *g);\n"
12421 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2334
12422 msgid "List all the partitions detected on all block devices."
12427 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2336
12428 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12433 #: ../src/guestfs-actions.pod:3381
12435 "This does not return logical volumes. For that you will need to call "
12441 #: ../src/guestfs-actions.pod:3392
12447 #: ../src/guestfs-actions.pod:3394
12451 " guestfs_ll (guestfs_h *g,\n"
12452 " const char *directory);\n"
12458 #: ../src/guestfs-actions.pod:3398 ../fish/guestfish-actions.pod:2347
12460 "List the files in C<directory> (relative to the root directory, there is no "
12461 "cwd) in the format of 'ls -la'."
12466 #: ../src/guestfs-actions.pod:3401 ../fish/guestfish-actions.pod:2350
12468 "This command is mostly useful for interactive sessions. It is I<not> "
12469 "intended that you try to parse the output string."
12474 #: ../src/guestfs-actions.pod:3409
12480 #: ../src/guestfs-actions.pod:3411
12484 " guestfs_ln (guestfs_h *g,\n"
12485 " const char *target,\n"
12486 " const char *linkname);\n"
12492 #: ../src/guestfs-actions.pod:3416 ../fish/guestfish-actions.pod:2357
12493 msgid "This command creates a hard link using the C<ln> command."
12498 #: ../src/guestfs-actions.pod:3422
12499 msgid "guestfs_ln_f"
12504 #: ../src/guestfs-actions.pod:3424
12508 " guestfs_ln_f (guestfs_h *g,\n"
12509 " const char *target,\n"
12510 " const char *linkname);\n"
12516 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2363
12518 "This command creates a hard link using the C<ln -f> command. The C<-f> "
12519 "option removes the link (C<linkname>) if it exists already."
12524 #: ../src/guestfs-actions.pod:3436
12525 msgid "guestfs_ln_s"
12530 #: ../src/guestfs-actions.pod:3438
12534 " guestfs_ln_s (guestfs_h *g,\n"
12535 " const char *target,\n"
12536 " const char *linkname);\n"
12542 #: ../src/guestfs-actions.pod:3443 ../fish/guestfish-actions.pod:2370
12543 msgid "This command creates a symbolic link using the C<ln -s> command."
12548 #: ../src/guestfs-actions.pod:3449
12549 msgid "guestfs_ln_sf"
12554 #: ../src/guestfs-actions.pod:3451
12558 " guestfs_ln_sf (guestfs_h *g,\n"
12559 " const char *target,\n"
12560 " const char *linkname);\n"
12566 #: ../src/guestfs-actions.pod:3456 ../fish/guestfish-actions.pod:2376
12568 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
12569 "option removes the link (C<linkname>) if it exists already."
12574 #: ../src/guestfs-actions.pod:3463
12575 msgid "guestfs_lremovexattr"
12580 #: ../src/guestfs-actions.pod:3465
12584 " guestfs_lremovexattr (guestfs_h *g,\n"
12585 " const char *xattr,\n"
12586 " const char *path);\n"
12592 #: ../src/guestfs-actions.pod:3470
12594 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12595 "link, then it removes an extended attribute of the link itself."
12600 #: ../src/guestfs-actions.pod:3478
12606 #: ../src/guestfs-actions.pod:3480
12610 " guestfs_ls (guestfs_h *g,\n"
12611 " const char *directory);\n"
12617 #: ../src/guestfs-actions.pod:3484 ../fish/guestfish-actions.pod:2391
12619 "List the files in C<directory> (relative to the root directory, there is no "
12620 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12625 #: ../src/guestfs-actions.pod:3488
12627 "This command is mostly useful for interactive sessions. Programs should "
12628 "probably use C<guestfs_readdir> instead."
12633 #: ../src/guestfs-actions.pod:3497
12634 msgid "guestfs_lsetxattr"
12639 #: ../src/guestfs-actions.pod:3499
12643 " guestfs_lsetxattr (guestfs_h *g,\n"
12644 " const char *xattr,\n"
12645 " const char *val,\n"
12647 " const char *path);\n"
12653 #: ../src/guestfs-actions.pod:3506
12655 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12656 "then it sets an extended attribute of the link itself."
12661 #: ../src/guestfs-actions.pod:3514
12662 msgid "guestfs_lstat"
12667 #: ../src/guestfs-actions.pod:3516
12670 " struct guestfs_stat *\n"
12671 " guestfs_lstat (guestfs_h *g,\n"
12672 " const char *path);\n"
12678 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:6026
12679 #: ../fish/guestfish-actions.pod:2410 ../fish/guestfish-actions.pod:4034
12680 msgid "Returns file information for the given C<path>."
12685 #: ../src/guestfs-actions.pod:3522
12687 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12688 "link, then the link is stat-ed, not the file it refers to."
12693 #: ../src/guestfs-actions.pod:3526 ../fish/guestfish-actions.pod:2416
12694 msgid "This is the same as the C<lstat(2)> system call."
12699 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:6030
12701 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12702 "error. I<The caller must call C<guestfs_free_stat> after use>."
12707 #: ../src/guestfs-actions.pod:3532 ../src/guestfs-actions.pod:6034
12708 #: ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6433
12709 msgid "(Added in 0.9.2)"
12714 #: ../src/guestfs-actions.pod:3534
12715 msgid "guestfs_lstatlist"
12720 #: ../src/guestfs-actions.pod:3536
12723 " struct guestfs_stat_list *\n"
12724 " guestfs_lstatlist (guestfs_h *g,\n"
12725 " const char *path,\n"
12726 " char *const *names);\n"
12732 #: ../src/guestfs-actions.pod:3541
12734 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12735 "files, where all files are in the directory C<path>. C<names> is the list "
12736 "of files from this directory."
12741 #: ../src/guestfs-actions.pod:3545 ../fish/guestfish-actions.pod:2426
12743 "On return you get a list of stat structs, with a one-to-one correspondence "
12744 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12745 "then the C<ino> field of that structure is set to C<-1>."
12750 #: ../src/guestfs-actions.pod:3550
12752 "This call is intended for programs that want to efficiently list a directory "
12753 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
12754 "for a similarly efficient call for getting extended attributes. Very long "
12755 "directory listings might cause the protocol message size to be exceeded, "
12756 "causing this call to fail. The caller must split up such requests into "
12757 "smaller groups of names."
12762 #: ../src/guestfs-actions.pod:3558
12764 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
12765 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
12770 #: ../src/guestfs-actions.pod:3564
12771 msgid "guestfs_luks_add_key"
12776 #: ../src/guestfs-actions.pod:3566
12780 " guestfs_luks_add_key (guestfs_h *g,\n"
12781 " const char *device,\n"
12782 " const char *key,\n"
12783 " const char *newkey,\n"
12790 #: ../src/guestfs-actions.pod:3573 ../fish/guestfish-actions.pod:2443
12792 "This command adds a new key on LUKS device C<device>. C<key> is any "
12793 "existing key, and is used to access the device. C<newkey> is the new key to "
12794 "add. C<keyslot> is the key slot that will be replaced."
12799 #: ../src/guestfs-actions.pod:3578
12801 "Note that if C<keyslot> already contains a key, then this command will "
12802 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
12807 #: ../src/guestfs-actions.pod:3584 ../src/guestfs-actions.pod:3624
12808 #: ../src/guestfs-actions.pod:3647 ../src/guestfs-actions.pod:3667
12809 #: ../src/guestfs-actions.pod:3699 ../src/guestfs-actions.pod:3718
12811 "This function takes a key or passphrase parameter which could contain "
12812 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
12818 #: ../src/guestfs-actions.pod:3588 ../src/guestfs-actions.pod:3628
12819 #: ../src/guestfs-actions.pod:3651 ../src/guestfs-actions.pod:3671
12820 msgid "(Added in 1.5.2)"
12825 #: ../src/guestfs-actions.pod:3590
12826 msgid "guestfs_luks_close"
12831 #: ../src/guestfs-actions.pod:3592
12835 " guestfs_luks_close (guestfs_h *g,\n"
12836 " const char *device);\n"
12842 #: ../src/guestfs-actions.pod:3596
12844 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
12845 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
12846 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
12847 "underlying block device."
12852 #: ../src/guestfs-actions.pod:3604 ../src/guestfs-actions.pod:3703
12853 #: ../src/guestfs-actions.pod:3722 ../src/guestfs-actions.pod:3772
12854 #: ../src/guestfs-actions.pod:3820
12855 msgid "(Added in 1.5.1)"
12860 #: ../src/guestfs-actions.pod:3606
12861 msgid "guestfs_luks_format"
12866 #: ../src/guestfs-actions.pod:3608
12870 " guestfs_luks_format (guestfs_h *g,\n"
12871 " const char *device,\n"
12872 " const char *key,\n"
12879 #: ../src/guestfs-actions.pod:3614 ../fish/guestfish-actions.pod:2469
12881 "This command erases existing data on C<device> and formats the device as a "
12882 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12883 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12888 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3644
12889 #: ../src/guestfs-actions.pod:3784 ../src/guestfs-actions.pod:4723
12890 #: ../src/guestfs-actions.pod:5486 ../src/guestfs-actions.pod:5861
12891 #: ../src/guestfs-actions.pod:5884 ../src/guestfs-actions.pod:5910
12892 #: ../src/guestfs-actions.pod:7070 ../fish/guestfish-actions.pod:2477
12893 #: ../fish/guestfish-actions.pod:2490 ../fish/guestfish-actions.pod:2574
12894 #: ../fish/guestfish-actions.pod:3146 ../fish/guestfish-actions.pod:3653
12895 #: ../fish/guestfish-actions.pod:3933 ../fish/guestfish-actions.pod:3949
12896 #: ../fish/guestfish-actions.pod:3964 ../fish/guestfish-actions.pod:4679
12898 "B<This command is dangerous. Without careful use you can easily destroy all "
12904 #: ../src/guestfs-actions.pod:3630
12905 msgid "guestfs_luks_format_cipher"
12910 #: ../src/guestfs-actions.pod:3632
12914 " guestfs_luks_format_cipher (guestfs_h *g,\n"
12915 " const char *device,\n"
12916 " const char *key,\n"
12918 " const char *cipher);\n"
12924 #: ../src/guestfs-actions.pod:3639
12926 "This command is the same as C<guestfs_luks_format> but it also allows you to "
12927 "set the C<cipher> used."
12932 #: ../src/guestfs-actions.pod:3653
12933 msgid "guestfs_luks_kill_slot"
12938 #: ../src/guestfs-actions.pod:3655
12942 " guestfs_luks_kill_slot (guestfs_h *g,\n"
12943 " const char *device,\n"
12944 " const char *key,\n"
12951 #: ../src/guestfs-actions.pod:3661 ../fish/guestfish-actions.pod:2497
12953 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
12954 "device C<device>. C<key> must be one of the I<other> keys."
12959 #: ../src/guestfs-actions.pod:3673
12960 msgid "guestfs_luks_open"
12965 #: ../src/guestfs-actions.pod:3675
12969 " guestfs_luks_open (guestfs_h *g,\n"
12970 " const char *device,\n"
12971 " const char *key,\n"
12972 " const char *mapname);\n"
12978 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2508
12980 "This command opens a block device which has been encrypted according to the "
12981 "Linux Unified Key Setup (LUKS) standard."
12986 #: ../src/guestfs-actions.pod:3684 ../fish/guestfish-actions.pod:2511
12987 msgid "C<device> is the encrypted block device or partition."
12992 #: ../src/guestfs-actions.pod:3686 ../fish/guestfish-actions.pod:2513
12994 "The caller must supply one of the keys associated with the LUKS block "
12995 "device, in the C<key> parameter."
13000 #: ../src/guestfs-actions.pod:3689 ../fish/guestfish-actions.pod:2516
13002 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13003 "writes to this block device are decrypted from and encrypted to the "
13004 "underlying C<device> respectively."
13009 #: ../src/guestfs-actions.pod:3693
13011 "If this block device contains LVM volume groups, then calling "
13012 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13018 #: ../src/guestfs-actions.pod:3705
13019 msgid "guestfs_luks_open_ro"
13024 #: ../src/guestfs-actions.pod:3707
13028 " guestfs_luks_open_ro (guestfs_h *g,\n"
13029 " const char *device,\n"
13030 " const char *key,\n"
13031 " const char *mapname);\n"
13037 #: ../src/guestfs-actions.pod:3713
13039 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13045 #: ../src/guestfs-actions.pod:3724
13046 msgid "guestfs_lvcreate"
13051 #: ../src/guestfs-actions.pod:3726
13055 " guestfs_lvcreate (guestfs_h *g,\n"
13056 " const char *logvol,\n"
13057 " const char *volgroup,\n"
13064 #: ../src/guestfs-actions.pod:3732 ../fish/guestfish-actions.pod:2541
13066 "This creates an LVM logical volume called C<logvol> on the volume group "
13067 "C<volgroup>, with C<size> megabytes."
13072 #: ../src/guestfs-actions.pod:3739
13073 msgid "guestfs_lvm_canonical_lv_name"
13078 #: ../src/guestfs-actions.pod:3741
13082 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13083 " const char *lvname);\n"
13089 #: ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2548
13091 "This converts alternative naming schemes for LVs that you might find to the "
13092 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13098 #: ../src/guestfs-actions.pod:3749 ../fish/guestfish-actions.pod:2552
13100 "This command returns an error if the C<lvname> parameter does not refer to a "
13106 #: ../src/guestfs-actions.pod:3752
13107 msgid "See also C<guestfs_is_lv>."
13112 #: ../src/guestfs-actions.pod:3757
13113 msgid "(Added in 1.5.24)"
13118 #: ../src/guestfs-actions.pod:3759
13119 msgid "guestfs_lvm_clear_filter"
13124 #: ../src/guestfs-actions.pod:3761
13128 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13134 #: ../src/guestfs-actions.pod:3764
13136 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13137 "see every block device."
13142 #: ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3809
13143 #: ../fish/guestfish-actions.pod:2564 ../fish/guestfish-actions.pod:2595
13145 "This command also clears the LVM cache and performs a volume group scan."
13150 #: ../src/guestfs-actions.pod:3774
13151 msgid "guestfs_lvm_remove_all"
13156 #: ../src/guestfs-actions.pod:3776
13160 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13166 #: ../src/guestfs-actions.pod:3779 ../fish/guestfish-actions.pod:2571
13168 "This command removes all LVM logical volumes, volume groups and physical "
13174 #: ../src/guestfs-actions.pod:3789
13175 msgid "guestfs_lvm_set_filter"
13180 #: ../src/guestfs-actions.pod:3791
13184 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13185 " char *const *devices);\n"
13191 #: ../src/guestfs-actions.pod:3795 ../fish/guestfish-actions.pod:2581
13193 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13194 "block devices in the list C<devices>, and will ignore all other attached "
13200 #: ../src/guestfs-actions.pod:3799 ../fish/guestfish-actions.pod:2585
13202 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13203 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13204 "there are two types of duplication possible: either cloned PVs/VGs which "
13205 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13206 "same name. In normal operation you cannot create this situation, but you "
13207 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13208 "inside the LVM metadata."
13213 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
13214 msgid "You can filter whole block devices or individual partitions."
13219 #: ../src/guestfs-actions.pod:3814 ../fish/guestfish-actions.pod:2600
13221 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13222 "filesystem), even if you are not filtering out that VG."
13227 #: ../src/guestfs-actions.pod:3822
13228 msgid "guestfs_lvremove"
13233 #: ../src/guestfs-actions.pod:3824
13237 " guestfs_lvremove (guestfs_h *g,\n"
13238 " const char *device);\n"
13244 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2608
13246 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13247 "LV, such as C</dev/VG/LV>."
13252 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2611
13254 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13260 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:5069
13261 #: ../src/guestfs-actions.pod:6809
13262 msgid "(Added in 1.0.13)"
13267 #: ../src/guestfs-actions.pod:3838
13268 msgid "guestfs_lvrename"
13273 #: ../src/guestfs-actions.pod:3840
13277 " guestfs_lvrename (guestfs_h *g,\n"
13278 " const char *logvol,\n"
13279 " const char *newlogvol);\n"
13285 #: ../src/guestfs-actions.pod:3845 ../fish/guestfish-actions.pod:2618
13286 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13291 #: ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:6822
13292 msgid "(Added in 1.0.83)"
13297 #: ../src/guestfs-actions.pod:3851
13298 msgid "guestfs_lvresize"
13303 #: ../src/guestfs-actions.pod:3853
13307 " guestfs_lvresize (guestfs_h *g,\n"
13308 " const char *device,\n"
13315 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2624
13317 "This resizes (expands or shrinks) an existing LVM logical volume to "
13318 "C<mbytes>. When reducing, data in the reduced part is lost."
13323 #: ../src/guestfs-actions.pod:3866
13324 msgid "guestfs_lvresize_free"
13329 #: ../src/guestfs-actions.pod:3868
13333 " guestfs_lvresize_free (guestfs_h *g,\n"
13334 " const char *lv,\n"
13341 #: ../src/guestfs-actions.pod:3873 ../fish/guestfish-actions.pod:2632
13343 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13344 "remaining free space in the volume group. Commonly you would call this with "
13345 "pc = 100 which expands the logical volume as much as possible, using all "
13346 "remaining free space in the volume group."
13351 #: ../src/guestfs-actions.pod:3881
13352 msgid "(Added in 1.3.3)"
13357 #: ../src/guestfs-actions.pod:3883
13358 msgid "guestfs_lvs"
13363 #: ../src/guestfs-actions.pod:3885
13367 " guestfs_lvs (guestfs_h *g);\n"
13373 #: ../src/guestfs-actions.pod:3888 ../fish/guestfish-actions.pod:2642
13375 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13381 #: ../src/guestfs-actions.pod:3891 ../fish/guestfish-actions.pod:2645
13383 "This returns a list of the logical volume device names (eg. C</dev/"
13384 "VolGroup00/LogVol00>)."
13389 #: ../src/guestfs-actions.pod:3894
13390 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13395 #: ../src/guestfs-actions.pod:3902
13396 msgid "guestfs_lvs_full"
13401 #: ../src/guestfs-actions.pod:3904
13404 " struct guestfs_lvm_lv_list *\n"
13405 " guestfs_lvs_full (guestfs_h *g);\n"
13411 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2654
13413 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13414 "(8)> command. The \"full\" version includes all fields."
13419 #: ../src/guestfs-actions.pod:3910
13421 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13422 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
13427 #: ../src/guestfs-actions.pod:3916
13428 msgid "guestfs_lvuuid"
13433 #: ../src/guestfs-actions.pod:3918
13437 " guestfs_lvuuid (guestfs_h *g,\n"
13438 " const char *device);\n"
13444 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2661
13445 msgid "This command returns the UUID of the LVM LV C<device>."
13450 #: ../src/guestfs-actions.pod:3929
13451 msgid "guestfs_lxattrlist"
13456 #: ../src/guestfs-actions.pod:3931
13459 " struct guestfs_xattr_list *\n"
13460 " guestfs_lxattrlist (guestfs_h *g,\n"
13461 " const char *path,\n"
13462 " char *const *names);\n"
13468 #: ../src/guestfs-actions.pod:3936 ../fish/guestfish-actions.pod:2667
13470 "This call allows you to get the extended attributes of multiple files, where "
13471 "all files are in the directory C<path>. C<names> is the list of files from "
13477 #: ../src/guestfs-actions.pod:3940 ../fish/guestfish-actions.pod:2671
13479 "On return you get a flat list of xattr structs which must be interpreted "
13480 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13481 "C<attrval> in this struct is zero-length to indicate there was an error "
13482 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13483 "number (the number of following attributes for this file, which could be C<"
13484 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13485 "for the first named file. This repeats for the second and subsequent files."
13490 #: ../src/guestfs-actions.pod:3950
13492 "This call is intended for programs that want to efficiently list a directory "
13493 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
13494 "a similarly efficient call for getting standard stats. Very long directory "
13495 "listings might cause the protocol message size to be exceeded, causing this "
13496 "call to fail. The caller must split up such requests into smaller groups of "
13502 #: ../src/guestfs-actions.pod:3964
13503 msgid "guestfs_mkdir"
13508 #: ../src/guestfs-actions.pod:3966
13512 " guestfs_mkdir (guestfs_h *g,\n"
13513 " const char *path);\n"
13519 #: ../src/guestfs-actions.pod:3970 ../fish/guestfish-actions.pod:2693
13520 msgid "Create a directory named C<path>."
13525 #: ../src/guestfs-actions.pod:3976
13526 msgid "guestfs_mkdir_mode"
13531 #: ../src/guestfs-actions.pod:3978
13535 " guestfs_mkdir_mode (guestfs_h *g,\n"
13536 " const char *path,\n"
13543 #: ../src/guestfs-actions.pod:3983 ../fish/guestfish-actions.pod:2699
13545 "This command creates a directory, setting the initial permissions of the "
13546 "directory to C<mode>."
13551 #: ../src/guestfs-actions.pod:3986 ../fish/guestfish-actions.pod:2702
13553 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13554 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13560 #: ../src/guestfs-actions.pod:3990
13561 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13566 #: ../src/guestfs-actions.pod:3996
13567 msgid "guestfs_mkdir_p"
13572 #: ../src/guestfs-actions.pod:3998
13576 " guestfs_mkdir_p (guestfs_h *g,\n"
13577 " const char *path);\n"
13583 #: ../src/guestfs-actions.pod:4002 ../fish/guestfish-actions.pod:2712
13585 "Create a directory named C<path>, creating any parent directories as "
13586 "necessary. This is like the C<mkdir -p> shell command."
13591 #: ../src/guestfs-actions.pod:4009
13592 msgid "guestfs_mkdtemp"
13597 #: ../src/guestfs-actions.pod:4011
13601 " guestfs_mkdtemp (guestfs_h *g,\n"
13602 " const char *template);\n"
13608 #: ../src/guestfs-actions.pod:4015 ../fish/guestfish-actions.pod:2719
13610 "This command creates a temporary directory. The C<template> parameter "
13611 "should be a full pathname for the temporary directory name with the final "
13612 "six characters being \"XXXXXX\"."
13617 #: ../src/guestfs-actions.pod:4020 ../fish/guestfish-actions.pod:2724
13619 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13620 "being suitable for Windows filesystems."
13625 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2727
13626 msgid "The name of the temporary directory that was created is returned."
13631 #: ../src/guestfs-actions.pod:4026 ../fish/guestfish-actions.pod:2730
13632 msgid "The temporary directory is created with mode 0700 and is owned by root."
13637 #: ../src/guestfs-actions.pod:4029 ../fish/guestfish-actions.pod:2733
13639 "The caller is responsible for deleting the temporary directory and its "
13640 "contents after use."
13645 #: ../src/guestfs-actions.pod:4032 ../fish/guestfish-actions.pod:2736
13646 msgid "See also: L<mkdtemp(3)>"
13651 #: ../src/guestfs-actions.pod:4039
13652 msgid "guestfs_mke2fs_J"
13657 #: ../src/guestfs-actions.pod:4041
13661 " guestfs_mke2fs_J (guestfs_h *g,\n"
13662 " const char *fstype,\n"
13663 " int blocksize,\n"
13664 " const char *device,\n"
13665 " const char *journal);\n"
13671 #: ../src/guestfs-actions.pod:4048 ../fish/guestfish-actions.pod:2742
13673 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13674 "C<journal>. It is equivalent to the command:"
13679 #: ../src/guestfs-actions.pod:4052 ../fish/guestfish-actions.pod:2746
13682 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13688 #: ../src/guestfs-actions.pod:4054
13689 msgid "See also C<guestfs_mke2journal>."
13694 #: ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4076
13695 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4110
13696 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4138
13697 #: ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4450
13698 msgid "(Added in 1.0.68)"
13703 #: ../src/guestfs-actions.pod:4060
13704 msgid "guestfs_mke2fs_JL"
13709 #: ../src/guestfs-actions.pod:4062
13713 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13714 " const char *fstype,\n"
13715 " int blocksize,\n"
13716 " const char *device,\n"
13717 " const char *label);\n"
13723 #: ../src/guestfs-actions.pod:4069 ../fish/guestfish-actions.pod:2754
13725 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13726 "the journal labeled C<label>."
13731 #: ../src/guestfs-actions.pod:4072
13732 msgid "See also C<guestfs_mke2journal_L>."
13737 #: ../src/guestfs-actions.pod:4078
13738 msgid "guestfs_mke2fs_JU"
13743 #: ../src/guestfs-actions.pod:4080
13747 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13748 " const char *fstype,\n"
13749 " int blocksize,\n"
13750 " const char *device,\n"
13751 " const char *uuid);\n"
13757 #: ../src/guestfs-actions.pod:4087 ../fish/guestfish-actions.pod:2763
13759 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13760 "the journal with UUID C<uuid>."
13765 #: ../src/guestfs-actions.pod:4090
13766 msgid "See also C<guestfs_mke2journal_U>."
13771 #: ../src/guestfs-actions.pod:4096
13772 msgid "guestfs_mke2journal"
13777 #: ../src/guestfs-actions.pod:4098
13781 " guestfs_mke2journal (guestfs_h *g,\n"
13782 " int blocksize,\n"
13783 " const char *device);\n"
13789 #: ../src/guestfs-actions.pod:4103 ../fish/guestfish-actions.pod:2772
13791 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13797 #: ../src/guestfs-actions.pod:4106 ../fish/guestfish-actions.pod:2775
13800 " mke2fs -O journal_dev -b blocksize device\n"
13806 #: ../src/guestfs-actions.pod:4112
13807 msgid "guestfs_mke2journal_L"
13812 #: ../src/guestfs-actions.pod:4114
13816 " guestfs_mke2journal_L (guestfs_h *g,\n"
13817 " int blocksize,\n"
13818 " const char *label,\n"
13819 " const char *device);\n"
13825 #: ../src/guestfs-actions.pod:4120 ../fish/guestfish-actions.pod:2781
13826 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13831 #: ../src/guestfs-actions.pod:4126
13832 msgid "guestfs_mke2journal_U"
13837 #: ../src/guestfs-actions.pod:4128
13841 " guestfs_mke2journal_U (guestfs_h *g,\n"
13842 " int blocksize,\n"
13843 " const char *uuid,\n"
13844 " const char *device);\n"
13850 #: ../src/guestfs-actions.pod:4134 ../fish/guestfish-actions.pod:2787
13851 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13856 #: ../src/guestfs-actions.pod:4140
13857 msgid "guestfs_mkfifo"
13862 #: ../src/guestfs-actions.pod:4142
13866 " guestfs_mkfifo (guestfs_h *g,\n"
13868 " const char *path);\n"
13874 #: ../src/guestfs-actions.pod:4147
13876 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13877 "is just a convenient wrapper around C<guestfs_mknod>."
13882 #: ../src/guestfs-actions.pod:4157
13883 msgid "guestfs_mkfs"
13888 #: ../src/guestfs-actions.pod:4159
13892 " guestfs_mkfs (guestfs_h *g,\n"
13893 " const char *fstype,\n"
13894 " const char *device);\n"
13900 #: ../src/guestfs-actions.pod:4164 ../fish/guestfish-actions.pod:2803
13902 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13903 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13908 #: ../src/guestfs-actions.pod:4172
13909 msgid "guestfs_mkfs_b"
13914 #: ../src/guestfs-actions.pod:4174
13918 " guestfs_mkfs_b (guestfs_h *g,\n"
13919 " const char *fstype,\n"
13920 " int blocksize,\n"
13921 " const char *device);\n"
13927 #: ../src/guestfs-actions.pod:4180
13929 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
13930 "block size of the resulting filesystem. Supported block sizes depend on the "
13931 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13936 #: ../src/guestfs-actions.pod:4185 ../src/guestfs-actions.pod:4227
13937 #: ../fish/guestfish-actions.pod:2816 ../fish/guestfish-actions.pod:2843
13939 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13944 #: ../src/guestfs-actions.pod:4190
13946 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
13952 #: ../src/guestfs-actions.pod:4199
13953 msgid "guestfs_mkfs_opts"
13958 #: ../src/guestfs-actions.pod:4201
13962 " guestfs_mkfs_opts (guestfs_h *g,\n"
13963 " const char *fstype,\n"
13964 " const char *device,\n"
13971 #: ../src/guestfs-actions.pod:4212
13974 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
13980 #: ../src/guestfs-actions.pod:4214 ../fish/guestfish-actions.pod:2830
13982 "This function creates a filesystem on C<device>. The filesystem type is "
13983 "C<fstype>, for example C<ext3>."
13988 #: ../src/guestfs-actions.pod:4221 ../fish/guestfish-actions.pod:2837
13989 msgid "C<blocksize>"
13994 #: ../src/guestfs-actions.pod:4223 ../fish/guestfish-actions.pod:2839
13996 "The filesystem block size. Supported block sizes depend on the filesystem "
13997 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14002 #: ../src/guestfs-actions.pod:4230 ../fish/guestfish-actions.pod:2846
14003 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14007 #: ../src/guestfs-actions.pod:4236
14008 msgid "(Added in 1.7.19)"
14013 #: ../src/guestfs-actions.pod:4238
14014 msgid "guestfs_mkfs_opts_va"
14019 #: ../src/guestfs-actions.pod:4240
14023 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14024 " const char *fstype,\n"
14025 " const char *device,\n"
14026 " va_list args);\n"
14032 #: ../src/guestfs-actions.pod:4246
14033 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14038 #: ../src/guestfs-actions.pod:4250
14039 msgid "guestfs_mkfs_opts_argv"
14044 #: ../src/guestfs-actions.pod:4252
14048 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14049 " const char *fstype,\n"
14050 " const char *device,\n"
14051 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14057 #: ../src/guestfs-actions.pod:4258
14058 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14063 #: ../src/guestfs-actions.pod:4262
14064 msgid "guestfs_mkmountpoint"
14069 #: ../src/guestfs-actions.pod:4264
14073 " guestfs_mkmountpoint (guestfs_h *g,\n"
14074 " const char *exemptpath);\n"
14080 #: ../src/guestfs-actions.pod:4268
14082 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14083 "that can be used to create extra mountpoints before mounting the first "
14089 #: ../src/guestfs-actions.pod:4272 ../fish/guestfish-actions.pod:2860
14091 "These calls are I<only> necessary in some very limited circumstances, mainly "
14092 "the case where you want to mount a mix of unrelated and/or read-only "
14093 "filesystems together."
14098 #: ../src/guestfs-actions.pod:4276 ../fish/guestfish-actions.pod:2864
14100 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14101 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14102 "inside that. You can unpack this as follows in guestfish:"
14107 #: ../src/guestfs-actions.pod:4281 ../fish/guestfish-actions.pod:2869
14110 " add-ro Fedora-11-i686-Live.iso\n"
14112 " mkmountpoint /cd\n"
14113 " mkmountpoint /sqsh\n"
14114 " mkmountpoint /ext3fs\n"
14115 " mount /dev/sda /cd\n"
14116 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14117 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14123 #: ../src/guestfs-actions.pod:4290 ../fish/guestfish-actions.pod:2878
14124 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14129 #: ../src/guestfs-actions.pod:4292
14131 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14132 "may get unexpected errors if you try to mix these calls. It is safest to "
14133 "manually unmount filesystems and remove mountpoints after use."
14138 #: ../src/guestfs-actions.pod:4296
14140 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14141 "first, so for this to work for manual mountpoints, you must ensure that the "
14142 "innermost mountpoints have the longest pathnames, as in the example code "
14148 #: ../src/guestfs-actions.pod:4301 ../fish/guestfish-actions.pod:2889
14150 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14155 #: ../src/guestfs-actions.pod:4303
14157 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14158 "means that C<guestfs_umount_all> is called when the handle is closed which "
14159 "can also trigger these issues."
14164 #: ../src/guestfs-actions.pod:4309 ../src/guestfs-actions.pod:4568
14165 #: ../src/guestfs-actions.pod:5470
14166 msgid "(Added in 1.0.62)"
14171 #: ../src/guestfs-actions.pod:4311
14172 msgid "guestfs_mknod"
14177 #: ../src/guestfs-actions.pod:4313
14181 " guestfs_mknod (guestfs_h *g,\n"
14185 " const char *path);\n"
14191 #: ../src/guestfs-actions.pod:4320 ../fish/guestfish-actions.pod:2899
14193 "This call creates block or character special devices, or named pipes (FIFOs)."
14198 #: ../src/guestfs-actions.pod:4323 ../fish/guestfish-actions.pod:2902
14200 "The C<mode> parameter should be the mode, using the standard constants. "
14201 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14202 "used when creating block and character special devices."
14207 #: ../src/guestfs-actions.pod:4328
14209 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14210 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14211 "regular file). These constants are available in the standard Linux header "
14212 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14213 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
14214 "the appropriate constant for you."
14219 #: ../src/guestfs-actions.pod:4342
14220 msgid "guestfs_mknod_b"
14225 #: ../src/guestfs-actions.pod:4344
14229 " guestfs_mknod_b (guestfs_h *g,\n"
14233 " const char *path);\n"
14239 #: ../src/guestfs-actions.pod:4351
14241 "This call creates a block device node called C<path> with mode C<mode> and "
14242 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14243 "wrapper around C<guestfs_mknod>."
14248 #: ../src/guestfs-actions.pod:4361
14249 msgid "guestfs_mknod_c"
14254 #: ../src/guestfs-actions.pod:4363
14258 " guestfs_mknod_c (guestfs_h *g,\n"
14262 " const char *path);\n"
14268 #: ../src/guestfs-actions.pod:4370
14270 "This call creates a char device node called C<path> with mode C<mode> and "
14271 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14272 "wrapper around C<guestfs_mknod>."
14277 #: ../src/guestfs-actions.pod:4380
14278 msgid "guestfs_mkswap"
14283 #: ../src/guestfs-actions.pod:4382
14287 " guestfs_mkswap (guestfs_h *g,\n"
14288 " const char *device);\n"
14294 #: ../src/guestfs-actions.pod:4386 ../fish/guestfish-actions.pod:2941
14295 msgid "Create a swap partition on C<device>."
14300 #: ../src/guestfs-actions.pod:4392
14301 msgid "guestfs_mkswap_L"
14306 #: ../src/guestfs-actions.pod:4394
14310 " guestfs_mkswap_L (guestfs_h *g,\n"
14311 " const char *label,\n"
14312 " const char *device);\n"
14318 #: ../src/guestfs-actions.pod:4399 ../fish/guestfish-actions.pod:2947
14319 msgid "Create a swap partition on C<device> with label C<label>."
14324 #: ../src/guestfs-actions.pod:4401 ../fish/guestfish-actions.pod:2949
14326 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14327 "sda>), just to a partition. This appears to be a limitation of the kernel "
14333 #: ../src/guestfs-actions.pod:4409
14334 msgid "guestfs_mkswap_U"
14339 #: ../src/guestfs-actions.pod:4411
14343 " guestfs_mkswap_U (guestfs_h *g,\n"
14344 " const char *uuid,\n"
14345 " const char *device);\n"
14351 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:2957
14352 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14357 #: ../src/guestfs-actions.pod:4422
14358 msgid "guestfs_mkswap_file"
14363 #: ../src/guestfs-actions.pod:4424
14367 " guestfs_mkswap_file (guestfs_h *g,\n"
14368 " const char *path);\n"
14374 #: ../src/guestfs-actions.pod:4428 ../fish/guestfish-actions.pod:2963
14375 msgid "Create a swap file."
14380 #: ../src/guestfs-actions.pod:4430
14382 "This command just writes a swap file signature to an existing file. To "
14383 "create the file itself, use something like C<guestfs_fallocate>."
14388 #: ../src/guestfs-actions.pod:4437
14389 msgid "guestfs_modprobe"
14394 #: ../src/guestfs-actions.pod:4439
14398 " guestfs_modprobe (guestfs_h *g,\n"
14399 " const char *modulename);\n"
14405 #: ../src/guestfs-actions.pod:4443 ../fish/guestfish-actions.pod:2972
14406 msgid "This loads a kernel module in the appliance."
14411 #: ../src/guestfs-actions.pod:4445 ../fish/guestfish-actions.pod:2974
14413 "The kernel module must have been whitelisted when libguestfs was built (see "
14414 "C<appliance/kmod.whitelist.in> in the source)."
14419 #: ../src/guestfs-actions.pod:4452
14420 msgid "guestfs_mount"
14425 #: ../src/guestfs-actions.pod:4454
14429 " guestfs_mount (guestfs_h *g,\n"
14430 " const char *device,\n"
14431 " const char *mountpoint);\n"
14437 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2981
14439 "Mount a guest disk at a position in the filesystem. Block devices are named "
14440 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14441 "those block devices contain partitions, they will have the usual names (eg. "
14442 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14447 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2987
14449 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14450 "mounted on C</> before others can be mounted. Other filesystems can only be "
14451 "mounted on directories which already exist."
14456 #: ../src/guestfs-actions.pod:4470 ../fish/guestfish-actions.pod:2992
14458 "The mounted filesystem is writable, if we have sufficient permissions on the "
14459 "underlying device."
14464 #: ../src/guestfs-actions.pod:4473
14466 "B<Important note:> When you use this call, the filesystem options C<sync> "
14467 "and C<noatime> are set implicitly. This was originally done because we "
14468 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14469 "very large negative performance impact and negligible effect on "
14470 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14471 "in any code that needs performance, and instead use C<guestfs_mount_options> "
14472 "(use an empty string for the first parameter if you don't want any options)."
14477 #: ../src/guestfs-actions.pod:4487
14478 msgid "guestfs_mount_loop"
14483 #: ../src/guestfs-actions.pod:4489
14487 " guestfs_mount_loop (guestfs_h *g,\n"
14488 " const char *file,\n"
14489 " const char *mountpoint);\n"
14495 #: ../src/guestfs-actions.pod:4494 ../fish/guestfish-actions.pod:3009
14497 "This command lets you mount C<file> (a filesystem image in a file) on a "
14498 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14504 #: ../src/guestfs-actions.pod:4502
14505 msgid "guestfs_mount_options"
14510 #: ../src/guestfs-actions.pod:4504
14514 " guestfs_mount_options (guestfs_h *g,\n"
14515 " const char *options,\n"
14516 " const char *device,\n"
14517 " const char *mountpoint);\n"
14523 #: ../src/guestfs-actions.pod:4510
14525 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14526 "the mount options as for the L<mount(8)> I<-o> flag."
14531 #: ../src/guestfs-actions.pod:4514 ../fish/guestfish-actions.pod:3021
14533 "If the C<options> parameter is an empty string, then no options are passed "
14534 "(all options default to whatever the filesystem uses)."
14539 #: ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4534
14540 #: ../src/guestfs-actions.pod:4551
14541 msgid "(Added in 1.0.10)"
14546 #: ../src/guestfs-actions.pod:4522
14547 msgid "guestfs_mount_ro"
14552 #: ../src/guestfs-actions.pod:4524
14556 " guestfs_mount_ro (guestfs_h *g,\n"
14557 " const char *device,\n"
14558 " const char *mountpoint);\n"
14564 #: ../src/guestfs-actions.pod:4529
14566 "This is the same as the C<guestfs_mount> command, but it mounts the "
14567 "filesystem with the read-only (I<-o ro>) flag."
14572 #: ../src/guestfs-actions.pod:4536
14573 msgid "guestfs_mount_vfs"
14578 #: ../src/guestfs-actions.pod:4538
14582 " guestfs_mount_vfs (guestfs_h *g,\n"
14583 " const char *options,\n"
14584 " const char *vfstype,\n"
14585 " const char *device,\n"
14586 " const char *mountpoint);\n"
14592 #: ../src/guestfs-actions.pod:4545
14594 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14595 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
14601 #: ../src/guestfs-actions.pod:4553
14602 msgid "guestfs_mountpoints"
14607 #: ../src/guestfs-actions.pod:4555
14611 " guestfs_mountpoints (guestfs_h *g);\n"
14617 #: ../src/guestfs-actions.pod:4558
14619 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14620 "devices. This one returns a hash table (map) of device name to directory "
14621 "where the device is mounted."
14626 #: ../src/guestfs-actions.pod:4570
14627 msgid "guestfs_mounts"
14632 #: ../src/guestfs-actions.pod:4572
14636 " guestfs_mounts (guestfs_h *g);\n"
14642 #: ../src/guestfs-actions.pod:4575 ../fish/guestfish-actions.pod:3052
14644 "This returns the list of currently mounted filesystems. It returns the list "
14645 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14650 #: ../src/guestfs-actions.pod:4578 ../fish/guestfish-actions.pod:3055
14651 msgid "Some internal mounts are not shown."
14656 #: ../src/guestfs-actions.pod:4580
14657 msgid "See also: C<guestfs_mountpoints>"
14662 #: ../src/guestfs-actions.pod:4588
14668 #: ../src/guestfs-actions.pod:4590
14672 " guestfs_mv (guestfs_h *g,\n"
14673 " const char *src,\n"
14674 " const char *dest);\n"
14680 #: ../src/guestfs-actions.pod:4595 ../fish/guestfish-actions.pod:3063
14682 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14683 "destination filename or destination directory."
14688 #: ../src/guestfs-actions.pod:4602
14689 msgid "guestfs_ntfs_3g_probe"
14694 #: ../src/guestfs-actions.pod:4604
14698 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14700 " const char *device);\n"
14706 #: ../src/guestfs-actions.pod:4609 ../fish/guestfish-actions.pod:3070
14708 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14709 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14710 "write, and some cannot be mounted at all)."
14715 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3074
14717 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14718 "can be mounted read-write. Set it to false if you want to test if the "
14719 "volume can be mounted read-only."
14724 #: ../src/guestfs-actions.pod:4617 ../fish/guestfish-actions.pod:3078
14726 "The return value is an integer which C<0> if the operation would succeed, or "
14727 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14732 #: ../src/guestfs-actions.pod:4623
14733 msgid "(Added in 1.0.43)"
14738 #: ../src/guestfs-actions.pod:4625
14739 msgid "guestfs_ntfsresize"
14744 #: ../src/guestfs-actions.pod:4627
14748 " guestfs_ntfsresize (guestfs_h *g,\n"
14749 " const char *device);\n"
14754 #: ../src/guestfs-actions.pod:4631 ../fish/guestfish-actions.pod:3086
14756 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14757 "size of the underlying device."
14761 #: ../src/guestfs-actions.pod:4634 ../fish/guestfish-actions.pod:3089
14763 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14764 "consistency check (for safety). You have to boot into Windows to perform "
14765 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14766 "resize filesystems which have been marked in this way. So in effect it is "
14767 "not possible to call ntfsresize multiple times on a single filesystem "
14768 "without booting into Windows between each resize."
14772 #: ../src/guestfs-actions.pod:4642 ../fish/guestfish-actions.pod:3097
14773 msgid "See also L<ntfsresize(8)>."
14778 #: ../src/guestfs-actions.pod:4648
14779 msgid "guestfs_ntfsresize_size"
14784 #: ../src/guestfs-actions.pod:4650
14788 " guestfs_ntfsresize_size (guestfs_h *g,\n"
14789 " const char *device,\n"
14790 " int64_t size);\n"
14796 #: ../src/guestfs-actions.pod:4655
14798 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
14799 "to specify the new size (in bytes) explicitly."
14804 #: ../src/guestfs-actions.pod:4660 ../src/guestfs-actions.pod:5096
14805 #: ../src/guestfs-actions.pod:5169 ../src/guestfs-actions.pod:5418
14806 #: ../src/guestfs-actions.pod:6957
14807 msgid "(Added in 1.3.14)"
14812 #: ../src/guestfs-actions.pod:4662
14813 msgid "guestfs_part_add"
14818 #: ../src/guestfs-actions.pod:4664
14822 " guestfs_part_add (guestfs_h *g,\n"
14823 " const char *device,\n"
14824 " const char *prlogex,\n"
14825 " int64_t startsect,\n"
14826 " int64_t endsect);\n"
14832 #: ../src/guestfs-actions.pod:4671
14834 "This command adds a partition to C<device>. If there is no partition table "
14835 "on the device, call C<guestfs_part_init> first."
14840 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3113
14842 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14843 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14844 "C<logical>) and C<e> (or C<extended>) partition types."
14849 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3118
14851 "C<startsect> and C<endsect> are the start and end of the partition in "
14852 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14853 "from the end of the disk (C<-1> is the last sector)."
14858 #: ../src/guestfs-actions.pod:4683
14860 "Creating a partition which covers the whole disk is not so easy. Use "
14861 "C<guestfs_part_disk> to do that."
14866 #: ../src/guestfs-actions.pod:4688 ../src/guestfs-actions.pod:4726
14867 #: ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4857
14868 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4914
14869 #: ../src/guestfs-actions.pod:4954
14870 msgid "(Added in 1.0.78)"
14875 #: ../src/guestfs-actions.pod:4690
14876 msgid "guestfs_part_del"
14881 #: ../src/guestfs-actions.pod:4692
14885 " guestfs_part_del (guestfs_h *g,\n"
14886 " const char *device,\n"
14893 #: ../src/guestfs-actions.pod:4697 ../fish/guestfish-actions.pod:3129
14894 msgid "This command deletes the partition numbered C<partnum> on C<device>."
14899 #: ../src/guestfs-actions.pod:4699 ../fish/guestfish-actions.pod:3131
14901 "Note that in the case of MBR partitioning, deleting an extended partition "
14902 "also deletes any logical partitions it contains."
14907 #: ../src/guestfs-actions.pod:4707
14908 msgid "guestfs_part_disk"
14913 #: ../src/guestfs-actions.pod:4709
14917 " guestfs_part_disk (guestfs_h *g,\n"
14918 " const char *device,\n"
14919 " const char *parttype);\n"
14925 #: ../src/guestfs-actions.pod:4714
14927 "This command is simply a combination of C<guestfs_part_init> followed by "
14928 "C<guestfs_part_add> to create a single primary partition covering the whole "
14934 #: ../src/guestfs-actions.pod:4718
14936 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
14937 "possible values are described in C<guestfs_part_init>."
14942 #: ../src/guestfs-actions.pod:4728
14943 msgid "guestfs_part_get_bootable"
14948 #: ../src/guestfs-actions.pod:4730
14952 " guestfs_part_get_bootable (guestfs_h *g,\n"
14953 " const char *device,\n"
14960 #: ../src/guestfs-actions.pod:4735 ../fish/guestfish-actions.pod:3153
14962 "This command returns true if the partition C<partnum> on C<device> has the "
14963 "bootable flag set."
14968 #: ../src/guestfs-actions.pod:4738
14969 msgid "See also C<guestfs_part_set_bootable>."
14974 #: ../src/guestfs-actions.pod:4744
14975 msgid "guestfs_part_get_mbr_id"
14980 #: ../src/guestfs-actions.pod:4746
14984 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
14985 " const char *device,\n"
14992 #: ../src/guestfs-actions.pod:4751 ../fish/guestfish-actions.pod:3162
14994 "Returns the MBR type byte (also known as the ID byte) from the numbered "
14995 "partition C<partnum>."
15000 #: ../src/guestfs-actions.pod:4754 ../src/guestfs-actions.pod:4930
15002 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15003 "undefined results for other partition table types (see "
15004 "C<guestfs_part_get_parttype>)."
15009 #: ../src/guestfs-actions.pod:4762
15010 msgid "guestfs_part_get_parttype"
15015 #: ../src/guestfs-actions.pod:4764
15019 " guestfs_part_get_parttype (guestfs_h *g,\n"
15020 " const char *device);\n"
15026 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3173
15028 "This command examines the partition table on C<device> and returns the "
15029 "partition table type (format) being used."
15034 #: ../src/guestfs-actions.pod:4771
15036 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15037 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15038 "possible, although unusual. See C<guestfs_part_init> for a full list."
15043 #: ../src/guestfs-actions.pod:4781
15044 msgid "guestfs_part_init"
15049 #: ../src/guestfs-actions.pod:4783
15053 " guestfs_part_init (guestfs_h *g,\n"
15054 " const char *device,\n"
15055 " const char *parttype);\n"
15061 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3185
15063 "This creates an empty partition table on C<device> of one of the partition "
15064 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15065 "(for large disks)."
15070 #: ../src/guestfs-actions.pod:4792
15072 "Initially there are no partitions. Following this, you should call "
15073 "C<guestfs_part_add> for each partition required."
15078 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3192
15079 msgid "Possible values for C<parttype> are:"
15084 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3196
15085 msgid "B<efi> | B<gpt>"
15090 #: ../src/guestfs-actions.pod:4801 ../fish/guestfish-actions.pod:3198
15091 msgid "Intel EFI / GPT partition table."
15096 #: ../src/guestfs-actions.pod:4803 ../fish/guestfish-actions.pod:3200
15098 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15099 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15100 "the C<mbr> format."
15105 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3204
15106 msgid "B<mbr> | B<msdos>"
15111 #: ../src/guestfs-actions.pod:4809 ../fish/guestfish-actions.pod:3206
15113 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15114 "Windows. This partition type will B<only> work for device sizes up to 2 "
15115 "TB. For large disks we recommend using C<gpt>."
15120 #: ../src/guestfs-actions.pod:4816 ../fish/guestfish-actions.pod:3213
15122 "Other partition table types that may work but are not supported include:"
15127 #: ../src/guestfs-actions.pod:4821 ../fish/guestfish-actions.pod:3218
15133 #: ../src/guestfs-actions.pod:4823 ../fish/guestfish-actions.pod:3220
15134 msgid "AIX disk labels."
15139 #: ../src/guestfs-actions.pod:4825 ../fish/guestfish-actions.pod:3222
15140 msgid "B<amiga> | B<rdb>"
15145 #: ../src/guestfs-actions.pod:4827 ../fish/guestfish-actions.pod:3224
15146 msgid "Amiga \"Rigid Disk Block\" format."
15151 #: ../src/guestfs-actions.pod:4829 ../fish/guestfish-actions.pod:3226
15157 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3228
15158 msgid "BSD disk labels."
15163 #: ../src/guestfs-actions.pod:4833 ../fish/guestfish-actions.pod:3230
15169 #: ../src/guestfs-actions.pod:4835 ../fish/guestfish-actions.pod:3232
15170 msgid "DASD, used on IBM mainframes."
15175 #: ../src/guestfs-actions.pod:4837 ../fish/guestfish-actions.pod:3234
15181 #: ../src/guestfs-actions.pod:4839 ../fish/guestfish-actions.pod:3236
15182 msgid "MIPS/SGI volumes."
15187 #: ../src/guestfs-actions.pod:4841 ../fish/guestfish-actions.pod:3238
15193 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3240
15194 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15199 #: ../src/guestfs-actions.pod:4845 ../fish/guestfish-actions.pod:3242
15205 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3244
15206 msgid "NEC PC-98 format, common in Japan apparently."
15211 #: ../src/guestfs-actions.pod:4849 ../fish/guestfish-actions.pod:3246
15217 #: ../src/guestfs-actions.pod:4851 ../fish/guestfish-actions.pod:3248
15218 msgid "Sun disk labels."
15223 #: ../src/guestfs-actions.pod:4859
15224 msgid "guestfs_part_list"
15229 #: ../src/guestfs-actions.pod:4861
15232 " struct guestfs_partition_list *\n"
15233 " guestfs_part_list (guestfs_h *g,\n"
15234 " const char *device);\n"
15240 #: ../src/guestfs-actions.pod:4865 ../fish/guestfish-actions.pod:3256
15242 "This command parses the partition table on C<device> and returns the list of "
15243 "partitions found."
15248 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3259
15249 msgid "The fields in the returned structure are:"
15254 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3263
15255 msgid "B<part_num>"
15260 #: ../src/guestfs-actions.pod:4874 ../fish/guestfish-actions.pod:3265
15261 msgid "Partition number, counting from 1."
15266 #: ../src/guestfs-actions.pod:4876 ../fish/guestfish-actions.pod:3267
15267 msgid "B<part_start>"
15272 #: ../src/guestfs-actions.pod:4878
15274 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15275 "the device's sector size, see C<guestfs_blockdev_getss>."
15280 #: ../src/guestfs-actions.pod:4881 ../fish/guestfish-actions.pod:3272
15281 msgid "B<part_end>"
15286 #: ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3274
15287 msgid "End of the partition in bytes."
15292 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3276
15293 msgid "B<part_size>"
15298 #: ../src/guestfs-actions.pod:4887 ../fish/guestfish-actions.pod:3278
15299 msgid "Size of the partition in bytes."
15304 #: ../src/guestfs-actions.pod:4891
15306 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
15307 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
15313 #: ../src/guestfs-actions.pod:4897
15314 msgid "guestfs_part_set_bootable"
15319 #: ../src/guestfs-actions.pod:4899
15323 " guestfs_part_set_bootable (guestfs_h *g,\n"
15324 " const char *device,\n"
15326 " int bootable);\n"
15332 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3286
15334 "This sets the bootable flag on partition numbered C<partnum> on device "
15335 "C<device>. Note that partitions are numbered from 1."
15340 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3289
15342 "The bootable flag is used by some operating systems (notably Windows) to "
15343 "determine which partition to boot from. It is by no means universally "
15349 #: ../src/guestfs-actions.pod:4916
15350 msgid "guestfs_part_set_mbr_id"
15355 #: ../src/guestfs-actions.pod:4918
15359 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15360 " const char *device,\n"
15368 #: ../src/guestfs-actions.pod:4924 ../fish/guestfish-actions.pod:3297
15370 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15371 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15372 "documentation are in fact hexadecimal numbers, but usually documented "
15373 "without any leading \"0x\" which might be confusing."
15378 #: ../src/guestfs-actions.pod:4938
15379 msgid "guestfs_part_set_name"
15384 #: ../src/guestfs-actions.pod:4940
15388 " guestfs_part_set_name (guestfs_h *g,\n"
15389 " const char *device,\n"
15391 " const char *name);\n"
15397 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3311
15399 "This sets the partition name on partition numbered C<partnum> on device "
15400 "C<device>. Note that partitions are numbered from 1."
15405 #: ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3314
15407 "The partition name can only be set on certain types of partition table. "
15408 "This works on C<gpt> but not on C<mbr> partitions."
15413 #: ../src/guestfs-actions.pod:4956
15414 msgid "guestfs_part_to_dev"
15419 #: ../src/guestfs-actions.pod:4958
15423 " guestfs_part_to_dev (guestfs_h *g,\n"
15424 " const char *partition);\n"
15430 #: ../src/guestfs-actions.pod:4962 ../fish/guestfish-actions.pod:3321
15432 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15433 "partition number, returning the device name (eg. \"/dev/sdb\")."
15438 #: ../src/guestfs-actions.pod:4966
15440 "The named partition must exist, for example as a string returned from "
15441 "C<guestfs_list_partitions>."
15446 #: ../src/guestfs-actions.pod:4974
15447 msgid "guestfs_ping_daemon"
15452 #: ../src/guestfs-actions.pod:4976
15456 " guestfs_ping_daemon (guestfs_h *g);\n"
15462 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3332
15464 "This is a test probe into the guestfs daemon running inside the qemu "
15465 "subprocess. Calling this function checks that the daemon responds to the "
15466 "ping message, without affecting the daemon or attached block device(s) in "
15472 #: ../src/guestfs-actions.pod:4988
15473 msgid "guestfs_pread"
15478 #: ../src/guestfs-actions.pod:4990
15482 " guestfs_pread (guestfs_h *g,\n"
15483 " const char *path,\n"
15485 " int64_t offset,\n"
15486 " size_t *size_r);\n"
15492 #: ../src/guestfs-actions.pod:4997 ../fish/guestfish-actions.pod:3341
15494 "This command lets you read part of a file. It reads C<count> bytes of the "
15495 "file, starting at C<offset>, from file C<path>."
15500 #: ../src/guestfs-actions.pod:5000 ../src/guestfs-actions.pod:5026
15501 #: ../fish/guestfish-actions.pod:3344 ../fish/guestfish-actions.pod:3359
15503 "This may read fewer bytes than requested. For further details see the "
15504 "L<pread(2)> system call."
15509 #: ../src/guestfs-actions.pod:5003
15510 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15515 #: ../src/guestfs-actions.pod:5014
15516 msgid "guestfs_pread_device"
15521 #: ../src/guestfs-actions.pod:5016
15525 " guestfs_pread_device (guestfs_h *g,\n"
15526 " const char *device,\n"
15528 " int64_t offset,\n"
15529 " size_t *size_r);\n"
15535 #: ../src/guestfs-actions.pod:5023 ../fish/guestfish-actions.pod:3356
15537 "This command lets you read part of a file. It reads C<count> bytes of "
15538 "C<device>, starting at C<offset>."
15543 #: ../src/guestfs-actions.pod:5029
15544 msgid "See also C<guestfs_pread>."
15549 #: ../src/guestfs-actions.pod:5038
15550 msgid "(Added in 1.5.21)"
15555 #: ../src/guestfs-actions.pod:5040
15556 msgid "guestfs_pvcreate"
15561 #: ../src/guestfs-actions.pod:5042
15565 " guestfs_pvcreate (guestfs_h *g,\n"
15566 " const char *device);\n"
15572 #: ../src/guestfs-actions.pod:5046 ../fish/guestfish-actions.pod:3371
15574 "This creates an LVM physical volume on the named C<device>, where C<device> "
15575 "should usually be a partition name such as C</dev/sda1>."
15580 #: ../src/guestfs-actions.pod:5054
15581 msgid "guestfs_pvremove"
15586 #: ../src/guestfs-actions.pod:5056
15590 " guestfs_pvremove (guestfs_h *g,\n"
15591 " const char *device);\n"
15597 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3379
15599 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15605 #: ../src/guestfs-actions.pod:5063 ../fish/guestfish-actions.pod:3382
15607 "The implementation uses the C<pvremove> command which refuses to wipe "
15608 "physical volumes that contain any volume groups, so you have to remove those "
15614 #: ../src/guestfs-actions.pod:5071
15615 msgid "guestfs_pvresize"
15620 #: ../src/guestfs-actions.pod:5073
15624 " guestfs_pvresize (guestfs_h *g,\n"
15625 " const char *device);\n"
15631 #: ../src/guestfs-actions.pod:5077 ../fish/guestfish-actions.pod:3390
15633 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15634 "the new size of the underlying device."
15639 #: ../src/guestfs-actions.pod:5084
15640 msgid "guestfs_pvresize_size"
15645 #: ../src/guestfs-actions.pod:5086
15649 " guestfs_pvresize_size (guestfs_h *g,\n"
15650 " const char *device,\n"
15651 " int64_t size);\n"
15657 #: ../src/guestfs-actions.pod:5091
15659 "This command is the same as C<guestfs_pvresize> except that it allows you to "
15660 "specify the new size (in bytes) explicitly."
15665 #: ../src/guestfs-actions.pod:5098
15666 msgid "guestfs_pvs"
15671 #: ../src/guestfs-actions.pod:5100
15675 " guestfs_pvs (guestfs_h *g);\n"
15681 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3404
15683 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15689 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3407
15691 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15697 #: ../src/guestfs-actions.pod:5109
15698 msgid "See also C<guestfs_pvs_full>."
15703 #: ../src/guestfs-actions.pod:5117
15704 msgid "guestfs_pvs_full"
15709 #: ../src/guestfs-actions.pod:5119
15712 " struct guestfs_lvm_pv_list *\n"
15713 " guestfs_pvs_full (guestfs_h *g);\n"
15719 #: ../src/guestfs-actions.pod:5122 ../fish/guestfish-actions.pod:3416
15721 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15722 "(8)> command. The \"full\" version includes all fields."
15727 #: ../src/guestfs-actions.pod:5125
15729 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15730 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
15735 #: ../src/guestfs-actions.pod:5131
15736 msgid "guestfs_pvuuid"
15741 #: ../src/guestfs-actions.pod:5133
15745 " guestfs_pvuuid (guestfs_h *g,\n"
15746 " const char *device);\n"
15752 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3423
15753 msgid "This command returns the UUID of the LVM PV C<device>."
15758 #: ../src/guestfs-actions.pod:5144
15759 msgid "guestfs_pwrite"
15764 #: ../src/guestfs-actions.pod:5146
15768 " guestfs_pwrite (guestfs_h *g,\n"
15769 " const char *path,\n"
15770 " const char *content,\n"
15771 " size_t content_size,\n"
15772 " int64_t offset);\n"
15778 #: ../src/guestfs-actions.pod:5153 ../fish/guestfish-actions.pod:3429
15780 "This command writes to part of a file. It writes the data buffer C<content> "
15781 "to the file C<path> starting at offset C<offset>."
15786 #: ../src/guestfs-actions.pod:5156 ../fish/guestfish-actions.pod:3432
15788 "This command implements the L<pwrite(2)> system call, and like that system "
15789 "call it may not write the full data requested. The return value is the "
15790 "number of bytes that were actually written to the file. This could even be "
15791 "0, although short writes are unlikely for regular files in ordinary "
15797 #: ../src/guestfs-actions.pod:5162
15798 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15803 #: ../src/guestfs-actions.pod:5171
15804 msgid "guestfs_pwrite_device"
15809 #: ../src/guestfs-actions.pod:5173
15813 " guestfs_pwrite_device (guestfs_h *g,\n"
15814 " const char *device,\n"
15815 " const char *content,\n"
15816 " size_t content_size,\n"
15817 " int64_t offset);\n"
15823 #: ../src/guestfs-actions.pod:5180 ../fish/guestfish-actions.pod:3447
15825 "This command writes to part of a device. It writes the data buffer "
15826 "C<content> to C<device> starting at offset C<offset>."
15831 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3450
15833 "This command implements the L<pwrite(2)> system call, and like that system "
15834 "call it may not write the full data requested (although short writes to disk "
15835 "devices and partitions are probably impossible with standard Linux kernels)."
15840 #: ../src/guestfs-actions.pod:5188
15841 msgid "See also C<guestfs_pwrite>."
15846 #: ../src/guestfs-actions.pod:5195
15847 msgid "(Added in 1.5.20)"
15852 #: ../src/guestfs-actions.pod:5197
15853 msgid "guestfs_read_file"
15858 #: ../src/guestfs-actions.pod:5199
15862 " guestfs_read_file (guestfs_h *g,\n"
15863 " const char *path,\n"
15864 " size_t *size_r);\n"
15870 #: ../src/guestfs-actions.pod:5204 ../fish/guestfish-actions.pod:3464
15871 msgid "This calls returns the contents of the file C<path> as a buffer."
15876 #: ../src/guestfs-actions.pod:5207
15878 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
15879 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
15880 "function is limited in the total size of file that can be handled."
15885 #: ../src/guestfs-actions.pod:5219
15886 msgid "(Added in 1.0.63)"
15891 #: ../src/guestfs-actions.pod:5221
15892 msgid "guestfs_read_lines"
15897 #: ../src/guestfs-actions.pod:5223
15901 " guestfs_read_lines (guestfs_h *g,\n"
15902 " const char *path);\n"
15908 #: ../src/guestfs-actions.pod:5229 ../fish/guestfish-actions.pod:3481
15910 "The file contents are returned as a list of lines. Trailing C<LF> and "
15911 "C<CRLF> character sequences are I<not> returned."
15916 #: ../src/guestfs-actions.pod:5232
15918 "Note that this function cannot correctly handle binary files (specifically, "
15919 "files containing C<\\0> character which is treated as end of line). For "
15920 "those you need to use the C<guestfs_read_file> function which has a more "
15921 "complex interface."
15926 #: ../src/guestfs-actions.pod:5243
15927 msgid "guestfs_readdir"
15932 #: ../src/guestfs-actions.pod:5245
15935 " struct guestfs_dirent_list *\n"
15936 " guestfs_readdir (guestfs_h *g,\n"
15937 " const char *dir);\n"
15943 #: ../src/guestfs-actions.pod:5249 ../fish/guestfish-actions.pod:3493
15944 msgid "This returns the list of directory entries in directory C<dir>."
15949 #: ../src/guestfs-actions.pod:5251 ../fish/guestfish-actions.pod:3495
15951 "All entries in the directory are returned, including C<.> and C<..>. The "
15952 "entries are I<not> sorted, but returned in the same order as the underlying "
15958 #: ../src/guestfs-actions.pod:5255 ../fish/guestfish-actions.pod:3499
15960 "Also this call returns basic file type information about each file. The "
15961 "C<ftyp> field will contain one of the following characters:"
15966 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3504
15972 #: ../src/guestfs-actions.pod:5262 ../fish/guestfish-actions.pod:3506
15973 msgid "Block special"
15978 #: ../src/guestfs-actions.pod:5264 ../fish/guestfish-actions.pod:3508
15984 #: ../src/guestfs-actions.pod:5266 ../fish/guestfish-actions.pod:3510
15985 msgid "Char special"
15990 #: ../src/guestfs-actions.pod:5268 ../fish/guestfish-actions.pod:3512
15996 #: ../src/guestfs-actions.pod:5270 ../fish/guestfish-actions.pod:3514
16002 #: ../src/guestfs-actions.pod:5272 ../fish/guestfish-actions.pod:3516
16008 #: ../src/guestfs-actions.pod:5274 ../fish/guestfish-actions.pod:3518
16009 msgid "FIFO (named pipe)"
16014 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3520
16020 #: ../src/guestfs-actions.pod:5278 ../fish/guestfish-actions.pod:3522
16021 msgid "Symbolic link"
16026 #: ../src/guestfs-actions.pod:5280 ../fish/guestfish-actions.pod:3524
16032 #: ../src/guestfs-actions.pod:5282 ../fish/guestfish-actions.pod:3526
16033 msgid "Regular file"
16038 #: ../src/guestfs-actions.pod:5284 ../fish/guestfish-actions.pod:3528
16044 #: ../src/guestfs-actions.pod:5286 ../fish/guestfish-actions.pod:3530
16050 #: ../src/guestfs-actions.pod:5288 ../fish/guestfish-actions.pod:3532
16056 #: ../src/guestfs-actions.pod:5290 ../fish/guestfish-actions.pod:3534
16057 msgid "Unknown file type"
16062 #: ../src/guestfs-actions.pod:5292 ../fish/guestfish-actions.pod:3536
16068 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3538
16070 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16075 #: ../src/guestfs-actions.pod:5299
16077 "This function is primarily intended for use by programs. To get a simple "
16078 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16079 "consumption, use C<guestfs_ll>."
16084 #: ../src/guestfs-actions.pod:5303
16086 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16087 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
16092 #: ../src/guestfs-actions.pod:5309
16093 msgid "guestfs_readlink"
16098 #: ../src/guestfs-actions.pod:5311
16102 " guestfs_readlink (guestfs_h *g,\n"
16103 " const char *path);\n"
16109 #: ../src/guestfs-actions.pod:5315 ../fish/guestfish-actions.pod:3551
16110 msgid "This command reads the target of a symbolic link."
16115 #: ../src/guestfs-actions.pod:5322
16116 msgid "guestfs_readlinklist"
16121 #: ../src/guestfs-actions.pod:5324
16125 " guestfs_readlinklist (guestfs_h *g,\n"
16126 " const char *path,\n"
16127 " char *const *names);\n"
16133 #: ../src/guestfs-actions.pod:5329 ../fish/guestfish-actions.pod:3557
16135 "This call allows you to do a C<readlink> operation on multiple files, where "
16136 "all files are in the directory C<path>. C<names> is the list of files from "
16142 #: ../src/guestfs-actions.pod:5333 ../fish/guestfish-actions.pod:3561
16144 "On return you get a list of strings, with a one-to-one correspondence to the "
16145 "C<names> list. Each string is the value of the symbolic link."
16150 #: ../src/guestfs-actions.pod:5337 ../fish/guestfish-actions.pod:3565
16152 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16153 "result string is the empty string C<\"\">. However the whole operation is "
16154 "completed even if there were C<readlink(2)> errors, and so you can call this "
16155 "function with names where you don't know if they are symbolic links already "
16156 "(albeit slightly less efficient)."
16161 #: ../src/guestfs-actions.pod:5344 ../fish/guestfish-actions.pod:3572
16163 "This call is intended for programs that want to efficiently list a directory "
16164 "contents without making many round-trips. Very long directory listings "
16165 "might cause the protocol message size to be exceeded, causing this call to "
16166 "fail. The caller must split up such requests into smaller groups of names."
16171 #: ../src/guestfs-actions.pod:5357
16172 msgid "guestfs_realpath"
16177 #: ../src/guestfs-actions.pod:5359
16181 " guestfs_realpath (guestfs_h *g,\n"
16182 " const char *path);\n"
16188 #: ../src/guestfs-actions.pod:5363 ../fish/guestfish-actions.pod:3583
16190 "Return the canonicalized absolute pathname of C<path>. The returned path "
16191 "has no C<.>, C<..> or symbolic link path elements."
16196 #: ../src/guestfs-actions.pod:5371
16197 msgid "guestfs_removexattr"
16202 #: ../src/guestfs-actions.pod:5373
16206 " guestfs_removexattr (guestfs_h *g,\n"
16207 " const char *xattr,\n"
16208 " const char *path);\n"
16214 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3590
16216 "This call removes the extended attribute named C<xattr> of the file C<path>."
16221 #: ../src/guestfs-actions.pod:5381
16222 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16227 #: ../src/guestfs-actions.pod:5387
16228 msgid "guestfs_resize2fs"
16233 #: ../src/guestfs-actions.pod:5389
16237 " guestfs_resize2fs (guestfs_h *g,\n"
16238 " const char *device);\n"
16244 #: ../src/guestfs-actions.pod:5393 ../fish/guestfish-actions.pod:3599
16246 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16247 "underlying device."
16252 #: ../src/guestfs-actions.pod:5396
16254 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16255 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16256 "sometimes gives an error about this and sometimes not. In any case, it is "
16257 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16262 #: ../src/guestfs-actions.pod:5406
16263 msgid "guestfs_resize2fs_size"
16268 #: ../src/guestfs-actions.pod:5408
16272 " guestfs_resize2fs_size (guestfs_h *g,\n"
16273 " const char *device,\n"
16274 " int64_t size);\n"
16280 #: ../src/guestfs-actions.pod:5413
16282 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16283 "to specify the new size (in bytes) explicitly."
16288 #: ../src/guestfs-actions.pod:5420
16294 #: ../src/guestfs-actions.pod:5422
16298 " guestfs_rm (guestfs_h *g,\n"
16299 " const char *path);\n"
16305 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3619
16306 msgid "Remove the single file C<path>."
16311 #: ../src/guestfs-actions.pod:5432
16312 msgid "guestfs_rm_rf"
16317 #: ../src/guestfs-actions.pod:5434
16321 " guestfs_rm_rf (guestfs_h *g,\n"
16322 " const char *path);\n"
16328 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3625
16330 "Remove the file or directory C<path>, recursively removing the contents if "
16331 "its a directory. This is like the C<rm -rf> shell command."
16336 #: ../src/guestfs-actions.pod:5446
16337 msgid "guestfs_rmdir"
16342 #: ../src/guestfs-actions.pod:5448
16346 " guestfs_rmdir (guestfs_h *g,\n"
16347 " const char *path);\n"
16353 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3633
16354 msgid "Remove the single directory C<path>."
16359 #: ../src/guestfs-actions.pod:5458
16360 msgid "guestfs_rmmountpoint"
16365 #: ../src/guestfs-actions.pod:5460
16369 " guestfs_rmmountpoint (guestfs_h *g,\n"
16370 " const char *exemptpath);\n"
16376 #: ../src/guestfs-actions.pod:5464
16378 "This calls removes a mountpoint that was previously created with "
16379 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16384 #: ../src/guestfs-actions.pod:5472
16385 msgid "guestfs_scrub_device"
16390 #: ../src/guestfs-actions.pod:5474
16394 " guestfs_scrub_device (guestfs_h *g,\n"
16395 " const char *device);\n"
16401 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3647
16403 "This command writes patterns over C<device> to make data retrieval more "
16409 #: ../src/guestfs-actions.pod:5481 ../src/guestfs-actions.pod:5502
16410 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3650
16411 #: ../fish/guestfish-actions.pod:3665 ../fish/guestfish-actions.pod:3678
16413 "It is an interface to the L<scrub(1)> program. See that manual page for "
16419 #: ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5507
16420 #: ../src/guestfs-actions.pod:5526
16421 msgid "(Added in 1.0.52)"
16426 #: ../src/guestfs-actions.pod:5491
16427 msgid "guestfs_scrub_file"
16432 #: ../src/guestfs-actions.pod:5493
16436 " guestfs_scrub_file (guestfs_h *g,\n"
16437 " const char *file);\n"
16443 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3660
16445 "This command writes patterns over a file to make data retrieval more "
16451 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3663
16452 msgid "The file is I<removed> after scrubbing."
16457 #: ../src/guestfs-actions.pod:5509
16458 msgid "guestfs_scrub_freespace"
16463 #: ../src/guestfs-actions.pod:5511
16467 " guestfs_scrub_freespace (guestfs_h *g,\n"
16468 " const char *dir);\n"
16474 #: ../src/guestfs-actions.pod:5515
16476 "This command creates the directory C<dir> and then fills it with files until "
16477 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16478 "and deletes them. The intention is to scrub any free space on the partition "
16479 "containing C<dir>."
16484 #: ../src/guestfs-actions.pod:5528
16485 msgid "guestfs_set_append"
16490 #: ../src/guestfs-actions.pod:5530
16494 " guestfs_set_append (guestfs_h *g,\n"
16495 " const char *append);\n"
16501 #: ../src/guestfs-actions.pod:5534 ../fish/guestfish-actions.pod:3687
16503 "This function is used to add additional options to the guest kernel command "
16509 #: ../src/guestfs-actions.pod:5537 ../fish/guestfish-actions.pod:3690
16511 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16512 "environment variable."
16517 #: ../src/guestfs-actions.pod:5540 ../fish/guestfish-actions.pod:3693
16519 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16520 "(libguestfs always adds a few of its own)."
16525 #: ../src/guestfs-actions.pod:5547
16526 msgid "guestfs_set_autosync"
16531 #: ../src/guestfs-actions.pod:5549
16535 " guestfs_set_autosync (guestfs_h *g,\n"
16536 " int autosync);\n"
16542 #: ../src/guestfs-actions.pod:5553
16544 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16545 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
16546 "the handle is closed (also if the program exits without closing handles)."
16551 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3707
16553 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16554 "disabled by default)."
16559 #: ../src/guestfs-actions.pod:5565
16560 msgid "guestfs_set_direct"
16565 #: ../src/guestfs-actions.pod:5567
16569 " guestfs_set_direct (guestfs_h *g,\n"
16576 #: ../src/guestfs-actions.pod:5571 ../fish/guestfish-actions.pod:3716
16578 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16579 "passed directly through to the appliance once it is launched."
16584 #: ../src/guestfs-actions.pod:5575
16586 "One consequence of this is that log messages aren't caught by the library "
16587 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16593 #: ../src/guestfs-actions.pod:5579 ../fish/guestfish-actions.pod:3724
16594 msgid "You probably don't want to use this unless you know what you are doing."
16599 #: ../src/guestfs-actions.pod:5582 ../fish/guestfish-actions.pod:3727
16600 msgid "The default is disabled."
16605 #: ../src/guestfs-actions.pod:5588
16606 msgid "guestfs_set_e2label"
16611 #: ../src/guestfs-actions.pod:5590
16615 " guestfs_set_e2label (guestfs_h *g,\n"
16616 " const char *device,\n"
16617 " const char *label);\n"
16623 #: ../src/guestfs-actions.pod:5595 ../fish/guestfish-actions.pod:3733
16625 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16626 "C<label>. Filesystem labels are limited to 16 characters."
16631 #: ../src/guestfs-actions.pod:5599
16633 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16634 "the existing label on a filesystem."
16639 #: ../src/guestfs-actions.pod:5606
16640 msgid "guestfs_set_e2uuid"
16645 #: ../src/guestfs-actions.pod:5608
16649 " guestfs_set_e2uuid (guestfs_h *g,\n"
16650 " const char *device,\n"
16651 " const char *uuid);\n"
16657 #: ../src/guestfs-actions.pod:5613 ../fish/guestfish-actions.pod:3744
16659 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16660 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16661 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16666 #: ../src/guestfs-actions.pod:5618
16668 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16669 "the existing UUID of a filesystem."
16674 #: ../src/guestfs-actions.pod:5625
16675 msgid "guestfs_set_memsize"
16680 #: ../src/guestfs-actions.pod:5627
16684 " guestfs_set_memsize (guestfs_h *g,\n"
16691 #: ../src/guestfs-actions.pod:5631
16693 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16694 "This only has any effect if called before C<guestfs_launch>."
16699 #: ../src/guestfs-actions.pod:5635 ../fish/guestfish-actions.pod:3762
16701 "You can also change this by setting the environment variable "
16702 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16707 #: ../src/guestfs-actions.pod:5646
16708 msgid "guestfs_set_network"
16713 #: ../src/guestfs-actions.pod:5648
16717 " guestfs_set_network (guestfs_h *g,\n"
16724 #: ../src/guestfs-actions.pod:5652 ../fish/guestfish-actions.pod:3775
16726 "If C<network> is true, then the network is enabled in the libguestfs "
16727 "appliance. The default is false."
16732 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3778
16734 "This affects whether commands are able to access the network (see L<guestfs"
16735 "(3)/RUNNING COMMANDS>)."
16740 #: ../src/guestfs-actions.pod:5658
16742 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16748 #: ../src/guestfs-actions.pod:5665
16749 msgid "guestfs_set_path"
16754 #: ../src/guestfs-actions.pod:5667
16758 " guestfs_set_path (guestfs_h *g,\n"
16759 " const char *searchpath);\n"
16765 #: ../src/guestfs-actions.pod:5671 ../fish/guestfish-actions.pod:3790
16766 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16771 #: ../src/guestfs-actions.pod:5673 ../fish/guestfish-actions.pod:3792
16773 "The default is C<$libdir/guestfs> unless overridden by setting "
16774 "C<LIBGUESTFS_PATH> environment variable."
16779 #: ../src/guestfs-actions.pod:5676 ../fish/guestfish-actions.pod:3795
16780 msgid "Setting C<path> to C<NULL> restores the default path."
16785 #: ../src/guestfs-actions.pod:5682
16786 msgid "guestfs_set_qemu"
16791 #: ../src/guestfs-actions.pod:5684
16795 " guestfs_set_qemu (guestfs_h *g,\n"
16796 " const char *qemu);\n"
16802 #: ../src/guestfs-actions.pod:5688 ../fish/guestfish-actions.pod:3803
16803 msgid "Set the qemu binary that we will use."
16808 #: ../src/guestfs-actions.pod:5690 ../fish/guestfish-actions.pod:3805
16810 "The default is chosen when the library was compiled by the configure script."
16815 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3808
16817 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16823 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3811
16824 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16829 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3813
16831 "Note that you should call this function as early as possible after creating "
16832 "the handle. This is because some pre-launch operations depend on testing "
16833 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16834 "don't retest features, and so you might see inconsistent results. Using the "
16835 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16836 "the qemu binary at the same time as the handle is created."
16841 #: ../src/guestfs-actions.pod:5710
16842 msgid "guestfs_set_recovery_proc"
16847 #: ../src/guestfs-actions.pod:5712
16851 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16852 " int recoveryproc);\n"
16858 #: ../src/guestfs-actions.pod:5716
16860 "If this is called with the parameter C<false> then C<guestfs_launch> does "
16861 "not create a recovery process. The purpose of the recovery process is to "
16862 "stop runaway qemu processes in the case where the main program aborts "
16868 #: ../src/guestfs-actions.pod:5721
16870 "This only has any effect if called before C<guestfs_launch>, and the default "
16876 #: ../src/guestfs-actions.pod:5724 ../fish/guestfish-actions.pod:3835
16878 "About the only time when you would want to disable this is if the main "
16879 "process will fork itself into the background (\"daemonize\" itself). In "
16880 "this case the recovery process thinks that the main program has disappeared "
16881 "and so kills qemu, which is not very helpful."
16886 #: ../src/guestfs-actions.pod:5734
16887 msgid "guestfs_set_selinux"
16892 #: ../src/guestfs-actions.pod:5736
16896 " guestfs_set_selinux (guestfs_h *g,\n"
16903 #: ../src/guestfs-actions.pod:5740 ../fish/guestfish-actions.pod:3847
16905 "This sets the selinux flag that is passed to the appliance at boot time. "
16906 "The default is C<selinux=0> (disabled)."
16911 #: ../src/guestfs-actions.pod:5743 ../fish/guestfish-actions.pod:3850
16913 "Note that if SELinux is enabled, it is always in Permissive mode "
16914 "(C<enforcing=0>)."
16919 #: ../src/guestfs-actions.pod:5753
16920 msgid "guestfs_set_trace"
16925 #: ../src/guestfs-actions.pod:5755
16929 " guestfs_set_trace (guestfs_h *g,\n"
16936 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3862
16938 "If the command trace flag is set to 1, then commands are printed on stderr "
16939 "before they are executed in a format which is very similar to the one used "
16940 "by guestfish. In other words, you can run a program with this enabled, and "
16941 "you will get out a script which you can feed to guestfish to perform the "
16942 "same set of actions."
16947 #: ../src/guestfs-actions.pod:5766 ../fish/guestfish-actions.pod:3869
16949 "If you want to trace C API calls into libguestfs (and other libraries) then "
16950 "possibly a better way is to use the external ltrace(1) command."
16955 #: ../src/guestfs-actions.pod:5770 ../fish/guestfish-actions.pod:3873
16957 "Command traces are disabled unless the environment variable "
16958 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
16963 #: ../src/guestfs-actions.pod:5777
16964 msgid "guestfs_set_verbose"
16969 #: ../src/guestfs-actions.pod:5779
16973 " guestfs_set_verbose (guestfs_h *g,\n"
16980 #: ../src/guestfs-actions.pod:5783 ../fish/guestfish-actions.pod:3882
16981 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
16986 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3884
16988 "Verbose messages are disabled unless the environment variable "
16989 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
16994 #: ../src/guestfs-actions.pod:5792
16995 msgid "guestfs_setcon"
17000 #: ../src/guestfs-actions.pod:5794
17004 " guestfs_setcon (guestfs_h *g,\n"
17005 " const char *context);\n"
17011 #: ../src/guestfs-actions.pod:5798 ../fish/guestfish-actions.pod:3891
17013 "This sets the SELinux security context of the daemon to the string "
17019 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3894
17020 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17025 #: ../src/guestfs-actions.pod:5807
17026 msgid "guestfs_setxattr"
17031 #: ../src/guestfs-actions.pod:5809
17035 " guestfs_setxattr (guestfs_h *g,\n"
17036 " const char *xattr,\n"
17037 " const char *val,\n"
17039 " const char *path);\n"
17045 #: ../src/guestfs-actions.pod:5816 ../fish/guestfish-actions.pod:3900
17047 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17048 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17053 #: ../src/guestfs-actions.pod:5820
17054 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17059 #: ../src/guestfs-actions.pod:5826
17060 msgid "guestfs_sfdisk"
17065 #: ../src/guestfs-actions.pod:5828
17069 " guestfs_sfdisk (guestfs_h *g,\n"
17070 " const char *device,\n"
17074 " char *const *lines);\n"
17080 #: ../src/guestfs-actions.pod:5836 ../fish/guestfish-actions.pod:3910
17082 "This is a direct interface to the L<sfdisk(8)> program for creating "
17083 "partitions on block devices."
17088 #: ../src/guestfs-actions.pod:5839 ../fish/guestfish-actions.pod:3913
17089 msgid "C<device> should be a block device, for example C</dev/sda>."
17094 #: ../src/guestfs-actions.pod:5841 ../fish/guestfish-actions.pod:3915
17096 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17097 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17098 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17099 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17100 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17101 "the kernel) cannot work out the right geometry and you will need to tell it."
17106 #: ../src/guestfs-actions.pod:5849 ../fish/guestfish-actions.pod:3923
17108 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17109 "refer to the L<sfdisk(8)> manpage."
17114 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3926
17116 "To create a single partition occupying the whole disk, you would pass "
17117 "C<lines> as a single element list, when the single element being the string "
17123 #: ../src/guestfs-actions.pod:5856
17125 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17130 #: ../src/guestfs-actions.pod:5866
17131 msgid "guestfs_sfdiskM"
17136 #: ../src/guestfs-actions.pod:5868
17140 " guestfs_sfdiskM (guestfs_h *g,\n"
17141 " const char *device,\n"
17142 " char *const *lines);\n"
17148 #: ../src/guestfs-actions.pod:5873
17150 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17151 "partition sizes are specified in megabytes only (rounded to the nearest "
17152 "cylinder) and you don't need to specify the cyls, heads and sectors "
17153 "parameters which were rarely if ever used anyway."
17158 #: ../src/guestfs-actions.pod:5879
17160 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17161 "C<guestfs_part_disk>"
17166 #: ../src/guestfs-actions.pod:5889
17167 msgid "guestfs_sfdisk_N"
17172 #: ../src/guestfs-actions.pod:5891
17176 " guestfs_sfdisk_N (guestfs_h *g,\n"
17177 " const char *device,\n"
17182 " const char *line);\n"
17188 #: ../src/guestfs-actions.pod:5900 ../fish/guestfish-actions.pod:3956
17190 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17191 "(note: C<n> counts from 1)."
17196 #: ../src/guestfs-actions.pod:5903
17198 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17199 "for the cyls/heads/sectors parameters."
17204 #: ../src/guestfs-actions.pod:5906
17205 msgid "See also: C<guestfs_part_add>"
17210 #: ../src/guestfs-actions.pod:5915
17211 msgid "guestfs_sfdisk_disk_geometry"
17216 #: ../src/guestfs-actions.pod:5917
17220 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17221 " const char *device);\n"
17227 #: ../src/guestfs-actions.pod:5921
17229 "This displays the disk geometry of C<device> read from the partition table. "
17230 "Especially in the case where the underlying block device has been resized, "
17231 "this can be different from the kernel's idea of the geometry (see "
17232 "C<guestfs_sfdisk_kernel_geometry>)."
17237 #: ../src/guestfs-actions.pod:5926 ../src/guestfs-actions.pod:5942
17238 #: ../fish/guestfish-actions.pod:3976 ../fish/guestfish-actions.pod:3985
17239 msgid "The result is in human-readable format, and not designed to be parsed."
17244 #: ../src/guestfs-actions.pod:5934
17245 msgid "guestfs_sfdisk_kernel_geometry"
17250 #: ../src/guestfs-actions.pod:5936
17254 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17255 " const char *device);\n"
17261 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:3983
17262 msgid "This displays the kernel's idea of the geometry of C<device>."
17267 #: ../src/guestfs-actions.pod:5950
17268 msgid "guestfs_sfdisk_l"
17273 #: ../src/guestfs-actions.pod:5952
17277 " guestfs_sfdisk_l (guestfs_h *g,\n"
17278 " const char *device);\n"
17284 #: ../src/guestfs-actions.pod:5956 ../fish/guestfish-actions.pod:3992
17286 "This displays the partition table on C<device>, in the human-readable output "
17287 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17292 #: ../src/guestfs-actions.pod:5960
17293 msgid "See also: C<guestfs_part_list>"
17298 #: ../src/guestfs-actions.pod:5967
17304 #: ../src/guestfs-actions.pod:5969
17308 " guestfs_sh (guestfs_h *g,\n"
17309 " const char *command);\n"
17315 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4002
17317 "This call runs a command from the guest filesystem via the guest's C</bin/"
17323 #: ../src/guestfs-actions.pod:5976
17324 msgid "This is like C<guestfs_command>, but passes the command to:"
17329 #: ../src/guestfs-actions.pod:5978 ../fish/guestfish-actions.pod:4007
17332 " /bin/sh -c \"command\"\n"
17338 #: ../src/guestfs-actions.pod:5980 ../fish/guestfish-actions.pod:4009
17340 "Depending on the guest's shell, this usually results in wildcards being "
17341 "expanded, shell expressions being interpolated and so on."
17346 #: ../src/guestfs-actions.pod:5984
17347 msgid "All the provisos about C<guestfs_command> apply to this call."
17352 #: ../src/guestfs-actions.pod:5991
17353 msgid "guestfs_sh_lines"
17358 #: ../src/guestfs-actions.pod:5993
17362 " guestfs_sh_lines (guestfs_h *g,\n"
17363 " const char *command);\n"
17369 #: ../src/guestfs-actions.pod:5997
17371 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17377 #: ../src/guestfs-actions.pod:6000
17378 msgid "See also: C<guestfs_command_lines>"
17383 #: ../src/guestfs-actions.pod:6008
17384 msgid "guestfs_sleep"
17389 #: ../src/guestfs-actions.pod:6010
17393 " guestfs_sleep (guestfs_h *g,\n"
17400 #: ../src/guestfs-actions.pod:6014 ../fish/guestfish-actions.pod:4028
17401 msgid "Sleep for C<secs> seconds."
17406 #: ../src/guestfs-actions.pod:6018
17407 msgid "(Added in 1.0.41)"
17412 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-structs.pod:109
17413 msgid "guestfs_stat"
17418 #: ../src/guestfs-actions.pod:6022
17421 " struct guestfs_stat *\n"
17422 " guestfs_stat (guestfs_h *g,\n"
17423 " const char *path);\n"
17429 #: ../src/guestfs-actions.pod:6028 ../fish/guestfish-actions.pod:4036
17430 msgid "This is the same as the C<stat(2)> system call."
17435 #: ../src/guestfs-actions.pod:6036 ../src/guestfs-structs.pod:135
17436 msgid "guestfs_statvfs"
17441 #: ../src/guestfs-actions.pod:6038
17444 " struct guestfs_statvfs *\n"
17445 " guestfs_statvfs (guestfs_h *g,\n"
17446 " const char *path);\n"
17452 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:4042
17454 "Returns file system statistics for any mounted file system. C<path> should "
17455 "be a file or directory in the mounted file system (typically it is the mount "
17456 "point itself, but it doesn't need to be)."
17461 #: ../src/guestfs-actions.pod:6046 ../fish/guestfish-actions.pod:4046
17462 msgid "This is the same as the C<statvfs(2)> system call."
17467 #: ../src/guestfs-actions.pod:6048
17469 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
17470 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
17475 #: ../src/guestfs-actions.pod:6054
17476 msgid "guestfs_strings"
17481 #: ../src/guestfs-actions.pod:6056
17485 " guestfs_strings (guestfs_h *g,\n"
17486 " const char *path);\n"
17492 #: ../src/guestfs-actions.pod:6060 ../fish/guestfish-actions.pod:4052
17494 "This runs the L<strings(1)> command on a file and returns the list of "
17495 "printable strings found."
17500 #: ../src/guestfs-actions.pod:6072
17501 msgid "guestfs_strings_e"
17506 #: ../src/guestfs-actions.pod:6074
17510 " guestfs_strings_e (guestfs_h *g,\n"
17511 " const char *encoding,\n"
17512 " const char *path);\n"
17518 #: ../src/guestfs-actions.pod:6079
17520 "This is like the C<guestfs_strings> command, but allows you to specify the "
17521 "encoding of strings that are looked for in the source file C<path>."
17526 #: ../src/guestfs-actions.pod:6083 ../fish/guestfish-actions.pod:4066
17527 msgid "Allowed encodings are:"
17532 #: ../src/guestfs-actions.pod:6087 ../fish/guestfish-actions.pod:4070
17538 #: ../src/guestfs-actions.pod:6089
17540 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17541 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17546 #: ../src/guestfs-actions.pod:6092 ../fish/guestfish-actions.pod:4075
17552 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4077
17553 msgid "Single 8-bit-byte characters."
17558 #: ../src/guestfs-actions.pod:6096 ../fish/guestfish-actions.pod:4079
17564 #: ../src/guestfs-actions.pod:6098 ../fish/guestfish-actions.pod:4081
17565 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17570 #: ../src/guestfs-actions.pod:6101 ../fish/guestfish-actions.pod:4084
17571 msgid "l (lower case letter L)"
17576 #: ../src/guestfs-actions.pod:6103 ../fish/guestfish-actions.pod:4086
17578 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17579 "examining binaries in Windows guests."
17584 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4089
17590 #: ../src/guestfs-actions.pod:6108 ../fish/guestfish-actions.pod:4091
17591 msgid "32-bit big endian such as UCS-4BE."
17596 #: ../src/guestfs-actions.pod:6110 ../fish/guestfish-actions.pod:4093
17602 #: ../src/guestfs-actions.pod:6112 ../fish/guestfish-actions.pod:4095
17603 msgid "32-bit little endian such as UCS-4LE."
17608 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4099
17609 msgid "The returned strings are transcoded to UTF-8."
17614 #: ../src/guestfs-actions.pod:6127
17615 msgid "guestfs_swapoff_device"
17620 #: ../src/guestfs-actions.pod:6129
17624 " guestfs_swapoff_device (guestfs_h *g,\n"
17625 " const char *device);\n"
17631 #: ../src/guestfs-actions.pod:6133
17633 "This command disables the libguestfs appliance swap device or partition "
17634 "named C<device>. See C<guestfs_swapon_device>."
17639 #: ../src/guestfs-actions.pod:6141
17640 msgid "guestfs_swapoff_file"
17645 #: ../src/guestfs-actions.pod:6143
17649 " guestfs_swapoff_file (guestfs_h *g,\n"
17650 " const char *file);\n"
17656 #: ../src/guestfs-actions.pod:6147 ../fish/guestfish-actions.pod:4116
17657 msgid "This command disables the libguestfs appliance swap on file."
17662 #: ../src/guestfs-actions.pod:6153
17663 msgid "guestfs_swapoff_label"
17668 #: ../src/guestfs-actions.pod:6155
17672 " guestfs_swapoff_label (guestfs_h *g,\n"
17673 " const char *label);\n"
17679 #: ../src/guestfs-actions.pod:6159 ../fish/guestfish-actions.pod:4122
17681 "This command disables the libguestfs appliance swap on labeled swap "
17687 #: ../src/guestfs-actions.pod:6166
17688 msgid "guestfs_swapoff_uuid"
17693 #: ../src/guestfs-actions.pod:6168
17697 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17698 " const char *uuid);\n"
17704 #: ../src/guestfs-actions.pod:6172 ../fish/guestfish-actions.pod:4129
17706 "This command disables the libguestfs appliance swap partition with the given "
17712 #: ../src/guestfs-actions.pod:6179
17713 msgid "guestfs_swapon_device"
17718 #: ../src/guestfs-actions.pod:6181
17722 " guestfs_swapon_device (guestfs_h *g,\n"
17723 " const char *device);\n"
17729 #: ../src/guestfs-actions.pod:6185
17731 "This command enables the libguestfs appliance to use the swap device or "
17732 "partition named C<device>. The increased memory is made available for all "
17733 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17738 #: ../src/guestfs-actions.pod:6190 ../fish/guestfish-actions.pod:4141
17740 "Note that you should not swap to existing guest swap partitions unless you "
17741 "know what you are doing. They may contain hibernation information, or other "
17742 "information that the guest doesn't want you to trash. You also risk leaking "
17743 "information about the host to the guest this way. Instead, attach a new "
17744 "host device to the guest and swap on that."
17749 #: ../src/guestfs-actions.pod:6201
17750 msgid "guestfs_swapon_file"
17755 #: ../src/guestfs-actions.pod:6203
17759 " guestfs_swapon_file (guestfs_h *g,\n"
17760 " const char *file);\n"
17766 #: ../src/guestfs-actions.pod:6207
17768 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
17774 #: ../src/guestfs-actions.pod:6214
17775 msgid "guestfs_swapon_label"
17780 #: ../src/guestfs-actions.pod:6216
17784 " guestfs_swapon_label (guestfs_h *g,\n"
17785 " const char *label);\n"
17791 #: ../src/guestfs-actions.pod:6220
17793 "This command enables swap to a labeled swap partition. See "
17794 "C<guestfs_swapon_device> for other notes."
17799 #: ../src/guestfs-actions.pod:6227
17800 msgid "guestfs_swapon_uuid"
17805 #: ../src/guestfs-actions.pod:6229
17809 " guestfs_swapon_uuid (guestfs_h *g,\n"
17810 " const char *uuid);\n"
17816 #: ../src/guestfs-actions.pod:6233
17818 "This command enables swap to a swap partition with the given UUID. See "
17819 "C<guestfs_swapon_device> for other notes."
17824 #: ../src/guestfs-actions.pod:6240
17825 msgid "guestfs_sync"
17830 #: ../src/guestfs-actions.pod:6242
17834 " guestfs_sync (guestfs_h *g);\n"
17840 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4173
17842 "This syncs the disk, so that any writes are flushed through to the "
17843 "underlying disk image."
17848 #: ../src/guestfs-actions.pod:6248 ../fish/guestfish-actions.pod:4176
17850 "You should always call this if you have modified a disk image, before "
17851 "closing the handle."
17856 #: ../src/guestfs-actions.pod:6255
17857 msgid "guestfs_tail"
17862 #: ../src/guestfs-actions.pod:6257
17866 " guestfs_tail (guestfs_h *g,\n"
17867 " const char *path);\n"
17873 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4183
17875 "This command returns up to the last 10 lines of a file as a list of strings."
17880 #: ../src/guestfs-actions.pod:6273
17881 msgid "guestfs_tail_n"
17886 #: ../src/guestfs-actions.pod:6275
17890 " guestfs_tail_n (guestfs_h *g,\n"
17892 " const char *path);\n"
17898 #: ../src/guestfs-actions.pod:6280 ../fish/guestfish-actions.pod:4193
17900 "If the parameter C<nrlines> is a positive number, this returns the last "
17901 "C<nrlines> lines of the file C<path>."
17906 #: ../src/guestfs-actions.pod:6283 ../fish/guestfish-actions.pod:4196
17908 "If the parameter C<nrlines> is a negative number, this returns lines from "
17909 "the file C<path>, starting with the C<-nrlines>th line."
17914 #: ../src/guestfs-actions.pod:6297
17915 msgid "guestfs_tar_in"
17920 #: ../src/guestfs-actions.pod:6299
17924 " guestfs_tar_in (guestfs_h *g,\n"
17925 " const char *tarfile,\n"
17926 " const char *directory);\n"
17932 #: ../src/guestfs-actions.pod:6304 ../fish/guestfish-actions.pod:4208
17934 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17935 "tar file) into C<directory>."
17940 #: ../src/guestfs-actions.pod:6307
17942 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17947 #: ../src/guestfs-actions.pod:6312 ../src/guestfs-actions.pod:6329
17948 #: ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6361
17949 msgid "(Added in 1.0.3)"
17954 #: ../src/guestfs-actions.pod:6314
17955 msgid "guestfs_tar_out"
17960 #: ../src/guestfs-actions.pod:6316
17964 " guestfs_tar_out (guestfs_h *g,\n"
17965 " const char *directory,\n"
17966 " const char *tarfile);\n"
17972 #: ../src/guestfs-actions.pod:6321 ../fish/guestfish-actions.pod:4220
17974 "This command packs the contents of C<directory> and downloads it to local "
17980 #: ../src/guestfs-actions.pod:6324
17982 "To download a compressed tarball, use C<guestfs_tgz_out> or "
17983 "C<guestfs_txz_out>."
17988 #: ../src/guestfs-actions.pod:6331
17989 msgid "guestfs_tgz_in"
17994 #: ../src/guestfs-actions.pod:6333
17998 " guestfs_tgz_in (guestfs_h *g,\n"
17999 " const char *tarball,\n"
18000 " const char *directory);\n"
18006 #: ../src/guestfs-actions.pod:6338 ../fish/guestfish-actions.pod:4232
18008 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18009 "tar file) into C<directory>."
18014 #: ../src/guestfs-actions.pod:6341
18015 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18020 #: ../src/guestfs-actions.pod:6347
18021 msgid "guestfs_tgz_out"
18026 #: ../src/guestfs-actions.pod:6349
18030 " guestfs_tgz_out (guestfs_h *g,\n"
18031 " const char *directory,\n"
18032 " const char *tarball);\n"
18038 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4243
18040 "This command packs the contents of C<directory> and downloads it to local "
18046 #: ../src/guestfs-actions.pod:6357
18047 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18052 #: ../src/guestfs-actions.pod:6363
18053 msgid "guestfs_touch"
18058 #: ../src/guestfs-actions.pod:6365
18062 " guestfs_touch (guestfs_h *g,\n"
18063 " const char *path);\n"
18069 #: ../src/guestfs-actions.pod:6369 ../fish/guestfish-actions.pod:4254
18071 "Touch acts like the L<touch(1)> command. It can be used to update the "
18072 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18078 #: ../src/guestfs-actions.pod:6373 ../fish/guestfish-actions.pod:4258
18080 "This command only works on regular files, and will fail on other file types "
18081 "such as directories, symbolic links, block special etc."
18086 #: ../src/guestfs-actions.pod:6380
18087 msgid "guestfs_truncate"
18092 #: ../src/guestfs-actions.pod:6382
18096 " guestfs_truncate (guestfs_h *g,\n"
18097 " const char *path);\n"
18103 #: ../src/guestfs-actions.pod:6386 ../fish/guestfish-actions.pod:4265
18105 "This command truncates C<path> to a zero-length file. The file must exist "
18111 #: ../src/guestfs-actions.pod:6393
18112 msgid "guestfs_truncate_size"
18117 #: ../src/guestfs-actions.pod:6395
18121 " guestfs_truncate_size (guestfs_h *g,\n"
18122 " const char *path,\n"
18123 " int64_t size);\n"
18129 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4272
18131 "This command truncates C<path> to size C<size> bytes. The file must exist "
18137 #: ../src/guestfs-actions.pod:6403
18139 "If the current file size is less than C<size> then the file is extended to "
18140 "the required size with zero bytes. This creates a sparse file (ie. disk "
18141 "blocks are not allocated for the file until you write to it). To create a "
18142 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18147 #: ../src/guestfs-actions.pod:6413
18148 msgid "guestfs_tune2fs_l"
18153 #: ../src/guestfs-actions.pod:6415
18157 " guestfs_tune2fs_l (guestfs_h *g,\n"
18158 " const char *device);\n"
18164 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4285
18166 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18172 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4288
18174 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18175 "for more details. The list of fields returned isn't clearly defined, and "
18176 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18177 "and the filesystem itself."
18182 #: ../src/guestfs-actions.pod:6435
18183 msgid "guestfs_txz_in"
18188 #: ../src/guestfs-actions.pod:6437
18192 " guestfs_txz_in (guestfs_h *g,\n"
18193 " const char *tarball,\n"
18194 " const char *directory);\n"
18200 #: ../src/guestfs-actions.pod:6442 ../fish/guestfish-actions.pod:4297
18202 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18203 "tar file) into C<directory>."
18208 #: ../src/guestfs-actions.pod:6449
18209 msgid "guestfs_txz_out"
18214 #: ../src/guestfs-actions.pod:6451
18218 " guestfs_txz_out (guestfs_h *g,\n"
18219 " const char *directory,\n"
18220 " const char *tarball);\n"
18226 #: ../src/guestfs-actions.pod:6456 ../fish/guestfish-actions.pod:4306
18228 "This command packs the contents of C<directory> and downloads it to local "
18229 "file C<tarball> (as an xz compressed tar archive)."
18234 #: ../src/guestfs-actions.pod:6463
18235 msgid "guestfs_umask"
18240 #: ../src/guestfs-actions.pod:6465
18244 " guestfs_umask (guestfs_h *g,\n"
18251 #: ../src/guestfs-actions.pod:6469 ../fish/guestfish-actions.pod:4315
18253 "This function sets the mask used for creating new files and device nodes to "
18259 #: ../src/guestfs-actions.pod:6472 ../fish/guestfish-actions.pod:4318
18261 "Typical umask values would be C<022> which creates new files with "
18262 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18263 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18268 #: ../src/guestfs-actions.pod:6477 ../fish/guestfish-actions.pod:4323
18270 "The default umask is C<022>. This is important because it means that "
18271 "directories and device nodes will be created with C<0644> or C<0755> mode "
18272 "even if you specify C<0777>."
18277 #: ../src/guestfs-actions.pod:6481
18279 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18280 "C<guestfs_mkdir>."
18285 #: ../src/guestfs-actions.pod:6484 ../fish/guestfish-actions.pod:4330
18286 msgid "This call returns the previous umask."
18291 #: ../src/guestfs-actions.pod:6490
18292 msgid "guestfs_umount"
18297 #: ../src/guestfs-actions.pod:6492
18301 " guestfs_umount (guestfs_h *g,\n"
18302 " const char *pathordevice);\n"
18308 #: ../src/guestfs-actions.pod:6496 ../fish/guestfish-actions.pod:4338
18310 "This unmounts the given filesystem. The filesystem may be specified either "
18311 "by its mountpoint (path) or the device which contains the filesystem."
18316 #: ../src/guestfs-actions.pod:6504
18317 msgid "guestfs_umount_all"
18322 #: ../src/guestfs-actions.pod:6506
18326 " guestfs_umount_all (guestfs_h *g);\n"
18332 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4348
18333 msgid "This unmounts all mounted filesystems."
18338 #: ../src/guestfs-actions.pod:6511 ../fish/guestfish-actions.pod:4350
18339 msgid "Some internal mounts are not unmounted by this call."
18344 #: ../src/guestfs-actions.pod:6517
18345 msgid "guestfs_upload"
18350 #: ../src/guestfs-actions.pod:6519
18354 " guestfs_upload (guestfs_h *g,\n"
18355 " const char *filename,\n"
18356 " const char *remotefilename);\n"
18362 #: ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6548
18363 #: ../fish/guestfish-actions.pod:4356 ../fish/guestfish-actions.pod:4369
18364 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18369 #: ../src/guestfs-actions.pod:6529
18370 msgid "See also C<guestfs_download>."
18375 #: ../src/guestfs-actions.pod:6540
18376 msgid "guestfs_upload_offset"
18381 #: ../src/guestfs-actions.pod:6542
18385 " guestfs_upload_offset (guestfs_h *g,\n"
18386 " const char *filename,\n"
18387 " const char *remotefilename,\n"
18388 " int64_t offset);\n"
18394 #: ../src/guestfs-actions.pod:6551 ../fish/guestfish-actions.pod:4372
18396 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18397 "The intention is to overwrite parts of existing files or devices, although "
18398 "if a non-existant file is specified then it is created with a \"hole\" "
18399 "before C<offset>. The size of the data written is implicit in the size of "
18400 "the source C<filename>."
18405 #: ../src/guestfs-actions.pod:6558
18407 "Note that there is no limit on the amount of data that can be uploaded with "
18408 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18409 "full amount unless an error occurs."
18414 #: ../src/guestfs-actions.pod:6563
18415 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18420 #: ../src/guestfs-actions.pod:6574
18421 msgid "guestfs_utimens"
18426 #: ../src/guestfs-actions.pod:6576
18430 " guestfs_utimens (guestfs_h *g,\n"
18431 " const char *path,\n"
18432 " int64_t atsecs,\n"
18433 " int64_t atnsecs,\n"
18434 " int64_t mtsecs,\n"
18435 " int64_t mtnsecs);\n"
18441 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4392
18442 msgid "This command sets the timestamps of a file with nanosecond precision."
18447 #: ../src/guestfs-actions.pod:6587 ../fish/guestfish-actions.pod:4395
18449 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18455 #: ../src/guestfs-actions.pod:6590 ../fish/guestfish-actions.pod:4398
18457 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18458 "nanoseconds from the epoch."
18463 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4401
18465 "If the C<*nsecs> field contains the special value C<-1> then the "
18466 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18467 "ignored in this case)."
18472 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4405
18474 "If the C<*nsecs> field contains the special value C<-2> then the "
18475 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18481 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-structs.pod:175
18482 msgid "guestfs_version"
18487 #: ../src/guestfs-actions.pod:6607
18490 " struct guestfs_version *\n"
18491 " guestfs_version (guestfs_h *g);\n"
18497 #: ../src/guestfs-actions.pod:6610 ../fish/guestfish-actions.pod:4413
18499 "Return the libguestfs version number that the program is linked against."
18504 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
18506 "Note that because of dynamic linking this is not necessarily the version of "
18507 "libguestfs that you compiled against. You can compile the program, and then "
18508 "at runtime dynamically link against a completely different C<libguestfs.so> "
18514 #: ../src/guestfs-actions.pod:6618 ../fish/guestfish-actions.pod:4421
18516 "This call was added in version C<1.0.58>. In previous versions of "
18517 "libguestfs there was no way to get the version number. From C code you can "
18518 "use dynamic linker functions to find out if this symbol exists (if it "
18519 "doesn't, then it's an earlier version)."
18524 #: ../src/guestfs-actions.pod:6624 ../fish/guestfish-actions.pod:4427
18526 "The call returns a structure with four elements. The first three (C<major>, "
18527 "C<minor> and C<release>) are numbers and correspond to the usual version "
18528 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18529 "but may be used for distro-specific information."
18534 #: ../src/guestfs-actions.pod:6630 ../fish/guestfish-actions.pod:4433
18536 "To construct the original version string: C<$major.$minor.$release$extra>"
18541 #: ../src/guestfs-actions.pod:6633 ../fish/guestfish-actions.pod:4436
18542 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18547 #: ../src/guestfs-actions.pod:6635
18549 "I<Note:> Don't use this call to test for availability of features. In "
18550 "enterprise distributions we backport features from later versions into "
18551 "earlier versions, making this an unreliable way to test for features. Use "
18552 "C<guestfs_available> instead."
18557 #: ../src/guestfs-actions.pod:6641
18559 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
18560 "error. I<The caller must call C<guestfs_free_version> after use>."
18565 #: ../src/guestfs-actions.pod:6645
18566 msgid "(Added in 1.0.58)"
18571 #: ../src/guestfs-actions.pod:6647
18572 msgid "guestfs_vfs_label"
18577 #: ../src/guestfs-actions.pod:6649
18581 " guestfs_vfs_label (guestfs_h *g,\n"
18582 " const char *device);\n"
18588 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4448
18589 msgid "This returns the filesystem label of the filesystem on C<device>."
18594 #: ../src/guestfs-actions.pod:6656 ../fish/guestfish-actions.pod:4451
18595 msgid "If the filesystem is unlabeled, this returns the empty string."
18600 #: ../src/guestfs-actions.pod:6658
18601 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18606 #: ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:6700
18607 msgid "(Added in 1.3.18)"
18612 #: ../src/guestfs-actions.pod:6665
18613 msgid "guestfs_vfs_type"
18618 #: ../src/guestfs-actions.pod:6667
18622 " guestfs_vfs_type (guestfs_h *g,\n"
18623 " const char *device);\n"
18629 #: ../src/guestfs-actions.pod:6671 ../fish/guestfish-actions.pod:4459
18631 "This command gets the filesystem type corresponding to the filesystem on "
18637 #: ../src/guestfs-actions.pod:6674 ../fish/guestfish-actions.pod:4462
18639 "For most filesystems, the result is the name of the Linux VFS module which "
18640 "would be used to mount this filesystem if you mounted it without specifying "
18641 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18646 #: ../src/guestfs-actions.pod:6684
18647 msgid "guestfs_vfs_uuid"
18652 #: ../src/guestfs-actions.pod:6686
18656 " guestfs_vfs_uuid (guestfs_h *g,\n"
18657 " const char *device);\n"
18663 #: ../src/guestfs-actions.pod:6690 ../fish/guestfish-actions.pod:4471
18664 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18669 #: ../src/guestfs-actions.pod:6693 ../fish/guestfish-actions.pod:4474
18670 msgid "If the filesystem does not have a UUID, this returns the empty string."
18675 #: ../src/guestfs-actions.pod:6695
18676 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18681 #: ../src/guestfs-actions.pod:6702
18682 msgid "guestfs_vg_activate"
18687 #: ../src/guestfs-actions.pod:6704
18691 " guestfs_vg_activate (guestfs_h *g,\n"
18693 " char *const *volgroups);\n"
18699 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4482
18701 "This command activates or (if C<activate> is false) deactivates all logical "
18702 "volumes in the listed volume groups C<volgroups>. If activated, then they "
18703 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
18704 "deactivated, then those devices disappear."
18709 #: ../src/guestfs-actions.pod:6715 ../fish/guestfish-actions.pod:4488
18710 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18715 #: ../src/guestfs-actions.pod:6717 ../fish/guestfish-actions.pod:4490
18717 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18718 "activated or deactivated."
18723 #: ../src/guestfs-actions.pod:6724
18724 msgid "guestfs_vg_activate_all"
18729 #: ../src/guestfs-actions.pod:6726
18733 " guestfs_vg_activate_all (guestfs_h *g,\n"
18734 " int activate);\n"
18740 #: ../src/guestfs-actions.pod:6730 ../fish/guestfish-actions.pod:4497
18742 "This command activates or (if C<activate> is false) deactivates all logical "
18743 "volumes in all volume groups. If activated, then they are made known to the "
18744 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
18745 "those devices disappear."
18750 #: ../src/guestfs-actions.pod:6736 ../fish/guestfish-actions.pod:4503
18751 msgid "This command is the same as running C<vgchange -a y|n>"
18756 #: ../src/guestfs-actions.pod:6742
18757 msgid "guestfs_vgcreate"
18762 #: ../src/guestfs-actions.pod:6744
18766 " guestfs_vgcreate (guestfs_h *g,\n"
18767 " const char *volgroup,\n"
18768 " char *const *physvols);\n"
18774 #: ../src/guestfs-actions.pod:6749 ../fish/guestfish-actions.pod:4509
18776 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18777 "of physical volumes C<physvols>."
18782 #: ../src/guestfs-actions.pod:6756
18783 msgid "guestfs_vglvuuids"
18788 #: ../src/guestfs-actions.pod:6758
18792 " guestfs_vglvuuids (guestfs_h *g,\n"
18793 " const char *vgname);\n"
18799 #: ../src/guestfs-actions.pod:6762 ../fish/guestfish-actions.pod:4516
18801 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18802 "volumes created in this volume group."
18807 #: ../src/guestfs-actions.pod:6765
18809 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18810 "associate logical volumes and volume groups."
18815 #: ../src/guestfs-actions.pod:6768
18816 msgid "See also C<guestfs_vgpvuuids>."
18821 #: ../src/guestfs-actions.pod:6776
18822 msgid "guestfs_vgpvuuids"
18827 #: ../src/guestfs-actions.pod:6778
18831 " guestfs_vgpvuuids (guestfs_h *g,\n"
18832 " const char *vgname);\n"
18838 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4528
18840 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18841 "volumes that this volume group resides on."
18846 #: ../src/guestfs-actions.pod:6785
18848 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18849 "associate physical volumes and volume groups."
18854 #: ../src/guestfs-actions.pod:6788
18855 msgid "See also C<guestfs_vglvuuids>."
18860 #: ../src/guestfs-actions.pod:6796
18861 msgid "guestfs_vgremove"
18866 #: ../src/guestfs-actions.pod:6798
18870 " guestfs_vgremove (guestfs_h *g,\n"
18871 " const char *vgname);\n"
18877 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4540
18878 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18883 #: ../src/guestfs-actions.pod:6804 ../fish/guestfish-actions.pod:4542
18885 "This also forcibly removes all logical volumes in the volume group (if any)."
18890 #: ../src/guestfs-actions.pod:6811
18891 msgid "guestfs_vgrename"
18896 #: ../src/guestfs-actions.pod:6813
18900 " guestfs_vgrename (guestfs_h *g,\n"
18901 " const char *volgroup,\n"
18902 " const char *newvolgroup);\n"
18908 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4549
18909 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18914 #: ../src/guestfs-actions.pod:6824
18915 msgid "guestfs_vgs"
18920 #: ../src/guestfs-actions.pod:6826
18924 " guestfs_vgs (guestfs_h *g);\n"
18930 #: ../src/guestfs-actions.pod:6829 ../fish/guestfish-actions.pod:4555
18932 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18938 #: ../src/guestfs-actions.pod:6832 ../fish/guestfish-actions.pod:4558
18940 "This returns a list of just the volume group names that were detected (eg. "
18946 #: ../src/guestfs-actions.pod:6835
18947 msgid "See also C<guestfs_vgs_full>."
18952 #: ../src/guestfs-actions.pod:6843
18953 msgid "guestfs_vgs_full"
18958 #: ../src/guestfs-actions.pod:6845
18961 " struct guestfs_lvm_vg_list *\n"
18962 " guestfs_vgs_full (guestfs_h *g);\n"
18968 #: ../src/guestfs-actions.pod:6848 ../fish/guestfish-actions.pod:4567
18970 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
18971 "> command. The \"full\" version includes all fields."
18976 #: ../src/guestfs-actions.pod:6851
18978 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18979 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
18984 #: ../src/guestfs-actions.pod:6857
18985 msgid "guestfs_vgscan"
18990 #: ../src/guestfs-actions.pod:6859
18994 " guestfs_vgscan (guestfs_h *g);\n"
19000 #: ../src/guestfs-actions.pod:6862 ../fish/guestfish-actions.pod:4574
19002 "This rescans all block devices and rebuilds the list of LVM physical "
19003 "volumes, volume groups and logical volumes."
19008 #: ../src/guestfs-actions.pod:6869
19009 msgid "guestfs_vguuid"
19014 #: ../src/guestfs-actions.pod:6871
19018 " guestfs_vguuid (guestfs_h *g,\n"
19019 " const char *vgname);\n"
19025 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4581
19026 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19031 #: ../src/guestfs-actions.pod:6882
19032 msgid "guestfs_wait_ready"
19037 #: ../src/guestfs-actions.pod:6884
19041 " guestfs_wait_ready (guestfs_h *g);\n"
19047 #: ../src/guestfs-actions.pod:6887
19048 msgid "This function is a no op."
19053 #: ../src/guestfs-actions.pod:6889
19055 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
19056 "calling C<guestfs_launch> to wait for the launch to complete. However this "
19057 "is no longer necessary because C<guestfs_launch> now does the waiting."
19062 #: ../src/guestfs-actions.pod:6894
19064 "If you see any calls to this function in code then you can just remove them, "
19065 "unless you want to retain compatibility with older versions of the API."
19070 #: ../src/guestfs-actions.pod:6902
19071 msgid "guestfs_wc_c"
19076 #: ../src/guestfs-actions.pod:6904
19080 " guestfs_wc_c (guestfs_h *g,\n"
19081 " const char *path);\n"
19087 #: ../src/guestfs-actions.pod:6908 ../fish/guestfish-actions.pod:4587
19089 "This command counts the characters in a file, using the C<wc -c> external "
19095 #: ../src/guestfs-actions.pod:6915
19096 msgid "guestfs_wc_l"
19101 #: ../src/guestfs-actions.pod:6917
19105 " guestfs_wc_l (guestfs_h *g,\n"
19106 " const char *path);\n"
19112 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4594
19114 "This command counts the lines in a file, using the C<wc -l> external command."
19119 #: ../src/guestfs-actions.pod:6928
19120 msgid "guestfs_wc_w"
19125 #: ../src/guestfs-actions.pod:6930
19129 " guestfs_wc_w (guestfs_h *g,\n"
19130 " const char *path);\n"
19136 #: ../src/guestfs-actions.pod:6934 ../fish/guestfish-actions.pod:4601
19138 "This command counts the words in a file, using the C<wc -w> external command."
19143 #: ../src/guestfs-actions.pod:6941
19144 msgid "guestfs_write"
19149 #: ../src/guestfs-actions.pod:6943
19153 " guestfs_write (guestfs_h *g,\n"
19154 " const char *path,\n"
19155 " const char *content,\n"
19156 " size_t content_size);\n"
19162 #: ../src/guestfs-actions.pod:6949 ../fish/guestfish-actions.pod:4608
19164 "This call creates a file called C<path>. The content of the file is the "
19165 "string C<content> (which can contain any 8 bit data)."
19170 #: ../src/guestfs-actions.pod:6959
19171 msgid "guestfs_write_file"
19176 #: ../src/guestfs-actions.pod:6961
19180 " guestfs_write_file (guestfs_h *g,\n"
19181 " const char *path,\n"
19182 " const char *content,\n"
19189 #: ../src/guestfs-actions.pod:6967 ../fish/guestfish-actions.pod:4618
19191 "This call creates a file called C<path>. The contents of the file is the "
19192 "string C<content> (which can contain any 8 bit data), with length C<size>."
19197 #: ../src/guestfs-actions.pod:6971 ../fish/guestfish-actions.pod:4622
19199 "As a special case, if C<size> is C<0> then the length is calculated using "
19200 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19205 #: ../src/guestfs-actions.pod:6975 ../fish/guestfish-actions.pod:4626
19207 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19208 "I<not> work, even if the length is specified."
19212 #: ../src/guestfs-actions.pod:6983
19214 "This function is deprecated. In new code, use the L</guestfs_write> call "
19220 #: ../src/guestfs-actions.pod:6992
19221 msgid "guestfs_zegrep"
19226 #: ../src/guestfs-actions.pod:6994
19230 " guestfs_zegrep (guestfs_h *g,\n"
19231 " const char *regex,\n"
19232 " const char *path);\n"
19238 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4643
19240 "This calls the external C<zegrep> program and returns the matching lines."
19245 #: ../src/guestfs-actions.pod:7011
19246 msgid "guestfs_zegrepi"
19251 #: ../src/guestfs-actions.pod:7013
19255 " guestfs_zegrepi (guestfs_h *g,\n"
19256 " const char *regex,\n"
19257 " const char *path);\n"
19263 #: ../src/guestfs-actions.pod:7018 ../fish/guestfish-actions.pod:4653
19265 "This calls the external C<zegrep -i> program and returns the matching lines."
19270 #: ../src/guestfs-actions.pod:7030
19271 msgid "guestfs_zero"
19276 #: ../src/guestfs-actions.pod:7032
19280 " guestfs_zero (guestfs_h *g,\n"
19281 " const char *device);\n"
19287 #: ../src/guestfs-actions.pod:7036 ../fish/guestfish-actions.pod:4663
19288 msgid "This command writes zeroes over the first few blocks of C<device>."
19293 #: ../src/guestfs-actions.pod:7038 ../fish/guestfish-actions.pod:4665
19295 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19296 "securely wipe the device). It should be sufficient to remove any partition "
19297 "tables, filesystem superblocks and so on."
19302 #: ../src/guestfs-actions.pod:7042
19303 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
19308 #: ../src/guestfs-actions.pod:7053
19309 msgid "guestfs_zero_device"
19314 #: ../src/guestfs-actions.pod:7055
19318 " guestfs_zero_device (guestfs_h *g,\n"
19319 " const char *device);\n"
19325 #: ../src/guestfs-actions.pod:7059
19327 "This command writes zeroes over the entire C<device>. Compare with "
19328 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19333 #: ../src/guestfs-actions.pod:7073
19334 msgid "(Added in 1.3.1)"
19339 #: ../src/guestfs-actions.pod:7075
19340 msgid "guestfs_zerofree"
19345 #: ../src/guestfs-actions.pod:7077
19349 " guestfs_zerofree (guestfs_h *g,\n"
19350 " const char *device);\n"
19356 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4686
19358 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19359 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19360 "possible to compress the filesystem more effectively."
19365 #: ../src/guestfs-actions.pod:7086 ../fish/guestfish-actions.pod:4691
19366 msgid "You should B<not> run this program if the filesystem is mounted."
19371 #: ../src/guestfs-actions.pod:7089 ../fish/guestfish-actions.pod:4694
19373 "It is possible that using this program can damage the filesystem or data on "
19379 #: ../src/guestfs-actions.pod:7096
19380 msgid "guestfs_zfgrep"
19385 #: ../src/guestfs-actions.pod:7098
19389 " guestfs_zfgrep (guestfs_h *g,\n"
19390 " const char *pattern,\n"
19391 " const char *path);\n"
19397 #: ../src/guestfs-actions.pod:7103 ../fish/guestfish-actions.pod:4701
19399 "This calls the external C<zfgrep> program and returns the matching lines."
19404 #: ../src/guestfs-actions.pod:7115
19405 msgid "guestfs_zfgrepi"
19410 #: ../src/guestfs-actions.pod:7117
19414 " guestfs_zfgrepi (guestfs_h *g,\n"
19415 " const char *pattern,\n"
19416 " const char *path);\n"
19422 #: ../src/guestfs-actions.pod:7122 ../fish/guestfish-actions.pod:4711
19424 "This calls the external C<zfgrep -i> program and returns the matching lines."
19429 #: ../src/guestfs-actions.pod:7134
19430 msgid "guestfs_zfile"
19435 #: ../src/guestfs-actions.pod:7136
19439 " guestfs_zfile (guestfs_h *g,\n"
19440 " const char *meth,\n"
19441 " const char *path);\n"
19447 #: ../src/guestfs-actions.pod:7141 ../fish/guestfish-actions.pod:4721
19449 "This command runs C<file> after first decompressing C<path> using C<method>."
19454 #: ../src/guestfs-actions.pod:7144 ../fish/guestfish-actions.pod:4724
19455 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19460 #: ../src/guestfs-actions.pod:7146
19462 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19467 #: ../src/guestfs-actions.pod:7152
19469 "This function is deprecated. In new code, use the L</guestfs_file> call "
19475 #: ../src/guestfs-actions.pod:7161
19476 msgid "guestfs_zgrep"
19481 #: ../src/guestfs-actions.pod:7163
19485 " guestfs_zgrep (guestfs_h *g,\n"
19486 " const char *regex,\n"
19487 " const char *path);\n"
19493 #: ../src/guestfs-actions.pod:7168 ../fish/guestfish-actions.pod:4740
19495 "This calls the external C<zgrep> program and returns the matching lines."
19500 #: ../src/guestfs-actions.pod:7180
19501 msgid "guestfs_zgrepi"
19506 #: ../src/guestfs-actions.pod:7182
19510 " guestfs_zgrepi (guestfs_h *g,\n"
19511 " const char *regex,\n"
19512 " const char *path);\n"
19518 #: ../src/guestfs-actions.pod:7187 ../fish/guestfish-actions.pod:4750
19520 "This calls the external C<zgrep -i> program and returns the matching lines."
19525 #: ../src/guestfs-availability.pod:3
19531 #: ../src/guestfs-availability.pod:5
19533 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
19534 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
19535 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
19536 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
19537 "L</guestfs_aug_save> L</guestfs_aug_set>"
19542 #: ../src/guestfs-availability.pod:21
19548 #: ../src/guestfs-availability.pod:23
19550 "The following functions: L</guestfs_inotify_add_watch> L</"
19551 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
19552 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19557 #: ../src/guestfs-availability.pod:31
19558 msgid "B<linuxfsuuid>"
19563 #: ../src/guestfs-availability.pod:33
19565 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
19566 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19571 #: ../src/guestfs-availability.pod:40
19572 msgid "B<linuxmodules>"
19577 #: ../src/guestfs-availability.pod:42
19578 msgid "The following functions: L</guestfs_modprobe>"
19583 #: ../src/guestfs-availability.pod:45
19584 msgid "B<linuxxattrs>"
19589 #: ../src/guestfs-availability.pod:47
19591 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
19592 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
19593 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
19594 "guestfs_setxattr>"
19599 #: ../src/guestfs-availability.pod:58
19605 #: ../src/guestfs-availability.pod:60
19607 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
19608 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
19609 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19614 #: ../src/guestfs-availability.pod:69
19620 #: ../src/guestfs-availability.pod:71
19622 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
19623 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
19624 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
19625 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
19626 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
19627 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
19628 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
19633 #: ../src/guestfs-availability.pod:94
19639 #: ../src/guestfs-availability.pod:96
19641 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
19642 "guestfs_mknod_b> L</guestfs_mknod_c>"
19647 #: ../src/guestfs-availability.pod:102
19653 #: ../src/guestfs-availability.pod:104
19654 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19659 #: ../src/guestfs-availability.pod:107
19660 msgid "B<ntfsprogs>"
19665 #: ../src/guestfs-availability.pod:109
19667 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
19672 #: ../src/guestfs-availability.pod:113
19673 msgid "B<realpath>"
19678 #: ../src/guestfs-availability.pod:115
19679 msgid "The following functions: L</guestfs_realpath>"
19684 #: ../src/guestfs-availability.pod:118
19690 #: ../src/guestfs-availability.pod:120
19692 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
19693 "guestfs_scrub_freespace>"
19698 #: ../src/guestfs-availability.pod:125
19704 #: ../src/guestfs-availability.pod:127
19705 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19710 #: ../src/guestfs-availability.pod:131
19716 #: ../src/guestfs-availability.pod:133
19717 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19722 #: ../src/guestfs-availability.pod:137
19723 msgid "B<zerofree>"
19728 #: ../src/guestfs-availability.pod:139
19729 msgid "The following functions: L</guestfs_zerofree>"
19734 #: ../src/guestfs-structs.pod:1
19735 msgid "guestfs_int_bool"
19740 #: ../src/guestfs-structs.pod:3
19743 " struct guestfs_int_bool {\n"
19752 #: ../src/guestfs-structs.pod:8
19755 " struct guestfs_int_bool_list {\n"
19756 " uint32_t len; /* Number of elements in list. */\n"
19757 " struct guestfs_int_bool *val; /* Elements. */\n"
19764 #: ../src/guestfs-structs.pod:13
19767 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19768 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19774 #: ../src/guestfs-structs.pod:16
19775 msgid "guestfs_lvm_pv"
19780 #: ../src/guestfs-structs.pod:18
19783 " struct guestfs_lvm_pv {\n"
19784 " char *pv_name;\n"
19785 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19786 " char pv_uuid[32];\n"
19788 " uint64_t pv_size;\n"
19789 " uint64_t dev_size;\n"
19790 " uint64_t pv_free;\n"
19791 " uint64_t pv_used;\n"
19792 " char *pv_attr;\n"
19793 " int64_t pv_pe_count;\n"
19794 " int64_t pv_pe_alloc_count;\n"
19795 " char *pv_tags;\n"
19796 " uint64_t pe_start;\n"
19797 " int64_t pv_mda_count;\n"
19798 " uint64_t pv_mda_free;\n"
19805 #: ../src/guestfs-structs.pod:36
19808 " struct guestfs_lvm_pv_list {\n"
19809 " uint32_t len; /* Number of elements in list. */\n"
19810 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19817 #: ../src/guestfs-structs.pod:41
19820 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19821 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19827 #: ../src/guestfs-structs.pod:44
19828 msgid "guestfs_lvm_vg"
19833 #: ../src/guestfs-structs.pod:46
19836 " struct guestfs_lvm_vg {\n"
19837 " char *vg_name;\n"
19838 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19839 " char vg_uuid[32];\n"
19841 " char *vg_attr;\n"
19842 " uint64_t vg_size;\n"
19843 " uint64_t vg_free;\n"
19844 " char *vg_sysid;\n"
19845 " uint64_t vg_extent_size;\n"
19846 " int64_t vg_extent_count;\n"
19847 " int64_t vg_free_count;\n"
19848 " int64_t max_lv;\n"
19849 " int64_t max_pv;\n"
19850 " int64_t pv_count;\n"
19851 " int64_t lv_count;\n"
19852 " int64_t snap_count;\n"
19853 " int64_t vg_seqno;\n"
19854 " char *vg_tags;\n"
19855 " int64_t vg_mda_count;\n"
19856 " uint64_t vg_mda_free;\n"
19863 #: ../src/guestfs-structs.pod:69
19866 " struct guestfs_lvm_vg_list {\n"
19867 " uint32_t len; /* Number of elements in list. */\n"
19868 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19875 #: ../src/guestfs-structs.pod:74
19878 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19879 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19885 #: ../src/guestfs-structs.pod:77
19886 msgid "guestfs_lvm_lv"
19891 #: ../src/guestfs-structs.pod:79
19894 " struct guestfs_lvm_lv {\n"
19895 " char *lv_name;\n"
19896 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19897 " char lv_uuid[32];\n"
19898 " char *lv_attr;\n"
19899 " int64_t lv_major;\n"
19900 " int64_t lv_minor;\n"
19901 " int64_t lv_kernel_major;\n"
19902 " int64_t lv_kernel_minor;\n"
19903 " uint64_t lv_size;\n"
19904 " int64_t seg_count;\n"
19906 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19907 " float snap_percent;\n"
19908 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19909 " float copy_percent;\n"
19910 " char *move_pv;\n"
19911 " char *lv_tags;\n"
19912 " char *mirror_log;\n"
19913 " char *modules;\n"
19920 #: ../src/guestfs-structs.pod:101
19923 " struct guestfs_lvm_lv_list {\n"
19924 " uint32_t len; /* Number of elements in list. */\n"
19925 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19932 #: ../src/guestfs-structs.pod:106
19935 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19936 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19942 #: ../src/guestfs-structs.pod:111
19945 " struct guestfs_stat {\n"
19949 " int64_t nlink;\n"
19954 " int64_t blksize;\n"
19955 " int64_t blocks;\n"
19956 " int64_t atime;\n"
19957 " int64_t mtime;\n"
19958 " int64_t ctime;\n"
19965 #: ../src/guestfs-structs.pod:127
19968 " struct guestfs_stat_list {\n"
19969 " uint32_t len; /* Number of elements in list. */\n"
19970 " struct guestfs_stat *val; /* Elements. */\n"
19977 #: ../src/guestfs-structs.pod:132
19980 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19981 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19987 #: ../src/guestfs-structs.pod:137
19990 " struct guestfs_statvfs {\n"
19991 " int64_t bsize;\n"
19992 " int64_t frsize;\n"
19993 " int64_t blocks;\n"
19994 " int64_t bfree;\n"
19995 " int64_t bavail;\n"
19996 " int64_t files;\n"
19997 " int64_t ffree;\n"
19998 " int64_t favail;\n"
20001 " int64_t namemax;\n"
20008 #: ../src/guestfs-structs.pod:151
20011 " struct guestfs_statvfs_list {\n"
20012 " uint32_t len; /* Number of elements in list. */\n"
20013 " struct guestfs_statvfs *val; /* Elements. */\n"
20020 #: ../src/guestfs-structs.pod:156
20023 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
20024 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
20030 #: ../src/guestfs-structs.pod:159
20031 msgid "guestfs_dirent"
20036 #: ../src/guestfs-structs.pod:161
20039 " struct guestfs_dirent {\n"
20049 #: ../src/guestfs-structs.pod:167
20052 " struct guestfs_dirent_list {\n"
20053 " uint32_t len; /* Number of elements in list. */\n"
20054 " struct guestfs_dirent *val; /* Elements. */\n"
20061 #: ../src/guestfs-structs.pod:172
20064 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
20065 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
20071 #: ../src/guestfs-structs.pod:177
20074 " struct guestfs_version {\n"
20075 " int64_t major;\n"
20076 " int64_t minor;\n"
20077 " int64_t release;\n"
20085 #: ../src/guestfs-structs.pod:184
20088 " struct guestfs_version_list {\n"
20089 " uint32_t len; /* Number of elements in list. */\n"
20090 " struct guestfs_version *val; /* Elements. */\n"
20097 #: ../src/guestfs-structs.pod:189
20100 " void guestfs_free_version (struct guestfs_free_version *);\n"
20101 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
20107 #: ../src/guestfs-structs.pod:192
20108 msgid "guestfs_xattr"
20113 #: ../src/guestfs-structs.pod:194
20116 " struct guestfs_xattr {\n"
20117 " char *attrname;\n"
20118 " /* The next two fields describe a byte array. */\n"
20119 " uint32_t attrval_len;\n"
20120 " char *attrval;\n"
20127 #: ../src/guestfs-structs.pod:201
20130 " struct guestfs_xattr_list {\n"
20131 " uint32_t len; /* Number of elements in list. */\n"
20132 " struct guestfs_xattr *val; /* Elements. */\n"
20139 #: ../src/guestfs-structs.pod:206
20142 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
20143 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
20149 #: ../src/guestfs-structs.pod:209
20150 msgid "guestfs_inotify_event"
20155 #: ../src/guestfs-structs.pod:211
20158 " struct guestfs_inotify_event {\n"
20159 " int64_t in_wd;\n"
20160 " uint32_t in_mask;\n"
20161 " uint32_t in_cookie;\n"
20162 " char *in_name;\n"
20169 #: ../src/guestfs-structs.pod:218
20172 " struct guestfs_inotify_event_list {\n"
20173 " uint32_t len; /* Number of elements in list. */\n"
20174 " struct guestfs_inotify_event *val; /* Elements. */\n"
20181 #: ../src/guestfs-structs.pod:223
20184 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20185 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20191 #: ../src/guestfs-structs.pod:226
20192 msgid "guestfs_partition"
20197 #: ../src/guestfs-structs.pod:228
20200 " struct guestfs_partition {\n"
20201 " int32_t part_num;\n"
20202 " uint64_t part_start;\n"
20203 " uint64_t part_end;\n"
20204 " uint64_t part_size;\n"
20211 #: ../src/guestfs-structs.pod:235
20214 " struct guestfs_partition_list {\n"
20215 " uint32_t len; /* Number of elements in list. */\n"
20216 " struct guestfs_partition *val; /* Elements. */\n"
20223 #: ../src/guestfs-structs.pod:240
20226 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20227 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20233 #: ../src/guestfs-structs.pod:243
20234 msgid "guestfs_application"
20239 #: ../src/guestfs-structs.pod:245
20242 " struct guestfs_application {\n"
20243 " char *app_name;\n"
20244 " char *app_display_name;\n"
20245 " int32_t app_epoch;\n"
20246 " char *app_version;\n"
20247 " char *app_release;\n"
20248 " char *app_install_path;\n"
20249 " char *app_trans_path;\n"
20250 " char *app_publisher;\n"
20251 " char *app_url;\n"
20252 " char *app_source_package;\n"
20253 " char *app_summary;\n"
20254 " char *app_description;\n"
20261 #: ../src/guestfs-structs.pod:260
20264 " struct guestfs_application_list {\n"
20265 " uint32_t len; /* Number of elements in list. */\n"
20266 " struct guestfs_application *val; /* Elements. */\n"
20273 #: ../src/guestfs-structs.pod:265
20276 " void guestfs_free_application (struct guestfs_free_application *);\n"
20277 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20283 #: ../fish/guestfish.pod:5
20284 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20289 #: ../fish/guestfish.pod:9
20292 " guestfish [--options] [commands]\n"
20298 #: ../fish/guestfish.pod:11
20307 #: ../fish/guestfish.pod:13
20310 " guestfish [--ro|--rw] -a disk.img\n"
20316 #: ../fish/guestfish.pod:15
20319 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20325 #: ../fish/guestfish.pod:17
20328 " guestfish -d libvirt-domain\n"
20334 #: ../fish/guestfish.pod:19
20337 " guestfish [--ro|--rw] -a disk.img -i\n"
20343 #: ../fish/guestfish.pod:21
20346 " guestfish -d libvirt-domain -i\n"
20352 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
20353 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
20359 #: ../fish/guestfish.pod:25
20361 "Using guestfish in read/write mode on live virtual machines can be "
20362 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20363 "option to use guestfish safely if the disk image or virtual machine might be "
20369 #: ../fish/guestfish.pod:32
20371 "Guestfish is a shell and command-line tool for examining and modifying "
20372 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20373 "functionality of the guestfs API, see L<guestfs(3)>."
20378 #: ../fish/guestfish.pod:36
20380 "Guestfish gives you structured access to the libguestfs API, from shell "
20381 "scripts or the command line or interactively. If you want to rescue a "
20382 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20388 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:908
20389 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:63
20390 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
20396 #: ../fish/guestfish.pod:43
20397 msgid "As an interactive shell"
20402 #: ../fish/guestfish.pod:45
20411 #: ../fish/guestfish.pod:47
20414 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20415 " editing virtual machine filesystems.\n"
20421 #: ../fish/guestfish.pod:50
20424 " Type: 'help' for a list of commands\n"
20425 " 'man' to read the manual\n"
20426 " 'quit' to quit the shell\n"
20432 #: ../fish/guestfish.pod:54
20435 " ><fs> add-ro disk.img\n"
20437 " ><fs> list-filesystems\n"
20438 " /dev/sda1: ext4\n"
20439 " /dev/vg_guest/lv_root: ext4\n"
20440 " /dev/vg_guest/lv_swap: swap\n"
20441 " ><fs> mount /dev/vg_guest/lv_root /\n"
20442 " ><fs> cat /etc/fstab\n"
20444 " # Created by anaconda\n"
20452 #: ../fish/guestfish.pod:67
20453 msgid "From shell scripts"
20458 #: ../fish/guestfish.pod:69
20459 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20464 #: ../fish/guestfish.pod:71
20467 " guestfish <<_EOF_\n"
20470 " mount /dev/vg_guest/lv_root /\n"
20471 " write /etc/motd \"Welcome, new users\"\n"
20478 #: ../fish/guestfish.pod:78
20479 msgid "List the LVM logical volumes in a disk image:"
20484 #: ../fish/guestfish.pod:80
20487 " guestfish -a disk.img --ro <<_EOF_\n"
20496 #: ../fish/guestfish.pod:85
20497 msgid "List all the filesystems in a disk image:"
20502 #: ../fish/guestfish.pod:87
20505 " guestfish -a disk.img --ro <<_EOF_\n"
20507 " list-filesystems\n"
20514 #: ../fish/guestfish.pod:92
20515 msgid "On one command line"
20520 #: ../fish/guestfish.pod:94
20521 msgid "Update C</etc/resolv.conf> in a guest:"
20526 #: ../fish/guestfish.pod:96
20530 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20531 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20537 #: ../fish/guestfish.pod:100
20538 msgid "Edit C</boot/grub/grub.conf> interactively:"
20543 #: ../fish/guestfish.pod:102
20546 " guestfish --rw --add disk.img \\\n"
20547 " --mount /dev/vg_guest/lv_root \\\n"
20548 " --mount /dev/sda1:/boot \\\n"
20549 " edit /boot/grub/grub.conf\n"
20555 #: ../fish/guestfish.pod:107
20556 msgid "Mount disks automatically"
20561 #: ../fish/guestfish.pod:109
20563 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20568 #: ../fish/guestfish.pod:112
20571 " guestfish --ro -a disk.img -i cat /etc/group\n"
20577 #: ../fish/guestfish.pod:114
20580 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20586 #: ../fish/guestfish.pod:116
20587 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20592 #: ../fish/guestfish.pod:118
20595 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20601 #: ../fish/guestfish.pod:120
20602 msgid "As a script interpreter"
20607 #: ../fish/guestfish.pod:122
20608 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20613 #: ../fish/guestfish.pod:124
20616 " #!/usr/bin/guestfish -f\n"
20617 " sparse test1.img 100M\n"
20619 " part-disk /dev/sda mbr\n"
20620 " mkfs ext2 /dev/sda1\n"
20626 #: ../fish/guestfish.pod:130
20627 msgid "Start with a prepared disk"
20632 #: ../fish/guestfish.pod:132
20634 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20635 "single ext2-formatted partition:"
20640 #: ../fish/guestfish.pod:135
20643 " guestfish -N fs\n"
20649 #: ../fish/guestfish.pod:137
20650 msgid "To list what is available do:"
20655 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:899
20658 " guestfish -N help | less\n"
20664 #: ../fish/guestfish.pod:141
20665 msgid "Remote control"
20670 #: ../fish/guestfish.pod:143
20673 " eval \"`guestfish --listen`\"\n"
20674 " guestfish --remote add-ro disk.img\n"
20675 " guestfish --remote run\n"
20676 " guestfish --remote lvs\n"
20682 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20683 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:77
20684 #: ../tools/virt-win-reg.pl:96 ../tools/virt-resize.pl:254
20685 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
20686 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20692 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
20693 #: ../tools/virt-edit.pl:85 ../tools/virt-win-reg.pl:104
20694 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
20695 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
20696 #: ../tools/virt-list-partitions.pl:62
20702 #: ../fish/guestfish.pod:154
20703 msgid "Displays general help on options."
20708 #: ../fish/guestfish.pod:156
20714 #: ../fish/guestfish.pod:158
20715 msgid "B<--cmd-help>"
20720 #: ../fish/guestfish.pod:160
20721 msgid "Lists all available guestfish commands."
20726 #: ../fish/guestfish.pod:162
20732 #: ../fish/guestfish.pod:164
20733 msgid "B<--cmd-help cmd>"
20738 #: ../fish/guestfish.pod:166
20739 msgid "Displays detailed help on a single command C<cmd>."
20744 #: ../fish/guestfish.pod:168
20745 msgid "B<-a image>"
20750 #: ../fish/guestfish.pod:170
20751 msgid "B<--add image>"
20756 #: ../fish/guestfish.pod:172
20757 msgid "Add a block device or virtual machine image to the shell."
20762 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
20764 "The format of the disk image is auto-detected. To override this and force a "
20765 "particular format use the I<--format=..> option."
20769 #: ../fish/guestfish.pod:177
20771 "Using this flag is mostly equivalent to using the C<add> command, with "
20772 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20773 "the I<--format=...> flag was given."
20778 #: ../fish/guestfish.pod:181
20784 #: ../fish/guestfish.pod:183
20785 msgid "B<--connect URI>"
20790 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
20792 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20793 "URI to use. The default is to use the default libvirt connection."
20798 #: ../fish/guestfish.pod:189
20804 #: ../fish/guestfish.pod:191
20806 "If using the I<--listen> option and a csh-like shell, use this option. See "
20807 "section L</REMOTE CONTROL AND CSH> below."
20812 #: ../fish/guestfish.pod:194
20813 msgid "B<-d libvirt-domain>"
20818 #: ../fish/guestfish.pod:196
20819 msgid "B<--domain libvirt-domain>"
20824 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
20826 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20827 "used, then any libvirt domain can be used. However in write mode, only "
20828 "libvirt domains which are shut down can be named here."
20833 #: ../fish/guestfish.pod:202
20835 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20836 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20837 "if the I<--format:...> flag was given."
20842 #: ../fish/guestfish.pod:206
20848 #: ../fish/guestfish.pod:208
20849 msgid "B<--no-dest-paths>"
20854 #: ../fish/guestfish.pod:210
20856 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20857 "to hit the tab key to complete paths on the guest filesystem, but this "
20858 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20859 "allow this feature to be disabled."
20864 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
20865 msgid "B<--echo-keys>"
20870 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
20872 "When prompting for keys and passphrases, guestfish normally turns echoing "
20873 "off so you cannot see what you are typing. If you are not worried about "
20874 "Tempest attacks and there is no one else in the room you can specify this "
20875 "flag to see what you are typing."
20880 #: ../fish/guestfish.pod:222
20886 #: ../fish/guestfish.pod:224
20887 msgid "B<--file file>"
20892 #: ../fish/guestfish.pod:226
20893 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20898 #: ../fish/guestfish.pod:229
20901 " #!/usr/bin/guestfish -f\n"
20907 #: ../fish/guestfish.pod:231
20908 msgid "B<--format=raw|qcow2|..>"
20913 #: ../fish/guestfish.pod:233
20914 msgid "B<--format>"
20919 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
20921 "The default for the I<-a> option is to auto-detect the format of the disk "
20922 "image. Using this forces the disk format for I<-a> options which follow on "
20923 "the command line. Using I<--format> with no argument switches back to auto-"
20924 "detection for subsequent I<-a> options."
20929 #: ../fish/guestfish.pod:242
20932 " guestfish --format=raw -a disk.img\n"
20938 #: ../fish/guestfish.pod:244
20939 msgid "forces raw format (no auto-detection) for C<disk.img>."
20944 #: ../fish/guestfish.pod:246
20947 " guestfish --format=raw -a disk.img --format -a another.img\n"
20953 #: ../fish/guestfish.pod:248
20955 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20956 "detection for C<another.img>."
20961 #: ../fish/guestfish.pod:251
20963 "If you have untrusted raw-format guest disk images, you should use this "
20964 "option to specify the disk format. This avoids a possible security problem "
20965 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20970 #: ../fish/guestfish.pod:256
20976 #: ../fish/guestfish.pod:258
20977 msgid "B<--inspector>"
20982 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
20984 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20985 "system and mount filesystems as they would be mounted on the real virtual "
20991 #: ../fish/guestfish.pod:264
20992 msgid "Typical usage is either:"
20997 #: ../fish/guestfish.pod:266
21000 " guestfish -d myguest -i\n"
21006 #: ../fish/guestfish.pod:268
21007 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21012 #: ../fish/guestfish.pod:270
21015 " guestfish --ro -d myguest -i\n"
21021 #: ../fish/guestfish.pod:272
21022 msgid "(for active domains, readonly), or specify the block device directly:"
21027 #: ../fish/guestfish.pod:274
21030 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21036 #: ../fish/guestfish.pod:276
21038 "Note that the command line syntax changed slightly over older versions of "
21039 "guestfish. You can still use the old syntax:"
21044 #: ../fish/guestfish.pod:279
21047 " guestfish [--ro] -i disk.img\n"
21053 #: ../fish/guestfish.pod:281
21056 " guestfish [--ro] -i libvirt-domain\n"
21062 #: ../fish/guestfish.pod:283
21064 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21065 "then using other commands to mount the filesystems that were found."
21070 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
21071 msgid "B<--keys-from-stdin>"
21076 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
21078 "Read key or passphrase parameters from stdin. The default is to try to read "
21079 "passphrases from the user by opening C</dev/tty>."
21084 #: ../fish/guestfish.pod:292
21085 msgid "B<--listen>"
21090 #: ../fish/guestfish.pod:294
21092 "Fork into the background and listen for remote commands. See section L</"
21093 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21098 #: ../fish/guestfish.pod:297
21099 msgid "B<-m dev[:mountpoint]>"
21104 #: ../fish/guestfish.pod:299
21105 msgid "B<--mount dev[:mountpoint]>"
21110 #: ../fish/guestfish.pod:301
21111 msgid "Mount the named partition or logical volume on the given mountpoint."
21116 #: ../fish/guestfish.pod:303
21117 msgid "If the mountpoint is omitted, it defaults to C</>."
21122 #: ../fish/guestfish.pod:305
21123 msgid "You have to mount something on C</> before most commands will work."
21128 #: ../fish/guestfish.pod:307
21130 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21136 #: ../fish/guestfish.pod:310
21138 "If you don't know what filesystems a disk image contains, you can either run "
21139 "guestfish without this option, then list the partitions, filesystems and LVs "
21140 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21141 "commands), or you can use the L<virt-filesystems(1)> program."
21146 #: ../fish/guestfish.pod:316
21148 "Using this flag is mostly equivalent to using the C<mount-options> command "
21149 "or the C<mount-ro> command if the I<--ro> flag was given."
21154 #: ../fish/guestfish.pod:319
21160 #: ../fish/guestfish.pod:321
21161 msgid "B<--no-sync>"
21166 #: ../fish/guestfish.pod:323
21168 "Disable autosync. This is enabled by default. See the discussion of "
21169 "autosync in the L<guestfs(3)> manpage."
21174 #: ../fish/guestfish.pod:326
21180 #: ../fish/guestfish.pod:328
21181 msgid "B<--new type>"
21186 #: ../fish/guestfish.pod:330
21192 #: ../fish/guestfish.pod:332
21194 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
21195 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
21196 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
21202 #: ../fish/guestfish.pod:337
21203 msgid "B<--progress-bars>"
21208 #: ../fish/guestfish.pod:339
21209 msgid "Enable progress bars, even when guestfish is used non-interactively."
21214 #: ../fish/guestfish.pod:341
21216 "Progress bars are enabled by default when guestfish is used as an "
21217 "interactive shell."
21222 #: ../fish/guestfish.pod:344
21223 msgid "B<--no-progress-bars>"
21228 #: ../fish/guestfish.pod:346
21229 msgid "Disable progress bars."
21234 #: ../fish/guestfish.pod:348
21235 msgid "B<--remote[=pid]>"
21240 #: ../fish/guestfish.pod:350
21242 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21243 "CONTROL GUESTFISH OVER A SOCKET> below."
21248 #: ../fish/guestfish.pod:353
21254 #: ../fish/guestfish.pod:355
21260 #: ../fish/guestfish.pod:357
21262 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21263 "mounts are done read-only."
21268 #: ../fish/guestfish.pod:360
21270 "The option must always be used if the disk image or virtual machine might be "
21271 "running, and is generally recommended in cases where you don't need write "
21272 "access to the disk."
21277 #: ../fish/guestfish.pod:364
21279 "Note that prepared disk images created with I<-N> are not affected by this "
21280 "option. Also commands like C<add> are not affected - you have to specify "
21281 "the C<readonly:true> option explicitly if you need it."
21286 #: ../fish/guestfish.pod:368
21287 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21292 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
21293 msgid "B<--selinux>"
21298 #: ../fish/guestfish.pod:372
21299 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21304 #: ../fish/guestfish.pod:374
21310 #: ../fish/guestfish.pod:376
21311 msgid "B<--verbose>"
21316 #: ../fish/guestfish.pod:378
21318 "Enable very verbose messages. This is particularly useful if you find a bug."
21323 #: ../fish/guestfish.pod:381
21329 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:93
21330 #: ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270
21331 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114
21332 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21333 msgid "B<--version>"
21338 #: ../fish/guestfish.pod:385
21339 msgid "Display the guestfish / libguestfs version number and exit."
21344 #: ../fish/guestfish.pod:387
21350 #: ../fish/guestfish.pod:389
21356 #: ../fish/guestfish.pod:391
21358 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
21364 #: ../fish/guestfish.pod:394
21370 #: ../fish/guestfish.pod:396
21371 msgid "Echo each command before executing it."
21376 #: ../fish/guestfish.pod:400
21377 msgid "COMMANDS ON COMMAND LINE"
21382 #: ../fish/guestfish.pod:402
21384 "Any additional (non-option) arguments are treated as commands to execute."
21389 #: ../fish/guestfish.pod:405
21391 "Commands to execute should be separated by a colon (C<:>), where the colon "
21392 "is a separate parameter. Thus:"
21397 #: ../fish/guestfish.pod:408
21400 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21406 #: ../fish/guestfish.pod:410
21408 "If there are no additional arguments, then we enter a shell, either an "
21409 "interactive shell with a prompt (if the input is a terminal) or a non-"
21410 "interactive shell."
21415 #: ../fish/guestfish.pod:414
21417 "In either command line mode or non-interactive shell, the first command that "
21418 "gives an error causes the whole shell to exit. In interactive mode (with a "
21419 "prompt) if a command fails, you can continue to enter commands."
21424 #: ../fish/guestfish.pod:419
21425 msgid "USING launch (OR run)"
21430 #: ../fish/guestfish.pod:421
21432 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21433 "then launch it, then mount any disks you need, and finally issue actions/"
21434 "commands. So the general order of the day is:"
21439 #: ../fish/guestfish.pod:429
21440 msgid "add or -a/--add"
21445 #: ../fish/guestfish.pod:433
21446 msgid "launch (aka run)"
21451 #: ../fish/guestfish.pod:437
21452 msgid "mount or -m/--mount"
21457 #: ../fish/guestfish.pod:441
21458 msgid "any other commands"
21463 #: ../fish/guestfish.pod:445
21465 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21466 "guest before mounting or performing any other commands."
21471 #: ../fish/guestfish.pod:448
21473 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21474 "I<--new> options were given then C<run> is done automatically, simply "
21475 "because guestfish can't perform the action you asked for without doing this."
21480 #: ../fish/guestfish.pod:453
21481 msgid "OPENING DISKS FOR READ AND WRITE"
21486 #: ../fish/guestfish.pod:455
21488 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
21489 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
21490 "open disk images read-only or for writing."
21495 #: ../fish/guestfish.pod:459
21497 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
21498 "disk images supplied on the command line for write. To open a disk image "
21499 "read-only you have to do I<-a image --ro>."
21504 #: ../fish/guestfish.pod:463
21506 "This matters: If you accidentally open a live VM disk image writable then "
21507 "you will cause irreversible disk corruption."
21511 #: ../fish/guestfish.pod:466
21513 "By libguestfs 1.10 we intend to change the default the other way. Disk "
21514 "images will be opened read-only. You will have to either specify "
21515 "I<guestfish --rw> or change a configuration file in order to get write "
21516 "access for disk images specified by those other command line options."
21521 #: ../fish/guestfish.pod:471
21523 "This version of guestfish has a I<--rw> option which does nothing (it is "
21524 "already the default). However it is highly recommended that you use this "
21525 "option to indicate that guestfish needs write access, and to prepare your "
21526 "scripts for the day when this option will be required for write access."
21531 #: ../fish/guestfish.pod:477
21533 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21534 "other libguestfs program apart from guestfish and guestmount."
21539 #: ../fish/guestfish.pod:480
21545 #: ../fish/guestfish.pod:482
21547 "You can quote ordinary parameters using either single or double quotes. For "
21553 #: ../fish/guestfish.pod:485
21556 " add \"file with a space.img\"\n"
21562 #: ../fish/guestfish.pod:487
21565 " rm '/file name'\n"
21571 #: ../fish/guestfish.pod:489
21580 #: ../fish/guestfish.pod:491
21582 "A few commands require a list of strings to be passed. For these, use a "
21583 "whitespace-separated list, enclosed in quotes. Strings containing "
21584 "whitespace to be passed through must be enclosed in single quotes. A "
21585 "literal single quote must be escaped with a backslash."
21590 #: ../fish/guestfish.pod:496
21593 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21594 " command \"/bin/echo 'foo bar'\"\n"
21595 " command \"/bin/echo \\'foo\\'\"\n"
21601 #: ../fish/guestfish.pod:500
21602 msgid "OPTIONAL ARGUMENTS"
21607 #: ../fish/guestfish.pod:502
21609 "Some commands take optional arguments. These arguments appear in this "
21610 "documentation as C<[argname:..]>. You can use them as in these examples:"
21615 #: ../fish/guestfish.pod:506
21618 " add-drive-opts filename\n"
21624 #: ../fish/guestfish.pod:508
21627 " add-drive-opts filename readonly:true\n"
21633 #: ../fish/guestfish.pod:510
21636 " add-drive-opts filename format:qcow2 readonly:false\n"
21642 #: ../fish/guestfish.pod:512
21644 "Each optional argument can appear at most once. All optional arguments must "
21645 "appear after the required ones."
21650 #: ../fish/guestfish.pod:515
21656 #: ../fish/guestfish.pod:517
21658 "This section applies to all commands which can take integers as parameters."
21663 #: ../fish/guestfish.pod:520
21664 msgid "SIZE SUFFIX"
21669 #: ../fish/guestfish.pod:522
21671 "When the command takes a parameter measured in bytes, you can use one of the "
21672 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21677 #: ../fish/guestfish.pod:528
21678 msgid "B<k> or B<K> or B<KiB>"
21683 #: ../fish/guestfish.pod:530
21684 msgid "The size in kilobytes (multiplied by 1024)."
21689 #: ../fish/guestfish.pod:532
21695 #: ../fish/guestfish.pod:534
21696 msgid "The size in SI 1000 byte units."
21701 #: ../fish/guestfish.pod:536
21702 msgid "B<M> or B<MiB>"
21707 #: ../fish/guestfish.pod:538
21708 msgid "The size in megabytes (multiplied by 1048576)."
21713 #: ../fish/guestfish.pod:540
21719 #: ../fish/guestfish.pod:542
21720 msgid "The size in SI 1000000 byte units."
21725 #: ../fish/guestfish.pod:544
21726 msgid "B<G> or B<GiB>"
21731 #: ../fish/guestfish.pod:546
21732 msgid "The size in gigabytes (multiplied by 2**30)."
21737 #: ../fish/guestfish.pod:548
21743 #: ../fish/guestfish.pod:550
21744 msgid "The size in SI 10**9 byte units."
21749 #: ../fish/guestfish.pod:552
21750 msgid "B<T> or B<TiB>"
21755 #: ../fish/guestfish.pod:554
21756 msgid "The size in terabytes (multiplied by 2**40)."
21761 #: ../fish/guestfish.pod:556
21767 #: ../fish/guestfish.pod:558
21768 msgid "The size in SI 10**12 byte units."
21773 #: ../fish/guestfish.pod:560
21774 msgid "B<P> or B<PiB>"
21779 #: ../fish/guestfish.pod:562
21780 msgid "The size in petabytes (multiplied by 2**50)."
21785 #: ../fish/guestfish.pod:564
21791 #: ../fish/guestfish.pod:566
21792 msgid "The size in SI 10**15 byte units."
21797 #: ../fish/guestfish.pod:568
21798 msgid "B<E> or B<EiB>"
21803 #: ../fish/guestfish.pod:570
21804 msgid "The size in exabytes (multiplied by 2**60)."
21809 #: ../fish/guestfish.pod:572
21815 #: ../fish/guestfish.pod:574
21816 msgid "The size in SI 10**18 byte units."
21821 #: ../fish/guestfish.pod:576
21822 msgid "B<Z> or B<ZiB>"
21827 #: ../fish/guestfish.pod:578
21828 msgid "The size in zettabytes (multiplied by 2**70)."
21833 #: ../fish/guestfish.pod:580
21839 #: ../fish/guestfish.pod:582
21840 msgid "The size in SI 10**21 byte units."
21845 #: ../fish/guestfish.pod:584
21846 msgid "B<Y> or B<YiB>"
21851 #: ../fish/guestfish.pod:586
21852 msgid "The size in yottabytes (multiplied by 2**80)."
21857 #: ../fish/guestfish.pod:588
21863 #: ../fish/guestfish.pod:590
21864 msgid "The size in SI 10**24 byte units."
21869 #: ../fish/guestfish.pod:596
21872 " truncate-size /file 1G\n"
21878 #: ../fish/guestfish.pod:598
21879 msgid "would truncate the file to 1 gigabyte."
21884 #: ../fish/guestfish.pod:600
21886 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21887 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21888 "suffix will probably not do what you expect."
21893 #: ../fish/guestfish.pod:604
21894 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21899 #: ../fish/guestfish.pod:606
21901 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21902 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21907 #: ../fish/guestfish.pod:609
21910 " 1234 decimal number 1234\n"
21911 " 02322 octal number, equivalent to decimal 1234\n"
21912 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21918 #: ../fish/guestfish.pod:613
21920 "When using the C<chmod> command, you almost always want to specify an octal "
21921 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21922 "L<chmod(1)> program):"
21927 #: ../fish/guestfish.pod:617
21930 " chmod 0777 /public # OK\n"
21931 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21937 #: ../fish/guestfish.pod:620
21939 "Commands that return numbers usually print them in decimal, but some "
21940 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21941 "octal, preceeded by C<0>)."
21946 #: ../fish/guestfish.pod:624
21947 msgid "WILDCARDS AND GLOBBING"
21952 #: ../fish/guestfish.pod:626
21954 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
21955 "(globbing) by default. So for example the following will not do what you "
21961 #: ../fish/guestfish.pod:630
21970 #: ../fish/guestfish.pod:632
21972 "Assuming you don't have a directory called literally C</home/*> then the "
21973 "above command will return an error."
21978 #: ../fish/guestfish.pod:635
21979 msgid "To perform wildcard expansion, use the C<glob> command."
21984 #: ../fish/guestfish.pod:637
21987 " glob rm-rf /home/*\n"
21993 #: ../fish/guestfish.pod:639
21995 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
21996 "many times), equivalent to:"
22001 #: ../fish/guestfish.pod:642
22004 " rm-rf /home/jim\n"
22005 " rm-rf /home/joe\n"
22006 " rm-rf /home/mary\n"
22012 #: ../fish/guestfish.pod:646
22013 msgid "C<glob> only works on simple guest paths and not on device names."
22018 #: ../fish/guestfish.pod:648
22020 "If you have several parameters, each containing a wildcard, then glob will "
22021 "perform a Cartesian product."
22026 #: ../fish/guestfish.pod:651
22032 #: ../fish/guestfish.pod:653
22034 "Any line which starts with a I<#> character is treated as a comment and "
22035 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22036 "a command. For example:"
22041 #: ../fish/guestfish.pod:657
22044 " # this is a comment\n"
22045 " # this is a comment\n"
22046 " foo # NOT a comment\n"
22052 #: ../fish/guestfish.pod:661
22053 msgid "Blank lines are also ignored."
22058 #: ../fish/guestfish.pod:663
22059 msgid "RUNNING COMMANDS LOCALLY"
22064 #: ../fish/guestfish.pod:665
22066 "Any line which starts with a I<!> character is treated as a command sent to "
22067 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22072 #: ../fish/guestfish.pod:669
22076 " tgz-out /remote local/remote-data.tar.gz\n"
22082 #: ../fish/guestfish.pod:672
22084 "will create a directory C<local> on the host, and then export the contents "
22085 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22086 "(See C<tgz-out>)."
22091 #: ../fish/guestfish.pod:676
22093 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22094 "effect, due to the way that subprocesses work in Unix."
22099 #: ../fish/guestfish.pod:679
22105 #: ../fish/guestfish.pod:681
22107 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22108 "command (a guestfish command) to the second command (any host command). For "
22114 #: ../fish/guestfish.pod:685
22117 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22123 #: ../fish/guestfish.pod:687
22125 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22126 "program). The above command would list all accounts in the guest filesystem "
22127 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22132 #: ../fish/guestfish.pod:692
22135 " hexdump /bin/ls | head\n"
22136 " list-devices | tail -1\n"
22137 " tgz-out / - | tar ztf -\n"
22143 #: ../fish/guestfish.pod:696
22145 "The space before the pipe symbol is required, any space after the pipe "
22146 "symbol is optional. Everything after the pipe symbol is just passed "
22147 "straight to the host shell, so it can contain redirections, globs and "
22148 "anything else that makes sense on the host side."
22153 #: ../fish/guestfish.pod:701
22155 "To use a literal argument which begins with a pipe symbol, you have to quote "
22161 #: ../fish/guestfish.pod:704
22170 #: ../fish/guestfish.pod:706
22171 msgid "HOME DIRECTORIES"
22176 #: ../fish/guestfish.pod:708
22178 "If a parameter starts with the character C<~> then the tilde may be expanded "
22179 "as a home directory path (either C<~> for the current user's home directory, "
22180 "or C<~user> for another user)."
22185 #: ../fish/guestfish.pod:712
22187 "Note that home directory expansion happens for users known I<on the host>, "
22188 "not in the guest filesystem."
22193 #: ../fish/guestfish.pod:715
22195 "To use a literal argument which begins with a tilde, you have to quote it, "
22201 #: ../fish/guestfish.pod:718
22210 #: ../fish/guestfish.pod:722
22212 "Libguestfs has some support for Linux guests encrypted according to the "
22213 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22214 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22215 "LUKS is supported."
22220 #: ../fish/guestfish.pod:727
22221 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22226 #: ../fish/guestfish.pod:729
22229 " ><fs> vfs-type /dev/sda2\n"
22236 #: ../fish/guestfish.pod:732
22238 "Then open those devices using L</luks-open>. This creates a device-mapper "
22239 "device called C</dev/mapper/luksdev>."
22244 #: ../fish/guestfish.pod:735
22247 " ><fs> luks-open /dev/sda2 luksdev\n"
22248 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22254 #: ../fish/guestfish.pod:738
22256 "Finally you have to tell LVM to scan for volume groups on the newly created "
22262 #: ../fish/guestfish.pod:741
22266 " vg-activate-all true\n"
22272 #: ../fish/guestfish.pod:744
22273 msgid "The logical volume(s) can now be mounted in the usual way."
22278 #: ../fish/guestfish.pod:746
22280 "Before closing a LUKS device you must unmount any logical volumes on it and "
22281 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22282 "one. Then you can close the mapper device:"
22287 #: ../fish/guestfish.pod:750
22290 " vg-activate false /dev/VG\n"
22291 " luks-close /dev/mapper/luksdev\n"
22297 #: ../fish/guestfish.pod:753
22298 msgid "WINDOWS PATHS"
22303 #: ../fish/guestfish.pod:755
22305 "If a path is prefixed with C<win:> then you can use Windows-style paths "
22306 "(with some limitations). The following commands are equivalent:"
22311 #: ../fish/guestfish.pod:758
22314 " file /WINDOWS/system32/config/system.LOG\n"
22320 #: ../fish/guestfish.pod:760
22323 " file win:/windows/system32/config/system.log\n"
22329 #: ../fish/guestfish.pod:762
22332 " file win:\\windows\\system32\\config\\system.log\n"
22338 #: ../fish/guestfish.pod:764
22341 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
22347 #: ../fish/guestfish.pod:766
22349 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
22350 "handles case insensitivity like Windows would. This only works in argument "
22351 "positions that expect a path."
22356 #: ../fish/guestfish.pod:770
22357 msgid "UPLOADING AND DOWNLOADING FILES"
22362 #: ../fish/guestfish.pod:772
22364 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22365 "others which upload from or download to a local file, you can use the "
22366 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22371 #: ../fish/guestfish.pod:776
22380 #: ../fish/guestfish.pod:778
22382 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22387 #: ../fish/guestfish.pod:781
22390 " tar-out /etc - | tar tf -\n"
22396 #: ../fish/guestfish.pod:783
22398 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22399 "command (see L</PIPES>)."
22404 #: ../fish/guestfish.pod:786
22406 "When using C<-> to read from stdin, the input is read up to the end of "
22407 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22408 "some arbitrary end marker:"
22413 #: ../fish/guestfish.pod:790
22416 " upload -<<END /foo\n"
22426 #: ../fish/guestfish.pod:796
22428 "Any string of characters can be used instead of C<END>. The end marker must "
22429 "appear on a line of its own, without any preceeding or following characters "
22430 "(not even spaces)."
22435 #: ../fish/guestfish.pod:800
22437 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22438 "upload local files (so-called \"FileIn\" parameters in the generator)."
22443 #: ../fish/guestfish.pod:803
22444 msgid "EXIT ON ERROR BEHAVIOUR"
22449 #: ../fish/guestfish.pod:805
22451 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22452 "taking commands from a human over a tty), and will exit on the first error "
22453 "in non-interactive mode (scripts, commands given on the command line)."
22458 #: ../fish/guestfish.pod:810
22460 "If you prefix a command with a I<-> character, then that command will not "
22461 "cause guestfish to exit, even if that (one) command returns an error."
22466 #: ../fish/guestfish.pod:814
22467 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22472 #: ../fish/guestfish.pod:816
22474 "Guestfish can be remote-controlled over a socket. This is useful "
22475 "particularly in shell scripts where you want to make several different "
22476 "changes to a filesystem, but you don't want the overhead of starting up a "
22477 "guestfish process each time."
22482 #: ../fish/guestfish.pod:821
22483 msgid "Start a guestfish server process using:"
22488 #: ../fish/guestfish.pod:823
22491 " eval \"`guestfish --listen`\"\n"
22497 #: ../fish/guestfish.pod:825
22498 msgid "and then send it commands by doing:"
22503 #: ../fish/guestfish.pod:827
22506 " guestfish --remote cmd [...]\n"
22512 #: ../fish/guestfish.pod:829
22513 msgid "To cause the server to exit, send it the exit command:"
22518 #: ../fish/guestfish.pod:831
22521 " guestfish --remote exit\n"
22527 #: ../fish/guestfish.pod:833
22529 "Note that the server will normally exit if there is an error in a command. "
22530 "You can change this in the usual way. See section L</EXIT ON ERROR "
22536 #: ../fish/guestfish.pod:837
22537 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22542 #: ../fish/guestfish.pod:839
22544 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22545 "is how the I<--remote> option knows where to send the commands. You can "
22546 "have several guestfish listener processes running using:"
22551 #: ../fish/guestfish.pod:843
22554 " eval \"`guestfish --listen`\"\n"
22555 " pid1=$GUESTFISH_PID\n"
22556 " eval \"`guestfish --listen`\"\n"
22557 " pid2=$GUESTFISH_PID\n"
22559 " guestfish --remote=$pid1 cmd\n"
22560 " guestfish --remote=$pid2 cmd\n"
22566 #: ../fish/guestfish.pod:851
22567 msgid "REMOTE CONTROL AND CSH"
22572 #: ../fish/guestfish.pod:853
22574 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22580 #: ../fish/guestfish.pod:856
22583 " eval \"`guestfish --listen --csh`\"\n"
22589 #: ../fish/guestfish.pod:858
22590 msgid "REMOTE CONTROL DETAILS"
22595 #: ../fish/guestfish.pod:860
22597 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22598 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22599 "and C<$PID> is the process ID of the server."
22604 #: ../fish/guestfish.pod:864
22605 msgid "Guestfish client and server versions must match exactly."
22609 #: ../fish/guestfish.pod:866
22610 msgid "REMOTE CONTROL RUN COMMAND HANGING"
22614 #: ../fish/guestfish.pod:868
22616 "Using the C<run> (or C<launch>) command remotely in a command substitution "
22617 "context hangs, ie. don't do (note the backquotes):"
22621 #: ../fish/guestfish.pod:871
22624 " a=`guestfish --remote run`\n"
22629 #: ../fish/guestfish.pod:873
22631 "Since the C<run> command produces no output on stdout, this is not useful "
22632 "anyway. For further information see L<https://bugzilla.redhat.com/show_bug."
22638 #: ../fish/guestfish.pod:877
22639 msgid "PREPARED DISK IMAGES"
22644 #: ../fish/guestfish.pod:879
22646 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22647 "preformatted disk images that guestfish can make for you to save typing. "
22648 "This is particularly useful for testing purposes. This option is used "
22649 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22650 "can be mixed with I<-a>)."
22655 #: ../fish/guestfish.pod:885
22657 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22658 "the second and so on. Existing files in the current directory are "
22664 #: ../fish/guestfish.pod:889
22666 "The type briefly describes how the disk should be sized, partitioned, how "
22667 "filesystem(s) should be created, and how content should be added. "
22668 "Optionally the type can be followed by extra parameters, separated by C<:> "
22669 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22670 "allocated disk, containing a single partition, with the partition formatted "
22671 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22677 #: ../fish/guestfish.pod:897
22678 msgid "To list the available types and any extra parameters they take, run:"
22683 #: ../fish/guestfish.pod:901
22685 "Note that the prepared filesystem is not mounted. You would usually have to "
22686 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22691 #: ../fish/guestfish.pod:905
22693 "If any I<-N> or I<--new> options are given, the guest is automatically "
22699 #: ../fish/guestfish.pod:910
22700 msgid "Create a 100MB disk with an ext4-formatted partition:"
22705 #: ../fish/guestfish.pod:912
22708 " guestfish -N fs:ext4\n"
22714 #: ../fish/guestfish.pod:914
22715 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22720 #: ../fish/guestfish.pod:916
22723 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22729 #: ../fish/guestfish.pod:918
22730 msgid "Create a blank 200MB disk:"
22735 #: ../fish/guestfish.pod:920
22738 " guestfish -N disk:200M\n"
22744 #: ../fish/guestfish.pod:922
22745 msgid "PROGRESS BARS"
22750 #: ../fish/guestfish.pod:924
22752 "Some (not all) long-running commands send progress notification messages as "
22753 "they are running. Guestfish turns these messages into progress bars."
22758 #: ../fish/guestfish.pod:928
22760 "When a command that supports progress bars takes longer than two seconds to "
22761 "run, and if progress bars are enabled, then you will see one appearing below "
22767 #: ../fish/guestfish.pod:932
22770 " ><fs> copy-size /large-file /another-file 2048M\n"
22771 " / 10% [#####-----------------------------------------] 00:30\n"
22777 #: ../fish/guestfish.pod:935
22779 "The spinner on the left hand side moves round once for every progress "
22780 "notification received from the backend. This is a (reasonably) golden "
22781 "assurance that the command is \"doing something\" even if the progress bar "
22782 "is not moving, because the command is able to send the progress "
22783 "notifications. When the bar reaches 100% and the command finishes, the "
22784 "spinner disappears."
22789 #: ../fish/guestfish.pod:942
22791 "Progress bars are enabled by default when guestfish is used interactively. "
22792 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22793 "and you can disable them completely using I<--no-progress-bars>."
22798 #: ../fish/guestfish.pod:947
22799 msgid "GUESTFISH COMMANDS"
22804 #: ../fish/guestfish.pod:949
22806 "The commands in this section are guestfish convenience commands, in other "
22807 "words, they are not part of the L<guestfs(3)> API."
22812 #: ../fish/guestfish.pod:952
22818 #: ../fish/guestfish.pod:954
22828 #: ../fish/guestfish.pod:957
22829 msgid "Without any parameter, this provides general help."
22834 #: ../fish/guestfish.pod:959
22835 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22840 #: ../fish/guestfish.pod:961
22841 msgid "quit | exit"
22846 #: ../fish/guestfish.pod:963
22847 msgid "This exits guestfish. You can also use C<^D> key."
22852 #: ../fish/guestfish.pod:965
22853 msgid "@FISH_COMMANDS@"
22858 #: ../fish/guestfish.pod:967
22864 #: ../fish/guestfish.pod:971 ../test-tool/libguestfs-test-tool.pod:83
22870 #: ../fish/guestfish.pod:973
22872 "guestfish returns 0 if the commands completed without error, or 1 if there "
22878 #: ../fish/guestfish.pod:980
22884 #: ../fish/guestfish.pod:982
22886 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22892 #: ../fish/guestfish.pod:985
22893 msgid "GUESTFISH_PID"
22898 #: ../fish/guestfish.pod:987
22900 "Used with the I<--remote> option to specify the remote guestfish process to "
22901 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22906 #: ../fish/guestfish.pod:991
22912 #: ../fish/guestfish.pod:993
22914 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22915 "not specified, the external L<hexedit(1)> program is used."
22920 #: ../fish/guestfish.pod:997
22926 #: ../fish/guestfish.pod:999
22928 "If compiled with GNU readline support, various files in the home directory "
22929 "can be used. See L</FILES>."
22934 #: ../fish/guestfish.pod:1008
22936 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22937 "effect as using the B<-v> option."
22942 #: ../fish/guestfish.pod:1020
22944 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22945 "the discussion of paths in L<guestfs(3)>."
22950 #: ../fish/guestfish.pod:1031
22951 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22956 #: ../fish/guestfish.pod:1033
22962 #: ../fish/guestfish.pod:1035
22964 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22970 #: ../fish/guestfish.pod:1050 ../test-tool/libguestfs-test-tool.pod:88
22976 #: ../fish/guestfish.pod:1054
22977 msgid "$HOME/.guestfish"
22982 #: ../fish/guestfish.pod:1056
22984 "If compiled with GNU readline support, then the command history is saved in "
22990 #: ../fish/guestfish.pod:1059
22991 msgid "$HOME/.inputrc"
22996 #: ../fish/guestfish.pod:1061
22997 msgid "/etc/inputrc"
23002 #: ../fish/guestfish.pod:1063
23004 "If compiled with GNU readline support, then these files can be used to "
23005 "configure readline. For further information, please see L<readline(3)/"
23006 "INITIALIZATION FILE>."
23011 #: ../fish/guestfish.pod:1067
23012 msgid "To write rules which only apply to guestfish, use:"
23017 #: ../fish/guestfish.pod:1069
23028 #: ../fish/guestfish.pod:1073
23030 "Variables that you can set in inputrc that change the behaviour of guestfish "
23031 "in useful ways include:"
23036 #: ../fish/guestfish.pod:1078
23037 msgid "completion-ignore-case (default: on)"
23042 #: ../fish/guestfish.pod:1080
23044 "By default, guestfish will ignore case when tab-completing paths on the "
23050 #: ../fish/guestfish.pod:1083
23053 " set completion-ignore-case off\n"
23059 #: ../fish/guestfish.pod:1085
23060 msgid "to make guestfish case sensitive."
23065 #: ../fish/guestfish.pod:1089
23071 #: ../fish/guestfish.pod:1091
23072 msgid "test2.img (etc)"
23077 #: ../fish/guestfish.pod:1093
23079 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
23080 "will be created in the file C<test1.img> in the current directory. The "
23081 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
23082 "the same name will be overwritten."
23087 #: ../fish/guestfish.pod:1102
23089 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
23090 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
23091 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
23092 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
23098 #: ../fish/guestfish.pod:1128 ../test-tool/libguestfs-test-tool.pod:124
23099 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:415
23100 #: ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512
23101 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
23102 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
23104 "This program is free software; you can redistribute it and/or modify it "
23105 "under the terms of the GNU General Public License as published by the Free "
23106 "Software Foundation; either version 2 of the License, or (at your option) "
23107 "any later version."
23112 #: ../fish/guestfish.pod:1133 ../test-tool/libguestfs-test-tool.pod:129
23113 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:420
23114 #: ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517
23115 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
23116 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
23118 "This program is distributed in the hope that it will be useful, but WITHOUT "
23119 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
23120 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
23126 #: ../fish/guestfish.pod:1138 ../test-tool/libguestfs-test-tool.pod:134
23127 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:425
23128 #: ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522
23129 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
23130 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
23132 "You should have received a copy of the GNU General Public License along with "
23133 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
23134 "Ave, Cambridge, MA 02139, USA."
23139 #: ../fish/guestfish-actions.pod:1
23145 #: ../fish/guestfish-actions.pod:3
23148 " add-cdrom filename\n"
23154 #: ../fish/guestfish-actions.pod:15
23156 "This call checks for the existence of C<filename>. This stops you from "
23157 "specifying other types of drive which are supported by qemu such as C<nbd:> "
23158 "and C<http:> URLs. To specify those, use the general L</config> call "
23164 #: ../fish/guestfish-actions.pod:22
23166 "If you just want to add an ISO file (often you use this as an efficient way "
23167 "to transfer large files into the guest), then you should probably use L</add-"
23168 "drive-ro> instead."
23172 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:151
23173 #: ../fish/guestfish-actions.pod:165
23175 "This function is deprecated. In new code, use the L</add_drive_opts> call "
23181 #: ../fish/guestfish-actions.pod:35
23187 #: ../fish/guestfish-actions.pod:37
23193 #: ../fish/guestfish-actions.pod:39
23196 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
23202 #: ../fish/guestfish-actions.pod:41
23204 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
23205 "It works by connecting to libvirt, requesting the domain and domain XML from "
23206 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
23211 #: ../fish/guestfish-actions.pod:64
23213 "The other optional parameters are passed directly through to L</add-drive-"
23219 #: ../fish/guestfish-actions.pod:67 ../fish/guestfish-actions.pod:131
23220 #: ../fish/guestfish-actions.pod:2850
23222 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
23227 #: ../fish/guestfish-actions.pod:69
23233 #: ../fish/guestfish-actions.pod:71
23236 " add-drive filename\n"
23242 #: ../fish/guestfish-actions.pod:73
23244 "This function is the equivalent of calling L</add-drive-opts> with no "
23245 "optional parameters, so the disk is added writable, with the format being "
23246 "detected automatically."
23251 #: ../fish/guestfish-actions.pod:77
23253 "Automatic detection of the format opens you up to a potential security hole "
23254 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
23255 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
23256 "you should think about replacing calls to this function with calls to L</add-"
23257 "drive-opts>, and specifying the format."
23262 #: ../fish/guestfish-actions.pod:84
23263 msgid "add-drive-opts"
23268 #: ../fish/guestfish-actions.pod:86
23274 #: ../fish/guestfish-actions.pod:88
23277 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
23283 #: ../fish/guestfish-actions.pod:115
23285 "This forces the image format. If you omit this (or use L</add-drive> or L</"
23286 "add-drive-ro>) then the format is automatically detected. Possible formats "
23287 "include C<raw> and C<qcow2>."
23292 #: ../fish/guestfish-actions.pod:126
23294 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
23295 "add-drive-with-if> call (q.v.)"
23300 #: ../fish/guestfish-actions.pod:133
23301 msgid "add-drive-ro"
23306 #: ../fish/guestfish-actions.pod:135
23312 #: ../fish/guestfish-actions.pod:137
23315 " add-drive-ro filename\n"
23321 #: ../fish/guestfish-actions.pod:139
23323 "This function is the equivalent of calling L</add-drive-opts> with the "
23324 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
23325 "is added read-only, with the format being detected automatically."
23330 #: ../fish/guestfish-actions.pod:144
23331 msgid "add-drive-ro-with-if"
23336 #: ../fish/guestfish-actions.pod:146
23339 " add-drive-ro-with-if filename iface\n"
23345 #: ../fish/guestfish-actions.pod:148
23347 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23348 "interface emulation to use at run time."
23353 #: ../fish/guestfish-actions.pod:158
23354 msgid "add-drive-with-if"
23359 #: ../fish/guestfish-actions.pod:160
23362 " add-drive-with-if filename iface\n"
23368 #: ../fish/guestfish-actions.pod:162
23370 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23371 "interface emulation to use at run time."
23376 #: ../fish/guestfish-actions.pod:172
23382 #: ../fish/guestfish-actions.pod:174
23385 " aug-clear augpath\n"
23391 #: ../fish/guestfish-actions.pod:179
23397 #: ../fish/guestfish-actions.pod:181
23406 #: ../fish/guestfish-actions.pod:183
23408 "Close the current Augeas handle and free up any resources used by it. After "
23409 "calling this, you have to call L</aug-init> again before you can use any "
23410 "other Augeas functions."
23415 #: ../fish/guestfish-actions.pod:188
23416 msgid "aug-defnode"
23421 #: ../fish/guestfish-actions.pod:190
23424 " aug-defnode name expr val\n"
23430 #: ../fish/guestfish-actions.pod:195
23432 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23433 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23434 "containing that single node."
23439 #: ../fish/guestfish-actions.pod:203
23445 #: ../fish/guestfish-actions.pod:205
23448 " aug-defvar name expr\n"
23454 #: ../fish/guestfish-actions.pod:214
23460 #: ../fish/guestfish-actions.pod:216
23463 " aug-get augpath\n"
23469 #: ../fish/guestfish-actions.pod:221
23475 #: ../fish/guestfish-actions.pod:223
23478 " aug-init root flags\n"
23484 #: ../fish/guestfish-actions.pod:229
23485 msgid "You must call this before using any other L</aug-*> commands."
23489 #: ../fish/guestfish-actions.pod:254
23491 "This option is only useful when debugging Augeas lenses. Use of this option "
23492 "may require additional memory for the libguestfs appliance. You may need to "
23493 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
23498 #: ../fish/guestfish-actions.pod:269
23499 msgid "Do not load the tree in L</aug-init>."
23504 #: ../fish/guestfish-actions.pod:273
23505 msgid "To close the handle, you can call L</aug-close>."
23510 #: ../fish/guestfish-actions.pod:277
23516 #: ../fish/guestfish-actions.pod:279
23519 " aug-insert augpath label true|false\n"
23525 #: ../fish/guestfish-actions.pod:289
23531 #: ../fish/guestfish-actions.pod:291
23540 #: ../fish/guestfish-actions.pod:298
23546 #: ../fish/guestfish-actions.pod:300
23549 " aug-ls augpath\n"
23555 #: ../fish/guestfish-actions.pod:302
23557 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23558 "resulting nodes into alphabetical order."
23563 #: ../fish/guestfish-actions.pod:305
23569 #: ../fish/guestfish-actions.pod:307
23572 " aug-match augpath\n"
23578 #: ../fish/guestfish-actions.pod:313
23584 #: ../fish/guestfish-actions.pod:315
23587 " aug-mv src dest\n"
23593 #: ../fish/guestfish-actions.pod:320
23599 #: ../fish/guestfish-actions.pod:322
23602 " aug-rm augpath\n"
23608 #: ../fish/guestfish-actions.pod:328
23614 #: ../fish/guestfish-actions.pod:330
23623 #: ../fish/guestfish-actions.pod:334
23625 "The flags which were passed to L</aug-init> affect exactly how files are "
23631 #: ../fish/guestfish-actions.pod:337
23637 #: ../fish/guestfish-actions.pod:339
23640 " aug-set augpath val\n"
23646 #: ../fish/guestfish-actions.pod:343
23648 "In the Augeas API, it is possible to clear a node by setting the value to "
23649 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23650 "this call. Instead you must use the L</aug-clear> call."
23655 #: ../fish/guestfish-actions.pod:348
23661 #: ../fish/guestfish-actions.pod:350
23664 " available 'groups ...'\n"
23670 #: ../fish/guestfish-actions.pod:356
23672 "The libguestfs groups, and the functions that those groups correspond to, "
23673 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23674 "runtime by calling L</available-all-groups>."
23679 #: ../fish/guestfish-actions.pod:380
23680 msgid "You must call L</launch> before calling this function."
23685 #: ../fish/guestfish-actions.pod:402
23687 "This call was added in version C<1.0.80>. In previous versions of "
23688 "libguestfs all you could do would be to speculatively execute a command to "
23689 "find out if the daemon implemented it. See also L</version>."
23694 #: ../fish/guestfish-actions.pod:409
23695 msgid "available-all-groups"
23700 #: ../fish/guestfish-actions.pod:411
23703 " available-all-groups\n"
23709 #: ../fish/guestfish-actions.pod:413
23711 "This command returns a list of all optional groups that this daemon knows "
23712 "about. Note this returns both supported and unsupported groups. To find "
23713 "out which ones the daemon can actually support you have to call L</"
23714 "available> on each member of the returned list."
23719 #: ../fish/guestfish-actions.pod:419
23720 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23725 #: ../fish/guestfish-actions.pod:421
23731 #: ../fish/guestfish-actions.pod:423
23734 " base64-in (base64file|-) filename\n"
23740 #: ../fish/guestfish-actions.pod:428 ../fish/guestfish-actions.pod:437
23741 #: ../fish/guestfish-actions.pod:661 ../fish/guestfish-actions.pod:830
23742 #: ../fish/guestfish-actions.pod:849 ../fish/guestfish-actions.pod:1223
23743 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4226
23744 #: ../fish/guestfish-actions.pod:4237 ../fish/guestfish-actions.pod:4248
23745 #: ../fish/guestfish-actions.pod:4300 ../fish/guestfish-actions.pod:4309
23746 #: ../fish/guestfish-actions.pod:4363 ../fish/guestfish-actions.pod:4386
23747 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23752 #: ../fish/guestfish-actions.pod:430
23758 #: ../fish/guestfish-actions.pod:432
23761 " base64-out filename (base64file|-)\n"
23767 #: ../fish/guestfish-actions.pod:439
23768 msgid "blockdev-flushbufs"
23773 #: ../fish/guestfish-actions.pod:441
23776 " blockdev-flushbufs device\n"
23782 #: ../fish/guestfish-actions.pod:448
23783 msgid "blockdev-getbsz"
23788 #: ../fish/guestfish-actions.pod:450
23791 " blockdev-getbsz device\n"
23797 #: ../fish/guestfish-actions.pod:459
23798 msgid "blockdev-getro"
23803 #: ../fish/guestfish-actions.pod:461
23806 " blockdev-getro device\n"
23812 #: ../fish/guestfish-actions.pod:468
23813 msgid "blockdev-getsize64"
23818 #: ../fish/guestfish-actions.pod:470
23821 " blockdev-getsize64 device\n"
23827 #: ../fish/guestfish-actions.pod:474
23828 msgid "See also L</blockdev-getsz>."
23833 #: ../fish/guestfish-actions.pod:478
23834 msgid "blockdev-getss"
23839 #: ../fish/guestfish-actions.pod:480
23842 " blockdev-getss device\n"
23848 #: ../fish/guestfish-actions.pod:485
23850 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23855 #: ../fish/guestfish-actions.pod:490
23856 msgid "blockdev-getsz"
23861 #: ../fish/guestfish-actions.pod:492
23864 " blockdev-getsz device\n"
23870 #: ../fish/guestfish-actions.pod:497
23872 "See also L</blockdev-getss> for the real sector size of the device, and L</"
23873 "blockdev-getsize64> for the more useful I<size in bytes>."
23878 #: ../fish/guestfish-actions.pod:503
23879 msgid "blockdev-rereadpt"
23884 #: ../fish/guestfish-actions.pod:505
23887 " blockdev-rereadpt device\n"
23893 #: ../fish/guestfish-actions.pod:511
23894 msgid "blockdev-setbsz"
23899 #: ../fish/guestfish-actions.pod:513
23902 " blockdev-setbsz device blocksize\n"
23908 #: ../fish/guestfish-actions.pod:522
23909 msgid "blockdev-setro"
23914 #: ../fish/guestfish-actions.pod:524
23917 " blockdev-setro device\n"
23923 #: ../fish/guestfish-actions.pod:530
23924 msgid "blockdev-setrw"
23929 #: ../fish/guestfish-actions.pod:532
23932 " blockdev-setrw device\n"
23938 #: ../fish/guestfish-actions.pod:538
23939 msgid "case-sensitive-path"
23944 #: ../fish/guestfish-actions.pod:540
23947 " case-sensitive-path path\n"
23953 #: ../fish/guestfish-actions.pod:564
23955 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
23956 "WINDOWS/system32\"> (the exact return value would depend on details of how "
23957 "the directories were originally created under Windows)."
23962 #: ../fish/guestfish-actions.pod:572
23963 msgid "See also L</realpath>."
23968 #: ../fish/guestfish-actions.pod:574
23974 #: ../fish/guestfish-actions.pod:576
23983 #: ../fish/guestfish-actions.pod:580
23985 "Note that this function cannot correctly handle binary files (specifically, "
23986 "files containing C<\\0> character which is treated as end of string). For "
23987 "those you need to use the L</read-file> or L</download> functions which have "
23988 "a more complex interface."
23993 #: ../fish/guestfish-actions.pod:588
23999 #: ../fish/guestfish-actions.pod:590
24002 " checksum csumtype path\n"
24008 #: ../fish/guestfish-actions.pod:633
24009 msgid "To get the checksum for a device, use L</checksum-device>."
24014 #: ../fish/guestfish-actions.pod:635
24015 msgid "To get the checksums for many files, use L</checksums-out>."
24020 #: ../fish/guestfish-actions.pod:637
24021 msgid "checksum-device"
24026 #: ../fish/guestfish-actions.pod:639
24029 " checksum-device csumtype device\n"
24035 #: ../fish/guestfish-actions.pod:641
24037 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
24038 "device named C<device>. For the types of checksums supported see the L</"
24039 "checksum> command."
24044 #: ../fish/guestfish-actions.pod:645
24045 msgid "checksums-out"
24050 #: ../fish/guestfish-actions.pod:647
24053 " checksums-out csumtype directory (sumsfile|-)\n"
24059 #: ../fish/guestfish-actions.pod:663
24065 #: ../fish/guestfish-actions.pod:665
24068 " chmod mode path\n"
24074 #: ../fish/guestfish-actions.pod:676
24080 #: ../fish/guestfish-actions.pod:678
24083 " chown owner group path\n"
24089 #: ../fish/guestfish-actions.pod:686
24095 #: ../fish/guestfish-actions.pod:688
24098 " command 'arguments ...'\n"
24104 #: ../fish/guestfish-actions.pod:695
24106 "The single parameter is an argv-style list of arguments. The first element "
24107 "is the name of the program to run. Subsequent elements are parameters. The "
24108 "list must be non-empty (ie. must contain a program name). Note that the "
24109 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
24114 #: ../fish/guestfish-actions.pod:723
24115 msgid "command-lines"
24120 #: ../fish/guestfish-actions.pod:725
24123 " command-lines 'arguments ...'\n"
24129 #: ../fish/guestfish-actions.pod:727
24131 "This is the same as L</command>, but splits the result into a list of lines."
24136 #: ../fish/guestfish-actions.pod:730
24137 msgid "See also: L</sh-lines>"
24142 #: ../fish/guestfish-actions.pod:735
24148 #: ../fish/guestfish-actions.pod:737
24151 " config qemuparam qemuvalue\n"
24157 #: ../fish/guestfish-actions.pod:748
24163 #: ../fish/guestfish-actions.pod:750
24166 " copy-size src dest size\n"
24172 #: ../fish/guestfish-actions.pod:758
24178 #: ../fish/guestfish-actions.pod:760
24187 #: ../fish/guestfish-actions.pod:765
24193 #: ../fish/guestfish-actions.pod:767
24202 #: ../fish/guestfish-actions.pod:772
24208 #: ../fish/guestfish-actions.pod:774
24217 #: ../fish/guestfish-actions.pod:781
24219 "If the destination is a device, it must be as large or larger than the "
24220 "source file or device, otherwise the copy will fail. This command cannot do "
24221 "partial copies (see L</copy-size>)."
24226 #: ../fish/guestfish-actions.pod:785
24232 #: ../fish/guestfish-actions.pod:787
24241 #: ../fish/guestfish-actions.pod:791 ../fish/guestfish-actions.pod:802
24243 "This command is mostly useful for interactive sessions. It is I<not> "
24244 "intended that you try to parse the output string. Use L</statvfs> from "
24250 #: ../fish/guestfish-actions.pod:795
24256 #: ../fish/guestfish-actions.pod:797
24265 #: ../fish/guestfish-actions.pod:806
24271 #: ../fish/guestfish-actions.pod:808
24280 #: ../fish/guestfish-actions.pod:814
24282 "Another way to get the same information is to enable verbose messages with "
24283 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
24284 "before running the program."
24289 #: ../fish/guestfish-actions.pod:819
24295 #: ../fish/guestfish-actions.pod:821
24298 " download remotefilename (filename|-)\n"
24304 #: ../fish/guestfish-actions.pod:828
24305 msgid "See also L</upload>, L</cat>."
24310 #: ../fish/guestfish-actions.pod:832
24311 msgid "download-offset"
24316 #: ../fish/guestfish-actions.pod:834
24319 " download-offset remotefilename (filename|-) offset size\n"
24325 #: ../fish/guestfish-actions.pod:842
24327 "Note that there is no limit on the amount of data that can be downloaded "
24328 "with this call, unlike with L</pread>, and this call always reads the full "
24329 "amount unless an error occurs."
24334 #: ../fish/guestfish-actions.pod:847
24335 msgid "See also L</download>, L</pread>."
24340 #: ../fish/guestfish-actions.pod:851
24341 msgid "drop-caches"
24346 #: ../fish/guestfish-actions.pod:853
24349 " drop-caches whattodrop\n"
24355 #: ../fish/guestfish-actions.pod:865
24361 #: ../fish/guestfish-actions.pod:867
24370 #: ../fish/guestfish-actions.pod:879
24376 #: ../fish/guestfish-actions.pod:881
24379 " e2fsck-f device\n"
24385 #: ../fish/guestfish-actions.pod:887
24387 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
24388 "should use L</fsck>."
24393 #: ../fish/guestfish-actions.pod:890
24394 msgid "echo-daemon"
24399 #: ../fish/guestfish-actions.pod:892
24402 " echo-daemon 'words ...'\n"
24408 #: ../fish/guestfish-actions.pod:899
24409 msgid "See also L</ping-daemon>."
24414 #: ../fish/guestfish-actions.pod:901
24420 #: ../fish/guestfish-actions.pod:903
24423 " egrep regex path\n"
24429 #: ../fish/guestfish-actions.pod:911
24435 #: ../fish/guestfish-actions.pod:913
24438 " egrepi regex path\n"
24444 #: ../fish/guestfish-actions.pod:921
24450 #: ../fish/guestfish-actions.pod:923
24453 " equal file1 file2\n"
24459 #: ../fish/guestfish-actions.pod:930
24465 #: ../fish/guestfish-actions.pod:932
24474 #: ../fish/guestfish-actions.pod:937
24475 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24480 #: ../fish/guestfish-actions.pod:939
24486 #: ../fish/guestfish-actions.pod:941
24489 " fallocate path len\n"
24494 #: ../fish/guestfish-actions.pod:951
24496 "This function is deprecated. In new code, use the L</fallocate64> call "
24502 #: ../fish/guestfish-actions.pod:958
24503 msgid "fallocate64"
24508 #: ../fish/guestfish-actions.pod:960
24511 " fallocate64 path len\n"
24517 #: ../fish/guestfish-actions.pod:966
24519 "Note that this call allocates disk blocks for the file. To create a sparse "
24520 "file use L</truncate-size> instead."
24525 #: ../fish/guestfish-actions.pod:969
24527 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24528 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24529 "maximum size of files created through that call to 1GB."
24534 #: ../fish/guestfish-actions.pod:978
24540 #: ../fish/guestfish-actions.pod:980
24543 " fgrep pattern path\n"
24549 #: ../fish/guestfish-actions.pod:988
24555 #: ../fish/guestfish-actions.pod:990
24558 " fgrepi pattern path\n"
24564 #: ../fish/guestfish-actions.pod:998
24570 #: ../fish/guestfish-actions.pod:1000
24578 #: ../fish/guestfish-actions.pod:1016
24580 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
24586 #: ../fish/guestfish-actions.pod:1019
24587 msgid "file-architecture"
24592 #: ../fish/guestfish-actions.pod:1021
24595 " file-architecture filename\n"
24601 #: ../fish/guestfish-actions.pod:1124
24607 #: ../fish/guestfish-actions.pod:1126
24616 #: ../fish/guestfish-actions.pod:1130
24618 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24619 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24624 #: ../fish/guestfish-actions.pod:1134
24630 #: ../fish/guestfish-actions.pod:1136
24633 " fill c len path\n"
24639 #: ../fish/guestfish-actions.pod:1142
24641 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24642 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
24643 "L</fill-pattern>."
24648 #: ../fish/guestfish-actions.pod:1147
24649 msgid "fill-pattern"
24654 #: ../fish/guestfish-actions.pod:1149
24657 " fill-pattern pattern len path\n"
24663 #: ../fish/guestfish-actions.pod:1151
24665 "This function is like L</fill> except that it creates a new file of length "
24666 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
24667 "is truncated if necessary to ensure the length of the file is exactly C<len> "
24673 #: ../fish/guestfish-actions.pod:1156
24679 #: ../fish/guestfish-actions.pod:1158
24682 " find directory\n"
24688 #: ../fish/guestfish-actions.pod:1172
24689 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24694 #: ../fish/guestfish-actions.pod:1185
24695 msgid "See also L</find0>."
24700 #: ../fish/guestfish-actions.pod:1190
24706 #: ../fish/guestfish-actions.pod:1192
24709 " find0 directory (files|-)\n"
24715 #: ../fish/guestfish-actions.pod:1198
24717 "This command works the same way as L</find> with the following exceptions:"
24722 #: ../fish/guestfish-actions.pod:1225
24723 msgid "findfs-label"
24728 #: ../fish/guestfish-actions.pod:1227
24731 " findfs-label label\n"
24737 #: ../fish/guestfish-actions.pod:1233
24738 msgid "To find the label of a filesystem, use L</vfs-label>."
24743 #: ../fish/guestfish-actions.pod:1235
24744 msgid "findfs-uuid"
24749 #: ../fish/guestfish-actions.pod:1237
24752 " findfs-uuid uuid\n"
24758 #: ../fish/guestfish-actions.pod:1243
24759 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24764 #: ../fish/guestfish-actions.pod:1245
24770 #: ../fish/guestfish-actions.pod:1247
24773 " fsck fstype device\n"
24779 #: ../fish/guestfish-actions.pod:1277
24785 #: ../fish/guestfish-actions.pod:1279
24794 #: ../fish/guestfish-actions.pod:1286
24795 msgid "get-autosync"
24800 #: ../fish/guestfish-actions.pod:1288
24809 #: ../fish/guestfish-actions.pod:1292
24815 #: ../fish/guestfish-actions.pod:1294
24824 #: ../fish/guestfish-actions.pod:1298
24825 msgid "get-e2label"
24830 #: ../fish/guestfish-actions.pod:1300
24833 " get-e2label device\n"
24838 #: ../fish/guestfish-actions.pod:1305
24840 "This function is deprecated. In new code, use the L</vfs_label> call "
24846 #: ../fish/guestfish-actions.pod:1312
24852 #: ../fish/guestfish-actions.pod:1314
24855 " get-e2uuid device\n"
24860 #: ../fish/guestfish-actions.pod:1319
24862 "This function is deprecated. In new code, use the L</vfs_uuid> call instead."
24867 #: ../fish/guestfish-actions.pod:1326
24868 msgid "get-memsize"
24873 #: ../fish/guestfish-actions.pod:1328
24882 #: ../fish/guestfish-actions.pod:1333
24884 "If L</set-memsize> was not called on this handle, and if "
24885 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
24886 "value for memsize."
24891 #: ../fish/guestfish-actions.pod:1340
24892 msgid "get-network"
24897 #: ../fish/guestfish-actions.pod:1342
24906 #: ../fish/guestfish-actions.pod:1346
24912 #: ../fish/guestfish-actions.pod:1348
24921 #: ../fish/guestfish-actions.pod:1355
24927 #: ../fish/guestfish-actions.pod:1357
24933 #: ../fish/guestfish-actions.pod:1359
24942 #: ../fish/guestfish-actions.pod:1366
24948 #: ../fish/guestfish-actions.pod:1368
24957 #: ../fish/guestfish-actions.pod:1375
24958 msgid "get-recovery-proc"
24963 #: ../fish/guestfish-actions.pod:1377
24966 " get-recovery-proc\n"
24972 #: ../fish/guestfish-actions.pod:1381
24973 msgid "get-selinux"
24978 #: ../fish/guestfish-actions.pod:1383
24987 #: ../fish/guestfish-actions.pod:1385
24989 "This returns the current setting of the selinux flag which is passed to the "
24990 "appliance at boot time. See L</set-selinux>."
24995 #: ../fish/guestfish-actions.pod:1391
25001 #: ../fish/guestfish-actions.pod:1393
25010 #: ../fish/guestfish-actions.pod:1400
25016 #: ../fish/guestfish-actions.pod:1402
25025 #: ../fish/guestfish-actions.pod:1406
25031 #: ../fish/guestfish-actions.pod:1408
25040 #: ../fish/guestfish-actions.pod:1410
25042 "Return the current umask. By default the umask is C<022> unless it has been "
25043 "set by calling L</umask>."
25048 #: ../fish/guestfish-actions.pod:1413
25049 msgid "get-verbose"
25054 #: ../fish/guestfish-actions.pod:1415
25063 #: ../fish/guestfish-actions.pod:1419
25069 #: ../fish/guestfish-actions.pod:1421
25078 #: ../fish/guestfish-actions.pod:1425
25079 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
25084 #: ../fish/guestfish-actions.pod:1428
25090 #: ../fish/guestfish-actions.pod:1430
25093 " getxattr path name\n"
25099 #: ../fish/guestfish-actions.pod:1432
25101 "Get a single extended attribute from file C<path> named C<name>. This call "
25102 "follows symlinks. If you want to lookup an extended attribute for the "
25103 "symlink itself, use L</lgetxattr>."
25108 #: ../fish/guestfish-actions.pod:1436 ../fish/guestfish-actions.pod:2267
25110 "Normally it is better to get all extended attributes from a file in one go "
25111 "by calling L</getxattrs>. However some Linux filesystem implementations are "
25112 "buggy and do not provide a way to list out attributes. For these "
25113 "filesystems (notably ntfs-3g) you have to know the names of the extended "
25114 "attributes you want in advance and call this function."
25119 #: ../fish/guestfish-actions.pod:1446
25120 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
25125 #: ../fish/guestfish-actions.pod:1448
25131 #: ../fish/guestfish-actions.pod:1450
25134 " getxattrs path\n"
25140 #: ../fish/guestfish-actions.pod:1458
25141 msgid "See also: L</lgetxattrs>, L<attr(5)>."
25146 #: ../fish/guestfish-actions.pod:1460
25147 msgid "glob-expand"
25152 #: ../fish/guestfish-actions.pod:1462
25155 " glob-expand pattern\n"
25161 #: ../fish/guestfish-actions.pod:1475
25167 #: ../fish/guestfish-actions.pod:1477
25170 " grep regex path\n"
25176 #: ../fish/guestfish-actions.pod:1485
25182 #: ../fish/guestfish-actions.pod:1487
25185 " grepi regex path\n"
25191 #: ../fish/guestfish-actions.pod:1495
25192 msgid "grub-install"
25197 #: ../fish/guestfish-actions.pod:1497
25200 " grub-install root device\n"
25206 #: ../fish/guestfish-actions.pod:1513
25212 #: ../fish/guestfish-actions.pod:1515
25221 #: ../fish/guestfish-actions.pod:1523
25227 #: ../fish/guestfish-actions.pod:1525
25230 " head-n nrlines path\n"
25236 #: ../fish/guestfish-actions.pod:1538
25242 #: ../fish/guestfish-actions.pod:1540
25251 #: ../fish/guestfish-actions.pod:1548
25257 #: ../fish/guestfish-actions.pod:1550
25260 " initrd-cat initrdpath filename\n"
25266 #: ../fish/guestfish-actions.pod:1562
25267 msgid "See also L</initrd-list>."
25272 #: ../fish/guestfish-actions.pod:1567
25273 msgid "initrd-list"
25278 #: ../fish/guestfish-actions.pod:1569
25281 " initrd-list path\n"
25287 #: ../fish/guestfish-actions.pod:1581
25288 msgid "inotify-add-watch"
25293 #: ../fish/guestfish-actions.pod:1583
25296 " inotify-add-watch path mask\n"
25302 #: ../fish/guestfish-actions.pod:1595
25303 msgid "inotify-close"
25308 #: ../fish/guestfish-actions.pod:1597
25317 #: ../fish/guestfish-actions.pod:1603
25318 msgid "inotify-files"
25323 #: ../fish/guestfish-actions.pod:1605
25332 #: ../fish/guestfish-actions.pod:1607
25334 "This function is a helpful wrapper around L</inotify-read> which just "
25335 "returns a list of pathnames of objects that were touched. The returned "
25336 "pathnames are sorted and deduplicated."
25341 #: ../fish/guestfish-actions.pod:1611
25342 msgid "inotify-init"
25347 #: ../fish/guestfish-actions.pod:1613
25350 " inotify-init maxevents\n"
25356 #: ../fish/guestfish-actions.pod:1619
25358 "C<maxevents> is the maximum number of events which will be queued up between "
25359 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
25360 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
25361 "default was 16384 events. Beyond this limit, the kernel throws away events, "
25362 "but records the fact that it threw them away by setting a flag "
25363 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
25368 #: ../fish/guestfish-actions.pod:1629
25370 "Before any events are generated, you have to add some watches to the "
25371 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
25372 "L</inotify-watch-all>."
25377 #: ../fish/guestfish-actions.pod:1635
25379 "Queued up events should be read periodically by calling L</inotify-read> (or "
25380 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
25381 "If you don't read the events out often enough then you risk the internal "
25382 "queue overflowing."
25387 #: ../fish/guestfish-actions.pod:1642
25389 "The handle should be closed after use by calling L</inotify-close>. This "
25390 "also removes any watches automatically."
25395 #: ../fish/guestfish-actions.pod:1651
25396 msgid "inotify-read"
25401 #: ../fish/guestfish-actions.pod:1653
25410 #: ../fish/guestfish-actions.pod:1666
25411 msgid "inotify-rm-watch"
25416 #: ../fish/guestfish-actions.pod:1668
25419 " inotify-rm-watch wd\n"
25425 #: ../fish/guestfish-actions.pod:1670
25426 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
25431 #: ../fish/guestfish-actions.pod:1673
25432 msgid "inspect-get-arch"
25437 #: ../fish/guestfish-actions.pod:1675
25440 " inspect-get-arch root\n"
25446 #: ../fish/guestfish-actions.pod:1677 ../fish/guestfish-actions.pod:1693
25447 #: ../fish/guestfish-actions.pod:1767 ../fish/guestfish-actions.pod:1785
25448 #: ../fish/guestfish-actions.pod:1800 ../fish/guestfish-actions.pod:1821
25449 #: ../fish/guestfish-actions.pod:1836 ../fish/guestfish-actions.pod:1863
25450 #: ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1909
25451 #: ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1974
25452 #: ../fish/guestfish-actions.pod:1990
25454 "This function should only be called with a root device string as returned by "
25460 #: ../fish/guestfish-actions.pod:1680
25462 "This returns the architecture of the inspected operating system. The "
25463 "possible return values are listed under L</file-architecture>."
25468 #: ../fish/guestfish-actions.pod:1689
25469 msgid "inspect-get-distro"
25474 #: ../fish/guestfish-actions.pod:1691
25477 " inspect-get-distro root\n"
25483 #: ../fish/guestfish-actions.pod:1763
25484 msgid "inspect-get-filesystems"
25489 #: ../fish/guestfish-actions.pod:1765
25492 " inspect-get-filesystems root\n"
25498 #: ../fish/guestfish-actions.pod:1778
25500 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25501 "get-mountpoints>."
25506 #: ../fish/guestfish-actions.pod:1781
25507 msgid "inspect-get-hostname"
25512 #: ../fish/guestfish-actions.pod:1783
25515 " inspect-get-hostname root\n"
25521 #: ../fish/guestfish-actions.pod:1796
25522 msgid "inspect-get-major-version"
25527 #: ../fish/guestfish-actions.pod:1798
25530 " inspect-get-major-version root\n"
25536 #: ../fish/guestfish-actions.pod:1817
25537 msgid "inspect-get-minor-version"
25542 #: ../fish/guestfish-actions.pod:1819
25545 " inspect-get-minor-version root\n"
25551 #: ../fish/guestfish-actions.pod:1829
25553 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25554 "get-major-version>."
25559 #: ../fish/guestfish-actions.pod:1832
25560 msgid "inspect-get-mountpoints"
25565 #: ../fish/guestfish-actions.pod:1834
25568 " inspect-get-mountpoints root\n"
25574 #: ../fish/guestfish-actions.pod:1856
25576 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25577 "get-filesystems>."
25582 #: ../fish/guestfish-actions.pod:1859
25583 msgid "inspect-get-package-format"
25588 #: ../fish/guestfish-actions.pod:1861
25591 " inspect-get-package-format root\n"
25597 #: ../fish/guestfish-actions.pod:1866
25599 "This function and L</inspect-get-package-management> return the package "
25600 "format and package management tool used by the inspected operating system. "
25601 "For example for Fedora these functions would return C<rpm> (package format) "
25602 "and C<yum> (package management)."
25607 #: ../fish/guestfish-actions.pod:1881
25608 msgid "inspect-get-package-management"
25613 #: ../fish/guestfish-actions.pod:1883
25616 " inspect-get-package-management root\n"
25622 #: ../fish/guestfish-actions.pod:1888
25624 "L</inspect-get-package-format> and this function return the package format "
25625 "and package management tool used by the inspected operating system. For "
25626 "example for Fedora these functions would return C<rpm> (package format) and "
25627 "C<yum> (package management)."
25632 #: ../fish/guestfish-actions.pod:1905
25633 msgid "inspect-get-product-name"
25638 #: ../fish/guestfish-actions.pod:1907
25641 " inspect-get-product-name root\n"
25647 #: ../fish/guestfish-actions.pod:1922
25648 msgid "inspect-get-roots"
25653 #: ../fish/guestfish-actions.pod:1924
25656 " inspect-get-roots\n"
25662 #: ../fish/guestfish-actions.pod:1926
25664 "This function is a convenient way to get the list of root devices, as "
25665 "returned from a previous call to L</inspect-os>, but without redoing the "
25666 "whole inspection process."
25671 #: ../fish/guestfish-actions.pod:1930
25673 "This returns an empty list if either no root devices were found or the "
25674 "caller has not called L</inspect-os>."
25679 #: ../fish/guestfish-actions.pod:1935
25680 msgid "inspect-get-type"
25685 #: ../fish/guestfish-actions.pod:1937
25688 " inspect-get-type root\n"
25694 #: ../fish/guestfish-actions.pod:1970
25695 msgid "inspect-get-windows-systemroot"
25700 #: ../fish/guestfish-actions.pod:1972
25703 " inspect-get-windows-systemroot root\n"
25709 #: ../fish/guestfish-actions.pod:1986
25710 msgid "inspect-list-applications"
25715 #: ../fish/guestfish-actions.pod:1988
25718 " inspect-list-applications root\n"
25724 #: ../fish/guestfish-actions.pod:1995
25726 "I<Note:> This call works differently from other parts of the inspection "
25727 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
25728 "then mount up the disks, before calling this. Listing applications is a "
25729 "significantly more difficult operation which requires access to the full "
25730 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25731 "are just returning data cached in the libguestfs handle, this call actually "
25732 "reads parts of the mounted filesystems during the call."
25737 #: ../fish/guestfish-actions.pod:2085
25743 #: ../fish/guestfish-actions.pod:2087
25752 #: ../fish/guestfish-actions.pod:2102
25754 "You can pass the root string(s) returned to other L</inspect-get-*> "
25755 "functions in order to query further information about each operating system, "
25756 "such as the name and version."
25761 #: ../fish/guestfish-actions.pod:2107
25763 "This function uses other libguestfs features such as L</mount-ro> and L</"
25764 "umount-all> in order to mount and unmount filesystems and look at the "
25765 "contents. This should be called with no disks currently mounted. The "
25766 "function may also use Augeas, so any existing Augeas handle will be closed."
25771 #: ../fish/guestfish-actions.pod:2119 ../fish/guestfish-actions.pod:2295
25772 #: ../fish/guestfish-actions.pod:2341
25773 msgid "See also L</list-filesystems>."
25778 #: ../fish/guestfish-actions.pod:2121
25779 msgid "is-blockdev"
25784 #: ../fish/guestfish-actions.pod:2123
25787 " is-blockdev path\n"
25793 #: ../fish/guestfish-actions.pod:2128 ../fish/guestfish-actions.pod:2146
25794 #: ../fish/guestfish-actions.pod:2165 ../fish/guestfish-actions.pod:2174
25795 #: ../fish/guestfish-actions.pod:2184 ../fish/guestfish-actions.pod:2218
25796 #: ../fish/guestfish-actions.pod:2227
25797 msgid "See also L</stat>."
25802 #: ../fish/guestfish-actions.pod:2130
25808 #: ../fish/guestfish-actions.pod:2132
25817 #: ../fish/guestfish-actions.pod:2139
25823 #: ../fish/guestfish-actions.pod:2141
25826 " is-chardev path\n"
25832 #: ../fish/guestfish-actions.pod:2148
25838 #: ../fish/guestfish-actions.pod:2150
25847 #: ../fish/guestfish-actions.pod:2157
25853 #: ../fish/guestfish-actions.pod:2159
25862 #: ../fish/guestfish-actions.pod:2167
25868 #: ../fish/guestfish-actions.pod:2169
25877 #: ../fish/guestfish-actions.pod:2176
25883 #: ../fish/guestfish-actions.pod:2178
25892 #: ../fish/guestfish-actions.pod:2186
25893 msgid "is-launching"
25898 #: ../fish/guestfish-actions.pod:2188
25907 #: ../fish/guestfish-actions.pod:2195
25913 #: ../fish/guestfish-actions.pod:2197
25922 #: ../fish/guestfish-actions.pod:2202
25928 #: ../fish/guestfish-actions.pod:2204
25937 #: ../fish/guestfish-actions.pod:2211
25943 #: ../fish/guestfish-actions.pod:2213
25946 " is-socket path\n"
25952 #: ../fish/guestfish-actions.pod:2220
25958 #: ../fish/guestfish-actions.pod:2222
25961 " is-symlink path\n"
25967 #: ../fish/guestfish-actions.pod:2229
25968 msgid "kill-subprocess"
25973 #: ../fish/guestfish-actions.pod:2231
25976 " kill-subprocess\n"
25982 #: ../fish/guestfish-actions.pod:2235
25988 #: ../fish/guestfish-actions.pod:2237
25994 #: ../fish/guestfish-actions.pod:2239
26003 #: ../fish/guestfish-actions.pod:2247
26009 #: ../fish/guestfish-actions.pod:2249
26012 " lchown owner group path\n"
26018 #: ../fish/guestfish-actions.pod:2251
26020 "Change the file owner to C<owner> and group to C<group>. This is like L</"
26021 "chown> but if C<path> is a symlink then the link itself is changed, not the "
26027 #: ../fish/guestfish-actions.pod:2259
26033 #: ../fish/guestfish-actions.pod:2261
26036 " lgetxattr path name\n"
26042 #: ../fish/guestfish-actions.pod:2277
26043 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
26048 #: ../fish/guestfish-actions.pod:2279
26054 #: ../fish/guestfish-actions.pod:2281
26057 " lgetxattrs path\n"
26063 #: ../fish/guestfish-actions.pod:2283
26065 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
26066 "it returns the extended attributes of the link itself."
26071 #: ../fish/guestfish-actions.pod:2287
26072 msgid "list-devices"
26077 #: ../fish/guestfish-actions.pod:2289
26086 #: ../fish/guestfish-actions.pod:2297
26087 msgid "list-filesystems"
26092 #: ../fish/guestfish-actions.pod:2299
26095 " list-filesystems\n"
26101 #: ../fish/guestfish-actions.pod:2318
26103 "This command runs other libguestfs commands, which might include L</mount> "
26104 "and L</umount>, and therefore you should use this soon after launch and only "
26105 "when nothing is mounted."
26110 #: ../fish/guestfish-actions.pod:2322
26112 "Not all of the filesystems returned will be mountable. In particular, swap "
26113 "partitions are returned in the list. Also this command does not check that "
26114 "each filesystem found is valid and mountable, and some filesystems might be "
26115 "mountable but require special options. Filesystems may not all belong to a "
26116 "single logical operating system (use L</inspect-os> to look for OSes)."
26121 #: ../fish/guestfish-actions.pod:2330
26122 msgid "list-partitions"
26127 #: ../fish/guestfish-actions.pod:2332
26130 " list-partitions\n"
26136 #: ../fish/guestfish-actions.pod:2338
26138 "This does not return logical volumes. For that you will need to call L</"
26144 #: ../fish/guestfish-actions.pod:2343
26150 #: ../fish/guestfish-actions.pod:2345
26159 #: ../fish/guestfish-actions.pod:2353
26165 #: ../fish/guestfish-actions.pod:2355
26168 " ln target linkname\n"
26174 #: ../fish/guestfish-actions.pod:2359
26180 #: ../fish/guestfish-actions.pod:2361
26183 " ln-f target linkname\n"
26189 #: ../fish/guestfish-actions.pod:2366
26195 #: ../fish/guestfish-actions.pod:2368
26198 " ln-s target linkname\n"
26204 #: ../fish/guestfish-actions.pod:2372
26210 #: ../fish/guestfish-actions.pod:2374
26213 " ln-sf target linkname\n"
26219 #: ../fish/guestfish-actions.pod:2379
26220 msgid "lremovexattr"
26225 #: ../fish/guestfish-actions.pod:2381
26228 " lremovexattr xattr path\n"
26234 #: ../fish/guestfish-actions.pod:2383
26236 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
26237 "it removes an extended attribute of the link itself."
26242 #: ../fish/guestfish-actions.pod:2387
26248 #: ../fish/guestfish-actions.pod:2389
26257 #: ../fish/guestfish-actions.pod:2395
26259 "This command is mostly useful for interactive sessions. Programs should "
26260 "probably use L</readdir> instead."
26265 #: ../fish/guestfish-actions.pod:2398
26271 #: ../fish/guestfish-actions.pod:2400
26274 " lsetxattr xattr val vallen path\n"
26280 #: ../fish/guestfish-actions.pod:2402
26282 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
26283 "sets an extended attribute of the link itself."
26288 #: ../fish/guestfish-actions.pod:2406
26294 #: ../fish/guestfish-actions.pod:2408
26303 #: ../fish/guestfish-actions.pod:2412
26305 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
26306 "the link is stat-ed, not the file it refers to."
26311 #: ../fish/guestfish-actions.pod:2418
26317 #: ../fish/guestfish-actions.pod:2420
26320 " lstatlist path 'names ...'\n"
26326 #: ../fish/guestfish-actions.pod:2422
26328 "This call allows you to perform the L</lstat> operation on multiple files, "
26329 "where all files are in the directory C<path>. C<names> is the list of files "
26330 "from this directory."
26335 #: ../fish/guestfish-actions.pod:2431
26337 "This call is intended for programs that want to efficiently list a directory "
26338 "contents without making many round-trips. See also L</lxattrlist> for a "
26339 "similarly efficient call for getting extended attributes. Very long "
26340 "directory listings might cause the protocol message size to be exceeded, "
26341 "causing this call to fail. The caller must split up such requests into "
26342 "smaller groups of names."
26347 #: ../fish/guestfish-actions.pod:2439
26348 msgid "luks-add-key"
26353 #: ../fish/guestfish-actions.pod:2441
26356 " luks-add-key device keyslot\n"
26362 #: ../fish/guestfish-actions.pod:2448
26364 "Note that if C<keyslot> already contains a key, then this command will "
26365 "fail. You have to use L</luks-kill-slot> first to remove that key."
26370 #: ../fish/guestfish-actions.pod:2452 ../fish/guestfish-actions.pod:2474
26371 #: ../fish/guestfish-actions.pod:2487 ../fish/guestfish-actions.pod:2501
26372 #: ../fish/guestfish-actions.pod:2524 ../fish/guestfish-actions.pod:2534
26374 "This command has one or more key or passphrase parameters. Guestfish will "
26375 "prompt for these separately."
26380 #: ../fish/guestfish-actions.pod:2455
26386 #: ../fish/guestfish-actions.pod:2457
26389 " luks-close device\n"
26395 #: ../fish/guestfish-actions.pod:2459
26397 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
26398 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
26399 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
26405 #: ../fish/guestfish-actions.pod:2465
26406 msgid "luks-format"
26411 #: ../fish/guestfish-actions.pod:2467
26414 " luks-format device keyslot\n"
26420 #: ../fish/guestfish-actions.pod:2480
26421 msgid "luks-format-cipher"
26426 #: ../fish/guestfish-actions.pod:2482
26429 " luks-format-cipher device keyslot cipher\n"
26435 #: ../fish/guestfish-actions.pod:2484
26437 "This command is the same as L</luks-format> but it also allows you to set "
26438 "the C<cipher> used."
26443 #: ../fish/guestfish-actions.pod:2493
26444 msgid "luks-kill-slot"
26449 #: ../fish/guestfish-actions.pod:2495
26452 " luks-kill-slot device keyslot\n"
26458 #: ../fish/guestfish-actions.pod:2504
26464 #: ../fish/guestfish-actions.pod:2506
26467 " luks-open device mapname\n"
26473 #: ../fish/guestfish-actions.pod:2520
26475 "If this block device contains LVM volume groups, then calling L</vgscan> "
26476 "followed by L</vg-activate-all> will make them visible."
26481 #: ../fish/guestfish-actions.pod:2527
26482 msgid "luks-open-ro"
26487 #: ../fish/guestfish-actions.pod:2529
26490 " luks-open-ro device mapname\n"
26496 #: ../fish/guestfish-actions.pod:2531
26498 "This is the same as L</luks-open> except that a read-only mapping is created."
26503 #: ../fish/guestfish-actions.pod:2537
26509 #: ../fish/guestfish-actions.pod:2539
26512 " lvcreate logvol volgroup mbytes\n"
26518 #: ../fish/guestfish-actions.pod:2544
26519 msgid "lvm-canonical-lv-name"
26524 #: ../fish/guestfish-actions.pod:2546
26527 " lvm-canonical-lv-name lvname\n"
26533 #: ../fish/guestfish-actions.pod:2555
26534 msgid "See also L</is-lv>."
26539 #: ../fish/guestfish-actions.pod:2557
26540 msgid "lvm-clear-filter"
26545 #: ../fish/guestfish-actions.pod:2559
26548 " lvm-clear-filter\n"
26554 #: ../fish/guestfish-actions.pod:2561
26556 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
26562 #: ../fish/guestfish-actions.pod:2567
26563 msgid "lvm-remove-all"
26568 #: ../fish/guestfish-actions.pod:2569
26571 " lvm-remove-all\n"
26577 #: ../fish/guestfish-actions.pod:2577
26578 msgid "lvm-set-filter"
26583 #: ../fish/guestfish-actions.pod:2579
26586 " lvm-set-filter 'devices ...'\n"
26592 #: ../fish/guestfish-actions.pod:2604
26598 #: ../fish/guestfish-actions.pod:2606
26601 " lvremove device\n"
26607 #: ../fish/guestfish-actions.pod:2614
26613 #: ../fish/guestfish-actions.pod:2616
26616 " lvrename logvol newlogvol\n"
26622 #: ../fish/guestfish-actions.pod:2620
26628 #: ../fish/guestfish-actions.pod:2622
26631 " lvresize device mbytes\n"
26637 #: ../fish/guestfish-actions.pod:2628
26638 msgid "lvresize-free"
26643 #: ../fish/guestfish-actions.pod:2630
26646 " lvresize-free lv percent\n"
26652 #: ../fish/guestfish-actions.pod:2638
26658 #: ../fish/guestfish-actions.pod:2640
26667 #: ../fish/guestfish-actions.pod:2648
26668 msgid "See also L</lvs-full>, L</list-filesystems>."
26673 #: ../fish/guestfish-actions.pod:2650
26679 #: ../fish/guestfish-actions.pod:2652
26688 #: ../fish/guestfish-actions.pod:2657
26694 #: ../fish/guestfish-actions.pod:2659
26703 #: ../fish/guestfish-actions.pod:2663
26709 #: ../fish/guestfish-actions.pod:2665
26712 " lxattrlist path 'names ...'\n"
26718 #: ../fish/guestfish-actions.pod:2681
26720 "This call is intended for programs that want to efficiently list a directory "
26721 "contents without making many round-trips. See also L</lstatlist> for a "
26722 "similarly efficient call for getting standard stats. Very long directory "
26723 "listings might cause the protocol message size to be exceeded, causing this "
26724 "call to fail. The caller must split up such requests into smaller groups of "
26730 #: ../fish/guestfish-actions.pod:2689
26736 #: ../fish/guestfish-actions.pod:2691
26745 #: ../fish/guestfish-actions.pod:2695
26751 #: ../fish/guestfish-actions.pod:2697
26754 " mkdir-mode path mode\n"
26760 #: ../fish/guestfish-actions.pod:2706
26761 msgid "See also L</mkdir>, L</umask>"
26766 #: ../fish/guestfish-actions.pod:2708
26772 #: ../fish/guestfish-actions.pod:2710
26781 #: ../fish/guestfish-actions.pod:2715
26787 #: ../fish/guestfish-actions.pod:2717
26790 " mkdtemp template\n"
26796 #: ../fish/guestfish-actions.pod:2738
26802 #: ../fish/guestfish-actions.pod:2740
26805 " mke2fs-J fstype blocksize device journal\n"
26811 #: ../fish/guestfish-actions.pod:2748
26812 msgid "See also L</mke2journal>."
26817 #: ../fish/guestfish-actions.pod:2750
26823 #: ../fish/guestfish-actions.pod:2752
26826 " mke2fs-JL fstype blocksize device label\n"
26832 #: ../fish/guestfish-actions.pod:2757
26833 msgid "See also L</mke2journal-L>."
26838 #: ../fish/guestfish-actions.pod:2759
26844 #: ../fish/guestfish-actions.pod:2761
26847 " mke2fs-JU fstype blocksize device uuid\n"
26853 #: ../fish/guestfish-actions.pod:2766
26854 msgid "See also L</mke2journal-U>."
26859 #: ../fish/guestfish-actions.pod:2768
26860 msgid "mke2journal"
26865 #: ../fish/guestfish-actions.pod:2770
26868 " mke2journal blocksize device\n"
26874 #: ../fish/guestfish-actions.pod:2777
26875 msgid "mke2journal-L"
26880 #: ../fish/guestfish-actions.pod:2779
26883 " mke2journal-L blocksize label device\n"
26889 #: ../fish/guestfish-actions.pod:2783
26890 msgid "mke2journal-U"
26895 #: ../fish/guestfish-actions.pod:2785
26898 " mke2journal-U blocksize uuid device\n"
26904 #: ../fish/guestfish-actions.pod:2789
26910 #: ../fish/guestfish-actions.pod:2791
26913 " mkfifo mode path\n"
26919 #: ../fish/guestfish-actions.pod:2793
26921 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26922 "is just a convenient wrapper around L</mknod>."
26927 #: ../fish/guestfish-actions.pod:2799
26933 #: ../fish/guestfish-actions.pod:2801
26936 " mkfs fstype device\n"
26942 #: ../fish/guestfish-actions.pod:2807
26948 #: ../fish/guestfish-actions.pod:2809
26951 " mkfs-b fstype blocksize device\n"
26957 #: ../fish/guestfish-actions.pod:2811
26959 "This call is similar to L</mkfs>, but it allows you to control the block "
26960 "size of the resulting filesystem. Supported block sizes depend on the "
26961 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26965 #: ../fish/guestfish-actions.pod:2819
26967 "This function is deprecated. In new code, use the L</mkfs_opts> call "
26973 #: ../fish/guestfish-actions.pod:2826
26979 #: ../fish/guestfish-actions.pod:2828
26982 " mkfs-opts fstype device [blocksize:..]\n"
26988 #: ../fish/guestfish-actions.pod:2852
26989 msgid "mkmountpoint"
26994 #: ../fish/guestfish-actions.pod:2854
26997 " mkmountpoint exemptpath\n"
27003 #: ../fish/guestfish-actions.pod:2856
27005 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
27006 "to create extra mountpoints before mounting the first filesystem."
27011 #: ../fish/guestfish-actions.pod:2880
27013 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
27014 "unexpected errors if you try to mix these calls. It is safest to manually "
27015 "unmount filesystems and remove mountpoints after use."
27020 #: ../fish/guestfish-actions.pod:2884
27022 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
27023 "for this to work for manual mountpoints, you must ensure that the innermost "
27024 "mountpoints have the longest pathnames, as in the example code above."
27029 #: ../fish/guestfish-actions.pod:2891
27031 "Autosync [see L</set-autosync>, this is set by default on handles] means "
27032 "that L</umount-all> is called when the handle is closed which can also "
27033 "trigger these issues."
27038 #: ../fish/guestfish-actions.pod:2895
27044 #: ../fish/guestfish-actions.pod:2897
27047 " mknod mode devmajor devminor path\n"
27053 #: ../fish/guestfish-actions.pod:2907
27055 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
27056 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
27057 "regular file). These constants are available in the standard Linux header "
27058 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
27059 "wrappers around this command which bitwise OR in the appropriate constant "
27065 #: ../fish/guestfish-actions.pod:2917
27071 #: ../fish/guestfish-actions.pod:2919
27074 " mknod-b mode devmajor devminor path\n"
27080 #: ../fish/guestfish-actions.pod:2921
27082 "This call creates a block device node called C<path> with mode C<mode> and "
27083 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27084 "wrapper around L</mknod>."
27089 #: ../fish/guestfish-actions.pod:2927
27095 #: ../fish/guestfish-actions.pod:2929
27098 " mknod-c mode devmajor devminor path\n"
27104 #: ../fish/guestfish-actions.pod:2931
27106 "This call creates a char device node called C<path> with mode C<mode> and "
27107 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
27108 "wrapper around L</mknod>."
27113 #: ../fish/guestfish-actions.pod:2937
27119 #: ../fish/guestfish-actions.pod:2939
27128 #: ../fish/guestfish-actions.pod:2943
27134 #: ../fish/guestfish-actions.pod:2945
27137 " mkswap-L label device\n"
27143 #: ../fish/guestfish-actions.pod:2953
27149 #: ../fish/guestfish-actions.pod:2955
27152 " mkswap-U uuid device\n"
27158 #: ../fish/guestfish-actions.pod:2959
27159 msgid "mkswap-file"
27164 #: ../fish/guestfish-actions.pod:2961
27167 " mkswap-file path\n"
27173 #: ../fish/guestfish-actions.pod:2965
27175 "This command just writes a swap file signature to an existing file. To "
27176 "create the file itself, use something like L</fallocate>."
27181 #: ../fish/guestfish-actions.pod:2968
27187 #: ../fish/guestfish-actions.pod:2970
27190 " modprobe modulename\n"
27196 #: ../fish/guestfish-actions.pod:2977
27202 #: ../fish/guestfish-actions.pod:2979
27205 " mount device mountpoint\n"
27211 #: ../fish/guestfish-actions.pod:2995
27213 "B<Important note:> When you use this call, the filesystem options C<sync> "
27214 "and C<noatime> are set implicitly. This was originally done because we "
27215 "thought it would improve reliability, but it turns out that I<-o sync> has a "
27216 "very large negative performance impact and negligible effect on "
27217 "reliability. Therefore we recommend that you avoid using L</mount> in any "
27218 "code that needs performance, and instead use L</mount-options> (use an empty "
27219 "string for the first parameter if you don't want any options)."
27224 #: ../fish/guestfish-actions.pod:3005
27230 #: ../fish/guestfish-actions.pod:3007
27233 " mount-loop file mountpoint\n"
27239 #: ../fish/guestfish-actions.pod:3013
27240 msgid "mount-options"
27245 #: ../fish/guestfish-actions.pod:3015
27248 " mount-options options device mountpoint\n"
27254 #: ../fish/guestfish-actions.pod:3017
27256 "This is the same as the L</mount> command, but it allows you to set the "
27257 "mount options as for the L<mount(8)> I<-o> flag."
27262 #: ../fish/guestfish-actions.pod:3025
27268 #: ../fish/guestfish-actions.pod:3027
27271 " mount-ro device mountpoint\n"
27277 #: ../fish/guestfish-actions.pod:3029
27279 "This is the same as the L</mount> command, but it mounts the filesystem with "
27280 "the read-only (I<-o ro>) flag."
27285 #: ../fish/guestfish-actions.pod:3032
27291 #: ../fish/guestfish-actions.pod:3034
27294 " mount-vfs options vfstype device mountpoint\n"
27300 #: ../fish/guestfish-actions.pod:3036
27302 "This is the same as the L</mount> command, but it allows you to set both the "
27303 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
27308 #: ../fish/guestfish-actions.pod:3040
27309 msgid "mountpoints"
27314 #: ../fish/guestfish-actions.pod:3042
27323 #: ../fish/guestfish-actions.pod:3044
27325 "This call is similar to L</mounts>. That call returns a list of devices. "
27326 "This one returns a hash table (map) of device name to directory where the "
27327 "device is mounted."
27332 #: ../fish/guestfish-actions.pod:3048
27338 #: ../fish/guestfish-actions.pod:3050
27347 #: ../fish/guestfish-actions.pod:3057
27348 msgid "See also: L</mountpoints>"
27353 #: ../fish/guestfish-actions.pod:3059
27359 #: ../fish/guestfish-actions.pod:3061
27368 #: ../fish/guestfish-actions.pod:3066
27369 msgid "ntfs-3g-probe"
27374 #: ../fish/guestfish-actions.pod:3068
27377 " ntfs-3g-probe true|false device\n"
27383 #: ../fish/guestfish-actions.pod:3082
27389 #: ../fish/guestfish-actions.pod:3084
27392 " ntfsresize device\n"
27398 #: ../fish/guestfish-actions.pod:3099
27399 msgid "ntfsresize-size"
27404 #: ../fish/guestfish-actions.pod:3101
27407 " ntfsresize-size device size\n"
27413 #: ../fish/guestfish-actions.pod:3103
27415 "This command is the same as L</ntfsresize> except that it allows you to "
27416 "specify the new size (in bytes) explicitly."
27421 #: ../fish/guestfish-actions.pod:3106
27427 #: ../fish/guestfish-actions.pod:3108
27430 " part-add device prlogex startsect endsect\n"
27436 #: ../fish/guestfish-actions.pod:3110
27438 "This command adds a partition to C<device>. If there is no partition table "
27439 "on the device, call L</part-init> first."
27444 #: ../fish/guestfish-actions.pod:3122
27446 "Creating a partition which covers the whole disk is not so easy. Use L</"
27447 "part-disk> to do that."
27452 #: ../fish/guestfish-actions.pod:3125
27458 #: ../fish/guestfish-actions.pod:3127
27461 " part-del device partnum\n"
27467 #: ../fish/guestfish-actions.pod:3135
27473 #: ../fish/guestfish-actions.pod:3137
27476 " part-disk device parttype\n"
27482 #: ../fish/guestfish-actions.pod:3139
27484 "This command is simply a combination of L</part-init> followed by L</part-"
27485 "add> to create a single primary partition covering the whole disk."
27490 #: ../fish/guestfish-actions.pod:3143
27492 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27493 "possible values are described in L</part-init>."
27498 #: ../fish/guestfish-actions.pod:3149
27499 msgid "part-get-bootable"
27504 #: ../fish/guestfish-actions.pod:3151
27507 " part-get-bootable device partnum\n"
27513 #: ../fish/guestfish-actions.pod:3156
27514 msgid "See also L</part-set-bootable>."
27519 #: ../fish/guestfish-actions.pod:3158
27520 msgid "part-get-mbr-id"
27525 #: ../fish/guestfish-actions.pod:3160
27528 " part-get-mbr-id device partnum\n"
27534 #: ../fish/guestfish-actions.pod:3165 ../fish/guestfish-actions.pod:3303
27536 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27537 "undefined results for other partition table types (see L</part-get-"
27543 #: ../fish/guestfish-actions.pod:3169
27544 msgid "part-get-parttype"
27549 #: ../fish/guestfish-actions.pod:3171
27552 " part-get-parttype device\n"
27558 #: ../fish/guestfish-actions.pod:3176
27560 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27561 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27562 "possible, although unusual. See L</part-init> for a full list."
27567 #: ../fish/guestfish-actions.pod:3181
27573 #: ../fish/guestfish-actions.pod:3183
27576 " part-init device parttype\n"
27582 #: ../fish/guestfish-actions.pod:3189
27584 "Initially there are no partitions. Following this, you should call L</part-"
27585 "add> for each partition required."
27590 #: ../fish/guestfish-actions.pod:3252
27596 #: ../fish/guestfish-actions.pod:3254
27599 " part-list device\n"
27605 #: ../fish/guestfish-actions.pod:3269
27607 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27608 "the device's sector size, see L</blockdev-getss>."
27613 #: ../fish/guestfish-actions.pod:3282
27614 msgid "part-set-bootable"
27619 #: ../fish/guestfish-actions.pod:3284
27622 " part-set-bootable device partnum true|false\n"
27628 #: ../fish/guestfish-actions.pod:3293
27629 msgid "part-set-mbr-id"
27634 #: ../fish/guestfish-actions.pod:3295
27637 " part-set-mbr-id device partnum idbyte\n"
27643 #: ../fish/guestfish-actions.pod:3307
27644 msgid "part-set-name"
27649 #: ../fish/guestfish-actions.pod:3309
27652 " part-set-name device partnum name\n"
27658 #: ../fish/guestfish-actions.pod:3317
27659 msgid "part-to-dev"
27664 #: ../fish/guestfish-actions.pod:3319
27667 " part-to-dev partition\n"
27673 #: ../fish/guestfish-actions.pod:3325
27675 "The named partition must exist, for example as a string returned from L</"
27676 "list-partitions>."
27681 #: ../fish/guestfish-actions.pod:3328
27682 msgid "ping-daemon"
27687 #: ../fish/guestfish-actions.pod:3330
27696 #: ../fish/guestfish-actions.pod:3337
27702 #: ../fish/guestfish-actions.pod:3339
27705 " pread path count offset\n"
27711 #: ../fish/guestfish-actions.pod:3347
27712 msgid "See also L</pwrite>, L</pread-device>."
27717 #: ../fish/guestfish-actions.pod:3352
27718 msgid "pread-device"
27723 #: ../fish/guestfish-actions.pod:3354
27726 " pread-device device count offset\n"
27732 #: ../fish/guestfish-actions.pod:3362
27733 msgid "See also L</pread>."
27738 #: ../fish/guestfish-actions.pod:3367
27744 #: ../fish/guestfish-actions.pod:3369
27747 " pvcreate device\n"
27753 #: ../fish/guestfish-actions.pod:3375
27759 #: ../fish/guestfish-actions.pod:3377
27762 " pvremove device\n"
27768 #: ../fish/guestfish-actions.pod:3386
27774 #: ../fish/guestfish-actions.pod:3388
27777 " pvresize device\n"
27783 #: ../fish/guestfish-actions.pod:3393
27784 msgid "pvresize-size"
27789 #: ../fish/guestfish-actions.pod:3395
27792 " pvresize-size device size\n"
27798 #: ../fish/guestfish-actions.pod:3397
27800 "This command is the same as L</pvresize> except that it allows you to "
27801 "specify the new size (in bytes) explicitly."
27806 #: ../fish/guestfish-actions.pod:3400
27812 #: ../fish/guestfish-actions.pod:3402
27821 #: ../fish/guestfish-actions.pod:3410
27822 msgid "See also L</pvs-full>."
27827 #: ../fish/guestfish-actions.pod:3412
27833 #: ../fish/guestfish-actions.pod:3414
27842 #: ../fish/guestfish-actions.pod:3419
27848 #: ../fish/guestfish-actions.pod:3421
27857 #: ../fish/guestfish-actions.pod:3425
27863 #: ../fish/guestfish-actions.pod:3427
27866 " pwrite path content offset\n"
27872 #: ../fish/guestfish-actions.pod:3438
27873 msgid "See also L</pread>, L</pwrite-device>."
27878 #: ../fish/guestfish-actions.pod:3443
27879 msgid "pwrite-device"
27884 #: ../fish/guestfish-actions.pod:3445
27887 " pwrite-device device content offset\n"
27893 #: ../fish/guestfish-actions.pod:3455
27894 msgid "See also L</pwrite>."
27899 #: ../fish/guestfish-actions.pod:3460
27905 #: ../fish/guestfish-actions.pod:3462
27908 " read-file path\n"
27914 #: ../fish/guestfish-actions.pod:3467
27916 "Unlike L</cat>, this function can correctly handle files that contain "
27917 "embedded ASCII NUL characters. However unlike L</download>, this function "
27918 "is limited in the total size of file that can be handled."
27923 #: ../fish/guestfish-actions.pod:3475
27929 #: ../fish/guestfish-actions.pod:3477
27932 " read-lines path\n"
27938 #: ../fish/guestfish-actions.pod:3484
27940 "Note that this function cannot correctly handle binary files (specifically, "
27941 "files containing C<\\0> character which is treated as end of line). For "
27942 "those you need to use the L</read-file> function which has a more complex "
27948 #: ../fish/guestfish-actions.pod:3489
27954 #: ../fish/guestfish-actions.pod:3491
27963 #: ../fish/guestfish-actions.pod:3543
27965 "This function is primarily intended for use by programs. To get a simple "
27966 "list of names, use L</ls>. To get a printable directory for human "
27967 "consumption, use L</ll>."
27972 #: ../fish/guestfish-actions.pod:3547
27978 #: ../fish/guestfish-actions.pod:3549
27987 #: ../fish/guestfish-actions.pod:3553
27988 msgid "readlinklist"
27993 #: ../fish/guestfish-actions.pod:3555
27996 " readlinklist path 'names ...'\n"
28002 #: ../fish/guestfish-actions.pod:3579
28008 #: ../fish/guestfish-actions.pod:3581
28017 #: ../fish/guestfish-actions.pod:3586
28018 msgid "removexattr"
28023 #: ../fish/guestfish-actions.pod:3588
28026 " removexattr xattr path\n"
28032 #: ../fish/guestfish-actions.pod:3593
28033 msgid "See also: L</lremovexattr>, L<attr(5)>."
28038 #: ../fish/guestfish-actions.pod:3595
28044 #: ../fish/guestfish-actions.pod:3597
28047 " resize2fs device\n"
28053 #: ../fish/guestfish-actions.pod:3602
28055 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
28056 "before calling this command. For unknown reasons C<resize2fs> sometimes "
28057 "gives an error about this and sometimes not. In any case, it is always safe "
28058 "to call L</e2fsck-f> before calling this function."
28063 #: ../fish/guestfish-actions.pod:3608
28064 msgid "resize2fs-size"
28069 #: ../fish/guestfish-actions.pod:3610
28072 " resize2fs-size device size\n"
28078 #: ../fish/guestfish-actions.pod:3612
28080 "This command is the same as L</resize2fs> except that it allows you to "
28081 "specify the new size (in bytes) explicitly."
28086 #: ../fish/guestfish-actions.pod:3615
28092 #: ../fish/guestfish-actions.pod:3617
28101 #: ../fish/guestfish-actions.pod:3621
28107 #: ../fish/guestfish-actions.pod:3623
28116 #: ../fish/guestfish-actions.pod:3629
28122 #: ../fish/guestfish-actions.pod:3631
28131 #: ../fish/guestfish-actions.pod:3635
28132 msgid "rmmountpoint"
28137 #: ../fish/guestfish-actions.pod:3637
28140 " rmmountpoint exemptpath\n"
28146 #: ../fish/guestfish-actions.pod:3639
28148 "This calls removes a mountpoint that was previously created with L</"
28149 "mkmountpoint>. See L</mkmountpoint> for full details."
28154 #: ../fish/guestfish-actions.pod:3643
28155 msgid "scrub-device"
28160 #: ../fish/guestfish-actions.pod:3645
28163 " scrub-device device\n"
28169 #: ../fish/guestfish-actions.pod:3656
28175 #: ../fish/guestfish-actions.pod:3658
28178 " scrub-file file\n"
28184 #: ../fish/guestfish-actions.pod:3668
28185 msgid "scrub-freespace"
28190 #: ../fish/guestfish-actions.pod:3670
28193 " scrub-freespace dir\n"
28199 #: ../fish/guestfish-actions.pod:3672
28201 "This command creates the directory C<dir> and then fills it with files until "
28202 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
28203 "deletes them. The intention is to scrub any free space on the partition "
28204 "containing C<dir>."
28209 #: ../fish/guestfish-actions.pod:3681
28215 #: ../fish/guestfish-actions.pod:3683
28221 #: ../fish/guestfish-actions.pod:3685
28224 " set-append append\n"
28230 #: ../fish/guestfish-actions.pod:3696
28231 msgid "set-autosync"
28236 #: ../fish/guestfish-actions.pod:3698
28242 #: ../fish/guestfish-actions.pod:3700
28245 " set-autosync true|false\n"
28251 #: ../fish/guestfish-actions.pod:3702
28253 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
28254 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
28255 "closed (also if the program exits without closing handles)."
28260 #: ../fish/guestfish-actions.pod:3710
28266 #: ../fish/guestfish-actions.pod:3712
28272 #: ../fish/guestfish-actions.pod:3714
28275 " set-direct true|false\n"
28281 #: ../fish/guestfish-actions.pod:3720
28283 "One consequence of this is that log messages aren't caught by the library "
28284 "and handled by L</set-log-message-callback>, but go straight to stdout."
28289 #: ../fish/guestfish-actions.pod:3729
28290 msgid "set-e2label"
28295 #: ../fish/guestfish-actions.pod:3731
28298 " set-e2label device label\n"
28304 #: ../fish/guestfish-actions.pod:3737
28306 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
28307 "label on a filesystem."
28312 #: ../fish/guestfish-actions.pod:3740
28318 #: ../fish/guestfish-actions.pod:3742
28321 " set-e2uuid device uuid\n"
28327 #: ../fish/guestfish-actions.pod:3749
28329 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
28330 "UUID of a filesystem."
28335 #: ../fish/guestfish-actions.pod:3752
28336 msgid "set-memsize"
28341 #: ../fish/guestfish-actions.pod:3754
28347 #: ../fish/guestfish-actions.pod:3756
28350 " set-memsize memsize\n"
28356 #: ../fish/guestfish-actions.pod:3758
28358 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28359 "This only has any effect if called before L</launch>."
28364 #: ../fish/guestfish-actions.pod:3769
28365 msgid "set-network"
28370 #: ../fish/guestfish-actions.pod:3771
28376 #: ../fish/guestfish-actions.pod:3773
28379 " set-network true|false\n"
28385 #: ../fish/guestfish-actions.pod:3781
28387 "You must call this before calling L</launch>, otherwise it has no effect."
28392 #: ../fish/guestfish-actions.pod:3784
28398 #: ../fish/guestfish-actions.pod:3786
28404 #: ../fish/guestfish-actions.pod:3788
28407 " set-path searchpath\n"
28413 #: ../fish/guestfish-actions.pod:3797
28419 #: ../fish/guestfish-actions.pod:3799
28425 #: ../fish/guestfish-actions.pod:3801
28434 #: ../fish/guestfish-actions.pod:3821
28435 msgid "set-recovery-proc"
28440 #: ../fish/guestfish-actions.pod:3823
28441 msgid "recovery-proc"
28446 #: ../fish/guestfish-actions.pod:3825
28449 " set-recovery-proc true|false\n"
28455 #: ../fish/guestfish-actions.pod:3827
28457 "If this is called with the parameter C<false> then L</launch> does not "
28458 "create a recovery process. The purpose of the recovery process is to stop "
28459 "runaway qemu processes in the case where the main program aborts abruptly."
28464 #: ../fish/guestfish-actions.pod:3832
28466 "This only has any effect if called before L</launch>, and the default is "
28472 #: ../fish/guestfish-actions.pod:3841
28473 msgid "set-selinux"
28478 #: ../fish/guestfish-actions.pod:3843
28484 #: ../fish/guestfish-actions.pod:3845
28487 " set-selinux true|false\n"
28493 #: ../fish/guestfish-actions.pod:3856
28499 #: ../fish/guestfish-actions.pod:3858
28505 #: ../fish/guestfish-actions.pod:3860
28508 " set-trace true|false\n"
28514 #: ../fish/guestfish-actions.pod:3876
28515 msgid "set-verbose"
28520 #: ../fish/guestfish-actions.pod:3878
28526 #: ../fish/guestfish-actions.pod:3880
28529 " set-verbose true|false\n"
28535 #: ../fish/guestfish-actions.pod:3887
28541 #: ../fish/guestfish-actions.pod:3889
28544 " setcon context\n"
28550 #: ../fish/guestfish-actions.pod:3896
28556 #: ../fish/guestfish-actions.pod:3898
28559 " setxattr xattr val vallen path\n"
28565 #: ../fish/guestfish-actions.pod:3904
28566 msgid "See also: L</lsetxattr>, L<attr(5)>."
28571 #: ../fish/guestfish-actions.pod:3906
28577 #: ../fish/guestfish-actions.pod:3908
28580 " sfdisk device cyls heads sectors 'lines ...'\n"
28586 #: ../fish/guestfish-actions.pod:3930
28587 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
28592 #: ../fish/guestfish-actions.pod:3936
28598 #: ../fish/guestfish-actions.pod:3938
28601 " sfdiskM device 'lines ...'\n"
28607 #: ../fish/guestfish-actions.pod:3940
28609 "This is a simplified interface to the L</sfdisk> command, where partition "
28610 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
28611 "you don't need to specify the cyls, heads and sectors parameters which were "
28612 "rarely if ever used anyway."
28617 #: ../fish/guestfish-actions.pod:3946
28618 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
28623 #: ../fish/guestfish-actions.pod:3952
28629 #: ../fish/guestfish-actions.pod:3954
28632 " sfdisk-N device partnum cyls heads sectors line\n"
28638 #: ../fish/guestfish-actions.pod:3959
28640 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
28641 "cyls/heads/sectors parameters."
28646 #: ../fish/guestfish-actions.pod:3962
28647 msgid "See also: L</part-add>"
28652 #: ../fish/guestfish-actions.pod:3967
28653 msgid "sfdisk-disk-geometry"
28658 #: ../fish/guestfish-actions.pod:3969
28661 " sfdisk-disk-geometry device\n"
28667 #: ../fish/guestfish-actions.pod:3971
28669 "This displays the disk geometry of C<device> read from the partition table. "
28670 "Especially in the case where the underlying block device has been resized, "
28671 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
28672 "kernel-geometry>)."
28677 #: ../fish/guestfish-actions.pod:3979
28678 msgid "sfdisk-kernel-geometry"
28683 #: ../fish/guestfish-actions.pod:3981
28686 " sfdisk-kernel-geometry device\n"
28692 #: ../fish/guestfish-actions.pod:3988
28698 #: ../fish/guestfish-actions.pod:3990
28701 " sfdisk-l device\n"
28707 #: ../fish/guestfish-actions.pod:3996
28708 msgid "See also: L</part-list>"
28713 #: ../fish/guestfish-actions.pod:3998
28719 #: ../fish/guestfish-actions.pod:4000
28728 #: ../fish/guestfish-actions.pod:4005
28729 msgid "This is like L</command>, but passes the command to:"
28734 #: ../fish/guestfish-actions.pod:4013
28735 msgid "All the provisos about L</command> apply to this call."
28740 #: ../fish/guestfish-actions.pod:4015
28746 #: ../fish/guestfish-actions.pod:4017
28749 " sh-lines command\n"
28755 #: ../fish/guestfish-actions.pod:4019
28756 msgid "This is the same as L</sh>, but splits the result into a list of lines."
28761 #: ../fish/guestfish-actions.pod:4022
28762 msgid "See also: L</command-lines>"
28767 #: ../fish/guestfish-actions.pod:4024
28773 #: ../fish/guestfish-actions.pod:4026
28782 #: ../fish/guestfish-actions.pod:4030
28788 #: ../fish/guestfish-actions.pod:4032
28797 #: ../fish/guestfish-actions.pod:4038
28803 #: ../fish/guestfish-actions.pod:4040
28812 #: ../fish/guestfish-actions.pod:4048
28818 #: ../fish/guestfish-actions.pod:4050
28827 #: ../fish/guestfish-actions.pod:4058
28833 #: ../fish/guestfish-actions.pod:4060
28836 " strings-e encoding path\n"
28842 #: ../fish/guestfish-actions.pod:4062
28844 "This is like the L</strings> command, but allows you to specify the encoding "
28845 "of strings that are looked for in the source file C<path>."
28850 #: ../fish/guestfish-actions.pod:4072
28852 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28853 "ISO-8859-X (this is what L</strings> uses)."
28858 #: ../fish/guestfish-actions.pod:4104
28859 msgid "swapoff-device"
28864 #: ../fish/guestfish-actions.pod:4106
28867 " swapoff-device device\n"
28873 #: ../fish/guestfish-actions.pod:4108
28875 "This command disables the libguestfs appliance swap device or partition "
28876 "named C<device>. See L</swapon-device>."
28881 #: ../fish/guestfish-actions.pod:4112
28882 msgid "swapoff-file"
28887 #: ../fish/guestfish-actions.pod:4114
28890 " swapoff-file file\n"
28896 #: ../fish/guestfish-actions.pod:4118
28897 msgid "swapoff-label"
28902 #: ../fish/guestfish-actions.pod:4120
28905 " swapoff-label label\n"
28911 #: ../fish/guestfish-actions.pod:4125
28912 msgid "swapoff-uuid"
28917 #: ../fish/guestfish-actions.pod:4127
28920 " swapoff-uuid uuid\n"
28926 #: ../fish/guestfish-actions.pod:4132
28927 msgid "swapon-device"
28932 #: ../fish/guestfish-actions.pod:4134
28935 " swapon-device device\n"
28941 #: ../fish/guestfish-actions.pod:4136
28943 "This command enables the libguestfs appliance to use the swap device or "
28944 "partition named C<device>. The increased memory is made available for all "
28945 "commands, for example those run using L</command> or L</sh>."
28950 #: ../fish/guestfish-actions.pod:4148
28951 msgid "swapon-file"
28956 #: ../fish/guestfish-actions.pod:4150
28959 " swapon-file file\n"
28965 #: ../fish/guestfish-actions.pod:4152
28967 "This command enables swap to a file. See L</swapon-device> for other notes."
28972 #: ../fish/guestfish-actions.pod:4155
28973 msgid "swapon-label"
28978 #: ../fish/guestfish-actions.pod:4157
28981 " swapon-label label\n"
28987 #: ../fish/guestfish-actions.pod:4159
28989 "This command enables swap to a labeled swap partition. See L</swapon-"
28990 "device> for other notes."
28995 #: ../fish/guestfish-actions.pod:4162
28996 msgid "swapon-uuid"
29001 #: ../fish/guestfish-actions.pod:4164
29004 " swapon-uuid uuid\n"
29010 #: ../fish/guestfish-actions.pod:4166
29012 "This command enables swap to a swap partition with the given UUID. See L</"
29013 "swapon-device> for other notes."
29018 #: ../fish/guestfish-actions.pod:4169
29024 #: ../fish/guestfish-actions.pod:4171
29033 #: ../fish/guestfish-actions.pod:4179
29039 #: ../fish/guestfish-actions.pod:4181
29048 #: ../fish/guestfish-actions.pod:4189
29054 #: ../fish/guestfish-actions.pod:4191
29057 " tail-n nrlines path\n"
29063 #: ../fish/guestfish-actions.pod:4204
29069 #: ../fish/guestfish-actions.pod:4206
29072 " tar-in (tarfile|-) directory\n"
29078 #: ../fish/guestfish-actions.pod:4211
29079 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
29084 #: ../fish/guestfish-actions.pod:4216
29090 #: ../fish/guestfish-actions.pod:4218
29093 " tar-out directory (tarfile|-)\n"
29099 #: ../fish/guestfish-actions.pod:4223
29100 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
29105 #: ../fish/guestfish-actions.pod:4228
29111 #: ../fish/guestfish-actions.pod:4230
29114 " tgz-in (tarball|-) directory\n"
29120 #: ../fish/guestfish-actions.pod:4235
29121 msgid "To upload an uncompressed tarball, use L</tar-in>."
29126 #: ../fish/guestfish-actions.pod:4239
29132 #: ../fish/guestfish-actions.pod:4241
29135 " tgz-out directory (tarball|-)\n"
29141 #: ../fish/guestfish-actions.pod:4246
29142 msgid "To download an uncompressed tarball, use L</tar-out>."
29147 #: ../fish/guestfish-actions.pod:4250
29153 #: ../fish/guestfish-actions.pod:4252
29162 #: ../fish/guestfish-actions.pod:4261
29168 #: ../fish/guestfish-actions.pod:4263
29177 #: ../fish/guestfish-actions.pod:4268
29178 msgid "truncate-size"
29183 #: ../fish/guestfish-actions.pod:4270
29186 " truncate-size path size\n"
29192 #: ../fish/guestfish-actions.pod:4275
29194 "If the current file size is less than C<size> then the file is extended to "
29195 "the required size with zero bytes. This creates a sparse file (ie. disk "
29196 "blocks are not allocated for the file until you write to it). To create a "
29197 "non-sparse file of zeroes, use L</fallocate64> instead."
29202 #: ../fish/guestfish-actions.pod:4281
29208 #: ../fish/guestfish-actions.pod:4283
29211 " tune2fs-l device\n"
29217 #: ../fish/guestfish-actions.pod:4293
29223 #: ../fish/guestfish-actions.pod:4295
29226 " txz-in (tarball|-) directory\n"
29232 #: ../fish/guestfish-actions.pod:4302
29238 #: ../fish/guestfish-actions.pod:4304
29241 " txz-out directory (tarball|-)\n"
29247 #: ../fish/guestfish-actions.pod:4311
29253 #: ../fish/guestfish-actions.pod:4313
29262 #: ../fish/guestfish-actions.pod:4327
29263 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
29268 #: ../fish/guestfish-actions.pod:4332
29274 #: ../fish/guestfish-actions.pod:4334
29280 #: ../fish/guestfish-actions.pod:4336
29283 " umount pathordevice\n"
29289 #: ../fish/guestfish-actions.pod:4342
29295 #: ../fish/guestfish-actions.pod:4344
29296 msgid "unmount-all"
29301 #: ../fish/guestfish-actions.pod:4346
29310 #: ../fish/guestfish-actions.pod:4352
29316 #: ../fish/guestfish-actions.pod:4354
29319 " upload (filename|-) remotefilename\n"
29325 #: ../fish/guestfish-actions.pod:4361
29326 msgid "See also L</download>."
29331 #: ../fish/guestfish-actions.pod:4365
29332 msgid "upload-offset"
29337 #: ../fish/guestfish-actions.pod:4367
29340 " upload-offset (filename|-) remotefilename offset\n"
29346 #: ../fish/guestfish-actions.pod:4379
29348 "Note that there is no limit on the amount of data that can be uploaded with "
29349 "this call, unlike with L</pwrite>, and this call always writes the full "
29350 "amount unless an error occurs."
29355 #: ../fish/guestfish-actions.pod:4384
29356 msgid "See also L</upload>, L</pwrite>."
29361 #: ../fish/guestfish-actions.pod:4388
29367 #: ../fish/guestfish-actions.pod:4390
29370 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
29376 #: ../fish/guestfish-actions.pod:4409
29382 #: ../fish/guestfish-actions.pod:4411
29391 #: ../fish/guestfish-actions.pod:4438
29393 "I<Note:> Don't use this call to test for availability of features. In "
29394 "enterprise distributions we backport features from later versions into "
29395 "earlier versions, making this an unreliable way to test for features. Use "
29396 "L</available> instead."
29401 #: ../fish/guestfish-actions.pod:4444
29407 #: ../fish/guestfish-actions.pod:4446
29410 " vfs-label device\n"
29416 #: ../fish/guestfish-actions.pod:4453
29417 msgid "To find a filesystem from the label, use L</findfs-label>."
29422 #: ../fish/guestfish-actions.pod:4455
29428 #: ../fish/guestfish-actions.pod:4457
29431 " vfs-type device\n"
29437 #: ../fish/guestfish-actions.pod:4467
29443 #: ../fish/guestfish-actions.pod:4469
29446 " vfs-uuid device\n"
29452 #: ../fish/guestfish-actions.pod:4476
29453 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
29458 #: ../fish/guestfish-actions.pod:4478
29459 msgid "vg-activate"
29464 #: ../fish/guestfish-actions.pod:4480
29467 " vg-activate true|false 'volgroups ...'\n"
29473 #: ../fish/guestfish-actions.pod:4493
29474 msgid "vg-activate-all"
29479 #: ../fish/guestfish-actions.pod:4495
29482 " vg-activate-all true|false\n"
29488 #: ../fish/guestfish-actions.pod:4505
29494 #: ../fish/guestfish-actions.pod:4507
29497 " vgcreate volgroup 'physvols ...'\n"
29503 #: ../fish/guestfish-actions.pod:4512
29509 #: ../fish/guestfish-actions.pod:4514
29512 " vglvuuids vgname\n"
29518 #: ../fish/guestfish-actions.pod:4519
29520 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
29521 "logical volumes and volume groups."
29526 #: ../fish/guestfish-actions.pod:4522
29527 msgid "See also L</vgpvuuids>."
29532 #: ../fish/guestfish-actions.pod:4524
29538 #: ../fish/guestfish-actions.pod:4526
29541 " vgpvuuids vgname\n"
29547 #: ../fish/guestfish-actions.pod:4531
29549 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
29550 "physical volumes and volume groups."
29555 #: ../fish/guestfish-actions.pod:4534
29556 msgid "See also L</vglvuuids>."
29561 #: ../fish/guestfish-actions.pod:4536
29567 #: ../fish/guestfish-actions.pod:4538
29570 " vgremove vgname\n"
29576 #: ../fish/guestfish-actions.pod:4545
29582 #: ../fish/guestfish-actions.pod:4547
29585 " vgrename volgroup newvolgroup\n"
29591 #: ../fish/guestfish-actions.pod:4551
29597 #: ../fish/guestfish-actions.pod:4553
29606 #: ../fish/guestfish-actions.pod:4561
29607 msgid "See also L</vgs-full>."
29612 #: ../fish/guestfish-actions.pod:4563
29618 #: ../fish/guestfish-actions.pod:4565
29627 #: ../fish/guestfish-actions.pod:4570
29633 #: ../fish/guestfish-actions.pod:4572
29642 #: ../fish/guestfish-actions.pod:4577
29648 #: ../fish/guestfish-actions.pod:4579
29657 #: ../fish/guestfish-actions.pod:4583
29663 #: ../fish/guestfish-actions.pod:4585
29672 #: ../fish/guestfish-actions.pod:4590
29678 #: ../fish/guestfish-actions.pod:4592
29687 #: ../fish/guestfish-actions.pod:4597
29693 #: ../fish/guestfish-actions.pod:4599
29702 #: ../fish/guestfish-actions.pod:4604
29708 #: ../fish/guestfish-actions.pod:4606
29711 " write path content\n"
29717 #: ../fish/guestfish-actions.pod:4614
29723 #: ../fish/guestfish-actions.pod:4616
29726 " write-file path content size\n"
29731 #: ../fish/guestfish-actions.pod:4632
29733 "This function is deprecated. In new code, use the L</write> call instead."
29738 #: ../fish/guestfish-actions.pod:4639
29744 #: ../fish/guestfish-actions.pod:4641
29747 " zegrep regex path\n"
29753 #: ../fish/guestfish-actions.pod:4649
29759 #: ../fish/guestfish-actions.pod:4651
29762 " zegrepi regex path\n"
29768 #: ../fish/guestfish-actions.pod:4659
29774 #: ../fish/guestfish-actions.pod:4661
29783 #: ../fish/guestfish-actions.pod:4669
29784 msgid "See also: L</zero-device>, L</scrub-device>."
29789 #: ../fish/guestfish-actions.pod:4671
29790 msgid "zero-device"
29795 #: ../fish/guestfish-actions.pod:4673
29798 " zero-device device\n"
29804 #: ../fish/guestfish-actions.pod:4675
29806 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
29807 "which just zeroes the first few blocks of a device."
29812 #: ../fish/guestfish-actions.pod:4682
29818 #: ../fish/guestfish-actions.pod:4684
29821 " zerofree device\n"
29827 #: ../fish/guestfish-actions.pod:4697
29833 #: ../fish/guestfish-actions.pod:4699
29836 " zfgrep pattern path\n"
29842 #: ../fish/guestfish-actions.pod:4707
29848 #: ../fish/guestfish-actions.pod:4709
29851 " zfgrepi pattern path\n"
29857 #: ../fish/guestfish-actions.pod:4717
29863 #: ../fish/guestfish-actions.pod:4719
29866 " zfile meth path\n"
29872 #: ../fish/guestfish-actions.pod:4726
29874 "Since 1.0.63, use L</file> instead which can now process compressed files."
29878 #: ../fish/guestfish-actions.pod:4729
29880 "This function is deprecated. In new code, use the L</file> call instead."
29885 #: ../fish/guestfish-actions.pod:4736
29891 #: ../fish/guestfish-actions.pod:4738
29894 " zgrep regex path\n"
29900 #: ../fish/guestfish-actions.pod:4746
29906 #: ../fish/guestfish-actions.pod:4748
29909 " zgrepi regex path\n"
29915 #: ../fish/guestfish-commands.pod:1
29921 #: ../fish/guestfish-commands.pod:3
29927 #: ../fish/guestfish-commands.pod:5
29930 " alloc filename size\n"
29936 #: ../fish/guestfish-commands.pod:7
29938 "This creates an empty (zeroed) file of the given size, and then adds so it "
29939 "can be further examined."
29944 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
29945 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29950 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
29951 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29956 #: ../fish/guestfish-commands.pod:14
29958 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29959 "image, see L</PREPARED DISK IMAGES>."
29964 #: ../fish/guestfish-commands.pod:17
29970 #: ../fish/guestfish-commands.pod:19
29973 " copy-in local [local ...] /remotedir\n"
29979 #: ../fish/guestfish-commands.pod:21
29981 "C<copy-in> copies local files or directories recursively into the disk "
29982 "image, placing them in the directory called C</remotedir> (which must "
29983 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
29984 "other commands as necessary."
29989 #: ../fish/guestfish-commands.pod:26
29991 "Multiple local files and directories can be specified, but the last "
29992 "parameter must always be a remote directory. Wildcards cannot be used."
29997 #: ../fish/guestfish-commands.pod:30
30003 #: ../fish/guestfish-commands.pod:32
30006 " copy-out remote [remote ...] localdir\n"
30012 #: ../fish/guestfish-commands.pod:34
30014 "C<copy-out> copies remote files or directories recursively out of the disk "
30015 "image, placing them on the host disk in a local directory called C<localdir> "
30016 "(which must exist). This guestfish meta-command turns into a sequence of L</"
30017 "download>, L</tar-out> and other commands as necessary."
30022 #: ../fish/guestfish-commands.pod:40
30024 "Multiple remote files and directories can be specified, but the last "
30025 "parameter must always be a local directory. To download to the current "
30026 "directory, use C<.> as in:"
30031 #: ../fish/guestfish-commands.pod:44
30034 " copy-out /home .\n"
30040 #: ../fish/guestfish-commands.pod:46
30042 "Wildcards cannot be used in the ordinary command, but you can use them with "
30043 "the help of L</glob> like this:"
30048 #: ../fish/guestfish-commands.pod:49
30051 " glob copy-out /home/* .\n"
30057 #: ../fish/guestfish-commands.pod:51
30063 #: ../fish/guestfish-commands.pod:53
30066 " echo [params ...]\n"
30072 #: ../fish/guestfish-commands.pod:55
30073 msgid "This echos the parameters to the terminal."
30078 #: ../fish/guestfish-commands.pod:57
30084 #: ../fish/guestfish-commands.pod:59
30090 #: ../fish/guestfish-commands.pod:61
30096 #: ../fish/guestfish-commands.pod:63
30105 #: ../fish/guestfish-commands.pod:65
30107 "This is used to edit a file. It downloads the file, edits it locally using "
30108 "your editor, then uploads the result."
30113 #: ../fish/guestfish-commands.pod:68
30115 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
30116 "or C<emacs> you will get those corresponding editors."
30121 #: ../fish/guestfish-commands.pod:72
30127 #: ../fish/guestfish-commands.pod:74
30130 " glob command args...\n"
30136 #: ../fish/guestfish-commands.pod:76
30138 "Expand wildcards in any paths in the args list, and run C<command> "
30139 "repeatedly on each matching path."
30144 #: ../fish/guestfish-commands.pod:79
30145 msgid "See L</WILDCARDS AND GLOBBING>."
30150 #: ../fish/guestfish-commands.pod:81
30156 #: ../fish/guestfish-commands.pod:83
30159 " hexedit <filename|device>\n"
30160 " hexedit <filename|device> <max>\n"
30161 " hexedit <filename|device> <start> <max>\n"
30167 #: ../fish/guestfish-commands.pod:87
30169 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
30175 #: ../fish/guestfish-commands.pod:90
30177 "This command works by downloading potentially the whole file or device, "
30178 "editing it locally, then uploading it. If the file or device is large, you "
30179 "have to specify which part you wish to edit by using C<max> and/or C<start> "
30180 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
30181 "usual modifiers allowed such as C<1M> (1 megabyte)."
30186 #: ../fish/guestfish-commands.pod:97
30187 msgid "For example to edit the first few sectors of a disk you might do:"
30192 #: ../fish/guestfish-commands.pod:100
30195 " hexedit /dev/sda 1M\n"
30201 #: ../fish/guestfish-commands.pod:102
30203 "which would allow you to edit anywhere within the first megabyte of the disk."
30208 #: ../fish/guestfish-commands.pod:105
30209 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
30214 #: ../fish/guestfish-commands.pod:107
30217 " hexedit /dev/sda1 0x400 0x400\n"
30223 #: ../fish/guestfish-commands.pod:109
30224 msgid "(assuming the superblock is in the standard location)."
30229 #: ../fish/guestfish-commands.pod:111
30231 "This command requires the external L<hexedit(1)> program. You can specify "
30232 "another program to use by setting the C<HEXEDITOR> environment variable."
30237 #: ../fish/guestfish-commands.pod:115
30238 msgid "See also L</hexdump>."
30243 #: ../fish/guestfish-commands.pod:117
30249 #: ../fish/guestfish-commands.pod:119
30258 #: ../fish/guestfish-commands.pod:121
30260 "Change the local directory, ie. the current directory of guestfish itself."
30265 #: ../fish/guestfish-commands.pod:124
30266 msgid "Note that C<!cd> won't do what you might expect."
30271 #: ../fish/guestfish-commands.pod:126
30277 #: ../fish/guestfish-commands.pod:128
30283 #: ../fish/guestfish-commands.pod:130
30292 #: ../fish/guestfish-commands.pod:132
30293 msgid "Opens the manual page for guestfish."
30298 #: ../fish/guestfish-commands.pod:134
30304 #: ../fish/guestfish-commands.pod:136
30310 #: ../fish/guestfish-commands.pod:138
30319 #: ../fish/guestfish-commands.pod:140
30328 #: ../fish/guestfish-commands.pod:142
30329 msgid "This is used to view a file."
30334 #: ../fish/guestfish-commands.pod:144
30336 "The default viewer is C<$PAGER>. However if you use the alternate command "
30337 "C<less> you will get the C<less> command specifically."
30342 #: ../fish/guestfish-commands.pod:147
30348 #: ../fish/guestfish-commands.pod:149
30357 #: ../fish/guestfish-commands.pod:151
30359 "Close and reopen the libguestfs handle. It is not necessary to use this "
30360 "normally, because the handle is closed properly when guestfish exits. "
30361 "However this is occasionally useful for testing."
30366 #: ../fish/guestfish-commands.pod:155
30372 #: ../fish/guestfish-commands.pod:157
30375 " sparse filename size\n"
30381 #: ../fish/guestfish-commands.pod:159
30383 "This creates an empty sparse file of the given size, and then adds so it can "
30384 "be further examined."
30389 #: ../fish/guestfish-commands.pod:162
30391 "In all respects it works the same as the L</alloc> command, except that the "
30392 "image file is allocated sparsely, which means that disk blocks are not "
30393 "assigned to the file until they are needed. Sparse disk files only use "
30394 "space when written to, but they are slower and there is a danger you could "
30395 "run out of real disk space during a write operation."
30400 #: ../fish/guestfish-commands.pod:172
30406 #: ../fish/guestfish-commands.pod:174
30415 #: ../fish/guestfish-commands.pod:176
30417 "This command returns a list of the optional groups known to the daemon, and "
30418 "indicates which ones are supported by this build of the libguestfs appliance."
30423 #: ../fish/guestfish-commands.pod:180
30424 msgid "See also L<guestfs(3)/AVAILABILITY>."
30429 #: ../fish/guestfish-commands.pod:182
30435 #: ../fish/guestfish-commands.pod:184
30438 " time command args...\n"
30444 #: ../fish/guestfish-commands.pod:186
30446 "Run the command as usual, but print the elapsed time afterwards. This can "
30447 "be useful for benchmarking operations."
30452 #: ../test-tool/libguestfs-test-tool.pod:5
30453 msgid "libguestfs-test-tool - End user tests for libguestfs"
30458 #: ../test-tool/libguestfs-test-tool.pod:9
30461 " libguestfs-test-tool [--options]\n"
30467 #: ../test-tool/libguestfs-test-tool.pod:13
30469 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
30470 "and developers, to allow them to check basic libguestfs functionality is "
30471 "working. This is needed because libguestfs occasionally breaks for reasons "
30472 "beyond our control: usually because of changes in the underlying qemu or "
30473 "kernel packages, or the host environment."
30478 #: ../test-tool/libguestfs-test-tool.pod:20
30479 msgid "If you suspect a problem in libguestfs, then just run:"
30484 #: ../test-tool/libguestfs-test-tool.pod:22
30487 " libguestfs-test-tool\n"
30493 #: ../test-tool/libguestfs-test-tool.pod:24
30494 msgid "It will print lots of diagnostic messages."
30499 #: ../test-tool/libguestfs-test-tool.pod:26
30500 msgid "If it runs to completion successfully, you will see this near the end:"
30505 #: ../test-tool/libguestfs-test-tool.pod:28
30508 " ===== TEST FINISHED OK =====\n"
30514 #: ../test-tool/libguestfs-test-tool.pod:30
30515 msgid "and the test tool will exit with code 0."
30520 #: ../test-tool/libguestfs-test-tool.pod:32
30522 "If it fails (and/or exits with non-zero error code), please paste the "
30523 "B<complete, unedited> output of the test tool into a bug report. More "
30524 "information about reporting bugs can be found on the L<http://libguestfs.org/"
30530 #: ../test-tool/libguestfs-test-tool.pod:41
30536 #: ../test-tool/libguestfs-test-tool.pod:43
30537 msgid "Display short usage information and exit."
30542 #: ../test-tool/libguestfs-test-tool.pod:45
30543 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
30548 #: ../test-tool/libguestfs-test-tool.pod:47
30550 "Pass an alternate name for the helper program. libguestfs-test-tool will "
30551 "normally look in the C<$libexec> directory that was configured when the tool "
30557 #: ../test-tool/libguestfs-test-tool.pod:51
30558 msgid "I<--qemu qemu_binary>"
30563 #: ../test-tool/libguestfs-test-tool.pod:53
30565 "If you have downloaded another qemu binary, point this option at the full "
30566 "path of the binary to try it."
30571 #: ../test-tool/libguestfs-test-tool.pod:56
30572 msgid "I<--qemudir qemu_source_dir>"
30577 #: ../test-tool/libguestfs-test-tool.pod:58
30579 "If you have compiled qemu from source, point this option at the source "
30580 "directory to try it."
30585 #: ../test-tool/libguestfs-test-tool.pod:61
30586 msgid "I<--timeout N>"
30591 #: ../test-tool/libguestfs-test-tool.pod:63
30593 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
30594 "does not usually need to be adjusted unless your machine is very slow."
30599 #: ../test-tool/libguestfs-test-tool.pod:69
30600 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
30605 #: ../test-tool/libguestfs-test-tool.pod:71
30607 "If you have compiled another version of qemu from source and would like to "
30608 "try that, then you can use the I<--qemudir> option to point to the qemu "
30609 "source directory."
30614 #: ../test-tool/libguestfs-test-tool.pod:75
30616 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
30617 "option to point to the binary."
30622 #: ../test-tool/libguestfs-test-tool.pod:78
30624 "When using an alternate qemu with libguestfs, usually you would need to "
30625 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
30626 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
30627 "use either of the I<--qemudir> or I<--qemu> options."
30632 #: ../test-tool/libguestfs-test-tool.pod:85
30634 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
30635 "I<1> if there was an error."
30640 #: ../test-tool/libguestfs-test-tool.pod:92
30641 msgid "/usr/libexec/libguestfs-test-tool-helper"
30646 #: ../test-tool/libguestfs-test-tool.pod:94
30648 "This helper program is run inside the appliance and provides additional "
30654 #: ../test-tool/libguestfs-test-tool.pod:97
30655 msgid "/usr/bin/mkisofs"
30660 #: ../test-tool/libguestfs-test-tool.pod:99
30662 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
30663 "which is used as part of the tests."
30668 #: ../test-tool/libguestfs-test-tool.pod:106
30670 "For the full list of environment variables which may affect libguestfs, "
30671 "please see the L<guestfs(3)> manual page."
30676 #: ../test-tool/libguestfs-test-tool.pod:111
30677 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
30682 #: ../test-tool/libguestfs-test-tool.pod:121
30683 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
30688 #: ../fuse/guestmount.pod:5
30690 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
30695 #: ../fuse/guestmount.pod:9
30698 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
30704 #: ../fuse/guestmount.pod:11
30707 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
30713 #: ../fuse/guestmount.pod:13
30716 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
30722 #: ../fuse/guestmount.pod:17
30724 "You must I<not> use C<guestmount> in read-write mode on live virtual "
30725 "machines. If you do this, you risk disk corruption in the VM."
30730 #: ../fuse/guestmount.pod:22
30732 "The guestmount program can be used to mount virtual machine filesystems and "
30733 "other disk images on the host. It uses libguestfs for access to the guest "
30734 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
30735 "a mountable device."
30740 #: ../fuse/guestmount.pod:27
30742 "Along with other options, you have to give at least one device (I<-a> "
30743 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
30744 "option) or use the I<-i> inspection option. How this works is better "
30745 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
30751 #: ../fuse/guestmount.pod:33
30753 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
30754 "by you, and the filesystem will not be visible to any other users unless you "
30755 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
30756 "the filesystem, use the C<fusermount -u> command."
30761 #: ../fuse/guestmount.pod:41
30763 "For a typical Windows guest which has its main filesystem on the first "
30769 #: ../fuse/guestmount.pod:44
30772 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
30778 #: ../fuse/guestmount.pod:46
30780 "For a typical Linux guest which has a /boot filesystem on the first "
30781 "partition, and the root filesystem on a logical volume:"
30786 #: ../fuse/guestmount.pod:49
30789 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
30795 #: ../fuse/guestmount.pod:51
30796 msgid "To get libguestfs to detect guest mountpoints for you:"
30801 #: ../fuse/guestmount.pod:53
30804 " guestmount -a guest.img -i --ro /mnt\n"
30810 #: ../fuse/guestmount.pod:55
30811 msgid "For a libvirt guest called \"Guest\" you could do:"
30816 #: ../fuse/guestmount.pod:57
30819 " guestmount -d Guest -i --ro /mnt\n"
30825 #: ../fuse/guestmount.pod:59
30827 "If you don't know what filesystems are contained in a guest or disk image, "
30828 "use L<virt-filesystems(1)> first:"
30833 #: ../fuse/guestmount.pod:62
30836 " virt-filesystems MyGuest\n"
30842 #: ../fuse/guestmount.pod:64
30844 "If you want to trace the libguestfs calls but without excessive debugging "
30845 "information, we recommend:"
30850 #: ../fuse/guestmount.pod:67
30853 " guestmount [...] --trace /mnt\n"
30859 #: ../fuse/guestmount.pod:69
30860 msgid "If you want to debug the program, we recommend:"
30865 #: ../fuse/guestmount.pod:71
30868 " guestmount [...] --trace --verbose /mnt\n"
30874 #: ../fuse/guestmount.pod:77
30875 msgid "B<-a image> | B<--add image>"
30880 #: ../fuse/guestmount.pod:79
30881 msgid "Add a block device or virtual machine image."
30886 #: ../fuse/guestmount.pod:84
30887 msgid "B<-c URI> | B<--connect URI>"
30892 #: ../fuse/guestmount.pod:90
30893 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
30898 #: ../fuse/guestmount.pod:96
30899 msgid "B<--dir-cache-timeout N>"
30904 #: ../fuse/guestmount.pod:98
30906 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
30907 "seconds. The readdir cache [actually, there are several semi-independent "
30908 "caches] is populated after a readdir(2) call with the stat and extended "
30909 "attributes of the files in the directory, in anticipation that they will be "
30910 "requested soon after."
30915 #: ../fuse/guestmount.pod:104
30917 "There is also a different attribute cache implemented by FUSE (see the FUSE "
30918 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
30919 "requests, only cache existing ones."
30924 #: ../fuse/guestmount.pod:115
30925 msgid "B<--format=raw|qcow2|..> | B<--format>"
30930 #: ../fuse/guestmount.pod:122
30932 "If you have untrusted raw-format guest disk images, you should use this "
30933 "option to specify the disk format. This avoids a possible security problem "
30934 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
30935 "guestfs_add_drive_opts>."
30940 #: ../fuse/guestmount.pod:127
30941 msgid "B<--fuse-help>"
30946 #: ../fuse/guestmount.pod:129
30947 msgid "Display help on special FUSE options (see I<-o> below)."
30952 #: ../fuse/guestmount.pod:133
30953 msgid "Display brief help and exit."
30958 #: ../fuse/guestmount.pod:135
30959 msgid "B<-i> | B<--inspector>"
30964 #: ../fuse/guestmount.pod:146
30965 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
30970 #: ../fuse/guestmount.pod:148
30972 "Mount the named partition or logical volume on the given mountpoint B<in the "
30973 "guest> (this has nothing to do with mountpoints in the host)."
30978 #: ../fuse/guestmount.pod:151
30980 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30981 "something on C</>."
30986 #: ../fuse/guestmount.pod:154
30987 msgid "B<-n> | B<--no-sync>"
30992 #: ../fuse/guestmount.pod:156
30994 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30995 "unmounted. If you specify this option, then we don't attempt to sync the "
30996 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
31001 #: ../fuse/guestmount.pod:161
31002 msgid "B<-o option> | B<--option option>"
31007 #: ../fuse/guestmount.pod:163
31008 msgid "Pass extra options to FUSE."
31013 #: ../fuse/guestmount.pod:165
31015 "To get a list of all the extra options supported by FUSE, use the command "
31016 "below. Note that only the FUSE I<-o> options can be passed, and only some "
31017 "of them are a good idea."
31022 #: ../fuse/guestmount.pod:169
31025 " guestmount --fuse-help\n"
31031 #: ../fuse/guestmount.pod:171
31032 msgid "Some potentially useful FUSE options:"
31037 #: ../fuse/guestmount.pod:175
31038 msgid "B<-o allow_other>"
31043 #: ../fuse/guestmount.pod:177
31044 msgid "Allow other users to see the filesystem."
31049 #: ../fuse/guestmount.pod:179
31050 msgid "B<-o attr_timeout=N>"
31055 #: ../fuse/guestmount.pod:181
31056 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
31061 #: ../fuse/guestmount.pod:183
31062 msgid "B<-o kernel_cache>"
31067 #: ../fuse/guestmount.pod:185
31069 "Allow the kernel to cache files (reduces the number of reads that have to go "
31070 "through the L<guestfs(3)> API). This is generally a good idea if you can "
31071 "afford the extra memory usage."
31076 #: ../fuse/guestmount.pod:189
31077 msgid "B<-o uid=N> B<-o gid=N>"
31082 #: ../fuse/guestmount.pod:191
31084 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
31085 "the chosen values."
31090 #: ../fuse/guestmount.pod:196
31091 msgid "B<-r> | B<--ro>"
31096 #: ../fuse/guestmount.pod:198
31098 "Add devices and mount everything read-only. Also disallow writes and make "
31099 "the disk appear read-only to FUSE."
31104 #: ../fuse/guestmount.pod:201
31106 "This is highly recommended if you are not going to edit the guest disk. If "
31107 "the guest is running and this option is I<not> supplied, then there is a "
31108 "strong risk of disk corruption in the guest. We try to prevent this from "
31109 "happening, but it is not always possible."
31114 #: ../fuse/guestmount.pod:206
31115 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
31120 #: ../fuse/guestmount.pod:210
31121 msgid "Enable SELinux support for the guest."
31126 #: ../fuse/guestmount.pod:212
31127 msgid "B<-v> | B<--verbose>"
31132 #: ../fuse/guestmount.pod:214
31133 msgid "Enable verbose messages from underlying libguestfs."
31138 #: ../fuse/guestmount.pod:216
31139 msgid "B<-V> | B<--version>"
31144 #: ../fuse/guestmount.pod:218
31145 msgid "Display the program version and exit."
31150 #: ../fuse/guestmount.pod:220
31151 msgid "B<-w> | B<--rw>"
31156 #: ../fuse/guestmount.pod:222
31158 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
31159 "FOR READ AND WRITE>."
31164 #: ../fuse/guestmount.pod:225
31165 msgid "B<-x> | B<--trace>"
31170 #: ../fuse/guestmount.pod:227
31171 msgid "Trace libguestfs calls and entry into each FUSE function."
31176 #: ../fuse/guestmount.pod:229
31177 msgid "This also stops the daemon from forking into the background."
31182 #: ../fuse/guestmount.pod:235
31184 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
31185 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
31190 #: ../tools/virt-edit.pl:34
31191 msgid "virt-edit - Edit a file in a virtual machine"
31195 #: ../tools/virt-edit.pl:38
31198 " virt-edit [--options] domname file\n"
31203 #: ../tools/virt-edit.pl:40
31206 " virt-edit [--options] disk.img [disk.img ...] file\n"
31211 #: ../tools/virt-edit.pl:42
31214 " virt-edit [domname|disk.img] file -e 'expr'\n"
31219 #: ../tools/virt-edit.pl:46
31221 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
31222 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
31223 "doing this, but doesn't catch all cases."
31227 #: ../tools/virt-edit.pl:52
31229 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
31230 "the named virtual machine (or disk image)."
31234 #: ../tools/virt-edit.pl:55
31235 msgid "If you want to just view a file, use L<virt-cat(1)>."
31239 #: ../tools/virt-edit.pl:57
31241 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
31242 "USING GUESTFISH> below)."
31246 #: ../tools/virt-edit.pl:60
31248 "C<virt-edit> cannot be used to create a new file, nor to edit multiple "
31249 "files. L<guestfish(1)> can do that and much more."
31253 #: ../tools/virt-edit.pl:65
31254 msgid "Edit the named files interactively:"
31258 #: ../tools/virt-edit.pl:67
31261 " virt-edit mydomain /boot/grub/grub.conf\n"
31266 #: ../tools/virt-edit.pl:69
31269 " virt-edit mydomain /etc/passwd\n"
31274 #: ../tools/virt-edit.pl:71
31276 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
31277 "below). To change the init default level to 5:"
31281 #: ../tools/virt-edit.pl:75
31284 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
31289 #: ../tools/virt-edit.pl:87 ../tools/virt-win-reg.pl:106
31290 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
31291 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
31292 msgid "Display brief help."
31296 #: ../tools/virt-edit.pl:95 ../tools/virt-win-reg.pl:114
31297 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
31298 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
31299 #: ../tools/virt-list-partitions.pl:72
31300 msgid "Display version number and exit."
31304 #: ../tools/virt-edit.pl:101
31305 msgid "B<--backup extension> | B<-b extension>"
31309 #: ../tools/virt-edit.pl:103
31311 "Create a backup of the original file I<in the guest disk image>. The backup "
31312 "has the original filename with C<extension> added."
31316 #: ../tools/virt-edit.pl:106
31318 "Usually the first character of C<extension> would be a dot C<.> so you would "
31323 #: ../tools/virt-edit.pl:109
31326 " virt-edit -b .orig [etc]\n"
31331 #: ../tools/virt-edit.pl:111
31332 msgid "By default, no backup file is made."
31336 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:128
31337 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
31338 #: ../tools/virt-list-partitions.pl:78
31339 msgid "B<--connect URI> | B<-c URI>"
31343 #: ../tools/virt-edit.pl:119 ../tools/virt-win-reg.pl:130
31344 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
31345 #: ../tools/virt-list-partitions.pl:80
31347 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
31348 "to the default libvirt hypervisor."
31352 #: ../tools/virt-edit.pl:122 ../tools/virt-win-reg.pl:133
31353 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
31354 #: ../tools/virt-list-partitions.pl:83
31356 "If you specify guest block devices directly, then libvirt is not used at all."
31360 #: ../tools/virt-edit.pl:129 ../tools/virt-win-reg.pl:140
31361 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
31362 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
31363 msgid "B<--format> raw"
31367 #: ../tools/virt-edit.pl:131 ../tools/virt-win-reg.pl:142
31368 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
31369 #: ../tools/virt-list-partitions.pl:92
31371 "Specify the format of disk images given on the command line. If this is "
31372 "omitted then the format is autodetected from the content of the disk image."
31376 #: ../tools/virt-edit.pl:135 ../tools/virt-win-reg.pl:146
31377 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
31378 #: ../tools/virt-list-partitions.pl:96
31380 "If disk images are requested from libvirt, then this program asks libvirt "
31381 "for this information. In this case, the value of the format parameter is "
31386 #: ../tools/virt-edit.pl:139 ../tools/virt-win-reg.pl:150
31387 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
31388 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
31389 #: ../tools/virt-list-partitions.pl:100
31391 "If working with untrusted raw-format guest disk images, you should ensure "
31392 "the format is always specified."
31396 #: ../tools/virt-edit.pl:146
31397 msgid "B<--expr EXPR> | B<-e EXPR>"
31401 #: ../tools/virt-edit.pl:148
31403 "Instead of launching the external editor, non-interactively apply the Perl "
31404 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
31409 #: ../tools/virt-edit.pl:152
31411 "Be careful to properly quote the expression to prevent it from being altered "
31416 #: ../tools/virt-edit.pl:272
31417 msgid "NON-INTERACTIVE EDITING"
31421 #: ../tools/virt-edit.pl:274
31423 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
31424 "administrator can interactively edit the file."
31428 #: ../tools/virt-edit.pl:277
31430 "There are two ways also to use C<virt-edit> from scripts in order to make "
31431 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
31432 "like this, it's less error-prone to write scripts directly using the "
31433 "libguestfs API and Augeas for configuration file editing.)"
31437 #: ../tools/virt-edit.pl:283
31439 "The first method is to temporarily set C<$EDITOR> to any script or program "
31440 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
31441 "update C<tmpfile> in place however it likes."
31445 #: ../tools/virt-edit.pl:287
31447 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
31448 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
31449 "instances of C<foo> with C<bar> in a file:"
31453 #: ../tools/virt-edit.pl:291
31456 " virt-edit domname filename -e 's/foo/bar/'\n"
31461 #: ../tools/virt-edit.pl:293
31463 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
31464 "For example to delete root's password you could do:"
31468 #: ../tools/virt-edit.pl:296
31471 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
31476 #: ../tools/virt-edit.pl:298
31478 "What really happens is that the snippet is evaluated as a Perl expression "
31479 "for each line of the file. The line, including the final C<\\n>, is passed "
31480 "in C<$_> and the expression should update C<$_> or leave it unchanged."
31484 #: ../tools/virt-edit.pl:303
31486 "To delete a line, set C<$_> to the empty string. For example, to delete the "
31487 "C<apache> user account from the password file you can do:"
31491 #: ../tools/virt-edit.pl:306
31494 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
31499 #: ../tools/virt-edit.pl:308
31501 "To insert a line, prepend or append it to C<$_>. However appending lines to "
31502 "the end of the file is rather difficult this way since there is no concept "
31503 "of \"last line of the file\" - your expression just doesn't get called "
31504 "again. You might want to use the first method (setting C<$EDITOR>) if you "
31509 #: ../tools/virt-edit.pl:314
31511 "The variable C<$lineno> contains the current line number. As is "
31512 "traditional, the first line in the file is number C<1>."
31516 #: ../tools/virt-edit.pl:317
31518 "The return value from the expression is ignored, but the expression may call "
31519 "C<die> in order to abort the whole program, leaving the original file "
31524 #: ../tools/virt-edit.pl:321
31526 "Remember when matching the end of a line that C<$_> may contain the final C<"
31527 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
31528 "newline then neither of these. Thus to match or substitute some text at the "
31529 "end of a line, use this regular expression:"
31533 #: ../tools/virt-edit.pl:326
31536 " /some text(\\r?\\n)?$/\n"
31541 #: ../tools/virt-edit.pl:328
31543 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
31544 "$_> itself (since that would remove all newlines from the file):"
31548 #: ../tools/virt-edit.pl:332
31551 " my $m = $_; chomp $m; $m =~ /some text$/\n"
31556 #: ../tools/virt-edit.pl:334
31557 msgid "USING GUESTFISH"
31561 #: ../tools/virt-edit.pl:336
31563 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
31564 "C<virt-edit> doesn't work."
31568 #: ../tools/virt-edit.pl:339
31569 msgid "Using C<virt-edit> is approximately equivalent to doing:"
31573 #: ../tools/virt-edit.pl:341
31576 " guestfish --rw -i -d domname edit /file\n"
31581 #: ../tools/virt-edit.pl:343
31583 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
31584 "path to the file."
31588 #: ../tools/virt-edit.pl:346
31590 "The command above uses libguestfs's guest inspection feature and so does not "
31591 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
31592 "disk images that don't contain guests. To edit a file on a disk image "
31597 #: ../tools/virt-edit.pl:351
31600 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
31605 #: ../tools/virt-edit.pl:353
31607 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
31608 "the disk image to edit, and C</file> is the full path to the file."
31612 #: ../tools/virt-edit.pl:357
31614 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
31615 "C<write> or C<upload> instead:"
31619 #: ../tools/virt-edit.pl:360
31622 " guestfish --rw -i -d domname touch /newfile\n"
31627 #: ../tools/virt-edit.pl:362
31630 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
31635 #: ../tools/virt-edit.pl:364
31638 " guestfish --rw -i -d domname upload localfile /newfile\n"
31643 #: ../tools/virt-edit.pl:366
31645 "C<virt-edit> cannot edit multiple files, but guestfish can do it like this:"
31649 #: ../tools/virt-edit.pl:369
31652 " guestfish --rw -i -d domname edit /file1 : edit /file2\n"
31657 #: ../tools/virt-edit.pl:379
31662 #: ../tools/virt-edit.pl:381
31664 "If set, this string is used as the editor. It may contain arguments, eg. C<"
31669 #: ../tools/virt-edit.pl:384
31670 msgid "If not set, C<vi> is used."
31674 #: ../tools/virt-edit.pl:388 ../tools/virt-win-reg.pl:559
31675 #: ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182
31676 #: ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:532
31677 #: ../tools/virt-list-partitions.pl:250
31678 msgid "SHELL QUOTING"
31682 #: ../tools/virt-edit.pl:390 ../tools/virt-win-reg.pl:567
31683 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184
31684 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:534
31685 #: ../tools/virt-list-partitions.pl:252
31687 "Libvirt guest names can contain arbitrary characters, some of which have "
31688 "meaning to the shell such as C<#> and space. You may need to quote or "
31689 "escape these characters on the command line. See the shell manual page L<sh"
31690 "(1)> for details."
31694 #: ../tools/virt-edit.pl:397
31696 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
31697 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
31702 #: ../tools/virt-edit.pl:407 ../tools/virt-win-reg.pl:598
31703 #: ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202
31704 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:564
31705 #: ../tools/virt-list-partitions.pl:269
31710 #: ../tools/virt-edit.pl:409 ../tools/virt-win-reg.pl:600
31711 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204
31712 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:566
31713 #: ../tools/virt-list-partitions.pl:271
31714 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
31718 #: ../tools/virt-edit.pl:413
31719 msgid "Copyright (C) 2009-2011 Red Hat Inc."
31723 #: ../tools/virt-win-reg.pl:37
31725 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
31729 #: ../tools/virt-win-reg.pl:41
31732 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
31737 #: ../tools/virt-win-reg.pl:43
31740 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
31745 #: ../tools/virt-win-reg.pl:45
31748 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
31753 #: ../tools/virt-win-reg.pl:47
31756 " virt-win-reg --merge domname [input.reg ...]\n"
31761 #: ../tools/virt-win-reg.pl:49
31764 " virt-win-reg [--options] disk.img ... # instead of domname\n"
31769 #: ../tools/virt-win-reg.pl:53
31771 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
31772 "virtual machines. If you do this, you I<will> get irreversible disk "
31773 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
31774 "but doesn't catch all cases."
31778 #: ../tools/virt-win-reg.pl:58
31780 "Modifying the Windows Registry is an inherently risky operation. The format "
31781 "is deliberately obscure and undocumented, and Registry changes can leave the "
31782 "system unbootable. Therefore when using the C<--merge> option, make sure "
31783 "you have a reliable backup first."
31787 #: ../tools/virt-win-reg.pl:65
31789 "This program can export and merge Windows Registry entries from a Windows "
31794 #: ../tools/virt-win-reg.pl:68
31796 "The first parameter is the libvirt guest name or the raw disk image of a "
31801 #: ../tools/virt-win-reg.pl:71
31803 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
31804 "exported (recursively). For example:"
31808 #: ../tools/virt-win-reg.pl:74
31811 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
31816 #: ../tools/virt-win-reg.pl:76
31818 "You can also display single values from within registry keys, for example:"
31822 #: ../tools/virt-win-reg.pl:79
31825 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
31826 " $ virt-win-reg Windows7 $cvkey ProductName\n"
31827 " Windows 7 Enterprise\n"
31832 #: ../tools/virt-win-reg.pl:83
31834 "With C<--merge>, you can merge a textual regedit file into the Windows "
31839 #: ../tools/virt-win-reg.pl:86
31842 " $ virt-win-reg --merge Windows7 changes.reg\n"
31847 #: ../tools/virt-win-reg.pl:88
31852 #: ../tools/virt-win-reg.pl:90
31854 "This program is only meant for simple access to the registry. If you want "
31855 "to do complicated things with the registry, we suggest you download the "
31856 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
31857 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
31858 "L<hivexregedit(1)>."
31862 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
31867 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
31868 msgid "Enable debugging messages."
31872 #: ../tools/virt-win-reg.pl:157
31877 #: ../tools/virt-win-reg.pl:159
31879 "In merge mode, this merges a textual regedit file into the Windows Registry "
31880 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
31881 "displays or exports Registry entries instead."
31885 #: ../tools/virt-win-reg.pl:163
31887 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
31888 "result in disk corruption. However exporting (without this flag) is always "
31893 #: ../tools/virt-win-reg.pl:171
31894 msgid "B<--encoding> UTF-16LE|ASCII"
31898 #: ../tools/virt-win-reg.pl:173
31900 "When merging (only), you may need to specify the encoding for strings to be "
31901 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
31902 "(3)/ENCODING STRINGS>."
31906 #: ../tools/virt-win-reg.pl:177
31908 "The default is to use UTF-16LE, which should work with recent versions of "
31913 #: ../tools/virt-win-reg.pl:402
31914 msgid "SUPPORTED SYSTEMS"
31918 #: ../tools/virt-win-reg.pl:404
31920 "The program currently supports Windows NT-derived guests starting with "
31921 "Windows XP through to at least Windows 7."
31925 #: ../tools/virt-win-reg.pl:407
31927 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
31928 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
31929 "and C<HKEY_USERS\\.DEFAULT>."
31933 #: ../tools/virt-win-reg.pl:411
31935 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
31940 #: ../tools/virt-win-reg.pl:414
31942 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
31947 #: ../tools/virt-win-reg.pl:417
31952 #: ../tools/virt-win-reg.pl:419
31954 "C<virt-win-reg> expects that regedit files have already been reencoded in "
31955 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
31956 "style line endings. Since Windows regedit files are often in UTF-16LE with "
31957 "Windows-style line endings, you may need to reencode the whole file before "
31958 "or after processing."
31962 #: ../tools/virt-win-reg.pl:425
31964 "To reencode a file from Windows format to Linux (before processing it with "
31965 "the C<--merge> option), you would do something like this:"
31969 #: ../tools/virt-win-reg.pl:428
31972 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
31977 #: ../tools/virt-win-reg.pl:430
31979 "To go in the opposite direction, after exporting and before sending the file "
31980 "to a Windows user, do something like this:"
31984 #: ../tools/virt-win-reg.pl:433
31987 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
31992 #: ../tools/virt-win-reg.pl:435
31993 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
31997 #: ../tools/virt-win-reg.pl:437
31999 "If you are unsure about the current encoding, use the L<file(1)> command. "
32000 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
32001 "style (CRLF) line endings, like this:"
32005 #: ../tools/virt-win-reg.pl:441
32008 " $ file software.reg\n"
32009 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
32010 " with CRLF line terminators\n"
32015 #: ../tools/virt-win-reg.pl:445
32016 msgid "This file would need conversion before you could C<--merge> it."
32020 #: ../tools/virt-win-reg.pl:447
32021 msgid "CurrentControlSet etc."
32025 #: ../tools/virt-win-reg.pl:449
32027 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
32028 "Registry at the level of the hive file, and therefore you cannot modify "
32033 #: ../tools/virt-win-reg.pl:453
32035 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
32036 "circumstances it might refer to another control set. The way to find out is "
32037 "to look at the C<HKLM\\SYSTEM\\Select> key:"
32041 #: ../tools/virt-win-reg.pl:457
32044 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
32045 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
32046 " \"Current\"=dword:00000001\n"
32047 " \"Default\"=dword:00000001\n"
32048 " \"Failed\"=dword:00000000\n"
32049 " \"LastKnownGood\"=dword:00000002\n"
32054 #: ../tools/virt-win-reg.pl:464
32055 msgid "\"Current\" is the one which Windows will choose when it boots."
32059 #: ../tools/virt-win-reg.pl:466
32061 "Similarly, other C<Current...> keys in the path may need to be replaced."
32065 #: ../tools/virt-win-reg.pl:469
32066 msgid "WINDOWS TIPS"
32070 #: ../tools/virt-win-reg.pl:471
32072 "Note that some of these tips modify the guest disk image. The guest I<must> "
32073 "be shut off, else you will get disk corruption."
32077 #: ../tools/virt-win-reg.pl:474
32078 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
32082 #: ../tools/virt-win-reg.pl:476
32084 "Prepare a DOS batch script, VBScript or executable. Upload this using "
32085 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
32086 "is uploaded into C<C:\\>:"
32090 #: ../tools/virt-win-reg.pl:480
32093 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
32098 #: ../tools/virt-win-reg.pl:482
32099 msgid "Prepare a regedit file containing the registry change:"
32103 #: ../tools/virt-win-reg.pl:484
32106 " cat > test.reg <<'EOF'\n"
32107 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
32108 " \"Test\"=\"c:\\\\test.bat\"\n"
32114 #: ../tools/virt-win-reg.pl:489
32116 "In this example we use the key C<RunOnce> which means that the script will "
32117 "run precisely once when the first user logs in. If you want it to run every "
32118 "time a user logs in, replace C<RunOnce> with C<Run>."
32122 #: ../tools/virt-win-reg.pl:493
32123 msgid "Now update the registry:"
32127 #: ../tools/virt-win-reg.pl:495
32130 " virt-win-reg --merge WindowsGuest test.reg\n"
32135 #: ../tools/virt-win-reg.pl:497
32136 msgid "INSTALLING A SERVICE"
32140 #: ../tools/virt-win-reg.pl:499
32142 "This section assumes you are familiar with Windows services, and you either "
32143 "have a program which handles the Windows Service Control Protocol directly "
32144 "or you want to run any program using a service wrapper like SrvAny or the "
32149 #: ../tools/virt-win-reg.pl:504
32151 "First upload the program and optionally the service wrapper. In this case "
32152 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
32156 #: ../tools/virt-win-reg.pl:508
32159 " guestfish -i -d WindowsGuest <<EOF\n"
32160 " upload rhsrvany.exe /rhsrvany.exe\n"
32161 " upload test.exe /test.exe\n"
32167 #: ../tools/virt-win-reg.pl:513
32169 "Prepare a regedit file containing the registry changes. In this example, "
32170 "the first registry change is needed for the service itself or the service "
32171 "wrapper (if used). The second registry change is only needed because I am "
32172 "using the RHSrvAny service wrapper."
32176 #: ../tools/virt-win-reg.pl:518
32179 " cat > service.reg <<'EOF'\n"
32180 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
32181 " \"Type\"=dword:00000010\n"
32182 " \"Start\"=dword:00000002\n"
32183 " \"ErrorControl\"=dword:00000001\n"
32184 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
32185 " \"DisplayName\"=\"RHSrvAny\"\n"
32186 " \"ObjectName\"=\"NetworkService\"\n"
32191 #: ../tools/virt-win-reg.pl:527
32194 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
32195 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
32196 " \"PWD\"=\"c:\\\\Temp\"\n"
32202 #: ../tools/virt-win-reg.pl:538
32204 "For use of C<ControlSet001> see the section above in this manual page. You "
32205 "may need to adjust this according to the control set that is in use by the "
32210 #: ../tools/virt-win-reg.pl:544
32212 "C<\"ObjectName\"> controls the privileges that the service will have. An "
32213 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
32214 "privileged account."
32218 #: ../tools/virt-win-reg.pl:550
32220 "For the meaning of the magic numbers, see this Microsoft KB article: "
32221 "L<http://support.microsoft.com/kb/103000>."
32225 #: ../tools/virt-win-reg.pl:555
32226 msgid "Update the registry:"
32230 #: ../tools/virt-win-reg.pl:557
32233 " virt-win-reg --merge WindowsGuest service.reg\n"
32238 #: ../tools/virt-win-reg.pl:561
32240 "Be careful when passing parameters containing C<\\> (backslash) in the "
32241 "shell. Usually you will have to use 'single quotes' or double backslashes "
32242 "(but not both) to protect them from the shell."
32246 #: ../tools/virt-win-reg.pl:565
32247 msgid "Paths and value names are case-insensitive."
32251 #: ../tools/virt-win-reg.pl:574
32253 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
32254 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
32255 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
32259 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:555
32261 "When reporting bugs, please enable debugging and capture the I<complete> "
32266 #: ../tools/virt-win-reg.pl:592
32269 " export LIBGUESTFS_DEBUG=1\n"
32270 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
32275 #: ../tools/virt-win-reg.pl:595
32277 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
32282 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510
32283 #: ../tools/virt-make-fs.pl:570
32284 msgid "Copyright (C) 2010 Red Hat Inc."
32288 #: ../tools/virt-resize.pl:42
32289 msgid "virt-resize - Resize a virtual machine disk"
32293 #: ../tools/virt-resize.pl:46
32296 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
32297 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
32298 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
32303 #: ../tools/virt-resize.pl:52
32305 "Virt-resize is a tool which can resize a virtual machine disk, making it "
32306 "larger or smaller overall, and resizing or deleting any partitions contained "
32311 #: ../tools/virt-resize.pl:56
32313 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
32314 "not> be used on live virtual machines - for consistent results, shut the "
32315 "virtual machine down before resizing it."
32319 #: ../tools/virt-resize.pl:60
32321 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
32322 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
32326 #: ../tools/virt-resize.pl:66
32328 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
32329 "fill the extra 5GB of space."
32333 #: ../tools/virt-resize.pl:69
32336 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
32337 " virt-filesystems --long -h --all -a olddisk\n"
32338 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
32339 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
32344 #: ../tools/virt-resize.pl:74
32346 "As above, but make the /boot partition 200MB bigger, while giving the "
32347 "remaining space to /dev/sda2:"
32351 #: ../tools/virt-resize.pl:77
32354 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
32359 #: ../tools/virt-resize.pl:79
32360 msgid "As above, but the output format will be uncompressed qcow2:"
32364 #: ../tools/virt-resize.pl:81
32367 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
32368 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
32373 #: ../tools/virt-resize.pl:84
32374 msgid "DETAILED USAGE"
32378 #: ../tools/virt-resize.pl:86
32379 msgid "EXPANDING A VIRTUAL MACHINE DISK"
32383 #: ../tools/virt-resize.pl:90
32384 msgid "1. Shut down the virtual machine"
32388 #: ../tools/virt-resize.pl:92
32389 msgid "2. Locate input disk image"
32393 #: ../tools/virt-resize.pl:94
32395 "Locate the input disk image (ie. the file or device on the host containing "
32396 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
32397 "dumpxml> like this to find the disk image name:"
32401 #: ../tools/virt-resize.pl:98
32404 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
32405 " Found 1 nodes:\n"
32407 " <source dev=\"/dev/vg/lv_guest\" />\n"
32412 #: ../tools/virt-resize.pl:103
32413 msgid "3. Look at current sizing"
32417 #: ../tools/virt-resize.pl:105
32418 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
32422 #: ../tools/virt-resize.pl:108
32425 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
32426 " Name Type Size Parent\n"
32427 " /dev/sda1 partition 101M /dev/sda\n"
32428 " /dev/sda2 partition 7.9G /dev/sda\n"
32429 " /dev/sda device 8.0G -\n"
32434 #: ../tools/virt-resize.pl:114
32436 "(This example is a virtual machine with an 8 GB disk which we would like to "
32437 "expand up to 10 GB)."
32441 #: ../tools/virt-resize.pl:117
32442 msgid "4. Create output disk"
32446 #: ../tools/virt-resize.pl:119
32448 "Virt-resize cannot do in-place disk modifications. You have to have space "
32449 "to store the resized output disk."
32453 #: ../tools/virt-resize.pl:122
32455 "To store the resized disk image in a file, create a file of a suitable size:"
32459 #: ../tools/virt-resize.pl:125
32462 " # rm -f outdisk\n"
32463 " # truncate -s 10G outdisk\n"
32468 #: ../tools/virt-resize.pl:128
32469 msgid "Or use L<lvcreate(1)> to create a logical volume:"
32473 #: ../tools/virt-resize.pl:130
32476 " # lvcreate -L 10G -n lv_name vg_name\n"
32481 #: ../tools/virt-resize.pl:132
32482 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
32486 #: ../tools/virt-resize.pl:134
32489 " # virsh pool-list\n"
32490 " # virsh vol-create-as poolname newvol 10G\n"
32495 #: ../tools/virt-resize.pl:137
32500 #: ../tools/virt-resize.pl:139
32502 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
32503 "file) and the output disk. The output disk is the one created in the "
32508 #: ../tools/virt-resize.pl:143
32511 " # virt-resize indisk outdisk\n"
32516 #: ../tools/virt-resize.pl:145
32518 "This command just copies disk image C<indisk> to disk image C<outdisk> "
32519 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
32520 "larger, then an extra, empty partition is created at the end of the disk "
32521 "covering the extra space. If C<outdisk> is smaller, then it will give an "
32526 #: ../tools/virt-resize.pl:151
32528 "More realistically you'd want to expand existing partitions in the disk "
32529 "image by passing extra options (for the full list see the L</OPTIONS> "
32534 #: ../tools/virt-resize.pl:155
32536 "L</--expand> is the most useful option. It expands the named partition "
32537 "within the disk to fill any extra space:"
32541 #: ../tools/virt-resize.pl:158
32544 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
32549 #: ../tools/virt-resize.pl:160
32551 "(In this case, an extra partition is I<not> created at the end of the disk, "
32552 "because there will be no unused space)."
32556 #: ../tools/virt-resize.pl:163
32558 "L</--resize> is the other commonly used option. The following would "
32559 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
32560 "rest of the available space:"
32564 #: ../tools/virt-resize.pl:167
32567 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
32568 " indisk outdisk\n"
32573 #: ../tools/virt-resize.pl:170
32575 "If the expanded partition in the image contains a filesystem or LVM PV, then "
32576 "if virt-resize knows how, it will resize the contents, the equivalent of "
32577 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
32578 ">. However virt-resize does not know how to resize some filesystems, so you "
32579 "would have to online resize them after booting the guest."
32583 #: ../tools/virt-resize.pl:177
32584 msgid "Other options are covered below."
32588 #: ../tools/virt-resize.pl:179
32593 #: ../tools/virt-resize.pl:181
32594 msgid "Thoroughly test the new disk image I<before> discarding the old one."
32598 #: ../tools/virt-resize.pl:183
32599 msgid "If you are using libvirt, edit the XML to point at the new disk:"
32603 #: ../tools/virt-resize.pl:185
32606 " # virsh edit guestname\n"
32611 #: ../tools/virt-resize.pl:187
32613 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
32614 "html#elementsDisks>"
32618 #: ../tools/virt-resize.pl:190
32619 msgid "Then start up the domain with the new, resized disk:"
32623 #: ../tools/virt-resize.pl:192
32626 " # virsh start guestname\n"
32631 #: ../tools/virt-resize.pl:194
32633 "and check that it still works. See also the L</NOTES> section below for "
32634 "additional information."
32638 #: ../tools/virt-resize.pl:197
32639 msgid "7. Resize LVs etc inside the guest"
32643 #: ../tools/virt-resize.pl:199
32644 msgid "(This can also be done offline using L<guestfish(1)>)"
32648 #: ../tools/virt-resize.pl:201
32650 "Once the guest has booted you should see the new space available, at least "
32651 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
32652 "may need to resize LVs inside PVs, and also resize filesystem types that "
32653 "virt-resize does not know how to expand."
32657 #: ../tools/virt-resize.pl:208
32658 msgid "SHRINKING A VIRTUAL MACHINE DISK"
32662 #: ../tools/virt-resize.pl:210
32664 "Shrinking is somewhat more complex than expanding, and only an overview is "
32669 #: ../tools/virt-resize.pl:213
32671 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
32672 "filesystems). The user has to shrink content before passing the disk image "
32673 "to virt-resize, and virt-resize will check that the content has been shrunk "
32678 #: ../tools/virt-resize.pl:218
32679 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
32683 #: ../tools/virt-resize.pl:220
32685 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
32686 "steps 3 and 4 above to allocate a new disk image."
32690 #: ../tools/virt-resize.pl:223
32692 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
32696 #: ../tools/virt-resize.pl:226
32697 msgid "IGNORING OR DELETING PARTITIONS"
32701 #: ../tools/virt-resize.pl:228
32703 "virt-resize also gives a convenient way to ignore or delete partitions when "
32704 "copying from the input disk to the output disk. Ignoring a partition speeds "
32705 "up the copy where you don't care about the existing contents of a "
32706 "partition. Deleting a partition removes it completely, but note that it "
32707 "also renumbers any partitions after the one which is deleted, which can "
32708 "leave some guests unbootable."
32712 #: ../tools/virt-resize.pl:235
32713 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
32717 #: ../tools/virt-resize.pl:237
32719 "If the input disk is in qcow2 format, then you may prefer that the output is "
32720 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
32721 "the fly. The output format is simply determined by the format of the empty "
32722 "output container that you provide. Thus to create qcow2 output, use:"
32726 #: ../tools/virt-resize.pl:243
32729 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
32734 #: ../tools/virt-resize.pl:245
32735 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
32739 #: ../tools/virt-resize.pl:247
32740 msgid "Similarly, to get non-sparse raw output use:"
32744 #: ../tools/virt-resize.pl:249
32747 " fallocate -l size outdisk\n"
32752 #: ../tools/virt-resize.pl:251
32754 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
32755 "dev/zero of=outdisk bs=1M count=..>)"
32759 #: ../tools/virt-resize.pl:264
32760 msgid "Display help."
32764 #: ../tools/virt-resize.pl:278
32765 msgid "B<--resize part=size>"
32769 #: ../tools/virt-resize.pl:280
32771 "Resize the named partition (expanding or shrinking it) so that it has the "
32776 #: ../tools/virt-resize.pl:283
32778 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
32779 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
32780 "Exabytes; or as a percentage of the current size; or as a relative number or "
32781 "percentage. For example:"
32785 #: ../tools/virt-resize.pl:288
32788 " --resize /dev/sda2=10G\n"
32793 #: ../tools/virt-resize.pl:290
32796 " --resize /dev/sda4=90%\n"
32801 #: ../tools/virt-resize.pl:292
32804 " --resize /dev/sda2=+1G\n"
32809 #: ../tools/virt-resize.pl:294
32812 " --resize /dev/sda2=-200M\n"
32817 #: ../tools/virt-resize.pl:296
32820 " --resize /dev/sda1=+128K\n"
32825 #: ../tools/virt-resize.pl:298
32828 " --resize /dev/sda1=+10%\n"
32833 #: ../tools/virt-resize.pl:300
32836 " --resize /dev/sda1=-10%\n"
32841 #: ../tools/virt-resize.pl:302
32843 "You can increase the size of any partition. Virt-resize will expand the "
32844 "direct content of the partition if it knows how (see C<--expand> below)."
32848 #: ../tools/virt-resize.pl:306
32850 "You can only I<decrease> the size of partitions that contain filesystems or "
32851 "PVs which have already been shrunk. Virt-resize will check this has been "
32852 "done before proceeding, or else will print an error (see also C<--resize-"
32857 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
32858 #: ../tools/virt-resize.pl:420
32859 msgid "You can give this option multiple times."
32863 #: ../tools/virt-resize.pl:317
32864 msgid "B<--resize-force part=size>"
32868 #: ../tools/virt-resize.pl:319
32870 "This is the same as C<--resize> except that it will let you decrease the "
32871 "size of any partition. Generally this means you will lose any data which "
32872 "was at the end of the partition you shrink, but you may not care about that "
32873 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
32874 "as a swap partition)."
32878 #: ../tools/virt-resize.pl:325
32879 msgid "See also the C<--ignore> option."
32883 #: ../tools/virt-resize.pl:331
32884 msgid "B<--expand part>"
32888 #: ../tools/virt-resize.pl:333
32890 "Expand the named partition so it uses up all extra space (space left over "
32891 "after any other resize changes that you request have been done)."
32895 #: ../tools/virt-resize.pl:336
32897 "If virt-resize knows how, it will expand the direct content of the "
32898 "partition. For example, if the partition is an LVM PV, it will expand the "
32899 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
32900 "content it doesn't know about alone."
32904 #: ../tools/virt-resize.pl:341
32905 msgid "Currently virt-resize can resize:"
32909 #: ../tools/virt-resize.pl:347
32911 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
32916 #: ../tools/virt-resize.pl:352
32918 "NTFS filesystems contained directly in a partition, if libguestfs was "
32919 "compiled with support for NTFS."
32923 #: ../tools/virt-resize.pl:355
32925 "The filesystem must have been shut down consistently last time it was used. "
32926 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
32927 "consistency check, so at the first boot after resizing Windows will check "
32932 #: ../tools/virt-resize.pl:362
32934 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
32935 "inside the PV, but see the C<--LV-expand> option. The user could also "
32936 "resize LVs as desired after boot."
32940 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
32941 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
32945 #: ../tools/virt-resize.pl:374
32946 msgid "B<--shrink part>"
32950 #: ../tools/virt-resize.pl:376
32952 "Shrink the named partition until the overall disk image fits in the "
32953 "destination. The named partition B<must> contain a filesystem or PV which "
32954 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
32955 "online tools). Virt-resize will check this and give an error if it has not "
32960 #: ../tools/virt-resize.pl:382
32962 "The amount by which the overall disk must be shrunk (after carrying out all "
32963 "other operations requested by the user) is called the \"deficit\". For "
32964 "example, a straight copy (assume no other operations) from a 5GB disk image "
32965 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
32966 "would give an error unless the user specified a partition to shrink and that "
32967 "partition had more than a gigabyte of free space."
32971 #: ../tools/virt-resize.pl:396
32972 msgid "B<--ignore part>"
32976 #: ../tools/virt-resize.pl:398
32978 "Ignore the named partition. Effectively this means the partition is "
32979 "allocated on the destination disk, but the content is not copied across from "
32980 "the source disk. The content of the partition will be blank (all zero "
32985 #: ../tools/virt-resize.pl:409
32986 msgid "B<--delete part>"
32990 #: ../tools/virt-resize.pl:411
32992 "Delete the named partition. It would be more accurate to describe this as "
32993 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
32994 "the original disk image is left intact."
32998 #: ../tools/virt-resize.pl:415
33000 "Note that when you delete a partition, then anything contained in the "
33001 "partition is also deleted. Furthermore, this causes any partitions that "
33002 "come after to be I<renumbered>, which can easily make your guest unbootable."
33006 #: ../tools/virt-resize.pl:426
33007 msgid "B<--LV-expand logvol>"
33011 #: ../tools/virt-resize.pl:428
33013 "This takes the logical volume and, as a final step, expands it to fill all "
33014 "the space available in its volume group. A typical usage, assuming a Linux "
33015 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
33016 "lv_root> would be:"
33020 #: ../tools/virt-resize.pl:433
33023 " virt-resize indisk outdisk \\\n"
33024 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
33029 #: ../tools/virt-resize.pl:436
33031 "This would first expand the partition (and PV), and then expand the root "
33032 "device to fill the extra space in the PV."
33036 #: ../tools/virt-resize.pl:439
33038 "The contents of the LV are also resized if virt-resize knows how to do "
33039 "that. You can stop virt-resize from trying to expand the content by using "
33040 "the option C<--no-expand-content>."
33044 #: ../tools/virt-resize.pl:443
33045 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
33049 #: ../tools/virt-resize.pl:446
33051 "You can give this option multiple times, I<but> it doesn't make sense to do "
33052 "this unless the logical volumes you specify are all in different volume "
33057 #: ../tools/virt-resize.pl:454
33058 msgid "B<--no-copy-boot-loader>"
33062 #: ../tools/virt-resize.pl:456
33064 "By default, virt-resize copies over some sectors at the start of the disk "
33065 "(up to the beginning of the first partition). Commonly these sectors "
33066 "contain the Master Boot Record (MBR) and the boot loader, and are required "
33067 "in order for the guest to boot correctly."
33071 #: ../tools/virt-resize.pl:461
33073 "If you specify this flag, then this initial copy is not done. You may need "
33074 "to reinstall the boot loader in this case."
33078 #: ../tools/virt-resize.pl:469
33079 msgid "B<--no-extra-partition>"
33083 #: ../tools/virt-resize.pl:471
33085 "By default, virt-resize creates an extra partition if there is any extra, "
33086 "unused space after all resizing has happened. Use this option to prevent "
33087 "the extra partition from being created. If you do this then the extra space "
33088 "will be inaccessible until you run fdisk, parted, or some other partitioning "
33089 "tool in the guest."
33093 #: ../tools/virt-resize.pl:477
33095 "Note that if the surplus space is smaller than 10 MB, no extra partition "
33100 #: ../tools/virt-resize.pl:484
33101 msgid "B<--no-expand-content>"
33105 #: ../tools/virt-resize.pl:486
33107 "By default, virt-resize will try to expand the direct contents of "
33108 "partitions, if it knows how (see C<--expand> option above)."
33112 #: ../tools/virt-resize.pl:489
33114 "If you give the C<--no-expand-content> option then virt-resize will not "
33119 #: ../tools/virt-resize.pl:496
33120 msgid "B<-d> | B<--debug>"
33124 #: ../tools/virt-resize.pl:504
33125 msgid "B<-n> | B<--dryrun>"
33129 #: ../tools/virt-resize.pl:506
33130 msgid "Print a summary of what would be done, but don't do anything."
33134 #: ../tools/virt-resize.pl:512
33135 msgid "B<-q> | B<--quiet>"
33139 #: ../tools/virt-resize.pl:514
33140 msgid "Don't print the summary."
33144 #: ../tools/virt-resize.pl:522
33146 "Specify the format of the input disk image. If this flag is not given then "
33147 "it is auto-detected from the image itself."
33151 #: ../tools/virt-resize.pl:528
33153 "Note that this option I<does not> affect the output format. See L</QCOW2 "
33154 "AND NON-SPARSE RAW FORMATS>."
33158 #: ../tools/virt-resize.pl:535
33159 msgid "B<--output-format> raw"
33163 #: ../tools/virt-resize.pl:537
33165 "Specify the format of the output disk image. If this flag is not given then "
33166 "it is auto-detected from the image itself."
33170 #: ../tools/virt-resize.pl:543
33172 "Note that you still need to create the output disk with the right format. "
33173 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
33177 #: ../tools/virt-resize.pl:1419
33182 #: ../tools/virt-resize.pl:1421
33183 msgid "\"Partition 1 does not end on cylinder boundary.\""
33187 #: ../tools/virt-resize.pl:1423
33189 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
33190 "means the partitions will not be aligned to the ancient CHS geometry. "
33191 "However CHS geometry is meaningless for disks manufactured since the early "
33192 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
33193 "cylinders is not required by any modern operating system."
33197 #: ../tools/virt-resize.pl:1430
33198 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
33202 #: ../tools/virt-resize.pl:1432
33204 "In Windows Vista and later versions, Microsoft switched to using a separate "
33205 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
33206 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
33207 "the boot partition. Doing so seems to break the guest completely. However "
33208 "expanding the second partition (ie. C: drive) should work."
33212 #: ../tools/virt-resize.pl:1439
33214 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
33215 "NTFS partitions have been expanded. This is just a safety check and (unless "
33216 "it find errors) is nothing to worry about."
33220 #: ../tools/virt-resize.pl:1443
33221 msgid "GUEST BOOT STUCK AT \"GRUB\""
33225 #: ../tools/virt-resize.pl:1445
33227 "If a Linux guest does not boot after resizing, and the boot is stuck after "
33228 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
33229 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
33230 "although we think is to do with partition alignment."
33234 #: ../tools/virt-resize.pl:1450
33237 " guestfish -i -a newdisk\n"
33238 " ><fs> cat /boot/grub/device.map\n"
33239 " # check the contents of this file are sensible or\n"
33240 " # edit the file if necessary\n"
33241 " ><fs> grub-install / /dev/vda\n"
33247 #: ../tools/virt-resize.pl:1457
33249 "For more flexible guest reconfiguration, including if you need to specify "
33250 "other parameters to grub-install, use L<virt-rescue(1)>."
33254 #: ../tools/virt-resize.pl:1460
33255 msgid "ALTERNATIVE TOOLS"
33259 #: ../tools/virt-resize.pl:1462
33261 "There are several proprietary tools for resizing partitions. We won't "
33262 "mention any here."
33266 #: ../tools/virt-resize.pl:1465
33268 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
33269 "operations on disk images. They can resize and move partitions, but I don't "
33270 "think they can do anything with the contents, and they certainly don't "
33275 #: ../tools/virt-resize.pl:1470
33277 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
33278 "but at a much lower level. You will probably end up hand-calculating sector "
33279 "offsets, which is something that virt-resize was designed to avoid. If you "
33280 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
33285 #: ../tools/virt-resize.pl:1485
33287 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
33288 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
33289 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
33290 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
33291 "libguestfs.org/>."
33295 #: ../tools/virt-list-filesystems.pl:32
33297 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
33301 #: ../tools/virt-list-filesystems.pl:36
33304 " virt-list-filesystems [--options] domname\n"
33309 #: ../tools/virt-list-filesystems.pl:38
33312 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
33317 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
33319 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
33324 #: ../tools/virt-list-filesystems.pl:45
33326 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
33327 "are contained in a virtual machine or disk image."
33331 #: ../tools/virt-list-filesystems.pl:49
33333 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
33334 "functionality. For more complex cases you should look at the L<guestfish(1)"
33339 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
33340 msgid "B<-l> | B<--long>"
33344 #: ../tools/virt-list-filesystems.pl:108
33346 "With this option, C<virt-list-filesystems> displays the type of each "
33347 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
33351 #: ../tools/virt-list-filesystems.pl:115
33352 msgid "B<-a> | B<--all>"
33356 #: ../tools/virt-list-filesystems.pl:117
33358 "Normally we only show mountable filesystems. If this option is given then "
33359 "swap devices are shown too."
33363 #: ../tools/virt-list-filesystems.pl:191
33365 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
33366 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
33367 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
33371 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
33372 msgid "Copyright (C) 2009 Red Hat Inc."
33376 #: ../tools/virt-tar.pl:33
33377 msgid "virt-tar - Extract or upload files to a virtual machine"
33381 #: ../tools/virt-tar.pl:37
33384 " virt-tar [--options] -x domname directory tarball\n"
33389 #: ../tools/virt-tar.pl:39
33392 " virt-tar [--options] -u domname tarball directory\n"
33397 #: ../tools/virt-tar.pl:41
33400 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
33405 #: ../tools/virt-tar.pl:43
33408 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
33413 #: ../tools/virt-tar.pl:47
33414 msgid "Download C</home> from the VM into a local tarball:"
33418 #: ../tools/virt-tar.pl:49
33421 " virt-tar -x domname /home home.tar\n"
33426 #: ../tools/virt-tar.pl:51
33429 " virt-tar -zx domname /home home.tar.gz\n"
33434 #: ../tools/virt-tar.pl:53
33435 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
33439 #: ../tools/virt-tar.pl:55
33442 " virt-tar -u domname uploadstuff.tar /tmp\n"
33447 #: ../tools/virt-tar.pl:57
33450 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
33455 #: ../tools/virt-tar.pl:61
33457 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
33458 "virtual machines. If you do this, you risk disk corruption in the VM. "
33459 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
33463 #: ../tools/virt-tar.pl:66
33465 "You can use C<-x> (extract) on live virtual machines, but you might get "
33466 "inconsistent results or errors if there is filesystem activity inside the "
33467 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
33468 "work, but the only way to guarantee consistent results is if the virtual "
33469 "machine is shut down."
33473 #: ../tools/virt-tar.pl:74
33475 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
33476 "parts of a guest filesystem. There are many possibilities: making backups, "
33477 "uploading data files, snooping on guest activity, fixing or customizing "
33482 #: ../tools/virt-tar.pl:79
33484 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
33485 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
33486 "should look at the L<guestfish(1)> tool."
33490 #: ../tools/virt-tar.pl:83
33492 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
33493 "its contents (recursively) from the virtual machine into a local tarball. "
33494 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
33495 "virtual machine. You cannot use these two options together."
33499 #: ../tools/virt-tar.pl:89
33501 "In addition, you may need to use the C<-z> (gZip) option to enable "
33502 "compression. When uploading, you have to specify C<-z> if the upload file "
33503 "is compressed because virt-tar won't detect this on its own."
33507 #: ../tools/virt-tar.pl:93
33509 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
33510 "example it cannot do PKZip files or bzip2 compression. If you want that "
33511 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
33512 "the L<libguestfs(3)> API)."
33516 #: ../tools/virt-tar.pl:151
33517 msgid "B<-x> | B<--extract> | B<--download>"
33521 #: ../tools/virt-tar.pl:153
33522 msgid "B<-u> | B<--upload>"
33526 #: ../tools/virt-tar.pl:155
33528 "Use C<-x> to extract (download) a directory from a virtual machine to a "
33533 #: ../tools/virt-tar.pl:158
33535 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
33536 "Please read the L</WARNING> section above before using this option."
33540 #: ../tools/virt-tar.pl:162
33541 msgid "You must specify exactly one of these options."
33545 #: ../tools/virt-tar.pl:168
33546 msgid "B<-z> | B<--gzip>"
33550 #: ../tools/virt-tar.pl:170
33551 msgid "Specify that the input or output tarball is gzip-compressed."
33555 #: ../tools/virt-tar.pl:283
33557 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
33558 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
33563 #: ../tools/virt-make-fs.pl:37
33564 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
33568 #: ../tools/virt-make-fs.pl:41
33571 " virt-make-fs [--options] input.tar output.img\n"
33576 #: ../tools/virt-make-fs.pl:43
33579 " virt-make-fs [--options] input.tar.gz output.img\n"
33584 #: ../tools/virt-make-fs.pl:45
33587 " virt-make-fs [--options] directory output.img\n"
33592 #: ../tools/virt-make-fs.pl:49
33594 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
33595 "archive or some files in a directory. It is similar to tools like L<mkisofs"
33596 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
33597 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
33598 "you want to attach these filesystems to existing virtual machines (eg. to "
33599 "import large amounts of read-only data to a VM)."
33603 #: ../tools/virt-make-fs.pl:57
33604 msgid "Basic usage is:"
33608 #: ../tools/virt-make-fs.pl:59
33611 " virt-make-fs input output\n"
33616 #: ../tools/virt-make-fs.pl:61
33618 "where C<input> is either a directory containing files that you want to add, "
33619 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
33620 "C<output> is a disk image. The input type is detected automatically. The "
33621 "output disk image defaults to a raw ext2 image unless you specify extra "
33622 "flags (see L</OPTIONS> below)."
33626 #: ../tools/virt-make-fs.pl:67
33627 msgid "EXTRA SPACE"
33631 #: ../tools/virt-make-fs.pl:69
33633 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
33634 "the files that it contains, but might have extra space. Depending on how "
33635 "you are going to use the output, you might think this extra space is wasted "
33636 "and want to minimize it, or you might want to leave space so that more files "
33637 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
33638 "but you can use the C<--size> flag to leave space in the filesystem if you "
33643 #: ../tools/virt-make-fs.pl:77
33645 "An alternative way to leave extra space but not make the output image any "
33646 "bigger is to use an alternative disk image format (instead of the default "
33647 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
33648 "image format (check your hypervisor supports this before using it). This "
33649 "allows you to choose a large C<--size> but the extra space won't actually be "
33650 "allocated in the image until you try to store something in it."
33654 #: ../tools/virt-make-fs.pl:85
33656 "Don't forget that you can also use local commands including L<resize2fs(8)> "
33657 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
33658 "to build another image from scratch."
33662 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
33663 #: ../tools/virt-make-fs.pl:142
33668 #: ../tools/virt-make-fs.pl:91
33671 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
33676 #: ../tools/virt-make-fs.pl:93
33677 msgid "FILESYSTEM TYPE"
33681 #: ../tools/virt-make-fs.pl:95
33683 "The default filesystem type is C<ext2>. Just about any filesystem type that "
33684 "libguestfs supports can be used (but I<not> read-only formats like "
33685 "ISO9660). Here are some of the more common choices:"
33689 #: ../tools/virt-make-fs.pl:101
33694 #: ../tools/virt-make-fs.pl:103
33696 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
33697 "you are not going to use the filesystem in a way that requires the journal, "
33698 "then this is just wasted overhead."
33702 #: ../tools/virt-make-fs.pl:107
33703 msgid "I<ntfs> or I<vfat>"
33707 #: ../tools/virt-make-fs.pl:109
33708 msgid "Useful if exporting data to a Windows guest."
33712 #: ../tools/virt-make-fs.pl:111
33714 "I<Note for vfat>: The tar archive or local directory must only contain files "
33715 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
33716 "program running within libguestfs is unable to change the ownership of non-"
33717 "root files, since vfat itself does not support this."
33721 #: ../tools/virt-make-fs.pl:116
33726 #: ../tools/virt-make-fs.pl:118
33728 "Lower overhead than C<ext2>, but certain limitations on filename length and "
33729 "total filesystem size."
33733 #: ../tools/virt-make-fs.pl:125
33736 " virt-make-fs --type=minix input minixfs.img\n"
33741 #: ../tools/virt-make-fs.pl:127
33742 msgid "TO PARTITION OR NOT TO PARTITION"
33746 #: ../tools/virt-make-fs.pl:129
33747 msgid "Optionally virt-make-fs can add a partition table to the output disk."
33751 #: ../tools/virt-make-fs.pl:131
33753 "Adding a partition can make the disk image more compatible with certain "
33754 "virtualized operating systems which don't expect to see a filesystem "
33755 "directly located on a block device (Linux doesn't care and will happily "
33756 "handle both types)."
33760 #: ../tools/virt-make-fs.pl:136
33762 "On the other hand, if you have a partition table then the output image is no "
33763 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
33764 "directly on a partitioned disk image. (However libguestfs tools such as "
33765 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
33769 #: ../tools/virt-make-fs.pl:144
33770 msgid "Add an MBR partition:"
33774 #: ../tools/virt-make-fs.pl:146
33777 " virt-make-fs --partition -- input disk.img\n"
33782 #: ../tools/virt-make-fs.pl:148
33784 "If the output disk image could be terabyte-sized or larger, it's better to "
33785 "use an EFI/GPT-compatible partition table:"
33789 #: ../tools/virt-make-fs.pl:151
33792 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
33797 #: ../tools/virt-make-fs.pl:179
33798 msgid "Enable debugging information."
33802 #: ../tools/virt-make-fs.pl:185
33803 msgid "B<--size=E<lt>NE<gt>>"
33807 #: ../tools/virt-make-fs.pl:187
33808 msgid "B<--size=+E<lt>NE<gt>>"
33812 #: ../tools/virt-make-fs.pl:189
33813 msgid "B<-s E<lt>NE<gt>>"
33817 #: ../tools/virt-make-fs.pl:191
33818 msgid "B<-s +E<lt>NE<gt>>"
33822 #: ../tools/virt-make-fs.pl:193
33824 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
33828 #: ../tools/virt-make-fs.pl:196
33830 "If this option is I<not> given, then the output image will be just large "
33831 "enough to contain all the files, with not much wasted space."
33835 #: ../tools/virt-make-fs.pl:199
33837 "To choose a fixed size output disk, specify an absolute number followed by b/"
33838 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33839 "Petabytes or Exabytes. This must be large enough to contain all the input "
33840 "files, else you will get an error."
33844 #: ../tools/virt-make-fs.pl:204
33846 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
33847 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
33848 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
33849 "the input files, and (approximately) an extra 200 MB free space."
33853 #: ../tools/virt-make-fs.pl:210
33855 "Note that virt-make-fs estimates free space, and therefore will not produce "
33856 "filesystems containing precisely the free space requested. (It is much more "
33857 "expensive and time-consuming to produce a filesystem which has precisely the "
33858 "desired free space)."
33862 #: ../tools/virt-make-fs.pl:219
33863 msgid "B<--format=E<lt>fmtE<gt>>"
33867 #: ../tools/virt-make-fs.pl:221
33868 msgid "B<-F E<lt>fmtE<gt>>"
33872 #: ../tools/virt-make-fs.pl:223
33873 msgid "Choose the output disk image format."
33877 #: ../tools/virt-make-fs.pl:225
33878 msgid "The default is C<raw> (raw disk image)."
33882 #: ../tools/virt-make-fs.pl:227
33884 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
33885 "that would really make sense here is C<qcow2>."
33889 #: ../tools/virt-make-fs.pl:234
33890 msgid "B<--type=E<lt>fsE<gt>>"
33894 #: ../tools/virt-make-fs.pl:236
33895 msgid "B<-t E<lt>fsE<gt>>"
33899 #: ../tools/virt-make-fs.pl:238
33900 msgid "Choose the output filesystem type."
33904 #: ../tools/virt-make-fs.pl:240
33905 msgid "The default is C<ext2>."
33909 #: ../tools/virt-make-fs.pl:242
33911 "Any filesystem which is supported read-write by libguestfs can be used here."
33915 #: ../tools/virt-make-fs.pl:249
33916 msgid "B<--partition>"
33920 #: ../tools/virt-make-fs.pl:251
33921 msgid "B<--partition=E<lt>parttypeE<gt>>"
33925 #: ../tools/virt-make-fs.pl:253
33927 "If specified, this flag adds an MBR partition table to the output disk image."
33931 #: ../tools/virt-make-fs.pl:256
33933 "You can change the partition table type, eg. C<--partition=gpt> for large "
33938 #: ../tools/virt-make-fs.pl:259
33940 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
33941 "might consider the next parameter to be the partition type. For example:"
33945 #: ../tools/virt-make-fs.pl:263
33948 " virt-make-fs --partition input.tar ...\n"
33953 #: ../tools/virt-make-fs.pl:265
33955 "would cause virt-make-fs to think you wanted to use a partition type of "
33956 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
33957 "dash) between options and the input file argument:"
33961 #: ../tools/virt-make-fs.pl:269
33964 " virt-make-fs --partition -- input.tar ...\n"
33969 #: ../tools/virt-make-fs.pl:541
33971 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
33972 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
33973 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
33977 #: ../tools/virt-make-fs.pl:558
33980 " export LIBGUESTFS_DEBUG=1\n"
33981 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
33986 #: ../tools/virt-make-fs.pl:561
33988 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
33993 #: ../tools/virt-list-partitions.pl:32
33995 "virt-list-partitions - List partitions in a virtual machine or disk image"
33999 #: ../tools/virt-list-partitions.pl:36
34002 " virt-list-partitions [--options] domname\n"
34007 #: ../tools/virt-list-partitions.pl:38
34010 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
34015 #: ../tools/virt-list-partitions.pl:45
34017 "C<virt-list-partitions> is a command line tool to list the partitions that "
34018 "are contained in a virtual machine or disk image. It is mainly useful as a "
34019 "first step to using L<virt-resize(1)>."
34023 #: ../tools/virt-list-partitions.pl:50
34025 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
34026 "functionality. For more complex cases you should look at the L<guestfish(1)"
34031 #: ../tools/virt-list-partitions.pl:107
34032 msgid "B<-h> | B<--human-readable>"
34036 #: ../tools/virt-list-partitions.pl:109
34037 msgid "Show sizes in human-readable form (eg. \"1G\")."
34041 #: ../tools/virt-list-partitions.pl:117
34043 "With this option, C<virt-list-partitions> displays the type and size of each "
34044 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
34048 #: ../tools/virt-list-partitions.pl:124
34049 msgid "B<-t> | B<--total>"
34053 #: ../tools/virt-list-partitions.pl:126
34055 "Display the total size of each block device (as a separate row or rows)."
34059 #: ../tools/virt-list-partitions.pl:259
34061 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
34062 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
34063 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
34067 #: ../tools/virt-list-partitions.pl:275
34068 msgid "Copyright (C) 2009-2010 Red Hat Inc."