1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
5 # rjones <rjones@redhat.com>, 2011.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: https://bugzilla.redhat.com/\n"
10 "POT-Creation-Date: 2011-07-15 17:18+0200\n"
11 "PO-Revision-Date: 2011-07-17 20:50+0000\n"
12 "Last-Translator: rjones <rjones@redhat.com>\n"
13 "Language-Team: Japanese (http://www.transifex.net/projects/p/fedora/team/ja/)\n"
15 "Content-Type: text/plain; charset=UTF-8\n"
16 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=1; plural=0\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-win-reg.pl:35 ../tools/virt-list-filesystems.pl:30
24 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
25 #: ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
36 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
37 #: ../tools/virt-win-reg.pl:39 ../tools/virt-list-filesystems.pl:34
38 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
39 #: ../tools/virt-list-partitions.pl:34
44 #: ../src/guestfs.pod:9
47 " #include <guestfs.h>\n"
52 #: ../src/guestfs.pod:11
55 " guestfs_h *g = guestfs_create ();\n"
56 " guestfs_add_drive (g, \"guest.img\");\n"
57 " guestfs_launch (g);\n"
58 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
59 " guestfs_touch (g, \"/hello\");\n"
60 " guestfs_umount (g, \"/\");\n"
61 " guestfs_close (g);\n"
66 #: ../src/guestfs.pod:19
69 " cc prog.c -o prog -lguestfs\n"
71 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
76 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
77 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
78 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
79 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
80 #: ../tools/virt-list-partitions.pl:40
85 #: ../src/guestfs.pod:25
87 "Libguestfs is a library for accessing and modifying guest disk images. "
88 "Amongst the things this is good for: making batch configuration changes to "
89 "guests, getting disk used/free statistics (see also: virt-df), migrating "
90 "between virtualization systems (see also: virt-p2v), performing partial "
91 "backups, performing partial guest clones, cloning guests and changing "
92 "registry/UUID/hostname info, and much else besides."
96 #: ../src/guestfs.pod:33
98 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest"
99 " filesystem that Linux and qemu can, including but not limited to: ext2/3/4,"
100 " btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
105 #: ../src/guestfs.pod:38
107 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
108 "what filesystem is in each LV, etc.). It can also run commands in the "
109 "context of the guest. Also you can access filesystems over FUSE."
113 #: ../src/guestfs.pod:43
115 "Libguestfs is a library that can be linked with C and C++ management "
116 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java,"
117 " PHP, Haskell or C#). You can also use it from shell scripts or the command"
122 #: ../src/guestfs.pod:48
124 "You don't need to be root to use libguestfs, although obviously you do need "
125 "enough permissions to access the disk images."
129 #: ../src/guestfs.pod:51
131 "Libguestfs is a large API because it can do many things. For a gentle "
132 "introduction, please read the L</API OVERVIEW> section next."
136 #: ../src/guestfs.pod:54
138 "There are also some example programs in the L<guestfs-examples(3)> manual "
143 #: ../src/guestfs.pod:57
148 #: ../src/guestfs.pod:59
150 "This section provides a gentler overview of the libguestfs API. We also try"
151 " to group API calls together, where that may not be obvious from reading "
152 "about the individual calls in the main section of this manual."
156 #: ../src/guestfs.pod:64
161 #: ../src/guestfs.pod:66
163 "Before you can use libguestfs calls, you have to create a handle. Then you "
164 "must add at least one disk image to the handle, followed by launching the "
165 "handle, then performing whatever operations you want, and finally closing "
166 "the handle. By convention we use the single letter C<g> for the name of the"
167 " handle variable, although of course you can use any name you want."
171 #: ../src/guestfs.pod:73
173 "The general structure of all libguestfs-using programs looks like this:"
177 #: ../src/guestfs.pod:76
180 " guestfs_h *g = guestfs_create ();\n"
185 #: ../src/guestfs.pod:78
188 " /* Call guestfs_add_drive additional times if there are\n"
189 " * multiple disk images.\n"
191 " guestfs_add_drive (g, \"guest.img\");\n"
196 #: ../src/guestfs.pod:83
199 " /* Most manipulation calls won't work until you've launched\n"
200 " * the handle 'g'. You have to do this _after_ adding drives\n"
201 " * and _before_ other commands.\n"
203 " guestfs_launch (g);\n"
208 #: ../src/guestfs.pod:89
211 " /* Now you can examine what partitions, LVs etc are available.\n"
213 " char **partitions = guestfs_list_partitions (g);\n"
214 " char **logvols = guestfs_lvs (g);\n"
219 #: ../src/guestfs.pod:94
222 " /* To access a filesystem in the image, you must mount it.\n"
224 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
229 #: ../src/guestfs.pod:98
232 " /* Now you can perform filesystem actions on the guest\n"
235 " guestfs_touch (g, \"/hello\");\n"
240 #: ../src/guestfs.pod:103
243 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
244 " * it is done automatically when you close the handle. See\n"
245 " * discussion of autosync in this page.\n"
247 " guestfs_sync (g);\n"
252 #: ../src/guestfs.pod:109
255 " /* Close the handle 'g'. */\n"
256 " guestfs_close (g);\n"
261 #: ../src/guestfs.pod:112
263 "The code above doesn't include any error checking. In real code you should "
264 "check return values carefully for errors. In general all functions that "
265 "return integers return C<-1> on error, and all functions that return "
266 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
267 "how to handle errors, and consult the documentation for each function call "
268 "below to see precisely how they return error indications. See L<guestfs-"
269 "examples(3)> for fully worked examples."
273 #: ../src/guestfs.pod:121
278 #: ../src/guestfs.pod:123
280 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
281 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
282 "actual block device, or simply an empty file of zeroes that you have created"
283 " through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all"
288 #: ../src/guestfs.pod:129
290 "The call you should use in modern code for adding drives is "
291 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
292 "specifying that the format is raw, do:"
296 #: ../src/guestfs.pod:133
299 " guestfs_add_drive_opts (g, filename,\n"
300 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
306 #: ../src/guestfs.pod:137
307 msgid "You can add a disk read-only using:"
311 #: ../src/guestfs.pod:139
314 " guestfs_add_drive_opts (g, filename,\n"
315 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
316 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
322 #: ../src/guestfs.pod:144
324 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
325 "libguestfs won't modify the file."
329 #: ../src/guestfs.pod:147
331 "Be extremely cautious if the disk image is in use, eg. if it is being used "
332 "by a virtual machine. Adding it read-write will almost certainly cause disk"
333 " corruption, but adding it read-only is safe."
337 #: ../src/guestfs.pod:151
339 "You must add at least one disk image, and you may add multiple disk images."
340 " In the API, the disk images are usually referred to as C</dev/sda> (for "
341 "the first one you added), C</dev/sdb> (for the second one you added), etc."
345 #: ../src/guestfs.pod:156
347 "Once L</guestfs_launch> has been called you cannot add any more images. You"
348 " can call L</guestfs_list_devices> to get a list of the device names, in the"
349 " order that you added them. See also L</BLOCK DEVICE NAMING> below."
353 #: ../src/guestfs.pod:161
358 #: ../src/guestfs.pod:163
360 "Before you can read or write files, create directories and so on in a disk "
361 "image that contains filesystems, you have to mount those filesystems using "
362 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that"
363 " a disk image contains (for example) one partition with a filesystem on that"
364 " partition, then you can mount it directly:"
368 #: ../src/guestfs.pod:170
371 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
376 #: ../src/guestfs.pod:172
378 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
379 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
380 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
381 "that these are libguestfs virtual devices, and are nothing to do with host "
386 #: ../src/guestfs.pod:178
388 "If you are given a disk image and you don't know what it contains then you "
389 "have to find out. Libguestfs can do that too: use "
390 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
391 "and LVs, and either try mounting each to see what is mountable, or else "
392 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
393 "filesystems, use L</guestfs_list_filesystems>."
397 #: ../src/guestfs.pod:186
399 "Libguestfs also has a set of APIs for inspection of unknown disk images (see"
400 " L</INSPECTION> below). But you might find it easier to look at higher "
401 "level programs built on top of libguestfs, in particular L<virt-"
406 #: ../src/guestfs.pod:191
408 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
409 "several other variations of the C<guestfs_mount_*> call."
413 #: ../src/guestfs.pod:194
414 msgid "FILESYSTEM ACCESS AND MODIFICATION"
418 #: ../src/guestfs.pod:196
420 "The majority of the libguestfs API consists of fairly low-level calls for "
421 "accessing and modifying the files, directories, symlinks etc on mounted "
422 "filesystems. There are over a hundred such calls which you can find listed "
423 "in detail below in this man page, and we don't even pretend to cover them "
424 "all in this overview."
428 #: ../src/guestfs.pod:202
430 "Specify filenames as full paths, starting with C<\"/\"> and including the "
435 #: ../src/guestfs.pod:205
437 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
438 "the file called C<\"etc/passwd\"> then you could do:"
442 #: ../src/guestfs.pod:208
445 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
450 #: ../src/guestfs.pod:210
452 "This would return C<data> as a newly allocated buffer containing the full "
453 "content of that file (with some conditions: see also L</DOWNLOADING> below),"
454 " or C<NULL> if there was an error."
458 #: ../src/guestfs.pod:214
460 "As another example, to create a top-level directory on that filesystem "
461 "called C<\"var\"> you would do:"
465 #: ../src/guestfs.pod:217
468 " guestfs_mkdir (g, \"/var\");\n"
473 #: ../src/guestfs.pod:219
474 msgid "To create a symlink you could do:"
478 #: ../src/guestfs.pod:221
481 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
482 " \"/etc/rc3.d/S30portmap\");\n"
487 #: ../src/guestfs.pod:224
489 "Libguestfs will reject attempts to use relative paths and there is no "
490 "concept of a current working directory."
494 #: ../src/guestfs.pod:227
496 "Libguestfs can return errors in many situations: for example if the "
497 "filesystem isn't writable, or if a file or directory that you requested "
498 "doesn't exist. If you are using the C API (documented here) you have to "
499 "check for those error conditions after each call. (Other language bindings "
500 "turn these errors into exceptions)."
504 #: ../src/guestfs.pod:233
506 "File writes are affected by the per-handle umask, set by calling "
507 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
511 #: ../src/guestfs.pod:236
516 #: ../src/guestfs.pod:238
518 "Libguestfs contains API calls to read, create and modify partition tables on"
523 #: ../src/guestfs.pod:241
525 "In the common case where you want to create a single partition covering the "
526 "whole disk, you should use the L</guestfs_part_disk> call:"
530 #: ../src/guestfs.pod:245
533 " const char *parttype = \"mbr\";\n"
534 " if (disk_is_larger_than_2TB)\n"
535 " parttype = \"gpt\";\n"
536 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
541 #: ../src/guestfs.pod:250
543 "Obviously this effectively wipes anything that was on that disk image "
548 #: ../src/guestfs.pod:253
553 #: ../src/guestfs.pod:255
555 "Libguestfs provides access to a large part of the LVM2 API, such as "
556 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
557 "unless you familiarize yourself with the concepts of physical volumes, "
558 "volume groups and logical volumes."
562 #: ../src/guestfs.pod:260
564 "This author strongly recommends reading the LVM HOWTO, online at "
565 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
569 #: ../src/guestfs.pod:263
574 #: ../src/guestfs.pod:265
576 "Use L</guestfs_cat> to download small, text only files. This call is "
577 "limited to files which are less than 2 MB and which cannot contain any ASCII"
578 " NUL (C<\\0>) characters. However the API is very simple to use."
582 #: ../src/guestfs.pod:269
584 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
585 "bit data, since it returns a (pointer, size) pair. However it is still "
586 "limited to \"small\" files, less than 2 MB."
590 #: ../src/guestfs.pod:273
592 "L</guestfs_download> can be used to download any file, with no limits on "
593 "content or size (even files larger than 4 GB)."
597 #: ../src/guestfs.pod:276
599 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
603 #: ../src/guestfs.pod:279
608 #: ../src/guestfs.pod:281
610 "It's often the case that you want to write a file or files to the disk "
615 #: ../src/guestfs.pod:284
617 "To write a small file with fixed content, use L</guestfs_write>. To create "
618 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
619 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
620 "variety of other functions for creating test files, for example "
621 "L</guestfs_fill> and L</guestfs_fill_pattern>."
625 #: ../src/guestfs.pod:290
627 "To upload a single file, use L</guestfs_upload>. This call has no limits on"
628 " file content or size (even files larger than 4 GB)."
632 #: ../src/guestfs.pod:293
634 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
638 #: ../src/guestfs.pod:295
640 "However the fastest way to upload I<large numbers of arbitrary files> is to "
641 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
642 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add"
643 " the drive in a predictable way (eg. adding it last after all other drives) "
644 "then you can get the device name from L</guestfs_list_devices> and mount it "
645 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
646 "sometimes non-portable between kernel versions, and they don't support "
647 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
648 "using a label or UUID, use an ISO image instead."
652 #: ../src/guestfs.pod:306
657 #: ../src/guestfs.pod:308
659 "There are various different commands for copying between files and devices "
660 "and in and out of the guest filesystem. These are summarised in the table "
665 #: ../src/guestfs.pod:314
666 msgid "B<file> to B<file>"
670 #: ../src/guestfs.pod:316
672 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
673 "directories recursively."
677 #: ../src/guestfs.pod:319
678 msgid "B<file or device> to B<file or device>"
682 #: ../src/guestfs.pod:321
684 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and"
685 " devices in the guest."
689 #: ../src/guestfs.pod:324
690 msgid "Example: duplicate the contents of an LV:"
694 #: ../src/guestfs.pod:326
697 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
702 #: ../src/guestfs.pod:328
704 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
705 "(C</dev/VG/Original>). To copy less than the whole source device, use "
706 "L</guestfs_copy_size>."
710 #: ../src/guestfs.pod:332
711 msgid "B<file on the host> to B<file or device>"
715 #: ../src/guestfs.pod:334
716 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
720 #: ../src/guestfs.pod:336
721 msgid "B<file or device> to B<file on the host>"
725 #: ../src/guestfs.pod:338
726 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
730 #: ../src/guestfs.pod:342
731 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
735 #: ../src/guestfs.pod:344
737 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
738 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
739 "appears you can only upload and download to files. However many Un*x-like "
740 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
741 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
742 "stderr, and arbitrary file descriptor N."
746 #: ../src/guestfs.pod:352
747 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
751 #: ../src/guestfs.pod:355
754 " guestfs_download (g, filename, \"/dev/stdout\");\n"
759 #: ../src/guestfs.pod:357
760 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
764 #: ../src/guestfs.pod:359
768 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
769 " guestfs_tar_out (g, \"/\", devfd);\n"
774 #: ../src/guestfs.pod:363
775 msgid "LISTING FILES"
779 #: ../src/guestfs.pod:365
781 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
782 "L<guestfish(1)>-equivalent command C<ll>)."
786 #: ../src/guestfs.pod:368
788 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
789 "programs, as a flat list of strings."
793 #: ../src/guestfs.pod:371
795 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
796 "directory, plus additional information about each one. It is more "
797 "equivalent to using the L<readdir(3)> call on a local filesystem."
801 #: ../src/guestfs.pod:375
803 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
808 #: ../src/guestfs.pod:378
809 msgid "RUNNING COMMANDS"
813 #: ../src/guestfs.pod:380
815 "Although libguestfs is primarily an API for manipulating files inside guest "
816 "images, we also provide some limited facilities for running commands inside "
821 #: ../src/guestfs.pod:384
822 msgid "There are many limitations to this:"
826 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
827 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
828 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
829 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
830 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
831 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
832 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
833 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
834 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
835 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052
836 #: ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420
837 #: ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437
838 #: ../src/guestfs.pod:3011 ../src/guestfs.pod:3015 ../src/guestfs.pod:3019
839 #: ../src/guestfs.pod:3023 ../src/guestfs-actions.pod:15
840 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
841 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
842 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662
843 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670
844 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682
845 #: ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690
846 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704
847 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846
848 #: ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855
849 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921
850 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930
851 #: ../src/guestfs-actions.pod:2857 ../src/guestfs-actions.pod:2863
852 #: ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2878
853 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish.pod:445
854 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
855 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
856 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
857 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
858 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099
859 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
860 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119
861 #: ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127
862 #: ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141
863 #: ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235
864 #: ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244
865 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291
866 #: ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300
867 #: ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1939
868 #: ../fish/guestfish-actions.pod:1947 ../fish/guestfish-actions.pod:1954
869 #: ../fish/guestfish-actions.pod:1961 ../tools/virt-win-reg.pl:195
870 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
871 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
872 #: ../tools/virt-win-reg.pl:720
877 #: ../src/guestfs.pod:390
879 "The kernel version that the command runs under will be different from what "
884 #: ../src/guestfs.pod:395
886 "If the command needs to communicate with daemons, then most likely they "
891 #: ../src/guestfs.pod:400
892 msgid "The command will be running in limited memory."
896 #: ../src/guestfs.pod:404
898 "The network may not be available unless you enable it (see "
899 "L</guestfs_set_network>)."
903 #: ../src/guestfs.pod:409
904 msgid "Only supports Linux guests (not Windows, BSD, etc)."
908 #: ../src/guestfs.pod:413
910 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
914 #: ../src/guestfs.pod:418
916 "For SELinux guests, you may need to enable SELinux and load policy first. "
917 "See L</SELINUX> in this manpage."
921 #: ../src/guestfs.pod:423
923 "I<Security:> It is not safe to run commands from untrusted, possibly "
924 "malicious guests. These commands may attempt to exploit your program by "
925 "sending unexpected output. They could also try to exploit the Linux kernel "
926 "or qemu provided by the libguestfs appliance. They could use the network "
927 "provided by the libguestfs appliance to bypass ordinary network partitions "
928 "and firewalls. They could use the elevated privileges or different SELinux "
929 "context of your program to their advantage."
933 #: ../src/guestfs.pod:432
935 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
936 "(a script which runs when the guest next boots normally), and to have this "
937 "script run the commands you want in the normal context of the running guest,"
938 " network security and so on. For information about other security issues, "
943 #: ../src/guestfs.pod:440
945 "The two main API calls to run commands are L</guestfs_command> and "
946 "L</guestfs_sh> (there are also variations)."
950 #: ../src/guestfs.pod:443
952 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
953 "shell globs, redirections, etc will work."
957 #: ../src/guestfs.pod:446
958 msgid "CONFIGURATION FILES"
962 #: ../src/guestfs.pod:448
964 "To read and write configuration files in Linux guest filesystems, we "
965 "strongly recommend using Augeas. For example, Augeas understands how to "
966 "read and write, say, a Linux shadow password file or X.org configuration "
967 "file, and so avoids you having to write that code."
971 #: ../src/guestfs.pod:453
973 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't"
974 " document Augeas itself here because there is excellent documentation on the"
975 " L<http://augeas.net/> website."
979 #: ../src/guestfs.pod:457
981 "If you don't want to use Augeas (you fool!) then try calling "
982 "L</guestfs_read_lines> to get the file as a list of lines which you can "
987 #: ../src/guestfs.pod:461
992 #: ../src/guestfs.pod:463
994 "We support SELinux guests. To ensure that labeling happens correctly in "
995 "SELinux guests, you need to enable SELinux and load the guest's policy:"
999 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1000 #: ../src/guestfs.pod:2465
1005 #: ../src/guestfs.pod:471
1006 msgid "Before launching, do:"
1010 #: ../src/guestfs.pod:473
1013 " guestfs_set_selinux (g, 1);\n"
1018 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1019 #: ../src/guestfs.pod:2490
1024 #: ../src/guestfs.pod:477
1026 "After mounting the guest's filesystem(s), load the policy. This is best "
1027 "done by running the L<load_policy(8)> command in the guest itself:"
1031 #: ../src/guestfs.pod:481
1034 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1039 #: ../src/guestfs.pod:483
1041 "(Older versions of C<load_policy> require you to specify the name of the "
1046 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1051 #: ../src/guestfs.pod:488
1053 "Optionally, set the security context for the API. The correct security "
1054 "context to use can only be known by inspecting the guest. As an example:"
1058 #: ../src/guestfs.pod:492
1061 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1066 #: ../src/guestfs.pod:496
1067 msgid "This will work for running commands and editing existing files."
1071 #: ../src/guestfs.pod:498
1073 "When new files are created, you may need to label them explicitly, for "
1074 "example by running the external command C<restorecon pathname>."
1078 #: ../src/guestfs.pod:502
1083 #: ../src/guestfs.pod:504
1085 "Certain calls are affected by the current file mode creation mask (the "
1086 "\"umask\"). In particular ones which create files or directories, such as "
1087 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1088 "either the default mode that the file is created with or modifies the mode "
1093 #: ../src/guestfs.pod:510
1095 "The default umask is C<022>, so files are created with modes such as C<0644>"
1096 " and directories with C<0755>."
1100 #: ../src/guestfs.pod:513
1102 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1103 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1104 "L</guestfs_chmod> after creating each file or directory."
1108 #: ../src/guestfs.pod:517
1109 msgid "For more information about umask, see L<umask(2)>."
1113 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:825
1114 msgid "ENCRYPTED DISKS"
1118 #: ../src/guestfs.pod:521
1120 "Libguestfs allows you to access Linux guests which have been encrypted using"
1121 " whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1122 "standard. This includes nearly all whole disk encryption systems used by "
1123 "modern Linux guests."
1127 #: ../src/guestfs.pod:527
1129 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1130 "returns the string C<crypto_LUKS>)."
1134 #: ../src/guestfs.pod:530
1136 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1137 "will require the passphrase!"
1141 #: ../src/guestfs.pod:533
1143 "Opening a LUKS device creates a new device mapper device called "
1144 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1145 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1146 "decrypted from and encrypted to the underlying block device respectively."
1150 #: ../src/guestfs.pod:539
1152 "LVM volume groups on the device can be made visible by calling "
1153 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1154 "volume(s) can now be mounted in the usual way."
1158 #: ../src/guestfs.pod:543
1160 "Use the reverse process to close a LUKS device. Unmount any logical volumes"
1161 " on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1162 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1163 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1164 "underlying encrypted block device)."
1168 #: ../src/guestfs.pod:550
1173 #: ../src/guestfs.pod:552
1175 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1176 "contains operating systems, an install CD or a live CD. (These APIs used to"
1177 " be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since"
1178 " version 1.5.3 the most frequently used part of this library has been "
1179 "rewritten in C and moved into the core code)."
1183 #: ../src/guestfs.pod:559
1185 "Add all disks belonging to the unknown virtual machine and call "
1186 "L</guestfs_launch> in the usual way."
1190 #: ../src/guestfs.pod:562
1192 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls"
1193 " and certain heuristics, and returns a list of operating systems that were "
1194 "found. An empty list means none were found. A single element is the root "
1195 "filesystem of the operating system. For dual- or multi-boot guests, "
1196 "multiple roots can be returned, each one corresponding to a separate "
1197 "operating system. (Multi-boot virtual machines are extremely rare in the "
1198 "world of virtualization, but since this scenario can happen, we have built "
1199 "libguestfs to deal with it.)"
1203 #: ../src/guestfs.pod:571
1205 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1206 "to get additional details about that operating system. For example, call "
1207 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for"
1208 " Windows and Linux-based operating systems respectively."
1212 #: ../src/guestfs.pod:577
1214 "Un*x-like and Linux-based operating systems usually consist of several "
1215 "filesystems which are mounted at boot time (for example, a separate boot "
1216 "partition mounted on C</boot>). The inspection rules are able to detect how"
1217 " filesystems correspond to mount points. Call "
1218 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1219 "hash table like this example:"
1223 #: ../src/guestfs.pod:584
1226 " /boot => /dev/sda1\n"
1227 " / => /dev/vg_guest/lv_root\n"
1228 " /usr => /dev/vg_guest/lv_usr\n"
1233 #: ../src/guestfs.pod:588
1235 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1236 "filesystems as suggested."
1240 #: ../src/guestfs.pod:591
1242 "Be careful to mount filesystems in the right order (eg. C</> before "
1243 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1248 #: ../src/guestfs.pod:595
1250 "Inspection currently only works for some common operating systems. "
1251 "Contributors are welcome to send patches for other operating systems that we"
1252 " currently cannot detect."
1256 #: ../src/guestfs.pod:599
1258 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1259 "for more details. The L</guestfs_inspect_os> function just ignores any "
1260 "encrypted devices."
1264 #: ../src/guestfs.pod:603
1266 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1267 "inspection and caches the results in the guest handle. Subsequent calls to "
1268 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1269 "read the disks. If you change the content of the guest disks, you can redo "
1270 "inspection by calling L</guestfs_inspect_os> again. "
1271 "(L</guestfs_inspect_list_applications> works a little differently from the "
1272 "other calls and does read the disks. See documentation for that function "
1277 #: ../src/guestfs.pod:612
1278 msgid "INSPECTING INSTALL DISKS"
1282 #: ../src/guestfs.pod:614
1284 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1289 #: ../src/guestfs.pod:617
1291 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1292 "system, which currently can be C<installed> (a regular operating system) or "
1293 "C<installer> (some sort of install disk)."
1297 #: ../src/guestfs.pod:621
1299 "Further information is available about the operating system that can be "
1300 "installed using the regular inspection APIs like "
1301 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1306 #: ../src/guestfs.pod:626
1308 "Some additional information specific to installer disks is also available "
1309 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1310 "L</guestfs_inspect_is_multipart> calls."
1314 #: ../src/guestfs.pod:631
1315 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1319 #: ../src/guestfs.pod:633
1321 "Libguestfs can mount NTFS partitions. It does this using the L<http://www"
1322 ".ntfs-3g.org/> driver."
1326 #: ../src/guestfs.pod:636
1327 msgid "DRIVE LETTERS AND PATHS"
1331 #: ../src/guestfs.pod:638
1333 "DOS and Windows still use drive letters, and the filesystems are always "
1334 "treated as case insensitive by Windows itself, and therefore you might find "
1335 "a Windows configuration file referring to a path like "
1336 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1337 "that directory might be referred to as C</WINDOWS/System32>."
1341 #: ../src/guestfs.pod:644
1343 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1344 "L</guestfs_inspect_get_drive_mappings>)"
1348 #: ../src/guestfs.pod:647
1350 "Dealing with separator characters (backslash vs forward slash) is outside "
1351 "the scope of libguestfs, but usually a simple character replacement will "
1356 #: ../src/guestfs.pod:651
1358 "To resolve the case insensitivity of paths, call "
1359 "L</guestfs_case_sensitive_path>."
1363 #: ../src/guestfs.pod:654
1364 msgid "ACCESSING THE WINDOWS REGISTRY"
1368 #: ../src/guestfs.pod:656
1370 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1371 "files, through the library C<hivex> which is part of the libguestfs project "
1372 "although ships as a separate tarball. You have to locate and download the "
1373 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1374 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-"
1375 "win-reg(1)> for more help on this issue."
1379 #: ../src/guestfs.pod:664
1380 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1384 #: ../src/guestfs.pod:666
1386 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1387 "provide something which looks like a Linux symlink. The way it tries to do "
1388 "the rewriting is described here:"
1392 #: ../src/guestfs.pod:670
1394 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1399 #: ../src/guestfs.pod:672
1401 "The essential problem is that ntfs-3g simply does not have enough "
1402 "information to do a correct job. NTFS links can contain drive letters and "
1403 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1404 "It is almost certainly the case that libguestfs callers should ignore what "
1405 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1409 #: ../src/guestfs.pod:679
1411 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1412 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1413 "attribute, and read the raw reparse data from that (you can find the format "
1414 "documented in various places around the web)."
1418 #: ../src/guestfs.pod:684
1419 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1423 #: ../src/guestfs.pod:686
1425 "There are other useful extended attributes that can be read from ntfs-3g "
1426 "filesystems (using L</guestfs_getxattr>). See:"
1430 #: ../src/guestfs.pod:689
1432 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1436 #: ../src/guestfs.pod:691
1437 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1441 #: ../src/guestfs.pod:693
1443 "Although we don't want to discourage you from using the C API, we will "
1444 "mention here that the same API is also available in other languages."
1448 #: ../src/guestfs.pod:696
1450 "The API is broadly identical in all supported languages. This means that "
1451 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)>"
1452 " in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1453 "OCaml. In other words, a straightforward, predictable isomorphism between "
1458 #: ../src/guestfs.pod:702
1460 "Error messages are automatically transformed into exceptions if the language"
1465 #: ../src/guestfs.pod:705
1467 "We don't try to \"object orientify\" parts of the API in OO languages, "
1468 "although contributors are welcome to write higher level APIs above what we "
1469 "provide in their favourite languages if they wish."
1473 #: ../src/guestfs.pod:711
1478 #: ../src/guestfs.pod:713
1480 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1481 "identical to the C API. C++ classes and exceptions are not used."
1485 #: ../src/guestfs.pod:717
1490 #: ../src/guestfs.pod:719
1492 "The C# bindings are highly experimental. Please read the warnings at the "
1493 "top of C<csharp/Libguestfs.cs>."
1497 #: ../src/guestfs.pod:722
1502 #: ../src/guestfs.pod:724
1504 "This is the only language binding that is working but incomplete. Only "
1505 "calls which return simple integers have been bound in Haskell, and we are "
1506 "looking for help to complete this binding."
1510 #: ../src/guestfs.pod:728
1515 #: ../src/guestfs.pod:730
1517 "Full documentation is contained in the Javadoc which is distributed with "
1522 #: ../src/guestfs.pod:733
1527 #: ../src/guestfs.pod:735
1528 msgid "See L<guestfs-ocaml(3)>."
1532 #: ../src/guestfs.pod:737
1537 #: ../src/guestfs.pod:739
1538 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1542 #: ../src/guestfs.pod:741
1547 #: ../src/guestfs.pod:743
1549 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1550 "the php-libguestfs package for your distribution."
1554 #: ../src/guestfs.pod:746
1555 msgid "The PHP binding only works correctly on 64 bit machines."
1559 #: ../src/guestfs.pod:748
1564 #: ../src/guestfs.pod:750
1565 msgid "See L<guestfs-python(3)>."
1569 #: ../src/guestfs.pod:752
1574 #: ../src/guestfs.pod:754
1575 msgid "See L<guestfs-ruby(3)>."
1579 #: ../src/guestfs.pod:756
1580 msgid "B<shell scripts>"
1584 #: ../src/guestfs.pod:758
1585 msgid "See L<guestfish(1)>."
1589 #: ../src/guestfs.pod:762
1590 msgid "LIBGUESTFS GOTCHAS"
1594 #: ../src/guestfs.pod:764
1596 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1597 "system [...] that works in the way it is documented but is counterintuitive "
1598 "and almost invites mistakes.\""
1602 #: ../src/guestfs.pod:768
1604 "Since we developed libguestfs and the associated tools, there are several "
1605 "things we would have designed differently, but are now stuck with for "
1606 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0"
1607 " release, you can expect these to change. Beware of them."
1611 #: ../src/guestfs.pod:776
1612 msgid "Autosync / forgetting to sync."
1616 #: ../src/guestfs.pod:778
1618 "I<Update:> Autosync is enabled by default for all API users starting from "
1619 "libguestfs 1.5.24. This section only applies to older versions."
1623 #: ../src/guestfs.pod:781
1625 "When modifying a filesystem from C or another language, you B<must> unmount "
1626 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1627 "libguestfs handle. You can also call:"
1631 #: ../src/guestfs.pod:785
1634 " guestfs_set_autosync (g, 1);\n"
1639 #: ../src/guestfs.pod:787
1641 "to have the unmount/sync done automatically for you when the handle 'g' is "
1642 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1647 #: ../src/guestfs.pod:791
1649 "If you forget to do this, then it is entirely possible that your changes "
1650 "won't be written out, or will be partially written, or (very rarely) that "
1651 "you'll get disk corruption."
1655 #: ../src/guestfs.pod:795
1657 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1658 "guestfish scripts that forget to sync will work just fine, which can make "
1659 "this very puzzling if you are trying to debug a problem."
1663 #: ../src/guestfs.pod:799
1664 msgid "Mount option C<-o sync> should not be the default."
1668 #: ../src/guestfs.pod:801
1670 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly."
1671 " However C<-o sync> does not add any reliability benefit, but does have a "
1672 "very large performance impact."
1676 #: ../src/guestfs.pod:805
1678 "The work around is to use L</guestfs_mount_options> and set the mount "
1679 "options that you actually want to use."
1683 #: ../src/guestfs.pod:808
1684 msgid "Read-only should be the default."
1688 #: ../src/guestfs.pod:810
1690 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1691 "specify I<--rw> if you want to make changes to the image."
1695 #: ../src/guestfs.pod:813
1696 msgid "This would reduce the potential to corrupt live VM images."
1700 #: ../src/guestfs.pod:815
1702 "Note that many filesystems change the disk when you just mount and unmount, "
1703 "even if you didn't perform any writes. You need to use "
1704 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1708 #: ../src/guestfs.pod:819
1709 msgid "guestfish command line is hard to use."
1713 #: ../src/guestfs.pod:821
1715 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1716 "examination). It tries to run a guestfish command C<disk.img> which doesn't"
1717 " exist, so it fails. In earlier versions of guestfish the error message was"
1718 " also unintuitive, but we have corrected this since. Like the Bourne shell,"
1719 " we should have used C<guestfish -c command> to run commands."
1723 #: ../src/guestfs.pod:828
1724 msgid "guestfish megabyte modifiers don't work right on all commands"
1728 #: ../src/guestfs.pod:830
1730 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1731 "other modifiers). What guestfish actually does is to multiply the number "
1732 "part by the modifier part and pass the result to the C API. However this "
1733 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1734 "expecting some other unit (eg. megabytes)."
1738 #: ../src/guestfs.pod:837
1739 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1743 #: ../src/guestfs.pod:839
1746 " lvcreate LV VG 100M\n"
1751 #: ../src/guestfs.pod:841
1753 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1754 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1755 "megabytes * megabytes) logical volume. The error message you get from this "
1756 "is also a little obscure."
1760 #: ../src/guestfs.pod:846
1762 "This could be fixed in the generator by specially marking parameters and "
1763 "return values which take bytes or other units."
1767 #: ../src/guestfs.pod:849
1768 msgid "Ambiguity between devices and paths"
1772 #: ../src/guestfs.pod:851
1774 "There is a subtle ambiguity in the API between a device name (eg. "
1775 "C</dev/sdb2>) and a similar pathname. A file might just happen to be called"
1776 " C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1780 #: ../src/guestfs.pod:856
1782 "In the current API we usually resolve this ambiguity by having two separate "
1783 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1784 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1785 "detecting if the path supplied begins with C</dev/>."
1789 #: ../src/guestfs.pod:862
1791 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1792 "make paths/devices into structured names. One way to do this would be to "
1793 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1794 "aspect of grub. Another way would be to use a structured type, equivalent "
1795 "to this OCaml type:"
1799 #: ../src/guestfs.pod:868
1802 " type path = Path of string | Device of int | Partition of int * int\n"
1807 #: ../src/guestfs.pod:870
1808 msgid "which would allow you to pass arguments like:"
1812 #: ../src/guestfs.pod:872
1815 " Path \"/foo/bar\"\n"
1816 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1817 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1818 " Path \"/dev/sdb2\" (* not a device *)\n"
1823 #: ../src/guestfs.pod:877
1825 "As you can see there are still problems to resolve even with this "
1826 "representation. Also consider how it might work in guestfish."
1830 #: ../src/guestfs.pod:882
1831 msgid "KEYS AND PASSPHRASES"
1835 #: ../src/guestfs.pod:884
1837 "Certain libguestfs calls take a parameter that contains sensitive key "
1838 "material, passed in as a C string."
1842 #: ../src/guestfs.pod:887
1844 "In the future we would hope to change the libguestfs implementation so that "
1845 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1846 "swap. However this is I<not> done at the moment, because of the complexity "
1847 "of such an implementation."
1851 #: ../src/guestfs.pod:892
1853 "Therefore you should be aware that any key parameter you pass to libguestfs "
1854 "might end up being written out to the swap partition. If this is a concern,"
1855 " scrub the swap partition or don't use libguestfs on encrypted devices."
1859 #: ../src/guestfs.pod:897
1860 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1864 #: ../src/guestfs.pod:899
1866 "All high-level libguestfs actions are synchronous. If you want to use "
1867 "libguestfs asynchronously then you must create a thread."
1871 #: ../src/guestfs.pod:902
1873 "Only use the handle from a single thread. Either use the handle exclusively"
1874 " from one thread, or provide your own mutex so that two threads cannot issue"
1875 " calls on the same handle at the same time."
1879 #: ../src/guestfs.pod:906
1881 "See the graphical program guestfs-browser for one possible architecture for "
1882 "multithreaded programs using libvirt and libguestfs."
1886 #: ../src/guestfs.pod:909
1891 #: ../src/guestfs.pod:911
1893 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1898 #: ../src/guestfs.pod:914
1900 "By default it looks for these in the directory C<$libdir/guestfs> (eg. "
1901 "C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1905 #: ../src/guestfs.pod:917
1907 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH>"
1908 " to change the directories that libguestfs will search in. The value is a "
1909 "colon-separated list of paths. The current directory is I<not> searched "
1910 "unless the path contains an empty element or C<.>. For example "
1911 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1912 "then C</usr/lib/guestfs>."
1916 #: ../src/guestfs.pod:924
1917 msgid "QEMU WRAPPERS"
1921 #: ../src/guestfs.pod:926
1923 "If you want to compile your own qemu, run qemu from a non-standard location,"
1924 " or pass extra arguments to qemu, then you can write a shell-script wrapper "
1929 #: ../src/guestfs.pod:930
1931 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1932 "last command in the shell script (so that qemu replaces the shell and "
1933 "becomes the direct child of the libguestfs-using program). If you don't do "
1934 "this, then the qemu process won't be cleaned up correctly."
1938 #: ../src/guestfs.pod:935
1940 "Here is an example of a wrapper, where I have built my own copy of qemu from"
1945 #: ../src/guestfs.pod:938
1949 " qemudir=/home/rjones/d/qemu\n"
1950 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1955 #: ../src/guestfs.pod:942
1957 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1958 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1963 #: ../src/guestfs.pod:946
1966 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1971 #: ../src/guestfs.pod:948
1973 "Note that libguestfs also calls qemu with the -help and -version options in "
1974 "order to determine features."
1978 #: ../src/guestfs.pod:951
1979 msgid "ATTACHING TO RUNNING DAEMONS"
1983 #: ../src/guestfs.pod:953
1985 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1986 "babies. Use with caution."
1990 #: ../src/guestfs.pod:956
1992 "I<Note (2):> This section explains how to attach to a running daemon from a "
1993 "low level perspective. For most users, simply using virt tools such as "
1994 "L<guestfish(1)> with the I<--live> option will \"just work\"."
1998 #: ../src/guestfs.pod:960
1999 msgid "Using guestfs_set_attach_method"
2003 #: ../src/guestfs.pod:962
2005 "By calling L</guestfs_set_attach_method> you can change how the library "
2006 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
2007 "L</ARCHITECTURE> for some background)."
2011 #: ../src/guestfs.pod:966
2013 "The normal attach method is C<appliance>, where a small appliance is created"
2014 " containing the daemon, and then the library connects to this."
2018 #: ../src/guestfs.pod:969
2020 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2021 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2022 "daemon over the Unix domain socket."
2026 #: ../src/guestfs.pod:973
2028 "The normal use for this is to connect to a running virtual machine that "
2029 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2030 "files inside the live virtual machine."
2034 #: ../src/guestfs.pod:977
2035 msgid "Using guestfs_add_domain with live flag"
2039 #: ../src/guestfs.pod:979
2041 "L</guestfs_add_domain> provides some help for getting the correct attach "
2042 "method. If you pass the C<live> option to this function, then (if the "
2043 "virtual machine is running) it will examine the libvirt XML looking for a "
2044 "virtio-serial channel to connect to:"
2048 #: ../src/guestfs.pod:985
2055 " <channel type='unix'>\n"
2056 " <source mode='bind' path='/path/to/socket'/>\n"
2057 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2066 #: ../src/guestfs.pod:997
2068 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2069 "method to C<unix:/path/to/socket>."
2073 #: ../src/guestfs.pod:1000
2075 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2076 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2077 "to attach to and modify live virtual machines."
2081 #: ../src/guestfs.pod:1004
2083 "The virtual machine needs to have been set up beforehand so that it has the "
2084 "virtio-serial channel and so that guestfsd is running inside it."
2088 #: ../src/guestfs.pod:1008
2089 msgid "ABI GUARANTEE"
2093 #: ../src/guestfs.pod:1010
2095 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2096 "actions as outlined in this section. Although we will deprecate some "
2097 "actions, for example if they get replaced by newer calls, we will keep the "
2098 "old actions forever. This allows you the developer to program in confidence"
2099 " against the libguestfs API."
2103 #: ../src/guestfs.pod:1016
2104 msgid "BLOCK DEVICE NAMING"
2108 #: ../src/guestfs.pod:1018
2110 "In the kernel there is now quite a profusion of schemata for naming block "
2111 "devices (in this context, by I<block device> I mean a physical or virtual "
2112 "hard drive). The original Linux IDE driver used names starting with "
2113 "C</dev/hd*>. SCSI devices have historically used a different naming scheme,"
2114 " C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2115 "replacement for the old IDE driver (particularly for SATA devices) those "
2116 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2117 "machines with paravirtualized drivers. This has created several different "
2118 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2123 #: ../src/guestfs.pod:1030
2125 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2126 "Linux kernel to access block devices. We can run a variety of appliances "
2127 "based on a variety of Linux kernels."
2131 #: ../src/guestfs.pod:1034
2133 "This causes a problem for libguestfs because many API calls use device or "
2134 "partition names. Working scripts and the recipe (example) scripts that we "
2135 "make available over the internet could fail if the naming scheme changes."
2139 #: ../src/guestfs.pod:1039
2141 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2142 "Internally C</dev/sd*> names are translated, if necessary, to other names as"
2143 " required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any"
2144 " device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2148 #: ../src/guestfs.pod:1045
2150 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>,"
2151 " L</guestfs_list_partitions> and similar calls return the true names of the "
2152 "devices and partitions as known to the appliance."
2156 #: ../src/guestfs.pod:1050
2157 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2161 #: ../src/guestfs.pod:1052
2163 "Usually this translation is transparent. However in some (very rare) cases"
2164 " you may need to know the exact algorithm. Such cases include where you use"
2165 " L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2166 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2170 #: ../src/guestfs.pod:1058
2172 "The algorithm is applied only to I<parameters> which are known to be either "
2173 "device or partition names. Return values from functions such as "
2174 "L</guestfs_list_devices> are never changed."
2178 #: ../src/guestfs.pod:1066
2179 msgid "Is the string a parameter which is a device or partition name?"
2183 #: ../src/guestfs.pod:1070
2184 msgid "Does the string begin with C</dev/sd>?"
2188 #: ../src/guestfs.pod:1074
2190 "Does the named device exist? If so, we use that device. However if I<not> "
2191 "then we continue with this algorithm."
2195 #: ../src/guestfs.pod:1079
2196 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2200 #: ../src/guestfs.pod:1081
2201 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2205 #: ../src/guestfs.pod:1083
2206 msgid "If that named device exists, use it. If not, continue."
2210 #: ../src/guestfs.pod:1087
2211 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2215 #: ../src/guestfs.pod:1089
2216 msgid "If that named device exists, use it. If not, return an error."
2220 #: ../src/guestfs.pod:1093
2221 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2225 #: ../src/guestfs.pod:1095
2227 "Although the standard naming scheme and automatic translation is useful for "
2228 "simple programs and guestfish scripts, for larger programs it is best not to"
2229 " rely on this mechanism."
2233 #: ../src/guestfs.pod:1099
2235 "Where possible for maximum future portability programs using libguestfs "
2236 "should use these future-proof techniques:"
2240 #: ../src/guestfs.pod:1106
2242 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2243 "device names, and then use those names directly."
2247 #: ../src/guestfs.pod:1109
2249 "Since those device names exist by definition, they will never be translated."
2253 #: ../src/guestfs.pod:1114
2255 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2256 "filesystem labels."
2260 #: ../src/guestfs.pod:1119
2265 #: ../src/guestfs.pod:1121
2267 "This section discusses security implications of using libguestfs, "
2268 "particularly with untrusted or malicious guests or disk images."
2272 #: ../src/guestfs.pod:1124
2273 msgid "GENERAL SECURITY CONSIDERATIONS"
2277 #: ../src/guestfs.pod:1126
2279 "Be careful with any files or data that you download from a guest (by "
2280 "\"download\" we mean not just the L</guestfs_download> command but any "
2281 "command that reads files, filenames, directories or anything else from a "
2282 "disk image). An attacker could manipulate the data to fool your program "
2283 "into doing the wrong thing. Consider cases such as:"
2287 #: ../src/guestfs.pod:1136
2288 msgid "the data (file etc) not being present"
2292 #: ../src/guestfs.pod:1140
2293 msgid "being present but empty"
2297 #: ../src/guestfs.pod:1144
2298 msgid "being much larger than normal"
2302 #: ../src/guestfs.pod:1148
2303 msgid "containing arbitrary 8 bit data"
2307 #: ../src/guestfs.pod:1152
2308 msgid "being in an unexpected character encoding"
2312 #: ../src/guestfs.pod:1156
2313 msgid "containing homoglyphs."
2317 #: ../src/guestfs.pod:1160
2318 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2322 #: ../src/guestfs.pod:1162
2324 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2325 "(VFS) module can sometimes be escalated into exploits by deliberately "
2326 "creating a malicious, malformed filesystem. These exploits are very severe "
2327 "for two reasons. Firstly there are very many filesystem drivers in the "
2328 "kernel, and many of them are infrequently used and not much developer "
2329 "attention has been paid to the code. Linux userspace helps potential "
2330 "crackers by detecting the filesystem type and automatically choosing the "
2331 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2332 "the administrator. Secondly, a kernel-level exploit is like a local root "
2333 "exploit (worse in some ways), giving immediate and total access to the "
2334 "system right down to the hardware level."
2338 #: ../src/guestfs.pod:1175
2340 "That explains why you should never mount a filesystem from an untrusted "
2341 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2342 "inside a qemu virtual machine, usually running as a non-root user. The "
2343 "attacker would need to write a filesystem which first exploited the kernel, "
2344 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2345 "the libguestfs protocol, and finally to be as serious as the host kernel "
2346 "exploit it would need to escalate its privileges to root. This multi-step "
2347 "escalation, performed by a static piece of data, is thought to be extremely "
2348 "hard to do, although we never say 'never' about security issues."
2352 #: ../src/guestfs.pod:1186
2354 "In any case callers can reduce the attack surface by forcing the filesystem "
2355 "type when mounting (use L</guestfs_mount_vfs>)."
2359 #: ../src/guestfs.pod:1189
2360 msgid "PROTOCOL SECURITY"
2364 #: ../src/guestfs.pod:1191
2366 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a"
2367 " defined upper message size. However a program that uses libguestfs must "
2368 "also take care - for example you can write a program that downloads a binary"
2369 " from a disk image and executes it locally, and no amount of protocol "
2370 "security will save you from the consequences."
2374 #: ../src/guestfs.pod:1197
2375 msgid "INSPECTION SECURITY"
2379 #: ../src/guestfs.pod:1199
2381 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2382 "directly from the guest, and these could contain any 8 bit data. Callers "
2383 "should be careful to escape these before printing them to a structured file "
2384 "(for example, use HTML escaping if creating a web page)."
2388 #: ../src/guestfs.pod:1205
2390 "Guest configuration may be altered in unusual ways by the administrator of "
2391 "the virtual machine, and may not reflect reality (particularly for untrusted"
2392 " or actively malicious guests). For example we parse the hostname from "
2393 "configuration files like C</etc/sysconfig/network> that we find in the "
2394 "guest, but the guest administrator can easily manipulate these files to "
2395 "provide the wrong hostname."
2399 #: ../src/guestfs.pod:1213
2401 "The inspection API parses guest configuration using two external libraries: "
2402 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2403 "designed to be robust in the face of malicious data, although denial of "
2404 "service attacks are still possible, for example with oversized configuration"
2409 #: ../src/guestfs.pod:1219
2410 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2414 #: ../src/guestfs.pod:1221
2416 "Be very cautious about running commands from the guest. By running a "
2417 "command in the guest, you are giving CPU time to a binary that you do not "
2418 "control, under the same user account as the library, albeit wrapped in qemu "
2419 "virtualization. More information and alternatives can be found in the "
2420 "section L</RUNNING COMMANDS>."
2424 #: ../src/guestfs.pod:1227
2425 msgid "CVE-2010-3851"
2429 #: ../src/guestfs.pod:1229
2430 msgid "https://bugzilla.redhat.com/642934"
2434 #: ../src/guestfs.pod:1231
2436 "This security bug concerns the automatic disk format detection that qemu "
2437 "does on disk images."
2441 #: ../src/guestfs.pod:1234
2443 "A raw disk image is just the raw bytes, there is no header. Other disk "
2444 "images like qcow2 contain a special header. Qemu deals with this by looking"
2445 " for one of the known headers, and if none is found then assuming the disk "
2446 "image must be raw."
2450 #: ../src/guestfs.pod:1239
2452 "This allows a guest which has been given a raw disk image to write some "
2453 "other header. At next boot (or when the disk image is accessed by "
2454 "libguestfs) qemu would do autodetection and think the disk image format was,"
2455 " say, qcow2 based on the header written by the guest."
2459 #: ../src/guestfs.pod:1244
2461 "This in itself would not be a problem, but qcow2 offers many features, one "
2462 "of which is to allow a disk image to refer to another image (called the "
2463 "\"backing disk\"). It does this by placing the path to the backing disk "
2464 "into the qcow2 header. This path is not validated and could point to any "
2465 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2466 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2467 "control of the attacker."
2471 #: ../src/guestfs.pod:1252
2473 "In libguestfs this is rather hard to exploit except under two circumstances:"
2477 #: ../src/guestfs.pod:1259
2478 msgid "You have enabled the network or have opened the disk in write mode."
2482 #: ../src/guestfs.pod:1263
2484 "You are also running untrusted code from the guest (see L</RUNNING "
2489 #: ../src/guestfs.pod:1268
2491 "The way to avoid this is to specify the expected disk format when adding "
2492 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2493 "should always do this if the disk is raw format, and it's a good idea for "
2498 #: ../src/guestfs.pod:1273
2500 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2501 "format is fetched from libvirt and passed through."
2505 #: ../src/guestfs.pod:1276
2507 "For libguestfs tools, use the I<--format> command line parameter as "
2512 #: ../src/guestfs.pod:1279
2513 msgid "CONNECTION MANAGEMENT"
2517 #: ../src/guestfs.pod:1281
2522 #: ../src/guestfs.pod:1283
2524 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2525 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2526 "handle and release all resources used."
2530 #: ../src/guestfs.pod:1287
2532 "For information on using multiple handles and threads, see the section "
2533 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2537 #: ../src/guestfs.pod:1290
2538 msgid "guestfs_create"
2542 #: ../src/guestfs.pod:1292
2545 " guestfs_h *guestfs_create (void);\n"
2550 #: ../src/guestfs.pod:1294
2551 msgid "Create a connection handle."
2555 #: ../src/guestfs.pod:1296
2557 "On success this returns a non-NULL pointer to a handle. On error it returns"
2562 #: ../src/guestfs.pod:1299
2564 "You have to \"configure\" the handle after creating it. This includes "
2565 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2566 "handle at least once."
2570 #: ../src/guestfs.pod:1303
2571 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2575 #: ../src/guestfs.pod:1305
2577 "You may also want to configure error handling for the handle. See the "
2578 "L</ERROR HANDLING> section below."
2582 #: ../src/guestfs.pod:1308
2583 msgid "guestfs_close"
2587 #: ../src/guestfs.pod:1310
2590 " void guestfs_close (guestfs_h *g);\n"
2595 #: ../src/guestfs.pod:1312
2596 msgid "This closes the connection handle and frees up all resources used."
2600 #: ../src/guestfs.pod:1314
2602 "If autosync was set on the handle and the handle was launched, then this "
2603 "implicitly calls various functions to unmount filesystems and sync the disk."
2604 " See L</guestfs_set_autosync> for more details."
2608 #: ../src/guestfs.pod:1318
2609 msgid "If a close callback was set on the handle, then it is called."
2613 #: ../src/guestfs.pod:1320
2614 msgid "ERROR HANDLING"
2618 #: ../src/guestfs.pod:1322
2620 "API functions can return errors. For example, almost all functions that "
2621 "return C<int> will return C<-1> to indicate an error."
2625 #: ../src/guestfs.pod:1325
2627 "Additional information is available for errors: an error message string and "
2628 "optionally an error number (errno) if the thing that failed was a system "
2633 #: ../src/guestfs.pod:1329
2635 "You can get at the additional information about the last error on the handle"
2636 " by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by "
2637 "setting up an error handler with L</guestfs_set_error_handler>."
2641 #: ../src/guestfs.pod:1334
2643 "When the handle is created, a default error handler is installed which "
2644 "prints the error message string to C<stderr>. For small short-running "
2645 "command line programs it is sufficient to do:"
2649 #: ../src/guestfs.pod:1338
2652 " if (guestfs_launch (g) == -1)\n"
2653 " exit (EXIT_FAILURE);\n"
2658 #: ../src/guestfs.pod:1341
2660 "since the default error handler will ensure that an error message has been "
2661 "printed to C<stderr> before the program exits."
2665 #: ../src/guestfs.pod:1344
2667 "For other programs the caller will almost certainly want to install an "
2668 "alternate error handler or do error handling in-line like this:"
2672 #: ../src/guestfs.pod:1347
2675 " g = guestfs_create ();\n"
2680 #: ../src/guestfs.pod:1349
2683 " /* This disables the default behaviour of printing errors\n"
2685 " guestfs_set_error_handler (g, NULL, NULL);\n"
2690 #: ../src/guestfs.pod:1353
2693 " if (guestfs_launch (g) == -1) {\n"
2694 " /* Examine the error message and print it etc. */\n"
2695 " char *msg = guestfs_last_error (g);\n"
2696 " int errnum = guestfs_last_errno (g);\n"
2697 " fprintf (stderr, \"%s\\n\", msg);\n"
2704 #: ../src/guestfs.pod:1361
2706 "Out of memory errors are handled differently. The default action is to call"
2707 " L<abort(3)>. If this is undesirable, then you can set a handler using "
2708 "L</guestfs_set_out_of_memory_handler>."
2712 #: ../src/guestfs.pod:1365
2714 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2715 "because there is no handle if this happens there is no way to get additional"
2716 " error information. However L</guestfs_create> is supposed to be a "
2717 "lightweight operation which can only fail because of insufficient memory (it"
2718 " returns NULL in this case)."
2722 #: ../src/guestfs.pod:1371
2723 msgid "guestfs_last_error"
2727 #: ../src/guestfs.pod:1373
2730 " const char *guestfs_last_error (guestfs_h *g);\n"
2735 #: ../src/guestfs.pod:1375
2737 "This returns the last error message that happened on C<g>. If there has not"
2738 " been an error since the handle was created, then this returns C<NULL>."
2742 #: ../src/guestfs.pod:1379
2744 "The lifetime of the returned string is until the next error occurs, or "
2745 "L</guestfs_close> is called."
2749 #: ../src/guestfs.pod:1382
2750 msgid "guestfs_last_errno"
2754 #: ../src/guestfs.pod:1384
2757 " int guestfs_last_errno (guestfs_h *g);\n"
2762 #: ../src/guestfs.pod:1386
2763 msgid "This returns the last error number (errno) that happened on C<g>."
2767 #: ../src/guestfs.pod:1388
2768 msgid "If successful, an errno integer not equal to zero is returned."
2772 #: ../src/guestfs.pod:1390
2774 "If no error, this returns 0. This call can return 0 in three situations:"
2778 #: ../src/guestfs.pod:1397
2779 msgid "There has not been any error on the handle."
2783 #: ../src/guestfs.pod:1401
2785 "There has been an error but the errno was meaningless. This corresponds to "
2786 "the case where the error did not come from a failed system call, but for "
2787 "some other reason."
2791 #: ../src/guestfs.pod:1407
2793 "There was an error from a failed system call, but for some reason the errno "
2794 "was not captured and returned. This usually indicates a bug in libguestfs."
2798 #: ../src/guestfs.pod:1413
2800 "Libguestfs tries to convert the errno from inside the applicance into a "
2801 "corresponding errno for the caller (not entirely trivial: the appliance "
2802 "might be running a completely different operating system from the library "
2803 "and error numbers are not standardized across Un*xen). If this could not be"
2804 " done, then the error is translated to C<EINVAL>. In practice this should "
2805 "only happen in very rare circumstances."
2809 #: ../src/guestfs.pod:1421
2810 msgid "guestfs_set_error_handler"
2814 #: ../src/guestfs.pod:1423
2817 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2819 " const char *msg);\n"
2820 " void guestfs_set_error_handler (guestfs_h *g,\n"
2821 " guestfs_error_handler_cb cb,\n"
2827 #: ../src/guestfs.pod:1430
2829 "The callback C<cb> will be called if there is an error. The parameters "
2830 "passed to the callback are an opaque data pointer and the error message "
2835 #: ../src/guestfs.pod:1434
2837 "C<errno> is not passed to the callback. To get that the callback must call "
2838 "L</guestfs_last_errno>."
2842 #: ../src/guestfs.pod:1437
2844 "Note that the message string C<msg> is freed as soon as the callback "
2845 "function returns, so if you want to stash it somewhere you must make your "
2850 #: ../src/guestfs.pod:1441
2851 msgid "The default handler prints messages on C<stderr>."
2855 #: ../src/guestfs.pod:1443
2856 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2860 #: ../src/guestfs.pod:1445
2861 msgid "guestfs_get_error_handler"
2865 #: ../src/guestfs.pod:1447
2868 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2869 " void **opaque_rtn);\n"
2874 #: ../src/guestfs.pod:1450
2875 msgid "Returns the current error handler callback."
2879 #: ../src/guestfs.pod:1452
2880 msgid "guestfs_set_out_of_memory_handler"
2884 #: ../src/guestfs.pod:1454
2887 " typedef void (*guestfs_abort_cb) (void);\n"
2888 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2889 " guestfs_abort_cb);\n"
2894 #: ../src/guestfs.pod:1458
2896 "The callback C<cb> will be called if there is an out of memory situation. "
2897 "I<Note this callback must not return>."
2901 #: ../src/guestfs.pod:1461
2902 msgid "The default is to call L<abort(3)>."
2906 #: ../src/guestfs.pod:1463
2908 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2912 #: ../src/guestfs.pod:1466
2913 msgid "guestfs_get_out_of_memory_handler"
2917 #: ../src/guestfs.pod:1468
2920 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2925 #: ../src/guestfs.pod:1470
2926 msgid "This returns the current out of memory handler."
2930 #: ../src/guestfs.pod:1472
2935 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1068
2940 #: ../src/guestfs.pod:1476
2945 #: ../src/guestfs.pod:1478
2950 #: ../src/guestfs.pod:1480
2951 msgid "AVAILABILITY"
2955 #: ../src/guestfs.pod:1482
2956 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2960 #: ../src/guestfs.pod:1484
2962 "Using L</guestfs_available> you can test availability of the following "
2963 "groups of functions. This test queries the appliance to see if the "
2964 "appliance you are currently using supports the functionality."
2968 #: ../src/guestfs.pod:1489
2969 msgid "@AVAILABILITY@"
2973 #: ../src/guestfs.pod:1491
2974 msgid "GUESTFISH supported COMMAND"
2978 #: ../src/guestfs.pod:1493
2980 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2981 "prints out the available groups and whether they are supported by this build"
2982 " of libguestfs. Note however that you have to do C<run> first."
2986 #: ../src/guestfs.pod:1498
2987 msgid "SINGLE CALLS AT COMPILE TIME"
2991 #: ../src/guestfs.pod:1500
2993 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2994 "function, such as:"
2998 #: ../src/guestfs.pod:1503
3001 " #define LIBGUESTFS_HAVE_DD 1\n"
3006 #: ../src/guestfs.pod:1505
3007 msgid "if L</guestfs_dd> is available."
3011 #: ../src/guestfs.pod:1507
3013 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3014 "function is available at compile time, we recommended using build tools such"
3015 " as autoconf or cmake. For example in autotools you could use:"
3019 #: ../src/guestfs.pod:1512
3022 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3023 " AC_CHECK_FUNCS([guestfs_dd])\n"
3028 #: ../src/guestfs.pod:1515
3030 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined"
3035 #: ../src/guestfs.pod:1518
3036 msgid "SINGLE CALLS AT RUN TIME"
3040 #: ../src/guestfs.pod:1520
3042 "Testing at compile time doesn't guarantee that a function really exists in "
3043 "the library. The reason is that you might be dynamically linked against a "
3044 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3045 "This situation unfortunately results in a segmentation fault, which is a "
3046 "shortcoming of the C dynamic linking system itself."
3050 #: ../src/guestfs.pod:1527
3052 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3053 "in this example program (note that you still need the compile time check as "
3058 #: ../src/guestfs.pod:1531
3061 " #include <stdio.h>\n"
3062 " #include <stdlib.h>\n"
3063 " #include <unistd.h>\n"
3064 " #include <dlfcn.h>\n"
3065 " #include <guestfs.h>\n"
3070 #: ../src/guestfs.pod:1537
3075 " #ifdef LIBGUESTFS_HAVE_DD\n"
3077 " int has_function;\n"
3082 #: ../src/guestfs.pod:1543
3085 " /* Test if the function guestfs_dd is really available. */\n"
3086 " dl = dlopen (NULL, RTLD_LAZY);\n"
3088 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3089 " exit (EXIT_FAILURE);\n"
3091 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3097 #: ../src/guestfs.pod:1552
3100 " if (!has_function)\n"
3101 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3103 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3104 " /* Now it's safe to call\n"
3105 " guestfs_dd (g, \"foo\", \"bar\");\n"
3109 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3116 #: ../src/guestfs.pod:1565
3118 "You may think the above is an awful lot of hassle, and it is. There are "
3119 "other ways outside of the C linking system to ensure that this kind of "
3120 "incompatibility never arises, such as using package versioning:"
3124 #: ../src/guestfs.pod:1570
3127 " Requires: libguestfs >= 1.0.80\n"
3132 #: ../src/guestfs.pod:1572
3133 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3137 #: ../src/guestfs.pod:1574
3139 "A recent feature of the API is the introduction of calls which take optional"
3140 " arguments. In C these are declared 3 ways. The main way is as a call "
3141 "which takes variable arguments (ie. C<...>), as in this example:"
3145 #: ../src/guestfs.pod:1579
3148 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3153 #: ../src/guestfs.pod:1581
3155 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3156 "call with no optional arguments specified:"
3160 #: ../src/guestfs.pod:1584
3163 " guestfs_add_drive_opts (g, filename, -1);\n"
3168 #: ../src/guestfs.pod:1586
3169 msgid "With a single optional argument:"
3173 #: ../src/guestfs.pod:1588
3176 " guestfs_add_drive_opts (g, filename,\n"
3177 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3183 #: ../src/guestfs.pod:1592
3188 #: ../src/guestfs.pod:1594
3191 " guestfs_add_drive_opts (g, filename,\n"
3192 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3193 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3199 #: ../src/guestfs.pod:1599
3201 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3206 #: ../src/guestfs.pod:1602
3207 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3211 #: ../src/guestfs.pod:1604
3213 "The second variant has the same name with the suffix C<_va>, which works the"
3214 " same way but takes a C<va_list>. See the C manual for details. For the "
3215 "example function, this is declared:"
3219 #: ../src/guestfs.pod:1608
3222 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3228 #: ../src/guestfs.pod:1611
3229 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3233 #: ../src/guestfs.pod:1613
3235 "The third variant is useful where you need to construct these calls. You "
3236 "pass in a structure where you fill in the optional fields. The structure "
3237 "has a bitmask as the first element which you must set to indicate which "
3238 "fields you have filled in. For our example function the structure and call "
3243 #: ../src/guestfs.pod:1619
3246 " struct guestfs_add_drive_opts_argv {\n"
3247 " uint64_t bitmask;\n"
3249 " const char *format;\n"
3252 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3253 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3258 #: ../src/guestfs.pod:1628
3259 msgid "You could call it like this:"
3263 #: ../src/guestfs.pod:1630
3266 " struct guestfs_add_drive_opts_argv optargs = {\n"
3267 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3268 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3270 " .format = \"qcow2\"\n"
3276 #: ../src/guestfs.pod:1637
3279 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3284 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3285 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2853
3286 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
3287 #: ../fish/guestfish-actions.pod:1929 ../tools/virt-win-reg.pl:704
3292 #: ../src/guestfs.pod:1645
3294 "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3298 #: ../src/guestfs.pod:1650
3299 msgid "You do not need to fill in all fields of the structure."
3303 #: ../src/guestfs.pod:1654
3305 "There must be a one-to-one correspondence between fields of the structure "
3306 "that are filled in, and bits set in the bitmask."
3310 #: ../src/guestfs.pod:1659
3311 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3315 #: ../src/guestfs.pod:1661
3317 "In other languages, optional arguments are expressed in the way that is "
3318 "natural for that language. We refer you to the language-specific "
3319 "documentation for more details on that."
3323 #: ../src/guestfs.pod:1665
3324 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3328 #: ../src/guestfs.pod:1667
3329 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3333 #: ../src/guestfs.pod:1669
3335 "B<Note:> This section documents the generic event mechanism introduced in "
3336 "libguestfs 1.10, which you should use in new code if possible. The old "
3337 "functions C<guestfs_set_log_message_callback>, "
3338 "C<guestfs_set_subprocess_quit_callback>, "
3339 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3340 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3341 "page. Because of the ABI guarantee, the old functions continue to work."
3345 #: ../src/guestfs.pod:1678
3347 "Handles generate events when certain things happen, such as log messages "
3348 "being generated, progress messages during long-running operations, or the "
3349 "handle being closed. The API calls described below let you register a "
3350 "callback to be called when events happen. You can register multiple "
3351 "callbacks (for the same, different or overlapping sets of events), and "
3352 "individually remove callbacks. If callbacks are not removed, then they "
3353 "remain in force until the handle is closed."
3357 #: ../src/guestfs.pod:1686
3359 "In the current implementation, events are only generated synchronously: that"
3360 " means that events (and hence callbacks) can only happen while you are in "
3361 "the middle of making another libguestfs call. The callback is called in the"
3366 #: ../src/guestfs.pod:1691
3368 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3369 "unsigned integers, or a message buffer. Payloads are discussed later on."
3373 #: ../src/guestfs.pod:1695
3374 msgid "CLASSES OF EVENTS"
3378 #: ../src/guestfs.pod:1699
3379 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3383 #: ../src/guestfs.pod:1702
3385 "The callback function will be called while the handle is being closed "
3386 "(synchronously from L</guestfs_close>)."
3390 #: ../src/guestfs.pod:1705
3392 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3393 "handles that are open when the program exits. This means that this callback"
3394 " might be called indirectly from L<exit(3)>, which can cause unexpected "
3395 "problems in higher-level languages (eg. if your HLL interpreter has already "
3396 "been cleaned up by the time this is called, and if your callback then jumps "
3397 "into some HLL function)."
3401 #: ../src/guestfs.pod:1712
3403 "If no callback is registered: the handle is closed without any callback "
3408 #: ../src/guestfs.pod:1715
3409 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3413 #: ../src/guestfs.pod:1718
3415 "The callback function will be called when the child process quits, either "
3416 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3417 "corresponds to a transition from any state to the CONFIG state)."
3421 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3422 msgid "If no callback is registered: the event is ignored."
3426 #: ../src/guestfs.pod:1724
3427 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3431 #: ../src/guestfs.pod:1727
3433 "The callback function will be called when the child process becomes ready "
3434 "first time after it has been launched. (This corresponds to a transition "
3435 "from LAUNCHING to the READY state)."
3439 #: ../src/guestfs.pod:1733
3440 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3444 #: ../src/guestfs.pod:1736
3446 "Some long-running operations can generate progress messages. If this "
3447 "callback is registered, then it will be called each time a progress message "
3448 "is generated (usually two seconds after the operation started, and three "
3449 "times per second thereafter until it completes, although the frequency may "
3450 "change in future versions)."
3454 #: ../src/guestfs.pod:1742
3456 "The callback receives in the payload four unsigned 64 bit numbers which are "
3457 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3461 #: ../src/guestfs.pod:1745
3463 "The units of C<total> are not defined, although for some operations C<total>"
3464 " may relate in some way to the amount of data to be transferred (eg. in "
3465 "bytes or megabytes), and C<position> may be the portion which has been "
3470 #: ../src/guestfs.pod:1750
3471 msgid "The only defined and stable parts of the API are:"
3475 #: ../src/guestfs.pod:1756
3477 "The callback can display to the user some type of progress bar or indicator "
3478 "which shows the ratio of C<position>:C<total>."
3482 #: ../src/guestfs.pod:1761
3483 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3487 #: ../src/guestfs.pod:1765
3489 "If any progress notification is sent during a call, then a final progress "
3490 "notification is always sent when C<position> = C<total> (I<unless> the call "
3491 "fails with an error)."
3495 #: ../src/guestfs.pod:1769
3497 "This is to simplify caller code, so callers can easily set the progress "
3498 "indicator to \"100%\" at the end of the operation, without requiring special"
3499 " code to detect this case."
3503 #: ../src/guestfs.pod:1775
3505 "For some calls we are unable to estimate the progress of the call, but we "
3506 "can still generate progress messages to indicate activity. This is known as"
3507 " \"pulse mode\", and is directly supported by certain progress bar "
3508 "implementations (eg. GtkProgressBar)."
3512 #: ../src/guestfs.pod:1780
3514 "For these calls, zero or more progress messages are generated with "
3515 "C<position = 0> and C<total = 1>, followed by a final message with "
3516 "C<position = total = 1>."
3520 #: ../src/guestfs.pod:1784
3522 "As noted above, if the call fails with an error then the final message may "
3527 #: ../src/guestfs.pod:1789
3529 "The callback also receives the procedure number (C<proc_nr>) and serial "
3530 "number (C<serial>) of the call. These are only useful for debugging "
3531 "protocol issues, and the callback can normally ignore them. The callback "
3532 "may want to print these numbers in error messages or debugging messages."
3536 #: ../src/guestfs.pod:1795
3537 msgid "If no callback is registered: progress messages are discarded."
3541 #: ../src/guestfs.pod:1797
3542 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3546 #: ../src/guestfs.pod:1800
3548 "The callback function is called whenever a log message is generated by qemu,"
3549 " the appliance kernel, guestfsd (daemon), or utility programs."
3553 #: ../src/guestfs.pod:1803
3555 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3556 "(L</guestfs_launch>) then additional debug messages are generated."
3560 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3562 "If no callback is registered: the messages are discarded unless the verbose "
3563 "flag is set in which case they are sent to stderr. You can override the "
3564 "printing of verbose messages to stderr by setting up a callback."
3568 #: ../src/guestfs.pod:1811
3569 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3573 #: ../src/guestfs.pod:1814
3575 "The callback function is called whenever a log message is generated by the "
3576 "library part of libguestfs."
3580 #: ../src/guestfs.pod:1817
3582 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3583 "messages are generated."
3587 #: ../src/guestfs.pod:1825
3588 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3592 #: ../src/guestfs.pod:1828
3594 "The callback function is called whenever a trace message is generated. This"
3595 " only applies if the trace flag (L</guestfs_set_trace>) is set."
3599 #: ../src/guestfs.pod:1831
3601 "If no callback is registered: the messages are sent to stderr. You can "
3602 "override the printing of trace messages to stderr by setting up a callback."
3606 #: ../src/guestfs.pod:1837
3607 msgid "guestfs_set_event_callback"
3611 #: ../src/guestfs.pod:1839
3614 " int guestfs_set_event_callback (guestfs_h *g,\n"
3615 " guestfs_event_callback cb,\n"
3616 " uint64_t event_bitmask,\n"
3623 #: ../src/guestfs.pod:1845
3625 "This function registers a callback (C<cb>) for all event classes in the "
3630 #: ../src/guestfs.pod:1848
3632 "For example, to register for all log message events, you could call this "
3633 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>."
3634 " To register a single callback for all possible classes of events, use "
3635 "C<GUESTFS_EVENT_ALL>."
3639 #: ../src/guestfs.pod:1854
3640 msgid "C<flags> should always be passed as 0."
3644 #: ../src/guestfs.pod:1856
3646 "C<opaque> is an opaque pointer which is passed to the callback. You can use"
3647 " it for any purpose."
3651 #: ../src/guestfs.pod:1859
3653 "The return value is the event handle (an integer) which you can use to "
3654 "delete the callback (see below)."
3658 #: ../src/guestfs.pod:1862
3660 "If there is an error, this function returns C<-1>, and sets the error in the"
3661 " handle in the usual way (see L</guestfs_last_error> etc.)"
3665 #: ../src/guestfs.pod:1865
3667 "Callbacks remain in effect until they are deleted, or until the handle is "
3672 #: ../src/guestfs.pod:1868
3674 "In the case where multiple callbacks are registered for a particular event "
3675 "class, all of the callbacks are called. The order in which multiple "
3676 "callbacks are called is not defined."
3680 #: ../src/guestfs.pod:1872
3681 msgid "guestfs_delete_event_callback"
3685 #: ../src/guestfs.pod:1874
3688 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3693 #: ../src/guestfs.pod:1876
3695 "Delete a callback that was previously registered. C<event_handle> should be"
3696 " the integer that was returned by a previous call to "
3697 "C<guestfs_set_event_callback> on the same handle."
3701 #: ../src/guestfs.pod:1880
3702 msgid "guestfs_event_callback"
3706 #: ../src/guestfs.pod:1882
3709 " typedef void (*guestfs_event_callback) (\n"
3712 " uint64_t event,\n"
3713 " int event_handle,\n"
3715 " const char *buf, size_t buf_len,\n"
3716 " const uint64_t *array, size_t array_len);\n"
3721 #: ../src/guestfs.pod:1891
3723 "This is the type of the event callback function that you have to provide."
3727 #: ../src/guestfs.pod:1894
3729 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3730 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3731 "handle, and C<flags> which in the current API you should ignore."
3735 #: ../src/guestfs.pod:1898
3737 "The remaining parameters contain the event payload (if any). Each event may"
3738 " contain a payload, which usually relates to the event class, but for future"
3739 " proofing your code should be written to handle any payload for any event "
3744 #: ../src/guestfs.pod:1903
3746 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3747 "there is no message buffer). Note that this message buffer can contain "
3748 "arbitrary 8 bit data, including NUL bytes."
3752 #: ../src/guestfs.pod:1907
3754 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3755 "moment this is only used for progress messages."
3759 #: ../src/guestfs.pod:1910
3760 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3764 #: ../src/guestfs.pod:1912
3766 "One motivation for the generic event API was to allow GUI programs to "
3767 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3768 "unconditionally to C<stderr>."
3772 #: ../src/guestfs.pod:1916
3774 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3775 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3776 "messages are not events; you must capture error messages separately)."
3780 #: ../src/guestfs.pod:1921
3782 "Programs have to set up a callback to capture the classes of events of "
3787 #: ../src/guestfs.pod:1924
3791 " guestfs_set_event_callback\n"
3792 " (g, message_callback,\n"
3793 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3794 " GUESTFS_EVENT_TRACE,\n"
3795 " 0, NULL) == -1)\n"
3796 " if (eh == -1) {\n"
3797 " // handle error in the usual way\n"
3803 #: ../src/guestfs.pod:1934
3805 "The callback can then direct messages to the appropriate place. In this "
3806 "example, messages are directed to syslog:"
3810 #: ../src/guestfs.pod:1937
3814 " message_callback (\n"
3817 " uint64_t event,\n"
3818 " int event_handle,\n"
3820 " const char *buf, size_t buf_len,\n"
3821 " const uint64_t *array, size_t array_len)\n"
3823 " const int priority = LOG_USER|LOG_INFO;\n"
3824 " if (buf_len > 0)\n"
3825 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3831 #: ../src/guestfs.pod:1952
3832 msgid "CANCELLING LONG TRANSFERS"
3836 #: ../src/guestfs.pod:1954
3838 "Some operations can be cancelled by the caller while they are in progress. "
3839 "Currently only operations that involve uploading or downloading data can be "
3840 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
3841 "parameters in the generator)."
3845 #: ../src/guestfs.pod:1959
3846 msgid "guestfs_user_cancel"
3850 #: ../src/guestfs.pod:1961
3853 " void guestfs_user_cancel (guestfs_h *g);\n"
3858 #: ../src/guestfs.pod:1963
3860 "C<guestfs_user_cancel> cancels the current upload or download operation."
3864 #: ../src/guestfs.pod:1966
3866 "Unlike most other libguestfs calls, this function is signal safe and thread "
3867 "safe. You can call it from a signal handler or from another thread, without"
3868 " needing to do any locking."
3872 #: ../src/guestfs.pod:1970
3874 "The transfer that was in progress (if there is one) will stop shortly "
3875 "afterwards, and will return an error. The errno (see "
3876 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find"
3877 " out if the operation was cancelled or failed because of another error."
3881 #: ../src/guestfs.pod:1976
3883 "No cleanup is performed: for example, if a file was being uploaded then "
3884 "after cancellation there may be a partially uploaded file. It is the "
3885 "caller's responsibility to clean up if necessary."
3889 #: ../src/guestfs.pod:1980
3891 "There are two common places that you might call C<guestfs_user_cancel>."
3895 #: ../src/guestfs.pod:1982
3897 "In an interactive text-based program, you might call it from a C<SIGINT> "
3898 "signal handler so that pressing C<^C> cancels the current operation. (You "
3899 "also need to call L</guestfs_set_pgroup> so that child processes don't "
3900 "receive the C<^C> signal)."
3904 #: ../src/guestfs.pod:1987
3906 "In a graphical program, when the main thread is displaying a progress bar "
3907 "with a cancel button, wire up the cancel button to call this function."
3911 #: ../src/guestfs.pod:1991
3912 msgid "PRIVATE DATA AREA"
3916 #: ../src/guestfs.pod:1993
3918 "You can attach named pieces of private data to the libguestfs handle, fetch "
3919 "them by name, and walk over them, for the lifetime of the handle. This is "
3920 "called the private data area and is only available from the C API."
3924 #: ../src/guestfs.pod:1998
3925 msgid "To attach a named piece of data, use the following call:"
3929 #: ../src/guestfs.pod:2000
3932 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3937 #: ../src/guestfs.pod:2002
3939 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3940 "pointer (which can be C<NULL>). Any previous item with the same key is "
3945 #: ../src/guestfs.pod:2006
3947 "You can use any C<key> you want, but your key should I<not> start with an "
3948 "underscore character. Keys beginning with an underscore character are "
3949 "reserved for internal libguestfs purposes (eg. for implementing language "
3950 "bindings). It is recommended that you prefix the key with some unique "
3951 "string to avoid collisions with other users."
3955 #: ../src/guestfs.pod:2012
3956 msgid "To retrieve the pointer, use:"
3960 #: ../src/guestfs.pod:2014
3963 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3968 #: ../src/guestfs.pod:2016
3970 "This function returns C<NULL> if either no data is found associated with "
3971 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3976 #: ../src/guestfs.pod:2020
3978 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3979 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3980 "all. In particular, libguestfs does I<not> try to free the data when the "
3981 "handle is closed. If the data must be freed, then the caller must either "
3982 "free it before calling L</guestfs_close> or must set up a close callback to "
3983 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3987 #: ../src/guestfs.pod:2027
3988 msgid "To walk over all entries, use these two functions:"
3992 #: ../src/guestfs.pod:2029
3995 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4000 #: ../src/guestfs.pod:2031
4003 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4008 #: ../src/guestfs.pod:2033
4010 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does"
4011 " not have any particular meaning -- keys are not returned in any defined "
4012 "order). A pointer to the key is returned in C<*key_rtn> and the "
4013 "corresponding data pointer is returned from the function. C<NULL> is "
4014 "returned if there are no keys stored in the handle."
4018 #: ../src/guestfs.pod:2039
4020 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4021 "value of this function is also C<NULL> is there are no further entries to "
4026 #: ../src/guestfs.pod:2043
4027 msgid "Notes about walking over entries:"
4031 #: ../src/guestfs.pod:2049
4033 "You must not call C<guestfs_set_private> while walking over the entries."
4037 #: ../src/guestfs.pod:2054
4039 "The handle maintains an internal iterator which is reset when you call "
4040 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4041 "call C<guestfs_set_private>."
4045 #: ../src/guestfs.pod:2060
4046 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4050 #: ../src/guestfs.pod:2062
4053 " guestfs_set_private (g, key, NULL);\n"
4058 #: ../src/guestfs.pod:2064
4059 msgid "then that C<key> is not returned when walking."
4063 #: ../src/guestfs.pod:2068
4065 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4066 "C<guestfs_next_private> or C<guestfs_set_private>."
4070 #: ../src/guestfs.pod:2074
4072 "The following example code shows how to print all keys and data pointers "
4073 "that are associated with the handle C<g>:"
4077 #: ../src/guestfs.pod:2077
4080 " const char *key;\n"
4081 " void *data = guestfs_first_private (g, &key);\n"
4082 " while (data != NULL)\n"
4084 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4085 " data = guestfs_next_private (g, &key);\n"
4091 #: ../src/guestfs.pod:2085
4093 "More commonly you are only interested in keys that begin with an "
4094 "application-specific prefix C<foo_>. Modify the loop like so:"
4098 #: ../src/guestfs.pod:2088
4101 " const char *key;\n"
4102 " void *data = guestfs_first_private (g, &key);\n"
4103 " while (data != NULL)\n"
4105 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4106 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4107 " data = guestfs_next_private (g, &key);\n"
4113 #: ../src/guestfs.pod:2097
4115 "If you need to modify keys while walking, then you have to jump back to the "
4116 "beginning of the loop. For example, to delete all keys prefixed with "
4121 #: ../src/guestfs.pod:2101
4124 " const char *key;\n"
4127 " data = guestfs_first_private (g, &key);\n"
4128 " while (data != NULL)\n"
4130 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4132 " guestfs_set_private (g, key, NULL);\n"
4133 " /* note that 'key' pointer is now invalid, and so is\n"
4134 " the internal iterator */\n"
4137 " data = guestfs_next_private (g, &key);\n"
4143 #: ../src/guestfs.pod:2117
4145 "Note that the above loop is guaranteed to terminate because the keys are "
4146 "being deleted, but other manipulations of keys within the loop might not "
4147 "terminate unless you also maintain an indication of which keys have been "
4152 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
4157 #: ../src/guestfs.pod:2124
4159 "<!-- old anchor for the next section --> <a "
4160 "name=\"state_machine_and_low_level_event_api\"/>"
4164 #: ../src/guestfs.pod:2129
4165 msgid "ARCHITECTURE"
4169 #: ../src/guestfs.pod:2131
4171 "Internally, libguestfs is implemented by running an appliance (a special "
4172 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4173 "process of the main program."
4177 #: ../src/guestfs.pod:2135
4180 " ___________________\n"
4182 " | main program |\n"
4184 " | | child process / appliance\n"
4185 " | | __________________________\n"
4187 " +-------------------+ RPC | +-----------------+ |\n"
4188 " | libguestfs <--------------------> guestfsd | |\n"
4189 " | | | +-----------------+ |\n"
4190 " \\___________________/ | | Linux kernel | |\n"
4191 " | +--^--------------+ |\n"
4192 " \\_________|________________/\n"
4198 " \\______________/\n"
4203 #: ../src/guestfs.pod:2155
4205 "The library, linked to the main program, creates the child process and hence"
4206 " the appliance in the L</guestfs_launch> function."
4210 #: ../src/guestfs.pod:2158
4212 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4213 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4214 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4215 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs"
4216 " API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4217 "attached to the qemu process which translates device access by the "
4218 "appliance's Linux kernel into accesses to the image."
4222 #: ../src/guestfs.pod:2167
4224 "A common misunderstanding is that the appliance \"is\" the virtual machine."
4225 " Although the disk image you are attached to might also be used by some "
4226 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4227 "care if both libguestfs's qemu process and your virtual machine are trying "
4228 "to update the disk image at the same time, since these usually results in "
4229 "massive disk corruption)."
4233 #: ../src/guestfs.pod:2174
4234 msgid "STATE MACHINE"
4238 #: ../src/guestfs.pod:2176
4239 msgid "libguestfs uses a state machine to model the child process:"
4243 #: ../src/guestfs.pod:2178
4255 " / | \\ \\ guestfs_launch\n"
4256 " / | _\\__V______\n"
4258 " / | | LAUNCHING |\n"
4259 " / | \\___________/\n"
4261 " / | guestfs_launch\n"
4263 " ______ / __|____V\n"
4264 " / \\ ------> / \\\n"
4265 " | BUSY | | READY |\n"
4266 " \\______/ <------ \\________/\n"
4271 #: ../src/guestfs.pod:2200
4273 "The normal transitions are (1) CONFIG (when the handle is created, but there"
4274 " is no child process), (2) LAUNCHING (when the child process is booting up),"
4275 " (3) alternating between READY and BUSY as commands are issued to, and "
4276 "carried out by, the child process."
4280 #: ../src/guestfs.pod:2205
4282 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4283 "asynchronously at any time (eg. due to some internal error), and that causes"
4284 " the state to transition back to CONFIG."
4288 #: ../src/guestfs.pod:2209
4290 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4291 "issued when in the CONFIG state."
4295 #: ../src/guestfs.pod:2212
4297 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4298 "L</guestfs_launch> blocks until the child process is READY to accept "
4299 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4300 "moves the state from CONFIG to LAUNCHING while it is running."
4304 #: ../src/guestfs.pod:2218
4306 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4307 "state. These API calls block waiting for the command to be carried out (ie."
4308 " the state to transition to BUSY and then back to READY). There are no non-"
4309 "blocking versions, and no way to issue more than one command per handle at "
4314 #: ../src/guestfs.pod:2224
4316 "Finally, the child process sends asynchronous messages back to the main "
4317 "program, such as kernel log messages. You can register a callback to "
4318 "receive these messages."
4322 #: ../src/guestfs.pod:2228
4327 #: ../src/guestfs.pod:2230
4328 msgid "COMMUNICATION PROTOCOL"
4332 #: ../src/guestfs.pod:2232
4334 "Don't rely on using this protocol directly. This section documents how it "
4335 "currently works, but it may change at any time."
4339 #: ../src/guestfs.pod:2235
4341 "The protocol used to talk between the library and the daemon running inside "
4342 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4343 "1014, RFC 1832, RFC 4506)."
4347 #: ../src/guestfs.pod:2239
4349 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4350 "this file is automatically generated)."
4354 #: ../src/guestfs.pod:2242
4356 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4357 "and C<FileOut> parameters, which are handled with very simple request/reply "
4358 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4359 "parameters, which use the same request and reply messages, but they may also"
4360 " be followed by files sent using a chunked encoding."
4364 #: ../src/guestfs.pod:2249
4365 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4369 #: ../src/guestfs.pod:2251
4370 msgid "For ordinary functions, the request message is:"
4374 #: ../src/guestfs.pod:2253
4377 " total length (header + arguments,\n"
4378 " but not including the length word itself)\n"
4379 " struct guestfs_message_header (encoded as XDR)\n"
4380 " struct guestfs_<foo>_args (encoded as XDR)\n"
4385 #: ../src/guestfs.pod:2258
4387 "The total length field allows the daemon to allocate a fixed size buffer "
4388 "into which it slurps the rest of the message. As a result, the total length"
4389 " is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the"
4390 " effective size of any request is limited to somewhere under this size."
4394 #: ../src/guestfs.pod:2264
4396 "Note also that many functions don't take any arguments, in which case the "
4397 "C<guestfs_I<foo>_args> is completely omitted."
4401 #: ../src/guestfs.pod:2267
4403 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4404 "receiver knows what type of args structure to expect, or none at all."
4408 #: ../src/guestfs.pod:2271
4410 "For functions that take optional arguments, the optional arguments are "
4411 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4412 "arguments. A bitmask in the header indicates which optional arguments are "
4413 "meaningful. The bitmask is also checked to see if it contains bits set "
4414 "which the daemon does not know about (eg. if more optional arguments were "
4415 "added in a later version of the library), and this causes the call to be "
4420 #: ../src/guestfs.pod:2279
4421 msgid "The reply message for ordinary functions is:"
4425 #: ../src/guestfs.pod:2281
4428 " total length (header + ret,\n"
4429 " but not including the length word itself)\n"
4430 " struct guestfs_message_header (encoded as XDR)\n"
4431 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4436 #: ../src/guestfs.pod:2286
4438 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4439 "functions that return no formal return values."
4443 #: ../src/guestfs.pod:2289
4445 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4449 #: ../src/guestfs.pod:2292
4451 "In the case of an error, a flag is set in the header, and the reply message "
4452 "is slightly changed:"
4456 #: ../src/guestfs.pod:2295
4459 " total length (header + error,\n"
4460 " but not including the length word itself)\n"
4461 " struct guestfs_message_header (encoded as XDR)\n"
4462 " struct guestfs_message_error (encoded as XDR)\n"
4467 #: ../src/guestfs.pod:2300
4469 "The C<guestfs_message_error> structure contains the error message as a "
4474 #: ../src/guestfs.pod:2303
4475 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4479 #: ../src/guestfs.pod:2305
4481 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4482 "The normal request message is sent (see above). However this is followed by"
4483 " a sequence of file chunks."
4487 #: ../src/guestfs.pod:2309
4490 " total length (header + arguments,\n"
4491 " but not including the length word itself,\n"
4492 " and not including the chunks)\n"
4493 " struct guestfs_message_header (encoded as XDR)\n"
4494 " struct guestfs_<foo>_args (encoded as XDR)\n"
4495 " sequence of chunks for FileIn param #0\n"
4496 " sequence of chunks for FileIn param #1 etc.\n"
4501 #: ../src/guestfs.pod:2317
4502 msgid "The \"sequence of chunks\" is:"
4506 #: ../src/guestfs.pod:2319
4509 " length of chunk (not including length word itself)\n"
4510 " struct guestfs_chunk (encoded as XDR)\n"
4511 " length of chunk\n"
4512 " struct guestfs_chunk (encoded as XDR)\n"
4514 " length of chunk\n"
4515 " struct guestfs_chunk (with data.data_len == 0)\n"
4520 #: ../src/guestfs.pod:2327
4522 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4523 "is set in the final chunk to indicate either successful completion or early "
4528 #: ../src/guestfs.pod:2331
4530 "At time of writing there are no functions that have more than one FileIn "
4531 "parameter. However this is (theoretically) supported, by sending the "
4532 "sequence of chunks for each FileIn parameter one after another (from left to"
4537 #: ../src/guestfs.pod:2336
4539 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4540 "transfer. The library does this by sending a chunk with a special flag set "
4541 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4542 "RPC, does I<not> send any reply, and goes back to reading the next request."
4546 #: ../src/guestfs.pod:2342
4548 "The daemon may also cancel. It does this by writing a special word "
4549 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4550 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4551 "cancel chunk). The special word is chosen so that even if cancellation "
4552 "happens right at the end of the transfer (after the library has finished "
4553 "writing and has started listening for the reply), the \"spurious\" cancel "
4554 "flag will not be confused with the reply message."
4558 #: ../src/guestfs.pod:2351
4560 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4561 "limit), and also files where the size is not known in advance (eg. from "
4562 "pipes or sockets). However the chunks are rather small "
4563 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need"
4564 " to keep much in memory."
4568 #: ../src/guestfs.pod:2357
4569 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4573 #: ../src/guestfs.pod:2359
4575 "The protocol for FileOut parameters is exactly the same as for FileIn "
4576 "parameters, but with the roles of daemon and library reversed."
4580 #: ../src/guestfs.pod:2362
4583 " total length (header + ret,\n"
4584 " but not including the length word itself,\n"
4585 " and not including the chunks)\n"
4586 " struct guestfs_message_header (encoded as XDR)\n"
4587 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4588 " sequence of chunks for FileOut param #0\n"
4589 " sequence of chunks for FileOut param #1 etc.\n"
4594 #: ../src/guestfs.pod:2370
4595 msgid "INITIAL MESSAGE"
4599 #: ../src/guestfs.pod:2372
4601 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4602 "which indicates that the guest and daemon is alive. This is what "
4603 "L</guestfs_launch> waits for."
4607 #: ../src/guestfs.pod:2376
4608 msgid "PROGRESS NOTIFICATION MESSAGES"
4612 #: ../src/guestfs.pod:2378
4614 "The daemon may send progress notification messages at any time. These are "
4615 "distinguished by the normal length word being replaced by "
4616 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4620 #: ../src/guestfs.pod:2382
4622 "The library turns them into progress callbacks (see "
4623 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4628 #: ../src/guestfs.pod:2386
4630 "The daemon self-limits the frequency of progress messages it sends (see "
4631 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4636 #: ../src/guestfs.pod:2390
4637 msgid "LIBGUESTFS VERSION NUMBERS"
4641 #: ../src/guestfs.pod:2392
4643 "Since April 2010, libguestfs has started to make separate development and "
4644 "stable releases, along with corresponding branches in our git repository. "
4645 "These separate releases can be identified by version number:"
4649 #: ../src/guestfs.pod:2397
4652 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4653 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4659 " | `-------- sub-version\n"
4661 " `------ always '1' because we don't change the ABI\n"
4666 #: ../src/guestfs.pod:2408
4667 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4671 #: ../src/guestfs.pod:2410
4673 "As time passes we cherry pick fixes from the development branch and backport"
4674 " those into the stable branch, the effect being that the stable branch "
4675 "should get more stable and less buggy over time. So the stable releases are"
4676 " ideal for people who don't need new features but would just like the "
4681 #: ../src/guestfs.pod:2416
4682 msgid "Our criteria for backporting changes are:"
4686 #: ../src/guestfs.pod:2422
4688 "Documentation changes which don't affect any code are backported unless the "
4689 "documentation refers to a future feature which is not in stable."
4693 #: ../src/guestfs.pod:2428
4695 "Bug fixes which are not controversial, fix obvious problems, and have been "
4696 "well tested are backported."
4700 #: ../src/guestfs.pod:2433
4702 "Simple rearrangements of code which shouldn't affect how it works get "
4703 "backported. This is so that the code in the two branches doesn't get too "
4704 "far out of step, allowing us to backport future fixes more easily."
4708 #: ../src/guestfs.pod:2439
4710 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4711 "exceptional case: the new feature is required in order to implement an "
4712 "important bug fix."
4716 #: ../src/guestfs.pod:2445
4718 "A new stable branch starts when we think the new features in development are"
4719 " substantial and compelling enough over the current stable branch to warrant"
4720 " it. When that happens we create new stable and development versions 1.N.0 "
4721 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4722 "stable at this point, but by backporting fixes from development, that branch"
4723 " will stabilize over time."
4727 #: ../src/guestfs.pod:2453
4728 msgid "EXTENDING LIBGUESTFS"
4732 #: ../src/guestfs.pod:2455
4733 msgid "ADDING A NEW API ACTION"
4737 #: ../src/guestfs.pod:2457
4739 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4740 "documentation) are generated, and this makes it easy to extend the "
4745 #: ../src/guestfs.pod:2461
4746 msgid "To add a new API action there are two changes:"
4750 #: ../src/guestfs.pod:2467
4752 "You need to add a description of the call (name, parameters, return type, "
4753 "tests, documentation) to C<generator/generator_actions.ml>."
4757 #: ../src/guestfs.pod:2470
4759 "There are two sorts of API action, depending on whether the call goes "
4760 "through to the daemon in the appliance, or is serviced entirely by the "
4761 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the"
4762 " former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4763 "an example of the latter, since a trace flag is maintained in the handle and"
4764 " all tracing is done on the library side."
4768 #: ../src/guestfs.pod:2478
4770 "Most new actions are of the first type, and get added to the "
4771 "C<daemon_functions> list. Each function has a unique procedure number used "
4772 "in the RPC protocol which is assigned to that action when we publish "
4773 "libguestfs and cannot be reused. Take the latest procedure number and "
4778 #: ../src/guestfs.pod:2484
4780 "For library-only actions of the second type, add to the "
4781 "C<non_daemon_functions> list. Since these functions are serviced by the "
4782 "library and do not travel over the RPC mechanism to the daemon, these "
4783 "functions do not need a procedure number, and so the procedure number is set"
4788 #: ../src/guestfs.pod:2492
4789 msgid "Implement the action (in C):"
4793 #: ../src/guestfs.pod:2494
4795 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4796 "C<daemon/> directory."
4800 #: ../src/guestfs.pod:2497
4802 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4803 "(note: double underscore) in the C<src/> directory."
4807 #: ../src/guestfs.pod:2500
4808 msgid "In either case, use another function as an example of what to do."
4812 #: ../src/guestfs.pod:2504
4813 msgid "After making these changes, use C<make> to compile."
4817 #: ../src/guestfs.pod:2506
4819 "Note that you don't need to implement the RPC, language bindings, manual "
4820 "pages or anything else. It's all automatically generated from the OCaml "
4825 #: ../src/guestfs.pod:2510
4826 msgid "ADDING TESTS FOR AN API ACTION"
4830 #: ../src/guestfs.pod:2512
4832 "You can supply zero or as many tests as you want per API call. The tests "
4833 "can either be added as part of the API description "
4834 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4835 "drop a script into C<regressions/>. Note that adding a script to "
4836 "C<regressions/> is slower, so if possible use the first method."
4840 #: ../src/guestfs.pod:2518
4842 "The following describes the test environment used when you add an API test "
4843 "in C<generator_actions.ml>."
4847 #: ../src/guestfs.pod:2521
4848 msgid "The test environment has 4 block devices:"
4852 #: ../src/guestfs.pod:2525
4853 msgid "C</dev/sda> 500MB"
4857 #: ../src/guestfs.pod:2527
4858 msgid "General block device for testing."
4862 #: ../src/guestfs.pod:2529
4863 msgid "C</dev/sdb> 50MB"
4867 #: ../src/guestfs.pod:2531
4869 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4874 #: ../src/guestfs.pod:2534
4875 msgid "C</dev/sdc> 10MB"
4879 #: ../src/guestfs.pod:2536
4880 msgid "Used in a few tests where two block devices are needed."
4884 #: ../src/guestfs.pod:2538
4889 #: ../src/guestfs.pod:2540
4890 msgid "ISO with fixed content (see C<images/test.iso>)."
4894 #: ../src/guestfs.pod:2544
4896 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4897 "appliance and block devices are reused between tests. So don't try testing "
4898 "L</guestfs_kill_subprocess> :-x"
4902 #: ../src/guestfs.pod:2548
4904 "Each test starts with an initial scenario, selected using one of the "
4905 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4906 "initialize the disks mentioned above in a particular way as documented in "
4907 "C<generator_types.ml>. You should not assume anything about the previous "
4908 "contents of other disks that are not initialized."
4912 #: ../src/guestfs.pod:2554
4914 "You can add a prerequisite clause to any individual test. This is a run-"
4915 "time check, which, if it fails, causes the test to be skipped. Useful if "
4916 "testing a command which might not work on all variations of libguestfs "
4917 "builds. A test that has prerequisite of C<Always> means to run "
4922 #: ../src/guestfs.pod:2560
4924 "In addition, packagers can skip individual tests by setting environment "
4925 "variables before running C<make check>."
4929 #: ../src/guestfs.pod:2563
4932 " SKIP_TEST_<CMD>_<NUM>=1\n"
4937 #: ../src/guestfs.pod:2565
4938 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4942 #: ../src/guestfs.pod:2567
4947 #: ../src/guestfs.pod:2569
4950 " SKIP_TEST_<CMD>=1\n"
4955 #: ../src/guestfs.pod:2571
4956 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4960 #: ../src/guestfs.pod:2573
4961 msgid "Packagers can run only certain tests by setting for example:"
4965 #: ../src/guestfs.pod:2575
4968 " TEST_ONLY=\"vfs_type zerofree\"\n"
4973 #: ../src/guestfs.pod:2577
4975 "See C<capitests/tests.c> for more details of how these environment variables"
4980 #: ../src/guestfs.pod:2580
4981 msgid "DEBUGGING NEW API ACTIONS"
4985 #: ../src/guestfs.pod:2582
4986 msgid "Test new actions work before submitting them."
4990 #: ../src/guestfs.pod:2584
4991 msgid "You can use guestfish to try out new commands."
4995 #: ../src/guestfs.pod:2586
4997 "Debugging the daemon is a problem because it runs inside a minimal "
4998 "environment. However you can fprintf messages in the daemon to stderr, and "
4999 "they will show up if you use C<guestfish -v>."
5003 #: ../src/guestfs.pod:2590
5004 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5008 #: ../src/guestfs.pod:2592
5010 "Our C source code generally adheres to some basic code-formatting "
5011 "conventions. The existing code base is not totally consistent on this "
5012 "front, but we do prefer that contributed code be formatted similarly. In "
5013 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5014 "indentation level, and other than that, follow the K&R style."
5018 #: ../src/guestfs.pod:2598
5020 "If you use Emacs, add the following to one of one of your start-up files "
5021 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
5025 #: ../src/guestfs.pod:2601
5028 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5029 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5030 " (add-hook 'find-file-hook\n"
5031 " '(lambda () (if (and buffer-file-name\n"
5032 " (string-match \"/libguestfs\\\\>\"\n"
5033 " (buffer-file-name))\n"
5034 " (not (string-equal mode-name \"Change Log\"))\n"
5035 " (not (string-equal mode-name \"Makefile\")))\n"
5036 " (setq indent-tabs-mode nil))))\n"
5041 #: ../src/guestfs.pod:2611
5044 " ;;; When editing C sources in libguestfs, use this style.\n"
5045 " (defun libguestfs-c-mode ()\n"
5046 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5048 " (c-set-style \"K&R\")\n"
5049 " (setq c-indent-level 2)\n"
5050 " (setq c-basic-offset 2))\n"
5051 " (add-hook 'c-mode-hook\n"
5052 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5053 " (buffer-file-name))\n"
5054 " (libguestfs-c-mode))))\n"
5059 #: ../src/guestfs.pod:2623
5060 msgid "Enable warnings when compiling (and fix any problems this finds):"
5064 #: ../src/guestfs.pod:2626
5067 " ./configure --enable-gcc-warnings\n"
5072 #: ../src/guestfs.pod:2628
5073 msgid "Useful targets are:"
5077 #: ../src/guestfs.pod:2630
5080 " make syntax-check # checks the syntax of the C code\n"
5081 " make check # runs the test suite\n"
5086 #: ../src/guestfs.pod:2633
5087 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5091 #: ../src/guestfs.pod:2635
5093 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>,"
5094 " which are used to do shell quoting."
5098 #: ../src/guestfs.pod:2640
5103 #: ../src/guestfs.pod:2642
5105 "Simple shell quoted string. Any spaces or other shell characters are "
5110 #: ../src/guestfs.pod:2645
5115 #: ../src/guestfs.pod:2647
5117 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5122 #: ../src/guestfs.pod:2652 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
5123 msgid "For example:"
5127 #: ../src/guestfs.pod:2654
5130 " asprintf (&cmd, \"cat %R\", path);\n"
5135 #: ../src/guestfs.pod:2656
5136 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5140 #: ../src/guestfs.pod:2658
5142 "I<Note:> Do I<not> use these when you are passing parameters to the "
5143 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
5144 "because they are not passed via the shell (instead, straight to exec). You "
5145 "probably want to use the C<sysroot_path()> function however."
5149 #: ../src/guestfs.pod:2664
5150 msgid "SUBMITTING YOUR NEW API ACTIONS"
5154 #: ../src/guestfs.pod:2666
5156 "Submit patches to the mailing list: "
5157 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5158 "L<rjones@redhat.com>."
5162 #: ../src/guestfs.pod:2670
5163 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5167 #: ../src/guestfs.pod:2672
5168 msgid "We support i18n (gettext anyhow) in the library."
5172 #: ../src/guestfs.pod:2674
5174 "However many messages come from the daemon, and we don't translate those at "
5175 "the moment. One reason is that the appliance generally has all locale files"
5176 " removed from it, because they take up a lot of space. So we'd have to "
5177 "readd some of those, as well as copying our PO files into the appliance."
5181 #: ../src/guestfs.pod:2680
5183 "Debugging messages are never translated, since they are intended for the "
5188 #: ../src/guestfs.pod:2683
5189 msgid "SOURCE CODE SUBDIRECTORIES"
5193 #: ../src/guestfs.pod:2687 ../src/guestfs-actions.pod:6174
5194 #: ../fish/guestfish-actions.pod:4072
5195 msgid "C<appliance>"
5199 #: ../src/guestfs.pod:2689
5200 msgid "The libguestfs appliance, build scripts and so on."
5204 #: ../src/guestfs.pod:2691
5205 msgid "C<capitests>"
5209 #: ../src/guestfs.pod:2693
5210 msgid "Automated tests of the C API."
5214 #: ../src/guestfs.pod:2695
5219 #: ../src/guestfs.pod:2697
5221 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5226 #: ../src/guestfs.pod:2700
5231 #: ../src/guestfs.pod:2702
5233 "Safety and liveness tests of components that libguestfs depends upon (not of"
5234 " libguestfs itself). Mainly this is for qemu and the kernel."
5238 #: ../src/guestfs.pod:2705
5243 #: ../src/guestfs.pod:2707
5244 msgid "Outside contributions, experimental parts."
5248 #: ../src/guestfs.pod:2709
5253 #: ../src/guestfs.pod:2711
5255 "The daemon that runs inside the libguestfs appliance and carries out "
5260 #: ../src/guestfs.pod:2714
5265 #: ../src/guestfs.pod:2716
5266 msgid "L<virt-df(1)> command and documentation."
5270 #: ../src/guestfs.pod:2718
5275 #: ../src/guestfs.pod:2720
5276 msgid "L<virt-edit(1)> command and documentation."
5280 #: ../src/guestfs.pod:2722
5285 #: ../src/guestfs.pod:2724
5286 msgid "C API example code."
5290 #: ../src/guestfs.pod:2726
5295 #: ../src/guestfs.pod:2728
5297 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5298 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L"
5299 "<virt-tar-out(1)>."
5303 #: ../src/guestfs.pod:2732
5308 #: ../src/guestfs.pod:2734
5310 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5314 #: ../src/guestfs.pod:2736
5315 msgid "C<generator>"
5319 #: ../src/guestfs.pod:2738
5321 "The crucially important generator, used to automatically generate large "
5322 "amounts of boilerplate C code for things like RPC and bindings."
5326 #: ../src/guestfs.pod:2741
5331 #: ../src/guestfs.pod:2743
5332 msgid "Files used by the test suite."
5336 #: ../src/guestfs.pod:2745
5337 msgid "Some \"phony\" guest images which we test against."
5341 #: ../src/guestfs.pod:2747
5342 msgid "C<inspector>"
5346 #: ../src/guestfs.pod:2749
5347 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5351 #: ../src/guestfs.pod:2751
5356 #: ../src/guestfs.pod:2753
5357 msgid "Logo used on the website. The fish is called Arthur by the way."
5361 #: ../src/guestfs.pod:2755
5366 #: ../src/guestfs.pod:2757
5367 msgid "M4 macros used by autoconf."
5371 #: ../src/guestfs.pod:2759
5376 #: ../src/guestfs.pod:2761
5377 msgid "Translations of simple gettext strings."
5381 #: ../src/guestfs.pod:2763
5386 #: ../src/guestfs.pod:2765
5388 "The build infrastructure and PO files for translations of manpages and POD "
5389 "files. Eventually this will be combined with the C<po> directory, but that "
5390 "is rather complicated."
5394 #: ../src/guestfs.pod:2769
5395 msgid "C<regressions>"
5399 #: ../src/guestfs.pod:2771
5400 msgid "Regression tests."
5404 #: ../src/guestfs.pod:2773
5409 #: ../src/guestfs.pod:2775
5410 msgid "L<virt-rescue(1)> command and documentation."
5414 #: ../src/guestfs.pod:2777
5419 #: ../src/guestfs.pod:2779
5420 msgid "Source code to the C library."
5424 #: ../src/guestfs.pod:2781
5429 #: ../src/guestfs.pod:2783
5431 "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5435 #: ../src/guestfs.pod:2785
5436 msgid "C<test-tool>"
5440 #: ../src/guestfs.pod:2787
5442 "Test tool for end users to test if their qemu/kernel combination will work "
5447 #: ../src/guestfs.pod:2790
5452 #: ../src/guestfs.pod:2792
5457 #: ../src/guestfs.pod:2794
5462 #: ../src/guestfs.pod:2796
5467 #: ../src/guestfs.pod:2798
5472 #: ../src/guestfs.pod:2800
5477 #: ../src/guestfs.pod:2802
5482 #: ../src/guestfs.pod:2804
5487 #: ../src/guestfs.pod:2806
5488 msgid "Language bindings."
5492 #: ../src/guestfs.pod:2810
5497 #: ../src/guestfs.pod:2812
5498 msgid "PROTOCOL LIMITS"
5502 #: ../src/guestfs.pod:2814
5504 "Internally libguestfs uses a message-based protocol to pass API calls and "
5505 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5506 "plenty more detail about this). The maximum message size used by the "
5507 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5508 "aware of this limit. The API calls which may be affected are individually "
5509 "documented, with a link back to this section of the documentation."
5513 #: ../src/guestfs.pod:2822
5515 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5516 "a simple string. Because this string is at some point internally encoded as"
5517 " a message, the maximum size that it can return is slightly under 4 MB. If "
5518 "the requested file is larger than this then you will get an error."
5522 #: ../src/guestfs.pod:2828
5524 "In order to transfer large files into and out of the guest filesystem, you "
5525 "need to use particular calls that support this. The sections L</UPLOADING> "
5526 "and L</DOWNLOADING> document how to do this."
5530 #: ../src/guestfs.pod:2832
5532 "You might also consider mounting the disk image using our FUSE filesystem "
5533 "support (L<guestmount(1)>)."
5537 #: ../src/guestfs.pod:2835
5538 msgid "MAXIMUM NUMBER OF DISKS"
5542 #: ../src/guestfs.pod:2837
5544 "When using virtio disks (the default) the current limit is B<25> disks."
5548 #: ../src/guestfs.pod:2840
5550 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31"
5551 " slots. However febootstrap only understands disks with names C</dev/vda> "
5552 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5557 #: ../src/guestfs.pod:2845
5559 "We are working to substantially raise this limit in future versions but it "
5560 "requires complex changes to qemu."
5564 #: ../src/guestfs.pod:2848
5566 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5567 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5568 "requires changes to qemu."
5572 #: ../src/guestfs.pod:2852
5573 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5577 #: ../src/guestfs.pod:2854
5578 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5582 #: ../src/guestfs.pod:2856
5584 "This is because it reserves 4 bits for the minor device number (thus "
5585 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5589 #: ../src/guestfs.pod:2859
5591 "If you attach a disk with more than 15 partitions, the extra partitions are "
5592 "ignored by libguestfs."
5596 #: ../src/guestfs.pod:2862
5597 msgid "MAXIMUM SIZE OF A DISK"
5601 #: ../src/guestfs.pod:2864
5602 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5606 #: ../src/guestfs.pod:2866
5608 "We have tested block devices up to 1 exabyte (2**60 or "
5609 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5614 #: ../src/guestfs.pod:2870
5616 "Although libguestfs probably does not impose any limit, the underlying host "
5617 "storage will. If you store disk images on a host ext4 filesystem, then the "
5618 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5619 "TB). If you store disk images as host logical volumes then you are limited "
5620 "by the maximum size of an LV."
5624 #: ../src/guestfs.pod:2876
5626 "For the hugest disk image files, we recommend using XFS on the host for "
5631 #: ../src/guestfs.pod:2879
5632 msgid "MAXIMUM SIZE OF A PARTITION"
5636 #: ../src/guestfs.pod:2881
5638 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector numbers."
5639 " Assuming a 512 byte sector size, this means that MBR cannot address a "
5640 "partition located beyond 2 TB on the disk."
5644 #: ../src/guestfs.pod:2885
5646 "It is recommended that you use GPT partitions on disks which are larger than"
5647 " this size. GPT uses 64 bit sector numbers and so can address partitions "
5648 "which are theoretically larger than the largest disk we could support."
5652 #: ../src/guestfs.pod:2890
5653 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5657 #: ../src/guestfs.pod:2892
5659 "This depends on the filesystem type. libguestfs itself does not impose any "
5660 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5661 "what these limits are."
5665 #: ../src/guestfs.pod:2896
5666 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5670 #: ../src/guestfs.pod:2898
5672 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5673 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5674 "uploads and downloads."
5678 #: ../src/guestfs.pod:2902
5679 msgid "INSPECTION LIMITS"
5683 #: ../src/guestfs.pod:2904
5685 "The inspection code has several arbitrary limits on things like the size of "
5686 "Windows Registry hive it will read, and the length of product name. These "
5687 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5688 "memory and disk space on the host, and should not be reached in practice. "
5689 "See the source code for more information."
5693 #: ../src/guestfs.pod:2910 ../fish/guestfish.pod:1075
5694 #: ../test-tool/libguestfs-test-tool.pod:82
5695 msgid "ENVIRONMENT VARIABLES"
5699 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1106
5700 msgid "LIBGUESTFS_APPEND"
5704 #: ../src/guestfs.pod:2916 ../fish/guestfish.pod:1108
5705 msgid "Pass additional options to the guest kernel."
5709 #: ../src/guestfs.pod:2918 ../fish/guestfish.pod:1110
5710 msgid "LIBGUESTFS_DEBUG"
5714 #: ../src/guestfs.pod:2920
5716 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5717 "effect as calling C<guestfs_set_verbose (g, 1)>."
5721 #: ../src/guestfs.pod:2923 ../fish/guestfish.pod:1115
5722 msgid "LIBGUESTFS_MEMSIZE"
5726 #: ../src/guestfs.pod:2925 ../fish/guestfish.pod:1117
5728 "Set the memory allocated to the qemu process, in megabytes. For example:"
5732 #: ../src/guestfs.pod:2928 ../fish/guestfish.pod:1120
5735 " LIBGUESTFS_MEMSIZE=700\n"
5740 #: ../src/guestfs.pod:2930 ../fish/guestfish.pod:1122
5741 msgid "LIBGUESTFS_PATH"
5745 #: ../src/guestfs.pod:2932
5747 "Set the path that libguestfs uses to search for a supermin appliance. See "
5748 "the discussion of paths in section L</PATH> above."
5752 #: ../src/guestfs.pod:2935 ../fish/guestfish.pod:1127
5753 msgid "LIBGUESTFS_QEMU"
5757 #: ../src/guestfs.pod:2937 ../fish/guestfish.pod:1129
5759 "Set the default qemu binary that libguestfs uses. If not set, then the qemu"
5760 " which was found at compile time by the configure script is used."
5764 #: ../src/guestfs.pod:2941
5765 msgid "See also L</QEMU WRAPPERS> above."
5769 #: ../src/guestfs.pod:2943 ../fish/guestfish.pod:1133
5770 msgid "LIBGUESTFS_TRACE"
5774 #: ../src/guestfs.pod:2945
5776 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5777 "effect as calling C<guestfs_set_trace (g, 1)>."
5781 #: ../src/guestfs.pod:2948 ../fish/guestfish.pod:1142
5786 #: ../src/guestfs.pod:2950 ../fish/guestfish.pod:1144
5788 "Location of temporary directory, defaults to C</tmp> except for the cached "
5789 "supermin appliance which defaults to C</var/tmp>."
5793 #: ../src/guestfs.pod:2953 ../fish/guestfish.pod:1147
5795 "If libguestfs was compiled to use the supermin appliance then the real "
5796 "appliance is cached in this directory, shared between all handles belonging "
5797 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5798 "use in case C</var/tmp> is not large enough."
5802 #: ../src/guestfs.pod:2961 ../fish/guestfish.pod:1214
5803 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
5804 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
5805 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5806 #: ../tools/virt-list-partitions.pl:257
5811 #: ../src/guestfs.pod:2963
5813 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L"
5814 "<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L"
5815 "<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L"
5816 "<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L"
5817 "<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
5818 "rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
5819 "win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5820 "L<http://libguestfs.org/>."
5824 #: ../src/guestfs.pod:2990
5826 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5827 "L<lvm(8)>, L<disktype(1)>."
5831 #: ../src/guestfs.pod:2997 ../tools/virt-win-reg.pl:759
5832 #: ../tools/virt-make-fs.pl:553
5837 #: ../src/guestfs.pod:2999
5838 msgid "To get a list of bugs against libguestfs use this link:"
5842 #: ../src/guestfs.pod:3001
5844 "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5848 #: ../src/guestfs.pod:3003
5849 msgid "To report a new bug against libguestfs use this link:"
5853 #: ../src/guestfs.pod:3005
5855 "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5859 #: ../src/guestfs.pod:3007
5860 msgid "When reporting a bug, please check:"
5864 #: ../src/guestfs.pod:3013
5865 msgid "That the bug hasn't been reported already."
5869 #: ../src/guestfs.pod:3017
5870 msgid "That you are testing a recent version."
5874 #: ../src/guestfs.pod:3021
5875 msgid "Describe the bug accurately, and give a way to reproduce it."
5879 #: ../src/guestfs.pod:3025
5881 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the"
5886 #: ../src/guestfs.pod:3030 ../fish/guestfish.pod:1238
5887 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5892 #: ../src/guestfs.pod:3032 ../fish/guestfish.pod:1240
5893 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5894 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5898 #: ../src/guestfs.pod:3034 ../fish/guestfish.pod:1242
5899 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
5900 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
5901 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5902 #: ../tools/virt-list-partitions.pl:273
5907 #: ../src/guestfs.pod:3036 ../fish/guestfish.pod:1244
5908 #: ../test-tool/libguestfs-test-tool.pod:99
5909 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5913 #: ../src/guestfs.pod:3039
5915 "This library is free software; you can redistribute it and/or modify it "
5916 "under the terms of the GNU Lesser General Public License as published by the"
5917 " Free Software Foundation; either version 2 of the License, or (at your "
5918 "option) any later version."
5922 #: ../src/guestfs.pod:3044
5924 "This library is distributed in the hope that it will be useful, but WITHOUT "
5925 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5926 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License"
5927 " for more details."
5931 #: ../src/guestfs.pod:3049
5933 "You should have received a copy of the GNU Lesser General Public License "
5934 "along with this library; if not, write to the Free Software Foundation, "
5935 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5939 #: ../src/guestfs-actions.pod:1
5940 msgid "guestfs_add_cdrom"
5944 #: ../src/guestfs-actions.pod:3
5948 " guestfs_add_cdrom (guestfs_h *g,\n"
5949 " const char *filename);\n"
5954 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5955 msgid "This function adds a virtual CD-ROM disk image to the guest."
5959 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5960 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5964 #: ../src/guestfs-actions.pod:17
5966 "This call checks for the existence of C<filename>. This stops you from "
5967 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5968 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call"
5973 #: ../src/guestfs-actions.pod:24
5975 "If you just want to add an ISO file (often you use this as an efficient way "
5976 "to transfer large files into the guest), then you should probably use "
5977 "C<guestfs_add_drive_ro> instead."
5981 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
5982 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5983 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5984 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5985 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5986 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5987 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5988 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5989 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
5990 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
5991 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
5992 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
5993 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
5994 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
5995 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
5996 #: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
5997 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
5998 #: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
5999 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
6000 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
6001 #: ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2483
6002 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2579
6003 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3634
6004 #: ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3848
6005 #: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3875
6006 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3904
6007 #: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:4012
6008 #: ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4049
6009 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4095
6010 #: ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4149
6011 #: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4203
6012 #: ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4251
6013 #: ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4280
6014 #: ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4312
6015 #: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4425
6016 #: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4489
6017 #: ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4525
6018 #: ../src/guestfs-actions.pod:4541 ../src/guestfs-actions.pod:4555
6019 #: ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4586
6020 #: ../src/guestfs-actions.pod:4601 ../src/guestfs-actions.pod:4621
6021 #: ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4764
6022 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814
6023 #: ../src/guestfs-actions.pod:4833 ../src/guestfs-actions.pod:4845
6024 #: ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4875
6025 #: ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4905
6026 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4973
6027 #: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5032
6028 #: ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5063
6029 #: ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5158
6030 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5248
6031 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5300
6032 #: ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5452
6033 #: ../src/guestfs-actions.pod:5509 ../src/guestfs-actions.pod:5531
6034 #: ../src/guestfs-actions.pod:5549 ../src/guestfs-actions.pod:5581
6035 #: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5664
6036 #: ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:5691
6037 #: ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:5999
6038 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6032
6039 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6058
6040 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6084
6041 #: ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6121
6042 #: ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6159
6043 #: ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6207
6044 #: ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6248
6045 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6288
6046 #: ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324
6047 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6369
6048 #: ../src/guestfs-actions.pod:6393 ../src/guestfs-actions.pod:6412
6049 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6455
6050 #: ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6489
6051 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6556
6052 #: ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6711
6053 #: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6844
6054 #: ../src/guestfs-actions.pod:6857 ../src/guestfs-actions.pod:6870
6055 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905
6056 #: ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:6931
6057 #: ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:7005
6058 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7038
6059 #: ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7071
6060 #: ../src/guestfs-actions.pod:7084 ../src/guestfs-actions.pod:7104
6061 #: ../src/guestfs-actions.pod:7140 ../src/guestfs-actions.pod:7154
6062 #: ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7208
6063 #: ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7260
6064 #: ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7412
6065 #: ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7441
6066 #: ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7509
6067 #: ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7587
6068 #: ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7670
6069 #: ../src/guestfs-actions.pod:7694 ../src/guestfs-actions.pod:7761
6070 #: ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7809
6071 msgid "This function returns 0 on success or -1 on error."
6075 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6076 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6077 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6079 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6084 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6085 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
6086 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
6087 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4945
6088 #: ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5253
6089 #: ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:6564
6090 #: ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6656
6091 #: ../src/guestfs-actions.pod:7592 ../src/guestfs-actions.pod:7702
6092 #: ../src/guestfs-actions.pod:7872 ../fish/guestfish-actions.pod:31
6093 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6094 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346
6095 #: ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3085
6096 #: ../fish/guestfish-actions.pod:3292 ../fish/guestfish-actions.pod:3406
6097 #: ../fish/guestfish-actions.pod:3454 ../fish/guestfish-actions.pod:4349
6098 #: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
6099 #: ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:5081
6100 #: ../fish/guestfish-actions.pod:5179
6102 "Deprecated functions will not be removed from the API, but the fact that "
6103 "they are deprecated indicates that there are problems with correct use of "
6108 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6109 #: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
6110 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2190
6111 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3641
6112 #: ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:6209
6113 #: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6457
6114 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7073
6115 #: ../src/guestfs-actions.pod:7596
6116 msgid "(Added in 0.3)"
6120 #: ../src/guestfs-actions.pod:41
6121 msgid "guestfs_add_domain"
6125 #: ../src/guestfs-actions.pod:43
6129 " guestfs_add_domain (guestfs_h *g,\n"
6130 " const char *dom,\n"
6136 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6137 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2824
6138 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4959
6139 #: ../src/guestfs-actions.pod:5176
6141 "You may supply a list of optional arguments to this call. Use zero or more "
6142 "of the following pairs of parameters, and terminate the list with C<-1> on "
6143 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6147 #: ../src/guestfs-actions.pod:53
6150 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6151 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6152 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6153 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6154 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6159 #: ../src/guestfs-actions.pod:59
6161 "This function adds the disk(s) attached to the named libvirt domain C<dom>."
6162 " It works by connecting to libvirt, requesting the domain and domain XML "
6163 "from libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on"
6168 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6170 "The number of disks added is returned. This operation is atomic: if an "
6171 "error is returned, then no disks are added."
6175 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6177 "This function does some minimal checks to make sure the libvirt domain is "
6178 "not running (unless C<readonly> is true). In a future version we will try "
6179 "to acquire the libvirt lock on each disk."
6183 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6185 "Disks must be accessible locally. This often means that adding disks from a"
6186 " remote libvirt connection (see L<http://libvirt.org/remote.html>) will "
6187 "fail unless those disks are accessible via the same device path locally too."
6191 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6193 "The optional C<libvirturi> parameter sets the libvirt URI (see "
6194 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
6195 "default libvirt URI (or one set through an environment variable, see the "
6196 "libvirt documentation for full details)."
6200 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6202 "The optional C<live> flag controls whether this call will try to connect to "
6203 "a running virtual machine C<guestfsd> process if it sees a suitable "
6204 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6205 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING"
6206 " DAEMONS> for more information."
6210 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6212 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6213 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6214 "first and looked up, and if that lookup fails then we treat C<dom> as a name"
6219 #: ../src/guestfs-actions.pod:94
6221 "The other optional parameters are passed directly through to "
6222 "C<guestfs_add_drive_opts>."
6226 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6227 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6228 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6229 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
6230 #: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
6231 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2099
6232 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177
6233 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2942
6234 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:5135
6235 #: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5761
6236 #: ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:7181
6237 #: ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7620
6238 #: ../src/guestfs-actions.pod:7633
6239 msgid "On error this function returns -1."
6243 #: ../src/guestfs-actions.pod:99
6244 msgid "(Added in 1.7.4)"
6248 #: ../src/guestfs-actions.pod:101
6249 msgid "guestfs_add_domain_va"
6253 #: ../src/guestfs-actions.pod:103
6257 " guestfs_add_domain_va (guestfs_h *g,\n"
6258 " const char *dom,\n"
6264 #: ../src/guestfs-actions.pod:108
6265 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6269 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6270 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6271 #: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
6272 #: ../src/guestfs-actions.pod:2908 ../src/guestfs-actions.pod:2920
6273 #: ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4717
6274 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:4999
6275 #: ../src/guestfs-actions.pod:5225 ../src/guestfs-actions.pod:5236
6276 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6280 #: ../src/guestfs-actions.pod:112
6281 msgid "guestfs_add_domain_argv"
6285 #: ../src/guestfs-actions.pod:114
6289 " guestfs_add_domain_argv (guestfs_h *g,\n"
6290 " const char *dom,\n"
6291 " const struct guestfs_add_domain_argv *optargs);\n"
6296 #: ../src/guestfs-actions.pod:119
6297 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6301 #: ../src/guestfs-actions.pod:123
6302 msgid "guestfs_add_drive"
6306 #: ../src/guestfs-actions.pod:125
6310 " guestfs_add_drive (guestfs_h *g,\n"
6311 " const char *filename);\n"
6316 #: ../src/guestfs-actions.pod:129
6318 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no"
6319 " optional parameters, so the disk is added writable, with the format being "
6320 "detected automatically."
6324 #: ../src/guestfs-actions.pod:133
6326 "Automatic detection of the format opens you up to a potential security hole "
6327 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6328 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6329 "you should think about replacing calls to this function with calls to "
6330 "C<guestfs_add_drive_opts>, and specifying the format."
6334 #: ../src/guestfs-actions.pod:144
6335 msgid "guestfs_add_drive_opts"
6339 #: ../src/guestfs-actions.pod:146
6343 " guestfs_add_drive_opts (guestfs_h *g,\n"
6344 " const char *filename,\n"
6350 #: ../src/guestfs-actions.pod:156
6353 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6354 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6355 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6360 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6362 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6363 "The first time you call this function, the disk appears as C</dev/sda>, the "
6364 "second time as C</dev/sdb>, and so on."
6368 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6370 "You don't necessarily need to be root when using libguestfs. However you "
6371 "obviously do need sufficient permissions to access the filename for whatever"
6372 " operations you want to perform (ie. read access if you just want to read "
6373 "the image or write access if you want to modify the image)."
6377 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6378 msgid "This call checks that C<filename> exists."
6382 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4653
6383 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
6384 msgid "The optional arguments are:"
6388 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6393 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6395 "If true then the image is treated as read-only. Writes are still allowed, "
6396 "but they are stored in a temporary snapshot overlay which is discarded at "
6397 "the end. The disk that you add is not modified."
6401 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6406 #: ../src/guestfs-actions.pod:185
6408 "This forces the image format. If you omit this (or use C<guestfs_add_drive>"
6409 " or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6410 "Possible formats include C<raw> and C<qcow2>."
6414 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6416 "Automatic detection of the format opens you up to a potential security hole "
6417 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6418 "RHBZ#642934. Specifying the format closes this security hole."
6422 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6427 #: ../src/guestfs-actions.pod:196
6429 "This rarely-used option lets you emulate the behaviour of the deprecated "
6430 "C<guestfs_add_drive_with_if> call (q.v.)"
6434 #: ../src/guestfs-actions.pod:203
6435 msgid "(Added in 1.5.23)"
6439 #: ../src/guestfs-actions.pod:205
6440 msgid "guestfs_add_drive_opts_va"
6444 #: ../src/guestfs-actions.pod:207
6448 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6449 " const char *filename,\n"
6455 #: ../src/guestfs-actions.pod:212
6456 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6460 #: ../src/guestfs-actions.pod:216
6461 msgid "guestfs_add_drive_opts_argv"
6465 #: ../src/guestfs-actions.pod:218
6469 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6470 " const char *filename,\n"
6471 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6476 #: ../src/guestfs-actions.pod:223
6477 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6481 #: ../src/guestfs-actions.pod:227
6482 msgid "guestfs_add_drive_ro"
6486 #: ../src/guestfs-actions.pod:229
6490 " guestfs_add_drive_ro (guestfs_h *g,\n"
6491 " const char *filename);\n"
6496 #: ../src/guestfs-actions.pod:233
6498 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6499 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6500 "disk is added read-only, with the format being detected automatically."
6504 #: ../src/guestfs-actions.pod:240
6505 msgid "(Added in 1.0.38)"
6509 #: ../src/guestfs-actions.pod:242
6510 msgid "guestfs_add_drive_ro_with_if"
6514 #: ../src/guestfs-actions.pod:244
6518 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6519 " const char *filename,\n"
6520 " const char *iface);\n"
6525 #: ../src/guestfs-actions.pod:249
6527 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the"
6528 " QEMU interface emulation to use at run time."
6532 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6533 #: ../src/guestfs-actions.pod:2429
6534 msgid "(Added in 1.0.84)"
6538 #: ../src/guestfs-actions.pod:263
6539 msgid "guestfs_add_drive_with_if"
6543 #: ../src/guestfs-actions.pod:265
6547 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6548 " const char *filename,\n"
6549 " const char *iface);\n"
6554 #: ../src/guestfs-actions.pod:270
6556 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6557 "QEMU interface emulation to use at run time."
6561 #: ../src/guestfs-actions.pod:284
6562 msgid "guestfs_aug_clear"
6566 #: ../src/guestfs-actions.pod:286
6570 " guestfs_aug_clear (guestfs_h *g,\n"
6571 " const char *augpath);\n"
6576 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6578 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6579 "L<augtool(1)> C<clear> command."
6583 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2179
6584 msgid "(Added in 1.3.4)"
6588 #: ../src/guestfs-actions.pod:297
6589 msgid "guestfs_aug_close"
6593 #: ../src/guestfs-actions.pod:299
6597 " guestfs_aug_close (guestfs_h *g);\n"
6602 #: ../src/guestfs-actions.pod:302
6604 "Close the current Augeas handle and free up any resources used by it. After"
6605 " calling this, you have to call C<guestfs_aug_init> again before you can use"
6606 " any other Augeas functions."
6610 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6611 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6612 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6613 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6614 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6615 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6616 #: ../src/guestfs-actions.pod:5838
6617 msgid "(Added in 0.7)"
6621 #: ../src/guestfs-actions.pod:311
6622 msgid "guestfs_aug_defnode"
6626 #: ../src/guestfs-actions.pod:313
6629 " struct guestfs_int_bool *\n"
6630 " guestfs_aug_defnode (guestfs_h *g,\n"
6631 " const char *name,\n"
6632 " const char *expr,\n"
6633 " const char *val);\n"
6638 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6640 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6644 #: ../src/guestfs-actions.pod:322
6646 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6647 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6648 "containing that single node."
6652 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6654 "On success this returns a pair containing the number of nodes in the "
6655 "nodeset, and a boolean flag if a node was created."
6659 #: ../src/guestfs-actions.pod:330
6661 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6662 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6666 #: ../src/guestfs-actions.pod:336
6667 msgid "guestfs_aug_defvar"
6671 #: ../src/guestfs-actions.pod:338
6675 " guestfs_aug_defvar (guestfs_h *g,\n"
6676 " const char *name,\n"
6677 " const char *expr);\n"
6682 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6684 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6685 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6689 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6691 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6692 "evaluates to something which is not a nodeset."
6696 #: ../src/guestfs-actions.pod:354
6697 msgid "guestfs_aug_get"
6701 #: ../src/guestfs-actions.pod:356
6705 " guestfs_aug_get (guestfs_h *g,\n"
6706 " const char *augpath);\n"
6711 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6713 "Look up the value associated with C<path>. If C<path> matches exactly one "
6714 "node, the C<value> is returned."
6718 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922
6719 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000
6720 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119
6721 #: ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266
6722 #: ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419
6723 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719
6724 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899
6725 #: ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002
6726 #: ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2202
6727 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2598
6728 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2792
6729 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:3025
6730 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
6731 #: ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3167
6732 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207
6733 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:4187
6734 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4467
6735 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5566
6736 #: ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5914
6737 #: ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6617
6738 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6650
6739 #: ../src/guestfs-actions.pod:6681 ../src/guestfs-actions.pod:7355
6740 #: ../src/guestfs-actions.pod:7374 ../src/guestfs-actions.pod:7392
6741 #: ../src/guestfs-actions.pod:7566 ../src/guestfs-actions.pod:7866
6743 "This function returns a string, or NULL on error. I<The caller must free "
6744 "the returned string after use>."
6748 #: ../src/guestfs-actions.pod:368
6749 msgid "guestfs_aug_init"
6753 #: ../src/guestfs-actions.pod:370
6757 " guestfs_aug_init (guestfs_h *g,\n"
6758 " const char *root,\n"
6764 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6766 "Create a new Augeas handle for editing configuration files. If there was "
6767 "any previous Augeas handle associated with this guestfs session, then it is "
6772 #: ../src/guestfs-actions.pod:379
6773 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6777 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6779 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6783 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6785 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6786 "logical I<or> of the following integers:"
6790 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6791 msgid "C<AUG_SAVE_BACKUP> = 1"
6795 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6796 msgid "Keep the original file with a C<.augsave> extension."
6800 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6801 msgid "C<AUG_SAVE_NEWFILE> = 2"
6805 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6807 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6808 "original. Overrides C<AUG_SAVE_BACKUP>."
6812 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6813 msgid "C<AUG_TYPE_CHECK> = 4"
6817 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6818 msgid "Typecheck lenses (can be expensive)."
6822 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6823 msgid "C<AUG_NO_STDINC> = 8"
6827 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6828 msgid "Do not use standard load path for modules."
6832 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6833 msgid "C<AUG_SAVE_NOOP> = 16"
6837 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6838 msgid "Make save a no-op, just record what would have been changed."
6842 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6843 msgid "C<AUG_NO_LOAD> = 32"
6847 #: ../src/guestfs-actions.pod:414
6848 msgid "Do not load the tree in C<guestfs_aug_init>."
6852 #: ../src/guestfs-actions.pod:418
6853 msgid "To close the handle, you can call C<guestfs_aug_close>."
6857 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6858 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6862 #: ../src/guestfs-actions.pod:426
6863 msgid "guestfs_aug_insert"
6867 #: ../src/guestfs-actions.pod:428
6871 " guestfs_aug_insert (guestfs_h *g,\n"
6872 " const char *augpath,\n"
6873 " const char *label,\n"
6879 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6881 "Create a new sibling C<label> for C<path>, inserting it into the tree before"
6882 " or after C<path> (depending on the boolean flag C<before>)."
6886 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6888 "C<path> must match exactly one existing node in the tree, and C<label> must "
6889 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6893 #: ../src/guestfs-actions.pod:446
6894 msgid "guestfs_aug_load"
6898 #: ../src/guestfs-actions.pod:448
6902 " guestfs_aug_load (guestfs_h *g);\n"
6907 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6908 msgid "Load files into the tree."
6912 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6913 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6917 #: ../src/guestfs-actions.pod:460
6918 msgid "guestfs_aug_ls"
6922 #: ../src/guestfs-actions.pod:462
6926 " guestfs_aug_ls (guestfs_h *g,\n"
6927 " const char *augpath);\n"
6932 #: ../src/guestfs-actions.pod:466
6934 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6935 "sorting the resulting nodes into alphabetical order."
6939 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6940 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138
6941 #: ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453
6942 #: ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575
6943 #: ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2274
6944 #: ../src/guestfs-actions.pod:2290 ../src/guestfs-actions.pod:2309
6945 #: ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:2376
6946 #: ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2496
6947 #: ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:3127
6948 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3717
6949 #: ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3754
6950 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3921
6951 #: ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:5096
6952 #: ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:5834
6953 #: ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:6697
6954 #: ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6813
6955 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6983
6956 #: ../src/guestfs-actions.pod:7459 ../src/guestfs-actions.pod:7479
6957 #: ../src/guestfs-actions.pod:7526 ../src/guestfs-actions.pod:7718
6958 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7823
6959 #: ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7888
6960 #: ../src/guestfs-actions.pod:7907
6962 "This function returns a NULL-terminated array of strings (like "
6963 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6964 "strings and the array after use>."
6968 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063
6969 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491
6970 #: ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3512
6971 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4220
6972 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4440
6973 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5100
6974 #: ../src/guestfs-actions.pod:5649 ../src/guestfs-actions.pod:6046
6975 #: ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6072
6976 #: ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:7197
6977 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7443
6978 #: ../src/guestfs-actions.pod:7706
6979 msgid "(Added in 0.8)"
6983 #: ../src/guestfs-actions.pod:475
6984 msgid "guestfs_aug_match"
6988 #: ../src/guestfs-actions.pod:477
6992 " guestfs_aug_match (guestfs_h *g,\n"
6993 " const char *augpath);\n"
6998 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7000 "Returns a list of paths which match the path expression C<path>. The "
7001 "returned paths are sufficiently qualified so that they match exactly one "
7002 "node in the current tree."
7006 #: ../src/guestfs-actions.pod:491
7007 msgid "guestfs_aug_mv"
7011 #: ../src/guestfs-actions.pod:493
7015 " guestfs_aug_mv (guestfs_h *g,\n"
7016 " const char *src,\n"
7017 " const char *dest);\n"
7022 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7024 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7025 "C<dest> is overwritten if it exists."
7029 #: ../src/guestfs-actions.pod:505
7030 msgid "guestfs_aug_rm"
7034 #: ../src/guestfs-actions.pod:507
7038 " guestfs_aug_rm (guestfs_h *g,\n"
7039 " const char *augpath);\n"
7044 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7045 msgid "Remove C<path> and all of its children."
7049 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7050 msgid "On success this returns the number of entries which were removed."
7054 #: ../src/guestfs-actions.pod:519
7055 msgid "guestfs_aug_save"
7059 #: ../src/guestfs-actions.pod:521
7063 " guestfs_aug_save (guestfs_h *g);\n"
7068 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7069 msgid "This writes all pending changes to disk."
7073 #: ../src/guestfs-actions.pod:526
7075 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7080 #: ../src/guestfs-actions.pod:533
7081 msgid "guestfs_aug_set"
7085 #: ../src/guestfs-actions.pod:535
7089 " guestfs_aug_set (guestfs_h *g,\n"
7090 " const char *augpath,\n"
7091 " const char *val);\n"
7096 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7097 msgid "Set the value associated with C<path> to C<val>."
7101 #: ../src/guestfs-actions.pod:542
7103 "In the Augeas API, it is possible to clear a node by setting the value to "
7104 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7105 "this call. Instead you must use the C<guestfs_aug_clear> call."
7109 #: ../src/guestfs-actions.pod:551
7110 msgid "guestfs_available"
7114 #: ../src/guestfs-actions.pod:553
7118 " guestfs_available (guestfs_h *g,\n"
7119 " char *const *groups);\n"
7124 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7126 "This command is used to check the availability of some groups of "
7127 "functionality in the appliance, which not all builds of the libguestfs "
7128 "appliance will be able to provide."
7132 #: ../src/guestfs-actions.pod:561
7134 "The libguestfs groups, and the functions that those groups correspond to, "
7135 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7136 "runtime by calling C<guestfs_available_all_groups>."
7140 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7142 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
7143 "\"augeas\"]> would check for the availability of the Linux inotify functions"
7144 " and Augeas (configuration file editing) functions."
7148 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7149 msgid "The command returns no error if I<all> requested groups are available."
7153 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7155 "It fails with an error if one or more of the requested groups is unavailable"
7156 " in the appliance."
7160 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7162 "If an unknown group name is included in the list of groups then an error is "
7167 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7172 #: ../src/guestfs-actions.pod:585
7173 msgid "You must call C<guestfs_launch> before calling this function."
7177 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7179 "The reason is because we don't know what groups are supported by the "
7180 "appliance/daemon until it is running and can be queried."
7184 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7186 "If a group of functions is available, this does not necessarily mean that "
7187 "they will work. You still have to check for errors when calling individual "
7188 "API functions even if they are available."
7192 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7194 "It is usually the job of distro packagers to build complete functionality "
7195 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7196 "with all requirements satisfied, will support everything."
7200 #: ../src/guestfs-actions.pod:607
7202 "This call was added in version C<1.0.80>. In previous versions of "
7203 "libguestfs all you could do would be to speculatively execute a command to "
7204 "find out if the daemon implemented it. See also C<guestfs_version>."
7208 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
7209 msgid "(Added in 1.0.80)"
7213 #: ../src/guestfs-actions.pod:618
7214 msgid "guestfs_available_all_groups"
7218 #: ../src/guestfs-actions.pod:620
7222 " guestfs_available_all_groups (guestfs_h *g);\n"
7227 #: ../src/guestfs-actions.pod:623
7229 "This command returns a list of all optional groups that this daemon knows "
7230 "about. Note this returns both supported and unsupported groups. To find "
7231 "out which ones the daemon can actually support you have to call "
7232 "C<guestfs_available> on each member of the returned list."
7236 #: ../src/guestfs-actions.pod:629
7237 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7241 #: ../src/guestfs-actions.pod:635
7242 msgid "(Added in 1.3.15)"
7246 #: ../src/guestfs-actions.pod:637
7247 msgid "guestfs_base64_in"
7251 #: ../src/guestfs-actions.pod:639
7255 " guestfs_base64_in (guestfs_h *g,\n"
7256 " const char *base64file,\n"
7257 " const char *filename);\n"
7262 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7264 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7268 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7269 msgid "(Added in 1.3.5)"
7273 #: ../src/guestfs-actions.pod:651
7274 msgid "guestfs_base64_out"
7278 #: ../src/guestfs-actions.pod:653
7282 " guestfs_base64_out (guestfs_h *g,\n"
7283 " const char *filename,\n"
7284 " const char *base64file);\n"
7289 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7291 "This command downloads the contents of C<filename>, writing it out to local "
7292 "file C<base64file> encoded as base64."
7296 #: ../src/guestfs-actions.pod:665
7297 msgid "guestfs_blockdev_flushbufs"
7301 #: ../src/guestfs-actions.pod:667
7305 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7306 " const char *device);\n"
7311 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7313 "This tells the kernel to flush internal buffers associated with C<device>."
7317 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7318 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7319 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7320 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7321 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7322 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7323 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7324 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7325 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7326 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7327 msgid "This uses the L<blockdev(8)> command."
7331 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7332 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7333 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7334 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7335 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7336 msgid "(Added in 0.9.3)"
7340 #: ../src/guestfs-actions.pod:680
7341 msgid "guestfs_blockdev_getbsz"
7345 #: ../src/guestfs-actions.pod:682
7349 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7350 " const char *device);\n"
7355 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7356 msgid "This returns the block size of a device."
7360 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7361 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7363 "(Note this is different from both I<size in blocks> and I<filesystem block "
7368 #: ../src/guestfs-actions.pod:697
7369 msgid "guestfs_blockdev_getro"
7373 #: ../src/guestfs-actions.pod:699
7377 " guestfs_blockdev_getro (guestfs_h *g,\n"
7378 " const char *device);\n"
7383 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7385 "Returns a boolean indicating if the block device is read-only (true if read-"
7386 "only, false if not)."
7390 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474
7391 #: ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978
7392 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061
7393 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2125
7394 #: ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2165
7395 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3224
7396 #: ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3258
7397 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3434
7398 #: ../src/guestfs-actions.pod:3449 ../src/guestfs-actions.pod:3463
7399 #: ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494
7400 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3524
7401 #: ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3551
7402 #: ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3581
7403 #: ../src/guestfs-actions.pod:3594 ../src/guestfs-actions.pod:3608
7404 #: ../src/guestfs-actions.pod:5337
7405 msgid "This function returns a C truth value on success or -1 on error."
7409 #: ../src/guestfs-actions.pod:712
7410 msgid "guestfs_blockdev_getsize64"
7414 #: ../src/guestfs-actions.pod:714
7418 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7419 " const char *device);\n"
7424 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7425 msgid "This returns the size of the device in bytes."
7429 #: ../src/guestfs-actions.pod:720
7430 msgid "See also C<guestfs_blockdev_getsz>."
7434 #: ../src/guestfs-actions.pod:728
7435 msgid "guestfs_blockdev_getss"
7439 #: ../src/guestfs-actions.pod:730
7443 " guestfs_blockdev_getss (guestfs_h *g,\n"
7444 " const char *device);\n"
7449 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7451 "This returns the size of sectors on a block device. Usually 512, but can be"
7452 " larger for modern devices."
7456 #: ../src/guestfs-actions.pod:737
7458 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7463 #: ../src/guestfs-actions.pod:746
7464 msgid "guestfs_blockdev_getsz"
7468 #: ../src/guestfs-actions.pod:748
7472 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7473 " const char *device);\n"
7478 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7480 "This returns the size of the device in units of 512-byte sectors (even if "
7481 "the sectorsize isn't 512 bytes ... weird)."
7485 #: ../src/guestfs-actions.pod:755
7487 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7488 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7492 #: ../src/guestfs-actions.pod:765
7493 msgid "guestfs_blockdev_rereadpt"
7497 #: ../src/guestfs-actions.pod:767
7501 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7502 " const char *device);\n"
7507 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7508 msgid "Reread the partition table on C<device>."
7512 #: ../src/guestfs-actions.pod:779
7513 msgid "guestfs_blockdev_setbsz"
7517 #: ../src/guestfs-actions.pod:781
7521 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7522 " const char *device,\n"
7523 " int blocksize);\n"
7528 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7529 msgid "This sets the block size of a device."
7533 #: ../src/guestfs-actions.pod:797
7534 msgid "guestfs_blockdev_setro"
7538 #: ../src/guestfs-actions.pod:799
7542 " guestfs_blockdev_setro (guestfs_h *g,\n"
7543 " const char *device);\n"
7548 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7549 msgid "Sets the block device named C<device> to read-only."
7553 #: ../src/guestfs-actions.pod:811
7554 msgid "guestfs_blockdev_setrw"
7558 #: ../src/guestfs-actions.pod:813
7562 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7563 " const char *device);\n"
7568 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7569 msgid "Sets the block device named C<device> to read-write."
7573 #: ../src/guestfs-actions.pod:825
7574 msgid "guestfs_btrfs_filesystem_resize"
7578 #: ../src/guestfs-actions.pod:827
7582 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
7583 " const char *mountpoint,\n"
7589 #: ../src/guestfs-actions.pod:837
7592 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
7597 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
7598 msgid "This command resizes a btrfs filesystem."
7602 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
7604 "Note that unlike other resize calls, the filesystem has to be mounted and "
7605 "the parameter is the mountpoint not the device (this is a requirement of "
7610 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5187
7611 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
7612 msgid "The optional parameters are:"
7616 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5191
7617 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
7622 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
7624 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7625 "resized to the maximum size."
7629 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
7630 msgid "See also L<btrfs(8)>."
7634 #: ../src/guestfs-actions.pod:860
7635 msgid "(Added in 1.11.17)"
7639 #: ../src/guestfs-actions.pod:862
7640 msgid "guestfs_btrfs_filesystem_resize_va"
7644 #: ../src/guestfs-actions.pod:864
7648 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
7649 " const char *mountpoint,\n"
7655 #: ../src/guestfs-actions.pod:869
7656 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
7660 #: ../src/guestfs-actions.pod:873
7661 msgid "guestfs_btrfs_filesystem_resize_argv"
7665 #: ../src/guestfs-actions.pod:875
7669 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
7670 " const char *mountpoint,\n"
7671 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
7676 #: ../src/guestfs-actions.pod:880
7677 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
7681 #: ../src/guestfs-actions.pod:884
7682 msgid "guestfs_case_sensitive_path"
7686 #: ../src/guestfs-actions.pod:886
7690 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7691 " const char *path);\n"
7696 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:574
7698 "This can be used to resolve case insensitive paths on a filesystem which is "
7699 "case sensitive. The use case is to resolve paths which you have read from "
7700 "Windows configuration files or the Windows Registry, to the true path."
7704 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:579
7706 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7707 "(and probably others), which is that although the underlying filesystem is "
7708 "case-insensitive, the driver exports the filesystem to Linux as case-"
7713 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:584
7715 "One consequence of this is that special directories such as C<c:\\windows> "
7716 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7717 "precise details of how they were created. In Windows itself this would not "
7722 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:590
7724 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-"
7725 "faq/#posixfilenames1>"
7729 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:593
7731 "This function resolves the true case of each element in the path and returns"
7732 " the case-sensitive path."
7736 #: ../src/guestfs-actions.pod:912
7738 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7739 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7740 "how the directories were originally created under Windows)."
7744 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:601
7745 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7749 #: ../src/guestfs-actions.pod:920
7750 msgid "See also C<guestfs_realpath>."
7754 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7377
7755 msgid "(Added in 1.0.75)"
7759 #: ../src/guestfs-actions.pod:927
7764 #: ../src/guestfs-actions.pod:929
7768 " guestfs_cat (guestfs_h *g,\n"
7769 " const char *path);\n"
7774 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5824
7775 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3831
7776 msgid "Return the contents of the file named C<path>."
7780 #: ../src/guestfs-actions.pod:935
7782 "Note that this function cannot correctly handle binary files (specifically, "
7783 "files containing C<\\0> character which is treated as end of string). For "
7784 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7785 "functions which have a more complex interface."
7789 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122
7790 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438
7791 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560
7792 #: ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825
7793 #: ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2313
7794 #: ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2380
7795 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2426
7796 #: ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5632
7797 #: ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5789
7798 #: ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:6762
7799 #: ../src/guestfs-actions.pod:6817 ../src/guestfs-actions.pod:6963
7800 #: ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7652
7801 #: ../src/guestfs-actions.pod:7672 ../src/guestfs-actions.pod:7696
7802 #: ../src/guestfs-actions.pod:7722 ../src/guestfs-actions.pod:7741
7803 #: ../src/guestfs-actions.pod:7827 ../src/guestfs-actions.pod:7846
7804 #: ../src/guestfs-actions.pod:7892 ../src/guestfs-actions.pod:7911
7805 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752
7806 #: ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940
7807 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017
7808 #: ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219
7809 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536
7810 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579
7811 #: ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608
7812 #: ../fish/guestfish-actions.pod:3701 ../fish/guestfish-actions.pod:3716
7813 #: ../fish/guestfish-actions.pod:3792 ../fish/guestfish-actions.pod:3809
7814 #: ../fish/guestfish-actions.pod:3824 ../fish/guestfish-actions.pod:4493
7815 #: ../fish/guestfish-actions.pod:4539 ../fish/guestfish-actions.pod:4624
7816 #: ../fish/guestfish-actions.pod:4639 ../fish/guestfish-actions.pod:5045
7817 #: ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5075
7818 #: ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5102
7819 #: ../fish/guestfish-actions.pod:5151 ../fish/guestfish-actions.pod:5161
7820 #: ../fish/guestfish-actions.pod:5190 ../fish/guestfish-actions.pod:5200
7822 "Because of the message protocol, there is a transfer limit of somewhere "
7823 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7827 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3738
7828 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3837
7829 #: ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:4333
7830 #: ../src/guestfs-actions.pod:4347 ../src/guestfs-actions.pod:5712
7831 #: ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:7530
7832 #: ../src/guestfs-actions.pod:7544
7833 msgid "(Added in 0.4)"
7837 #: ../src/guestfs-actions.pod:948
7838 msgid "guestfs_checksum"
7842 #: ../src/guestfs-actions.pod:950
7846 " guestfs_checksum (guestfs_h *g,\n"
7847 " const char *csumtype,\n"
7848 " const char *path);\n"
7853 #: ../src/guestfs-actions.pod:955 ../fish/guestfish-actions.pod:624
7855 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7859 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:627
7861 "The type of checksum to compute is given by the C<csumtype> parameter which "
7862 "must have one of the following values:"
7866 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:632
7871 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:634
7873 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7878 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:637
7883 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:639
7884 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7888 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:641
7893 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:643
7894 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7898 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:645
7903 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:647
7904 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7908 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:649
7913 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:651
7914 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7918 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:653
7923 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:655
7924 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7928 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:657
7933 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:659
7934 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7938 #: ../src/guestfs-actions.pod:994 ../fish/guestfish-actions.pod:663
7939 msgid "The checksum is returned as a printable string."
7943 #: ../src/guestfs-actions.pod:996
7944 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7948 #: ../src/guestfs-actions.pod:998
7949 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7953 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311
7954 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3436
7955 #: ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3526
7956 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:7233
7957 msgid "(Added in 1.0.2)"
7961 #: ../src/guestfs-actions.pod:1005
7962 msgid "guestfs_checksum_device"
7966 #: ../src/guestfs-actions.pod:1007
7970 " guestfs_checksum_device (guestfs_h *g,\n"
7971 " const char *csumtype,\n"
7972 " const char *device);\n"
7977 #: ../src/guestfs-actions.pod:1012
7979 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7980 "device named C<device>. For the types of checksums supported see the "
7981 "C<guestfs_checksum> command."
7985 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5167
7986 #: ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5339
7987 #: ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5533
7988 #: ../src/guestfs-actions.pod:7142 ../src/guestfs-actions.pod:7156
7989 #: ../src/guestfs-actions.pod:7556
7990 msgid "(Added in 1.3.2)"
7994 #: ../src/guestfs-actions.pod:1021
7995 msgid "guestfs_checksums_out"
7999 #: ../src/guestfs-actions.pod:1023
8003 " guestfs_checksums_out (guestfs_h *g,\n"
8004 " const char *csumtype,\n"
8005 " const char *directory,\n"
8006 " const char *sumsfile);\n"
8011 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:681
8013 "This command computes the checksums of all regular files in C<directory> and"
8014 " then emits a list of those checksums to the local output file C<sumsfile>."
8018 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:685
8020 "This can be used for verifying the integrity of a virtual machine. However "
8021 "to be properly secure you should pay attention to the output of the checksum"
8022 " command (it uses the ones from GNU coreutils). In particular when the "
8023 "filename is not printable, coreutils uses a special backslash syntax. For "
8024 "more information, see the GNU coreutils info file."
8028 #: ../src/guestfs-actions.pod:1043
8029 msgid "(Added in 1.3.7)"
8033 #: ../src/guestfs-actions.pod:1045
8034 msgid "guestfs_chmod"
8038 #: ../src/guestfs-actions.pod:1047
8042 " guestfs_chmod (guestfs_h *g,\n"
8044 " const char *path);\n"
8049 #: ../src/guestfs-actions.pod:1052 ../fish/guestfish-actions.pod:699
8051 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are"
8056 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:702
8058 "I<Note>: When using this command from guestfish, C<mode> by default would be"
8059 " decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8064 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4584
8065 #: ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4812
8066 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:706
8067 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3199
8068 #: ../fish/guestfish-actions.pod:3209 ../fish/guestfish-actions.pod:3219
8069 msgid "The mode actually set is affected by the umask."
8073 #: ../src/guestfs-actions.pod:1065
8074 msgid "guestfs_chown"
8078 #: ../src/guestfs-actions.pod:1067
8082 " guestfs_chown (guestfs_h *g,\n"
8085 " const char *path);\n"
8090 #: ../src/guestfs-actions.pod:1073 ../fish/guestfish-actions.pod:712
8091 msgid "Change the file owner to C<owner> and group to C<group>."
8095 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3655
8096 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
8098 "Only numeric uid and gid are supported. If you want to use names, you will "
8099 "need to locate and parse the password file yourself (Augeas support makes "
8100 "this relatively easy)."
8104 #: ../src/guestfs-actions.pod:1083
8105 msgid "guestfs_command"
8109 #: ../src/guestfs-actions.pod:1085
8113 " guestfs_command (guestfs_h *g,\n"
8114 " char *const *arguments);\n"
8119 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:722
8121 "This call runs a command from the guest filesystem. The filesystem must be "
8122 "mounted, and must contain a compatible operating system (ie. something "
8123 "Linux, with the same or compatible processor architecture)."
8127 #: ../src/guestfs-actions.pod:1094
8129 "The single parameter is an argv-style list of arguments. The first element "
8130 "is the name of the program to run. Subsequent elements are parameters. The"
8131 " list must be non-empty (ie. must contain a program name). Note that the "
8132 "command runs directly, and is I<not> invoked via the shell (see "
8137 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:734
8138 msgid "The return value is anything printed to I<stdout> by the command."
8142 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:737
8144 "If the command returns a non-zero exit status, then this function returns an"
8145 " error message. The error message string is the content of I<stderr> from "
8150 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:741
8152 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
8153 "C</bin>. If you require a program from another location, you should provide"
8154 " the full path in the first parameter."
8158 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:746
8160 "Shared libraries and data files required by the program must be available on"
8161 " filesystems which are mounted in the correct places. It is the caller's "
8162 "responsibility to ensure all filesystems that are needed are mounted at the "
8167 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145
8168 #: ../src/guestfs-actions.pod:1610
8169 msgid "(Added in 0.9.1)"
8173 #: ../src/guestfs-actions.pod:1127
8174 msgid "guestfs_command_lines"
8178 #: ../src/guestfs-actions.pod:1129
8182 " guestfs_command_lines (guestfs_h *g,\n"
8183 " char *const *arguments);\n"
8188 #: ../src/guestfs-actions.pod:1133
8190 "This is the same as C<guestfs_command>, but splits the result into a list of"
8195 #: ../src/guestfs-actions.pod:1136
8196 msgid "See also: C<guestfs_sh_lines>"
8200 #: ../src/guestfs-actions.pod:1147
8201 msgid "guestfs_config"
8205 #: ../src/guestfs-actions.pod:1149
8209 " guestfs_config (guestfs_h *g,\n"
8210 " const char *qemuparam,\n"
8211 " const char *qemuvalue);\n"
8216 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:771
8218 "This can be used to add arbitrary qemu command line parameters of the form "
8219 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8220 "setting some parameters which would interfere with parameters that we use."
8224 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:776
8225 msgid "The first character of C<param> string must be a C<-> (dash)."
8229 #: ../src/guestfs-actions.pod:1161 ../fish/guestfish-actions.pod:778
8230 msgid "C<value> can be NULL."
8234 #: ../src/guestfs-actions.pod:1167
8235 msgid "guestfs_copy_size"
8239 #: ../src/guestfs-actions.pod:1169
8243 " guestfs_copy_size (guestfs_h *g,\n"
8244 " const char *src,\n"
8245 " const char *dest,\n"
8251 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:784
8253 "This command copies exactly C<size> bytes from one source device or file "
8254 "C<src> to another destination device or file C<dest>."
8258 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:787
8260 "Note this will fail if the source is too short or if the destination is not "
8265 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306
8266 #: ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382
8267 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781
8268 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:7228
8269 #: ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7763
8270 #: ../src/guestfs-actions.pod:7782
8272 "This long-running command can generate progress notification messages so "
8273 "that the caller can display a progress bar or indicator. To receive these "
8274 "messages, the caller must register a progress event callback. See "
8275 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
8279 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4360
8280 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7463
8281 #: ../src/guestfs-actions.pod:7483 ../src/guestfs-actions.pod:7569
8282 msgid "(Added in 1.0.87)"
8286 #: ../src/guestfs-actions.pod:1190
8291 #: ../src/guestfs-actions.pod:1192
8295 " guestfs_cp (guestfs_h *g,\n"
8296 " const char *src,\n"
8297 " const char *dest);\n"
8302 #: ../src/guestfs-actions.pod:1197 ../fish/guestfish-actions.pod:794
8304 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8305 "destination filename or destination directory."
8309 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216
8310 #: ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362
8311 #: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5114
8312 #: ../src/guestfs-actions.pod:5583
8313 msgid "(Added in 1.0.18)"
8317 #: ../src/guestfs-actions.pod:1204
8318 msgid "guestfs_cp_a"
8322 #: ../src/guestfs-actions.pod:1206
8326 " guestfs_cp_a (guestfs_h *g,\n"
8327 " const char *src,\n"
8328 " const char *dest);\n"
8333 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:801
8335 "This copies a file or directory from C<src> to C<dest> recursively using the"
8336 " C<cp -a> command."
8340 #: ../src/guestfs-actions.pod:1218
8345 #: ../src/guestfs-actions.pod:1220
8349 " guestfs_dd (guestfs_h *g,\n"
8350 " const char *src,\n"
8351 " const char *dest);\n"
8356 #: ../src/guestfs-actions.pod:1225 ../fish/guestfish-actions.pod:808
8358 "This command copies from one source device or file C<src> to another "
8359 "destination device or file C<dest>. Normally you would use this to copy to "
8360 "or from a device or partition, for example to duplicate a filesystem."
8364 #: ../src/guestfs-actions.pod:1230
8366 "If the destination is a device, it must be as large or larger than the "
8367 "source file or device, otherwise the copy will fail. This command cannot do"
8368 " partial copies (see C<guestfs_copy_size>)."
8372 #: ../src/guestfs-actions.pod:1238
8377 #: ../src/guestfs-actions.pod:1240
8381 " guestfs_df (guestfs_h *g);\n"
8386 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:821
8387 msgid "This command runs the C<df> command to report disk space used."
8391 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
8393 "This command is mostly useful for interactive sessions. It is I<not> "
8394 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8399 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269
8400 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2359
8401 #: ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2451
8402 #: ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:5014
8403 #: ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6990
8404 #: ../src/guestfs-actions.pod:7609 ../src/guestfs-actions.pod:7622
8405 #: ../src/guestfs-actions.pod:7635
8406 msgid "(Added in 1.0.54)"
8410 #: ../src/guestfs-actions.pod:1254
8411 msgid "guestfs_df_h"
8415 #: ../src/guestfs-actions.pod:1256
8419 " guestfs_df_h (guestfs_h *g);\n"
8424 #: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:831
8426 "This command runs the C<df -h> command to report disk space used in human-"
8431 #: ../src/guestfs-actions.pod:1271
8432 msgid "guestfs_dmesg"
8436 #: ../src/guestfs-actions.pod:1273
8440 " guestfs_dmesg (guestfs_h *g);\n"
8445 #: ../src/guestfs-actions.pod:1276 ../fish/guestfish-actions.pod:842
8447 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8448 "This is sometimes useful for extended debugging of problems."
8452 #: ../src/guestfs-actions.pod:1280
8454 "Another way to get the same information is to enable verbose messages with "
8455 "C<guestfs_set_verbose> or by setting the environment variable "
8456 "C<LIBGUESTFS_DEBUG=1> before running the program."
8460 #: ../src/guestfs-actions.pod:1290
8461 msgid "guestfs_download"
8465 #: ../src/guestfs-actions.pod:1292
8469 " guestfs_download (guestfs_h *g,\n"
8470 " const char *remotefilename,\n"
8471 " const char *filename);\n"
8476 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
8477 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
8479 "Download file C<remotefilename> and save it as C<filename> on the local "
8484 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7222
8485 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4797
8486 msgid "C<filename> can also be a named pipe."
8490 #: ../src/guestfs-actions.pod:1302
8491 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8495 #: ../src/guestfs-actions.pod:1313
8496 msgid "guestfs_download_offset"
8500 #: ../src/guestfs-actions.pod:1315
8504 " guestfs_download_offset (guestfs_h *g,\n"
8505 " const char *remotefilename,\n"
8506 " const char *filename,\n"
8507 " int64_t offset,\n"
8513 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:871
8515 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8516 "region must be within the file or device)."
8520 #: ../src/guestfs-actions.pod:1328
8522 "Note that there is no limit on the amount of data that can be downloaded "
8523 "with this call, unlike with C<guestfs_pread>, and this call always reads the"
8524 " full amount unless an error occurs."
8528 #: ../src/guestfs-actions.pod:1333
8529 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8533 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7267
8534 msgid "(Added in 1.5.17)"
8538 #: ../src/guestfs-actions.pod:1344
8539 msgid "guestfs_drop_caches"
8543 #: ../src/guestfs-actions.pod:1346
8547 " guestfs_drop_caches (guestfs_h *g,\n"
8548 " int whattodrop);\n"
8553 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:887
8555 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8556 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8557 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8561 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:892
8562 msgid "Setting C<whattodrop> to 3 should drop everything."
8566 #: ../src/guestfs-actions.pod:1357 ../fish/guestfish-actions.pod:894
8568 "This automatically calls L<sync(2)> before the operation, so that the "
8569 "maximum guest memory is freed."
8573 #: ../src/guestfs-actions.pod:1364
8578 #: ../src/guestfs-actions.pod:1366
8582 " guestfs_du (guestfs_h *g,\n"
8583 " const char *path);\n"
8588 #: ../src/guestfs-actions.pod:1370 ../fish/guestfish-actions.pod:901
8590 "This command runs the C<du -s> command to estimate file space usage for "
8595 #: ../src/guestfs-actions.pod:1373 ../fish/guestfish-actions.pod:904
8597 "C<path> can be a file or a directory. If C<path> is a directory then the "
8598 "estimate includes the contents of the directory and all subdirectories "
8603 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:908
8605 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8609 #: ../src/guestfs-actions.pod:1389
8610 msgid "guestfs_e2fsck_f"
8614 #: ../src/guestfs-actions.pod:1391
8618 " guestfs_e2fsck_f (guestfs_h *g,\n"
8619 " const char *device);\n"
8624 #: ../src/guestfs-actions.pod:1395 ../fish/guestfish-actions.pod:915
8626 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8627 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be"
8632 #: ../src/guestfs-actions.pod:1399
8634 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8635 "Normally you should use C<guestfs_fsck>."
8639 #: ../src/guestfs-actions.pod:1404
8640 msgid "(Added in 1.0.29)"
8644 #: ../src/guestfs-actions.pod:1406
8645 msgid "guestfs_echo_daemon"
8649 #: ../src/guestfs-actions.pod:1408
8653 " guestfs_echo_daemon (guestfs_h *g,\n"
8654 " char *const *words);\n"
8659 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:926
8661 "This command concatenates the list of C<words> passed with single spaces "
8662 "between them and returns the resulting string."
8666 #: ../src/guestfs-actions.pod:1415 ../fish/guestfish-actions.pod:929
8667 msgid "You can use this command to test the connection through to the daemon."
8671 #: ../src/guestfs-actions.pod:1417
8672 msgid "See also C<guestfs_ping_daemon>."
8676 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2167
8677 #: ../src/guestfs-actions.pod:6438
8678 msgid "(Added in 1.0.69)"
8682 #: ../src/guestfs-actions.pod:1424
8683 msgid "guestfs_egrep"
8687 #: ../src/guestfs-actions.pod:1426
8691 " guestfs_egrep (guestfs_h *g,\n"
8692 " const char *regex,\n"
8693 " const char *path);\n"
8698 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:937
8700 "This calls the external C<egrep> program and returns the matching lines."
8704 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460
8705 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563
8706 #: ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2297
8707 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2472
8708 #: ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:2500
8709 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2568
8710 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:3850
8711 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877
8712 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4892
8713 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5966
8714 #: ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6846
8715 #: ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872
8716 #: ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6907
8717 #: ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6933
8718 #: ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7744
8719 #: ../src/guestfs-actions.pod:7830 ../src/guestfs-actions.pod:7849
8720 #: ../src/guestfs-actions.pod:7895 ../src/guestfs-actions.pod:7914
8721 msgid "(Added in 1.0.66)"
8725 #: ../src/guestfs-actions.pod:1443
8726 msgid "guestfs_egrepi"
8730 #: ../src/guestfs-actions.pod:1445
8734 " guestfs_egrepi (guestfs_h *g,\n"
8735 " const char *regex,\n"
8736 " const char *path);\n"
8741 #: ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:947
8743 "This calls the external C<egrep -i> program and returns the matching lines."
8747 #: ../src/guestfs-actions.pod:1462
8748 msgid "guestfs_equal"
8752 #: ../src/guestfs-actions.pod:1464
8756 " guestfs_equal (guestfs_h *g,\n"
8757 " const char *file1,\n"
8758 " const char *file2);\n"
8763 #: ../src/guestfs-actions.pod:1469 ../fish/guestfish-actions.pod:957
8765 "This compares the two files C<file1> and C<file2> and returns true if their "
8766 "content is exactly equal, or false otherwise."
8770 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:960
8771 msgid "The external L<cmp(1)> program is used for the comparison."
8775 #: ../src/guestfs-actions.pod:1478
8776 msgid "guestfs_exists"
8780 #: ../src/guestfs-actions.pod:1480
8784 " guestfs_exists (guestfs_h *g,\n"
8785 " const char *path);\n"
8790 #: ../src/guestfs-actions.pod:1484 ../fish/guestfish-actions.pod:966
8792 "This returns C<true> if and only if there is a file, directory (or anything)"
8793 " with the given C<path> name."
8797 #: ../src/guestfs-actions.pod:1487
8798 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8802 #: ../src/guestfs-actions.pod:1493
8803 msgid "guestfs_fallocate"
8807 #: ../src/guestfs-actions.pod:1495
8811 " guestfs_fallocate (guestfs_h *g,\n"
8812 " const char *path,\n"
8818 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
8819 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8821 "This command preallocates a file (containing zero bytes) named C<path> of "
8822 "size C<len> bytes. If the file exists already, it is overwritten."
8826 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:979
8828 "Do not confuse this with the guestfish-specific C<alloc> command which "
8829 "allocates a file in the host and attaches it as a device."
8833 #: ../src/guestfs-actions.pod:1510 ../fish/guestfish-actions.pod:983
8835 "This function is deprecated. In new code, use the C<fallocate64> call "
8840 #: ../src/guestfs-actions.pod:1519
8841 msgid "guestfs_fallocate64"
8845 #: ../src/guestfs-actions.pod:1521
8849 " guestfs_fallocate64 (guestfs_h *g,\n"
8850 " const char *path,\n"
8856 #: ../src/guestfs-actions.pod:1530
8858 "Note that this call allocates disk blocks for the file. To create a sparse "
8859 "file use C<guestfs_truncate_size> instead."
8863 #: ../src/guestfs-actions.pod:1533
8865 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8866 "oversight it only allowed 30 bit lengths to be specified, effectively "
8867 "limiting the maximum size of files created through that call to 1GB."
8871 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1006
8873 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8874 "commands which create a file in the host and attach it as a device."
8878 #: ../src/guestfs-actions.pod:1544
8879 msgid "(Added in 1.3.17)"
8883 #: ../src/guestfs-actions.pod:1546
8884 msgid "guestfs_fgrep"
8888 #: ../src/guestfs-actions.pod:1548
8892 " guestfs_fgrep (guestfs_h *g,\n"
8893 " const char *pattern,\n"
8894 " const char *path);\n"
8899 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1014
8901 "This calls the external C<fgrep> program and returns the matching lines."
8905 #: ../src/guestfs-actions.pod:1565
8906 msgid "guestfs_fgrepi"
8910 #: ../src/guestfs-actions.pod:1567
8914 " guestfs_fgrepi (guestfs_h *g,\n"
8915 " const char *pattern,\n"
8916 " const char *path);\n"
8921 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1024
8923 "This calls the external C<fgrep -i> program and returns the matching lines."
8927 #: ../src/guestfs-actions.pod:1584
8928 msgid "guestfs_file"
8932 #: ../src/guestfs-actions.pod:1586
8936 " guestfs_file (guestfs_h *g,\n"
8937 " const char *path);\n"
8942 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1034
8944 "This call uses the standard L<file(1)> command to determine the type or "
8945 "contents of the file."
8949 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1037
8951 "This call will also transparently look inside various types of compressed "
8956 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1040
8958 "The exact command which runs is C<file -zb path>. Note in particular that "
8959 "the filename is not prepended to the output (the I<-b> option)."
8963 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1044
8965 "The output depends on the output of the underlying L<file(1)> command and it"
8966 " can change in future in ways beyond our control. In other words, the "
8967 "output is not guaranteed by the ABI."
8971 #: ../src/guestfs-actions.pod:1604
8973 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8974 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8978 #: ../src/guestfs-actions.pod:1612
8979 msgid "guestfs_file_architecture"
8983 #: ../src/guestfs-actions.pod:1614
8987 " guestfs_file_architecture (guestfs_h *g,\n"
8988 " const char *filename);\n"
8993 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1055
8995 "This detects the architecture of the binary C<filename>, and returns it if "
9000 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1058
9001 msgid "Currently defined architectures are:"
9005 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1062
9010 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1064
9012 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9013 "irrespective of the precise processor requirements of the binary."
9017 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1067
9022 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1069
9023 msgid "64 bit x86-64."
9027 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1071
9032 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1073
9033 msgid "32 bit SPARC."
9037 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1075
9042 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1077
9043 msgid "64 bit SPARC V9 and above."
9047 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1079
9052 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1081
9053 msgid "Intel Itanium."
9057 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1083
9062 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1085
9063 msgid "32 bit Power PC."
9067 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1087
9072 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1089
9073 msgid "64 bit Power PC."
9077 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1093
9078 msgid "Libguestfs may return other architecture strings in future."
9082 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1095
9083 msgid "The function works on at least the following types of files:"
9087 #: ../src/guestfs-actions.pod:1664 ../fish/guestfish-actions.pod:1101
9088 msgid "many types of Un*x and Linux binary"
9092 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1105
9093 msgid "many types of Un*x and Linux shared library"
9097 #: ../src/guestfs-actions.pod:1672 ../fish/guestfish-actions.pod:1109
9098 msgid "Windows Win32 and Win64 binaries"
9102 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1113
9103 msgid "Windows Win32 and Win64 DLLs"
9107 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1115
9108 msgid "Win32 binaries and DLLs return C<i386>."
9112 #: ../src/guestfs-actions.pod:1680 ../fish/guestfish-actions.pod:1117
9113 msgid "Win64 binaries and DLLs return C<x86_64>."
9117 #: ../src/guestfs-actions.pod:1684 ../fish/guestfish-actions.pod:1121
9118 msgid "Linux kernel modules"
9122 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1125
9123 msgid "Linux new-style initrd images"
9127 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1129
9128 msgid "some non-x86 Linux vmlinuz kernels"
9132 #: ../src/guestfs-actions.pod:1696 ../fish/guestfish-actions.pod:1133
9133 msgid "What it can't do currently:"
9137 #: ../src/guestfs-actions.pod:1702 ../fish/guestfish-actions.pod:1139
9138 msgid "static libraries (libfoo.a)"
9142 #: ../src/guestfs-actions.pod:1706 ../fish/guestfish-actions.pod:1143
9143 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9147 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1147
9148 msgid "x86 Linux vmlinuz kernels"
9152 #: ../src/guestfs-actions.pod:1712 ../fish/guestfish-actions.pod:1149
9154 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9155 "compressed code, and are horribly hard to unpack. If you want to find the "
9156 "architecture of a kernel, use the architecture of the associated initrd or "
9157 "kernel module(s) instead."
9161 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885
9162 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2601
9163 #: ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2757
9164 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2962
9165 #: ../src/guestfs-actions.pod:3002 ../src/guestfs-actions.pod:3077
9166 #: ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3407
9167 #: ../src/guestfs-actions.pod:3539
9168 msgid "(Added in 1.5.3)"
9172 #: ../src/guestfs-actions.pod:1724
9173 msgid "guestfs_filesize"
9177 #: ../src/guestfs-actions.pod:1726
9181 " guestfs_filesize (guestfs_h *g,\n"
9182 " const char *file);\n"
9187 #: ../src/guestfs-actions.pod:1730 ../fish/guestfish-actions.pod:1160
9188 msgid "This command returns the size of C<file> in bytes."
9192 #: ../src/guestfs-actions.pod:1732
9194 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9195 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9196 "devices, use C<guestfs_blockdev_getsize64>."
9200 #: ../src/guestfs-actions.pod:1738
9201 msgid "(Added in 1.0.82)"
9205 #: ../src/guestfs-actions.pod:1740
9206 msgid "guestfs_fill"
9210 #: ../src/guestfs-actions.pod:1742
9214 " guestfs_fill (guestfs_h *g,\n"
9217 " const char *path);\n"
9222 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1170
9224 "This command creates a new file called C<path>. The initial content of the "
9225 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
9230 #: ../src/guestfs-actions.pod:1752
9232 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9233 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9234 "bytes use C<guestfs_fill_pattern>."
9238 #: ../src/guestfs-actions.pod:1764
9239 msgid "(Added in 1.0.79)"
9243 #: ../src/guestfs-actions.pod:1766
9244 msgid "guestfs_fill_pattern"
9248 #: ../src/guestfs-actions.pod:1768
9252 " guestfs_fill_pattern (guestfs_h *g,\n"
9253 " const char *pattern,\n"
9255 " const char *path);\n"
9260 #: ../src/guestfs-actions.pod:1774
9262 "This function is like C<guestfs_fill> except that it creates a new file of "
9263 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9264 "pattern is truncated if necessary to ensure the length of the file is "
9265 "exactly C<len> bytes."
9269 #: ../src/guestfs-actions.pod:1786
9270 msgid "(Added in 1.3.12)"
9274 #: ../src/guestfs-actions.pod:1788
9275 msgid "guestfs_find"
9279 #: ../src/guestfs-actions.pod:1790
9283 " guestfs_find (guestfs_h *g,\n"
9284 " const char *directory);\n"
9289 #: ../src/guestfs-actions.pod:1794 ../fish/guestfish-actions.pod:1192
9291 "This command lists out all files and directories, recursively, starting at "
9292 "C<directory>. It is essentially equivalent to running the shell command "
9293 "C<find directory -print> but some post-processing happens on the output, "
9298 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1197
9300 "This returns a list of strings I<without any prefix>. Thus if the directory"
9305 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1200
9315 #: ../src/guestfs-actions.pod:1806
9317 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9321 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1207
9332 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1212
9334 "If C<directory> is not a directory, then this command returns an error."
9338 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1215
9339 msgid "The returned list is sorted."
9343 #: ../src/guestfs-actions.pod:1819
9344 msgid "See also C<guestfs_find0>."
9348 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4297
9349 #: ../src/guestfs-actions.pod:6001
9350 msgid "(Added in 1.0.27)"
9354 #: ../src/guestfs-actions.pod:1830
9355 msgid "guestfs_find0"
9359 #: ../src/guestfs-actions.pod:1832
9363 " guestfs_find0 (guestfs_h *g,\n"
9364 " const char *directory,\n"
9365 " const char *files);\n"
9370 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1226
9372 "This command lists out all files and directories, recursively, starting at "
9373 "C<directory>, placing the resulting list in the external file called "
9378 #: ../src/guestfs-actions.pod:1841
9380 "This command works the same way as C<guestfs_find> with the following "
9385 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1237
9386 msgid "The resulting list is written to an external file."
9390 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1241
9392 "Items (filenames) in the result are separated by C<\\0> characters. See "
9393 "L<find(1)> option I<-print0>."
9397 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1246
9398 msgid "This command is not limited in the number of names that it can return."
9402 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1251
9403 msgid "The result list is not sorted."
9407 #: ../src/guestfs-actions.pod:1868
9408 msgid "(Added in 1.0.74)"
9412 #: ../src/guestfs-actions.pod:1870
9413 msgid "guestfs_findfs_label"
9417 #: ../src/guestfs-actions.pod:1872
9421 " guestfs_findfs_label (guestfs_h *g,\n"
9422 " const char *label);\n"
9427 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1261
9429 "This command searches the filesystems and returns the one which has the "
9430 "given label. An error is returned if no such filesystem can be found."
9434 #: ../src/guestfs-actions.pod:1880
9435 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9439 #: ../src/guestfs-actions.pod:1887
9440 msgid "guestfs_findfs_uuid"
9444 #: ../src/guestfs-actions.pod:1889
9448 " guestfs_findfs_uuid (guestfs_h *g,\n"
9449 " const char *uuid);\n"
9454 #: ../src/guestfs-actions.pod:1893 ../fish/guestfish-actions.pod:1271
9456 "This command searches the filesystems and returns the one which has the "
9457 "given UUID. An error is returned if no such filesystem can be found."
9461 #: ../src/guestfs-actions.pod:1897
9462 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9466 #: ../src/guestfs-actions.pod:1904
9467 msgid "guestfs_fsck"
9471 #: ../src/guestfs-actions.pod:1906
9475 " guestfs_fsck (guestfs_h *g,\n"
9476 " const char *fstype,\n"
9477 " const char *device);\n"
9482 #: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1281
9484 "This runs the filesystem checker (fsck) on C<device> which should have "
9485 "filesystem type C<fstype>."
9489 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1284
9491 "The returned integer is the status. See L<fsck(8)> for the list of status "
9492 "codes from C<fsck>."
9496 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1293
9497 msgid "Multiple status codes can be summed together."
9501 #: ../src/guestfs-actions.pod:1927 ../fish/guestfish-actions.pod:1297
9503 "A non-zero return code can mean \"success\", for example if errors have been"
9504 " corrected on the filesystem."
9508 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1302
9509 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9513 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1307
9515 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9519 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7768
9520 msgid "(Added in 1.0.16)"
9524 #: ../src/guestfs-actions.pod:1943
9525 msgid "guestfs_get_append"
9529 #: ../src/guestfs-actions.pod:1945
9533 " guestfs_get_append (guestfs_h *g);\n"
9538 #: ../src/guestfs-actions.pod:1948 ../fish/guestfish-actions.pod:1313
9540 "Return the additional kernel options which are added to the guest kernel "
9545 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1316
9546 msgid "If C<NULL> then no options are added."
9550 #: ../src/guestfs-actions.pod:1953
9552 "This function returns a string which may be NULL. There is no way to return"
9553 " an error from this function. The string is owned by the guest handle and "
9554 "must I<not> be freed."
9558 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5679
9559 #: ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6601
9560 #: ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6636
9561 #: ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:7414
9562 #: ../src/guestfs-actions.pod:7429 ../src/guestfs-actions.pod:7811
9563 msgid "(Added in 1.0.26)"
9567 #: ../src/guestfs-actions.pod:1959
9568 msgid "guestfs_get_attach_method"
9572 #: ../src/guestfs-actions.pod:1961
9576 " guestfs_get_attach_method (guestfs_h *g);\n"
9581 #: ../src/guestfs-actions.pod:1964
9582 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9586 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6191
9587 msgid "(Added in 1.9.8)"
9591 #: ../src/guestfs-actions.pod:1971
9592 msgid "guestfs_get_autosync"
9596 #: ../src/guestfs-actions.pod:1973
9600 " guestfs_get_autosync (guestfs_h *g);\n"
9605 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1328
9606 msgid "Get the autosync flag."
9610 #: ../src/guestfs-actions.pod:1982
9611 msgid "guestfs_get_direct"
9615 #: ../src/guestfs-actions.pod:1984
9619 " guestfs_get_direct (guestfs_h *g);\n"
9624 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1334
9625 msgid "Return the direct appliance mode flag."
9629 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6232
9630 msgid "(Added in 1.0.72)"
9634 #: ../src/guestfs-actions.pod:1993
9635 msgid "guestfs_get_e2label"
9639 #: ../src/guestfs-actions.pod:1995
9643 " guestfs_get_e2label (guestfs_h *g,\n"
9644 " const char *device);\n"
9649 #: ../src/guestfs-actions.pod:1999 ../fish/guestfish-actions.pod:1340
9651 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9655 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1343
9657 "This function is deprecated. In new code, use the C<vfs_label> call "
9662 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033
9663 #: ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6269
9664 msgid "(Added in 1.0.15)"
9668 #: ../src/guestfs-actions.pod:2014
9669 msgid "guestfs_get_e2uuid"
9673 #: ../src/guestfs-actions.pod:2016
9677 " guestfs_get_e2uuid (guestfs_h *g,\n"
9678 " const char *device);\n"
9683 #: ../src/guestfs-actions.pod:2020 ../fish/guestfish-actions.pod:1354
9685 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9689 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1357
9691 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9695 #: ../src/guestfs-actions.pod:2035
9696 msgid "guestfs_get_memsize"
9700 #: ../src/guestfs-actions.pod:2037
9704 " guestfs_get_memsize (guestfs_h *g);\n"
9709 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1368
9711 "This gets the memory size in megabytes allocated to the qemu subprocess."
9715 #: ../src/guestfs-actions.pod:2043
9717 "If C<guestfs_set_memsize> was not called on this handle, and if "
9718 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default"
9719 " value for memsize."
9723 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2137
9724 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6409
9725 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432
9726 #: ../fish/guestfish-actions.pod:4157 ../fish/guestfish-actions.pod:4259
9728 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9732 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4588
9733 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816
9734 #: ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847
9735 #: ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877
9736 #: ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:6290
9737 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:7183
9738 msgid "(Added in 1.0.55)"
9742 #: ../src/guestfs-actions.pod:2054
9743 msgid "guestfs_get_network"
9747 #: ../src/guestfs-actions.pod:2056
9751 " guestfs_get_network (guestfs_h *g);\n"
9756 #: ../src/guestfs-actions.pod:2059 ../fish/guestfish-actions.pod:1382
9757 msgid "This returns the enable network flag."
9761 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6309
9762 msgid "(Added in 1.5.4)"
9766 #: ../src/guestfs-actions.pod:2065
9767 msgid "guestfs_get_path"
9771 #: ../src/guestfs-actions.pod:2067
9775 " guestfs_get_path (guestfs_h *g);\n"
9780 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1388
9781 msgid "Return the current search path."
9785 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1390
9787 "This is always non-NULL. If it wasn't set already, then this will return "
9792 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2113
9794 "This function returns a string, or NULL on error. The string is owned by "
9795 "the guest handle and must I<not> be freed."
9799 #: ../src/guestfs-actions.pod:2080
9800 msgid "guestfs_get_pgroup"
9804 #: ../src/guestfs-actions.pod:2082
9808 " guestfs_get_pgroup (guestfs_h *g);\n"
9813 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1397
9814 msgid "This returns the process group flag."
9818 #: ../src/guestfs-actions.pod:2089
9819 msgid "guestfs_get_pid"
9823 #: ../src/guestfs-actions.pod:2091
9827 " guestfs_get_pid (guestfs_h *g);\n"
9832 #: ../src/guestfs-actions.pod:2094 ../fish/guestfish-actions.pod:1405
9834 "Return the process ID of the qemu subprocess. If there is no qemu "
9835 "subprocess, then this will return an error."
9839 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
9840 msgid "This is an internal call used for debugging and testing."
9844 #: ../src/guestfs-actions.pod:2101
9845 msgid "(Added in 1.0.56)"
9849 #: ../src/guestfs-actions.pod:2103
9850 msgid "guestfs_get_qemu"
9854 #: ../src/guestfs-actions.pod:2105
9858 " guestfs_get_qemu (guestfs_h *g);\n"
9863 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1414
9864 msgid "Return the current qemu binary."
9868 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1416
9870 "This is always non-NULL. If it wasn't set already, then this will return "
9871 "the default qemu binary name."
9875 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:6371
9876 msgid "(Added in 1.0.6)"
9880 #: ../src/guestfs-actions.pod:2118
9881 msgid "guestfs_get_recovery_proc"
9885 #: ../src/guestfs-actions.pod:2120
9889 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9894 #: ../src/guestfs-actions.pod:2123 ../fish/guestfish-actions.pod:1423
9895 msgid "Return the recovery process enabled flag."
9899 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3661
9900 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4395
9901 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:5609
9902 #: ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6395
9903 #: ../src/guestfs-actions.pod:7086 ../src/guestfs-actions.pod:7106
9904 #: ../src/guestfs-actions.pod:7298
9905 msgid "(Added in 1.0.77)"
9909 #: ../src/guestfs-actions.pod:2129
9910 msgid "guestfs_get_selinux"
9914 #: ../src/guestfs-actions.pod:2131
9918 " guestfs_get_selinux (guestfs_h *g);\n"
9923 #: ../src/guestfs-actions.pod:2134
9925 "This returns the current setting of the selinux flag which is passed to the "
9926 "appliance at boot time. See C<guestfs_set_selinux>."
9930 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2205
9931 #: ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:6472
9932 msgid "(Added in 1.0.67)"
9936 #: ../src/guestfs-actions.pod:2144
9937 msgid "guestfs_get_state"
9941 #: ../src/guestfs-actions.pod:2146
9945 " guestfs_get_state (guestfs_h *g);\n"
9950 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1439
9952 "This returns the current state as an opaque integer. This is only useful "
9953 "for printing debug and internal error messages."
9957 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3432
9958 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3522
9959 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:1442
9960 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2380
9961 #: ../fish/guestfish-actions.pod:2418 ../fish/guestfish-actions.pod:2434
9962 msgid "For more information on states, see L<guestfs(3)>."
9966 #: ../src/guestfs-actions.pod:2158
9967 msgid "guestfs_get_trace"
9971 #: ../src/guestfs-actions.pod:2160
9975 " guestfs_get_trace (guestfs_h *g);\n"
9980 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1448
9981 msgid "Return the command trace flag."
9985 #: ../src/guestfs-actions.pod:2169
9986 msgid "guestfs_get_umask"
9990 #: ../src/guestfs-actions.pod:2171
9994 " guestfs_get_umask (guestfs_h *g);\n"
9999 #: ../src/guestfs-actions.pod:2174
10001 "Return the current umask. By default the umask is C<022> unless it has been"
10002 " set by calling C<guestfs_umask>."
10006 #: ../src/guestfs-actions.pod:2181
10007 msgid "guestfs_get_verbose"
10011 #: ../src/guestfs-actions.pod:2183
10015 " guestfs_get_verbose (guestfs_h *g);\n"
10020 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
10021 msgid "This returns the verbose messages flag."
10025 #: ../src/guestfs-actions.pod:2192
10026 msgid "guestfs_getcon"
10030 #: ../src/guestfs-actions.pod:2194
10034 " guestfs_getcon (guestfs_h *g);\n"
10039 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1467
10040 msgid "This gets the SELinux security context of the daemon."
10044 #: ../src/guestfs-actions.pod:2199
10046 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10050 #: ../src/guestfs-actions.pod:2207
10051 msgid "guestfs_getxattr"
10055 #: ../src/guestfs-actions.pod:2209
10059 " guestfs_getxattr (guestfs_h *g,\n"
10060 " const char *path,\n"
10061 " const char *name,\n"
10062 " size_t *size_r);\n"
10067 #: ../src/guestfs-actions.pod:2215
10069 "Get a single extended attribute from file C<path> named C<name>. This call "
10070 "follows symlinks. If you want to lookup an extended attribute for the "
10071 "symlink itself, use C<guestfs_lgetxattr>."
10075 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:3675
10077 "Normally it is better to get all extended attributes from a file in one go "
10078 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10079 "implementations are buggy and do not provide a way to list out attributes. "
10080 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10081 "extended attributes you want in advance and call this function."
10085 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
10086 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
10088 "Extended attribute values are blobs of binary data. If there is no extended"
10089 " attribute named C<name>, this returns an error."
10093 #: ../src/guestfs-actions.pod:2229
10094 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10098 #: ../src/guestfs-actions.pod:2231 ../src/guestfs-actions.pod:2422
10099 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:3687
10100 #: ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5628
10101 #: ../src/guestfs-actions.pod:5809
10103 "This function returns a buffer, or NULL on error. The size of the returned "
10104 "buffer is written to C<*size_r>. I<The caller must free the returned buffer"
10109 #: ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:3691
10110 msgid "(Added in 1.7.24)"
10114 #: ../src/guestfs-actions.pod:2237
10115 msgid "guestfs_getxattrs"
10119 #: ../src/guestfs-actions.pod:2239
10122 " struct guestfs_xattr_list *\n"
10123 " guestfs_getxattrs (guestfs_h *g,\n"
10124 " const char *path);\n"
10129 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1496
10131 "This call lists the extended attributes of the file or directory C<path>."
10135 #: ../src/guestfs-actions.pod:2246 ../fish/guestfish-actions.pod:1499
10137 "At the system call level, this is a combination of the L<listxattr(2)> and "
10138 "L<getxattr(2)> calls."
10142 #: ../src/guestfs-actions.pod:2249
10143 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10147 #: ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:3703
10148 #: ../src/guestfs-actions.pod:4391
10150 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was"
10151 " an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10155 #: ../src/guestfs-actions.pod:2255 ../src/guestfs-actions.pod:3707
10156 #: ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3942
10157 #: ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6491
10158 #: ../src/guestfs-actions.pod:7876
10159 msgid "(Added in 1.0.59)"
10163 #: ../src/guestfs-actions.pod:2257
10164 msgid "guestfs_glob_expand"
10168 #: ../src/guestfs-actions.pod:2259
10172 " guestfs_glob_expand (guestfs_h *g,\n"
10173 " const char *pattern);\n"
10178 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1508
10180 "This command searches for all the pathnames matching C<pattern> according to"
10181 " the wildcard expansion rules used by the shell."
10185 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1512
10187 "If no paths match, then this returns an empty list (note: not an error)."
10191 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1515
10193 "It is just a wrapper around the C L<glob(3)> function with flags "
10194 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
10198 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6684
10199 #: ../src/guestfs-actions.pod:6701
10200 msgid "(Added in 1.0.50)"
10204 #: ../src/guestfs-actions.pod:2280
10205 msgid "guestfs_grep"
10209 #: ../src/guestfs-actions.pod:2282
10213 " guestfs_grep (guestfs_h *g,\n"
10214 " const char *regex,\n"
10215 " const char *path);\n"
10220 #: ../src/guestfs-actions.pod:2287 ../fish/guestfish-actions.pod:1523
10222 "This calls the external C<grep> program and returns the matching lines."
10226 #: ../src/guestfs-actions.pod:2299
10227 msgid "guestfs_grepi"
10231 #: ../src/guestfs-actions.pod:2301
10235 " guestfs_grepi (guestfs_h *g,\n"
10236 " const char *regex,\n"
10237 " const char *path);\n"
10242 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1533
10244 "This calls the external C<grep -i> program and returns the matching lines."
10248 #: ../src/guestfs-actions.pod:2318
10249 msgid "guestfs_grub_install"
10253 #: ../src/guestfs-actions.pod:2320
10257 " guestfs_grub_install (guestfs_h *g,\n"
10258 " const char *root,\n"
10259 " const char *device);\n"
10264 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1543
10266 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with"
10267 " the root directory being C<root>."
10271 #: ../src/guestfs-actions.pod:2328 ../fish/guestfish-actions.pod:1546
10273 "Note: If grub-install reports the error \"No suitable drive was found in the"
10274 " generated device map.\" it may be that you need to create a "
10275 "C</boot/grub/device.map> file first that contains the mapping between grub "
10276 "device names and Linux device names. It is usually sufficient to create a "
10281 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1553
10284 " (hd0) /dev/vda\n"
10289 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1555
10290 msgid "replacing C</dev/vda> with the name of the installation device."
10294 #: ../src/guestfs-actions.pod:2341
10295 msgid "(Added in 1.0.17)"
10299 #: ../src/guestfs-actions.pod:2343
10300 msgid "guestfs_head"
10304 #: ../src/guestfs-actions.pod:2345
10308 " guestfs_head (guestfs_h *g,\n"
10309 " const char *path);\n"
10314 #: ../src/guestfs-actions.pod:2349 ../fish/guestfish-actions.pod:1561
10316 "This command returns up to the first 10 lines of a file as a list of "
10321 #: ../src/guestfs-actions.pod:2361
10322 msgid "guestfs_head_n"
10326 #: ../src/guestfs-actions.pod:2363
10330 " guestfs_head_n (guestfs_h *g,\n"
10332 " const char *path);\n"
10337 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1571
10339 "If the parameter C<nrlines> is a positive number, this returns the first "
10340 "C<nrlines> lines of the file C<path>."
10344 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1574
10346 "If the parameter C<nrlines> is a negative number, this returns lines from "
10347 "the file C<path>, excluding the last C<nrlines> lines."
10351 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6981
10352 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4637
10353 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10357 #: ../src/guestfs-actions.pod:2385
10358 msgid "guestfs_hexdump"
10362 #: ../src/guestfs-actions.pod:2387
10366 " guestfs_hexdump (guestfs_h *g,\n"
10367 " const char *path);\n"
10372 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1586
10374 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10375 "readable, canonical hex dump of the file."
10379 #: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:6765
10380 #: ../src/guestfs-actions.pod:6820
10381 msgid "(Added in 1.0.22)"
10385 #: ../src/guestfs-actions.pod:2402
10386 msgid "guestfs_initrd_cat"
10390 #: ../src/guestfs-actions.pod:2404
10394 " guestfs_initrd_cat (guestfs_h *g,\n"
10395 " const char *initrdpath,\n"
10396 " const char *filename,\n"
10397 " size_t *size_r);\n"
10402 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1596
10404 "This command unpacks the file C<filename> from the initrd file called "
10405 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10410 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1600
10412 "For example, in guestfish you could use the following command to examine the"
10413 " boot script (usually called C</init>) contained in a Linux initrd or "
10418 #: ../src/guestfs-actions.pod:2418 ../fish/guestfish-actions.pod:1604
10421 " initrd-cat /boot/initrd-<version>.img init\n"
10426 #: ../src/guestfs-actions.pod:2420
10427 msgid "See also C<guestfs_initrd_list>."
10431 #: ../src/guestfs-actions.pod:2431
10432 msgid "guestfs_initrd_list"
10436 #: ../src/guestfs-actions.pod:2433
10440 " guestfs_initrd_list (guestfs_h *g,\n"
10441 " const char *path);\n"
10446 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1615
10447 msgid "This command lists out files contained in an initrd."
10451 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1617
10453 "The files are listed without any initial C</> character. The files are "
10454 "listed in the order they appear (not necessarily alphabetical). Directory "
10455 "names are listed as separate items."
10459 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1621
10461 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10462 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10467 #: ../src/guestfs-actions.pod:2453
10468 msgid "guestfs_inotify_add_watch"
10472 #: ../src/guestfs-actions.pod:2455
10476 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10477 " const char *path,\n"
10483 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1629
10484 msgid "Watch C<path> for the events listed in C<mask>."
10488 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1631
10490 "Note that if C<path> is a directory then events within that directory are "
10491 "watched, but this does I<not> happen recursively (in subdirectories)."
10495 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1635
10497 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10498 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10502 #: ../src/guestfs-actions.pod:2474
10503 msgid "guestfs_inotify_close"
10507 #: ../src/guestfs-actions.pod:2476
10511 " guestfs_inotify_close (guestfs_h *g);\n"
10516 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1643
10518 "This closes the inotify handle which was previously opened by inotify_init."
10519 " It removes all watches, throws away any pending events, and deallocates "
10524 #: ../src/guestfs-actions.pod:2487
10525 msgid "guestfs_inotify_files"
10529 #: ../src/guestfs-actions.pod:2489
10533 " guestfs_inotify_files (guestfs_h *g);\n"
10538 #: ../src/guestfs-actions.pod:2492
10540 "This function is a helpful wrapper around C<guestfs_inotify_read> which just"
10541 " returns a list of pathnames of objects that were touched. The returned "
10542 "pathnames are sorted and deduplicated."
10546 #: ../src/guestfs-actions.pod:2502
10547 msgid "guestfs_inotify_init"
10551 #: ../src/guestfs-actions.pod:2504
10555 " guestfs_inotify_init (guestfs_h *g,\n"
10556 " int maxevents);\n"
10561 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1659
10563 "This command creates a new inotify handle. The inotify subsystem can be "
10564 "used to notify events which happen to objects in the guest filesystem."
10568 #: ../src/guestfs-actions.pod:2512
10570 "C<maxevents> is the maximum number of events which will be queued up between"
10571 " calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10572 "passed as C<0>, then the kernel (or previously set) default is used. For "
10573 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10574 "throws away events, but records the fact that it threw them away by setting "
10575 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10576 "C<guestfs_inotify_read>)."
10580 #: ../src/guestfs-actions.pod:2522
10582 "Before any events are generated, you have to add some watches to the "
10583 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10584 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10588 #: ../src/guestfs-actions.pod:2528
10590 "Queued up events should be read periodically by calling "
10591 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful"
10592 " wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10593 "often enough then you risk the internal queue overflowing."
10597 #: ../src/guestfs-actions.pod:2535
10599 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10600 "This also removes any watches automatically."
10604 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1690
10606 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10607 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10608 "that there is one global inotify handle per libguestfs instance."
10612 #: ../src/guestfs-actions.pod:2548
10613 msgid "guestfs_inotify_read"
10617 #: ../src/guestfs-actions.pod:2550
10620 " struct guestfs_inotify_event_list *\n"
10621 " guestfs_inotify_read (guestfs_h *g);\n"
10626 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1699
10628 "Return the complete queue of events that have happened since the previous "
10633 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1702
10634 msgid "If no events have happened, this returns an empty list."
10638 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1704
10640 "I<Note>: In order to make sure that all events have been read, you must call"
10641 " this function repeatedly until it returns an empty list. The reason is "
10642 "that the call will read events up to the maximum appliance-to-host message "
10643 "size and leave remaining events in the queue."
10647 #: ../src/guestfs-actions.pod:2564
10649 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10650 "there was an error. I<The caller must call "
10651 "C<guestfs_free_inotify_event_list> after use>."
10655 #: ../src/guestfs-actions.pod:2570
10656 msgid "guestfs_inotify_rm_watch"
10660 #: ../src/guestfs-actions.pod:2572
10664 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10670 #: ../src/guestfs-actions.pod:2576
10672 "Remove a previously defined inotify watch. See "
10673 "C<guestfs_inotify_add_watch>."
10677 #: ../src/guestfs-actions.pod:2583
10678 msgid "guestfs_inspect_get_arch"
10682 #: ../src/guestfs-actions.pod:2585
10686 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10687 " const char *root);\n"
10692 #: ../src/guestfs-actions.pod:2589
10694 "This returns the architecture of the inspected operating system. The "
10695 "possible return values are listed under C<guestfs_file_architecture>."
10699 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1725
10701 "If the architecture could not be determined, then the string C<unknown> is "
10706 #: ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:2686
10707 #: ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2809
10708 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:3023
10709 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
10710 #: ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3165
10711 #: ../src/guestfs-actions.pod:3185 ../src/guestfs-actions.pod:3205
10712 #: ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3238
10713 #: ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3358
10714 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:1728
10715 #: ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1890
10716 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1986
10717 #: ../fish/guestfish-actions.pod:2047 ../fish/guestfish-actions.pod:2068
10718 #: ../fish/guestfish-actions.pod:2082 ../fish/guestfish-actions.pod:2122
10719 #: ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2167
10720 #: ../fish/guestfish-actions.pod:2180 ../fish/guestfish-actions.pod:2190
10721 #: ../fish/guestfish-actions.pod:2200 ../fish/guestfish-actions.pod:2212
10722 #: ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2342
10723 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10727 #: ../src/guestfs-actions.pod:2603
10728 msgid "guestfs_inspect_get_distro"
10732 #: ../src/guestfs-actions.pod:2605
10736 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10737 " const char *root);\n"
10742 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1734
10744 "This returns the distro (distribution) of the inspected operating system."
10748 #: ../src/guestfs-actions.pod:2612 ../fish/guestfish-actions.pod:1737
10749 msgid "Currently defined distros are:"
10753 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1741
10754 msgid "\"archlinux\""
10758 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1743
10759 msgid "Arch Linux."
10763 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1745
10768 #: ../src/guestfs-actions.pod:2622 ../fish/guestfish-actions.pod:1747
10773 #: ../src/guestfs-actions.pod:2624 ../fish/guestfish-actions.pod:1749
10778 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1751
10783 #: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:1753
10788 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1755
10793 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1757
10798 #: ../src/guestfs-actions.pod:2634 ../fish/guestfish-actions.pod:1759
10803 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1761
10804 msgid "\"linuxmint\""
10808 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1763
10809 msgid "Linux Mint."
10813 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1765
10814 msgid "\"mandriva\""
10818 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1767
10823 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1769
10828 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1771
10833 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1773
10838 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1775
10843 #: ../src/guestfs-actions.pod:2652 ../fish/guestfish-actions.pod:1777
10844 msgid "\"redhat-based\""
10848 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1779
10849 msgid "Some Red Hat-derived distro."
10853 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1781
10858 #: ../src/guestfs-actions.pod:2658 ../fish/guestfish-actions.pod:1783
10859 msgid "Red Hat Enterprise Linux."
10863 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1785
10864 msgid "\"scientificlinux\""
10868 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1787
10869 msgid "Scientific Linux."
10873 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1789
10874 msgid "\"slackware\""
10878 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1791
10883 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1793
10888 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1795
10893 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2781
10894 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:1797
10895 #: ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
10896 msgid "\"unknown\""
10900 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1799
10901 msgid "The distro could not be determined."
10905 #: ../src/guestfs-actions.pod:2676 ../src/guestfs-actions.pod:3148
10906 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
10907 msgid "\"windows\""
10911 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1803
10913 "Windows does not have distributions. This string is returned if the OS type"
10918 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:2787
10919 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:1808
10920 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:2151
10922 "Future versions of libguestfs may return other strings here. The caller "
10923 "should be prepared to handle any string."
10927 #: ../src/guestfs-actions.pod:2693
10928 msgid "guestfs_inspect_get_drive_mappings"
10932 #: ../src/guestfs-actions.pod:2695
10936 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10937 " const char *root);\n"
10942 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1817
10944 "This call is useful for Windows which uses a primitive system of assigning "
10945 "drive letters (like \"C:\") to partitions. This inspection API examines the"
10946 " Windows Registry to find out how disks/partitions are mapped to drive "
10947 "letters, and returns a hash table as in the example below:"
10951 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1823
10954 " C => /dev/vda2\n"
10955 " E => /dev/vdb1\n"
10956 " F => /dev/vdc1\n"
10961 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1827
10963 "Note that keys are drive letters. For Windows, the key is case insensitive "
10964 "and just contains the drive letter, without the customary colon separator "
10969 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1831
10971 "In future we may support other operating systems that also used drive "
10972 "letters, but the keys for those might not be case insensitive and might be "
10973 "longer than 1 character. For example in OS-9, hard drives were named C<h0>,"
10978 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1836
10980 "For Windows guests, currently only hard drive mappings are returned. "
10981 "Removable disks (eg. DVD-ROMs) are ignored."
10985 #: ../src/guestfs-actions.pod:2721 ../fish/guestfish-actions.pod:1839
10987 "For guests that do not use drive mappings, or if the drive mappings could "
10988 "not be determined, this returns an empty hash table."
10992 #: ../src/guestfs-actions.pod:2724
10994 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
10995 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
10999 #: ../src/guestfs-actions.pod:2728 ../src/guestfs-actions.pod:2996
11000 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:5076
11001 #: ../src/guestfs-actions.pod:7122
11003 "This function returns a NULL-terminated array of strings, or NULL if there "
11004 "was an error. The array of strings will always have length C<2n+1>, where "
11005 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11006 "caller must free the strings and the array after use>."
11010 #: ../src/guestfs-actions.pod:2734 ../src/guestfs-actions.pod:3190
11011 msgid "(Added in 1.9.17)"
11015 #: ../src/guestfs-actions.pod:2736
11016 msgid "guestfs_inspect_get_filesystems"
11020 #: ../src/guestfs-actions.pod:2738
11024 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11025 " const char *root);\n"
11030 #: ../src/guestfs-actions.pod:2742 ../fish/guestfish-actions.pod:1850
11032 "This returns a list of all the filesystems that we think are associated with"
11033 " this operating system. This includes the root filesystem, other ordinary "
11034 "filesystems, and non-mounted devices like swap partitions."
11038 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1855
11040 "In the case of a multi-boot virtual machine, it is possible for a filesystem"
11041 " to be shared between operating systems."
11045 #: ../src/guestfs-actions.pod:2750
11047 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11048 "C<guestfs_inspect_get_mountpoints>."
11052 #: ../src/guestfs-actions.pod:2759
11053 msgid "guestfs_inspect_get_format"
11057 #: ../src/guestfs-actions.pod:2761
11061 " guestfs_inspect_get_format (guestfs_h *g,\n"
11062 " const char *root);\n"
11067 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1865
11069 "This returns the format of the inspected operating system. You can use it "
11070 "to detect install images, live CDs and similar."
11074 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1868
11075 msgid "Currently defined formats are:"
11079 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1872
11080 msgid "\"installed\""
11084 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1874
11085 msgid "This is an installed operating system."
11089 #: ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1876
11090 msgid "\"installer\""
11094 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1878
11096 "The disk image being inspected is not an installed operating system, but a "
11097 "I<bootable> install disk, live CD, or similar."
11101 #: ../src/guestfs-actions.pod:2783 ../fish/guestfish-actions.pod:1883
11102 msgid "The format of this disk image is not known."
11106 #: ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:3226
11107 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260
11108 #: ../src/guestfs-actions.pod:6020
11109 msgid "(Added in 1.9.4)"
11113 #: ../src/guestfs-actions.pod:2797
11114 msgid "guestfs_inspect_get_hostname"
11118 #: ../src/guestfs-actions.pod:2799
11122 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11123 " const char *root);\n"
11128 #: ../src/guestfs-actions.pod:2803 ../fish/guestfish-actions.pod:1896
11130 "This function returns the hostname of the operating system as found by "
11131 "inspection of the guest's configuration files."
11135 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1899
11137 "If the hostname could not be determined, then the string C<unknown> is "
11142 #: ../src/guestfs-actions.pod:2814
11143 msgid "(Added in 1.7.9)"
11147 #: ../src/guestfs-actions.pod:2816
11148 msgid "guestfs_inspect_get_icon"
11152 #: ../src/guestfs-actions.pod:2818
11156 " guestfs_inspect_get_icon (guestfs_h *g,\n"
11157 " const char *root,\n"
11158 " size_t *size_r,\n"
11164 #: ../src/guestfs-actions.pod:2829
11167 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
11168 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
11173 #: ../src/guestfs-actions.pod:2832 ../fish/guestfish-actions.pod:1908
11175 "This function returns an icon corresponding to the inspected operating "
11176 "system. The icon is returned as a buffer containing a PNG image (re-encoded"
11177 " to PNG if necessary)."
11181 #: ../src/guestfs-actions.pod:2836 ../fish/guestfish-actions.pod:1912
11183 "If it was not possible to get an icon this function returns a zero-length "
11184 "(non-NULL) buffer. I<Callers must check for this case>."
11188 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1915
11190 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11191 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11192 "this file will be returned. You can disable favicons by passing the "
11193 "optional C<favicon> boolean as false (default is true)."
11197 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1921
11199 "If finding the favicon fails, then we look in other places in the guest for "
11204 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1924
11206 "If the optional C<highquality> boolean is true then only high quality icons "
11207 "are returned, which means only icons of high resolution with an alpha "
11208 "channel. The default (false) is to return any icon we can, even if it is of"
11209 " substandard quality."
11213 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1935
11215 "Unlike most other inspection API calls, the guest's disks must be mounted up"
11216 " before you call this, since it needs to read information from the guest "
11217 "filesystem during the call."
11221 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1941
11223 "B<Security:> The icon data comes from the untrusted guest, and should be "
11224 "treated with caution. PNG files have been known to contain exploits. "
11225 "Ensure that libpng (or other relevant libraries) are fully up to date before"
11226 " trying to process or display the icon."
11230 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1949
11232 "The PNG image returned can be any size. It might not be square. Libguestfs"
11233 " tries to return the largest, highest quality icon available. The "
11234 "application must scale the icon to the required size."
11238 #: ../src/guestfs-actions.pod:2880 ../fish/guestfish-actions.pod:1956
11240 "Extracting icons from Windows guests requires the external C<wrestool> "
11241 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11242 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11243 "installed separately."
11247 #: ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1963
11249 "Operating system icons are usually trademarks. Seek legal advice before "
11250 "using trademarks in applications."
11254 #: ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:3721
11255 #: ../src/guestfs-actions.pod:4975
11256 msgid "(Added in 1.11.12)"
11260 #: ../src/guestfs-actions.pod:2898
11261 msgid "guestfs_inspect_get_icon_va"
11265 #: ../src/guestfs-actions.pod:2900
11269 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11270 " const char *root,\n"
11271 " size_t *size_r,\n"
11272 " va_list args);\n"
11277 #: ../src/guestfs-actions.pod:2906
11278 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11282 #: ../src/guestfs-actions.pod:2910
11283 msgid "guestfs_inspect_get_icon_argv"
11287 #: ../src/guestfs-actions.pod:2912
11291 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11292 " const char *root,\n"
11293 " size_t *size_r,\n"
11294 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11299 #: ../src/guestfs-actions.pod:2918
11300 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11304 #: ../src/guestfs-actions.pod:2922
11305 msgid "guestfs_inspect_get_major_version"
11309 #: ../src/guestfs-actions.pod:2924
11313 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11314 " const char *root);\n"
11319 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:1974
11321 "This returns the major version number of the inspected operating system."
11325 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:1977
11327 "Windows uses a consistent versioning scheme which is I<not> reflected in the"
11328 " popular public names used by the operating system. Notably the operating "
11329 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11330 "1). You can find out the real versions corresponding to releases of Windows"
11331 " by consulting Wikipedia or MSDN."
11335 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2955
11336 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
11337 msgid "If the version could not be determined, then C<0> is returned."
11341 #: ../src/guestfs-actions.pod:2946
11342 msgid "guestfs_inspect_get_minor_version"
11346 #: ../src/guestfs-actions.pod:2948
11350 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11351 " const char *root);\n"
11356 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:1992
11358 "This returns the minor version number of the inspected operating system."
11362 #: ../src/guestfs-actions.pod:2957
11364 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11365 "C<guestfs_inspect_get_major_version>."
11369 #: ../src/guestfs-actions.pod:2964
11370 msgid "guestfs_inspect_get_mountpoints"
11374 #: ../src/guestfs-actions.pod:2966
11378 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11379 " const char *root);\n"
11384 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2004
11386 "This returns a hash of where we think the filesystems associated with this "
11387 "operating system should be mounted. Callers should note that this is at "
11388 "best an educated guess made by reading configuration files such as "
11389 "C</etc/fstab>. I<In particular note> that this may return filesystems which"
11390 " are non-existent or not mountable and callers should be prepared to handle "
11391 "or ignore failures if they try to mount them."
11395 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2013
11397 "Each element in the returned hashtable has a key which is the path of the "
11398 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11399 "mounted there (eg. C</dev/sda1>)."
11403 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2018
11405 "Non-mounted devices such as swap devices are I<not> returned in this list."
11409 #: ../src/guestfs-actions.pod:2987
11411 "For operating systems like Windows which still use drive letters, this call "
11412 "will only return an entry for the first drive \"mounted on\" C</>. For "
11413 "information about the mapping of drive letters to partitions, see "
11414 "C<guestfs_inspect_get_drive_mappings>."
11418 #: ../src/guestfs-actions.pod:2993
11420 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11421 "C<guestfs_inspect_get_filesystems>."
11425 #: ../src/guestfs-actions.pod:3004
11426 msgid "guestfs_inspect_get_package_format"
11430 #: ../src/guestfs-actions.pod:3006
11434 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11435 " const char *root);\n"
11440 #: ../src/guestfs-actions.pod:3010
11442 "This function and C<guestfs_inspect_get_package_management> return the "
11443 "package format and package management tool used by the inspected operating "
11444 "system. For example for Fedora these functions would return C<rpm> (package"
11445 " format) and C<yum> (package management)."
11449 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:2040
11451 "This returns the string C<unknown> if we could not determine the package "
11452 "format I<or> if the operating system does not have a real packaging system "
11457 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2044
11459 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11460 "Future versions of libguestfs may return other strings."
11464 #: ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3056
11465 msgid "(Added in 1.7.5)"
11469 #: ../src/guestfs-actions.pod:3030
11470 msgid "guestfs_inspect_get_package_management"
11474 #: ../src/guestfs-actions.pod:3032
11478 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11479 " const char *root);\n"
11484 #: ../src/guestfs-actions.pod:3036
11486 "C<guestfs_inspect_get_package_format> and this function return the package "
11487 "format and package management tool used by the inspected operating system. "
11488 "For example for Fedora these functions would return C<rpm> (package format) "
11489 "and C<yum> (package management)."
11493 #: ../src/guestfs-actions.pod:3042 ../fish/guestfish-actions.pod:2059
11495 "This returns the string C<unknown> if we could not determine the package "
11496 "management tool I<or> if the operating system does not have a real packaging"
11497 " system (eg. Windows)."
11501 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2063
11503 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11504 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11505 "libguestfs may return other strings."
11509 #: ../src/guestfs-actions.pod:3058
11510 msgid "guestfs_inspect_get_product_name"
11514 #: ../src/guestfs-actions.pod:3060
11518 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11519 " const char *root);\n"
11524 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2074
11526 "This returns the product name of the inspected operating system. The "
11527 "product name is generally some freeform string which can be displayed to the"
11528 " user, but should not be parsed by programs."
11532 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2079
11534 "If the product name could not be determined, then the string C<unknown> is "
11539 #: ../src/guestfs-actions.pod:3079
11540 msgid "guestfs_inspect_get_product_variant"
11544 #: ../src/guestfs-actions.pod:3081
11548 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11549 " const char *root);\n"
11554 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2088
11555 msgid "This returns the product variant of the inspected operating system."
11559 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2091
11561 "For Windows guests, this returns the contents of the Registry key "
11562 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType>"
11563 " which is usually a string such as C<Client> or C<Server> (other values are "
11564 "possible). This can be used to distinguish consumer and enterprise versions"
11565 " of Windows that have the same version number (for example, Windows 7 and "
11566 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11567 "the latter is C<Server>)."
11571 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2100
11573 "For enterprise Linux guests, in future we intend this to return the product "
11574 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11575 "implemented at present."
11579 #: ../src/guestfs-actions.pod:3101 ../fish/guestfish-actions.pod:2104
11581 "If the product variant could not be determined, then the string C<unknown> "
11586 #: ../src/guestfs-actions.pod:3104
11588 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11589 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11593 #: ../src/guestfs-actions.pod:3111
11594 msgid "(Added in 1.9.13)"
11598 #: ../src/guestfs-actions.pod:3113
11599 msgid "guestfs_inspect_get_roots"
11603 #: ../src/guestfs-actions.pod:3115
11607 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11612 #: ../src/guestfs-actions.pod:3118
11614 "This function is a convenient way to get the list of root devices, as "
11615 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11616 "the whole inspection process."
11620 #: ../src/guestfs-actions.pod:3122
11622 "This returns an empty list if either no root devices were found or the "
11623 "caller has not called C<guestfs_inspect_os>."
11627 #: ../src/guestfs-actions.pod:3131
11628 msgid "(Added in 1.7.3)"
11632 #: ../src/guestfs-actions.pod:3133
11633 msgid "guestfs_inspect_get_type"
11637 #: ../src/guestfs-actions.pod:3135
11641 " guestfs_inspect_get_type (guestfs_h *g,\n"
11642 " const char *root);\n"
11647 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2128
11649 "This returns the type of the inspected operating system. Currently defined "
11654 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2133
11659 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2135
11660 msgid "Any Linux-based operating system."
11664 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2139
11665 msgid "Any Microsoft Windows operating system."
11669 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2141
11670 msgid "\"freebsd\""
11674 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2143
11679 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2147
11680 msgid "The operating system type could not be determined."
11684 #: ../src/guestfs-actions.pod:3172
11685 msgid "guestfs_inspect_get_windows_current_control_set"
11689 #: ../src/guestfs-actions.pod:3174
11693 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11694 " const char *root);\n"
11699 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2160
11701 "This returns the Windows CurrentControlSet of the inspected guest. The "
11702 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11706 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2163
11708 "This call assumes that the guest is Windows and that the Registry could be "
11709 "examined by inspection. If this is not the case then an error is returned."
11713 #: ../src/guestfs-actions.pod:3192
11714 msgid "guestfs_inspect_get_windows_systemroot"
11718 #: ../src/guestfs-actions.pod:3194
11722 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11723 " const char *root);\n"
11728 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2173
11730 "This returns the Windows systemroot of the inspected guest. The systemroot "
11731 "is a directory path such as C</WINDOWS>."
11735 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2176
11737 "This call assumes that the guest is Windows and that the systemroot could be"
11738 " determined by inspection. If this is not the case then an error is "
11743 #: ../src/guestfs-actions.pod:3210
11744 msgid "(Added in 1.5.25)"
11748 #: ../src/guestfs-actions.pod:3212
11749 msgid "guestfs_inspect_is_live"
11753 #: ../src/guestfs-actions.pod:3214
11757 " guestfs_inspect_is_live (guestfs_h *g,\n"
11758 " const char *root);\n"
11763 #: ../src/guestfs-actions.pod:3218
11765 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11766 "disk), then this returns true if a live image was detected on the disk."
11770 #: ../src/guestfs-actions.pod:3228
11771 msgid "guestfs_inspect_is_multipart"
11775 #: ../src/guestfs-actions.pod:3230
11779 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11780 " const char *root);\n"
11785 #: ../src/guestfs-actions.pod:3234
11787 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11788 "disk), then this returns true if the disk is part of a set."
11792 #: ../src/guestfs-actions.pod:3244
11793 msgid "guestfs_inspect_is_netinst"
11797 #: ../src/guestfs-actions.pod:3246
11801 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11802 " const char *root);\n"
11807 #: ../src/guestfs-actions.pod:3250
11809 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11810 "disk), then this returns true if the disk is a network installer, ie. not a "
11811 "self-contained install CD but one which is likely to require network access "
11812 "to complete the install."
11816 #: ../src/guestfs-actions.pod:3262
11817 msgid "guestfs_inspect_list_applications"
11821 #: ../src/guestfs-actions.pod:3264
11824 " struct guestfs_application_list *\n"
11825 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11826 " const char *root);\n"
11831 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2218
11832 msgid "Return the list of applications installed in the operating system."
11836 #: ../src/guestfs-actions.pod:3270
11838 "I<Note:> This call works differently from other parts of the inspection API."
11839 " You have to call C<guestfs_inspect_os>, then "
11840 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11841 "this. Listing applications is a significantly more difficult operation "
11842 "which requires access to the full filesystem. Also note that unlike the "
11843 "other C<guestfs_inspect_get_*> calls which are just returning data cached in"
11844 " the libguestfs handle, this call actually reads parts of the mounted "
11845 "filesystems during the call."
11849 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2230
11851 "This returns an empty list if the inspection code was not able to determine "
11852 "the list of applications."
11856 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2233
11857 msgid "The application structure contains the following fields:"
11861 #: ../src/guestfs-actions.pod:3287 ../fish/guestfish-actions.pod:2237
11862 msgid "C<app_name>"
11866 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2239
11868 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11869 "guests, this is the package name."
11873 #: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2242
11874 msgid "C<app_display_name>"
11878 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2244
11880 "The display name of the application, sometimes localized to the install "
11881 "language of the guest operating system."
11885 #: ../src/guestfs-actions.pod:3297 ../fish/guestfish-actions.pod:2247
11887 "If unavailable this is returned as an empty string C<\"\">. Callers needing"
11888 " to display something can use C<app_name> instead."
11892 #: ../src/guestfs-actions.pod:3300 ../fish/guestfish-actions.pod:2250
11893 msgid "C<app_epoch>"
11897 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2252
11899 "For package managers which use epochs, this contains the epoch of the "
11900 "package (an integer). If unavailable, this is returned as C<0>."
11904 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2255
11905 msgid "C<app_version>"
11909 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2257
11911 "The version string of the application or package. If unavailable this is "
11912 "returned as an empty string C<\"\">."
11916 #: ../src/guestfs-actions.pod:3310 ../fish/guestfish-actions.pod:2260
11917 msgid "C<app_release>"
11921 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2262
11923 "The release string of the application or package, for package managers that "
11924 "use this. If unavailable this is returned as an empty string C<\"\">."
11928 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2266
11929 msgid "C<app_install_path>"
11933 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2268
11935 "The installation path of the application (on operating systems such as "
11936 "Windows which use installation paths). This path is in the format used by "
11937 "the guest operating system, it is not a libguestfs path."
11941 #: ../src/guestfs-actions.pod:3323 ../fish/guestfish-actions.pod:2273
11942 msgid "If unavailable this is returned as an empty string C<\"\">."
11946 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2275
11947 msgid "C<app_trans_path>"
11951 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2277
11953 "The install path translated into a libguestfs path. If unavailable this is "
11954 "returned as an empty string C<\"\">."
11958 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2280
11959 msgid "C<app_publisher>"
11963 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2282
11965 "The name of the publisher of the application, for package managers that use "
11966 "this. If unavailable this is returned as an empty string C<\"\">."
11970 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2286
11975 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2288
11977 "The URL (eg. upstream URL) of the application. If unavailable this is "
11978 "returned as an empty string C<\"\">."
11982 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2291
11983 msgid "C<app_source_package>"
11987 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2293
11989 "For packaging systems which support this, the name of the source package. "
11990 "If unavailable this is returned as an empty string C<\"\">."
11994 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2296
11995 msgid "C<app_summary>"
11999 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2298
12001 "A short (usually one line) description of the application or package. If "
12002 "unavailable this is returned as an empty string C<\"\">."
12006 #: ../src/guestfs-actions.pod:3351 ../fish/guestfish-actions.pod:2301
12007 msgid "C<app_description>"
12011 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2303
12013 "A longer description of the application or package. If unavailable this is "
12014 "returned as an empty string C<\"\">."
12018 #: ../src/guestfs-actions.pod:3360
12020 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12021 "there was an error. I<The caller must call C<guestfs_free_application_list>"
12026 #: ../src/guestfs-actions.pod:3364
12027 msgid "(Added in 1.7.8)"
12031 #: ../src/guestfs-actions.pod:3366
12032 msgid "guestfs_inspect_os"
12036 #: ../src/guestfs-actions.pod:3368
12040 " guestfs_inspect_os (guestfs_h *g);\n"
12045 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2314
12047 "This function uses other libguestfs functions and certain heuristics to "
12048 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12049 "for operating systems."
12053 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2318
12054 msgid "The list returned is empty if no operating systems were found."
12058 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2320
12060 "If one operating system was found, then this returns a list with a single "
12061 "element, which is the name of the root filesystem of this operating system."
12062 " It is also possible for this function to return a list containing more "
12063 "than one element, indicating a dual-boot or multi-boot virtual machine, with"
12064 " each element being the root filesystem of one of the operating systems."
12068 #: ../src/guestfs-actions.pod:3384
12070 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12071 "functions in order to query further information about each operating system,"
12072 " such as the name and version."
12076 #: ../src/guestfs-actions.pod:3389
12078 "This function uses other libguestfs features such as C<guestfs_mount_ro> and"
12079 " C<guestfs_umount_all> in order to mount and unmount filesystems and look at"
12080 " the contents. This should be called with no disks currently mounted. The "
12081 "function may also use Augeas, so any existing Augeas handle will be closed."
12085 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2338
12087 "This function cannot decrypt encrypted disks. The caller must do that first"
12088 " (supplying the necessary keys) if the disk is encrypted."
12092 #: ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3732
12093 #: ../src/guestfs-actions.pod:3814
12094 msgid "See also C<guestfs_list_filesystems>."
12098 #: ../src/guestfs-actions.pod:3409
12099 msgid "guestfs_is_blockdev"
12103 #: ../src/guestfs-actions.pod:3411
12107 " guestfs_is_blockdev (guestfs_h *g,\n"
12108 " const char *path);\n"
12113 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2350
12115 "This returns C<true> if and only if there is a block device with the given "
12120 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3447
12121 #: ../src/guestfs-actions.pod:3477 ../src/guestfs-actions.pod:3492
12122 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3564
12123 #: ../src/guestfs-actions.pod:3579
12124 msgid "See also C<guestfs_stat>."
12128 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3451
12129 #: ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3568
12130 #: ../src/guestfs-actions.pod:3583
12131 msgid "(Added in 1.5.10)"
12135 #: ../src/guestfs-actions.pod:3424
12136 msgid "guestfs_is_busy"
12140 #: ../src/guestfs-actions.pod:3426
12144 " guestfs_is_busy (guestfs_h *g);\n"
12149 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2359
12151 "This returns true iff this handle is busy processing a command (in the "
12156 #: ../src/guestfs-actions.pod:3438
12157 msgid "guestfs_is_chardev"
12161 #: ../src/guestfs-actions.pod:3440
12165 " guestfs_is_chardev (guestfs_h *g,\n"
12166 " const char *path);\n"
12171 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2368
12173 "This returns C<true> if and only if there is a character device with the "
12174 "given C<path> name."
12178 #: ../src/guestfs-actions.pod:3453
12179 msgid "guestfs_is_config"
12183 #: ../src/guestfs-actions.pod:3455
12187 " guestfs_is_config (guestfs_h *g);\n"
12192 #: ../src/guestfs-actions.pod:3458 ../fish/guestfish-actions.pod:2377
12194 "This returns true iff this handle is being configured (in the C<CONFIG> "
12199 #: ../src/guestfs-actions.pod:3467
12200 msgid "guestfs_is_dir"
12204 #: ../src/guestfs-actions.pod:3469
12208 " guestfs_is_dir (guestfs_h *g,\n"
12209 " const char *path);\n"
12214 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2386
12216 "This returns C<true> if and only if there is a directory with the given "
12217 "C<path> name. Note that it returns false for other objects like files."
12221 #: ../src/guestfs-actions.pod:3483
12222 msgid "guestfs_is_fifo"
12226 #: ../src/guestfs-actions.pod:3485
12230 " guestfs_is_fifo (guestfs_h *g,\n"
12231 " const char *path);\n"
12236 #: ../src/guestfs-actions.pod:3489 ../fish/guestfish-actions.pod:2396
12238 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12239 "given C<path> name."
12243 #: ../src/guestfs-actions.pod:3498
12244 msgid "guestfs_is_file"
12248 #: ../src/guestfs-actions.pod:3500
12252 " guestfs_is_file (guestfs_h *g,\n"
12253 " const char *path);\n"
12258 #: ../src/guestfs-actions.pod:3504 ../fish/guestfish-actions.pod:2405
12260 "This returns C<true> if and only if there is a regular file with the given "
12261 "C<path> name. Note that it returns false for other objects like "
12266 #: ../src/guestfs-actions.pod:3514
12267 msgid "guestfs_is_launching"
12271 #: ../src/guestfs-actions.pod:3516
12275 " guestfs_is_launching (guestfs_h *g);\n"
12280 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2415
12282 "This returns true iff this handle is launching the subprocess (in the "
12283 "C<LAUNCHING> state)."
12287 #: ../src/guestfs-actions.pod:3528
12288 msgid "guestfs_is_lv"
12292 #: ../src/guestfs-actions.pod:3530
12296 " guestfs_is_lv (guestfs_h *g,\n"
12297 " const char *device);\n"
12302 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2424
12304 "This command tests whether C<device> is a logical volume, and returns true "
12305 "iff this is the case."
12309 #: ../src/guestfs-actions.pod:3541
12310 msgid "guestfs_is_ready"
12314 #: ../src/guestfs-actions.pod:3543
12318 " guestfs_is_ready (guestfs_h *g);\n"
12323 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2431
12325 "This returns true iff this handle is ready to accept commands (in the "
12330 #: ../src/guestfs-actions.pod:3555
12331 msgid "guestfs_is_socket"
12335 #: ../src/guestfs-actions.pod:3557
12339 " guestfs_is_socket (guestfs_h *g,\n"
12340 " const char *path);\n"
12345 #: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2440
12347 "This returns C<true> if and only if there is a Unix domain socket with the "
12348 "given C<path> name."
12352 #: ../src/guestfs-actions.pod:3570
12353 msgid "guestfs_is_symlink"
12357 #: ../src/guestfs-actions.pod:3572
12361 " guestfs_is_symlink (guestfs_h *g,\n"
12362 " const char *path);\n"
12367 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2449
12369 "This returns C<true> if and only if there is a symbolic link with the given "
12374 #: ../src/guestfs-actions.pod:3585
12375 msgid "guestfs_is_zero"
12379 #: ../src/guestfs-actions.pod:3587
12383 " guestfs_is_zero (guestfs_h *g,\n"
12384 " const char *path);\n"
12389 #: ../src/guestfs-actions.pod:3591 ../fish/guestfish-actions.pod:2458
12391 "This returns true iff the file exists and the file is empty or it contains "
12396 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
12397 msgid "(Added in 1.11.8)"
12401 #: ../src/guestfs-actions.pod:3598
12402 msgid "guestfs_is_zero_device"
12406 #: ../src/guestfs-actions.pod:3600
12410 " guestfs_is_zero_device (guestfs_h *g,\n"
12411 " const char *device);\n"
12416 #: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2465
12417 msgid "This returns true iff the device exists and contains all zero bytes."
12421 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
12422 msgid "Note that for large devices this can take a long time to run."
12426 #: ../src/guestfs-actions.pod:3612
12427 msgid "guestfs_kill_subprocess"
12431 #: ../src/guestfs-actions.pod:3614
12435 " guestfs_kill_subprocess (guestfs_h *g);\n"
12440 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2473
12441 msgid "This kills the qemu subprocess. You should never need to call this."
12445 #: ../src/guestfs-actions.pod:3623
12446 msgid "guestfs_launch"
12450 #: ../src/guestfs-actions.pod:3625
12454 " guestfs_launch (guestfs_h *g);\n"
12459 #: ../src/guestfs-actions.pod:3628 ../fish/guestfish-actions.pod:2481
12461 "Internally libguestfs is implemented by running a virtual machine using "
12466 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2484
12468 "You should call this after configuring the handle (eg. adding drives) but "
12469 "before performing any actions."
12473 #: ../src/guestfs-actions.pod:3643
12474 msgid "guestfs_lchown"
12478 #: ../src/guestfs-actions.pod:3645
12482 " guestfs_lchown (guestfs_h *g,\n"
12485 " const char *path);\n"
12490 #: ../src/guestfs-actions.pod:3651
12492 "Change the file owner to C<owner> and group to C<group>. This is like "
12493 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12494 "changed, not the target."
12498 #: ../src/guestfs-actions.pod:3663
12499 msgid "guestfs_lgetxattr"
12503 #: ../src/guestfs-actions.pod:3665
12507 " guestfs_lgetxattr (guestfs_h *g,\n"
12508 " const char *path,\n"
12509 " const char *name,\n"
12510 " size_t *size_r);\n"
12515 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2503
12517 "Get a single extended attribute from file C<path> named C<name>. If C<path>"
12518 " is a symlink, then this call returns an extended attribute from the "
12523 #: ../src/guestfs-actions.pod:3685
12524 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12528 #: ../src/guestfs-actions.pod:3693
12529 msgid "guestfs_lgetxattrs"
12533 #: ../src/guestfs-actions.pod:3695
12536 " struct guestfs_xattr_list *\n"
12537 " guestfs_lgetxattrs (guestfs_h *g,\n"
12538 " const char *path);\n"
12543 #: ../src/guestfs-actions.pod:3699
12545 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link,"
12546 " then it returns the extended attributes of the link itself."
12550 #: ../src/guestfs-actions.pod:3709
12551 msgid "guestfs_list_9p"
12555 #: ../src/guestfs-actions.pod:3711
12559 " guestfs_list_9p (guestfs_h *g);\n"
12564 #: ../src/guestfs-actions.pod:3714 ../fish/guestfish-actions.pod:2531
12566 "List all 9p filesystems attached to the guest. A list of mount tags is "
12571 #: ../src/guestfs-actions.pod:3723
12572 msgid "guestfs_list_devices"
12576 #: ../src/guestfs-actions.pod:3725
12580 " guestfs_list_devices (guestfs_h *g);\n"
12585 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2538
12586 msgid "List all the block devices."
12590 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2540
12591 msgid "The full block device names are returned, eg. C</dev/sda>."
12595 #: ../src/guestfs-actions.pod:3740
12596 msgid "guestfs_list_dm_devices"
12600 #: ../src/guestfs-actions.pod:3742
12604 " guestfs_list_dm_devices (guestfs_h *g);\n"
12609 #: ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2548
12610 msgid "List all device mapper devices."
12614 #: ../src/guestfs-actions.pod:3747
12616 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12617 "previous call to C<guestfs_luks_open>."
12621 #: ../src/guestfs-actions.pod:3750
12623 "Device mapper devices which correspond to logical volumes are I<not> "
12624 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12629 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:5214
12630 msgid "(Added in 1.11.15)"
12634 #: ../src/guestfs-actions.pod:3760
12635 msgid "guestfs_list_filesystems"
12639 #: ../src/guestfs-actions.pod:3762
12643 " guestfs_list_filesystems (guestfs_h *g);\n"
12648 #: ../src/guestfs-actions.pod:3765 ../fish/guestfish-actions.pod:2561
12650 "This inspection command looks for filesystems on partitions, block devices "
12651 "and logical volumes, returning a list of devices containing filesystems and "
12656 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2565
12658 "The return value is a hash, where the keys are the devices containing "
12659 "filesystems, and the values are the filesystem types. For example:"
12663 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2569
12666 " \"/dev/sda1\" => \"ntfs\"\n"
12667 " \"/dev/sda2\" => \"ext2\"\n"
12668 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12669 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12674 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2574
12676 "The value can have the special value \"unknown\", meaning the content of the"
12677 " device is undetermined or empty. \"swap\" means a Linux swap partition."
12681 #: ../src/guestfs-actions.pod:3782
12683 "This command runs other libguestfs commands, which might include "
12684 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12685 "soon after launch and only when nothing is mounted."
12689 #: ../src/guestfs-actions.pod:3786
12691 "Not all of the filesystems returned will be mountable. In particular, swap "
12692 "partitions are returned in the list. Also this command does not check that "
12693 "each filesystem found is valid and mountable, and some filesystems might be "
12694 "mountable but require special options. Filesystems may not all belong to a "
12695 "single logical operating system (use C<guestfs_inspect_os> to look for "
12700 #: ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5569
12701 msgid "(Added in 1.5.15)"
12705 #: ../src/guestfs-actions.pod:3802
12706 msgid "guestfs_list_partitions"
12710 #: ../src/guestfs-actions.pod:3804
12714 " guestfs_list_partitions (guestfs_h *g);\n"
12719 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2594
12720 msgid "List all the partitions detected on all block devices."
12724 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2596
12725 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12729 #: ../src/guestfs-actions.pod:3811
12731 "This does not return logical volumes. For that you will need to call "
12736 #: ../src/guestfs-actions.pod:3822
12741 #: ../src/guestfs-actions.pod:3824
12745 " guestfs_ll (guestfs_h *g,\n"
12746 " const char *directory);\n"
12751 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2607
12753 "List the files in C<directory> (relative to the root directory, there is no "
12754 "cwd) in the format of 'ls -la'."
12758 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
12760 "This command is mostly useful for interactive sessions. It is I<not> "
12761 "intended that you try to parse the output string."
12765 #: ../src/guestfs-actions.pod:3839
12770 #: ../src/guestfs-actions.pod:3841
12774 " guestfs_ln (guestfs_h *g,\n"
12775 " const char *target,\n"
12776 " const char *linkname);\n"
12781 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
12782 msgid "This command creates a hard link using the C<ln> command."
12786 #: ../src/guestfs-actions.pod:3852
12787 msgid "guestfs_ln_f"
12791 #: ../src/guestfs-actions.pod:3854
12795 " guestfs_ln_f (guestfs_h *g,\n"
12796 " const char *target,\n"
12797 " const char *linkname);\n"
12802 #: ../src/guestfs-actions.pod:3859 ../fish/guestfish-actions.pod:2623
12804 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12805 "option removes the link (C<linkname>) if it exists already."
12809 #: ../src/guestfs-actions.pod:3866
12810 msgid "guestfs_ln_s"
12814 #: ../src/guestfs-actions.pod:3868
12818 " guestfs_ln_s (guestfs_h *g,\n"
12819 " const char *target,\n"
12820 " const char *linkname);\n"
12825 #: ../src/guestfs-actions.pod:3873 ../fish/guestfish-actions.pod:2630
12826 msgid "This command creates a symbolic link using the C<ln -s> command."
12830 #: ../src/guestfs-actions.pod:3879
12831 msgid "guestfs_ln_sf"
12835 #: ../src/guestfs-actions.pod:3881
12839 " guestfs_ln_sf (guestfs_h *g,\n"
12840 " const char *target,\n"
12841 " const char *linkname);\n"
12846 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2636
12848 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12849 "option removes the link (C<linkname>) if it exists already."
12853 #: ../src/guestfs-actions.pod:3893
12854 msgid "guestfs_lremovexattr"
12858 #: ../src/guestfs-actions.pod:3895
12862 " guestfs_lremovexattr (guestfs_h *g,\n"
12863 " const char *xattr,\n"
12864 " const char *path);\n"
12869 #: ../src/guestfs-actions.pod:3900
12871 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12872 "link, then it removes an extended attribute of the link itself."
12876 #: ../src/guestfs-actions.pod:3908
12881 #: ../src/guestfs-actions.pod:3910
12885 " guestfs_ls (guestfs_h *g,\n"
12886 " const char *directory);\n"
12891 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2651
12893 "List the files in C<directory> (relative to the root directory, there is no "
12894 "cwd). The '.' and '..' entries are not returned, but hidden files are "
12899 #: ../src/guestfs-actions.pod:3918
12901 "This command is mostly useful for interactive sessions. Programs should "
12902 "probably use C<guestfs_readdir> instead."
12906 #: ../src/guestfs-actions.pod:3927
12907 msgid "guestfs_lsetxattr"
12911 #: ../src/guestfs-actions.pod:3929
12915 " guestfs_lsetxattr (guestfs_h *g,\n"
12916 " const char *xattr,\n"
12917 " const char *val,\n"
12919 " const char *path);\n"
12924 #: ../src/guestfs-actions.pod:3936
12926 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12927 "then it sets an extended attribute of the link itself."
12931 #: ../src/guestfs-actions.pod:3944
12932 msgid "guestfs_lstat"
12936 #: ../src/guestfs-actions.pod:3946
12939 " struct guestfs_stat *\n"
12940 " guestfs_lstat (guestfs_h *g,\n"
12941 " const char *path);\n"
12946 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:6721
12947 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4472
12948 msgid "Returns file information for the given C<path>."
12952 #: ../src/guestfs-actions.pod:3952
12954 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12955 "link, then the link is stat-ed, not the file it refers to."
12959 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2676
12960 msgid "This is the same as the C<lstat(2)> system call."
12964 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:6725
12966 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12967 "error. I<The caller must call C<guestfs_free_stat> after use>."
12971 #: ../src/guestfs-actions.pod:3962 ../src/guestfs-actions.pod:6729
12972 #: ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:7128
12973 msgid "(Added in 0.9.2)"
12977 #: ../src/guestfs-actions.pod:3964
12978 msgid "guestfs_lstatlist"
12982 #: ../src/guestfs-actions.pod:3966
12985 " struct guestfs_stat_list *\n"
12986 " guestfs_lstatlist (guestfs_h *g,\n"
12987 " const char *path,\n"
12988 " char *const *names);\n"
12993 #: ../src/guestfs-actions.pod:3971
12995 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
12996 "files, where all files are in the directory C<path>. C<names> is the list "
12997 "of files from this directory."
13001 #: ../src/guestfs-actions.pod:3975 ../fish/guestfish-actions.pod:2686
13003 "On return you get a list of stat structs, with a one-to-one correspondence "
13004 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13005 "then the C<ino> field of that structure is set to C<-1>."
13009 #: ../src/guestfs-actions.pod:3980
13011 "This call is intended for programs that want to efficiently list a directory"
13012 " contents without making many round-trips. See also C<guestfs_lxattrlist> "
13013 "for a similarly efficient call for getting extended attributes. Very long "
13014 "directory listings might cause the protocol message size to be exceeded, "
13015 "causing this call to fail. The caller must split up such requests into "
13016 "smaller groups of names."
13020 #: ../src/guestfs-actions.pod:3988
13022 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13023 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13027 #: ../src/guestfs-actions.pod:3994
13028 msgid "guestfs_luks_add_key"
13032 #: ../src/guestfs-actions.pod:3996
13036 " guestfs_luks_add_key (guestfs_h *g,\n"
13037 " const char *device,\n"
13038 " const char *key,\n"
13039 " const char *newkey,\n"
13045 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2703
13047 "This command adds a new key on LUKS device C<device>. C<key> is any "
13048 "existing key, and is used to access the device. C<newkey> is the new key to"
13049 " add. C<keyslot> is the key slot that will be replaced."
13053 #: ../src/guestfs-actions.pod:4008
13055 "Note that if C<keyslot> already contains a key, then this command will fail."
13056 " You have to use C<guestfs_luks_kill_slot> first to remove that key."
13060 #: ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4054
13061 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4097
13062 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
13064 "This function takes a key or passphrase parameter which could contain "
13065 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13070 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4058
13071 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4101
13072 msgid "(Added in 1.5.2)"
13076 #: ../src/guestfs-actions.pod:4020
13077 msgid "guestfs_luks_close"
13081 #: ../src/guestfs-actions.pod:4022
13085 " guestfs_luks_close (guestfs_h *g,\n"
13086 " const char *device);\n"
13091 #: ../src/guestfs-actions.pod:4026
13093 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13094 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the"
13095 " LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the"
13096 " underlying block device."
13100 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4136
13101 #: ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4205
13102 #: ../src/guestfs-actions.pod:4253
13103 msgid "(Added in 1.5.1)"
13107 #: ../src/guestfs-actions.pod:4036
13108 msgid "guestfs_luks_format"
13112 #: ../src/guestfs-actions.pod:4038
13116 " guestfs_luks_format (guestfs_h *g,\n"
13117 " const char *device,\n"
13118 " const char *key,\n"
13124 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2729
13126 "This command erases existing data on C<device> and formats the device as a "
13127 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13128 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13132 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4074
13133 #: ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:5320
13134 #: ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6528
13135 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6591
13136 #: ../src/guestfs-actions.pod:7787 ../fish/guestfish-actions.pod:2737
13137 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2837
13138 #: ../fish/guestfish-actions.pod:3498 ../fish/guestfish-actions.pod:4018
13139 #: ../fish/guestfish-actions.pod:4343 ../fish/guestfish-actions.pod:4366
13140 #: ../fish/guestfish-actions.pod:4388 ../fish/guestfish-actions.pod:5126
13142 "B<This command is dangerous. Without careful use you can easily destroy all"
13147 #: ../src/guestfs-actions.pod:4060
13148 msgid "guestfs_luks_format_cipher"
13152 #: ../src/guestfs-actions.pod:4062
13156 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13157 " const char *device,\n"
13158 " const char *key,\n"
13160 " const char *cipher);\n"
13165 #: ../src/guestfs-actions.pod:4069
13167 "This command is the same as C<guestfs_luks_format> but it also allows you to"
13168 " set the C<cipher> used."
13172 #: ../src/guestfs-actions.pod:4083
13173 msgid "guestfs_luks_kill_slot"
13177 #: ../src/guestfs-actions.pod:4085
13181 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13182 " const char *device,\n"
13183 " const char *key,\n"
13189 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2757
13191 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13192 "device C<device>. C<key> must be one of the I<other> keys."
13196 #: ../src/guestfs-actions.pod:4103
13197 msgid "guestfs_luks_open"
13201 #: ../src/guestfs-actions.pod:4105
13205 " guestfs_luks_open (guestfs_h *g,\n"
13206 " const char *device,\n"
13207 " const char *key,\n"
13208 " const char *mapname);\n"
13213 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2768
13215 "This command opens a block device which has been encrypted according to the "
13216 "Linux Unified Key Setup (LUKS) standard."
13220 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2771
13221 msgid "C<device> is the encrypted block device or partition."
13225 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2773
13227 "The caller must supply one of the keys associated with the LUKS block "
13228 "device, in the C<key> parameter."
13232 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2776
13234 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13235 "writes to this block device are decrypted from and encrypted to the "
13236 "underlying C<device> respectively."
13240 #: ../src/guestfs-actions.pod:4123
13242 "If this block device contains LVM volume groups, then calling "
13243 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13248 #: ../src/guestfs-actions.pod:4127
13249 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
13253 #: ../src/guestfs-actions.pod:4138
13254 msgid "guestfs_luks_open_ro"
13258 #: ../src/guestfs-actions.pod:4140
13262 " guestfs_luks_open_ro (guestfs_h *g,\n"
13263 " const char *device,\n"
13264 " const char *key,\n"
13265 " const char *mapname);\n"
13270 #: ../src/guestfs-actions.pod:4146
13272 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13277 #: ../src/guestfs-actions.pod:4157
13278 msgid "guestfs_lvcreate"
13282 #: ../src/guestfs-actions.pod:4159
13286 " guestfs_lvcreate (guestfs_h *g,\n"
13287 " const char *logvol,\n"
13288 " const char *volgroup,\n"
13294 #: ../src/guestfs-actions.pod:4165 ../fish/guestfish-actions.pod:2804
13296 "This creates an LVM logical volume called C<logvol> on the volume group "
13297 "C<volgroup>, with C<size> megabytes."
13301 #: ../src/guestfs-actions.pod:4172
13302 msgid "guestfs_lvm_canonical_lv_name"
13306 #: ../src/guestfs-actions.pod:4174
13310 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13311 " const char *lvname);\n"
13316 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2811
13318 "This converts alternative naming schemes for LVs that you might find to the "
13319 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
13324 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2815
13326 "This command returns an error if the C<lvname> parameter does not refer to a"
13331 #: ../src/guestfs-actions.pod:4185
13332 msgid "See also C<guestfs_is_lv>."
13336 #: ../src/guestfs-actions.pod:4190
13337 msgid "(Added in 1.5.24)"
13341 #: ../src/guestfs-actions.pod:4192
13342 msgid "guestfs_lvm_clear_filter"
13346 #: ../src/guestfs-actions.pod:4194
13350 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13355 #: ../src/guestfs-actions.pod:4197
13357 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13358 "see every block device."
13362 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4242
13363 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
13365 "This command also clears the LVM cache and performs a volume group scan."
13369 #: ../src/guestfs-actions.pod:4207
13370 msgid "guestfs_lvm_remove_all"
13374 #: ../src/guestfs-actions.pod:4209
13378 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13383 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2834
13385 "This command removes all LVM logical volumes, volume groups and physical "
13390 #: ../src/guestfs-actions.pod:4222
13391 msgid "guestfs_lvm_set_filter"
13395 #: ../src/guestfs-actions.pod:4224
13399 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13400 " char *const *devices);\n"
13405 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
13407 "This sets the LVM device filter so that LVM will only be able to \"see\" the"
13408 " block devices in the list C<devices>, and will ignore all other attached "
13413 #: ../src/guestfs-actions.pod:4232 ../fish/guestfish-actions.pod:2848
13415 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13416 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also"
13417 " there are two types of duplication possible: either cloned PVs/VGs which "
13418 "have identical UUIDs; or VGs that are not cloned but just happen to have the"
13419 " same name. In normal operation you cannot create this situation, but you "
13420 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13421 "inside the LVM metadata."
13425 #: ../src/guestfs-actions.pod:4245 ../fish/guestfish-actions.pod:2861
13426 msgid "You can filter whole block devices or individual partitions."
13430 #: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:2863
13432 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13433 "filesystem), even if you are not filtering out that VG."
13437 #: ../src/guestfs-actions.pod:4255
13438 msgid "guestfs_lvremove"
13442 #: ../src/guestfs-actions.pod:4257
13446 " guestfs_lvremove (guestfs_h *g,\n"
13447 " const char *device);\n"
13452 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2871
13454 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13455 "LV, such as C</dev/VG/LV>."
13459 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2874
13461 "You can also remove all LVs in a volume group by specifying the VG name, "
13466 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:5666
13467 #: ../src/guestfs-actions.pod:7498
13468 msgid "(Added in 1.0.13)"
13472 #: ../src/guestfs-actions.pod:4271
13473 msgid "guestfs_lvrename"
13477 #: ../src/guestfs-actions.pod:4273
13481 " guestfs_lvrename (guestfs_h *g,\n"
13482 " const char *logvol,\n"
13483 " const char *newlogvol);\n"
13488 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2881
13489 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13493 #: ../src/guestfs-actions.pod:4282 ../src/guestfs-actions.pod:7511
13494 msgid "(Added in 1.0.83)"
13498 #: ../src/guestfs-actions.pod:4284
13499 msgid "guestfs_lvresize"
13503 #: ../src/guestfs-actions.pod:4286
13507 " guestfs_lvresize (guestfs_h *g,\n"
13508 " const char *device,\n"
13514 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2887
13516 "This resizes (expands or shrinks) an existing LVM logical volume to "
13517 "C<mbytes>. When reducing, data in the reduced part is lost."
13521 #: ../src/guestfs-actions.pod:4299
13522 msgid "guestfs_lvresize_free"
13526 #: ../src/guestfs-actions.pod:4301
13530 " guestfs_lvresize_free (guestfs_h *g,\n"
13531 " const char *lv,\n"
13537 #: ../src/guestfs-actions.pod:4306 ../fish/guestfish-actions.pod:2895
13539 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the"
13540 " remaining free space in the volume group. Commonly you would call this "
13541 "with pc = 100 which expands the logical volume as much as possible, using "
13542 "all remaining free space in the volume group."
13546 #: ../src/guestfs-actions.pod:4314
13547 msgid "(Added in 1.3.3)"
13551 #: ../src/guestfs-actions.pod:4316
13552 msgid "guestfs_lvs"
13556 #: ../src/guestfs-actions.pod:4318
13560 " guestfs_lvs (guestfs_h *g);\n"
13565 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2905
13567 "List all the logical volumes detected. This is the equivalent of the "
13568 "L<lvs(8)> command."
13572 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2908
13574 "This returns a list of the logical volume device names (eg. "
13575 "C</dev/VolGroup00/LogVol00>)."
13579 #: ../src/guestfs-actions.pod:4327
13580 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13584 #: ../src/guestfs-actions.pod:4335
13585 msgid "guestfs_lvs_full"
13589 #: ../src/guestfs-actions.pod:4337
13592 " struct guestfs_lvm_lv_list *\n"
13593 " guestfs_lvs_full (guestfs_h *g);\n"
13598 #: ../src/guestfs-actions.pod:4340 ../fish/guestfish-actions.pod:2917
13600 "List all the logical volumes detected. This is the equivalent of the "
13601 "L<lvs(8)> command. The \"full\" version includes all fields."
13605 #: ../src/guestfs-actions.pod:4343
13607 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13608 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
13613 #: ../src/guestfs-actions.pod:4349
13614 msgid "guestfs_lvuuid"
13618 #: ../src/guestfs-actions.pod:4351
13622 " guestfs_lvuuid (guestfs_h *g,\n"
13623 " const char *device);\n"
13628 #: ../src/guestfs-actions.pod:4355 ../fish/guestfish-actions.pod:2924
13629 msgid "This command returns the UUID of the LVM LV C<device>."
13633 #: ../src/guestfs-actions.pod:4362
13634 msgid "guestfs_lxattrlist"
13638 #: ../src/guestfs-actions.pod:4364
13641 " struct guestfs_xattr_list *\n"
13642 " guestfs_lxattrlist (guestfs_h *g,\n"
13643 " const char *path,\n"
13644 " char *const *names);\n"
13649 #: ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:2930
13651 "This call allows you to get the extended attributes of multiple files, where"
13652 " all files are in the directory C<path>. C<names> is the list of files from"
13657 #: ../src/guestfs-actions.pod:4373 ../fish/guestfish-actions.pod:2934
13659 "On return you get a flat list of xattr structs which must be interpreted "
13660 "sequentially. The first xattr struct always has a zero-length C<attrname>."
13661 " C<attrval> in this struct is zero-length to indicate there was an error "
13662 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13663 "number (the number of following attributes for this file, which could be "
13664 "C<\"0\">). Then after the first xattr struct are the zero or more "
13665 "attributes for the first named file. This repeats for the second and "
13666 "subsequent files."
13670 #: ../src/guestfs-actions.pod:4383
13672 "This call is intended for programs that want to efficiently list a directory"
13673 " contents without making many round-trips. See also C<guestfs_lstatlist> "
13674 "for a similarly efficient call for getting standard stats. Very long "
13675 "directory listings might cause the protocol message size to be exceeded, "
13676 "causing this call to fail. The caller must split up such requests into "
13677 "smaller groups of names."
13681 #: ../src/guestfs-actions.pod:4397
13682 msgid "guestfs_mkdir"
13686 #: ../src/guestfs-actions.pod:4399
13690 " guestfs_mkdir (guestfs_h *g,\n"
13691 " const char *path);\n"
13696 #: ../src/guestfs-actions.pod:4403 ../fish/guestfish-actions.pod:2956
13697 msgid "Create a directory named C<path>."
13701 #: ../src/guestfs-actions.pod:4409
13702 msgid "guestfs_mkdir_mode"
13706 #: ../src/guestfs-actions.pod:4411
13710 " guestfs_mkdir_mode (guestfs_h *g,\n"
13711 " const char *path,\n"
13717 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:2962
13719 "This command creates a directory, setting the initial permissions of the "
13720 "directory to C<mode>."
13724 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:2965
13726 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13727 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13732 #: ../src/guestfs-actions.pod:4423
13733 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13737 #: ../src/guestfs-actions.pod:4429
13738 msgid "guestfs_mkdir_p"
13742 #: ../src/guestfs-actions.pod:4431
13746 " guestfs_mkdir_p (guestfs_h *g,\n"
13747 " const char *path);\n"
13752 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:2975
13754 "Create a directory named C<path>, creating any parent directories as "
13755 "necessary. This is like the C<mkdir -p> shell command."
13759 #: ../src/guestfs-actions.pod:4442
13760 msgid "guestfs_mkdtemp"
13764 #: ../src/guestfs-actions.pod:4444
13768 " guestfs_mkdtemp (guestfs_h *g,\n"
13769 " const char *template);\n"
13774 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2982
13776 "This command creates a temporary directory. The C<template> parameter "
13777 "should be a full pathname for the temporary directory name with the final "
13778 "six characters being \"XXXXXX\"."
13782 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:2987
13784 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one"
13785 " being suitable for Windows filesystems."
13789 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2990
13790 msgid "The name of the temporary directory that was created is returned."
13794 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2993
13796 "The temporary directory is created with mode 0700 and is owned by root."
13800 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2996
13802 "The caller is responsible for deleting the temporary directory and its "
13803 "contents after use."
13807 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2999
13808 msgid "See also: L<mkdtemp(3)>"
13812 #: ../src/guestfs-actions.pod:4472
13813 msgid "guestfs_mke2fs_J"
13817 #: ../src/guestfs-actions.pod:4474
13821 " guestfs_mke2fs_J (guestfs_h *g,\n"
13822 " const char *fstype,\n"
13823 " int blocksize,\n"
13824 " const char *device,\n"
13825 " const char *journal);\n"
13830 #: ../src/guestfs-actions.pod:4481 ../fish/guestfish-actions.pod:3005
13832 "This creates an ext2/3/4 filesystem on C<device> with an external journal on"
13833 " C<journal>. It is equivalent to the command:"
13837 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
13840 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13845 #: ../src/guestfs-actions.pod:4487
13846 msgid "See also C<guestfs_mke2journal>."
13850 #: ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4509
13851 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4543
13852 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4571
13853 #: ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4907
13854 msgid "(Added in 1.0.68)"
13858 #: ../src/guestfs-actions.pod:4493
13859 msgid "guestfs_mke2fs_JL"
13863 #: ../src/guestfs-actions.pod:4495
13867 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13868 " const char *fstype,\n"
13869 " int blocksize,\n"
13870 " const char *device,\n"
13871 " const char *label);\n"
13876 #: ../src/guestfs-actions.pod:4502 ../fish/guestfish-actions.pod:3017
13878 "This creates an ext2/3/4 filesystem on C<device> with an external journal on"
13879 " the journal labeled C<label>."
13883 #: ../src/guestfs-actions.pod:4505
13884 msgid "See also C<guestfs_mke2journal_L>."
13888 #: ../src/guestfs-actions.pod:4511
13889 msgid "guestfs_mke2fs_JU"
13893 #: ../src/guestfs-actions.pod:4513
13897 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13898 " const char *fstype,\n"
13899 " int blocksize,\n"
13900 " const char *device,\n"
13901 " const char *uuid);\n"
13906 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3026
13908 "This creates an ext2/3/4 filesystem on C<device> with an external journal on"
13909 " the journal with UUID C<uuid>."
13913 #: ../src/guestfs-actions.pod:4523
13914 msgid "See also C<guestfs_mke2journal_U>."
13918 #: ../src/guestfs-actions.pod:4529
13919 msgid "guestfs_mke2journal"
13923 #: ../src/guestfs-actions.pod:4531
13927 " guestfs_mke2journal (guestfs_h *g,\n"
13928 " int blocksize,\n"
13929 " const char *device);\n"
13934 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3035
13936 "This creates an ext2 external journal on C<device>. It is equivalent to the"
13941 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3038
13944 " mke2fs -O journal_dev -b blocksize device\n"
13949 #: ../src/guestfs-actions.pod:4545
13950 msgid "guestfs_mke2journal_L"
13954 #: ../src/guestfs-actions.pod:4547
13958 " guestfs_mke2journal_L (guestfs_h *g,\n"
13959 " int blocksize,\n"
13960 " const char *label,\n"
13961 " const char *device);\n"
13966 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3044
13968 "This creates an ext2 external journal on C<device> with label C<label>."
13972 #: ../src/guestfs-actions.pod:4559
13973 msgid "guestfs_mke2journal_U"
13977 #: ../src/guestfs-actions.pod:4561
13981 " guestfs_mke2journal_U (guestfs_h *g,\n"
13982 " int blocksize,\n"
13983 " const char *uuid,\n"
13984 " const char *device);\n"
13989 #: ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:3050
13990 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13994 #: ../src/guestfs-actions.pod:4573
13995 msgid "guestfs_mkfifo"
13999 #: ../src/guestfs-actions.pod:4575
14003 " guestfs_mkfifo (guestfs_h *g,\n"
14005 " const char *path);\n"
14010 #: ../src/guestfs-actions.pod:4580
14012 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14013 "is just a convenient wrapper around C<guestfs_mknod>."
14017 #: ../src/guestfs-actions.pod:4590
14018 msgid "guestfs_mkfs"
14022 #: ../src/guestfs-actions.pod:4592
14026 " guestfs_mkfs (guestfs_h *g,\n"
14027 " const char *fstype,\n"
14028 " const char *device);\n"
14033 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3066
14035 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14036 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14040 #: ../src/guestfs-actions.pod:4605
14041 msgid "guestfs_mkfs_b"
14045 #: ../src/guestfs-actions.pod:4607
14049 " guestfs_mkfs_b (guestfs_h *g,\n"
14050 " const char *fstype,\n"
14051 " int blocksize,\n"
14052 " const char *device);\n"
14057 #: ../src/guestfs-actions.pod:4613
14059 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14060 "block size of the resulting filesystem. Supported block sizes depend on the"
14061 " filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14065 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4663
14066 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
14068 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14073 #: ../src/guestfs-actions.pod:4623 ../fish/guestfish-actions.pod:3082
14075 "This function is deprecated. In new code, use the C<mkfs_opts> call "
14080 #: ../src/guestfs-actions.pod:4632
14081 msgid "guestfs_mkfs_opts"
14085 #: ../src/guestfs-actions.pod:4634
14089 " guestfs_mkfs_opts (guestfs_h *g,\n"
14090 " const char *fstype,\n"
14091 " const char *device,\n"
14097 #: ../src/guestfs-actions.pod:4645
14100 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14101 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14102 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
14103 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
14108 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3093
14110 "This function creates a filesystem on C<device>. The filesystem type is "
14111 "C<fstype>, for example C<ext3>."
14115 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3100
14116 msgid "C<blocksize>"
14120 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3102
14122 "The filesystem block size. Supported block sizes depend on the filesystem "
14123 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14128 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3109
14129 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14133 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3111
14134 msgid "C<features>"
14138 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3113
14139 msgid "This passes the I<-O> parameter to the external mkfs program."
14143 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3115
14145 "For certain filesystem types, this allows extra filesystem features to be "
14146 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14150 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3119
14152 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem"
14157 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3122
14162 #: ../src/guestfs-actions.pod:4681 ../fish/guestfish-actions.pod:3124
14164 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
14165 "sets the inode size (only for ext2/3/4 filesystems at present)."
14169 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3127
14170 msgid "C<sectorsize>"
14174 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3129
14176 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
14177 "sets sector size for ufs filesystem."
14181 #: ../src/guestfs-actions.pod:4693
14182 msgid "(Added in 1.7.19)"
14186 #: ../src/guestfs-actions.pod:4695
14187 msgid "guestfs_mkfs_opts_va"
14191 #: ../src/guestfs-actions.pod:4697
14195 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14196 " const char *fstype,\n"
14197 " const char *device,\n"
14198 " va_list args);\n"
14203 #: ../src/guestfs-actions.pod:4703
14204 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14208 #: ../src/guestfs-actions.pod:4707
14209 msgid "guestfs_mkfs_opts_argv"
14213 #: ../src/guestfs-actions.pod:4709
14217 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14218 " const char *fstype,\n"
14219 " const char *device,\n"
14220 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14225 #: ../src/guestfs-actions.pod:4715
14226 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14230 #: ../src/guestfs-actions.pod:4719
14231 msgid "guestfs_mkmountpoint"
14235 #: ../src/guestfs-actions.pod:4721
14239 " guestfs_mkmountpoint (guestfs_h *g,\n"
14240 " const char *exemptpath);\n"
14245 #: ../src/guestfs-actions.pod:4725
14247 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14248 "that can be used to create extra mountpoints before mounting the first "
14253 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3144
14255 "These calls are I<only> necessary in some very limited circumstances, mainly"
14256 " the case where you want to mount a mix of unrelated and/or read-only "
14257 "filesystems together."
14261 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3148
14263 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14264 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14265 "inside that. You can unpack this as follows in guestfish:"
14269 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3153
14272 " add-ro Fedora-11-i686-Live.iso\n"
14274 " mkmountpoint /cd\n"
14275 " mkmountpoint /sqsh\n"
14276 " mkmountpoint /ext3fs\n"
14277 " mount /dev/sda /cd\n"
14278 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14279 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14284 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3162
14285 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14289 #: ../src/guestfs-actions.pod:4749
14291 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14292 "may get unexpected errors if you try to mix these calls. It is safest to "
14293 "manually unmount filesystems and remove mountpoints after use."
14297 #: ../src/guestfs-actions.pod:4753
14299 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14300 "first, so for this to work for manual mountpoints, you must ensure that the "
14301 "innermost mountpoints have the longest pathnames, as in the example code "
14306 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3173
14308 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14312 #: ../src/guestfs-actions.pod:4760
14314 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14315 "can cause C<guestfs_umount_all> to be called when the handle is closed which"
14316 " can also trigger these issues."
14320 #: ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:5082
14321 #: ../src/guestfs-actions.pod:6086
14322 msgid "(Added in 1.0.62)"
14326 #: ../src/guestfs-actions.pod:4768
14327 msgid "guestfs_mknod"
14331 #: ../src/guestfs-actions.pod:4770
14335 " guestfs_mknod (guestfs_h *g,\n"
14339 " const char *path);\n"
14344 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3183
14346 "This call creates block or character special devices, or named pipes "
14351 #: ../src/guestfs-actions.pod:4780 ../fish/guestfish-actions.pod:3186
14353 "The C<mode> parameter should be the mode, using the standard constants. "
14354 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14355 "used when creating block and character special devices."
14359 #: ../src/guestfs-actions.pod:4785
14361 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14362 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14363 "regular file). These constants are available in the standard Linux header "
14364 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14365 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in"
14366 " the appropriate constant for you."
14370 #: ../src/guestfs-actions.pod:4799
14371 msgid "guestfs_mknod_b"
14375 #: ../src/guestfs-actions.pod:4801
14379 " guestfs_mknod_b (guestfs_h *g,\n"
14383 " const char *path);\n"
14388 #: ../src/guestfs-actions.pod:4808
14390 "This call creates a block device node called C<path> with mode C<mode> and "
14391 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14392 "wrapper around C<guestfs_mknod>."
14396 #: ../src/guestfs-actions.pod:4818
14397 msgid "guestfs_mknod_c"
14401 #: ../src/guestfs-actions.pod:4820
14405 " guestfs_mknod_c (guestfs_h *g,\n"
14409 " const char *path);\n"
14414 #: ../src/guestfs-actions.pod:4827
14416 "This call creates a char device node called C<path> with mode C<mode> and "
14417 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14418 "wrapper around C<guestfs_mknod>."
14422 #: ../src/guestfs-actions.pod:4837
14423 msgid "guestfs_mkswap"
14427 #: ../src/guestfs-actions.pod:4839
14431 " guestfs_mkswap (guestfs_h *g,\n"
14432 " const char *device);\n"
14437 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3225
14438 msgid "Create a swap partition on C<device>."
14442 #: ../src/guestfs-actions.pod:4849
14443 msgid "guestfs_mkswap_L"
14447 #: ../src/guestfs-actions.pod:4851
14451 " guestfs_mkswap_L (guestfs_h *g,\n"
14452 " const char *label,\n"
14453 " const char *device);\n"
14458 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3231
14459 msgid "Create a swap partition on C<device> with label C<label>."
14463 #: ../src/guestfs-actions.pod:4858 ../fish/guestfish-actions.pod:3233
14465 "Note that you cannot attach a swap label to a block device (eg. "
14466 "C</dev/sda>), just to a partition. This appears to be a limitation of the "
14467 "kernel or swap tools."
14471 #: ../src/guestfs-actions.pod:4866
14472 msgid "guestfs_mkswap_U"
14476 #: ../src/guestfs-actions.pod:4868
14480 " guestfs_mkswap_U (guestfs_h *g,\n"
14481 " const char *uuid,\n"
14482 " const char *device);\n"
14487 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3241
14488 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14492 #: ../src/guestfs-actions.pod:4879
14493 msgid "guestfs_mkswap_file"
14497 #: ../src/guestfs-actions.pod:4881
14501 " guestfs_mkswap_file (guestfs_h *g,\n"
14502 " const char *path);\n"
14507 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3247
14508 msgid "Create a swap file."
14512 #: ../src/guestfs-actions.pod:4887
14514 "This command just writes a swap file signature to an existing file. To "
14515 "create the file itself, use something like C<guestfs_fallocate>."
14519 #: ../src/guestfs-actions.pod:4894
14520 msgid "guestfs_modprobe"
14524 #: ../src/guestfs-actions.pod:4896
14528 " guestfs_modprobe (guestfs_h *g,\n"
14529 " const char *modulename);\n"
14534 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3256
14535 msgid "This loads a kernel module in the appliance."
14539 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3258
14541 "The kernel module must have been whitelisted when libguestfs was built (see "
14542 "C<appliance/kmod.whitelist.in> in the source)."
14546 #: ../src/guestfs-actions.pod:4909
14547 msgid "guestfs_mount"
14551 #: ../src/guestfs-actions.pod:4911
14555 " guestfs_mount (guestfs_h *g,\n"
14556 " const char *device,\n"
14557 " const char *mountpoint);\n"
14562 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3265
14564 "Mount a guest disk at a position in the filesystem. Block devices are named"
14565 " C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14566 "those block devices contain partitions, they will have the usual names (eg. "
14567 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14571 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3271
14573 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14574 "mounted on C</> before others can be mounted. Other filesystems can only be"
14575 " mounted on directories which already exist."
14579 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3276
14581 "The mounted filesystem is writable, if we have sufficient permissions on the"
14582 " underlying device."
14586 #: ../src/guestfs-actions.pod:4930
14588 "B<Important note:> When you use this call, the filesystem options C<sync> "
14589 "and C<noatime> are set implicitly. This was originally done because we "
14590 "thought it would improve reliability, but it turns out that I<-o sync> has a"
14591 " very large negative performance impact and negligible effect on "
14592 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14593 "in any code that needs performance, and instead use C<guestfs_mount_options>"
14594 " (use an empty string for the first parameter if you don't want any "
14599 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3289
14601 "This function is deprecated. In new code, use the C<mount_options> call "
14606 #: ../src/guestfs-actions.pod:4951
14607 msgid "guestfs_mount_9p"
14611 #: ../src/guestfs-actions.pod:4953
14615 " guestfs_mount_9p (guestfs_h *g,\n"
14616 " const char *mounttag,\n"
14617 " const char *mountpoint,\n"
14623 #: ../src/guestfs-actions.pod:4964
14626 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14631 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3300
14633 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14638 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3303
14640 "If required, C<trans=virtio> will be automatically added to the options. "
14641 "Any other options required can be passed in the optional C<options> "
14646 #: ../src/guestfs-actions.pod:4977
14647 msgid "guestfs_mount_9p_va"
14651 #: ../src/guestfs-actions.pod:4979
14655 " guestfs_mount_9p_va (guestfs_h *g,\n"
14656 " const char *mounttag,\n"
14657 " const char *mountpoint,\n"
14658 " va_list args);\n"
14663 #: ../src/guestfs-actions.pod:4985
14664 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14668 #: ../src/guestfs-actions.pod:4989
14669 msgid "guestfs_mount_9p_argv"
14673 #: ../src/guestfs-actions.pod:4991
14677 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14678 " const char *mounttag,\n"
14679 " const char *mountpoint,\n"
14680 " const struct guestfs_mount_9p_argv *optargs);\n"
14685 #: ../src/guestfs-actions.pod:4997
14686 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14690 #: ../src/guestfs-actions.pod:5001
14691 msgid "guestfs_mount_loop"
14695 #: ../src/guestfs-actions.pod:5003
14699 " guestfs_mount_loop (guestfs_h *g,\n"
14700 " const char *file,\n"
14701 " const char *mountpoint);\n"
14706 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3313
14708 "This command lets you mount C<file> (a filesystem image in a file) on a "
14709 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14714 #: ../src/guestfs-actions.pod:5016
14715 msgid "guestfs_mount_options"
14719 #: ../src/guestfs-actions.pod:5018
14723 " guestfs_mount_options (guestfs_h *g,\n"
14724 " const char *options,\n"
14725 " const char *device,\n"
14726 " const char *mountpoint);\n"
14731 #: ../src/guestfs-actions.pod:5024
14733 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14734 "the mount options as for the L<mount(8)> I<-o> flag."
14738 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3325
14740 "If the C<options> parameter is an empty string, then no options are passed "
14741 "(all options default to whatever the filesystem uses)."
14745 #: ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048
14746 #: ../src/guestfs-actions.pod:5065
14747 msgid "(Added in 1.0.10)"
14751 #: ../src/guestfs-actions.pod:5036
14752 msgid "guestfs_mount_ro"
14756 #: ../src/guestfs-actions.pod:5038
14760 " guestfs_mount_ro (guestfs_h *g,\n"
14761 " const char *device,\n"
14762 " const char *mountpoint);\n"
14767 #: ../src/guestfs-actions.pod:5043
14769 "This is the same as the C<guestfs_mount> command, but it mounts the "
14770 "filesystem with the read-only (I<-o ro>) flag."
14774 #: ../src/guestfs-actions.pod:5050
14775 msgid "guestfs_mount_vfs"
14779 #: ../src/guestfs-actions.pod:5052
14783 " guestfs_mount_vfs (guestfs_h *g,\n"
14784 " const char *options,\n"
14785 " const char *vfstype,\n"
14786 " const char *device,\n"
14787 " const char *mountpoint);\n"
14792 #: ../src/guestfs-actions.pod:5059
14794 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14795 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
14800 #: ../src/guestfs-actions.pod:5067
14801 msgid "guestfs_mountpoints"
14805 #: ../src/guestfs-actions.pod:5069
14809 " guestfs_mountpoints (guestfs_h *g);\n"
14814 #: ../src/guestfs-actions.pod:5072
14816 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14817 "devices. This one returns a hash table (map) of device name to directory "
14818 "where the device is mounted."
14822 #: ../src/guestfs-actions.pod:5084
14823 msgid "guestfs_mounts"
14827 #: ../src/guestfs-actions.pod:5086
14831 " guestfs_mounts (guestfs_h *g);\n"
14836 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3356
14838 "This returns the list of currently mounted filesystems. It returns the list"
14839 " of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14843 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3359
14844 msgid "Some internal mounts are not shown."
14848 #: ../src/guestfs-actions.pod:5094
14849 msgid "See also: C<guestfs_mountpoints>"
14853 #: ../src/guestfs-actions.pod:5102
14858 #: ../src/guestfs-actions.pod:5104
14862 " guestfs_mv (guestfs_h *g,\n"
14863 " const char *src,\n"
14864 " const char *dest);\n"
14869 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3367
14871 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14872 "destination filename or destination directory."
14876 #: ../src/guestfs-actions.pod:5116
14877 msgid "guestfs_ntfs_3g_probe"
14881 #: ../src/guestfs-actions.pod:5118
14885 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14887 " const char *device);\n"
14892 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3374
14894 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14895 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14896 "write, and some cannot be mounted at all)."
14900 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3378
14902 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14903 "can be mounted read-write. Set it to false if you want to test if the "
14904 "volume can be mounted read-only."
14908 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3382
14910 "The return value is an integer which C<0> if the operation would succeed, or"
14911 " some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14915 #: ../src/guestfs-actions.pod:5137
14916 msgid "(Added in 1.0.43)"
14920 #: ../src/guestfs-actions.pod:5139
14921 msgid "guestfs_ntfsresize"
14925 #: ../src/guestfs-actions.pod:5141
14929 " guestfs_ntfsresize (guestfs_h *g,\n"
14930 " const char *device);\n"
14935 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5184
14936 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
14938 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14939 "size of the underlying device."
14943 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3393
14945 "I<Note:> After the resize operation, the filesystem is marked as requiring a"
14946 " consistency check (for safety). You have to boot into Windows to perform "
14947 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14948 "resize filesystems which have been marked in this way. So in effect it is "
14949 "not possible to call ntfsresize multiple times on a single filesystem "
14950 "without booting into Windows between each resize."
14954 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5210
14955 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
14956 msgid "See also L<ntfsresize(8)>."
14960 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5250
14961 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
14963 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14968 #: ../src/guestfs-actions.pod:5169
14969 msgid "guestfs_ntfsresize_opts"
14973 #: ../src/guestfs-actions.pod:5171
14977 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
14978 " const char *device,\n"
14984 #: ../src/guestfs-actions.pod:5181
14987 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
14988 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
14993 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3423
14995 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14996 "resized to fit the container (eg. partition)."
15000 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3426
15005 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3428
15007 "If this option is true, then force the resize of the filesystem even if the "
15008 "filesystem is marked as requiring a consistency check."
15012 #: ../src/guestfs-actions.pod:5201
15014 "After the resize operation, the filesystem is always marked as requiring a "
15015 "consistency check (for safety). You have to boot into Windows to perform "
15016 "this check and clear this condition. If you I<don't> set the C<force> "
15017 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
15018 "times on a single filesystem without booting into Windows between each "
15023 #: ../src/guestfs-actions.pod:5216
15024 msgid "guestfs_ntfsresize_opts_va"
15028 #: ../src/guestfs-actions.pod:5218
15032 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
15033 " const char *device,\n"
15034 " va_list args);\n"
15039 #: ../src/guestfs-actions.pod:5223
15040 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
15044 #: ../src/guestfs-actions.pod:5227
15045 msgid "guestfs_ntfsresize_opts_argv"
15049 #: ../src/guestfs-actions.pod:5229
15053 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
15054 " const char *device,\n"
15055 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
15060 #: ../src/guestfs-actions.pod:5234
15061 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
15065 #: ../src/guestfs-actions.pod:5238
15066 msgid "guestfs_ntfsresize_size"
15070 #: ../src/guestfs-actions.pod:5240
15074 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15075 " const char *device,\n"
15076 " int64_t size);\n"
15081 #: ../src/guestfs-actions.pod:5245
15083 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15084 "to specify the new size (in bytes) explicitly."
15088 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5693
15089 #: ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:6034
15090 #: ../src/guestfs-actions.pod:7655
15091 msgid "(Added in 1.3.14)"
15095 #: ../src/guestfs-actions.pod:5259
15096 msgid "guestfs_part_add"
15100 #: ../src/guestfs-actions.pod:5261
15104 " guestfs_part_add (guestfs_h *g,\n"
15105 " const char *device,\n"
15106 " const char *prlogex,\n"
15107 " int64_t startsect,\n"
15108 " int64_t endsect);\n"
15113 #: ../src/guestfs-actions.pod:5268
15115 "This command adds a partition to C<device>. If there is no partition table "
15116 "on the device, call C<guestfs_part_init> first."
15120 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3465
15122 "The C<prlogex> parameter is the type of partition. Normally you should pass"
15123 " C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15124 "C<logical>) and C<e> (or C<extended>) partition types."
15128 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3470
15130 "C<startsect> and C<endsect> are the start and end of the partition in "
15131 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15132 "from the end of the disk (C<-1> is the last sector)."
15136 #: ../src/guestfs-actions.pod:5280
15138 "Creating a partition which covers the whole disk is not so easy. Use "
15139 "C<guestfs_part_disk> to do that."
15143 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5323
15144 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5454
15145 #: ../src/guestfs-actions.pod:5492 ../src/guestfs-actions.pod:5511
15146 #: ../src/guestfs-actions.pod:5551
15147 msgid "(Added in 1.0.78)"
15151 #: ../src/guestfs-actions.pod:5287
15152 msgid "guestfs_part_del"
15156 #: ../src/guestfs-actions.pod:5289
15160 " guestfs_part_del (guestfs_h *g,\n"
15161 " const char *device,\n"
15167 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3481
15168 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15172 #: ../src/guestfs-actions.pod:5296 ../fish/guestfish-actions.pod:3483
15174 "Note that in the case of MBR partitioning, deleting an extended partition "
15175 "also deletes any logical partitions it contains."
15179 #: ../src/guestfs-actions.pod:5304
15180 msgid "guestfs_part_disk"
15184 #: ../src/guestfs-actions.pod:5306
15188 " guestfs_part_disk (guestfs_h *g,\n"
15189 " const char *device,\n"
15190 " const char *parttype);\n"
15195 #: ../src/guestfs-actions.pod:5311
15197 "This command is simply a combination of C<guestfs_part_init> followed by "
15198 "C<guestfs_part_add> to create a single primary partition covering the whole "
15203 #: ../src/guestfs-actions.pod:5315
15205 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other"
15206 " possible values are described in C<guestfs_part_init>."
15210 #: ../src/guestfs-actions.pod:5325
15211 msgid "guestfs_part_get_bootable"
15215 #: ../src/guestfs-actions.pod:5327
15219 " guestfs_part_get_bootable (guestfs_h *g,\n"
15220 " const char *device,\n"
15226 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3505
15228 "This command returns true if the partition C<partnum> on C<device> has the "
15229 "bootable flag set."
15233 #: ../src/guestfs-actions.pod:5335
15234 msgid "See also C<guestfs_part_set_bootable>."
15238 #: ../src/guestfs-actions.pod:5341
15239 msgid "guestfs_part_get_mbr_id"
15243 #: ../src/guestfs-actions.pod:5343
15247 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15248 " const char *device,\n"
15254 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3514
15256 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15257 "partition C<partnum>."
15261 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5527
15263 "Note that only MBR (old DOS-style) partitions have type bytes. You will get"
15264 " undefined results for other partition table types (see "
15265 "C<guestfs_part_get_parttype>)."
15269 #: ../src/guestfs-actions.pod:5359
15270 msgid "guestfs_part_get_parttype"
15274 #: ../src/guestfs-actions.pod:5361
15278 " guestfs_part_get_parttype (guestfs_h *g,\n"
15279 " const char *device);\n"
15284 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3525
15286 "This command examines the partition table on C<device> and returns the "
15287 "partition table type (format) being used."
15291 #: ../src/guestfs-actions.pod:5368
15293 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15294 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15295 "possible, although unusual. See C<guestfs_part_init> for a full list."
15299 #: ../src/guestfs-actions.pod:5378
15300 msgid "guestfs_part_init"
15304 #: ../src/guestfs-actions.pod:5380
15308 " guestfs_part_init (guestfs_h *g,\n"
15309 " const char *device,\n"
15310 " const char *parttype);\n"
15315 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3537
15317 "This creates an empty partition table on C<device> of one of the partition "
15318 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt>"
15319 " (for large disks)."
15323 #: ../src/guestfs-actions.pod:5389
15325 "Initially there are no partitions. Following this, you should call "
15326 "C<guestfs_part_add> for each partition required."
15330 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3544
15331 msgid "Possible values for C<parttype> are:"
15335 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3548
15336 msgid "B<efi> | B<gpt>"
15340 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3550
15341 msgid "Intel EFI / GPT partition table."
15345 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3552
15347 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15348 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15349 "the C<mbr> format."
15353 #: ../src/guestfs-actions.pod:5404 ../fish/guestfish-actions.pod:3556
15354 msgid "B<mbr> | B<msdos>"
15358 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3558
15360 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15361 "Windows. This partition type will B<only> work for device sizes up to 2 TB."
15362 " For large disks we recommend using C<gpt>."
15366 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3565
15368 "Other partition table types that may work but are not supported include:"
15372 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3570
15377 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3572
15378 msgid "AIX disk labels."
15382 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3574
15383 msgid "B<amiga> | B<rdb>"
15387 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3576
15388 msgid "Amiga \"Rigid Disk Block\" format."
15392 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3578
15397 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3580
15398 msgid "BSD disk labels."
15402 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3582
15407 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3584
15408 msgid "DASD, used on IBM mainframes."
15412 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3586
15417 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3588
15418 msgid "MIPS/SGI volumes."
15422 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3590
15427 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3592
15428 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15432 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3594
15437 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3596
15438 msgid "NEC PC-98 format, common in Japan apparently."
15442 #: ../src/guestfs-actions.pod:5446 ../fish/guestfish-actions.pod:3598
15447 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3600
15448 msgid "Sun disk labels."
15452 #: ../src/guestfs-actions.pod:5456
15453 msgid "guestfs_part_list"
15457 #: ../src/guestfs-actions.pod:5458
15460 " struct guestfs_partition_list *\n"
15461 " guestfs_part_list (guestfs_h *g,\n"
15462 " const char *device);\n"
15467 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3608
15469 "This command parses the partition table on C<device> and returns the list of"
15470 " partitions found."
15474 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3611
15475 msgid "The fields in the returned structure are:"
15479 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3615
15480 msgid "B<part_num>"
15484 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3617
15485 msgid "Partition number, counting from 1."
15489 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3619
15490 msgid "B<part_start>"
15494 #: ../src/guestfs-actions.pod:5475
15496 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15497 "the device's sector size, see C<guestfs_blockdev_getss>."
15501 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3624
15502 msgid "B<part_end>"
15506 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3626
15507 msgid "End of the partition in bytes."
15511 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3628
15512 msgid "B<part_size>"
15516 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3630
15517 msgid "Size of the partition in bytes."
15521 #: ../src/guestfs-actions.pod:5488
15523 "This function returns a C<struct guestfs_partition_list *>, or NULL if there"
15524 " was an error. I<The caller must call C<guestfs_free_partition_list> after "
15529 #: ../src/guestfs-actions.pod:5494
15530 msgid "guestfs_part_set_bootable"
15534 #: ../src/guestfs-actions.pod:5496
15538 " guestfs_part_set_bootable (guestfs_h *g,\n"
15539 " const char *device,\n"
15541 " int bootable);\n"
15546 #: ../src/guestfs-actions.pod:5502 ../fish/guestfish-actions.pod:3638
15548 "This sets the bootable flag on partition numbered C<partnum> on device "
15549 "C<device>. Note that partitions are numbered from 1."
15553 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3641
15555 "The bootable flag is used by some operating systems (notably Windows) to "
15556 "determine which partition to boot from. It is by no means universally "
15561 #: ../src/guestfs-actions.pod:5513
15562 msgid "guestfs_part_set_mbr_id"
15566 #: ../src/guestfs-actions.pod:5515
15570 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15571 " const char *device,\n"
15578 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3649
15580 "Sets the MBR type byte (also known as the ID byte) of the numbered partition"
15581 " C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15582 "documentation are in fact hexadecimal numbers, but usually documented "
15583 "without any leading \"0x\" which might be confusing."
15587 #: ../src/guestfs-actions.pod:5535
15588 msgid "guestfs_part_set_name"
15592 #: ../src/guestfs-actions.pod:5537
15596 " guestfs_part_set_name (guestfs_h *g,\n"
15597 " const char *device,\n"
15599 " const char *name);\n"
15604 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3663
15606 "This sets the partition name on partition numbered C<partnum> on device "
15607 "C<device>. Note that partitions are numbered from 1."
15611 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3666
15613 "The partition name can only be set on certain types of partition table. "
15614 "This works on C<gpt> but not on C<mbr> partitions."
15618 #: ../src/guestfs-actions.pod:5553
15619 msgid "guestfs_part_to_dev"
15623 #: ../src/guestfs-actions.pod:5555
15627 " guestfs_part_to_dev (guestfs_h *g,\n"
15628 " const char *partition);\n"
15633 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3673
15635 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15636 "partition number, returning the device name (eg. \"/dev/sdb\")."
15640 #: ../src/guestfs-actions.pod:5563
15642 "The named partition must exist, for example as a string returned from "
15643 "C<guestfs_list_partitions>."
15647 #: ../src/guestfs-actions.pod:5571
15648 msgid "guestfs_ping_daemon"
15652 #: ../src/guestfs-actions.pod:5573
15656 " guestfs_ping_daemon (guestfs_h *g);\n"
15661 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3684
15663 "This is a test probe into the guestfs daemon running inside the qemu "
15664 "subprocess. Calling this function checks that the daemon responds to the "
15665 "ping message, without affecting the daemon or attached block device(s) in "
15670 #: ../src/guestfs-actions.pod:5585
15671 msgid "guestfs_pread"
15675 #: ../src/guestfs-actions.pod:5587
15679 " guestfs_pread (guestfs_h *g,\n"
15680 " const char *path,\n"
15682 " int64_t offset,\n"
15683 " size_t *size_r);\n"
15688 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3693
15690 "This command lets you read part of a file. It reads C<count> bytes of the "
15691 "file, starting at C<offset>, from file C<path>."
15695 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5623
15696 #: ../fish/guestfish-actions.pod:3696 ../fish/guestfish-actions.pod:3711
15698 "This may read fewer bytes than requested. For further details see the "
15699 "L<pread(2)> system call."
15703 #: ../src/guestfs-actions.pod:5600
15704 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15708 #: ../src/guestfs-actions.pod:5611
15709 msgid "guestfs_pread_device"
15713 #: ../src/guestfs-actions.pod:5613
15717 " guestfs_pread_device (guestfs_h *g,\n"
15718 " const char *device,\n"
15720 " int64_t offset,\n"
15721 " size_t *size_r);\n"
15726 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3708
15728 "This command lets you read part of a file. It reads C<count> bytes of "
15729 "C<device>, starting at C<offset>."
15733 #: ../src/guestfs-actions.pod:5626
15734 msgid "See also C<guestfs_pread>."
15738 #: ../src/guestfs-actions.pod:5635
15739 msgid "(Added in 1.5.21)"
15743 #: ../src/guestfs-actions.pod:5637
15744 msgid "guestfs_pvcreate"
15748 #: ../src/guestfs-actions.pod:5639
15752 " guestfs_pvcreate (guestfs_h *g,\n"
15753 " const char *device);\n"
15758 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3723
15760 "This creates an LVM physical volume on the named C<device>, where C<device> "
15761 "should usually be a partition name such as C</dev/sda1>."
15765 #: ../src/guestfs-actions.pod:5651
15766 msgid "guestfs_pvremove"
15770 #: ../src/guestfs-actions.pod:5653
15774 " guestfs_pvremove (guestfs_h *g,\n"
15775 " const char *device);\n"
15780 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3731
15782 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15787 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3734
15789 "The implementation uses the C<pvremove> command which refuses to wipe "
15790 "physical volumes that contain any volume groups, so you have to remove those"
15795 #: ../src/guestfs-actions.pod:5668
15796 msgid "guestfs_pvresize"
15800 #: ../src/guestfs-actions.pod:5670
15804 " guestfs_pvresize (guestfs_h *g,\n"
15805 " const char *device);\n"
15810 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3742
15812 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15813 "the new size of the underlying device."
15817 #: ../src/guestfs-actions.pod:5681
15818 msgid "guestfs_pvresize_size"
15822 #: ../src/guestfs-actions.pod:5683
15826 " guestfs_pvresize_size (guestfs_h *g,\n"
15827 " const char *device,\n"
15828 " int64_t size);\n"
15833 #: ../src/guestfs-actions.pod:5688
15835 "This command is the same as C<guestfs_pvresize> except that it allows you to"
15836 " specify the new size (in bytes) explicitly."
15840 #: ../src/guestfs-actions.pod:5695
15841 msgid "guestfs_pvs"
15845 #: ../src/guestfs-actions.pod:5697
15849 " guestfs_pvs (guestfs_h *g);\n"
15854 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3756
15856 "List all the physical volumes detected. This is the equivalent of the "
15857 "L<pvs(8)> command."
15861 #: ../src/guestfs-actions.pod:5703 ../fish/guestfish-actions.pod:3759
15863 "This returns a list of just the device names that contain PVs (eg. "
15868 #: ../src/guestfs-actions.pod:5706
15869 msgid "See also C<guestfs_pvs_full>."
15873 #: ../src/guestfs-actions.pod:5714
15874 msgid "guestfs_pvs_full"
15878 #: ../src/guestfs-actions.pod:5716
15881 " struct guestfs_lvm_pv_list *\n"
15882 " guestfs_pvs_full (guestfs_h *g);\n"
15887 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3768
15889 "List all the physical volumes detected. This is the equivalent of the "
15890 "L<pvs(8)> command. The \"full\" version includes all fields."
15894 #: ../src/guestfs-actions.pod:5722
15896 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15897 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
15902 #: ../src/guestfs-actions.pod:5728
15903 msgid "guestfs_pvuuid"
15907 #: ../src/guestfs-actions.pod:5730
15911 " guestfs_pvuuid (guestfs_h *g,\n"
15912 " const char *device);\n"
15917 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3775
15918 msgid "This command returns the UUID of the LVM PV C<device>."
15922 #: ../src/guestfs-actions.pod:5741
15923 msgid "guestfs_pwrite"
15927 #: ../src/guestfs-actions.pod:5743
15931 " guestfs_pwrite (guestfs_h *g,\n"
15932 " const char *path,\n"
15933 " const char *content,\n"
15934 " size_t content_size,\n"
15935 " int64_t offset);\n"
15940 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3781
15942 "This command writes to part of a file. It writes the data buffer C<content>"
15943 " to the file C<path> starting at offset C<offset>."
15947 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3784
15949 "This command implements the L<pwrite(2)> system call, and like that system "
15950 "call it may not write the full data requested. The return value is the "
15951 "number of bytes that were actually written to the file. This could even be "
15952 "0, although short writes are unlikely for regular files in ordinary "
15957 #: ../src/guestfs-actions.pod:5759
15958 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15962 #: ../src/guestfs-actions.pod:5768
15963 msgid "guestfs_pwrite_device"
15967 #: ../src/guestfs-actions.pod:5770
15971 " guestfs_pwrite_device (guestfs_h *g,\n"
15972 " const char *device,\n"
15973 " const char *content,\n"
15974 " size_t content_size,\n"
15975 " int64_t offset);\n"
15980 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3799
15982 "This command writes to part of a device. It writes the data buffer "
15983 "C<content> to C<device> starting at offset C<offset>."
15987 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3802
15989 "This command implements the L<pwrite(2)> system call, and like that system "
15990 "call it may not write the full data requested (although short writes to disk"
15991 " devices and partitions are probably impossible with standard Linux "
15996 #: ../src/guestfs-actions.pod:5785
15997 msgid "See also C<guestfs_pwrite>."
16001 #: ../src/guestfs-actions.pod:5792
16002 msgid "(Added in 1.5.20)"
16006 #: ../src/guestfs-actions.pod:5794
16007 msgid "guestfs_read_file"
16011 #: ../src/guestfs-actions.pod:5796
16015 " guestfs_read_file (guestfs_h *g,\n"
16016 " const char *path,\n"
16017 " size_t *size_r);\n"
16022 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3816
16023 msgid "This calls returns the contents of the file C<path> as a buffer."
16027 #: ../src/guestfs-actions.pod:5804
16029 "Unlike C<guestfs_cat>, this function can correctly handle files that contain"
16030 " embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16031 "function is limited in the total size of file that can be handled."
16035 #: ../src/guestfs-actions.pod:5816
16036 msgid "(Added in 1.0.63)"
16040 #: ../src/guestfs-actions.pod:5818
16041 msgid "guestfs_read_lines"
16045 #: ../src/guestfs-actions.pod:5820
16049 " guestfs_read_lines (guestfs_h *g,\n"
16050 " const char *path);\n"
16055 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3833
16057 "The file contents are returned as a list of lines. Trailing C<LF> and "
16058 "C<CRLF> character sequences are I<not> returned."
16062 #: ../src/guestfs-actions.pod:5829
16064 "Note that this function cannot correctly handle binary files (specifically, "
16065 "files containing C<\\0> character which is treated as end of line). For "
16066 "those you need to use the C<guestfs_read_file> function which has a more "
16067 "complex interface."
16071 #: ../src/guestfs-actions.pod:5840
16072 msgid "guestfs_readdir"
16076 #: ../src/guestfs-actions.pod:5842
16079 " struct guestfs_dirent_list *\n"
16080 " guestfs_readdir (guestfs_h *g,\n"
16081 " const char *dir);\n"
16086 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3845
16087 msgid "This returns the list of directory entries in directory C<dir>."
16091 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3847
16093 "All entries in the directory are returned, including C<.> and C<..>. The "
16094 "entries are I<not> sorted, but returned in the same order as the underlying "
16099 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3851
16101 "Also this call returns basic file type information about each file. The "
16102 "C<ftyp> field will contain one of the following characters:"
16106 #: ../src/guestfs-actions.pod:5857 ../fish/guestfish-actions.pod:3856
16111 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3858
16112 msgid "Block special"
16116 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3860
16121 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3862
16122 msgid "Char special"
16126 #: ../src/guestfs-actions.pod:5865 ../fish/guestfish-actions.pod:3864
16131 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3866
16136 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3868
16141 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3870
16142 msgid "FIFO (named pipe)"
16146 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3872
16151 #: ../src/guestfs-actions.pod:5875 ../fish/guestfish-actions.pod:3874
16152 msgid "Symbolic link"
16156 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3876
16161 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3878
16162 msgid "Regular file"
16166 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3880
16171 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3882
16176 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3884
16181 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3886
16182 msgid "Unknown file type"
16186 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3888
16191 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3890
16193 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16197 #: ../src/guestfs-actions.pod:5896
16199 "This function is primarily intended for use by programs. To get a simple "
16200 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16201 "consumption, use C<guestfs_ll>."
16205 #: ../src/guestfs-actions.pod:5900
16207 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16208 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
16213 #: ../src/guestfs-actions.pod:5906
16214 msgid "guestfs_readlink"
16218 #: ../src/guestfs-actions.pod:5908
16222 " guestfs_readlink (guestfs_h *g,\n"
16223 " const char *path);\n"
16228 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3903
16229 msgid "This command reads the target of a symbolic link."
16233 #: ../src/guestfs-actions.pod:5919
16234 msgid "guestfs_readlinklist"
16238 #: ../src/guestfs-actions.pod:5921
16242 " guestfs_readlinklist (guestfs_h *g,\n"
16243 " const char *path,\n"
16244 " char *const *names);\n"
16249 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:3909
16251 "This call allows you to do a C<readlink> operation on multiple files, where "
16252 "all files are in the directory C<path>. C<names> is the list of files from "
16257 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3913
16259 "On return you get a list of strings, with a one-to-one correspondence to the"
16260 " C<names> list. Each string is the value of the symbolic link."
16264 #: ../src/guestfs-actions.pod:5934 ../fish/guestfish-actions.pod:3917
16266 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16267 "result string is the empty string C<\"\">. However the whole operation is "
16268 "completed even if there were C<readlink(2)> errors, and so you can call this"
16269 " function with names where you don't know if they are symbolic links already"
16270 " (albeit slightly less efficient)."
16274 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3924
16276 "This call is intended for programs that want to efficiently list a directory"
16277 " contents without making many round-trips. Very long directory listings "
16278 "might cause the protocol message size to be exceeded, causing this call to "
16279 "fail. The caller must split up such requests into smaller groups of names."
16283 #: ../src/guestfs-actions.pod:5954
16284 msgid "guestfs_realpath"
16288 #: ../src/guestfs-actions.pod:5956
16292 " guestfs_realpath (guestfs_h *g,\n"
16293 " const char *path);\n"
16298 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3935
16300 "Return the canonicalized absolute pathname of C<path>. The returned path "
16301 "has no C<.>, C<..> or symbolic link path elements."
16305 #: ../src/guestfs-actions.pod:5968
16306 msgid "guestfs_removexattr"
16310 #: ../src/guestfs-actions.pod:5970
16314 " guestfs_removexattr (guestfs_h *g,\n"
16315 " const char *xattr,\n"
16316 " const char *path);\n"
16321 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:3942
16323 "This call removes the extended attribute named C<xattr> of the file C<path>."
16327 #: ../src/guestfs-actions.pod:5978
16328 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16332 #: ../src/guestfs-actions.pod:5984
16333 msgid "guestfs_resize2fs"
16337 #: ../src/guestfs-actions.pod:5986
16341 " guestfs_resize2fs (guestfs_h *g,\n"
16342 " const char *device);\n"
16347 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:3951
16349 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16350 "underlying device."
16354 #: ../src/guestfs-actions.pod:5993
16356 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16357 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16358 "sometimes gives an error about this and sometimes not. In any case, it is "
16359 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16363 #: ../src/guestfs-actions.pod:6003
16364 msgid "guestfs_resize2fs_M"
16368 #: ../src/guestfs-actions.pod:6005
16372 " guestfs_resize2fs_M (guestfs_h *g,\n"
16373 " const char *device);\n"
16378 #: ../src/guestfs-actions.pod:6009
16380 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16381 "resized to its minimum size. This works like the I<-M> option to the "
16382 "C<resize2fs> command."
16386 #: ../src/guestfs-actions.pod:6013
16388 "To get the resulting size of the filesystem you should call "
16389 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16390 "These two numbers, multiplied together, give the resulting size of the "
16391 "minimal filesystem in bytes."
16395 #: ../src/guestfs-actions.pod:6022
16396 msgid "guestfs_resize2fs_size"
16400 #: ../src/guestfs-actions.pod:6024
16404 " guestfs_resize2fs_size (guestfs_h *g,\n"
16405 " const char *device,\n"
16406 " int64_t size);\n"
16411 #: ../src/guestfs-actions.pod:6029
16413 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16414 "to specify the new size (in bytes) explicitly."
16418 #: ../src/guestfs-actions.pod:6036
16423 #: ../src/guestfs-actions.pod:6038
16427 " guestfs_rm (guestfs_h *g,\n"
16428 " const char *path);\n"
16433 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:3984
16434 msgid "Remove the single file C<path>."
16438 #: ../src/guestfs-actions.pod:6048
16439 msgid "guestfs_rm_rf"
16443 #: ../src/guestfs-actions.pod:6050
16447 " guestfs_rm_rf (guestfs_h *g,\n"
16448 " const char *path);\n"
16453 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:3990
16455 "Remove the file or directory C<path>, recursively removing the contents if "
16456 "its a directory. This is like the C<rm -rf> shell command."
16460 #: ../src/guestfs-actions.pod:6062
16461 msgid "guestfs_rmdir"
16465 #: ../src/guestfs-actions.pod:6064
16469 " guestfs_rmdir (guestfs_h *g,\n"
16470 " const char *path);\n"
16475 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:3998
16476 msgid "Remove the single directory C<path>."
16480 #: ../src/guestfs-actions.pod:6074
16481 msgid "guestfs_rmmountpoint"
16485 #: ../src/guestfs-actions.pod:6076
16489 " guestfs_rmmountpoint (guestfs_h *g,\n"
16490 " const char *exemptpath);\n"
16495 #: ../src/guestfs-actions.pod:6080
16497 "This calls removes a mountpoint that was previously created with "
16498 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16502 #: ../src/guestfs-actions.pod:6088
16503 msgid "guestfs_scrub_device"
16507 #: ../src/guestfs-actions.pod:6090
16511 " guestfs_scrub_device (guestfs_h *g,\n"
16512 " const char *device);\n"
16517 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4012
16519 "This command writes patterns over C<device> to make data retrieval more "
16524 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6118
16525 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4015
16526 #: ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4043
16528 "It is an interface to the L<scrub(1)> program. See that manual page for "
16533 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6123
16534 #: ../src/guestfs-actions.pod:6142
16535 msgid "(Added in 1.0.52)"
16539 #: ../src/guestfs-actions.pod:6107
16540 msgid "guestfs_scrub_file"
16544 #: ../src/guestfs-actions.pod:6109
16548 " guestfs_scrub_file (guestfs_h *g,\n"
16549 " const char *file);\n"
16554 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4025
16556 "This command writes patterns over a file to make data retrieval more "
16561 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4028
16562 msgid "The file is I<removed> after scrubbing."
16566 #: ../src/guestfs-actions.pod:6125
16567 msgid "guestfs_scrub_freespace"
16571 #: ../src/guestfs-actions.pod:6127
16575 " guestfs_scrub_freespace (guestfs_h *g,\n"
16576 " const char *dir);\n"
16581 #: ../src/guestfs-actions.pod:6131
16583 "This command creates the directory C<dir> and then fills it with files until"
16584 " the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16585 "and deletes them. The intention is to scrub any free space on the partition"
16586 " containing C<dir>."
16590 #: ../src/guestfs-actions.pod:6144
16591 msgid "guestfs_set_append"
16595 #: ../src/guestfs-actions.pod:6146
16599 " guestfs_set_append (guestfs_h *g,\n"
16600 " const char *append);\n"
16605 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4052
16607 "This function is used to add additional options to the guest kernel command "
16612 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4055
16614 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16615 "environment variable."
16619 #: ../src/guestfs-actions.pod:6156 ../fish/guestfish-actions.pod:4058
16621 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16622 "(libguestfs always adds a few of its own)."
16626 #: ../src/guestfs-actions.pod:6163
16627 msgid "guestfs_set_attach_method"
16631 #: ../src/guestfs-actions.pod:6165
16635 " guestfs_set_attach_method (guestfs_h *g,\n"
16636 " const char *attachmethod);\n"
16641 #: ../src/guestfs-actions.pod:6169 ../fish/guestfish-actions.pod:4067
16643 "Set the method that libguestfs uses to connect to the back end guestfsd "
16644 "daemon. Possible methods are:"
16648 #: ../src/guestfs-actions.pod:6176 ../fish/guestfish-actions.pod:4074
16650 "Launch an appliance and connect to it. This is the ordinary method and the "
16655 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4077
16656 msgid "C<unix:I<path>>"
16660 #: ../src/guestfs-actions.pod:6181 ../fish/guestfish-actions.pod:4079
16661 msgid "Connect to the Unix domain socket I<path>."
16665 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4081
16667 "This method lets you connect to an existing daemon or (using virtio-serial) "
16668 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16669 "RUNNING DAEMONS>."
16673 #: ../src/guestfs-actions.pod:6193
16674 msgid "guestfs_set_autosync"
16678 #: ../src/guestfs-actions.pod:6195
16682 " guestfs_set_autosync (guestfs_h *g,\n"
16683 " int autosync);\n"
16688 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4093
16690 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16691 "effort attempt to make filesystems consistent and synchronized when the "
16692 "handle is closed (also if the program exits without closing handles)."
16696 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4098
16698 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16699 "disabled by default)."
16703 #: ../src/guestfs-actions.pod:6211
16704 msgid "guestfs_set_direct"
16708 #: ../src/guestfs-actions.pod:6213
16712 " guestfs_set_direct (guestfs_h *g,\n"
16718 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4107
16720 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16721 "passed directly through to the appliance once it is launched."
16725 #: ../src/guestfs-actions.pod:6221
16727 "One consequence of this is that log messages aren't caught by the library "
16728 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16733 #: ../src/guestfs-actions.pod:6225 ../fish/guestfish-actions.pod:4115
16735 "You probably don't want to use this unless you know what you are doing."
16739 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4118
16740 msgid "The default is disabled."
16744 #: ../src/guestfs-actions.pod:6234
16745 msgid "guestfs_set_e2label"
16749 #: ../src/guestfs-actions.pod:6236
16753 " guestfs_set_e2label (guestfs_h *g,\n"
16754 " const char *device,\n"
16755 " const char *label);\n"
16760 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4124
16762 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16763 "C<label>. Filesystem labels are limited to 16 characters."
16767 #: ../src/guestfs-actions.pod:6245
16769 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16770 "the existing label on a filesystem."
16774 #: ../src/guestfs-actions.pod:6252
16775 msgid "guestfs_set_e2uuid"
16779 #: ../src/guestfs-actions.pod:6254
16783 " guestfs_set_e2uuid (guestfs_h *g,\n"
16784 " const char *device,\n"
16785 " const char *uuid);\n"
16790 #: ../src/guestfs-actions.pod:6259 ../fish/guestfish-actions.pod:4135
16792 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16793 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16794 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16798 #: ../src/guestfs-actions.pod:6264
16800 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16801 "the existing UUID of a filesystem."
16805 #: ../src/guestfs-actions.pod:6271
16806 msgid "guestfs_set_memsize"
16810 #: ../src/guestfs-actions.pod:6273
16814 " guestfs_set_memsize (guestfs_h *g,\n"
16820 #: ../src/guestfs-actions.pod:6277
16822 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16823 "This only has any effect if called before C<guestfs_launch>."
16827 #: ../src/guestfs-actions.pod:6281 ../fish/guestfish-actions.pod:4153
16829 "You can also change this by setting the environment variable "
16830 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16834 #: ../src/guestfs-actions.pod:6292
16835 msgid "guestfs_set_network"
16839 #: ../src/guestfs-actions.pod:6294
16843 " guestfs_set_network (guestfs_h *g,\n"
16849 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4166
16851 "If C<network> is true, then the network is enabled in the libguestfs "
16852 "appliance. The default is false."
16856 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4169
16858 "This affects whether commands are able to access the network (see "
16859 "L<guestfs(3)/RUNNING COMMANDS>)."
16863 #: ../src/guestfs-actions.pod:6304
16865 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16870 #: ../src/guestfs-actions.pod:6311
16871 msgid "guestfs_set_path"
16875 #: ../src/guestfs-actions.pod:6313
16879 " guestfs_set_path (guestfs_h *g,\n"
16880 " const char *searchpath);\n"
16885 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4181
16886 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16890 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4183
16892 "The default is C<$libdir/guestfs> unless overridden by setting "
16893 "C<LIBGUESTFS_PATH> environment variable."
16897 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4186
16898 msgid "Setting C<path> to C<NULL> restores the default path."
16902 #: ../src/guestfs-actions.pod:6328
16903 msgid "guestfs_set_pgroup"
16907 #: ../src/guestfs-actions.pod:6330
16911 " guestfs_set_pgroup (guestfs_h *g,\n"
16917 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4194
16919 "If C<pgroup> is true, child processes are placed into their own process "
16924 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4197
16926 "The practical upshot of this is that signals like C<SIGINT> (from users "
16927 "pressing C<^C>) won't be received by the child process."
16931 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4200
16933 "The default for this flag is false, because usually you want C<^C> to kill "
16938 #: ../src/guestfs-actions.pod:6345
16939 msgid "guestfs_set_qemu"
16943 #: ../src/guestfs-actions.pod:6347
16947 " guestfs_set_qemu (guestfs_h *g,\n"
16948 " const char *qemu);\n"
16953 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4209
16954 msgid "Set the qemu binary that we will use."
16958 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4211
16960 "The default is chosen when the library was compiled by the configure script."
16964 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4214
16966 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16971 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4217
16972 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16976 #: ../src/guestfs-actions.pod:6361 ../fish/guestfish-actions.pod:4219
16978 "Note that you should call this function as early as possible after creating "
16979 "the handle. This is because some pre-launch operations depend on testing "
16980 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16981 "don't retest features, and so you might see inconsistent results. Using the"
16982 " environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16983 "the qemu binary at the same time as the handle is created."
16987 #: ../src/guestfs-actions.pod:6373
16988 msgid "guestfs_set_recovery_proc"
16992 #: ../src/guestfs-actions.pod:6375
16996 " guestfs_set_recovery_proc (guestfs_h *g,\n"
16997 " int recoveryproc);\n"
17002 #: ../src/guestfs-actions.pod:6379
17004 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17005 "not create a recovery process. The purpose of the recovery process is to "
17006 "stop runaway qemu processes in the case where the main program aborts "
17011 #: ../src/guestfs-actions.pod:6384
17013 "This only has any effect if called before C<guestfs_launch>, and the default"
17018 #: ../src/guestfs-actions.pod:6387 ../fish/guestfish-actions.pod:4241
17020 "About the only time when you would want to disable this is if the main "
17021 "process will fork itself into the background (\"daemonize\" itself). In "
17022 "this case the recovery process thinks that the main program has disappeared "
17023 "and so kills qemu, which is not very helpful."
17027 #: ../src/guestfs-actions.pod:6397
17028 msgid "guestfs_set_selinux"
17032 #: ../src/guestfs-actions.pod:6399
17036 " guestfs_set_selinux (guestfs_h *g,\n"
17042 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4253
17044 "This sets the selinux flag that is passed to the appliance at boot time. "
17045 "The default is C<selinux=0> (disabled)."
17049 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4256
17051 "Note that if SELinux is enabled, it is always in Permissive mode "
17052 "(C<enforcing=0>)."
17056 #: ../src/guestfs-actions.pod:6416
17057 msgid "guestfs_set_trace"
17061 #: ../src/guestfs-actions.pod:6418
17065 " guestfs_set_trace (guestfs_h *g,\n"
17071 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4268
17073 "If the command trace flag is set to 1, then libguestfs calls, parameters and"
17074 " return values are traced."
17078 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4271
17080 "If you want to trace C API calls into libguestfs (and other libraries) then "
17081 "possibly a better way is to use the external ltrace(1) command."
17085 #: ../src/guestfs-actions.pod:6429 ../fish/guestfish-actions.pod:4275
17087 "Command traces are disabled unless the environment variable "
17088 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17092 #: ../src/guestfs-actions.pod:6432
17094 "Trace messages are normally sent to C<stderr>, unless you register a "
17095 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17099 #: ../src/guestfs-actions.pod:6440
17100 msgid "guestfs_set_verbose"
17104 #: ../src/guestfs-actions.pod:6442
17108 " guestfs_set_verbose (guestfs_h *g,\n"
17114 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4288
17115 msgid "If C<verbose> is true, this turns on verbose messages."
17119 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4290
17121 "Verbose messages are disabled unless the environment variable "
17122 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17126 #: ../src/guestfs-actions.pod:6451
17128 "Verbose messages are normally sent to C<stderr>, unless you register a "
17129 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17133 #: ../src/guestfs-actions.pod:6459
17134 msgid "guestfs_setcon"
17138 #: ../src/guestfs-actions.pod:6461
17142 " guestfs_setcon (guestfs_h *g,\n"
17143 " const char *context);\n"
17148 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4301
17150 "This sets the SELinux security context of the daemon to the string "
17155 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4304
17156 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17160 #: ../src/guestfs-actions.pod:6474
17161 msgid "guestfs_setxattr"
17165 #: ../src/guestfs-actions.pod:6476
17169 " guestfs_setxattr (guestfs_h *g,\n"
17170 " const char *xattr,\n"
17171 " const char *val,\n"
17173 " const char *path);\n"
17178 #: ../src/guestfs-actions.pod:6483 ../fish/guestfish-actions.pod:4310
17180 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17181 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17185 #: ../src/guestfs-actions.pod:6487
17186 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17190 #: ../src/guestfs-actions.pod:6493
17191 msgid "guestfs_sfdisk"
17195 #: ../src/guestfs-actions.pod:6495
17199 " guestfs_sfdisk (guestfs_h *g,\n"
17200 " const char *device,\n"
17204 " char *const *lines);\n"
17209 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4320
17211 "This is a direct interface to the L<sfdisk(8)> program for creating "
17212 "partitions on block devices."
17216 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4323
17217 msgid "C<device> should be a block device, for example C</dev/sda>."
17221 #: ../src/guestfs-actions.pod:6508 ../fish/guestfish-actions.pod:4325
17223 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17224 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
17225 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17226 "corresponding parameter is omitted. Usually for 'large' disks, you can just"
17227 " pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather,"
17228 " the kernel) cannot work out the right geometry and you will need to tell "
17233 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4333
17235 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information"
17236 " refer to the L<sfdisk(8)> manpage."
17240 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4336
17242 "To create a single partition occupying the whole disk, you would pass "
17243 "C<lines> as a single element list, when the single element being the string "
17248 #: ../src/guestfs-actions.pod:6523
17250 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17254 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6561
17255 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4346
17256 #: ../fish/guestfish-actions.pod:4369 ../fish/guestfish-actions.pod:4391
17258 "This function is deprecated. In new code, use the C<part_add> call instead."
17262 #: ../src/guestfs-actions.pod:6540
17263 msgid "guestfs_sfdiskM"
17267 #: ../src/guestfs-actions.pod:6542
17271 " guestfs_sfdiskM (guestfs_h *g,\n"
17272 " const char *device,\n"
17273 " char *const *lines);\n"
17278 #: ../src/guestfs-actions.pod:6547
17280 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17281 "partition sizes are specified in megabytes only (rounded to the nearest "
17282 "cylinder) and you don't need to specify the cyls, heads and sectors "
17283 "parameters which were rarely if ever used anyway."
17287 #: ../src/guestfs-actions.pod:6553
17289 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17290 "C<guestfs_part_disk>"
17294 #: ../src/guestfs-actions.pod:6570
17295 msgid "guestfs_sfdisk_N"
17299 #: ../src/guestfs-actions.pod:6572
17303 " guestfs_sfdisk_N (guestfs_h *g,\n"
17304 " const char *device,\n"
17309 " const char *line);\n"
17314 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4380
17316 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17317 "(note: C<n> counts from 1)."
17321 #: ../src/guestfs-actions.pod:6584
17323 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17324 "for the cyls/heads/sectors parameters."
17328 #: ../src/guestfs-actions.pod:6587
17329 msgid "See also: C<guestfs_part_add>"
17333 #: ../src/guestfs-actions.pod:6603
17334 msgid "guestfs_sfdisk_disk_geometry"
17338 #: ../src/guestfs-actions.pod:6605
17342 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17343 " const char *device);\n"
17348 #: ../src/guestfs-actions.pod:6609
17350 "This displays the disk geometry of C<device> read from the partition table."
17351 " Especially in the case where the underlying block device has been resized,"
17352 " this can be different from the kernel's idea of the geometry (see "
17353 "C<guestfs_sfdisk_kernel_geometry>)."
17357 #: ../src/guestfs-actions.pod:6614 ../src/guestfs-actions.pod:6630
17358 #: ../fish/guestfish-actions.pod:4407 ../fish/guestfish-actions.pod:4416
17359 msgid "The result is in human-readable format, and not designed to be parsed."
17363 #: ../src/guestfs-actions.pod:6622
17364 msgid "guestfs_sfdisk_kernel_geometry"
17368 #: ../src/guestfs-actions.pod:6624
17372 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17373 " const char *device);\n"
17378 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4414
17379 msgid "This displays the kernel's idea of the geometry of C<device>."
17383 #: ../src/guestfs-actions.pod:6638
17384 msgid "guestfs_sfdisk_l"
17388 #: ../src/guestfs-actions.pod:6640
17392 " guestfs_sfdisk_l (guestfs_h *g,\n"
17393 " const char *device);\n"
17398 #: ../src/guestfs-actions.pod:6644 ../fish/guestfish-actions.pod:4423
17400 "This displays the partition table on C<device>, in the human-readable output"
17401 " of the L<sfdisk(8)> command. It is not intended to be parsed."
17405 #: ../src/guestfs-actions.pod:6648
17406 msgid "See also: C<guestfs_part_list>"
17410 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4429
17412 "This function is deprecated. In new code, use the C<part_list> call "
17417 #: ../src/guestfs-actions.pod:6662
17422 #: ../src/guestfs-actions.pod:6664
17426 " guestfs_sh (guestfs_h *g,\n"
17427 " const char *command);\n"
17432 #: ../src/guestfs-actions.pod:6668 ../fish/guestfish-actions.pod:4440
17434 "This call runs a command from the guest filesystem via the guest's "
17439 #: ../src/guestfs-actions.pod:6671
17440 msgid "This is like C<guestfs_command>, but passes the command to:"
17444 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4445
17447 " /bin/sh -c \"command\"\n"
17452 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:4447
17454 "Depending on the guest's shell, this usually results in wildcards being "
17455 "expanded, shell expressions being interpolated and so on."
17459 #: ../src/guestfs-actions.pod:6679
17460 msgid "All the provisos about C<guestfs_command> apply to this call."
17464 #: ../src/guestfs-actions.pod:6686
17465 msgid "guestfs_sh_lines"
17469 #: ../src/guestfs-actions.pod:6688
17473 " guestfs_sh_lines (guestfs_h *g,\n"
17474 " const char *command);\n"
17479 #: ../src/guestfs-actions.pod:6692
17481 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17486 #: ../src/guestfs-actions.pod:6695
17487 msgid "See also: C<guestfs_command_lines>"
17491 #: ../src/guestfs-actions.pod:6703
17492 msgid "guestfs_sleep"
17496 #: ../src/guestfs-actions.pod:6705
17500 " guestfs_sleep (guestfs_h *g,\n"
17506 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4466
17507 msgid "Sleep for C<secs> seconds."
17511 #: ../src/guestfs-actions.pod:6713
17512 msgid "(Added in 1.0.41)"
17516 #: ../src/guestfs-actions.pod:6715 ../src/guestfs-structs.pod:109
17517 msgid "guestfs_stat"
17521 #: ../src/guestfs-actions.pod:6717
17524 " struct guestfs_stat *\n"
17525 " guestfs_stat (guestfs_h *g,\n"
17526 " const char *path);\n"
17531 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4474
17532 msgid "This is the same as the C<stat(2)> system call."
17536 #: ../src/guestfs-actions.pod:6731 ../src/guestfs-structs.pod:135
17537 msgid "guestfs_statvfs"
17541 #: ../src/guestfs-actions.pod:6733
17544 " struct guestfs_statvfs *\n"
17545 " guestfs_statvfs (guestfs_h *g,\n"
17546 " const char *path);\n"
17551 #: ../src/guestfs-actions.pod:6737 ../fish/guestfish-actions.pod:4480
17553 "Returns file system statistics for any mounted file system. C<path> should "
17554 "be a file or directory in the mounted file system (typically it is the mount"
17555 " point itself, but it doesn't need to be)."
17559 #: ../src/guestfs-actions.pod:6741 ../fish/guestfish-actions.pod:4484
17560 msgid "This is the same as the C<statvfs(2)> system call."
17564 #: ../src/guestfs-actions.pod:6743
17566 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an"
17567 " error. I<The caller must call C<guestfs_free_statvfs> after use>."
17571 #: ../src/guestfs-actions.pod:6749
17572 msgid "guestfs_strings"
17576 #: ../src/guestfs-actions.pod:6751
17580 " guestfs_strings (guestfs_h *g,\n"
17581 " const char *path);\n"
17586 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4490
17588 "This runs the L<strings(1)> command on a file and returns the list of "
17589 "printable strings found."
17593 #: ../src/guestfs-actions.pod:6767
17594 msgid "guestfs_strings_e"
17598 #: ../src/guestfs-actions.pod:6769
17602 " guestfs_strings_e (guestfs_h *g,\n"
17603 " const char *encoding,\n"
17604 " const char *path);\n"
17609 #: ../src/guestfs-actions.pod:6774
17611 "This is like the C<guestfs_strings> command, but allows you to specify the "
17612 "encoding of strings that are looked for in the source file C<path>."
17616 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4504
17617 msgid "Allowed encodings are:"
17621 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4508
17626 #: ../src/guestfs-actions.pod:6784
17628 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17629 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17633 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4513
17638 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4515
17639 msgid "Single 8-bit-byte characters."
17643 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4517
17648 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4519
17650 "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17654 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4522
17655 msgid "l (lower case letter L)"
17659 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4524
17661 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17662 "examining binaries in Windows guests."
17666 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4527
17671 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4529
17672 msgid "32-bit big endian such as UCS-4BE."
17676 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4531
17681 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4533
17682 msgid "32-bit little endian such as UCS-4LE."
17686 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4537
17687 msgid "The returned strings are transcoded to UTF-8."
17691 #: ../src/guestfs-actions.pod:6822
17692 msgid "guestfs_swapoff_device"
17696 #: ../src/guestfs-actions.pod:6824
17700 " guestfs_swapoff_device (guestfs_h *g,\n"
17701 " const char *device);\n"
17706 #: ../src/guestfs-actions.pod:6828
17708 "This command disables the libguestfs appliance swap device or partition "
17709 "named C<device>. See C<guestfs_swapon_device>."
17713 #: ../src/guestfs-actions.pod:6836
17714 msgid "guestfs_swapoff_file"
17718 #: ../src/guestfs-actions.pod:6838
17722 " guestfs_swapoff_file (guestfs_h *g,\n"
17723 " const char *file);\n"
17728 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4554
17729 msgid "This command disables the libguestfs appliance swap on file."
17733 #: ../src/guestfs-actions.pod:6848
17734 msgid "guestfs_swapoff_label"
17738 #: ../src/guestfs-actions.pod:6850
17742 " guestfs_swapoff_label (guestfs_h *g,\n"
17743 " const char *label);\n"
17748 #: ../src/guestfs-actions.pod:6854 ../fish/guestfish-actions.pod:4560
17750 "This command disables the libguestfs appliance swap on labeled swap "
17755 #: ../src/guestfs-actions.pod:6861
17756 msgid "guestfs_swapoff_uuid"
17760 #: ../src/guestfs-actions.pod:6863
17764 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17765 " const char *uuid);\n"
17770 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4567
17772 "This command disables the libguestfs appliance swap partition with the given"
17777 #: ../src/guestfs-actions.pod:6874
17778 msgid "guestfs_swapon_device"
17782 #: ../src/guestfs-actions.pod:6876
17786 " guestfs_swapon_device (guestfs_h *g,\n"
17787 " const char *device);\n"
17792 #: ../src/guestfs-actions.pod:6880
17794 "This command enables the libguestfs appliance to use the swap device or "
17795 "partition named C<device>. The increased memory is made available for all "
17796 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17800 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4579
17802 "Note that you should not swap to existing guest swap partitions unless you "
17803 "know what you are doing. They may contain hibernation information, or other"
17804 " information that the guest doesn't want you to trash. You also risk "
17805 "leaking information about the host to the guest this way. Instead, attach a"
17806 " new host device to the guest and swap on that."
17810 #: ../src/guestfs-actions.pod:6896
17811 msgid "guestfs_swapon_file"
17815 #: ../src/guestfs-actions.pod:6898
17819 " guestfs_swapon_file (guestfs_h *g,\n"
17820 " const char *file);\n"
17825 #: ../src/guestfs-actions.pod:6902
17827 "This command enables swap to a file. See C<guestfs_swapon_device> for other"
17832 #: ../src/guestfs-actions.pod:6909
17833 msgid "guestfs_swapon_label"
17837 #: ../src/guestfs-actions.pod:6911
17841 " guestfs_swapon_label (guestfs_h *g,\n"
17842 " const char *label);\n"
17847 #: ../src/guestfs-actions.pod:6915
17849 "This command enables swap to a labeled swap partition. See "
17850 "C<guestfs_swapon_device> for other notes."
17854 #: ../src/guestfs-actions.pod:6922
17855 msgid "guestfs_swapon_uuid"
17859 #: ../src/guestfs-actions.pod:6924
17863 " guestfs_swapon_uuid (guestfs_h *g,\n"
17864 " const char *uuid);\n"
17869 #: ../src/guestfs-actions.pod:6928
17871 "This command enables swap to a swap partition with the given UUID. See "
17872 "C<guestfs_swapon_device> for other notes."
17876 #: ../src/guestfs-actions.pod:6935
17877 msgid "guestfs_sync"
17881 #: ../src/guestfs-actions.pod:6937
17885 " guestfs_sync (guestfs_h *g);\n"
17890 #: ../src/guestfs-actions.pod:6940 ../fish/guestfish-actions.pod:4611
17892 "This syncs the disk, so that any writes are flushed through to the "
17893 "underlying disk image."
17897 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4614
17899 "You should always call this if you have modified a disk image, before "
17900 "closing the handle."
17904 #: ../src/guestfs-actions.pod:6950
17905 msgid "guestfs_tail"
17909 #: ../src/guestfs-actions.pod:6952
17913 " guestfs_tail (guestfs_h *g,\n"
17914 " const char *path);\n"
17919 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4621
17921 "This command returns up to the last 10 lines of a file as a list of strings."
17925 #: ../src/guestfs-actions.pod:6968
17926 msgid "guestfs_tail_n"
17930 #: ../src/guestfs-actions.pod:6970
17934 " guestfs_tail_n (guestfs_h *g,\n"
17936 " const char *path);\n"
17941 #: ../src/guestfs-actions.pod:6975 ../fish/guestfish-actions.pod:4631
17943 "If the parameter C<nrlines> is a positive number, this returns the last "
17944 "C<nrlines> lines of the file C<path>."
17948 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4634
17950 "If the parameter C<nrlines> is a negative number, this returns lines from "
17951 "the file C<path>, starting with the C<-nrlines>th line."
17955 #: ../src/guestfs-actions.pod:6992
17956 msgid "guestfs_tar_in"
17960 #: ../src/guestfs-actions.pod:6994
17964 " guestfs_tar_in (guestfs_h *g,\n"
17965 " const char *tarfile,\n"
17966 " const char *directory);\n"
17971 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4646
17973 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17974 "tar file) into C<directory>."
17978 #: ../src/guestfs-actions.pod:7002
17980 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17984 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7024
17985 #: ../src/guestfs-actions.pod:7040 ../src/guestfs-actions.pod:7056
17986 msgid "(Added in 1.0.3)"
17990 #: ../src/guestfs-actions.pod:7009
17991 msgid "guestfs_tar_out"
17995 #: ../src/guestfs-actions.pod:7011
17999 " guestfs_tar_out (guestfs_h *g,\n"
18000 " const char *directory,\n"
18001 " const char *tarfile);\n"
18006 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4658
18008 "This command packs the contents of C<directory> and downloads it to local "
18013 #: ../src/guestfs-actions.pod:7019
18015 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18016 "C<guestfs_txz_out>."
18020 #: ../src/guestfs-actions.pod:7026
18021 msgid "guestfs_tgz_in"
18025 #: ../src/guestfs-actions.pod:7028
18029 " guestfs_tgz_in (guestfs_h *g,\n"
18030 " const char *tarball,\n"
18031 " const char *directory);\n"
18036 #: ../src/guestfs-actions.pod:7033 ../fish/guestfish-actions.pod:4670
18038 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed>"
18039 " tar file) into C<directory>."
18043 #: ../src/guestfs-actions.pod:7036
18044 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18048 #: ../src/guestfs-actions.pod:7042
18049 msgid "guestfs_tgz_out"
18053 #: ../src/guestfs-actions.pod:7044
18057 " guestfs_tgz_out (guestfs_h *g,\n"
18058 " const char *directory,\n"
18059 " const char *tarball);\n"
18064 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4681
18066 "This command packs the contents of C<directory> and downloads it to local "
18071 #: ../src/guestfs-actions.pod:7052
18072 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18076 #: ../src/guestfs-actions.pod:7058
18077 msgid "guestfs_touch"
18081 #: ../src/guestfs-actions.pod:7060
18085 " guestfs_touch (guestfs_h *g,\n"
18086 " const char *path);\n"
18091 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4692
18093 "Touch acts like the L<touch(1)> command. It can be used to update the "
18094 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18099 #: ../src/guestfs-actions.pod:7068 ../fish/guestfish-actions.pod:4696
18101 "This command only works on regular files, and will fail on other file types "
18102 "such as directories, symbolic links, block special etc."
18106 #: ../src/guestfs-actions.pod:7075
18107 msgid "guestfs_truncate"
18111 #: ../src/guestfs-actions.pod:7077
18115 " guestfs_truncate (guestfs_h *g,\n"
18116 " const char *path);\n"
18121 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4703
18123 "This command truncates C<path> to a zero-length file. The file must exist "
18128 #: ../src/guestfs-actions.pod:7088
18129 msgid "guestfs_truncate_size"
18133 #: ../src/guestfs-actions.pod:7090
18137 " guestfs_truncate_size (guestfs_h *g,\n"
18138 " const char *path,\n"
18139 " int64_t size);\n"
18144 #: ../src/guestfs-actions.pod:7095 ../fish/guestfish-actions.pod:4710
18146 "This command truncates C<path> to size C<size> bytes. The file must exist "
18151 #: ../src/guestfs-actions.pod:7098
18153 "If the current file size is less than C<size> then the file is extended to "
18154 "the required size with zero bytes. This creates a sparse file (ie. disk "
18155 "blocks are not allocated for the file until you write to it). To create a "
18156 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18160 #: ../src/guestfs-actions.pod:7108
18161 msgid "guestfs_tune2fs_l"
18165 #: ../src/guestfs-actions.pod:7110
18169 " guestfs_tune2fs_l (guestfs_h *g,\n"
18170 " const char *device);\n"
18175 #: ../src/guestfs-actions.pod:7114 ../fish/guestfish-actions.pod:4723
18177 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on"
18182 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4726
18184 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18185 "for more details. The list of fields returned isn't clearly defined, and "
18186 "depends on both the version of C<tune2fs> that libguestfs was built against,"
18187 " and the filesystem itself."
18191 #: ../src/guestfs-actions.pod:7130
18192 msgid "guestfs_txz_in"
18196 #: ../src/guestfs-actions.pod:7132
18200 " guestfs_txz_in (guestfs_h *g,\n"
18201 " const char *tarball,\n"
18202 " const char *directory);\n"
18207 #: ../src/guestfs-actions.pod:7137 ../fish/guestfish-actions.pod:4735
18209 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18210 "tar file) into C<directory>."
18214 #: ../src/guestfs-actions.pod:7144
18215 msgid "guestfs_txz_out"
18219 #: ../src/guestfs-actions.pod:7146
18223 " guestfs_txz_out (guestfs_h *g,\n"
18224 " const char *directory,\n"
18225 " const char *tarball);\n"
18230 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4744
18232 "This command packs the contents of C<directory> and downloads it to local "
18233 "file C<tarball> (as an xz compressed tar archive)."
18237 #: ../src/guestfs-actions.pod:7158
18238 msgid "guestfs_umask"
18242 #: ../src/guestfs-actions.pod:7160
18246 " guestfs_umask (guestfs_h *g,\n"
18252 #: ../src/guestfs-actions.pod:7164 ../fish/guestfish-actions.pod:4753
18254 "This function sets the mask used for creating new files and device nodes to "
18259 #: ../src/guestfs-actions.pod:7167 ../fish/guestfish-actions.pod:4756
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\"."
18267 #: ../src/guestfs-actions.pod:7172 ../fish/guestfish-actions.pod:4761
18269 "The default umask is C<022>. This is important because it means that "
18270 "directories and device nodes will be created with C<0644> or C<0755> mode "
18271 "even if you specify C<0777>."
18275 #: ../src/guestfs-actions.pod:7176
18277 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18278 "C<guestfs_mkdir>."
18282 #: ../src/guestfs-actions.pod:7179 ../fish/guestfish-actions.pod:4768
18283 msgid "This call returns the previous umask."
18287 #: ../src/guestfs-actions.pod:7185
18288 msgid "guestfs_umount"
18292 #: ../src/guestfs-actions.pod:7187
18296 " guestfs_umount (guestfs_h *g,\n"
18297 " const char *pathordevice);\n"
18302 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4776
18304 "This unmounts the given filesystem. The filesystem may be specified either "
18305 "by its mountpoint (path) or the device which contains the filesystem."
18309 #: ../src/guestfs-actions.pod:7199
18310 msgid "guestfs_umount_all"
18314 #: ../src/guestfs-actions.pod:7201
18318 " guestfs_umount_all (guestfs_h *g);\n"
18323 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4786
18324 msgid "This unmounts all mounted filesystems."
18328 #: ../src/guestfs-actions.pod:7206 ../fish/guestfish-actions.pod:4788
18329 msgid "Some internal mounts are not unmounted by this call."
18333 #: ../src/guestfs-actions.pod:7212
18334 msgid "guestfs_upload"
18338 #: ../src/guestfs-actions.pod:7214
18342 " guestfs_upload (guestfs_h *g,\n"
18343 " const char *filename,\n"
18344 " const char *remotefilename);\n"
18349 #: ../src/guestfs-actions.pod:7219 ../src/guestfs-actions.pod:7243
18350 #: ../fish/guestfish-actions.pod:4794 ../fish/guestfish-actions.pod:4807
18351 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18355 #: ../src/guestfs-actions.pod:7224
18356 msgid "See also C<guestfs_download>."
18360 #: ../src/guestfs-actions.pod:7235
18361 msgid "guestfs_upload_offset"
18365 #: ../src/guestfs-actions.pod:7237
18369 " guestfs_upload_offset (guestfs_h *g,\n"
18370 " const char *filename,\n"
18371 " const char *remotefilename,\n"
18372 " int64_t offset);\n"
18377 #: ../src/guestfs-actions.pod:7246 ../fish/guestfish-actions.pod:4810
18379 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18380 "The intention is to overwrite parts of existing files or devices, although "
18381 "if a non-existant file is specified then it is created with a \"hole\" "
18382 "before C<offset>. The size of the data written is implicit in the size of "
18383 "the source C<filename>."
18387 #: ../src/guestfs-actions.pod:7253
18389 "Note that there is no limit on the amount of data that can be uploaded with "
18390 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18391 "full amount unless an error occurs."
18395 #: ../src/guestfs-actions.pod:7258
18396 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18400 #: ../src/guestfs-actions.pod:7269
18401 msgid "guestfs_utimens"
18405 #: ../src/guestfs-actions.pod:7271
18409 " guestfs_utimens (guestfs_h *g,\n"
18410 " const char *path,\n"
18411 " int64_t atsecs,\n"
18412 " int64_t atnsecs,\n"
18413 " int64_t mtsecs,\n"
18414 " int64_t mtnsecs);\n"
18419 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4830
18420 msgid "This command sets the timestamps of a file with nanosecond precision."
18424 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4833
18426 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18431 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4836
18433 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18434 "nanoseconds from the epoch."
18438 #: ../src/guestfs-actions.pod:7288 ../fish/guestfish-actions.pod:4839
18440 "If the C<*nsecs> field contains the special value C<-1> then the "
18441 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18442 "ignored in this case)."
18446 #: ../src/guestfs-actions.pod:7292 ../fish/guestfish-actions.pod:4843
18448 "If the C<*nsecs> field contains the special value C<-2> then the "
18449 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18454 #: ../src/guestfs-actions.pod:7300 ../src/guestfs-structs.pod:175
18455 msgid "guestfs_version"
18459 #: ../src/guestfs-actions.pod:7302
18462 " struct guestfs_version *\n"
18463 " guestfs_version (guestfs_h *g);\n"
18468 #: ../src/guestfs-actions.pod:7305 ../fish/guestfish-actions.pod:4851
18470 "Return the libguestfs version number that the program is linked against."
18474 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4854
18476 "Note that because of dynamic linking this is not necessarily the version of "
18477 "libguestfs that you compiled against. You can compile the program, and then"
18478 " at runtime dynamically link against a completely different C<libguestfs.so>"
18483 #: ../src/guestfs-actions.pod:7313 ../fish/guestfish-actions.pod:4859
18485 "This call was added in version C<1.0.58>. In previous versions of "
18486 "libguestfs there was no way to get the version number. From C code you can "
18487 "use dynamic linker functions to find out if this symbol exists (if it "
18488 "doesn't, then it's an earlier version)."
18492 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4865
18494 "The call returns a structure with four elements. The first three (C<major>,"
18495 " C<minor> and C<release>) are numbers and correspond to the usual version "
18496 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18497 "but may be used for distro-specific information."
18501 #: ../src/guestfs-actions.pod:7325 ../fish/guestfish-actions.pod:4871
18503 "To construct the original version string: C<$major.$minor.$release$extra>"
18507 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4874
18508 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18512 #: ../src/guestfs-actions.pod:7330
18514 "I<Note:> Don't use this call to test for availability of features. In "
18515 "enterprise distributions we backport features from later versions into "
18516 "earlier versions, making this an unreliable way to test for features. Use "
18517 "C<guestfs_available> instead."
18521 #: ../src/guestfs-actions.pod:7336
18523 "This function returns a C<struct guestfs_version *>, or NULL if there was an"
18524 " error. I<The caller must call C<guestfs_free_version> after use>."
18528 #: ../src/guestfs-actions.pod:7340
18529 msgid "(Added in 1.0.58)"
18533 #: ../src/guestfs-actions.pod:7342
18534 msgid "guestfs_vfs_label"
18538 #: ../src/guestfs-actions.pod:7344
18542 " guestfs_vfs_label (guestfs_h *g,\n"
18543 " const char *device);\n"
18548 #: ../src/guestfs-actions.pod:7348 ../fish/guestfish-actions.pod:4886
18549 msgid "This returns the filesystem label of the filesystem on C<device>."
18553 #: ../src/guestfs-actions.pod:7351 ../fish/guestfish-actions.pod:4889
18554 msgid "If the filesystem is unlabeled, this returns the empty string."
18558 #: ../src/guestfs-actions.pod:7353
18559 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18563 #: ../src/guestfs-actions.pod:7358 ../src/guestfs-actions.pod:7395
18564 msgid "(Added in 1.3.18)"
18568 #: ../src/guestfs-actions.pod:7360
18569 msgid "guestfs_vfs_type"
18573 #: ../src/guestfs-actions.pod:7362
18577 " guestfs_vfs_type (guestfs_h *g,\n"
18578 " const char *device);\n"
18583 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4897
18585 "This command gets the filesystem type corresponding to the filesystem on "
18590 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4900
18592 "For most filesystems, the result is the name of the Linux VFS module which "
18593 "would be used to mount this filesystem if you mounted it without specifying "
18594 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18598 #: ../src/guestfs-actions.pod:7379
18599 msgid "guestfs_vfs_uuid"
18603 #: ../src/guestfs-actions.pod:7381
18607 " guestfs_vfs_uuid (guestfs_h *g,\n"
18608 " const char *device);\n"
18613 #: ../src/guestfs-actions.pod:7385 ../fish/guestfish-actions.pod:4909
18614 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18618 #: ../src/guestfs-actions.pod:7388 ../fish/guestfish-actions.pod:4912
18619 msgid "If the filesystem does not have a UUID, this returns the empty string."
18623 #: ../src/guestfs-actions.pod:7390
18624 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18628 #: ../src/guestfs-actions.pod:7397
18629 msgid "guestfs_vg_activate"
18633 #: ../src/guestfs-actions.pod:7399
18637 " guestfs_vg_activate (guestfs_h *g,\n"
18639 " char *const *volgroups);\n"
18644 #: ../src/guestfs-actions.pod:7404 ../fish/guestfish-actions.pod:4920
18646 "This command activates or (if C<activate> is false) deactivates all logical "
18647 "volumes in the listed volume groups C<volgroups>."
18651 #: ../src/guestfs-actions.pod:7407 ../fish/guestfish-actions.pod:4923
18652 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18656 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4925
18658 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18659 "activated or deactivated."
18663 #: ../src/guestfs-actions.pod:7416
18664 msgid "guestfs_vg_activate_all"
18668 #: ../src/guestfs-actions.pod:7418
18672 " guestfs_vg_activate_all (guestfs_h *g,\n"
18673 " int activate);\n"
18678 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4932
18680 "This command activates or (if C<activate> is false) deactivates all logical "
18681 "volumes in all volume groups."
18685 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4935
18686 msgid "This command is the same as running C<vgchange -a y|n>"
18690 #: ../src/guestfs-actions.pod:7431
18691 msgid "guestfs_vgcreate"
18695 #: ../src/guestfs-actions.pod:7433
18699 " guestfs_vgcreate (guestfs_h *g,\n"
18700 " const char *volgroup,\n"
18701 " char *const *physvols);\n"
18706 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4941
18708 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18709 "of physical volumes C<physvols>."
18713 #: ../src/guestfs-actions.pod:7445
18714 msgid "guestfs_vglvuuids"
18718 #: ../src/guestfs-actions.pod:7447
18722 " guestfs_vglvuuids (guestfs_h *g,\n"
18723 " const char *vgname);\n"
18728 #: ../src/guestfs-actions.pod:7451 ../fish/guestfish-actions.pod:4948
18730 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18731 "volumes created in this volume group."
18735 #: ../src/guestfs-actions.pod:7454
18737 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18738 "associate logical volumes and volume groups."
18742 #: ../src/guestfs-actions.pod:7457
18743 msgid "See also C<guestfs_vgpvuuids>."
18747 #: ../src/guestfs-actions.pod:7465
18748 msgid "guestfs_vgpvuuids"
18752 #: ../src/guestfs-actions.pod:7467
18756 " guestfs_vgpvuuids (guestfs_h *g,\n"
18757 " const char *vgname);\n"
18762 #: ../src/guestfs-actions.pod:7471 ../fish/guestfish-actions.pod:4960
18764 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18765 "volumes that this volume group resides on."
18769 #: ../src/guestfs-actions.pod:7474
18771 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18772 "associate physical volumes and volume groups."
18776 #: ../src/guestfs-actions.pod:7477
18777 msgid "See also C<guestfs_vglvuuids>."
18781 #: ../src/guestfs-actions.pod:7485
18782 msgid "guestfs_vgremove"
18786 #: ../src/guestfs-actions.pod:7487
18790 " guestfs_vgremove (guestfs_h *g,\n"
18791 " const char *vgname);\n"
18796 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:4972
18797 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18801 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4974
18803 "This also forcibly removes all logical volumes in the volume group (if any)."
18807 #: ../src/guestfs-actions.pod:7500
18808 msgid "guestfs_vgrename"
18812 #: ../src/guestfs-actions.pod:7502
18816 " guestfs_vgrename (guestfs_h *g,\n"
18817 " const char *volgroup,\n"
18818 " const char *newvolgroup);\n"
18823 #: ../src/guestfs-actions.pod:7507 ../fish/guestfish-actions.pod:4981
18824 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18828 #: ../src/guestfs-actions.pod:7513
18829 msgid "guestfs_vgs"
18833 #: ../src/guestfs-actions.pod:7515
18837 " guestfs_vgs (guestfs_h *g);\n"
18842 #: ../src/guestfs-actions.pod:7518 ../fish/guestfish-actions.pod:4987
18844 "List all the volumes groups detected. This is the equivalent of the "
18845 "L<vgs(8)> command."
18849 #: ../src/guestfs-actions.pod:7521 ../fish/guestfish-actions.pod:4990
18851 "This returns a list of just the volume group names that were detected (eg. "
18856 #: ../src/guestfs-actions.pod:7524
18857 msgid "See also C<guestfs_vgs_full>."
18861 #: ../src/guestfs-actions.pod:7532
18862 msgid "guestfs_vgs_full"
18866 #: ../src/guestfs-actions.pod:7534
18869 " struct guestfs_lvm_vg_list *\n"
18870 " guestfs_vgs_full (guestfs_h *g);\n"
18875 #: ../src/guestfs-actions.pod:7537 ../fish/guestfish-actions.pod:4999
18877 "List all the volumes groups detected. This is the equivalent of the "
18878 "L<vgs(8)> command. The \"full\" version includes all fields."
18882 #: ../src/guestfs-actions.pod:7540
18884 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18885 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
18890 #: ../src/guestfs-actions.pod:7546
18891 msgid "guestfs_vgscan"
18895 #: ../src/guestfs-actions.pod:7548
18899 " guestfs_vgscan (guestfs_h *g);\n"
18904 #: ../src/guestfs-actions.pod:7551 ../fish/guestfish-actions.pod:5006
18906 "This rescans all block devices and rebuilds the list of LVM physical "
18907 "volumes, volume groups and logical volumes."
18911 #: ../src/guestfs-actions.pod:7558
18912 msgid "guestfs_vguuid"
18916 #: ../src/guestfs-actions.pod:7560
18920 " guestfs_vguuid (guestfs_h *g,\n"
18921 " const char *vgname);\n"
18926 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5013
18927 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18931 #: ../src/guestfs-actions.pod:7571
18932 msgid "guestfs_wait_ready"
18936 #: ../src/guestfs-actions.pod:7573
18940 " guestfs_wait_ready (guestfs_h *g);\n"
18945 #: ../src/guestfs-actions.pod:7576
18946 msgid "This function is a no op."
18950 #: ../src/guestfs-actions.pod:7578
18952 "In versions of the API E<lt> 1.0.71 you had to call this function just after"
18953 " calling C<guestfs_launch> to wait for the launch to complete. However this"
18954 " is no longer necessary because C<guestfs_launch> now does the waiting."
18958 #: ../src/guestfs-actions.pod:7583
18960 "If you see any calls to this function in code then you can just remove them,"
18961 " unless you want to retain compatibility with older versions of the API."
18965 #: ../src/guestfs-actions.pod:7589
18967 "This function is deprecated. In new code, use the C<launch> call instead."
18971 #: ../src/guestfs-actions.pod:7598
18972 msgid "guestfs_wc_c"
18976 #: ../src/guestfs-actions.pod:7600
18980 " guestfs_wc_c (guestfs_h *g,\n"
18981 " const char *path);\n"
18986 #: ../src/guestfs-actions.pod:7604 ../fish/guestfish-actions.pod:5019
18988 "This command counts the characters in a file, using the C<wc -c> external "
18993 #: ../src/guestfs-actions.pod:7611
18994 msgid "guestfs_wc_l"
18998 #: ../src/guestfs-actions.pod:7613
19002 " guestfs_wc_l (guestfs_h *g,\n"
19003 " const char *path);\n"
19008 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5026
19010 "This command counts the lines in a file, using the C<wc -l> external "
19015 #: ../src/guestfs-actions.pod:7624
19016 msgid "guestfs_wc_w"
19020 #: ../src/guestfs-actions.pod:7626
19024 " guestfs_wc_w (guestfs_h *g,\n"
19025 " const char *path);\n"
19030 #: ../src/guestfs-actions.pod:7630 ../fish/guestfish-actions.pod:5033
19032 "This command counts the words in a file, using the C<wc -w> external "
19037 #: ../src/guestfs-actions.pod:7637
19038 msgid "guestfs_write"
19042 #: ../src/guestfs-actions.pod:7639
19046 " guestfs_write (guestfs_h *g,\n"
19047 " const char *path,\n"
19048 " const char *content,\n"
19049 " size_t content_size);\n"
19054 #: ../src/guestfs-actions.pod:7645 ../fish/guestfish-actions.pod:5040
19056 "This call creates a file called C<path>. The content of the file is the "
19057 "string C<content> (which can contain any 8 bit data)."
19061 #: ../src/guestfs-actions.pod:7648
19062 msgid "See also C<guestfs_write_append>."
19066 #: ../src/guestfs-actions.pod:7657
19067 msgid "guestfs_write_append"
19071 #: ../src/guestfs-actions.pod:7659
19075 " guestfs_write_append (guestfs_h *g,\n"
19076 " const char *path,\n"
19077 " const char *content,\n"
19078 " size_t content_size);\n"
19083 #: ../src/guestfs-actions.pod:7665 ../fish/guestfish-actions.pod:5052
19085 "This call appends C<content> to the end of file C<path>. If C<path> does "
19086 "not exist, then a new file is created."
19090 #: ../src/guestfs-actions.pod:7668
19091 msgid "See also C<guestfs_write>."
19095 #: ../src/guestfs-actions.pod:7675
19096 msgid "guestfs_write_file"
19100 #: ../src/guestfs-actions.pod:7677
19104 " guestfs_write_file (guestfs_h *g,\n"
19105 " const char *path,\n"
19106 " const char *content,\n"
19112 #: ../src/guestfs-actions.pod:7683 ../fish/guestfish-actions.pod:5064
19114 "This call creates a file called C<path>. The contents of the file is the "
19115 "string C<content> (which can contain any 8 bit data), with length C<size>."
19119 #: ../src/guestfs-actions.pod:7687 ../fish/guestfish-actions.pod:5068
19121 "As a special case, if C<size> is C<0> then the length is calculated using "
19122 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19126 #: ../src/guestfs-actions.pod:7691 ../fish/guestfish-actions.pod:5072
19128 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19129 "I<not> work, even if the length is specified."
19133 #: ../src/guestfs-actions.pod:7699 ../fish/guestfish-actions.pod:5078
19135 "This function is deprecated. In new code, use the C<write> call instead."
19139 #: ../src/guestfs-actions.pod:7708
19140 msgid "guestfs_zegrep"
19144 #: ../src/guestfs-actions.pod:7710
19148 " guestfs_zegrep (guestfs_h *g,\n"
19149 " const char *regex,\n"
19150 " const char *path);\n"
19155 #: ../src/guestfs-actions.pod:7715 ../fish/guestfish-actions.pod:5089
19157 "This calls the external C<zegrep> program and returns the matching lines."
19161 #: ../src/guestfs-actions.pod:7727
19162 msgid "guestfs_zegrepi"
19166 #: ../src/guestfs-actions.pod:7729
19170 " guestfs_zegrepi (guestfs_h *g,\n"
19171 " const char *regex,\n"
19172 " const char *path);\n"
19177 #: ../src/guestfs-actions.pod:7734 ../fish/guestfish-actions.pod:5099
19179 "This calls the external C<zegrep -i> program and returns the matching lines."
19183 #: ../src/guestfs-actions.pod:7746
19184 msgid "guestfs_zero"
19188 #: ../src/guestfs-actions.pod:7748
19192 " guestfs_zero (guestfs_h *g,\n"
19193 " const char *device);\n"
19198 #: ../src/guestfs-actions.pod:7752 ../fish/guestfish-actions.pod:5109
19199 msgid "This command writes zeroes over the first few blocks of C<device>."
19203 #: ../src/guestfs-actions.pod:7754 ../fish/guestfish-actions.pod:5111
19205 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19206 "securely wipe the device). It should be sufficient to remove any partition "
19207 "tables, filesystem superblocks and so on."
19211 #: ../src/guestfs-actions.pod:7758
19213 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
19214 "C<guestfs_is_zero_device>"
19218 #: ../src/guestfs-actions.pod:7770
19219 msgid "guestfs_zero_device"
19223 #: ../src/guestfs-actions.pod:7772
19227 " guestfs_zero_device (guestfs_h *g,\n"
19228 " const char *device);\n"
19233 #: ../src/guestfs-actions.pod:7776
19235 "This command writes zeroes over the entire C<device>. Compare with "
19236 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19240 #: ../src/guestfs-actions.pod:7790
19241 msgid "(Added in 1.3.1)"
19245 #: ../src/guestfs-actions.pod:7792
19246 msgid "guestfs_zerofree"
19250 #: ../src/guestfs-actions.pod:7794
19254 " guestfs_zerofree (guestfs_h *g,\n"
19255 " const char *device);\n"
19260 #: ../src/guestfs-actions.pod:7798 ../fish/guestfish-actions.pod:5133
19262 "This runs the I<zerofree> program on C<device>. This program claims to zero"
19263 " unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19264 "possible to compress the filesystem more effectively."
19268 #: ../src/guestfs-actions.pod:7803 ../fish/guestfish-actions.pod:5138
19269 msgid "You should B<not> run this program if the filesystem is mounted."
19273 #: ../src/guestfs-actions.pod:7806 ../fish/guestfish-actions.pod:5141
19275 "It is possible that using this program can damage the filesystem or data on "
19280 #: ../src/guestfs-actions.pod:7813
19281 msgid "guestfs_zfgrep"
19285 #: ../src/guestfs-actions.pod:7815
19289 " guestfs_zfgrep (guestfs_h *g,\n"
19290 " const char *pattern,\n"
19291 " const char *path);\n"
19296 #: ../src/guestfs-actions.pod:7820 ../fish/guestfish-actions.pod:5148
19298 "This calls the external C<zfgrep> program and returns the matching lines."
19302 #: ../src/guestfs-actions.pod:7832
19303 msgid "guestfs_zfgrepi"
19307 #: ../src/guestfs-actions.pod:7834
19311 " guestfs_zfgrepi (guestfs_h *g,\n"
19312 " const char *pattern,\n"
19313 " const char *path);\n"
19318 #: ../src/guestfs-actions.pod:7839 ../fish/guestfish-actions.pod:5158
19320 "This calls the external C<zfgrep -i> program and returns the matching lines."
19324 #: ../src/guestfs-actions.pod:7851
19325 msgid "guestfs_zfile"
19329 #: ../src/guestfs-actions.pod:7853
19333 " guestfs_zfile (guestfs_h *g,\n"
19334 " const char *meth,\n"
19335 " const char *path);\n"
19340 #: ../src/guestfs-actions.pod:7858 ../fish/guestfish-actions.pod:5168
19342 "This command runs C<file> after first decompressing C<path> using C<method>."
19346 #: ../src/guestfs-actions.pod:7861 ../fish/guestfish-actions.pod:5171
19347 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19351 #: ../src/guestfs-actions.pod:7863
19353 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19358 #: ../src/guestfs-actions.pod:7869 ../fish/guestfish-actions.pod:5176
19360 "This function is deprecated. In new code, use the C<file> call instead."
19364 #: ../src/guestfs-actions.pod:7878
19365 msgid "guestfs_zgrep"
19369 #: ../src/guestfs-actions.pod:7880
19373 " guestfs_zgrep (guestfs_h *g,\n"
19374 " const char *regex,\n"
19375 " const char *path);\n"
19380 #: ../src/guestfs-actions.pod:7885 ../fish/guestfish-actions.pod:5187
19382 "This calls the external C<zgrep> program and returns the matching lines."
19386 #: ../src/guestfs-actions.pod:7897
19387 msgid "guestfs_zgrepi"
19391 #: ../src/guestfs-actions.pod:7899
19395 " guestfs_zgrepi (guestfs_h *g,\n"
19396 " const char *regex,\n"
19397 " const char *path);\n"
19402 #: ../src/guestfs-actions.pod:7904 ../fish/guestfish-actions.pod:5197
19404 "This calls the external C<zgrep -i> program and returns the matching lines."
19408 #: ../src/guestfs-availability.pod:3
19413 #: ../src/guestfs-availability.pod:5
19415 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
19416 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
19417 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
19418 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
19419 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
19423 #: ../src/guestfs-availability.pod:21
19428 #: ../src/guestfs-availability.pod:23
19429 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
19433 #: ../src/guestfs-availability.pod:26
19438 #: ../src/guestfs-availability.pod:28
19440 "The following functions: L</guestfs_inotify_add_watch> "
19441 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init>"
19442 " L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19446 #: ../src/guestfs-availability.pod:36
19447 msgid "B<linuxfsuuid>"
19451 #: ../src/guestfs-availability.pod:38
19453 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
19454 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19458 #: ../src/guestfs-availability.pod:45
19459 msgid "B<linuxmodules>"
19463 #: ../src/guestfs-availability.pod:47
19464 msgid "The following functions: L</guestfs_modprobe>"
19468 #: ../src/guestfs-availability.pod:50
19469 msgid "B<linuxxattrs>"
19473 #: ../src/guestfs-availability.pod:52
19475 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
19476 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
19477 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
19478 "L</guestfs_setxattr>"
19482 #: ../src/guestfs-availability.pod:63
19487 #: ../src/guestfs-availability.pod:65
19489 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
19490 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
19491 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19495 #: ../src/guestfs-availability.pod:74
19500 #: ../src/guestfs-availability.pod:76
19502 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
19503 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
19504 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
19505 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
19506 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
19507 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
19508 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
19509 "L</guestfs_vgs_full>"
19513 #: ../src/guestfs-availability.pod:99
19518 #: ../src/guestfs-availability.pod:101
19520 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
19521 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
19525 #: ../src/guestfs-availability.pod:107
19530 #: ../src/guestfs-availability.pod:109
19531 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19535 #: ../src/guestfs-availability.pod:112
19536 msgid "B<ntfsprogs>"
19540 #: ../src/guestfs-availability.pod:114
19542 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
19543 "L</guestfs_ntfsresize_size>"
19547 #: ../src/guestfs-availability.pod:119
19548 msgid "B<realpath>"
19552 #: ../src/guestfs-availability.pod:121
19553 msgid "The following functions: L</guestfs_realpath>"
19557 #: ../src/guestfs-availability.pod:124
19562 #: ../src/guestfs-availability.pod:126
19564 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
19565 "L</guestfs_scrub_freespace>"
19569 #: ../src/guestfs-availability.pod:131
19574 #: ../src/guestfs-availability.pod:133
19575 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19579 #: ../src/guestfs-availability.pod:137
19584 #: ../src/guestfs-availability.pod:139
19585 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19589 #: ../src/guestfs-availability.pod:143
19590 msgid "B<zerofree>"
19594 #: ../src/guestfs-availability.pod:145
19595 msgid "The following functions: L</guestfs_zerofree>"
19599 #: ../src/guestfs-structs.pod:1
19600 msgid "guestfs_int_bool"
19604 #: ../src/guestfs-structs.pod:3
19607 " struct guestfs_int_bool {\n"
19615 #: ../src/guestfs-structs.pod:8
19618 " struct guestfs_int_bool_list {\n"
19619 " uint32_t len; /* Number of elements in list. */\n"
19620 " struct guestfs_int_bool *val; /* Elements. */\n"
19626 #: ../src/guestfs-structs.pod:13
19629 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19630 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19635 #: ../src/guestfs-structs.pod:16
19636 msgid "guestfs_lvm_pv"
19640 #: ../src/guestfs-structs.pod:18
19643 " struct guestfs_lvm_pv {\n"
19644 " char *pv_name;\n"
19645 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19646 " char pv_uuid[32];\n"
19648 " uint64_t pv_size;\n"
19649 " uint64_t dev_size;\n"
19650 " uint64_t pv_free;\n"
19651 " uint64_t pv_used;\n"
19652 " char *pv_attr;\n"
19653 " int64_t pv_pe_count;\n"
19654 " int64_t pv_pe_alloc_count;\n"
19655 " char *pv_tags;\n"
19656 " uint64_t pe_start;\n"
19657 " int64_t pv_mda_count;\n"
19658 " uint64_t pv_mda_free;\n"
19664 #: ../src/guestfs-structs.pod:36
19667 " struct guestfs_lvm_pv_list {\n"
19668 " uint32_t len; /* Number of elements in list. */\n"
19669 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19675 #: ../src/guestfs-structs.pod:41
19678 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19679 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19684 #: ../src/guestfs-structs.pod:44
19685 msgid "guestfs_lvm_vg"
19689 #: ../src/guestfs-structs.pod:46
19692 " struct guestfs_lvm_vg {\n"
19693 " char *vg_name;\n"
19694 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19695 " char vg_uuid[32];\n"
19697 " char *vg_attr;\n"
19698 " uint64_t vg_size;\n"
19699 " uint64_t vg_free;\n"
19700 " char *vg_sysid;\n"
19701 " uint64_t vg_extent_size;\n"
19702 " int64_t vg_extent_count;\n"
19703 " int64_t vg_free_count;\n"
19704 " int64_t max_lv;\n"
19705 " int64_t max_pv;\n"
19706 " int64_t pv_count;\n"
19707 " int64_t lv_count;\n"
19708 " int64_t snap_count;\n"
19709 " int64_t vg_seqno;\n"
19710 " char *vg_tags;\n"
19711 " int64_t vg_mda_count;\n"
19712 " uint64_t vg_mda_free;\n"
19718 #: ../src/guestfs-structs.pod:69
19721 " struct guestfs_lvm_vg_list {\n"
19722 " uint32_t len; /* Number of elements in list. */\n"
19723 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19729 #: ../src/guestfs-structs.pod:74
19732 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19733 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19738 #: ../src/guestfs-structs.pod:77
19739 msgid "guestfs_lvm_lv"
19743 #: ../src/guestfs-structs.pod:79
19746 " struct guestfs_lvm_lv {\n"
19747 " char *lv_name;\n"
19748 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19749 " char lv_uuid[32];\n"
19750 " char *lv_attr;\n"
19751 " int64_t lv_major;\n"
19752 " int64_t lv_minor;\n"
19753 " int64_t lv_kernel_major;\n"
19754 " int64_t lv_kernel_minor;\n"
19755 " uint64_t lv_size;\n"
19756 " int64_t seg_count;\n"
19758 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19759 " float snap_percent;\n"
19760 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19761 " float copy_percent;\n"
19762 " char *move_pv;\n"
19763 " char *lv_tags;\n"
19764 " char *mirror_log;\n"
19765 " char *modules;\n"
19771 #: ../src/guestfs-structs.pod:101
19774 " struct guestfs_lvm_lv_list {\n"
19775 " uint32_t len; /* Number of elements in list. */\n"
19776 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19782 #: ../src/guestfs-structs.pod:106
19785 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19786 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19791 #: ../src/guestfs-structs.pod:111
19794 " struct guestfs_stat {\n"
19798 " int64_t nlink;\n"
19803 " int64_t blksize;\n"
19804 " int64_t blocks;\n"
19805 " int64_t atime;\n"
19806 " int64_t mtime;\n"
19807 " int64_t ctime;\n"
19813 #: ../src/guestfs-structs.pod:127
19816 " struct guestfs_stat_list {\n"
19817 " uint32_t len; /* Number of elements in list. */\n"
19818 " struct guestfs_stat *val; /* Elements. */\n"
19824 #: ../src/guestfs-structs.pod:132
19827 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19828 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19833 #: ../src/guestfs-structs.pod:137
19836 " struct guestfs_statvfs {\n"
19837 " int64_t bsize;\n"
19838 " int64_t frsize;\n"
19839 " int64_t blocks;\n"
19840 " int64_t bfree;\n"
19841 " int64_t bavail;\n"
19842 " int64_t files;\n"
19843 " int64_t ffree;\n"
19844 " int64_t favail;\n"
19847 " int64_t namemax;\n"
19853 #: ../src/guestfs-structs.pod:151
19856 " struct guestfs_statvfs_list {\n"
19857 " uint32_t len; /* Number of elements in list. */\n"
19858 " struct guestfs_statvfs *val; /* Elements. */\n"
19864 #: ../src/guestfs-structs.pod:156
19867 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19868 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19873 #: ../src/guestfs-structs.pod:159
19874 msgid "guestfs_dirent"
19878 #: ../src/guestfs-structs.pod:161
19881 " struct guestfs_dirent {\n"
19890 #: ../src/guestfs-structs.pod:167
19893 " struct guestfs_dirent_list {\n"
19894 " uint32_t len; /* Number of elements in list. */\n"
19895 " struct guestfs_dirent *val; /* Elements. */\n"
19901 #: ../src/guestfs-structs.pod:172
19904 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19905 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19910 #: ../src/guestfs-structs.pod:177
19913 " struct guestfs_version {\n"
19914 " int64_t major;\n"
19915 " int64_t minor;\n"
19916 " int64_t release;\n"
19923 #: ../src/guestfs-structs.pod:184
19926 " struct guestfs_version_list {\n"
19927 " uint32_t len; /* Number of elements in list. */\n"
19928 " struct guestfs_version *val; /* Elements. */\n"
19934 #: ../src/guestfs-structs.pod:189
19937 " void guestfs_free_version (struct guestfs_free_version *);\n"
19938 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19943 #: ../src/guestfs-structs.pod:192
19944 msgid "guestfs_xattr"
19948 #: ../src/guestfs-structs.pod:194
19951 " struct guestfs_xattr {\n"
19952 " char *attrname;\n"
19953 " /* The next two fields describe a byte array. */\n"
19954 " uint32_t attrval_len;\n"
19955 " char *attrval;\n"
19961 #: ../src/guestfs-structs.pod:201
19964 " struct guestfs_xattr_list {\n"
19965 " uint32_t len; /* Number of elements in list. */\n"
19966 " struct guestfs_xattr *val; /* Elements. */\n"
19972 #: ../src/guestfs-structs.pod:206
19975 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19976 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19981 #: ../src/guestfs-structs.pod:209
19982 msgid "guestfs_inotify_event"
19986 #: ../src/guestfs-structs.pod:211
19989 " struct guestfs_inotify_event {\n"
19990 " int64_t in_wd;\n"
19991 " uint32_t in_mask;\n"
19992 " uint32_t in_cookie;\n"
19993 " char *in_name;\n"
19999 #: ../src/guestfs-structs.pod:218
20002 " struct guestfs_inotify_event_list {\n"
20003 " uint32_t len; /* Number of elements in list. */\n"
20004 " struct guestfs_inotify_event *val; /* Elements. */\n"
20010 #: ../src/guestfs-structs.pod:223
20013 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20014 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20019 #: ../src/guestfs-structs.pod:226
20020 msgid "guestfs_partition"
20024 #: ../src/guestfs-structs.pod:228
20027 " struct guestfs_partition {\n"
20028 " int32_t part_num;\n"
20029 " uint64_t part_start;\n"
20030 " uint64_t part_end;\n"
20031 " uint64_t part_size;\n"
20037 #: ../src/guestfs-structs.pod:235
20040 " struct guestfs_partition_list {\n"
20041 " uint32_t len; /* Number of elements in list. */\n"
20042 " struct guestfs_partition *val; /* Elements. */\n"
20048 #: ../src/guestfs-structs.pod:240
20051 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20052 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20057 #: ../src/guestfs-structs.pod:243
20058 msgid "guestfs_application"
20062 #: ../src/guestfs-structs.pod:245
20065 " struct guestfs_application {\n"
20066 " char *app_name;\n"
20067 " char *app_display_name;\n"
20068 " int32_t app_epoch;\n"
20069 " char *app_version;\n"
20070 " char *app_release;\n"
20071 " char *app_install_path;\n"
20072 " char *app_trans_path;\n"
20073 " char *app_publisher;\n"
20074 " char *app_url;\n"
20075 " char *app_source_package;\n"
20076 " char *app_summary;\n"
20077 " char *app_description;\n"
20083 #: ../src/guestfs-structs.pod:260
20086 " struct guestfs_application_list {\n"
20087 " uint32_t len; /* Number of elements in list. */\n"
20088 " struct guestfs_application *val; /* Elements. */\n"
20094 #: ../src/guestfs-structs.pod:265
20097 " void guestfs_free_application (struct guestfs_free_application *);\n"
20098 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20103 #: ../fish/guestfish.pod:5
20104 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20108 #: ../fish/guestfish.pod:9
20111 " guestfish [--options] [commands]\n"
20116 #: ../fish/guestfish.pod:11
20124 #: ../fish/guestfish.pod:13
20127 " guestfish [--ro|--rw] -a disk.img\n"
20132 #: ../fish/guestfish.pod:15
20135 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20140 #: ../fish/guestfish.pod:17
20143 " guestfish -d libvirt-domain\n"
20148 #: ../fish/guestfish.pod:19
20151 " guestfish [--ro|--rw] -a disk.img -i\n"
20156 #: ../fish/guestfish.pod:21
20159 " guestfish -d libvirt-domain -i\n"
20164 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
20165 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
20170 #: ../fish/guestfish.pod:25
20172 "Using guestfish in read/write mode on live virtual machines can be "
20173 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only)"
20174 " option to use guestfish safely if the disk image or virtual machine might "
20179 #: ../fish/guestfish.pod:32
20181 "Guestfish is a shell and command-line tool for examining and modifying "
20182 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20183 "functionality of the guestfs API, see L<guestfs(3)>."
20187 #: ../fish/guestfish.pod:36
20189 "Guestfish gives you structured access to the libguestfs API, from shell "
20190 "scripts or the command line or interactively. If you want to rescue a "
20191 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20196 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:1007
20197 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
20202 #: ../fish/guestfish.pod:43
20203 msgid "As an interactive shell"
20207 #: ../fish/guestfish.pod:45
20215 #: ../fish/guestfish.pod:47
20218 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20219 " editing virtual machine filesystems.\n"
20224 #: ../fish/guestfish.pod:50
20227 " Type: 'help' for a list of commands\n"
20228 " 'man' to read the manual\n"
20229 " 'quit' to quit the shell\n"
20234 #: ../fish/guestfish.pod:54
20237 " ><fs> add-ro disk.img\n"
20239 " ><fs> list-filesystems\n"
20240 " /dev/sda1: ext4\n"
20241 " /dev/vg_guest/lv_root: ext4\n"
20242 " /dev/vg_guest/lv_swap: swap\n"
20243 " ><fs> mount /dev/vg_guest/lv_root /\n"
20244 " ><fs> cat /etc/fstab\n"
20246 " # Created by anaconda\n"
20253 #: ../fish/guestfish.pod:67
20254 msgid "From shell scripts"
20258 #: ../fish/guestfish.pod:69
20259 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20263 #: ../fish/guestfish.pod:71
20266 " guestfish <<_EOF_\n"
20269 " mount /dev/vg_guest/lv_root /\n"
20270 " write /etc/motd \"Welcome, new users\"\n"
20276 #: ../fish/guestfish.pod:78
20277 msgid "List the LVM logical volumes in a disk image:"
20281 #: ../fish/guestfish.pod:80
20284 " guestfish -a disk.img --ro <<_EOF_\n"
20292 #: ../fish/guestfish.pod:85
20293 msgid "List all the filesystems in a disk image:"
20297 #: ../fish/guestfish.pod:87
20300 " guestfish -a disk.img --ro <<_EOF_\n"
20302 " list-filesystems\n"
20308 #: ../fish/guestfish.pod:92
20309 msgid "On one command line"
20313 #: ../fish/guestfish.pod:94
20314 msgid "Update C</etc/resolv.conf> in a guest:"
20318 #: ../fish/guestfish.pod:96
20322 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20323 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20328 #: ../fish/guestfish.pod:100
20329 msgid "Edit C</boot/grub/grub.conf> interactively:"
20333 #: ../fish/guestfish.pod:102
20336 " guestfish --rw --add disk.img \\\n"
20337 " --mount /dev/vg_guest/lv_root \\\n"
20338 " --mount /dev/sda1:/boot \\\n"
20339 " edit /boot/grub/grub.conf\n"
20344 #: ../fish/guestfish.pod:107
20345 msgid "Mount disks automatically"
20349 #: ../fish/guestfish.pod:109
20351 "Use the I<-i> option to automatically mount the disks from a virtual "
20356 #: ../fish/guestfish.pod:112
20359 " guestfish --ro -a disk.img -i cat /etc/group\n"
20364 #: ../fish/guestfish.pod:114
20367 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20372 #: ../fish/guestfish.pod:116
20373 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20377 #: ../fish/guestfish.pod:118
20380 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20385 #: ../fish/guestfish.pod:120
20386 msgid "As a script interpreter"
20390 #: ../fish/guestfish.pod:122
20391 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20395 #: ../fish/guestfish.pod:124
20398 " #!/usr/bin/guestfish -f\n"
20399 " sparse test1.img 100M\n"
20401 " part-disk /dev/sda mbr\n"
20402 " mkfs ext2 /dev/sda1\n"
20407 #: ../fish/guestfish.pod:130
20408 msgid "Start with a prepared disk"
20412 #: ../fish/guestfish.pod:132
20414 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20415 "single ext2-formatted partition:"
20419 #: ../fish/guestfish.pod:135
20422 " guestfish -N fs\n"
20427 #: ../fish/guestfish.pod:137
20428 msgid "To list what is available do:"
20432 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
20435 " guestfish -N help | less\n"
20440 #: ../fish/guestfish.pod:141
20441 msgid "Remote control"
20445 #: ../fish/guestfish.pod:143
20448 " eval \"`guestfish --listen`\"\n"
20449 " guestfish --remote add-ro disk.img\n"
20450 " guestfish --remote run\n"
20451 " guestfish --remote lvs\n"
20456 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20457 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
20458 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
20459 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20464 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
20465 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
20466 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
20467 #: ../tools/virt-list-partitions.pl:62
20472 #: ../fish/guestfish.pod:154
20473 msgid "Displays general help on options."
20477 #: ../fish/guestfish.pod:156
20482 #: ../fish/guestfish.pod:158
20483 msgid "B<--cmd-help>"
20487 #: ../fish/guestfish.pod:160
20488 msgid "Lists all available guestfish commands."
20492 #: ../fish/guestfish.pod:162
20497 #: ../fish/guestfish.pod:164
20498 msgid "B<--cmd-help cmd>"
20502 #: ../fish/guestfish.pod:166
20503 msgid "Displays detailed help on a single command C<cmd>."
20507 #: ../fish/guestfish.pod:168
20508 msgid "B<-a image>"
20512 #: ../fish/guestfish.pod:170
20513 msgid "B<--add image>"
20517 #: ../fish/guestfish.pod:172
20518 msgid "Add a block device or virtual machine image to the shell."
20522 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20524 "The format of the disk image is auto-detected. To override this and force a"
20525 " particular format use the I<--format=..> option."
20529 #: ../fish/guestfish.pod:177
20531 "Using this flag is mostly equivalent to using the C<add> command, with "
20532 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20533 "the I<--format=...> flag was given."
20537 #: ../fish/guestfish.pod:181
20542 #: ../fish/guestfish.pod:183
20543 msgid "B<--connect URI>"
20547 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20549 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20550 "URI to use. The default is to use the default libvirt connection."
20554 #: ../fish/guestfish.pod:189
20559 #: ../fish/guestfish.pod:191
20561 "If using the I<--listen> option and a csh-like shell, use this option. See "
20562 "section L</REMOTE CONTROL AND CSH> below."
20566 #: ../fish/guestfish.pod:194
20567 msgid "B<-d libvirt-domain>"
20571 #: ../fish/guestfish.pod:196
20572 msgid "B<--domain libvirt-domain>"
20576 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20578 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20579 "used, then any libvirt domain can be used. However in write mode, only "
20580 "libvirt domains which are shut down can be named here."
20584 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20585 msgid "Domain UUIDs can be used instead of names."
20589 #: ../fish/guestfish.pod:204
20591 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20592 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20593 "if the I<--format:...> flag was given."
20597 #: ../fish/guestfish.pod:208
20602 #: ../fish/guestfish.pod:210
20603 msgid "B<--no-dest-paths>"
20607 #: ../fish/guestfish.pod:212
20609 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20610 "to hit the tab key to complete paths on the guest filesystem, but this "
20611 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20612 "allow this feature to be disabled."
20616 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20617 msgid "B<--echo-keys>"
20621 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20623 "When prompting for keys and passphrases, guestfish normally turns echoing "
20624 "off so you cannot see what you are typing. If you are not worried about "
20625 "Tempest attacks and there is no one else in the room you can specify this "
20626 "flag to see what you are typing."
20630 #: ../fish/guestfish.pod:224
20635 #: ../fish/guestfish.pod:226
20636 msgid "B<--file file>"
20640 #: ../fish/guestfish.pod:228
20641 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20645 #: ../fish/guestfish.pod:231
20648 " #!/usr/bin/guestfish -f\n"
20653 #: ../fish/guestfish.pod:233
20654 msgid "B<--format=raw|qcow2|..>"
20658 #: ../fish/guestfish.pod:235
20659 msgid "B<--format>"
20663 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20665 "The default for the I<-a> option is to auto-detect the format of the disk "
20666 "image. Using this forces the disk format for I<-a> options which follow on "
20667 "the command line. Using I<--format> with no argument switches back to auto-"
20668 "detection for subsequent I<-a> options."
20672 #: ../fish/guestfish.pod:244
20675 " guestfish --format=raw -a disk.img\n"
20680 #: ../fish/guestfish.pod:246
20681 msgid "forces raw format (no auto-detection) for C<disk.img>."
20685 #: ../fish/guestfish.pod:248
20688 " guestfish --format=raw -a disk.img --format -a another.img\n"
20693 #: ../fish/guestfish.pod:250
20695 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20696 "detection for C<another.img>."
20700 #: ../fish/guestfish.pod:253
20702 "If you have untrusted raw-format guest disk images, you should use this "
20703 "option to specify the disk format. This avoids a possible security problem "
20704 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20708 #: ../fish/guestfish.pod:258
20713 #: ../fish/guestfish.pod:260
20714 msgid "B<--inspector>"
20718 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20720 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20721 "system and mount filesystems as they would be mounted on the real virtual "
20726 #: ../fish/guestfish.pod:266
20727 msgid "Typical usage is either:"
20731 #: ../fish/guestfish.pod:268
20734 " guestfish -d myguest -i\n"
20739 #: ../fish/guestfish.pod:270
20740 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20744 #: ../fish/guestfish.pod:272
20747 " guestfish --ro -d myguest -i\n"
20752 #: ../fish/guestfish.pod:274
20753 msgid "(for active domains, readonly), or specify the block device directly:"
20757 #: ../fish/guestfish.pod:276
20760 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20765 #: ../fish/guestfish.pod:278
20767 "Note that the command line syntax changed slightly over older versions of "
20768 "guestfish. You can still use the old syntax:"
20772 #: ../fish/guestfish.pod:281
20775 " guestfish [--ro] -i disk.img\n"
20780 #: ../fish/guestfish.pod:283
20783 " guestfish [--ro] -i libvirt-domain\n"
20788 #: ../fish/guestfish.pod:285
20790 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20791 "then using other commands to mount the filesystems that were found."
20795 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20796 msgid "B<--keys-from-stdin>"
20800 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20802 "Read key or passphrase parameters from stdin. The default is to try to read"
20803 " passphrases from the user by opening C</dev/tty>."
20807 #: ../fish/guestfish.pod:294
20808 msgid "B<--listen>"
20812 #: ../fish/guestfish.pod:296
20814 "Fork into the background and listen for remote commands. See section "
20815 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20819 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20824 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20826 "Connect to a live virtual machine. (Experimental, see "
20827 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
20831 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20832 msgid "B<-m dev[:mountpoint[:options]]>"
20836 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20837 msgid "B<--mount dev[:mountpoint[:options]]>"
20841 #: ../fish/guestfish.pod:308
20842 msgid "Mount the named partition or logical volume on the given mountpoint."
20846 #: ../fish/guestfish.pod:310
20847 msgid "If the mountpoint is omitted, it defaults to C</>."
20851 #: ../fish/guestfish.pod:312
20852 msgid "You have to mount something on C</> before most commands will work."
20856 #: ../fish/guestfish.pod:314
20858 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20863 #: ../fish/guestfish.pod:317
20865 "If you don't know what filesystems a disk image contains, you can either run"
20866 " guestfish without this option, then list the partitions, filesystems and "
20867 "LVs available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20868 "commands), or you can use the L<virt-filesystems(1)> program."
20872 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20874 "The third (and rarely used) part of the mount parameter is the list of mount"
20875 " options used to mount the underlying filesystem. If this is not given, "
20876 "then the mount options are either the empty string or C<ro> (the latter if "
20877 "the I<--ro> flag is used). By specifying the mount options, you override "
20878 "this default choice. Probably the only time you would use this is to enable"
20879 " ACLs and/or extended attributes if the filesystem can support them:"
20883 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20886 " -m /dev/sda1:/:acl,user_xattr\n"
20891 #: ../fish/guestfish.pod:333
20892 msgid "Using this flag is equivalent to using the C<mount-options> command."
20896 #: ../fish/guestfish.pod:335
20901 #: ../fish/guestfish.pod:337
20902 msgid "B<--no-sync>"
20906 #: ../fish/guestfish.pod:339
20908 "Disable autosync. This is enabled by default. See the discussion of "
20909 "autosync in the L<guestfs(3)> manpage."
20913 #: ../fish/guestfish.pod:342
20918 #: ../fish/guestfish.pod:344
20919 msgid "B<--new type>"
20923 #: ../fish/guestfish.pod:346
20928 #: ../fish/guestfish.pod:348
20930 "Prepare a fresh disk image formatted as \"type\". This is an alternative to"
20931 " the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20932 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20937 #: ../fish/guestfish.pod:353
20938 msgid "B<--progress-bars>"
20942 #: ../fish/guestfish.pod:355
20943 msgid "Enable progress bars, even when guestfish is used non-interactively."
20947 #: ../fish/guestfish.pod:357
20949 "Progress bars are enabled by default when guestfish is used as an "
20950 "interactive shell."
20954 #: ../fish/guestfish.pod:360
20955 msgid "B<--no-progress-bars>"
20959 #: ../fish/guestfish.pod:362
20960 msgid "Disable progress bars."
20964 #: ../fish/guestfish.pod:364
20965 msgid "B<--remote[=pid]>"
20969 #: ../fish/guestfish.pod:366
20971 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20972 "CONTROL GUESTFISH OVER A SOCKET> below."
20976 #: ../fish/guestfish.pod:369
20981 #: ../fish/guestfish.pod:371
20986 #: ../fish/guestfish.pod:373
20988 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20989 "mounts are done read-only."
20993 #: ../fish/guestfish.pod:376
20995 "The option must always be used if the disk image or virtual machine might be"
20996 " running, and is generally recommended in cases where you don't need write "
20997 "access to the disk."
21001 #: ../fish/guestfish.pod:380
21003 "Note that prepared disk images created with I<-N> are not affected by this "
21004 "option. Also commands like C<add> are not affected - you have to specify "
21005 "the C<readonly:true> option explicitly if you need it."
21009 #: ../fish/guestfish.pod:384
21010 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21014 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
21015 msgid "B<--selinux>"
21019 #: ../fish/guestfish.pod:388
21020 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21024 #: ../fish/guestfish.pod:390
21029 #: ../fish/guestfish.pod:392
21030 msgid "B<--verbose>"
21034 #: ../fish/guestfish.pod:394
21036 "Enable very verbose messages. This is particularly useful if you find a "
21041 #: ../fish/guestfish.pod:397
21046 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
21047 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
21048 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21049 msgid "B<--version>"
21053 #: ../fish/guestfish.pod:401
21054 msgid "Display the guestfish / libguestfs version number and exit."
21058 #: ../fish/guestfish.pod:403
21063 #: ../fish/guestfish.pod:405
21068 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
21070 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21071 "mounts are done read-write."
21075 #: ../fish/guestfish.pod:410
21076 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
21080 #: ../fish/guestfish.pod:412
21085 #: ../fish/guestfish.pod:414
21086 msgid "Echo each command before executing it."
21090 #: ../fish/guestfish.pod:418
21091 msgid "COMMANDS ON COMMAND LINE"
21095 #: ../fish/guestfish.pod:420
21097 "Any additional (non-option) arguments are treated as commands to execute."
21101 #: ../fish/guestfish.pod:423
21103 "Commands to execute should be separated by a colon (C<:>), where the colon "
21104 "is a separate parameter. Thus:"
21108 #: ../fish/guestfish.pod:426
21111 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21116 #: ../fish/guestfish.pod:428
21118 "If there are no additional arguments, then we enter a shell, either an "
21119 "interactive shell with a prompt (if the input is a terminal) or a non-"
21120 "interactive shell."
21124 #: ../fish/guestfish.pod:432
21126 "In either command line mode or non-interactive shell, the first command that"
21127 " gives an error causes the whole shell to exit. In interactive mode (with a"
21128 " prompt) if a command fails, you can continue to enter commands."
21132 #: ../fish/guestfish.pod:437
21133 msgid "USING launch (OR run)"
21137 #: ../fish/guestfish.pod:439
21139 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21140 "then launch it, then mount any disks you need, and finally issue "
21141 "actions/commands. So the general order of the day is:"
21145 #: ../fish/guestfish.pod:447
21146 msgid "add or -a/--add"
21150 #: ../fish/guestfish.pod:451
21151 msgid "launch (aka run)"
21155 #: ../fish/guestfish.pod:455
21156 msgid "mount or -m/--mount"
21160 #: ../fish/guestfish.pod:459
21161 msgid "any other commands"
21165 #: ../fish/guestfish.pod:463
21167 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21168 "guest before mounting or performing any other commands."
21172 #: ../fish/guestfish.pod:466
21174 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21175 "I<--new> options were given then C<run> is done automatically, simply "
21176 "because guestfish can't perform the action you asked for without doing this."
21180 #: ../fish/guestfish.pod:471
21181 msgid "OPENING DISKS FOR READ AND WRITE"
21185 #: ../fish/guestfish.pod:473
21187 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
21188 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
21189 "I<-i> and I<-m> open disk images read-only or for writing."
21193 #: ../fish/guestfish.pod:478
21195 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to"
21196 " opening disk images supplied on the command line for write. To open a disk"
21197 " image read-only you have to do I<-a image --ro>."
21201 #: ../fish/guestfish.pod:482
21203 "This matters: If you accidentally open a live VM disk image writable then "
21204 "you will cause irreversible disk corruption."
21208 #: ../fish/guestfish.pod:485
21210 "By libguestfs 1.12 we intend to change the default the other way. Disk "
21211 "images will be opened read-only. You will have to either specify "
21212 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
21213 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
21214 "access for disk images specified by those other command line options."
21218 #: ../fish/guestfish.pod:492
21220 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
21221 "which does nothing (it is already the default). However it is highly "
21222 "recommended that you use this option to indicate that you need write access,"
21223 " and prepare your scripts for the day when this option will be required for "
21228 #: ../fish/guestfish.pod:498
21230 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any"
21231 " other libguestfs program apart from guestfish and guestmount."
21235 #: ../fish/guestfish.pod:501
21240 #: ../fish/guestfish.pod:503
21242 "You can quote ordinary parameters using either single or double quotes. For"
21247 #: ../fish/guestfish.pod:506
21250 " add \"file with a space.img\"\n"
21255 #: ../fish/guestfish.pod:508
21258 " rm '/file name'\n"
21263 #: ../fish/guestfish.pod:510
21271 #: ../fish/guestfish.pod:512
21273 "A few commands require a list of strings to be passed. For these, use a "
21274 "whitespace-separated list, enclosed in quotes. Strings containing "
21275 "whitespace to be passed through must be enclosed in single quotes. A "
21276 "literal single quote must be escaped with a backslash."
21280 #: ../fish/guestfish.pod:517
21283 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21284 " command \"/bin/echo 'foo bar'\"\n"
21285 " command \"/bin/echo \\'foo\\'\"\n"
21290 #: ../fish/guestfish.pod:521
21291 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
21295 #: ../fish/guestfish.pod:523
21297 "In double-quoted arguments (only) use backslash to insert special "
21302 #: ../fish/guestfish.pod:528
21307 #: ../fish/guestfish.pod:530
21308 msgid "Alert (bell) character."
21312 #: ../fish/guestfish.pod:532
21317 #: ../fish/guestfish.pod:534
21318 msgid "Backspace character."
21322 #: ../fish/guestfish.pod:536
21327 #: ../fish/guestfish.pod:538
21328 msgid "Form feed character."
21332 #: ../fish/guestfish.pod:540
21337 #: ../fish/guestfish.pod:542
21338 msgid "Newline character."
21342 #: ../fish/guestfish.pod:544
21347 #: ../fish/guestfish.pod:546
21348 msgid "Carriage return character."
21352 #: ../fish/guestfish.pod:548
21357 #: ../fish/guestfish.pod:550
21358 msgid "Horizontal tab character."
21362 #: ../fish/guestfish.pod:552
21367 #: ../fish/guestfish.pod:554
21368 msgid "Vertical tab character."
21372 #: ../fish/guestfish.pod:556
21377 #: ../fish/guestfish.pod:558
21378 msgid "A literal double quote character."
21382 #: ../fish/guestfish.pod:560
21387 #: ../fish/guestfish.pod:562
21389 "A character with octal value I<ooo>. There must be precisely 3 octal digits"
21394 #: ../fish/guestfish.pod:565
21399 #: ../fish/guestfish.pod:567
21401 "A character with hex value I<hh>. There must be precisely 2 hex digits."
21405 #: ../fish/guestfish.pod:570
21407 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
21412 #: ../fish/guestfish.pod:573
21417 #: ../fish/guestfish.pod:575
21418 msgid "A literal backslash character."
21422 #: ../fish/guestfish.pod:579
21423 msgid "OPTIONAL ARGUMENTS"
21427 #: ../fish/guestfish.pod:581
21429 "Some commands take optional arguments. These arguments appear in this "
21430 "documentation as C<[argname:..]>. You can use them as in these examples:"
21434 #: ../fish/guestfish.pod:585
21437 " add-drive-opts filename\n"
21442 #: ../fish/guestfish.pod:587
21445 " add-drive-opts filename readonly:true\n"
21450 #: ../fish/guestfish.pod:589
21453 " add-drive-opts filename format:qcow2 readonly:false\n"
21458 #: ../fish/guestfish.pod:591
21460 "Each optional argument can appear at most once. All optional arguments must"
21461 " appear after the required ones."
21465 #: ../fish/guestfish.pod:594
21470 #: ../fish/guestfish.pod:596
21472 "This section applies to all commands which can take integers as parameters."
21476 #: ../fish/guestfish.pod:599
21477 msgid "SIZE SUFFIX"
21481 #: ../fish/guestfish.pod:601
21483 "When the command takes a parameter measured in bytes, you can use one of the"
21484 " following suffixes to specify kilobytes, megabytes and larger sizes:"
21488 #: ../fish/guestfish.pod:607
21489 msgid "B<k> or B<K> or B<KiB>"
21493 #: ../fish/guestfish.pod:609
21494 msgid "The size in kilobytes (multiplied by 1024)."
21498 #: ../fish/guestfish.pod:611
21503 #: ../fish/guestfish.pod:613
21504 msgid "The size in SI 1000 byte units."
21508 #: ../fish/guestfish.pod:615
21509 msgid "B<M> or B<MiB>"
21513 #: ../fish/guestfish.pod:617
21514 msgid "The size in megabytes (multiplied by 1048576)."
21518 #: ../fish/guestfish.pod:619
21523 #: ../fish/guestfish.pod:621
21524 msgid "The size in SI 1000000 byte units."
21528 #: ../fish/guestfish.pod:623
21529 msgid "B<G> or B<GiB>"
21533 #: ../fish/guestfish.pod:625
21534 msgid "The size in gigabytes (multiplied by 2**30)."
21538 #: ../fish/guestfish.pod:627
21543 #: ../fish/guestfish.pod:629
21544 msgid "The size in SI 10**9 byte units."
21548 #: ../fish/guestfish.pod:631
21549 msgid "B<T> or B<TiB>"
21553 #: ../fish/guestfish.pod:633
21554 msgid "The size in terabytes (multiplied by 2**40)."
21558 #: ../fish/guestfish.pod:635
21563 #: ../fish/guestfish.pod:637
21564 msgid "The size in SI 10**12 byte units."
21568 #: ../fish/guestfish.pod:639
21569 msgid "B<P> or B<PiB>"
21573 #: ../fish/guestfish.pod:641
21574 msgid "The size in petabytes (multiplied by 2**50)."
21578 #: ../fish/guestfish.pod:643
21583 #: ../fish/guestfish.pod:645
21584 msgid "The size in SI 10**15 byte units."
21588 #: ../fish/guestfish.pod:647
21589 msgid "B<E> or B<EiB>"
21593 #: ../fish/guestfish.pod:649
21594 msgid "The size in exabytes (multiplied by 2**60)."
21598 #: ../fish/guestfish.pod:651
21603 #: ../fish/guestfish.pod:653
21604 msgid "The size in SI 10**18 byte units."
21608 #: ../fish/guestfish.pod:655
21609 msgid "B<Z> or B<ZiB>"
21613 #: ../fish/guestfish.pod:657
21614 msgid "The size in zettabytes (multiplied by 2**70)."
21618 #: ../fish/guestfish.pod:659
21623 #: ../fish/guestfish.pod:661
21624 msgid "The size in SI 10**21 byte units."
21628 #: ../fish/guestfish.pod:663
21629 msgid "B<Y> or B<YiB>"
21633 #: ../fish/guestfish.pod:665
21634 msgid "The size in yottabytes (multiplied by 2**80)."
21638 #: ../fish/guestfish.pod:667
21643 #: ../fish/guestfish.pod:669
21644 msgid "The size in SI 10**24 byte units."
21648 #: ../fish/guestfish.pod:675
21651 " truncate-size /file 1G\n"
21656 #: ../fish/guestfish.pod:677
21657 msgid "would truncate the file to 1 gigabyte."
21661 #: ../fish/guestfish.pod:679
21663 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21664 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21665 "suffix will probably not do what you expect."
21669 #: ../fish/guestfish.pod:683
21670 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21674 #: ../fish/guestfish.pod:685
21676 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21677 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21681 #: ../fish/guestfish.pod:688
21684 " 1234 decimal number 1234\n"
21685 " 02322 octal number, equivalent to decimal 1234\n"
21686 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21691 #: ../fish/guestfish.pod:692
21693 "When using the C<chmod> command, you almost always want to specify an octal "
21694 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21695 "L<chmod(1)> program):"
21699 #: ../fish/guestfish.pod:696
21702 " chmod 0777 /public # OK\n"
21703 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21708 #: ../fish/guestfish.pod:699
21710 "Commands that return numbers usually print them in decimal, but some "
21711 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21712 "octal, preceeded by C<0>)."
21716 #: ../fish/guestfish.pod:703
21717 msgid "WILDCARDS AND GLOBBING"
21721 #: ../fish/guestfish.pod:705
21723 "Neither guestfish nor the underlying guestfs API performs wildcard expansion"
21724 " (globbing) by default. So for example the following will not do what you "
21729 #: ../fish/guestfish.pod:709
21737 #: ../fish/guestfish.pod:711
21739 "Assuming you don't have a directory called literally C</home/*> then the "
21740 "above command will return an error."
21744 #: ../fish/guestfish.pod:714
21745 msgid "To perform wildcard expansion, use the C<glob> command."
21749 #: ../fish/guestfish.pod:716
21752 " glob rm-rf /home/*\n"
21757 #: ../fish/guestfish.pod:718
21759 "runs C<rm-rf> on each path that matches (ie. potentially running the command"
21760 " many times), equivalent to:"
21764 #: ../fish/guestfish.pod:721
21767 " rm-rf /home/jim\n"
21768 " rm-rf /home/joe\n"
21769 " rm-rf /home/mary\n"
21774 #: ../fish/guestfish.pod:725
21775 msgid "C<glob> only works on simple guest paths and not on device names."
21779 #: ../fish/guestfish.pod:727
21781 "If you have several parameters, each containing a wildcard, then glob will "
21782 "perform a Cartesian product."
21786 #: ../fish/guestfish.pod:730
21791 #: ../fish/guestfish.pod:732
21793 "Any line which starts with a I<#> character is treated as a comment and "
21794 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21795 "a command. For example:"
21799 #: ../fish/guestfish.pod:736
21802 " # this is a comment\n"
21803 " # this is a comment\n"
21804 " foo # NOT a comment\n"
21809 #: ../fish/guestfish.pod:740
21810 msgid "Blank lines are also ignored."
21814 #: ../fish/guestfish.pod:742
21815 msgid "RUNNING COMMANDS LOCALLY"
21819 #: ../fish/guestfish.pod:744
21821 "Any line which starts with a I<!> character is treated as a command sent to "
21822 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21826 #: ../fish/guestfish.pod:748
21830 " tgz-out /remote local/remote-data.tar.gz\n"
21835 #: ../fish/guestfish.pod:751
21837 "will create a directory C<local> on the host, and then export the contents "
21838 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21839 "(See C<tgz-out>)."
21843 #: ../fish/guestfish.pod:755
21845 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21846 "effect, due to the way that subprocesses work in Unix."
21850 #: ../fish/guestfish.pod:758
21851 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21855 #: ../fish/guestfish.pod:760
21857 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21858 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21859 "and executed as guestfish commands."
21863 #: ../fish/guestfish.pod:764
21865 "Thus you can use shell script to construct arbitrary guestfish commands "
21866 "which are then parsed by guestfish."
21870 #: ../fish/guestfish.pod:767
21872 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21873 "through C</foo.100>) using guestfish commands alone. However this is simple"
21874 " if we use a shell script to create the guestfish commands for us:"
21878 #: ../fish/guestfish.pod:772
21881 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21886 #: ../fish/guestfish.pod:774
21887 msgid "or with names like C</foo.001>:"
21891 #: ../fish/guestfish.pod:776
21894 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21899 #: ../fish/guestfish.pod:778
21901 "When using guestfish interactively it can be helpful to just run the shell "
21902 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21903 "ordinary I<!> local command), see what guestfish commands it would run, and "
21904 "when you are happy with those prepend the C<E<lt>> character to run the "
21905 "guestfish commands for real."
21909 #: ../fish/guestfish.pod:784
21914 #: ../fish/guestfish.pod:786
21916 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21917 "command (a guestfish command) to the second command (any host command). For"
21922 #: ../fish/guestfish.pod:790
21925 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21930 #: ../fish/guestfish.pod:792
21932 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21933 "program). The above command would list all accounts in the guest filesystem"
21934 " which have UID 0, ie. root accounts including backdoors. Other examples:"
21938 #: ../fish/guestfish.pod:797
21941 " hexdump /bin/ls | head\n"
21942 " list-devices | tail -1\n"
21943 " tgz-out / - | tar ztf -\n"
21948 #: ../fish/guestfish.pod:801
21950 "The space before the pipe symbol is required, any space after the pipe "
21951 "symbol is optional. Everything after the pipe symbol is just passed "
21952 "straight to the host shell, so it can contain redirections, globs and "
21953 "anything else that makes sense on the host side."
21957 #: ../fish/guestfish.pod:806
21959 "To use a literal argument which begins with a pipe symbol, you have to quote"
21964 #: ../fish/guestfish.pod:809
21972 #: ../fish/guestfish.pod:811
21973 msgid "HOME DIRECTORIES"
21977 #: ../fish/guestfish.pod:813
21979 "If a parameter starts with the character C<~> then the tilde may be expanded"
21980 " as a home directory path (either C<~> for the current user's home "
21981 "directory, or C<~user> for another user)."
21985 #: ../fish/guestfish.pod:817
21987 "Note that home directory expansion happens for users known I<on the host>, "
21988 "not in the guest filesystem."
21992 #: ../fish/guestfish.pod:820
21994 "To use a literal argument which begins with a tilde, you have to quote it, "
21999 #: ../fish/guestfish.pod:823
22007 #: ../fish/guestfish.pod:827
22009 "Libguestfs has some support for Linux guests encrypted according to the "
22010 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22011 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22012 "LUKS is supported."
22016 #: ../fish/guestfish.pod:832
22017 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22021 #: ../fish/guestfish.pod:834
22024 " ><fs> vfs-type /dev/sda2\n"
22030 #: ../fish/guestfish.pod:837
22032 "Then open those devices using L</luks-open>. This creates a device-mapper "
22033 "device called C</dev/mapper/luksdev>."
22037 #: ../fish/guestfish.pod:840
22040 " ><fs> luks-open /dev/sda2 luksdev\n"
22041 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22046 #: ../fish/guestfish.pod:843
22048 "Finally you have to tell LVM to scan for volume groups on the newly created "
22053 #: ../fish/guestfish.pod:846
22057 " vg-activate-all true\n"
22062 #: ../fish/guestfish.pod:849
22063 msgid "The logical volume(s) can now be mounted in the usual way."
22067 #: ../fish/guestfish.pod:851
22069 "Before closing a LUKS device you must unmount any logical volumes on it and "
22070 "deactivate the volume groups by calling C<vg-activate false VG> on each one."
22071 " Then you can close the mapper device:"
22075 #: ../fish/guestfish.pod:855
22078 " vg-activate false /dev/VG\n"
22079 " luks-close /dev/mapper/luksdev\n"
22084 #: ../fish/guestfish.pod:858
22085 msgid "WINDOWS PATHS"
22089 #: ../fish/guestfish.pod:860
22091 "If a path is prefixed with C<win:> then you can use Windows-style drive "
22092 "letters and paths (with some limitations). The following commands are "
22097 #: ../fish/guestfish.pod:864
22100 " file /WINDOWS/system32/config/system.LOG\n"
22105 #: ../fish/guestfish.pod:866
22108 " file win:\\windows\\system32\\config\\system.log\n"
22113 #: ../fish/guestfish.pod:868
22116 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
22121 #: ../fish/guestfish.pod:870
22123 "The parameter is rewritten \"behind the scenes\" by looking up the position "
22124 "where the drive is mounted, prepending that to the path, changing all "
22125 "backslash characters to forward slash, then resolving the result using L"
22126 "</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
22127 "then the parameter might be rewritten like this:"
22131 #: ../fish/guestfish.pod:876
22134 " win:e:\\foo\\bar => /e/FOO/bar\n"
22139 #: ../fish/guestfish.pod:878
22140 msgid "This only works in argument positions that expect a path."
22144 #: ../fish/guestfish.pod:880
22145 msgid "UPLOADING AND DOWNLOADING FILES"
22149 #: ../fish/guestfish.pod:882
22151 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22152 "others which upload from or download to a local file, you can use the "
22153 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22157 #: ../fish/guestfish.pod:886
22165 #: ../fish/guestfish.pod:888
22167 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22171 #: ../fish/guestfish.pod:891
22174 " tar-out /etc - | tar tf -\n"
22179 #: ../fish/guestfish.pod:893
22181 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22182 "command (see L</PIPES>)."
22186 #: ../fish/guestfish.pod:896
22188 "When using C<-> to read from stdin, the input is read up to the end of "
22189 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22190 "some arbitrary end marker:"
22194 #: ../fish/guestfish.pod:900
22197 " upload -<<END /foo\n"
22206 #: ../fish/guestfish.pod:906
22208 "Any string of characters can be used instead of C<END>. The end marker must"
22209 " appear on a line of its own, without any preceeding or following characters"
22210 " (not even spaces)."
22214 #: ../fish/guestfish.pod:910
22216 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22217 "upload local files (so-called \"FileIn\" parameters in the generator)."
22221 #: ../fish/guestfish.pod:913
22222 msgid "EXIT ON ERROR BEHAVIOUR"
22226 #: ../fish/guestfish.pod:915
22228 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22229 "taking commands from a human over a tty), and will exit on the first error "
22230 "in non-interactive mode (scripts, commands given on the command line)."
22234 #: ../fish/guestfish.pod:920
22236 "If you prefix a command with a I<-> character, then that command will not "
22237 "cause guestfish to exit, even if that (one) command returns an error."
22241 #: ../fish/guestfish.pod:924
22242 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22246 #: ../fish/guestfish.pod:926
22248 "Guestfish can be remote-controlled over a socket. This is useful "
22249 "particularly in shell scripts where you want to make several different "
22250 "changes to a filesystem, but you don't want the overhead of starting up a "
22251 "guestfish process each time."
22255 #: ../fish/guestfish.pod:931
22256 msgid "Start a guestfish server process using:"
22260 #: ../fish/guestfish.pod:933
22263 " eval \"`guestfish --listen`\"\n"
22268 #: ../fish/guestfish.pod:935
22269 msgid "and then send it commands by doing:"
22273 #: ../fish/guestfish.pod:937
22276 " guestfish --remote cmd [...]\n"
22281 #: ../fish/guestfish.pod:939
22282 msgid "To cause the server to exit, send it the exit command:"
22286 #: ../fish/guestfish.pod:941
22289 " guestfish --remote exit\n"
22294 #: ../fish/guestfish.pod:943
22296 "Note that the server will normally exit if there is an error in a command. "
22297 "You can change this in the usual way. See section L</EXIT ON ERROR "
22302 #: ../fish/guestfish.pod:947
22303 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22307 #: ../fish/guestfish.pod:949
22309 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which"
22310 " is how the I<--remote> option knows where to send the commands. You can "
22311 "have several guestfish listener processes running using:"
22315 #: ../fish/guestfish.pod:953
22318 " eval \"`guestfish --listen`\"\n"
22319 " pid1=$GUESTFISH_PID\n"
22320 " eval \"`guestfish --listen`\"\n"
22321 " pid2=$GUESTFISH_PID\n"
22323 " guestfish --remote=$pid1 cmd\n"
22324 " guestfish --remote=$pid2 cmd\n"
22329 #: ../fish/guestfish.pod:961
22330 msgid "REMOTE CONTROL AND CSH"
22334 #: ../fish/guestfish.pod:963
22336 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22341 #: ../fish/guestfish.pod:966
22344 " eval \"`guestfish --listen --csh`\"\n"
22349 #: ../fish/guestfish.pod:968
22350 msgid "REMOTE CONTROL DETAILS"
22354 #: ../fish/guestfish.pod:970
22356 "Remote control happens over a Unix domain socket called "
22357 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
22358 "of the process, and C<$PID> is the process ID of the server."
22362 #: ../fish/guestfish.pod:974
22363 msgid "Guestfish client and server versions must match exactly."
22367 #: ../fish/guestfish.pod:976
22368 msgid "PREPARED DISK IMAGES"
22372 #: ../fish/guestfish.pod:978
22374 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22375 "preformatted disk images that guestfish can make for you to save typing. "
22376 "This is particularly useful for testing purposes. This option is used "
22377 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22378 "can be mixed with I<-a>)."
22382 #: ../fish/guestfish.pod:984
22384 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22385 "the second and so on. Existing files in the current directory are "
22390 #: ../fish/guestfish.pod:988
22392 "The type briefly describes how the disk should be sized, partitioned, how "
22393 "filesystem(s) should be created, and how content should be added. "
22394 "Optionally the type can be followed by extra parameters, separated by C<:> "
22395 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
22396 "sparsely-allocated disk, containing a single partition, with the partition "
22397 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem"
22398 " on a 1GB disk instead."
22402 #: ../fish/guestfish.pod:996
22403 msgid "To list the available types and any extra parameters they take, run:"
22407 #: ../fish/guestfish.pod:1000
22409 "Note that the prepared filesystem is not mounted. You would usually have to"
22410 " use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22414 #: ../fish/guestfish.pod:1004
22416 "If any I<-N> or I<--new> options are given, the guest is automatically "
22421 #: ../fish/guestfish.pod:1009
22422 msgid "Create a 100MB disk with an ext4-formatted partition:"
22426 #: ../fish/guestfish.pod:1011
22429 " guestfish -N fs:ext4\n"
22434 #: ../fish/guestfish.pod:1013
22435 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22439 #: ../fish/guestfish.pod:1015
22442 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22447 #: ../fish/guestfish.pod:1017
22448 msgid "Create a blank 200MB disk:"
22452 #: ../fish/guestfish.pod:1019
22455 " guestfish -N disk:200M\n"
22460 #: ../fish/guestfish.pod:1021
22461 msgid "PROGRESS BARS"
22465 #: ../fish/guestfish.pod:1023
22467 "Some (not all) long-running commands send progress notification messages as "
22468 "they are running. Guestfish turns these messages into progress bars."
22472 #: ../fish/guestfish.pod:1027
22474 "When a command that supports progress bars takes longer than two seconds to "
22475 "run, and if progress bars are enabled, then you will see one appearing below"
22480 #: ../fish/guestfish.pod:1031
22483 " ><fs> copy-size /large-file /another-file 2048M\n"
22484 " / 10% [#####-----------------------------------------] 00:30\n"
22489 #: ../fish/guestfish.pod:1034
22491 "The spinner on the left hand side moves round once for every progress "
22492 "notification received from the backend. This is a (reasonably) golden "
22493 "assurance that the command is \"doing something\" even if the progress bar "
22494 "is not moving, because the command is able to send the progress "
22495 "notifications. When the bar reaches 100% and the command finishes, the "
22496 "spinner disappears."
22500 #: ../fish/guestfish.pod:1041
22502 "Progress bars are enabled by default when guestfish is used interactively. "
22503 "You can enable them even for non-interactive modes using I<--progress-bars>,"
22504 " and you can disable them completely using I<--no-progress-bars>."
22508 #: ../fish/guestfish.pod:1046
22509 msgid "GUESTFISH COMMANDS"
22513 #: ../fish/guestfish.pod:1048
22515 "The commands in this section are guestfish convenience commands, in other "
22516 "words, they are not part of the L<guestfs(3)> API."
22520 #: ../fish/guestfish.pod:1051
22525 #: ../fish/guestfish.pod:1053
22534 #: ../fish/guestfish.pod:1056
22535 msgid "Without any parameter, this provides general help."
22539 #: ../fish/guestfish.pod:1058
22540 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22544 #: ../fish/guestfish.pod:1060
22545 msgid "quit | exit"
22549 #: ../fish/guestfish.pod:1062
22550 msgid "This exits guestfish. You can also use C<^D> key."
22554 #: ../fish/guestfish.pod:1064
22555 msgid "@FISH_COMMANDS@"
22559 #: ../fish/guestfish.pod:1066
22564 #: ../fish/guestfish.pod:1070 ../test-tool/libguestfs-test-tool.pod:77
22569 #: ../fish/guestfish.pod:1072
22571 "guestfish returns 0 if the commands completed without error, or 1 if there "
22576 #: ../fish/guestfish.pod:1079
22581 #: ../fish/guestfish.pod:1081
22583 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22588 #: ../fish/guestfish.pod:1084
22589 msgid "GUESTFISH_DISPLAY_IMAGE"
22593 #: ../fish/guestfish.pod:1086
22595 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22596 "If not set, it uses L<display(1)>."
22600 #: ../fish/guestfish.pod:1089
22601 msgid "GUESTFISH_PID"
22605 #: ../fish/guestfish.pod:1091
22607 "Used with the I<--remote> option to specify the remote guestfish process to "
22608 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22612 #: ../fish/guestfish.pod:1095
22617 #: ../fish/guestfish.pod:1097
22619 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22620 "not specified, the external L<hexedit(1)> program is used."
22624 #: ../fish/guestfish.pod:1101
22629 #: ../fish/guestfish.pod:1103
22631 "If compiled with GNU readline support, various files in the home directory "
22632 "can be used. See L</FILES>."
22636 #: ../fish/guestfish.pod:1112
22638 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22639 "effect as using the B<-v> option."
22643 #: ../fish/guestfish.pod:1124
22645 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22646 "the discussion of paths in L<guestfs(3)>."
22650 #: ../fish/guestfish.pod:1135
22651 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22655 #: ../fish/guestfish.pod:1137
22660 #: ../fish/guestfish.pod:1139
22662 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22667 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:264
22672 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:268
22673 msgid "$HOME/.libguestfs-tools.rc"
22677 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:270
22678 msgid "/etc/libguestfs-tools.conf"
22682 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:272
22684 "This configuration file controls the default read-only or read-write mode "
22685 "(I<--ro> or I<--rw>)."
22689 #: ../fish/guestfish.pod:1166
22690 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22694 #: ../fish/guestfish.pod:1168
22695 msgid "$HOME/.guestfish"
22699 #: ../fish/guestfish.pod:1170
22701 "If compiled with GNU readline support, then the command history is saved in "
22706 #: ../fish/guestfish.pod:1173
22707 msgid "$HOME/.inputrc"
22711 #: ../fish/guestfish.pod:1175
22712 msgid "/etc/inputrc"
22716 #: ../fish/guestfish.pod:1177
22718 "If compiled with GNU readline support, then these files can be used to "
22719 "configure readline. For further information, please see "
22720 "L<readline(3)/INITIALIZATION FILE>."
22724 #: ../fish/guestfish.pod:1181
22725 msgid "To write rules which only apply to guestfish, use:"
22729 #: ../fish/guestfish.pod:1183
22739 #: ../fish/guestfish.pod:1187
22741 "Variables that you can set in inputrc that change the behaviour of guestfish"
22742 " in useful ways include:"
22746 #: ../fish/guestfish.pod:1192
22747 msgid "completion-ignore-case (default: on)"
22751 #: ../fish/guestfish.pod:1194
22753 "By default, guestfish will ignore case when tab-completing paths on the "
22758 #: ../fish/guestfish.pod:1197
22761 " set completion-ignore-case off\n"
22766 #: ../fish/guestfish.pod:1199
22767 msgid "to make guestfish case sensitive."
22771 #: ../fish/guestfish.pod:1203
22776 #: ../fish/guestfish.pod:1205
22777 msgid "test2.img (etc)"
22781 #: ../fish/guestfish.pod:1207
22783 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22784 "will be created in the file C<test1.img> in the current directory. The "
22785 "second use of I<-N> will use C<test2.img> and so on. Any existing file with"
22786 " the same name will be overwritten."
22790 #: ../fish/guestfish.pod:1216
22792 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-"
22793 "in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-"
22794 "filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-"
22795 "list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L"
22796 "<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L"
22797 "<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>."
22801 #: ../fish/guestfish.pod:1247 ../test-tool/libguestfs-test-tool.pod:102
22802 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22803 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22804 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22806 "This program is free software; you can redistribute it and/or modify it "
22807 "under the terms of the GNU General Public License as published by the Free "
22808 "Software Foundation; either version 2 of the License, or (at your option) "
22809 "any later version."
22813 #: ../fish/guestfish.pod:1252 ../test-tool/libguestfs-test-tool.pod:107
22814 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22815 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22816 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22818 "This program is distributed in the hope that it will be useful, but WITHOUT "
22819 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22820 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22825 #: ../fish/guestfish.pod:1257 ../test-tool/libguestfs-test-tool.pod:112
22826 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22827 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22828 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22830 "You should have received a copy of the GNU General Public License along with"
22831 " this program; if not, write to the Free Software Foundation, Inc., 675 Mass"
22832 " Ave, Cambridge, MA 02139, USA."
22836 #: ../fish/guestfish-actions.pod:1
22841 #: ../fish/guestfish-actions.pod:3
22844 " add-cdrom filename\n"
22849 #: ../fish/guestfish-actions.pod:15
22851 "This call checks for the existence of C<filename>. This stops you from "
22852 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22853 "and C<http:> URLs. To specify those, use the general L</config> call "
22858 #: ../fish/guestfish-actions.pod:22
22860 "If you just want to add an ISO file (often you use this as an efficient way "
22861 "to transfer large files into the guest), then you should probably use L"
22862 "</add-drive-ro> instead."
22866 #: ../fish/guestfish-actions.pod:35
22871 #: ../fish/guestfish-actions.pod:37
22876 #: ../fish/guestfish-actions.pod:39
22879 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22884 #: ../fish/guestfish-actions.pod:41
22886 "This function adds the disk(s) attached to the named libvirt domain C<dom>."
22887 " It works by connecting to libvirt, requesting the domain and domain XML "
22888 "from libvirt, parsing it for disks, and calling L</add-drive-opts> on each "
22893 #: ../fish/guestfish-actions.pod:76
22895 "The other optional parameters are passed directly through to L</add-drive-"
22900 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22901 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
22902 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
22903 #: ../fish/guestfish-actions.pod:3442
22905 "This command has one or more optional arguments. See L</OPTIONAL "
22910 #: ../fish/guestfish-actions.pod:81
22915 #: ../fish/guestfish-actions.pod:83
22918 " add-drive filename\n"
22923 #: ../fish/guestfish-actions.pod:85
22925 "This function is the equivalent of calling L</add-drive-opts> with no "
22926 "optional parameters, so the disk is added writable, with the format being "
22927 "detected automatically."
22931 #: ../fish/guestfish-actions.pod:89
22933 "Automatic detection of the format opens you up to a potential security hole "
22934 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22935 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22936 "you should think about replacing calls to this function with calls to L"
22937 "</add-drive-opts>, and specifying the format."
22941 #: ../fish/guestfish-actions.pod:96
22942 msgid "add-drive-opts"
22946 #: ../fish/guestfish-actions.pod:98
22951 #: ../fish/guestfish-actions.pod:100
22954 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22959 #: ../fish/guestfish-actions.pod:127
22961 "This forces the image format. If you omit this (or use L</add-drive> or L"
22962 "</add-drive-ro>) then the format is automatically detected. Possible "
22963 "formats include C<raw> and C<qcow2>."
22967 #: ../fish/guestfish-actions.pod:138
22969 "This rarely-used option lets you emulate the behaviour of the deprecated L"
22970 "</add-drive-with-if> call (q.v.)"
22974 #: ../fish/guestfish-actions.pod:145
22975 msgid "add-drive-ro"
22979 #: ../fish/guestfish-actions.pod:147
22984 #: ../fish/guestfish-actions.pod:149
22987 " add-drive-ro filename\n"
22992 #: ../fish/guestfish-actions.pod:151
22994 "This function is the equivalent of calling L</add-drive-opts> with the "
22995 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
22996 "is added read-only, with the format being detected automatically."
23000 #: ../fish/guestfish-actions.pod:156
23001 msgid "add-drive-ro-with-if"
23005 #: ../fish/guestfish-actions.pod:158
23008 " add-drive-ro-with-if filename iface\n"
23013 #: ../fish/guestfish-actions.pod:160
23015 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23016 "interface emulation to use at run time."
23020 #: ../fish/guestfish-actions.pod:170
23021 msgid "add-drive-with-if"
23025 #: ../fish/guestfish-actions.pod:172
23028 " add-drive-with-if filename iface\n"
23033 #: ../fish/guestfish-actions.pod:174
23035 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23036 "interface emulation to use at run time."
23040 #: ../fish/guestfish-actions.pod:184
23045 #: ../fish/guestfish-actions.pod:186
23048 " aug-clear augpath\n"
23053 #: ../fish/guestfish-actions.pod:191
23058 #: ../fish/guestfish-actions.pod:193
23066 #: ../fish/guestfish-actions.pod:195
23068 "Close the current Augeas handle and free up any resources used by it. After"
23069 " calling this, you have to call L</aug-init> again before you can use any "
23070 "other Augeas functions."
23074 #: ../fish/guestfish-actions.pod:200
23075 msgid "aug-defnode"
23079 #: ../fish/guestfish-actions.pod:202
23082 " aug-defnode name expr val\n"
23087 #: ../fish/guestfish-actions.pod:207
23089 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23090 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23091 "containing that single node."
23095 #: ../fish/guestfish-actions.pod:215
23100 #: ../fish/guestfish-actions.pod:217
23103 " aug-defvar name expr\n"
23108 #: ../fish/guestfish-actions.pod:226
23113 #: ../fish/guestfish-actions.pod:228
23116 " aug-get augpath\n"
23121 #: ../fish/guestfish-actions.pod:233
23126 #: ../fish/guestfish-actions.pod:235
23129 " aug-init root flags\n"
23134 #: ../fish/guestfish-actions.pod:241
23135 msgid "You must call this before using any other L</aug-*> commands."
23139 #: ../fish/guestfish-actions.pod:276
23140 msgid "Do not load the tree in L</aug-init>."
23144 #: ../fish/guestfish-actions.pod:280
23145 msgid "To close the handle, you can call L</aug-close>."
23149 #: ../fish/guestfish-actions.pod:284
23154 #: ../fish/guestfish-actions.pod:286
23157 " aug-insert augpath label true|false\n"
23162 #: ../fish/guestfish-actions.pod:296
23167 #: ../fish/guestfish-actions.pod:298
23175 #: ../fish/guestfish-actions.pod:305
23180 #: ../fish/guestfish-actions.pod:307
23183 " aug-ls augpath\n"
23188 #: ../fish/guestfish-actions.pod:309
23190 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23191 "resulting nodes into alphabetical order."
23195 #: ../fish/guestfish-actions.pod:312
23200 #: ../fish/guestfish-actions.pod:314
23203 " aug-match augpath\n"
23208 #: ../fish/guestfish-actions.pod:320
23213 #: ../fish/guestfish-actions.pod:322
23216 " aug-mv src dest\n"
23221 #: ../fish/guestfish-actions.pod:327
23226 #: ../fish/guestfish-actions.pod:329
23229 " aug-rm augpath\n"
23234 #: ../fish/guestfish-actions.pod:335
23239 #: ../fish/guestfish-actions.pod:337
23247 #: ../fish/guestfish-actions.pod:341
23249 "The flags which were passed to L</aug-init> affect exactly how files are "
23254 #: ../fish/guestfish-actions.pod:344
23259 #: ../fish/guestfish-actions.pod:346
23262 " aug-set augpath val\n"
23267 #: ../fish/guestfish-actions.pod:350
23269 "In the Augeas API, it is possible to clear a node by setting the value to "
23270 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23271 "this call. Instead you must use the L</aug-clear> call."
23275 #: ../fish/guestfish-actions.pod:355
23280 #: ../fish/guestfish-actions.pod:357
23283 " available 'groups ...'\n"
23288 #: ../fish/guestfish-actions.pod:363
23290 "The libguestfs groups, and the functions that those groups correspond to, "
23291 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23292 "runtime by calling L</available-all-groups>."
23296 #: ../fish/guestfish-actions.pod:387
23297 msgid "You must call L</launch> before calling this function."
23301 #: ../fish/guestfish-actions.pod:409
23303 "This call was added in version C<1.0.80>. In previous versions of "
23304 "libguestfs all you could do would be to speculatively execute a command to "
23305 "find out if the daemon implemented it. See also L</version>."
23309 #: ../fish/guestfish-actions.pod:416
23310 msgid "available-all-groups"
23314 #: ../fish/guestfish-actions.pod:418
23317 " available-all-groups\n"
23322 #: ../fish/guestfish-actions.pod:420
23324 "This command returns a list of all optional groups that this daemon knows "
23325 "about. Note this returns both supported and unsupported groups. To find "
23326 "out which ones the daemon can actually support you have to call "
23327 "L</available> on each member of the returned list."
23331 #: ../fish/guestfish-actions.pod:426
23332 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23336 #: ../fish/guestfish-actions.pod:428
23341 #: ../fish/guestfish-actions.pod:430
23344 " base64-in (base64file|-) filename\n"
23349 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
23350 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
23351 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
23352 #: ../fish/guestfish-actions.pod:4652 ../fish/guestfish-actions.pod:4664
23353 #: ../fish/guestfish-actions.pod:4675 ../fish/guestfish-actions.pod:4686
23354 #: ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4747
23355 #: ../fish/guestfish-actions.pod:4801 ../fish/guestfish-actions.pod:4824
23356 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23360 #: ../fish/guestfish-actions.pod:437
23365 #: ../fish/guestfish-actions.pod:439
23368 " base64-out filename (base64file|-)\n"
23373 #: ../fish/guestfish-actions.pod:446
23374 msgid "blockdev-flushbufs"
23378 #: ../fish/guestfish-actions.pod:448
23381 " blockdev-flushbufs device\n"
23386 #: ../fish/guestfish-actions.pod:455
23387 msgid "blockdev-getbsz"
23391 #: ../fish/guestfish-actions.pod:457
23394 " blockdev-getbsz device\n"
23399 #: ../fish/guestfish-actions.pod:466
23400 msgid "blockdev-getro"
23404 #: ../fish/guestfish-actions.pod:468
23407 " blockdev-getro device\n"
23412 #: ../fish/guestfish-actions.pod:475
23413 msgid "blockdev-getsize64"
23417 #: ../fish/guestfish-actions.pod:477
23420 " blockdev-getsize64 device\n"
23425 #: ../fish/guestfish-actions.pod:481
23426 msgid "See also L</blockdev-getsz>."
23430 #: ../fish/guestfish-actions.pod:485
23431 msgid "blockdev-getss"
23435 #: ../fish/guestfish-actions.pod:487
23438 " blockdev-getss device\n"
23443 #: ../fish/guestfish-actions.pod:492
23445 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23449 #: ../fish/guestfish-actions.pod:497
23450 msgid "blockdev-getsz"
23454 #: ../fish/guestfish-actions.pod:499
23457 " blockdev-getsz device\n"
23462 #: ../fish/guestfish-actions.pod:504
23464 "See also L</blockdev-getss> for the real sector size of the device, and L"
23465 "</blockdev-getsize64> for the more useful I<size in bytes>."
23469 #: ../fish/guestfish-actions.pod:510
23470 msgid "blockdev-rereadpt"
23474 #: ../fish/guestfish-actions.pod:512
23477 " blockdev-rereadpt device\n"
23482 #: ../fish/guestfish-actions.pod:518
23483 msgid "blockdev-setbsz"
23487 #: ../fish/guestfish-actions.pod:520
23490 " blockdev-setbsz device blocksize\n"
23495 #: ../fish/guestfish-actions.pod:529
23496 msgid "blockdev-setro"
23500 #: ../fish/guestfish-actions.pod:531
23503 " blockdev-setro device\n"
23508 #: ../fish/guestfish-actions.pod:537
23509 msgid "blockdev-setrw"
23513 #: ../fish/guestfish-actions.pod:539
23516 " blockdev-setrw device\n"
23521 #: ../fish/guestfish-actions.pod:545
23522 msgid "btrfs-filesystem-resize"
23526 #: ../fish/guestfish-actions.pod:547
23529 " btrfs-filesystem-resize mountpoint [size:..]\n"
23534 #: ../fish/guestfish-actions.pod:570
23535 msgid "case-sensitive-path"
23539 #: ../fish/guestfish-actions.pod:572
23542 " case-sensitive-path path\n"
23547 #: ../fish/guestfish-actions.pod:596
23549 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
23550 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
23551 "how the directories were originally created under Windows)."
23555 #: ../fish/guestfish-actions.pod:604
23556 msgid "See also L</realpath>."
23560 #: ../fish/guestfish-actions.pod:606
23565 #: ../fish/guestfish-actions.pod:608
23573 #: ../fish/guestfish-actions.pod:612
23575 "Note that this function cannot correctly handle binary files (specifically, "
23576 "files containing C<\\0> character which is treated as end of string). For "
23577 "those you need to use the L</read-file> or L</download> functions which have"
23578 " a more complex interface."
23582 #: ../fish/guestfish-actions.pod:620
23587 #: ../fish/guestfish-actions.pod:622
23590 " checksum csumtype path\n"
23595 #: ../fish/guestfish-actions.pod:665
23596 msgid "To get the checksum for a device, use L</checksum-device>."
23600 #: ../fish/guestfish-actions.pod:667
23601 msgid "To get the checksums for many files, use L</checksums-out>."
23605 #: ../fish/guestfish-actions.pod:669
23606 msgid "checksum-device"
23610 #: ../fish/guestfish-actions.pod:671
23613 " checksum-device csumtype device\n"
23618 #: ../fish/guestfish-actions.pod:673
23620 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23621 "device named C<device>. For the types of checksums supported see the "
23622 "L</checksum> command."
23626 #: ../fish/guestfish-actions.pod:677
23627 msgid "checksums-out"
23631 #: ../fish/guestfish-actions.pod:679
23634 " checksums-out csumtype directory (sumsfile|-)\n"
23639 #: ../fish/guestfish-actions.pod:695
23644 #: ../fish/guestfish-actions.pod:697
23647 " chmod mode path\n"
23652 #: ../fish/guestfish-actions.pod:708
23657 #: ../fish/guestfish-actions.pod:710
23660 " chown owner group path\n"
23665 #: ../fish/guestfish-actions.pod:718
23670 #: ../fish/guestfish-actions.pod:720
23673 " command 'arguments ...'\n"
23678 #: ../fish/guestfish-actions.pod:727
23680 "The single parameter is an argv-style list of arguments. The first element "
23681 "is the name of the program to run. Subsequent elements are parameters. The"
23682 " list must be non-empty (ie. must contain a program name). Note that the "
23683 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23687 #: ../fish/guestfish-actions.pod:755
23688 msgid "command-lines"
23692 #: ../fish/guestfish-actions.pod:757
23695 " command-lines 'arguments ...'\n"
23700 #: ../fish/guestfish-actions.pod:759
23702 "This is the same as L</command>, but splits the result into a list of lines."
23706 #: ../fish/guestfish-actions.pod:762
23707 msgid "See also: L</sh-lines>"
23711 #: ../fish/guestfish-actions.pod:767
23716 #: ../fish/guestfish-actions.pod:769
23719 " config qemuparam qemuvalue\n"
23724 #: ../fish/guestfish-actions.pod:780
23729 #: ../fish/guestfish-actions.pod:782
23732 " copy-size src dest size\n"
23737 #: ../fish/guestfish-actions.pod:790
23742 #: ../fish/guestfish-actions.pod:792
23750 #: ../fish/guestfish-actions.pod:797
23755 #: ../fish/guestfish-actions.pod:799
23763 #: ../fish/guestfish-actions.pod:804
23768 #: ../fish/guestfish-actions.pod:806
23776 #: ../fish/guestfish-actions.pod:813
23778 "If the destination is a device, it must be as large or larger than the "
23779 "source file or device, otherwise the copy will fail. This command cannot do"
23780 " partial copies (see L</copy-size>)."
23784 #: ../fish/guestfish-actions.pod:817
23789 #: ../fish/guestfish-actions.pod:819
23797 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
23799 "This command is mostly useful for interactive sessions. It is I<not> "
23800 "intended that you try to parse the output string. Use L</statvfs> from "
23805 #: ../fish/guestfish-actions.pod:827
23810 #: ../fish/guestfish-actions.pod:829
23818 #: ../fish/guestfish-actions.pod:838
23823 #: ../fish/guestfish-actions.pod:840
23831 #: ../fish/guestfish-actions.pod:846
23833 "Another way to get the same information is to enable verbose messages with L"
23834 "</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23835 "before running the program."
23839 #: ../fish/guestfish-actions.pod:851
23844 #: ../fish/guestfish-actions.pod:853
23847 " download remotefilename (filename|-)\n"
23852 #: ../fish/guestfish-actions.pod:860
23853 msgid "See also L</upload>, L</cat>."
23857 #: ../fish/guestfish-actions.pod:864
23858 msgid "download-offset"
23862 #: ../fish/guestfish-actions.pod:866
23865 " download-offset remotefilename (filename|-) offset size\n"
23870 #: ../fish/guestfish-actions.pod:874
23872 "Note that there is no limit on the amount of data that can be downloaded "
23873 "with this call, unlike with L</pread>, and this call always reads the full "
23874 "amount unless an error occurs."
23878 #: ../fish/guestfish-actions.pod:879
23879 msgid "See also L</download>, L</pread>."
23883 #: ../fish/guestfish-actions.pod:883
23884 msgid "drop-caches"
23888 #: ../fish/guestfish-actions.pod:885
23891 " drop-caches whattodrop\n"
23896 #: ../fish/guestfish-actions.pod:897
23901 #: ../fish/guestfish-actions.pod:899
23909 #: ../fish/guestfish-actions.pod:911
23914 #: ../fish/guestfish-actions.pod:913
23917 " e2fsck-f device\n"
23922 #: ../fish/guestfish-actions.pod:919
23924 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23925 "should use L</fsck>."
23929 #: ../fish/guestfish-actions.pod:922
23930 msgid "echo-daemon"
23934 #: ../fish/guestfish-actions.pod:924
23937 " echo-daemon 'words ...'\n"
23942 #: ../fish/guestfish-actions.pod:931
23943 msgid "See also L</ping-daemon>."
23947 #: ../fish/guestfish-actions.pod:933
23952 #: ../fish/guestfish-actions.pod:935
23955 " egrep regex path\n"
23960 #: ../fish/guestfish-actions.pod:943
23965 #: ../fish/guestfish-actions.pod:945
23968 " egrepi regex path\n"
23973 #: ../fish/guestfish-actions.pod:953
23978 #: ../fish/guestfish-actions.pod:955
23981 " equal file1 file2\n"
23986 #: ../fish/guestfish-actions.pod:962
23991 #: ../fish/guestfish-actions.pod:964
23999 #: ../fish/guestfish-actions.pod:969
24000 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24004 #: ../fish/guestfish-actions.pod:971
24009 #: ../fish/guestfish-actions.pod:973
24012 " fallocate path len\n"
24017 #: ../fish/guestfish-actions.pod:990
24018 msgid "fallocate64"
24022 #: ../fish/guestfish-actions.pod:992
24025 " fallocate64 path len\n"
24030 #: ../fish/guestfish-actions.pod:998
24032 "Note that this call allocates disk blocks for the file. To create a sparse "
24033 "file use L</truncate-size> instead."
24037 #: ../fish/guestfish-actions.pod:1001
24039 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24040 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24041 "maximum size of files created through that call to 1GB."
24045 #: ../fish/guestfish-actions.pod:1010
24050 #: ../fish/guestfish-actions.pod:1012
24053 " fgrep pattern path\n"
24058 #: ../fish/guestfish-actions.pod:1020
24063 #: ../fish/guestfish-actions.pod:1022
24066 " fgrepi pattern path\n"
24071 #: ../fish/guestfish-actions.pod:1030
24076 #: ../fish/guestfish-actions.pod:1032
24084 #: ../fish/guestfish-actions.pod:1048
24086 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
24087 "(etc), L</is-zero>."
24091 #: ../fish/guestfish-actions.pod:1051
24092 msgid "file-architecture"
24096 #: ../fish/guestfish-actions.pod:1053
24099 " file-architecture filename\n"
24104 #: ../fish/guestfish-actions.pod:1156
24109 #: ../fish/guestfish-actions.pod:1158
24117 #: ../fish/guestfish-actions.pod:1162
24119 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24120 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24124 #: ../fish/guestfish-actions.pod:1166
24129 #: ../fish/guestfish-actions.pod:1168
24132 " fill c len path\n"
24137 #: ../fish/guestfish-actions.pod:1174
24139 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24140 "L</truncate-size>. To create a file with a pattern of repeating bytes use L"
24145 #: ../fish/guestfish-actions.pod:1179
24146 msgid "fill-pattern"
24150 #: ../fish/guestfish-actions.pod:1181
24153 " fill-pattern pattern len path\n"
24158 #: ../fish/guestfish-actions.pod:1183
24160 "This function is like L</fill> except that it creates a new file of length "
24161 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern"
24162 " is truncated if necessary to ensure the length of the file is exactly "
24167 #: ../fish/guestfish-actions.pod:1188
24172 #: ../fish/guestfish-actions.pod:1190
24175 " find directory\n"
24180 #: ../fish/guestfish-actions.pod:1204
24181 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24185 #: ../fish/guestfish-actions.pod:1217
24186 msgid "See also L</find0>."
24190 #: ../fish/guestfish-actions.pod:1222
24195 #: ../fish/guestfish-actions.pod:1224
24198 " find0 directory (files|-)\n"
24203 #: ../fish/guestfish-actions.pod:1230
24205 "This command works the same way as L</find> with the following exceptions:"
24209 #: ../fish/guestfish-actions.pod:1257
24210 msgid "findfs-label"
24214 #: ../fish/guestfish-actions.pod:1259
24217 " findfs-label label\n"
24222 #: ../fish/guestfish-actions.pod:1265
24223 msgid "To find the label of a filesystem, use L</vfs-label>."
24227 #: ../fish/guestfish-actions.pod:1267
24228 msgid "findfs-uuid"
24232 #: ../fish/guestfish-actions.pod:1269
24235 " findfs-uuid uuid\n"
24240 #: ../fish/guestfish-actions.pod:1275
24241 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24245 #: ../fish/guestfish-actions.pod:1277
24250 #: ../fish/guestfish-actions.pod:1279
24253 " fsck fstype device\n"
24258 #: ../fish/guestfish-actions.pod:1309
24263 #: ../fish/guestfish-actions.pod:1311
24271 #: ../fish/guestfish-actions.pod:1318
24272 msgid "get-attach-method"
24276 #: ../fish/guestfish-actions.pod:1320
24279 " get-attach-method\n"
24284 #: ../fish/guestfish-actions.pod:1322
24285 msgid "Return the current attach method. See L</set-attach-method>."
24289 #: ../fish/guestfish-actions.pod:1324
24290 msgid "get-autosync"
24294 #: ../fish/guestfish-actions.pod:1326
24302 #: ../fish/guestfish-actions.pod:1330
24307 #: ../fish/guestfish-actions.pod:1332
24315 #: ../fish/guestfish-actions.pod:1336
24316 msgid "get-e2label"
24320 #: ../fish/guestfish-actions.pod:1338
24323 " get-e2label device\n"
24328 #: ../fish/guestfish-actions.pod:1350
24333 #: ../fish/guestfish-actions.pod:1352
24336 " get-e2uuid device\n"
24341 #: ../fish/guestfish-actions.pod:1364
24342 msgid "get-memsize"
24346 #: ../fish/guestfish-actions.pod:1366
24354 #: ../fish/guestfish-actions.pod:1371
24356 "If L</set-memsize> was not called on this handle, and if "
24357 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default"
24358 " value for memsize."
24362 #: ../fish/guestfish-actions.pod:1378
24363 msgid "get-network"
24367 #: ../fish/guestfish-actions.pod:1380
24375 #: ../fish/guestfish-actions.pod:1384
24380 #: ../fish/guestfish-actions.pod:1386
24388 #: ../fish/guestfish-actions.pod:1393
24393 #: ../fish/guestfish-actions.pod:1395
24401 #: ../fish/guestfish-actions.pod:1399
24406 #: ../fish/guestfish-actions.pod:1401
24411 #: ../fish/guestfish-actions.pod:1403
24419 #: ../fish/guestfish-actions.pod:1410
24424 #: ../fish/guestfish-actions.pod:1412
24432 #: ../fish/guestfish-actions.pod:1419
24433 msgid "get-recovery-proc"
24437 #: ../fish/guestfish-actions.pod:1421
24440 " get-recovery-proc\n"
24445 #: ../fish/guestfish-actions.pod:1425
24446 msgid "get-selinux"
24450 #: ../fish/guestfish-actions.pod:1427
24458 #: ../fish/guestfish-actions.pod:1429
24460 "This returns the current setting of the selinux flag which is passed to the "
24461 "appliance at boot time. See L</set-selinux>."
24465 #: ../fish/guestfish-actions.pod:1435
24470 #: ../fish/guestfish-actions.pod:1437
24478 #: ../fish/guestfish-actions.pod:1444
24483 #: ../fish/guestfish-actions.pod:1446
24491 #: ../fish/guestfish-actions.pod:1450
24496 #: ../fish/guestfish-actions.pod:1452
24504 #: ../fish/guestfish-actions.pod:1454
24506 "Return the current umask. By default the umask is C<022> unless it has been"
24507 " set by calling L</umask>."
24511 #: ../fish/guestfish-actions.pod:1457
24512 msgid "get-verbose"
24516 #: ../fish/guestfish-actions.pod:1459
24524 #: ../fish/guestfish-actions.pod:1463
24529 #: ../fish/guestfish-actions.pod:1465
24537 #: ../fish/guestfish-actions.pod:1469
24538 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24542 #: ../fish/guestfish-actions.pod:1472
24547 #: ../fish/guestfish-actions.pod:1474
24550 " getxattr path name\n"
24555 #: ../fish/guestfish-actions.pod:1476
24557 "Get a single extended attribute from file C<path> named C<name>. This call "
24558 "follows symlinks. If you want to lookup an extended attribute for the "
24559 "symlink itself, use L</lgetxattr>."
24563 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
24565 "Normally it is better to get all extended attributes from a file in one go "
24566 "by calling L</getxattrs>. However some Linux filesystem implementations are"
24567 " buggy and do not provide a way to list out attributes. For these "
24568 "filesystems (notably ntfs-3g) you have to know the names of the extended "
24569 "attributes you want in advance and call this function."
24573 #: ../fish/guestfish-actions.pod:1490
24574 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
24578 #: ../fish/guestfish-actions.pod:1492
24583 #: ../fish/guestfish-actions.pod:1494
24586 " getxattrs path\n"
24591 #: ../fish/guestfish-actions.pod:1502
24592 msgid "See also: L</lgetxattrs>, L<attr(5)>."
24596 #: ../fish/guestfish-actions.pod:1504
24597 msgid "glob-expand"
24601 #: ../fish/guestfish-actions.pod:1506
24604 " glob-expand pattern\n"
24609 #: ../fish/guestfish-actions.pod:1519
24614 #: ../fish/guestfish-actions.pod:1521
24617 " grep regex path\n"
24622 #: ../fish/guestfish-actions.pod:1529
24627 #: ../fish/guestfish-actions.pod:1531
24630 " grepi regex path\n"
24635 #: ../fish/guestfish-actions.pod:1539
24636 msgid "grub-install"
24640 #: ../fish/guestfish-actions.pod:1541
24643 " grub-install root device\n"
24648 #: ../fish/guestfish-actions.pod:1557
24653 #: ../fish/guestfish-actions.pod:1559
24661 #: ../fish/guestfish-actions.pod:1567
24666 #: ../fish/guestfish-actions.pod:1569
24669 " head-n nrlines path\n"
24674 #: ../fish/guestfish-actions.pod:1582
24679 #: ../fish/guestfish-actions.pod:1584
24687 #: ../fish/guestfish-actions.pod:1592
24692 #: ../fish/guestfish-actions.pod:1594
24695 " initrd-cat initrdpath filename\n"
24700 #: ../fish/guestfish-actions.pod:1606
24701 msgid "See also L</initrd-list>."
24705 #: ../fish/guestfish-actions.pod:1611
24706 msgid "initrd-list"
24710 #: ../fish/guestfish-actions.pod:1613
24713 " initrd-list path\n"
24718 #: ../fish/guestfish-actions.pod:1625
24719 msgid "inotify-add-watch"
24723 #: ../fish/guestfish-actions.pod:1627
24726 " inotify-add-watch path mask\n"
24731 #: ../fish/guestfish-actions.pod:1639
24732 msgid "inotify-close"
24736 #: ../fish/guestfish-actions.pod:1641
24744 #: ../fish/guestfish-actions.pod:1647
24745 msgid "inotify-files"
24749 #: ../fish/guestfish-actions.pod:1649
24757 #: ../fish/guestfish-actions.pod:1651
24759 "This function is a helpful wrapper around L</inotify-read> which just "
24760 "returns a list of pathnames of objects that were touched. The returned "
24761 "pathnames are sorted and deduplicated."
24765 #: ../fish/guestfish-actions.pod:1655
24766 msgid "inotify-init"
24770 #: ../fish/guestfish-actions.pod:1657
24773 " inotify-init maxevents\n"
24778 #: ../fish/guestfish-actions.pod:1663
24780 "C<maxevents> is the maximum number of events which will be queued up between"
24781 " calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>,"
24782 " then the kernel (or previously set) default is used. For Linux 2.6.29 the"
24783 " default was 16384 events. Beyond this limit, the kernel throws away "
24784 "events, but records the fact that it threw them away by setting a flag "
24785 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24789 #: ../fish/guestfish-actions.pod:1673
24791 "Before any events are generated, you have to add some watches to the "
24792 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and L"
24793 "</inotify-watch-all>."
24797 #: ../fish/guestfish-actions.pod:1679
24799 "Queued up events should be read periodically by calling L</inotify-read> (or"
24800 " L</inotify-files> which is just a helpful wrapper around L</inotify-read>)."
24801 " If you don't read the events out often enough then you risk the internal "
24802 "queue overflowing."
24806 #: ../fish/guestfish-actions.pod:1686
24808 "The handle should be closed after use by calling L</inotify-close>. This "
24809 "also removes any watches automatically."
24813 #: ../fish/guestfish-actions.pod:1695
24814 msgid "inotify-read"
24818 #: ../fish/guestfish-actions.pod:1697
24826 #: ../fish/guestfish-actions.pod:1710
24827 msgid "inotify-rm-watch"
24831 #: ../fish/guestfish-actions.pod:1712
24834 " inotify-rm-watch wd\n"
24839 #: ../fish/guestfish-actions.pod:1714
24840 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24844 #: ../fish/guestfish-actions.pod:1717
24845 msgid "inspect-get-arch"
24849 #: ../fish/guestfish-actions.pod:1719
24852 " inspect-get-arch root\n"
24857 #: ../fish/guestfish-actions.pod:1721
24859 "This returns the architecture of the inspected operating system. The "
24860 "possible return values are listed under L</file-architecture>."
24864 #: ../fish/guestfish-actions.pod:1730
24865 msgid "inspect-get-distro"
24869 #: ../fish/guestfish-actions.pod:1732
24872 " inspect-get-distro root\n"
24877 #: ../fish/guestfish-actions.pod:1813
24878 msgid "inspect-get-drive-mappings"
24882 #: ../fish/guestfish-actions.pod:1815
24885 " inspect-get-drive-mappings root\n"
24890 #: ../fish/guestfish-actions.pod:1842
24892 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24893 "get-mountpoints>, L</inspect-get-filesystems>."
24897 #: ../fish/guestfish-actions.pod:1846
24898 msgid "inspect-get-filesystems"
24902 #: ../fish/guestfish-actions.pod:1848
24905 " inspect-get-filesystems root\n"
24910 #: ../fish/guestfish-actions.pod:1858
24912 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24913 "get-mountpoints>."
24917 #: ../fish/guestfish-actions.pod:1861
24918 msgid "inspect-get-format"
24922 #: ../fish/guestfish-actions.pod:1863
24925 " inspect-get-format root\n"
24930 #: ../fish/guestfish-actions.pod:1892
24931 msgid "inspect-get-hostname"
24935 #: ../fish/guestfish-actions.pod:1894
24938 " inspect-get-hostname root\n"
24943 #: ../fish/guestfish-actions.pod:1904
24944 msgid "inspect-get-icon"
24948 #: ../fish/guestfish-actions.pod:1906
24951 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24956 #: ../fish/guestfish-actions.pod:1970
24957 msgid "inspect-get-major-version"
24961 #: ../fish/guestfish-actions.pod:1972
24964 " inspect-get-major-version root\n"
24969 #: ../fish/guestfish-actions.pod:1988
24970 msgid "inspect-get-minor-version"
24974 #: ../fish/guestfish-actions.pod:1990
24977 " inspect-get-minor-version root\n"
24982 #: ../fish/guestfish-actions.pod:1997
24984 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24985 "get-major-version>."
24989 #: ../fish/guestfish-actions.pod:2000
24990 msgid "inspect-get-mountpoints"
24994 #: ../fish/guestfish-actions.pod:2002
24997 " inspect-get-mountpoints root\n"
25002 #: ../fish/guestfish-actions.pod:2021
25004 "For operating systems like Windows which still use drive letters, this call "
25005 "will only return an entry for the first drive \"mounted on\" C</>. For "
25006 "information about the mapping of drive letters to partitions, see L"
25007 "</inspect-get-drive-mappings>."
25011 #: ../fish/guestfish-actions.pod:2027
25013 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25014 "get-filesystems>."
25018 #: ../fish/guestfish-actions.pod:2030
25019 msgid "inspect-get-package-format"
25023 #: ../fish/guestfish-actions.pod:2032
25026 " inspect-get-package-format root\n"
25031 #: ../fish/guestfish-actions.pod:2034
25033 "This function and L</inspect-get-package-management> return the package "
25034 "format and package management tool used by the inspected operating system. "
25035 "For example for Fedora these functions would return C<rpm> (package format) "
25036 "and C<yum> (package management)."
25040 #: ../fish/guestfish-actions.pod:2049
25041 msgid "inspect-get-package-management"
25045 #: ../fish/guestfish-actions.pod:2051
25048 " inspect-get-package-management root\n"
25053 #: ../fish/guestfish-actions.pod:2053
25055 "L</inspect-get-package-format> and this function return the package format "
25056 "and package management tool used by the inspected operating system. For "
25057 "example for Fedora these functions would return C<rpm> (package format) and "
25058 "C<yum> (package management)."
25062 #: ../fish/guestfish-actions.pod:2070
25063 msgid "inspect-get-product-name"
25067 #: ../fish/guestfish-actions.pod:2072
25070 " inspect-get-product-name root\n"
25075 #: ../fish/guestfish-actions.pod:2084
25076 msgid "inspect-get-product-variant"
25080 #: ../fish/guestfish-actions.pod:2086
25083 " inspect-get-product-variant root\n"
25088 #: ../fish/guestfish-actions.pod:2107
25090 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25091 "get-product-name>, L</inspect-get-major-version>."
25095 #: ../fish/guestfish-actions.pod:2111
25096 msgid "inspect-get-roots"
25100 #: ../fish/guestfish-actions.pod:2113
25103 " inspect-get-roots\n"
25108 #: ../fish/guestfish-actions.pod:2115
25110 "This function is a convenient way to get the list of root devices, as "
25111 "returned from a previous call to L</inspect-os>, but without redoing the "
25112 "whole inspection process."
25116 #: ../fish/guestfish-actions.pod:2119
25118 "This returns an empty list if either no root devices were found or the "
25119 "caller has not called L</inspect-os>."
25123 #: ../fish/guestfish-actions.pod:2124
25124 msgid "inspect-get-type"
25128 #: ../fish/guestfish-actions.pod:2126
25131 " inspect-get-type root\n"
25136 #: ../fish/guestfish-actions.pod:2156
25137 msgid "inspect-get-windows-current-control-set"
25141 #: ../fish/guestfish-actions.pod:2158
25144 " inspect-get-windows-current-control-set root\n"
25149 #: ../fish/guestfish-actions.pod:2169
25150 msgid "inspect-get-windows-systemroot"
25154 #: ../fish/guestfish-actions.pod:2171
25157 " inspect-get-windows-systemroot root\n"
25162 #: ../fish/guestfish-actions.pod:2182
25163 msgid "inspect-is-live"
25167 #: ../fish/guestfish-actions.pod:2184
25170 " inspect-is-live root\n"
25175 #: ../fish/guestfish-actions.pod:2186
25177 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25178 "then this returns true if a live image was detected on the disk."
25182 #: ../fish/guestfish-actions.pod:2192
25183 msgid "inspect-is-multipart"
25187 #: ../fish/guestfish-actions.pod:2194
25190 " inspect-is-multipart root\n"
25195 #: ../fish/guestfish-actions.pod:2196
25197 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25198 "then this returns true if the disk is part of a set."
25202 #: ../fish/guestfish-actions.pod:2202
25203 msgid "inspect-is-netinst"
25207 #: ../fish/guestfish-actions.pod:2204
25210 " inspect-is-netinst root\n"
25215 #: ../fish/guestfish-actions.pod:2206
25217 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25218 "then this returns true if the disk is a network installer, ie. not a self-"
25219 "contained install CD but one which is likely to require network access to "
25220 "complete the install."
25224 #: ../fish/guestfish-actions.pod:2214
25225 msgid "inspect-list-applications"
25229 #: ../fish/guestfish-actions.pod:2216
25232 " inspect-list-applications root\n"
25237 #: ../fish/guestfish-actions.pod:2220
25239 "I<Note:> This call works differently from other parts of the inspection API."
25240 " You have to call L</inspect-os>, then L</inspect-get-mountpoints>, then "
25241 "mount up the disks, before calling this. Listing applications is a "
25242 "significantly more difficult operation which requires access to the full "
25243 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25244 "are just returning data cached in the libguestfs handle, this call actually "
25245 "reads parts of the mounted filesystems during the call."
25249 #: ../fish/guestfish-actions.pod:2310
25254 #: ../fish/guestfish-actions.pod:2312
25262 #: ../fish/guestfish-actions.pod:2327
25264 "You can pass the root string(s) returned to other L</inspect-get-*> "
25265 "functions in order to query further information about each operating system,"
25266 " such as the name and version."
25270 #: ../fish/guestfish-actions.pod:2332
25272 "This function uses other libguestfs features such as L</mount-ro> and L"
25273 "</umount-all> in order to mount and unmount filesystems and look at the "
25274 "contents. This should be called with no disks currently mounted. The "
25275 "function may also use Augeas, so any existing Augeas handle will be closed."
25279 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542
25280 #: ../fish/guestfish-actions.pod:2601
25281 msgid "See also L</list-filesystems>."
25285 #: ../fish/guestfish-actions.pod:2346
25286 msgid "is-blockdev"
25290 #: ../fish/guestfish-actions.pod:2348
25293 " is-blockdev path\n"
25298 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371
25299 #: ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399
25300 #: ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443
25301 #: ../fish/guestfish-actions.pod:2452
25302 msgid "See also L</stat>."
25306 #: ../fish/guestfish-actions.pod:2355
25311 #: ../fish/guestfish-actions.pod:2357
25319 #: ../fish/guestfish-actions.pod:2364
25324 #: ../fish/guestfish-actions.pod:2366
25327 " is-chardev path\n"
25332 #: ../fish/guestfish-actions.pod:2373
25337 #: ../fish/guestfish-actions.pod:2375
25345 #: ../fish/guestfish-actions.pod:2382
25350 #: ../fish/guestfish-actions.pod:2384
25358 #: ../fish/guestfish-actions.pod:2392
25363 #: ../fish/guestfish-actions.pod:2394
25371 #: ../fish/guestfish-actions.pod:2401
25376 #: ../fish/guestfish-actions.pod:2403
25384 #: ../fish/guestfish-actions.pod:2411
25385 msgid "is-launching"
25389 #: ../fish/guestfish-actions.pod:2413
25397 #: ../fish/guestfish-actions.pod:2420
25402 #: ../fish/guestfish-actions.pod:2422
25410 #: ../fish/guestfish-actions.pod:2427
25415 #: ../fish/guestfish-actions.pod:2429
25423 #: ../fish/guestfish-actions.pod:2436
25428 #: ../fish/guestfish-actions.pod:2438
25431 " is-socket path\n"
25436 #: ../fish/guestfish-actions.pod:2445
25441 #: ../fish/guestfish-actions.pod:2447
25444 " is-symlink path\n"
25449 #: ../fish/guestfish-actions.pod:2454
25454 #: ../fish/guestfish-actions.pod:2456
25462 #: ../fish/guestfish-actions.pod:2461
25463 msgid "is-zero-device"
25467 #: ../fish/guestfish-actions.pod:2463
25470 " is-zero-device device\n"
25475 #: ../fish/guestfish-actions.pod:2469
25476 msgid "kill-subprocess"
25480 #: ../fish/guestfish-actions.pod:2471
25483 " kill-subprocess\n"
25488 #: ../fish/guestfish-actions.pod:2475
25493 #: ../fish/guestfish-actions.pod:2477
25498 #: ../fish/guestfish-actions.pod:2479
25506 #: ../fish/guestfish-actions.pod:2487
25511 #: ../fish/guestfish-actions.pod:2489
25514 " lchown owner group path\n"
25519 #: ../fish/guestfish-actions.pod:2491
25521 "Change the file owner to C<owner> and group to C<group>. This is like "
25522 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
25527 #: ../fish/guestfish-actions.pod:2499
25532 #: ../fish/guestfish-actions.pod:2501
25535 " lgetxattr path name\n"
25540 #: ../fish/guestfish-actions.pod:2517
25541 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25545 #: ../fish/guestfish-actions.pod:2519
25550 #: ../fish/guestfish-actions.pod:2521
25553 " lgetxattrs path\n"
25558 #: ../fish/guestfish-actions.pod:2523
25560 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25561 "it returns the extended attributes of the link itself."
25565 #: ../fish/guestfish-actions.pod:2527
25570 #: ../fish/guestfish-actions.pod:2529
25578 #: ../fish/guestfish-actions.pod:2534
25579 msgid "list-devices"
25583 #: ../fish/guestfish-actions.pod:2536
25591 #: ../fish/guestfish-actions.pod:2544
25592 msgid "list-dm-devices"
25596 #: ../fish/guestfish-actions.pod:2546
25599 " list-dm-devices\n"
25604 #: ../fish/guestfish-actions.pod:2550
25606 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25607 "previous call to L</luks-open>."
25611 #: ../fish/guestfish-actions.pod:2553
25613 "Device mapper devices which correspond to logical volumes are I<not> "
25614 "returned in this list. Call L</lvs> if you want to list logical volumes."
25618 #: ../fish/guestfish-actions.pod:2557
25619 msgid "list-filesystems"
25623 #: ../fish/guestfish-actions.pod:2559
25626 " list-filesystems\n"
25631 #: ../fish/guestfish-actions.pod:2578
25633 "This command runs other libguestfs commands, which might include L</mount> "
25634 "and L</umount>, and therefore you should use this soon after launch and only"
25635 " when nothing is mounted."
25639 #: ../fish/guestfish-actions.pod:2582
25641 "Not all of the filesystems returned will be mountable. In particular, swap "
25642 "partitions are returned in the list. Also this command does not check that "
25643 "each filesystem found is valid and mountable, and some filesystems might be "
25644 "mountable but require special options. Filesystems may not all belong to a "
25645 "single logical operating system (use L</inspect-os> to look for OSes)."
25649 #: ../fish/guestfish-actions.pod:2590
25650 msgid "list-partitions"
25654 #: ../fish/guestfish-actions.pod:2592
25657 " list-partitions\n"
25662 #: ../fish/guestfish-actions.pod:2598
25664 "This does not return logical volumes. For that you will need to call "
25669 #: ../fish/guestfish-actions.pod:2603
25674 #: ../fish/guestfish-actions.pod:2605
25682 #: ../fish/guestfish-actions.pod:2613
25687 #: ../fish/guestfish-actions.pod:2615
25690 " ln target linkname\n"
25695 #: ../fish/guestfish-actions.pod:2619
25700 #: ../fish/guestfish-actions.pod:2621
25703 " ln-f target linkname\n"
25708 #: ../fish/guestfish-actions.pod:2626
25713 #: ../fish/guestfish-actions.pod:2628
25716 " ln-s target linkname\n"
25721 #: ../fish/guestfish-actions.pod:2632
25726 #: ../fish/guestfish-actions.pod:2634
25729 " ln-sf target linkname\n"
25734 #: ../fish/guestfish-actions.pod:2639
25735 msgid "lremovexattr"
25739 #: ../fish/guestfish-actions.pod:2641
25742 " lremovexattr xattr path\n"
25747 #: ../fish/guestfish-actions.pod:2643
25749 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then"
25750 " it removes an extended attribute of the link itself."
25754 #: ../fish/guestfish-actions.pod:2647
25759 #: ../fish/guestfish-actions.pod:2649
25767 #: ../fish/guestfish-actions.pod:2655
25769 "This command is mostly useful for interactive sessions. Programs should "
25770 "probably use L</readdir> instead."
25774 #: ../fish/guestfish-actions.pod:2658
25779 #: ../fish/guestfish-actions.pod:2660
25782 " lsetxattr xattr val vallen path\n"
25787 #: ../fish/guestfish-actions.pod:2662
25789 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it"
25790 " sets an extended attribute of the link itself."
25794 #: ../fish/guestfish-actions.pod:2666
25799 #: ../fish/guestfish-actions.pod:2668
25807 #: ../fish/guestfish-actions.pod:2672
25809 "This is the same as L</stat> except that if C<path> is a symbolic link, then"
25810 " the link is stat-ed, not the file it refers to."
25814 #: ../fish/guestfish-actions.pod:2678
25819 #: ../fish/guestfish-actions.pod:2680
25822 " lstatlist path 'names ...'\n"
25827 #: ../fish/guestfish-actions.pod:2682
25829 "This call allows you to perform the L</lstat> operation on multiple files, "
25830 "where all files are in the directory C<path>. C<names> is the list of files"
25831 " from this directory."
25835 #: ../fish/guestfish-actions.pod:2691
25837 "This call is intended for programs that want to efficiently list a directory"
25838 " contents without making many round-trips. See also L</lxattrlist> for a "
25839 "similarly efficient call for getting extended attributes. Very long "
25840 "directory listings might cause the protocol message size to be exceeded, "
25841 "causing this call to fail. The caller must split up such requests into "
25842 "smaller groups of names."
25846 #: ../fish/guestfish-actions.pod:2699
25847 msgid "luks-add-key"
25851 #: ../fish/guestfish-actions.pod:2701
25854 " luks-add-key device keyslot\n"
25859 #: ../fish/guestfish-actions.pod:2708
25861 "Note that if C<keyslot> already contains a key, then this command will fail."
25862 " You have to use L</luks-kill-slot> first to remove that key."
25866 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734
25867 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761
25868 #: ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
25870 "This command has one or more key or passphrase parameters. Guestfish will "
25871 "prompt for these separately."
25875 #: ../fish/guestfish-actions.pod:2715
25880 #: ../fish/guestfish-actions.pod:2717
25883 " luks-close device\n"
25888 #: ../fish/guestfish-actions.pod:2719
25890 "This closes a LUKS device that was created earlier by L</luks-open> or L"
25891 "</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
25892 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25893 "underlying block device."
25897 #: ../fish/guestfish-actions.pod:2725
25898 msgid "luks-format"
25902 #: ../fish/guestfish-actions.pod:2727
25905 " luks-format device keyslot\n"
25910 #: ../fish/guestfish-actions.pod:2740
25911 msgid "luks-format-cipher"
25915 #: ../fish/guestfish-actions.pod:2742
25918 " luks-format-cipher device keyslot cipher\n"
25923 #: ../fish/guestfish-actions.pod:2744
25925 "This command is the same as L</luks-format> but it also allows you to set "
25926 "the C<cipher> used."
25930 #: ../fish/guestfish-actions.pod:2753
25931 msgid "luks-kill-slot"
25935 #: ../fish/guestfish-actions.pod:2755
25938 " luks-kill-slot device keyslot\n"
25943 #: ../fish/guestfish-actions.pod:2764
25948 #: ../fish/guestfish-actions.pod:2766
25951 " luks-open device mapname\n"
25956 #: ../fish/guestfish-actions.pod:2780
25958 "If this block device contains LVM volume groups, then calling L</vgscan> "
25959 "followed by L</vg-activate-all> will make them visible."
25963 #: ../fish/guestfish-actions.pod:2784
25964 msgid "Use L</list-dm-devices> to list all device mapper devices."
25968 #: ../fish/guestfish-actions.pod:2790
25969 msgid "luks-open-ro"
25973 #: ../fish/guestfish-actions.pod:2792
25976 " luks-open-ro device mapname\n"
25981 #: ../fish/guestfish-actions.pod:2794
25983 "This is the same as L</luks-open> except that a read-only mapping is "
25988 #: ../fish/guestfish-actions.pod:2800
25993 #: ../fish/guestfish-actions.pod:2802
25996 " lvcreate logvol volgroup mbytes\n"
26001 #: ../fish/guestfish-actions.pod:2807
26002 msgid "lvm-canonical-lv-name"
26006 #: ../fish/guestfish-actions.pod:2809
26009 " lvm-canonical-lv-name lvname\n"
26014 #: ../fish/guestfish-actions.pod:2818
26015 msgid "See also L</is-lv>."
26019 #: ../fish/guestfish-actions.pod:2820
26020 msgid "lvm-clear-filter"
26024 #: ../fish/guestfish-actions.pod:2822
26027 " lvm-clear-filter\n"
26032 #: ../fish/guestfish-actions.pod:2824
26034 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every"
26039 #: ../fish/guestfish-actions.pod:2830
26040 msgid "lvm-remove-all"
26044 #: ../fish/guestfish-actions.pod:2832
26047 " lvm-remove-all\n"
26052 #: ../fish/guestfish-actions.pod:2840
26053 msgid "lvm-set-filter"
26057 #: ../fish/guestfish-actions.pod:2842
26060 " lvm-set-filter 'devices ...'\n"
26065 #: ../fish/guestfish-actions.pod:2867
26070 #: ../fish/guestfish-actions.pod:2869
26073 " lvremove device\n"
26078 #: ../fish/guestfish-actions.pod:2877
26083 #: ../fish/guestfish-actions.pod:2879
26086 " lvrename logvol newlogvol\n"
26091 #: ../fish/guestfish-actions.pod:2883
26096 #: ../fish/guestfish-actions.pod:2885
26099 " lvresize device mbytes\n"
26104 #: ../fish/guestfish-actions.pod:2891
26105 msgid "lvresize-free"
26109 #: ../fish/guestfish-actions.pod:2893
26112 " lvresize-free lv percent\n"
26117 #: ../fish/guestfish-actions.pod:2901
26122 #: ../fish/guestfish-actions.pod:2903
26130 #: ../fish/guestfish-actions.pod:2911
26131 msgid "See also L</lvs-full>, L</list-filesystems>."
26135 #: ../fish/guestfish-actions.pod:2913
26140 #: ../fish/guestfish-actions.pod:2915
26148 #: ../fish/guestfish-actions.pod:2920
26153 #: ../fish/guestfish-actions.pod:2922
26161 #: ../fish/guestfish-actions.pod:2926
26166 #: ../fish/guestfish-actions.pod:2928
26169 " lxattrlist path 'names ...'\n"
26174 #: ../fish/guestfish-actions.pod:2944
26176 "This call is intended for programs that want to efficiently list a directory"
26177 " contents without making many round-trips. See also L</lstatlist> for a "
26178 "similarly efficient call for getting standard stats. Very long directory "
26179 "listings might cause the protocol message size to be exceeded, causing this "
26180 "call to fail. The caller must split up such requests into smaller groups of"
26185 #: ../fish/guestfish-actions.pod:2952
26190 #: ../fish/guestfish-actions.pod:2954
26198 #: ../fish/guestfish-actions.pod:2958
26203 #: ../fish/guestfish-actions.pod:2960
26206 " mkdir-mode path mode\n"
26211 #: ../fish/guestfish-actions.pod:2969
26212 msgid "See also L</mkdir>, L</umask>"
26216 #: ../fish/guestfish-actions.pod:2971
26221 #: ../fish/guestfish-actions.pod:2973
26229 #: ../fish/guestfish-actions.pod:2978
26234 #: ../fish/guestfish-actions.pod:2980
26237 " mkdtemp template\n"
26242 #: ../fish/guestfish-actions.pod:3001
26247 #: ../fish/guestfish-actions.pod:3003
26250 " mke2fs-J fstype blocksize device journal\n"
26255 #: ../fish/guestfish-actions.pod:3011
26256 msgid "See also L</mke2journal>."
26260 #: ../fish/guestfish-actions.pod:3013
26265 #: ../fish/guestfish-actions.pod:3015
26268 " mke2fs-JL fstype blocksize device label\n"
26273 #: ../fish/guestfish-actions.pod:3020
26274 msgid "See also L</mke2journal-L>."
26278 #: ../fish/guestfish-actions.pod:3022
26283 #: ../fish/guestfish-actions.pod:3024
26286 " mke2fs-JU fstype blocksize device uuid\n"
26291 #: ../fish/guestfish-actions.pod:3029
26292 msgid "See also L</mke2journal-U>."
26296 #: ../fish/guestfish-actions.pod:3031
26297 msgid "mke2journal"
26301 #: ../fish/guestfish-actions.pod:3033
26304 " mke2journal blocksize device\n"
26309 #: ../fish/guestfish-actions.pod:3040
26310 msgid "mke2journal-L"
26314 #: ../fish/guestfish-actions.pod:3042
26317 " mke2journal-L blocksize label device\n"
26322 #: ../fish/guestfish-actions.pod:3046
26323 msgid "mke2journal-U"
26327 #: ../fish/guestfish-actions.pod:3048
26330 " mke2journal-U blocksize uuid device\n"
26335 #: ../fish/guestfish-actions.pod:3052
26340 #: ../fish/guestfish-actions.pod:3054
26343 " mkfifo mode path\n"
26348 #: ../fish/guestfish-actions.pod:3056
26350 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26351 "is just a convenient wrapper around L</mknod>."
26355 #: ../fish/guestfish-actions.pod:3062
26360 #: ../fish/guestfish-actions.pod:3064
26363 " mkfs fstype device\n"
26368 #: ../fish/guestfish-actions.pod:3070
26373 #: ../fish/guestfish-actions.pod:3072
26376 " mkfs-b fstype blocksize device\n"
26381 #: ../fish/guestfish-actions.pod:3074
26383 "This call is similar to L</mkfs>, but it allows you to control the block "
26384 "size of the resulting filesystem. Supported block sizes depend on the "
26385 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26389 #: ../fish/guestfish-actions.pod:3089
26394 #: ../fish/guestfish-actions.pod:3091
26397 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
26402 #: ../fish/guestfish-actions.pod:3136
26403 msgid "mkmountpoint"
26407 #: ../fish/guestfish-actions.pod:3138
26410 " mkmountpoint exemptpath\n"
26415 #: ../fish/guestfish-actions.pod:3140
26417 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used"
26418 " to create extra mountpoints before mounting the first filesystem."
26422 #: ../fish/guestfish-actions.pod:3164
26424 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26425 "unexpected errors if you try to mix these calls. It is safest to manually "
26426 "unmount filesystems and remove mountpoints after use."
26430 #: ../fish/guestfish-actions.pod:3168
26432 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26433 "for this to work for manual mountpoints, you must ensure that the innermost "
26434 "mountpoints have the longest pathnames, as in the example code above."
26438 #: ../fish/guestfish-actions.pod:3175
26440 "Autosync [see L</set-autosync>, this is set by default on handles] can cause"
26441 " L</umount-all> to be called when the handle is closed which can also "
26442 "trigger these issues."
26446 #: ../fish/guestfish-actions.pod:3179
26451 #: ../fish/guestfish-actions.pod:3181
26454 " mknod mode devmajor devminor path\n"
26459 #: ../fish/guestfish-actions.pod:3191
26461 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26462 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26463 "regular file). These constants are available in the standard Linux header "
26464 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26465 "wrappers around this command which bitwise OR in the appropriate constant "
26470 #: ../fish/guestfish-actions.pod:3201
26475 #: ../fish/guestfish-actions.pod:3203
26478 " mknod-b mode devmajor devminor path\n"
26483 #: ../fish/guestfish-actions.pod:3205
26485 "This call creates a block device node called C<path> with mode C<mode> and "
26486 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26487 "wrapper around L</mknod>."
26491 #: ../fish/guestfish-actions.pod:3211
26496 #: ../fish/guestfish-actions.pod:3213
26499 " mknod-c mode devmajor devminor path\n"
26504 #: ../fish/guestfish-actions.pod:3215
26506 "This call creates a char device node called C<path> with mode C<mode> and "
26507 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26508 "wrapper around L</mknod>."
26512 #: ../fish/guestfish-actions.pod:3221
26517 #: ../fish/guestfish-actions.pod:3223
26525 #: ../fish/guestfish-actions.pod:3227
26530 #: ../fish/guestfish-actions.pod:3229
26533 " mkswap-L label device\n"
26538 #: ../fish/guestfish-actions.pod:3237
26543 #: ../fish/guestfish-actions.pod:3239
26546 " mkswap-U uuid device\n"
26551 #: ../fish/guestfish-actions.pod:3243
26552 msgid "mkswap-file"
26556 #: ../fish/guestfish-actions.pod:3245
26559 " mkswap-file path\n"
26564 #: ../fish/guestfish-actions.pod:3249
26566 "This command just writes a swap file signature to an existing file. To "
26567 "create the file itself, use something like L</fallocate>."
26571 #: ../fish/guestfish-actions.pod:3252
26576 #: ../fish/guestfish-actions.pod:3254
26579 " modprobe modulename\n"
26584 #: ../fish/guestfish-actions.pod:3261
26589 #: ../fish/guestfish-actions.pod:3263
26592 " mount device mountpoint\n"
26597 #: ../fish/guestfish-actions.pod:3279
26599 "B<Important note:> When you use this call, the filesystem options C<sync> "
26600 "and C<noatime> are set implicitly. This was originally done because we "
26601 "thought it would improve reliability, but it turns out that I<-o sync> has a"
26602 " very large negative performance impact and negligible effect on "
26603 "reliability. Therefore we recommend that you avoid using L</mount> in any "
26604 "code that needs performance, and instead use L</mount-options> (use an empty"
26605 " string for the first parameter if you don't want any options)."
26609 #: ../fish/guestfish-actions.pod:3296
26614 #: ../fish/guestfish-actions.pod:3298
26617 " mount-9p mounttag mountpoint [options:..]\n"
26622 #: ../fish/guestfish-actions.pod:3309
26627 #: ../fish/guestfish-actions.pod:3311
26630 " mount-loop file mountpoint\n"
26635 #: ../fish/guestfish-actions.pod:3317
26636 msgid "mount-options"
26640 #: ../fish/guestfish-actions.pod:3319
26643 " mount-options options device mountpoint\n"
26648 #: ../fish/guestfish-actions.pod:3321
26650 "This is the same as the L</mount> command, but it allows you to set the "
26651 "mount options as for the L<mount(8)> I<-o> flag."
26655 #: ../fish/guestfish-actions.pod:3329
26660 #: ../fish/guestfish-actions.pod:3331
26663 " mount-ro device mountpoint\n"
26668 #: ../fish/guestfish-actions.pod:3333
26670 "This is the same as the L</mount> command, but it mounts the filesystem with"
26671 " the read-only (I<-o ro>) flag."
26675 #: ../fish/guestfish-actions.pod:3336
26680 #: ../fish/guestfish-actions.pod:3338
26683 " mount-vfs options vfstype device mountpoint\n"
26688 #: ../fish/guestfish-actions.pod:3340
26690 "This is the same as the L</mount> command, but it allows you to set both the"
26691 " mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26695 #: ../fish/guestfish-actions.pod:3344
26696 msgid "mountpoints"
26700 #: ../fish/guestfish-actions.pod:3346
26708 #: ../fish/guestfish-actions.pod:3348
26710 "This call is similar to L</mounts>. That call returns a list of devices. "
26711 "This one returns a hash table (map) of device name to directory where the "
26712 "device is mounted."
26716 #: ../fish/guestfish-actions.pod:3352
26721 #: ../fish/guestfish-actions.pod:3354
26729 #: ../fish/guestfish-actions.pod:3361
26730 msgid "See also: L</mountpoints>"
26734 #: ../fish/guestfish-actions.pod:3363
26739 #: ../fish/guestfish-actions.pod:3365
26747 #: ../fish/guestfish-actions.pod:3370
26748 msgid "ntfs-3g-probe"
26752 #: ../fish/guestfish-actions.pod:3372
26755 " ntfs-3g-probe true|false device\n"
26760 #: ../fish/guestfish-actions.pod:3386
26765 #: ../fish/guestfish-actions.pod:3388
26768 " ntfsresize device\n"
26773 #: ../fish/guestfish-actions.pod:3410
26774 msgid "ntfsresize-opts"
26778 #: ../fish/guestfish-actions.pod:3412
26781 " ntfsresize-opts device [size:..] [force:..]\n"
26786 #: ../fish/guestfish-actions.pod:3431
26788 "After the resize operation, the filesystem is always marked as requiring a "
26789 "consistency check (for safety). You have to boot into Windows to perform "
26790 "this check and clear this condition. If you I<don't> set the C<force> "
26791 "option then it is not possible to call L</ntfsresize-opts> multiple times on"
26792 " a single filesystem without booting into Windows between each resize."
26796 #: ../fish/guestfish-actions.pod:3444
26797 msgid "ntfsresize-size"
26801 #: ../fish/guestfish-actions.pod:3446
26804 " ntfsresize-size device size\n"
26809 #: ../fish/guestfish-actions.pod:3448
26811 "This command is the same as L</ntfsresize> except that it allows you to "
26812 "specify the new size (in bytes) explicitly."
26816 #: ../fish/guestfish-actions.pod:3458
26821 #: ../fish/guestfish-actions.pod:3460
26824 " part-add device prlogex startsect endsect\n"
26829 #: ../fish/guestfish-actions.pod:3462
26831 "This command adds a partition to C<device>. If there is no partition table "
26832 "on the device, call L</part-init> first."
26836 #: ../fish/guestfish-actions.pod:3474
26838 "Creating a partition which covers the whole disk is not so easy. Use L"
26839 "</part-disk> to do that."
26843 #: ../fish/guestfish-actions.pod:3477
26848 #: ../fish/guestfish-actions.pod:3479
26851 " part-del device partnum\n"
26856 #: ../fish/guestfish-actions.pod:3487
26861 #: ../fish/guestfish-actions.pod:3489
26864 " part-disk device parttype\n"
26869 #: ../fish/guestfish-actions.pod:3491
26871 "This command is simply a combination of L</part-init> followed by L</part-"
26872 "add> to create a single primary partition covering the whole disk."
26876 #: ../fish/guestfish-actions.pod:3495
26878 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other"
26879 " possible values are described in L</part-init>."
26883 #: ../fish/guestfish-actions.pod:3501
26884 msgid "part-get-bootable"
26888 #: ../fish/guestfish-actions.pod:3503
26891 " part-get-bootable device partnum\n"
26896 #: ../fish/guestfish-actions.pod:3508
26897 msgid "See also L</part-set-bootable>."
26901 #: ../fish/guestfish-actions.pod:3510
26902 msgid "part-get-mbr-id"
26906 #: ../fish/guestfish-actions.pod:3512
26909 " part-get-mbr-id device partnum\n"
26914 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3655
26916 "Note that only MBR (old DOS-style) partitions have type bytes. You will get"
26917 " undefined results for other partition table types (see L</part-get-"
26922 #: ../fish/guestfish-actions.pod:3521
26923 msgid "part-get-parttype"
26927 #: ../fish/guestfish-actions.pod:3523
26930 " part-get-parttype device\n"
26935 #: ../fish/guestfish-actions.pod:3528
26937 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26938 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26939 "possible, although unusual. See L</part-init> for a full list."
26943 #: ../fish/guestfish-actions.pod:3533
26948 #: ../fish/guestfish-actions.pod:3535
26951 " part-init device parttype\n"
26956 #: ../fish/guestfish-actions.pod:3541
26958 "Initially there are no partitions. Following this, you should call L</part-"
26959 "add> for each partition required."
26963 #: ../fish/guestfish-actions.pod:3604
26968 #: ../fish/guestfish-actions.pod:3606
26971 " part-list device\n"
26976 #: ../fish/guestfish-actions.pod:3621
26978 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26979 "the device's sector size, see L</blockdev-getss>."
26983 #: ../fish/guestfish-actions.pod:3634
26984 msgid "part-set-bootable"
26988 #: ../fish/guestfish-actions.pod:3636
26991 " part-set-bootable device partnum true|false\n"
26996 #: ../fish/guestfish-actions.pod:3645
26997 msgid "part-set-mbr-id"
27001 #: ../fish/guestfish-actions.pod:3647
27004 " part-set-mbr-id device partnum idbyte\n"
27009 #: ../fish/guestfish-actions.pod:3659
27010 msgid "part-set-name"
27014 #: ../fish/guestfish-actions.pod:3661
27017 " part-set-name device partnum name\n"
27022 #: ../fish/guestfish-actions.pod:3669
27023 msgid "part-to-dev"
27027 #: ../fish/guestfish-actions.pod:3671
27030 " part-to-dev partition\n"
27035 #: ../fish/guestfish-actions.pod:3677
27037 "The named partition must exist, for example as a string returned from L"
27038 "</list-partitions>."
27042 #: ../fish/guestfish-actions.pod:3680
27043 msgid "ping-daemon"
27047 #: ../fish/guestfish-actions.pod:3682
27055 #: ../fish/guestfish-actions.pod:3689
27060 #: ../fish/guestfish-actions.pod:3691
27063 " pread path count offset\n"
27068 #: ../fish/guestfish-actions.pod:3699
27069 msgid "See also L</pwrite>, L</pread-device>."
27073 #: ../fish/guestfish-actions.pod:3704
27074 msgid "pread-device"
27078 #: ../fish/guestfish-actions.pod:3706
27081 " pread-device device count offset\n"
27086 #: ../fish/guestfish-actions.pod:3714
27087 msgid "See also L</pread>."
27091 #: ../fish/guestfish-actions.pod:3719
27096 #: ../fish/guestfish-actions.pod:3721
27099 " pvcreate device\n"
27104 #: ../fish/guestfish-actions.pod:3727
27109 #: ../fish/guestfish-actions.pod:3729
27112 " pvremove device\n"
27117 #: ../fish/guestfish-actions.pod:3738
27122 #: ../fish/guestfish-actions.pod:3740
27125 " pvresize device\n"
27130 #: ../fish/guestfish-actions.pod:3745
27131 msgid "pvresize-size"
27135 #: ../fish/guestfish-actions.pod:3747
27138 " pvresize-size device size\n"
27143 #: ../fish/guestfish-actions.pod:3749
27145 "This command is the same as L</pvresize> except that it allows you to "
27146 "specify the new size (in bytes) explicitly."
27150 #: ../fish/guestfish-actions.pod:3752
27155 #: ../fish/guestfish-actions.pod:3754
27163 #: ../fish/guestfish-actions.pod:3762
27164 msgid "See also L</pvs-full>."
27168 #: ../fish/guestfish-actions.pod:3764
27173 #: ../fish/guestfish-actions.pod:3766
27181 #: ../fish/guestfish-actions.pod:3771
27186 #: ../fish/guestfish-actions.pod:3773
27194 #: ../fish/guestfish-actions.pod:3777
27199 #: ../fish/guestfish-actions.pod:3779
27202 " pwrite path content offset\n"
27207 #: ../fish/guestfish-actions.pod:3790
27208 msgid "See also L</pread>, L</pwrite-device>."
27212 #: ../fish/guestfish-actions.pod:3795
27213 msgid "pwrite-device"
27217 #: ../fish/guestfish-actions.pod:3797
27220 " pwrite-device device content offset\n"
27225 #: ../fish/guestfish-actions.pod:3807
27226 msgid "See also L</pwrite>."
27230 #: ../fish/guestfish-actions.pod:3812
27235 #: ../fish/guestfish-actions.pod:3814
27238 " read-file path\n"
27243 #: ../fish/guestfish-actions.pod:3819
27245 "Unlike L</cat>, this function can correctly handle files that contain "
27246 "embedded ASCII NUL characters. However unlike L</download>, this function "
27247 "is limited in the total size of file that can be handled."
27251 #: ../fish/guestfish-actions.pod:3827
27256 #: ../fish/guestfish-actions.pod:3829
27259 " read-lines path\n"
27264 #: ../fish/guestfish-actions.pod:3836
27266 "Note that this function cannot correctly handle binary files (specifically, "
27267 "files containing C<\\0> character which is treated as end of line). For "
27268 "those you need to use the L</read-file> function which has a more complex "
27273 #: ../fish/guestfish-actions.pod:3841
27278 #: ../fish/guestfish-actions.pod:3843
27286 #: ../fish/guestfish-actions.pod:3895
27288 "This function is primarily intended for use by programs. To get a simple "
27289 "list of names, use L</ls>. To get a printable directory for human "
27290 "consumption, use L</ll>."
27294 #: ../fish/guestfish-actions.pod:3899
27299 #: ../fish/guestfish-actions.pod:3901
27307 #: ../fish/guestfish-actions.pod:3905
27308 msgid "readlinklist"
27312 #: ../fish/guestfish-actions.pod:3907
27315 " readlinklist path 'names ...'\n"
27320 #: ../fish/guestfish-actions.pod:3931
27325 #: ../fish/guestfish-actions.pod:3933
27333 #: ../fish/guestfish-actions.pod:3938
27334 msgid "removexattr"
27338 #: ../fish/guestfish-actions.pod:3940
27341 " removexattr xattr path\n"
27346 #: ../fish/guestfish-actions.pod:3945
27347 msgid "See also: L</lremovexattr>, L<attr(5)>."
27351 #: ../fish/guestfish-actions.pod:3947
27356 #: ../fish/guestfish-actions.pod:3949
27359 " resize2fs device\n"
27364 #: ../fish/guestfish-actions.pod:3954
27366 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device>"
27367 " before calling this command. For unknown reasons C<resize2fs> sometimes "
27368 "gives an error about this and sometimes not. In any case, it is always safe"
27369 " to call L</e2fsck-f> before calling this function."
27373 #: ../fish/guestfish-actions.pod:3960
27374 msgid "resize2fs-M"
27378 #: ../fish/guestfish-actions.pod:3962
27381 " resize2fs-M device\n"
27386 #: ../fish/guestfish-actions.pod:3964
27388 "This command is the same as L</resize2fs>, but the filesystem is resized to "
27389 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
27394 #: ../fish/guestfish-actions.pod:3968
27396 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
27397 "and read the C<Block size> and C<Block count> values. These two numbers, "
27398 "multiplied together, give the resulting size of the minimal filesystem in "
27403 #: ../fish/guestfish-actions.pod:3973
27404 msgid "resize2fs-size"
27408 #: ../fish/guestfish-actions.pod:3975
27411 " resize2fs-size device size\n"
27416 #: ../fish/guestfish-actions.pod:3977
27418 "This command is the same as L</resize2fs> except that it allows you to "
27419 "specify the new size (in bytes) explicitly."
27423 #: ../fish/guestfish-actions.pod:3980
27428 #: ../fish/guestfish-actions.pod:3982
27436 #: ../fish/guestfish-actions.pod:3986
27441 #: ../fish/guestfish-actions.pod:3988
27449 #: ../fish/guestfish-actions.pod:3994
27454 #: ../fish/guestfish-actions.pod:3996
27462 #: ../fish/guestfish-actions.pod:4000
27463 msgid "rmmountpoint"
27467 #: ../fish/guestfish-actions.pod:4002
27470 " rmmountpoint exemptpath\n"
27475 #: ../fish/guestfish-actions.pod:4004
27477 "This calls removes a mountpoint that was previously created with "
27478 "L</mkmountpoint>. See L</mkmountpoint> for full details."
27482 #: ../fish/guestfish-actions.pod:4008
27483 msgid "scrub-device"
27487 #: ../fish/guestfish-actions.pod:4010
27490 " scrub-device device\n"
27495 #: ../fish/guestfish-actions.pod:4021
27500 #: ../fish/guestfish-actions.pod:4023
27503 " scrub-file file\n"
27508 #: ../fish/guestfish-actions.pod:4033
27509 msgid "scrub-freespace"
27513 #: ../fish/guestfish-actions.pod:4035
27516 " scrub-freespace dir\n"
27521 #: ../fish/guestfish-actions.pod:4037
27523 "This command creates the directory C<dir> and then fills it with files until"
27524 " the filesystem is full, and scrubs the files as for L</scrub-file>, and "
27525 "deletes them. The intention is to scrub any free space on the partition "
27526 "containing C<dir>."
27530 #: ../fish/guestfish-actions.pod:4046
27535 #: ../fish/guestfish-actions.pod:4048
27540 #: ../fish/guestfish-actions.pod:4050
27543 " set-append append\n"
27548 #: ../fish/guestfish-actions.pod:4061
27549 msgid "set-attach-method"
27553 #: ../fish/guestfish-actions.pod:4063
27554 msgid "attach-method"
27558 #: ../fish/guestfish-actions.pod:4065
27561 " set-attach-method attachmethod\n"
27566 #: ../fish/guestfish-actions.pod:4087
27567 msgid "set-autosync"
27571 #: ../fish/guestfish-actions.pod:4089
27576 #: ../fish/guestfish-actions.pod:4091
27579 " set-autosync true|false\n"
27584 #: ../fish/guestfish-actions.pod:4101
27589 #: ../fish/guestfish-actions.pod:4103
27594 #: ../fish/guestfish-actions.pod:4105
27597 " set-direct true|false\n"
27602 #: ../fish/guestfish-actions.pod:4111
27604 "One consequence of this is that log messages aren't caught by the library "
27605 "and handled by L</set-log-message-callback>, but go straight to stdout."
27609 #: ../fish/guestfish-actions.pod:4120
27610 msgid "set-e2label"
27614 #: ../fish/guestfish-actions.pod:4122
27617 " set-e2label device label\n"
27622 #: ../fish/guestfish-actions.pod:4128
27624 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
27625 "label on a filesystem."
27629 #: ../fish/guestfish-actions.pod:4131
27634 #: ../fish/guestfish-actions.pod:4133
27637 " set-e2uuid device uuid\n"
27642 #: ../fish/guestfish-actions.pod:4140
27644 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
27645 "UUID of a filesystem."
27649 #: ../fish/guestfish-actions.pod:4143
27650 msgid "set-memsize"
27654 #: ../fish/guestfish-actions.pod:4145
27659 #: ../fish/guestfish-actions.pod:4147
27662 " set-memsize memsize\n"
27667 #: ../fish/guestfish-actions.pod:4149
27669 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27670 "This only has any effect if called before L</launch>."
27674 #: ../fish/guestfish-actions.pod:4160
27675 msgid "set-network"
27679 #: ../fish/guestfish-actions.pod:4162
27684 #: ../fish/guestfish-actions.pod:4164
27687 " set-network true|false\n"
27692 #: ../fish/guestfish-actions.pod:4172
27694 "You must call this before calling L</launch>, otherwise it has no effect."
27698 #: ../fish/guestfish-actions.pod:4175
27703 #: ../fish/guestfish-actions.pod:4177
27708 #: ../fish/guestfish-actions.pod:4179
27711 " set-path searchpath\n"
27716 #: ../fish/guestfish-actions.pod:4188
27721 #: ../fish/guestfish-actions.pod:4190
27726 #: ../fish/guestfish-actions.pod:4192
27729 " set-pgroup true|false\n"
27734 #: ../fish/guestfish-actions.pod:4203
27739 #: ../fish/guestfish-actions.pod:4205
27744 #: ../fish/guestfish-actions.pod:4207
27752 #: ../fish/guestfish-actions.pod:4227
27753 msgid "set-recovery-proc"
27757 #: ../fish/guestfish-actions.pod:4229
27758 msgid "recovery-proc"
27762 #: ../fish/guestfish-actions.pod:4231
27765 " set-recovery-proc true|false\n"
27770 #: ../fish/guestfish-actions.pod:4233
27772 "If this is called with the parameter C<false> then L</launch> does not "
27773 "create a recovery process. The purpose of the recovery process is to stop "
27774 "runaway qemu processes in the case where the main program aborts abruptly."
27778 #: ../fish/guestfish-actions.pod:4238
27780 "This only has any effect if called before L</launch>, and the default is "
27785 #: ../fish/guestfish-actions.pod:4247
27786 msgid "set-selinux"
27790 #: ../fish/guestfish-actions.pod:4249
27795 #: ../fish/guestfish-actions.pod:4251
27798 " set-selinux true|false\n"
27803 #: ../fish/guestfish-actions.pod:4262
27808 #: ../fish/guestfish-actions.pod:4264
27813 #: ../fish/guestfish-actions.pod:4266
27816 " set-trace true|false\n"
27821 #: ../fish/guestfish-actions.pod:4278
27823 "Trace messages are normally sent to C<stderr>, unless you register a "
27824 "callback to send them somewhere else (see L</set-event-callback>)."
27828 #: ../fish/guestfish-actions.pod:4282
27829 msgid "set-verbose"
27833 #: ../fish/guestfish-actions.pod:4284
27838 #: ../fish/guestfish-actions.pod:4286
27841 " set-verbose true|false\n"
27846 #: ../fish/guestfish-actions.pod:4293
27848 "Verbose messages are normally sent to C<stderr>, unless you register a "
27849 "callback to send them somewhere else (see L</set-event-callback>)."
27853 #: ../fish/guestfish-actions.pod:4297
27858 #: ../fish/guestfish-actions.pod:4299
27861 " setcon context\n"
27866 #: ../fish/guestfish-actions.pod:4306
27871 #: ../fish/guestfish-actions.pod:4308
27874 " setxattr xattr val vallen path\n"
27879 #: ../fish/guestfish-actions.pod:4314
27880 msgid "See also: L</lsetxattr>, L<attr(5)>."
27884 #: ../fish/guestfish-actions.pod:4316
27889 #: ../fish/guestfish-actions.pod:4318
27892 " sfdisk device cyls heads sectors 'lines ...'\n"
27897 #: ../fish/guestfish-actions.pod:4340
27898 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27902 #: ../fish/guestfish-actions.pod:4353
27907 #: ../fish/guestfish-actions.pod:4355
27910 " sfdiskM device 'lines ...'\n"
27915 #: ../fish/guestfish-actions.pod:4357
27917 "This is a simplified interface to the L</sfdisk> command, where partition "
27918 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27919 "you don't need to specify the cyls, heads and sectors parameters which were "
27920 "rarely if ever used anyway."
27924 #: ../fish/guestfish-actions.pod:4363
27925 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27929 #: ../fish/guestfish-actions.pod:4376
27934 #: ../fish/guestfish-actions.pod:4378
27937 " sfdisk-N device partnum cyls heads sectors line\n"
27942 #: ../fish/guestfish-actions.pod:4383
27944 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27945 "cyls/heads/sectors parameters."
27949 #: ../fish/guestfish-actions.pod:4386
27950 msgid "See also: L</part-add>"
27954 #: ../fish/guestfish-actions.pod:4398
27955 msgid "sfdisk-disk-geometry"
27959 #: ../fish/guestfish-actions.pod:4400
27962 " sfdisk-disk-geometry device\n"
27967 #: ../fish/guestfish-actions.pod:4402
27969 "This displays the disk geometry of C<device> read from the partition table."
27970 " Especially in the case where the underlying block device has been resized,"
27971 " this can be different from the kernel's idea of the geometry (see L"
27972 "</sfdisk-kernel-geometry>)."
27976 #: ../fish/guestfish-actions.pod:4410
27977 msgid "sfdisk-kernel-geometry"
27981 #: ../fish/guestfish-actions.pod:4412
27984 " sfdisk-kernel-geometry device\n"
27989 #: ../fish/guestfish-actions.pod:4419
27994 #: ../fish/guestfish-actions.pod:4421
27997 " sfdisk-l device\n"
28002 #: ../fish/guestfish-actions.pod:4427
28003 msgid "See also: L</part-list>"
28007 #: ../fish/guestfish-actions.pod:4436
28012 #: ../fish/guestfish-actions.pod:4438
28020 #: ../fish/guestfish-actions.pod:4443
28021 msgid "This is like L</command>, but passes the command to:"
28025 #: ../fish/guestfish-actions.pod:4451
28026 msgid "All the provisos about L</command> apply to this call."
28030 #: ../fish/guestfish-actions.pod:4453
28035 #: ../fish/guestfish-actions.pod:4455
28038 " sh-lines command\n"
28043 #: ../fish/guestfish-actions.pod:4457
28045 "This is the same as L</sh>, but splits the result into a list of lines."
28049 #: ../fish/guestfish-actions.pod:4460
28050 msgid "See also: L</command-lines>"
28054 #: ../fish/guestfish-actions.pod:4462
28059 #: ../fish/guestfish-actions.pod:4464
28067 #: ../fish/guestfish-actions.pod:4468
28072 #: ../fish/guestfish-actions.pod:4470
28080 #: ../fish/guestfish-actions.pod:4476
28085 #: ../fish/guestfish-actions.pod:4478
28093 #: ../fish/guestfish-actions.pod:4486
28098 #: ../fish/guestfish-actions.pod:4488
28106 #: ../fish/guestfish-actions.pod:4496
28111 #: ../fish/guestfish-actions.pod:4498
28114 " strings-e encoding path\n"
28119 #: ../fish/guestfish-actions.pod:4500
28121 "This is like the L</strings> command, but allows you to specify the encoding"
28122 " of strings that are looked for in the source file C<path>."
28126 #: ../fish/guestfish-actions.pod:4510
28128 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28129 "ISO-8859-X (this is what L</strings> uses)."
28133 #: ../fish/guestfish-actions.pod:4542
28134 msgid "swapoff-device"
28138 #: ../fish/guestfish-actions.pod:4544
28141 " swapoff-device device\n"
28146 #: ../fish/guestfish-actions.pod:4546
28148 "This command disables the libguestfs appliance swap device or partition "
28149 "named C<device>. See L</swapon-device>."
28153 #: ../fish/guestfish-actions.pod:4550
28154 msgid "swapoff-file"
28158 #: ../fish/guestfish-actions.pod:4552
28161 " swapoff-file file\n"
28166 #: ../fish/guestfish-actions.pod:4556
28167 msgid "swapoff-label"
28171 #: ../fish/guestfish-actions.pod:4558
28174 " swapoff-label label\n"
28179 #: ../fish/guestfish-actions.pod:4563
28180 msgid "swapoff-uuid"
28184 #: ../fish/guestfish-actions.pod:4565
28187 " swapoff-uuid uuid\n"
28192 #: ../fish/guestfish-actions.pod:4570
28193 msgid "swapon-device"
28197 #: ../fish/guestfish-actions.pod:4572
28200 " swapon-device device\n"
28205 #: ../fish/guestfish-actions.pod:4574
28207 "This command enables the libguestfs appliance to use the swap device or "
28208 "partition named C<device>. The increased memory is made available for all "
28209 "commands, for example those run using L</command> or L</sh>."
28213 #: ../fish/guestfish-actions.pod:4586
28214 msgid "swapon-file"
28218 #: ../fish/guestfish-actions.pod:4588
28221 " swapon-file file\n"
28226 #: ../fish/guestfish-actions.pod:4590
28228 "This command enables swap to a file. See L</swapon-device> for other notes."
28232 #: ../fish/guestfish-actions.pod:4593
28233 msgid "swapon-label"
28237 #: ../fish/guestfish-actions.pod:4595
28240 " swapon-label label\n"
28245 #: ../fish/guestfish-actions.pod:4597
28247 "This command enables swap to a labeled swap partition. See L</swapon-"
28248 "device> for other notes."
28252 #: ../fish/guestfish-actions.pod:4600
28253 msgid "swapon-uuid"
28257 #: ../fish/guestfish-actions.pod:4602
28260 " swapon-uuid uuid\n"
28265 #: ../fish/guestfish-actions.pod:4604
28267 "This command enables swap to a swap partition with the given UUID. See L"
28268 "</swapon-device> for other notes."
28272 #: ../fish/guestfish-actions.pod:4607
28277 #: ../fish/guestfish-actions.pod:4609
28285 #: ../fish/guestfish-actions.pod:4617
28290 #: ../fish/guestfish-actions.pod:4619
28298 #: ../fish/guestfish-actions.pod:4627
28303 #: ../fish/guestfish-actions.pod:4629
28306 " tail-n nrlines path\n"
28311 #: ../fish/guestfish-actions.pod:4642
28316 #: ../fish/guestfish-actions.pod:4644
28319 " tar-in (tarfile|-) directory\n"
28324 #: ../fish/guestfish-actions.pod:4649
28325 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
28329 #: ../fish/guestfish-actions.pod:4654
28334 #: ../fish/guestfish-actions.pod:4656
28337 " tar-out directory (tarfile|-)\n"
28342 #: ../fish/guestfish-actions.pod:4661
28343 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
28347 #: ../fish/guestfish-actions.pod:4666
28352 #: ../fish/guestfish-actions.pod:4668
28355 " tgz-in (tarball|-) directory\n"
28360 #: ../fish/guestfish-actions.pod:4673
28361 msgid "To upload an uncompressed tarball, use L</tar-in>."
28365 #: ../fish/guestfish-actions.pod:4677
28370 #: ../fish/guestfish-actions.pod:4679
28373 " tgz-out directory (tarball|-)\n"
28378 #: ../fish/guestfish-actions.pod:4684
28379 msgid "To download an uncompressed tarball, use L</tar-out>."
28383 #: ../fish/guestfish-actions.pod:4688
28388 #: ../fish/guestfish-actions.pod:4690
28396 #: ../fish/guestfish-actions.pod:4699
28401 #: ../fish/guestfish-actions.pod:4701
28409 #: ../fish/guestfish-actions.pod:4706
28410 msgid "truncate-size"
28414 #: ../fish/guestfish-actions.pod:4708
28417 " truncate-size path size\n"
28422 #: ../fish/guestfish-actions.pod:4713
28424 "If the current file size is less than C<size> then the file is extended to "
28425 "the required size with zero bytes. This creates a sparse file (ie. disk "
28426 "blocks are not allocated for the file until you write to it). To create a "
28427 "non-sparse file of zeroes, use L</fallocate64> instead."
28431 #: ../fish/guestfish-actions.pod:4719
28436 #: ../fish/guestfish-actions.pod:4721
28439 " tune2fs-l device\n"
28444 #: ../fish/guestfish-actions.pod:4731
28449 #: ../fish/guestfish-actions.pod:4733
28452 " txz-in (tarball|-) directory\n"
28457 #: ../fish/guestfish-actions.pod:4740
28462 #: ../fish/guestfish-actions.pod:4742
28465 " txz-out directory (tarball|-)\n"
28470 #: ../fish/guestfish-actions.pod:4749
28475 #: ../fish/guestfish-actions.pod:4751
28483 #: ../fish/guestfish-actions.pod:4765
28484 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
28488 #: ../fish/guestfish-actions.pod:4770
28493 #: ../fish/guestfish-actions.pod:4772
28498 #: ../fish/guestfish-actions.pod:4774
28501 " umount pathordevice\n"
28506 #: ../fish/guestfish-actions.pod:4780
28511 #: ../fish/guestfish-actions.pod:4782
28512 msgid "unmount-all"
28516 #: ../fish/guestfish-actions.pod:4784
28524 #: ../fish/guestfish-actions.pod:4790
28529 #: ../fish/guestfish-actions.pod:4792
28532 " upload (filename|-) remotefilename\n"
28537 #: ../fish/guestfish-actions.pod:4799
28538 msgid "See also L</download>."
28542 #: ../fish/guestfish-actions.pod:4803
28543 msgid "upload-offset"
28547 #: ../fish/guestfish-actions.pod:4805
28550 " upload-offset (filename|-) remotefilename offset\n"
28555 #: ../fish/guestfish-actions.pod:4817
28557 "Note that there is no limit on the amount of data that can be uploaded with "
28558 "this call, unlike with L</pwrite>, and this call always writes the full "
28559 "amount unless an error occurs."
28563 #: ../fish/guestfish-actions.pod:4822
28564 msgid "See also L</upload>, L</pwrite>."
28568 #: ../fish/guestfish-actions.pod:4826
28573 #: ../fish/guestfish-actions.pod:4828
28576 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
28581 #: ../fish/guestfish-actions.pod:4847
28586 #: ../fish/guestfish-actions.pod:4849
28594 #: ../fish/guestfish-actions.pod:4876
28596 "I<Note:> Don't use this call to test for availability of features. In "
28597 "enterprise distributions we backport features from later versions into "
28598 "earlier versions, making this an unreliable way to test for features. Use "
28599 "L</available> instead."
28603 #: ../fish/guestfish-actions.pod:4882
28608 #: ../fish/guestfish-actions.pod:4884
28611 " vfs-label device\n"
28616 #: ../fish/guestfish-actions.pod:4891
28617 msgid "To find a filesystem from the label, use L</findfs-label>."
28621 #: ../fish/guestfish-actions.pod:4893
28626 #: ../fish/guestfish-actions.pod:4895
28629 " vfs-type device\n"
28634 #: ../fish/guestfish-actions.pod:4905
28639 #: ../fish/guestfish-actions.pod:4907
28642 " vfs-uuid device\n"
28647 #: ../fish/guestfish-actions.pod:4914
28648 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
28652 #: ../fish/guestfish-actions.pod:4916
28653 msgid "vg-activate"
28657 #: ../fish/guestfish-actions.pod:4918
28660 " vg-activate true|false 'volgroups ...'\n"
28665 #: ../fish/guestfish-actions.pod:4928
28666 msgid "vg-activate-all"
28670 #: ../fish/guestfish-actions.pod:4930
28673 " vg-activate-all true|false\n"
28678 #: ../fish/guestfish-actions.pod:4937
28683 #: ../fish/guestfish-actions.pod:4939
28686 " vgcreate volgroup 'physvols ...'\n"
28691 #: ../fish/guestfish-actions.pod:4944
28696 #: ../fish/guestfish-actions.pod:4946
28699 " vglvuuids vgname\n"
28704 #: ../fish/guestfish-actions.pod:4951
28706 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28707 "logical volumes and volume groups."
28711 #: ../fish/guestfish-actions.pod:4954
28712 msgid "See also L</vgpvuuids>."
28716 #: ../fish/guestfish-actions.pod:4956
28721 #: ../fish/guestfish-actions.pod:4958
28724 " vgpvuuids vgname\n"
28729 #: ../fish/guestfish-actions.pod:4963
28731 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28732 "physical volumes and volume groups."
28736 #: ../fish/guestfish-actions.pod:4966
28737 msgid "See also L</vglvuuids>."
28741 #: ../fish/guestfish-actions.pod:4968
28746 #: ../fish/guestfish-actions.pod:4970
28749 " vgremove vgname\n"
28754 #: ../fish/guestfish-actions.pod:4977
28759 #: ../fish/guestfish-actions.pod:4979
28762 " vgrename volgroup newvolgroup\n"
28767 #: ../fish/guestfish-actions.pod:4983
28772 #: ../fish/guestfish-actions.pod:4985
28780 #: ../fish/guestfish-actions.pod:4993
28781 msgid "See also L</vgs-full>."
28785 #: ../fish/guestfish-actions.pod:4995
28790 #: ../fish/guestfish-actions.pod:4997
28798 #: ../fish/guestfish-actions.pod:5002
28803 #: ../fish/guestfish-actions.pod:5004
28811 #: ../fish/guestfish-actions.pod:5009
28816 #: ../fish/guestfish-actions.pod:5011
28824 #: ../fish/guestfish-actions.pod:5015
28829 #: ../fish/guestfish-actions.pod:5017
28837 #: ../fish/guestfish-actions.pod:5022
28842 #: ../fish/guestfish-actions.pod:5024
28850 #: ../fish/guestfish-actions.pod:5029
28855 #: ../fish/guestfish-actions.pod:5031
28863 #: ../fish/guestfish-actions.pod:5036
28868 #: ../fish/guestfish-actions.pod:5038
28871 " write path content\n"
28876 #: ../fish/guestfish-actions.pod:5043
28877 msgid "See also L</write-append>."
28881 #: ../fish/guestfish-actions.pod:5048
28882 msgid "write-append"
28886 #: ../fish/guestfish-actions.pod:5050
28889 " write-append path content\n"
28894 #: ../fish/guestfish-actions.pod:5055
28895 msgid "See also L</write>."
28899 #: ../fish/guestfish-actions.pod:5060
28904 #: ../fish/guestfish-actions.pod:5062
28907 " write-file path content size\n"
28912 #: ../fish/guestfish-actions.pod:5085
28917 #: ../fish/guestfish-actions.pod:5087
28920 " zegrep regex path\n"
28925 #: ../fish/guestfish-actions.pod:5095
28930 #: ../fish/guestfish-actions.pod:5097
28933 " zegrepi regex path\n"
28938 #: ../fish/guestfish-actions.pod:5105
28943 #: ../fish/guestfish-actions.pod:5107
28951 #: ../fish/guestfish-actions.pod:5115
28952 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28956 #: ../fish/guestfish-actions.pod:5118
28957 msgid "zero-device"
28961 #: ../fish/guestfish-actions.pod:5120
28964 " zero-device device\n"
28969 #: ../fish/guestfish-actions.pod:5122
28971 "This command writes zeroes over the entire C<device>. Compare with L</zero>"
28972 " which just zeroes the first few blocks of a device."
28976 #: ../fish/guestfish-actions.pod:5129
28981 #: ../fish/guestfish-actions.pod:5131
28984 " zerofree device\n"
28989 #: ../fish/guestfish-actions.pod:5144
28994 #: ../fish/guestfish-actions.pod:5146
28997 " zfgrep pattern path\n"
29002 #: ../fish/guestfish-actions.pod:5154
29007 #: ../fish/guestfish-actions.pod:5156
29010 " zfgrepi pattern path\n"
29015 #: ../fish/guestfish-actions.pod:5164
29020 #: ../fish/guestfish-actions.pod:5166
29023 " zfile meth path\n"
29028 #: ../fish/guestfish-actions.pod:5173
29030 "Since 1.0.63, use L</file> instead which can now process compressed files."
29034 #: ../fish/guestfish-actions.pod:5183
29039 #: ../fish/guestfish-actions.pod:5185
29042 " zgrep regex path\n"
29047 #: ../fish/guestfish-actions.pod:5193
29052 #: ../fish/guestfish-actions.pod:5195
29055 " zgrepi regex path\n"
29060 #: ../fish/guestfish-commands.pod:1
29065 #: ../fish/guestfish-commands.pod:3
29070 #: ../fish/guestfish-commands.pod:5
29073 " alloc filename size\n"
29078 #: ../fish/guestfish-commands.pod:7
29080 "This creates an empty (zeroed) file of the given size, and then adds so it "
29081 "can be further examined."
29085 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
29086 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29090 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
29091 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29095 #: ../fish/guestfish-commands.pod:14
29097 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29098 "image, see L</PREPARED DISK IMAGES>."
29102 #: ../fish/guestfish-commands.pod:17
29107 #: ../fish/guestfish-commands.pod:19
29110 " copy-in local [local ...] /remotedir\n"
29115 #: ../fish/guestfish-commands.pod:21
29117 "C<copy-in> copies local files or directories recursively into the disk "
29118 "image, placing them in the directory called C</remotedir> (which must "
29119 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and"
29120 " other commands as necessary."
29124 #: ../fish/guestfish-commands.pod:26
29126 "Multiple local files and directories can be specified, but the last "
29127 "parameter must always be a remote directory. Wildcards cannot be used."
29131 #: ../fish/guestfish-commands.pod:30
29136 #: ../fish/guestfish-commands.pod:32
29139 " copy-out remote [remote ...] localdir\n"
29144 #: ../fish/guestfish-commands.pod:34
29146 "C<copy-out> copies remote files or directories recursively out of the disk "
29147 "image, placing them on the host disk in a local directory called C<localdir>"
29148 " (which must exist). This guestfish meta-command turns into a sequence of "
29149 "L</download>, L</tar-out> and other commands as necessary."
29153 #: ../fish/guestfish-commands.pod:40
29155 "Multiple remote files and directories can be specified, but the last "
29156 "parameter must always be a local directory. To download to the current "
29157 "directory, use C<.> as in:"
29161 #: ../fish/guestfish-commands.pod:44
29164 " copy-out /home .\n"
29169 #: ../fish/guestfish-commands.pod:46
29171 "Wildcards cannot be used in the ordinary command, but you can use them with "
29172 "the help of L</glob> like this:"
29176 #: ../fish/guestfish-commands.pod:49
29179 " glob copy-out /home/* .\n"
29184 #: ../fish/guestfish-commands.pod:51
29189 #: ../fish/guestfish-commands.pod:53
29192 " display filename\n"
29197 #: ../fish/guestfish-commands.pod:55
29199 "Use C<display> (a graphical display program) to display an image file. It "
29200 "downloads the file, and runs C<display> on it."
29204 #: ../fish/guestfish-commands.pod:58
29206 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
29207 "environment variable. For example to use the GNOME display program:"
29211 #: ../fish/guestfish-commands.pod:61
29214 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
29219 #: ../fish/guestfish-commands.pod:63
29220 msgid "See also L<display(1)>."
29224 #: ../fish/guestfish-commands.pod:65
29229 #: ../fish/guestfish-commands.pod:67
29232 " echo [params ...]\n"
29237 #: ../fish/guestfish-commands.pod:69
29238 msgid "This echos the parameters to the terminal."
29242 #: ../fish/guestfish-commands.pod:71
29247 #: ../fish/guestfish-commands.pod:73
29252 #: ../fish/guestfish-commands.pod:75
29257 #: ../fish/guestfish-commands.pod:77
29265 #: ../fish/guestfish-commands.pod:79
29267 "This is used to edit a file. It downloads the file, edits it locally using "
29268 "your editor, then uploads the result."
29272 #: ../fish/guestfish-commands.pod:82
29274 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
29275 "or C<emacs> you will get those corresponding editors."
29279 #: ../fish/guestfish-commands.pod:86
29284 #: ../fish/guestfish-commands.pod:88
29287 " glob command args...\n"
29292 #: ../fish/guestfish-commands.pod:90
29294 "Expand wildcards in any paths in the args list, and run C<command> "
29295 "repeatedly on each matching path."
29299 #: ../fish/guestfish-commands.pod:93
29300 msgid "See L</WILDCARDS AND GLOBBING>."
29304 #: ../fish/guestfish-commands.pod:95
29309 #: ../fish/guestfish-commands.pod:97
29312 " hexedit <filename|device>\n"
29313 " hexedit <filename|device> <max>\n"
29314 " hexedit <filename|device> <start> <max>\n"
29319 #: ../fish/guestfish-commands.pod:101
29321 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
29326 #: ../fish/guestfish-commands.pod:104
29328 "This command works by downloading potentially the whole file or device, "
29329 "editing it locally, then uploading it. If the file or device is large, you "
29330 "have to specify which part you wish to edit by using C<max> and/or C<start> "
29331 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
29332 "usual modifiers allowed such as C<1M> (1 megabyte)."
29336 #: ../fish/guestfish-commands.pod:111
29337 msgid "For example to edit the first few sectors of a disk you might do:"
29341 #: ../fish/guestfish-commands.pod:114
29344 " hexedit /dev/sda 1M\n"
29349 #: ../fish/guestfish-commands.pod:116
29351 "which would allow you to edit anywhere within the first megabyte of the "
29356 #: ../fish/guestfish-commands.pod:119
29357 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
29361 #: ../fish/guestfish-commands.pod:121
29364 " hexedit /dev/sda1 0x400 0x400\n"
29369 #: ../fish/guestfish-commands.pod:123
29370 msgid "(assuming the superblock is in the standard location)."
29374 #: ../fish/guestfish-commands.pod:125
29376 "This command requires the external L<hexedit(1)> program. You can specify "
29377 "another program to use by setting the C<HEXEDITOR> environment variable."
29381 #: ../fish/guestfish-commands.pod:129
29382 msgid "See also L</hexdump>."
29386 #: ../fish/guestfish-commands.pod:131
29391 #: ../fish/guestfish-commands.pod:133
29399 #: ../fish/guestfish-commands.pod:135
29401 "Change the local directory, ie. the current directory of guestfish itself."
29405 #: ../fish/guestfish-commands.pod:138
29406 msgid "Note that C<!cd> won't do what you might expect."
29410 #: ../fish/guestfish-commands.pod:140
29415 #: ../fish/guestfish-commands.pod:142
29420 #: ../fish/guestfish-commands.pod:144
29428 #: ../fish/guestfish-commands.pod:146
29429 msgid "Opens the manual page for guestfish."
29433 #: ../fish/guestfish-commands.pod:148
29438 #: ../fish/guestfish-commands.pod:150
29443 #: ../fish/guestfish-commands.pod:152
29451 #: ../fish/guestfish-commands.pod:154
29459 #: ../fish/guestfish-commands.pod:156
29460 msgid "This is used to view a file."
29464 #: ../fish/guestfish-commands.pod:158
29466 "The default viewer is C<$PAGER>. However if you use the alternate command "
29467 "C<less> you will get the C<less> command specifically."
29471 #: ../fish/guestfish-commands.pod:161
29476 #: ../fish/guestfish-commands.pod:163
29484 #: ../fish/guestfish-commands.pod:165
29486 "Close and reopen the libguestfs handle. It is not necessary to use this "
29487 "normally, because the handle is closed properly when guestfish exits. "
29488 "However this is occasionally useful for testing."
29492 #: ../fish/guestfish-commands.pod:169
29497 #: ../fish/guestfish-commands.pod:171
29500 " sparse filename size\n"
29505 #: ../fish/guestfish-commands.pod:173
29507 "This creates an empty sparse file of the given size, and then adds so it can"
29508 " be further examined."
29512 #: ../fish/guestfish-commands.pod:176
29514 "In all respects it works the same as the L</alloc> command, except that the "
29515 "image file is allocated sparsely, which means that disk blocks are not "
29516 "assigned to the file until they are needed. Sparse disk files only use "
29517 "space when written to, but they are slower and there is a danger you could "
29518 "run out of real disk space during a write operation."
29522 #: ../fish/guestfish-commands.pod:186
29527 #: ../fish/guestfish-commands.pod:188
29535 #: ../fish/guestfish-commands.pod:190
29537 "This command returns a list of the optional groups known to the daemon, and "
29538 "indicates which ones are supported by this build of the libguestfs "
29543 #: ../fish/guestfish-commands.pod:194
29544 msgid "See also L<guestfs(3)/AVAILABILITY>."
29548 #: ../fish/guestfish-commands.pod:196
29553 #: ../fish/guestfish-commands.pod:198
29556 " time command args...\n"
29561 #: ../fish/guestfish-commands.pod:200
29563 "Run the command as usual, but print the elapsed time afterwards. This can "
29564 "be useful for benchmarking operations."
29568 #: ../test-tool/libguestfs-test-tool.pod:5
29569 msgid "libguestfs-test-tool - End user tests for libguestfs"
29573 #: ../test-tool/libguestfs-test-tool.pod:9
29576 " libguestfs-test-tool [--options]\n"
29581 #: ../test-tool/libguestfs-test-tool.pod:13
29583 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
29584 "and developers, to allow them to check basic libguestfs functionality is "
29585 "working. This is needed because libguestfs occasionally breaks for reasons "
29586 "beyond our control: usually because of changes in the underlying qemu or "
29587 "kernel packages, or the host environment."
29591 #: ../test-tool/libguestfs-test-tool.pod:20
29592 msgid "If you suspect a problem in libguestfs, then just run:"
29596 #: ../test-tool/libguestfs-test-tool.pod:22
29599 " libguestfs-test-tool\n"
29604 #: ../test-tool/libguestfs-test-tool.pod:24
29605 msgid "It will print lots of diagnostic messages."
29609 #: ../test-tool/libguestfs-test-tool.pod:26
29610 msgid "If it runs to completion successfully, you will see this near the end:"
29614 #: ../test-tool/libguestfs-test-tool.pod:28
29617 " ===== TEST FINISHED OK =====\n"
29622 #: ../test-tool/libguestfs-test-tool.pod:30
29623 msgid "and the test tool will exit with code 0."
29627 #: ../test-tool/libguestfs-test-tool.pod:32
29629 "If it fails (and/or exits with non-zero error code), please paste the "
29630 "B<complete, unedited> output of the test tool into a bug report. More "
29631 "information about reporting bugs can be found on the "
29632 "L<http://libguestfs.org/> website."
29636 #: ../test-tool/libguestfs-test-tool.pod:41
29641 #: ../test-tool/libguestfs-test-tool.pod:43
29642 msgid "Display short usage information and exit."
29646 #: ../test-tool/libguestfs-test-tool.pod:45
29647 msgid "I<--qemu qemu_binary>"
29651 #: ../test-tool/libguestfs-test-tool.pod:47
29653 "If you have downloaded another qemu binary, point this option at the full "
29654 "path of the binary to try it."
29658 #: ../test-tool/libguestfs-test-tool.pod:50
29659 msgid "I<--qemudir qemu_source_dir>"
29663 #: ../test-tool/libguestfs-test-tool.pod:52
29665 "If you have compiled qemu from source, point this option at the source "
29666 "directory to try it."
29670 #: ../test-tool/libguestfs-test-tool.pod:55
29671 msgid "I<--timeout N>"
29675 #: ../test-tool/libguestfs-test-tool.pod:57
29677 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
29678 "does not usually need to be adjusted unless your machine is very slow."
29682 #: ../test-tool/libguestfs-test-tool.pod:63
29683 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
29687 #: ../test-tool/libguestfs-test-tool.pod:65
29689 "If you have compiled another version of qemu from source and would like to "
29690 "try that, then you can use the I<--qemudir> option to point to the qemu "
29691 "source directory."
29695 #: ../test-tool/libguestfs-test-tool.pod:69
29697 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
29698 "option to point to the binary."
29702 #: ../test-tool/libguestfs-test-tool.pod:72
29704 "When using an alternate qemu with libguestfs, usually you would need to "
29705 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)>)."
29706 " libguestfs-test-tool writes a temporary qemu wrapper script when you use "
29707 "either of the I<--qemudir> or I<--qemu> options."
29711 #: ../test-tool/libguestfs-test-tool.pod:79
29713 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29714 "I<1> if there was an error."
29718 #: ../test-tool/libguestfs-test-tool.pod:84
29720 "For the full list of environment variables which may affect libguestfs, "
29721 "please see the L<guestfs(3)> manual page."
29725 #: ../test-tool/libguestfs-test-tool.pod:89
29726 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29730 #: ../fuse/guestmount.pod:5
29732 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29736 #: ../fuse/guestmount.pod:9
29739 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29744 #: ../fuse/guestmount.pod:11
29747 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29752 #: ../fuse/guestmount.pod:13
29755 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29760 #: ../fuse/guestmount.pod:17
29762 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29763 "machines. If you do this, you risk disk corruption in the VM."
29767 #: ../fuse/guestmount.pod:22
29769 "The guestmount program can be used to mount virtual machine filesystems and "
29770 "other disk images on the host. It uses libguestfs for access to the guest "
29771 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29772 "a mountable device."
29776 #: ../fuse/guestmount.pod:27
29778 "Along with other options, you have to give at least one device (I<-a> "
29779 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m>"
29780 " option) or use the I<-i> inspection option. How this works is better "
29781 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29786 #: ../fuse/guestmount.pod:33
29788 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29789 "by you, and the filesystem will not be visible to any other users unless you"
29790 " make certain global configuration changes to C</etc/fuse.conf>. To unmount"
29791 " the filesystem, use the C<fusermount -u> command."
29795 #: ../fuse/guestmount.pod:41
29797 "For a typical Windows guest which has its main filesystem on the first "
29802 #: ../fuse/guestmount.pod:44
29805 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29810 #: ../fuse/guestmount.pod:46
29812 "For a typical Linux guest which has a /boot filesystem on the first "
29813 "partition, and the root filesystem on a logical volume:"
29817 #: ../fuse/guestmount.pod:49
29820 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29825 #: ../fuse/guestmount.pod:51
29826 msgid "To get libguestfs to detect guest mountpoints for you:"
29830 #: ../fuse/guestmount.pod:53
29833 " guestmount -a guest.img -i --ro /mnt\n"
29838 #: ../fuse/guestmount.pod:55
29839 msgid "For a libvirt guest called \"Guest\" you could do:"
29843 #: ../fuse/guestmount.pod:57
29846 " guestmount -d Guest -i --ro /mnt\n"
29851 #: ../fuse/guestmount.pod:59
29853 "If you don't know what filesystems are contained in a guest or disk image, "
29854 "use L<virt-filesystems(1)> first:"
29858 #: ../fuse/guestmount.pod:62
29861 " virt-filesystems MyGuest\n"
29866 #: ../fuse/guestmount.pod:64
29868 "If you want to trace the libguestfs calls but without excessive debugging "
29869 "information, we recommend:"
29873 #: ../fuse/guestmount.pod:67
29876 " guestmount [...] --trace /mnt\n"
29881 #: ../fuse/guestmount.pod:69
29882 msgid "If you want to debug the program, we recommend:"
29886 #: ../fuse/guestmount.pod:71
29889 " guestmount [...] --trace --verbose /mnt\n"
29894 #: ../fuse/guestmount.pod:73
29899 #: ../fuse/guestmount.pod:75
29900 msgid "Other users cannot see the filesystem by default"
29904 #: ../fuse/guestmount.pod:77
29906 "If you mount a filesystem as one user (eg. root), then other users will not "
29907 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29908 "option when mounting:"
29912 #: ../fuse/guestmount.pod:81
29915 " sudo guestmount [...] -o allow_other /mnt\n"
29920 #: ../fuse/guestmount.pod:87
29921 msgid "B<-a image> | B<--add image>"
29925 #: ../fuse/guestmount.pod:89
29926 msgid "Add a block device or virtual machine image."
29930 #: ../fuse/guestmount.pod:94
29931 msgid "B<-c URI> | B<--connect URI>"
29935 #: ../fuse/guestmount.pod:100
29936 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29940 #: ../fuse/guestmount.pod:108
29941 msgid "B<--dir-cache-timeout N>"
29945 #: ../fuse/guestmount.pod:110
29947 "Set the readdir cache timeout to I<N> seconds, the default being 60 seconds."
29948 " The readdir cache [actually, there are several semi-independent caches] is"
29949 " populated after a readdir(2) call with the stat and extended attributes of "
29950 "the files in the directory, in anticipation that they will be requested soon"
29955 #: ../fuse/guestmount.pod:116
29957 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29958 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29959 "requests, only cache existing ones."
29963 #: ../fuse/guestmount.pod:127
29964 msgid "B<--format=raw|qcow2|..> | B<--format>"
29968 #: ../fuse/guestmount.pod:134
29970 "If you have untrusted raw-format guest disk images, you should use this "
29971 "option to specify the disk format. This avoids a possible security problem "
29972 "with malicious guests (CVE-2010-3851). See also "
29973 "L<guestfs(3)/guestfs_add_drive_opts>."
29977 #: ../fuse/guestmount.pod:139
29978 msgid "B<--fuse-help>"
29982 #: ../fuse/guestmount.pod:141
29983 msgid "Display help on special FUSE options (see I<-o> below)."
29987 #: ../fuse/guestmount.pod:145
29988 msgid "Display brief help and exit."
29992 #: ../fuse/guestmount.pod:147
29993 msgid "B<-i> | B<--inspector>"
29997 #: ../fuse/guestmount.pod:167
29999 "Mount the named partition or logical volume on the given mountpoint B<in the"
30000 " guest> (this has nothing to do with mountpoints in the host)."
30004 #: ../fuse/guestmount.pod:170
30006 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30007 "something on C</>."
30011 #: ../fuse/guestmount.pod:183
30012 msgid "B<-n> | B<--no-sync>"
30016 #: ../fuse/guestmount.pod:185
30018 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30019 "unmounted. If you specify this option, then we don't attempt to sync the "
30020 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
30024 #: ../fuse/guestmount.pod:190
30025 msgid "B<-o option> | B<--option option>"
30029 #: ../fuse/guestmount.pod:192
30030 msgid "Pass extra options to FUSE."
30034 #: ../fuse/guestmount.pod:194
30036 "To get a list of all the extra options supported by FUSE, use the command "
30037 "below. Note that only the FUSE I<-o> options can be passed, and only some "
30038 "of them are a good idea."
30042 #: ../fuse/guestmount.pod:198
30045 " guestmount --fuse-help\n"
30050 #: ../fuse/guestmount.pod:200
30051 msgid "Some potentially useful FUSE options:"
30055 #: ../fuse/guestmount.pod:204
30056 msgid "B<-o allow_other>"
30060 #: ../fuse/guestmount.pod:206
30061 msgid "Allow other users to see the filesystem."
30065 #: ../fuse/guestmount.pod:208
30066 msgid "B<-o attr_timeout=N>"
30070 #: ../fuse/guestmount.pod:210
30071 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
30075 #: ../fuse/guestmount.pod:212
30076 msgid "B<-o kernel_cache>"
30080 #: ../fuse/guestmount.pod:214
30082 "Allow the kernel to cache files (reduces the number of reads that have to go"
30083 " through the L<guestfs(3)> API). This is generally a good idea if you can "
30084 "afford the extra memory usage."
30088 #: ../fuse/guestmount.pod:218
30089 msgid "B<-o uid=N> B<-o gid=N>"
30093 #: ../fuse/guestmount.pod:220
30095 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
30096 "the chosen values."
30100 #: ../fuse/guestmount.pod:225
30101 msgid "B<-r> | B<--ro>"
30105 #: ../fuse/guestmount.pod:227
30107 "Add devices and mount everything read-only. Also disallow writes and make "
30108 "the disk appear read-only to FUSE."
30112 #: ../fuse/guestmount.pod:230
30114 "This is highly recommended if you are not going to edit the guest disk. If "
30115 "the guest is running and this option is I<not> supplied, then there is a "
30116 "strong risk of disk corruption in the guest. We try to prevent this from "
30117 "happening, but it is not always possible."
30121 #: ../fuse/guestmount.pod:235
30122 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
30126 #: ../fuse/guestmount.pod:239
30127 msgid "Enable SELinux support for the guest."
30131 #: ../fuse/guestmount.pod:241
30132 msgid "B<-v> | B<--verbose>"
30136 #: ../fuse/guestmount.pod:243
30137 msgid "Enable verbose messages from underlying libguestfs."
30141 #: ../fuse/guestmount.pod:245
30142 msgid "B<-V> | B<--version>"
30146 #: ../fuse/guestmount.pod:247
30147 msgid "Display the program version and exit."
30151 #: ../fuse/guestmount.pod:249
30152 msgid "B<-w> | B<--rw>"
30156 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
30157 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
30161 #: ../fuse/guestmount.pod:256
30162 msgid "B<-x> | B<--trace>"
30166 #: ../fuse/guestmount.pod:258
30167 msgid "Trace libguestfs calls and entry into each FUSE function."
30171 #: ../fuse/guestmount.pod:260
30172 msgid "This also stops the daemon from forking into the background."
30176 #: ../fuse/guestmount.pod:281
30178 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L"
30179 "<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
30180 "L<http://fuse.sf.net/>."
30184 #: ../fuse/guestmount.pod:296
30185 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
30189 #: ../tools/virt-win-reg.pl:37
30191 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
30196 #: ../tools/virt-win-reg.pl:41
30199 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
30204 #: ../tools/virt-win-reg.pl:43
30207 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
30212 #: ../tools/virt-win-reg.pl:45
30215 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
30220 #: ../tools/virt-win-reg.pl:47
30223 " virt-win-reg --merge domname [input.reg ...]\n"
30228 #: ../tools/virt-win-reg.pl:49
30231 " virt-win-reg [--options] disk.img ... # instead of domname\n"
30236 #: ../tools/virt-win-reg.pl:53
30238 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
30239 "virtual machines. If you do this, you I<will> get irreversible disk "
30240 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
30241 "but doesn't catch all cases."
30245 #: ../tools/virt-win-reg.pl:58
30247 "Modifying the Windows Registry is an inherently risky operation. The format"
30248 " is deliberately obscure and undocumented, and Registry changes can leave "
30249 "the system unbootable. Therefore when using the I<--merge> option, make "
30250 "sure you have a reliable backup first."
30254 #: ../tools/virt-win-reg.pl:65
30256 "This program can export and merge Windows Registry entries from a Windows "
30261 #: ../tools/virt-win-reg.pl:68
30263 "The first parameter is the libvirt guest name or the raw disk image of a "
30268 #: ../tools/virt-win-reg.pl:71
30270 "If I<--merge> is I<not> specified, then the chosen registry key is "
30271 "displayed/exported (recursively). For example:"
30275 #: ../tools/virt-win-reg.pl:74
30278 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
30283 #: ../tools/virt-win-reg.pl:76
30285 "You can also display single values from within registry keys, for example:"
30289 #: ../tools/virt-win-reg.pl:79
30292 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
30293 " $ virt-win-reg Windows7 $cvkey ProductName\n"
30294 " Windows 7 Enterprise\n"
30299 #: ../tools/virt-win-reg.pl:83
30301 "With I<--merge>, you can merge a textual regedit file into the Windows "
30306 #: ../tools/virt-win-reg.pl:86
30309 " $ virt-win-reg --merge Windows7 changes.reg\n"
30314 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
30319 #: ../tools/virt-win-reg.pl:90
30321 "This program is only meant for simple access to the registry. If you want "
30322 "to do complicated things with the registry, we suggest you download the "
30323 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)>"
30324 " and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
30325 "L<hivexregedit(1)>."
30329 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
30330 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
30331 #: ../tools/virt-list-partitions.pl:64
30332 msgid "Display brief help."
30336 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
30337 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
30338 #: ../tools/virt-list-partitions.pl:72
30339 msgid "Display version number and exit."
30343 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
30348 #: ../tools/virt-win-reg.pl:122
30349 msgid "Enable debugging messages."
30353 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
30354 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
30355 msgid "B<--connect URI> | B<-c URI>"
30359 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
30360 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
30362 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
30363 "to the default libvirt hypervisor."
30367 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
30368 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
30370 "If you specify guest block devices directly, then libvirt is not used at "
30375 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
30376 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
30377 msgid "B<--format> raw"
30381 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
30382 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
30384 "Specify the format of disk images given on the command line. If this is "
30385 "omitted then the format is autodetected from the content of the disk image."
30389 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
30390 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
30392 "If disk images are requested from libvirt, then this program asks libvirt "
30393 "for this information. In this case, the value of the format parameter is "
30398 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
30399 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
30401 "If working with untrusted raw-format guest disk images, you should ensure "
30402 "the format is always specified."
30406 #: ../tools/virt-win-reg.pl:157
30411 #: ../tools/virt-win-reg.pl:159
30413 "In merge mode, this merges a textual regedit file into the Windows Registry "
30414 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
30415 "displays or exports Registry entries instead."
30419 #: ../tools/virt-win-reg.pl:163
30421 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
30422 "result in disk corruption. However exporting (without this flag) is always"
30427 #: ../tools/virt-win-reg.pl:171
30428 msgid "B<--encoding> UTF-16LE|ASCII"
30432 #: ../tools/virt-win-reg.pl:173
30434 "When merging (only), you may need to specify the encoding for strings to be "
30435 "used in the hive file. This is explained in detail in "
30436 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
30440 #: ../tools/virt-win-reg.pl:177
30442 "The default is to use UTF-16LE, which should work with recent versions of "
30447 #: ../tools/virt-win-reg.pl:184
30448 msgid "B<--unsafe-printable-strings>"
30452 #: ../tools/virt-win-reg.pl:186
30454 "When exporting (only), assume strings are UTF-16LE and print them as strings"
30455 " instead of hex sequences. Remove the final zero codepoint from strings if "
30460 #: ../tools/virt-win-reg.pl:190
30462 "This is unsafe and does not preserve the fidelity of strings in the original"
30463 " Registry for various reasons:"
30467 #: ../tools/virt-win-reg.pl:197
30469 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
30470 "other encodings will be corrupted by this transformation."
30474 #: ../tools/virt-win-reg.pl:202
30476 "Assumes that everything which has type 1 or 2 is really a string and that "
30477 "everything else is not a string, but the type field in real Registries is "
30482 #: ../tools/virt-win-reg.pl:208
30484 "Loses information about whether a zero codepoint followed the string in the "
30489 #: ../tools/virt-win-reg.pl:213
30491 "This all happens because the Registry itself contains no information about "
30492 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
30496 #: ../tools/virt-win-reg.pl:217
30498 "You should only use this option for quick hacking and debugging of the "
30499 "Registry contents, and I<never> use it if the output is going to be passed "
30500 "into another program or stored in another Registry."
30504 #: ../tools/virt-win-reg.pl:554
30505 msgid "SUPPORTED SYSTEMS"
30509 #: ../tools/virt-win-reg.pl:556
30511 "The program currently supports Windows NT-derived guests starting with "
30512 "Windows XP through to at least Windows 7."
30516 #: ../tools/virt-win-reg.pl:559
30517 msgid "The following Registry keys are supported:"
30521 #: ../tools/virt-win-reg.pl:563
30522 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
30526 #: ../tools/virt-win-reg.pl:565
30527 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
30531 #: ../tools/virt-win-reg.pl:567
30532 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
30536 #: ../tools/virt-win-reg.pl:569
30537 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
30541 #: ../tools/virt-win-reg.pl:571
30542 msgid "C<HKEY_USERS\\.DEFAULT>"
30546 #: ../tools/virt-win-reg.pl:573
30547 msgid "C<HKEY_USERS\\I<SID>>"
30551 #: ../tools/virt-win-reg.pl:575
30552 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
30556 #: ../tools/virt-win-reg.pl:577
30557 msgid "C<HKEY_USERS\\I<username>>"
30561 #: ../tools/virt-win-reg.pl:579
30563 "where I<username> is a local user name (this is a libguestfs extension)."
30567 #: ../tools/virt-win-reg.pl:583
30569 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for"
30574 #: ../tools/virt-win-reg.pl:586
30576 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
30577 "supported (there is no \"current user\")."
30581 #: ../tools/virt-win-reg.pl:589
30586 #: ../tools/virt-win-reg.pl:591
30588 "C<virt-win-reg> expects that regedit files have already been reencoded in "
30589 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
30590 "style line endings. Since Windows regedit files are often in UTF-16LE with "
30591 "Windows-style line endings, you may need to reencode the whole file before "
30592 "or after processing."
30596 #: ../tools/virt-win-reg.pl:597
30598 "To reencode a file from Windows format to Linux (before processing it with "
30599 "the I<--merge> option), you would do something like this:"
30603 #: ../tools/virt-win-reg.pl:600
30606 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
30611 #: ../tools/virt-win-reg.pl:602
30613 "To go in the opposite direction, after exporting and before sending the file"
30614 " to a Windows user, do something like this:"
30618 #: ../tools/virt-win-reg.pl:605
30621 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
30626 #: ../tools/virt-win-reg.pl:607
30627 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
30631 #: ../tools/virt-win-reg.pl:609
30633 "If you are unsure about the current encoding, use the L<file(1)> command. "
30634 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30635 "style (CRLF) line endings, like this:"
30639 #: ../tools/virt-win-reg.pl:613
30642 " $ file software.reg\n"
30643 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30644 " with CRLF line terminators\n"
30649 #: ../tools/virt-win-reg.pl:617
30650 msgid "This file would need conversion before you could I<--merge> it."
30654 #: ../tools/virt-win-reg.pl:619
30655 msgid "CurrentControlSet etc."
30659 #: ../tools/virt-win-reg.pl:621
30661 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30662 "Registry at the level of the hive file, and therefore you cannot modify "
30667 #: ../tools/virt-win-reg.pl:625
30669 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30670 "circumstances it might refer to another control set. The way to find out is"
30671 " to look at the C<HKLM\\SYSTEM\\Select> key:"
30675 #: ../tools/virt-win-reg.pl:629
30678 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30679 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30680 " \"Current\"=dword:00000001\n"
30681 " \"Default\"=dword:00000001\n"
30682 " \"Failed\"=dword:00000000\n"
30683 " \"LastKnownGood\"=dword:00000002\n"
30688 #: ../tools/virt-win-reg.pl:636
30689 msgid "\"Current\" is the one which Windows will choose when it boots."
30693 #: ../tools/virt-win-reg.pl:638
30695 "Similarly, other C<Current...> keys in the path may need to be replaced."
30699 #: ../tools/virt-win-reg.pl:641
30700 msgid "WINDOWS TIPS"
30704 #: ../tools/virt-win-reg.pl:643
30706 "Note that some of these tips modify the guest disk image. The guest I<must>"
30707 " be shut off, else you will get disk corruption."
30711 #: ../tools/virt-win-reg.pl:646
30712 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30716 #: ../tools/virt-win-reg.pl:648
30718 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30719 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30720 "is uploaded into C<C:\\>:"
30724 #: ../tools/virt-win-reg.pl:652
30727 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30732 #: ../tools/virt-win-reg.pl:654
30733 msgid "Prepare a regedit file containing the registry change:"
30737 #: ../tools/virt-win-reg.pl:656
30740 " cat > test.reg <<'EOF'\n"
30741 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30742 " \"Test\"=\"c:\\\\test.bat\"\n"
30748 #: ../tools/virt-win-reg.pl:661
30750 "In this example we use the key C<RunOnce> which means that the script will "
30751 "run precisely once when the first user logs in. If you want it to run every"
30752 " time a user logs in, replace C<RunOnce> with C<Run>."
30756 #: ../tools/virt-win-reg.pl:665
30757 msgid "Now update the registry:"
30761 #: ../tools/virt-win-reg.pl:667
30764 " virt-win-reg --merge WindowsGuest test.reg\n"
30769 #: ../tools/virt-win-reg.pl:669
30770 msgid "INSTALLING A SERVICE"
30774 #: ../tools/virt-win-reg.pl:671
30776 "This section assumes you are familiar with Windows services, and you either "
30777 "have a program which handles the Windows Service Control Protocol directly "
30778 "or you want to run any program using a service wrapper like SrvAny or the "
30783 #: ../tools/virt-win-reg.pl:676
30785 "First upload the program and optionally the service wrapper. In this case "
30786 "the test program is called C<test.exe> and we are using the RHSrvAny "
30791 #: ../tools/virt-win-reg.pl:680
30794 " guestfish -i -d WindowsGuest <<EOF\n"
30795 " upload rhsrvany.exe /rhsrvany.exe\n"
30796 " upload test.exe /test.exe\n"
30802 #: ../tools/virt-win-reg.pl:685
30804 "Prepare a regedit file containing the registry changes. In this example, "
30805 "the first registry change is needed for the service itself or the service "
30806 "wrapper (if used). The second registry change is only needed because I am "
30807 "using the RHSrvAny service wrapper."
30811 #: ../tools/virt-win-reg.pl:690
30814 " cat > service.reg <<'EOF'\n"
30815 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30816 " \"Type\"=dword:00000010\n"
30817 " \"Start\"=dword:00000002\n"
30818 " \"ErrorControl\"=dword:00000001\n"
30819 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30820 " \"DisplayName\"=\"RHSrvAny\"\n"
30821 " \"ObjectName\"=\"NetworkService\"\n"
30826 #: ../tools/virt-win-reg.pl:699
30829 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30830 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30831 " \"PWD\"=\"c:\\\\Temp\"\n"
30837 #: ../tools/virt-win-reg.pl:710
30839 "For use of C<ControlSet001> see the section above in this manual page. You "
30840 "may need to adjust this according to the control set that is in use by the "
30845 #: ../tools/virt-win-reg.pl:716
30847 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30848 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30849 "privileged account."
30853 #: ../tools/virt-win-reg.pl:722
30855 "For the meaning of the magic numbers, see this Microsoft KB article: "
30856 "L<http://support.microsoft.com/kb/103000>."
30860 #: ../tools/virt-win-reg.pl:727
30861 msgid "Update the registry:"
30865 #: ../tools/virt-win-reg.pl:729
30868 " virt-win-reg --merge WindowsGuest service.reg\n"
30873 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30874 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30875 #: ../tools/virt-list-partitions.pl:250
30876 msgid "SHELL QUOTING"
30880 #: ../tools/virt-win-reg.pl:733
30882 "Be careful when passing parameters containing C<\\> (backslash) in the "
30883 "shell. Usually you will have to use 'single quotes' or double backslashes "
30884 "(but not both) to protect them from the shell."
30888 #: ../tools/virt-win-reg.pl:737
30889 msgid "Paths and value names are case-insensitive."
30893 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30894 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30895 #: ../tools/virt-list-partitions.pl:252
30897 "Libvirt guest names can contain arbitrary characters, some of which have "
30898 "meaning to the shell such as C<#> and space. You may need to quote or "
30899 "escape these characters on the command line. See the shell manual page "
30900 "L<sh(1)> for details."
30904 #: ../tools/virt-win-reg.pl:746
30906 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
30907 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
30908 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
30909 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30913 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30915 "When reporting bugs, please enable debugging and capture the I<complete> "
30920 #: ../tools/virt-win-reg.pl:764
30923 " export LIBGUESTFS_DEBUG=1\n"
30924 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30929 #: ../tools/virt-win-reg.pl:767
30931 "Attach /tmp/virt-win-reg.log to a new bug report at "
30932 "L<https://bugzilla.redhat.com/>"
30936 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30937 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30938 #: ../tools/virt-list-partitions.pl:269
30943 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30944 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30945 #: ../tools/virt-list-partitions.pl:271
30946 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30950 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30951 msgid "Copyright (C) 2010 Red Hat Inc."
30955 #: ../tools/virt-list-filesystems.pl:32
30957 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30961 #: ../tools/virt-list-filesystems.pl:36
30964 " virt-list-filesystems [--options] domname\n"
30969 #: ../tools/virt-list-filesystems.pl:38
30972 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30977 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30979 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30984 #: ../tools/virt-list-filesystems.pl:45
30986 "C<virt-list-filesystems> is a command line tool to list the filesystems that"
30987 " are contained in a virtual machine or disk image."
30991 #: ../tools/virt-list-filesystems.pl:49
30993 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
30994 "functionality. For more complex cases you should look at the "
30995 "L<guestfish(1)> tool."
30999 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
31000 msgid "B<-l> | B<--long>"
31004 #: ../tools/virt-list-filesystems.pl:108
31006 "With this option, C<virt-list-filesystems> displays the type of each "
31007 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
31011 #: ../tools/virt-list-filesystems.pl:115
31012 msgid "B<-a> | B<--all>"
31016 #: ../tools/virt-list-filesystems.pl:117
31018 "Normally we only show mountable filesystems. If this option is given then "
31019 "swap devices are shown too."
31023 #: ../tools/virt-list-filesystems.pl:191
31025 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
31026 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
31027 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31031 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
31032 msgid "Copyright (C) 2009 Red Hat Inc."
31036 #: ../tools/virt-tar.pl:33
31037 msgid "virt-tar - Extract or upload files to a virtual machine"
31041 #: ../tools/virt-tar.pl:37
31044 " virt-tar [--options] -x domname directory tarball\n"
31049 #: ../tools/virt-tar.pl:39
31052 " virt-tar [--options] -u domname tarball directory\n"
31057 #: ../tools/virt-tar.pl:41
31060 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
31065 #: ../tools/virt-tar.pl:43
31068 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
31073 #: ../tools/virt-tar.pl:47
31075 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
31076 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
31080 #: ../tools/virt-tar.pl:52
31081 msgid "Download C</home> from the VM into a local tarball:"
31085 #: ../tools/virt-tar.pl:54
31088 " virt-tar -x domname /home home.tar\n"
31093 #: ../tools/virt-tar.pl:56
31096 " virt-tar -zx domname /home home.tar.gz\n"
31101 #: ../tools/virt-tar.pl:58
31102 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
31106 #: ../tools/virt-tar.pl:60
31109 " virt-tar -u domname uploadstuff.tar /tmp\n"
31114 #: ../tools/virt-tar.pl:62
31117 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
31122 #: ../tools/virt-tar.pl:66
31124 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
31125 "virtual machines. If you do this, you risk disk corruption in the VM. C"
31126 "<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
31130 #: ../tools/virt-tar.pl:71
31132 "You can use I<-x> (extract) on live virtual machines, but you might get "
31133 "inconsistent results or errors if there is filesystem activity inside the "
31134 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
31135 "work, but the only way to guarantee consistent results is if the virtual "
31136 "machine is shut down."
31140 #: ../tools/virt-tar.pl:79
31142 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
31143 "parts of a guest filesystem. There are many possibilities: making backups, "
31144 "uploading data files, snooping on guest activity, fixing or customizing "
31149 #: ../tools/virt-tar.pl:84
31151 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
31152 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you"
31153 " should look at the L<guestfish(1)> tool."
31157 #: ../tools/virt-tar.pl:88
31159 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
31160 "its contents (recursively) from the virtual machine into a local tarball. "
31161 "I<-u> uploads from a local tarball, unpacking it into a directory inside the"
31162 " virtual machine. You cannot use these two options together."
31166 #: ../tools/virt-tar.pl:94
31168 "In addition, you may need to use the I<-z> (gZip) option to enable "
31169 "compression. When uploading, you have to specify I<-z> if the upload file "
31170 "is compressed because virt-tar won't detect this on its own."
31174 #: ../tools/virt-tar.pl:98
31176 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
31177 "example it cannot do PKZip files or bzip2 compression. If you want that "
31178 "then you'll have to rebuild the tarballs yourself. (This is a limitation of"
31179 " the L<libguestfs(3)> API)."
31183 #: ../tools/virt-tar.pl:156
31184 msgid "B<-x> | B<--extract> | B<--download>"
31188 #: ../tools/virt-tar.pl:158
31189 msgid "B<-u> | B<--upload>"
31193 #: ../tools/virt-tar.pl:160
31195 "Use I<-x> to extract (download) a directory from a virtual machine to a "
31200 #: ../tools/virt-tar.pl:163
31202 "Use I<-u> to upload and unpack from a local tarball into a virtual machine."
31203 " Please read the L</WARNING> section above before using this option."
31207 #: ../tools/virt-tar.pl:167
31208 msgid "You must specify exactly one of these options."
31212 #: ../tools/virt-tar.pl:173
31213 msgid "B<-z> | B<--gzip>"
31217 #: ../tools/virt-tar.pl:175
31218 msgid "Specify that the input or output tarball is gzip-compressed."
31222 #: ../tools/virt-tar.pl:288
31224 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-"
31225 "copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
31226 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
31227 "L<http://libguestfs.org/>."
31231 #: ../tools/virt-make-fs.pl:37
31232 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
31236 #: ../tools/virt-make-fs.pl:41
31239 " virt-make-fs [--options] input.tar output.img\n"
31244 #: ../tools/virt-make-fs.pl:43
31247 " virt-make-fs [--options] input.tar.gz output.img\n"
31252 #: ../tools/virt-make-fs.pl:45
31255 " virt-make-fs [--options] directory output.img\n"
31260 #: ../tools/virt-make-fs.pl:49
31262 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
31263 "archive or some files in a directory. It is similar to tools like "
31264 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
31265 "it can create common filesystem types like ext2/3 or NTFS, which can be "
31266 "useful if you want to attach these filesystems to existing virtual machines "
31267 "(eg. to import large amounts of read-only data to a VM)."
31271 #: ../tools/virt-make-fs.pl:57
31272 msgid "Basic usage is:"
31276 #: ../tools/virt-make-fs.pl:59
31279 " virt-make-fs input output\n"
31284 #: ../tools/virt-make-fs.pl:61
31286 "where C<input> is either a directory containing files that you want to add, "
31287 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
31288 "C<output> is a disk image. The input type is detected automatically. The "
31289 "output disk image defaults to a raw ext2 image unless you specify extra "
31290 "flags (see L</OPTIONS> below)."
31294 #: ../tools/virt-make-fs.pl:67
31295 msgid "EXTRA SPACE"
31299 #: ../tools/virt-make-fs.pl:69
31301 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
31302 "the files that it contains, but might have extra space. Depending on how "
31303 "you are going to use the output, you might think this extra space is wasted "
31304 "and want to minimize it, or you might want to leave space so that more files"
31305 " can be added later. Virt-make-fs defaults to minimizing the extra space, "
31306 "but you can use the I<--size> flag to leave space in the filesystem if you "
31311 #: ../tools/virt-make-fs.pl:77
31313 "An alternative way to leave extra space but not make the output image any "
31314 "bigger is to use an alternative disk image format (instead of the default "
31315 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2"
31316 " image format (check your hypervisor supports this before using it). This "
31317 "allows you to choose a large I<--size> but the extra space won't actually be"
31318 " allocated in the image until you try to store something in it."
31322 #: ../tools/virt-make-fs.pl:85
31324 "Don't forget that you can also use local commands including L<resize2fs(8)> "
31325 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
31326 "to build another image from scratch."
31330 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
31331 #: ../tools/virt-make-fs.pl:142
31336 #: ../tools/virt-make-fs.pl:91
31339 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
31344 #: ../tools/virt-make-fs.pl:93
31345 msgid "FILESYSTEM TYPE"
31349 #: ../tools/virt-make-fs.pl:95
31351 "The default filesystem type is C<ext2>. Just about any filesystem type that"
31352 " libguestfs supports can be used (but I<not> read-only formats like "
31353 "ISO9660). Here are some of the more common choices:"
31357 #: ../tools/virt-make-fs.pl:101
31362 #: ../tools/virt-make-fs.pl:103
31364 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If"
31365 " you are not going to use the filesystem in a way that requires the journal,"
31366 " then this is just wasted overhead."
31370 #: ../tools/virt-make-fs.pl:107
31371 msgid "I<ntfs> or I<vfat>"
31375 #: ../tools/virt-make-fs.pl:109
31376 msgid "Useful if exporting data to a Windows guest."
31380 #: ../tools/virt-make-fs.pl:111
31382 "I<Note for vfat>: The tar archive or local directory must only contain files"
31383 " which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
31384 "program running within libguestfs is unable to change the ownership of non-"
31385 "root files, since vfat itself does not support this."
31389 #: ../tools/virt-make-fs.pl:116
31394 #: ../tools/virt-make-fs.pl:118
31396 "Lower overhead than C<ext2>, but certain limitations on filename length and "
31397 "total filesystem size."
31401 #: ../tools/virt-make-fs.pl:125
31404 " virt-make-fs --type=minix input minixfs.img\n"
31409 #: ../tools/virt-make-fs.pl:127
31410 msgid "TO PARTITION OR NOT TO PARTITION"
31414 #: ../tools/virt-make-fs.pl:129
31415 msgid "Optionally virt-make-fs can add a partition table to the output disk."
31419 #: ../tools/virt-make-fs.pl:131
31421 "Adding a partition can make the disk image more compatible with certain "
31422 "virtualized operating systems which don't expect to see a filesystem "
31423 "directly located on a block device (Linux doesn't care and will happily "
31424 "handle both types)."
31428 #: ../tools/virt-make-fs.pl:136
31430 "On the other hand, if you have a partition table then the output image is no"
31431 " longer a straight filesystem. For example you cannot run L<fsck(8)> "
31432 "directly on a partitioned disk image. (However libguestfs tools such as "
31433 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
31437 #: ../tools/virt-make-fs.pl:144
31438 msgid "Add an MBR partition:"
31442 #: ../tools/virt-make-fs.pl:146
31445 " virt-make-fs --partition -- input disk.img\n"
31450 #: ../tools/virt-make-fs.pl:148
31452 "If the output disk image could be terabyte-sized or larger, it's better to "
31453 "use an EFI/GPT-compatible partition table:"
31457 #: ../tools/virt-make-fs.pl:151
31460 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
31465 #: ../tools/virt-make-fs.pl:179
31466 msgid "Enable debugging information."
31470 #: ../tools/virt-make-fs.pl:185
31471 msgid "B<--size=E<lt>NE<gt>>"
31475 #: ../tools/virt-make-fs.pl:187
31476 msgid "B<--size=+E<lt>NE<gt>>"
31480 #: ../tools/virt-make-fs.pl:189
31481 msgid "B<-s E<lt>NE<gt>>"
31485 #: ../tools/virt-make-fs.pl:191
31486 msgid "B<-s +E<lt>NE<gt>>"
31490 #: ../tools/virt-make-fs.pl:193
31492 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
31496 #: ../tools/virt-make-fs.pl:196
31498 "If this option is I<not> given, then the output image will be just large "
31499 "enough to contain all the files, with not much wasted space."
31503 #: ../tools/virt-make-fs.pl:199
31505 "To choose a fixed size output disk, specify an absolute number followed by "
31506 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31507 "Petabytes or Exabytes. This must be large enough to contain all the input "
31508 "files, else you will get an error."
31512 #: ../tools/virt-make-fs.pl:204
31514 "To leave extra space, specify C<+> (plus sign) and a number followed by "
31515 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31516 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
31517 "the input files, and (approximately) an extra 200 MB free space."
31521 #: ../tools/virt-make-fs.pl:210
31523 "Note that virt-make-fs estimates free space, and therefore will not produce "
31524 "filesystems containing precisely the free space requested. (It is much more"
31525 " expensive and time-consuming to produce a filesystem which has precisely "
31526 "the desired free space)."
31530 #: ../tools/virt-make-fs.pl:219
31531 msgid "B<--format=E<lt>fmtE<gt>>"
31535 #: ../tools/virt-make-fs.pl:221
31536 msgid "B<-F E<lt>fmtE<gt>>"
31540 #: ../tools/virt-make-fs.pl:223
31541 msgid "Choose the output disk image format."
31545 #: ../tools/virt-make-fs.pl:225
31546 msgid "The default is C<raw> (raw disk image)."
31550 #: ../tools/virt-make-fs.pl:227
31552 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31553 "that would really make sense here is C<qcow2>."
31557 #: ../tools/virt-make-fs.pl:234
31558 msgid "B<--type=E<lt>fsE<gt>>"
31562 #: ../tools/virt-make-fs.pl:236
31563 msgid "B<-t E<lt>fsE<gt>>"
31567 #: ../tools/virt-make-fs.pl:238
31568 msgid "Choose the output filesystem type."
31572 #: ../tools/virt-make-fs.pl:240
31573 msgid "The default is C<ext2>."
31577 #: ../tools/virt-make-fs.pl:242
31579 "Any filesystem which is supported read-write by libguestfs can be used here."
31583 #: ../tools/virt-make-fs.pl:249
31584 msgid "B<--partition>"
31588 #: ../tools/virt-make-fs.pl:251
31589 msgid "B<--partition=E<lt>parttypeE<gt>>"
31593 #: ../tools/virt-make-fs.pl:253
31595 "If specified, this flag adds an MBR partition table to the output disk "
31600 #: ../tools/virt-make-fs.pl:256
31602 "You can change the partition table type, eg. I<--partition=gpt> for large "
31607 #: ../tools/virt-make-fs.pl:259
31609 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
31610 "might consider the next parameter to be the partition type. For example:"
31614 #: ../tools/virt-make-fs.pl:263
31617 " virt-make-fs --partition input.tar ...\n"
31622 #: ../tools/virt-make-fs.pl:265
31624 "would cause virt-make-fs to think you wanted to use a partition type of "
31625 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
31626 "dash) between options and the input file argument:"
31630 #: ../tools/virt-make-fs.pl:269
31633 " virt-make-fs --partition -- input.tar ...\n"
31638 #: ../tools/virt-make-fs.pl:541
31640 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31641 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
31642 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31646 #: ../tools/virt-make-fs.pl:558
31649 " export LIBGUESTFS_DEBUG=1\n"
31650 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31655 #: ../tools/virt-make-fs.pl:561
31657 "Attach /tmp/virt-make-fs.log to a new bug report at "
31658 "L<https://bugzilla.redhat.com/>"
31662 #: ../tools/virt-list-partitions.pl:32
31664 "virt-list-partitions - List partitions in a virtual machine or disk image"
31668 #: ../tools/virt-list-partitions.pl:36
31671 " virt-list-partitions [--options] domname\n"
31676 #: ../tools/virt-list-partitions.pl:38
31679 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31684 #: ../tools/virt-list-partitions.pl:45
31686 "C<virt-list-partitions> is a command line tool to list the partitions that "
31687 "are contained in a virtual machine or disk image. It is mainly useful as a "
31688 "first step to using L<virt-resize(1)>."
31692 #: ../tools/virt-list-partitions.pl:50
31694 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31695 "functionality. For more complex cases you should look at the "
31696 "L<guestfish(1)> tool."
31700 #: ../tools/virt-list-partitions.pl:107
31701 msgid "B<-h> | B<--human-readable>"
31705 #: ../tools/virt-list-partitions.pl:109
31706 msgid "Show sizes in human-readable form (eg. \"1G\")."
31710 #: ../tools/virt-list-partitions.pl:117
31712 "With this option, C<virt-list-partitions> displays the type and size of each"
31713 " partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31717 #: ../tools/virt-list-partitions.pl:124
31718 msgid "B<-t> | B<--total>"
31722 #: ../tools/virt-list-partitions.pl:126
31724 "Display the total size of each block device (as a separate row or rows)."
31728 #: ../tools/virt-list-partitions.pl:259
31730 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31731 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
31732 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31736 #: ../tools/virt-list-partitions.pl:275
31737 msgid "Copyright (C) 2009-2010 Red Hat Inc."