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 # Luis Bazán <lbazan@bakertillypanama.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: Spanish (Castilian) <trans-es@lists.fedoraproject.org>\n"
15 "Content-Type: text/plain; charset=UTF-8\n"
16 "Content-Transfer-Encoding: 8bit\n"
18 "Plural-Forms: nplurals=2; plural=(n != 1)\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"
50 " #include <guestfs.h>\n"
54 #: ../src/guestfs.pod:11
57 " guestfs_h *g = guestfs_create ();\n"
58 " guestfs_add_drive (g, \"guest.img\");\n"
59 " guestfs_launch (g);\n"
60 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
61 " guestfs_touch (g, \"/hello\");\n"
62 " guestfs_umount (g, \"/\");\n"
63 " guestfs_close (g);\n"
66 " guestfs_h *g = guestfs_create ();\n"
67 " guestfs_add_drive (g, \"guest.img\");\n"
68 " guestfs_launch (g);\n"
69 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
70 " guestfs_touch (g, \"/hello\");\n"
71 " guestfs_umount (g, \"/\");\n"
72 " guestfs_close (g);\n"
76 #: ../src/guestfs.pod:19
79 " cc prog.c -o prog -lguestfs\n"
81 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
86 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30
87 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
88 #: ../tools/virt-win-reg.pl:63 ../tools/virt-list-filesystems.pl:40
89 #: ../tools/virt-tar.pl:77 ../tools/virt-make-fs.pl:47
90 #: ../tools/virt-list-partitions.pl:40
95 #: ../src/guestfs.pod:25
97 "Libguestfs is a library for accessing and modifying guest disk images. "
98 "Amongst the things this is good for: making batch configuration changes to "
99 "guests, getting disk used/free statistics (see also: virt-df), migrating "
100 "between virtualization systems (see also: virt-p2v), performing partial "
101 "backups, performing partial guest clones, cloning guests and changing "
102 "registry/UUID/hostname info, and much else besides."
106 #: ../src/guestfs.pod:33
108 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest"
109 " filesystem that Linux and qemu can, including but not limited to: ext2/3/4,"
110 " btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
115 #: ../src/guestfs.pod:38
117 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
118 "what filesystem is in each LV, etc.). It can also run commands in the "
119 "context of the guest. Also you can access filesystems over FUSE."
123 #: ../src/guestfs.pod:43
125 "Libguestfs is a library that can be linked with C and C++ management "
126 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java,"
127 " PHP, Haskell or C#). You can also use it from shell scripts or the command"
132 #: ../src/guestfs.pod:48
134 "You don't need to be root to use libguestfs, although obviously you do need "
135 "enough permissions to access the disk images."
139 #: ../src/guestfs.pod:51
141 "Libguestfs is a large API because it can do many things. For a gentle "
142 "introduction, please read the L</API OVERVIEW> section next."
146 #: ../src/guestfs.pod:54
148 "There are also some example programs in the L<guestfs-examples(3)> manual "
153 #: ../src/guestfs.pod:57
158 #: ../src/guestfs.pod:59
160 "This section provides a gentler overview of the libguestfs API. We also try"
161 " to group API calls together, where that may not be obvious from reading "
162 "about the individual calls in the main section of this manual."
166 #: ../src/guestfs.pod:64
171 #: ../src/guestfs.pod:66
173 "Before you can use libguestfs calls, you have to create a handle. Then you "
174 "must add at least one disk image to the handle, followed by launching the "
175 "handle, then performing whatever operations you want, and finally closing "
176 "the handle. By convention we use the single letter C<g> for the name of the"
177 " handle variable, although of course you can use any name you want."
181 #: ../src/guestfs.pod:73
183 "The general structure of all libguestfs-using programs looks like this:"
187 #: ../src/guestfs.pod:76
190 " guestfs_h *g = guestfs_create ();\n"
195 #: ../src/guestfs.pod:78
198 " /* Call guestfs_add_drive additional times if there are\n"
199 " * multiple disk images.\n"
201 " guestfs_add_drive (g, \"guest.img\");\n"
206 #: ../src/guestfs.pod:83
209 " /* Most manipulation calls won't work until you've launched\n"
210 " * the handle 'g'. You have to do this _after_ adding drives\n"
211 " * and _before_ other commands.\n"
213 " guestfs_launch (g);\n"
218 #: ../src/guestfs.pod:89
221 " /* Now you can examine what partitions, LVs etc are available.\n"
223 " char **partitions = guestfs_list_partitions (g);\n"
224 " char **logvols = guestfs_lvs (g);\n"
229 #: ../src/guestfs.pod:94
232 " /* To access a filesystem in the image, you must mount it.\n"
234 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
239 #: ../src/guestfs.pod:98
242 " /* Now you can perform filesystem actions on the guest\n"
245 " guestfs_touch (g, \"/hello\");\n"
250 #: ../src/guestfs.pod:103
253 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
254 " * it is done automatically when you close the handle. See\n"
255 " * discussion of autosync in this page.\n"
257 " guestfs_sync (g);\n"
262 #: ../src/guestfs.pod:109
265 " /* Close the handle 'g'. */\n"
266 " guestfs_close (g);\n"
271 #: ../src/guestfs.pod:112
273 "The code above doesn't include any error checking. In real code you should "
274 "check return values carefully for errors. In general all functions that "
275 "return integers return C<-1> on error, and all functions that return "
276 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
277 "how to handle errors, and consult the documentation for each function call "
278 "below to see precisely how they return error indications. See L<guestfs-"
279 "examples(3)> for fully worked examples."
283 #: ../src/guestfs.pod:121
288 #: ../src/guestfs.pod:123
290 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
291 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
292 "actual block device, or simply an empty file of zeroes that you have created"
293 " through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all"
298 #: ../src/guestfs.pod:129
300 "The call you should use in modern code for adding drives is "
301 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
302 "specifying that the format is raw, do:"
306 #: ../src/guestfs.pod:133
309 " guestfs_add_drive_opts (g, filename,\n"
310 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
316 #: ../src/guestfs.pod:137
317 msgid "You can add a disk read-only using:"
321 #: ../src/guestfs.pod:139
324 " guestfs_add_drive_opts (g, filename,\n"
325 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
326 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
332 #: ../src/guestfs.pod:144
334 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
335 "libguestfs won't modify the file."
339 #: ../src/guestfs.pod:147
341 "Be extremely cautious if the disk image is in use, eg. if it is being used "
342 "by a virtual machine. Adding it read-write will almost certainly cause disk"
343 " corruption, but adding it read-only is safe."
347 #: ../src/guestfs.pod:151
349 "You must add at least one disk image, and you may add multiple disk images."
350 " In the API, the disk images are usually referred to as C</dev/sda> (for "
351 "the first one you added), C</dev/sdb> (for the second one you added), etc."
355 #: ../src/guestfs.pod:156
357 "Once L</guestfs_launch> has been called you cannot add any more images. You"
358 " can call L</guestfs_list_devices> to get a list of the device names, in the"
359 " order that you added them. See also L</BLOCK DEVICE NAMING> below."
363 #: ../src/guestfs.pod:161
368 #: ../src/guestfs.pod:163
370 "Before you can read or write files, create directories and so on in a disk "
371 "image that contains filesystems, you have to mount those filesystems using "
372 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that"
373 " a disk image contains (for example) one partition with a filesystem on that"
374 " partition, then you can mount it directly:"
378 #: ../src/guestfs.pod:170
381 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
386 #: ../src/guestfs.pod:172
388 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
389 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
390 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
391 "that these are libguestfs virtual devices, and are nothing to do with host "
396 #: ../src/guestfs.pod:178
398 "If you are given a disk image and you don't know what it contains then you "
399 "have to find out. Libguestfs can do that too: use "
400 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
401 "and LVs, and either try mounting each to see what is mountable, or else "
402 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
403 "filesystems, use L</guestfs_list_filesystems>."
407 #: ../src/guestfs.pod:186
409 "Libguestfs also has a set of APIs for inspection of unknown disk images (see"
410 " L</INSPECTION> below). But you might find it easier to look at higher "
411 "level programs built on top of libguestfs, in particular L<virt-"
416 #: ../src/guestfs.pod:191
418 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
419 "several other variations of the C<guestfs_mount_*> call."
423 #: ../src/guestfs.pod:194
424 msgid "FILESYSTEM ACCESS AND MODIFICATION"
428 #: ../src/guestfs.pod:196
430 "The majority of the libguestfs API consists of fairly low-level calls for "
431 "accessing and modifying the files, directories, symlinks etc on mounted "
432 "filesystems. There are over a hundred such calls which you can find listed "
433 "in detail below in this man page, and we don't even pretend to cover them "
434 "all in this overview."
438 #: ../src/guestfs.pod:202
440 "Specify filenames as full paths, starting with C<\"/\"> and including the "
445 #: ../src/guestfs.pod:205
447 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
448 "the file called C<\"etc/passwd\"> then you could do:"
452 #: ../src/guestfs.pod:208
455 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
460 #: ../src/guestfs.pod:210
462 "This would return C<data> as a newly allocated buffer containing the full "
463 "content of that file (with some conditions: see also L</DOWNLOADING> below),"
464 " or C<NULL> if there was an error."
468 #: ../src/guestfs.pod:214
470 "As another example, to create a top-level directory on that filesystem "
471 "called C<\"var\"> you would do:"
475 #: ../src/guestfs.pod:217
478 " guestfs_mkdir (g, \"/var\");\n"
483 #: ../src/guestfs.pod:219
484 msgid "To create a symlink you could do:"
488 #: ../src/guestfs.pod:221
491 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
492 " \"/etc/rc3.d/S30portmap\");\n"
497 #: ../src/guestfs.pod:224
499 "Libguestfs will reject attempts to use relative paths and there is no "
500 "concept of a current working directory."
504 #: ../src/guestfs.pod:227
506 "Libguestfs can return errors in many situations: for example if the "
507 "filesystem isn't writable, or if a file or directory that you requested "
508 "doesn't exist. If you are using the C API (documented here) you have to "
509 "check for those error conditions after each call. (Other language bindings "
510 "turn these errors into exceptions)."
514 #: ../src/guestfs.pod:233
516 "File writes are affected by the per-handle umask, set by calling "
517 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
521 #: ../src/guestfs.pod:236
526 #: ../src/guestfs.pod:238
528 "Libguestfs contains API calls to read, create and modify partition tables on"
533 #: ../src/guestfs.pod:241
535 "In the common case where you want to create a single partition covering the "
536 "whole disk, you should use the L</guestfs_part_disk> call:"
540 #: ../src/guestfs.pod:245
543 " const char *parttype = \"mbr\";\n"
544 " if (disk_is_larger_than_2TB)\n"
545 " parttype = \"gpt\";\n"
546 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
551 #: ../src/guestfs.pod:250
553 "Obviously this effectively wipes anything that was on that disk image "
558 #: ../src/guestfs.pod:253
563 #: ../src/guestfs.pod:255
565 "Libguestfs provides access to a large part of the LVM2 API, such as "
566 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
567 "unless you familiarize yourself with the concepts of physical volumes, "
568 "volume groups and logical volumes."
572 #: ../src/guestfs.pod:260
574 "This author strongly recommends reading the LVM HOWTO, online at "
575 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
579 #: ../src/guestfs.pod:263
584 #: ../src/guestfs.pod:265
586 "Use L</guestfs_cat> to download small, text only files. This call is "
587 "limited to files which are less than 2 MB and which cannot contain any ASCII"
588 " NUL (C<\\0>) characters. However the API is very simple to use."
592 #: ../src/guestfs.pod:269
594 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
595 "bit data, since it returns a (pointer, size) pair. However it is still "
596 "limited to \"small\" files, less than 2 MB."
600 #: ../src/guestfs.pod:273
602 "L</guestfs_download> can be used to download any file, with no limits on "
603 "content or size (even files larger than 4 GB)."
607 #: ../src/guestfs.pod:276
609 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
613 #: ../src/guestfs.pod:279
618 #: ../src/guestfs.pod:281
620 "It's often the case that you want to write a file or files to the disk "
625 #: ../src/guestfs.pod:284
627 "To write a small file with fixed content, use L</guestfs_write>. To create "
628 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
629 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
630 "variety of other functions for creating test files, for example "
631 "L</guestfs_fill> and L</guestfs_fill_pattern>."
635 #: ../src/guestfs.pod:290
637 "To upload a single file, use L</guestfs_upload>. This call has no limits on"
638 " file content or size (even files larger than 4 GB)."
642 #: ../src/guestfs.pod:293
644 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
648 #: ../src/guestfs.pod:295
650 "However the fastest way to upload I<large numbers of arbitrary files> is to "
651 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
652 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add"
653 " the drive in a predictable way (eg. adding it last after all other drives) "
654 "then you can get the device name from L</guestfs_list_devices> and mount it "
655 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
656 "sometimes non-portable between kernel versions, and they don't support "
657 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
658 "using a label or UUID, use an ISO image instead."
662 #: ../src/guestfs.pod:306
667 #: ../src/guestfs.pod:308
669 "There are various different commands for copying between files and devices "
670 "and in and out of the guest filesystem. These are summarised in the table "
675 #: ../src/guestfs.pod:314
676 msgid "B<file> to B<file>"
680 #: ../src/guestfs.pod:316
682 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
683 "directories recursively."
687 #: ../src/guestfs.pod:319
688 msgid "B<file or device> to B<file or device>"
692 #: ../src/guestfs.pod:321
694 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and"
695 " devices in the guest."
699 #: ../src/guestfs.pod:324
700 msgid "Example: duplicate the contents of an LV:"
704 #: ../src/guestfs.pod:326
707 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
712 #: ../src/guestfs.pod:328
714 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
715 "(C</dev/VG/Original>). To copy less than the whole source device, use "
716 "L</guestfs_copy_size>."
720 #: ../src/guestfs.pod:332
721 msgid "B<file on the host> to B<file or device>"
725 #: ../src/guestfs.pod:334
726 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
730 #: ../src/guestfs.pod:336
731 msgid "B<file or device> to B<file on the host>"
735 #: ../src/guestfs.pod:338
736 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
740 #: ../src/guestfs.pod:342
741 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
745 #: ../src/guestfs.pod:344
747 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
748 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
749 "appears you can only upload and download to files. However many Un*x-like "
750 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
751 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
752 "stderr, and arbitrary file descriptor N."
756 #: ../src/guestfs.pod:352
757 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
761 #: ../src/guestfs.pod:355
764 " guestfs_download (g, filename, \"/dev/stdout\");\n"
769 #: ../src/guestfs.pod:357
770 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
774 #: ../src/guestfs.pod:359
778 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
779 " guestfs_tar_out (g, \"/\", devfd);\n"
784 #: ../src/guestfs.pod:363
785 msgid "LISTING FILES"
789 #: ../src/guestfs.pod:365
791 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
792 "L<guestfish(1)>-equivalent command C<ll>)."
796 #: ../src/guestfs.pod:368
798 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
799 "programs, as a flat list of strings."
803 #: ../src/guestfs.pod:371
805 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
806 "directory, plus additional information about each one. It is more "
807 "equivalent to using the L<readdir(3)> call on a local filesystem."
811 #: ../src/guestfs.pod:375
813 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
818 #: ../src/guestfs.pod:378
819 msgid "RUNNING COMMANDS"
823 #: ../src/guestfs.pod:380
825 "Although libguestfs is primarily an API for manipulating files inside guest "
826 "images, we also provide some limited facilities for running commands inside "
831 #: ../src/guestfs.pod:384
832 msgid "There are many limitations to this:"
836 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398
837 #: ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411
838 #: ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1064
839 #: ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077
840 #: ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112
841 #: ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142
842 #: ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154
843 #: ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652
844 #: ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763
845 #: ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052
846 #: ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420
847 #: ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437
848 #: ../src/guestfs.pod:3011 ../src/guestfs.pod:3015 ../src/guestfs.pod:3019
849 #: ../src/guestfs.pod:3023 ../src/guestfs-actions.pod:15
850 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
851 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
852 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662
853 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670
854 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682
855 #: ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690
856 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704
857 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846
858 #: ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855
859 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921
860 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930
861 #: ../src/guestfs-actions.pod:2857 ../src/guestfs-actions.pod:2863
862 #: ../src/guestfs-actions.pod:2871 ../src/guestfs-actions.pod:2878
863 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish.pod:445
864 #: ../fish/guestfish.pod:449 ../fish/guestfish.pod:453
865 #: ../fish/guestfish.pod:457 ../fish/guestfish-actions.pod:13
866 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:385
867 #: ../fish/guestfish-actions.pod:393 ../fish/guestfish-actions.pod:400
868 #: ../fish/guestfish-actions.pod:407 ../fish/guestfish-actions.pod:1099
869 #: ../fish/guestfish-actions.pod:1103 ../fish/guestfish-actions.pod:1107
870 #: ../fish/guestfish-actions.pod:1111 ../fish/guestfish-actions.pod:1119
871 #: ../fish/guestfish-actions.pod:1123 ../fish/guestfish-actions.pod:1127
872 #: ../fish/guestfish-actions.pod:1137 ../fish/guestfish-actions.pod:1141
873 #: ../fish/guestfish-actions.pod:1145 ../fish/guestfish-actions.pod:1235
874 #: ../fish/guestfish-actions.pod:1239 ../fish/guestfish-actions.pod:1244
875 #: ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1291
876 #: ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:1300
877 #: ../fish/guestfish-actions.pod:1933 ../fish/guestfish-actions.pod:1939
878 #: ../fish/guestfish-actions.pod:1947 ../fish/guestfish-actions.pod:1954
879 #: ../fish/guestfish-actions.pod:1961 ../tools/virt-win-reg.pl:195
880 #: ../tools/virt-win-reg.pl:200 ../tools/virt-win-reg.pl:206
881 #: ../tools/virt-win-reg.pl:708 ../tools/virt-win-reg.pl:714
882 #: ../tools/virt-win-reg.pl:720
887 #: ../src/guestfs.pod:390
889 "The kernel version that the command runs under will be different from what "
894 #: ../src/guestfs.pod:395
896 "If the command needs to communicate with daemons, then most likely they "
901 #: ../src/guestfs.pod:400
902 msgid "The command will be running in limited memory."
906 #: ../src/guestfs.pod:404
908 "The network may not be available unless you enable it (see "
909 "L</guestfs_set_network>)."
913 #: ../src/guestfs.pod:409
914 msgid "Only supports Linux guests (not Windows, BSD, etc)."
918 #: ../src/guestfs.pod:413
920 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
924 #: ../src/guestfs.pod:418
926 "For SELinux guests, you may need to enable SELinux and load policy first. "
927 "See L</SELINUX> in this manpage."
931 #: ../src/guestfs.pod:423
933 "I<Security:> It is not safe to run commands from untrusted, possibly "
934 "malicious guests. These commands may attempt to exploit your program by "
935 "sending unexpected output. They could also try to exploit the Linux kernel "
936 "or qemu provided by the libguestfs appliance. They could use the network "
937 "provided by the libguestfs appliance to bypass ordinary network partitions "
938 "and firewalls. They could use the elevated privileges or different SELinux "
939 "context of your program to their advantage."
943 #: ../src/guestfs.pod:432
945 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
946 "(a script which runs when the guest next boots normally), and to have this "
947 "script run the commands you want in the normal context of the running guest,"
948 " network security and so on. For information about other security issues, "
953 #: ../src/guestfs.pod:440
955 "The two main API calls to run commands are L</guestfs_command> and "
956 "L</guestfs_sh> (there are also variations)."
960 #: ../src/guestfs.pod:443
962 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
963 "shell globs, redirections, etc will work."
967 #: ../src/guestfs.pod:446
968 msgid "CONFIGURATION FILES"
972 #: ../src/guestfs.pod:448
974 "To read and write configuration files in Linux guest filesystems, we "
975 "strongly recommend using Augeas. For example, Augeas understands how to "
976 "read and write, say, a Linux shadow password file or X.org configuration "
977 "file, and so avoids you having to write that code."
981 #: ../src/guestfs.pod:453
983 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't"
984 " document Augeas itself here because there is excellent documentation on the"
985 " L<http://augeas.net/> website."
989 #: ../src/guestfs.pod:457
991 "If you don't want to use Augeas (you fool!) then try calling "
992 "L</guestfs_read_lines> to get the file as a list of lines which you can "
997 #: ../src/guestfs.pod:461
1002 #: ../src/guestfs.pod:463
1004 "We support SELinux guests. To ensure that labeling happens correctly in "
1005 "SELinux guests, you need to enable SELinux and load the guest's policy:"
1009 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
1010 #: ../src/guestfs.pod:2465
1015 #: ../src/guestfs.pod:471
1016 msgid "Before launching, do:"
1020 #: ../src/guestfs.pod:473
1023 " guestfs_set_selinux (g, 1);\n"
1028 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
1029 #: ../src/guestfs.pod:2490
1034 #: ../src/guestfs.pod:477
1036 "After mounting the guest's filesystem(s), load the policy. This is best "
1037 "done by running the L<load_policy(8)> command in the guest itself:"
1041 #: ../src/guestfs.pod:481
1044 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
1049 #: ../src/guestfs.pod:483
1051 "(Older versions of C<load_policy> require you to specify the name of the "
1056 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
1061 #: ../src/guestfs.pod:488
1063 "Optionally, set the security context for the API. The correct security "
1064 "context to use can only be known by inspecting the guest. As an example:"
1068 #: ../src/guestfs.pod:492
1071 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1076 #: ../src/guestfs.pod:496
1077 msgid "This will work for running commands and editing existing files."
1081 #: ../src/guestfs.pod:498
1083 "When new files are created, you may need to label them explicitly, for "
1084 "example by running the external command C<restorecon pathname>."
1088 #: ../src/guestfs.pod:502
1093 #: ../src/guestfs.pod:504
1095 "Certain calls are affected by the current file mode creation mask (the "
1096 "\"umask\"). In particular ones which create files or directories, such as "
1097 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1098 "either the default mode that the file is created with or modifies the mode "
1103 #: ../src/guestfs.pod:510
1105 "The default umask is C<022>, so files are created with modes such as C<0644>"
1106 " and directories with C<0755>."
1110 #: ../src/guestfs.pod:513
1112 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1113 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
1114 "L</guestfs_chmod> after creating each file or directory."
1118 #: ../src/guestfs.pod:517
1119 msgid "For more information about umask, see L<umask(2)>."
1123 #: ../src/guestfs.pod:519 ../fish/guestfish.pod:825
1124 msgid "ENCRYPTED DISKS"
1128 #: ../src/guestfs.pod:521
1130 "Libguestfs allows you to access Linux guests which have been encrypted using"
1131 " whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1132 "standard. This includes nearly all whole disk encryption systems used by "
1133 "modern Linux guests."
1137 #: ../src/guestfs.pod:527
1139 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1140 "returns the string C<crypto_LUKS>)."
1144 #: ../src/guestfs.pod:530
1146 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1147 "will require the passphrase!"
1151 #: ../src/guestfs.pod:533
1153 "Opening a LUKS device creates a new device mapper device called "
1154 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1155 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1156 "decrypted from and encrypted to the underlying block device respectively."
1160 #: ../src/guestfs.pod:539
1162 "LVM volume groups on the device can be made visible by calling "
1163 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1164 "volume(s) can now be mounted in the usual way."
1168 #: ../src/guestfs.pod:543
1170 "Use the reverse process to close a LUKS device. Unmount any logical volumes"
1171 " on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1172 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1173 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1174 "underlying encrypted block device)."
1178 #: ../src/guestfs.pod:550
1183 #: ../src/guestfs.pod:552
1185 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1186 "contains operating systems, an install CD or a live CD. (These APIs used to"
1187 " be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since"
1188 " version 1.5.3 the most frequently used part of this library has been "
1189 "rewritten in C and moved into the core code)."
1193 #: ../src/guestfs.pod:559
1195 "Add all disks belonging to the unknown virtual machine and call "
1196 "L</guestfs_launch> in the usual way."
1200 #: ../src/guestfs.pod:562
1202 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls"
1203 " and certain heuristics, and returns a list of operating systems that were "
1204 "found. An empty list means none were found. A single element is the root "
1205 "filesystem of the operating system. For dual- or multi-boot guests, "
1206 "multiple roots can be returned, each one corresponding to a separate "
1207 "operating system. (Multi-boot virtual machines are extremely rare in the "
1208 "world of virtualization, but since this scenario can happen, we have built "
1209 "libguestfs to deal with it.)"
1213 #: ../src/guestfs.pod:571
1215 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1216 "to get additional details about that operating system. For example, call "
1217 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for"
1218 " Windows and Linux-based operating systems respectively."
1222 #: ../src/guestfs.pod:577
1224 "Un*x-like and Linux-based operating systems usually consist of several "
1225 "filesystems which are mounted at boot time (for example, a separate boot "
1226 "partition mounted on C</boot>). The inspection rules are able to detect how"
1227 " filesystems correspond to mount points. Call "
1228 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1229 "hash table like this example:"
1233 #: ../src/guestfs.pod:584
1236 " /boot => /dev/sda1\n"
1237 " / => /dev/vg_guest/lv_root\n"
1238 " /usr => /dev/vg_guest/lv_usr\n"
1243 #: ../src/guestfs.pod:588
1245 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1246 "filesystems as suggested."
1250 #: ../src/guestfs.pod:591
1252 "Be careful to mount filesystems in the right order (eg. C</> before "
1253 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1258 #: ../src/guestfs.pod:595
1260 "Inspection currently only works for some common operating systems. "
1261 "Contributors are welcome to send patches for other operating systems that we"
1262 " currently cannot detect."
1266 #: ../src/guestfs.pod:599
1268 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1269 "for more details. The L</guestfs_inspect_os> function just ignores any "
1270 "encrypted devices."
1274 #: ../src/guestfs.pod:603
1276 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1277 "inspection and caches the results in the guest handle. Subsequent calls to "
1278 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1279 "read the disks. If you change the content of the guest disks, you can redo "
1280 "inspection by calling L</guestfs_inspect_os> again. "
1281 "(L</guestfs_inspect_list_applications> works a little differently from the "
1282 "other calls and does read the disks. See documentation for that function "
1287 #: ../src/guestfs.pod:612
1288 msgid "INSPECTING INSTALL DISKS"
1292 #: ../src/guestfs.pod:614
1294 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
1299 #: ../src/guestfs.pod:617
1301 "Call L</guestfs_inspect_get_format> to return the format of the operating "
1302 "system, which currently can be C<installed> (a regular operating system) or "
1303 "C<installer> (some sort of install disk)."
1307 #: ../src/guestfs.pod:621
1309 "Further information is available about the operating system that can be "
1310 "installed using the regular inspection APIs like "
1311 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
1316 #: ../src/guestfs.pod:626
1318 "Some additional information specific to installer disks is also available "
1319 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
1320 "L</guestfs_inspect_is_multipart> calls."
1324 #: ../src/guestfs.pod:631
1325 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1329 #: ../src/guestfs.pod:633
1331 "Libguestfs can mount NTFS partitions. It does this using the L<http://www"
1332 ".ntfs-3g.org/> driver."
1336 #: ../src/guestfs.pod:636
1337 msgid "DRIVE LETTERS AND PATHS"
1341 #: ../src/guestfs.pod:638
1343 "DOS and Windows still use drive letters, and the filesystems are always "
1344 "treated as case insensitive by Windows itself, and therefore you might find "
1345 "a Windows configuration file referring to a path like "
1346 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1347 "that directory might be referred to as C</WINDOWS/System32>."
1351 #: ../src/guestfs.pod:644
1353 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
1354 "L</guestfs_inspect_get_drive_mappings>)"
1358 #: ../src/guestfs.pod:647
1360 "Dealing with separator characters (backslash vs forward slash) is outside "
1361 "the scope of libguestfs, but usually a simple character replacement will "
1366 #: ../src/guestfs.pod:651
1368 "To resolve the case insensitivity of paths, call "
1369 "L</guestfs_case_sensitive_path>."
1373 #: ../src/guestfs.pod:654
1374 msgid "ACCESSING THE WINDOWS REGISTRY"
1378 #: ../src/guestfs.pod:656
1380 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1381 "files, through the library C<hivex> which is part of the libguestfs project "
1382 "although ships as a separate tarball. You have to locate and download the "
1383 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1384 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-"
1385 "win-reg(1)> for more help on this issue."
1389 #: ../src/guestfs.pod:664
1390 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
1394 #: ../src/guestfs.pod:666
1396 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
1397 "provide something which looks like a Linux symlink. The way it tries to do "
1398 "the rewriting is described here:"
1402 #: ../src/guestfs.pod:670
1404 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
1409 #: ../src/guestfs.pod:672
1411 "The essential problem is that ntfs-3g simply does not have enough "
1412 "information to do a correct job. NTFS links can contain drive letters and "
1413 "references to external device GUIDs that ntfs-3g has no way of resolving. "
1414 "It is almost certainly the case that libguestfs callers should ignore what "
1415 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
1419 #: ../src/guestfs.pod:679
1421 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
1422 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
1423 "attribute, and read the raw reparse data from that (you can find the format "
1424 "documented in various places around the web)."
1428 #: ../src/guestfs.pod:684
1429 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
1433 #: ../src/guestfs.pod:686
1435 "There are other useful extended attributes that can be read from ntfs-3g "
1436 "filesystems (using L</guestfs_getxattr>). See:"
1440 #: ../src/guestfs.pod:689
1442 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
1446 #: ../src/guestfs.pod:691
1447 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1451 #: ../src/guestfs.pod:693
1453 "Although we don't want to discourage you from using the C API, we will "
1454 "mention here that the same API is also available in other languages."
1458 #: ../src/guestfs.pod:696
1460 "The API is broadly identical in all supported languages. This means that "
1461 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)>"
1462 " in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
1463 "OCaml. In other words, a straightforward, predictable isomorphism between "
1468 #: ../src/guestfs.pod:702
1470 "Error messages are automatically transformed into exceptions if the language"
1475 #: ../src/guestfs.pod:705
1477 "We don't try to \"object orientify\" parts of the API in OO languages, "
1478 "although contributors are welcome to write higher level APIs above what we "
1479 "provide in their favourite languages if they wish."
1483 #: ../src/guestfs.pod:711
1488 #: ../src/guestfs.pod:713
1490 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1491 "identical to the C API. C++ classes and exceptions are not used."
1495 #: ../src/guestfs.pod:717
1500 #: ../src/guestfs.pod:719
1502 "The C# bindings are highly experimental. Please read the warnings at the "
1503 "top of C<csharp/Libguestfs.cs>."
1507 #: ../src/guestfs.pod:722
1512 #: ../src/guestfs.pod:724
1514 "This is the only language binding that is working but incomplete. Only "
1515 "calls which return simple integers have been bound in Haskell, and we are "
1516 "looking for help to complete this binding."
1520 #: ../src/guestfs.pod:728
1525 #: ../src/guestfs.pod:730
1527 "Full documentation is contained in the Javadoc which is distributed with "
1532 #: ../src/guestfs.pod:733
1537 #: ../src/guestfs.pod:735
1538 msgid "See L<guestfs-ocaml(3)>."
1542 #: ../src/guestfs.pod:737
1547 #: ../src/guestfs.pod:739
1548 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
1552 #: ../src/guestfs.pod:741
1557 #: ../src/guestfs.pod:743
1559 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1560 "the php-libguestfs package for your distribution."
1564 #: ../src/guestfs.pod:746
1565 msgid "The PHP binding only works correctly on 64 bit machines."
1569 #: ../src/guestfs.pod:748
1574 #: ../src/guestfs.pod:750
1575 msgid "See L<guestfs-python(3)>."
1579 #: ../src/guestfs.pod:752
1584 #: ../src/guestfs.pod:754
1585 msgid "See L<guestfs-ruby(3)>."
1589 #: ../src/guestfs.pod:756
1590 msgid "B<shell scripts>"
1594 #: ../src/guestfs.pod:758
1595 msgid "See L<guestfish(1)>."
1599 #: ../src/guestfs.pod:762
1600 msgid "LIBGUESTFS GOTCHAS"
1604 #: ../src/guestfs.pod:764
1606 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1607 "system [...] that works in the way it is documented but is counterintuitive "
1608 "and almost invites mistakes.\""
1612 #: ../src/guestfs.pod:768
1614 "Since we developed libguestfs and the associated tools, there are several "
1615 "things we would have designed differently, but are now stuck with for "
1616 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0"
1617 " release, you can expect these to change. Beware of them."
1621 #: ../src/guestfs.pod:776
1622 msgid "Autosync / forgetting to sync."
1626 #: ../src/guestfs.pod:778
1628 "I<Update:> Autosync is enabled by default for all API users starting from "
1629 "libguestfs 1.5.24. This section only applies to older versions."
1633 #: ../src/guestfs.pod:781
1635 "When modifying a filesystem from C or another language, you B<must> unmount "
1636 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1637 "libguestfs handle. You can also call:"
1641 #: ../src/guestfs.pod:785
1644 " guestfs_set_autosync (g, 1);\n"
1649 #: ../src/guestfs.pod:787
1651 "to have the unmount/sync done automatically for you when the handle 'g' is "
1652 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1657 #: ../src/guestfs.pod:791
1659 "If you forget to do this, then it is entirely possible that your changes "
1660 "won't be written out, or will be partially written, or (very rarely) that "
1661 "you'll get disk corruption."
1665 #: ../src/guestfs.pod:795
1667 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1668 "guestfish scripts that forget to sync will work just fine, which can make "
1669 "this very puzzling if you are trying to debug a problem."
1673 #: ../src/guestfs.pod:799
1674 msgid "Mount option C<-o sync> should not be the default."
1678 #: ../src/guestfs.pod:801
1680 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly."
1681 " However C<-o sync> does not add any reliability benefit, but does have a "
1682 "very large performance impact."
1686 #: ../src/guestfs.pod:805
1688 "The work around is to use L</guestfs_mount_options> and set the mount "
1689 "options that you actually want to use."
1693 #: ../src/guestfs.pod:808
1694 msgid "Read-only should be the default."
1698 #: ../src/guestfs.pod:810
1700 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1701 "specify I<--rw> if you want to make changes to the image."
1705 #: ../src/guestfs.pod:813
1706 msgid "This would reduce the potential to corrupt live VM images."
1710 #: ../src/guestfs.pod:815
1712 "Note that many filesystems change the disk when you just mount and unmount, "
1713 "even if you didn't perform any writes. You need to use "
1714 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1718 #: ../src/guestfs.pod:819
1719 msgid "guestfish command line is hard to use."
1723 #: ../src/guestfs.pod:821
1725 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1726 "examination). It tries to run a guestfish command C<disk.img> which doesn't"
1727 " exist, so it fails. In earlier versions of guestfish the error message was"
1728 " also unintuitive, but we have corrected this since. Like the Bourne shell,"
1729 " we should have used C<guestfish -c command> to run commands."
1733 #: ../src/guestfs.pod:828
1734 msgid "guestfish megabyte modifiers don't work right on all commands"
1738 #: ../src/guestfs.pod:830
1740 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1741 "other modifiers). What guestfish actually does is to multiply the number "
1742 "part by the modifier part and pass the result to the C API. However this "
1743 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1744 "expecting some other unit (eg. megabytes)."
1748 #: ../src/guestfs.pod:837
1749 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1753 #: ../src/guestfs.pod:839
1756 " lvcreate LV VG 100M\n"
1761 #: ../src/guestfs.pod:841
1763 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1764 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1765 "megabytes * megabytes) logical volume. The error message you get from this "
1766 "is also a little obscure."
1770 #: ../src/guestfs.pod:846
1772 "This could be fixed in the generator by specially marking parameters and "
1773 "return values which take bytes or other units."
1777 #: ../src/guestfs.pod:849
1778 msgid "Ambiguity between devices and paths"
1782 #: ../src/guestfs.pod:851
1784 "There is a subtle ambiguity in the API between a device name (eg. "
1785 "C</dev/sdb2>) and a similar pathname. A file might just happen to be called"
1786 " C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1790 #: ../src/guestfs.pod:856
1792 "In the current API we usually resolve this ambiguity by having two separate "
1793 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1794 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1795 "detecting if the path supplied begins with C</dev/>."
1799 #: ../src/guestfs.pod:862
1801 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1802 "make paths/devices into structured names. One way to do this would be to "
1803 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1804 "aspect of grub. Another way would be to use a structured type, equivalent "
1805 "to this OCaml type:"
1809 #: ../src/guestfs.pod:868
1812 " type path = Path of string | Device of int | Partition of int * int\n"
1817 #: ../src/guestfs.pod:870
1818 msgid "which would allow you to pass arguments like:"
1822 #: ../src/guestfs.pod:872
1825 " Path \"/foo/bar\"\n"
1826 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1827 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1828 " Path \"/dev/sdb2\" (* not a device *)\n"
1833 #: ../src/guestfs.pod:877
1835 "As you can see there are still problems to resolve even with this "
1836 "representation. Also consider how it might work in guestfish."
1840 #: ../src/guestfs.pod:882
1841 msgid "KEYS AND PASSPHRASES"
1845 #: ../src/guestfs.pod:884
1847 "Certain libguestfs calls take a parameter that contains sensitive key "
1848 "material, passed in as a C string."
1852 #: ../src/guestfs.pod:887
1854 "In the future we would hope to change the libguestfs implementation so that "
1855 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1856 "swap. However this is I<not> done at the moment, because of the complexity "
1857 "of such an implementation."
1861 #: ../src/guestfs.pod:892
1863 "Therefore you should be aware that any key parameter you pass to libguestfs "
1864 "might end up being written out to the swap partition. If this is a concern,"
1865 " scrub the swap partition or don't use libguestfs on encrypted devices."
1869 #: ../src/guestfs.pod:897
1870 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1874 #: ../src/guestfs.pod:899
1876 "All high-level libguestfs actions are synchronous. If you want to use "
1877 "libguestfs asynchronously then you must create a thread."
1881 #: ../src/guestfs.pod:902
1883 "Only use the handle from a single thread. Either use the handle exclusively"
1884 " from one thread, or provide your own mutex so that two threads cannot issue"
1885 " calls on the same handle at the same time."
1889 #: ../src/guestfs.pod:906
1891 "See the graphical program guestfs-browser for one possible architecture for "
1892 "multithreaded programs using libvirt and libguestfs."
1896 #: ../src/guestfs.pod:909
1901 #: ../src/guestfs.pod:911
1903 "Libguestfs needs a supermin appliance, which it finds by looking along an "
1908 #: ../src/guestfs.pod:914
1910 "By default it looks for these in the directory C<$libdir/guestfs> (eg. "
1911 "C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1915 #: ../src/guestfs.pod:917
1917 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH>"
1918 " to change the directories that libguestfs will search in. The value is a "
1919 "colon-separated list of paths. The current directory is I<not> searched "
1920 "unless the path contains an empty element or C<.>. For example "
1921 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1922 "then C</usr/lib/guestfs>."
1926 #: ../src/guestfs.pod:924
1927 msgid "QEMU WRAPPERS"
1931 #: ../src/guestfs.pod:926
1933 "If you want to compile your own qemu, run qemu from a non-standard location,"
1934 " or pass extra arguments to qemu, then you can write a shell-script wrapper "
1939 #: ../src/guestfs.pod:930
1941 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1942 "last command in the shell script (so that qemu replaces the shell and "
1943 "becomes the direct child of the libguestfs-using program). If you don't do "
1944 "this, then the qemu process won't be cleaned up correctly."
1948 #: ../src/guestfs.pod:935
1950 "Here is an example of a wrapper, where I have built my own copy of qemu from"
1955 #: ../src/guestfs.pod:938
1959 " qemudir=/home/rjones/d/qemu\n"
1960 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1965 #: ../src/guestfs.pod:942
1967 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1968 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1973 #: ../src/guestfs.pod:946
1976 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1981 #: ../src/guestfs.pod:948
1983 "Note that libguestfs also calls qemu with the -help and -version options in "
1984 "order to determine features."
1988 #: ../src/guestfs.pod:951
1989 msgid "ATTACHING TO RUNNING DAEMONS"
1993 #: ../src/guestfs.pod:953
1995 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
1996 "babies. Use with caution."
2000 #: ../src/guestfs.pod:956
2002 "I<Note (2):> This section explains how to attach to a running daemon from a "
2003 "low level perspective. For most users, simply using virt tools such as "
2004 "L<guestfish(1)> with the I<--live> option will \"just work\"."
2008 #: ../src/guestfs.pod:960
2009 msgid "Using guestfs_set_attach_method"
2013 #: ../src/guestfs.pod:962
2015 "By calling L</guestfs_set_attach_method> you can change how the library "
2016 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
2017 "L</ARCHITECTURE> for some background)."
2021 #: ../src/guestfs.pod:966
2023 "The normal attach method is C<appliance>, where a small appliance is created"
2024 " containing the daemon, and then the library connects to this."
2028 #: ../src/guestfs.pod:969
2030 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
2031 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
2032 "daemon over the Unix domain socket."
2036 #: ../src/guestfs.pod:973
2038 "The normal use for this is to connect to a running virtual machine that "
2039 "contains a C<guestfsd> daemon, and send commands so you can read and write "
2040 "files inside the live virtual machine."
2044 #: ../src/guestfs.pod:977
2045 msgid "Using guestfs_add_domain with live flag"
2049 #: ../src/guestfs.pod:979
2051 "L</guestfs_add_domain> provides some help for getting the correct attach "
2052 "method. If you pass the C<live> option to this function, then (if the "
2053 "virtual machine is running) it will examine the libvirt XML looking for a "
2054 "virtio-serial channel to connect to:"
2058 #: ../src/guestfs.pod:985
2065 " <channel type='unix'>\n"
2066 " <source mode='bind' path='/path/to/socket'/>\n"
2067 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
2076 #: ../src/guestfs.pod:997
2078 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
2079 "method to C<unix:/path/to/socket>."
2083 #: ../src/guestfs.pod:1000
2085 "Some of the libguestfs tools (including guestfish) support a I<--live> "
2086 "option which is passed through to L</guestfs_add_domain> thus allowing you "
2087 "to attach to and modify live virtual machines."
2091 #: ../src/guestfs.pod:1004
2093 "The virtual machine needs to have been set up beforehand so that it has the "
2094 "virtio-serial channel and so that guestfsd is running inside it."
2098 #: ../src/guestfs.pod:1008
2099 msgid "ABI GUARANTEE"
2103 #: ../src/guestfs.pod:1010
2105 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
2106 "actions as outlined in this section. Although we will deprecate some "
2107 "actions, for example if they get replaced by newer calls, we will keep the "
2108 "old actions forever. This allows you the developer to program in confidence"
2109 " against the libguestfs API."
2113 #: ../src/guestfs.pod:1016
2114 msgid "BLOCK DEVICE NAMING"
2118 #: ../src/guestfs.pod:1018
2120 "In the kernel there is now quite a profusion of schemata for naming block "
2121 "devices (in this context, by I<block device> I mean a physical or virtual "
2122 "hard drive). The original Linux IDE driver used names starting with "
2123 "C</dev/hd*>. SCSI devices have historically used a different naming scheme,"
2124 " C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
2125 "replacement for the old IDE driver (particularly for SATA devices) those "
2126 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
2127 "machines with paravirtualized drivers. This has created several different "
2128 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
2133 #: ../src/guestfs.pod:1030
2135 "As discussed above, libguestfs uses a qemu appliance running an embedded "
2136 "Linux kernel to access block devices. We can run a variety of appliances "
2137 "based on a variety of Linux kernels."
2141 #: ../src/guestfs.pod:1034
2143 "This causes a problem for libguestfs because many API calls use device or "
2144 "partition names. Working scripts and the recipe (example) scripts that we "
2145 "make available over the internet could fail if the naming scheme changes."
2149 #: ../src/guestfs.pod:1039
2151 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
2152 "Internally C</dev/sd*> names are translated, if necessary, to other names as"
2153 " required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any"
2154 " device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
2158 #: ../src/guestfs.pod:1045
2160 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>,"
2161 " L</guestfs_list_partitions> and similar calls return the true names of the "
2162 "devices and partitions as known to the appliance."
2166 #: ../src/guestfs.pod:1050
2167 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
2171 #: ../src/guestfs.pod:1052
2173 "Usually this translation is transparent. However in some (very rare) cases"
2174 " you may need to know the exact algorithm. Such cases include where you use"
2175 " L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
2176 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
2180 #: ../src/guestfs.pod:1058
2182 "The algorithm is applied only to I<parameters> which are known to be either "
2183 "device or partition names. Return values from functions such as "
2184 "L</guestfs_list_devices> are never changed."
2188 #: ../src/guestfs.pod:1066
2189 msgid "Is the string a parameter which is a device or partition name?"
2193 #: ../src/guestfs.pod:1070
2194 msgid "Does the string begin with C</dev/sd>?"
2198 #: ../src/guestfs.pod:1074
2200 "Does the named device exist? If so, we use that device. However if I<not> "
2201 "then we continue with this algorithm."
2205 #: ../src/guestfs.pod:1079
2206 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
2210 #: ../src/guestfs.pod:1081
2211 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
2215 #: ../src/guestfs.pod:1083
2216 msgid "If that named device exists, use it. If not, continue."
2220 #: ../src/guestfs.pod:1087
2221 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
2225 #: ../src/guestfs.pod:1089
2226 msgid "If that named device exists, use it. If not, return an error."
2230 #: ../src/guestfs.pod:1093
2231 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
2235 #: ../src/guestfs.pod:1095
2237 "Although the standard naming scheme and automatic translation is useful for "
2238 "simple programs and guestfish scripts, for larger programs it is best not to"
2239 " rely on this mechanism."
2243 #: ../src/guestfs.pod:1099
2245 "Where possible for maximum future portability programs using libguestfs "
2246 "should use these future-proof techniques:"
2250 #: ../src/guestfs.pod:1106
2252 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2253 "device names, and then use those names directly."
2257 #: ../src/guestfs.pod:1109
2259 "Since those device names exist by definition, they will never be translated."
2263 #: ../src/guestfs.pod:1114
2265 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2266 "filesystem labels."
2270 #: ../src/guestfs.pod:1119
2275 #: ../src/guestfs.pod:1121
2277 "This section discusses security implications of using libguestfs, "
2278 "particularly with untrusted or malicious guests or disk images."
2282 #: ../src/guestfs.pod:1124
2283 msgid "GENERAL SECURITY CONSIDERATIONS"
2287 #: ../src/guestfs.pod:1126
2289 "Be careful with any files or data that you download from a guest (by "
2290 "\"download\" we mean not just the L</guestfs_download> command but any "
2291 "command that reads files, filenames, directories or anything else from a "
2292 "disk image). An attacker could manipulate the data to fool your program "
2293 "into doing the wrong thing. Consider cases such as:"
2297 #: ../src/guestfs.pod:1136
2298 msgid "the data (file etc) not being present"
2302 #: ../src/guestfs.pod:1140
2303 msgid "being present but empty"
2307 #: ../src/guestfs.pod:1144
2308 msgid "being much larger than normal"
2312 #: ../src/guestfs.pod:1148
2313 msgid "containing arbitrary 8 bit data"
2317 #: ../src/guestfs.pod:1152
2318 msgid "being in an unexpected character encoding"
2322 #: ../src/guestfs.pod:1156
2323 msgid "containing homoglyphs."
2327 #: ../src/guestfs.pod:1160
2328 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2332 #: ../src/guestfs.pod:1162
2334 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2335 "(VFS) module can sometimes be escalated into exploits by deliberately "
2336 "creating a malicious, malformed filesystem. These exploits are very severe "
2337 "for two reasons. Firstly there are very many filesystem drivers in the "
2338 "kernel, and many of them are infrequently used and not much developer "
2339 "attention has been paid to the code. Linux userspace helps potential "
2340 "crackers by detecting the filesystem type and automatically choosing the "
2341 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2342 "the administrator. Secondly, a kernel-level exploit is like a local root "
2343 "exploit (worse in some ways), giving immediate and total access to the "
2344 "system right down to the hardware level."
2348 #: ../src/guestfs.pod:1175
2350 "That explains why you should never mount a filesystem from an untrusted "
2351 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2352 "inside a qemu virtual machine, usually running as a non-root user. The "
2353 "attacker would need to write a filesystem which first exploited the kernel, "
2354 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2355 "the libguestfs protocol, and finally to be as serious as the host kernel "
2356 "exploit it would need to escalate its privileges to root. This multi-step "
2357 "escalation, performed by a static piece of data, is thought to be extremely "
2358 "hard to do, although we never say 'never' about security issues."
2362 #: ../src/guestfs.pod:1186
2364 "In any case callers can reduce the attack surface by forcing the filesystem "
2365 "type when mounting (use L</guestfs_mount_vfs>)."
2369 #: ../src/guestfs.pod:1189
2370 msgid "PROTOCOL SECURITY"
2374 #: ../src/guestfs.pod:1191
2376 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a"
2377 " defined upper message size. However a program that uses libguestfs must "
2378 "also take care - for example you can write a program that downloads a binary"
2379 " from a disk image and executes it locally, and no amount of protocol "
2380 "security will save you from the consequences."
2384 #: ../src/guestfs.pod:1197
2385 msgid "INSPECTION SECURITY"
2389 #: ../src/guestfs.pod:1199
2391 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2392 "directly from the guest, and these could contain any 8 bit data. Callers "
2393 "should be careful to escape these before printing them to a structured file "
2394 "(for example, use HTML escaping if creating a web page)."
2398 #: ../src/guestfs.pod:1205
2400 "Guest configuration may be altered in unusual ways by the administrator of "
2401 "the virtual machine, and may not reflect reality (particularly for untrusted"
2402 " or actively malicious guests). For example we parse the hostname from "
2403 "configuration files like C</etc/sysconfig/network> that we find in the "
2404 "guest, but the guest administrator can easily manipulate these files to "
2405 "provide the wrong hostname."
2409 #: ../src/guestfs.pod:1213
2411 "The inspection API parses guest configuration using two external libraries: "
2412 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2413 "designed to be robust in the face of malicious data, although denial of "
2414 "service attacks are still possible, for example with oversized configuration"
2419 #: ../src/guestfs.pod:1219
2420 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2424 #: ../src/guestfs.pod:1221
2426 "Be very cautious about running commands from the guest. By running a "
2427 "command in the guest, you are giving CPU time to a binary that you do not "
2428 "control, under the same user account as the library, albeit wrapped in qemu "
2429 "virtualization. More information and alternatives can be found in the "
2430 "section L</RUNNING COMMANDS>."
2434 #: ../src/guestfs.pod:1227
2435 msgid "CVE-2010-3851"
2439 #: ../src/guestfs.pod:1229
2440 msgid "https://bugzilla.redhat.com/642934"
2444 #: ../src/guestfs.pod:1231
2446 "This security bug concerns the automatic disk format detection that qemu "
2447 "does on disk images."
2451 #: ../src/guestfs.pod:1234
2453 "A raw disk image is just the raw bytes, there is no header. Other disk "
2454 "images like qcow2 contain a special header. Qemu deals with this by looking"
2455 " for one of the known headers, and if none is found then assuming the disk "
2456 "image must be raw."
2460 #: ../src/guestfs.pod:1239
2462 "This allows a guest which has been given a raw disk image to write some "
2463 "other header. At next boot (or when the disk image is accessed by "
2464 "libguestfs) qemu would do autodetection and think the disk image format was,"
2465 " say, qcow2 based on the header written by the guest."
2469 #: ../src/guestfs.pod:1244
2471 "This in itself would not be a problem, but qcow2 offers many features, one "
2472 "of which is to allow a disk image to refer to another image (called the "
2473 "\"backing disk\"). It does this by placing the path to the backing disk "
2474 "into the qcow2 header. This path is not validated and could point to any "
2475 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2476 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2477 "control of the attacker."
2481 #: ../src/guestfs.pod:1252
2483 "In libguestfs this is rather hard to exploit except under two circumstances:"
2487 #: ../src/guestfs.pod:1259
2488 msgid "You have enabled the network or have opened the disk in write mode."
2492 #: ../src/guestfs.pod:1263
2494 "You are also running untrusted code from the guest (see L</RUNNING "
2499 #: ../src/guestfs.pod:1268
2501 "The way to avoid this is to specify the expected disk format when adding "
2502 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2503 "should always do this if the disk is raw format, and it's a good idea for "
2508 #: ../src/guestfs.pod:1273
2510 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2511 "format is fetched from libvirt and passed through."
2515 #: ../src/guestfs.pod:1276
2517 "For libguestfs tools, use the I<--format> command line parameter as "
2522 #: ../src/guestfs.pod:1279
2523 msgid "CONNECTION MANAGEMENT"
2527 #: ../src/guestfs.pod:1281
2532 #: ../src/guestfs.pod:1283
2534 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2535 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2536 "handle and release all resources used."
2540 #: ../src/guestfs.pod:1287
2542 "For information on using multiple handles and threads, see the section "
2543 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
2547 #: ../src/guestfs.pod:1290
2548 msgid "guestfs_create"
2552 #: ../src/guestfs.pod:1292
2555 " guestfs_h *guestfs_create (void);\n"
2560 #: ../src/guestfs.pod:1294
2561 msgid "Create a connection handle."
2565 #: ../src/guestfs.pod:1296
2567 "On success this returns a non-NULL pointer to a handle. On error it returns"
2572 #: ../src/guestfs.pod:1299
2574 "You have to \"configure\" the handle after creating it. This includes "
2575 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
2576 "handle at least once."
2580 #: ../src/guestfs.pod:1303
2581 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2585 #: ../src/guestfs.pod:1305
2587 "You may also want to configure error handling for the handle. See the "
2588 "L</ERROR HANDLING> section below."
2592 #: ../src/guestfs.pod:1308
2593 msgid "guestfs_close"
2597 #: ../src/guestfs.pod:1310
2600 " void guestfs_close (guestfs_h *g);\n"
2605 #: ../src/guestfs.pod:1312
2606 msgid "This closes the connection handle and frees up all resources used."
2610 #: ../src/guestfs.pod:1314
2612 "If autosync was set on the handle and the handle was launched, then this "
2613 "implicitly calls various functions to unmount filesystems and sync the disk."
2614 " See L</guestfs_set_autosync> for more details."
2618 #: ../src/guestfs.pod:1318
2619 msgid "If a close callback was set on the handle, then it is called."
2623 #: ../src/guestfs.pod:1320
2624 msgid "ERROR HANDLING"
2628 #: ../src/guestfs.pod:1322
2630 "API functions can return errors. For example, almost all functions that "
2631 "return C<int> will return C<-1> to indicate an error."
2635 #: ../src/guestfs.pod:1325
2637 "Additional information is available for errors: an error message string and "
2638 "optionally an error number (errno) if the thing that failed was a system "
2643 #: ../src/guestfs.pod:1329
2645 "You can get at the additional information about the last error on the handle"
2646 " by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by "
2647 "setting up an error handler with L</guestfs_set_error_handler>."
2651 #: ../src/guestfs.pod:1334
2653 "When the handle is created, a default error handler is installed which "
2654 "prints the error message string to C<stderr>. For small short-running "
2655 "command line programs it is sufficient to do:"
2659 #: ../src/guestfs.pod:1338
2662 " if (guestfs_launch (g) == -1)\n"
2663 " exit (EXIT_FAILURE);\n"
2668 #: ../src/guestfs.pod:1341
2670 "since the default error handler will ensure that an error message has been "
2671 "printed to C<stderr> before the program exits."
2675 #: ../src/guestfs.pod:1344
2677 "For other programs the caller will almost certainly want to install an "
2678 "alternate error handler or do error handling in-line like this:"
2682 #: ../src/guestfs.pod:1347
2685 " g = guestfs_create ();\n"
2690 #: ../src/guestfs.pod:1349
2693 " /* This disables the default behaviour of printing errors\n"
2695 " guestfs_set_error_handler (g, NULL, NULL);\n"
2700 #: ../src/guestfs.pod:1353
2703 " if (guestfs_launch (g) == -1) {\n"
2704 " /* Examine the error message and print it etc. */\n"
2705 " char *msg = guestfs_last_error (g);\n"
2706 " int errnum = guestfs_last_errno (g);\n"
2707 " fprintf (stderr, \"%s\\n\", msg);\n"
2714 #: ../src/guestfs.pod:1361
2716 "Out of memory errors are handled differently. The default action is to call"
2717 " L<abort(3)>. If this is undesirable, then you can set a handler using "
2718 "L</guestfs_set_out_of_memory_handler>."
2722 #: ../src/guestfs.pod:1365
2724 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2725 "because there is no handle if this happens there is no way to get additional"
2726 " error information. However L</guestfs_create> is supposed to be a "
2727 "lightweight operation which can only fail because of insufficient memory (it"
2728 " returns NULL in this case)."
2732 #: ../src/guestfs.pod:1371
2733 msgid "guestfs_last_error"
2737 #: ../src/guestfs.pod:1373
2740 " const char *guestfs_last_error (guestfs_h *g);\n"
2745 #: ../src/guestfs.pod:1375
2747 "This returns the last error message that happened on C<g>. If there has not"
2748 " been an error since the handle was created, then this returns C<NULL>."
2752 #: ../src/guestfs.pod:1379
2754 "The lifetime of the returned string is until the next error occurs, or "
2755 "L</guestfs_close> is called."
2759 #: ../src/guestfs.pod:1382
2760 msgid "guestfs_last_errno"
2764 #: ../src/guestfs.pod:1384
2767 " int guestfs_last_errno (guestfs_h *g);\n"
2772 #: ../src/guestfs.pod:1386
2773 msgid "This returns the last error number (errno) that happened on C<g>."
2777 #: ../src/guestfs.pod:1388
2778 msgid "If successful, an errno integer not equal to zero is returned."
2782 #: ../src/guestfs.pod:1390
2784 "If no error, this returns 0. This call can return 0 in three situations:"
2788 #: ../src/guestfs.pod:1397
2789 msgid "There has not been any error on the handle."
2793 #: ../src/guestfs.pod:1401
2795 "There has been an error but the errno was meaningless. This corresponds to "
2796 "the case where the error did not come from a failed system call, but for "
2797 "some other reason."
2801 #: ../src/guestfs.pod:1407
2803 "There was an error from a failed system call, but for some reason the errno "
2804 "was not captured and returned. This usually indicates a bug in libguestfs."
2808 #: ../src/guestfs.pod:1413
2810 "Libguestfs tries to convert the errno from inside the applicance into a "
2811 "corresponding errno for the caller (not entirely trivial: the appliance "
2812 "might be running a completely different operating system from the library "
2813 "and error numbers are not standardized across Un*xen). If this could not be"
2814 " done, then the error is translated to C<EINVAL>. In practice this should "
2815 "only happen in very rare circumstances."
2819 #: ../src/guestfs.pod:1421
2820 msgid "guestfs_set_error_handler"
2824 #: ../src/guestfs.pod:1423
2827 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2829 " const char *msg);\n"
2830 " void guestfs_set_error_handler (guestfs_h *g,\n"
2831 " guestfs_error_handler_cb cb,\n"
2837 #: ../src/guestfs.pod:1430
2839 "The callback C<cb> will be called if there is an error. The parameters "
2840 "passed to the callback are an opaque data pointer and the error message "
2845 #: ../src/guestfs.pod:1434
2847 "C<errno> is not passed to the callback. To get that the callback must call "
2848 "L</guestfs_last_errno>."
2852 #: ../src/guestfs.pod:1437
2854 "Note that the message string C<msg> is freed as soon as the callback "
2855 "function returns, so if you want to stash it somewhere you must make your "
2860 #: ../src/guestfs.pod:1441
2861 msgid "The default handler prints messages on C<stderr>."
2865 #: ../src/guestfs.pod:1443
2866 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2870 #: ../src/guestfs.pod:1445
2871 msgid "guestfs_get_error_handler"
2875 #: ../src/guestfs.pod:1447
2878 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2879 " void **opaque_rtn);\n"
2884 #: ../src/guestfs.pod:1450
2885 msgid "Returns the current error handler callback."
2889 #: ../src/guestfs.pod:1452
2890 msgid "guestfs_set_out_of_memory_handler"
2894 #: ../src/guestfs.pod:1454
2897 " typedef void (*guestfs_abort_cb) (void);\n"
2898 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2899 " guestfs_abort_cb);\n"
2904 #: ../src/guestfs.pod:1458
2906 "The callback C<cb> will be called if there is an out of memory situation. "
2907 "I<Note this callback must not return>."
2911 #: ../src/guestfs.pod:1461
2912 msgid "The default is to call L<abort(3)>."
2916 #: ../src/guestfs.pod:1463
2918 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2922 #: ../src/guestfs.pod:1466
2923 msgid "guestfs_get_out_of_memory_handler"
2927 #: ../src/guestfs.pod:1468
2930 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2935 #: ../src/guestfs.pod:1470
2936 msgid "This returns the current out of memory handler."
2940 #: ../src/guestfs.pod:1472
2945 #: ../src/guestfs.pod:1474 ../fish/guestfish.pod:1068
2950 #: ../src/guestfs.pod:1476
2955 #: ../src/guestfs.pod:1478
2960 #: ../src/guestfs.pod:1480
2961 msgid "AVAILABILITY"
2965 #: ../src/guestfs.pod:1482
2966 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2970 #: ../src/guestfs.pod:1484
2972 "Using L</guestfs_available> you can test availability of the following "
2973 "groups of functions. This test queries the appliance to see if the "
2974 "appliance you are currently using supports the functionality."
2978 #: ../src/guestfs.pod:1489
2979 msgid "@AVAILABILITY@"
2983 #: ../src/guestfs.pod:1491
2984 msgid "GUESTFISH supported COMMAND"
2988 #: ../src/guestfs.pod:1493
2990 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2991 "prints out the available groups and whether they are supported by this build"
2992 " of libguestfs. Note however that you have to do C<run> first."
2996 #: ../src/guestfs.pod:1498
2997 msgid "SINGLE CALLS AT COMPILE TIME"
3001 #: ../src/guestfs.pod:1500
3003 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
3004 "function, such as:"
3008 #: ../src/guestfs.pod:1503
3011 " #define LIBGUESTFS_HAVE_DD 1\n"
3016 #: ../src/guestfs.pod:1505
3017 msgid "if L</guestfs_dd> is available."
3021 #: ../src/guestfs.pod:1507
3023 "Before version 1.5.8, if you needed to test whether a single libguestfs "
3024 "function is available at compile time, we recommended using build tools such"
3025 " as autoconf or cmake. For example in autotools you could use:"
3029 #: ../src/guestfs.pod:1512
3032 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
3033 " AC_CHECK_FUNCS([guestfs_dd])\n"
3038 #: ../src/guestfs.pod:1515
3040 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined"
3045 #: ../src/guestfs.pod:1518
3046 msgid "SINGLE CALLS AT RUN TIME"
3050 #: ../src/guestfs.pod:1520
3052 "Testing at compile time doesn't guarantee that a function really exists in "
3053 "the library. The reason is that you might be dynamically linked against a "
3054 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
3055 "This situation unfortunately results in a segmentation fault, which is a "
3056 "shortcoming of the C dynamic linking system itself."
3060 #: ../src/guestfs.pod:1527
3062 "You can use L<dlopen(3)> to test if a function is available at run time, as "
3063 "in this example program (note that you still need the compile time check as "
3068 #: ../src/guestfs.pod:1531
3071 " #include <stdio.h>\n"
3072 " #include <stdlib.h>\n"
3073 " #include <unistd.h>\n"
3074 " #include <dlfcn.h>\n"
3075 " #include <guestfs.h>\n"
3080 #: ../src/guestfs.pod:1537
3085 " #ifdef LIBGUESTFS_HAVE_DD\n"
3087 " int has_function;\n"
3092 #: ../src/guestfs.pod:1543
3095 " /* Test if the function guestfs_dd is really available. */\n"
3096 " dl = dlopen (NULL, RTLD_LAZY);\n"
3098 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
3099 " exit (EXIT_FAILURE);\n"
3101 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
3107 #: ../src/guestfs.pod:1552
3110 " if (!has_function)\n"
3111 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
3113 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
3114 " /* Now it's safe to call\n"
3115 " guestfs_dd (g, \"foo\", \"bar\");\n"
3119 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
3126 #: ../src/guestfs.pod:1565
3128 "You may think the above is an awful lot of hassle, and it is. There are "
3129 "other ways outside of the C linking system to ensure that this kind of "
3130 "incompatibility never arises, such as using package versioning:"
3134 #: ../src/guestfs.pod:1570
3137 " Requires: libguestfs >= 1.0.80\n"
3142 #: ../src/guestfs.pod:1572
3143 msgid "CALLS WITH OPTIONAL ARGUMENTS"
3147 #: ../src/guestfs.pod:1574
3149 "A recent feature of the API is the introduction of calls which take optional"
3150 " arguments. In C these are declared 3 ways. The main way is as a call "
3151 "which takes variable arguments (ie. C<...>), as in this example:"
3155 #: ../src/guestfs.pod:1579
3158 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
3163 #: ../src/guestfs.pod:1581
3165 "Call this with a list of optional arguments, terminated by C<-1>. So to "
3166 "call with no optional arguments specified:"
3170 #: ../src/guestfs.pod:1584
3173 " guestfs_add_drive_opts (g, filename, -1);\n"
3178 #: ../src/guestfs.pod:1586
3179 msgid "With a single optional argument:"
3183 #: ../src/guestfs.pod:1588
3186 " guestfs_add_drive_opts (g, filename,\n"
3187 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3193 #: ../src/guestfs.pod:1592
3198 #: ../src/guestfs.pod:1594
3201 " guestfs_add_drive_opts (g, filename,\n"
3202 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
3203 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
3209 #: ../src/guestfs.pod:1599
3211 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
3216 #: ../src/guestfs.pod:1602
3217 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
3221 #: ../src/guestfs.pod:1604
3223 "The second variant has the same name with the suffix C<_va>, which works the"
3224 " same way but takes a C<va_list>. See the C manual for details. For the "
3225 "example function, this is declared:"
3229 #: ../src/guestfs.pod:1608
3232 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
3238 #: ../src/guestfs.pod:1611
3239 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
3243 #: ../src/guestfs.pod:1613
3245 "The third variant is useful where you need to construct these calls. You "
3246 "pass in a structure where you fill in the optional fields. The structure "
3247 "has a bitmask as the first element which you must set to indicate which "
3248 "fields you have filled in. For our example function the structure and call "
3253 #: ../src/guestfs.pod:1619
3256 " struct guestfs_add_drive_opts_argv {\n"
3257 " uint64_t bitmask;\n"
3259 " const char *format;\n"
3262 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3263 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3268 #: ../src/guestfs.pod:1628
3269 msgid "You could call it like this:"
3273 #: ../src/guestfs.pod:1630
3276 " struct guestfs_add_drive_opts_argv optargs = {\n"
3277 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3278 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3280 " .format = \"qcow2\"\n"
3286 #: ../src/guestfs.pod:1637
3289 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3294 #: ../src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
3295 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2853
3296 #: ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1287
3297 #: ../fish/guestfish-actions.pod:1929 ../tools/virt-win-reg.pl:704
3302 #: ../src/guestfs.pod:1645
3304 "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3308 #: ../src/guestfs.pod:1650
3309 msgid "You do not need to fill in all fields of the structure."
3313 #: ../src/guestfs.pod:1654
3315 "There must be a one-to-one correspondence between fields of the structure "
3316 "that are filled in, and bits set in the bitmask."
3320 #: ../src/guestfs.pod:1659
3321 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3325 #: ../src/guestfs.pod:1661
3327 "In other languages, optional arguments are expressed in the way that is "
3328 "natural for that language. We refer you to the language-specific "
3329 "documentation for more details on that."
3333 #: ../src/guestfs.pod:1665
3334 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3338 #: ../src/guestfs.pod:1667
3339 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3343 #: ../src/guestfs.pod:1669
3345 "B<Note:> This section documents the generic event mechanism introduced in "
3346 "libguestfs 1.10, which you should use in new code if possible. The old "
3347 "functions C<guestfs_set_log_message_callback>, "
3348 "C<guestfs_set_subprocess_quit_callback>, "
3349 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
3350 "C<guestfs_set_progress_callback> are no longer documented in this manual "
3351 "page. Because of the ABI guarantee, the old functions continue to work."
3355 #: ../src/guestfs.pod:1678
3357 "Handles generate events when certain things happen, such as log messages "
3358 "being generated, progress messages during long-running operations, or the "
3359 "handle being closed. The API calls described below let you register a "
3360 "callback to be called when events happen. You can register multiple "
3361 "callbacks (for the same, different or overlapping sets of events), and "
3362 "individually remove callbacks. If callbacks are not removed, then they "
3363 "remain in force until the handle is closed."
3367 #: ../src/guestfs.pod:1686
3369 "In the current implementation, events are only generated synchronously: that"
3370 " means that events (and hence callbacks) can only happen while you are in "
3371 "the middle of making another libguestfs call. The callback is called in the"
3376 #: ../src/guestfs.pod:1691
3378 "Events may contain a payload, usually nothing (void), an array of 64 bit "
3379 "unsigned integers, or a message buffer. Payloads are discussed later on."
3383 #: ../src/guestfs.pod:1695
3384 msgid "CLASSES OF EVENTS"
3388 #: ../src/guestfs.pod:1699
3389 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
3393 #: ../src/guestfs.pod:1702
3395 "The callback function will be called while the handle is being closed "
3396 "(synchronously from L</guestfs_close>)."
3400 #: ../src/guestfs.pod:1705
3402 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3403 "handles that are open when the program exits. This means that this callback"
3404 " might be called indirectly from L<exit(3)>, which can cause unexpected "
3405 "problems in higher-level languages (eg. if your HLL interpreter has already "
3406 "been cleaned up by the time this is called, and if your callback then jumps "
3407 "into some HLL function)."
3411 #: ../src/guestfs.pod:1712
3413 "If no callback is registered: the handle is closed without any callback "
3418 #: ../src/guestfs.pod:1715
3419 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
3423 #: ../src/guestfs.pod:1718
3425 "The callback function will be called when the child process quits, either "
3426 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3427 "corresponds to a transition from any state to the CONFIG state)."
3431 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
3432 msgid "If no callback is registered: the event is ignored."
3436 #: ../src/guestfs.pod:1724
3437 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
3441 #: ../src/guestfs.pod:1727
3443 "The callback function will be called when the child process becomes ready "
3444 "first time after it has been launched. (This corresponds to a transition "
3445 "from LAUNCHING to the READY state)."
3449 #: ../src/guestfs.pod:1733
3450 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
3454 #: ../src/guestfs.pod:1736
3456 "Some long-running operations can generate progress messages. If this "
3457 "callback is registered, then it will be called each time a progress message "
3458 "is generated (usually two seconds after the operation started, and three "
3459 "times per second thereafter until it completes, although the frequency may "
3460 "change in future versions)."
3464 #: ../src/guestfs.pod:1742
3466 "The callback receives in the payload four unsigned 64 bit numbers which are "
3467 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
3471 #: ../src/guestfs.pod:1745
3473 "The units of C<total> are not defined, although for some operations C<total>"
3474 " may relate in some way to the amount of data to be transferred (eg. in "
3475 "bytes or megabytes), and C<position> may be the portion which has been "
3480 #: ../src/guestfs.pod:1750
3481 msgid "The only defined and stable parts of the API are:"
3485 #: ../src/guestfs.pod:1756
3487 "The callback can display to the user some type of progress bar or indicator "
3488 "which shows the ratio of C<position>:C<total>."
3492 #: ../src/guestfs.pod:1761
3493 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3497 #: ../src/guestfs.pod:1765
3499 "If any progress notification is sent during a call, then a final progress "
3500 "notification is always sent when C<position> = C<total> (I<unless> the call "
3501 "fails with an error)."
3505 #: ../src/guestfs.pod:1769
3507 "This is to simplify caller code, so callers can easily set the progress "
3508 "indicator to \"100%\" at the end of the operation, without requiring special"
3509 " code to detect this case."
3513 #: ../src/guestfs.pod:1775
3515 "For some calls we are unable to estimate the progress of the call, but we "
3516 "can still generate progress messages to indicate activity. This is known as"
3517 " \"pulse mode\", and is directly supported by certain progress bar "
3518 "implementations (eg. GtkProgressBar)."
3522 #: ../src/guestfs.pod:1780
3524 "For these calls, zero or more progress messages are generated with "
3525 "C<position = 0> and C<total = 1>, followed by a final message with "
3526 "C<position = total = 1>."
3530 #: ../src/guestfs.pod:1784
3532 "As noted above, if the call fails with an error then the final message may "
3537 #: ../src/guestfs.pod:1789
3539 "The callback also receives the procedure number (C<proc_nr>) and serial "
3540 "number (C<serial>) of the call. These are only useful for debugging "
3541 "protocol issues, and the callback can normally ignore them. The callback "
3542 "may want to print these numbers in error messages or debugging messages."
3546 #: ../src/guestfs.pod:1795
3547 msgid "If no callback is registered: progress messages are discarded."
3551 #: ../src/guestfs.pod:1797
3552 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
3556 #: ../src/guestfs.pod:1800
3558 "The callback function is called whenever a log message is generated by qemu,"
3559 " the appliance kernel, guestfsd (daemon), or utility programs."
3563 #: ../src/guestfs.pod:1803
3565 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
3566 "(L</guestfs_launch>) then additional debug messages are generated."
3570 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
3572 "If no callback is registered: the messages are discarded unless the verbose "
3573 "flag is set in which case they are sent to stderr. You can override the "
3574 "printing of verbose messages to stderr by setting up a callback."
3578 #: ../src/guestfs.pod:1811
3579 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
3583 #: ../src/guestfs.pod:1814
3585 "The callback function is called whenever a log message is generated by the "
3586 "library part of libguestfs."
3590 #: ../src/guestfs.pod:1817
3592 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
3593 "messages are generated."
3597 #: ../src/guestfs.pod:1825
3598 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
3602 #: ../src/guestfs.pod:1828
3604 "The callback function is called whenever a trace message is generated. This"
3605 " only applies if the trace flag (L</guestfs_set_trace>) is set."
3609 #: ../src/guestfs.pod:1831
3611 "If no callback is registered: the messages are sent to stderr. You can "
3612 "override the printing of trace messages to stderr by setting up a callback."
3616 #: ../src/guestfs.pod:1837
3617 msgid "guestfs_set_event_callback"
3621 #: ../src/guestfs.pod:1839
3624 " int guestfs_set_event_callback (guestfs_h *g,\n"
3625 " guestfs_event_callback cb,\n"
3626 " uint64_t event_bitmask,\n"
3633 #: ../src/guestfs.pod:1845
3635 "This function registers a callback (C<cb>) for all event classes in the "
3640 #: ../src/guestfs.pod:1848
3642 "For example, to register for all log message events, you could call this "
3643 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>."
3644 " To register a single callback for all possible classes of events, use "
3645 "C<GUESTFS_EVENT_ALL>."
3649 #: ../src/guestfs.pod:1854
3650 msgid "C<flags> should always be passed as 0."
3654 #: ../src/guestfs.pod:1856
3656 "C<opaque> is an opaque pointer which is passed to the callback. You can use"
3657 " it for any purpose."
3661 #: ../src/guestfs.pod:1859
3663 "The return value is the event handle (an integer) which you can use to "
3664 "delete the callback (see below)."
3668 #: ../src/guestfs.pod:1862
3670 "If there is an error, this function returns C<-1>, and sets the error in the"
3671 " handle in the usual way (see L</guestfs_last_error> etc.)"
3675 #: ../src/guestfs.pod:1865
3677 "Callbacks remain in effect until they are deleted, or until the handle is "
3682 #: ../src/guestfs.pod:1868
3684 "In the case where multiple callbacks are registered for a particular event "
3685 "class, all of the callbacks are called. The order in which multiple "
3686 "callbacks are called is not defined."
3690 #: ../src/guestfs.pod:1872
3691 msgid "guestfs_delete_event_callback"
3695 #: ../src/guestfs.pod:1874
3698 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
3703 #: ../src/guestfs.pod:1876
3705 "Delete a callback that was previously registered. C<event_handle> should be"
3706 " the integer that was returned by a previous call to "
3707 "C<guestfs_set_event_callback> on the same handle."
3711 #: ../src/guestfs.pod:1880
3712 msgid "guestfs_event_callback"
3716 #: ../src/guestfs.pod:1882
3719 " typedef void (*guestfs_event_callback) (\n"
3722 " uint64_t event,\n"
3723 " int event_handle,\n"
3725 " const char *buf, size_t buf_len,\n"
3726 " const uint64_t *array, size_t array_len);\n"
3731 #: ../src/guestfs.pod:1891
3733 "This is the type of the event callback function that you have to provide."
3737 #: ../src/guestfs.pod:1894
3739 "The basic parameters are: the handle (C<g>), the opaque user pointer "
3740 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
3741 "handle, and C<flags> which in the current API you should ignore."
3745 #: ../src/guestfs.pod:1898
3747 "The remaining parameters contain the event payload (if any). Each event may"
3748 " contain a payload, which usually relates to the event class, but for future"
3749 " proofing your code should be written to handle any payload for any event "
3754 #: ../src/guestfs.pod:1903
3756 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
3757 "there is no message buffer). Note that this message buffer can contain "
3758 "arbitrary 8 bit data, including NUL bytes."
3762 #: ../src/guestfs.pod:1907
3764 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
3765 "moment this is only used for progress messages."
3769 #: ../src/guestfs.pod:1910
3770 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
3774 #: ../src/guestfs.pod:1912
3776 "One motivation for the generic event API was to allow GUI programs to "
3777 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
3778 "unconditionally to C<stderr>."
3782 #: ../src/guestfs.pod:1916
3784 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
3785 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
3786 "messages are not events; you must capture error messages separately)."
3790 #: ../src/guestfs.pod:1921
3792 "Programs have to set up a callback to capture the classes of events of "
3797 #: ../src/guestfs.pod:1924
3801 " guestfs_set_event_callback\n"
3802 " (g, message_callback,\n"
3803 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
3804 " GUESTFS_EVENT_TRACE,\n"
3805 " 0, NULL) == -1)\n"
3806 " if (eh == -1) {\n"
3807 " // handle error in the usual way\n"
3813 #: ../src/guestfs.pod:1934
3815 "The callback can then direct messages to the appropriate place. In this "
3816 "example, messages are directed to syslog:"
3820 #: ../src/guestfs.pod:1937
3824 " message_callback (\n"
3827 " uint64_t event,\n"
3828 " int event_handle,\n"
3830 " const char *buf, size_t buf_len,\n"
3831 " const uint64_t *array, size_t array_len)\n"
3833 " const int priority = LOG_USER|LOG_INFO;\n"
3834 " if (buf_len > 0)\n"
3835 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
3841 #: ../src/guestfs.pod:1952
3842 msgid "CANCELLING LONG TRANSFERS"
3846 #: ../src/guestfs.pod:1954
3848 "Some operations can be cancelled by the caller while they are in progress. "
3849 "Currently only operations that involve uploading or downloading data can be "
3850 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
3851 "parameters in the generator)."
3855 #: ../src/guestfs.pod:1959
3856 msgid "guestfs_user_cancel"
3860 #: ../src/guestfs.pod:1961
3863 " void guestfs_user_cancel (guestfs_h *g);\n"
3868 #: ../src/guestfs.pod:1963
3870 "C<guestfs_user_cancel> cancels the current upload or download operation."
3874 #: ../src/guestfs.pod:1966
3876 "Unlike most other libguestfs calls, this function is signal safe and thread "
3877 "safe. You can call it from a signal handler or from another thread, without"
3878 " needing to do any locking."
3882 #: ../src/guestfs.pod:1970
3884 "The transfer that was in progress (if there is one) will stop shortly "
3885 "afterwards, and will return an error. The errno (see "
3886 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find"
3887 " out if the operation was cancelled or failed because of another error."
3891 #: ../src/guestfs.pod:1976
3893 "No cleanup is performed: for example, if a file was being uploaded then "
3894 "after cancellation there may be a partially uploaded file. It is the "
3895 "caller's responsibility to clean up if necessary."
3899 #: ../src/guestfs.pod:1980
3901 "There are two common places that you might call C<guestfs_user_cancel>."
3905 #: ../src/guestfs.pod:1982
3907 "In an interactive text-based program, you might call it from a C<SIGINT> "
3908 "signal handler so that pressing C<^C> cancels the current operation. (You "
3909 "also need to call L</guestfs_set_pgroup> so that child processes don't "
3910 "receive the C<^C> signal)."
3914 #: ../src/guestfs.pod:1987
3916 "In a graphical program, when the main thread is displaying a progress bar "
3917 "with a cancel button, wire up the cancel button to call this function."
3921 #: ../src/guestfs.pod:1991
3922 msgid "PRIVATE DATA AREA"
3926 #: ../src/guestfs.pod:1993
3928 "You can attach named pieces of private data to the libguestfs handle, fetch "
3929 "them by name, and walk over them, for the lifetime of the handle. This is "
3930 "called the private data area and is only available from the C API."
3934 #: ../src/guestfs.pod:1998
3935 msgid "To attach a named piece of data, use the following call:"
3939 #: ../src/guestfs.pod:2000
3942 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3947 #: ../src/guestfs.pod:2002
3949 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3950 "pointer (which can be C<NULL>). Any previous item with the same key is "
3955 #: ../src/guestfs.pod:2006
3957 "You can use any C<key> you want, but your key should I<not> start with an "
3958 "underscore character. Keys beginning with an underscore character are "
3959 "reserved for internal libguestfs purposes (eg. for implementing language "
3960 "bindings). It is recommended that you prefix the key with some unique "
3961 "string to avoid collisions with other users."
3965 #: ../src/guestfs.pod:2012
3966 msgid "To retrieve the pointer, use:"
3970 #: ../src/guestfs.pod:2014
3973 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3978 #: ../src/guestfs.pod:2016
3980 "This function returns C<NULL> if either no data is found associated with "
3981 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3986 #: ../src/guestfs.pod:2020
3988 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3989 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3990 "all. In particular, libguestfs does I<not> try to free the data when the "
3991 "handle is closed. If the data must be freed, then the caller must either "
3992 "free it before calling L</guestfs_close> or must set up a close callback to "
3993 "do it (see L</GUESTFS_EVENT_CLOSE>)."
3997 #: ../src/guestfs.pod:2027
3998 msgid "To walk over all entries, use these two functions:"
4002 #: ../src/guestfs.pod:2029
4005 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
4010 #: ../src/guestfs.pod:2031
4013 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
4018 #: ../src/guestfs.pod:2033
4020 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does"
4021 " not have any particular meaning -- keys are not returned in any defined "
4022 "order). A pointer to the key is returned in C<*key_rtn> and the "
4023 "corresponding data pointer is returned from the function. C<NULL> is "
4024 "returned if there are no keys stored in the handle."
4028 #: ../src/guestfs.pod:2039
4030 "C<guestfs_next_private> returns the next key, pointer pair. The return "
4031 "value of this function is also C<NULL> is there are no further entries to "
4036 #: ../src/guestfs.pod:2043
4037 msgid "Notes about walking over entries:"
4041 #: ../src/guestfs.pod:2049
4043 "You must not call C<guestfs_set_private> while walking over the entries."
4047 #: ../src/guestfs.pod:2054
4049 "The handle maintains an internal iterator which is reset when you call "
4050 "C<guestfs_first_private>. This internal iterator is invalidated when you "
4051 "call C<guestfs_set_private>."
4055 #: ../src/guestfs.pod:2060
4056 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
4060 #: ../src/guestfs.pod:2062
4063 " guestfs_set_private (g, key, NULL);\n"
4068 #: ../src/guestfs.pod:2064
4069 msgid "then that C<key> is not returned when walking."
4073 #: ../src/guestfs.pod:2068
4075 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
4076 "C<guestfs_next_private> or C<guestfs_set_private>."
4080 #: ../src/guestfs.pod:2074
4082 "The following example code shows how to print all keys and data pointers "
4083 "that are associated with the handle C<g>:"
4087 #: ../src/guestfs.pod:2077
4090 " const char *key;\n"
4091 " void *data = guestfs_first_private (g, &key);\n"
4092 " while (data != NULL)\n"
4094 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4095 " data = guestfs_next_private (g, &key);\n"
4101 #: ../src/guestfs.pod:2085
4103 "More commonly you are only interested in keys that begin with an "
4104 "application-specific prefix C<foo_>. Modify the loop like so:"
4108 #: ../src/guestfs.pod:2088
4111 " const char *key;\n"
4112 " void *data = guestfs_first_private (g, &key);\n"
4113 " while (data != NULL)\n"
4115 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4116 " printf (\"key = %s, data = %p\\n\", key, data);\n"
4117 " data = guestfs_next_private (g, &key);\n"
4123 #: ../src/guestfs.pod:2097
4125 "If you need to modify keys while walking, then you have to jump back to the "
4126 "beginning of the loop. For example, to delete all keys prefixed with "
4131 #: ../src/guestfs.pod:2101
4134 " const char *key;\n"
4137 " data = guestfs_first_private (g, &key);\n"
4138 " while (data != NULL)\n"
4140 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
4142 " guestfs_set_private (g, key, NULL);\n"
4143 " /* note that 'key' pointer is now invalid, and so is\n"
4144 " the internal iterator */\n"
4147 " data = guestfs_next_private (g, &key);\n"
4153 #: ../src/guestfs.pod:2117
4155 "Note that the above loop is guaranteed to terminate because the keys are "
4156 "being deleted, but other manipulations of keys within the loop might not "
4157 "terminate unless you also maintain an indication of which keys have been "
4162 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
4167 #: ../src/guestfs.pod:2124
4169 "<!-- old anchor for the next section --> <a "
4170 "name=\"state_machine_and_low_level_event_api\"/>"
4174 #: ../src/guestfs.pod:2129
4175 msgid "ARCHITECTURE"
4179 #: ../src/guestfs.pod:2131
4181 "Internally, libguestfs is implemented by running an appliance (a special "
4182 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
4183 "process of the main program."
4187 #: ../src/guestfs.pod:2135
4190 " ___________________\n"
4192 " | main program |\n"
4194 " | | child process / appliance\n"
4195 " | | __________________________\n"
4197 " +-------------------+ RPC | +-----------------+ |\n"
4198 " | libguestfs <--------------------> guestfsd | |\n"
4199 " | | | +-----------------+ |\n"
4200 " \\___________________/ | | Linux kernel | |\n"
4201 " | +--^--------------+ |\n"
4202 " \\_________|________________/\n"
4208 " \\______________/\n"
4213 #: ../src/guestfs.pod:2155
4215 "The library, linked to the main program, creates the child process and hence"
4216 " the appliance in the L</guestfs_launch> function."
4220 #: ../src/guestfs.pod:2158
4222 "Inside the appliance is a Linux kernel and a complete stack of userspace "
4223 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
4224 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
4225 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs"
4226 " API calls and RPC calls to the daemon. Lastly the disk image(s) are "
4227 "attached to the qemu process which translates device access by the "
4228 "appliance's Linux kernel into accesses to the image."
4232 #: ../src/guestfs.pod:2167
4234 "A common misunderstanding is that the appliance \"is\" the virtual machine."
4235 " Although the disk image you are attached to might also be used by some "
4236 "virtual machine, libguestfs doesn't know or care about this. (But you will "
4237 "care if both libguestfs's qemu process and your virtual machine are trying "
4238 "to update the disk image at the same time, since these usually results in "
4239 "massive disk corruption)."
4243 #: ../src/guestfs.pod:2174
4244 msgid "STATE MACHINE"
4248 #: ../src/guestfs.pod:2176
4249 msgid "libguestfs uses a state machine to model the child process:"
4253 #: ../src/guestfs.pod:2178
4265 " / | \\ \\ guestfs_launch\n"
4266 " / | _\\__V______\n"
4268 " / | | LAUNCHING |\n"
4269 " / | \\___________/\n"
4271 " / | guestfs_launch\n"
4273 " ______ / __|____V\n"
4274 " / \\ ------> / \\\n"
4275 " | BUSY | | READY |\n"
4276 " \\______/ <------ \\________/\n"
4281 #: ../src/guestfs.pod:2200
4283 "The normal transitions are (1) CONFIG (when the handle is created, but there"
4284 " is no child process), (2) LAUNCHING (when the child process is booting up),"
4285 " (3) alternating between READY and BUSY as commands are issued to, and "
4286 "carried out by, the child process."
4290 #: ../src/guestfs.pod:2205
4292 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
4293 "asynchronously at any time (eg. due to some internal error), and that causes"
4294 " the state to transition back to CONFIG."
4298 #: ../src/guestfs.pod:2209
4300 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
4301 "issued when in the CONFIG state."
4305 #: ../src/guestfs.pod:2212
4307 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
4308 "L</guestfs_launch> blocks until the child process is READY to accept "
4309 "commands (or until some failure or timeout). L</guestfs_launch> internally "
4310 "moves the state from CONFIG to LAUNCHING while it is running."
4314 #: ../src/guestfs.pod:2218
4316 "API actions such as L</guestfs_mount> can only be issued when in the READY "
4317 "state. These API calls block waiting for the command to be carried out (ie."
4318 " the state to transition to BUSY and then back to READY). There are no non-"
4319 "blocking versions, and no way to issue more than one command per handle at "
4324 #: ../src/guestfs.pod:2224
4326 "Finally, the child process sends asynchronous messages back to the main "
4327 "program, such as kernel log messages. You can register a callback to "
4328 "receive these messages."
4332 #: ../src/guestfs.pod:2228
4337 #: ../src/guestfs.pod:2230
4338 msgid "COMMUNICATION PROTOCOL"
4342 #: ../src/guestfs.pod:2232
4344 "Don't rely on using this protocol directly. This section documents how it "
4345 "currently works, but it may change at any time."
4349 #: ../src/guestfs.pod:2235
4351 "The protocol used to talk between the library and the daemon running inside "
4352 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
4353 "1014, RFC 1832, RFC 4506)."
4357 #: ../src/guestfs.pod:2239
4359 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
4360 "this file is automatically generated)."
4364 #: ../src/guestfs.pod:2242
4366 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
4367 "and C<FileOut> parameters, which are handled with very simple request/reply "
4368 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
4369 "parameters, which use the same request and reply messages, but they may also"
4370 " be followed by files sent using a chunked encoding."
4374 #: ../src/guestfs.pod:2249
4375 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
4379 #: ../src/guestfs.pod:2251
4380 msgid "For ordinary functions, the request message is:"
4384 #: ../src/guestfs.pod:2253
4387 " total length (header + arguments,\n"
4388 " but not including the length word itself)\n"
4389 " struct guestfs_message_header (encoded as XDR)\n"
4390 " struct guestfs_<foo>_args (encoded as XDR)\n"
4395 #: ../src/guestfs.pod:2258
4397 "The total length field allows the daemon to allocate a fixed size buffer "
4398 "into which it slurps the rest of the message. As a result, the total length"
4399 " is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the"
4400 " effective size of any request is limited to somewhere under this size."
4404 #: ../src/guestfs.pod:2264
4406 "Note also that many functions don't take any arguments, in which case the "
4407 "C<guestfs_I<foo>_args> is completely omitted."
4411 #: ../src/guestfs.pod:2267
4413 "The header contains the procedure number (C<guestfs_proc>) which is how the "
4414 "receiver knows what type of args structure to expect, or none at all."
4418 #: ../src/guestfs.pod:2271
4420 "For functions that take optional arguments, the optional arguments are "
4421 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
4422 "arguments. A bitmask in the header indicates which optional arguments are "
4423 "meaningful. The bitmask is also checked to see if it contains bits set "
4424 "which the daemon does not know about (eg. if more optional arguments were "
4425 "added in a later version of the library), and this causes the call to be "
4430 #: ../src/guestfs.pod:2279
4431 msgid "The reply message for ordinary functions is:"
4435 #: ../src/guestfs.pod:2281
4438 " total length (header + ret,\n"
4439 " but not including the length word itself)\n"
4440 " struct guestfs_message_header (encoded as XDR)\n"
4441 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4446 #: ../src/guestfs.pod:2286
4448 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
4449 "functions that return no formal return values."
4453 #: ../src/guestfs.pod:2289
4455 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
4459 #: ../src/guestfs.pod:2292
4461 "In the case of an error, a flag is set in the header, and the reply message "
4462 "is slightly changed:"
4466 #: ../src/guestfs.pod:2295
4469 " total length (header + error,\n"
4470 " but not including the length word itself)\n"
4471 " struct guestfs_message_header (encoded as XDR)\n"
4472 " struct guestfs_message_error (encoded as XDR)\n"
4477 #: ../src/guestfs.pod:2300
4479 "The C<guestfs_message_error> structure contains the error message as a "
4484 #: ../src/guestfs.pod:2303
4485 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
4489 #: ../src/guestfs.pod:2305
4491 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
4492 "The normal request message is sent (see above). However this is followed by"
4493 " a sequence of file chunks."
4497 #: ../src/guestfs.pod:2309
4500 " total length (header + arguments,\n"
4501 " but not including the length word itself,\n"
4502 " and not including the chunks)\n"
4503 " struct guestfs_message_header (encoded as XDR)\n"
4504 " struct guestfs_<foo>_args (encoded as XDR)\n"
4505 " sequence of chunks for FileIn param #0\n"
4506 " sequence of chunks for FileIn param #1 etc.\n"
4511 #: ../src/guestfs.pod:2317
4512 msgid "The \"sequence of chunks\" is:"
4516 #: ../src/guestfs.pod:2319
4519 " length of chunk (not including length word itself)\n"
4520 " struct guestfs_chunk (encoded as XDR)\n"
4521 " length of chunk\n"
4522 " struct guestfs_chunk (encoded as XDR)\n"
4524 " length of chunk\n"
4525 " struct guestfs_chunk (with data.data_len == 0)\n"
4530 #: ../src/guestfs.pod:2327
4532 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
4533 "is set in the final chunk to indicate either successful completion or early "
4538 #: ../src/guestfs.pod:2331
4540 "At time of writing there are no functions that have more than one FileIn "
4541 "parameter. However this is (theoretically) supported, by sending the "
4542 "sequence of chunks for each FileIn parameter one after another (from left to"
4547 #: ../src/guestfs.pod:2336
4549 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
4550 "transfer. The library does this by sending a chunk with a special flag set "
4551 "to indicate cancellation. When the daemon sees this, it cancels the whole "
4552 "RPC, does I<not> send any reply, and goes back to reading the next request."
4556 #: ../src/guestfs.pod:2342
4558 "The daemon may also cancel. It does this by writing a special word "
4559 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
4560 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
4561 "cancel chunk). The special word is chosen so that even if cancellation "
4562 "happens right at the end of the transfer (after the library has finished "
4563 "writing and has started listening for the reply), the \"spurious\" cancel "
4564 "flag will not be confused with the reply message."
4568 #: ../src/guestfs.pod:2351
4570 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
4571 "limit), and also files where the size is not known in advance (eg. from "
4572 "pipes or sockets). However the chunks are rather small "
4573 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need"
4574 " to keep much in memory."
4578 #: ../src/guestfs.pod:2357
4579 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
4583 #: ../src/guestfs.pod:2359
4585 "The protocol for FileOut parameters is exactly the same as for FileIn "
4586 "parameters, but with the roles of daemon and library reversed."
4590 #: ../src/guestfs.pod:2362
4593 " total length (header + ret,\n"
4594 " but not including the length word itself,\n"
4595 " and not including the chunks)\n"
4596 " struct guestfs_message_header (encoded as XDR)\n"
4597 " struct guestfs_<foo>_ret (encoded as XDR)\n"
4598 " sequence of chunks for FileOut param #0\n"
4599 " sequence of chunks for FileOut param #1 etc.\n"
4604 #: ../src/guestfs.pod:2370
4605 msgid "INITIAL MESSAGE"
4609 #: ../src/guestfs.pod:2372
4611 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
4612 "which indicates that the guest and daemon is alive. This is what "
4613 "L</guestfs_launch> waits for."
4617 #: ../src/guestfs.pod:2376
4618 msgid "PROGRESS NOTIFICATION MESSAGES"
4622 #: ../src/guestfs.pod:2378
4624 "The daemon may send progress notification messages at any time. These are "
4625 "distinguished by the normal length word being replaced by "
4626 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
4630 #: ../src/guestfs.pod:2382
4632 "The library turns them into progress callbacks (see "
4633 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
4638 #: ../src/guestfs.pod:2386
4640 "The daemon self-limits the frequency of progress messages it sends (see "
4641 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
4646 #: ../src/guestfs.pod:2390
4647 msgid "LIBGUESTFS VERSION NUMBERS"
4651 #: ../src/guestfs.pod:2392
4653 "Since April 2010, libguestfs has started to make separate development and "
4654 "stable releases, along with corresponding branches in our git repository. "
4655 "These separate releases can be identified by version number:"
4659 #: ../src/guestfs.pod:2397
4662 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
4663 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
4669 " | `-------- sub-version\n"
4671 " `------ always '1' because we don't change the ABI\n"
4676 #: ../src/guestfs.pod:2408
4677 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
4681 #: ../src/guestfs.pod:2410
4683 "As time passes we cherry pick fixes from the development branch and backport"
4684 " those into the stable branch, the effect being that the stable branch "
4685 "should get more stable and less buggy over time. So the stable releases are"
4686 " ideal for people who don't need new features but would just like the "
4691 #: ../src/guestfs.pod:2416
4692 msgid "Our criteria for backporting changes are:"
4696 #: ../src/guestfs.pod:2422
4698 "Documentation changes which don't affect any code are backported unless the "
4699 "documentation refers to a future feature which is not in stable."
4703 #: ../src/guestfs.pod:2428
4705 "Bug fixes which are not controversial, fix obvious problems, and have been "
4706 "well tested are backported."
4710 #: ../src/guestfs.pod:2433
4712 "Simple rearrangements of code which shouldn't affect how it works get "
4713 "backported. This is so that the code in the two branches doesn't get too "
4714 "far out of step, allowing us to backport future fixes more easily."
4718 #: ../src/guestfs.pod:2439
4720 "We I<don't> backport new features, new APIs, new tools etc, except in one "
4721 "exceptional case: the new feature is required in order to implement an "
4722 "important bug fix."
4726 #: ../src/guestfs.pod:2445
4728 "A new stable branch starts when we think the new features in development are"
4729 " substantial and compelling enough over the current stable branch to warrant"
4730 " it. When that happens we create new stable and development versions 1.N.0 "
4731 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
4732 "stable at this point, but by backporting fixes from development, that branch"
4733 " will stabilize over time."
4737 #: ../src/guestfs.pod:2453
4738 msgid "EXTENDING LIBGUESTFS"
4742 #: ../src/guestfs.pod:2455
4743 msgid "ADDING A NEW API ACTION"
4747 #: ../src/guestfs.pod:2457
4749 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
4750 "documentation) are generated, and this makes it easy to extend the "
4755 #: ../src/guestfs.pod:2461
4756 msgid "To add a new API action there are two changes:"
4760 #: ../src/guestfs.pod:2467
4762 "You need to add a description of the call (name, parameters, return type, "
4763 "tests, documentation) to C<generator/generator_actions.ml>."
4767 #: ../src/guestfs.pod:2470
4769 "There are two sorts of API action, depending on whether the call goes "
4770 "through to the daemon in the appliance, or is serviced entirely by the "
4771 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the"
4772 " former, since the sync is done in the appliance. L</guestfs_set_trace> is "
4773 "an example of the latter, since a trace flag is maintained in the handle and"
4774 " all tracing is done on the library side."
4778 #: ../src/guestfs.pod:2478
4780 "Most new actions are of the first type, and get added to the "
4781 "C<daemon_functions> list. Each function has a unique procedure number used "
4782 "in the RPC protocol which is assigned to that action when we publish "
4783 "libguestfs and cannot be reused. Take the latest procedure number and "
4788 #: ../src/guestfs.pod:2484
4790 "For library-only actions of the second type, add to the "
4791 "C<non_daemon_functions> list. Since these functions are serviced by the "
4792 "library and do not travel over the RPC mechanism to the daemon, these "
4793 "functions do not need a procedure number, and so the procedure number is set"
4798 #: ../src/guestfs.pod:2492
4799 msgid "Implement the action (in C):"
4803 #: ../src/guestfs.pod:2494
4805 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
4806 "C<daemon/> directory."
4810 #: ../src/guestfs.pod:2497
4812 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
4813 "(note: double underscore) in the C<src/> directory."
4817 #: ../src/guestfs.pod:2500
4818 msgid "In either case, use another function as an example of what to do."
4822 #: ../src/guestfs.pod:2504
4823 msgid "After making these changes, use C<make> to compile."
4827 #: ../src/guestfs.pod:2506
4829 "Note that you don't need to implement the RPC, language bindings, manual "
4830 "pages or anything else. It's all automatically generated from the OCaml "
4835 #: ../src/guestfs.pod:2510
4836 msgid "ADDING TESTS FOR AN API ACTION"
4840 #: ../src/guestfs.pod:2512
4842 "You can supply zero or as many tests as you want per API call. The tests "
4843 "can either be added as part of the API description "
4844 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
4845 "drop a script into C<regressions/>. Note that adding a script to "
4846 "C<regressions/> is slower, so if possible use the first method."
4850 #: ../src/guestfs.pod:2518
4852 "The following describes the test environment used when you add an API test "
4853 "in C<generator_actions.ml>."
4857 #: ../src/guestfs.pod:2521
4858 msgid "The test environment has 4 block devices:"
4862 #: ../src/guestfs.pod:2525
4863 msgid "C</dev/sda> 500MB"
4867 #: ../src/guestfs.pod:2527
4868 msgid "General block device for testing."
4872 #: ../src/guestfs.pod:2529
4873 msgid "C</dev/sdb> 50MB"
4877 #: ../src/guestfs.pod:2531
4879 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
4884 #: ../src/guestfs.pod:2534
4885 msgid "C</dev/sdc> 10MB"
4889 #: ../src/guestfs.pod:2536
4890 msgid "Used in a few tests where two block devices are needed."
4894 #: ../src/guestfs.pod:2538
4899 #: ../src/guestfs.pod:2540
4900 msgid "ISO with fixed content (see C<images/test.iso>)."
4904 #: ../src/guestfs.pod:2544
4906 "To be able to run the tests in a reasonable amount of time, the libguestfs "
4907 "appliance and block devices are reused between tests. So don't try testing "
4908 "L</guestfs_kill_subprocess> :-x"
4912 #: ../src/guestfs.pod:2548
4914 "Each test starts with an initial scenario, selected using one of the "
4915 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
4916 "initialize the disks mentioned above in a particular way as documented in "
4917 "C<generator_types.ml>. You should not assume anything about the previous "
4918 "contents of other disks that are not initialized."
4922 #: ../src/guestfs.pod:2554
4924 "You can add a prerequisite clause to any individual test. This is a run-"
4925 "time check, which, if it fails, causes the test to be skipped. Useful if "
4926 "testing a command which might not work on all variations of libguestfs "
4927 "builds. A test that has prerequisite of C<Always> means to run "
4932 #: ../src/guestfs.pod:2560
4934 "In addition, packagers can skip individual tests by setting environment "
4935 "variables before running C<make check>."
4939 #: ../src/guestfs.pod:2563
4942 " SKIP_TEST_<CMD>_<NUM>=1\n"
4947 #: ../src/guestfs.pod:2565
4948 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
4952 #: ../src/guestfs.pod:2567
4957 #: ../src/guestfs.pod:2569
4960 " SKIP_TEST_<CMD>=1\n"
4965 #: ../src/guestfs.pod:2571
4966 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
4970 #: ../src/guestfs.pod:2573
4971 msgid "Packagers can run only certain tests by setting for example:"
4975 #: ../src/guestfs.pod:2575
4978 " TEST_ONLY=\"vfs_type zerofree\"\n"
4983 #: ../src/guestfs.pod:2577
4985 "See C<capitests/tests.c> for more details of how these environment variables"
4990 #: ../src/guestfs.pod:2580
4991 msgid "DEBUGGING NEW API ACTIONS"
4995 #: ../src/guestfs.pod:2582
4996 msgid "Test new actions work before submitting them."
5000 #: ../src/guestfs.pod:2584
5001 msgid "You can use guestfish to try out new commands."
5005 #: ../src/guestfs.pod:2586
5007 "Debugging the daemon is a problem because it runs inside a minimal "
5008 "environment. However you can fprintf messages in the daemon to stderr, and "
5009 "they will show up if you use C<guestfish -v>."
5013 #: ../src/guestfs.pod:2590
5014 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
5018 #: ../src/guestfs.pod:2592
5020 "Our C source code generally adheres to some basic code-formatting "
5021 "conventions. The existing code base is not totally consistent on this "
5022 "front, but we do prefer that contributed code be formatted similarly. In "
5023 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
5024 "indentation level, and other than that, follow the K&R style."
5028 #: ../src/guestfs.pod:2598
5030 "If you use Emacs, add the following to one of one of your start-up files "
5031 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
5035 #: ../src/guestfs.pod:2601
5038 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
5039 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
5040 " (add-hook 'find-file-hook\n"
5041 " '(lambda () (if (and buffer-file-name\n"
5042 " (string-match \"/libguestfs\\\\>\"\n"
5043 " (buffer-file-name))\n"
5044 " (not (string-equal mode-name \"Change Log\"))\n"
5045 " (not (string-equal mode-name \"Makefile\")))\n"
5046 " (setq indent-tabs-mode nil))))\n"
5051 #: ../src/guestfs.pod:2611
5054 " ;;; When editing C sources in libguestfs, use this style.\n"
5055 " (defun libguestfs-c-mode ()\n"
5056 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
5058 " (c-set-style \"K&R\")\n"
5059 " (setq c-indent-level 2)\n"
5060 " (setq c-basic-offset 2))\n"
5061 " (add-hook 'c-mode-hook\n"
5062 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
5063 " (buffer-file-name))\n"
5064 " (libguestfs-c-mode))))\n"
5069 #: ../src/guestfs.pod:2623
5070 msgid "Enable warnings when compiling (and fix any problems this finds):"
5074 #: ../src/guestfs.pod:2626
5077 " ./configure --enable-gcc-warnings\n"
5082 #: ../src/guestfs.pod:2628
5083 msgid "Useful targets are:"
5087 #: ../src/guestfs.pod:2630
5090 " make syntax-check # checks the syntax of the C code\n"
5091 " make check # runs the test suite\n"
5096 #: ../src/guestfs.pod:2633
5097 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
5101 #: ../src/guestfs.pod:2635
5103 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>,"
5104 " which are used to do shell quoting."
5108 #: ../src/guestfs.pod:2640
5113 #: ../src/guestfs.pod:2642
5115 "Simple shell quoted string. Any spaces or other shell characters are "
5120 #: ../src/guestfs.pod:2645
5125 #: ../src/guestfs.pod:2647
5127 "Same as C<%Q> except the string is treated as a path which is prefixed by "
5132 #: ../src/guestfs.pod:2652 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
5133 msgid "For example:"
5137 #: ../src/guestfs.pod:2654
5140 " asprintf (&cmd, \"cat %R\", path);\n"
5145 #: ../src/guestfs.pod:2656
5146 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
5150 #: ../src/guestfs.pod:2658
5152 "I<Note:> Do I<not> use these when you are passing parameters to the "
5153 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
5154 "because they are not passed via the shell (instead, straight to exec). You "
5155 "probably want to use the C<sysroot_path()> function however."
5159 #: ../src/guestfs.pod:2664
5160 msgid "SUBMITTING YOUR NEW API ACTIONS"
5164 #: ../src/guestfs.pod:2666
5166 "Submit patches to the mailing list: "
5167 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
5168 "L<rjones@redhat.com>."
5172 #: ../src/guestfs.pod:2670
5173 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
5177 #: ../src/guestfs.pod:2672
5178 msgid "We support i18n (gettext anyhow) in the library."
5182 #: ../src/guestfs.pod:2674
5184 "However many messages come from the daemon, and we don't translate those at "
5185 "the moment. One reason is that the appliance generally has all locale files"
5186 " removed from it, because they take up a lot of space. So we'd have to "
5187 "readd some of those, as well as copying our PO files into the appliance."
5191 #: ../src/guestfs.pod:2680
5193 "Debugging messages are never translated, since they are intended for the "
5198 #: ../src/guestfs.pod:2683
5199 msgid "SOURCE CODE SUBDIRECTORIES"
5203 #: ../src/guestfs.pod:2687 ../src/guestfs-actions.pod:6174
5204 #: ../fish/guestfish-actions.pod:4072
5205 msgid "C<appliance>"
5209 #: ../src/guestfs.pod:2689
5210 msgid "The libguestfs appliance, build scripts and so on."
5214 #: ../src/guestfs.pod:2691
5215 msgid "C<capitests>"
5219 #: ../src/guestfs.pod:2693
5220 msgid "Automated tests of the C API."
5224 #: ../src/guestfs.pod:2695
5229 #: ../src/guestfs.pod:2697
5231 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
5236 #: ../src/guestfs.pod:2700
5241 #: ../src/guestfs.pod:2702
5243 "Safety and liveness tests of components that libguestfs depends upon (not of"
5244 " libguestfs itself). Mainly this is for qemu and the kernel."
5248 #: ../src/guestfs.pod:2705
5253 #: ../src/guestfs.pod:2707
5254 msgid "Outside contributions, experimental parts."
5258 #: ../src/guestfs.pod:2709
5263 #: ../src/guestfs.pod:2711
5265 "The daemon that runs inside the libguestfs appliance and carries out "
5270 #: ../src/guestfs.pod:2714
5275 #: ../src/guestfs.pod:2716
5276 msgid "L<virt-df(1)> command and documentation."
5280 #: ../src/guestfs.pod:2718
5285 #: ../src/guestfs.pod:2720
5286 msgid "L<virt-edit(1)> command and documentation."
5290 #: ../src/guestfs.pod:2722
5295 #: ../src/guestfs.pod:2724
5296 msgid "C API example code."
5300 #: ../src/guestfs.pod:2726
5305 #: ../src/guestfs.pod:2728
5307 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
5308 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L"
5309 "<virt-tar-out(1)>."
5313 #: ../src/guestfs.pod:2732
5318 #: ../src/guestfs.pod:2734
5320 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
5324 #: ../src/guestfs.pod:2736
5325 msgid "C<generator>"
5329 #: ../src/guestfs.pod:2738
5331 "The crucially important generator, used to automatically generate large "
5332 "amounts of boilerplate C code for things like RPC and bindings."
5336 #: ../src/guestfs.pod:2741
5341 #: ../src/guestfs.pod:2743
5342 msgid "Files used by the test suite."
5346 #: ../src/guestfs.pod:2745
5347 msgid "Some \"phony\" guest images which we test against."
5351 #: ../src/guestfs.pod:2747
5352 msgid "C<inspector>"
5356 #: ../src/guestfs.pod:2749
5357 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
5361 #: ../src/guestfs.pod:2751
5366 #: ../src/guestfs.pod:2753
5367 msgid "Logo used on the website. The fish is called Arthur by the way."
5371 #: ../src/guestfs.pod:2755
5376 #: ../src/guestfs.pod:2757
5377 msgid "M4 macros used by autoconf."
5381 #: ../src/guestfs.pod:2759
5386 #: ../src/guestfs.pod:2761
5387 msgid "Translations of simple gettext strings."
5391 #: ../src/guestfs.pod:2763
5396 #: ../src/guestfs.pod:2765
5398 "The build infrastructure and PO files for translations of manpages and POD "
5399 "files. Eventually this will be combined with the C<po> directory, but that "
5400 "is rather complicated."
5404 #: ../src/guestfs.pod:2769
5405 msgid "C<regressions>"
5409 #: ../src/guestfs.pod:2771
5410 msgid "Regression tests."
5414 #: ../src/guestfs.pod:2773
5419 #: ../src/guestfs.pod:2775
5420 msgid "L<virt-rescue(1)> command and documentation."
5424 #: ../src/guestfs.pod:2777
5429 #: ../src/guestfs.pod:2779
5430 msgid "Source code to the C library."
5434 #: ../src/guestfs.pod:2781
5439 #: ../src/guestfs.pod:2783
5441 "Command line tools written in Perl (L<virt-resize(1)> and many others)."
5445 #: ../src/guestfs.pod:2785
5446 msgid "C<test-tool>"
5450 #: ../src/guestfs.pod:2787
5452 "Test tool for end users to test if their qemu/kernel combination will work "
5457 #: ../src/guestfs.pod:2790
5462 #: ../src/guestfs.pod:2792
5467 #: ../src/guestfs.pod:2794
5472 #: ../src/guestfs.pod:2796
5477 #: ../src/guestfs.pod:2798
5482 #: ../src/guestfs.pod:2800
5487 #: ../src/guestfs.pod:2802
5492 #: ../src/guestfs.pod:2804
5497 #: ../src/guestfs.pod:2806
5498 msgid "Language bindings."
5502 #: ../src/guestfs.pod:2810
5507 #: ../src/guestfs.pod:2812
5508 msgid "PROTOCOL LIMITS"
5512 #: ../src/guestfs.pod:2814
5514 "Internally libguestfs uses a message-based protocol to pass API calls and "
5515 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
5516 "plenty more detail about this). The maximum message size used by the "
5517 "protocol is slightly less than 4 MB. For some API calls you may need to be "
5518 "aware of this limit. The API calls which may be affected are individually "
5519 "documented, with a link back to this section of the documentation."
5523 #: ../src/guestfs.pod:2822
5525 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
5526 "a simple string. Because this string is at some point internally encoded as"
5527 " a message, the maximum size that it can return is slightly under 4 MB. If "
5528 "the requested file is larger than this then you will get an error."
5532 #: ../src/guestfs.pod:2828
5534 "In order to transfer large files into and out of the guest filesystem, you "
5535 "need to use particular calls that support this. The sections L</UPLOADING> "
5536 "and L</DOWNLOADING> document how to do this."
5540 #: ../src/guestfs.pod:2832
5542 "You might also consider mounting the disk image using our FUSE filesystem "
5543 "support (L<guestmount(1)>)."
5547 #: ../src/guestfs.pod:2835
5548 msgid "MAXIMUM NUMBER OF DISKS"
5552 #: ../src/guestfs.pod:2837
5554 "When using virtio disks (the default) the current limit is B<25> disks."
5558 #: ../src/guestfs.pod:2840
5560 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31"
5561 " slots. However febootstrap only understands disks with names C</dev/vda> "
5562 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
5567 #: ../src/guestfs.pod:2845
5569 "We are working to substantially raise this limit in future versions but it "
5570 "requires complex changes to qemu."
5574 #: ../src/guestfs.pod:2848
5576 "In future versions of libguestfs it should also be possible to \"hot plug\" "
5577 "disks (add and remove disks after calling L</guestfs_launch>). This also "
5578 "requires changes to qemu."
5582 #: ../src/guestfs.pod:2852
5583 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
5587 #: ../src/guestfs.pod:2854
5588 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
5592 #: ../src/guestfs.pod:2856
5594 "This is because it reserves 4 bits for the minor device number (thus "
5595 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
5599 #: ../src/guestfs.pod:2859
5601 "If you attach a disk with more than 15 partitions, the extra partitions are "
5602 "ignored by libguestfs."
5606 #: ../src/guestfs.pod:2862
5607 msgid "MAXIMUM SIZE OF A DISK"
5611 #: ../src/guestfs.pod:2864
5612 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
5616 #: ../src/guestfs.pod:2866
5618 "We have tested block devices up to 1 exabyte (2**60 or "
5619 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
5624 #: ../src/guestfs.pod:2870
5626 "Although libguestfs probably does not impose any limit, the underlying host "
5627 "storage will. If you store disk images on a host ext4 filesystem, then the "
5628 "maximum size will be limited by the maximum ext4 file size (currently 16 "
5629 "TB). If you store disk images as host logical volumes then you are limited "
5630 "by the maximum size of an LV."
5634 #: ../src/guestfs.pod:2876
5636 "For the hugest disk image files, we recommend using XFS on the host for "
5641 #: ../src/guestfs.pod:2879
5642 msgid "MAXIMUM SIZE OF A PARTITION"
5646 #: ../src/guestfs.pod:2881
5648 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector numbers."
5649 " Assuming a 512 byte sector size, this means that MBR cannot address a "
5650 "partition located beyond 2 TB on the disk."
5654 #: ../src/guestfs.pod:2885
5656 "It is recommended that you use GPT partitions on disks which are larger than"
5657 " this size. GPT uses 64 bit sector numbers and so can address partitions "
5658 "which are theoretically larger than the largest disk we could support."
5662 #: ../src/guestfs.pod:2890
5663 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
5667 #: ../src/guestfs.pod:2892
5669 "This depends on the filesystem type. libguestfs itself does not impose any "
5670 "known limit. Consult Wikipedia or the filesystem documentation to find out "
5671 "what these limits are."
5675 #: ../src/guestfs.pod:2896
5676 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
5680 #: ../src/guestfs.pod:2898
5682 "The API functions L</guestfs_upload>, L</guestfs_download>, "
5683 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
5684 "uploads and downloads."
5688 #: ../src/guestfs.pod:2902
5689 msgid "INSPECTION LIMITS"
5693 #: ../src/guestfs.pod:2904
5695 "The inspection code has several arbitrary limits on things like the size of "
5696 "Windows Registry hive it will read, and the length of product name. These "
5697 "are intended to stop a malicious guest from consuming arbitrary amounts of "
5698 "memory and disk space on the host, and should not be reached in practice. "
5699 "See the source code for more information."
5703 #: ../src/guestfs.pod:2910 ../fish/guestfish.pod:1075
5704 #: ../test-tool/libguestfs-test-tool.pod:82
5705 msgid "ENVIRONMENT VARIABLES"
5709 #: ../src/guestfs.pod:2914 ../fish/guestfish.pod:1106
5710 msgid "LIBGUESTFS_APPEND"
5714 #: ../src/guestfs.pod:2916 ../fish/guestfish.pod:1108
5715 msgid "Pass additional options to the guest kernel."
5719 #: ../src/guestfs.pod:2918 ../fish/guestfish.pod:1110
5720 msgid "LIBGUESTFS_DEBUG"
5724 #: ../src/guestfs.pod:2920
5726 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
5727 "effect as calling C<guestfs_set_verbose (g, 1)>."
5731 #: ../src/guestfs.pod:2923 ../fish/guestfish.pod:1115
5732 msgid "LIBGUESTFS_MEMSIZE"
5736 #: ../src/guestfs.pod:2925 ../fish/guestfish.pod:1117
5738 "Set the memory allocated to the qemu process, in megabytes. For example:"
5742 #: ../src/guestfs.pod:2928 ../fish/guestfish.pod:1120
5745 " LIBGUESTFS_MEMSIZE=700\n"
5750 #: ../src/guestfs.pod:2930 ../fish/guestfish.pod:1122
5751 msgid "LIBGUESTFS_PATH"
5755 #: ../src/guestfs.pod:2932
5757 "Set the path that libguestfs uses to search for a supermin appliance. See "
5758 "the discussion of paths in section L</PATH> above."
5762 #: ../src/guestfs.pod:2935 ../fish/guestfish.pod:1127
5763 msgid "LIBGUESTFS_QEMU"
5767 #: ../src/guestfs.pod:2937 ../fish/guestfish.pod:1129
5769 "Set the default qemu binary that libguestfs uses. If not set, then the qemu"
5770 " which was found at compile time by the configure script is used."
5774 #: ../src/guestfs.pod:2941
5775 msgid "See also L</QEMU WRAPPERS> above."
5779 #: ../src/guestfs.pod:2943 ../fish/guestfish.pod:1133
5780 msgid "LIBGUESTFS_TRACE"
5784 #: ../src/guestfs.pod:2945
5786 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
5787 "effect as calling C<guestfs_set_trace (g, 1)>."
5791 #: ../src/guestfs.pod:2948 ../fish/guestfish.pod:1142
5796 #: ../src/guestfs.pod:2950 ../fish/guestfish.pod:1144
5798 "Location of temporary directory, defaults to C</tmp> except for the cached "
5799 "supermin appliance which defaults to C</var/tmp>."
5803 #: ../src/guestfs.pod:2953 ../fish/guestfish.pod:1147
5805 "If libguestfs was compiled to use the supermin appliance then the real "
5806 "appliance is cached in this directory, shared between all handles belonging "
5807 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
5808 "use in case C</var/tmp> is not large enough."
5812 #: ../src/guestfs.pod:2961 ../fish/guestfish.pod:1214
5813 #: ../test-tool/libguestfs-test-tool.pod:87 ../fuse/guestmount.pod:279
5814 #: ../tools/virt-win-reg.pl:744 ../tools/virt-list-filesystems.pl:189
5815 #: ../tools/virt-tar.pl:286 ../tools/virt-make-fs.pl:539
5816 #: ../tools/virt-list-partitions.pl:257
5821 #: ../src/guestfs.pod:2963
5823 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L"
5824 "<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L"
5825 "<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L"
5826 "<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L"
5827 "<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
5828 "rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-"
5829 "win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, L<hivex(3)>, "
5830 "L<http://libguestfs.org/>."
5834 #: ../src/guestfs.pod:2990
5836 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
5837 "L<lvm(8)>, L<disktype(1)>."
5841 #: ../src/guestfs.pod:2997 ../tools/virt-win-reg.pl:759
5842 #: ../tools/virt-make-fs.pl:553
5847 #: ../src/guestfs.pod:2999
5848 msgid "To get a list of bugs against libguestfs use this link:"
5852 #: ../src/guestfs.pod:3001
5854 "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
5858 #: ../src/guestfs.pod:3003
5859 msgid "To report a new bug against libguestfs use this link:"
5863 #: ../src/guestfs.pod:3005
5865 "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
5869 #: ../src/guestfs.pod:3007
5870 msgid "When reporting a bug, please check:"
5874 #: ../src/guestfs.pod:3013
5875 msgid "That the bug hasn't been reported already."
5879 #: ../src/guestfs.pod:3017
5880 msgid "That you are testing a recent version."
5884 #: ../src/guestfs.pod:3021
5885 msgid "Describe the bug accurately, and give a way to reproduce it."
5889 #: ../src/guestfs.pod:3025
5891 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the"
5896 #: ../src/guestfs.pod:3030 ../fish/guestfish.pod:1238
5897 #: ../test-tool/libguestfs-test-tool.pod:93 ../fuse/guestmount.pod:290
5902 #: ../src/guestfs.pod:3032 ../fish/guestfish.pod:1240
5903 #: ../test-tool/libguestfs-test-tool.pod:95 ../fuse/guestmount.pod:292
5904 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
5908 #: ../src/guestfs.pod:3034 ../fish/guestfish.pod:1242
5909 #: ../test-tool/libguestfs-test-tool.pod:97 ../fuse/guestmount.pod:294
5910 #: ../tools/virt-win-reg.pl:774 ../tools/virt-list-filesystems.pl:206
5911 #: ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:568
5912 #: ../tools/virt-list-partitions.pl:273
5917 #: ../src/guestfs.pod:3036 ../fish/guestfish.pod:1244
5918 #: ../test-tool/libguestfs-test-tool.pod:99
5919 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5923 #: ../src/guestfs.pod:3039
5925 "This library is free software; you can redistribute it and/or modify it "
5926 "under the terms of the GNU Lesser General Public License as published by the"
5927 " Free Software Foundation; either version 2 of the License, or (at your "
5928 "option) any later version."
5932 #: ../src/guestfs.pod:3044
5934 "This library is distributed in the hope that it will be useful, but WITHOUT "
5935 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
5936 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License"
5937 " for more details."
5941 #: ../src/guestfs.pod:3049
5943 "You should have received a copy of the GNU Lesser General Public License "
5944 "along with this library; if not, write to the Free Software Foundation, "
5945 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
5949 #: ../src/guestfs-actions.pod:1
5950 msgid "guestfs_add_cdrom"
5954 #: ../src/guestfs-actions.pod:3
5958 " guestfs_add_cdrom (guestfs_h *g,\n"
5959 " const char *filename);\n"
5964 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
5965 msgid "This function adds a virtual CD-ROM disk image to the guest."
5969 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
5970 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5974 #: ../src/guestfs-actions.pod:17
5976 "This call checks for the existence of C<filename>. This stops you from "
5977 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5978 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call"
5983 #: ../src/guestfs-actions.pod:24
5985 "If you just want to add an ISO file (often you use this as an efficient way "
5986 "to transfer large files into the guest), then you should probably use "
5987 "C<guestfs_add_drive_ro> instead."
5991 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
5992 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
5993 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
5994 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
5995 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
5996 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
5997 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
5998 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
5999 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
6000 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
6001 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
6002 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
6003 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
6004 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
6005 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
6006 #: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
6007 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
6008 #: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
6009 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
6010 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
6011 #: ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2483
6012 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2579
6013 #: ../src/guestfs-actions.pod:3619 ../src/guestfs-actions.pod:3634
6014 #: ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3848
6015 #: ../src/guestfs-actions.pod:3862 ../src/guestfs-actions.pod:3875
6016 #: ../src/guestfs-actions.pod:3889 ../src/guestfs-actions.pod:3904
6017 #: ../src/guestfs-actions.pod:3940 ../src/guestfs-actions.pod:4012
6018 #: ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4049
6019 #: ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4095
6020 #: ../src/guestfs-actions.pod:4130 ../src/guestfs-actions.pod:4149
6021 #: ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4203
6022 #: ../src/guestfs-actions.pod:4215 ../src/guestfs-actions.pod:4251
6023 #: ../src/guestfs-actions.pod:4267 ../src/guestfs-actions.pod:4280
6024 #: ../src/guestfs-actions.pod:4295 ../src/guestfs-actions.pod:4312
6025 #: ../src/guestfs-actions.pod:4405 ../src/guestfs-actions.pod:4425
6026 #: ../src/guestfs-actions.pod:4438 ../src/guestfs-actions.pod:4489
6027 #: ../src/guestfs-actions.pod:4507 ../src/guestfs-actions.pod:4525
6028 #: ../src/guestfs-actions.pod:4541 ../src/guestfs-actions.pod:4555
6029 #: ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4586
6030 #: ../src/guestfs-actions.pod:4601 ../src/guestfs-actions.pod:4621
6031 #: ../src/guestfs-actions.pod:4691 ../src/guestfs-actions.pod:4764
6032 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814
6033 #: ../src/guestfs-actions.pod:4833 ../src/guestfs-actions.pod:4845
6034 #: ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4875
6035 #: ../src/guestfs-actions.pod:4890 ../src/guestfs-actions.pod:4905
6036 #: ../src/guestfs-actions.pod:4940 ../src/guestfs-actions.pod:4973
6037 #: ../src/guestfs-actions.pod:5012 ../src/guestfs-actions.pod:5032
6038 #: ../src/guestfs-actions.pod:5046 ../src/guestfs-actions.pod:5063
6039 #: ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5158
6040 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5248
6041 #: ../src/guestfs-actions.pod:5283 ../src/guestfs-actions.pod:5300
6042 #: ../src/guestfs-actions.pod:5318 ../src/guestfs-actions.pod:5452
6043 #: ../src/guestfs-actions.pod:5509 ../src/guestfs-actions.pod:5531
6044 #: ../src/guestfs-actions.pod:5549 ../src/guestfs-actions.pod:5581
6045 #: ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5664
6046 #: ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:5691
6047 #: ../src/guestfs-actions.pod:5980 ../src/guestfs-actions.pod:5999
6048 #: ../src/guestfs-actions.pod:6018 ../src/guestfs-actions.pod:6032
6049 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6058
6050 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6084
6051 #: ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6121
6052 #: ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6159
6053 #: ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6207
6054 #: ../src/guestfs-actions.pod:6230 ../src/guestfs-actions.pod:6248
6055 #: ../src/guestfs-actions.pod:6267 ../src/guestfs-actions.pod:6288
6056 #: ../src/guestfs-actions.pod:6307 ../src/guestfs-actions.pod:6324
6057 #: ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6369
6058 #: ../src/guestfs-actions.pod:6393 ../src/guestfs-actions.pod:6412
6059 #: ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6455
6060 #: ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6489
6061 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6556
6062 #: ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6711
6063 #: ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6844
6064 #: ../src/guestfs-actions.pod:6857 ../src/guestfs-actions.pod:6870
6065 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-actions.pod:6905
6066 #: ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:6931
6067 #: ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:7005
6068 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7038
6069 #: ../src/guestfs-actions.pod:7054 ../src/guestfs-actions.pod:7071
6070 #: ../src/guestfs-actions.pod:7084 ../src/guestfs-actions.pod:7104
6071 #: ../src/guestfs-actions.pod:7140 ../src/guestfs-actions.pod:7154
6072 #: ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7208
6073 #: ../src/guestfs-actions.pod:7226 ../src/guestfs-actions.pod:7260
6074 #: ../src/guestfs-actions.pod:7296 ../src/guestfs-actions.pod:7412
6075 #: ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7441
6076 #: ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7509
6077 #: ../src/guestfs-actions.pod:7554 ../src/guestfs-actions.pod:7587
6078 #: ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7670
6079 #: ../src/guestfs-actions.pod:7694 ../src/guestfs-actions.pod:7761
6080 #: ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7809
6081 msgid "This function returns 0 on success or -1 on error."
6085 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
6086 #: ../src/guestfs-actions.pod:275 ../fish/guestfish-actions.pod:28
6087 #: ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
6089 "This function is deprecated. In new code, use the C<add_drive_opts> call "
6094 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
6095 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
6096 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
6097 #: ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4945
6098 #: ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5253
6099 #: ../src/guestfs-actions.pod:6534 ../src/guestfs-actions.pod:6564
6100 #: ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6656
6101 #: ../src/guestfs-actions.pod:7592 ../src/guestfs-actions.pod:7702
6102 #: ../src/guestfs-actions.pod:7872 ../fish/guestfish-actions.pod:31
6103 #: ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180
6104 #: ../fish/guestfish-actions.pod:986 ../fish/guestfish-actions.pod:1346
6105 #: ../fish/guestfish-actions.pod:1360 ../fish/guestfish-actions.pod:3085
6106 #: ../fish/guestfish-actions.pod:3292 ../fish/guestfish-actions.pod:3406
6107 #: ../fish/guestfish-actions.pod:3454 ../fish/guestfish-actions.pod:4349
6108 #: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
6109 #: ../fish/guestfish-actions.pod:4432 ../fish/guestfish-actions.pod:5081
6110 #: ../fish/guestfish-actions.pod:5179
6112 "Deprecated functions will not be removed from the API, but the fact that "
6113 "they are deprecated indicates that there are problems with correct use of "
6118 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
6119 #: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
6120 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2190
6121 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3641
6122 #: ../src/guestfs-actions.pod:4949 ../src/guestfs-actions.pod:6209
6123 #: ../src/guestfs-actions.pod:6326 ../src/guestfs-actions.pod:6457
6124 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7073
6125 #: ../src/guestfs-actions.pod:7596
6126 msgid "(Added in 0.3)"
6130 #: ../src/guestfs-actions.pod:41
6131 msgid "guestfs_add_domain"
6135 #: ../src/guestfs-actions.pod:43
6139 " guestfs_add_domain (guestfs_h *g,\n"
6140 " const char *dom,\n"
6146 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
6147 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2824
6148 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4959
6149 #: ../src/guestfs-actions.pod:5176
6151 "You may supply a list of optional arguments to this call. Use zero or more "
6152 "of the following pairs of parameters, and terminate the list with C<-1> on "
6153 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
6157 #: ../src/guestfs-actions.pod:53
6160 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
6161 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
6162 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
6163 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
6164 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
6169 #: ../src/guestfs-actions.pod:59
6171 "This function adds the disk(s) attached to the named libvirt domain C<dom>."
6172 " It works by connecting to libvirt, requesting the domain and domain XML "
6173 "from libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on"
6178 #: ../src/guestfs-actions.pod:64 ../fish/guestfish-actions.pod:46
6180 "The number of disks added is returned. This operation is atomic: if an "
6181 "error is returned, then no disks are added."
6185 #: ../src/guestfs-actions.pod:67 ../fish/guestfish-actions.pod:49
6187 "This function does some minimal checks to make sure the libvirt domain is "
6188 "not running (unless C<readonly> is true). In a future version we will try "
6189 "to acquire the libvirt lock on each disk."
6193 #: ../src/guestfs-actions.pod:71 ../fish/guestfish-actions.pod:53
6195 "Disks must be accessible locally. This often means that adding disks from a"
6196 " remote libvirt connection (see L<http://libvirt.org/remote.html>) will "
6197 "fail unless those disks are accessible via the same device path locally too."
6201 #: ../src/guestfs-actions.pod:76 ../fish/guestfish-actions.pod:58
6203 "The optional C<libvirturi> parameter sets the libvirt URI (see "
6204 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
6205 "default libvirt URI (or one set through an environment variable, see the "
6206 "libvirt documentation for full details)."
6210 #: ../src/guestfs-actions.pod:82 ../fish/guestfish-actions.pod:64
6212 "The optional C<live> flag controls whether this call will try to connect to "
6213 "a running virtual machine C<guestfsd> process if it sees a suitable "
6214 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
6215 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING"
6216 " DAEMONS> for more information."
6220 #: ../src/guestfs-actions.pod:89 ../fish/guestfish-actions.pod:71
6222 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
6223 "passed instead of the domain name. The C<dom> string is treated as a UUID "
6224 "first and looked up, and if that lookup fails then we treat C<dom> as a name"
6229 #: ../src/guestfs-actions.pod:94
6231 "The other optional parameters are passed directly through to "
6232 "C<guestfs_add_drive_opts>."
6236 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
6237 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
6238 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
6239 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
6240 #: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
6241 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2099
6242 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:2177
6243 #: ../src/guestfs-actions.pod:2470 ../src/guestfs-actions.pod:2942
6244 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:5135
6245 #: ../src/guestfs-actions.pod:5355 ../src/guestfs-actions.pod:5761
6246 #: ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:7181
6247 #: ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7620
6248 #: ../src/guestfs-actions.pod:7633
6249 msgid "On error this function returns -1."
6253 #: ../src/guestfs-actions.pod:99
6254 msgid "(Added in 1.7.4)"
6258 #: ../src/guestfs-actions.pod:101
6259 msgid "guestfs_add_domain_va"
6263 #: ../src/guestfs-actions.pod:103
6267 " guestfs_add_domain_va (guestfs_h *g,\n"
6268 " const char *dom,\n"
6274 #: ../src/guestfs-actions.pod:108
6275 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
6279 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
6280 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
6281 #: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
6282 #: ../src/guestfs-actions.pod:2908 ../src/guestfs-actions.pod:2920
6283 #: ../src/guestfs-actions.pod:4705 ../src/guestfs-actions.pod:4717
6284 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:4999
6285 #: ../src/guestfs-actions.pod:5225 ../src/guestfs-actions.pod:5236
6286 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
6290 #: ../src/guestfs-actions.pod:112
6291 msgid "guestfs_add_domain_argv"
6295 #: ../src/guestfs-actions.pod:114
6299 " guestfs_add_domain_argv (guestfs_h *g,\n"
6300 " const char *dom,\n"
6301 " const struct guestfs_add_domain_argv *optargs);\n"
6306 #: ../src/guestfs-actions.pod:119
6307 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
6311 #: ../src/guestfs-actions.pod:123
6312 msgid "guestfs_add_drive"
6316 #: ../src/guestfs-actions.pod:125
6320 " guestfs_add_drive (guestfs_h *g,\n"
6321 " const char *filename);\n"
6326 #: ../src/guestfs-actions.pod:129
6328 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no"
6329 " optional parameters, so the disk is added writable, with the format being "
6330 "detected automatically."
6334 #: ../src/guestfs-actions.pod:133
6336 "Automatic detection of the format opens you up to a potential security hole "
6337 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6338 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
6339 "you should think about replacing calls to this function with calls to "
6340 "C<guestfs_add_drive_opts>, and specifying the format."
6344 #: ../src/guestfs-actions.pod:144
6345 msgid "guestfs_add_drive_opts"
6349 #: ../src/guestfs-actions.pod:146
6353 " guestfs_add_drive_opts (guestfs_h *g,\n"
6354 " const char *filename,\n"
6360 #: ../src/guestfs-actions.pod:156
6363 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
6364 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
6365 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
6370 #: ../src/guestfs-actions.pod:160 ../fish/guestfish-actions.pod:102
6372 "This function adds a virtual machine disk image C<filename> to libguestfs. "
6373 "The first time you call this function, the disk appears as C</dev/sda>, the "
6374 "second time as C</dev/sdb>, and so on."
6378 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:107
6380 "You don't necessarily need to be root when using libguestfs. However you "
6381 "obviously do need sufficient permissions to access the filename for whatever"
6382 " operations you want to perform (ie. read access if you just want to read "
6383 "the image or write access if you want to modify the image)."
6387 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:113
6388 msgid "This call checks that C<filename> exists."
6392 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4653
6393 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
6394 msgid "The optional arguments are:"
6398 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:119
6403 #: ../src/guestfs-actions.pod:179 ../fish/guestfish-actions.pod:121
6405 "If true then the image is treated as read-only. Writes are still allowed, "
6406 "but they are stored in a temporary snapshot overlay which is discarded at "
6407 "the end. The disk that you add is not modified."
6411 #: ../src/guestfs-actions.pod:183 ../fish/guestfish-actions.pod:125
6416 #: ../src/guestfs-actions.pod:185
6418 "This forces the image format. If you omit this (or use C<guestfs_add_drive>"
6419 " or C<guestfs_add_drive_ro>) then the format is automatically detected. "
6420 "Possible formats include C<raw> and C<qcow2>."
6424 #: ../src/guestfs-actions.pod:189 ../fish/guestfish-actions.pod:131
6426 "Automatic detection of the format opens you up to a potential security hole "
6427 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
6428 "RHBZ#642934. Specifying the format closes this security hole."
6432 #: ../src/guestfs-actions.pod:194 ../fish/guestfish-actions.pod:136
6437 #: ../src/guestfs-actions.pod:196
6439 "This rarely-used option lets you emulate the behaviour of the deprecated "
6440 "C<guestfs_add_drive_with_if> call (q.v.)"
6444 #: ../src/guestfs-actions.pod:203
6445 msgid "(Added in 1.5.23)"
6449 #: ../src/guestfs-actions.pod:205
6450 msgid "guestfs_add_drive_opts_va"
6454 #: ../src/guestfs-actions.pod:207
6458 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
6459 " const char *filename,\n"
6465 #: ../src/guestfs-actions.pod:212
6466 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
6470 #: ../src/guestfs-actions.pod:216
6471 msgid "guestfs_add_drive_opts_argv"
6475 #: ../src/guestfs-actions.pod:218
6479 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
6480 " const char *filename,\n"
6481 " const struct guestfs_add_drive_opts_argv *optargs);\n"
6486 #: ../src/guestfs-actions.pod:223
6487 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
6491 #: ../src/guestfs-actions.pod:227
6492 msgid "guestfs_add_drive_ro"
6496 #: ../src/guestfs-actions.pod:229
6500 " guestfs_add_drive_ro (guestfs_h *g,\n"
6501 " const char *filename);\n"
6506 #: ../src/guestfs-actions.pod:233
6508 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
6509 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
6510 "disk is added read-only, with the format being detected automatically."
6514 #: ../src/guestfs-actions.pod:240
6515 msgid "(Added in 1.0.38)"
6519 #: ../src/guestfs-actions.pod:242
6520 msgid "guestfs_add_drive_ro_with_if"
6524 #: ../src/guestfs-actions.pod:244
6528 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
6529 " const char *filename,\n"
6530 " const char *iface);\n"
6535 #: ../src/guestfs-actions.pod:249
6537 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the"
6538 " QEMU interface emulation to use at run time."
6542 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
6543 #: ../src/guestfs-actions.pod:2429
6544 msgid "(Added in 1.0.84)"
6548 #: ../src/guestfs-actions.pod:263
6549 msgid "guestfs_add_drive_with_if"
6553 #: ../src/guestfs-actions.pod:265
6557 " guestfs_add_drive_with_if (guestfs_h *g,\n"
6558 " const char *filename,\n"
6559 " const char *iface);\n"
6564 #: ../src/guestfs-actions.pod:270
6566 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
6567 "QEMU interface emulation to use at run time."
6571 #: ../src/guestfs-actions.pod:284
6572 msgid "guestfs_aug_clear"
6576 #: ../src/guestfs-actions.pod:286
6580 " guestfs_aug_clear (guestfs_h *g,\n"
6581 " const char *augpath);\n"
6586 #: ../src/guestfs-actions.pod:290 ../fish/guestfish-actions.pod:188
6588 "Set the value associated with C<path> to C<NULL>. This is the same as the "
6589 "L<augtool(1)> C<clear> command."
6593 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2179
6594 msgid "(Added in 1.3.4)"
6598 #: ../src/guestfs-actions.pod:297
6599 msgid "guestfs_aug_close"
6603 #: ../src/guestfs-actions.pod:299
6607 " guestfs_aug_close (guestfs_h *g);\n"
6612 #: ../src/guestfs-actions.pod:302
6614 "Close the current Augeas handle and free up any resources used by it. After"
6615 " calling this, you have to call C<guestfs_aug_init> again before you can use"
6616 " any other Augeas functions."
6620 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
6621 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
6622 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
6623 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
6624 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
6625 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
6626 #: ../src/guestfs-actions.pod:5838
6627 msgid "(Added in 0.7)"
6631 #: ../src/guestfs-actions.pod:311
6632 msgid "guestfs_aug_defnode"
6636 #: ../src/guestfs-actions.pod:313
6639 " struct guestfs_int_bool *\n"
6640 " guestfs_aug_defnode (guestfs_h *g,\n"
6641 " const char *name,\n"
6642 " const char *expr,\n"
6643 " const char *val);\n"
6648 #: ../src/guestfs-actions.pod:319 ../fish/guestfish-actions.pod:204
6650 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
6654 #: ../src/guestfs-actions.pod:322
6656 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
6657 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
6658 "containing that single node."
6662 #: ../src/guestfs-actions.pod:326 ../fish/guestfish-actions.pod:211
6664 "On success this returns a pair containing the number of nodes in the "
6665 "nodeset, and a boolean flag if a node was created."
6669 #: ../src/guestfs-actions.pod:330
6671 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
6672 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
6676 #: ../src/guestfs-actions.pod:336
6677 msgid "guestfs_aug_defvar"
6681 #: ../src/guestfs-actions.pod:338
6685 " guestfs_aug_defvar (guestfs_h *g,\n"
6686 " const char *name,\n"
6687 " const char *expr);\n"
6692 #: ../src/guestfs-actions.pod:343 ../fish/guestfish-actions.pod:219
6694 "Defines an Augeas variable C<name> whose value is the result of evaluating "
6695 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
6699 #: ../src/guestfs-actions.pod:347 ../fish/guestfish-actions.pod:223
6701 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
6702 "evaluates to something which is not a nodeset."
6706 #: ../src/guestfs-actions.pod:354
6707 msgid "guestfs_aug_get"
6711 #: ../src/guestfs-actions.pod:356
6715 " guestfs_aug_get (guestfs_h *g,\n"
6716 " const char *augpath);\n"
6721 #: ../src/guestfs-actions.pod:360 ../fish/guestfish-actions.pod:230
6723 "Look up the value associated with C<path>. If C<path> matches exactly one "
6724 "node, the C<value> is returned."
6728 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922
6729 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000
6730 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119
6731 #: ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266
6732 #: ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419
6733 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719
6734 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899
6735 #: ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002
6736 #: ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2202
6737 #: ../src/guestfs-actions.pod:2394 ../src/guestfs-actions.pod:2598
6738 #: ../src/guestfs-actions.pod:2688 ../src/guestfs-actions.pod:2792
6739 #: ../src/guestfs-actions.pod:2811 ../src/guestfs-actions.pod:3025
6740 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
6741 #: ../src/guestfs-actions.pod:3108 ../src/guestfs-actions.pod:3167
6742 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207
6743 #: ../src/guestfs-actions.pod:3834 ../src/guestfs-actions.pod:4187
6744 #: ../src/guestfs-actions.pod:4357 ../src/guestfs-actions.pod:4467
6745 #: ../src/guestfs-actions.pod:5373 ../src/guestfs-actions.pod:5566
6746 #: ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5914
6747 #: ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6617
6748 #: ../src/guestfs-actions.pod:6633 ../src/guestfs-actions.pod:6650
6749 #: ../src/guestfs-actions.pod:6681 ../src/guestfs-actions.pod:7355
6750 #: ../src/guestfs-actions.pod:7374 ../src/guestfs-actions.pod:7392
6751 #: ../src/guestfs-actions.pod:7566 ../src/guestfs-actions.pod:7866
6753 "This function returns a string, or NULL on error. I<The caller must free "
6754 "the returned string after use>."
6758 #: ../src/guestfs-actions.pod:368
6759 msgid "guestfs_aug_init"
6763 #: ../src/guestfs-actions.pod:370
6767 " guestfs_aug_init (guestfs_h *g,\n"
6768 " const char *root,\n"
6774 #: ../src/guestfs-actions.pod:375 ../fish/guestfish-actions.pod:237
6776 "Create a new Augeas handle for editing configuration files. If there was "
6777 "any previous Augeas handle associated with this guestfs session, then it is "
6782 #: ../src/guestfs-actions.pod:379
6783 msgid "You must call this before using any other C<guestfs_aug_*> commands."
6787 #: ../src/guestfs-actions.pod:382 ../fish/guestfish-actions.pod:244
6789 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
6793 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:247
6795 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
6796 "logical I<or> of the following integers:"
6800 #: ../src/guestfs-actions.pod:391 ../fish/guestfish-actions.pod:253
6801 msgid "C<AUG_SAVE_BACKUP> = 1"
6805 #: ../src/guestfs-actions.pod:393 ../fish/guestfish-actions.pod:255
6806 msgid "Keep the original file with a C<.augsave> extension."
6810 #: ../src/guestfs-actions.pod:395 ../fish/guestfish-actions.pod:257
6811 msgid "C<AUG_SAVE_NEWFILE> = 2"
6815 #: ../src/guestfs-actions.pod:397 ../fish/guestfish-actions.pod:259
6817 "Save changes into a file with extension C<.augnew>, and do not overwrite "
6818 "original. Overrides C<AUG_SAVE_BACKUP>."
6822 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:262
6823 msgid "C<AUG_TYPE_CHECK> = 4"
6827 #: ../src/guestfs-actions.pod:402 ../fish/guestfish-actions.pod:264
6828 msgid "Typecheck lenses (can be expensive)."
6832 #: ../src/guestfs-actions.pod:404 ../fish/guestfish-actions.pod:266
6833 msgid "C<AUG_NO_STDINC> = 8"
6837 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:268
6838 msgid "Do not use standard load path for modules."
6842 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:270
6843 msgid "C<AUG_SAVE_NOOP> = 16"
6847 #: ../src/guestfs-actions.pod:410 ../fish/guestfish-actions.pod:272
6848 msgid "Make save a no-op, just record what would have been changed."
6852 #: ../src/guestfs-actions.pod:412 ../fish/guestfish-actions.pod:274
6853 msgid "C<AUG_NO_LOAD> = 32"
6857 #: ../src/guestfs-actions.pod:414
6858 msgid "Do not load the tree in C<guestfs_aug_init>."
6862 #: ../src/guestfs-actions.pod:418
6863 msgid "To close the handle, you can call C<guestfs_aug_close>."
6867 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:282
6868 msgid "To find out more about Augeas, see L<http://augeas.net/>."
6872 #: ../src/guestfs-actions.pod:426
6873 msgid "guestfs_aug_insert"
6877 #: ../src/guestfs-actions.pod:428
6881 " guestfs_aug_insert (guestfs_h *g,\n"
6882 " const char *augpath,\n"
6883 " const char *label,\n"
6889 #: ../src/guestfs-actions.pod:434 ../fish/guestfish-actions.pod:288
6891 "Create a new sibling C<label> for C<path>, inserting it into the tree before"
6892 " or after C<path> (depending on the boolean flag C<before>)."
6896 #: ../src/guestfs-actions.pod:438 ../fish/guestfish-actions.pod:292
6898 "C<path> must match exactly one existing node in the tree, and C<label> must "
6899 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
6903 #: ../src/guestfs-actions.pod:446
6904 msgid "guestfs_aug_load"
6908 #: ../src/guestfs-actions.pod:448
6912 " guestfs_aug_load (guestfs_h *g);\n"
6917 #: ../src/guestfs-actions.pod:451 ../fish/guestfish-actions.pod:300
6918 msgid "Load files into the tree."
6922 #: ../src/guestfs-actions.pod:453 ../fish/guestfish-actions.pod:302
6923 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
6927 #: ../src/guestfs-actions.pod:460
6928 msgid "guestfs_aug_ls"
6932 #: ../src/guestfs-actions.pod:462
6936 " guestfs_aug_ls (guestfs_h *g,\n"
6937 " const char *augpath);\n"
6942 #: ../src/guestfs-actions.pod:466
6944 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
6945 "sorting the resulting nodes into alphabetical order."
6949 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
6950 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138
6951 #: ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453
6952 #: ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575
6953 #: ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2274
6954 #: ../src/guestfs-actions.pod:2290 ../src/guestfs-actions.pod:2309
6955 #: ../src/guestfs-actions.pod:2352 ../src/guestfs-actions.pod:2376
6956 #: ../src/guestfs-actions.pod:2447 ../src/guestfs-actions.pod:2496
6957 #: ../src/guestfs-actions.pod:2753 ../src/guestfs-actions.pod:3127
6958 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3717
6959 #: ../src/guestfs-actions.pod:3734 ../src/guestfs-actions.pod:3754
6960 #: ../src/guestfs-actions.pod:3816 ../src/guestfs-actions.pod:3921
6961 #: ../src/guestfs-actions.pod:4329 ../src/guestfs-actions.pod:5096
6962 #: ../src/guestfs-actions.pod:5708 ../src/guestfs-actions.pod:5834
6963 #: ../src/guestfs-actions.pod:5948 ../src/guestfs-actions.pod:6697
6964 #: ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6813
6965 #: ../src/guestfs-actions.pod:6959 ../src/guestfs-actions.pod:6983
6966 #: ../src/guestfs-actions.pod:7459 ../src/guestfs-actions.pod:7479
6967 #: ../src/guestfs-actions.pod:7526 ../src/guestfs-actions.pod:7718
6968 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7823
6969 #: ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7888
6970 #: ../src/guestfs-actions.pod:7907
6972 "This function returns a NULL-terminated array of strings (like "
6973 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
6974 "strings and the array after use>."
6978 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063
6979 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491
6980 #: ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3512
6981 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4220
6982 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4440
6983 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5100
6984 #: ../src/guestfs-actions.pod:5649 ../src/guestfs-actions.pod:6046
6985 #: ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6072
6986 #: ../src/guestfs-actions.pod:6538 ../src/guestfs-actions.pod:7197
6987 #: ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7443
6988 #: ../src/guestfs-actions.pod:7706
6989 msgid "(Added in 0.8)"
6993 #: ../src/guestfs-actions.pod:475
6994 msgid "guestfs_aug_match"
6998 #: ../src/guestfs-actions.pod:477
7002 " guestfs_aug_match (guestfs_h *g,\n"
7003 " const char *augpath);\n"
7008 #: ../src/guestfs-actions.pod:481 ../fish/guestfish-actions.pod:316
7010 "Returns a list of paths which match the path expression C<path>. The "
7011 "returned paths are sufficiently qualified so that they match exactly one "
7012 "node in the current tree."
7016 #: ../src/guestfs-actions.pod:491
7017 msgid "guestfs_aug_mv"
7021 #: ../src/guestfs-actions.pod:493
7025 " guestfs_aug_mv (guestfs_h *g,\n"
7026 " const char *src,\n"
7027 " const char *dest);\n"
7032 #: ../src/guestfs-actions.pod:498 ../fish/guestfish-actions.pod:324
7034 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
7035 "C<dest> is overwritten if it exists."
7039 #: ../src/guestfs-actions.pod:505
7040 msgid "guestfs_aug_rm"
7044 #: ../src/guestfs-actions.pod:507
7048 " guestfs_aug_rm (guestfs_h *g,\n"
7049 " const char *augpath);\n"
7054 #: ../src/guestfs-actions.pod:511 ../fish/guestfish-actions.pod:331
7055 msgid "Remove C<path> and all of its children."
7059 #: ../src/guestfs-actions.pod:513 ../fish/guestfish-actions.pod:333
7060 msgid "On success this returns the number of entries which were removed."
7064 #: ../src/guestfs-actions.pod:519
7065 msgid "guestfs_aug_save"
7069 #: ../src/guestfs-actions.pod:521
7073 " guestfs_aug_save (guestfs_h *g);\n"
7078 #: ../src/guestfs-actions.pod:524 ../fish/guestfish-actions.pod:339
7079 msgid "This writes all pending changes to disk."
7083 #: ../src/guestfs-actions.pod:526
7085 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
7090 #: ../src/guestfs-actions.pod:533
7091 msgid "guestfs_aug_set"
7095 #: ../src/guestfs-actions.pod:535
7099 " guestfs_aug_set (guestfs_h *g,\n"
7100 " const char *augpath,\n"
7101 " const char *val);\n"
7106 #: ../src/guestfs-actions.pod:540 ../fish/guestfish-actions.pod:348
7107 msgid "Set the value associated with C<path> to C<val>."
7111 #: ../src/guestfs-actions.pod:542
7113 "In the Augeas API, it is possible to clear a node by setting the value to "
7114 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
7115 "this call. Instead you must use the C<guestfs_aug_clear> call."
7119 #: ../src/guestfs-actions.pod:551
7120 msgid "guestfs_available"
7124 #: ../src/guestfs-actions.pod:553
7128 " guestfs_available (guestfs_h *g,\n"
7129 " char *const *groups);\n"
7134 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:359
7136 "This command is used to check the availability of some groups of "
7137 "functionality in the appliance, which not all builds of the libguestfs "
7138 "appliance will be able to provide."
7142 #: ../src/guestfs-actions.pod:561
7144 "The libguestfs groups, and the functions that those groups correspond to, "
7145 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
7146 "runtime by calling C<guestfs_available_all_groups>."
7150 #: ../src/guestfs-actions.pod:566 ../fish/guestfish-actions.pod:368
7152 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
7153 "\"augeas\"]> would check for the availability of the Linux inotify functions"
7154 " and Augeas (configuration file editing) functions."
7158 #: ../src/guestfs-actions.pod:571 ../fish/guestfish-actions.pod:373
7159 msgid "The command returns no error if I<all> requested groups are available."
7163 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:375
7165 "It fails with an error if one or more of the requested groups is unavailable"
7166 " in the appliance."
7170 #: ../src/guestfs-actions.pod:576 ../fish/guestfish-actions.pod:378
7172 "If an unknown group name is included in the list of groups then an error is "
7177 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:381
7182 #: ../src/guestfs-actions.pod:585
7183 msgid "You must call C<guestfs_launch> before calling this function."
7187 #: ../src/guestfs-actions.pod:587 ../fish/guestfish-actions.pod:389
7189 "The reason is because we don't know what groups are supported by the "
7190 "appliance/daemon until it is running and can be queried."
7194 #: ../src/guestfs-actions.pod:593 ../fish/guestfish-actions.pod:395
7196 "If a group of functions is available, this does not necessarily mean that "
7197 "they will work. You still have to check for errors when calling individual "
7198 "API functions even if they are available."
7202 #: ../src/guestfs-actions.pod:600 ../fish/guestfish-actions.pod:402
7204 "It is usually the job of distro packagers to build complete functionality "
7205 "into the libguestfs appliance. Upstream libguestfs, if built from source "
7206 "with all requirements satisfied, will support everything."
7210 #: ../src/guestfs-actions.pod:607
7212 "This call was added in version C<1.0.80>. In previous versions of "
7213 "libguestfs all you could do would be to speculatively execute a command to "
7214 "find out if the daemon implemented it. See also C<guestfs_version>."
7218 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
7219 msgid "(Added in 1.0.80)"
7223 #: ../src/guestfs-actions.pod:618
7224 msgid "guestfs_available_all_groups"
7228 #: ../src/guestfs-actions.pod:620
7232 " guestfs_available_all_groups (guestfs_h *g);\n"
7237 #: ../src/guestfs-actions.pod:623
7239 "This command returns a list of all optional groups that this daemon knows "
7240 "about. Note this returns both supported and unsupported groups. To find "
7241 "out which ones the daemon can actually support you have to call "
7242 "C<guestfs_available> on each member of the returned list."
7246 #: ../src/guestfs-actions.pod:629
7247 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
7251 #: ../src/guestfs-actions.pod:635
7252 msgid "(Added in 1.3.15)"
7256 #: ../src/guestfs-actions.pod:637
7257 msgid "guestfs_base64_in"
7261 #: ../src/guestfs-actions.pod:639
7265 " guestfs_base64_in (guestfs_h *g,\n"
7266 " const char *base64file,\n"
7267 " const char *filename);\n"
7272 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:432
7274 "This command uploads base64-encoded data from C<base64file> to C<filename>."
7278 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
7279 msgid "(Added in 1.3.5)"
7283 #: ../src/guestfs-actions.pod:651
7284 msgid "guestfs_base64_out"
7288 #: ../src/guestfs-actions.pod:653
7292 " guestfs_base64_out (guestfs_h *g,\n"
7293 " const char *filename,\n"
7294 " const char *base64file);\n"
7299 #: ../src/guestfs-actions.pod:658 ../fish/guestfish-actions.pod:441
7301 "This command downloads the contents of C<filename>, writing it out to local "
7302 "file C<base64file> encoded as base64."
7306 #: ../src/guestfs-actions.pod:665
7307 msgid "guestfs_blockdev_flushbufs"
7311 #: ../src/guestfs-actions.pod:667
7315 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
7316 " const char *device);\n"
7321 #: ../src/guestfs-actions.pod:671 ../fish/guestfish-actions.pod:450
7323 "This tells the kernel to flush internal buffers associated with C<device>."
7327 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
7328 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
7329 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
7330 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
7331 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
7332 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
7333 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
7334 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
7335 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
7336 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
7337 msgid "This uses the L<blockdev(8)> command."
7341 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
7342 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
7343 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
7344 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
7345 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
7346 msgid "(Added in 0.9.3)"
7350 #: ../src/guestfs-actions.pod:680
7351 msgid "guestfs_blockdev_getbsz"
7355 #: ../src/guestfs-actions.pod:682
7359 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
7360 " const char *device);\n"
7365 #: ../src/guestfs-actions.pod:686 ../fish/guestfish-actions.pod:459
7366 msgid "This returns the block size of a device."
7370 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
7371 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
7373 "(Note this is different from both I<size in blocks> and I<filesystem block "
7378 #: ../src/guestfs-actions.pod:697
7379 msgid "guestfs_blockdev_getro"
7383 #: ../src/guestfs-actions.pod:699
7387 " guestfs_blockdev_getro (guestfs_h *g,\n"
7388 " const char *device);\n"
7393 #: ../src/guestfs-actions.pod:703 ../fish/guestfish-actions.pod:470
7395 "Returns a boolean indicating if the block device is read-only (true if read-"
7396 "only, false if not)."
7400 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474
7401 #: ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978
7402 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061
7403 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2125
7404 #: ../src/guestfs-actions.pod:2140 ../src/guestfs-actions.pod:2165
7405 #: ../src/guestfs-actions.pod:2188 ../src/guestfs-actions.pod:3224
7406 #: ../src/guestfs-actions.pod:3240 ../src/guestfs-actions.pod:3258
7407 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3434
7408 #: ../src/guestfs-actions.pod:3449 ../src/guestfs-actions.pod:3463
7409 #: ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494
7410 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3524
7411 #: ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3551
7412 #: ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3581
7413 #: ../src/guestfs-actions.pod:3594 ../src/guestfs-actions.pod:3608
7414 #: ../src/guestfs-actions.pod:5337
7415 msgid "This function returns a C truth value on success or -1 on error."
7419 #: ../src/guestfs-actions.pod:712
7420 msgid "guestfs_blockdev_getsize64"
7424 #: ../src/guestfs-actions.pod:714
7428 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
7429 " const char *device);\n"
7434 #: ../src/guestfs-actions.pod:718 ../fish/guestfish-actions.pod:479
7435 msgid "This returns the size of the device in bytes."
7439 #: ../src/guestfs-actions.pod:720
7440 msgid "See also C<guestfs_blockdev_getsz>."
7444 #: ../src/guestfs-actions.pod:728
7445 msgid "guestfs_blockdev_getss"
7449 #: ../src/guestfs-actions.pod:730
7453 " guestfs_blockdev_getss (guestfs_h *g,\n"
7454 " const char *device);\n"
7459 #: ../src/guestfs-actions.pod:734 ../fish/guestfish-actions.pod:489
7461 "This returns the size of sectors on a block device. Usually 512, but can be"
7462 " larger for modern devices."
7466 #: ../src/guestfs-actions.pod:737
7468 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
7473 #: ../src/guestfs-actions.pod:746
7474 msgid "guestfs_blockdev_getsz"
7478 #: ../src/guestfs-actions.pod:748
7482 " guestfs_blockdev_getsz (guestfs_h *g,\n"
7483 " const char *device);\n"
7488 #: ../src/guestfs-actions.pod:752 ../fish/guestfish-actions.pod:501
7490 "This returns the size of the device in units of 512-byte sectors (even if "
7491 "the sectorsize isn't 512 bytes ... weird)."
7495 #: ../src/guestfs-actions.pod:755
7497 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
7498 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
7502 #: ../src/guestfs-actions.pod:765
7503 msgid "guestfs_blockdev_rereadpt"
7507 #: ../src/guestfs-actions.pod:767
7511 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
7512 " const char *device);\n"
7517 #: ../src/guestfs-actions.pod:771 ../fish/guestfish-actions.pod:514
7518 msgid "Reread the partition table on C<device>."
7522 #: ../src/guestfs-actions.pod:779
7523 msgid "guestfs_blockdev_setbsz"
7527 #: ../src/guestfs-actions.pod:781
7531 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
7532 " const char *device,\n"
7533 " int blocksize);\n"
7538 #: ../src/guestfs-actions.pod:786 ../fish/guestfish-actions.pod:522
7539 msgid "This sets the block size of a device."
7543 #: ../src/guestfs-actions.pod:797
7544 msgid "guestfs_blockdev_setro"
7548 #: ../src/guestfs-actions.pod:799
7552 " guestfs_blockdev_setro (guestfs_h *g,\n"
7553 " const char *device);\n"
7558 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:533
7559 msgid "Sets the block device named C<device> to read-only."
7563 #: ../src/guestfs-actions.pod:811
7564 msgid "guestfs_blockdev_setrw"
7568 #: ../src/guestfs-actions.pod:813
7572 " guestfs_blockdev_setrw (guestfs_h *g,\n"
7573 " const char *device);\n"
7578 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:541
7579 msgid "Sets the block device named C<device> to read-write."
7583 #: ../src/guestfs-actions.pod:825
7584 msgid "guestfs_btrfs_filesystem_resize"
7588 #: ../src/guestfs-actions.pod:827
7592 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
7593 " const char *mountpoint,\n"
7599 #: ../src/guestfs-actions.pod:837
7602 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
7607 #: ../src/guestfs-actions.pod:839 ../fish/guestfish-actions.pod:549
7608 msgid "This command resizes a btrfs filesystem."
7612 #: ../src/guestfs-actions.pod:841 ../fish/guestfish-actions.pod:551
7614 "Note that unlike other resize calls, the filesystem has to be mounted and "
7615 "the parameter is the mountpoint not the device (this is a requirement of "
7620 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5187
7621 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
7622 msgid "The optional parameters are:"
7626 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5191
7627 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
7632 #: ../src/guestfs-actions.pod:851 ../fish/guestfish-actions.pod:561
7634 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
7635 "resized to the maximum size."
7639 #: ../src/guestfs-actions.pod:856 ../fish/guestfish-actions.pod:566
7640 msgid "See also L<btrfs(8)>."
7644 #: ../src/guestfs-actions.pod:860
7645 msgid "(Added in 1.11.17)"
7649 #: ../src/guestfs-actions.pod:862
7650 msgid "guestfs_btrfs_filesystem_resize_va"
7654 #: ../src/guestfs-actions.pod:864
7658 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
7659 " const char *mountpoint,\n"
7665 #: ../src/guestfs-actions.pod:869
7666 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
7670 #: ../src/guestfs-actions.pod:873
7671 msgid "guestfs_btrfs_filesystem_resize_argv"
7675 #: ../src/guestfs-actions.pod:875
7679 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
7680 " const char *mountpoint,\n"
7681 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
7686 #: ../src/guestfs-actions.pod:880
7687 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
7691 #: ../src/guestfs-actions.pod:884
7692 msgid "guestfs_case_sensitive_path"
7696 #: ../src/guestfs-actions.pod:886
7700 " guestfs_case_sensitive_path (guestfs_h *g,\n"
7701 " const char *path);\n"
7706 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:574
7708 "This can be used to resolve case insensitive paths on a filesystem which is "
7709 "case sensitive. The use case is to resolve paths which you have read from "
7710 "Windows configuration files or the Windows Registry, to the true path."
7714 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:579
7716 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
7717 "(and probably others), which is that although the underlying filesystem is "
7718 "case-insensitive, the driver exports the filesystem to Linux as case-"
7723 #: ../src/guestfs-actions.pod:900 ../fish/guestfish-actions.pod:584
7725 "One consequence of this is that special directories such as C<c:\\windows> "
7726 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
7727 "precise details of how they were created. In Windows itself this would not "
7732 #: ../src/guestfs-actions.pod:906 ../fish/guestfish-actions.pod:590
7734 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-"
7735 "faq/#posixfilenames1>"
7739 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:593
7741 "This function resolves the true case of each element in the path and returns"
7742 " the case-sensitive path."
7746 #: ../src/guestfs-actions.pod:912
7748 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
7749 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
7750 "how the directories were originally created under Windows)."
7754 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:601
7755 msgid "I<Note>: This function does not handle drive names, backslashes etc."
7759 #: ../src/guestfs-actions.pod:920
7760 msgid "See also C<guestfs_realpath>."
7764 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7377
7765 msgid "(Added in 1.0.75)"
7769 #: ../src/guestfs-actions.pod:927
7774 #: ../src/guestfs-actions.pod:929
7778 " guestfs_cat (guestfs_h *g,\n"
7779 " const char *path);\n"
7784 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5824
7785 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3831
7786 msgid "Return the contents of the file named C<path>."
7790 #: ../src/guestfs-actions.pod:935
7792 "Note that this function cannot correctly handle binary files (specifically, "
7793 "files containing C<\\0> character which is treated as end of string). For "
7794 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
7795 "functions which have a more complex interface."
7799 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122
7800 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438
7801 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560
7802 #: ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825
7803 #: ../src/guestfs-actions.pod:2294 ../src/guestfs-actions.pod:2313
7804 #: ../src/guestfs-actions.pod:2356 ../src/guestfs-actions.pod:2380
7805 #: ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2426
7806 #: ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5632
7807 #: ../src/guestfs-actions.pod:5763 ../src/guestfs-actions.pod:5789
7808 #: ../src/guestfs-actions.pod:5813 ../src/guestfs-actions.pod:6762
7809 #: ../src/guestfs-actions.pod:6817 ../src/guestfs-actions.pod:6963
7810 #: ../src/guestfs-actions.pod:6987 ../src/guestfs-actions.pod:7652
7811 #: ../src/guestfs-actions.pod:7672 ../src/guestfs-actions.pod:7696
7812 #: ../src/guestfs-actions.pod:7722 ../src/guestfs-actions.pod:7741
7813 #: ../src/guestfs-actions.pod:7827 ../src/guestfs-actions.pod:7846
7814 #: ../src/guestfs-actions.pod:7892 ../src/guestfs-actions.pod:7911
7815 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752
7816 #: ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940
7817 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017
7818 #: ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219
7819 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536
7820 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579
7821 #: ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608
7822 #: ../fish/guestfish-actions.pod:3701 ../fish/guestfish-actions.pod:3716
7823 #: ../fish/guestfish-actions.pod:3792 ../fish/guestfish-actions.pod:3809
7824 #: ../fish/guestfish-actions.pod:3824 ../fish/guestfish-actions.pod:4493
7825 #: ../fish/guestfish-actions.pod:4539 ../fish/guestfish-actions.pod:4624
7826 #: ../fish/guestfish-actions.pod:4639 ../fish/guestfish-actions.pod:5045
7827 #: ../fish/guestfish-actions.pod:5057 ../fish/guestfish-actions.pod:5075
7828 #: ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5102
7829 #: ../fish/guestfish-actions.pod:5151 ../fish/guestfish-actions.pod:5161
7830 #: ../fish/guestfish-actions.pod:5190 ../fish/guestfish-actions.pod:5200
7832 "Because of the message protocol, there is a transfer limit of somewhere "
7833 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
7837 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3738
7838 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:3837
7839 #: ../src/guestfs-actions.pod:3925 ../src/guestfs-actions.pod:4333
7840 #: ../src/guestfs-actions.pod:4347 ../src/guestfs-actions.pod:5712
7841 #: ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:7530
7842 #: ../src/guestfs-actions.pod:7544
7843 msgid "(Added in 0.4)"
7847 #: ../src/guestfs-actions.pod:948
7848 msgid "guestfs_checksum"
7852 #: ../src/guestfs-actions.pod:950
7856 " guestfs_checksum (guestfs_h *g,\n"
7857 " const char *csumtype,\n"
7858 " const char *path);\n"
7863 #: ../src/guestfs-actions.pod:955 ../fish/guestfish-actions.pod:624
7865 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
7869 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:627
7871 "The type of checksum to compute is given by the C<csumtype> parameter which "
7872 "must have one of the following values:"
7876 #: ../src/guestfs-actions.pod:963 ../fish/guestfish-actions.pod:632
7881 #: ../src/guestfs-actions.pod:965 ../fish/guestfish-actions.pod:634
7883 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7888 #: ../src/guestfs-actions.pod:968 ../fish/guestfish-actions.pod:637
7893 #: ../src/guestfs-actions.pod:970 ../fish/guestfish-actions.pod:639
7894 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7898 #: ../src/guestfs-actions.pod:972 ../fish/guestfish-actions.pod:641
7903 #: ../src/guestfs-actions.pod:974 ../fish/guestfish-actions.pod:643
7904 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7908 #: ../src/guestfs-actions.pod:976 ../fish/guestfish-actions.pod:645
7913 #: ../src/guestfs-actions.pod:978 ../fish/guestfish-actions.pod:647
7914 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7918 #: ../src/guestfs-actions.pod:980 ../fish/guestfish-actions.pod:649
7923 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:651
7924 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7928 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:653
7933 #: ../src/guestfs-actions.pod:986 ../fish/guestfish-actions.pod:655
7934 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7938 #: ../src/guestfs-actions.pod:988 ../fish/guestfish-actions.pod:657
7943 #: ../src/guestfs-actions.pod:990 ../fish/guestfish-actions.pod:659
7944 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7948 #: ../src/guestfs-actions.pod:994 ../fish/guestfish-actions.pod:663
7949 msgid "The checksum is returned as a printable string."
7953 #: ../src/guestfs-actions.pod:996
7954 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
7958 #: ../src/guestfs-actions.pod:998
7959 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
7963 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311
7964 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:3436
7965 #: ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3526
7966 #: ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:7233
7967 msgid "(Added in 1.0.2)"
7971 #: ../src/guestfs-actions.pod:1005
7972 msgid "guestfs_checksum_device"
7976 #: ../src/guestfs-actions.pod:1007
7980 " guestfs_checksum_device (guestfs_h *g,\n"
7981 " const char *csumtype,\n"
7982 " const char *device);\n"
7987 #: ../src/guestfs-actions.pod:1012
7989 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7990 "device named C<device>. For the types of checksums supported see the "
7991 "C<guestfs_checksum> command."
7995 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5167
7996 #: ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5339
7997 #: ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5533
7998 #: ../src/guestfs-actions.pod:7142 ../src/guestfs-actions.pod:7156
7999 #: ../src/guestfs-actions.pod:7556
8000 msgid "(Added in 1.3.2)"
8004 #: ../src/guestfs-actions.pod:1021
8005 msgid "guestfs_checksums_out"
8009 #: ../src/guestfs-actions.pod:1023
8013 " guestfs_checksums_out (guestfs_h *g,\n"
8014 " const char *csumtype,\n"
8015 " const char *directory,\n"
8016 " const char *sumsfile);\n"
8021 #: ../src/guestfs-actions.pod:1029 ../fish/guestfish-actions.pod:681
8023 "This command computes the checksums of all regular files in C<directory> and"
8024 " then emits a list of those checksums to the local output file C<sumsfile>."
8028 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:685
8030 "This can be used for verifying the integrity of a virtual machine. However "
8031 "to be properly secure you should pay attention to the output of the checksum"
8032 " command (it uses the ones from GNU coreutils). In particular when the "
8033 "filename is not printable, coreutils uses a special backslash syntax. For "
8034 "more information, see the GNU coreutils info file."
8038 #: ../src/guestfs-actions.pod:1043
8039 msgid "(Added in 1.3.7)"
8043 #: ../src/guestfs-actions.pod:1045
8044 msgid "guestfs_chmod"
8048 #: ../src/guestfs-actions.pod:1047
8052 " guestfs_chmod (guestfs_h *g,\n"
8054 " const char *path);\n"
8059 #: ../src/guestfs-actions.pod:1052 ../fish/guestfish-actions.pod:699
8061 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are"
8066 #: ../src/guestfs-actions.pod:1055 ../fish/guestfish-actions.pod:702
8068 "I<Note>: When using this command from guestfish, C<mode> by default would be"
8069 " decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
8074 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4584
8075 #: ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4812
8076 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:706
8077 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3199
8078 #: ../fish/guestfish-actions.pod:3209 ../fish/guestfish-actions.pod:3219
8079 msgid "The mode actually set is affected by the umask."
8083 #: ../src/guestfs-actions.pod:1065
8084 msgid "guestfs_chown"
8088 #: ../src/guestfs-actions.pod:1067
8092 " guestfs_chown (guestfs_h *g,\n"
8095 " const char *path);\n"
8100 #: ../src/guestfs-actions.pod:1073 ../fish/guestfish-actions.pod:712
8101 msgid "Change the file owner to C<owner> and group to C<group>."
8105 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3655
8106 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
8108 "Only numeric uid and gid are supported. If you want to use names, you will "
8109 "need to locate and parse the password file yourself (Augeas support makes "
8110 "this relatively easy)."
8114 #: ../src/guestfs-actions.pod:1083
8115 msgid "guestfs_command"
8119 #: ../src/guestfs-actions.pod:1085
8123 " guestfs_command (guestfs_h *g,\n"
8124 " char *const *arguments);\n"
8129 #: ../src/guestfs-actions.pod:1089 ../fish/guestfish-actions.pod:722
8131 "This call runs a command from the guest filesystem. The filesystem must be "
8132 "mounted, and must contain a compatible operating system (ie. something "
8133 "Linux, with the same or compatible processor architecture)."
8137 #: ../src/guestfs-actions.pod:1094
8139 "The single parameter is an argv-style list of arguments. The first element "
8140 "is the name of the program to run. Subsequent elements are parameters. The"
8141 " list must be non-empty (ie. must contain a program name). Note that the "
8142 "command runs directly, and is I<not> invoked via the shell (see "
8147 #: ../src/guestfs-actions.pod:1101 ../fish/guestfish-actions.pod:734
8148 msgid "The return value is anything printed to I<stdout> by the command."
8152 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:737
8154 "If the command returns a non-zero exit status, then this function returns an"
8155 " error message. The error message string is the content of I<stderr> from "
8160 #: ../src/guestfs-actions.pod:1108 ../fish/guestfish-actions.pod:741
8162 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
8163 "C</bin>. If you require a program from another location, you should provide"
8164 " the full path in the first parameter."
8168 #: ../src/guestfs-actions.pod:1113 ../fish/guestfish-actions.pod:746
8170 "Shared libraries and data files required by the program must be available on"
8171 " filesystems which are mounted in the correct places. It is the caller's "
8172 "responsibility to ensure all filesystems that are needed are mounted at the "
8177 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145
8178 #: ../src/guestfs-actions.pod:1610
8179 msgid "(Added in 0.9.1)"
8183 #: ../src/guestfs-actions.pod:1127
8184 msgid "guestfs_command_lines"
8188 #: ../src/guestfs-actions.pod:1129
8192 " guestfs_command_lines (guestfs_h *g,\n"
8193 " char *const *arguments);\n"
8198 #: ../src/guestfs-actions.pod:1133
8200 "This is the same as C<guestfs_command>, but splits the result into a list of"
8205 #: ../src/guestfs-actions.pod:1136
8206 msgid "See also: C<guestfs_sh_lines>"
8210 #: ../src/guestfs-actions.pod:1147
8211 msgid "guestfs_config"
8215 #: ../src/guestfs-actions.pod:1149
8219 " guestfs_config (guestfs_h *g,\n"
8220 " const char *qemuparam,\n"
8221 " const char *qemuvalue);\n"
8226 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:771
8228 "This can be used to add arbitrary qemu command line parameters of the form "
8229 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
8230 "setting some parameters which would interfere with parameters that we use."
8234 #: ../src/guestfs-actions.pod:1159 ../fish/guestfish-actions.pod:776
8235 msgid "The first character of C<param> string must be a C<-> (dash)."
8239 #: ../src/guestfs-actions.pod:1161 ../fish/guestfish-actions.pod:778
8240 msgid "C<value> can be NULL."
8244 #: ../src/guestfs-actions.pod:1167
8245 msgid "guestfs_copy_size"
8249 #: ../src/guestfs-actions.pod:1169
8253 " guestfs_copy_size (guestfs_h *g,\n"
8254 " const char *src,\n"
8255 " const char *dest,\n"
8261 #: ../src/guestfs-actions.pod:1175 ../fish/guestfish-actions.pod:784
8263 "This command copies exactly C<size> bytes from one source device or file "
8264 "C<src> to another destination device or file C<dest>."
8268 #: ../src/guestfs-actions.pod:1178 ../fish/guestfish-actions.pod:787
8270 "Note this will fail if the source is too short or if the destination is not "
8275 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306
8276 #: ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382
8277 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781
8278 #: ../src/guestfs-actions.pod:3636 ../src/guestfs-actions.pod:7228
8279 #: ../src/guestfs-actions.pod:7262 ../src/guestfs-actions.pod:7763
8280 #: ../src/guestfs-actions.pod:7782
8282 "This long-running command can generate progress notification messages so "
8283 "that the caller can display a progress bar or indicator. To receive these "
8284 "messages, the caller must register a progress event callback. See "
8285 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
8289 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4360
8290 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7463
8291 #: ../src/guestfs-actions.pod:7483 ../src/guestfs-actions.pod:7569
8292 msgid "(Added in 1.0.87)"
8296 #: ../src/guestfs-actions.pod:1190
8301 #: ../src/guestfs-actions.pod:1192
8305 " guestfs_cp (guestfs_h *g,\n"
8306 " const char *src,\n"
8307 " const char *dest);\n"
8312 #: ../src/guestfs-actions.pod:1197 ../fish/guestfish-actions.pod:794
8314 "This copies a file from C<src> to C<dest> where C<dest> is either a "
8315 "destination filename or destination directory."
8319 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216
8320 #: ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362
8321 #: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5114
8322 #: ../src/guestfs-actions.pod:5583
8323 msgid "(Added in 1.0.18)"
8327 #: ../src/guestfs-actions.pod:1204
8328 msgid "guestfs_cp_a"
8332 #: ../src/guestfs-actions.pod:1206
8336 " guestfs_cp_a (guestfs_h *g,\n"
8337 " const char *src,\n"
8338 " const char *dest);\n"
8343 #: ../src/guestfs-actions.pod:1211 ../fish/guestfish-actions.pod:801
8345 "This copies a file or directory from C<src> to C<dest> recursively using the"
8346 " C<cp -a> command."
8350 #: ../src/guestfs-actions.pod:1218
8355 #: ../src/guestfs-actions.pod:1220
8359 " guestfs_dd (guestfs_h *g,\n"
8360 " const char *src,\n"
8361 " const char *dest);\n"
8366 #: ../src/guestfs-actions.pod:1225 ../fish/guestfish-actions.pod:808
8368 "This command copies from one source device or file C<src> to another "
8369 "destination device or file C<dest>. Normally you would use this to copy to "
8370 "or from a device or partition, for example to duplicate a filesystem."
8374 #: ../src/guestfs-actions.pod:1230
8376 "If the destination is a device, it must be as large or larger than the "
8377 "source file or device, otherwise the copy will fail. This command cannot do"
8378 " partial copies (see C<guestfs_copy_size>)."
8382 #: ../src/guestfs-actions.pod:1238
8387 #: ../src/guestfs-actions.pod:1240
8391 " guestfs_df (guestfs_h *g);\n"
8396 #: ../src/guestfs-actions.pod:1243 ../fish/guestfish-actions.pod:821
8397 msgid "This command runs the C<df> command to report disk space used."
8401 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
8403 "This command is mostly useful for interactive sessions. It is I<not> "
8404 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
8409 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269
8410 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2359
8411 #: ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2451
8412 #: ../src/guestfs-actions.pod:4470 ../src/guestfs-actions.pod:5014
8413 #: ../src/guestfs-actions.pod:6966 ../src/guestfs-actions.pod:6990
8414 #: ../src/guestfs-actions.pod:7609 ../src/guestfs-actions.pod:7622
8415 #: ../src/guestfs-actions.pod:7635
8416 msgid "(Added in 1.0.54)"
8420 #: ../src/guestfs-actions.pod:1254
8421 msgid "guestfs_df_h"
8425 #: ../src/guestfs-actions.pod:1256
8429 " guestfs_df_h (guestfs_h *g);\n"
8434 #: ../src/guestfs-actions.pod:1259 ../fish/guestfish-actions.pod:831
8436 "This command runs the C<df -h> command to report disk space used in human-"
8441 #: ../src/guestfs-actions.pod:1271
8442 msgid "guestfs_dmesg"
8446 #: ../src/guestfs-actions.pod:1273
8450 " guestfs_dmesg (guestfs_h *g);\n"
8455 #: ../src/guestfs-actions.pod:1276 ../fish/guestfish-actions.pod:842
8457 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
8458 "This is sometimes useful for extended debugging of problems."
8462 #: ../src/guestfs-actions.pod:1280
8464 "Another way to get the same information is to enable verbose messages with "
8465 "C<guestfs_set_verbose> or by setting the environment variable "
8466 "C<LIBGUESTFS_DEBUG=1> before running the program."
8470 #: ../src/guestfs-actions.pod:1290
8471 msgid "guestfs_download"
8475 #: ../src/guestfs-actions.pod:1292
8479 " guestfs_download (guestfs_h *g,\n"
8480 " const char *remotefilename,\n"
8481 " const char *filename);\n"
8486 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
8487 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
8489 "Download file C<remotefilename> and save it as C<filename> on the local "
8494 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7222
8495 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4797
8496 msgid "C<filename> can also be a named pipe."
8500 #: ../src/guestfs-actions.pod:1302
8501 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
8505 #: ../src/guestfs-actions.pod:1313
8506 msgid "guestfs_download_offset"
8510 #: ../src/guestfs-actions.pod:1315
8514 " guestfs_download_offset (guestfs_h *g,\n"
8515 " const char *remotefilename,\n"
8516 " const char *filename,\n"
8517 " int64_t offset,\n"
8523 #: ../src/guestfs-actions.pod:1325 ../fish/guestfish-actions.pod:871
8525 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
8526 "region must be within the file or device)."
8530 #: ../src/guestfs-actions.pod:1328
8532 "Note that there is no limit on the amount of data that can be downloaded "
8533 "with this call, unlike with C<guestfs_pread>, and this call always reads the"
8534 " full amount unless an error occurs."
8538 #: ../src/guestfs-actions.pod:1333
8539 msgid "See also C<guestfs_download>, C<guestfs_pread>."
8543 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7267
8544 msgid "(Added in 1.5.17)"
8548 #: ../src/guestfs-actions.pod:1344
8549 msgid "guestfs_drop_caches"
8553 #: ../src/guestfs-actions.pod:1346
8557 " guestfs_drop_caches (guestfs_h *g,\n"
8558 " int whattodrop);\n"
8563 #: ../src/guestfs-actions.pod:1350 ../fish/guestfish-actions.pod:887
8565 "This instructs the guest kernel to drop its page cache, and/or dentries and "
8566 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
8567 "to drop, see L<http://linux-mm.org/Drop_Caches>"
8571 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:892
8572 msgid "Setting C<whattodrop> to 3 should drop everything."
8576 #: ../src/guestfs-actions.pod:1357 ../fish/guestfish-actions.pod:894
8578 "This automatically calls L<sync(2)> before the operation, so that the "
8579 "maximum guest memory is freed."
8583 #: ../src/guestfs-actions.pod:1364
8588 #: ../src/guestfs-actions.pod:1366
8592 " guestfs_du (guestfs_h *g,\n"
8593 " const char *path);\n"
8598 #: ../src/guestfs-actions.pod:1370 ../fish/guestfish-actions.pod:901
8600 "This command runs the C<du -s> command to estimate file space usage for "
8605 #: ../src/guestfs-actions.pod:1373 ../fish/guestfish-actions.pod:904
8607 "C<path> can be a file or a directory. If C<path> is a directory then the "
8608 "estimate includes the contents of the directory and all subdirectories "
8613 #: ../src/guestfs-actions.pod:1377 ../fish/guestfish-actions.pod:908
8615 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
8619 #: ../src/guestfs-actions.pod:1389
8620 msgid "guestfs_e2fsck_f"
8624 #: ../src/guestfs-actions.pod:1391
8628 " guestfs_e2fsck_f (guestfs_h *g,\n"
8629 " const char *device);\n"
8634 #: ../src/guestfs-actions.pod:1395 ../fish/guestfish-actions.pod:915
8636 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
8637 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be"
8642 #: ../src/guestfs-actions.pod:1399
8644 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
8645 "Normally you should use C<guestfs_fsck>."
8649 #: ../src/guestfs-actions.pod:1404
8650 msgid "(Added in 1.0.29)"
8654 #: ../src/guestfs-actions.pod:1406
8655 msgid "guestfs_echo_daemon"
8659 #: ../src/guestfs-actions.pod:1408
8663 " guestfs_echo_daemon (guestfs_h *g,\n"
8664 " char *const *words);\n"
8669 #: ../src/guestfs-actions.pod:1412 ../fish/guestfish-actions.pod:926
8671 "This command concatenates the list of C<words> passed with single spaces "
8672 "between them and returns the resulting string."
8676 #: ../src/guestfs-actions.pod:1415 ../fish/guestfish-actions.pod:929
8677 msgid "You can use this command to test the connection through to the daemon."
8681 #: ../src/guestfs-actions.pod:1417
8682 msgid "See also C<guestfs_ping_daemon>."
8686 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2167
8687 #: ../src/guestfs-actions.pod:6438
8688 msgid "(Added in 1.0.69)"
8692 #: ../src/guestfs-actions.pod:1424
8693 msgid "guestfs_egrep"
8697 #: ../src/guestfs-actions.pod:1426
8701 " guestfs_egrep (guestfs_h *g,\n"
8702 " const char *regex,\n"
8703 " const char *path);\n"
8708 #: ../src/guestfs-actions.pod:1431 ../fish/guestfish-actions.pod:937
8710 "This calls the external C<egrep> program and returns the matching lines."
8714 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460
8715 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563
8716 #: ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2297
8717 #: ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2472
8718 #: ../src/guestfs-actions.pod:2485 ../src/guestfs-actions.pod:2500
8719 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2568
8720 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:3850
8721 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877
8722 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:4892
8723 #: ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:5966
8724 #: ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6846
8725 #: ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872
8726 #: ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6907
8727 #: ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6933
8728 #: ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7744
8729 #: ../src/guestfs-actions.pod:7830 ../src/guestfs-actions.pod:7849
8730 #: ../src/guestfs-actions.pod:7895 ../src/guestfs-actions.pod:7914
8731 msgid "(Added in 1.0.66)"
8735 #: ../src/guestfs-actions.pod:1443
8736 msgid "guestfs_egrepi"
8740 #: ../src/guestfs-actions.pod:1445
8744 " guestfs_egrepi (guestfs_h *g,\n"
8745 " const char *regex,\n"
8746 " const char *path);\n"
8751 #: ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:947
8753 "This calls the external C<egrep -i> program and returns the matching lines."
8757 #: ../src/guestfs-actions.pod:1462
8758 msgid "guestfs_equal"
8762 #: ../src/guestfs-actions.pod:1464
8766 " guestfs_equal (guestfs_h *g,\n"
8767 " const char *file1,\n"
8768 " const char *file2);\n"
8773 #: ../src/guestfs-actions.pod:1469 ../fish/guestfish-actions.pod:957
8775 "This compares the two files C<file1> and C<file2> and returns true if their "
8776 "content is exactly equal, or false otherwise."
8780 #: ../src/guestfs-actions.pod:1472 ../fish/guestfish-actions.pod:960
8781 msgid "The external L<cmp(1)> program is used for the comparison."
8785 #: ../src/guestfs-actions.pod:1478
8786 msgid "guestfs_exists"
8790 #: ../src/guestfs-actions.pod:1480
8794 " guestfs_exists (guestfs_h *g,\n"
8795 " const char *path);\n"
8800 #: ../src/guestfs-actions.pod:1484 ../fish/guestfish-actions.pod:966
8802 "This returns C<true> if and only if there is a file, directory (or anything)"
8803 " with the given C<path> name."
8807 #: ../src/guestfs-actions.pod:1487
8808 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
8812 #: ../src/guestfs-actions.pod:1493
8813 msgid "guestfs_fallocate"
8817 #: ../src/guestfs-actions.pod:1495
8821 " guestfs_fallocate (guestfs_h *g,\n"
8822 " const char *path,\n"
8828 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
8829 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8831 "This command preallocates a file (containing zero bytes) named C<path> of "
8832 "size C<len> bytes. If the file exists already, it is overwritten."
8836 #: ../src/guestfs-actions.pod:1504 ../fish/guestfish-actions.pod:979
8838 "Do not confuse this with the guestfish-specific C<alloc> command which "
8839 "allocates a file in the host and attaches it as a device."
8843 #: ../src/guestfs-actions.pod:1510 ../fish/guestfish-actions.pod:983
8845 "This function is deprecated. In new code, use the C<fallocate64> call "
8850 #: ../src/guestfs-actions.pod:1519
8851 msgid "guestfs_fallocate64"
8855 #: ../src/guestfs-actions.pod:1521
8859 " guestfs_fallocate64 (guestfs_h *g,\n"
8860 " const char *path,\n"
8866 #: ../src/guestfs-actions.pod:1530
8868 "Note that this call allocates disk blocks for the file. To create a sparse "
8869 "file use C<guestfs_truncate_size> instead."
8873 #: ../src/guestfs-actions.pod:1533
8875 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
8876 "oversight it only allowed 30 bit lengths to be specified, effectively "
8877 "limiting the maximum size of files created through that call to 1GB."
8881 #: ../src/guestfs-actions.pod:1538 ../fish/guestfish-actions.pod:1006
8883 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8884 "commands which create a file in the host and attach it as a device."
8888 #: ../src/guestfs-actions.pod:1544
8889 msgid "(Added in 1.3.17)"
8893 #: ../src/guestfs-actions.pod:1546
8894 msgid "guestfs_fgrep"
8898 #: ../src/guestfs-actions.pod:1548
8902 " guestfs_fgrep (guestfs_h *g,\n"
8903 " const char *pattern,\n"
8904 " const char *path);\n"
8909 #: ../src/guestfs-actions.pod:1553 ../fish/guestfish-actions.pod:1014
8911 "This calls the external C<fgrep> program and returns the matching lines."
8915 #: ../src/guestfs-actions.pod:1565
8916 msgid "guestfs_fgrepi"
8920 #: ../src/guestfs-actions.pod:1567
8924 " guestfs_fgrepi (guestfs_h *g,\n"
8925 " const char *pattern,\n"
8926 " const char *path);\n"
8931 #: ../src/guestfs-actions.pod:1572 ../fish/guestfish-actions.pod:1024
8933 "This calls the external C<fgrep -i> program and returns the matching lines."
8937 #: ../src/guestfs-actions.pod:1584
8938 msgid "guestfs_file"
8942 #: ../src/guestfs-actions.pod:1586
8946 " guestfs_file (guestfs_h *g,\n"
8947 " const char *path);\n"
8952 #: ../src/guestfs-actions.pod:1590 ../fish/guestfish-actions.pod:1034
8954 "This call uses the standard L<file(1)> command to determine the type or "
8955 "contents of the file."
8959 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1037
8961 "This call will also transparently look inside various types of compressed "
8966 #: ../src/guestfs-actions.pod:1596 ../fish/guestfish-actions.pod:1040
8968 "The exact command which runs is C<file -zb path>. Note in particular that "
8969 "the filename is not prepended to the output (the I<-b> option)."
8973 #: ../src/guestfs-actions.pod:1600 ../fish/guestfish-actions.pod:1044
8975 "The output depends on the output of the underlying L<file(1)> command and it"
8976 " can change in future in ways beyond our control. In other words, the "
8977 "output is not guaranteed by the ABI."
8981 #: ../src/guestfs-actions.pod:1604
8983 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
8984 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
8988 #: ../src/guestfs-actions.pod:1612
8989 msgid "guestfs_file_architecture"
8993 #: ../src/guestfs-actions.pod:1614
8997 " guestfs_file_architecture (guestfs_h *g,\n"
8998 " const char *filename);\n"
9003 #: ../src/guestfs-actions.pod:1618 ../fish/guestfish-actions.pod:1055
9005 "This detects the architecture of the binary C<filename>, and returns it if "
9010 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1058
9011 msgid "Currently defined architectures are:"
9015 #: ../src/guestfs-actions.pod:1625 ../fish/guestfish-actions.pod:1062
9020 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1064
9022 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
9023 "irrespective of the precise processor requirements of the binary."
9027 #: ../src/guestfs-actions.pod:1630 ../fish/guestfish-actions.pod:1067
9032 #: ../src/guestfs-actions.pod:1632 ../fish/guestfish-actions.pod:1069
9033 msgid "64 bit x86-64."
9037 #: ../src/guestfs-actions.pod:1634 ../fish/guestfish-actions.pod:1071
9042 #: ../src/guestfs-actions.pod:1636 ../fish/guestfish-actions.pod:1073
9043 msgid "32 bit SPARC."
9047 #: ../src/guestfs-actions.pod:1638 ../fish/guestfish-actions.pod:1075
9052 #: ../src/guestfs-actions.pod:1640 ../fish/guestfish-actions.pod:1077
9053 msgid "64 bit SPARC V9 and above."
9057 #: ../src/guestfs-actions.pod:1642 ../fish/guestfish-actions.pod:1079
9062 #: ../src/guestfs-actions.pod:1644 ../fish/guestfish-actions.pod:1081
9063 msgid "Intel Itanium."
9067 #: ../src/guestfs-actions.pod:1646 ../fish/guestfish-actions.pod:1083
9072 #: ../src/guestfs-actions.pod:1648 ../fish/guestfish-actions.pod:1085
9073 msgid "32 bit Power PC."
9077 #: ../src/guestfs-actions.pod:1650 ../fish/guestfish-actions.pod:1087
9082 #: ../src/guestfs-actions.pod:1652 ../fish/guestfish-actions.pod:1089
9083 msgid "64 bit Power PC."
9087 #: ../src/guestfs-actions.pod:1656 ../fish/guestfish-actions.pod:1093
9088 msgid "Libguestfs may return other architecture strings in future."
9092 #: ../src/guestfs-actions.pod:1658 ../fish/guestfish-actions.pod:1095
9093 msgid "The function works on at least the following types of files:"
9097 #: ../src/guestfs-actions.pod:1664 ../fish/guestfish-actions.pod:1101
9098 msgid "many types of Un*x and Linux binary"
9102 #: ../src/guestfs-actions.pod:1668 ../fish/guestfish-actions.pod:1105
9103 msgid "many types of Un*x and Linux shared library"
9107 #: ../src/guestfs-actions.pod:1672 ../fish/guestfish-actions.pod:1109
9108 msgid "Windows Win32 and Win64 binaries"
9112 #: ../src/guestfs-actions.pod:1676 ../fish/guestfish-actions.pod:1113
9113 msgid "Windows Win32 and Win64 DLLs"
9117 #: ../src/guestfs-actions.pod:1678 ../fish/guestfish-actions.pod:1115
9118 msgid "Win32 binaries and DLLs return C<i386>."
9122 #: ../src/guestfs-actions.pod:1680 ../fish/guestfish-actions.pod:1117
9123 msgid "Win64 binaries and DLLs return C<x86_64>."
9127 #: ../src/guestfs-actions.pod:1684 ../fish/guestfish-actions.pod:1121
9128 msgid "Linux kernel modules"
9132 #: ../src/guestfs-actions.pod:1688 ../fish/guestfish-actions.pod:1125
9133 msgid "Linux new-style initrd images"
9137 #: ../src/guestfs-actions.pod:1692 ../fish/guestfish-actions.pod:1129
9138 msgid "some non-x86 Linux vmlinuz kernels"
9142 #: ../src/guestfs-actions.pod:1696 ../fish/guestfish-actions.pod:1133
9143 msgid "What it can't do currently:"
9147 #: ../src/guestfs-actions.pod:1702 ../fish/guestfish-actions.pod:1139
9148 msgid "static libraries (libfoo.a)"
9152 #: ../src/guestfs-actions.pod:1706 ../fish/guestfish-actions.pod:1143
9153 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
9157 #: ../src/guestfs-actions.pod:1710 ../fish/guestfish-actions.pod:1147
9158 msgid "x86 Linux vmlinuz kernels"
9162 #: ../src/guestfs-actions.pod:1712 ../fish/guestfish-actions.pod:1149
9164 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
9165 "compressed code, and are horribly hard to unpack. If you want to find the "
9166 "architecture of a kernel, use the architecture of the associated initrd or "
9167 "kernel module(s) instead."
9171 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885
9172 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2601
9173 #: ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2757
9174 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:2962
9175 #: ../src/guestfs-actions.pod:3002 ../src/guestfs-actions.pod:3077
9176 #: ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3407
9177 #: ../src/guestfs-actions.pod:3539
9178 msgid "(Added in 1.5.3)"
9182 #: ../src/guestfs-actions.pod:1724
9183 msgid "guestfs_filesize"
9187 #: ../src/guestfs-actions.pod:1726
9191 " guestfs_filesize (guestfs_h *g,\n"
9192 " const char *file);\n"
9197 #: ../src/guestfs-actions.pod:1730 ../fish/guestfish-actions.pod:1160
9198 msgid "This command returns the size of C<file> in bytes."
9202 #: ../src/guestfs-actions.pod:1732
9204 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
9205 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
9206 "devices, use C<guestfs_blockdev_getsize64>."
9210 #: ../src/guestfs-actions.pod:1738
9211 msgid "(Added in 1.0.82)"
9215 #: ../src/guestfs-actions.pod:1740
9216 msgid "guestfs_fill"
9220 #: ../src/guestfs-actions.pod:1742
9224 " guestfs_fill (guestfs_h *g,\n"
9227 " const char *path);\n"
9232 #: ../src/guestfs-actions.pod:1748 ../fish/guestfish-actions.pod:1170
9234 "This command creates a new file called C<path>. The initial content of the "
9235 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
9240 #: ../src/guestfs-actions.pod:1752
9242 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
9243 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
9244 "bytes use C<guestfs_fill_pattern>."
9248 #: ../src/guestfs-actions.pod:1764
9249 msgid "(Added in 1.0.79)"
9253 #: ../src/guestfs-actions.pod:1766
9254 msgid "guestfs_fill_pattern"
9258 #: ../src/guestfs-actions.pod:1768
9262 " guestfs_fill_pattern (guestfs_h *g,\n"
9263 " const char *pattern,\n"
9265 " const char *path);\n"
9270 #: ../src/guestfs-actions.pod:1774
9272 "This function is like C<guestfs_fill> except that it creates a new file of "
9273 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
9274 "pattern is truncated if necessary to ensure the length of the file is "
9275 "exactly C<len> bytes."
9279 #: ../src/guestfs-actions.pod:1786
9280 msgid "(Added in 1.3.12)"
9284 #: ../src/guestfs-actions.pod:1788
9285 msgid "guestfs_find"
9289 #: ../src/guestfs-actions.pod:1790
9293 " guestfs_find (guestfs_h *g,\n"
9294 " const char *directory);\n"
9299 #: ../src/guestfs-actions.pod:1794 ../fish/guestfish-actions.pod:1192
9301 "This command lists out all files and directories, recursively, starting at "
9302 "C<directory>. It is essentially equivalent to running the shell command "
9303 "C<find directory -print> but some post-processing happens on the output, "
9308 #: ../src/guestfs-actions.pod:1799 ../fish/guestfish-actions.pod:1197
9310 "This returns a list of strings I<without any prefix>. Thus if the directory"
9315 #: ../src/guestfs-actions.pod:1802 ../fish/guestfish-actions.pod:1200
9325 #: ../src/guestfs-actions.pod:1806
9327 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
9331 #: ../src/guestfs-actions.pod:1809 ../fish/guestfish-actions.pod:1207
9342 #: ../src/guestfs-actions.pod:1814 ../fish/guestfish-actions.pod:1212
9344 "If C<directory> is not a directory, then this command returns an error."
9348 #: ../src/guestfs-actions.pod:1817 ../fish/guestfish-actions.pod:1215
9349 msgid "The returned list is sorted."
9353 #: ../src/guestfs-actions.pod:1819
9354 msgid "See also C<guestfs_find0>."
9358 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4297
9359 #: ../src/guestfs-actions.pod:6001
9360 msgid "(Added in 1.0.27)"
9364 #: ../src/guestfs-actions.pod:1830
9365 msgid "guestfs_find0"
9369 #: ../src/guestfs-actions.pod:1832
9373 " guestfs_find0 (guestfs_h *g,\n"
9374 " const char *directory,\n"
9375 " const char *files);\n"
9380 #: ../src/guestfs-actions.pod:1837 ../fish/guestfish-actions.pod:1226
9382 "This command lists out all files and directories, recursively, starting at "
9383 "C<directory>, placing the resulting list in the external file called "
9388 #: ../src/guestfs-actions.pod:1841
9390 "This command works the same way as C<guestfs_find> with the following "
9395 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1237
9396 msgid "The resulting list is written to an external file."
9400 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1241
9402 "Items (filenames) in the result are separated by C<\\0> characters. See "
9403 "L<find(1)> option I<-print0>."
9407 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1246
9408 msgid "This command is not limited in the number of names that it can return."
9412 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1251
9413 msgid "The result list is not sorted."
9417 #: ../src/guestfs-actions.pod:1868
9418 msgid "(Added in 1.0.74)"
9422 #: ../src/guestfs-actions.pod:1870
9423 msgid "guestfs_findfs_label"
9427 #: ../src/guestfs-actions.pod:1872
9431 " guestfs_findfs_label (guestfs_h *g,\n"
9432 " const char *label);\n"
9437 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1261
9439 "This command searches the filesystems and returns the one which has the "
9440 "given label. An error is returned if no such filesystem can be found."
9444 #: ../src/guestfs-actions.pod:1880
9445 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
9449 #: ../src/guestfs-actions.pod:1887
9450 msgid "guestfs_findfs_uuid"
9454 #: ../src/guestfs-actions.pod:1889
9458 " guestfs_findfs_uuid (guestfs_h *g,\n"
9459 " const char *uuid);\n"
9464 #: ../src/guestfs-actions.pod:1893 ../fish/guestfish-actions.pod:1271
9466 "This command searches the filesystems and returns the one which has the "
9467 "given UUID. An error is returned if no such filesystem can be found."
9471 #: ../src/guestfs-actions.pod:1897
9472 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
9476 #: ../src/guestfs-actions.pod:1904
9477 msgid "guestfs_fsck"
9481 #: ../src/guestfs-actions.pod:1906
9485 " guestfs_fsck (guestfs_h *g,\n"
9486 " const char *fstype,\n"
9487 " const char *device);\n"
9492 #: ../src/guestfs-actions.pod:1911 ../fish/guestfish-actions.pod:1281
9494 "This runs the filesystem checker (fsck) on C<device> which should have "
9495 "filesystem type C<fstype>."
9499 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1284
9501 "The returned integer is the status. See L<fsck(8)> for the list of status "
9502 "codes from C<fsck>."
9506 #: ../src/guestfs-actions.pod:1923 ../fish/guestfish-actions.pod:1293
9507 msgid "Multiple status codes can be summed together."
9511 #: ../src/guestfs-actions.pod:1927 ../fish/guestfish-actions.pod:1297
9513 "A non-zero return code can mean \"success\", for example if errors have been"
9514 " corrected on the filesystem."
9518 #: ../src/guestfs-actions.pod:1932 ../fish/guestfish-actions.pod:1302
9519 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
9523 #: ../src/guestfs-actions.pod:1937 ../fish/guestfish-actions.pod:1307
9525 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
9529 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7768
9530 msgid "(Added in 1.0.16)"
9534 #: ../src/guestfs-actions.pod:1943
9535 msgid "guestfs_get_append"
9539 #: ../src/guestfs-actions.pod:1945
9543 " guestfs_get_append (guestfs_h *g);\n"
9548 #: ../src/guestfs-actions.pod:1948 ../fish/guestfish-actions.pod:1313
9550 "Return the additional kernel options which are added to the guest kernel "
9555 #: ../src/guestfs-actions.pod:1951 ../fish/guestfish-actions.pod:1316
9556 msgid "If C<NULL> then no options are added."
9560 #: ../src/guestfs-actions.pod:1953
9562 "This function returns a string which may be NULL. There is no way to return"
9563 " an error from this function. The string is owned by the guest handle and "
9564 "must I<not> be freed."
9568 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5679
9569 #: ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6601
9570 #: ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6636
9571 #: ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:7414
9572 #: ../src/guestfs-actions.pod:7429 ../src/guestfs-actions.pod:7811
9573 msgid "(Added in 1.0.26)"
9577 #: ../src/guestfs-actions.pod:1959
9578 msgid "guestfs_get_attach_method"
9582 #: ../src/guestfs-actions.pod:1961
9586 " guestfs_get_attach_method (guestfs_h *g);\n"
9591 #: ../src/guestfs-actions.pod:1964
9592 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
9596 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6191
9597 msgid "(Added in 1.9.8)"
9601 #: ../src/guestfs-actions.pod:1971
9602 msgid "guestfs_get_autosync"
9606 #: ../src/guestfs-actions.pod:1973
9610 " guestfs_get_autosync (guestfs_h *g);\n"
9615 #: ../src/guestfs-actions.pod:1976 ../fish/guestfish-actions.pod:1328
9616 msgid "Get the autosync flag."
9620 #: ../src/guestfs-actions.pod:1982
9621 msgid "guestfs_get_direct"
9625 #: ../src/guestfs-actions.pod:1984
9629 " guestfs_get_direct (guestfs_h *g);\n"
9634 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1334
9635 msgid "Return the direct appliance mode flag."
9639 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6232
9640 msgid "(Added in 1.0.72)"
9644 #: ../src/guestfs-actions.pod:1993
9645 msgid "guestfs_get_e2label"
9649 #: ../src/guestfs-actions.pod:1995
9653 " guestfs_get_e2label (guestfs_h *g,\n"
9654 " const char *device);\n"
9659 #: ../src/guestfs-actions.pod:1999 ../fish/guestfish-actions.pod:1340
9661 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
9665 #: ../src/guestfs-actions.pod:2005 ../fish/guestfish-actions.pod:1343
9667 "This function is deprecated. In new code, use the C<vfs_label> call "
9672 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033
9673 #: ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6269
9674 msgid "(Added in 1.0.15)"
9678 #: ../src/guestfs-actions.pod:2014
9679 msgid "guestfs_get_e2uuid"
9683 #: ../src/guestfs-actions.pod:2016
9687 " guestfs_get_e2uuid (guestfs_h *g,\n"
9688 " const char *device);\n"
9693 #: ../src/guestfs-actions.pod:2020 ../fish/guestfish-actions.pod:1354
9695 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9699 #: ../src/guestfs-actions.pod:2026 ../fish/guestfish-actions.pod:1357
9701 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9705 #: ../src/guestfs-actions.pod:2035
9706 msgid "guestfs_get_memsize"
9710 #: ../src/guestfs-actions.pod:2037
9714 " guestfs_get_memsize (guestfs_h *g);\n"
9719 #: ../src/guestfs-actions.pod:2040 ../fish/guestfish-actions.pod:1368
9721 "This gets the memory size in megabytes allocated to the qemu subprocess."
9725 #: ../src/guestfs-actions.pod:2043
9727 "If C<guestfs_set_memsize> was not called on this handle, and if "
9728 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default"
9729 " value for memsize."
9733 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2137
9734 #: ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6409
9735 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432
9736 #: ../fish/guestfish-actions.pod:4157 ../fish/guestfish-actions.pod:4259
9738 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9742 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4588
9743 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816
9744 #: ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847
9745 #: ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877
9746 #: ../src/guestfs-actions.pod:5904 ../src/guestfs-actions.pod:6290
9747 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:7183
9748 msgid "(Added in 1.0.55)"
9752 #: ../src/guestfs-actions.pod:2054
9753 msgid "guestfs_get_network"
9757 #: ../src/guestfs-actions.pod:2056
9761 " guestfs_get_network (guestfs_h *g);\n"
9766 #: ../src/guestfs-actions.pod:2059 ../fish/guestfish-actions.pod:1382
9767 msgid "This returns the enable network flag."
9771 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6309
9772 msgid "(Added in 1.5.4)"
9776 #: ../src/guestfs-actions.pod:2065
9777 msgid "guestfs_get_path"
9781 #: ../src/guestfs-actions.pod:2067
9785 " guestfs_get_path (guestfs_h *g);\n"
9790 #: ../src/guestfs-actions.pod:2070 ../fish/guestfish-actions.pod:1388
9791 msgid "Return the current search path."
9795 #: ../src/guestfs-actions.pod:2072 ../fish/guestfish-actions.pod:1390
9797 "This is always non-NULL. If it wasn't set already, then this will return "
9802 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2113
9804 "This function returns a string, or NULL on error. The string is owned by "
9805 "the guest handle and must I<not> be freed."
9809 #: ../src/guestfs-actions.pod:2080
9810 msgid "guestfs_get_pgroup"
9814 #: ../src/guestfs-actions.pod:2082
9818 " guestfs_get_pgroup (guestfs_h *g);\n"
9823 #: ../src/guestfs-actions.pod:2085 ../fish/guestfish-actions.pod:1397
9824 msgid "This returns the process group flag."
9828 #: ../src/guestfs-actions.pod:2089
9829 msgid "guestfs_get_pid"
9833 #: ../src/guestfs-actions.pod:2091
9837 " guestfs_get_pid (guestfs_h *g);\n"
9842 #: ../src/guestfs-actions.pod:2094 ../fish/guestfish-actions.pod:1405
9844 "Return the process ID of the qemu subprocess. If there is no qemu "
9845 "subprocess, then this will return an error."
9849 #: ../src/guestfs-actions.pod:2097 ../fish/guestfish-actions.pod:1408
9850 msgid "This is an internal call used for debugging and testing."
9854 #: ../src/guestfs-actions.pod:2101
9855 msgid "(Added in 1.0.56)"
9859 #: ../src/guestfs-actions.pod:2103
9860 msgid "guestfs_get_qemu"
9864 #: ../src/guestfs-actions.pod:2105
9868 " guestfs_get_qemu (guestfs_h *g);\n"
9873 #: ../src/guestfs-actions.pod:2108 ../fish/guestfish-actions.pod:1414
9874 msgid "Return the current qemu binary."
9878 #: ../src/guestfs-actions.pod:2110 ../fish/guestfish-actions.pod:1416
9880 "This is always non-NULL. If it wasn't set already, then this will return "
9881 "the default qemu binary name."
9885 #: ../src/guestfs-actions.pod:2116 ../src/guestfs-actions.pod:6371
9886 msgid "(Added in 1.0.6)"
9890 #: ../src/guestfs-actions.pod:2118
9891 msgid "guestfs_get_recovery_proc"
9895 #: ../src/guestfs-actions.pod:2120
9899 " guestfs_get_recovery_proc (guestfs_h *g);\n"
9904 #: ../src/guestfs-actions.pod:2123 ../fish/guestfish-actions.pod:1423
9905 msgid "Return the recovery process enabled flag."
9909 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3661
9910 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4395
9911 #: ../src/guestfs-actions.pod:4427 ../src/guestfs-actions.pod:5609
9912 #: ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6395
9913 #: ../src/guestfs-actions.pod:7086 ../src/guestfs-actions.pod:7106
9914 #: ../src/guestfs-actions.pod:7298
9915 msgid "(Added in 1.0.77)"
9919 #: ../src/guestfs-actions.pod:2129
9920 msgid "guestfs_get_selinux"
9924 #: ../src/guestfs-actions.pod:2131
9928 " guestfs_get_selinux (guestfs_h *g);\n"
9933 #: ../src/guestfs-actions.pod:2134
9935 "This returns the current setting of the selinux flag which is passed to the "
9936 "appliance at boot time. See C<guestfs_set_selinux>."
9940 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2205
9941 #: ../src/guestfs-actions.pod:6414 ../src/guestfs-actions.pod:6472
9942 msgid "(Added in 1.0.67)"
9946 #: ../src/guestfs-actions.pod:2144
9947 msgid "guestfs_get_state"
9951 #: ../src/guestfs-actions.pod:2146
9955 " guestfs_get_state (guestfs_h *g);\n"
9960 #: ../src/guestfs-actions.pod:2149 ../fish/guestfish-actions.pod:1439
9962 "This returns the current state as an opaque integer. This is only useful "
9963 "for printing debug and internal error messages."
9967 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:3432
9968 #: ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3522
9969 #: ../src/guestfs-actions.pod:3549 ../fish/guestfish-actions.pod:1442
9970 #: ../fish/guestfish-actions.pod:2362 ../fish/guestfish-actions.pod:2380
9971 #: ../fish/guestfish-actions.pod:2418 ../fish/guestfish-actions.pod:2434
9972 msgid "For more information on states, see L<guestfs(3)>."
9976 #: ../src/guestfs-actions.pod:2158
9977 msgid "guestfs_get_trace"
9981 #: ../src/guestfs-actions.pod:2160
9985 " guestfs_get_trace (guestfs_h *g);\n"
9990 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1448
9991 msgid "Return the command trace flag."
9995 #: ../src/guestfs-actions.pod:2169
9996 msgid "guestfs_get_umask"
10000 #: ../src/guestfs-actions.pod:2171
10004 " guestfs_get_umask (guestfs_h *g);\n"
10009 #: ../src/guestfs-actions.pod:2174
10011 "Return the current umask. By default the umask is C<022> unless it has been"
10012 " set by calling C<guestfs_umask>."
10016 #: ../src/guestfs-actions.pod:2181
10017 msgid "guestfs_get_verbose"
10021 #: ../src/guestfs-actions.pod:2183
10025 " guestfs_get_verbose (guestfs_h *g);\n"
10030 #: ../src/guestfs-actions.pod:2186 ../fish/guestfish-actions.pod:1461
10031 msgid "This returns the verbose messages flag."
10035 #: ../src/guestfs-actions.pod:2192
10036 msgid "guestfs_getcon"
10040 #: ../src/guestfs-actions.pod:2194
10044 " guestfs_getcon (guestfs_h *g);\n"
10049 #: ../src/guestfs-actions.pod:2197 ../fish/guestfish-actions.pod:1467
10050 msgid "This gets the SELinux security context of the daemon."
10054 #: ../src/guestfs-actions.pod:2199
10056 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
10060 #: ../src/guestfs-actions.pod:2207
10061 msgid "guestfs_getxattr"
10065 #: ../src/guestfs-actions.pod:2209
10069 " guestfs_getxattr (guestfs_h *g,\n"
10070 " const char *path,\n"
10071 " const char *name,\n"
10072 " size_t *size_r);\n"
10077 #: ../src/guestfs-actions.pod:2215
10079 "Get a single extended attribute from file C<path> named C<name>. This call "
10080 "follows symlinks. If you want to lookup an extended attribute for the "
10081 "symlink itself, use C<guestfs_lgetxattr>."
10085 #: ../src/guestfs-actions.pod:2219 ../src/guestfs-actions.pod:3675
10087 "Normally it is better to get all extended attributes from a file in one go "
10088 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
10089 "implementations are buggy and do not provide a way to list out attributes. "
10090 "For these filesystems (notably ntfs-3g) you have to know the names of the "
10091 "extended attributes you want in advance and call this function."
10095 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
10096 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
10098 "Extended attribute values are blobs of binary data. If there is no extended"
10099 " attribute named C<name>, this returns an error."
10103 #: ../src/guestfs-actions.pod:2229
10104 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
10108 #: ../src/guestfs-actions.pod:2231 ../src/guestfs-actions.pod:2422
10109 #: ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:3687
10110 #: ../src/guestfs-actions.pod:5602 ../src/guestfs-actions.pod:5628
10111 #: ../src/guestfs-actions.pod:5809
10113 "This function returns a buffer, or NULL on error. The size of the returned "
10114 "buffer is written to C<*size_r>. I<The caller must free the returned buffer"
10119 #: ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:3691
10120 msgid "(Added in 1.7.24)"
10124 #: ../src/guestfs-actions.pod:2237
10125 msgid "guestfs_getxattrs"
10129 #: ../src/guestfs-actions.pod:2239
10132 " struct guestfs_xattr_list *\n"
10133 " guestfs_getxattrs (guestfs_h *g,\n"
10134 " const char *path);\n"
10139 #: ../src/guestfs-actions.pod:2243 ../fish/guestfish-actions.pod:1496
10141 "This call lists the extended attributes of the file or directory C<path>."
10145 #: ../src/guestfs-actions.pod:2246 ../fish/guestfish-actions.pod:1499
10147 "At the system call level, this is a combination of the L<listxattr(2)> and "
10148 "L<getxattr(2)> calls."
10152 #: ../src/guestfs-actions.pod:2249
10153 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
10157 #: ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:3703
10158 #: ../src/guestfs-actions.pod:4391
10160 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was"
10161 " an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
10165 #: ../src/guestfs-actions.pod:2255 ../src/guestfs-actions.pod:3707
10166 #: ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3942
10167 #: ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:6491
10168 #: ../src/guestfs-actions.pod:7876
10169 msgid "(Added in 1.0.59)"
10173 #: ../src/guestfs-actions.pod:2257
10174 msgid "guestfs_glob_expand"
10178 #: ../src/guestfs-actions.pod:2259
10182 " guestfs_glob_expand (guestfs_h *g,\n"
10183 " const char *pattern);\n"
10188 #: ../src/guestfs-actions.pod:2263 ../fish/guestfish-actions.pod:1508
10190 "This command searches for all the pathnames matching C<pattern> according to"
10191 " the wildcard expansion rules used by the shell."
10195 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1512
10197 "If no paths match, then this returns an empty list (note: not an error)."
10201 #: ../src/guestfs-actions.pod:2270 ../fish/guestfish-actions.pod:1515
10203 "It is just a wrapper around the C L<glob(3)> function with flags "
10204 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
10208 #: ../src/guestfs-actions.pod:2278 ../src/guestfs-actions.pod:6684
10209 #: ../src/guestfs-actions.pod:6701
10210 msgid "(Added in 1.0.50)"
10214 #: ../src/guestfs-actions.pod:2280
10215 msgid "guestfs_grep"
10219 #: ../src/guestfs-actions.pod:2282
10223 " guestfs_grep (guestfs_h *g,\n"
10224 " const char *regex,\n"
10225 " const char *path);\n"
10230 #: ../src/guestfs-actions.pod:2287 ../fish/guestfish-actions.pod:1523
10232 "This calls the external C<grep> program and returns the matching lines."
10236 #: ../src/guestfs-actions.pod:2299
10237 msgid "guestfs_grepi"
10241 #: ../src/guestfs-actions.pod:2301
10245 " guestfs_grepi (guestfs_h *g,\n"
10246 " const char *regex,\n"
10247 " const char *path);\n"
10252 #: ../src/guestfs-actions.pod:2306 ../fish/guestfish-actions.pod:1533
10254 "This calls the external C<grep -i> program and returns the matching lines."
10258 #: ../src/guestfs-actions.pod:2318
10259 msgid "guestfs_grub_install"
10263 #: ../src/guestfs-actions.pod:2320
10267 " guestfs_grub_install (guestfs_h *g,\n"
10268 " const char *root,\n"
10269 " const char *device);\n"
10274 #: ../src/guestfs-actions.pod:2325 ../fish/guestfish-actions.pod:1543
10276 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with"
10277 " the root directory being C<root>."
10281 #: ../src/guestfs-actions.pod:2328 ../fish/guestfish-actions.pod:1546
10283 "Note: If grub-install reports the error \"No suitable drive was found in the"
10284 " generated device map.\" it may be that you need to create a "
10285 "C</boot/grub/device.map> file first that contains the mapping between grub "
10286 "device names and Linux device names. It is usually sufficient to create a "
10291 #: ../src/guestfs-actions.pod:2335 ../fish/guestfish-actions.pod:1553
10294 " (hd0) /dev/vda\n"
10299 #: ../src/guestfs-actions.pod:2337 ../fish/guestfish-actions.pod:1555
10300 msgid "replacing C</dev/vda> with the name of the installation device."
10304 #: ../src/guestfs-actions.pod:2341
10305 msgid "(Added in 1.0.17)"
10309 #: ../src/guestfs-actions.pod:2343
10310 msgid "guestfs_head"
10314 #: ../src/guestfs-actions.pod:2345
10318 " guestfs_head (guestfs_h *g,\n"
10319 " const char *path);\n"
10324 #: ../src/guestfs-actions.pod:2349 ../fish/guestfish-actions.pod:1561
10326 "This command returns up to the first 10 lines of a file as a list of "
10331 #: ../src/guestfs-actions.pod:2361
10332 msgid "guestfs_head_n"
10336 #: ../src/guestfs-actions.pod:2363
10340 " guestfs_head_n (guestfs_h *g,\n"
10342 " const char *path);\n"
10347 #: ../src/guestfs-actions.pod:2368 ../fish/guestfish-actions.pod:1571
10349 "If the parameter C<nrlines> is a positive number, this returns the first "
10350 "C<nrlines> lines of the file C<path>."
10354 #: ../src/guestfs-actions.pod:2371 ../fish/guestfish-actions.pod:1574
10356 "If the parameter C<nrlines> is a negative number, this returns lines from "
10357 "the file C<path>, excluding the last C<nrlines> lines."
10361 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:6981
10362 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4637
10363 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
10367 #: ../src/guestfs-actions.pod:2385
10368 msgid "guestfs_hexdump"
10372 #: ../src/guestfs-actions.pod:2387
10376 " guestfs_hexdump (guestfs_h *g,\n"
10377 " const char *path);\n"
10382 #: ../src/guestfs-actions.pod:2391 ../fish/guestfish-actions.pod:1586
10384 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
10385 "readable, canonical hex dump of the file."
10389 #: ../src/guestfs-actions.pod:2400 ../src/guestfs-actions.pod:6765
10390 #: ../src/guestfs-actions.pod:6820
10391 msgid "(Added in 1.0.22)"
10395 #: ../src/guestfs-actions.pod:2402
10396 msgid "guestfs_initrd_cat"
10400 #: ../src/guestfs-actions.pod:2404
10404 " guestfs_initrd_cat (guestfs_h *g,\n"
10405 " const char *initrdpath,\n"
10406 " const char *filename,\n"
10407 " size_t *size_r);\n"
10412 #: ../src/guestfs-actions.pod:2410 ../fish/guestfish-actions.pod:1596
10414 "This command unpacks the file C<filename> from the initrd file called "
10415 "C<initrdpath>. The filename must be given I<without> the initial C</> "
10420 #: ../src/guestfs-actions.pod:2414 ../fish/guestfish-actions.pod:1600
10422 "For example, in guestfish you could use the following command to examine the"
10423 " boot script (usually called C</init>) contained in a Linux initrd or "
10428 #: ../src/guestfs-actions.pod:2418 ../fish/guestfish-actions.pod:1604
10431 " initrd-cat /boot/initrd-<version>.img init\n"
10436 #: ../src/guestfs-actions.pod:2420
10437 msgid "See also C<guestfs_initrd_list>."
10441 #: ../src/guestfs-actions.pod:2431
10442 msgid "guestfs_initrd_list"
10446 #: ../src/guestfs-actions.pod:2433
10450 " guestfs_initrd_list (guestfs_h *g,\n"
10451 " const char *path);\n"
10456 #: ../src/guestfs-actions.pod:2437 ../fish/guestfish-actions.pod:1615
10457 msgid "This command lists out files contained in an initrd."
10461 #: ../src/guestfs-actions.pod:2439 ../fish/guestfish-actions.pod:1617
10463 "The files are listed without any initial C</> character. The files are "
10464 "listed in the order they appear (not necessarily alphabetical). Directory "
10465 "names are listed as separate items."
10469 #: ../src/guestfs-actions.pod:2443 ../fish/guestfish-actions.pod:1621
10471 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
10472 "initrd. We I<only> support the newer initramfs format (compressed cpio "
10477 #: ../src/guestfs-actions.pod:2453
10478 msgid "guestfs_inotify_add_watch"
10482 #: ../src/guestfs-actions.pod:2455
10486 " guestfs_inotify_add_watch (guestfs_h *g,\n"
10487 " const char *path,\n"
10493 #: ../src/guestfs-actions.pod:2460 ../fish/guestfish-actions.pod:1629
10494 msgid "Watch C<path> for the events listed in C<mask>."
10498 #: ../src/guestfs-actions.pod:2462 ../fish/guestfish-actions.pod:1631
10500 "Note that if C<path> is a directory then events within that directory are "
10501 "watched, but this does I<not> happen recursively (in subdirectories)."
10505 #: ../src/guestfs-actions.pod:2466 ../fish/guestfish-actions.pod:1635
10507 "Note for non-C or non-Linux callers: the inotify events are defined by the "
10508 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
10512 #: ../src/guestfs-actions.pod:2474
10513 msgid "guestfs_inotify_close"
10517 #: ../src/guestfs-actions.pod:2476
10521 " guestfs_inotify_close (guestfs_h *g);\n"
10526 #: ../src/guestfs-actions.pod:2479 ../fish/guestfish-actions.pod:1643
10528 "This closes the inotify handle which was previously opened by inotify_init."
10529 " It removes all watches, throws away any pending events, and deallocates "
10534 #: ../src/guestfs-actions.pod:2487
10535 msgid "guestfs_inotify_files"
10539 #: ../src/guestfs-actions.pod:2489
10543 " guestfs_inotify_files (guestfs_h *g);\n"
10548 #: ../src/guestfs-actions.pod:2492
10550 "This function is a helpful wrapper around C<guestfs_inotify_read> which just"
10551 " returns a list of pathnames of objects that were touched. The returned "
10552 "pathnames are sorted and deduplicated."
10556 #: ../src/guestfs-actions.pod:2502
10557 msgid "guestfs_inotify_init"
10561 #: ../src/guestfs-actions.pod:2504
10565 " guestfs_inotify_init (guestfs_h *g,\n"
10566 " int maxevents);\n"
10571 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1659
10573 "This command creates a new inotify handle. The inotify subsystem can be "
10574 "used to notify events which happen to objects in the guest filesystem."
10578 #: ../src/guestfs-actions.pod:2512
10580 "C<maxevents> is the maximum number of events which will be queued up between"
10581 " calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
10582 "passed as C<0>, then the kernel (or previously set) default is used. For "
10583 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
10584 "throws away events, but records the fact that it threw them away by setting "
10585 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
10586 "C<guestfs_inotify_read>)."
10590 #: ../src/guestfs-actions.pod:2522
10592 "Before any events are generated, you have to add some watches to the "
10593 "internal watch list. See: C<guestfs_inotify_add_watch>, "
10594 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
10598 #: ../src/guestfs-actions.pod:2528
10600 "Queued up events should be read periodically by calling "
10601 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful"
10602 " wrapper around C<guestfs_inotify_read>). If you don't read the events out "
10603 "often enough then you risk the internal queue overflowing."
10607 #: ../src/guestfs-actions.pod:2535
10609 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
10610 "This also removes any watches automatically."
10614 #: ../src/guestfs-actions.pod:2539 ../fish/guestfish-actions.pod:1690
10616 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10617 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10618 "that there is one global inotify handle per libguestfs instance."
10622 #: ../src/guestfs-actions.pod:2548
10623 msgid "guestfs_inotify_read"
10627 #: ../src/guestfs-actions.pod:2550
10630 " struct guestfs_inotify_event_list *\n"
10631 " guestfs_inotify_read (guestfs_h *g);\n"
10636 #: ../src/guestfs-actions.pod:2553 ../fish/guestfish-actions.pod:1699
10638 "Return the complete queue of events that have happened since the previous "
10643 #: ../src/guestfs-actions.pod:2556 ../fish/guestfish-actions.pod:1702
10644 msgid "If no events have happened, this returns an empty list."
10648 #: ../src/guestfs-actions.pod:2558 ../fish/guestfish-actions.pod:1704
10650 "I<Note>: In order to make sure that all events have been read, you must call"
10651 " this function repeatedly until it returns an empty list. The reason is "
10652 "that the call will read events up to the maximum appliance-to-host message "
10653 "size and leave remaining events in the queue."
10657 #: ../src/guestfs-actions.pod:2564
10659 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
10660 "there was an error. I<The caller must call "
10661 "C<guestfs_free_inotify_event_list> after use>."
10665 #: ../src/guestfs-actions.pod:2570
10666 msgid "guestfs_inotify_rm_watch"
10670 #: ../src/guestfs-actions.pod:2572
10674 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
10680 #: ../src/guestfs-actions.pod:2576
10682 "Remove a previously defined inotify watch. See "
10683 "C<guestfs_inotify_add_watch>."
10687 #: ../src/guestfs-actions.pod:2583
10688 msgid "guestfs_inspect_get_arch"
10692 #: ../src/guestfs-actions.pod:2585
10696 " guestfs_inspect_get_arch (guestfs_h *g,\n"
10697 " const char *root);\n"
10702 #: ../src/guestfs-actions.pod:2589
10704 "This returns the architecture of the inspected operating system. The "
10705 "possible return values are listed under C<guestfs_file_architecture>."
10709 #: ../src/guestfs-actions.pod:2593 ../fish/guestfish-actions.pod:1725
10711 "If the architecture could not be determined, then the string C<unknown> is "
10716 #: ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:2686
10717 #: ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:2809
10718 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:3023
10719 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3072
10720 #: ../src/guestfs-actions.pod:3125 ../src/guestfs-actions.pod:3165
10721 #: ../src/guestfs-actions.pod:3185 ../src/guestfs-actions.pod:3205
10722 #: ../src/guestfs-actions.pod:3222 ../src/guestfs-actions.pod:3238
10723 #: ../src/guestfs-actions.pod:3256 ../src/guestfs-actions.pod:3358
10724 #: ../src/guestfs-actions.pod:3399 ../fish/guestfish-actions.pod:1728
10725 #: ../fish/guestfish-actions.pod:1811 ../fish/guestfish-actions.pod:1890
10726 #: ../fish/guestfish-actions.pod:1902 ../fish/guestfish-actions.pod:1986
10727 #: ../fish/guestfish-actions.pod:2047 ../fish/guestfish-actions.pod:2068
10728 #: ../fish/guestfish-actions.pod:2082 ../fish/guestfish-actions.pod:2122
10729 #: ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2167
10730 #: ../fish/guestfish-actions.pod:2180 ../fish/guestfish-actions.pod:2190
10731 #: ../fish/guestfish-actions.pod:2200 ../fish/guestfish-actions.pod:2212
10732 #: ../fish/guestfish-actions.pod:2308 ../fish/guestfish-actions.pod:2342
10733 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10737 #: ../src/guestfs-actions.pod:2603
10738 msgid "guestfs_inspect_get_distro"
10742 #: ../src/guestfs-actions.pod:2605
10746 " guestfs_inspect_get_distro (guestfs_h *g,\n"
10747 " const char *root);\n"
10752 #: ../src/guestfs-actions.pod:2609 ../fish/guestfish-actions.pod:1734
10754 "This returns the distro (distribution) of the inspected operating system."
10758 #: ../src/guestfs-actions.pod:2612 ../fish/guestfish-actions.pod:1737
10759 msgid "Currently defined distros are:"
10763 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1741
10764 msgid "\"archlinux\""
10768 #: ../src/guestfs-actions.pod:2618 ../fish/guestfish-actions.pod:1743
10769 msgid "Arch Linux."
10773 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1745
10778 #: ../src/guestfs-actions.pod:2622 ../fish/guestfish-actions.pod:1747
10783 #: ../src/guestfs-actions.pod:2624 ../fish/guestfish-actions.pod:1749
10788 #: ../src/guestfs-actions.pod:2626 ../fish/guestfish-actions.pod:1751
10793 #: ../src/guestfs-actions.pod:2628 ../fish/guestfish-actions.pod:1753
10798 #: ../src/guestfs-actions.pod:2630 ../fish/guestfish-actions.pod:1755
10803 #: ../src/guestfs-actions.pod:2632 ../fish/guestfish-actions.pod:1757
10808 #: ../src/guestfs-actions.pod:2634 ../fish/guestfish-actions.pod:1759
10813 #: ../src/guestfs-actions.pod:2636 ../fish/guestfish-actions.pod:1761
10814 msgid "\"linuxmint\""
10818 #: ../src/guestfs-actions.pod:2638 ../fish/guestfish-actions.pod:1763
10819 msgid "Linux Mint."
10823 #: ../src/guestfs-actions.pod:2640 ../fish/guestfish-actions.pod:1765
10824 msgid "\"mandriva\""
10828 #: ../src/guestfs-actions.pod:2642 ../fish/guestfish-actions.pod:1767
10833 #: ../src/guestfs-actions.pod:2644 ../fish/guestfish-actions.pod:1769
10838 #: ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1771
10843 #: ../src/guestfs-actions.pod:2648 ../fish/guestfish-actions.pod:1773
10848 #: ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1775
10853 #: ../src/guestfs-actions.pod:2652 ../fish/guestfish-actions.pod:1777
10854 msgid "\"redhat-based\""
10858 #: ../src/guestfs-actions.pod:2654 ../fish/guestfish-actions.pod:1779
10859 msgid "Some Red Hat-derived distro."
10863 #: ../src/guestfs-actions.pod:2656 ../fish/guestfish-actions.pod:1781
10868 #: ../src/guestfs-actions.pod:2658 ../fish/guestfish-actions.pod:1783
10869 msgid "Red Hat Enterprise Linux."
10873 #: ../src/guestfs-actions.pod:2660 ../fish/guestfish-actions.pod:1785
10874 msgid "\"scientificlinux\""
10878 #: ../src/guestfs-actions.pod:2662 ../fish/guestfish-actions.pod:1787
10879 msgid "Scientific Linux."
10883 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1789
10884 msgid "\"slackware\""
10888 #: ../src/guestfs-actions.pod:2666 ../fish/guestfish-actions.pod:1791
10893 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1793
10898 #: ../src/guestfs-actions.pod:2670 ../fish/guestfish-actions.pod:1795
10903 #: ../src/guestfs-actions.pod:2672 ../src/guestfs-actions.pod:2781
10904 #: ../src/guestfs-actions.pod:3156 ../fish/guestfish-actions.pod:1797
10905 #: ../fish/guestfish-actions.pod:1881 ../fish/guestfish-actions.pod:2145
10906 msgid "\"unknown\""
10910 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1799
10911 msgid "The distro could not be determined."
10915 #: ../src/guestfs-actions.pod:2676 ../src/guestfs-actions.pod:3148
10916 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
10917 msgid "\"windows\""
10921 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1803
10923 "Windows does not have distributions. This string is returned if the OS type"
10928 #: ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:2787
10929 #: ../src/guestfs-actions.pod:3162 ../fish/guestfish-actions.pod:1808
10930 #: ../fish/guestfish-actions.pod:1887 ../fish/guestfish-actions.pod:2151
10932 "Future versions of libguestfs may return other strings here. The caller "
10933 "should be prepared to handle any string."
10937 #: ../src/guestfs-actions.pod:2693
10938 msgid "guestfs_inspect_get_drive_mappings"
10942 #: ../src/guestfs-actions.pod:2695
10946 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
10947 " const char *root);\n"
10952 #: ../src/guestfs-actions.pod:2699 ../fish/guestfish-actions.pod:1817
10954 "This call is useful for Windows which uses a primitive system of assigning "
10955 "drive letters (like \"C:\") to partitions. This inspection API examines the"
10956 " Windows Registry to find out how disks/partitions are mapped to drive "
10957 "letters, and returns a hash table as in the example below:"
10961 #: ../src/guestfs-actions.pod:2705 ../fish/guestfish-actions.pod:1823
10964 " C => /dev/vda2\n"
10965 " E => /dev/vdb1\n"
10966 " F => /dev/vdc1\n"
10971 #: ../src/guestfs-actions.pod:2709 ../fish/guestfish-actions.pod:1827
10973 "Note that keys are drive letters. For Windows, the key is case insensitive "
10974 "and just contains the drive letter, without the customary colon separator "
10979 #: ../src/guestfs-actions.pod:2713 ../fish/guestfish-actions.pod:1831
10981 "In future we may support other operating systems that also used drive "
10982 "letters, but the keys for those might not be case insensitive and might be "
10983 "longer than 1 character. For example in OS-9, hard drives were named C<h0>,"
10988 #: ../src/guestfs-actions.pod:2718 ../fish/guestfish-actions.pod:1836
10990 "For Windows guests, currently only hard drive mappings are returned. "
10991 "Removable disks (eg. DVD-ROMs) are ignored."
10995 #: ../src/guestfs-actions.pod:2721 ../fish/guestfish-actions.pod:1839
10997 "For guests that do not use drive mappings, or if the drive mappings could "
10998 "not be determined, this returns an empty hash table."
11002 #: ../src/guestfs-actions.pod:2724
11004 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11005 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
11009 #: ../src/guestfs-actions.pod:2728 ../src/guestfs-actions.pod:2996
11010 #: ../src/guestfs-actions.pod:3794 ../src/guestfs-actions.pod:5076
11011 #: ../src/guestfs-actions.pod:7122
11013 "This function returns a NULL-terminated array of strings, or NULL if there "
11014 "was an error. The array of strings will always have length C<2n+1>, where "
11015 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
11016 "caller must free the strings and the array after use>."
11020 #: ../src/guestfs-actions.pod:2734 ../src/guestfs-actions.pod:3190
11021 msgid "(Added in 1.9.17)"
11025 #: ../src/guestfs-actions.pod:2736
11026 msgid "guestfs_inspect_get_filesystems"
11030 #: ../src/guestfs-actions.pod:2738
11034 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
11035 " const char *root);\n"
11040 #: ../src/guestfs-actions.pod:2742 ../fish/guestfish-actions.pod:1850
11042 "This returns a list of all the filesystems that we think are associated with"
11043 " this operating system. This includes the root filesystem, other ordinary "
11044 "filesystems, and non-mounted devices like swap partitions."
11048 #: ../src/guestfs-actions.pod:2747 ../fish/guestfish-actions.pod:1855
11050 "In the case of a multi-boot virtual machine, it is possible for a filesystem"
11051 " to be shared between operating systems."
11055 #: ../src/guestfs-actions.pod:2750
11057 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11058 "C<guestfs_inspect_get_mountpoints>."
11062 #: ../src/guestfs-actions.pod:2759
11063 msgid "guestfs_inspect_get_format"
11067 #: ../src/guestfs-actions.pod:2761
11071 " guestfs_inspect_get_format (guestfs_h *g,\n"
11072 " const char *root);\n"
11077 #: ../src/guestfs-actions.pod:2765 ../fish/guestfish-actions.pod:1865
11079 "This returns the format of the inspected operating system. You can use it "
11080 "to detect install images, live CDs and similar."
11084 #: ../src/guestfs-actions.pod:2768 ../fish/guestfish-actions.pod:1868
11085 msgid "Currently defined formats are:"
11089 #: ../src/guestfs-actions.pod:2772 ../fish/guestfish-actions.pod:1872
11090 msgid "\"installed\""
11094 #: ../src/guestfs-actions.pod:2774 ../fish/guestfish-actions.pod:1874
11095 msgid "This is an installed operating system."
11099 #: ../src/guestfs-actions.pod:2776 ../fish/guestfish-actions.pod:1876
11100 msgid "\"installer\""
11104 #: ../src/guestfs-actions.pod:2778 ../fish/guestfish-actions.pod:1878
11106 "The disk image being inspected is not an installed operating system, but a "
11107 "I<bootable> install disk, live CD, or similar."
11111 #: ../src/guestfs-actions.pod:2783 ../fish/guestfish-actions.pod:1883
11112 msgid "The format of this disk image is not known."
11116 #: ../src/guestfs-actions.pod:2795 ../src/guestfs-actions.pod:3226
11117 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260
11118 #: ../src/guestfs-actions.pod:6020
11119 msgid "(Added in 1.9.4)"
11123 #: ../src/guestfs-actions.pod:2797
11124 msgid "guestfs_inspect_get_hostname"
11128 #: ../src/guestfs-actions.pod:2799
11132 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
11133 " const char *root);\n"
11138 #: ../src/guestfs-actions.pod:2803 ../fish/guestfish-actions.pod:1896
11140 "This function returns the hostname of the operating system as found by "
11141 "inspection of the guest's configuration files."
11145 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1899
11147 "If the hostname could not be determined, then the string C<unknown> is "
11152 #: ../src/guestfs-actions.pod:2814
11153 msgid "(Added in 1.7.9)"
11157 #: ../src/guestfs-actions.pod:2816
11158 msgid "guestfs_inspect_get_icon"
11162 #: ../src/guestfs-actions.pod:2818
11166 " guestfs_inspect_get_icon (guestfs_h *g,\n"
11167 " const char *root,\n"
11168 " size_t *size_r,\n"
11174 #: ../src/guestfs-actions.pod:2829
11177 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
11178 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
11183 #: ../src/guestfs-actions.pod:2832 ../fish/guestfish-actions.pod:1908
11185 "This function returns an icon corresponding to the inspected operating "
11186 "system. The icon is returned as a buffer containing a PNG image (re-encoded"
11187 " to PNG if necessary)."
11191 #: ../src/guestfs-actions.pod:2836 ../fish/guestfish-actions.pod:1912
11193 "If it was not possible to get an icon this function returns a zero-length "
11194 "(non-NULL) buffer. I<Callers must check for this case>."
11198 #: ../src/guestfs-actions.pod:2839 ../fish/guestfish-actions.pod:1915
11200 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
11201 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
11202 "this file will be returned. You can disable favicons by passing the "
11203 "optional C<favicon> boolean as false (default is true)."
11207 #: ../src/guestfs-actions.pod:2845 ../fish/guestfish-actions.pod:1921
11209 "If finding the favicon fails, then we look in other places in the guest for "
11214 #: ../src/guestfs-actions.pod:2848 ../fish/guestfish-actions.pod:1924
11216 "If the optional C<highquality> boolean is true then only high quality icons "
11217 "are returned, which means only icons of high resolution with an alpha "
11218 "channel. The default (false) is to return any icon we can, even if it is of"
11219 " substandard quality."
11223 #: ../src/guestfs-actions.pod:2859 ../fish/guestfish-actions.pod:1935
11225 "Unlike most other inspection API calls, the guest's disks must be mounted up"
11226 " before you call this, since it needs to read information from the guest "
11227 "filesystem during the call."
11231 #: ../src/guestfs-actions.pod:2865 ../fish/guestfish-actions.pod:1941
11233 "B<Security:> The icon data comes from the untrusted guest, and should be "
11234 "treated with caution. PNG files have been known to contain exploits. "
11235 "Ensure that libpng (or other relevant libraries) are fully up to date before"
11236 " trying to process or display the icon."
11240 #: ../src/guestfs-actions.pod:2873 ../fish/guestfish-actions.pod:1949
11242 "The PNG image returned can be any size. It might not be square. Libguestfs"
11243 " tries to return the largest, highest quality icon available. The "
11244 "application must scale the icon to the required size."
11248 #: ../src/guestfs-actions.pod:2880 ../fish/guestfish-actions.pod:1956
11250 "Extracting icons from Windows guests requires the external C<wrestool> "
11251 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
11252 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
11253 "installed separately."
11257 #: ../src/guestfs-actions.pod:2887 ../fish/guestfish-actions.pod:1963
11259 "Operating system icons are usually trademarks. Seek legal advice before "
11260 "using trademarks in applications."
11264 #: ../src/guestfs-actions.pod:2896 ../src/guestfs-actions.pod:3721
11265 #: ../src/guestfs-actions.pod:4975
11266 msgid "(Added in 1.11.12)"
11270 #: ../src/guestfs-actions.pod:2898
11271 msgid "guestfs_inspect_get_icon_va"
11275 #: ../src/guestfs-actions.pod:2900
11279 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
11280 " const char *root,\n"
11281 " size_t *size_r,\n"
11282 " va_list args);\n"
11287 #: ../src/guestfs-actions.pod:2906
11288 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
11292 #: ../src/guestfs-actions.pod:2910
11293 msgid "guestfs_inspect_get_icon_argv"
11297 #: ../src/guestfs-actions.pod:2912
11301 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
11302 " const char *root,\n"
11303 " size_t *size_r,\n"
11304 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
11309 #: ../src/guestfs-actions.pod:2918
11310 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
11314 #: ../src/guestfs-actions.pod:2922
11315 msgid "guestfs_inspect_get_major_version"
11319 #: ../src/guestfs-actions.pod:2924
11323 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
11324 " const char *root);\n"
11329 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:1974
11331 "This returns the major version number of the inspected operating system."
11335 #: ../src/guestfs-actions.pod:2931 ../fish/guestfish-actions.pod:1977
11337 "Windows uses a consistent versioning scheme which is I<not> reflected in the"
11338 " popular public names used by the operating system. Notably the operating "
11339 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
11340 "1). You can find out the real versions corresponding to releases of Windows"
11341 " by consulting Wikipedia or MSDN."
11345 #: ../src/guestfs-actions.pod:2938 ../src/guestfs-actions.pod:2955
11346 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
11347 msgid "If the version could not be determined, then C<0> is returned."
11351 #: ../src/guestfs-actions.pod:2946
11352 msgid "guestfs_inspect_get_minor_version"
11356 #: ../src/guestfs-actions.pod:2948
11360 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
11361 " const char *root);\n"
11366 #: ../src/guestfs-actions.pod:2952 ../fish/guestfish-actions.pod:1992
11368 "This returns the minor version number of the inspected operating system."
11372 #: ../src/guestfs-actions.pod:2957
11374 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11375 "C<guestfs_inspect_get_major_version>."
11379 #: ../src/guestfs-actions.pod:2964
11380 msgid "guestfs_inspect_get_mountpoints"
11384 #: ../src/guestfs-actions.pod:2966
11388 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
11389 " const char *root);\n"
11394 #: ../src/guestfs-actions.pod:2970 ../fish/guestfish-actions.pod:2004
11396 "This returns a hash of where we think the filesystems associated with this "
11397 "operating system should be mounted. Callers should note that this is at "
11398 "best an educated guess made by reading configuration files such as "
11399 "C</etc/fstab>. I<In particular note> that this may return filesystems which"
11400 " are non-existent or not mountable and callers should be prepared to handle "
11401 "or ignore failures if they try to mount them."
11405 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2013
11407 "Each element in the returned hashtable has a key which is the path of the "
11408 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
11409 "mounted there (eg. C</dev/sda1>)."
11413 #: ../src/guestfs-actions.pod:2984 ../fish/guestfish-actions.pod:2018
11415 "Non-mounted devices such as swap devices are I<not> returned in this list."
11419 #: ../src/guestfs-actions.pod:2987
11421 "For operating systems like Windows which still use drive letters, this call "
11422 "will only return an entry for the first drive \"mounted on\" C</>. For "
11423 "information about the mapping of drive letters to partitions, see "
11424 "C<guestfs_inspect_get_drive_mappings>."
11428 #: ../src/guestfs-actions.pod:2993
11430 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11431 "C<guestfs_inspect_get_filesystems>."
11435 #: ../src/guestfs-actions.pod:3004
11436 msgid "guestfs_inspect_get_package_format"
11440 #: ../src/guestfs-actions.pod:3006
11444 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
11445 " const char *root);\n"
11450 #: ../src/guestfs-actions.pod:3010
11452 "This function and C<guestfs_inspect_get_package_management> return the "
11453 "package format and package management tool used by the inspected operating "
11454 "system. For example for Fedora these functions would return C<rpm> (package"
11455 " format) and C<yum> (package management)."
11459 #: ../src/guestfs-actions.pod:3016 ../fish/guestfish-actions.pod:2040
11461 "This returns the string C<unknown> if we could not determine the package "
11462 "format I<or> if the operating system does not have a real packaging system "
11467 #: ../src/guestfs-actions.pod:3020 ../fish/guestfish-actions.pod:2044
11469 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11470 "Future versions of libguestfs may return other strings."
11474 #: ../src/guestfs-actions.pod:3028 ../src/guestfs-actions.pod:3056
11475 msgid "(Added in 1.7.5)"
11479 #: ../src/guestfs-actions.pod:3030
11480 msgid "guestfs_inspect_get_package_management"
11484 #: ../src/guestfs-actions.pod:3032
11488 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
11489 " const char *root);\n"
11494 #: ../src/guestfs-actions.pod:3036
11496 "C<guestfs_inspect_get_package_format> and this function return the package "
11497 "format and package management tool used by the inspected operating system. "
11498 "For example for Fedora these functions would return C<rpm> (package format) "
11499 "and C<yum> (package management)."
11503 #: ../src/guestfs-actions.pod:3042 ../fish/guestfish-actions.pod:2059
11505 "This returns the string C<unknown> if we could not determine the package "
11506 "management tool I<or> if the operating system does not have a real packaging"
11507 " system (eg. Windows)."
11511 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2063
11513 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11514 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11515 "libguestfs may return other strings."
11519 #: ../src/guestfs-actions.pod:3058
11520 msgid "guestfs_inspect_get_product_name"
11524 #: ../src/guestfs-actions.pod:3060
11528 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
11529 " const char *root);\n"
11534 #: ../src/guestfs-actions.pod:3064 ../fish/guestfish-actions.pod:2074
11536 "This returns the product name of the inspected operating system. The "
11537 "product name is generally some freeform string which can be displayed to the"
11538 " user, but should not be parsed by programs."
11542 #: ../src/guestfs-actions.pod:3069 ../fish/guestfish-actions.pod:2079
11544 "If the product name could not be determined, then the string C<unknown> is "
11549 #: ../src/guestfs-actions.pod:3079
11550 msgid "guestfs_inspect_get_product_variant"
11554 #: ../src/guestfs-actions.pod:3081
11558 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
11559 " const char *root);\n"
11564 #: ../src/guestfs-actions.pod:3085 ../fish/guestfish-actions.pod:2088
11565 msgid "This returns the product variant of the inspected operating system."
11569 #: ../src/guestfs-actions.pod:3088 ../fish/guestfish-actions.pod:2091
11571 "For Windows guests, this returns the contents of the Registry key "
11572 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType>"
11573 " which is usually a string such as C<Client> or C<Server> (other values are "
11574 "possible). This can be used to distinguish consumer and enterprise versions"
11575 " of Windows that have the same version number (for example, Windows 7 and "
11576 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11577 "the latter is C<Server>)."
11581 #: ../src/guestfs-actions.pod:3097 ../fish/guestfish-actions.pod:2100
11583 "For enterprise Linux guests, in future we intend this to return the product "
11584 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11585 "implemented at present."
11589 #: ../src/guestfs-actions.pod:3101 ../fish/guestfish-actions.pod:2104
11591 "If the product variant could not be determined, then the string C<unknown> "
11596 #: ../src/guestfs-actions.pod:3104
11598 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
11599 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
11603 #: ../src/guestfs-actions.pod:3111
11604 msgid "(Added in 1.9.13)"
11608 #: ../src/guestfs-actions.pod:3113
11609 msgid "guestfs_inspect_get_roots"
11613 #: ../src/guestfs-actions.pod:3115
11617 " guestfs_inspect_get_roots (guestfs_h *g);\n"
11622 #: ../src/guestfs-actions.pod:3118
11624 "This function is a convenient way to get the list of root devices, as "
11625 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
11626 "the whole inspection process."
11630 #: ../src/guestfs-actions.pod:3122
11632 "This returns an empty list if either no root devices were found or the "
11633 "caller has not called C<guestfs_inspect_os>."
11637 #: ../src/guestfs-actions.pod:3131
11638 msgid "(Added in 1.7.3)"
11642 #: ../src/guestfs-actions.pod:3133
11643 msgid "guestfs_inspect_get_type"
11647 #: ../src/guestfs-actions.pod:3135
11651 " guestfs_inspect_get_type (guestfs_h *g,\n"
11652 " const char *root);\n"
11657 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:2128
11659 "This returns the type of the inspected operating system. Currently defined "
11664 #: ../src/guestfs-actions.pod:3144 ../fish/guestfish-actions.pod:2133
11669 #: ../src/guestfs-actions.pod:3146 ../fish/guestfish-actions.pod:2135
11670 msgid "Any Linux-based operating system."
11674 #: ../src/guestfs-actions.pod:3150 ../fish/guestfish-actions.pod:2139
11675 msgid "Any Microsoft Windows operating system."
11679 #: ../src/guestfs-actions.pod:3152 ../fish/guestfish-actions.pod:2141
11680 msgid "\"freebsd\""
11684 #: ../src/guestfs-actions.pod:3154 ../fish/guestfish-actions.pod:2143
11689 #: ../src/guestfs-actions.pod:3158 ../fish/guestfish-actions.pod:2147
11690 msgid "The operating system type could not be determined."
11694 #: ../src/guestfs-actions.pod:3172
11695 msgid "guestfs_inspect_get_windows_current_control_set"
11699 #: ../src/guestfs-actions.pod:3174
11703 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
11704 " const char *root);\n"
11709 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2160
11711 "This returns the Windows CurrentControlSet of the inspected guest. The "
11712 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11716 #: ../src/guestfs-actions.pod:3181 ../fish/guestfish-actions.pod:2163
11718 "This call assumes that the guest is Windows and that the Registry could be "
11719 "examined by inspection. If this is not the case then an error is returned."
11723 #: ../src/guestfs-actions.pod:3192
11724 msgid "guestfs_inspect_get_windows_systemroot"
11728 #: ../src/guestfs-actions.pod:3194
11732 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
11733 " const char *root);\n"
11738 #: ../src/guestfs-actions.pod:3198 ../fish/guestfish-actions.pod:2173
11740 "This returns the Windows systemroot of the inspected guest. The systemroot "
11741 "is a directory path such as C</WINDOWS>."
11745 #: ../src/guestfs-actions.pod:3201 ../fish/guestfish-actions.pod:2176
11747 "This call assumes that the guest is Windows and that the systemroot could be"
11748 " determined by inspection. If this is not the case then an error is "
11753 #: ../src/guestfs-actions.pod:3210
11754 msgid "(Added in 1.5.25)"
11758 #: ../src/guestfs-actions.pod:3212
11759 msgid "guestfs_inspect_is_live"
11763 #: ../src/guestfs-actions.pod:3214
11767 " guestfs_inspect_is_live (guestfs_h *g,\n"
11768 " const char *root);\n"
11773 #: ../src/guestfs-actions.pod:3218
11775 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11776 "disk), then this returns true if a live image was detected on the disk."
11780 #: ../src/guestfs-actions.pod:3228
11781 msgid "guestfs_inspect_is_multipart"
11785 #: ../src/guestfs-actions.pod:3230
11789 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
11790 " const char *root);\n"
11795 #: ../src/guestfs-actions.pod:3234
11797 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11798 "disk), then this returns true if the disk is part of a set."
11802 #: ../src/guestfs-actions.pod:3244
11803 msgid "guestfs_inspect_is_netinst"
11807 #: ../src/guestfs-actions.pod:3246
11811 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
11812 " const char *root);\n"
11817 #: ../src/guestfs-actions.pod:3250
11819 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
11820 "disk), then this returns true if the disk is a network installer, ie. not a "
11821 "self-contained install CD but one which is likely to require network access "
11822 "to complete the install."
11826 #: ../src/guestfs-actions.pod:3262
11827 msgid "guestfs_inspect_list_applications"
11831 #: ../src/guestfs-actions.pod:3264
11834 " struct guestfs_application_list *\n"
11835 " guestfs_inspect_list_applications (guestfs_h *g,\n"
11836 " const char *root);\n"
11841 #: ../src/guestfs-actions.pod:3268 ../fish/guestfish-actions.pod:2218
11842 msgid "Return the list of applications installed in the operating system."
11846 #: ../src/guestfs-actions.pod:3270
11848 "I<Note:> This call works differently from other parts of the inspection API."
11849 " You have to call C<guestfs_inspect_os>, then "
11850 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
11851 "this. Listing applications is a significantly more difficult operation "
11852 "which requires access to the full filesystem. Also note that unlike the "
11853 "other C<guestfs_inspect_get_*> calls which are just returning data cached in"
11854 " the libguestfs handle, this call actually reads parts of the mounted "
11855 "filesystems during the call."
11859 #: ../src/guestfs-actions.pod:3280 ../fish/guestfish-actions.pod:2230
11861 "This returns an empty list if the inspection code was not able to determine "
11862 "the list of applications."
11866 #: ../src/guestfs-actions.pod:3283 ../fish/guestfish-actions.pod:2233
11867 msgid "The application structure contains the following fields:"
11871 #: ../src/guestfs-actions.pod:3287 ../fish/guestfish-actions.pod:2237
11872 msgid "C<app_name>"
11876 #: ../src/guestfs-actions.pod:3289 ../fish/guestfish-actions.pod:2239
11878 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11879 "guests, this is the package name."
11883 #: ../src/guestfs-actions.pod:3292 ../fish/guestfish-actions.pod:2242
11884 msgid "C<app_display_name>"
11888 #: ../src/guestfs-actions.pod:3294 ../fish/guestfish-actions.pod:2244
11890 "The display name of the application, sometimes localized to the install "
11891 "language of the guest operating system."
11895 #: ../src/guestfs-actions.pod:3297 ../fish/guestfish-actions.pod:2247
11897 "If unavailable this is returned as an empty string C<\"\">. Callers needing"
11898 " to display something can use C<app_name> instead."
11902 #: ../src/guestfs-actions.pod:3300 ../fish/guestfish-actions.pod:2250
11903 msgid "C<app_epoch>"
11907 #: ../src/guestfs-actions.pod:3302 ../fish/guestfish-actions.pod:2252
11909 "For package managers which use epochs, this contains the epoch of the "
11910 "package (an integer). If unavailable, this is returned as C<0>."
11914 #: ../src/guestfs-actions.pod:3305 ../fish/guestfish-actions.pod:2255
11915 msgid "C<app_version>"
11919 #: ../src/guestfs-actions.pod:3307 ../fish/guestfish-actions.pod:2257
11921 "The version string of the application or package. If unavailable this is "
11922 "returned as an empty string C<\"\">."
11926 #: ../src/guestfs-actions.pod:3310 ../fish/guestfish-actions.pod:2260
11927 msgid "C<app_release>"
11931 #: ../src/guestfs-actions.pod:3312 ../fish/guestfish-actions.pod:2262
11933 "The release string of the application or package, for package managers that "
11934 "use this. If unavailable this is returned as an empty string C<\"\">."
11938 #: ../src/guestfs-actions.pod:3316 ../fish/guestfish-actions.pod:2266
11939 msgid "C<app_install_path>"
11943 #: ../src/guestfs-actions.pod:3318 ../fish/guestfish-actions.pod:2268
11945 "The installation path of the application (on operating systems such as "
11946 "Windows which use installation paths). This path is in the format used by "
11947 "the guest operating system, it is not a libguestfs path."
11951 #: ../src/guestfs-actions.pod:3323 ../fish/guestfish-actions.pod:2273
11952 msgid "If unavailable this is returned as an empty string C<\"\">."
11956 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2275
11957 msgid "C<app_trans_path>"
11961 #: ../src/guestfs-actions.pod:3327 ../fish/guestfish-actions.pod:2277
11963 "The install path translated into a libguestfs path. If unavailable this is "
11964 "returned as an empty string C<\"\">."
11968 #: ../src/guestfs-actions.pod:3330 ../fish/guestfish-actions.pod:2280
11969 msgid "C<app_publisher>"
11973 #: ../src/guestfs-actions.pod:3332 ../fish/guestfish-actions.pod:2282
11975 "The name of the publisher of the application, for package managers that use "
11976 "this. If unavailable this is returned as an empty string C<\"\">."
11980 #: ../src/guestfs-actions.pod:3336 ../fish/guestfish-actions.pod:2286
11985 #: ../src/guestfs-actions.pod:3338 ../fish/guestfish-actions.pod:2288
11987 "The URL (eg. upstream URL) of the application. If unavailable this is "
11988 "returned as an empty string C<\"\">."
11992 #: ../src/guestfs-actions.pod:3341 ../fish/guestfish-actions.pod:2291
11993 msgid "C<app_source_package>"
11997 #: ../src/guestfs-actions.pod:3343 ../fish/guestfish-actions.pod:2293
11999 "For packaging systems which support this, the name of the source package. "
12000 "If unavailable this is returned as an empty string C<\"\">."
12004 #: ../src/guestfs-actions.pod:3346 ../fish/guestfish-actions.pod:2296
12005 msgid "C<app_summary>"
12009 #: ../src/guestfs-actions.pod:3348 ../fish/guestfish-actions.pod:2298
12011 "A short (usually one line) description of the application or package. If "
12012 "unavailable this is returned as an empty string C<\"\">."
12016 #: ../src/guestfs-actions.pod:3351 ../fish/guestfish-actions.pod:2301
12017 msgid "C<app_description>"
12021 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2303
12023 "A longer description of the application or package. If unavailable this is "
12024 "returned as an empty string C<\"\">."
12028 #: ../src/guestfs-actions.pod:3360
12030 "This function returns a C<struct guestfs_application_list *>, or NULL if "
12031 "there was an error. I<The caller must call C<guestfs_free_application_list>"
12036 #: ../src/guestfs-actions.pod:3364
12037 msgid "(Added in 1.7.8)"
12041 #: ../src/guestfs-actions.pod:3366
12042 msgid "guestfs_inspect_os"
12046 #: ../src/guestfs-actions.pod:3368
12050 " guestfs_inspect_os (guestfs_h *g);\n"
12055 #: ../src/guestfs-actions.pod:3371 ../fish/guestfish-actions.pod:2314
12057 "This function uses other libguestfs functions and certain heuristics to "
12058 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
12059 "for operating systems."
12063 #: ../src/guestfs-actions.pod:3375 ../fish/guestfish-actions.pod:2318
12064 msgid "The list returned is empty if no operating systems were found."
12068 #: ../src/guestfs-actions.pod:3377 ../fish/guestfish-actions.pod:2320
12070 "If one operating system was found, then this returns a list with a single "
12071 "element, which is the name of the root filesystem of this operating system."
12072 " It is also possible for this function to return a list containing more "
12073 "than one element, indicating a dual-boot or multi-boot virtual machine, with"
12074 " each element being the root filesystem of one of the operating systems."
12078 #: ../src/guestfs-actions.pod:3384
12080 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
12081 "functions in order to query further information about each operating system,"
12082 " such as the name and version."
12086 #: ../src/guestfs-actions.pod:3389
12088 "This function uses other libguestfs features such as C<guestfs_mount_ro> and"
12089 " C<guestfs_umount_all> in order to mount and unmount filesystems and look at"
12090 " the contents. This should be called with no disks currently mounted. The "
12091 "function may also use Augeas, so any existing Augeas handle will be closed."
12095 #: ../src/guestfs-actions.pod:3395 ../fish/guestfish-actions.pod:2338
12097 "This function cannot decrypt encrypted disks. The caller must do that first"
12098 " (supplying the necessary keys) if the disk is encrypted."
12102 #: ../src/guestfs-actions.pod:3401 ../src/guestfs-actions.pod:3732
12103 #: ../src/guestfs-actions.pod:3814
12104 msgid "See also C<guestfs_list_filesystems>."
12108 #: ../src/guestfs-actions.pod:3409
12109 msgid "guestfs_is_blockdev"
12113 #: ../src/guestfs-actions.pod:3411
12117 " guestfs_is_blockdev (guestfs_h *g,\n"
12118 " const char *path);\n"
12123 #: ../src/guestfs-actions.pod:3415 ../fish/guestfish-actions.pod:2350
12125 "This returns C<true> if and only if there is a block device with the given "
12130 #: ../src/guestfs-actions.pod:3418 ../src/guestfs-actions.pod:3447
12131 #: ../src/guestfs-actions.pod:3477 ../src/guestfs-actions.pod:3492
12132 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3564
12133 #: ../src/guestfs-actions.pod:3579
12134 msgid "See also C<guestfs_stat>."
12138 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3451
12139 #: ../src/guestfs-actions.pod:3496 ../src/guestfs-actions.pod:3568
12140 #: ../src/guestfs-actions.pod:3583
12141 msgid "(Added in 1.5.10)"
12145 #: ../src/guestfs-actions.pod:3424
12146 msgid "guestfs_is_busy"
12150 #: ../src/guestfs-actions.pod:3426
12154 " guestfs_is_busy (guestfs_h *g);\n"
12159 #: ../src/guestfs-actions.pod:3429 ../fish/guestfish-actions.pod:2359
12161 "This returns true iff this handle is busy processing a command (in the "
12166 #: ../src/guestfs-actions.pod:3438
12167 msgid "guestfs_is_chardev"
12171 #: ../src/guestfs-actions.pod:3440
12175 " guestfs_is_chardev (guestfs_h *g,\n"
12176 " const char *path);\n"
12181 #: ../src/guestfs-actions.pod:3444 ../fish/guestfish-actions.pod:2368
12183 "This returns C<true> if and only if there is a character device with the "
12184 "given C<path> name."
12188 #: ../src/guestfs-actions.pod:3453
12189 msgid "guestfs_is_config"
12193 #: ../src/guestfs-actions.pod:3455
12197 " guestfs_is_config (guestfs_h *g);\n"
12202 #: ../src/guestfs-actions.pod:3458 ../fish/guestfish-actions.pod:2377
12204 "This returns true iff this handle is being configured (in the C<CONFIG> "
12209 #: ../src/guestfs-actions.pod:3467
12210 msgid "guestfs_is_dir"
12214 #: ../src/guestfs-actions.pod:3469
12218 " guestfs_is_dir (guestfs_h *g,\n"
12219 " const char *path);\n"
12224 #: ../src/guestfs-actions.pod:3473 ../fish/guestfish-actions.pod:2386
12226 "This returns C<true> if and only if there is a directory with the given "
12227 "C<path> name. Note that it returns false for other objects like files."
12231 #: ../src/guestfs-actions.pod:3483
12232 msgid "guestfs_is_fifo"
12236 #: ../src/guestfs-actions.pod:3485
12240 " guestfs_is_fifo (guestfs_h *g,\n"
12241 " const char *path);\n"
12246 #: ../src/guestfs-actions.pod:3489 ../fish/guestfish-actions.pod:2396
12248 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
12249 "given C<path> name."
12253 #: ../src/guestfs-actions.pod:3498
12254 msgid "guestfs_is_file"
12258 #: ../src/guestfs-actions.pod:3500
12262 " guestfs_is_file (guestfs_h *g,\n"
12263 " const char *path);\n"
12268 #: ../src/guestfs-actions.pod:3504 ../fish/guestfish-actions.pod:2405
12270 "This returns C<true> if and only if there is a regular file with the given "
12271 "C<path> name. Note that it returns false for other objects like "
12276 #: ../src/guestfs-actions.pod:3514
12277 msgid "guestfs_is_launching"
12281 #: ../src/guestfs-actions.pod:3516
12285 " guestfs_is_launching (guestfs_h *g);\n"
12290 #: ../src/guestfs-actions.pod:3519 ../fish/guestfish-actions.pod:2415
12292 "This returns true iff this handle is launching the subprocess (in the "
12293 "C<LAUNCHING> state)."
12297 #: ../src/guestfs-actions.pod:3528
12298 msgid "guestfs_is_lv"
12302 #: ../src/guestfs-actions.pod:3530
12306 " guestfs_is_lv (guestfs_h *g,\n"
12307 " const char *device);\n"
12312 #: ../src/guestfs-actions.pod:3534 ../fish/guestfish-actions.pod:2424
12314 "This command tests whether C<device> is a logical volume, and returns true "
12315 "iff this is the case."
12319 #: ../src/guestfs-actions.pod:3541
12320 msgid "guestfs_is_ready"
12324 #: ../src/guestfs-actions.pod:3543
12328 " guestfs_is_ready (guestfs_h *g);\n"
12333 #: ../src/guestfs-actions.pod:3546 ../fish/guestfish-actions.pod:2431
12335 "This returns true iff this handle is ready to accept commands (in the "
12340 #: ../src/guestfs-actions.pod:3555
12341 msgid "guestfs_is_socket"
12345 #: ../src/guestfs-actions.pod:3557
12349 " guestfs_is_socket (guestfs_h *g,\n"
12350 " const char *path);\n"
12355 #: ../src/guestfs-actions.pod:3561 ../fish/guestfish-actions.pod:2440
12357 "This returns C<true> if and only if there is a Unix domain socket with the "
12358 "given C<path> name."
12362 #: ../src/guestfs-actions.pod:3570
12363 msgid "guestfs_is_symlink"
12367 #: ../src/guestfs-actions.pod:3572
12371 " guestfs_is_symlink (guestfs_h *g,\n"
12372 " const char *path);\n"
12377 #: ../src/guestfs-actions.pod:3576 ../fish/guestfish-actions.pod:2449
12379 "This returns C<true> if and only if there is a symbolic link with the given "
12384 #: ../src/guestfs-actions.pod:3585
12385 msgid "guestfs_is_zero"
12389 #: ../src/guestfs-actions.pod:3587
12393 " guestfs_is_zero (guestfs_h *g,\n"
12394 " const char *path);\n"
12399 #: ../src/guestfs-actions.pod:3591 ../fish/guestfish-actions.pod:2458
12401 "This returns true iff the file exists and the file is empty or it contains "
12406 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
12407 msgid "(Added in 1.11.8)"
12411 #: ../src/guestfs-actions.pod:3598
12412 msgid "guestfs_is_zero_device"
12416 #: ../src/guestfs-actions.pod:3600
12420 " guestfs_is_zero_device (guestfs_h *g,\n"
12421 " const char *device);\n"
12426 #: ../src/guestfs-actions.pod:3604 ../fish/guestfish-actions.pod:2465
12427 msgid "This returns true iff the device exists and contains all zero bytes."
12431 #: ../src/guestfs-actions.pod:3606 ../fish/guestfish-actions.pod:2467
12432 msgid "Note that for large devices this can take a long time to run."
12436 #: ../src/guestfs-actions.pod:3612
12437 msgid "guestfs_kill_subprocess"
12441 #: ../src/guestfs-actions.pod:3614
12445 " guestfs_kill_subprocess (guestfs_h *g);\n"
12450 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2473
12451 msgid "This kills the qemu subprocess. You should never need to call this."
12455 #: ../src/guestfs-actions.pod:3623
12456 msgid "guestfs_launch"
12460 #: ../src/guestfs-actions.pod:3625
12464 " guestfs_launch (guestfs_h *g);\n"
12469 #: ../src/guestfs-actions.pod:3628 ../fish/guestfish-actions.pod:2481
12471 "Internally libguestfs is implemented by running a virtual machine using "
12476 #: ../src/guestfs-actions.pod:3631 ../fish/guestfish-actions.pod:2484
12478 "You should call this after configuring the handle (eg. adding drives) but "
12479 "before performing any actions."
12483 #: ../src/guestfs-actions.pod:3643
12484 msgid "guestfs_lchown"
12488 #: ../src/guestfs-actions.pod:3645
12492 " guestfs_lchown (guestfs_h *g,\n"
12495 " const char *path);\n"
12500 #: ../src/guestfs-actions.pod:3651
12502 "Change the file owner to C<owner> and group to C<group>. This is like "
12503 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
12504 "changed, not the target."
12508 #: ../src/guestfs-actions.pod:3663
12509 msgid "guestfs_lgetxattr"
12513 #: ../src/guestfs-actions.pod:3665
12517 " guestfs_lgetxattr (guestfs_h *g,\n"
12518 " const char *path,\n"
12519 " const char *name,\n"
12520 " size_t *size_r);\n"
12525 #: ../src/guestfs-actions.pod:3671 ../fish/guestfish-actions.pod:2503
12527 "Get a single extended attribute from file C<path> named C<name>. If C<path>"
12528 " is a symlink, then this call returns an extended attribute from the "
12533 #: ../src/guestfs-actions.pod:3685
12534 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
12538 #: ../src/guestfs-actions.pod:3693
12539 msgid "guestfs_lgetxattrs"
12543 #: ../src/guestfs-actions.pod:3695
12546 " struct guestfs_xattr_list *\n"
12547 " guestfs_lgetxattrs (guestfs_h *g,\n"
12548 " const char *path);\n"
12553 #: ../src/guestfs-actions.pod:3699
12555 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link,"
12556 " then it returns the extended attributes of the link itself."
12560 #: ../src/guestfs-actions.pod:3709
12561 msgid "guestfs_list_9p"
12565 #: ../src/guestfs-actions.pod:3711
12569 " guestfs_list_9p (guestfs_h *g);\n"
12574 #: ../src/guestfs-actions.pod:3714 ../fish/guestfish-actions.pod:2531
12576 "List all 9p filesystems attached to the guest. A list of mount tags is "
12581 #: ../src/guestfs-actions.pod:3723
12582 msgid "guestfs_list_devices"
12586 #: ../src/guestfs-actions.pod:3725
12590 " guestfs_list_devices (guestfs_h *g);\n"
12595 #: ../src/guestfs-actions.pod:3728 ../fish/guestfish-actions.pod:2538
12596 msgid "List all the block devices."
12600 #: ../src/guestfs-actions.pod:3730 ../fish/guestfish-actions.pod:2540
12601 msgid "The full block device names are returned, eg. C</dev/sda>."
12605 #: ../src/guestfs-actions.pod:3740
12606 msgid "guestfs_list_dm_devices"
12610 #: ../src/guestfs-actions.pod:3742
12614 " guestfs_list_dm_devices (guestfs_h *g);\n"
12619 #: ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2548
12620 msgid "List all device mapper devices."
12624 #: ../src/guestfs-actions.pod:3747
12626 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12627 "previous call to C<guestfs_luks_open>."
12631 #: ../src/guestfs-actions.pod:3750
12633 "Device mapper devices which correspond to logical volumes are I<not> "
12634 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
12639 #: ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:5214
12640 msgid "(Added in 1.11.15)"
12644 #: ../src/guestfs-actions.pod:3760
12645 msgid "guestfs_list_filesystems"
12649 #: ../src/guestfs-actions.pod:3762
12653 " guestfs_list_filesystems (guestfs_h *g);\n"
12658 #: ../src/guestfs-actions.pod:3765 ../fish/guestfish-actions.pod:2561
12660 "This inspection command looks for filesystems on partitions, block devices "
12661 "and logical volumes, returning a list of devices containing filesystems and "
12666 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2565
12668 "The return value is a hash, where the keys are the devices containing "
12669 "filesystems, and the values are the filesystem types. For example:"
12673 #: ../src/guestfs-actions.pod:3773 ../fish/guestfish-actions.pod:2569
12676 " \"/dev/sda1\" => \"ntfs\"\n"
12677 " \"/dev/sda2\" => \"ext2\"\n"
12678 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12679 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12684 #: ../src/guestfs-actions.pod:3778 ../fish/guestfish-actions.pod:2574
12686 "The value can have the special value \"unknown\", meaning the content of the"
12687 " device is undetermined or empty. \"swap\" means a Linux swap partition."
12691 #: ../src/guestfs-actions.pod:3782
12693 "This command runs other libguestfs commands, which might include "
12694 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
12695 "soon after launch and only when nothing is mounted."
12699 #: ../src/guestfs-actions.pod:3786
12701 "Not all of the filesystems returned will be mountable. In particular, swap "
12702 "partitions are returned in the list. Also this command does not check that "
12703 "each filesystem found is valid and mountable, and some filesystems might be "
12704 "mountable but require special options. Filesystems may not all belong to a "
12705 "single logical operating system (use C<guestfs_inspect_os> to look for "
12710 #: ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5569
12711 msgid "(Added in 1.5.15)"
12715 #: ../src/guestfs-actions.pod:3802
12716 msgid "guestfs_list_partitions"
12720 #: ../src/guestfs-actions.pod:3804
12724 " guestfs_list_partitions (guestfs_h *g);\n"
12729 #: ../src/guestfs-actions.pod:3807 ../fish/guestfish-actions.pod:2594
12730 msgid "List all the partitions detected on all block devices."
12734 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2596
12735 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12739 #: ../src/guestfs-actions.pod:3811
12741 "This does not return logical volumes. For that you will need to call "
12746 #: ../src/guestfs-actions.pod:3822
12751 #: ../src/guestfs-actions.pod:3824
12755 " guestfs_ll (guestfs_h *g,\n"
12756 " const char *directory);\n"
12761 #: ../src/guestfs-actions.pod:3828 ../fish/guestfish-actions.pod:2607
12763 "List the files in C<directory> (relative to the root directory, there is no "
12764 "cwd) in the format of 'ls -la'."
12768 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
12770 "This command is mostly useful for interactive sessions. It is I<not> "
12771 "intended that you try to parse the output string."
12775 #: ../src/guestfs-actions.pod:3839
12780 #: ../src/guestfs-actions.pod:3841
12784 " guestfs_ln (guestfs_h *g,\n"
12785 " const char *target,\n"
12786 " const char *linkname);\n"
12791 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
12792 msgid "This command creates a hard link using the C<ln> command."
12796 #: ../src/guestfs-actions.pod:3852
12797 msgid "guestfs_ln_f"
12801 #: ../src/guestfs-actions.pod:3854
12805 " guestfs_ln_f (guestfs_h *g,\n"
12806 " const char *target,\n"
12807 " const char *linkname);\n"
12812 #: ../src/guestfs-actions.pod:3859 ../fish/guestfish-actions.pod:2623
12814 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12815 "option removes the link (C<linkname>) if it exists already."
12819 #: ../src/guestfs-actions.pod:3866
12820 msgid "guestfs_ln_s"
12824 #: ../src/guestfs-actions.pod:3868
12828 " guestfs_ln_s (guestfs_h *g,\n"
12829 " const char *target,\n"
12830 " const char *linkname);\n"
12835 #: ../src/guestfs-actions.pod:3873 ../fish/guestfish-actions.pod:2630
12836 msgid "This command creates a symbolic link using the C<ln -s> command."
12840 #: ../src/guestfs-actions.pod:3879
12841 msgid "guestfs_ln_sf"
12845 #: ../src/guestfs-actions.pod:3881
12849 " guestfs_ln_sf (guestfs_h *g,\n"
12850 " const char *target,\n"
12851 " const char *linkname);\n"
12856 #: ../src/guestfs-actions.pod:3886 ../fish/guestfish-actions.pod:2636
12858 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12859 "option removes the link (C<linkname>) if it exists already."
12863 #: ../src/guestfs-actions.pod:3893
12864 msgid "guestfs_lremovexattr"
12868 #: ../src/guestfs-actions.pod:3895
12872 " guestfs_lremovexattr (guestfs_h *g,\n"
12873 " const char *xattr,\n"
12874 " const char *path);\n"
12879 #: ../src/guestfs-actions.pod:3900
12881 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
12882 "link, then it removes an extended attribute of the link itself."
12886 #: ../src/guestfs-actions.pod:3908
12891 #: ../src/guestfs-actions.pod:3910
12895 " guestfs_ls (guestfs_h *g,\n"
12896 " const char *directory);\n"
12901 #: ../src/guestfs-actions.pod:3914 ../fish/guestfish-actions.pod:2651
12903 "List the files in C<directory> (relative to the root directory, there is no "
12904 "cwd). The '.' and '..' entries are not returned, but hidden files are "
12909 #: ../src/guestfs-actions.pod:3918
12911 "This command is mostly useful for interactive sessions. Programs should "
12912 "probably use C<guestfs_readdir> instead."
12916 #: ../src/guestfs-actions.pod:3927
12917 msgid "guestfs_lsetxattr"
12921 #: ../src/guestfs-actions.pod:3929
12925 " guestfs_lsetxattr (guestfs_h *g,\n"
12926 " const char *xattr,\n"
12927 " const char *val,\n"
12929 " const char *path);\n"
12934 #: ../src/guestfs-actions.pod:3936
12936 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
12937 "then it sets an extended attribute of the link itself."
12941 #: ../src/guestfs-actions.pod:3944
12942 msgid "guestfs_lstat"
12946 #: ../src/guestfs-actions.pod:3946
12949 " struct guestfs_stat *\n"
12950 " guestfs_lstat (guestfs_h *g,\n"
12951 " const char *path);\n"
12956 #: ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:6721
12957 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4472
12958 msgid "Returns file information for the given C<path>."
12962 #: ../src/guestfs-actions.pod:3952
12964 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
12965 "link, then the link is stat-ed, not the file it refers to."
12969 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2676
12970 msgid "This is the same as the C<lstat(2)> system call."
12974 #: ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:6725
12976 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
12977 "error. I<The caller must call C<guestfs_free_stat> after use>."
12981 #: ../src/guestfs-actions.pod:3962 ../src/guestfs-actions.pod:6729
12982 #: ../src/guestfs-actions.pod:6747 ../src/guestfs-actions.pod:7128
12983 msgid "(Added in 0.9.2)"
12987 #: ../src/guestfs-actions.pod:3964
12988 msgid "guestfs_lstatlist"
12992 #: ../src/guestfs-actions.pod:3966
12995 " struct guestfs_stat_list *\n"
12996 " guestfs_lstatlist (guestfs_h *g,\n"
12997 " const char *path,\n"
12998 " char *const *names);\n"
13003 #: ../src/guestfs-actions.pod:3971
13005 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
13006 "files, where all files are in the directory C<path>. C<names> is the list "
13007 "of files from this directory."
13011 #: ../src/guestfs-actions.pod:3975 ../fish/guestfish-actions.pod:2686
13013 "On return you get a list of stat structs, with a one-to-one correspondence "
13014 "to the C<names> list. If any name did not exist or could not be lstat'd, "
13015 "then the C<ino> field of that structure is set to C<-1>."
13019 #: ../src/guestfs-actions.pod:3980
13021 "This call is intended for programs that want to efficiently list a directory"
13022 " contents without making many round-trips. See also C<guestfs_lxattrlist> "
13023 "for a similarly efficient call for getting extended attributes. Very long "
13024 "directory listings might cause the protocol message size to be exceeded, "
13025 "causing this call to fail. The caller must split up such requests into "
13026 "smaller groups of names."
13030 #: ../src/guestfs-actions.pod:3988
13032 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
13033 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
13037 #: ../src/guestfs-actions.pod:3994
13038 msgid "guestfs_luks_add_key"
13042 #: ../src/guestfs-actions.pod:3996
13046 " guestfs_luks_add_key (guestfs_h *g,\n"
13047 " const char *device,\n"
13048 " const char *key,\n"
13049 " const char *newkey,\n"
13055 #: ../src/guestfs-actions.pod:4003 ../fish/guestfish-actions.pod:2703
13057 "This command adds a new key on LUKS device C<device>. C<key> is any "
13058 "existing key, and is used to access the device. C<newkey> is the new key to"
13059 " add. C<keyslot> is the key slot that will be replaced."
13063 #: ../src/guestfs-actions.pod:4008
13065 "Note that if C<keyslot> already contains a key, then this command will fail."
13066 " You have to use C<guestfs_luks_kill_slot> first to remove that key."
13070 #: ../src/guestfs-actions.pod:4014 ../src/guestfs-actions.pod:4054
13071 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4097
13072 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
13074 "This function takes a key or passphrase parameter which could contain "
13075 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
13080 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4058
13081 #: ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4101
13082 msgid "(Added in 1.5.2)"
13086 #: ../src/guestfs-actions.pod:4020
13087 msgid "guestfs_luks_close"
13091 #: ../src/guestfs-actions.pod:4022
13095 " guestfs_luks_close (guestfs_h *g,\n"
13096 " const char *device);\n"
13101 #: ../src/guestfs-actions.pod:4026
13103 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
13104 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the"
13105 " LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the"
13106 " underlying block device."
13110 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4136
13111 #: ../src/guestfs-actions.pod:4155 ../src/guestfs-actions.pod:4205
13112 #: ../src/guestfs-actions.pod:4253
13113 msgid "(Added in 1.5.1)"
13117 #: ../src/guestfs-actions.pod:4036
13118 msgid "guestfs_luks_format"
13122 #: ../src/guestfs-actions.pod:4038
13126 " guestfs_luks_format (guestfs_h *g,\n"
13127 " const char *device,\n"
13128 " const char *key,\n"
13134 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2729
13136 "This command erases existing data on C<device> and formats the device as a "
13137 "LUKS encrypted device. C<key> is the initial key, which is added to key "
13138 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
13142 #: ../src/guestfs-actions.pod:4051 ../src/guestfs-actions.pod:4074
13143 #: ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:5320
13144 #: ../src/guestfs-actions.pod:6102 ../src/guestfs-actions.pod:6528
13145 #: ../src/guestfs-actions.pod:6558 ../src/guestfs-actions.pod:6591
13146 #: ../src/guestfs-actions.pod:7787 ../fish/guestfish-actions.pod:2737
13147 #: ../fish/guestfish-actions.pod:2750 ../fish/guestfish-actions.pod:2837
13148 #: ../fish/guestfish-actions.pod:3498 ../fish/guestfish-actions.pod:4018
13149 #: ../fish/guestfish-actions.pod:4343 ../fish/guestfish-actions.pod:4366
13150 #: ../fish/guestfish-actions.pod:4388 ../fish/guestfish-actions.pod:5126
13152 "B<This command is dangerous. Without careful use you can easily destroy all"
13157 #: ../src/guestfs-actions.pod:4060
13158 msgid "guestfs_luks_format_cipher"
13162 #: ../src/guestfs-actions.pod:4062
13166 " guestfs_luks_format_cipher (guestfs_h *g,\n"
13167 " const char *device,\n"
13168 " const char *key,\n"
13170 " const char *cipher);\n"
13175 #: ../src/guestfs-actions.pod:4069
13177 "This command is the same as C<guestfs_luks_format> but it also allows you to"
13178 " set the C<cipher> used."
13182 #: ../src/guestfs-actions.pod:4083
13183 msgid "guestfs_luks_kill_slot"
13187 #: ../src/guestfs-actions.pod:4085
13191 " guestfs_luks_kill_slot (guestfs_h *g,\n"
13192 " const char *device,\n"
13193 " const char *key,\n"
13199 #: ../src/guestfs-actions.pod:4091 ../fish/guestfish-actions.pod:2757
13201 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13202 "device C<device>. C<key> must be one of the I<other> keys."
13206 #: ../src/guestfs-actions.pod:4103
13207 msgid "guestfs_luks_open"
13211 #: ../src/guestfs-actions.pod:4105
13215 " guestfs_luks_open (guestfs_h *g,\n"
13216 " const char *device,\n"
13217 " const char *key,\n"
13218 " const char *mapname);\n"
13223 #: ../src/guestfs-actions.pod:4111 ../fish/guestfish-actions.pod:2768
13225 "This command opens a block device which has been encrypted according to the "
13226 "Linux Unified Key Setup (LUKS) standard."
13230 #: ../src/guestfs-actions.pod:4114 ../fish/guestfish-actions.pod:2771
13231 msgid "C<device> is the encrypted block device or partition."
13235 #: ../src/guestfs-actions.pod:4116 ../fish/guestfish-actions.pod:2773
13237 "The caller must supply one of the keys associated with the LUKS block "
13238 "device, in the C<key> parameter."
13242 #: ../src/guestfs-actions.pod:4119 ../fish/guestfish-actions.pod:2776
13244 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13245 "writes to this block device are decrypted from and encrypted to the "
13246 "underlying C<device> respectively."
13250 #: ../src/guestfs-actions.pod:4123
13252 "If this block device contains LVM volume groups, then calling "
13253 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
13258 #: ../src/guestfs-actions.pod:4127
13259 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
13263 #: ../src/guestfs-actions.pod:4138
13264 msgid "guestfs_luks_open_ro"
13268 #: ../src/guestfs-actions.pod:4140
13272 " guestfs_luks_open_ro (guestfs_h *g,\n"
13273 " const char *device,\n"
13274 " const char *key,\n"
13275 " const char *mapname);\n"
13280 #: ../src/guestfs-actions.pod:4146
13282 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
13287 #: ../src/guestfs-actions.pod:4157
13288 msgid "guestfs_lvcreate"
13292 #: ../src/guestfs-actions.pod:4159
13296 " guestfs_lvcreate (guestfs_h *g,\n"
13297 " const char *logvol,\n"
13298 " const char *volgroup,\n"
13304 #: ../src/guestfs-actions.pod:4165 ../fish/guestfish-actions.pod:2804
13306 "This creates an LVM logical volume called C<logvol> on the volume group "
13307 "C<volgroup>, with C<size> megabytes."
13311 #: ../src/guestfs-actions.pod:4172
13312 msgid "guestfs_lvm_canonical_lv_name"
13316 #: ../src/guestfs-actions.pod:4174
13320 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
13321 " const char *lvname);\n"
13326 #: ../src/guestfs-actions.pod:4178 ../fish/guestfish-actions.pod:2811
13328 "This converts alternative naming schemes for LVs that you might find to the "
13329 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
13334 #: ../src/guestfs-actions.pod:4182 ../fish/guestfish-actions.pod:2815
13336 "This command returns an error if the C<lvname> parameter does not refer to a"
13341 #: ../src/guestfs-actions.pod:4185
13342 msgid "See also C<guestfs_is_lv>."
13346 #: ../src/guestfs-actions.pod:4190
13347 msgid "(Added in 1.5.24)"
13351 #: ../src/guestfs-actions.pod:4192
13352 msgid "guestfs_lvm_clear_filter"
13356 #: ../src/guestfs-actions.pod:4194
13360 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
13365 #: ../src/guestfs-actions.pod:4197
13367 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
13368 "see every block device."
13372 #: ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4242
13373 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
13375 "This command also clears the LVM cache and performs a volume group scan."
13379 #: ../src/guestfs-actions.pod:4207
13380 msgid "guestfs_lvm_remove_all"
13384 #: ../src/guestfs-actions.pod:4209
13388 " guestfs_lvm_remove_all (guestfs_h *g);\n"
13393 #: ../src/guestfs-actions.pod:4212 ../fish/guestfish-actions.pod:2834
13395 "This command removes all LVM logical volumes, volume groups and physical "
13400 #: ../src/guestfs-actions.pod:4222
13401 msgid "guestfs_lvm_set_filter"
13405 #: ../src/guestfs-actions.pod:4224
13409 " guestfs_lvm_set_filter (guestfs_h *g,\n"
13410 " char *const *devices);\n"
13415 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:2844
13417 "This sets the LVM device filter so that LVM will only be able to \"see\" the"
13418 " block devices in the list C<devices>, and will ignore all other attached "
13423 #: ../src/guestfs-actions.pod:4232 ../fish/guestfish-actions.pod:2848
13425 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13426 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also"
13427 " there are two types of duplication possible: either cloned PVs/VGs which "
13428 "have identical UUIDs; or VGs that are not cloned but just happen to have the"
13429 " same name. In normal operation you cannot create this situation, but you "
13430 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13431 "inside the LVM metadata."
13435 #: ../src/guestfs-actions.pod:4245 ../fish/guestfish-actions.pod:2861
13436 msgid "You can filter whole block devices or individual partitions."
13440 #: ../src/guestfs-actions.pod:4247 ../fish/guestfish-actions.pod:2863
13442 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13443 "filesystem), even if you are not filtering out that VG."
13447 #: ../src/guestfs-actions.pod:4255
13448 msgid "guestfs_lvremove"
13452 #: ../src/guestfs-actions.pod:4257
13456 " guestfs_lvremove (guestfs_h *g,\n"
13457 " const char *device);\n"
13462 #: ../src/guestfs-actions.pod:4261 ../fish/guestfish-actions.pod:2871
13464 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13465 "LV, such as C</dev/VG/LV>."
13469 #: ../src/guestfs-actions.pod:4264 ../fish/guestfish-actions.pod:2874
13471 "You can also remove all LVs in a volume group by specifying the VG name, "
13476 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:5666
13477 #: ../src/guestfs-actions.pod:7498
13478 msgid "(Added in 1.0.13)"
13482 #: ../src/guestfs-actions.pod:4271
13483 msgid "guestfs_lvrename"
13487 #: ../src/guestfs-actions.pod:4273
13491 " guestfs_lvrename (guestfs_h *g,\n"
13492 " const char *logvol,\n"
13493 " const char *newlogvol);\n"
13498 #: ../src/guestfs-actions.pod:4278 ../fish/guestfish-actions.pod:2881
13499 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13503 #: ../src/guestfs-actions.pod:4282 ../src/guestfs-actions.pod:7511
13504 msgid "(Added in 1.0.83)"
13508 #: ../src/guestfs-actions.pod:4284
13509 msgid "guestfs_lvresize"
13513 #: ../src/guestfs-actions.pod:4286
13517 " guestfs_lvresize (guestfs_h *g,\n"
13518 " const char *device,\n"
13524 #: ../src/guestfs-actions.pod:4291 ../fish/guestfish-actions.pod:2887
13526 "This resizes (expands or shrinks) an existing LVM logical volume to "
13527 "C<mbytes>. When reducing, data in the reduced part is lost."
13531 #: ../src/guestfs-actions.pod:4299
13532 msgid "guestfs_lvresize_free"
13536 #: ../src/guestfs-actions.pod:4301
13540 " guestfs_lvresize_free (guestfs_h *g,\n"
13541 " const char *lv,\n"
13547 #: ../src/guestfs-actions.pod:4306 ../fish/guestfish-actions.pod:2895
13549 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the"
13550 " remaining free space in the volume group. Commonly you would call this "
13551 "with pc = 100 which expands the logical volume as much as possible, using "
13552 "all remaining free space in the volume group."
13556 #: ../src/guestfs-actions.pod:4314
13557 msgid "(Added in 1.3.3)"
13561 #: ../src/guestfs-actions.pod:4316
13562 msgid "guestfs_lvs"
13566 #: ../src/guestfs-actions.pod:4318
13570 " guestfs_lvs (guestfs_h *g);\n"
13575 #: ../src/guestfs-actions.pod:4321 ../fish/guestfish-actions.pod:2905
13577 "List all the logical volumes detected. This is the equivalent of the "
13578 "L<lvs(8)> command."
13582 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2908
13584 "This returns a list of the logical volume device names (eg. "
13585 "C</dev/VolGroup00/LogVol00>)."
13589 #: ../src/guestfs-actions.pod:4327
13590 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
13594 #: ../src/guestfs-actions.pod:4335
13595 msgid "guestfs_lvs_full"
13599 #: ../src/guestfs-actions.pod:4337
13602 " struct guestfs_lvm_lv_list *\n"
13603 " guestfs_lvs_full (guestfs_h *g);\n"
13608 #: ../src/guestfs-actions.pod:4340 ../fish/guestfish-actions.pod:2917
13610 "List all the logical volumes detected. This is the equivalent of the "
13611 "L<lvs(8)> command. The \"full\" version includes all fields."
13615 #: ../src/guestfs-actions.pod:4343
13617 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
13618 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
13623 #: ../src/guestfs-actions.pod:4349
13624 msgid "guestfs_lvuuid"
13628 #: ../src/guestfs-actions.pod:4351
13632 " guestfs_lvuuid (guestfs_h *g,\n"
13633 " const char *device);\n"
13638 #: ../src/guestfs-actions.pod:4355 ../fish/guestfish-actions.pod:2924
13639 msgid "This command returns the UUID of the LVM LV C<device>."
13643 #: ../src/guestfs-actions.pod:4362
13644 msgid "guestfs_lxattrlist"
13648 #: ../src/guestfs-actions.pod:4364
13651 " struct guestfs_xattr_list *\n"
13652 " guestfs_lxattrlist (guestfs_h *g,\n"
13653 " const char *path,\n"
13654 " char *const *names);\n"
13659 #: ../src/guestfs-actions.pod:4369 ../fish/guestfish-actions.pod:2930
13661 "This call allows you to get the extended attributes of multiple files, where"
13662 " all files are in the directory C<path>. C<names> is the list of files from"
13667 #: ../src/guestfs-actions.pod:4373 ../fish/guestfish-actions.pod:2934
13669 "On return you get a flat list of xattr structs which must be interpreted "
13670 "sequentially. The first xattr struct always has a zero-length C<attrname>."
13671 " C<attrval> in this struct is zero-length to indicate there was an error "
13672 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13673 "number (the number of following attributes for this file, which could be "
13674 "C<\"0\">). Then after the first xattr struct are the zero or more "
13675 "attributes for the first named file. This repeats for the second and "
13676 "subsequent files."
13680 #: ../src/guestfs-actions.pod:4383
13682 "This call is intended for programs that want to efficiently list a directory"
13683 " contents without making many round-trips. See also C<guestfs_lstatlist> "
13684 "for a similarly efficient call for getting standard stats. Very long "
13685 "directory listings might cause the protocol message size to be exceeded, "
13686 "causing this call to fail. The caller must split up such requests into "
13687 "smaller groups of names."
13691 #: ../src/guestfs-actions.pod:4397
13692 msgid "guestfs_mkdir"
13696 #: ../src/guestfs-actions.pod:4399
13700 " guestfs_mkdir (guestfs_h *g,\n"
13701 " const char *path);\n"
13706 #: ../src/guestfs-actions.pod:4403 ../fish/guestfish-actions.pod:2956
13707 msgid "Create a directory named C<path>."
13711 #: ../src/guestfs-actions.pod:4409
13712 msgid "guestfs_mkdir_mode"
13716 #: ../src/guestfs-actions.pod:4411
13720 " guestfs_mkdir_mode (guestfs_h *g,\n"
13721 " const char *path,\n"
13727 #: ../src/guestfs-actions.pod:4416 ../fish/guestfish-actions.pod:2962
13729 "This command creates a directory, setting the initial permissions of the "
13730 "directory to C<mode>."
13734 #: ../src/guestfs-actions.pod:4419 ../fish/guestfish-actions.pod:2965
13736 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13737 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13742 #: ../src/guestfs-actions.pod:4423
13743 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
13747 #: ../src/guestfs-actions.pod:4429
13748 msgid "guestfs_mkdir_p"
13752 #: ../src/guestfs-actions.pod:4431
13756 " guestfs_mkdir_p (guestfs_h *g,\n"
13757 " const char *path);\n"
13762 #: ../src/guestfs-actions.pod:4435 ../fish/guestfish-actions.pod:2975
13764 "Create a directory named C<path>, creating any parent directories as "
13765 "necessary. This is like the C<mkdir -p> shell command."
13769 #: ../src/guestfs-actions.pod:4442
13770 msgid "guestfs_mkdtemp"
13774 #: ../src/guestfs-actions.pod:4444
13778 " guestfs_mkdtemp (guestfs_h *g,\n"
13779 " const char *template);\n"
13784 #: ../src/guestfs-actions.pod:4448 ../fish/guestfish-actions.pod:2982
13786 "This command creates a temporary directory. The C<template> parameter "
13787 "should be a full pathname for the temporary directory name with the final "
13788 "six characters being \"XXXXXX\"."
13792 #: ../src/guestfs-actions.pod:4453 ../fish/guestfish-actions.pod:2987
13794 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one"
13795 " being suitable for Windows filesystems."
13799 #: ../src/guestfs-actions.pod:4456 ../fish/guestfish-actions.pod:2990
13800 msgid "The name of the temporary directory that was created is returned."
13804 #: ../src/guestfs-actions.pod:4459 ../fish/guestfish-actions.pod:2993
13806 "The temporary directory is created with mode 0700 and is owned by root."
13810 #: ../src/guestfs-actions.pod:4462 ../fish/guestfish-actions.pod:2996
13812 "The caller is responsible for deleting the temporary directory and its "
13813 "contents after use."
13817 #: ../src/guestfs-actions.pod:4465 ../fish/guestfish-actions.pod:2999
13818 msgid "See also: L<mkdtemp(3)>"
13822 #: ../src/guestfs-actions.pod:4472
13823 msgid "guestfs_mke2fs_J"
13827 #: ../src/guestfs-actions.pod:4474
13831 " guestfs_mke2fs_J (guestfs_h *g,\n"
13832 " const char *fstype,\n"
13833 " int blocksize,\n"
13834 " const char *device,\n"
13835 " const char *journal);\n"
13840 #: ../src/guestfs-actions.pod:4481 ../fish/guestfish-actions.pod:3005
13842 "This creates an ext2/3/4 filesystem on C<device> with an external journal on"
13843 " C<journal>. It is equivalent to the command:"
13847 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
13850 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13855 #: ../src/guestfs-actions.pod:4487
13856 msgid "See also C<guestfs_mke2journal>."
13860 #: ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4509
13861 #: ../src/guestfs-actions.pod:4527 ../src/guestfs-actions.pod:4543
13862 #: ../src/guestfs-actions.pod:4557 ../src/guestfs-actions.pod:4571
13863 #: ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4907
13864 msgid "(Added in 1.0.68)"
13868 #: ../src/guestfs-actions.pod:4493
13869 msgid "guestfs_mke2fs_JL"
13873 #: ../src/guestfs-actions.pod:4495
13877 " guestfs_mke2fs_JL (guestfs_h *g,\n"
13878 " const char *fstype,\n"
13879 " int blocksize,\n"
13880 " const char *device,\n"
13881 " const char *label);\n"
13886 #: ../src/guestfs-actions.pod:4502 ../fish/guestfish-actions.pod:3017
13888 "This creates an ext2/3/4 filesystem on C<device> with an external journal on"
13889 " the journal labeled C<label>."
13893 #: ../src/guestfs-actions.pod:4505
13894 msgid "See also C<guestfs_mke2journal_L>."
13898 #: ../src/guestfs-actions.pod:4511
13899 msgid "guestfs_mke2fs_JU"
13903 #: ../src/guestfs-actions.pod:4513
13907 " guestfs_mke2fs_JU (guestfs_h *g,\n"
13908 " const char *fstype,\n"
13909 " int blocksize,\n"
13910 " const char *device,\n"
13911 " const char *uuid);\n"
13916 #: ../src/guestfs-actions.pod:4520 ../fish/guestfish-actions.pod:3026
13918 "This creates an ext2/3/4 filesystem on C<device> with an external journal on"
13919 " the journal with UUID C<uuid>."
13923 #: ../src/guestfs-actions.pod:4523
13924 msgid "See also C<guestfs_mke2journal_U>."
13928 #: ../src/guestfs-actions.pod:4529
13929 msgid "guestfs_mke2journal"
13933 #: ../src/guestfs-actions.pod:4531
13937 " guestfs_mke2journal (guestfs_h *g,\n"
13938 " int blocksize,\n"
13939 " const char *device);\n"
13944 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3035
13946 "This creates an ext2 external journal on C<device>. It is equivalent to the"
13951 #: ../src/guestfs-actions.pod:4539 ../fish/guestfish-actions.pod:3038
13954 " mke2fs -O journal_dev -b blocksize device\n"
13959 #: ../src/guestfs-actions.pod:4545
13960 msgid "guestfs_mke2journal_L"
13964 #: ../src/guestfs-actions.pod:4547
13968 " guestfs_mke2journal_L (guestfs_h *g,\n"
13969 " int blocksize,\n"
13970 " const char *label,\n"
13971 " const char *device);\n"
13976 #: ../src/guestfs-actions.pod:4553 ../fish/guestfish-actions.pod:3044
13978 "This creates an ext2 external journal on C<device> with label C<label>."
13982 #: ../src/guestfs-actions.pod:4559
13983 msgid "guestfs_mke2journal_U"
13987 #: ../src/guestfs-actions.pod:4561
13991 " guestfs_mke2journal_U (guestfs_h *g,\n"
13992 " int blocksize,\n"
13993 " const char *uuid,\n"
13994 " const char *device);\n"
13999 #: ../src/guestfs-actions.pod:4567 ../fish/guestfish-actions.pod:3050
14000 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
14004 #: ../src/guestfs-actions.pod:4573
14005 msgid "guestfs_mkfifo"
14009 #: ../src/guestfs-actions.pod:4575
14013 " guestfs_mkfifo (guestfs_h *g,\n"
14015 " const char *path);\n"
14020 #: ../src/guestfs-actions.pod:4580
14022 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
14023 "is just a convenient wrapper around C<guestfs_mknod>."
14027 #: ../src/guestfs-actions.pod:4590
14028 msgid "guestfs_mkfs"
14032 #: ../src/guestfs-actions.pod:4592
14036 " guestfs_mkfs (guestfs_h *g,\n"
14037 " const char *fstype,\n"
14038 " const char *device);\n"
14043 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3066
14045 "This creates a filesystem on C<device> (usually a partition or LVM logical "
14046 "volume). The filesystem type is C<fstype>, for example C<ext3>."
14050 #: ../src/guestfs-actions.pod:4605
14051 msgid "guestfs_mkfs_b"
14055 #: ../src/guestfs-actions.pod:4607
14059 " guestfs_mkfs_b (guestfs_h *g,\n"
14060 " const char *fstype,\n"
14061 " int blocksize,\n"
14062 " const char *device);\n"
14067 #: ../src/guestfs-actions.pod:4613
14069 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
14070 "block size of the resulting filesystem. Supported block sizes depend on the"
14071 " filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
14075 #: ../src/guestfs-actions.pod:4618 ../src/guestfs-actions.pod:4663
14076 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
14078 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
14083 #: ../src/guestfs-actions.pod:4623 ../fish/guestfish-actions.pod:3082
14085 "This function is deprecated. In new code, use the C<mkfs_opts> call "
14090 #: ../src/guestfs-actions.pod:4632
14091 msgid "guestfs_mkfs_opts"
14095 #: ../src/guestfs-actions.pod:4634
14099 " guestfs_mkfs_opts (guestfs_h *g,\n"
14100 " const char *fstype,\n"
14101 " const char *device,\n"
14107 #: ../src/guestfs-actions.pod:4645
14110 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
14111 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
14112 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
14113 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
14118 #: ../src/guestfs-actions.pod:4650 ../fish/guestfish-actions.pod:3093
14120 "This function creates a filesystem on C<device>. The filesystem type is "
14121 "C<fstype>, for example C<ext3>."
14125 #: ../src/guestfs-actions.pod:4657 ../fish/guestfish-actions.pod:3100
14126 msgid "C<blocksize>"
14130 #: ../src/guestfs-actions.pod:4659 ../fish/guestfish-actions.pod:3102
14132 "The filesystem block size. Supported block sizes depend on the filesystem "
14133 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14138 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3109
14139 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14143 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3111
14144 msgid "C<features>"
14148 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3113
14149 msgid "This passes the I<-O> parameter to the external mkfs program."
14153 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3115
14155 "For certain filesystem types, this allows extra filesystem features to be "
14156 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14160 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3119
14162 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem"
14167 #: ../src/guestfs-actions.pod:4679 ../fish/guestfish-actions.pod:3122
14172 #: ../src/guestfs-actions.pod:4681 ../fish/guestfish-actions.pod:3124
14174 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
14175 "sets the inode size (only for ext2/3/4 filesystems at present)."
14179 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3127
14180 msgid "C<sectorsize>"
14184 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3129
14186 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
14187 "sets sector size for ufs filesystem."
14191 #: ../src/guestfs-actions.pod:4693
14192 msgid "(Added in 1.7.19)"
14196 #: ../src/guestfs-actions.pod:4695
14197 msgid "guestfs_mkfs_opts_va"
14201 #: ../src/guestfs-actions.pod:4697
14205 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
14206 " const char *fstype,\n"
14207 " const char *device,\n"
14208 " va_list args);\n"
14213 #: ../src/guestfs-actions.pod:4703
14214 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
14218 #: ../src/guestfs-actions.pod:4707
14219 msgid "guestfs_mkfs_opts_argv"
14223 #: ../src/guestfs-actions.pod:4709
14227 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
14228 " const char *fstype,\n"
14229 " const char *device,\n"
14230 " const struct guestfs_mkfs_opts_argv *optargs);\n"
14235 #: ../src/guestfs-actions.pod:4715
14236 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
14240 #: ../src/guestfs-actions.pod:4719
14241 msgid "guestfs_mkmountpoint"
14245 #: ../src/guestfs-actions.pod:4721
14249 " guestfs_mkmountpoint (guestfs_h *g,\n"
14250 " const char *exemptpath);\n"
14255 #: ../src/guestfs-actions.pod:4725
14257 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
14258 "that can be used to create extra mountpoints before mounting the first "
14263 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3144
14265 "These calls are I<only> necessary in some very limited circumstances, mainly"
14266 " the case where you want to mount a mix of unrelated and/or read-only "
14267 "filesystems together."
14271 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3148
14273 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14274 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14275 "inside that. You can unpack this as follows in guestfish:"
14279 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3153
14282 " add-ro Fedora-11-i686-Live.iso\n"
14284 " mkmountpoint /cd\n"
14285 " mkmountpoint /sqsh\n"
14286 " mkmountpoint /ext3fs\n"
14287 " mount /dev/sda /cd\n"
14288 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14289 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14294 #: ../src/guestfs-actions.pod:4747 ../fish/guestfish-actions.pod:3162
14295 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14299 #: ../src/guestfs-actions.pod:4749
14301 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
14302 "may get unexpected errors if you try to mix these calls. It is safest to "
14303 "manually unmount filesystems and remove mountpoints after use."
14307 #: ../src/guestfs-actions.pod:4753
14309 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
14310 "first, so for this to work for manual mountpoints, you must ensure that the "
14311 "innermost mountpoints have the longest pathnames, as in the example code "
14316 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3173
14318 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14322 #: ../src/guestfs-actions.pod:4760
14324 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
14325 "can cause C<guestfs_umount_all> to be called when the handle is closed which"
14326 " can also trigger these issues."
14330 #: ../src/guestfs-actions.pod:4766 ../src/guestfs-actions.pod:5082
14331 #: ../src/guestfs-actions.pod:6086
14332 msgid "(Added in 1.0.62)"
14336 #: ../src/guestfs-actions.pod:4768
14337 msgid "guestfs_mknod"
14341 #: ../src/guestfs-actions.pod:4770
14345 " guestfs_mknod (guestfs_h *g,\n"
14349 " const char *path);\n"
14354 #: ../src/guestfs-actions.pod:4777 ../fish/guestfish-actions.pod:3183
14356 "This call creates block or character special devices, or named pipes "
14361 #: ../src/guestfs-actions.pod:4780 ../fish/guestfish-actions.pod:3186
14363 "The C<mode> parameter should be the mode, using the standard constants. "
14364 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14365 "used when creating block and character special devices."
14369 #: ../src/guestfs-actions.pod:4785
14371 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14372 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14373 "regular file). These constants are available in the standard Linux header "
14374 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
14375 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in"
14376 " the appropriate constant for you."
14380 #: ../src/guestfs-actions.pod:4799
14381 msgid "guestfs_mknod_b"
14385 #: ../src/guestfs-actions.pod:4801
14389 " guestfs_mknod_b (guestfs_h *g,\n"
14393 " const char *path);\n"
14398 #: ../src/guestfs-actions.pod:4808
14400 "This call creates a block device node called C<path> with mode C<mode> and "
14401 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14402 "wrapper around C<guestfs_mknod>."
14406 #: ../src/guestfs-actions.pod:4818
14407 msgid "guestfs_mknod_c"
14411 #: ../src/guestfs-actions.pod:4820
14415 " guestfs_mknod_c (guestfs_h *g,\n"
14419 " const char *path);\n"
14424 #: ../src/guestfs-actions.pod:4827
14426 "This call creates a char device node called C<path> with mode C<mode> and "
14427 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14428 "wrapper around C<guestfs_mknod>."
14432 #: ../src/guestfs-actions.pod:4837
14433 msgid "guestfs_mkswap"
14437 #: ../src/guestfs-actions.pod:4839
14441 " guestfs_mkswap (guestfs_h *g,\n"
14442 " const char *device);\n"
14447 #: ../src/guestfs-actions.pod:4843 ../fish/guestfish-actions.pod:3225
14448 msgid "Create a swap partition on C<device>."
14452 #: ../src/guestfs-actions.pod:4849
14453 msgid "guestfs_mkswap_L"
14457 #: ../src/guestfs-actions.pod:4851
14461 " guestfs_mkswap_L (guestfs_h *g,\n"
14462 " const char *label,\n"
14463 " const char *device);\n"
14468 #: ../src/guestfs-actions.pod:4856 ../fish/guestfish-actions.pod:3231
14469 msgid "Create a swap partition on C<device> with label C<label>."
14473 #: ../src/guestfs-actions.pod:4858 ../fish/guestfish-actions.pod:3233
14475 "Note that you cannot attach a swap label to a block device (eg. "
14476 "C</dev/sda>), just to a partition. This appears to be a limitation of the "
14477 "kernel or swap tools."
14481 #: ../src/guestfs-actions.pod:4866
14482 msgid "guestfs_mkswap_U"
14486 #: ../src/guestfs-actions.pod:4868
14490 " guestfs_mkswap_U (guestfs_h *g,\n"
14491 " const char *uuid,\n"
14492 " const char *device);\n"
14497 #: ../src/guestfs-actions.pod:4873 ../fish/guestfish-actions.pod:3241
14498 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14502 #: ../src/guestfs-actions.pod:4879
14503 msgid "guestfs_mkswap_file"
14507 #: ../src/guestfs-actions.pod:4881
14511 " guestfs_mkswap_file (guestfs_h *g,\n"
14512 " const char *path);\n"
14517 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3247
14518 msgid "Create a swap file."
14522 #: ../src/guestfs-actions.pod:4887
14524 "This command just writes a swap file signature to an existing file. To "
14525 "create the file itself, use something like C<guestfs_fallocate>."
14529 #: ../src/guestfs-actions.pod:4894
14530 msgid "guestfs_modprobe"
14534 #: ../src/guestfs-actions.pod:4896
14538 " guestfs_modprobe (guestfs_h *g,\n"
14539 " const char *modulename);\n"
14544 #: ../src/guestfs-actions.pod:4900 ../fish/guestfish-actions.pod:3256
14545 msgid "This loads a kernel module in the appliance."
14549 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3258
14551 "The kernel module must have been whitelisted when libguestfs was built (see "
14552 "C<appliance/kmod.whitelist.in> in the source)."
14556 #: ../src/guestfs-actions.pod:4909
14557 msgid "guestfs_mount"
14561 #: ../src/guestfs-actions.pod:4911
14565 " guestfs_mount (guestfs_h *g,\n"
14566 " const char *device,\n"
14567 " const char *mountpoint);\n"
14572 #: ../src/guestfs-actions.pod:4916 ../fish/guestfish-actions.pod:3265
14574 "Mount a guest disk at a position in the filesystem. Block devices are named"
14575 " C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14576 "those block devices contain partitions, they will have the usual names (eg. "
14577 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14581 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3271
14583 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14584 "mounted on C</> before others can be mounted. Other filesystems can only be"
14585 " mounted on directories which already exist."
14589 #: ../src/guestfs-actions.pod:4927 ../fish/guestfish-actions.pod:3276
14591 "The mounted filesystem is writable, if we have sufficient permissions on the"
14592 " underlying device."
14596 #: ../src/guestfs-actions.pod:4930
14598 "B<Important note:> When you use this call, the filesystem options C<sync> "
14599 "and C<noatime> are set implicitly. This was originally done because we "
14600 "thought it would improve reliability, but it turns out that I<-o sync> has a"
14601 " very large negative performance impact and negligible effect on "
14602 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
14603 "in any code that needs performance, and instead use C<guestfs_mount_options>"
14604 " (use an empty string for the first parameter if you don't want any "
14609 #: ../src/guestfs-actions.pod:4942 ../fish/guestfish-actions.pod:3289
14611 "This function is deprecated. In new code, use the C<mount_options> call "
14616 #: ../src/guestfs-actions.pod:4951
14617 msgid "guestfs_mount_9p"
14621 #: ../src/guestfs-actions.pod:4953
14625 " guestfs_mount_9p (guestfs_h *g,\n"
14626 " const char *mounttag,\n"
14627 " const char *mountpoint,\n"
14633 #: ../src/guestfs-actions.pod:4964
14636 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
14641 #: ../src/guestfs-actions.pod:4966 ../fish/guestfish-actions.pod:3300
14643 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14648 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3303
14650 "If required, C<trans=virtio> will be automatically added to the options. "
14651 "Any other options required can be passed in the optional C<options> "
14656 #: ../src/guestfs-actions.pod:4977
14657 msgid "guestfs_mount_9p_va"
14661 #: ../src/guestfs-actions.pod:4979
14665 " guestfs_mount_9p_va (guestfs_h *g,\n"
14666 " const char *mounttag,\n"
14667 " const char *mountpoint,\n"
14668 " va_list args);\n"
14673 #: ../src/guestfs-actions.pod:4985
14674 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
14678 #: ../src/guestfs-actions.pod:4989
14679 msgid "guestfs_mount_9p_argv"
14683 #: ../src/guestfs-actions.pod:4991
14687 " guestfs_mount_9p_argv (guestfs_h *g,\n"
14688 " const char *mounttag,\n"
14689 " const char *mountpoint,\n"
14690 " const struct guestfs_mount_9p_argv *optargs);\n"
14695 #: ../src/guestfs-actions.pod:4997
14696 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
14700 #: ../src/guestfs-actions.pod:5001
14701 msgid "guestfs_mount_loop"
14705 #: ../src/guestfs-actions.pod:5003
14709 " guestfs_mount_loop (guestfs_h *g,\n"
14710 " const char *file,\n"
14711 " const char *mountpoint);\n"
14716 #: ../src/guestfs-actions.pod:5008 ../fish/guestfish-actions.pod:3313
14718 "This command lets you mount C<file> (a filesystem image in a file) on a "
14719 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14724 #: ../src/guestfs-actions.pod:5016
14725 msgid "guestfs_mount_options"
14729 #: ../src/guestfs-actions.pod:5018
14733 " guestfs_mount_options (guestfs_h *g,\n"
14734 " const char *options,\n"
14735 " const char *device,\n"
14736 " const char *mountpoint);\n"
14741 #: ../src/guestfs-actions.pod:5024
14743 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14744 "the mount options as for the L<mount(8)> I<-o> flag."
14748 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3325
14750 "If the C<options> parameter is an empty string, then no options are passed "
14751 "(all options default to whatever the filesystem uses)."
14755 #: ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5048
14756 #: ../src/guestfs-actions.pod:5065
14757 msgid "(Added in 1.0.10)"
14761 #: ../src/guestfs-actions.pod:5036
14762 msgid "guestfs_mount_ro"
14766 #: ../src/guestfs-actions.pod:5038
14770 " guestfs_mount_ro (guestfs_h *g,\n"
14771 " const char *device,\n"
14772 " const char *mountpoint);\n"
14777 #: ../src/guestfs-actions.pod:5043
14779 "This is the same as the C<guestfs_mount> command, but it mounts the "
14780 "filesystem with the read-only (I<-o ro>) flag."
14784 #: ../src/guestfs-actions.pod:5050
14785 msgid "guestfs_mount_vfs"
14789 #: ../src/guestfs-actions.pod:5052
14793 " guestfs_mount_vfs (guestfs_h *g,\n"
14794 " const char *options,\n"
14795 " const char *vfstype,\n"
14796 " const char *device,\n"
14797 " const char *mountpoint);\n"
14802 #: ../src/guestfs-actions.pod:5059
14804 "This is the same as the C<guestfs_mount> command, but it allows you to set "
14805 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
14810 #: ../src/guestfs-actions.pod:5067
14811 msgid "guestfs_mountpoints"
14815 #: ../src/guestfs-actions.pod:5069
14819 " guestfs_mountpoints (guestfs_h *g);\n"
14824 #: ../src/guestfs-actions.pod:5072
14826 "This call is similar to C<guestfs_mounts>. That call returns a list of "
14827 "devices. This one returns a hash table (map) of device name to directory "
14828 "where the device is mounted."
14832 #: ../src/guestfs-actions.pod:5084
14833 msgid "guestfs_mounts"
14837 #: ../src/guestfs-actions.pod:5086
14841 " guestfs_mounts (guestfs_h *g);\n"
14846 #: ../src/guestfs-actions.pod:5089 ../fish/guestfish-actions.pod:3356
14848 "This returns the list of currently mounted filesystems. It returns the list"
14849 " of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14853 #: ../src/guestfs-actions.pod:5092 ../fish/guestfish-actions.pod:3359
14854 msgid "Some internal mounts are not shown."
14858 #: ../src/guestfs-actions.pod:5094
14859 msgid "See also: C<guestfs_mountpoints>"
14863 #: ../src/guestfs-actions.pod:5102
14868 #: ../src/guestfs-actions.pod:5104
14872 " guestfs_mv (guestfs_h *g,\n"
14873 " const char *src,\n"
14874 " const char *dest);\n"
14879 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3367
14881 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14882 "destination filename or destination directory."
14886 #: ../src/guestfs-actions.pod:5116
14887 msgid "guestfs_ntfs_3g_probe"
14891 #: ../src/guestfs-actions.pod:5118
14895 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
14897 " const char *device);\n"
14902 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3374
14904 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14905 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14906 "write, and some cannot be mounted at all)."
14910 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3378
14912 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14913 "can be mounted read-write. Set it to false if you want to test if the "
14914 "volume can be mounted read-only."
14918 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3382
14920 "The return value is an integer which C<0> if the operation would succeed, or"
14921 " some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14925 #: ../src/guestfs-actions.pod:5137
14926 msgid "(Added in 1.0.43)"
14930 #: ../src/guestfs-actions.pod:5139
14931 msgid "guestfs_ntfsresize"
14935 #: ../src/guestfs-actions.pod:5141
14939 " guestfs_ntfsresize (guestfs_h *g,\n"
14940 " const char *device);\n"
14945 #: ../src/guestfs-actions.pod:5145 ../src/guestfs-actions.pod:5184
14946 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
14948 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14949 "size of the underlying device."
14953 #: ../src/guestfs-actions.pod:5148 ../fish/guestfish-actions.pod:3393
14955 "I<Note:> After the resize operation, the filesystem is marked as requiring a"
14956 " consistency check (for safety). You have to boot into Windows to perform "
14957 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14958 "resize filesystems which have been marked in this way. So in effect it is "
14959 "not possible to call ntfsresize multiple times on a single filesystem "
14960 "without booting into Windows between each resize."
14964 #: ../src/guestfs-actions.pod:5156 ../src/guestfs-actions.pod:5210
14965 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
14966 msgid "See also L<ntfsresize(8)>."
14970 #: ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5250
14971 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
14973 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14978 #: ../src/guestfs-actions.pod:5169
14979 msgid "guestfs_ntfsresize_opts"
14983 #: ../src/guestfs-actions.pod:5171
14987 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
14988 " const char *device,\n"
14994 #: ../src/guestfs-actions.pod:5181
14997 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
14998 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
15003 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3423
15005 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
15006 "resized to fit the container (eg. partition)."
15010 #: ../src/guestfs-actions.pod:5196 ../fish/guestfish-actions.pod:3426
15015 #: ../src/guestfs-actions.pod:5198 ../fish/guestfish-actions.pod:3428
15017 "If this option is true, then force the resize of the filesystem even if the "
15018 "filesystem is marked as requiring a consistency check."
15022 #: ../src/guestfs-actions.pod:5201
15024 "After the resize operation, the filesystem is always marked as requiring a "
15025 "consistency check (for safety). You have to boot into Windows to perform "
15026 "this check and clear this condition. If you I<don't> set the C<force> "
15027 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
15028 "times on a single filesystem without booting into Windows between each "
15033 #: ../src/guestfs-actions.pod:5216
15034 msgid "guestfs_ntfsresize_opts_va"
15038 #: ../src/guestfs-actions.pod:5218
15042 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
15043 " const char *device,\n"
15044 " va_list args);\n"
15049 #: ../src/guestfs-actions.pod:5223
15050 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
15054 #: ../src/guestfs-actions.pod:5227
15055 msgid "guestfs_ntfsresize_opts_argv"
15059 #: ../src/guestfs-actions.pod:5229
15063 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
15064 " const char *device,\n"
15065 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
15070 #: ../src/guestfs-actions.pod:5234
15071 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
15075 #: ../src/guestfs-actions.pod:5238
15076 msgid "guestfs_ntfsresize_size"
15080 #: ../src/guestfs-actions.pod:5240
15084 " guestfs_ntfsresize_size (guestfs_h *g,\n"
15085 " const char *device,\n"
15086 " int64_t size);\n"
15091 #: ../src/guestfs-actions.pod:5245
15093 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
15094 "to specify the new size (in bytes) explicitly."
15098 #: ../src/guestfs-actions.pod:5257 ../src/guestfs-actions.pod:5693
15099 #: ../src/guestfs-actions.pod:5766 ../src/guestfs-actions.pod:6034
15100 #: ../src/guestfs-actions.pod:7655
15101 msgid "(Added in 1.3.14)"
15105 #: ../src/guestfs-actions.pod:5259
15106 msgid "guestfs_part_add"
15110 #: ../src/guestfs-actions.pod:5261
15114 " guestfs_part_add (guestfs_h *g,\n"
15115 " const char *device,\n"
15116 " const char *prlogex,\n"
15117 " int64_t startsect,\n"
15118 " int64_t endsect);\n"
15123 #: ../src/guestfs-actions.pod:5268
15125 "This command adds a partition to C<device>. If there is no partition table "
15126 "on the device, call C<guestfs_part_init> first."
15130 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3465
15132 "The C<prlogex> parameter is the type of partition. Normally you should pass"
15133 " C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
15134 "C<logical>) and C<e> (or C<extended>) partition types."
15138 #: ../src/guestfs-actions.pod:5276 ../fish/guestfish-actions.pod:3470
15140 "C<startsect> and C<endsect> are the start and end of the partition in "
15141 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
15142 "from the end of the disk (C<-1> is the last sector)."
15146 #: ../src/guestfs-actions.pod:5280
15148 "Creating a partition which covers the whole disk is not so easy. Use "
15149 "C<guestfs_part_disk> to do that."
15153 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5323
15154 #: ../src/guestfs-actions.pod:5376 ../src/guestfs-actions.pod:5454
15155 #: ../src/guestfs-actions.pod:5492 ../src/guestfs-actions.pod:5511
15156 #: ../src/guestfs-actions.pod:5551
15157 msgid "(Added in 1.0.78)"
15161 #: ../src/guestfs-actions.pod:5287
15162 msgid "guestfs_part_del"
15166 #: ../src/guestfs-actions.pod:5289
15170 " guestfs_part_del (guestfs_h *g,\n"
15171 " const char *device,\n"
15177 #: ../src/guestfs-actions.pod:5294 ../fish/guestfish-actions.pod:3481
15178 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15182 #: ../src/guestfs-actions.pod:5296 ../fish/guestfish-actions.pod:3483
15184 "Note that in the case of MBR partitioning, deleting an extended partition "
15185 "also deletes any logical partitions it contains."
15189 #: ../src/guestfs-actions.pod:5304
15190 msgid "guestfs_part_disk"
15194 #: ../src/guestfs-actions.pod:5306
15198 " guestfs_part_disk (guestfs_h *g,\n"
15199 " const char *device,\n"
15200 " const char *parttype);\n"
15205 #: ../src/guestfs-actions.pod:5311
15207 "This command is simply a combination of C<guestfs_part_init> followed by "
15208 "C<guestfs_part_add> to create a single primary partition covering the whole "
15213 #: ../src/guestfs-actions.pod:5315
15215 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other"
15216 " possible values are described in C<guestfs_part_init>."
15220 #: ../src/guestfs-actions.pod:5325
15221 msgid "guestfs_part_get_bootable"
15225 #: ../src/guestfs-actions.pod:5327
15229 " guestfs_part_get_bootable (guestfs_h *g,\n"
15230 " const char *device,\n"
15236 #: ../src/guestfs-actions.pod:5332 ../fish/guestfish-actions.pod:3505
15238 "This command returns true if the partition C<partnum> on C<device> has the "
15239 "bootable flag set."
15243 #: ../src/guestfs-actions.pod:5335
15244 msgid "See also C<guestfs_part_set_bootable>."
15248 #: ../src/guestfs-actions.pod:5341
15249 msgid "guestfs_part_get_mbr_id"
15253 #: ../src/guestfs-actions.pod:5343
15257 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
15258 " const char *device,\n"
15264 #: ../src/guestfs-actions.pod:5348 ../fish/guestfish-actions.pod:3514
15266 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15267 "partition C<partnum>."
15271 #: ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5527
15273 "Note that only MBR (old DOS-style) partitions have type bytes. You will get"
15274 " undefined results for other partition table types (see "
15275 "C<guestfs_part_get_parttype>)."
15279 #: ../src/guestfs-actions.pod:5359
15280 msgid "guestfs_part_get_parttype"
15284 #: ../src/guestfs-actions.pod:5361
15288 " guestfs_part_get_parttype (guestfs_h *g,\n"
15289 " const char *device);\n"
15294 #: ../src/guestfs-actions.pod:5365 ../fish/guestfish-actions.pod:3525
15296 "This command examines the partition table on C<device> and returns the "
15297 "partition table type (format) being used."
15301 #: ../src/guestfs-actions.pod:5368
15303 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15304 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15305 "possible, although unusual. See C<guestfs_part_init> for a full list."
15309 #: ../src/guestfs-actions.pod:5378
15310 msgid "guestfs_part_init"
15314 #: ../src/guestfs-actions.pod:5380
15318 " guestfs_part_init (guestfs_h *g,\n"
15319 " const char *device,\n"
15320 " const char *parttype);\n"
15325 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3537
15327 "This creates an empty partition table on C<device> of one of the partition "
15328 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt>"
15329 " (for large disks)."
15333 #: ../src/guestfs-actions.pod:5389
15335 "Initially there are no partitions. Following this, you should call "
15336 "C<guestfs_part_add> for each partition required."
15340 #: ../src/guestfs-actions.pod:5392 ../fish/guestfish-actions.pod:3544
15341 msgid "Possible values for C<parttype> are:"
15345 #: ../src/guestfs-actions.pod:5396 ../fish/guestfish-actions.pod:3548
15346 msgid "B<efi> | B<gpt>"
15350 #: ../src/guestfs-actions.pod:5398 ../fish/guestfish-actions.pod:3550
15351 msgid "Intel EFI / GPT partition table."
15355 #: ../src/guestfs-actions.pod:5400 ../fish/guestfish-actions.pod:3552
15357 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15358 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15359 "the C<mbr> format."
15363 #: ../src/guestfs-actions.pod:5404 ../fish/guestfish-actions.pod:3556
15364 msgid "B<mbr> | B<msdos>"
15368 #: ../src/guestfs-actions.pod:5406 ../fish/guestfish-actions.pod:3558
15370 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15371 "Windows. This partition type will B<only> work for device sizes up to 2 TB."
15372 " For large disks we recommend using C<gpt>."
15376 #: ../src/guestfs-actions.pod:5413 ../fish/guestfish-actions.pod:3565
15378 "Other partition table types that may work but are not supported include:"
15382 #: ../src/guestfs-actions.pod:5418 ../fish/guestfish-actions.pod:3570
15387 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3572
15388 msgid "AIX disk labels."
15392 #: ../src/guestfs-actions.pod:5422 ../fish/guestfish-actions.pod:3574
15393 msgid "B<amiga> | B<rdb>"
15397 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3576
15398 msgid "Amiga \"Rigid Disk Block\" format."
15402 #: ../src/guestfs-actions.pod:5426 ../fish/guestfish-actions.pod:3578
15407 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3580
15408 msgid "BSD disk labels."
15412 #: ../src/guestfs-actions.pod:5430 ../fish/guestfish-actions.pod:3582
15417 #: ../src/guestfs-actions.pod:5432 ../fish/guestfish-actions.pod:3584
15418 msgid "DASD, used on IBM mainframes."
15422 #: ../src/guestfs-actions.pod:5434 ../fish/guestfish-actions.pod:3586
15427 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3588
15428 msgid "MIPS/SGI volumes."
15432 #: ../src/guestfs-actions.pod:5438 ../fish/guestfish-actions.pod:3590
15437 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3592
15438 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15442 #: ../src/guestfs-actions.pod:5442 ../fish/guestfish-actions.pod:3594
15447 #: ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3596
15448 msgid "NEC PC-98 format, common in Japan apparently."
15452 #: ../src/guestfs-actions.pod:5446 ../fish/guestfish-actions.pod:3598
15457 #: ../src/guestfs-actions.pod:5448 ../fish/guestfish-actions.pod:3600
15458 msgid "Sun disk labels."
15462 #: ../src/guestfs-actions.pod:5456
15463 msgid "guestfs_part_list"
15467 #: ../src/guestfs-actions.pod:5458
15470 " struct guestfs_partition_list *\n"
15471 " guestfs_part_list (guestfs_h *g,\n"
15472 " const char *device);\n"
15477 #: ../src/guestfs-actions.pod:5462 ../fish/guestfish-actions.pod:3608
15479 "This command parses the partition table on C<device> and returns the list of"
15480 " partitions found."
15484 #: ../src/guestfs-actions.pod:5465 ../fish/guestfish-actions.pod:3611
15485 msgid "The fields in the returned structure are:"
15489 #: ../src/guestfs-actions.pod:5469 ../fish/guestfish-actions.pod:3615
15490 msgid "B<part_num>"
15494 #: ../src/guestfs-actions.pod:5471 ../fish/guestfish-actions.pod:3617
15495 msgid "Partition number, counting from 1."
15499 #: ../src/guestfs-actions.pod:5473 ../fish/guestfish-actions.pod:3619
15500 msgid "B<part_start>"
15504 #: ../src/guestfs-actions.pod:5475
15506 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15507 "the device's sector size, see C<guestfs_blockdev_getss>."
15511 #: ../src/guestfs-actions.pod:5478 ../fish/guestfish-actions.pod:3624
15512 msgid "B<part_end>"
15516 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3626
15517 msgid "End of the partition in bytes."
15521 #: ../src/guestfs-actions.pod:5482 ../fish/guestfish-actions.pod:3628
15522 msgid "B<part_size>"
15526 #: ../src/guestfs-actions.pod:5484 ../fish/guestfish-actions.pod:3630
15527 msgid "Size of the partition in bytes."
15531 #: ../src/guestfs-actions.pod:5488
15533 "This function returns a C<struct guestfs_partition_list *>, or NULL if there"
15534 " was an error. I<The caller must call C<guestfs_free_partition_list> after "
15539 #: ../src/guestfs-actions.pod:5494
15540 msgid "guestfs_part_set_bootable"
15544 #: ../src/guestfs-actions.pod:5496
15548 " guestfs_part_set_bootable (guestfs_h *g,\n"
15549 " const char *device,\n"
15551 " int bootable);\n"
15556 #: ../src/guestfs-actions.pod:5502 ../fish/guestfish-actions.pod:3638
15558 "This sets the bootable flag on partition numbered C<partnum> on device "
15559 "C<device>. Note that partitions are numbered from 1."
15563 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3641
15565 "The bootable flag is used by some operating systems (notably Windows) to "
15566 "determine which partition to boot from. It is by no means universally "
15571 #: ../src/guestfs-actions.pod:5513
15572 msgid "guestfs_part_set_mbr_id"
15576 #: ../src/guestfs-actions.pod:5515
15580 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
15581 " const char *device,\n"
15588 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3649
15590 "Sets the MBR type byte (also known as the ID byte) of the numbered partition"
15591 " C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15592 "documentation are in fact hexadecimal numbers, but usually documented "
15593 "without any leading \"0x\" which might be confusing."
15597 #: ../src/guestfs-actions.pod:5535
15598 msgid "guestfs_part_set_name"
15602 #: ../src/guestfs-actions.pod:5537
15606 " guestfs_part_set_name (guestfs_h *g,\n"
15607 " const char *device,\n"
15609 " const char *name);\n"
15614 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3663
15616 "This sets the partition name on partition numbered C<partnum> on device "
15617 "C<device>. Note that partitions are numbered from 1."
15621 #: ../src/guestfs-actions.pod:5546 ../fish/guestfish-actions.pod:3666
15623 "The partition name can only be set on certain types of partition table. "
15624 "This works on C<gpt> but not on C<mbr> partitions."
15628 #: ../src/guestfs-actions.pod:5553
15629 msgid "guestfs_part_to_dev"
15633 #: ../src/guestfs-actions.pod:5555
15637 " guestfs_part_to_dev (guestfs_h *g,\n"
15638 " const char *partition);\n"
15643 #: ../src/guestfs-actions.pod:5559 ../fish/guestfish-actions.pod:3673
15645 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15646 "partition number, returning the device name (eg. \"/dev/sdb\")."
15650 #: ../src/guestfs-actions.pod:5563
15652 "The named partition must exist, for example as a string returned from "
15653 "C<guestfs_list_partitions>."
15657 #: ../src/guestfs-actions.pod:5571
15658 msgid "guestfs_ping_daemon"
15662 #: ../src/guestfs-actions.pod:5573
15666 " guestfs_ping_daemon (guestfs_h *g);\n"
15671 #: ../src/guestfs-actions.pod:5576 ../fish/guestfish-actions.pod:3684
15673 "This is a test probe into the guestfs daemon running inside the qemu "
15674 "subprocess. Calling this function checks that the daemon responds to the "
15675 "ping message, without affecting the daemon or attached block device(s) in "
15680 #: ../src/guestfs-actions.pod:5585
15681 msgid "guestfs_pread"
15685 #: ../src/guestfs-actions.pod:5587
15689 " guestfs_pread (guestfs_h *g,\n"
15690 " const char *path,\n"
15692 " int64_t offset,\n"
15693 " size_t *size_r);\n"
15698 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3693
15700 "This command lets you read part of a file. It reads C<count> bytes of the "
15701 "file, starting at C<offset>, from file C<path>."
15705 #: ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5623
15706 #: ../fish/guestfish-actions.pod:3696 ../fish/guestfish-actions.pod:3711
15708 "This may read fewer bytes than requested. For further details see the "
15709 "L<pread(2)> system call."
15713 #: ../src/guestfs-actions.pod:5600
15714 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
15718 #: ../src/guestfs-actions.pod:5611
15719 msgid "guestfs_pread_device"
15723 #: ../src/guestfs-actions.pod:5613
15727 " guestfs_pread_device (guestfs_h *g,\n"
15728 " const char *device,\n"
15730 " int64_t offset,\n"
15731 " size_t *size_r);\n"
15736 #: ../src/guestfs-actions.pod:5620 ../fish/guestfish-actions.pod:3708
15738 "This command lets you read part of a file. It reads C<count> bytes of "
15739 "C<device>, starting at C<offset>."
15743 #: ../src/guestfs-actions.pod:5626
15744 msgid "See also C<guestfs_pread>."
15748 #: ../src/guestfs-actions.pod:5635
15749 msgid "(Added in 1.5.21)"
15753 #: ../src/guestfs-actions.pod:5637
15754 msgid "guestfs_pvcreate"
15758 #: ../src/guestfs-actions.pod:5639
15762 " guestfs_pvcreate (guestfs_h *g,\n"
15763 " const char *device);\n"
15768 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3723
15770 "This creates an LVM physical volume on the named C<device>, where C<device> "
15771 "should usually be a partition name such as C</dev/sda1>."
15775 #: ../src/guestfs-actions.pod:5651
15776 msgid "guestfs_pvremove"
15780 #: ../src/guestfs-actions.pod:5653
15784 " guestfs_pvremove (guestfs_h *g,\n"
15785 " const char *device);\n"
15790 #: ../src/guestfs-actions.pod:5657 ../fish/guestfish-actions.pod:3731
15792 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15797 #: ../src/guestfs-actions.pod:5660 ../fish/guestfish-actions.pod:3734
15799 "The implementation uses the C<pvremove> command which refuses to wipe "
15800 "physical volumes that contain any volume groups, so you have to remove those"
15805 #: ../src/guestfs-actions.pod:5668
15806 msgid "guestfs_pvresize"
15810 #: ../src/guestfs-actions.pod:5670
15814 " guestfs_pvresize (guestfs_h *g,\n"
15815 " const char *device);\n"
15820 #: ../src/guestfs-actions.pod:5674 ../fish/guestfish-actions.pod:3742
15822 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15823 "the new size of the underlying device."
15827 #: ../src/guestfs-actions.pod:5681
15828 msgid "guestfs_pvresize_size"
15832 #: ../src/guestfs-actions.pod:5683
15836 " guestfs_pvresize_size (guestfs_h *g,\n"
15837 " const char *device,\n"
15838 " int64_t size);\n"
15843 #: ../src/guestfs-actions.pod:5688
15845 "This command is the same as C<guestfs_pvresize> except that it allows you to"
15846 " specify the new size (in bytes) explicitly."
15850 #: ../src/guestfs-actions.pod:5695
15851 msgid "guestfs_pvs"
15855 #: ../src/guestfs-actions.pod:5697
15859 " guestfs_pvs (guestfs_h *g);\n"
15864 #: ../src/guestfs-actions.pod:5700 ../fish/guestfish-actions.pod:3756
15866 "List all the physical volumes detected. This is the equivalent of the "
15867 "L<pvs(8)> command."
15871 #: ../src/guestfs-actions.pod:5703 ../fish/guestfish-actions.pod:3759
15873 "This returns a list of just the device names that contain PVs (eg. "
15878 #: ../src/guestfs-actions.pod:5706
15879 msgid "See also C<guestfs_pvs_full>."
15883 #: ../src/guestfs-actions.pod:5714
15884 msgid "guestfs_pvs_full"
15888 #: ../src/guestfs-actions.pod:5716
15891 " struct guestfs_lvm_pv_list *\n"
15892 " guestfs_pvs_full (guestfs_h *g);\n"
15897 #: ../src/guestfs-actions.pod:5719 ../fish/guestfish-actions.pod:3768
15899 "List all the physical volumes detected. This is the equivalent of the "
15900 "L<pvs(8)> command. The \"full\" version includes all fields."
15904 #: ../src/guestfs-actions.pod:5722
15906 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
15907 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
15912 #: ../src/guestfs-actions.pod:5728
15913 msgid "guestfs_pvuuid"
15917 #: ../src/guestfs-actions.pod:5730
15921 " guestfs_pvuuid (guestfs_h *g,\n"
15922 " const char *device);\n"
15927 #: ../src/guestfs-actions.pod:5734 ../fish/guestfish-actions.pod:3775
15928 msgid "This command returns the UUID of the LVM PV C<device>."
15932 #: ../src/guestfs-actions.pod:5741
15933 msgid "guestfs_pwrite"
15937 #: ../src/guestfs-actions.pod:5743
15941 " guestfs_pwrite (guestfs_h *g,\n"
15942 " const char *path,\n"
15943 " const char *content,\n"
15944 " size_t content_size,\n"
15945 " int64_t offset);\n"
15950 #: ../src/guestfs-actions.pod:5750 ../fish/guestfish-actions.pod:3781
15952 "This command writes to part of a file. It writes the data buffer C<content>"
15953 " to the file C<path> starting at offset C<offset>."
15957 #: ../src/guestfs-actions.pod:5753 ../fish/guestfish-actions.pod:3784
15959 "This command implements the L<pwrite(2)> system call, and like that system "
15960 "call it may not write the full data requested. The return value is the "
15961 "number of bytes that were actually written to the file. This could even be "
15962 "0, although short writes are unlikely for regular files in ordinary "
15967 #: ../src/guestfs-actions.pod:5759
15968 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
15972 #: ../src/guestfs-actions.pod:5768
15973 msgid "guestfs_pwrite_device"
15977 #: ../src/guestfs-actions.pod:5770
15981 " guestfs_pwrite_device (guestfs_h *g,\n"
15982 " const char *device,\n"
15983 " const char *content,\n"
15984 " size_t content_size,\n"
15985 " int64_t offset);\n"
15990 #: ../src/guestfs-actions.pod:5777 ../fish/guestfish-actions.pod:3799
15992 "This command writes to part of a device. It writes the data buffer "
15993 "C<content> to C<device> starting at offset C<offset>."
15997 #: ../src/guestfs-actions.pod:5780 ../fish/guestfish-actions.pod:3802
15999 "This command implements the L<pwrite(2)> system call, and like that system "
16000 "call it may not write the full data requested (although short writes to disk"
16001 " devices and partitions are probably impossible with standard Linux "
16006 #: ../src/guestfs-actions.pod:5785
16007 msgid "See also C<guestfs_pwrite>."
16011 #: ../src/guestfs-actions.pod:5792
16012 msgid "(Added in 1.5.20)"
16016 #: ../src/guestfs-actions.pod:5794
16017 msgid "guestfs_read_file"
16021 #: ../src/guestfs-actions.pod:5796
16025 " guestfs_read_file (guestfs_h *g,\n"
16026 " const char *path,\n"
16027 " size_t *size_r);\n"
16032 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3816
16033 msgid "This calls returns the contents of the file C<path> as a buffer."
16037 #: ../src/guestfs-actions.pod:5804
16039 "Unlike C<guestfs_cat>, this function can correctly handle files that contain"
16040 " embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
16041 "function is limited in the total size of file that can be handled."
16045 #: ../src/guestfs-actions.pod:5816
16046 msgid "(Added in 1.0.63)"
16050 #: ../src/guestfs-actions.pod:5818
16051 msgid "guestfs_read_lines"
16055 #: ../src/guestfs-actions.pod:5820
16059 " guestfs_read_lines (guestfs_h *g,\n"
16060 " const char *path);\n"
16065 #: ../src/guestfs-actions.pod:5826 ../fish/guestfish-actions.pod:3833
16067 "The file contents are returned as a list of lines. Trailing C<LF> and "
16068 "C<CRLF> character sequences are I<not> returned."
16072 #: ../src/guestfs-actions.pod:5829
16074 "Note that this function cannot correctly handle binary files (specifically, "
16075 "files containing C<\\0> character which is treated as end of line). For "
16076 "those you need to use the C<guestfs_read_file> function which has a more "
16077 "complex interface."
16081 #: ../src/guestfs-actions.pod:5840
16082 msgid "guestfs_readdir"
16086 #: ../src/guestfs-actions.pod:5842
16089 " struct guestfs_dirent_list *\n"
16090 " guestfs_readdir (guestfs_h *g,\n"
16091 " const char *dir);\n"
16096 #: ../src/guestfs-actions.pod:5846 ../fish/guestfish-actions.pod:3845
16097 msgid "This returns the list of directory entries in directory C<dir>."
16101 #: ../src/guestfs-actions.pod:5848 ../fish/guestfish-actions.pod:3847
16103 "All entries in the directory are returned, including C<.> and C<..>. The "
16104 "entries are I<not> sorted, but returned in the same order as the underlying "
16109 #: ../src/guestfs-actions.pod:5852 ../fish/guestfish-actions.pod:3851
16111 "Also this call returns basic file type information about each file. The "
16112 "C<ftyp> field will contain one of the following characters:"
16116 #: ../src/guestfs-actions.pod:5857 ../fish/guestfish-actions.pod:3856
16121 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3858
16122 msgid "Block special"
16126 #: ../src/guestfs-actions.pod:5861 ../fish/guestfish-actions.pod:3860
16131 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3862
16132 msgid "Char special"
16136 #: ../src/guestfs-actions.pod:5865 ../fish/guestfish-actions.pod:3864
16141 #: ../src/guestfs-actions.pod:5867 ../fish/guestfish-actions.pod:3866
16146 #: ../src/guestfs-actions.pod:5869 ../fish/guestfish-actions.pod:3868
16151 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3870
16152 msgid "FIFO (named pipe)"
16156 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3872
16161 #: ../src/guestfs-actions.pod:5875 ../fish/guestfish-actions.pod:3874
16162 msgid "Symbolic link"
16166 #: ../src/guestfs-actions.pod:5877 ../fish/guestfish-actions.pod:3876
16171 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3878
16172 msgid "Regular file"
16176 #: ../src/guestfs-actions.pod:5881 ../fish/guestfish-actions.pod:3880
16181 #: ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:3882
16186 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3884
16191 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3886
16192 msgid "Unknown file type"
16196 #: ../src/guestfs-actions.pod:5889 ../fish/guestfish-actions.pod:3888
16201 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3890
16203 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16207 #: ../src/guestfs-actions.pod:5896
16209 "This function is primarily intended for use by programs. To get a simple "
16210 "list of names, use C<guestfs_ls>. To get a printable directory for human "
16211 "consumption, use C<guestfs_ll>."
16215 #: ../src/guestfs-actions.pod:5900
16217 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
16218 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
16223 #: ../src/guestfs-actions.pod:5906
16224 msgid "guestfs_readlink"
16228 #: ../src/guestfs-actions.pod:5908
16232 " guestfs_readlink (guestfs_h *g,\n"
16233 " const char *path);\n"
16238 #: ../src/guestfs-actions.pod:5912 ../fish/guestfish-actions.pod:3903
16239 msgid "This command reads the target of a symbolic link."
16243 #: ../src/guestfs-actions.pod:5919
16244 msgid "guestfs_readlinklist"
16248 #: ../src/guestfs-actions.pod:5921
16252 " guestfs_readlinklist (guestfs_h *g,\n"
16253 " const char *path,\n"
16254 " char *const *names);\n"
16259 #: ../src/guestfs-actions.pod:5926 ../fish/guestfish-actions.pod:3909
16261 "This call allows you to do a C<readlink> operation on multiple files, where "
16262 "all files are in the directory C<path>. C<names> is the list of files from "
16267 #: ../src/guestfs-actions.pod:5930 ../fish/guestfish-actions.pod:3913
16269 "On return you get a list of strings, with a one-to-one correspondence to the"
16270 " C<names> list. Each string is the value of the symbolic link."
16274 #: ../src/guestfs-actions.pod:5934 ../fish/guestfish-actions.pod:3917
16276 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16277 "result string is the empty string C<\"\">. However the whole operation is "
16278 "completed even if there were C<readlink(2)> errors, and so you can call this"
16279 " function with names where you don't know if they are symbolic links already"
16280 " (albeit slightly less efficient)."
16284 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3924
16286 "This call is intended for programs that want to efficiently list a directory"
16287 " contents without making many round-trips. Very long directory listings "
16288 "might cause the protocol message size to be exceeded, causing this call to "
16289 "fail. The caller must split up such requests into smaller groups of names."
16293 #: ../src/guestfs-actions.pod:5954
16294 msgid "guestfs_realpath"
16298 #: ../src/guestfs-actions.pod:5956
16302 " guestfs_realpath (guestfs_h *g,\n"
16303 " const char *path);\n"
16308 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:3935
16310 "Return the canonicalized absolute pathname of C<path>. The returned path "
16311 "has no C<.>, C<..> or symbolic link path elements."
16315 #: ../src/guestfs-actions.pod:5968
16316 msgid "guestfs_removexattr"
16320 #: ../src/guestfs-actions.pod:5970
16324 " guestfs_removexattr (guestfs_h *g,\n"
16325 " const char *xattr,\n"
16326 " const char *path);\n"
16331 #: ../src/guestfs-actions.pod:5975 ../fish/guestfish-actions.pod:3942
16333 "This call removes the extended attribute named C<xattr> of the file C<path>."
16337 #: ../src/guestfs-actions.pod:5978
16338 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
16342 #: ../src/guestfs-actions.pod:5984
16343 msgid "guestfs_resize2fs"
16347 #: ../src/guestfs-actions.pod:5986
16351 " guestfs_resize2fs (guestfs_h *g,\n"
16352 " const char *device);\n"
16357 #: ../src/guestfs-actions.pod:5990 ../fish/guestfish-actions.pod:3951
16359 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16360 "underlying device."
16364 #: ../src/guestfs-actions.pod:5993
16366 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
16367 "C<device> before calling this command. For unknown reasons C<resize2fs> "
16368 "sometimes gives an error about this and sometimes not. In any case, it is "
16369 "always safe to call C<guestfs_e2fsck_f> before calling this function."
16373 #: ../src/guestfs-actions.pod:6003
16374 msgid "guestfs_resize2fs_M"
16378 #: ../src/guestfs-actions.pod:6005
16382 " guestfs_resize2fs_M (guestfs_h *g,\n"
16383 " const char *device);\n"
16388 #: ../src/guestfs-actions.pod:6009
16390 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
16391 "resized to its minimum size. This works like the I<-M> option to the "
16392 "C<resize2fs> command."
16396 #: ../src/guestfs-actions.pod:6013
16398 "To get the resulting size of the filesystem you should call "
16399 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
16400 "These two numbers, multiplied together, give the resulting size of the "
16401 "minimal filesystem in bytes."
16405 #: ../src/guestfs-actions.pod:6022
16406 msgid "guestfs_resize2fs_size"
16410 #: ../src/guestfs-actions.pod:6024
16414 " guestfs_resize2fs_size (guestfs_h *g,\n"
16415 " const char *device,\n"
16416 " int64_t size);\n"
16421 #: ../src/guestfs-actions.pod:6029
16423 "This command is the same as C<guestfs_resize2fs> except that it allows you "
16424 "to specify the new size (in bytes) explicitly."
16428 #: ../src/guestfs-actions.pod:6036
16433 #: ../src/guestfs-actions.pod:6038
16437 " guestfs_rm (guestfs_h *g,\n"
16438 " const char *path);\n"
16443 #: ../src/guestfs-actions.pod:6042 ../fish/guestfish-actions.pod:3984
16444 msgid "Remove the single file C<path>."
16448 #: ../src/guestfs-actions.pod:6048
16449 msgid "guestfs_rm_rf"
16453 #: ../src/guestfs-actions.pod:6050
16457 " guestfs_rm_rf (guestfs_h *g,\n"
16458 " const char *path);\n"
16463 #: ../src/guestfs-actions.pod:6054 ../fish/guestfish-actions.pod:3990
16465 "Remove the file or directory C<path>, recursively removing the contents if "
16466 "its a directory. This is like the C<rm -rf> shell command."
16470 #: ../src/guestfs-actions.pod:6062
16471 msgid "guestfs_rmdir"
16475 #: ../src/guestfs-actions.pod:6064
16479 " guestfs_rmdir (guestfs_h *g,\n"
16480 " const char *path);\n"
16485 #: ../src/guestfs-actions.pod:6068 ../fish/guestfish-actions.pod:3998
16486 msgid "Remove the single directory C<path>."
16490 #: ../src/guestfs-actions.pod:6074
16491 msgid "guestfs_rmmountpoint"
16495 #: ../src/guestfs-actions.pod:6076
16499 " guestfs_rmmountpoint (guestfs_h *g,\n"
16500 " const char *exemptpath);\n"
16505 #: ../src/guestfs-actions.pod:6080
16507 "This calls removes a mountpoint that was previously created with "
16508 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
16512 #: ../src/guestfs-actions.pod:6088
16513 msgid "guestfs_scrub_device"
16517 #: ../src/guestfs-actions.pod:6090
16521 " guestfs_scrub_device (guestfs_h *g,\n"
16522 " const char *device);\n"
16527 #: ../src/guestfs-actions.pod:6094 ../fish/guestfish-actions.pod:4012
16529 "This command writes patterns over C<device> to make data retrieval more "
16534 #: ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6118
16535 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4015
16536 #: ../fish/guestfish-actions.pod:4030 ../fish/guestfish-actions.pod:4043
16538 "It is an interface to the L<scrub(1)> program. See that manual page for "
16543 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6123
16544 #: ../src/guestfs-actions.pod:6142
16545 msgid "(Added in 1.0.52)"
16549 #: ../src/guestfs-actions.pod:6107
16550 msgid "guestfs_scrub_file"
16554 #: ../src/guestfs-actions.pod:6109
16558 " guestfs_scrub_file (guestfs_h *g,\n"
16559 " const char *file);\n"
16564 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4025
16566 "This command writes patterns over a file to make data retrieval more "
16571 #: ../src/guestfs-actions.pod:6116 ../fish/guestfish-actions.pod:4028
16572 msgid "The file is I<removed> after scrubbing."
16576 #: ../src/guestfs-actions.pod:6125
16577 msgid "guestfs_scrub_freespace"
16581 #: ../src/guestfs-actions.pod:6127
16585 " guestfs_scrub_freespace (guestfs_h *g,\n"
16586 " const char *dir);\n"
16591 #: ../src/guestfs-actions.pod:6131
16593 "This command creates the directory C<dir> and then fills it with files until"
16594 " the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
16595 "and deletes them. The intention is to scrub any free space on the partition"
16596 " containing C<dir>."
16600 #: ../src/guestfs-actions.pod:6144
16601 msgid "guestfs_set_append"
16605 #: ../src/guestfs-actions.pod:6146
16609 " guestfs_set_append (guestfs_h *g,\n"
16610 " const char *append);\n"
16615 #: ../src/guestfs-actions.pod:6150 ../fish/guestfish-actions.pod:4052
16617 "This function is used to add additional options to the guest kernel command "
16622 #: ../src/guestfs-actions.pod:6153 ../fish/guestfish-actions.pod:4055
16624 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16625 "environment variable."
16629 #: ../src/guestfs-actions.pod:6156 ../fish/guestfish-actions.pod:4058
16631 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16632 "(libguestfs always adds a few of its own)."
16636 #: ../src/guestfs-actions.pod:6163
16637 msgid "guestfs_set_attach_method"
16641 #: ../src/guestfs-actions.pod:6165
16645 " guestfs_set_attach_method (guestfs_h *g,\n"
16646 " const char *attachmethod);\n"
16651 #: ../src/guestfs-actions.pod:6169 ../fish/guestfish-actions.pod:4067
16653 "Set the method that libguestfs uses to connect to the back end guestfsd "
16654 "daemon. Possible methods are:"
16658 #: ../src/guestfs-actions.pod:6176 ../fish/guestfish-actions.pod:4074
16660 "Launch an appliance and connect to it. This is the ordinary method and the "
16665 #: ../src/guestfs-actions.pod:6179 ../fish/guestfish-actions.pod:4077
16666 msgid "C<unix:I<path>>"
16670 #: ../src/guestfs-actions.pod:6181 ../fish/guestfish-actions.pod:4079
16671 msgid "Connect to the Unix domain socket I<path>."
16675 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4081
16677 "This method lets you connect to an existing daemon or (using virtio-serial) "
16678 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16679 "RUNNING DAEMONS>."
16683 #: ../src/guestfs-actions.pod:6193
16684 msgid "guestfs_set_autosync"
16688 #: ../src/guestfs-actions.pod:6195
16692 " guestfs_set_autosync (guestfs_h *g,\n"
16693 " int autosync);\n"
16698 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4093
16700 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16701 "effort attempt to make filesystems consistent and synchronized when the "
16702 "handle is closed (also if the program exits without closing handles)."
16706 #: ../src/guestfs-actions.pod:6204 ../fish/guestfish-actions.pod:4098
16708 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16709 "disabled by default)."
16713 #: ../src/guestfs-actions.pod:6211
16714 msgid "guestfs_set_direct"
16718 #: ../src/guestfs-actions.pod:6213
16722 " guestfs_set_direct (guestfs_h *g,\n"
16728 #: ../src/guestfs-actions.pod:6217 ../fish/guestfish-actions.pod:4107
16730 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16731 "passed directly through to the appliance once it is launched."
16735 #: ../src/guestfs-actions.pod:6221
16737 "One consequence of this is that log messages aren't caught by the library "
16738 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
16743 #: ../src/guestfs-actions.pod:6225 ../fish/guestfish-actions.pod:4115
16745 "You probably don't want to use this unless you know what you are doing."
16749 #: ../src/guestfs-actions.pod:6228 ../fish/guestfish-actions.pod:4118
16750 msgid "The default is disabled."
16754 #: ../src/guestfs-actions.pod:6234
16755 msgid "guestfs_set_e2label"
16759 #: ../src/guestfs-actions.pod:6236
16763 " guestfs_set_e2label (guestfs_h *g,\n"
16764 " const char *device,\n"
16765 " const char *label);\n"
16770 #: ../src/guestfs-actions.pod:6241 ../fish/guestfish-actions.pod:4124
16772 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16773 "C<label>. Filesystem labels are limited to 16 characters."
16777 #: ../src/guestfs-actions.pod:6245
16779 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
16780 "the existing label on a filesystem."
16784 #: ../src/guestfs-actions.pod:6252
16785 msgid "guestfs_set_e2uuid"
16789 #: ../src/guestfs-actions.pod:6254
16793 " guestfs_set_e2uuid (guestfs_h *g,\n"
16794 " const char *device,\n"
16795 " const char *uuid);\n"
16800 #: ../src/guestfs-actions.pod:6259 ../fish/guestfish-actions.pod:4135
16802 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16803 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16804 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16808 #: ../src/guestfs-actions.pod:6264
16810 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
16811 "the existing UUID of a filesystem."
16815 #: ../src/guestfs-actions.pod:6271
16816 msgid "guestfs_set_memsize"
16820 #: ../src/guestfs-actions.pod:6273
16824 " guestfs_set_memsize (guestfs_h *g,\n"
16830 #: ../src/guestfs-actions.pod:6277
16832 "This sets the memory size in megabytes allocated to the qemu subprocess. "
16833 "This only has any effect if called before C<guestfs_launch>."
16837 #: ../src/guestfs-actions.pod:6281 ../fish/guestfish-actions.pod:4153
16839 "You can also change this by setting the environment variable "
16840 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
16844 #: ../src/guestfs-actions.pod:6292
16845 msgid "guestfs_set_network"
16849 #: ../src/guestfs-actions.pod:6294
16853 " guestfs_set_network (guestfs_h *g,\n"
16859 #: ../src/guestfs-actions.pod:6298 ../fish/guestfish-actions.pod:4166
16861 "If C<network> is true, then the network is enabled in the libguestfs "
16862 "appliance. The default is false."
16866 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4169
16868 "This affects whether commands are able to access the network (see "
16869 "L<guestfs(3)/RUNNING COMMANDS>)."
16873 #: ../src/guestfs-actions.pod:6304
16875 "You must call this before calling C<guestfs_launch>, otherwise it has no "
16880 #: ../src/guestfs-actions.pod:6311
16881 msgid "guestfs_set_path"
16885 #: ../src/guestfs-actions.pod:6313
16889 " guestfs_set_path (guestfs_h *g,\n"
16890 " const char *searchpath);\n"
16895 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4181
16896 msgid "Set the path that libguestfs searches for kernel and initrd.img."
16900 #: ../src/guestfs-actions.pod:6319 ../fish/guestfish-actions.pod:4183
16902 "The default is C<$libdir/guestfs> unless overridden by setting "
16903 "C<LIBGUESTFS_PATH> environment variable."
16907 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4186
16908 msgid "Setting C<path> to C<NULL> restores the default path."
16912 #: ../src/guestfs-actions.pod:6328
16913 msgid "guestfs_set_pgroup"
16917 #: ../src/guestfs-actions.pod:6330
16921 " guestfs_set_pgroup (guestfs_h *g,\n"
16927 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4194
16929 "If C<pgroup> is true, child processes are placed into their own process "
16934 #: ../src/guestfs-actions.pod:6337 ../fish/guestfish-actions.pod:4197
16936 "The practical upshot of this is that signals like C<SIGINT> (from users "
16937 "pressing C<^C>) won't be received by the child process."
16941 #: ../src/guestfs-actions.pod:6340 ../fish/guestfish-actions.pod:4200
16943 "The default for this flag is false, because usually you want C<^C> to kill "
16948 #: ../src/guestfs-actions.pod:6345
16949 msgid "guestfs_set_qemu"
16953 #: ../src/guestfs-actions.pod:6347
16957 " guestfs_set_qemu (guestfs_h *g,\n"
16958 " const char *qemu);\n"
16963 #: ../src/guestfs-actions.pod:6351 ../fish/guestfish-actions.pod:4209
16964 msgid "Set the qemu binary that we will use."
16968 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4211
16970 "The default is chosen when the library was compiled by the configure script."
16974 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4214
16976 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
16981 #: ../src/guestfs-actions.pod:6359 ../fish/guestfish-actions.pod:4217
16982 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
16986 #: ../src/guestfs-actions.pod:6361 ../fish/guestfish-actions.pod:4219
16988 "Note that you should call this function as early as possible after creating "
16989 "the handle. This is because some pre-launch operations depend on testing "
16990 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
16991 "don't retest features, and so you might see inconsistent results. Using the"
16992 " environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
16993 "the qemu binary at the same time as the handle is created."
16997 #: ../src/guestfs-actions.pod:6373
16998 msgid "guestfs_set_recovery_proc"
17002 #: ../src/guestfs-actions.pod:6375
17006 " guestfs_set_recovery_proc (guestfs_h *g,\n"
17007 " int recoveryproc);\n"
17012 #: ../src/guestfs-actions.pod:6379
17014 "If this is called with the parameter C<false> then C<guestfs_launch> does "
17015 "not create a recovery process. The purpose of the recovery process is to "
17016 "stop runaway qemu processes in the case where the main program aborts "
17021 #: ../src/guestfs-actions.pod:6384
17023 "This only has any effect if called before C<guestfs_launch>, and the default"
17028 #: ../src/guestfs-actions.pod:6387 ../fish/guestfish-actions.pod:4241
17030 "About the only time when you would want to disable this is if the main "
17031 "process will fork itself into the background (\"daemonize\" itself). In "
17032 "this case the recovery process thinks that the main program has disappeared "
17033 "and so kills qemu, which is not very helpful."
17037 #: ../src/guestfs-actions.pod:6397
17038 msgid "guestfs_set_selinux"
17042 #: ../src/guestfs-actions.pod:6399
17046 " guestfs_set_selinux (guestfs_h *g,\n"
17052 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4253
17054 "This sets the selinux flag that is passed to the appliance at boot time. "
17055 "The default is C<selinux=0> (disabled)."
17059 #: ../src/guestfs-actions.pod:6406 ../fish/guestfish-actions.pod:4256
17061 "Note that if SELinux is enabled, it is always in Permissive mode "
17062 "(C<enforcing=0>)."
17066 #: ../src/guestfs-actions.pod:6416
17067 msgid "guestfs_set_trace"
17071 #: ../src/guestfs-actions.pod:6418
17075 " guestfs_set_trace (guestfs_h *g,\n"
17081 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4268
17083 "If the command trace flag is set to 1, then libguestfs calls, parameters and"
17084 " return values are traced."
17088 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4271
17090 "If you want to trace C API calls into libguestfs (and other libraries) then "
17091 "possibly a better way is to use the external ltrace(1) command."
17095 #: ../src/guestfs-actions.pod:6429 ../fish/guestfish-actions.pod:4275
17097 "Command traces are disabled unless the environment variable "
17098 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17102 #: ../src/guestfs-actions.pod:6432
17104 "Trace messages are normally sent to C<stderr>, unless you register a "
17105 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17109 #: ../src/guestfs-actions.pod:6440
17110 msgid "guestfs_set_verbose"
17114 #: ../src/guestfs-actions.pod:6442
17118 " guestfs_set_verbose (guestfs_h *g,\n"
17124 #: ../src/guestfs-actions.pod:6446 ../fish/guestfish-actions.pod:4288
17125 msgid "If C<verbose> is true, this turns on verbose messages."
17129 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4290
17131 "Verbose messages are disabled unless the environment variable "
17132 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17136 #: ../src/guestfs-actions.pod:6451
17138 "Verbose messages are normally sent to C<stderr>, unless you register a "
17139 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
17143 #: ../src/guestfs-actions.pod:6459
17144 msgid "guestfs_setcon"
17148 #: ../src/guestfs-actions.pod:6461
17152 " guestfs_setcon (guestfs_h *g,\n"
17153 " const char *context);\n"
17158 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4301
17160 "This sets the SELinux security context of the daemon to the string "
17165 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4304
17166 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17170 #: ../src/guestfs-actions.pod:6474
17171 msgid "guestfs_setxattr"
17175 #: ../src/guestfs-actions.pod:6476
17179 " guestfs_setxattr (guestfs_h *g,\n"
17180 " const char *xattr,\n"
17181 " const char *val,\n"
17183 " const char *path);\n"
17188 #: ../src/guestfs-actions.pod:6483 ../fish/guestfish-actions.pod:4310
17190 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17191 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17195 #: ../src/guestfs-actions.pod:6487
17196 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
17200 #: ../src/guestfs-actions.pod:6493
17201 msgid "guestfs_sfdisk"
17205 #: ../src/guestfs-actions.pod:6495
17209 " guestfs_sfdisk (guestfs_h *g,\n"
17210 " const char *device,\n"
17214 " char *const *lines);\n"
17219 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4320
17221 "This is a direct interface to the L<sfdisk(8)> program for creating "
17222 "partitions on block devices."
17226 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4323
17227 msgid "C<device> should be a block device, for example C</dev/sda>."
17231 #: ../src/guestfs-actions.pod:6508 ../fish/guestfish-actions.pod:4325
17233 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17234 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
17235 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17236 "corresponding parameter is omitted. Usually for 'large' disks, you can just"
17237 " pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather,"
17238 " the kernel) cannot work out the right geometry and you will need to tell "
17243 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4333
17245 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information"
17246 " refer to the L<sfdisk(8)> manpage."
17250 #: ../src/guestfs-actions.pod:6519 ../fish/guestfish-actions.pod:4336
17252 "To create a single partition occupying the whole disk, you would pass "
17253 "C<lines> as a single element list, when the single element being the string "
17258 #: ../src/guestfs-actions.pod:6523
17260 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
17264 #: ../src/guestfs-actions.pod:6531 ../src/guestfs-actions.pod:6561
17265 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4346
17266 #: ../fish/guestfish-actions.pod:4369 ../fish/guestfish-actions.pod:4391
17268 "This function is deprecated. In new code, use the C<part_add> call instead."
17272 #: ../src/guestfs-actions.pod:6540
17273 msgid "guestfs_sfdiskM"
17277 #: ../src/guestfs-actions.pod:6542
17281 " guestfs_sfdiskM (guestfs_h *g,\n"
17282 " const char *device,\n"
17283 " char *const *lines);\n"
17288 #: ../src/guestfs-actions.pod:6547
17290 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
17291 "partition sizes are specified in megabytes only (rounded to the nearest "
17292 "cylinder) and you don't need to specify the cyls, heads and sectors "
17293 "parameters which were rarely if ever used anyway."
17297 #: ../src/guestfs-actions.pod:6553
17299 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
17300 "C<guestfs_part_disk>"
17304 #: ../src/guestfs-actions.pod:6570
17305 msgid "guestfs_sfdisk_N"
17309 #: ../src/guestfs-actions.pod:6572
17313 " guestfs_sfdisk_N (guestfs_h *g,\n"
17314 " const char *device,\n"
17319 " const char *line);\n"
17324 #: ../src/guestfs-actions.pod:6581 ../fish/guestfish-actions.pod:4380
17326 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17327 "(note: C<n> counts from 1)."
17331 #: ../src/guestfs-actions.pod:6584
17333 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
17334 "for the cyls/heads/sectors parameters."
17338 #: ../src/guestfs-actions.pod:6587
17339 msgid "See also: C<guestfs_part_add>"
17343 #: ../src/guestfs-actions.pod:6603
17344 msgid "guestfs_sfdisk_disk_geometry"
17348 #: ../src/guestfs-actions.pod:6605
17352 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
17353 " const char *device);\n"
17358 #: ../src/guestfs-actions.pod:6609
17360 "This displays the disk geometry of C<device> read from the partition table."
17361 " Especially in the case where the underlying block device has been resized,"
17362 " this can be different from the kernel's idea of the geometry (see "
17363 "C<guestfs_sfdisk_kernel_geometry>)."
17367 #: ../src/guestfs-actions.pod:6614 ../src/guestfs-actions.pod:6630
17368 #: ../fish/guestfish-actions.pod:4407 ../fish/guestfish-actions.pod:4416
17369 msgid "The result is in human-readable format, and not designed to be parsed."
17373 #: ../src/guestfs-actions.pod:6622
17374 msgid "guestfs_sfdisk_kernel_geometry"
17378 #: ../src/guestfs-actions.pod:6624
17382 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
17383 " const char *device);\n"
17388 #: ../src/guestfs-actions.pod:6628 ../fish/guestfish-actions.pod:4414
17389 msgid "This displays the kernel's idea of the geometry of C<device>."
17393 #: ../src/guestfs-actions.pod:6638
17394 msgid "guestfs_sfdisk_l"
17398 #: ../src/guestfs-actions.pod:6640
17402 " guestfs_sfdisk_l (guestfs_h *g,\n"
17403 " const char *device);\n"
17408 #: ../src/guestfs-actions.pod:6644 ../fish/guestfish-actions.pod:4423
17410 "This displays the partition table on C<device>, in the human-readable output"
17411 " of the L<sfdisk(8)> command. It is not intended to be parsed."
17415 #: ../src/guestfs-actions.pod:6648
17416 msgid "See also: C<guestfs_part_list>"
17420 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4429
17422 "This function is deprecated. In new code, use the C<part_list> call "
17427 #: ../src/guestfs-actions.pod:6662
17432 #: ../src/guestfs-actions.pod:6664
17436 " guestfs_sh (guestfs_h *g,\n"
17437 " const char *command);\n"
17442 #: ../src/guestfs-actions.pod:6668 ../fish/guestfish-actions.pod:4440
17444 "This call runs a command from the guest filesystem via the guest's "
17449 #: ../src/guestfs-actions.pod:6671
17450 msgid "This is like C<guestfs_command>, but passes the command to:"
17454 #: ../src/guestfs-actions.pod:6673 ../fish/guestfish-actions.pod:4445
17457 " /bin/sh -c \"command\"\n"
17462 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:4447
17464 "Depending on the guest's shell, this usually results in wildcards being "
17465 "expanded, shell expressions being interpolated and so on."
17469 #: ../src/guestfs-actions.pod:6679
17470 msgid "All the provisos about C<guestfs_command> apply to this call."
17474 #: ../src/guestfs-actions.pod:6686
17475 msgid "guestfs_sh_lines"
17479 #: ../src/guestfs-actions.pod:6688
17483 " guestfs_sh_lines (guestfs_h *g,\n"
17484 " const char *command);\n"
17489 #: ../src/guestfs-actions.pod:6692
17491 "This is the same as C<guestfs_sh>, but splits the result into a list of "
17496 #: ../src/guestfs-actions.pod:6695
17497 msgid "See also: C<guestfs_command_lines>"
17501 #: ../src/guestfs-actions.pod:6703
17502 msgid "guestfs_sleep"
17506 #: ../src/guestfs-actions.pod:6705
17510 " guestfs_sleep (guestfs_h *g,\n"
17516 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4466
17517 msgid "Sleep for C<secs> seconds."
17521 #: ../src/guestfs-actions.pod:6713
17522 msgid "(Added in 1.0.41)"
17526 #: ../src/guestfs-actions.pod:6715 ../src/guestfs-structs.pod:109
17527 msgid "guestfs_stat"
17531 #: ../src/guestfs-actions.pod:6717
17534 " struct guestfs_stat *\n"
17535 " guestfs_stat (guestfs_h *g,\n"
17536 " const char *path);\n"
17541 #: ../src/guestfs-actions.pod:6723 ../fish/guestfish-actions.pod:4474
17542 msgid "This is the same as the C<stat(2)> system call."
17546 #: ../src/guestfs-actions.pod:6731 ../src/guestfs-structs.pod:135
17547 msgid "guestfs_statvfs"
17551 #: ../src/guestfs-actions.pod:6733
17554 " struct guestfs_statvfs *\n"
17555 " guestfs_statvfs (guestfs_h *g,\n"
17556 " const char *path);\n"
17561 #: ../src/guestfs-actions.pod:6737 ../fish/guestfish-actions.pod:4480
17563 "Returns file system statistics for any mounted file system. C<path> should "
17564 "be a file or directory in the mounted file system (typically it is the mount"
17565 " point itself, but it doesn't need to be)."
17569 #: ../src/guestfs-actions.pod:6741 ../fish/guestfish-actions.pod:4484
17570 msgid "This is the same as the C<statvfs(2)> system call."
17574 #: ../src/guestfs-actions.pod:6743
17576 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an"
17577 " error. I<The caller must call C<guestfs_free_statvfs> after use>."
17581 #: ../src/guestfs-actions.pod:6749
17582 msgid "guestfs_strings"
17586 #: ../src/guestfs-actions.pod:6751
17590 " guestfs_strings (guestfs_h *g,\n"
17591 " const char *path);\n"
17596 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4490
17598 "This runs the L<strings(1)> command on a file and returns the list of "
17599 "printable strings found."
17603 #: ../src/guestfs-actions.pod:6767
17604 msgid "guestfs_strings_e"
17608 #: ../src/guestfs-actions.pod:6769
17612 " guestfs_strings_e (guestfs_h *g,\n"
17613 " const char *encoding,\n"
17614 " const char *path);\n"
17619 #: ../src/guestfs-actions.pod:6774
17621 "This is like the C<guestfs_strings> command, but allows you to specify the "
17622 "encoding of strings that are looked for in the source file C<path>."
17626 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4504
17627 msgid "Allowed encodings are:"
17631 #: ../src/guestfs-actions.pod:6782 ../fish/guestfish-actions.pod:4508
17636 #: ../src/guestfs-actions.pod:6784
17638 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17639 "ISO-8859-X (this is what C<guestfs_strings> uses)."
17643 #: ../src/guestfs-actions.pod:6787 ../fish/guestfish-actions.pod:4513
17648 #: ../src/guestfs-actions.pod:6789 ../fish/guestfish-actions.pod:4515
17649 msgid "Single 8-bit-byte characters."
17653 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4517
17658 #: ../src/guestfs-actions.pod:6793 ../fish/guestfish-actions.pod:4519
17660 "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
17664 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4522
17665 msgid "l (lower case letter L)"
17669 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4524
17671 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
17672 "examining binaries in Windows guests."
17676 #: ../src/guestfs-actions.pod:6801 ../fish/guestfish-actions.pod:4527
17681 #: ../src/guestfs-actions.pod:6803 ../fish/guestfish-actions.pod:4529
17682 msgid "32-bit big endian such as UCS-4BE."
17686 #: ../src/guestfs-actions.pod:6805 ../fish/guestfish-actions.pod:4531
17691 #: ../src/guestfs-actions.pod:6807 ../fish/guestfish-actions.pod:4533
17692 msgid "32-bit little endian such as UCS-4LE."
17696 #: ../src/guestfs-actions.pod:6811 ../fish/guestfish-actions.pod:4537
17697 msgid "The returned strings are transcoded to UTF-8."
17701 #: ../src/guestfs-actions.pod:6822
17702 msgid "guestfs_swapoff_device"
17706 #: ../src/guestfs-actions.pod:6824
17710 " guestfs_swapoff_device (guestfs_h *g,\n"
17711 " const char *device);\n"
17716 #: ../src/guestfs-actions.pod:6828
17718 "This command disables the libguestfs appliance swap device or partition "
17719 "named C<device>. See C<guestfs_swapon_device>."
17723 #: ../src/guestfs-actions.pod:6836
17724 msgid "guestfs_swapoff_file"
17728 #: ../src/guestfs-actions.pod:6838
17732 " guestfs_swapoff_file (guestfs_h *g,\n"
17733 " const char *file);\n"
17738 #: ../src/guestfs-actions.pod:6842 ../fish/guestfish-actions.pod:4554
17739 msgid "This command disables the libguestfs appliance swap on file."
17743 #: ../src/guestfs-actions.pod:6848
17744 msgid "guestfs_swapoff_label"
17748 #: ../src/guestfs-actions.pod:6850
17752 " guestfs_swapoff_label (guestfs_h *g,\n"
17753 " const char *label);\n"
17758 #: ../src/guestfs-actions.pod:6854 ../fish/guestfish-actions.pod:4560
17760 "This command disables the libguestfs appliance swap on labeled swap "
17765 #: ../src/guestfs-actions.pod:6861
17766 msgid "guestfs_swapoff_uuid"
17770 #: ../src/guestfs-actions.pod:6863
17774 " guestfs_swapoff_uuid (guestfs_h *g,\n"
17775 " const char *uuid);\n"
17780 #: ../src/guestfs-actions.pod:6867 ../fish/guestfish-actions.pod:4567
17782 "This command disables the libguestfs appliance swap partition with the given"
17787 #: ../src/guestfs-actions.pod:6874
17788 msgid "guestfs_swapon_device"
17792 #: ../src/guestfs-actions.pod:6876
17796 " guestfs_swapon_device (guestfs_h *g,\n"
17797 " const char *device);\n"
17802 #: ../src/guestfs-actions.pod:6880
17804 "This command enables the libguestfs appliance to use the swap device or "
17805 "partition named C<device>. The increased memory is made available for all "
17806 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
17810 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4579
17812 "Note that you should not swap to existing guest swap partitions unless you "
17813 "know what you are doing. They may contain hibernation information, or other"
17814 " information that the guest doesn't want you to trash. You also risk "
17815 "leaking information about the host to the guest this way. Instead, attach a"
17816 " new host device to the guest and swap on that."
17820 #: ../src/guestfs-actions.pod:6896
17821 msgid "guestfs_swapon_file"
17825 #: ../src/guestfs-actions.pod:6898
17829 " guestfs_swapon_file (guestfs_h *g,\n"
17830 " const char *file);\n"
17835 #: ../src/guestfs-actions.pod:6902
17837 "This command enables swap to a file. See C<guestfs_swapon_device> for other"
17842 #: ../src/guestfs-actions.pod:6909
17843 msgid "guestfs_swapon_label"
17847 #: ../src/guestfs-actions.pod:6911
17851 " guestfs_swapon_label (guestfs_h *g,\n"
17852 " const char *label);\n"
17857 #: ../src/guestfs-actions.pod:6915
17859 "This command enables swap to a labeled swap partition. See "
17860 "C<guestfs_swapon_device> for other notes."
17864 #: ../src/guestfs-actions.pod:6922
17865 msgid "guestfs_swapon_uuid"
17869 #: ../src/guestfs-actions.pod:6924
17873 " guestfs_swapon_uuid (guestfs_h *g,\n"
17874 " const char *uuid);\n"
17879 #: ../src/guestfs-actions.pod:6928
17881 "This command enables swap to a swap partition with the given UUID. See "
17882 "C<guestfs_swapon_device> for other notes."
17886 #: ../src/guestfs-actions.pod:6935
17887 msgid "guestfs_sync"
17891 #: ../src/guestfs-actions.pod:6937
17895 " guestfs_sync (guestfs_h *g);\n"
17900 #: ../src/guestfs-actions.pod:6940 ../fish/guestfish-actions.pod:4611
17902 "This syncs the disk, so that any writes are flushed through to the "
17903 "underlying disk image."
17907 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4614
17909 "You should always call this if you have modified a disk image, before "
17910 "closing the handle."
17914 #: ../src/guestfs-actions.pod:6950
17915 msgid "guestfs_tail"
17919 #: ../src/guestfs-actions.pod:6952
17923 " guestfs_tail (guestfs_h *g,\n"
17924 " const char *path);\n"
17929 #: ../src/guestfs-actions.pod:6956 ../fish/guestfish-actions.pod:4621
17931 "This command returns up to the last 10 lines of a file as a list of strings."
17935 #: ../src/guestfs-actions.pod:6968
17936 msgid "guestfs_tail_n"
17940 #: ../src/guestfs-actions.pod:6970
17944 " guestfs_tail_n (guestfs_h *g,\n"
17946 " const char *path);\n"
17951 #: ../src/guestfs-actions.pod:6975 ../fish/guestfish-actions.pod:4631
17953 "If the parameter C<nrlines> is a positive number, this returns the last "
17954 "C<nrlines> lines of the file C<path>."
17958 #: ../src/guestfs-actions.pod:6978 ../fish/guestfish-actions.pod:4634
17960 "If the parameter C<nrlines> is a negative number, this returns lines from "
17961 "the file C<path>, starting with the C<-nrlines>th line."
17965 #: ../src/guestfs-actions.pod:6992
17966 msgid "guestfs_tar_in"
17970 #: ../src/guestfs-actions.pod:6994
17974 " guestfs_tar_in (guestfs_h *g,\n"
17975 " const char *tarfile,\n"
17976 " const char *directory);\n"
17981 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4646
17983 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
17984 "tar file) into C<directory>."
17988 #: ../src/guestfs-actions.pod:7002
17990 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
17994 #: ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7024
17995 #: ../src/guestfs-actions.pod:7040 ../src/guestfs-actions.pod:7056
17996 msgid "(Added in 1.0.3)"
18000 #: ../src/guestfs-actions.pod:7009
18001 msgid "guestfs_tar_out"
18005 #: ../src/guestfs-actions.pod:7011
18009 " guestfs_tar_out (guestfs_h *g,\n"
18010 " const char *directory,\n"
18011 " const char *tarfile);\n"
18016 #: ../src/guestfs-actions.pod:7016 ../fish/guestfish-actions.pod:4658
18018 "This command packs the contents of C<directory> and downloads it to local "
18023 #: ../src/guestfs-actions.pod:7019
18025 "To download a compressed tarball, use C<guestfs_tgz_out> or "
18026 "C<guestfs_txz_out>."
18030 #: ../src/guestfs-actions.pod:7026
18031 msgid "guestfs_tgz_in"
18035 #: ../src/guestfs-actions.pod:7028
18039 " guestfs_tgz_in (guestfs_h *g,\n"
18040 " const char *tarball,\n"
18041 " const char *directory);\n"
18046 #: ../src/guestfs-actions.pod:7033 ../fish/guestfish-actions.pod:4670
18048 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed>"
18049 " tar file) into C<directory>."
18053 #: ../src/guestfs-actions.pod:7036
18054 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
18058 #: ../src/guestfs-actions.pod:7042
18059 msgid "guestfs_tgz_out"
18063 #: ../src/guestfs-actions.pod:7044
18067 " guestfs_tgz_out (guestfs_h *g,\n"
18068 " const char *directory,\n"
18069 " const char *tarball);\n"
18074 #: ../src/guestfs-actions.pod:7049 ../fish/guestfish-actions.pod:4681
18076 "This command packs the contents of C<directory> and downloads it to local "
18081 #: ../src/guestfs-actions.pod:7052
18082 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
18086 #: ../src/guestfs-actions.pod:7058
18087 msgid "guestfs_touch"
18091 #: ../src/guestfs-actions.pod:7060
18095 " guestfs_touch (guestfs_h *g,\n"
18096 " const char *path);\n"
18101 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4692
18103 "Touch acts like the L<touch(1)> command. It can be used to update the "
18104 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18109 #: ../src/guestfs-actions.pod:7068 ../fish/guestfish-actions.pod:4696
18111 "This command only works on regular files, and will fail on other file types "
18112 "such as directories, symbolic links, block special etc."
18116 #: ../src/guestfs-actions.pod:7075
18117 msgid "guestfs_truncate"
18121 #: ../src/guestfs-actions.pod:7077
18125 " guestfs_truncate (guestfs_h *g,\n"
18126 " const char *path);\n"
18131 #: ../src/guestfs-actions.pod:7081 ../fish/guestfish-actions.pod:4703
18133 "This command truncates C<path> to a zero-length file. The file must exist "
18138 #: ../src/guestfs-actions.pod:7088
18139 msgid "guestfs_truncate_size"
18143 #: ../src/guestfs-actions.pod:7090
18147 " guestfs_truncate_size (guestfs_h *g,\n"
18148 " const char *path,\n"
18149 " int64_t size);\n"
18154 #: ../src/guestfs-actions.pod:7095 ../fish/guestfish-actions.pod:4710
18156 "This command truncates C<path> to size C<size> bytes. The file must exist "
18161 #: ../src/guestfs-actions.pod:7098
18163 "If the current file size is less than C<size> then the file is extended to "
18164 "the required size with zero bytes. This creates a sparse file (ie. disk "
18165 "blocks are not allocated for the file until you write to it). To create a "
18166 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
18170 #: ../src/guestfs-actions.pod:7108
18171 msgid "guestfs_tune2fs_l"
18175 #: ../src/guestfs-actions.pod:7110
18179 " guestfs_tune2fs_l (guestfs_h *g,\n"
18180 " const char *device);\n"
18185 #: ../src/guestfs-actions.pod:7114 ../fish/guestfish-actions.pod:4723
18187 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on"
18192 #: ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:4726
18194 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18195 "for more details. The list of fields returned isn't clearly defined, and "
18196 "depends on both the version of C<tune2fs> that libguestfs was built against,"
18197 " and the filesystem itself."
18201 #: ../src/guestfs-actions.pod:7130
18202 msgid "guestfs_txz_in"
18206 #: ../src/guestfs-actions.pod:7132
18210 " guestfs_txz_in (guestfs_h *g,\n"
18211 " const char *tarball,\n"
18212 " const char *directory);\n"
18217 #: ../src/guestfs-actions.pod:7137 ../fish/guestfish-actions.pod:4735
18219 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18220 "tar file) into C<directory>."
18224 #: ../src/guestfs-actions.pod:7144
18225 msgid "guestfs_txz_out"
18229 #: ../src/guestfs-actions.pod:7146
18233 " guestfs_txz_out (guestfs_h *g,\n"
18234 " const char *directory,\n"
18235 " const char *tarball);\n"
18240 #: ../src/guestfs-actions.pod:7151 ../fish/guestfish-actions.pod:4744
18242 "This command packs the contents of C<directory> and downloads it to local "
18243 "file C<tarball> (as an xz compressed tar archive)."
18247 #: ../src/guestfs-actions.pod:7158
18248 msgid "guestfs_umask"
18252 #: ../src/guestfs-actions.pod:7160
18256 " guestfs_umask (guestfs_h *g,\n"
18262 #: ../src/guestfs-actions.pod:7164 ../fish/guestfish-actions.pod:4753
18264 "This function sets the mask used for creating new files and device nodes to "
18269 #: ../src/guestfs-actions.pod:7167 ../fish/guestfish-actions.pod:4756
18271 "Typical umask values would be C<022> which creates new files with "
18272 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18273 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18277 #: ../src/guestfs-actions.pod:7172 ../fish/guestfish-actions.pod:4761
18279 "The default umask is C<022>. This is important because it means that "
18280 "directories and device nodes will be created with C<0644> or C<0755> mode "
18281 "even if you specify C<0777>."
18285 #: ../src/guestfs-actions.pod:7176
18287 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
18288 "C<guestfs_mkdir>."
18292 #: ../src/guestfs-actions.pod:7179 ../fish/guestfish-actions.pod:4768
18293 msgid "This call returns the previous umask."
18297 #: ../src/guestfs-actions.pod:7185
18298 msgid "guestfs_umount"
18302 #: ../src/guestfs-actions.pod:7187
18306 " guestfs_umount (guestfs_h *g,\n"
18307 " const char *pathordevice);\n"
18312 #: ../src/guestfs-actions.pod:7191 ../fish/guestfish-actions.pod:4776
18314 "This unmounts the given filesystem. The filesystem may be specified either "
18315 "by its mountpoint (path) or the device which contains the filesystem."
18319 #: ../src/guestfs-actions.pod:7199
18320 msgid "guestfs_umount_all"
18324 #: ../src/guestfs-actions.pod:7201
18328 " guestfs_umount_all (guestfs_h *g);\n"
18333 #: ../src/guestfs-actions.pod:7204 ../fish/guestfish-actions.pod:4786
18334 msgid "This unmounts all mounted filesystems."
18338 #: ../src/guestfs-actions.pod:7206 ../fish/guestfish-actions.pod:4788
18339 msgid "Some internal mounts are not unmounted by this call."
18343 #: ../src/guestfs-actions.pod:7212
18344 msgid "guestfs_upload"
18348 #: ../src/guestfs-actions.pod:7214
18352 " guestfs_upload (guestfs_h *g,\n"
18353 " const char *filename,\n"
18354 " const char *remotefilename);\n"
18359 #: ../src/guestfs-actions.pod:7219 ../src/guestfs-actions.pod:7243
18360 #: ../fish/guestfish-actions.pod:4794 ../fish/guestfish-actions.pod:4807
18361 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18365 #: ../src/guestfs-actions.pod:7224
18366 msgid "See also C<guestfs_download>."
18370 #: ../src/guestfs-actions.pod:7235
18371 msgid "guestfs_upload_offset"
18375 #: ../src/guestfs-actions.pod:7237
18379 " guestfs_upload_offset (guestfs_h *g,\n"
18380 " const char *filename,\n"
18381 " const char *remotefilename,\n"
18382 " int64_t offset);\n"
18387 #: ../src/guestfs-actions.pod:7246 ../fish/guestfish-actions.pod:4810
18389 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18390 "The intention is to overwrite parts of existing files or devices, although "
18391 "if a non-existant file is specified then it is created with a \"hole\" "
18392 "before C<offset>. The size of the data written is implicit in the size of "
18393 "the source C<filename>."
18397 #: ../src/guestfs-actions.pod:7253
18399 "Note that there is no limit on the amount of data that can be uploaded with "
18400 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
18401 "full amount unless an error occurs."
18405 #: ../src/guestfs-actions.pod:7258
18406 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
18410 #: ../src/guestfs-actions.pod:7269
18411 msgid "guestfs_utimens"
18415 #: ../src/guestfs-actions.pod:7271
18419 " guestfs_utimens (guestfs_h *g,\n"
18420 " const char *path,\n"
18421 " int64_t atsecs,\n"
18422 " int64_t atnsecs,\n"
18423 " int64_t mtsecs,\n"
18424 " int64_t mtnsecs);\n"
18429 #: ../src/guestfs-actions.pod:7279 ../fish/guestfish-actions.pod:4830
18430 msgid "This command sets the timestamps of a file with nanosecond precision."
18434 #: ../src/guestfs-actions.pod:7282 ../fish/guestfish-actions.pod:4833
18436 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18441 #: ../src/guestfs-actions.pod:7285 ../fish/guestfish-actions.pod:4836
18443 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18444 "nanoseconds from the epoch."
18448 #: ../src/guestfs-actions.pod:7288 ../fish/guestfish-actions.pod:4839
18450 "If the C<*nsecs> field contains the special value C<-1> then the "
18451 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18452 "ignored in this case)."
18456 #: ../src/guestfs-actions.pod:7292 ../fish/guestfish-actions.pod:4843
18458 "If the C<*nsecs> field contains the special value C<-2> then the "
18459 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18464 #: ../src/guestfs-actions.pod:7300 ../src/guestfs-structs.pod:175
18465 msgid "guestfs_version"
18469 #: ../src/guestfs-actions.pod:7302
18472 " struct guestfs_version *\n"
18473 " guestfs_version (guestfs_h *g);\n"
18478 #: ../src/guestfs-actions.pod:7305 ../fish/guestfish-actions.pod:4851
18480 "Return the libguestfs version number that the program is linked against."
18484 #: ../src/guestfs-actions.pod:7308 ../fish/guestfish-actions.pod:4854
18486 "Note that because of dynamic linking this is not necessarily the version of "
18487 "libguestfs that you compiled against. You can compile the program, and then"
18488 " at runtime dynamically link against a completely different C<libguestfs.so>"
18493 #: ../src/guestfs-actions.pod:7313 ../fish/guestfish-actions.pod:4859
18495 "This call was added in version C<1.0.58>. In previous versions of "
18496 "libguestfs there was no way to get the version number. From C code you can "
18497 "use dynamic linker functions to find out if this symbol exists (if it "
18498 "doesn't, then it's an earlier version)."
18502 #: ../src/guestfs-actions.pod:7319 ../fish/guestfish-actions.pod:4865
18504 "The call returns a structure with four elements. The first three (C<major>,"
18505 " C<minor> and C<release>) are numbers and correspond to the usual version "
18506 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
18507 "but may be used for distro-specific information."
18511 #: ../src/guestfs-actions.pod:7325 ../fish/guestfish-actions.pod:4871
18513 "To construct the original version string: C<$major.$minor.$release$extra>"
18517 #: ../src/guestfs-actions.pod:7328 ../fish/guestfish-actions.pod:4874
18518 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
18522 #: ../src/guestfs-actions.pod:7330
18524 "I<Note:> Don't use this call to test for availability of features. In "
18525 "enterprise distributions we backport features from later versions into "
18526 "earlier versions, making this an unreliable way to test for features. Use "
18527 "C<guestfs_available> instead."
18531 #: ../src/guestfs-actions.pod:7336
18533 "This function returns a C<struct guestfs_version *>, or NULL if there was an"
18534 " error. I<The caller must call C<guestfs_free_version> after use>."
18538 #: ../src/guestfs-actions.pod:7340
18539 msgid "(Added in 1.0.58)"
18543 #: ../src/guestfs-actions.pod:7342
18544 msgid "guestfs_vfs_label"
18548 #: ../src/guestfs-actions.pod:7344
18552 " guestfs_vfs_label (guestfs_h *g,\n"
18553 " const char *device);\n"
18558 #: ../src/guestfs-actions.pod:7348 ../fish/guestfish-actions.pod:4886
18559 msgid "This returns the filesystem label of the filesystem on C<device>."
18563 #: ../src/guestfs-actions.pod:7351 ../fish/guestfish-actions.pod:4889
18564 msgid "If the filesystem is unlabeled, this returns the empty string."
18568 #: ../src/guestfs-actions.pod:7353
18569 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
18573 #: ../src/guestfs-actions.pod:7358 ../src/guestfs-actions.pod:7395
18574 msgid "(Added in 1.3.18)"
18578 #: ../src/guestfs-actions.pod:7360
18579 msgid "guestfs_vfs_type"
18583 #: ../src/guestfs-actions.pod:7362
18587 " guestfs_vfs_type (guestfs_h *g,\n"
18588 " const char *device);\n"
18593 #: ../src/guestfs-actions.pod:7366 ../fish/guestfish-actions.pod:4897
18595 "This command gets the filesystem type corresponding to the filesystem on "
18600 #: ../src/guestfs-actions.pod:7369 ../fish/guestfish-actions.pod:4900
18602 "For most filesystems, the result is the name of the Linux VFS module which "
18603 "would be used to mount this filesystem if you mounted it without specifying "
18604 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
18608 #: ../src/guestfs-actions.pod:7379
18609 msgid "guestfs_vfs_uuid"
18613 #: ../src/guestfs-actions.pod:7381
18617 " guestfs_vfs_uuid (guestfs_h *g,\n"
18618 " const char *device);\n"
18623 #: ../src/guestfs-actions.pod:7385 ../fish/guestfish-actions.pod:4909
18624 msgid "This returns the filesystem UUID of the filesystem on C<device>."
18628 #: ../src/guestfs-actions.pod:7388 ../fish/guestfish-actions.pod:4912
18629 msgid "If the filesystem does not have a UUID, this returns the empty string."
18633 #: ../src/guestfs-actions.pod:7390
18634 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
18638 #: ../src/guestfs-actions.pod:7397
18639 msgid "guestfs_vg_activate"
18643 #: ../src/guestfs-actions.pod:7399
18647 " guestfs_vg_activate (guestfs_h *g,\n"
18649 " char *const *volgroups);\n"
18654 #: ../src/guestfs-actions.pod:7404 ../fish/guestfish-actions.pod:4920
18656 "This command activates or (if C<activate> is false) deactivates all logical "
18657 "volumes in the listed volume groups C<volgroups>."
18661 #: ../src/guestfs-actions.pod:7407 ../fish/guestfish-actions.pod:4923
18662 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
18666 #: ../src/guestfs-actions.pod:7409 ../fish/guestfish-actions.pod:4925
18668 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
18669 "activated or deactivated."
18673 #: ../src/guestfs-actions.pod:7416
18674 msgid "guestfs_vg_activate_all"
18678 #: ../src/guestfs-actions.pod:7418
18682 " guestfs_vg_activate_all (guestfs_h *g,\n"
18683 " int activate);\n"
18688 #: ../src/guestfs-actions.pod:7422 ../fish/guestfish-actions.pod:4932
18690 "This command activates or (if C<activate> is false) deactivates all logical "
18691 "volumes in all volume groups."
18695 #: ../src/guestfs-actions.pod:7425 ../fish/guestfish-actions.pod:4935
18696 msgid "This command is the same as running C<vgchange -a y|n>"
18700 #: ../src/guestfs-actions.pod:7431
18701 msgid "guestfs_vgcreate"
18705 #: ../src/guestfs-actions.pod:7433
18709 " guestfs_vgcreate (guestfs_h *g,\n"
18710 " const char *volgroup,\n"
18711 " char *const *physvols);\n"
18716 #: ../src/guestfs-actions.pod:7438 ../fish/guestfish-actions.pod:4941
18718 "This creates an LVM volume group called C<volgroup> from the non-empty list "
18719 "of physical volumes C<physvols>."
18723 #: ../src/guestfs-actions.pod:7445
18724 msgid "guestfs_vglvuuids"
18728 #: ../src/guestfs-actions.pod:7447
18732 " guestfs_vglvuuids (guestfs_h *g,\n"
18733 " const char *vgname);\n"
18738 #: ../src/guestfs-actions.pod:7451 ../fish/guestfish-actions.pod:4948
18740 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
18741 "volumes created in this volume group."
18745 #: ../src/guestfs-actions.pod:7454
18747 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
18748 "associate logical volumes and volume groups."
18752 #: ../src/guestfs-actions.pod:7457
18753 msgid "See also C<guestfs_vgpvuuids>."
18757 #: ../src/guestfs-actions.pod:7465
18758 msgid "guestfs_vgpvuuids"
18762 #: ../src/guestfs-actions.pod:7467
18766 " guestfs_vgpvuuids (guestfs_h *g,\n"
18767 " const char *vgname);\n"
18772 #: ../src/guestfs-actions.pod:7471 ../fish/guestfish-actions.pod:4960
18774 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
18775 "volumes that this volume group resides on."
18779 #: ../src/guestfs-actions.pod:7474
18781 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
18782 "associate physical volumes and volume groups."
18786 #: ../src/guestfs-actions.pod:7477
18787 msgid "See also C<guestfs_vglvuuids>."
18791 #: ../src/guestfs-actions.pod:7485
18792 msgid "guestfs_vgremove"
18796 #: ../src/guestfs-actions.pod:7487
18800 " guestfs_vgremove (guestfs_h *g,\n"
18801 " const char *vgname);\n"
18806 #: ../src/guestfs-actions.pod:7491 ../fish/guestfish-actions.pod:4972
18807 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
18811 #: ../src/guestfs-actions.pod:7493 ../fish/guestfish-actions.pod:4974
18813 "This also forcibly removes all logical volumes in the volume group (if any)."
18817 #: ../src/guestfs-actions.pod:7500
18818 msgid "guestfs_vgrename"
18822 #: ../src/guestfs-actions.pod:7502
18826 " guestfs_vgrename (guestfs_h *g,\n"
18827 " const char *volgroup,\n"
18828 " const char *newvolgroup);\n"
18833 #: ../src/guestfs-actions.pod:7507 ../fish/guestfish-actions.pod:4981
18834 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
18838 #: ../src/guestfs-actions.pod:7513
18839 msgid "guestfs_vgs"
18843 #: ../src/guestfs-actions.pod:7515
18847 " guestfs_vgs (guestfs_h *g);\n"
18852 #: ../src/guestfs-actions.pod:7518 ../fish/guestfish-actions.pod:4987
18854 "List all the volumes groups detected. This is the equivalent of the "
18855 "L<vgs(8)> command."
18859 #: ../src/guestfs-actions.pod:7521 ../fish/guestfish-actions.pod:4990
18861 "This returns a list of just the volume group names that were detected (eg. "
18866 #: ../src/guestfs-actions.pod:7524
18867 msgid "See also C<guestfs_vgs_full>."
18871 #: ../src/guestfs-actions.pod:7532
18872 msgid "guestfs_vgs_full"
18876 #: ../src/guestfs-actions.pod:7534
18879 " struct guestfs_lvm_vg_list *\n"
18880 " guestfs_vgs_full (guestfs_h *g);\n"
18885 #: ../src/guestfs-actions.pod:7537 ../fish/guestfish-actions.pod:4999
18887 "List all the volumes groups detected. This is the equivalent of the "
18888 "L<vgs(8)> command. The \"full\" version includes all fields."
18892 #: ../src/guestfs-actions.pod:7540
18894 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
18895 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
18900 #: ../src/guestfs-actions.pod:7546
18901 msgid "guestfs_vgscan"
18905 #: ../src/guestfs-actions.pod:7548
18909 " guestfs_vgscan (guestfs_h *g);\n"
18914 #: ../src/guestfs-actions.pod:7551 ../fish/guestfish-actions.pod:5006
18916 "This rescans all block devices and rebuilds the list of LVM physical "
18917 "volumes, volume groups and logical volumes."
18921 #: ../src/guestfs-actions.pod:7558
18922 msgid "guestfs_vguuid"
18926 #: ../src/guestfs-actions.pod:7560
18930 " guestfs_vguuid (guestfs_h *g,\n"
18931 " const char *vgname);\n"
18936 #: ../src/guestfs-actions.pod:7564 ../fish/guestfish-actions.pod:5013
18937 msgid "This command returns the UUID of the LVM VG named C<vgname>."
18941 #: ../src/guestfs-actions.pod:7571
18942 msgid "guestfs_wait_ready"
18946 #: ../src/guestfs-actions.pod:7573
18950 " guestfs_wait_ready (guestfs_h *g);\n"
18955 #: ../src/guestfs-actions.pod:7576
18956 msgid "This function is a no op."
18960 #: ../src/guestfs-actions.pod:7578
18962 "In versions of the API E<lt> 1.0.71 you had to call this function just after"
18963 " calling C<guestfs_launch> to wait for the launch to complete. However this"
18964 " is no longer necessary because C<guestfs_launch> now does the waiting."
18968 #: ../src/guestfs-actions.pod:7583
18970 "If you see any calls to this function in code then you can just remove them,"
18971 " unless you want to retain compatibility with older versions of the API."
18975 #: ../src/guestfs-actions.pod:7589
18977 "This function is deprecated. In new code, use the C<launch> call instead."
18981 #: ../src/guestfs-actions.pod:7598
18982 msgid "guestfs_wc_c"
18986 #: ../src/guestfs-actions.pod:7600
18990 " guestfs_wc_c (guestfs_h *g,\n"
18991 " const char *path);\n"
18996 #: ../src/guestfs-actions.pod:7604 ../fish/guestfish-actions.pod:5019
18998 "This command counts the characters in a file, using the C<wc -c> external "
19003 #: ../src/guestfs-actions.pod:7611
19004 msgid "guestfs_wc_l"
19008 #: ../src/guestfs-actions.pod:7613
19012 " guestfs_wc_l (guestfs_h *g,\n"
19013 " const char *path);\n"
19018 #: ../src/guestfs-actions.pod:7617 ../fish/guestfish-actions.pod:5026
19020 "This command counts the lines in a file, using the C<wc -l> external "
19025 #: ../src/guestfs-actions.pod:7624
19026 msgid "guestfs_wc_w"
19030 #: ../src/guestfs-actions.pod:7626
19034 " guestfs_wc_w (guestfs_h *g,\n"
19035 " const char *path);\n"
19040 #: ../src/guestfs-actions.pod:7630 ../fish/guestfish-actions.pod:5033
19042 "This command counts the words in a file, using the C<wc -w> external "
19047 #: ../src/guestfs-actions.pod:7637
19048 msgid "guestfs_write"
19052 #: ../src/guestfs-actions.pod:7639
19056 " guestfs_write (guestfs_h *g,\n"
19057 " const char *path,\n"
19058 " const char *content,\n"
19059 " size_t content_size);\n"
19064 #: ../src/guestfs-actions.pod:7645 ../fish/guestfish-actions.pod:5040
19066 "This call creates a file called C<path>. The content of the file is the "
19067 "string C<content> (which can contain any 8 bit data)."
19071 #: ../src/guestfs-actions.pod:7648
19072 msgid "See also C<guestfs_write_append>."
19076 #: ../src/guestfs-actions.pod:7657
19077 msgid "guestfs_write_append"
19081 #: ../src/guestfs-actions.pod:7659
19085 " guestfs_write_append (guestfs_h *g,\n"
19086 " const char *path,\n"
19087 " const char *content,\n"
19088 " size_t content_size);\n"
19093 #: ../src/guestfs-actions.pod:7665 ../fish/guestfish-actions.pod:5052
19095 "This call appends C<content> to the end of file C<path>. If C<path> does "
19096 "not exist, then a new file is created."
19100 #: ../src/guestfs-actions.pod:7668
19101 msgid "See also C<guestfs_write>."
19105 #: ../src/guestfs-actions.pod:7675
19106 msgid "guestfs_write_file"
19110 #: ../src/guestfs-actions.pod:7677
19114 " guestfs_write_file (guestfs_h *g,\n"
19115 " const char *path,\n"
19116 " const char *content,\n"
19122 #: ../src/guestfs-actions.pod:7683 ../fish/guestfish-actions.pod:5064
19124 "This call creates a file called C<path>. The contents of the file is the "
19125 "string C<content> (which can contain any 8 bit data), with length C<size>."
19129 #: ../src/guestfs-actions.pod:7687 ../fish/guestfish-actions.pod:5068
19131 "As a special case, if C<size> is C<0> then the length is calculated using "
19132 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19136 #: ../src/guestfs-actions.pod:7691 ../fish/guestfish-actions.pod:5072
19138 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19139 "I<not> work, even if the length is specified."
19143 #: ../src/guestfs-actions.pod:7699 ../fish/guestfish-actions.pod:5078
19145 "This function is deprecated. In new code, use the C<write> call instead."
19149 #: ../src/guestfs-actions.pod:7708
19150 msgid "guestfs_zegrep"
19154 #: ../src/guestfs-actions.pod:7710
19158 " guestfs_zegrep (guestfs_h *g,\n"
19159 " const char *regex,\n"
19160 " const char *path);\n"
19165 #: ../src/guestfs-actions.pod:7715 ../fish/guestfish-actions.pod:5089
19167 "This calls the external C<zegrep> program and returns the matching lines."
19171 #: ../src/guestfs-actions.pod:7727
19172 msgid "guestfs_zegrepi"
19176 #: ../src/guestfs-actions.pod:7729
19180 " guestfs_zegrepi (guestfs_h *g,\n"
19181 " const char *regex,\n"
19182 " const char *path);\n"
19187 #: ../src/guestfs-actions.pod:7734 ../fish/guestfish-actions.pod:5099
19189 "This calls the external C<zegrep -i> program and returns the matching lines."
19193 #: ../src/guestfs-actions.pod:7746
19194 msgid "guestfs_zero"
19198 #: ../src/guestfs-actions.pod:7748
19202 " guestfs_zero (guestfs_h *g,\n"
19203 " const char *device);\n"
19208 #: ../src/guestfs-actions.pod:7752 ../fish/guestfish-actions.pod:5109
19209 msgid "This command writes zeroes over the first few blocks of C<device>."
19213 #: ../src/guestfs-actions.pod:7754 ../fish/guestfish-actions.pod:5111
19215 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19216 "securely wipe the device). It should be sufficient to remove any partition "
19217 "tables, filesystem superblocks and so on."
19221 #: ../src/guestfs-actions.pod:7758
19223 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
19224 "C<guestfs_is_zero_device>"
19228 #: ../src/guestfs-actions.pod:7770
19229 msgid "guestfs_zero_device"
19233 #: ../src/guestfs-actions.pod:7772
19237 " guestfs_zero_device (guestfs_h *g,\n"
19238 " const char *device);\n"
19243 #: ../src/guestfs-actions.pod:7776
19245 "This command writes zeroes over the entire C<device>. Compare with "
19246 "C<guestfs_zero> which just zeroes the first few blocks of a device."
19250 #: ../src/guestfs-actions.pod:7790
19251 msgid "(Added in 1.3.1)"
19255 #: ../src/guestfs-actions.pod:7792
19256 msgid "guestfs_zerofree"
19260 #: ../src/guestfs-actions.pod:7794
19264 " guestfs_zerofree (guestfs_h *g,\n"
19265 " const char *device);\n"
19270 #: ../src/guestfs-actions.pod:7798 ../fish/guestfish-actions.pod:5133
19272 "This runs the I<zerofree> program on C<device>. This program claims to zero"
19273 " unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19274 "possible to compress the filesystem more effectively."
19278 #: ../src/guestfs-actions.pod:7803 ../fish/guestfish-actions.pod:5138
19279 msgid "You should B<not> run this program if the filesystem is mounted."
19283 #: ../src/guestfs-actions.pod:7806 ../fish/guestfish-actions.pod:5141
19285 "It is possible that using this program can damage the filesystem or data on "
19290 #: ../src/guestfs-actions.pod:7813
19291 msgid "guestfs_zfgrep"
19295 #: ../src/guestfs-actions.pod:7815
19299 " guestfs_zfgrep (guestfs_h *g,\n"
19300 " const char *pattern,\n"
19301 " const char *path);\n"
19306 #: ../src/guestfs-actions.pod:7820 ../fish/guestfish-actions.pod:5148
19308 "This calls the external C<zfgrep> program and returns the matching lines."
19312 #: ../src/guestfs-actions.pod:7832
19313 msgid "guestfs_zfgrepi"
19317 #: ../src/guestfs-actions.pod:7834
19321 " guestfs_zfgrepi (guestfs_h *g,\n"
19322 " const char *pattern,\n"
19323 " const char *path);\n"
19328 #: ../src/guestfs-actions.pod:7839 ../fish/guestfish-actions.pod:5158
19330 "This calls the external C<zfgrep -i> program and returns the matching lines."
19334 #: ../src/guestfs-actions.pod:7851
19335 msgid "guestfs_zfile"
19339 #: ../src/guestfs-actions.pod:7853
19343 " guestfs_zfile (guestfs_h *g,\n"
19344 " const char *meth,\n"
19345 " const char *path);\n"
19350 #: ../src/guestfs-actions.pod:7858 ../fish/guestfish-actions.pod:5168
19352 "This command runs C<file> after first decompressing C<path> using C<method>."
19356 #: ../src/guestfs-actions.pod:7861 ../fish/guestfish-actions.pod:5171
19357 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19361 #: ../src/guestfs-actions.pod:7863
19363 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
19368 #: ../src/guestfs-actions.pod:7869 ../fish/guestfish-actions.pod:5176
19370 "This function is deprecated. In new code, use the C<file> call instead."
19374 #: ../src/guestfs-actions.pod:7878
19375 msgid "guestfs_zgrep"
19379 #: ../src/guestfs-actions.pod:7880
19383 " guestfs_zgrep (guestfs_h *g,\n"
19384 " const char *regex,\n"
19385 " const char *path);\n"
19390 #: ../src/guestfs-actions.pod:7885 ../fish/guestfish-actions.pod:5187
19392 "This calls the external C<zgrep> program and returns the matching lines."
19396 #: ../src/guestfs-actions.pod:7897
19397 msgid "guestfs_zgrepi"
19401 #: ../src/guestfs-actions.pod:7899
19405 " guestfs_zgrepi (guestfs_h *g,\n"
19406 " const char *regex,\n"
19407 " const char *path);\n"
19412 #: ../src/guestfs-actions.pod:7904 ../fish/guestfish-actions.pod:5197
19414 "This calls the external C<zgrep -i> program and returns the matching lines."
19418 #: ../src/guestfs-availability.pod:3
19423 #: ../src/guestfs-availability.pod:5
19425 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
19426 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
19427 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
19428 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
19429 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
19433 #: ../src/guestfs-availability.pod:21
19438 #: ../src/guestfs-availability.pod:23
19439 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
19443 #: ../src/guestfs-availability.pod:26
19448 #: ../src/guestfs-availability.pod:28
19450 "The following functions: L</guestfs_inotify_add_watch> "
19451 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init>"
19452 " L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
19456 #: ../src/guestfs-availability.pod:36
19457 msgid "B<linuxfsuuid>"
19461 #: ../src/guestfs-availability.pod:38
19463 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
19464 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
19468 #: ../src/guestfs-availability.pod:45
19469 msgid "B<linuxmodules>"
19473 #: ../src/guestfs-availability.pod:47
19474 msgid "The following functions: L</guestfs_modprobe>"
19478 #: ../src/guestfs-availability.pod:50
19479 msgid "B<linuxxattrs>"
19483 #: ../src/guestfs-availability.pod:52
19485 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
19486 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
19487 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
19488 "L</guestfs_setxattr>"
19492 #: ../src/guestfs-availability.pod:63
19497 #: ../src/guestfs-availability.pod:65
19499 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
19500 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
19501 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
19505 #: ../src/guestfs-availability.pod:74
19510 #: ../src/guestfs-availability.pod:76
19512 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
19513 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
19514 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
19515 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
19516 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
19517 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
19518 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
19519 "L</guestfs_vgs_full>"
19523 #: ../src/guestfs-availability.pod:99
19528 #: ../src/guestfs-availability.pod:101
19530 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
19531 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
19535 #: ../src/guestfs-availability.pod:107
19540 #: ../src/guestfs-availability.pod:109
19541 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
19545 #: ../src/guestfs-availability.pod:112
19546 msgid "B<ntfsprogs>"
19550 #: ../src/guestfs-availability.pod:114
19552 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
19553 "L</guestfs_ntfsresize_size>"
19557 #: ../src/guestfs-availability.pod:119
19558 msgid "B<realpath>"
19562 #: ../src/guestfs-availability.pod:121
19563 msgid "The following functions: L</guestfs_realpath>"
19567 #: ../src/guestfs-availability.pod:124
19572 #: ../src/guestfs-availability.pod:126
19574 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
19575 "L</guestfs_scrub_freespace>"
19579 #: ../src/guestfs-availability.pod:131
19584 #: ../src/guestfs-availability.pod:133
19585 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
19589 #: ../src/guestfs-availability.pod:137
19594 #: ../src/guestfs-availability.pod:139
19595 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
19599 #: ../src/guestfs-availability.pod:143
19600 msgid "B<zerofree>"
19604 #: ../src/guestfs-availability.pod:145
19605 msgid "The following functions: L</guestfs_zerofree>"
19609 #: ../src/guestfs-structs.pod:1
19610 msgid "guestfs_int_bool"
19614 #: ../src/guestfs-structs.pod:3
19617 " struct guestfs_int_bool {\n"
19625 #: ../src/guestfs-structs.pod:8
19628 " struct guestfs_int_bool_list {\n"
19629 " uint32_t len; /* Number of elements in list. */\n"
19630 " struct guestfs_int_bool *val; /* Elements. */\n"
19636 #: ../src/guestfs-structs.pod:13
19639 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
19640 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
19645 #: ../src/guestfs-structs.pod:16
19646 msgid "guestfs_lvm_pv"
19650 #: ../src/guestfs-structs.pod:18
19653 " struct guestfs_lvm_pv {\n"
19654 " char *pv_name;\n"
19655 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19656 " char pv_uuid[32];\n"
19658 " uint64_t pv_size;\n"
19659 " uint64_t dev_size;\n"
19660 " uint64_t pv_free;\n"
19661 " uint64_t pv_used;\n"
19662 " char *pv_attr;\n"
19663 " int64_t pv_pe_count;\n"
19664 " int64_t pv_pe_alloc_count;\n"
19665 " char *pv_tags;\n"
19666 " uint64_t pe_start;\n"
19667 " int64_t pv_mda_count;\n"
19668 " uint64_t pv_mda_free;\n"
19674 #: ../src/guestfs-structs.pod:36
19677 " struct guestfs_lvm_pv_list {\n"
19678 " uint32_t len; /* Number of elements in list. */\n"
19679 " struct guestfs_lvm_pv *val; /* Elements. */\n"
19685 #: ../src/guestfs-structs.pod:41
19688 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
19689 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
19694 #: ../src/guestfs-structs.pod:44
19695 msgid "guestfs_lvm_vg"
19699 #: ../src/guestfs-structs.pod:46
19702 " struct guestfs_lvm_vg {\n"
19703 " char *vg_name;\n"
19704 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19705 " char vg_uuid[32];\n"
19707 " char *vg_attr;\n"
19708 " uint64_t vg_size;\n"
19709 " uint64_t vg_free;\n"
19710 " char *vg_sysid;\n"
19711 " uint64_t vg_extent_size;\n"
19712 " int64_t vg_extent_count;\n"
19713 " int64_t vg_free_count;\n"
19714 " int64_t max_lv;\n"
19715 " int64_t max_pv;\n"
19716 " int64_t pv_count;\n"
19717 " int64_t lv_count;\n"
19718 " int64_t snap_count;\n"
19719 " int64_t vg_seqno;\n"
19720 " char *vg_tags;\n"
19721 " int64_t vg_mda_count;\n"
19722 " uint64_t vg_mda_free;\n"
19728 #: ../src/guestfs-structs.pod:69
19731 " struct guestfs_lvm_vg_list {\n"
19732 " uint32_t len; /* Number of elements in list. */\n"
19733 " struct guestfs_lvm_vg *val; /* Elements. */\n"
19739 #: ../src/guestfs-structs.pod:74
19742 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
19743 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
19748 #: ../src/guestfs-structs.pod:77
19749 msgid "guestfs_lvm_lv"
19753 #: ../src/guestfs-structs.pod:79
19756 " struct guestfs_lvm_lv {\n"
19757 " char *lv_name;\n"
19758 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
19759 " char lv_uuid[32];\n"
19760 " char *lv_attr;\n"
19761 " int64_t lv_major;\n"
19762 " int64_t lv_minor;\n"
19763 " int64_t lv_kernel_major;\n"
19764 " int64_t lv_kernel_minor;\n"
19765 " uint64_t lv_size;\n"
19766 " int64_t seg_count;\n"
19768 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19769 " float snap_percent;\n"
19770 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
19771 " float copy_percent;\n"
19772 " char *move_pv;\n"
19773 " char *lv_tags;\n"
19774 " char *mirror_log;\n"
19775 " char *modules;\n"
19781 #: ../src/guestfs-structs.pod:101
19784 " struct guestfs_lvm_lv_list {\n"
19785 " uint32_t len; /* Number of elements in list. */\n"
19786 " struct guestfs_lvm_lv *val; /* Elements. */\n"
19792 #: ../src/guestfs-structs.pod:106
19795 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
19796 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
19801 #: ../src/guestfs-structs.pod:111
19804 " struct guestfs_stat {\n"
19808 " int64_t nlink;\n"
19813 " int64_t blksize;\n"
19814 " int64_t blocks;\n"
19815 " int64_t atime;\n"
19816 " int64_t mtime;\n"
19817 " int64_t ctime;\n"
19823 #: ../src/guestfs-structs.pod:127
19826 " struct guestfs_stat_list {\n"
19827 " uint32_t len; /* Number of elements in list. */\n"
19828 " struct guestfs_stat *val; /* Elements. */\n"
19834 #: ../src/guestfs-structs.pod:132
19837 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
19838 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
19843 #: ../src/guestfs-structs.pod:137
19846 " struct guestfs_statvfs {\n"
19847 " int64_t bsize;\n"
19848 " int64_t frsize;\n"
19849 " int64_t blocks;\n"
19850 " int64_t bfree;\n"
19851 " int64_t bavail;\n"
19852 " int64_t files;\n"
19853 " int64_t ffree;\n"
19854 " int64_t favail;\n"
19857 " int64_t namemax;\n"
19863 #: ../src/guestfs-structs.pod:151
19866 " struct guestfs_statvfs_list {\n"
19867 " uint32_t len; /* Number of elements in list. */\n"
19868 " struct guestfs_statvfs *val; /* Elements. */\n"
19874 #: ../src/guestfs-structs.pod:156
19877 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
19878 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
19883 #: ../src/guestfs-structs.pod:159
19884 msgid "guestfs_dirent"
19888 #: ../src/guestfs-structs.pod:161
19891 " struct guestfs_dirent {\n"
19900 #: ../src/guestfs-structs.pod:167
19903 " struct guestfs_dirent_list {\n"
19904 " uint32_t len; /* Number of elements in list. */\n"
19905 " struct guestfs_dirent *val; /* Elements. */\n"
19911 #: ../src/guestfs-structs.pod:172
19914 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
19915 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
19920 #: ../src/guestfs-structs.pod:177
19923 " struct guestfs_version {\n"
19924 " int64_t major;\n"
19925 " int64_t minor;\n"
19926 " int64_t release;\n"
19933 #: ../src/guestfs-structs.pod:184
19936 " struct guestfs_version_list {\n"
19937 " uint32_t len; /* Number of elements in list. */\n"
19938 " struct guestfs_version *val; /* Elements. */\n"
19944 #: ../src/guestfs-structs.pod:189
19947 " void guestfs_free_version (struct guestfs_free_version *);\n"
19948 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
19953 #: ../src/guestfs-structs.pod:192
19954 msgid "guestfs_xattr"
19958 #: ../src/guestfs-structs.pod:194
19961 " struct guestfs_xattr {\n"
19962 " char *attrname;\n"
19963 " /* The next two fields describe a byte array. */\n"
19964 " uint32_t attrval_len;\n"
19965 " char *attrval;\n"
19971 #: ../src/guestfs-structs.pod:201
19974 " struct guestfs_xattr_list {\n"
19975 " uint32_t len; /* Number of elements in list. */\n"
19976 " struct guestfs_xattr *val; /* Elements. */\n"
19982 #: ../src/guestfs-structs.pod:206
19985 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
19986 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
19991 #: ../src/guestfs-structs.pod:209
19992 msgid "guestfs_inotify_event"
19996 #: ../src/guestfs-structs.pod:211
19999 " struct guestfs_inotify_event {\n"
20000 " int64_t in_wd;\n"
20001 " uint32_t in_mask;\n"
20002 " uint32_t in_cookie;\n"
20003 " char *in_name;\n"
20009 #: ../src/guestfs-structs.pod:218
20012 " struct guestfs_inotify_event_list {\n"
20013 " uint32_t len; /* Number of elements in list. */\n"
20014 " struct guestfs_inotify_event *val; /* Elements. */\n"
20020 #: ../src/guestfs-structs.pod:223
20023 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
20024 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
20029 #: ../src/guestfs-structs.pod:226
20030 msgid "guestfs_partition"
20034 #: ../src/guestfs-structs.pod:228
20037 " struct guestfs_partition {\n"
20038 " int32_t part_num;\n"
20039 " uint64_t part_start;\n"
20040 " uint64_t part_end;\n"
20041 " uint64_t part_size;\n"
20047 #: ../src/guestfs-structs.pod:235
20050 " struct guestfs_partition_list {\n"
20051 " uint32_t len; /* Number of elements in list. */\n"
20052 " struct guestfs_partition *val; /* Elements. */\n"
20058 #: ../src/guestfs-structs.pod:240
20061 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
20062 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
20067 #: ../src/guestfs-structs.pod:243
20068 msgid "guestfs_application"
20072 #: ../src/guestfs-structs.pod:245
20075 " struct guestfs_application {\n"
20076 " char *app_name;\n"
20077 " char *app_display_name;\n"
20078 " int32_t app_epoch;\n"
20079 " char *app_version;\n"
20080 " char *app_release;\n"
20081 " char *app_install_path;\n"
20082 " char *app_trans_path;\n"
20083 " char *app_publisher;\n"
20084 " char *app_url;\n"
20085 " char *app_source_package;\n"
20086 " char *app_summary;\n"
20087 " char *app_description;\n"
20093 #: ../src/guestfs-structs.pod:260
20096 " struct guestfs_application_list {\n"
20097 " uint32_t len; /* Number of elements in list. */\n"
20098 " struct guestfs_application *val; /* Elements. */\n"
20104 #: ../src/guestfs-structs.pod:265
20107 " void guestfs_free_application (struct guestfs_free_application *);\n"
20108 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
20113 #: ../fish/guestfish.pod:5
20114 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20118 #: ../fish/guestfish.pod:9
20121 " guestfish [--options] [commands]\n"
20126 #: ../fish/guestfish.pod:11
20134 #: ../fish/guestfish.pod:13
20137 " guestfish [--ro|--rw] -a disk.img\n"
20142 #: ../fish/guestfish.pod:15
20145 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20150 #: ../fish/guestfish.pod:17
20153 " guestfish -d libvirt-domain\n"
20158 #: ../fish/guestfish.pod:19
20161 " guestfish [--ro|--rw] -a disk.img -i\n"
20166 #: ../fish/guestfish.pod:21
20169 " guestfish -d libvirt-domain -i\n"
20174 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15
20175 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:64
20180 #: ../fish/guestfish.pod:25
20182 "Using guestfish in read/write mode on live virtual machines can be "
20183 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only)"
20184 " option to use guestfish safely if the disk image or virtual machine might "
20189 #: ../fish/guestfish.pod:32
20191 "Guestfish is a shell and command-line tool for examining and modifying "
20192 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20193 "functionality of the guestfs API, see L<guestfs(3)>."
20197 #: ../fish/guestfish.pod:36
20199 "Guestfish gives you structured access to the libguestfs API, from shell "
20200 "scripts or the command line or interactively. If you want to rescue a "
20201 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20206 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:1007
20207 #: ../fuse/guestmount.pod:39 ../tools/virt-tar.pl:50
20212 #: ../fish/guestfish.pod:43
20213 msgid "As an interactive shell"
20217 #: ../fish/guestfish.pod:45
20225 #: ../fish/guestfish.pod:47
20228 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20229 " editing virtual machine filesystems.\n"
20234 #: ../fish/guestfish.pod:50
20237 " Type: 'help' for a list of commands\n"
20238 " 'man' to read the manual\n"
20239 " 'quit' to quit the shell\n"
20244 #: ../fish/guestfish.pod:54
20247 " ><fs> add-ro disk.img\n"
20249 " ><fs> list-filesystems\n"
20250 " /dev/sda1: ext4\n"
20251 " /dev/vg_guest/lv_root: ext4\n"
20252 " /dev/vg_guest/lv_swap: swap\n"
20253 " ><fs> mount /dev/vg_guest/lv_root /\n"
20254 " ><fs> cat /etc/fstab\n"
20256 " # Created by anaconda\n"
20263 #: ../fish/guestfish.pod:67
20264 msgid "From shell scripts"
20268 #: ../fish/guestfish.pod:69
20269 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20273 #: ../fish/guestfish.pod:71
20276 " guestfish <<_EOF_\n"
20279 " mount /dev/vg_guest/lv_root /\n"
20280 " write /etc/motd \"Welcome, new users\"\n"
20286 #: ../fish/guestfish.pod:78
20287 msgid "List the LVM logical volumes in a disk image:"
20291 #: ../fish/guestfish.pod:80
20294 " guestfish -a disk.img --ro <<_EOF_\n"
20302 #: ../fish/guestfish.pod:85
20303 msgid "List all the filesystems in a disk image:"
20307 #: ../fish/guestfish.pod:87
20310 " guestfish -a disk.img --ro <<_EOF_\n"
20312 " list-filesystems\n"
20318 #: ../fish/guestfish.pod:92
20319 msgid "On one command line"
20323 #: ../fish/guestfish.pod:94
20324 msgid "Update C</etc/resolv.conf> in a guest:"
20328 #: ../fish/guestfish.pod:96
20332 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20333 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20338 #: ../fish/guestfish.pod:100
20339 msgid "Edit C</boot/grub/grub.conf> interactively:"
20343 #: ../fish/guestfish.pod:102
20346 " guestfish --rw --add disk.img \\\n"
20347 " --mount /dev/vg_guest/lv_root \\\n"
20348 " --mount /dev/sda1:/boot \\\n"
20349 " edit /boot/grub/grub.conf\n"
20354 #: ../fish/guestfish.pod:107
20355 msgid "Mount disks automatically"
20359 #: ../fish/guestfish.pod:109
20361 "Use the I<-i> option to automatically mount the disks from a virtual "
20366 #: ../fish/guestfish.pod:112
20369 " guestfish --ro -a disk.img -i cat /etc/group\n"
20374 #: ../fish/guestfish.pod:114
20377 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20382 #: ../fish/guestfish.pod:116
20383 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20387 #: ../fish/guestfish.pod:118
20390 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20395 #: ../fish/guestfish.pod:120
20396 msgid "As a script interpreter"
20400 #: ../fish/guestfish.pod:122
20401 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20405 #: ../fish/guestfish.pod:124
20408 " #!/usr/bin/guestfish -f\n"
20409 " sparse test1.img 100M\n"
20411 " part-disk /dev/sda mbr\n"
20412 " mkfs ext2 /dev/sda1\n"
20417 #: ../fish/guestfish.pod:130
20418 msgid "Start with a prepared disk"
20422 #: ../fish/guestfish.pod:132
20424 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20425 "single ext2-formatted partition:"
20429 #: ../fish/guestfish.pod:135
20432 " guestfish -N fs\n"
20437 #: ../fish/guestfish.pod:137
20438 msgid "To list what is available do:"
20442 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
20445 " guestfish -N help | less\n"
20450 #: ../fish/guestfish.pod:141
20451 msgid "Remote control"
20455 #: ../fish/guestfish.pod:143
20458 " eval \"`guestfish --listen`\"\n"
20459 " guestfish --remote add-ro disk.img\n"
20460 " guestfish --remote run\n"
20461 " guestfish --remote lvs\n"
20466 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
20467 #: ../fuse/guestmount.pod:83 ../tools/virt-win-reg.pl:96
20468 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:103
20469 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
20474 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:143
20475 #: ../tools/virt-win-reg.pl:104 ../tools/virt-list-filesystems.pl:61
20476 #: ../tools/virt-tar.pl:111 ../tools/virt-make-fs.pl:161
20477 #: ../tools/virt-list-partitions.pl:62
20482 #: ../fish/guestfish.pod:154
20483 msgid "Displays general help on options."
20487 #: ../fish/guestfish.pod:156
20492 #: ../fish/guestfish.pod:158
20493 msgid "B<--cmd-help>"
20497 #: ../fish/guestfish.pod:160
20498 msgid "Lists all available guestfish commands."
20502 #: ../fish/guestfish.pod:162
20507 #: ../fish/guestfish.pod:164
20508 msgid "B<--cmd-help cmd>"
20512 #: ../fish/guestfish.pod:166
20513 msgid "Displays detailed help on a single command C<cmd>."
20517 #: ../fish/guestfish.pod:168
20518 msgid "B<-a image>"
20522 #: ../fish/guestfish.pod:170
20523 msgid "B<--add image>"
20527 #: ../fish/guestfish.pod:172
20528 msgid "Add a block device or virtual machine image to the shell."
20532 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:91
20534 "The format of the disk image is auto-detected. To override this and force a"
20535 " particular format use the I<--format=..> option."
20539 #: ../fish/guestfish.pod:177
20541 "Using this flag is mostly equivalent to using the C<add> command, with "
20542 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20543 "the I<--format=...> flag was given."
20547 #: ../fish/guestfish.pod:181
20552 #: ../fish/guestfish.pod:183
20553 msgid "B<--connect URI>"
20557 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:96
20559 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20560 "URI to use. The default is to use the default libvirt connection."
20564 #: ../fish/guestfish.pod:189
20569 #: ../fish/guestfish.pod:191
20571 "If using the I<--listen> option and a csh-like shell, use this option. See "
20572 "section L</REMOTE CONTROL AND CSH> below."
20576 #: ../fish/guestfish.pod:194
20577 msgid "B<-d libvirt-domain>"
20581 #: ../fish/guestfish.pod:196
20582 msgid "B<--domain libvirt-domain>"
20586 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:102
20588 "Add disks from the named libvirt domain. If the I<--ro> option is also "
20589 "used, then any libvirt domain can be used. However in write mode, only "
20590 "libvirt domains which are shut down can be named here."
20594 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:106
20595 msgid "Domain UUIDs can be used instead of names."
20599 #: ../fish/guestfish.pod:204
20601 "Using this flag is mostly equivalent to using the C<add-domain> command, "
20602 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
20603 "if the I<--format:...> flag was given."
20607 #: ../fish/guestfish.pod:208
20612 #: ../fish/guestfish.pod:210
20613 msgid "B<--no-dest-paths>"
20617 #: ../fish/guestfish.pod:212
20619 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
20620 "to hit the tab key to complete paths on the guest filesystem, but this "
20621 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
20622 "allow this feature to be disabled."
20626 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:120
20627 msgid "B<--echo-keys>"
20631 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:122
20633 "When prompting for keys and passphrases, guestfish normally turns echoing "
20634 "off so you cannot see what you are typing. If you are not worried about "
20635 "Tempest attacks and there is no one else in the room you can specify this "
20636 "flag to see what you are typing."
20640 #: ../fish/guestfish.pod:224
20645 #: ../fish/guestfish.pod:226
20646 msgid "B<--file file>"
20650 #: ../fish/guestfish.pod:228
20651 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
20655 #: ../fish/guestfish.pod:231
20658 " #!/usr/bin/guestfish -f\n"
20663 #: ../fish/guestfish.pod:233
20664 msgid "B<--format=raw|qcow2|..>"
20668 #: ../fish/guestfish.pod:235
20669 msgid "B<--format>"
20673 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:129
20675 "The default for the I<-a> option is to auto-detect the format of the disk "
20676 "image. Using this forces the disk format for I<-a> options which follow on "
20677 "the command line. Using I<--format> with no argument switches back to auto-"
20678 "detection for subsequent I<-a> options."
20682 #: ../fish/guestfish.pod:244
20685 " guestfish --format=raw -a disk.img\n"
20690 #: ../fish/guestfish.pod:246
20691 msgid "forces raw format (no auto-detection) for C<disk.img>."
20695 #: ../fish/guestfish.pod:248
20698 " guestfish --format=raw -a disk.img --format -a another.img\n"
20703 #: ../fish/guestfish.pod:250
20705 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
20706 "detection for C<another.img>."
20710 #: ../fish/guestfish.pod:253
20712 "If you have untrusted raw-format guest disk images, you should use this "
20713 "option to specify the disk format. This avoids a possible security problem "
20714 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
20718 #: ../fish/guestfish.pod:258
20723 #: ../fish/guestfish.pod:260
20724 msgid "B<--inspector>"
20728 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:149
20730 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
20731 "system and mount filesystems as they would be mounted on the real virtual "
20736 #: ../fish/guestfish.pod:266
20737 msgid "Typical usage is either:"
20741 #: ../fish/guestfish.pod:268
20744 " guestfish -d myguest -i\n"
20749 #: ../fish/guestfish.pod:270
20750 msgid "(for an inactive libvirt domain called I<myguest>), or:"
20754 #: ../fish/guestfish.pod:272
20757 " guestfish --ro -d myguest -i\n"
20762 #: ../fish/guestfish.pod:274
20763 msgid "(for active domains, readonly), or specify the block device directly:"
20767 #: ../fish/guestfish.pod:276
20770 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
20775 #: ../fish/guestfish.pod:278
20777 "Note that the command line syntax changed slightly over older versions of "
20778 "guestfish. You can still use the old syntax:"
20782 #: ../fish/guestfish.pod:281
20785 " guestfish [--ro] -i disk.img\n"
20790 #: ../fish/guestfish.pod:283
20793 " guestfish [--ro] -i libvirt-domain\n"
20798 #: ../fish/guestfish.pod:285
20800 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
20801 "then using other commands to mount the filesystems that were found."
20805 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:153
20806 msgid "B<--keys-from-stdin>"
20810 #: ../fish/guestfish.pod:291 ../fuse/guestmount.pod:155
20812 "Read key or passphrase parameters from stdin. The default is to try to read"
20813 " passphrases from the user by opening C</dev/tty>."
20817 #: ../fish/guestfish.pod:294
20818 msgid "B<--listen>"
20822 #: ../fish/guestfish.pod:296
20824 "Fork into the background and listen for remote commands. See section "
20825 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
20829 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:158
20834 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:160
20836 "Connect to a live virtual machine. (Experimental, see "
20837 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
20841 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:163
20842 msgid "B<-m dev[:mountpoint[:options]]>"
20846 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:165
20847 msgid "B<--mount dev[:mountpoint[:options]]>"
20851 #: ../fish/guestfish.pod:308
20852 msgid "Mount the named partition or logical volume on the given mountpoint."
20856 #: ../fish/guestfish.pod:310
20857 msgid "If the mountpoint is omitted, it defaults to C</>."
20861 #: ../fish/guestfish.pod:312
20862 msgid "You have to mount something on C</> before most commands will work."
20866 #: ../fish/guestfish.pod:314
20868 "If any I<-m> or I<--mount> options are given, the guest is automatically "
20873 #: ../fish/guestfish.pod:317
20875 "If you don't know what filesystems a disk image contains, you can either run"
20876 " guestfish without this option, then list the partitions, filesystems and "
20877 "LVs available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
20878 "commands), or you can use the L<virt-filesystems(1)> program."
20882 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:173
20884 "The third (and rarely used) part of the mount parameter is the list of mount"
20885 " options used to mount the underlying filesystem. If this is not given, "
20886 "then the mount options are either the empty string or C<ro> (the latter if "
20887 "the I<--ro> flag is used). By specifying the mount options, you override "
20888 "this default choice. Probably the only time you would use this is to enable"
20889 " ACLs and/or extended attributes if the filesystem can support them:"
20893 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:181
20896 " -m /dev/sda1:/:acl,user_xattr\n"
20901 #: ../fish/guestfish.pod:333
20902 msgid "Using this flag is equivalent to using the C<mount-options> command."
20906 #: ../fish/guestfish.pod:335
20911 #: ../fish/guestfish.pod:337
20912 msgid "B<--no-sync>"
20916 #: ../fish/guestfish.pod:339
20918 "Disable autosync. This is enabled by default. See the discussion of "
20919 "autosync in the L<guestfs(3)> manpage."
20923 #: ../fish/guestfish.pod:342
20928 #: ../fish/guestfish.pod:344
20929 msgid "B<--new type>"
20933 #: ../fish/guestfish.pod:346
20938 #: ../fish/guestfish.pod:348
20940 "Prepare a fresh disk image formatted as \"type\". This is an alternative to"
20941 " the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
20942 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
20947 #: ../fish/guestfish.pod:353
20948 msgid "B<--progress-bars>"
20952 #: ../fish/guestfish.pod:355
20953 msgid "Enable progress bars, even when guestfish is used non-interactively."
20957 #: ../fish/guestfish.pod:357
20959 "Progress bars are enabled by default when guestfish is used as an "
20960 "interactive shell."
20964 #: ../fish/guestfish.pod:360
20965 msgid "B<--no-progress-bars>"
20969 #: ../fish/guestfish.pod:362
20970 msgid "Disable progress bars."
20974 #: ../fish/guestfish.pod:364
20975 msgid "B<--remote[=pid]>"
20979 #: ../fish/guestfish.pod:366
20981 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
20982 "CONTROL GUESTFISH OVER A SOCKET> below."
20986 #: ../fish/guestfish.pod:369
20991 #: ../fish/guestfish.pod:371
20996 #: ../fish/guestfish.pod:373
20998 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
20999 "mounts are done read-only."
21003 #: ../fish/guestfish.pod:376
21005 "The option must always be used if the disk image or virtual machine might be"
21006 " running, and is generally recommended in cases where you don't need write "
21007 "access to the disk."
21011 #: ../fish/guestfish.pod:380
21013 "Note that prepared disk images created with I<-N> are not affected by this "
21014 "option. Also commands like C<add> are not affected - you have to specify "
21015 "the C<readonly:true> option explicitly if you need it."
21019 #: ../fish/guestfish.pod:384
21020 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21024 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:237
21025 msgid "B<--selinux>"
21029 #: ../fish/guestfish.pod:388
21030 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21034 #: ../fish/guestfish.pod:390
21039 #: ../fish/guestfish.pod:392
21040 msgid "B<--verbose>"
21044 #: ../fish/guestfish.pod:394
21046 "Enable very verbose messages. This is particularly useful if you find a "
21051 #: ../fish/guestfish.pod:397
21056 #: ../fish/guestfish.pod:399 ../tools/virt-win-reg.pl:112
21057 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:119
21058 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
21059 msgid "B<--version>"
21063 #: ../fish/guestfish.pod:401
21064 msgid "Display the guestfish / libguestfs version number and exit."
21068 #: ../fish/guestfish.pod:403
21073 #: ../fish/guestfish.pod:405
21078 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:251
21080 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21081 "mounts are done read-write."
21085 #: ../fish/guestfish.pod:410
21086 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
21090 #: ../fish/guestfish.pod:412
21095 #: ../fish/guestfish.pod:414
21096 msgid "Echo each command before executing it."
21100 #: ../fish/guestfish.pod:418
21101 msgid "COMMANDS ON COMMAND LINE"
21105 #: ../fish/guestfish.pod:420
21107 "Any additional (non-option) arguments are treated as commands to execute."
21111 #: ../fish/guestfish.pod:423
21113 "Commands to execute should be separated by a colon (C<:>), where the colon "
21114 "is a separate parameter. Thus:"
21118 #: ../fish/guestfish.pod:426
21121 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21126 #: ../fish/guestfish.pod:428
21128 "If there are no additional arguments, then we enter a shell, either an "
21129 "interactive shell with a prompt (if the input is a terminal) or a non-"
21130 "interactive shell."
21134 #: ../fish/guestfish.pod:432
21136 "In either command line mode or non-interactive shell, the first command that"
21137 " gives an error causes the whole shell to exit. In interactive mode (with a"
21138 " prompt) if a command fails, you can continue to enter commands."
21142 #: ../fish/guestfish.pod:437
21143 msgid "USING launch (OR run)"
21147 #: ../fish/guestfish.pod:439
21149 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21150 "then launch it, then mount any disks you need, and finally issue "
21151 "actions/commands. So the general order of the day is:"
21155 #: ../fish/guestfish.pod:447
21156 msgid "add or -a/--add"
21160 #: ../fish/guestfish.pod:451
21161 msgid "launch (aka run)"
21165 #: ../fish/guestfish.pod:455
21166 msgid "mount or -m/--mount"
21170 #: ../fish/guestfish.pod:459
21171 msgid "any other commands"
21175 #: ../fish/guestfish.pod:463
21177 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21178 "guest before mounting or performing any other commands."
21182 #: ../fish/guestfish.pod:466
21184 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21185 "I<--new> options were given then C<run> is done automatically, simply "
21186 "because guestfish can't perform the action you asked for without doing this."
21190 #: ../fish/guestfish.pod:471
21191 msgid "OPENING DISKS FOR READ AND WRITE"
21195 #: ../fish/guestfish.pod:473
21197 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
21198 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
21199 "I<-i> and I<-m> open disk images read-only or for writing."
21203 #: ../fish/guestfish.pod:478
21205 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to"
21206 " opening disk images supplied on the command line for write. To open a disk"
21207 " image read-only you have to do I<-a image --ro>."
21211 #: ../fish/guestfish.pod:482
21213 "This matters: If you accidentally open a live VM disk image writable then "
21214 "you will cause irreversible disk corruption."
21218 #: ../fish/guestfish.pod:485
21220 "By libguestfs 1.12 we intend to change the default the other way. Disk "
21221 "images will be opened read-only. You will have to either specify "
21222 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
21223 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
21224 "access for disk images specified by those other command line options."
21228 #: ../fish/guestfish.pod:492
21230 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
21231 "which does nothing (it is already the default). However it is highly "
21232 "recommended that you use this option to indicate that you need write access,"
21233 " and prepare your scripts for the day when this option will be required for "
21238 #: ../fish/guestfish.pod:498
21240 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any"
21241 " other libguestfs program apart from guestfish and guestmount."
21245 #: ../fish/guestfish.pod:501
21250 #: ../fish/guestfish.pod:503
21252 "You can quote ordinary parameters using either single or double quotes. For"
21257 #: ../fish/guestfish.pod:506
21260 " add \"file with a space.img\"\n"
21265 #: ../fish/guestfish.pod:508
21268 " rm '/file name'\n"
21273 #: ../fish/guestfish.pod:510
21281 #: ../fish/guestfish.pod:512
21283 "A few commands require a list of strings to be passed. For these, use a "
21284 "whitespace-separated list, enclosed in quotes. Strings containing "
21285 "whitespace to be passed through must be enclosed in single quotes. A "
21286 "literal single quote must be escaped with a backslash."
21290 #: ../fish/guestfish.pod:517
21293 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21294 " command \"/bin/echo 'foo bar'\"\n"
21295 " command \"/bin/echo \\'foo\\'\"\n"
21300 #: ../fish/guestfish.pod:521
21301 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
21305 #: ../fish/guestfish.pod:523
21307 "In double-quoted arguments (only) use backslash to insert special "
21312 #: ../fish/guestfish.pod:528
21317 #: ../fish/guestfish.pod:530
21318 msgid "Alert (bell) character."
21322 #: ../fish/guestfish.pod:532
21327 #: ../fish/guestfish.pod:534
21328 msgid "Backspace character."
21332 #: ../fish/guestfish.pod:536
21337 #: ../fish/guestfish.pod:538
21338 msgid "Form feed character."
21342 #: ../fish/guestfish.pod:540
21347 #: ../fish/guestfish.pod:542
21348 msgid "Newline character."
21352 #: ../fish/guestfish.pod:544
21357 #: ../fish/guestfish.pod:546
21358 msgid "Carriage return character."
21362 #: ../fish/guestfish.pod:548
21367 #: ../fish/guestfish.pod:550
21368 msgid "Horizontal tab character."
21372 #: ../fish/guestfish.pod:552
21377 #: ../fish/guestfish.pod:554
21378 msgid "Vertical tab character."
21382 #: ../fish/guestfish.pod:556
21387 #: ../fish/guestfish.pod:558
21388 msgid "A literal double quote character."
21392 #: ../fish/guestfish.pod:560
21397 #: ../fish/guestfish.pod:562
21399 "A character with octal value I<ooo>. There must be precisely 3 octal digits"
21404 #: ../fish/guestfish.pod:565
21409 #: ../fish/guestfish.pod:567
21411 "A character with hex value I<hh>. There must be precisely 2 hex digits."
21415 #: ../fish/guestfish.pod:570
21417 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
21422 #: ../fish/guestfish.pod:573
21427 #: ../fish/guestfish.pod:575
21428 msgid "A literal backslash character."
21432 #: ../fish/guestfish.pod:579
21433 msgid "OPTIONAL ARGUMENTS"
21437 #: ../fish/guestfish.pod:581
21439 "Some commands take optional arguments. These arguments appear in this "
21440 "documentation as C<[argname:..]>. You can use them as in these examples:"
21444 #: ../fish/guestfish.pod:585
21447 " add-drive-opts filename\n"
21452 #: ../fish/guestfish.pod:587
21455 " add-drive-opts filename readonly:true\n"
21460 #: ../fish/guestfish.pod:589
21463 " add-drive-opts filename format:qcow2 readonly:false\n"
21468 #: ../fish/guestfish.pod:591
21470 "Each optional argument can appear at most once. All optional arguments must"
21471 " appear after the required ones."
21475 #: ../fish/guestfish.pod:594
21480 #: ../fish/guestfish.pod:596
21482 "This section applies to all commands which can take integers as parameters."
21486 #: ../fish/guestfish.pod:599
21487 msgid "SIZE SUFFIX"
21491 #: ../fish/guestfish.pod:601
21493 "When the command takes a parameter measured in bytes, you can use one of the"
21494 " following suffixes to specify kilobytes, megabytes and larger sizes:"
21498 #: ../fish/guestfish.pod:607
21499 msgid "B<k> or B<K> or B<KiB>"
21503 #: ../fish/guestfish.pod:609
21504 msgid "The size in kilobytes (multiplied by 1024)."
21508 #: ../fish/guestfish.pod:611
21513 #: ../fish/guestfish.pod:613
21514 msgid "The size in SI 1000 byte units."
21518 #: ../fish/guestfish.pod:615
21519 msgid "B<M> or B<MiB>"
21523 #: ../fish/guestfish.pod:617
21524 msgid "The size in megabytes (multiplied by 1048576)."
21528 #: ../fish/guestfish.pod:619
21533 #: ../fish/guestfish.pod:621
21534 msgid "The size in SI 1000000 byte units."
21538 #: ../fish/guestfish.pod:623
21539 msgid "B<G> or B<GiB>"
21543 #: ../fish/guestfish.pod:625
21544 msgid "The size in gigabytes (multiplied by 2**30)."
21548 #: ../fish/guestfish.pod:627
21553 #: ../fish/guestfish.pod:629
21554 msgid "The size in SI 10**9 byte units."
21558 #: ../fish/guestfish.pod:631
21559 msgid "B<T> or B<TiB>"
21563 #: ../fish/guestfish.pod:633
21564 msgid "The size in terabytes (multiplied by 2**40)."
21568 #: ../fish/guestfish.pod:635
21573 #: ../fish/guestfish.pod:637
21574 msgid "The size in SI 10**12 byte units."
21578 #: ../fish/guestfish.pod:639
21579 msgid "B<P> or B<PiB>"
21583 #: ../fish/guestfish.pod:641
21584 msgid "The size in petabytes (multiplied by 2**50)."
21588 #: ../fish/guestfish.pod:643
21593 #: ../fish/guestfish.pod:645
21594 msgid "The size in SI 10**15 byte units."
21598 #: ../fish/guestfish.pod:647
21599 msgid "B<E> or B<EiB>"
21603 #: ../fish/guestfish.pod:649
21604 msgid "The size in exabytes (multiplied by 2**60)."
21608 #: ../fish/guestfish.pod:651
21613 #: ../fish/guestfish.pod:653
21614 msgid "The size in SI 10**18 byte units."
21618 #: ../fish/guestfish.pod:655
21619 msgid "B<Z> or B<ZiB>"
21623 #: ../fish/guestfish.pod:657
21624 msgid "The size in zettabytes (multiplied by 2**70)."
21628 #: ../fish/guestfish.pod:659
21633 #: ../fish/guestfish.pod:661
21634 msgid "The size in SI 10**21 byte units."
21638 #: ../fish/guestfish.pod:663
21639 msgid "B<Y> or B<YiB>"
21643 #: ../fish/guestfish.pod:665
21644 msgid "The size in yottabytes (multiplied by 2**80)."
21648 #: ../fish/guestfish.pod:667
21653 #: ../fish/guestfish.pod:669
21654 msgid "The size in SI 10**24 byte units."
21658 #: ../fish/guestfish.pod:675
21661 " truncate-size /file 1G\n"
21666 #: ../fish/guestfish.pod:677
21667 msgid "would truncate the file to 1 gigabyte."
21671 #: ../fish/guestfish.pod:679
21673 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
21674 "the parameter to L</memsize> is specified in megabytes already). Adding a "
21675 "suffix will probably not do what you expect."
21679 #: ../fish/guestfish.pod:683
21680 msgid "OCTAL AND HEXADECIMAL NUMBERS"
21684 #: ../fish/guestfish.pod:685
21686 "For specifying the radix (base) use the C convention: C<0> to prefix an "
21687 "octal number or C<0x> to prefix a hexadecimal number. For example:"
21691 #: ../fish/guestfish.pod:688
21694 " 1234 decimal number 1234\n"
21695 " 02322 octal number, equivalent to decimal 1234\n"
21696 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
21701 #: ../fish/guestfish.pod:692
21703 "When using the C<chmod> command, you almost always want to specify an octal "
21704 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
21705 "L<chmod(1)> program):"
21709 #: ../fish/guestfish.pod:696
21712 " chmod 0777 /public # OK\n"
21713 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
21718 #: ../fish/guestfish.pod:699
21720 "Commands that return numbers usually print them in decimal, but some "
21721 "commands print numbers in other radices (eg. C<umask> prints the mode in "
21722 "octal, preceeded by C<0>)."
21726 #: ../fish/guestfish.pod:703
21727 msgid "WILDCARDS AND GLOBBING"
21731 #: ../fish/guestfish.pod:705
21733 "Neither guestfish nor the underlying guestfs API performs wildcard expansion"
21734 " (globbing) by default. So for example the following will not do what you "
21739 #: ../fish/guestfish.pod:709
21747 #: ../fish/guestfish.pod:711
21749 "Assuming you don't have a directory called literally C</home/*> then the "
21750 "above command will return an error."
21754 #: ../fish/guestfish.pod:714
21755 msgid "To perform wildcard expansion, use the C<glob> command."
21759 #: ../fish/guestfish.pod:716
21762 " glob rm-rf /home/*\n"
21767 #: ../fish/guestfish.pod:718
21769 "runs C<rm-rf> on each path that matches (ie. potentially running the command"
21770 " many times), equivalent to:"
21774 #: ../fish/guestfish.pod:721
21777 " rm-rf /home/jim\n"
21778 " rm-rf /home/joe\n"
21779 " rm-rf /home/mary\n"
21784 #: ../fish/guestfish.pod:725
21785 msgid "C<glob> only works on simple guest paths and not on device names."
21789 #: ../fish/guestfish.pod:727
21791 "If you have several parameters, each containing a wildcard, then glob will "
21792 "perform a Cartesian product."
21796 #: ../fish/guestfish.pod:730
21801 #: ../fish/guestfish.pod:732
21803 "Any line which starts with a I<#> character is treated as a comment and "
21804 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
21805 "a command. For example:"
21809 #: ../fish/guestfish.pod:736
21812 " # this is a comment\n"
21813 " # this is a comment\n"
21814 " foo # NOT a comment\n"
21819 #: ../fish/guestfish.pod:740
21820 msgid "Blank lines are also ignored."
21824 #: ../fish/guestfish.pod:742
21825 msgid "RUNNING COMMANDS LOCALLY"
21829 #: ../fish/guestfish.pod:744
21831 "Any line which starts with a I<!> character is treated as a command sent to "
21832 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
21836 #: ../fish/guestfish.pod:748
21840 " tgz-out /remote local/remote-data.tar.gz\n"
21845 #: ../fish/guestfish.pod:751
21847 "will create a directory C<local> on the host, and then export the contents "
21848 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
21849 "(See C<tgz-out>)."
21853 #: ../fish/guestfish.pod:755
21855 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
21856 "effect, due to the way that subprocesses work in Unix."
21860 #: ../fish/guestfish.pod:758
21861 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
21865 #: ../fish/guestfish.pod:760
21867 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
21868 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
21869 "and executed as guestfish commands."
21873 #: ../fish/guestfish.pod:764
21875 "Thus you can use shell script to construct arbitrary guestfish commands "
21876 "which are then parsed by guestfish."
21880 #: ../fish/guestfish.pod:767
21882 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
21883 "through C</foo.100>) using guestfish commands alone. However this is simple"
21884 " if we use a shell script to create the guestfish commands for us:"
21888 #: ../fish/guestfish.pod:772
21891 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
21896 #: ../fish/guestfish.pod:774
21897 msgid "or with names like C</foo.001>:"
21901 #: ../fish/guestfish.pod:776
21904 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
21909 #: ../fish/guestfish.pod:778
21911 "When using guestfish interactively it can be helpful to just run the shell "
21912 "script first (ie. remove the initial C<E<lt>> character so it is just an "
21913 "ordinary I<!> local command), see what guestfish commands it would run, and "
21914 "when you are happy with those prepend the C<E<lt>> character to run the "
21915 "guestfish commands for real."
21919 #: ../fish/guestfish.pod:784
21924 #: ../fish/guestfish.pod:786
21926 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
21927 "command (a guestfish command) to the second command (any host command). For"
21932 #: ../fish/guestfish.pod:790
21935 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
21940 #: ../fish/guestfish.pod:792
21942 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
21943 "program). The above command would list all accounts in the guest filesystem"
21944 " which have UID 0, ie. root accounts including backdoors. Other examples:"
21948 #: ../fish/guestfish.pod:797
21951 " hexdump /bin/ls | head\n"
21952 " list-devices | tail -1\n"
21953 " tgz-out / - | tar ztf -\n"
21958 #: ../fish/guestfish.pod:801
21960 "The space before the pipe symbol is required, any space after the pipe "
21961 "symbol is optional. Everything after the pipe symbol is just passed "
21962 "straight to the host shell, so it can contain redirections, globs and "
21963 "anything else that makes sense on the host side."
21967 #: ../fish/guestfish.pod:806
21969 "To use a literal argument which begins with a pipe symbol, you have to quote"
21974 #: ../fish/guestfish.pod:809
21982 #: ../fish/guestfish.pod:811
21983 msgid "HOME DIRECTORIES"
21987 #: ../fish/guestfish.pod:813
21989 "If a parameter starts with the character C<~> then the tilde may be expanded"
21990 " as a home directory path (either C<~> for the current user's home "
21991 "directory, or C<~user> for another user)."
21995 #: ../fish/guestfish.pod:817
21997 "Note that home directory expansion happens for users known I<on the host>, "
21998 "not in the guest filesystem."
22002 #: ../fish/guestfish.pod:820
22004 "To use a literal argument which begins with a tilde, you have to quote it, "
22009 #: ../fish/guestfish.pod:823
22017 #: ../fish/guestfish.pod:827
22019 "Libguestfs has some support for Linux guests encrypted according to the "
22020 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22021 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22022 "LUKS is supported."
22026 #: ../fish/guestfish.pod:832
22027 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22031 #: ../fish/guestfish.pod:834
22034 " ><fs> vfs-type /dev/sda2\n"
22040 #: ../fish/guestfish.pod:837
22042 "Then open those devices using L</luks-open>. This creates a device-mapper "
22043 "device called C</dev/mapper/luksdev>."
22047 #: ../fish/guestfish.pod:840
22050 " ><fs> luks-open /dev/sda2 luksdev\n"
22051 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22056 #: ../fish/guestfish.pod:843
22058 "Finally you have to tell LVM to scan for volume groups on the newly created "
22063 #: ../fish/guestfish.pod:846
22067 " vg-activate-all true\n"
22072 #: ../fish/guestfish.pod:849
22073 msgid "The logical volume(s) can now be mounted in the usual way."
22077 #: ../fish/guestfish.pod:851
22079 "Before closing a LUKS device you must unmount any logical volumes on it and "
22080 "deactivate the volume groups by calling C<vg-activate false VG> on each one."
22081 " Then you can close the mapper device:"
22085 #: ../fish/guestfish.pod:855
22088 " vg-activate false /dev/VG\n"
22089 " luks-close /dev/mapper/luksdev\n"
22094 #: ../fish/guestfish.pod:858
22095 msgid "WINDOWS PATHS"
22099 #: ../fish/guestfish.pod:860
22101 "If a path is prefixed with C<win:> then you can use Windows-style drive "
22102 "letters and paths (with some limitations). The following commands are "
22107 #: ../fish/guestfish.pod:864
22110 " file /WINDOWS/system32/config/system.LOG\n"
22115 #: ../fish/guestfish.pod:866
22118 " file win:\\windows\\system32\\config\\system.log\n"
22123 #: ../fish/guestfish.pod:868
22126 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
22131 #: ../fish/guestfish.pod:870
22133 "The parameter is rewritten \"behind the scenes\" by looking up the position "
22134 "where the drive is mounted, prepending that to the path, changing all "
22135 "backslash characters to forward slash, then resolving the result using L"
22136 "</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
22137 "then the parameter might be rewritten like this:"
22141 #: ../fish/guestfish.pod:876
22144 " win:e:\\foo\\bar => /e/FOO/bar\n"
22149 #: ../fish/guestfish.pod:878
22150 msgid "This only works in argument positions that expect a path."
22154 #: ../fish/guestfish.pod:880
22155 msgid "UPLOADING AND DOWNLOADING FILES"
22159 #: ../fish/guestfish.pod:882
22161 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22162 "others which upload from or download to a local file, you can use the "
22163 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22167 #: ../fish/guestfish.pod:886
22175 #: ../fish/guestfish.pod:888
22177 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22181 #: ../fish/guestfish.pod:891
22184 " tar-out /etc - | tar tf -\n"
22189 #: ../fish/guestfish.pod:893
22191 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22192 "command (see L</PIPES>)."
22196 #: ../fish/guestfish.pod:896
22198 "When using C<-> to read from stdin, the input is read up to the end of "
22199 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22200 "some arbitrary end marker:"
22204 #: ../fish/guestfish.pod:900
22207 " upload -<<END /foo\n"
22216 #: ../fish/guestfish.pod:906
22218 "Any string of characters can be used instead of C<END>. The end marker must"
22219 " appear on a line of its own, without any preceeding or following characters"
22220 " (not even spaces)."
22224 #: ../fish/guestfish.pod:910
22226 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22227 "upload local files (so-called \"FileIn\" parameters in the generator)."
22231 #: ../fish/guestfish.pod:913
22232 msgid "EXIT ON ERROR BEHAVIOUR"
22236 #: ../fish/guestfish.pod:915
22238 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22239 "taking commands from a human over a tty), and will exit on the first error "
22240 "in non-interactive mode (scripts, commands given on the command line)."
22244 #: ../fish/guestfish.pod:920
22246 "If you prefix a command with a I<-> character, then that command will not "
22247 "cause guestfish to exit, even if that (one) command returns an error."
22251 #: ../fish/guestfish.pod:924
22252 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22256 #: ../fish/guestfish.pod:926
22258 "Guestfish can be remote-controlled over a socket. This is useful "
22259 "particularly in shell scripts where you want to make several different "
22260 "changes to a filesystem, but you don't want the overhead of starting up a "
22261 "guestfish process each time."
22265 #: ../fish/guestfish.pod:931
22266 msgid "Start a guestfish server process using:"
22270 #: ../fish/guestfish.pod:933
22273 " eval \"`guestfish --listen`\"\n"
22278 #: ../fish/guestfish.pod:935
22279 msgid "and then send it commands by doing:"
22283 #: ../fish/guestfish.pod:937
22286 " guestfish --remote cmd [...]\n"
22291 #: ../fish/guestfish.pod:939
22292 msgid "To cause the server to exit, send it the exit command:"
22296 #: ../fish/guestfish.pod:941
22299 " guestfish --remote exit\n"
22304 #: ../fish/guestfish.pod:943
22306 "Note that the server will normally exit if there is an error in a command. "
22307 "You can change this in the usual way. See section L</EXIT ON ERROR "
22312 #: ../fish/guestfish.pod:947
22313 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22317 #: ../fish/guestfish.pod:949
22319 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which"
22320 " is how the I<--remote> option knows where to send the commands. You can "
22321 "have several guestfish listener processes running using:"
22325 #: ../fish/guestfish.pod:953
22328 " eval \"`guestfish --listen`\"\n"
22329 " pid1=$GUESTFISH_PID\n"
22330 " eval \"`guestfish --listen`\"\n"
22331 " pid2=$GUESTFISH_PID\n"
22333 " guestfish --remote=$pid1 cmd\n"
22334 " guestfish --remote=$pid2 cmd\n"
22339 #: ../fish/guestfish.pod:961
22340 msgid "REMOTE CONTROL AND CSH"
22344 #: ../fish/guestfish.pod:963
22346 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22351 #: ../fish/guestfish.pod:966
22354 " eval \"`guestfish --listen --csh`\"\n"
22359 #: ../fish/guestfish.pod:968
22360 msgid "REMOTE CONTROL DETAILS"
22364 #: ../fish/guestfish.pod:970
22366 "Remote control happens over a Unix domain socket called "
22367 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
22368 "of the process, and C<$PID> is the process ID of the server."
22372 #: ../fish/guestfish.pod:974
22373 msgid "Guestfish client and server versions must match exactly."
22377 #: ../fish/guestfish.pod:976
22378 msgid "PREPARED DISK IMAGES"
22382 #: ../fish/guestfish.pod:978
22384 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22385 "preformatted disk images that guestfish can make for you to save typing. "
22386 "This is particularly useful for testing purposes. This option is used "
22387 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22388 "can be mixed with I<-a>)."
22392 #: ../fish/guestfish.pod:984
22394 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22395 "the second and so on. Existing files in the current directory are "
22400 #: ../fish/guestfish.pod:988
22402 "The type briefly describes how the disk should be sized, partitioned, how "
22403 "filesystem(s) should be created, and how content should be added. "
22404 "Optionally the type can be followed by extra parameters, separated by C<:> "
22405 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
22406 "sparsely-allocated disk, containing a single partition, with the partition "
22407 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem"
22408 " on a 1GB disk instead."
22412 #: ../fish/guestfish.pod:996
22413 msgid "To list the available types and any extra parameters they take, run:"
22417 #: ../fish/guestfish.pod:1000
22419 "Note that the prepared filesystem is not mounted. You would usually have to"
22420 " use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22424 #: ../fish/guestfish.pod:1004
22426 "If any I<-N> or I<--new> options are given, the guest is automatically "
22431 #: ../fish/guestfish.pod:1009
22432 msgid "Create a 100MB disk with an ext4-formatted partition:"
22436 #: ../fish/guestfish.pod:1011
22439 " guestfish -N fs:ext4\n"
22444 #: ../fish/guestfish.pod:1013
22445 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22449 #: ../fish/guestfish.pod:1015
22452 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22457 #: ../fish/guestfish.pod:1017
22458 msgid "Create a blank 200MB disk:"
22462 #: ../fish/guestfish.pod:1019
22465 " guestfish -N disk:200M\n"
22470 #: ../fish/guestfish.pod:1021
22471 msgid "PROGRESS BARS"
22475 #: ../fish/guestfish.pod:1023
22477 "Some (not all) long-running commands send progress notification messages as "
22478 "they are running. Guestfish turns these messages into progress bars."
22482 #: ../fish/guestfish.pod:1027
22484 "When a command that supports progress bars takes longer than two seconds to "
22485 "run, and if progress bars are enabled, then you will see one appearing below"
22490 #: ../fish/guestfish.pod:1031
22493 " ><fs> copy-size /large-file /another-file 2048M\n"
22494 " / 10% [#####-----------------------------------------] 00:30\n"
22499 #: ../fish/guestfish.pod:1034
22501 "The spinner on the left hand side moves round once for every progress "
22502 "notification received from the backend. This is a (reasonably) golden "
22503 "assurance that the command is \"doing something\" even if the progress bar "
22504 "is not moving, because the command is able to send the progress "
22505 "notifications. When the bar reaches 100% and the command finishes, the "
22506 "spinner disappears."
22510 #: ../fish/guestfish.pod:1041
22512 "Progress bars are enabled by default when guestfish is used interactively. "
22513 "You can enable them even for non-interactive modes using I<--progress-bars>,"
22514 " and you can disable them completely using I<--no-progress-bars>."
22518 #: ../fish/guestfish.pod:1046
22519 msgid "GUESTFISH COMMANDS"
22523 #: ../fish/guestfish.pod:1048
22525 "The commands in this section are guestfish convenience commands, in other "
22526 "words, they are not part of the L<guestfs(3)> API."
22530 #: ../fish/guestfish.pod:1051
22535 #: ../fish/guestfish.pod:1053
22544 #: ../fish/guestfish.pod:1056
22545 msgid "Without any parameter, this provides general help."
22549 #: ../fish/guestfish.pod:1058
22550 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22554 #: ../fish/guestfish.pod:1060
22555 msgid "quit | exit"
22559 #: ../fish/guestfish.pod:1062
22560 msgid "This exits guestfish. You can also use C<^D> key."
22564 #: ../fish/guestfish.pod:1064
22565 msgid "@FISH_COMMANDS@"
22569 #: ../fish/guestfish.pod:1066
22574 #: ../fish/guestfish.pod:1070 ../test-tool/libguestfs-test-tool.pod:77
22579 #: ../fish/guestfish.pod:1072
22581 "guestfish returns 0 if the commands completed without error, or 1 if there "
22586 #: ../fish/guestfish.pod:1079
22591 #: ../fish/guestfish.pod:1081
22593 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22598 #: ../fish/guestfish.pod:1084
22599 msgid "GUESTFISH_DISPLAY_IMAGE"
22603 #: ../fish/guestfish.pod:1086
22605 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22606 "If not set, it uses L<display(1)>."
22610 #: ../fish/guestfish.pod:1089
22611 msgid "GUESTFISH_PID"
22615 #: ../fish/guestfish.pod:1091
22617 "Used with the I<--remote> option to specify the remote guestfish process to "
22618 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
22622 #: ../fish/guestfish.pod:1095
22627 #: ../fish/guestfish.pod:1097
22629 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
22630 "not specified, the external L<hexedit(1)> program is used."
22634 #: ../fish/guestfish.pod:1101
22639 #: ../fish/guestfish.pod:1103
22641 "If compiled with GNU readline support, various files in the home directory "
22642 "can be used. See L</FILES>."
22646 #: ../fish/guestfish.pod:1112
22648 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
22649 "effect as using the B<-v> option."
22653 #: ../fish/guestfish.pod:1124
22655 "Set the path that guestfish uses to search for kernel and initrd.img. See "
22656 "the discussion of paths in L<guestfs(3)>."
22660 #: ../fish/guestfish.pod:1135
22661 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
22665 #: ../fish/guestfish.pod:1137
22670 #: ../fish/guestfish.pod:1139
22672 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
22677 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:264
22682 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:268
22683 msgid "$HOME/.libguestfs-tools.rc"
22687 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:270
22688 msgid "/etc/libguestfs-tools.conf"
22692 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:272
22694 "This configuration file controls the default read-only or read-write mode "
22695 "(I<--ro> or I<--rw>)."
22699 #: ../fish/guestfish.pod:1166
22700 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
22704 #: ../fish/guestfish.pod:1168
22705 msgid "$HOME/.guestfish"
22709 #: ../fish/guestfish.pod:1170
22711 "If compiled with GNU readline support, then the command history is saved in "
22716 #: ../fish/guestfish.pod:1173
22717 msgid "$HOME/.inputrc"
22721 #: ../fish/guestfish.pod:1175
22722 msgid "/etc/inputrc"
22726 #: ../fish/guestfish.pod:1177
22728 "If compiled with GNU readline support, then these files can be used to "
22729 "configure readline. For further information, please see "
22730 "L<readline(3)/INITIALIZATION FILE>."
22734 #: ../fish/guestfish.pod:1181
22735 msgid "To write rules which only apply to guestfish, use:"
22739 #: ../fish/guestfish.pod:1183
22749 #: ../fish/guestfish.pod:1187
22751 "Variables that you can set in inputrc that change the behaviour of guestfish"
22752 " in useful ways include:"
22756 #: ../fish/guestfish.pod:1192
22757 msgid "completion-ignore-case (default: on)"
22761 #: ../fish/guestfish.pod:1194
22763 "By default, guestfish will ignore case when tab-completing paths on the "
22768 #: ../fish/guestfish.pod:1197
22771 " set completion-ignore-case off\n"
22776 #: ../fish/guestfish.pod:1199
22777 msgid "to make guestfish case sensitive."
22781 #: ../fish/guestfish.pod:1203
22786 #: ../fish/guestfish.pod:1205
22787 msgid "test2.img (etc)"
22791 #: ../fish/guestfish.pod:1207
22793 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
22794 "will be created in the file C<test1.img> in the current directory. The "
22795 "second use of I<-N> will use C<test2.img> and so on. Any existing file with"
22796 " the same name will be overwritten."
22800 #: ../fish/guestfish.pod:1216
22802 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-"
22803 "in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-"
22804 "filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-"
22805 "list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L"
22806 "<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L"
22807 "<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>."
22811 #: ../fish/guestfish.pod:1247 ../test-tool/libguestfs-test-tool.pod:102
22812 #: ../fuse/guestmount.pod:299 ../tools/virt-win-reg.pl:778
22813 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:309
22814 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:277
22816 "This program is free software; you can redistribute it and/or modify it "
22817 "under the terms of the GNU General Public License as published by the Free "
22818 "Software Foundation; either version 2 of the License, or (at your option) "
22819 "any later version."
22823 #: ../fish/guestfish.pod:1252 ../test-tool/libguestfs-test-tool.pod:107
22824 #: ../fuse/guestmount.pod:304 ../tools/virt-win-reg.pl:783
22825 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:314
22826 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:282
22828 "This program is distributed in the hope that it will be useful, but WITHOUT "
22829 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
22830 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
22835 #: ../fish/guestfish.pod:1257 ../test-tool/libguestfs-test-tool.pod:112
22836 #: ../fuse/guestmount.pod:309 ../tools/virt-win-reg.pl:788
22837 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:319
22838 #: ../tools/virt-make-fs.pl:582 ../tools/virt-list-partitions.pl:287
22840 "You should have received a copy of the GNU General Public License along with"
22841 " this program; if not, write to the Free Software Foundation, Inc., 675 Mass"
22842 " Ave, Cambridge, MA 02139, USA."
22846 #: ../fish/guestfish-actions.pod:1
22851 #: ../fish/guestfish-actions.pod:3
22854 " add-cdrom filename\n"
22859 #: ../fish/guestfish-actions.pod:15
22861 "This call checks for the existence of C<filename>. This stops you from "
22862 "specifying other types of drive which are supported by qemu such as C<nbd:> "
22863 "and C<http:> URLs. To specify those, use the general L</config> call "
22868 #: ../fish/guestfish-actions.pod:22
22870 "If you just want to add an ISO file (often you use this as an efficient way "
22871 "to transfer large files into the guest), then you should probably use L"
22872 "</add-drive-ro> instead."
22876 #: ../fish/guestfish-actions.pod:35
22881 #: ../fish/guestfish-actions.pod:37
22886 #: ../fish/guestfish-actions.pod:39
22889 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
22894 #: ../fish/guestfish-actions.pod:41
22896 "This function adds the disk(s) attached to the named libvirt domain C<dom>."
22897 " It works by connecting to libvirt, requesting the domain and domain XML "
22898 "from libvirt, parsing it for disks, and calling L</add-drive-opts> on each "
22903 #: ../fish/guestfish-actions.pod:76
22905 "The other optional parameters are passed directly through to L</add-drive-"
22910 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
22911 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
22912 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
22913 #: ../fish/guestfish-actions.pod:3442
22915 "This command has one or more optional arguments. See L</OPTIONAL "
22920 #: ../fish/guestfish-actions.pod:81
22925 #: ../fish/guestfish-actions.pod:83
22928 " add-drive filename\n"
22933 #: ../fish/guestfish-actions.pod:85
22935 "This function is the equivalent of calling L</add-drive-opts> with no "
22936 "optional parameters, so the disk is added writable, with the format being "
22937 "detected automatically."
22941 #: ../fish/guestfish-actions.pod:89
22943 "Automatic detection of the format opens you up to a potential security hole "
22944 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
22945 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
22946 "you should think about replacing calls to this function with calls to L"
22947 "</add-drive-opts>, and specifying the format."
22951 #: ../fish/guestfish-actions.pod:96
22952 msgid "add-drive-opts"
22956 #: ../fish/guestfish-actions.pod:98
22961 #: ../fish/guestfish-actions.pod:100
22964 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
22969 #: ../fish/guestfish-actions.pod:127
22971 "This forces the image format. If you omit this (or use L</add-drive> or L"
22972 "</add-drive-ro>) then the format is automatically detected. Possible "
22973 "formats include C<raw> and C<qcow2>."
22977 #: ../fish/guestfish-actions.pod:138
22979 "This rarely-used option lets you emulate the behaviour of the deprecated L"
22980 "</add-drive-with-if> call (q.v.)"
22984 #: ../fish/guestfish-actions.pod:145
22985 msgid "add-drive-ro"
22989 #: ../fish/guestfish-actions.pod:147
22994 #: ../fish/guestfish-actions.pod:149
22997 " add-drive-ro filename\n"
23002 #: ../fish/guestfish-actions.pod:151
23004 "This function is the equivalent of calling L</add-drive-opts> with the "
23005 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
23006 "is added read-only, with the format being detected automatically."
23010 #: ../fish/guestfish-actions.pod:156
23011 msgid "add-drive-ro-with-if"
23015 #: ../fish/guestfish-actions.pod:158
23018 " add-drive-ro-with-if filename iface\n"
23023 #: ../fish/guestfish-actions.pod:160
23025 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
23026 "interface emulation to use at run time."
23030 #: ../fish/guestfish-actions.pod:170
23031 msgid "add-drive-with-if"
23035 #: ../fish/guestfish-actions.pod:172
23038 " add-drive-with-if filename iface\n"
23043 #: ../fish/guestfish-actions.pod:174
23045 "This is the same as L</add-drive> but it allows you to specify the QEMU "
23046 "interface emulation to use at run time."
23050 #: ../fish/guestfish-actions.pod:184
23055 #: ../fish/guestfish-actions.pod:186
23058 " aug-clear augpath\n"
23063 #: ../fish/guestfish-actions.pod:191
23068 #: ../fish/guestfish-actions.pod:193
23076 #: ../fish/guestfish-actions.pod:195
23078 "Close the current Augeas handle and free up any resources used by it. After"
23079 " calling this, you have to call L</aug-init> again before you can use any "
23080 "other Augeas functions."
23084 #: ../fish/guestfish-actions.pod:200
23085 msgid "aug-defnode"
23089 #: ../fish/guestfish-actions.pod:202
23092 " aug-defnode name expr val\n"
23097 #: ../fish/guestfish-actions.pod:207
23099 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
23100 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
23101 "containing that single node."
23105 #: ../fish/guestfish-actions.pod:215
23110 #: ../fish/guestfish-actions.pod:217
23113 " aug-defvar name expr\n"
23118 #: ../fish/guestfish-actions.pod:226
23123 #: ../fish/guestfish-actions.pod:228
23126 " aug-get augpath\n"
23131 #: ../fish/guestfish-actions.pod:233
23136 #: ../fish/guestfish-actions.pod:235
23139 " aug-init root flags\n"
23144 #: ../fish/guestfish-actions.pod:241
23145 msgid "You must call this before using any other L</aug-*> commands."
23149 #: ../fish/guestfish-actions.pod:276
23150 msgid "Do not load the tree in L</aug-init>."
23154 #: ../fish/guestfish-actions.pod:280
23155 msgid "To close the handle, you can call L</aug-close>."
23159 #: ../fish/guestfish-actions.pod:284
23164 #: ../fish/guestfish-actions.pod:286
23167 " aug-insert augpath label true|false\n"
23172 #: ../fish/guestfish-actions.pod:296
23177 #: ../fish/guestfish-actions.pod:298
23185 #: ../fish/guestfish-actions.pod:305
23190 #: ../fish/guestfish-actions.pod:307
23193 " aug-ls augpath\n"
23198 #: ../fish/guestfish-actions.pod:309
23200 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
23201 "resulting nodes into alphabetical order."
23205 #: ../fish/guestfish-actions.pod:312
23210 #: ../fish/guestfish-actions.pod:314
23213 " aug-match augpath\n"
23218 #: ../fish/guestfish-actions.pod:320
23223 #: ../fish/guestfish-actions.pod:322
23226 " aug-mv src dest\n"
23231 #: ../fish/guestfish-actions.pod:327
23236 #: ../fish/guestfish-actions.pod:329
23239 " aug-rm augpath\n"
23244 #: ../fish/guestfish-actions.pod:335
23249 #: ../fish/guestfish-actions.pod:337
23257 #: ../fish/guestfish-actions.pod:341
23259 "The flags which were passed to L</aug-init> affect exactly how files are "
23264 #: ../fish/guestfish-actions.pod:344
23269 #: ../fish/guestfish-actions.pod:346
23272 " aug-set augpath val\n"
23277 #: ../fish/guestfish-actions.pod:350
23279 "In the Augeas API, it is possible to clear a node by setting the value to "
23280 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
23281 "this call. Instead you must use the L</aug-clear> call."
23285 #: ../fish/guestfish-actions.pod:355
23290 #: ../fish/guestfish-actions.pod:357
23293 " available 'groups ...'\n"
23298 #: ../fish/guestfish-actions.pod:363
23300 "The libguestfs groups, and the functions that those groups correspond to, "
23301 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
23302 "runtime by calling L</available-all-groups>."
23306 #: ../fish/guestfish-actions.pod:387
23307 msgid "You must call L</launch> before calling this function."
23311 #: ../fish/guestfish-actions.pod:409
23313 "This call was added in version C<1.0.80>. In previous versions of "
23314 "libguestfs all you could do would be to speculatively execute a command to "
23315 "find out if the daemon implemented it. See also L</version>."
23319 #: ../fish/guestfish-actions.pod:416
23320 msgid "available-all-groups"
23324 #: ../fish/guestfish-actions.pod:418
23327 " available-all-groups\n"
23332 #: ../fish/guestfish-actions.pod:420
23334 "This command returns a list of all optional groups that this daemon knows "
23335 "about. Note this returns both supported and unsupported groups. To find "
23336 "out which ones the daemon can actually support you have to call "
23337 "L</available> on each member of the returned list."
23341 #: ../fish/guestfish-actions.pod:426
23342 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
23346 #: ../fish/guestfish-actions.pod:428
23351 #: ../fish/guestfish-actions.pod:430
23354 " base64-in (base64file|-) filename\n"
23359 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
23360 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
23361 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
23362 #: ../fish/guestfish-actions.pod:4652 ../fish/guestfish-actions.pod:4664
23363 #: ../fish/guestfish-actions.pod:4675 ../fish/guestfish-actions.pod:4686
23364 #: ../fish/guestfish-actions.pod:4738 ../fish/guestfish-actions.pod:4747
23365 #: ../fish/guestfish-actions.pod:4801 ../fish/guestfish-actions.pod:4824
23366 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
23370 #: ../fish/guestfish-actions.pod:437
23375 #: ../fish/guestfish-actions.pod:439
23378 " base64-out filename (base64file|-)\n"
23383 #: ../fish/guestfish-actions.pod:446
23384 msgid "blockdev-flushbufs"
23388 #: ../fish/guestfish-actions.pod:448
23391 " blockdev-flushbufs device\n"
23396 #: ../fish/guestfish-actions.pod:455
23397 msgid "blockdev-getbsz"
23401 #: ../fish/guestfish-actions.pod:457
23404 " blockdev-getbsz device\n"
23409 #: ../fish/guestfish-actions.pod:466
23410 msgid "blockdev-getro"
23414 #: ../fish/guestfish-actions.pod:468
23417 " blockdev-getro device\n"
23422 #: ../fish/guestfish-actions.pod:475
23423 msgid "blockdev-getsize64"
23427 #: ../fish/guestfish-actions.pod:477
23430 " blockdev-getsize64 device\n"
23435 #: ../fish/guestfish-actions.pod:481
23436 msgid "See also L</blockdev-getsz>."
23440 #: ../fish/guestfish-actions.pod:485
23441 msgid "blockdev-getss"
23445 #: ../fish/guestfish-actions.pod:487
23448 " blockdev-getss device\n"
23453 #: ../fish/guestfish-actions.pod:492
23455 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
23459 #: ../fish/guestfish-actions.pod:497
23460 msgid "blockdev-getsz"
23464 #: ../fish/guestfish-actions.pod:499
23467 " blockdev-getsz device\n"
23472 #: ../fish/guestfish-actions.pod:504
23474 "See also L</blockdev-getss> for the real sector size of the device, and L"
23475 "</blockdev-getsize64> for the more useful I<size in bytes>."
23479 #: ../fish/guestfish-actions.pod:510
23480 msgid "blockdev-rereadpt"
23484 #: ../fish/guestfish-actions.pod:512
23487 " blockdev-rereadpt device\n"
23492 #: ../fish/guestfish-actions.pod:518
23493 msgid "blockdev-setbsz"
23497 #: ../fish/guestfish-actions.pod:520
23500 " blockdev-setbsz device blocksize\n"
23505 #: ../fish/guestfish-actions.pod:529
23506 msgid "blockdev-setro"
23510 #: ../fish/guestfish-actions.pod:531
23513 " blockdev-setro device\n"
23518 #: ../fish/guestfish-actions.pod:537
23519 msgid "blockdev-setrw"
23523 #: ../fish/guestfish-actions.pod:539
23526 " blockdev-setrw device\n"
23531 #: ../fish/guestfish-actions.pod:545
23532 msgid "btrfs-filesystem-resize"
23536 #: ../fish/guestfish-actions.pod:547
23539 " btrfs-filesystem-resize mountpoint [size:..]\n"
23544 #: ../fish/guestfish-actions.pod:570
23545 msgid "case-sensitive-path"
23549 #: ../fish/guestfish-actions.pod:572
23552 " case-sensitive-path path\n"
23557 #: ../fish/guestfish-actions.pod:596
23559 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
23560 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
23561 "how the directories were originally created under Windows)."
23565 #: ../fish/guestfish-actions.pod:604
23566 msgid "See also L</realpath>."
23570 #: ../fish/guestfish-actions.pod:606
23575 #: ../fish/guestfish-actions.pod:608
23583 #: ../fish/guestfish-actions.pod:612
23585 "Note that this function cannot correctly handle binary files (specifically, "
23586 "files containing C<\\0> character which is treated as end of string). For "
23587 "those you need to use the L</read-file> or L</download> functions which have"
23588 " a more complex interface."
23592 #: ../fish/guestfish-actions.pod:620
23597 #: ../fish/guestfish-actions.pod:622
23600 " checksum csumtype path\n"
23605 #: ../fish/guestfish-actions.pod:665
23606 msgid "To get the checksum for a device, use L</checksum-device>."
23610 #: ../fish/guestfish-actions.pod:667
23611 msgid "To get the checksums for many files, use L</checksums-out>."
23615 #: ../fish/guestfish-actions.pod:669
23616 msgid "checksum-device"
23620 #: ../fish/guestfish-actions.pod:671
23623 " checksum-device csumtype device\n"
23628 #: ../fish/guestfish-actions.pod:673
23630 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
23631 "device named C<device>. For the types of checksums supported see the "
23632 "L</checksum> command."
23636 #: ../fish/guestfish-actions.pod:677
23637 msgid "checksums-out"
23641 #: ../fish/guestfish-actions.pod:679
23644 " checksums-out csumtype directory (sumsfile|-)\n"
23649 #: ../fish/guestfish-actions.pod:695
23654 #: ../fish/guestfish-actions.pod:697
23657 " chmod mode path\n"
23662 #: ../fish/guestfish-actions.pod:708
23667 #: ../fish/guestfish-actions.pod:710
23670 " chown owner group path\n"
23675 #: ../fish/guestfish-actions.pod:718
23680 #: ../fish/guestfish-actions.pod:720
23683 " command 'arguments ...'\n"
23688 #: ../fish/guestfish-actions.pod:727
23690 "The single parameter is an argv-style list of arguments. The first element "
23691 "is the name of the program to run. Subsequent elements are parameters. The"
23692 " list must be non-empty (ie. must contain a program name). Note that the "
23693 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
23697 #: ../fish/guestfish-actions.pod:755
23698 msgid "command-lines"
23702 #: ../fish/guestfish-actions.pod:757
23705 " command-lines 'arguments ...'\n"
23710 #: ../fish/guestfish-actions.pod:759
23712 "This is the same as L</command>, but splits the result into a list of lines."
23716 #: ../fish/guestfish-actions.pod:762
23717 msgid "See also: L</sh-lines>"
23721 #: ../fish/guestfish-actions.pod:767
23726 #: ../fish/guestfish-actions.pod:769
23729 " config qemuparam qemuvalue\n"
23734 #: ../fish/guestfish-actions.pod:780
23739 #: ../fish/guestfish-actions.pod:782
23742 " copy-size src dest size\n"
23747 #: ../fish/guestfish-actions.pod:790
23752 #: ../fish/guestfish-actions.pod:792
23760 #: ../fish/guestfish-actions.pod:797
23765 #: ../fish/guestfish-actions.pod:799
23773 #: ../fish/guestfish-actions.pod:804
23778 #: ../fish/guestfish-actions.pod:806
23786 #: ../fish/guestfish-actions.pod:813
23788 "If the destination is a device, it must be as large or larger than the "
23789 "source file or device, otherwise the copy will fail. This command cannot do"
23790 " partial copies (see L</copy-size>)."
23794 #: ../fish/guestfish-actions.pod:817
23799 #: ../fish/guestfish-actions.pod:819
23807 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
23809 "This command is mostly useful for interactive sessions. It is I<not> "
23810 "intended that you try to parse the output string. Use L</statvfs> from "
23815 #: ../fish/guestfish-actions.pod:827
23820 #: ../fish/guestfish-actions.pod:829
23828 #: ../fish/guestfish-actions.pod:838
23833 #: ../fish/guestfish-actions.pod:840
23841 #: ../fish/guestfish-actions.pod:846
23843 "Another way to get the same information is to enable verbose messages with L"
23844 "</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
23845 "before running the program."
23849 #: ../fish/guestfish-actions.pod:851
23854 #: ../fish/guestfish-actions.pod:853
23857 " download remotefilename (filename|-)\n"
23862 #: ../fish/guestfish-actions.pod:860
23863 msgid "See also L</upload>, L</cat>."
23867 #: ../fish/guestfish-actions.pod:864
23868 msgid "download-offset"
23872 #: ../fish/guestfish-actions.pod:866
23875 " download-offset remotefilename (filename|-) offset size\n"
23880 #: ../fish/guestfish-actions.pod:874
23882 "Note that there is no limit on the amount of data that can be downloaded "
23883 "with this call, unlike with L</pread>, and this call always reads the full "
23884 "amount unless an error occurs."
23888 #: ../fish/guestfish-actions.pod:879
23889 msgid "See also L</download>, L</pread>."
23893 #: ../fish/guestfish-actions.pod:883
23894 msgid "drop-caches"
23898 #: ../fish/guestfish-actions.pod:885
23901 " drop-caches whattodrop\n"
23906 #: ../fish/guestfish-actions.pod:897
23911 #: ../fish/guestfish-actions.pod:899
23919 #: ../fish/guestfish-actions.pod:911
23924 #: ../fish/guestfish-actions.pod:913
23927 " e2fsck-f device\n"
23932 #: ../fish/guestfish-actions.pod:919
23934 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
23935 "should use L</fsck>."
23939 #: ../fish/guestfish-actions.pod:922
23940 msgid "echo-daemon"
23944 #: ../fish/guestfish-actions.pod:924
23947 " echo-daemon 'words ...'\n"
23952 #: ../fish/guestfish-actions.pod:931
23953 msgid "See also L</ping-daemon>."
23957 #: ../fish/guestfish-actions.pod:933
23962 #: ../fish/guestfish-actions.pod:935
23965 " egrep regex path\n"
23970 #: ../fish/guestfish-actions.pod:943
23975 #: ../fish/guestfish-actions.pod:945
23978 " egrepi regex path\n"
23983 #: ../fish/guestfish-actions.pod:953
23988 #: ../fish/guestfish-actions.pod:955
23991 " equal file1 file2\n"
23996 #: ../fish/guestfish-actions.pod:962
24001 #: ../fish/guestfish-actions.pod:964
24009 #: ../fish/guestfish-actions.pod:969
24010 msgid "See also L</is-file>, L</is-dir>, L</stat>."
24014 #: ../fish/guestfish-actions.pod:971
24019 #: ../fish/guestfish-actions.pod:973
24022 " fallocate path len\n"
24027 #: ../fish/guestfish-actions.pod:990
24028 msgid "fallocate64"
24032 #: ../fish/guestfish-actions.pod:992
24035 " fallocate64 path len\n"
24040 #: ../fish/guestfish-actions.pod:998
24042 "Note that this call allocates disk blocks for the file. To create a sparse "
24043 "file use L</truncate-size> instead."
24047 #: ../fish/guestfish-actions.pod:1001
24049 "The deprecated call L</fallocate> does the same, but owing to an oversight "
24050 "it only allowed 30 bit lengths to be specified, effectively limiting the "
24051 "maximum size of files created through that call to 1GB."
24055 #: ../fish/guestfish-actions.pod:1010
24060 #: ../fish/guestfish-actions.pod:1012
24063 " fgrep pattern path\n"
24068 #: ../fish/guestfish-actions.pod:1020
24073 #: ../fish/guestfish-actions.pod:1022
24076 " fgrepi pattern path\n"
24081 #: ../fish/guestfish-actions.pod:1030
24086 #: ../fish/guestfish-actions.pod:1032
24094 #: ../fish/guestfish-actions.pod:1048
24096 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
24097 "(etc), L</is-zero>."
24101 #: ../fish/guestfish-actions.pod:1051
24102 msgid "file-architecture"
24106 #: ../fish/guestfish-actions.pod:1053
24109 " file-architecture filename\n"
24114 #: ../fish/guestfish-actions.pod:1156
24119 #: ../fish/guestfish-actions.pod:1158
24127 #: ../fish/guestfish-actions.pod:1162
24129 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
24130 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
24134 #: ../fish/guestfish-actions.pod:1166
24139 #: ../fish/guestfish-actions.pod:1168
24142 " fill c len path\n"
24147 #: ../fish/guestfish-actions.pod:1174
24149 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
24150 "L</truncate-size>. To create a file with a pattern of repeating bytes use L"
24155 #: ../fish/guestfish-actions.pod:1179
24156 msgid "fill-pattern"
24160 #: ../fish/guestfish-actions.pod:1181
24163 " fill-pattern pattern len path\n"
24168 #: ../fish/guestfish-actions.pod:1183
24170 "This function is like L</fill> except that it creates a new file of length "
24171 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern"
24172 " is truncated if necessary to ensure the length of the file is exactly "
24177 #: ../fish/guestfish-actions.pod:1188
24182 #: ../fish/guestfish-actions.pod:1190
24185 " find directory\n"
24190 #: ../fish/guestfish-actions.pod:1204
24191 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
24195 #: ../fish/guestfish-actions.pod:1217
24196 msgid "See also L</find0>."
24200 #: ../fish/guestfish-actions.pod:1222
24205 #: ../fish/guestfish-actions.pod:1224
24208 " find0 directory (files|-)\n"
24213 #: ../fish/guestfish-actions.pod:1230
24215 "This command works the same way as L</find> with the following exceptions:"
24219 #: ../fish/guestfish-actions.pod:1257
24220 msgid "findfs-label"
24224 #: ../fish/guestfish-actions.pod:1259
24227 " findfs-label label\n"
24232 #: ../fish/guestfish-actions.pod:1265
24233 msgid "To find the label of a filesystem, use L</vfs-label>."
24237 #: ../fish/guestfish-actions.pod:1267
24238 msgid "findfs-uuid"
24242 #: ../fish/guestfish-actions.pod:1269
24245 " findfs-uuid uuid\n"
24250 #: ../fish/guestfish-actions.pod:1275
24251 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
24255 #: ../fish/guestfish-actions.pod:1277
24260 #: ../fish/guestfish-actions.pod:1279
24263 " fsck fstype device\n"
24268 #: ../fish/guestfish-actions.pod:1309
24273 #: ../fish/guestfish-actions.pod:1311
24281 #: ../fish/guestfish-actions.pod:1318
24282 msgid "get-attach-method"
24286 #: ../fish/guestfish-actions.pod:1320
24289 " get-attach-method\n"
24294 #: ../fish/guestfish-actions.pod:1322
24295 msgid "Return the current attach method. See L</set-attach-method>."
24299 #: ../fish/guestfish-actions.pod:1324
24300 msgid "get-autosync"
24304 #: ../fish/guestfish-actions.pod:1326
24312 #: ../fish/guestfish-actions.pod:1330
24317 #: ../fish/guestfish-actions.pod:1332
24325 #: ../fish/guestfish-actions.pod:1336
24326 msgid "get-e2label"
24330 #: ../fish/guestfish-actions.pod:1338
24333 " get-e2label device\n"
24338 #: ../fish/guestfish-actions.pod:1350
24343 #: ../fish/guestfish-actions.pod:1352
24346 " get-e2uuid device\n"
24351 #: ../fish/guestfish-actions.pod:1364
24352 msgid "get-memsize"
24356 #: ../fish/guestfish-actions.pod:1366
24364 #: ../fish/guestfish-actions.pod:1371
24366 "If L</set-memsize> was not called on this handle, and if "
24367 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default"
24368 " value for memsize."
24372 #: ../fish/guestfish-actions.pod:1378
24373 msgid "get-network"
24377 #: ../fish/guestfish-actions.pod:1380
24385 #: ../fish/guestfish-actions.pod:1384
24390 #: ../fish/guestfish-actions.pod:1386
24398 #: ../fish/guestfish-actions.pod:1393
24403 #: ../fish/guestfish-actions.pod:1395
24411 #: ../fish/guestfish-actions.pod:1399
24416 #: ../fish/guestfish-actions.pod:1401
24421 #: ../fish/guestfish-actions.pod:1403
24429 #: ../fish/guestfish-actions.pod:1410
24434 #: ../fish/guestfish-actions.pod:1412
24442 #: ../fish/guestfish-actions.pod:1419
24443 msgid "get-recovery-proc"
24447 #: ../fish/guestfish-actions.pod:1421
24450 " get-recovery-proc\n"
24455 #: ../fish/guestfish-actions.pod:1425
24456 msgid "get-selinux"
24460 #: ../fish/guestfish-actions.pod:1427
24468 #: ../fish/guestfish-actions.pod:1429
24470 "This returns the current setting of the selinux flag which is passed to the "
24471 "appliance at boot time. See L</set-selinux>."
24475 #: ../fish/guestfish-actions.pod:1435
24480 #: ../fish/guestfish-actions.pod:1437
24488 #: ../fish/guestfish-actions.pod:1444
24493 #: ../fish/guestfish-actions.pod:1446
24501 #: ../fish/guestfish-actions.pod:1450
24506 #: ../fish/guestfish-actions.pod:1452
24514 #: ../fish/guestfish-actions.pod:1454
24516 "Return the current umask. By default the umask is C<022> unless it has been"
24517 " set by calling L</umask>."
24521 #: ../fish/guestfish-actions.pod:1457
24522 msgid "get-verbose"
24526 #: ../fish/guestfish-actions.pod:1459
24534 #: ../fish/guestfish-actions.pod:1463
24539 #: ../fish/guestfish-actions.pod:1465
24547 #: ../fish/guestfish-actions.pod:1469
24548 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
24552 #: ../fish/guestfish-actions.pod:1472
24557 #: ../fish/guestfish-actions.pod:1474
24560 " getxattr path name\n"
24565 #: ../fish/guestfish-actions.pod:1476
24567 "Get a single extended attribute from file C<path> named C<name>. This call "
24568 "follows symlinks. If you want to lookup an extended attribute for the "
24569 "symlink itself, use L</lgetxattr>."
24573 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
24575 "Normally it is better to get all extended attributes from a file in one go "
24576 "by calling L</getxattrs>. However some Linux filesystem implementations are"
24577 " buggy and do not provide a way to list out attributes. For these "
24578 "filesystems (notably ntfs-3g) you have to know the names of the extended "
24579 "attributes you want in advance and call this function."
24583 #: ../fish/guestfish-actions.pod:1490
24584 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
24588 #: ../fish/guestfish-actions.pod:1492
24593 #: ../fish/guestfish-actions.pod:1494
24596 " getxattrs path\n"
24601 #: ../fish/guestfish-actions.pod:1502
24602 msgid "See also: L</lgetxattrs>, L<attr(5)>."
24606 #: ../fish/guestfish-actions.pod:1504
24607 msgid "glob-expand"
24611 #: ../fish/guestfish-actions.pod:1506
24614 " glob-expand pattern\n"
24619 #: ../fish/guestfish-actions.pod:1519
24624 #: ../fish/guestfish-actions.pod:1521
24627 " grep regex path\n"
24632 #: ../fish/guestfish-actions.pod:1529
24637 #: ../fish/guestfish-actions.pod:1531
24640 " grepi regex path\n"
24645 #: ../fish/guestfish-actions.pod:1539
24646 msgid "grub-install"
24650 #: ../fish/guestfish-actions.pod:1541
24653 " grub-install root device\n"
24658 #: ../fish/guestfish-actions.pod:1557
24663 #: ../fish/guestfish-actions.pod:1559
24671 #: ../fish/guestfish-actions.pod:1567
24676 #: ../fish/guestfish-actions.pod:1569
24679 " head-n nrlines path\n"
24684 #: ../fish/guestfish-actions.pod:1582
24689 #: ../fish/guestfish-actions.pod:1584
24697 #: ../fish/guestfish-actions.pod:1592
24702 #: ../fish/guestfish-actions.pod:1594
24705 " initrd-cat initrdpath filename\n"
24710 #: ../fish/guestfish-actions.pod:1606
24711 msgid "See also L</initrd-list>."
24715 #: ../fish/guestfish-actions.pod:1611
24716 msgid "initrd-list"
24720 #: ../fish/guestfish-actions.pod:1613
24723 " initrd-list path\n"
24728 #: ../fish/guestfish-actions.pod:1625
24729 msgid "inotify-add-watch"
24733 #: ../fish/guestfish-actions.pod:1627
24736 " inotify-add-watch path mask\n"
24741 #: ../fish/guestfish-actions.pod:1639
24742 msgid "inotify-close"
24746 #: ../fish/guestfish-actions.pod:1641
24754 #: ../fish/guestfish-actions.pod:1647
24755 msgid "inotify-files"
24759 #: ../fish/guestfish-actions.pod:1649
24767 #: ../fish/guestfish-actions.pod:1651
24769 "This function is a helpful wrapper around L</inotify-read> which just "
24770 "returns a list of pathnames of objects that were touched. The returned "
24771 "pathnames are sorted and deduplicated."
24775 #: ../fish/guestfish-actions.pod:1655
24776 msgid "inotify-init"
24780 #: ../fish/guestfish-actions.pod:1657
24783 " inotify-init maxevents\n"
24788 #: ../fish/guestfish-actions.pod:1663
24790 "C<maxevents> is the maximum number of events which will be queued up between"
24791 " calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>,"
24792 " then the kernel (or previously set) default is used. For Linux 2.6.29 the"
24793 " default was 16384 events. Beyond this limit, the kernel throws away "
24794 "events, but records the fact that it threw them away by setting a flag "
24795 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
24799 #: ../fish/guestfish-actions.pod:1673
24801 "Before any events are generated, you have to add some watches to the "
24802 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and L"
24803 "</inotify-watch-all>."
24807 #: ../fish/guestfish-actions.pod:1679
24809 "Queued up events should be read periodically by calling L</inotify-read> (or"
24810 " L</inotify-files> which is just a helpful wrapper around L</inotify-read>)."
24811 " If you don't read the events out often enough then you risk the internal "
24812 "queue overflowing."
24816 #: ../fish/guestfish-actions.pod:1686
24818 "The handle should be closed after use by calling L</inotify-close>. This "
24819 "also removes any watches automatically."
24823 #: ../fish/guestfish-actions.pod:1695
24824 msgid "inotify-read"
24828 #: ../fish/guestfish-actions.pod:1697
24836 #: ../fish/guestfish-actions.pod:1710
24837 msgid "inotify-rm-watch"
24841 #: ../fish/guestfish-actions.pod:1712
24844 " inotify-rm-watch wd\n"
24849 #: ../fish/guestfish-actions.pod:1714
24850 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
24854 #: ../fish/guestfish-actions.pod:1717
24855 msgid "inspect-get-arch"
24859 #: ../fish/guestfish-actions.pod:1719
24862 " inspect-get-arch root\n"
24867 #: ../fish/guestfish-actions.pod:1721
24869 "This returns the architecture of the inspected operating system. The "
24870 "possible return values are listed under L</file-architecture>."
24874 #: ../fish/guestfish-actions.pod:1730
24875 msgid "inspect-get-distro"
24879 #: ../fish/guestfish-actions.pod:1732
24882 " inspect-get-distro root\n"
24887 #: ../fish/guestfish-actions.pod:1813
24888 msgid "inspect-get-drive-mappings"
24892 #: ../fish/guestfish-actions.pod:1815
24895 " inspect-get-drive-mappings root\n"
24900 #: ../fish/guestfish-actions.pod:1842
24902 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24903 "get-mountpoints>, L</inspect-get-filesystems>."
24907 #: ../fish/guestfish-actions.pod:1846
24908 msgid "inspect-get-filesystems"
24912 #: ../fish/guestfish-actions.pod:1848
24915 " inspect-get-filesystems root\n"
24920 #: ../fish/guestfish-actions.pod:1858
24922 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24923 "get-mountpoints>."
24927 #: ../fish/guestfish-actions.pod:1861
24928 msgid "inspect-get-format"
24932 #: ../fish/guestfish-actions.pod:1863
24935 " inspect-get-format root\n"
24940 #: ../fish/guestfish-actions.pod:1892
24941 msgid "inspect-get-hostname"
24945 #: ../fish/guestfish-actions.pod:1894
24948 " inspect-get-hostname root\n"
24953 #: ../fish/guestfish-actions.pod:1904
24954 msgid "inspect-get-icon"
24958 #: ../fish/guestfish-actions.pod:1906
24961 " inspect-get-icon root [favicon:..] [highquality:..]\n"
24966 #: ../fish/guestfish-actions.pod:1970
24967 msgid "inspect-get-major-version"
24971 #: ../fish/guestfish-actions.pod:1972
24974 " inspect-get-major-version root\n"
24979 #: ../fish/guestfish-actions.pod:1988
24980 msgid "inspect-get-minor-version"
24984 #: ../fish/guestfish-actions.pod:1990
24987 " inspect-get-minor-version root\n"
24992 #: ../fish/guestfish-actions.pod:1997
24994 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
24995 "get-major-version>."
24999 #: ../fish/guestfish-actions.pod:2000
25000 msgid "inspect-get-mountpoints"
25004 #: ../fish/guestfish-actions.pod:2002
25007 " inspect-get-mountpoints root\n"
25012 #: ../fish/guestfish-actions.pod:2021
25014 "For operating systems like Windows which still use drive letters, this call "
25015 "will only return an entry for the first drive \"mounted on\" C</>. For "
25016 "information about the mapping of drive letters to partitions, see L"
25017 "</inspect-get-drive-mappings>."
25021 #: ../fish/guestfish-actions.pod:2027
25023 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25024 "get-filesystems>."
25028 #: ../fish/guestfish-actions.pod:2030
25029 msgid "inspect-get-package-format"
25033 #: ../fish/guestfish-actions.pod:2032
25036 " inspect-get-package-format root\n"
25041 #: ../fish/guestfish-actions.pod:2034
25043 "This function and L</inspect-get-package-management> return the package "
25044 "format and package management tool used by the inspected operating system. "
25045 "For example for Fedora these functions would return C<rpm> (package format) "
25046 "and C<yum> (package management)."
25050 #: ../fish/guestfish-actions.pod:2049
25051 msgid "inspect-get-package-management"
25055 #: ../fish/guestfish-actions.pod:2051
25058 " inspect-get-package-management root\n"
25063 #: ../fish/guestfish-actions.pod:2053
25065 "L</inspect-get-package-format> and this function return the package format "
25066 "and package management tool used by the inspected operating system. For "
25067 "example for Fedora these functions would return C<rpm> (package format) and "
25068 "C<yum> (package management)."
25072 #: ../fish/guestfish-actions.pod:2070
25073 msgid "inspect-get-product-name"
25077 #: ../fish/guestfish-actions.pod:2072
25080 " inspect-get-product-name root\n"
25085 #: ../fish/guestfish-actions.pod:2084
25086 msgid "inspect-get-product-variant"
25090 #: ../fish/guestfish-actions.pod:2086
25093 " inspect-get-product-variant root\n"
25098 #: ../fish/guestfish-actions.pod:2107
25100 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
25101 "get-product-name>, L</inspect-get-major-version>."
25105 #: ../fish/guestfish-actions.pod:2111
25106 msgid "inspect-get-roots"
25110 #: ../fish/guestfish-actions.pod:2113
25113 " inspect-get-roots\n"
25118 #: ../fish/guestfish-actions.pod:2115
25120 "This function is a convenient way to get the list of root devices, as "
25121 "returned from a previous call to L</inspect-os>, but without redoing the "
25122 "whole inspection process."
25126 #: ../fish/guestfish-actions.pod:2119
25128 "This returns an empty list if either no root devices were found or the "
25129 "caller has not called L</inspect-os>."
25133 #: ../fish/guestfish-actions.pod:2124
25134 msgid "inspect-get-type"
25138 #: ../fish/guestfish-actions.pod:2126
25141 " inspect-get-type root\n"
25146 #: ../fish/guestfish-actions.pod:2156
25147 msgid "inspect-get-windows-current-control-set"
25151 #: ../fish/guestfish-actions.pod:2158
25154 " inspect-get-windows-current-control-set root\n"
25159 #: ../fish/guestfish-actions.pod:2169
25160 msgid "inspect-get-windows-systemroot"
25164 #: ../fish/guestfish-actions.pod:2171
25167 " inspect-get-windows-systemroot root\n"
25172 #: ../fish/guestfish-actions.pod:2182
25173 msgid "inspect-is-live"
25177 #: ../fish/guestfish-actions.pod:2184
25180 " inspect-is-live root\n"
25185 #: ../fish/guestfish-actions.pod:2186
25187 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25188 "then this returns true if a live image was detected on the disk."
25192 #: ../fish/guestfish-actions.pod:2192
25193 msgid "inspect-is-multipart"
25197 #: ../fish/guestfish-actions.pod:2194
25200 " inspect-is-multipart root\n"
25205 #: ../fish/guestfish-actions.pod:2196
25207 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25208 "then this returns true if the disk is part of a set."
25212 #: ../fish/guestfish-actions.pod:2202
25213 msgid "inspect-is-netinst"
25217 #: ../fish/guestfish-actions.pod:2204
25220 " inspect-is-netinst root\n"
25225 #: ../fish/guestfish-actions.pod:2206
25227 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
25228 "then this returns true if the disk is a network installer, ie. not a self-"
25229 "contained install CD but one which is likely to require network access to "
25230 "complete the install."
25234 #: ../fish/guestfish-actions.pod:2214
25235 msgid "inspect-list-applications"
25239 #: ../fish/guestfish-actions.pod:2216
25242 " inspect-list-applications root\n"
25247 #: ../fish/guestfish-actions.pod:2220
25249 "I<Note:> This call works differently from other parts of the inspection API."
25250 " You have to call L</inspect-os>, then L</inspect-get-mountpoints>, then "
25251 "mount up the disks, before calling this. Listing applications is a "
25252 "significantly more difficult operation which requires access to the full "
25253 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
25254 "are just returning data cached in the libguestfs handle, this call actually "
25255 "reads parts of the mounted filesystems during the call."
25259 #: ../fish/guestfish-actions.pod:2310
25264 #: ../fish/guestfish-actions.pod:2312
25272 #: ../fish/guestfish-actions.pod:2327
25274 "You can pass the root string(s) returned to other L</inspect-get-*> "
25275 "functions in order to query further information about each operating system,"
25276 " such as the name and version."
25280 #: ../fish/guestfish-actions.pod:2332
25282 "This function uses other libguestfs features such as L</mount-ro> and L"
25283 "</umount-all> in order to mount and unmount filesystems and look at the "
25284 "contents. This should be called with no disks currently mounted. The "
25285 "function may also use Augeas, so any existing Augeas handle will be closed."
25289 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542
25290 #: ../fish/guestfish-actions.pod:2601
25291 msgid "See also L</list-filesystems>."
25295 #: ../fish/guestfish-actions.pod:2346
25296 msgid "is-blockdev"
25300 #: ../fish/guestfish-actions.pod:2348
25303 " is-blockdev path\n"
25308 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371
25309 #: ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399
25310 #: ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443
25311 #: ../fish/guestfish-actions.pod:2452
25312 msgid "See also L</stat>."
25316 #: ../fish/guestfish-actions.pod:2355
25321 #: ../fish/guestfish-actions.pod:2357
25329 #: ../fish/guestfish-actions.pod:2364
25334 #: ../fish/guestfish-actions.pod:2366
25337 " is-chardev path\n"
25342 #: ../fish/guestfish-actions.pod:2373
25347 #: ../fish/guestfish-actions.pod:2375
25355 #: ../fish/guestfish-actions.pod:2382
25360 #: ../fish/guestfish-actions.pod:2384
25368 #: ../fish/guestfish-actions.pod:2392
25373 #: ../fish/guestfish-actions.pod:2394
25381 #: ../fish/guestfish-actions.pod:2401
25386 #: ../fish/guestfish-actions.pod:2403
25394 #: ../fish/guestfish-actions.pod:2411
25395 msgid "is-launching"
25399 #: ../fish/guestfish-actions.pod:2413
25407 #: ../fish/guestfish-actions.pod:2420
25412 #: ../fish/guestfish-actions.pod:2422
25420 #: ../fish/guestfish-actions.pod:2427
25425 #: ../fish/guestfish-actions.pod:2429
25433 #: ../fish/guestfish-actions.pod:2436
25438 #: ../fish/guestfish-actions.pod:2438
25441 " is-socket path\n"
25446 #: ../fish/guestfish-actions.pod:2445
25451 #: ../fish/guestfish-actions.pod:2447
25454 " is-symlink path\n"
25459 #: ../fish/guestfish-actions.pod:2454
25464 #: ../fish/guestfish-actions.pod:2456
25472 #: ../fish/guestfish-actions.pod:2461
25473 msgid "is-zero-device"
25477 #: ../fish/guestfish-actions.pod:2463
25480 " is-zero-device device\n"
25485 #: ../fish/guestfish-actions.pod:2469
25486 msgid "kill-subprocess"
25490 #: ../fish/guestfish-actions.pod:2471
25493 " kill-subprocess\n"
25498 #: ../fish/guestfish-actions.pod:2475
25503 #: ../fish/guestfish-actions.pod:2477
25508 #: ../fish/guestfish-actions.pod:2479
25516 #: ../fish/guestfish-actions.pod:2487
25521 #: ../fish/guestfish-actions.pod:2489
25524 " lchown owner group path\n"
25529 #: ../fish/guestfish-actions.pod:2491
25531 "Change the file owner to C<owner> and group to C<group>. This is like "
25532 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
25537 #: ../fish/guestfish-actions.pod:2499
25542 #: ../fish/guestfish-actions.pod:2501
25545 " lgetxattr path name\n"
25550 #: ../fish/guestfish-actions.pod:2517
25551 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
25555 #: ../fish/guestfish-actions.pod:2519
25560 #: ../fish/guestfish-actions.pod:2521
25563 " lgetxattrs path\n"
25568 #: ../fish/guestfish-actions.pod:2523
25570 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
25571 "it returns the extended attributes of the link itself."
25575 #: ../fish/guestfish-actions.pod:2527
25580 #: ../fish/guestfish-actions.pod:2529
25588 #: ../fish/guestfish-actions.pod:2534
25589 msgid "list-devices"
25593 #: ../fish/guestfish-actions.pod:2536
25601 #: ../fish/guestfish-actions.pod:2544
25602 msgid "list-dm-devices"
25606 #: ../fish/guestfish-actions.pod:2546
25609 " list-dm-devices\n"
25614 #: ../fish/guestfish-actions.pod:2550
25616 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25617 "previous call to L</luks-open>."
25621 #: ../fish/guestfish-actions.pod:2553
25623 "Device mapper devices which correspond to logical volumes are I<not> "
25624 "returned in this list. Call L</lvs> if you want to list logical volumes."
25628 #: ../fish/guestfish-actions.pod:2557
25629 msgid "list-filesystems"
25633 #: ../fish/guestfish-actions.pod:2559
25636 " list-filesystems\n"
25641 #: ../fish/guestfish-actions.pod:2578
25643 "This command runs other libguestfs commands, which might include L</mount> "
25644 "and L</umount>, and therefore you should use this soon after launch and only"
25645 " when nothing is mounted."
25649 #: ../fish/guestfish-actions.pod:2582
25651 "Not all of the filesystems returned will be mountable. In particular, swap "
25652 "partitions are returned in the list. Also this command does not check that "
25653 "each filesystem found is valid and mountable, and some filesystems might be "
25654 "mountable but require special options. Filesystems may not all belong to a "
25655 "single logical operating system (use L</inspect-os> to look for OSes)."
25659 #: ../fish/guestfish-actions.pod:2590
25660 msgid "list-partitions"
25664 #: ../fish/guestfish-actions.pod:2592
25667 " list-partitions\n"
25672 #: ../fish/guestfish-actions.pod:2598
25674 "This does not return logical volumes. For that you will need to call "
25679 #: ../fish/guestfish-actions.pod:2603
25684 #: ../fish/guestfish-actions.pod:2605
25692 #: ../fish/guestfish-actions.pod:2613
25697 #: ../fish/guestfish-actions.pod:2615
25700 " ln target linkname\n"
25705 #: ../fish/guestfish-actions.pod:2619
25710 #: ../fish/guestfish-actions.pod:2621
25713 " ln-f target linkname\n"
25718 #: ../fish/guestfish-actions.pod:2626
25723 #: ../fish/guestfish-actions.pod:2628
25726 " ln-s target linkname\n"
25731 #: ../fish/guestfish-actions.pod:2632
25736 #: ../fish/guestfish-actions.pod:2634
25739 " ln-sf target linkname\n"
25744 #: ../fish/guestfish-actions.pod:2639
25745 msgid "lremovexattr"
25749 #: ../fish/guestfish-actions.pod:2641
25752 " lremovexattr xattr path\n"
25757 #: ../fish/guestfish-actions.pod:2643
25759 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then"
25760 " it removes an extended attribute of the link itself."
25764 #: ../fish/guestfish-actions.pod:2647
25769 #: ../fish/guestfish-actions.pod:2649
25777 #: ../fish/guestfish-actions.pod:2655
25779 "This command is mostly useful for interactive sessions. Programs should "
25780 "probably use L</readdir> instead."
25784 #: ../fish/guestfish-actions.pod:2658
25789 #: ../fish/guestfish-actions.pod:2660
25792 " lsetxattr xattr val vallen path\n"
25797 #: ../fish/guestfish-actions.pod:2662
25799 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it"
25800 " sets an extended attribute of the link itself."
25804 #: ../fish/guestfish-actions.pod:2666
25809 #: ../fish/guestfish-actions.pod:2668
25817 #: ../fish/guestfish-actions.pod:2672
25819 "This is the same as L</stat> except that if C<path> is a symbolic link, then"
25820 " the link is stat-ed, not the file it refers to."
25824 #: ../fish/guestfish-actions.pod:2678
25829 #: ../fish/guestfish-actions.pod:2680
25832 " lstatlist path 'names ...'\n"
25837 #: ../fish/guestfish-actions.pod:2682
25839 "This call allows you to perform the L</lstat> operation on multiple files, "
25840 "where all files are in the directory C<path>. C<names> is the list of files"
25841 " from this directory."
25845 #: ../fish/guestfish-actions.pod:2691
25847 "This call is intended for programs that want to efficiently list a directory"
25848 " contents without making many round-trips. See also L</lxattrlist> for a "
25849 "similarly efficient call for getting extended attributes. Very long "
25850 "directory listings might cause the protocol message size to be exceeded, "
25851 "causing this call to fail. The caller must split up such requests into "
25852 "smaller groups of names."
25856 #: ../fish/guestfish-actions.pod:2699
25857 msgid "luks-add-key"
25861 #: ../fish/guestfish-actions.pod:2701
25864 " luks-add-key device keyslot\n"
25869 #: ../fish/guestfish-actions.pod:2708
25871 "Note that if C<keyslot> already contains a key, then this command will fail."
25872 " You have to use L</luks-kill-slot> first to remove that key."
25876 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734
25877 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761
25878 #: ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
25880 "This command has one or more key or passphrase parameters. Guestfish will "
25881 "prompt for these separately."
25885 #: ../fish/guestfish-actions.pod:2715
25890 #: ../fish/guestfish-actions.pod:2717
25893 " luks-close device\n"
25898 #: ../fish/guestfish-actions.pod:2719
25900 "This closes a LUKS device that was created earlier by L</luks-open> or L"
25901 "</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
25902 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25903 "underlying block device."
25907 #: ../fish/guestfish-actions.pod:2725
25908 msgid "luks-format"
25912 #: ../fish/guestfish-actions.pod:2727
25915 " luks-format device keyslot\n"
25920 #: ../fish/guestfish-actions.pod:2740
25921 msgid "luks-format-cipher"
25925 #: ../fish/guestfish-actions.pod:2742
25928 " luks-format-cipher device keyslot cipher\n"
25933 #: ../fish/guestfish-actions.pod:2744
25935 "This command is the same as L</luks-format> but it also allows you to set "
25936 "the C<cipher> used."
25940 #: ../fish/guestfish-actions.pod:2753
25941 msgid "luks-kill-slot"
25945 #: ../fish/guestfish-actions.pod:2755
25948 " luks-kill-slot device keyslot\n"
25953 #: ../fish/guestfish-actions.pod:2764
25958 #: ../fish/guestfish-actions.pod:2766
25961 " luks-open device mapname\n"
25966 #: ../fish/guestfish-actions.pod:2780
25968 "If this block device contains LVM volume groups, then calling L</vgscan> "
25969 "followed by L</vg-activate-all> will make them visible."
25973 #: ../fish/guestfish-actions.pod:2784
25974 msgid "Use L</list-dm-devices> to list all device mapper devices."
25978 #: ../fish/guestfish-actions.pod:2790
25979 msgid "luks-open-ro"
25983 #: ../fish/guestfish-actions.pod:2792
25986 " luks-open-ro device mapname\n"
25991 #: ../fish/guestfish-actions.pod:2794
25993 "This is the same as L</luks-open> except that a read-only mapping is "
25998 #: ../fish/guestfish-actions.pod:2800
26003 #: ../fish/guestfish-actions.pod:2802
26006 " lvcreate logvol volgroup mbytes\n"
26011 #: ../fish/guestfish-actions.pod:2807
26012 msgid "lvm-canonical-lv-name"
26016 #: ../fish/guestfish-actions.pod:2809
26019 " lvm-canonical-lv-name lvname\n"
26024 #: ../fish/guestfish-actions.pod:2818
26025 msgid "See also L</is-lv>."
26029 #: ../fish/guestfish-actions.pod:2820
26030 msgid "lvm-clear-filter"
26034 #: ../fish/guestfish-actions.pod:2822
26037 " lvm-clear-filter\n"
26042 #: ../fish/guestfish-actions.pod:2824
26044 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every"
26049 #: ../fish/guestfish-actions.pod:2830
26050 msgid "lvm-remove-all"
26054 #: ../fish/guestfish-actions.pod:2832
26057 " lvm-remove-all\n"
26062 #: ../fish/guestfish-actions.pod:2840
26063 msgid "lvm-set-filter"
26067 #: ../fish/guestfish-actions.pod:2842
26070 " lvm-set-filter 'devices ...'\n"
26075 #: ../fish/guestfish-actions.pod:2867
26080 #: ../fish/guestfish-actions.pod:2869
26083 " lvremove device\n"
26088 #: ../fish/guestfish-actions.pod:2877
26093 #: ../fish/guestfish-actions.pod:2879
26096 " lvrename logvol newlogvol\n"
26101 #: ../fish/guestfish-actions.pod:2883
26106 #: ../fish/guestfish-actions.pod:2885
26109 " lvresize device mbytes\n"
26114 #: ../fish/guestfish-actions.pod:2891
26115 msgid "lvresize-free"
26119 #: ../fish/guestfish-actions.pod:2893
26122 " lvresize-free lv percent\n"
26127 #: ../fish/guestfish-actions.pod:2901
26132 #: ../fish/guestfish-actions.pod:2903
26140 #: ../fish/guestfish-actions.pod:2911
26141 msgid "See also L</lvs-full>, L</list-filesystems>."
26145 #: ../fish/guestfish-actions.pod:2913
26150 #: ../fish/guestfish-actions.pod:2915
26158 #: ../fish/guestfish-actions.pod:2920
26163 #: ../fish/guestfish-actions.pod:2922
26171 #: ../fish/guestfish-actions.pod:2926
26176 #: ../fish/guestfish-actions.pod:2928
26179 " lxattrlist path 'names ...'\n"
26184 #: ../fish/guestfish-actions.pod:2944
26186 "This call is intended for programs that want to efficiently list a directory"
26187 " contents without making many round-trips. See also L</lstatlist> for a "
26188 "similarly efficient call for getting standard stats. Very long directory "
26189 "listings might cause the protocol message size to be exceeded, causing this "
26190 "call to fail. The caller must split up such requests into smaller groups of"
26195 #: ../fish/guestfish-actions.pod:2952
26200 #: ../fish/guestfish-actions.pod:2954
26208 #: ../fish/guestfish-actions.pod:2958
26213 #: ../fish/guestfish-actions.pod:2960
26216 " mkdir-mode path mode\n"
26221 #: ../fish/guestfish-actions.pod:2969
26222 msgid "See also L</mkdir>, L</umask>"
26226 #: ../fish/guestfish-actions.pod:2971
26231 #: ../fish/guestfish-actions.pod:2973
26239 #: ../fish/guestfish-actions.pod:2978
26244 #: ../fish/guestfish-actions.pod:2980
26247 " mkdtemp template\n"
26252 #: ../fish/guestfish-actions.pod:3001
26257 #: ../fish/guestfish-actions.pod:3003
26260 " mke2fs-J fstype blocksize device journal\n"
26265 #: ../fish/guestfish-actions.pod:3011
26266 msgid "See also L</mke2journal>."
26270 #: ../fish/guestfish-actions.pod:3013
26275 #: ../fish/guestfish-actions.pod:3015
26278 " mke2fs-JL fstype blocksize device label\n"
26283 #: ../fish/guestfish-actions.pod:3020
26284 msgid "See also L</mke2journal-L>."
26288 #: ../fish/guestfish-actions.pod:3022
26293 #: ../fish/guestfish-actions.pod:3024
26296 " mke2fs-JU fstype blocksize device uuid\n"
26301 #: ../fish/guestfish-actions.pod:3029
26302 msgid "See also L</mke2journal-U>."
26306 #: ../fish/guestfish-actions.pod:3031
26307 msgid "mke2journal"
26311 #: ../fish/guestfish-actions.pod:3033
26314 " mke2journal blocksize device\n"
26319 #: ../fish/guestfish-actions.pod:3040
26320 msgid "mke2journal-L"
26324 #: ../fish/guestfish-actions.pod:3042
26327 " mke2journal-L blocksize label device\n"
26332 #: ../fish/guestfish-actions.pod:3046
26333 msgid "mke2journal-U"
26337 #: ../fish/guestfish-actions.pod:3048
26340 " mke2journal-U blocksize uuid device\n"
26345 #: ../fish/guestfish-actions.pod:3052
26350 #: ../fish/guestfish-actions.pod:3054
26353 " mkfifo mode path\n"
26358 #: ../fish/guestfish-actions.pod:3056
26360 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26361 "is just a convenient wrapper around L</mknod>."
26365 #: ../fish/guestfish-actions.pod:3062
26370 #: ../fish/guestfish-actions.pod:3064
26373 " mkfs fstype device\n"
26378 #: ../fish/guestfish-actions.pod:3070
26383 #: ../fish/guestfish-actions.pod:3072
26386 " mkfs-b fstype blocksize device\n"
26391 #: ../fish/guestfish-actions.pod:3074
26393 "This call is similar to L</mkfs>, but it allows you to control the block "
26394 "size of the resulting filesystem. Supported block sizes depend on the "
26395 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26399 #: ../fish/guestfish-actions.pod:3089
26404 #: ../fish/guestfish-actions.pod:3091
26407 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
26412 #: ../fish/guestfish-actions.pod:3136
26413 msgid "mkmountpoint"
26417 #: ../fish/guestfish-actions.pod:3138
26420 " mkmountpoint exemptpath\n"
26425 #: ../fish/guestfish-actions.pod:3140
26427 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used"
26428 " to create extra mountpoints before mounting the first filesystem."
26432 #: ../fish/guestfish-actions.pod:3164
26434 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
26435 "unexpected errors if you try to mix these calls. It is safest to manually "
26436 "unmount filesystems and remove mountpoints after use."
26440 #: ../fish/guestfish-actions.pod:3168
26442 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
26443 "for this to work for manual mountpoints, you must ensure that the innermost "
26444 "mountpoints have the longest pathnames, as in the example code above."
26448 #: ../fish/guestfish-actions.pod:3175
26450 "Autosync [see L</set-autosync>, this is set by default on handles] can cause"
26451 " L</umount-all> to be called when the handle is closed which can also "
26452 "trigger these issues."
26456 #: ../fish/guestfish-actions.pod:3179
26461 #: ../fish/guestfish-actions.pod:3181
26464 " mknod mode devmajor devminor path\n"
26469 #: ../fish/guestfish-actions.pod:3191
26471 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26472 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26473 "regular file). These constants are available in the standard Linux header "
26474 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
26475 "wrappers around this command which bitwise OR in the appropriate constant "
26480 #: ../fish/guestfish-actions.pod:3201
26485 #: ../fish/guestfish-actions.pod:3203
26488 " mknod-b mode devmajor devminor path\n"
26493 #: ../fish/guestfish-actions.pod:3205
26495 "This call creates a block device node called C<path> with mode C<mode> and "
26496 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26497 "wrapper around L</mknod>."
26501 #: ../fish/guestfish-actions.pod:3211
26506 #: ../fish/guestfish-actions.pod:3213
26509 " mknod-c mode devmajor devminor path\n"
26514 #: ../fish/guestfish-actions.pod:3215
26516 "This call creates a char device node called C<path> with mode C<mode> and "
26517 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26518 "wrapper around L</mknod>."
26522 #: ../fish/guestfish-actions.pod:3221
26527 #: ../fish/guestfish-actions.pod:3223
26535 #: ../fish/guestfish-actions.pod:3227
26540 #: ../fish/guestfish-actions.pod:3229
26543 " mkswap-L label device\n"
26548 #: ../fish/guestfish-actions.pod:3237
26553 #: ../fish/guestfish-actions.pod:3239
26556 " mkswap-U uuid device\n"
26561 #: ../fish/guestfish-actions.pod:3243
26562 msgid "mkswap-file"
26566 #: ../fish/guestfish-actions.pod:3245
26569 " mkswap-file path\n"
26574 #: ../fish/guestfish-actions.pod:3249
26576 "This command just writes a swap file signature to an existing file. To "
26577 "create the file itself, use something like L</fallocate>."
26581 #: ../fish/guestfish-actions.pod:3252
26586 #: ../fish/guestfish-actions.pod:3254
26589 " modprobe modulename\n"
26594 #: ../fish/guestfish-actions.pod:3261
26599 #: ../fish/guestfish-actions.pod:3263
26602 " mount device mountpoint\n"
26607 #: ../fish/guestfish-actions.pod:3279
26609 "B<Important note:> When you use this call, the filesystem options C<sync> "
26610 "and C<noatime> are set implicitly. This was originally done because we "
26611 "thought it would improve reliability, but it turns out that I<-o sync> has a"
26612 " very large negative performance impact and negligible effect on "
26613 "reliability. Therefore we recommend that you avoid using L</mount> in any "
26614 "code that needs performance, and instead use L</mount-options> (use an empty"
26615 " string for the first parameter if you don't want any options)."
26619 #: ../fish/guestfish-actions.pod:3296
26624 #: ../fish/guestfish-actions.pod:3298
26627 " mount-9p mounttag mountpoint [options:..]\n"
26632 #: ../fish/guestfish-actions.pod:3309
26637 #: ../fish/guestfish-actions.pod:3311
26640 " mount-loop file mountpoint\n"
26645 #: ../fish/guestfish-actions.pod:3317
26646 msgid "mount-options"
26650 #: ../fish/guestfish-actions.pod:3319
26653 " mount-options options device mountpoint\n"
26658 #: ../fish/guestfish-actions.pod:3321
26660 "This is the same as the L</mount> command, but it allows you to set the "
26661 "mount options as for the L<mount(8)> I<-o> flag."
26665 #: ../fish/guestfish-actions.pod:3329
26670 #: ../fish/guestfish-actions.pod:3331
26673 " mount-ro device mountpoint\n"
26678 #: ../fish/guestfish-actions.pod:3333
26680 "This is the same as the L</mount> command, but it mounts the filesystem with"
26681 " the read-only (I<-o ro>) flag."
26685 #: ../fish/guestfish-actions.pod:3336
26690 #: ../fish/guestfish-actions.pod:3338
26693 " mount-vfs options vfstype device mountpoint\n"
26698 #: ../fish/guestfish-actions.pod:3340
26700 "This is the same as the L</mount> command, but it allows you to set both the"
26701 " mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
26705 #: ../fish/guestfish-actions.pod:3344
26706 msgid "mountpoints"
26710 #: ../fish/guestfish-actions.pod:3346
26718 #: ../fish/guestfish-actions.pod:3348
26720 "This call is similar to L</mounts>. That call returns a list of devices. "
26721 "This one returns a hash table (map) of device name to directory where the "
26722 "device is mounted."
26726 #: ../fish/guestfish-actions.pod:3352
26731 #: ../fish/guestfish-actions.pod:3354
26739 #: ../fish/guestfish-actions.pod:3361
26740 msgid "See also: L</mountpoints>"
26744 #: ../fish/guestfish-actions.pod:3363
26749 #: ../fish/guestfish-actions.pod:3365
26757 #: ../fish/guestfish-actions.pod:3370
26758 msgid "ntfs-3g-probe"
26762 #: ../fish/guestfish-actions.pod:3372
26765 " ntfs-3g-probe true|false device\n"
26770 #: ../fish/guestfish-actions.pod:3386
26775 #: ../fish/guestfish-actions.pod:3388
26778 " ntfsresize device\n"
26783 #: ../fish/guestfish-actions.pod:3410
26784 msgid "ntfsresize-opts"
26788 #: ../fish/guestfish-actions.pod:3412
26791 " ntfsresize-opts device [size:..] [force:..]\n"
26796 #: ../fish/guestfish-actions.pod:3431
26798 "After the resize operation, the filesystem is always marked as requiring a "
26799 "consistency check (for safety). You have to boot into Windows to perform "
26800 "this check and clear this condition. If you I<don't> set the C<force> "
26801 "option then it is not possible to call L</ntfsresize-opts> multiple times on"
26802 " a single filesystem without booting into Windows between each resize."
26806 #: ../fish/guestfish-actions.pod:3444
26807 msgid "ntfsresize-size"
26811 #: ../fish/guestfish-actions.pod:3446
26814 " ntfsresize-size device size\n"
26819 #: ../fish/guestfish-actions.pod:3448
26821 "This command is the same as L</ntfsresize> except that it allows you to "
26822 "specify the new size (in bytes) explicitly."
26826 #: ../fish/guestfish-actions.pod:3458
26831 #: ../fish/guestfish-actions.pod:3460
26834 " part-add device prlogex startsect endsect\n"
26839 #: ../fish/guestfish-actions.pod:3462
26841 "This command adds a partition to C<device>. If there is no partition table "
26842 "on the device, call L</part-init> first."
26846 #: ../fish/guestfish-actions.pod:3474
26848 "Creating a partition which covers the whole disk is not so easy. Use L"
26849 "</part-disk> to do that."
26853 #: ../fish/guestfish-actions.pod:3477
26858 #: ../fish/guestfish-actions.pod:3479
26861 " part-del device partnum\n"
26866 #: ../fish/guestfish-actions.pod:3487
26871 #: ../fish/guestfish-actions.pod:3489
26874 " part-disk device parttype\n"
26879 #: ../fish/guestfish-actions.pod:3491
26881 "This command is simply a combination of L</part-init> followed by L</part-"
26882 "add> to create a single primary partition covering the whole disk."
26886 #: ../fish/guestfish-actions.pod:3495
26888 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other"
26889 " possible values are described in L</part-init>."
26893 #: ../fish/guestfish-actions.pod:3501
26894 msgid "part-get-bootable"
26898 #: ../fish/guestfish-actions.pod:3503
26901 " part-get-bootable device partnum\n"
26906 #: ../fish/guestfish-actions.pod:3508
26907 msgid "See also L</part-set-bootable>."
26911 #: ../fish/guestfish-actions.pod:3510
26912 msgid "part-get-mbr-id"
26916 #: ../fish/guestfish-actions.pod:3512
26919 " part-get-mbr-id device partnum\n"
26924 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3655
26926 "Note that only MBR (old DOS-style) partitions have type bytes. You will get"
26927 " undefined results for other partition table types (see L</part-get-"
26932 #: ../fish/guestfish-actions.pod:3521
26933 msgid "part-get-parttype"
26937 #: ../fish/guestfish-actions.pod:3523
26940 " part-get-parttype device\n"
26945 #: ../fish/guestfish-actions.pod:3528
26947 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26948 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26949 "possible, although unusual. See L</part-init> for a full list."
26953 #: ../fish/guestfish-actions.pod:3533
26958 #: ../fish/guestfish-actions.pod:3535
26961 " part-init device parttype\n"
26966 #: ../fish/guestfish-actions.pod:3541
26968 "Initially there are no partitions. Following this, you should call L</part-"
26969 "add> for each partition required."
26973 #: ../fish/guestfish-actions.pod:3604
26978 #: ../fish/guestfish-actions.pod:3606
26981 " part-list device\n"
26986 #: ../fish/guestfish-actions.pod:3621
26988 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26989 "the device's sector size, see L</blockdev-getss>."
26993 #: ../fish/guestfish-actions.pod:3634
26994 msgid "part-set-bootable"
26998 #: ../fish/guestfish-actions.pod:3636
27001 " part-set-bootable device partnum true|false\n"
27006 #: ../fish/guestfish-actions.pod:3645
27007 msgid "part-set-mbr-id"
27011 #: ../fish/guestfish-actions.pod:3647
27014 " part-set-mbr-id device partnum idbyte\n"
27019 #: ../fish/guestfish-actions.pod:3659
27020 msgid "part-set-name"
27024 #: ../fish/guestfish-actions.pod:3661
27027 " part-set-name device partnum name\n"
27032 #: ../fish/guestfish-actions.pod:3669
27033 msgid "part-to-dev"
27037 #: ../fish/guestfish-actions.pod:3671
27040 " part-to-dev partition\n"
27045 #: ../fish/guestfish-actions.pod:3677
27047 "The named partition must exist, for example as a string returned from L"
27048 "</list-partitions>."
27052 #: ../fish/guestfish-actions.pod:3680
27053 msgid "ping-daemon"
27057 #: ../fish/guestfish-actions.pod:3682
27065 #: ../fish/guestfish-actions.pod:3689
27070 #: ../fish/guestfish-actions.pod:3691
27073 " pread path count offset\n"
27078 #: ../fish/guestfish-actions.pod:3699
27079 msgid "See also L</pwrite>, L</pread-device>."
27083 #: ../fish/guestfish-actions.pod:3704
27084 msgid "pread-device"
27088 #: ../fish/guestfish-actions.pod:3706
27091 " pread-device device count offset\n"
27096 #: ../fish/guestfish-actions.pod:3714
27097 msgid "See also L</pread>."
27101 #: ../fish/guestfish-actions.pod:3719
27106 #: ../fish/guestfish-actions.pod:3721
27109 " pvcreate device\n"
27114 #: ../fish/guestfish-actions.pod:3727
27119 #: ../fish/guestfish-actions.pod:3729
27122 " pvremove device\n"
27127 #: ../fish/guestfish-actions.pod:3738
27132 #: ../fish/guestfish-actions.pod:3740
27135 " pvresize device\n"
27140 #: ../fish/guestfish-actions.pod:3745
27141 msgid "pvresize-size"
27145 #: ../fish/guestfish-actions.pod:3747
27148 " pvresize-size device size\n"
27153 #: ../fish/guestfish-actions.pod:3749
27155 "This command is the same as L</pvresize> except that it allows you to "
27156 "specify the new size (in bytes) explicitly."
27160 #: ../fish/guestfish-actions.pod:3752
27165 #: ../fish/guestfish-actions.pod:3754
27173 #: ../fish/guestfish-actions.pod:3762
27174 msgid "See also L</pvs-full>."
27178 #: ../fish/guestfish-actions.pod:3764
27183 #: ../fish/guestfish-actions.pod:3766
27191 #: ../fish/guestfish-actions.pod:3771
27196 #: ../fish/guestfish-actions.pod:3773
27204 #: ../fish/guestfish-actions.pod:3777
27209 #: ../fish/guestfish-actions.pod:3779
27212 " pwrite path content offset\n"
27217 #: ../fish/guestfish-actions.pod:3790
27218 msgid "See also L</pread>, L</pwrite-device>."
27222 #: ../fish/guestfish-actions.pod:3795
27223 msgid "pwrite-device"
27227 #: ../fish/guestfish-actions.pod:3797
27230 " pwrite-device device content offset\n"
27235 #: ../fish/guestfish-actions.pod:3807
27236 msgid "See also L</pwrite>."
27240 #: ../fish/guestfish-actions.pod:3812
27245 #: ../fish/guestfish-actions.pod:3814
27248 " read-file path\n"
27253 #: ../fish/guestfish-actions.pod:3819
27255 "Unlike L</cat>, this function can correctly handle files that contain "
27256 "embedded ASCII NUL characters. However unlike L</download>, this function "
27257 "is limited in the total size of file that can be handled."
27261 #: ../fish/guestfish-actions.pod:3827
27266 #: ../fish/guestfish-actions.pod:3829
27269 " read-lines path\n"
27274 #: ../fish/guestfish-actions.pod:3836
27276 "Note that this function cannot correctly handle binary files (specifically, "
27277 "files containing C<\\0> character which is treated as end of line). For "
27278 "those you need to use the L</read-file> function which has a more complex "
27283 #: ../fish/guestfish-actions.pod:3841
27288 #: ../fish/guestfish-actions.pod:3843
27296 #: ../fish/guestfish-actions.pod:3895
27298 "This function is primarily intended for use by programs. To get a simple "
27299 "list of names, use L</ls>. To get a printable directory for human "
27300 "consumption, use L</ll>."
27304 #: ../fish/guestfish-actions.pod:3899
27309 #: ../fish/guestfish-actions.pod:3901
27317 #: ../fish/guestfish-actions.pod:3905
27318 msgid "readlinklist"
27322 #: ../fish/guestfish-actions.pod:3907
27325 " readlinklist path 'names ...'\n"
27330 #: ../fish/guestfish-actions.pod:3931
27335 #: ../fish/guestfish-actions.pod:3933
27343 #: ../fish/guestfish-actions.pod:3938
27344 msgid "removexattr"
27348 #: ../fish/guestfish-actions.pod:3940
27351 " removexattr xattr path\n"
27356 #: ../fish/guestfish-actions.pod:3945
27357 msgid "See also: L</lremovexattr>, L<attr(5)>."
27361 #: ../fish/guestfish-actions.pod:3947
27366 #: ../fish/guestfish-actions.pod:3949
27369 " resize2fs device\n"
27374 #: ../fish/guestfish-actions.pod:3954
27376 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device>"
27377 " before calling this command. For unknown reasons C<resize2fs> sometimes "
27378 "gives an error about this and sometimes not. In any case, it is always safe"
27379 " to call L</e2fsck-f> before calling this function."
27383 #: ../fish/guestfish-actions.pod:3960
27384 msgid "resize2fs-M"
27388 #: ../fish/guestfish-actions.pod:3962
27391 " resize2fs-M device\n"
27396 #: ../fish/guestfish-actions.pod:3964
27398 "This command is the same as L</resize2fs>, but the filesystem is resized to "
27399 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
27404 #: ../fish/guestfish-actions.pod:3968
27406 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
27407 "and read the C<Block size> and C<Block count> values. These two numbers, "
27408 "multiplied together, give the resulting size of the minimal filesystem in "
27413 #: ../fish/guestfish-actions.pod:3973
27414 msgid "resize2fs-size"
27418 #: ../fish/guestfish-actions.pod:3975
27421 " resize2fs-size device size\n"
27426 #: ../fish/guestfish-actions.pod:3977
27428 "This command is the same as L</resize2fs> except that it allows you to "
27429 "specify the new size (in bytes) explicitly."
27433 #: ../fish/guestfish-actions.pod:3980
27438 #: ../fish/guestfish-actions.pod:3982
27446 #: ../fish/guestfish-actions.pod:3986
27451 #: ../fish/guestfish-actions.pod:3988
27459 #: ../fish/guestfish-actions.pod:3994
27464 #: ../fish/guestfish-actions.pod:3996
27472 #: ../fish/guestfish-actions.pod:4000
27473 msgid "rmmountpoint"
27477 #: ../fish/guestfish-actions.pod:4002
27480 " rmmountpoint exemptpath\n"
27485 #: ../fish/guestfish-actions.pod:4004
27487 "This calls removes a mountpoint that was previously created with "
27488 "L</mkmountpoint>. See L</mkmountpoint> for full details."
27492 #: ../fish/guestfish-actions.pod:4008
27493 msgid "scrub-device"
27497 #: ../fish/guestfish-actions.pod:4010
27500 " scrub-device device\n"
27505 #: ../fish/guestfish-actions.pod:4021
27510 #: ../fish/guestfish-actions.pod:4023
27513 " scrub-file file\n"
27518 #: ../fish/guestfish-actions.pod:4033
27519 msgid "scrub-freespace"
27523 #: ../fish/guestfish-actions.pod:4035
27526 " scrub-freespace dir\n"
27531 #: ../fish/guestfish-actions.pod:4037
27533 "This command creates the directory C<dir> and then fills it with files until"
27534 " the filesystem is full, and scrubs the files as for L</scrub-file>, and "
27535 "deletes them. The intention is to scrub any free space on the partition "
27536 "containing C<dir>."
27540 #: ../fish/guestfish-actions.pod:4046
27545 #: ../fish/guestfish-actions.pod:4048
27550 #: ../fish/guestfish-actions.pod:4050
27553 " set-append append\n"
27558 #: ../fish/guestfish-actions.pod:4061
27559 msgid "set-attach-method"
27563 #: ../fish/guestfish-actions.pod:4063
27564 msgid "attach-method"
27568 #: ../fish/guestfish-actions.pod:4065
27571 " set-attach-method attachmethod\n"
27576 #: ../fish/guestfish-actions.pod:4087
27577 msgid "set-autosync"
27581 #: ../fish/guestfish-actions.pod:4089
27586 #: ../fish/guestfish-actions.pod:4091
27589 " set-autosync true|false\n"
27594 #: ../fish/guestfish-actions.pod:4101
27599 #: ../fish/guestfish-actions.pod:4103
27604 #: ../fish/guestfish-actions.pod:4105
27607 " set-direct true|false\n"
27612 #: ../fish/guestfish-actions.pod:4111
27614 "One consequence of this is that log messages aren't caught by the library "
27615 "and handled by L</set-log-message-callback>, but go straight to stdout."
27619 #: ../fish/guestfish-actions.pod:4120
27620 msgid "set-e2label"
27624 #: ../fish/guestfish-actions.pod:4122
27627 " set-e2label device label\n"
27632 #: ../fish/guestfish-actions.pod:4128
27634 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
27635 "label on a filesystem."
27639 #: ../fish/guestfish-actions.pod:4131
27644 #: ../fish/guestfish-actions.pod:4133
27647 " set-e2uuid device uuid\n"
27652 #: ../fish/guestfish-actions.pod:4140
27654 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
27655 "UUID of a filesystem."
27659 #: ../fish/guestfish-actions.pod:4143
27660 msgid "set-memsize"
27664 #: ../fish/guestfish-actions.pod:4145
27669 #: ../fish/guestfish-actions.pod:4147
27672 " set-memsize memsize\n"
27677 #: ../fish/guestfish-actions.pod:4149
27679 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27680 "This only has any effect if called before L</launch>."
27684 #: ../fish/guestfish-actions.pod:4160
27685 msgid "set-network"
27689 #: ../fish/guestfish-actions.pod:4162
27694 #: ../fish/guestfish-actions.pod:4164
27697 " set-network true|false\n"
27702 #: ../fish/guestfish-actions.pod:4172
27704 "You must call this before calling L</launch>, otherwise it has no effect."
27708 #: ../fish/guestfish-actions.pod:4175
27713 #: ../fish/guestfish-actions.pod:4177
27718 #: ../fish/guestfish-actions.pod:4179
27721 " set-path searchpath\n"
27726 #: ../fish/guestfish-actions.pod:4188
27731 #: ../fish/guestfish-actions.pod:4190
27736 #: ../fish/guestfish-actions.pod:4192
27739 " set-pgroup true|false\n"
27744 #: ../fish/guestfish-actions.pod:4203
27749 #: ../fish/guestfish-actions.pod:4205
27754 #: ../fish/guestfish-actions.pod:4207
27762 #: ../fish/guestfish-actions.pod:4227
27763 msgid "set-recovery-proc"
27767 #: ../fish/guestfish-actions.pod:4229
27768 msgid "recovery-proc"
27772 #: ../fish/guestfish-actions.pod:4231
27775 " set-recovery-proc true|false\n"
27780 #: ../fish/guestfish-actions.pod:4233
27782 "If this is called with the parameter C<false> then L</launch> does not "
27783 "create a recovery process. The purpose of the recovery process is to stop "
27784 "runaway qemu processes in the case where the main program aborts abruptly."
27788 #: ../fish/guestfish-actions.pod:4238
27790 "This only has any effect if called before L</launch>, and the default is "
27795 #: ../fish/guestfish-actions.pod:4247
27796 msgid "set-selinux"
27800 #: ../fish/guestfish-actions.pod:4249
27805 #: ../fish/guestfish-actions.pod:4251
27808 " set-selinux true|false\n"
27813 #: ../fish/guestfish-actions.pod:4262
27818 #: ../fish/guestfish-actions.pod:4264
27823 #: ../fish/guestfish-actions.pod:4266
27826 " set-trace true|false\n"
27831 #: ../fish/guestfish-actions.pod:4278
27833 "Trace messages are normally sent to C<stderr>, unless you register a "
27834 "callback to send them somewhere else (see L</set-event-callback>)."
27838 #: ../fish/guestfish-actions.pod:4282
27839 msgid "set-verbose"
27843 #: ../fish/guestfish-actions.pod:4284
27848 #: ../fish/guestfish-actions.pod:4286
27851 " set-verbose true|false\n"
27856 #: ../fish/guestfish-actions.pod:4293
27858 "Verbose messages are normally sent to C<stderr>, unless you register a "
27859 "callback to send them somewhere else (see L</set-event-callback>)."
27863 #: ../fish/guestfish-actions.pod:4297
27868 #: ../fish/guestfish-actions.pod:4299
27871 " setcon context\n"
27876 #: ../fish/guestfish-actions.pod:4306
27881 #: ../fish/guestfish-actions.pod:4308
27884 " setxattr xattr val vallen path\n"
27889 #: ../fish/guestfish-actions.pod:4314
27890 msgid "See also: L</lsetxattr>, L<attr(5)>."
27894 #: ../fish/guestfish-actions.pod:4316
27899 #: ../fish/guestfish-actions.pod:4318
27902 " sfdisk device cyls heads sectors 'lines ...'\n"
27907 #: ../fish/guestfish-actions.pod:4340
27908 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
27912 #: ../fish/guestfish-actions.pod:4353
27917 #: ../fish/guestfish-actions.pod:4355
27920 " sfdiskM device 'lines ...'\n"
27925 #: ../fish/guestfish-actions.pod:4357
27927 "This is a simplified interface to the L</sfdisk> command, where partition "
27928 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
27929 "you don't need to specify the cyls, heads and sectors parameters which were "
27930 "rarely if ever used anyway."
27934 #: ../fish/guestfish-actions.pod:4363
27935 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
27939 #: ../fish/guestfish-actions.pod:4376
27944 #: ../fish/guestfish-actions.pod:4378
27947 " sfdisk-N device partnum cyls heads sectors line\n"
27952 #: ../fish/guestfish-actions.pod:4383
27954 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
27955 "cyls/heads/sectors parameters."
27959 #: ../fish/guestfish-actions.pod:4386
27960 msgid "See also: L</part-add>"
27964 #: ../fish/guestfish-actions.pod:4398
27965 msgid "sfdisk-disk-geometry"
27969 #: ../fish/guestfish-actions.pod:4400
27972 " sfdisk-disk-geometry device\n"
27977 #: ../fish/guestfish-actions.pod:4402
27979 "This displays the disk geometry of C<device> read from the partition table."
27980 " Especially in the case where the underlying block device has been resized,"
27981 " this can be different from the kernel's idea of the geometry (see L"
27982 "</sfdisk-kernel-geometry>)."
27986 #: ../fish/guestfish-actions.pod:4410
27987 msgid "sfdisk-kernel-geometry"
27991 #: ../fish/guestfish-actions.pod:4412
27994 " sfdisk-kernel-geometry device\n"
27999 #: ../fish/guestfish-actions.pod:4419
28004 #: ../fish/guestfish-actions.pod:4421
28007 " sfdisk-l device\n"
28012 #: ../fish/guestfish-actions.pod:4427
28013 msgid "See also: L</part-list>"
28017 #: ../fish/guestfish-actions.pod:4436
28022 #: ../fish/guestfish-actions.pod:4438
28030 #: ../fish/guestfish-actions.pod:4443
28031 msgid "This is like L</command>, but passes the command to:"
28035 #: ../fish/guestfish-actions.pod:4451
28036 msgid "All the provisos about L</command> apply to this call."
28040 #: ../fish/guestfish-actions.pod:4453
28045 #: ../fish/guestfish-actions.pod:4455
28048 " sh-lines command\n"
28053 #: ../fish/guestfish-actions.pod:4457
28055 "This is the same as L</sh>, but splits the result into a list of lines."
28059 #: ../fish/guestfish-actions.pod:4460
28060 msgid "See also: L</command-lines>"
28064 #: ../fish/guestfish-actions.pod:4462
28069 #: ../fish/guestfish-actions.pod:4464
28077 #: ../fish/guestfish-actions.pod:4468
28082 #: ../fish/guestfish-actions.pod:4470
28090 #: ../fish/guestfish-actions.pod:4476
28095 #: ../fish/guestfish-actions.pod:4478
28103 #: ../fish/guestfish-actions.pod:4486
28108 #: ../fish/guestfish-actions.pod:4488
28116 #: ../fish/guestfish-actions.pod:4496
28121 #: ../fish/guestfish-actions.pod:4498
28124 " strings-e encoding path\n"
28129 #: ../fish/guestfish-actions.pod:4500
28131 "This is like the L</strings> command, but allows you to specify the encoding"
28132 " of strings that are looked for in the source file C<path>."
28136 #: ../fish/guestfish-actions.pod:4510
28138 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28139 "ISO-8859-X (this is what L</strings> uses)."
28143 #: ../fish/guestfish-actions.pod:4542
28144 msgid "swapoff-device"
28148 #: ../fish/guestfish-actions.pod:4544
28151 " swapoff-device device\n"
28156 #: ../fish/guestfish-actions.pod:4546
28158 "This command disables the libguestfs appliance swap device or partition "
28159 "named C<device>. See L</swapon-device>."
28163 #: ../fish/guestfish-actions.pod:4550
28164 msgid "swapoff-file"
28168 #: ../fish/guestfish-actions.pod:4552
28171 " swapoff-file file\n"
28176 #: ../fish/guestfish-actions.pod:4556
28177 msgid "swapoff-label"
28181 #: ../fish/guestfish-actions.pod:4558
28184 " swapoff-label label\n"
28189 #: ../fish/guestfish-actions.pod:4563
28190 msgid "swapoff-uuid"
28194 #: ../fish/guestfish-actions.pod:4565
28197 " swapoff-uuid uuid\n"
28202 #: ../fish/guestfish-actions.pod:4570
28203 msgid "swapon-device"
28207 #: ../fish/guestfish-actions.pod:4572
28210 " swapon-device device\n"
28215 #: ../fish/guestfish-actions.pod:4574
28217 "This command enables the libguestfs appliance to use the swap device or "
28218 "partition named C<device>. The increased memory is made available for all "
28219 "commands, for example those run using L</command> or L</sh>."
28223 #: ../fish/guestfish-actions.pod:4586
28224 msgid "swapon-file"
28228 #: ../fish/guestfish-actions.pod:4588
28231 " swapon-file file\n"
28236 #: ../fish/guestfish-actions.pod:4590
28238 "This command enables swap to a file. See L</swapon-device> for other notes."
28242 #: ../fish/guestfish-actions.pod:4593
28243 msgid "swapon-label"
28247 #: ../fish/guestfish-actions.pod:4595
28250 " swapon-label label\n"
28255 #: ../fish/guestfish-actions.pod:4597
28257 "This command enables swap to a labeled swap partition. See L</swapon-"
28258 "device> for other notes."
28262 #: ../fish/guestfish-actions.pod:4600
28263 msgid "swapon-uuid"
28267 #: ../fish/guestfish-actions.pod:4602
28270 " swapon-uuid uuid\n"
28275 #: ../fish/guestfish-actions.pod:4604
28277 "This command enables swap to a swap partition with the given UUID. See L"
28278 "</swapon-device> for other notes."
28282 #: ../fish/guestfish-actions.pod:4607
28287 #: ../fish/guestfish-actions.pod:4609
28295 #: ../fish/guestfish-actions.pod:4617
28300 #: ../fish/guestfish-actions.pod:4619
28308 #: ../fish/guestfish-actions.pod:4627
28313 #: ../fish/guestfish-actions.pod:4629
28316 " tail-n nrlines path\n"
28321 #: ../fish/guestfish-actions.pod:4642
28326 #: ../fish/guestfish-actions.pod:4644
28329 " tar-in (tarfile|-) directory\n"
28334 #: ../fish/guestfish-actions.pod:4649
28335 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
28339 #: ../fish/guestfish-actions.pod:4654
28344 #: ../fish/guestfish-actions.pod:4656
28347 " tar-out directory (tarfile|-)\n"
28352 #: ../fish/guestfish-actions.pod:4661
28353 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
28357 #: ../fish/guestfish-actions.pod:4666
28362 #: ../fish/guestfish-actions.pod:4668
28365 " tgz-in (tarball|-) directory\n"
28370 #: ../fish/guestfish-actions.pod:4673
28371 msgid "To upload an uncompressed tarball, use L</tar-in>."
28375 #: ../fish/guestfish-actions.pod:4677
28380 #: ../fish/guestfish-actions.pod:4679
28383 " tgz-out directory (tarball|-)\n"
28388 #: ../fish/guestfish-actions.pod:4684
28389 msgid "To download an uncompressed tarball, use L</tar-out>."
28393 #: ../fish/guestfish-actions.pod:4688
28398 #: ../fish/guestfish-actions.pod:4690
28406 #: ../fish/guestfish-actions.pod:4699
28411 #: ../fish/guestfish-actions.pod:4701
28419 #: ../fish/guestfish-actions.pod:4706
28420 msgid "truncate-size"
28424 #: ../fish/guestfish-actions.pod:4708
28427 " truncate-size path size\n"
28432 #: ../fish/guestfish-actions.pod:4713
28434 "If the current file size is less than C<size> then the file is extended to "
28435 "the required size with zero bytes. This creates a sparse file (ie. disk "
28436 "blocks are not allocated for the file until you write to it). To create a "
28437 "non-sparse file of zeroes, use L</fallocate64> instead."
28441 #: ../fish/guestfish-actions.pod:4719
28446 #: ../fish/guestfish-actions.pod:4721
28449 " tune2fs-l device\n"
28454 #: ../fish/guestfish-actions.pod:4731
28459 #: ../fish/guestfish-actions.pod:4733
28462 " txz-in (tarball|-) directory\n"
28467 #: ../fish/guestfish-actions.pod:4740
28472 #: ../fish/guestfish-actions.pod:4742
28475 " txz-out directory (tarball|-)\n"
28480 #: ../fish/guestfish-actions.pod:4749
28485 #: ../fish/guestfish-actions.pod:4751
28493 #: ../fish/guestfish-actions.pod:4765
28494 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
28498 #: ../fish/guestfish-actions.pod:4770
28503 #: ../fish/guestfish-actions.pod:4772
28508 #: ../fish/guestfish-actions.pod:4774
28511 " umount pathordevice\n"
28516 #: ../fish/guestfish-actions.pod:4780
28521 #: ../fish/guestfish-actions.pod:4782
28522 msgid "unmount-all"
28526 #: ../fish/guestfish-actions.pod:4784
28534 #: ../fish/guestfish-actions.pod:4790
28539 #: ../fish/guestfish-actions.pod:4792
28542 " upload (filename|-) remotefilename\n"
28547 #: ../fish/guestfish-actions.pod:4799
28548 msgid "See also L</download>."
28552 #: ../fish/guestfish-actions.pod:4803
28553 msgid "upload-offset"
28557 #: ../fish/guestfish-actions.pod:4805
28560 " upload-offset (filename|-) remotefilename offset\n"
28565 #: ../fish/guestfish-actions.pod:4817
28567 "Note that there is no limit on the amount of data that can be uploaded with "
28568 "this call, unlike with L</pwrite>, and this call always writes the full "
28569 "amount unless an error occurs."
28573 #: ../fish/guestfish-actions.pod:4822
28574 msgid "See also L</upload>, L</pwrite>."
28578 #: ../fish/guestfish-actions.pod:4826
28583 #: ../fish/guestfish-actions.pod:4828
28586 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
28591 #: ../fish/guestfish-actions.pod:4847
28596 #: ../fish/guestfish-actions.pod:4849
28604 #: ../fish/guestfish-actions.pod:4876
28606 "I<Note:> Don't use this call to test for availability of features. In "
28607 "enterprise distributions we backport features from later versions into "
28608 "earlier versions, making this an unreliable way to test for features. Use "
28609 "L</available> instead."
28613 #: ../fish/guestfish-actions.pod:4882
28618 #: ../fish/guestfish-actions.pod:4884
28621 " vfs-label device\n"
28626 #: ../fish/guestfish-actions.pod:4891
28627 msgid "To find a filesystem from the label, use L</findfs-label>."
28631 #: ../fish/guestfish-actions.pod:4893
28636 #: ../fish/guestfish-actions.pod:4895
28639 " vfs-type device\n"
28644 #: ../fish/guestfish-actions.pod:4905
28649 #: ../fish/guestfish-actions.pod:4907
28652 " vfs-uuid device\n"
28657 #: ../fish/guestfish-actions.pod:4914
28658 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
28662 #: ../fish/guestfish-actions.pod:4916
28663 msgid "vg-activate"
28667 #: ../fish/guestfish-actions.pod:4918
28670 " vg-activate true|false 'volgroups ...'\n"
28675 #: ../fish/guestfish-actions.pod:4928
28676 msgid "vg-activate-all"
28680 #: ../fish/guestfish-actions.pod:4930
28683 " vg-activate-all true|false\n"
28688 #: ../fish/guestfish-actions.pod:4937
28693 #: ../fish/guestfish-actions.pod:4939
28696 " vgcreate volgroup 'physvols ...'\n"
28701 #: ../fish/guestfish-actions.pod:4944
28706 #: ../fish/guestfish-actions.pod:4946
28709 " vglvuuids vgname\n"
28714 #: ../fish/guestfish-actions.pod:4951
28716 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
28717 "logical volumes and volume groups."
28721 #: ../fish/guestfish-actions.pod:4954
28722 msgid "See also L</vgpvuuids>."
28726 #: ../fish/guestfish-actions.pod:4956
28731 #: ../fish/guestfish-actions.pod:4958
28734 " vgpvuuids vgname\n"
28739 #: ../fish/guestfish-actions.pod:4963
28741 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
28742 "physical volumes and volume groups."
28746 #: ../fish/guestfish-actions.pod:4966
28747 msgid "See also L</vglvuuids>."
28751 #: ../fish/guestfish-actions.pod:4968
28756 #: ../fish/guestfish-actions.pod:4970
28759 " vgremove vgname\n"
28764 #: ../fish/guestfish-actions.pod:4977
28769 #: ../fish/guestfish-actions.pod:4979
28772 " vgrename volgroup newvolgroup\n"
28777 #: ../fish/guestfish-actions.pod:4983
28782 #: ../fish/guestfish-actions.pod:4985
28790 #: ../fish/guestfish-actions.pod:4993
28791 msgid "See also L</vgs-full>."
28795 #: ../fish/guestfish-actions.pod:4995
28800 #: ../fish/guestfish-actions.pod:4997
28808 #: ../fish/guestfish-actions.pod:5002
28813 #: ../fish/guestfish-actions.pod:5004
28821 #: ../fish/guestfish-actions.pod:5009
28826 #: ../fish/guestfish-actions.pod:5011
28834 #: ../fish/guestfish-actions.pod:5015
28839 #: ../fish/guestfish-actions.pod:5017
28847 #: ../fish/guestfish-actions.pod:5022
28852 #: ../fish/guestfish-actions.pod:5024
28860 #: ../fish/guestfish-actions.pod:5029
28865 #: ../fish/guestfish-actions.pod:5031
28873 #: ../fish/guestfish-actions.pod:5036
28878 #: ../fish/guestfish-actions.pod:5038
28881 " write path content\n"
28886 #: ../fish/guestfish-actions.pod:5043
28887 msgid "See also L</write-append>."
28891 #: ../fish/guestfish-actions.pod:5048
28892 msgid "write-append"
28896 #: ../fish/guestfish-actions.pod:5050
28899 " write-append path content\n"
28904 #: ../fish/guestfish-actions.pod:5055
28905 msgid "See also L</write>."
28909 #: ../fish/guestfish-actions.pod:5060
28914 #: ../fish/guestfish-actions.pod:5062
28917 " write-file path content size\n"
28922 #: ../fish/guestfish-actions.pod:5085
28927 #: ../fish/guestfish-actions.pod:5087
28930 " zegrep regex path\n"
28935 #: ../fish/guestfish-actions.pod:5095
28940 #: ../fish/guestfish-actions.pod:5097
28943 " zegrepi regex path\n"
28948 #: ../fish/guestfish-actions.pod:5105
28953 #: ../fish/guestfish-actions.pod:5107
28961 #: ../fish/guestfish-actions.pod:5115
28962 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
28966 #: ../fish/guestfish-actions.pod:5118
28967 msgid "zero-device"
28971 #: ../fish/guestfish-actions.pod:5120
28974 " zero-device device\n"
28979 #: ../fish/guestfish-actions.pod:5122
28981 "This command writes zeroes over the entire C<device>. Compare with L</zero>"
28982 " which just zeroes the first few blocks of a device."
28986 #: ../fish/guestfish-actions.pod:5129
28991 #: ../fish/guestfish-actions.pod:5131
28994 " zerofree device\n"
28999 #: ../fish/guestfish-actions.pod:5144
29004 #: ../fish/guestfish-actions.pod:5146
29007 " zfgrep pattern path\n"
29012 #: ../fish/guestfish-actions.pod:5154
29017 #: ../fish/guestfish-actions.pod:5156
29020 " zfgrepi pattern path\n"
29025 #: ../fish/guestfish-actions.pod:5164
29030 #: ../fish/guestfish-actions.pod:5166
29033 " zfile meth path\n"
29038 #: ../fish/guestfish-actions.pod:5173
29040 "Since 1.0.63, use L</file> instead which can now process compressed files."
29044 #: ../fish/guestfish-actions.pod:5183
29049 #: ../fish/guestfish-actions.pod:5185
29052 " zgrep regex path\n"
29057 #: ../fish/guestfish-actions.pod:5193
29062 #: ../fish/guestfish-actions.pod:5195
29065 " zgrepi regex path\n"
29070 #: ../fish/guestfish-commands.pod:1
29075 #: ../fish/guestfish-commands.pod:3
29080 #: ../fish/guestfish-commands.pod:5
29083 " alloc filename size\n"
29088 #: ../fish/guestfish-commands.pod:7
29090 "This creates an empty (zeroed) file of the given size, and then adds so it "
29091 "can be further examined."
29095 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
29096 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
29100 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
29101 msgid "Size can be specified using standard suffixes, eg. C<1M>."
29105 #: ../fish/guestfish-commands.pod:14
29107 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
29108 "image, see L</PREPARED DISK IMAGES>."
29112 #: ../fish/guestfish-commands.pod:17
29117 #: ../fish/guestfish-commands.pod:19
29120 " copy-in local [local ...] /remotedir\n"
29125 #: ../fish/guestfish-commands.pod:21
29127 "C<copy-in> copies local files or directories recursively into the disk "
29128 "image, placing them in the directory called C</remotedir> (which must "
29129 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and"
29130 " other commands as necessary."
29134 #: ../fish/guestfish-commands.pod:26
29136 "Multiple local files and directories can be specified, but the last "
29137 "parameter must always be a remote directory. Wildcards cannot be used."
29141 #: ../fish/guestfish-commands.pod:30
29146 #: ../fish/guestfish-commands.pod:32
29149 " copy-out remote [remote ...] localdir\n"
29154 #: ../fish/guestfish-commands.pod:34
29156 "C<copy-out> copies remote files or directories recursively out of the disk "
29157 "image, placing them on the host disk in a local directory called C<localdir>"
29158 " (which must exist). This guestfish meta-command turns into a sequence of "
29159 "L</download>, L</tar-out> and other commands as necessary."
29163 #: ../fish/guestfish-commands.pod:40
29165 "Multiple remote files and directories can be specified, but the last "
29166 "parameter must always be a local directory. To download to the current "
29167 "directory, use C<.> as in:"
29171 #: ../fish/guestfish-commands.pod:44
29174 " copy-out /home .\n"
29179 #: ../fish/guestfish-commands.pod:46
29181 "Wildcards cannot be used in the ordinary command, but you can use them with "
29182 "the help of L</glob> like this:"
29186 #: ../fish/guestfish-commands.pod:49
29189 " glob copy-out /home/* .\n"
29194 #: ../fish/guestfish-commands.pod:51
29199 #: ../fish/guestfish-commands.pod:53
29202 " display filename\n"
29207 #: ../fish/guestfish-commands.pod:55
29209 "Use C<display> (a graphical display program) to display an image file. It "
29210 "downloads the file, and runs C<display> on it."
29214 #: ../fish/guestfish-commands.pod:58
29216 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
29217 "environment variable. For example to use the GNOME display program:"
29221 #: ../fish/guestfish-commands.pod:61
29224 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
29229 #: ../fish/guestfish-commands.pod:63
29230 msgid "See also L<display(1)>."
29234 #: ../fish/guestfish-commands.pod:65
29239 #: ../fish/guestfish-commands.pod:67
29242 " echo [params ...]\n"
29247 #: ../fish/guestfish-commands.pod:69
29248 msgid "This echos the parameters to the terminal."
29252 #: ../fish/guestfish-commands.pod:71
29257 #: ../fish/guestfish-commands.pod:73
29262 #: ../fish/guestfish-commands.pod:75
29267 #: ../fish/guestfish-commands.pod:77
29275 #: ../fish/guestfish-commands.pod:79
29277 "This is used to edit a file. It downloads the file, edits it locally using "
29278 "your editor, then uploads the result."
29282 #: ../fish/guestfish-commands.pod:82
29284 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
29285 "or C<emacs> you will get those corresponding editors."
29289 #: ../fish/guestfish-commands.pod:86
29294 #: ../fish/guestfish-commands.pod:88
29297 " glob command args...\n"
29302 #: ../fish/guestfish-commands.pod:90
29304 "Expand wildcards in any paths in the args list, and run C<command> "
29305 "repeatedly on each matching path."
29309 #: ../fish/guestfish-commands.pod:93
29310 msgid "See L</WILDCARDS AND GLOBBING>."
29314 #: ../fish/guestfish-commands.pod:95
29319 #: ../fish/guestfish-commands.pod:97
29322 " hexedit <filename|device>\n"
29323 " hexedit <filename|device> <max>\n"
29324 " hexedit <filename|device> <start> <max>\n"
29329 #: ../fish/guestfish-commands.pod:101
29331 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
29336 #: ../fish/guestfish-commands.pod:104
29338 "This command works by downloading potentially the whole file or device, "
29339 "editing it locally, then uploading it. If the file or device is large, you "
29340 "have to specify which part you wish to edit by using C<max> and/or C<start> "
29341 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
29342 "usual modifiers allowed such as C<1M> (1 megabyte)."
29346 #: ../fish/guestfish-commands.pod:111
29347 msgid "For example to edit the first few sectors of a disk you might do:"
29351 #: ../fish/guestfish-commands.pod:114
29354 " hexedit /dev/sda 1M\n"
29359 #: ../fish/guestfish-commands.pod:116
29361 "which would allow you to edit anywhere within the first megabyte of the "
29366 #: ../fish/guestfish-commands.pod:119
29367 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
29371 #: ../fish/guestfish-commands.pod:121
29374 " hexedit /dev/sda1 0x400 0x400\n"
29379 #: ../fish/guestfish-commands.pod:123
29380 msgid "(assuming the superblock is in the standard location)."
29384 #: ../fish/guestfish-commands.pod:125
29386 "This command requires the external L<hexedit(1)> program. You can specify "
29387 "another program to use by setting the C<HEXEDITOR> environment variable."
29391 #: ../fish/guestfish-commands.pod:129
29392 msgid "See also L</hexdump>."
29396 #: ../fish/guestfish-commands.pod:131
29401 #: ../fish/guestfish-commands.pod:133
29409 #: ../fish/guestfish-commands.pod:135
29411 "Change the local directory, ie. the current directory of guestfish itself."
29415 #: ../fish/guestfish-commands.pod:138
29416 msgid "Note that C<!cd> won't do what you might expect."
29420 #: ../fish/guestfish-commands.pod:140
29425 #: ../fish/guestfish-commands.pod:142
29430 #: ../fish/guestfish-commands.pod:144
29438 #: ../fish/guestfish-commands.pod:146
29439 msgid "Opens the manual page for guestfish."
29443 #: ../fish/guestfish-commands.pod:148
29448 #: ../fish/guestfish-commands.pod:150
29453 #: ../fish/guestfish-commands.pod:152
29461 #: ../fish/guestfish-commands.pod:154
29469 #: ../fish/guestfish-commands.pod:156
29470 msgid "This is used to view a file."
29474 #: ../fish/guestfish-commands.pod:158
29476 "The default viewer is C<$PAGER>. However if you use the alternate command "
29477 "C<less> you will get the C<less> command specifically."
29481 #: ../fish/guestfish-commands.pod:161
29486 #: ../fish/guestfish-commands.pod:163
29494 #: ../fish/guestfish-commands.pod:165
29496 "Close and reopen the libguestfs handle. It is not necessary to use this "
29497 "normally, because the handle is closed properly when guestfish exits. "
29498 "However this is occasionally useful for testing."
29502 #: ../fish/guestfish-commands.pod:169
29507 #: ../fish/guestfish-commands.pod:171
29510 " sparse filename size\n"
29515 #: ../fish/guestfish-commands.pod:173
29517 "This creates an empty sparse file of the given size, and then adds so it can"
29518 " be further examined."
29522 #: ../fish/guestfish-commands.pod:176
29524 "In all respects it works the same as the L</alloc> command, except that the "
29525 "image file is allocated sparsely, which means that disk blocks are not "
29526 "assigned to the file until they are needed. Sparse disk files only use "
29527 "space when written to, but they are slower and there is a danger you could "
29528 "run out of real disk space during a write operation."
29532 #: ../fish/guestfish-commands.pod:186
29537 #: ../fish/guestfish-commands.pod:188
29545 #: ../fish/guestfish-commands.pod:190
29547 "This command returns a list of the optional groups known to the daemon, and "
29548 "indicates which ones are supported by this build of the libguestfs "
29553 #: ../fish/guestfish-commands.pod:194
29554 msgid "See also L<guestfs(3)/AVAILABILITY>."
29558 #: ../fish/guestfish-commands.pod:196
29563 #: ../fish/guestfish-commands.pod:198
29566 " time command args...\n"
29571 #: ../fish/guestfish-commands.pod:200
29573 "Run the command as usual, but print the elapsed time afterwards. This can "
29574 "be useful for benchmarking operations."
29578 #: ../test-tool/libguestfs-test-tool.pod:5
29579 msgid "libguestfs-test-tool - End user tests for libguestfs"
29583 #: ../test-tool/libguestfs-test-tool.pod:9
29586 " libguestfs-test-tool [--options]\n"
29591 #: ../test-tool/libguestfs-test-tool.pod:13
29593 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
29594 "and developers, to allow them to check basic libguestfs functionality is "
29595 "working. This is needed because libguestfs occasionally breaks for reasons "
29596 "beyond our control: usually because of changes in the underlying qemu or "
29597 "kernel packages, or the host environment."
29601 #: ../test-tool/libguestfs-test-tool.pod:20
29602 msgid "If you suspect a problem in libguestfs, then just run:"
29606 #: ../test-tool/libguestfs-test-tool.pod:22
29609 " libguestfs-test-tool\n"
29614 #: ../test-tool/libguestfs-test-tool.pod:24
29615 msgid "It will print lots of diagnostic messages."
29619 #: ../test-tool/libguestfs-test-tool.pod:26
29620 msgid "If it runs to completion successfully, you will see this near the end:"
29624 #: ../test-tool/libguestfs-test-tool.pod:28
29627 " ===== TEST FINISHED OK =====\n"
29632 #: ../test-tool/libguestfs-test-tool.pod:30
29633 msgid "and the test tool will exit with code 0."
29637 #: ../test-tool/libguestfs-test-tool.pod:32
29639 "If it fails (and/or exits with non-zero error code), please paste the "
29640 "B<complete, unedited> output of the test tool into a bug report. More "
29641 "information about reporting bugs can be found on the "
29642 "L<http://libguestfs.org/> website."
29646 #: ../test-tool/libguestfs-test-tool.pod:41
29651 #: ../test-tool/libguestfs-test-tool.pod:43
29652 msgid "Display short usage information and exit."
29656 #: ../test-tool/libguestfs-test-tool.pod:45
29657 msgid "I<--qemu qemu_binary>"
29661 #: ../test-tool/libguestfs-test-tool.pod:47
29663 "If you have downloaded another qemu binary, point this option at the full "
29664 "path of the binary to try it."
29668 #: ../test-tool/libguestfs-test-tool.pod:50
29669 msgid "I<--qemudir qemu_source_dir>"
29673 #: ../test-tool/libguestfs-test-tool.pod:52
29675 "If you have compiled qemu from source, point this option at the source "
29676 "directory to try it."
29680 #: ../test-tool/libguestfs-test-tool.pod:55
29681 msgid "I<--timeout N>"
29685 #: ../test-tool/libguestfs-test-tool.pod:57
29687 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
29688 "does not usually need to be adjusted unless your machine is very slow."
29692 #: ../test-tool/libguestfs-test-tool.pod:63
29693 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
29697 #: ../test-tool/libguestfs-test-tool.pod:65
29699 "If you have compiled another version of qemu from source and would like to "
29700 "try that, then you can use the I<--qemudir> option to point to the qemu "
29701 "source directory."
29705 #: ../test-tool/libguestfs-test-tool.pod:69
29707 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
29708 "option to point to the binary."
29712 #: ../test-tool/libguestfs-test-tool.pod:72
29714 "When using an alternate qemu with libguestfs, usually you would need to "
29715 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)>)."
29716 " libguestfs-test-tool writes a temporary qemu wrapper script when you use "
29717 "either of the I<--qemudir> or I<--qemu> options."
29721 #: ../test-tool/libguestfs-test-tool.pod:79
29723 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
29724 "I<1> if there was an error."
29728 #: ../test-tool/libguestfs-test-tool.pod:84
29730 "For the full list of environment variables which may affect libguestfs, "
29731 "please see the L<guestfs(3)> manual page."
29735 #: ../test-tool/libguestfs-test-tool.pod:89
29736 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
29740 #: ../fuse/guestmount.pod:5
29742 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
29746 #: ../fuse/guestmount.pod:9
29749 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
29754 #: ../fuse/guestmount.pod:11
29757 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
29762 #: ../fuse/guestmount.pod:13
29765 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
29770 #: ../fuse/guestmount.pod:17
29772 "You must I<not> use C<guestmount> in read-write mode on live virtual "
29773 "machines. If you do this, you risk disk corruption in the VM."
29777 #: ../fuse/guestmount.pod:22
29779 "The guestmount program can be used to mount virtual machine filesystems and "
29780 "other disk images on the host. It uses libguestfs for access to the guest "
29781 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
29782 "a mountable device."
29786 #: ../fuse/guestmount.pod:27
29788 "Along with other options, you have to give at least one device (I<-a> "
29789 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m>"
29790 " option) or use the I<-i> inspection option. How this works is better "
29791 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
29796 #: ../fuse/guestmount.pod:33
29798 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
29799 "by you, and the filesystem will not be visible to any other users unless you"
29800 " make certain global configuration changes to C</etc/fuse.conf>. To unmount"
29801 " the filesystem, use the C<fusermount -u> command."
29805 #: ../fuse/guestmount.pod:41
29807 "For a typical Windows guest which has its main filesystem on the first "
29812 #: ../fuse/guestmount.pod:44
29815 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
29820 #: ../fuse/guestmount.pod:46
29822 "For a typical Linux guest which has a /boot filesystem on the first "
29823 "partition, and the root filesystem on a logical volume:"
29827 #: ../fuse/guestmount.pod:49
29830 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
29835 #: ../fuse/guestmount.pod:51
29836 msgid "To get libguestfs to detect guest mountpoints for you:"
29840 #: ../fuse/guestmount.pod:53
29843 " guestmount -a guest.img -i --ro /mnt\n"
29848 #: ../fuse/guestmount.pod:55
29849 msgid "For a libvirt guest called \"Guest\" you could do:"
29853 #: ../fuse/guestmount.pod:57
29856 " guestmount -d Guest -i --ro /mnt\n"
29861 #: ../fuse/guestmount.pod:59
29863 "If you don't know what filesystems are contained in a guest or disk image, "
29864 "use L<virt-filesystems(1)> first:"
29868 #: ../fuse/guestmount.pod:62
29871 " virt-filesystems MyGuest\n"
29876 #: ../fuse/guestmount.pod:64
29878 "If you want to trace the libguestfs calls but without excessive debugging "
29879 "information, we recommend:"
29883 #: ../fuse/guestmount.pod:67
29886 " guestmount [...] --trace /mnt\n"
29891 #: ../fuse/guestmount.pod:69
29892 msgid "If you want to debug the program, we recommend:"
29896 #: ../fuse/guestmount.pod:71
29899 " guestmount [...] --trace --verbose /mnt\n"
29904 #: ../fuse/guestmount.pod:73
29909 #: ../fuse/guestmount.pod:75
29910 msgid "Other users cannot see the filesystem by default"
29914 #: ../fuse/guestmount.pod:77
29916 "If you mount a filesystem as one user (eg. root), then other users will not "
29917 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
29918 "option when mounting:"
29922 #: ../fuse/guestmount.pod:81
29925 " sudo guestmount [...] -o allow_other /mnt\n"
29930 #: ../fuse/guestmount.pod:87
29931 msgid "B<-a image> | B<--add image>"
29935 #: ../fuse/guestmount.pod:89
29936 msgid "Add a block device or virtual machine image."
29940 #: ../fuse/guestmount.pod:94
29941 msgid "B<-c URI> | B<--connect URI>"
29945 #: ../fuse/guestmount.pod:100
29946 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
29950 #: ../fuse/guestmount.pod:108
29951 msgid "B<--dir-cache-timeout N>"
29955 #: ../fuse/guestmount.pod:110
29957 "Set the readdir cache timeout to I<N> seconds, the default being 60 seconds."
29958 " The readdir cache [actually, there are several semi-independent caches] is"
29959 " populated after a readdir(2) call with the stat and extended attributes of "
29960 "the files in the directory, in anticipation that they will be requested soon"
29965 #: ../fuse/guestmount.pod:116
29967 "There is also a different attribute cache implemented by FUSE (see the FUSE "
29968 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
29969 "requests, only cache existing ones."
29973 #: ../fuse/guestmount.pod:127
29974 msgid "B<--format=raw|qcow2|..> | B<--format>"
29978 #: ../fuse/guestmount.pod:134
29980 "If you have untrusted raw-format guest disk images, you should use this "
29981 "option to specify the disk format. This avoids a possible security problem "
29982 "with malicious guests (CVE-2010-3851). See also "
29983 "L<guestfs(3)/guestfs_add_drive_opts>."
29987 #: ../fuse/guestmount.pod:139
29988 msgid "B<--fuse-help>"
29992 #: ../fuse/guestmount.pod:141
29993 msgid "Display help on special FUSE options (see I<-o> below)."
29997 #: ../fuse/guestmount.pod:145
29998 msgid "Display brief help and exit."
30002 #: ../fuse/guestmount.pod:147
30003 msgid "B<-i> | B<--inspector>"
30007 #: ../fuse/guestmount.pod:167
30009 "Mount the named partition or logical volume on the given mountpoint B<in the"
30010 " guest> (this has nothing to do with mountpoints in the host)."
30014 #: ../fuse/guestmount.pod:170
30016 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
30017 "something on C</>."
30021 #: ../fuse/guestmount.pod:183
30022 msgid "B<-n> | B<--no-sync>"
30026 #: ../fuse/guestmount.pod:185
30028 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
30029 "unmounted. If you specify this option, then we don't attempt to sync the "
30030 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
30034 #: ../fuse/guestmount.pod:190
30035 msgid "B<-o option> | B<--option option>"
30039 #: ../fuse/guestmount.pod:192
30040 msgid "Pass extra options to FUSE."
30044 #: ../fuse/guestmount.pod:194
30046 "To get a list of all the extra options supported by FUSE, use the command "
30047 "below. Note that only the FUSE I<-o> options can be passed, and only some "
30048 "of them are a good idea."
30052 #: ../fuse/guestmount.pod:198
30055 " guestmount --fuse-help\n"
30060 #: ../fuse/guestmount.pod:200
30061 msgid "Some potentially useful FUSE options:"
30065 #: ../fuse/guestmount.pod:204
30066 msgid "B<-o allow_other>"
30070 #: ../fuse/guestmount.pod:206
30071 msgid "Allow other users to see the filesystem."
30075 #: ../fuse/guestmount.pod:208
30076 msgid "B<-o attr_timeout=N>"
30080 #: ../fuse/guestmount.pod:210
30081 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
30085 #: ../fuse/guestmount.pod:212
30086 msgid "B<-o kernel_cache>"
30090 #: ../fuse/guestmount.pod:214
30092 "Allow the kernel to cache files (reduces the number of reads that have to go"
30093 " through the L<guestfs(3)> API). This is generally a good idea if you can "
30094 "afford the extra memory usage."
30098 #: ../fuse/guestmount.pod:218
30099 msgid "B<-o uid=N> B<-o gid=N>"
30103 #: ../fuse/guestmount.pod:220
30105 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
30106 "the chosen values."
30110 #: ../fuse/guestmount.pod:225
30111 msgid "B<-r> | B<--ro>"
30115 #: ../fuse/guestmount.pod:227
30117 "Add devices and mount everything read-only. Also disallow writes and make "
30118 "the disk appear read-only to FUSE."
30122 #: ../fuse/guestmount.pod:230
30124 "This is highly recommended if you are not going to edit the guest disk. If "
30125 "the guest is running and this option is I<not> supplied, then there is a "
30126 "strong risk of disk corruption in the guest. We try to prevent this from "
30127 "happening, but it is not always possible."
30131 #: ../fuse/guestmount.pod:235
30132 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
30136 #: ../fuse/guestmount.pod:239
30137 msgid "Enable SELinux support for the guest."
30141 #: ../fuse/guestmount.pod:241
30142 msgid "B<-v> | B<--verbose>"
30146 #: ../fuse/guestmount.pod:243
30147 msgid "Enable verbose messages from underlying libguestfs."
30151 #: ../fuse/guestmount.pod:245
30152 msgid "B<-V> | B<--version>"
30156 #: ../fuse/guestmount.pod:247
30157 msgid "Display the program version and exit."
30161 #: ../fuse/guestmount.pod:249
30162 msgid "B<-w> | B<--rw>"
30166 #: ../fuse/guestmount.pod:254 ../fuse/guestmount.pod:275
30167 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
30171 #: ../fuse/guestmount.pod:256
30172 msgid "B<-x> | B<--trace>"
30176 #: ../fuse/guestmount.pod:258
30177 msgid "Trace libguestfs calls and entry into each FUSE function."
30181 #: ../fuse/guestmount.pod:260
30182 msgid "This also stops the daemon from forking into the background."
30186 #: ../fuse/guestmount.pod:281
30188 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L"
30189 "<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
30190 "L<http://fuse.sf.net/>."
30194 #: ../fuse/guestmount.pod:296
30195 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
30199 #: ../tools/virt-win-reg.pl:37
30201 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
30206 #: ../tools/virt-win-reg.pl:41
30209 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
30214 #: ../tools/virt-win-reg.pl:43
30217 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
30222 #: ../tools/virt-win-reg.pl:45
30225 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
30230 #: ../tools/virt-win-reg.pl:47
30233 " virt-win-reg --merge domname [input.reg ...]\n"
30238 #: ../tools/virt-win-reg.pl:49
30241 " virt-win-reg [--options] disk.img ... # instead of domname\n"
30246 #: ../tools/virt-win-reg.pl:53
30248 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
30249 "virtual machines. If you do this, you I<will> get irreversible disk "
30250 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
30251 "but doesn't catch all cases."
30255 #: ../tools/virt-win-reg.pl:58
30257 "Modifying the Windows Registry is an inherently risky operation. The format"
30258 " is deliberately obscure and undocumented, and Registry changes can leave "
30259 "the system unbootable. Therefore when using the I<--merge> option, make "
30260 "sure you have a reliable backup first."
30264 #: ../tools/virt-win-reg.pl:65
30266 "This program can export and merge Windows Registry entries from a Windows "
30271 #: ../tools/virt-win-reg.pl:68
30273 "The first parameter is the libvirt guest name or the raw disk image of a "
30278 #: ../tools/virt-win-reg.pl:71
30280 "If I<--merge> is I<not> specified, then the chosen registry key is "
30281 "displayed/exported (recursively). For example:"
30285 #: ../tools/virt-win-reg.pl:74
30288 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
30293 #: ../tools/virt-win-reg.pl:76
30295 "You can also display single values from within registry keys, for example:"
30299 #: ../tools/virt-win-reg.pl:79
30302 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
30303 " $ virt-win-reg Windows7 $cvkey ProductName\n"
30304 " Windows 7 Enterprise\n"
30309 #: ../tools/virt-win-reg.pl:83
30311 "With I<--merge>, you can merge a textual regedit file into the Windows "
30316 #: ../tools/virt-win-reg.pl:86
30319 " $ virt-win-reg --merge Windows7 changes.reg\n"
30324 #: ../tools/virt-win-reg.pl:88 ../tools/virt-tar.pl:45
30329 #: ../tools/virt-win-reg.pl:90
30331 "This program is only meant for simple access to the registry. If you want "
30332 "to do complicated things with the registry, we suggest you download the "
30333 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)>"
30334 " and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
30335 "L<hivexregedit(1)>."
30339 #: ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63
30340 #: ../tools/virt-tar.pl:113 ../tools/virt-make-fs.pl:163
30341 #: ../tools/virt-list-partitions.pl:64
30342 msgid "Display brief help."
30346 #: ../tools/virt-win-reg.pl:114 ../tools/virt-list-filesystems.pl:71
30347 #: ../tools/virt-tar.pl:121 ../tools/virt-make-fs.pl:171
30348 #: ../tools/virt-list-partitions.pl:72
30349 msgid "Display version number and exit."
30353 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
30358 #: ../tools/virt-win-reg.pl:122
30359 msgid "Enable debugging messages."
30363 #: ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77
30364 #: ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:78
30365 msgid "B<--connect URI> | B<-c URI>"
30369 #: ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79
30370 #: ../tools/virt-tar.pl:129 ../tools/virt-list-partitions.pl:80
30372 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
30373 "to the default libvirt hypervisor."
30377 #: ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82
30378 #: ../tools/virt-tar.pl:132 ../tools/virt-list-partitions.pl:83
30380 "If you specify guest block devices directly, then libvirt is not used at "
30385 #: ../tools/virt-win-reg.pl:140 ../tools/virt-list-filesystems.pl:89
30386 #: ../tools/virt-tar.pl:139 ../tools/virt-list-partitions.pl:90
30387 msgid "B<--format> raw"
30391 #: ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91
30392 #: ../tools/virt-tar.pl:141 ../tools/virt-list-partitions.pl:92
30394 "Specify the format of disk images given on the command line. If this is "
30395 "omitted then the format is autodetected from the content of the disk image."
30399 #: ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95
30400 #: ../tools/virt-tar.pl:145 ../tools/virt-list-partitions.pl:96
30402 "If disk images are requested from libvirt, then this program asks libvirt "
30403 "for this information. In this case, the value of the format parameter is "
30408 #: ../tools/virt-win-reg.pl:150 ../tools/virt-list-filesystems.pl:99
30409 #: ../tools/virt-tar.pl:149 ../tools/virt-list-partitions.pl:100
30411 "If working with untrusted raw-format guest disk images, you should ensure "
30412 "the format is always specified."
30416 #: ../tools/virt-win-reg.pl:157
30421 #: ../tools/virt-win-reg.pl:159
30423 "In merge mode, this merges a textual regedit file into the Windows Registry "
30424 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
30425 "displays or exports Registry entries instead."
30429 #: ../tools/virt-win-reg.pl:163
30431 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
30432 "result in disk corruption. However exporting (without this flag) is always"
30437 #: ../tools/virt-win-reg.pl:171
30438 msgid "B<--encoding> UTF-16LE|ASCII"
30442 #: ../tools/virt-win-reg.pl:173
30444 "When merging (only), you may need to specify the encoding for strings to be "
30445 "used in the hive file. This is explained in detail in "
30446 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
30450 #: ../tools/virt-win-reg.pl:177
30452 "The default is to use UTF-16LE, which should work with recent versions of "
30457 #: ../tools/virt-win-reg.pl:184
30458 msgid "B<--unsafe-printable-strings>"
30462 #: ../tools/virt-win-reg.pl:186
30464 "When exporting (only), assume strings are UTF-16LE and print them as strings"
30465 " instead of hex sequences. Remove the final zero codepoint from strings if "
30470 #: ../tools/virt-win-reg.pl:190
30472 "This is unsafe and does not preserve the fidelity of strings in the original"
30473 " Registry for various reasons:"
30477 #: ../tools/virt-win-reg.pl:197
30479 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
30480 "other encodings will be corrupted by this transformation."
30484 #: ../tools/virt-win-reg.pl:202
30486 "Assumes that everything which has type 1 or 2 is really a string and that "
30487 "everything else is not a string, but the type field in real Registries is "
30492 #: ../tools/virt-win-reg.pl:208
30494 "Loses information about whether a zero codepoint followed the string in the "
30499 #: ../tools/virt-win-reg.pl:213
30501 "This all happens because the Registry itself contains no information about "
30502 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
30506 #: ../tools/virt-win-reg.pl:217
30508 "You should only use this option for quick hacking and debugging of the "
30509 "Registry contents, and I<never> use it if the output is going to be passed "
30510 "into another program or stored in another Registry."
30514 #: ../tools/virt-win-reg.pl:554
30515 msgid "SUPPORTED SYSTEMS"
30519 #: ../tools/virt-win-reg.pl:556
30521 "The program currently supports Windows NT-derived guests starting with "
30522 "Windows XP through to at least Windows 7."
30526 #: ../tools/virt-win-reg.pl:559
30527 msgid "The following Registry keys are supported:"
30531 #: ../tools/virt-win-reg.pl:563
30532 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
30536 #: ../tools/virt-win-reg.pl:565
30537 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
30541 #: ../tools/virt-win-reg.pl:567
30542 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
30546 #: ../tools/virt-win-reg.pl:569
30547 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
30551 #: ../tools/virt-win-reg.pl:571
30552 msgid "C<HKEY_USERS\\.DEFAULT>"
30556 #: ../tools/virt-win-reg.pl:573
30557 msgid "C<HKEY_USERS\\I<SID>>"
30561 #: ../tools/virt-win-reg.pl:575
30562 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
30566 #: ../tools/virt-win-reg.pl:577
30567 msgid "C<HKEY_USERS\\I<username>>"
30571 #: ../tools/virt-win-reg.pl:579
30573 "where I<username> is a local user name (this is a libguestfs extension)."
30577 #: ../tools/virt-win-reg.pl:583
30579 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for"
30584 #: ../tools/virt-win-reg.pl:586
30586 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
30587 "supported (there is no \"current user\")."
30591 #: ../tools/virt-win-reg.pl:589
30596 #: ../tools/virt-win-reg.pl:591
30598 "C<virt-win-reg> expects that regedit files have already been reencoded in "
30599 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
30600 "style line endings. Since Windows regedit files are often in UTF-16LE with "
30601 "Windows-style line endings, you may need to reencode the whole file before "
30602 "or after processing."
30606 #: ../tools/virt-win-reg.pl:597
30608 "To reencode a file from Windows format to Linux (before processing it with "
30609 "the I<--merge> option), you would do something like this:"
30613 #: ../tools/virt-win-reg.pl:600
30616 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
30621 #: ../tools/virt-win-reg.pl:602
30623 "To go in the opposite direction, after exporting and before sending the file"
30624 " to a Windows user, do something like this:"
30628 #: ../tools/virt-win-reg.pl:605
30631 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
30636 #: ../tools/virt-win-reg.pl:607
30637 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
30641 #: ../tools/virt-win-reg.pl:609
30643 "If you are unsure about the current encoding, use the L<file(1)> command. "
30644 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
30645 "style (CRLF) line endings, like this:"
30649 #: ../tools/virt-win-reg.pl:613
30652 " $ file software.reg\n"
30653 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
30654 " with CRLF line terminators\n"
30659 #: ../tools/virt-win-reg.pl:617
30660 msgid "This file would need conversion before you could I<--merge> it."
30664 #: ../tools/virt-win-reg.pl:619
30665 msgid "CurrentControlSet etc."
30669 #: ../tools/virt-win-reg.pl:621
30671 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
30672 "Registry at the level of the hive file, and therefore you cannot modify "
30677 #: ../tools/virt-win-reg.pl:625
30679 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
30680 "circumstances it might refer to another control set. The way to find out is"
30681 " to look at the C<HKLM\\SYSTEM\\Select> key:"
30685 #: ../tools/virt-win-reg.pl:629
30688 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
30689 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
30690 " \"Current\"=dword:00000001\n"
30691 " \"Default\"=dword:00000001\n"
30692 " \"Failed\"=dword:00000000\n"
30693 " \"LastKnownGood\"=dword:00000002\n"
30698 #: ../tools/virt-win-reg.pl:636
30699 msgid "\"Current\" is the one which Windows will choose when it boots."
30703 #: ../tools/virt-win-reg.pl:638
30705 "Similarly, other C<Current...> keys in the path may need to be replaced."
30709 #: ../tools/virt-win-reg.pl:641
30710 msgid "WINDOWS TIPS"
30714 #: ../tools/virt-win-reg.pl:643
30716 "Note that some of these tips modify the guest disk image. The guest I<must>"
30717 " be shut off, else you will get disk corruption."
30721 #: ../tools/virt-win-reg.pl:646
30722 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
30726 #: ../tools/virt-win-reg.pl:648
30728 "Prepare a DOS batch script, VBScript or executable. Upload this using "
30729 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
30730 "is uploaded into C<C:\\>:"
30734 #: ../tools/virt-win-reg.pl:652
30737 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
30742 #: ../tools/virt-win-reg.pl:654
30743 msgid "Prepare a regedit file containing the registry change:"
30747 #: ../tools/virt-win-reg.pl:656
30750 " cat > test.reg <<'EOF'\n"
30751 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
30752 " \"Test\"=\"c:\\\\test.bat\"\n"
30758 #: ../tools/virt-win-reg.pl:661
30760 "In this example we use the key C<RunOnce> which means that the script will "
30761 "run precisely once when the first user logs in. If you want it to run every"
30762 " time a user logs in, replace C<RunOnce> with C<Run>."
30766 #: ../tools/virt-win-reg.pl:665
30767 msgid "Now update the registry:"
30771 #: ../tools/virt-win-reg.pl:667
30774 " virt-win-reg --merge WindowsGuest test.reg\n"
30779 #: ../tools/virt-win-reg.pl:669
30780 msgid "INSTALLING A SERVICE"
30784 #: ../tools/virt-win-reg.pl:671
30786 "This section assumes you are familiar with Windows services, and you either "
30787 "have a program which handles the Windows Service Control Protocol directly "
30788 "or you want to run any program using a service wrapper like SrvAny or the "
30793 #: ../tools/virt-win-reg.pl:676
30795 "First upload the program and optionally the service wrapper. In this case "
30796 "the test program is called C<test.exe> and we are using the RHSrvAny "
30801 #: ../tools/virt-win-reg.pl:680
30804 " guestfish -i -d WindowsGuest <<EOF\n"
30805 " upload rhsrvany.exe /rhsrvany.exe\n"
30806 " upload test.exe /test.exe\n"
30812 #: ../tools/virt-win-reg.pl:685
30814 "Prepare a regedit file containing the registry changes. In this example, "
30815 "the first registry change is needed for the service itself or the service "
30816 "wrapper (if used). The second registry change is only needed because I am "
30817 "using the RHSrvAny service wrapper."
30821 #: ../tools/virt-win-reg.pl:690
30824 " cat > service.reg <<'EOF'\n"
30825 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
30826 " \"Type\"=dword:00000010\n"
30827 " \"Start\"=dword:00000002\n"
30828 " \"ErrorControl\"=dword:00000001\n"
30829 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
30830 " \"DisplayName\"=\"RHSrvAny\"\n"
30831 " \"ObjectName\"=\"NetworkService\"\n"
30836 #: ../tools/virt-win-reg.pl:699
30839 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
30840 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
30841 " \"PWD\"=\"c:\\\\Temp\"\n"
30847 #: ../tools/virt-win-reg.pl:710
30849 "For use of C<ControlSet001> see the section above in this manual page. You "
30850 "may need to adjust this according to the control set that is in use by the "
30855 #: ../tools/virt-win-reg.pl:716
30857 "C<\"ObjectName\"> controls the privileges that the service will have. An "
30858 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
30859 "privileged account."
30863 #: ../tools/virt-win-reg.pl:722
30865 "For the meaning of the magic numbers, see this Microsoft KB article: "
30866 "L<http://support.microsoft.com/kb/103000>."
30870 #: ../tools/virt-win-reg.pl:727
30871 msgid "Update the registry:"
30875 #: ../tools/virt-win-reg.pl:729
30878 " virt-win-reg --merge WindowsGuest service.reg\n"
30883 #: ../tools/virt-win-reg.pl:731 ../tools/virt-list-filesystems.pl:182
30884 #: ../tools/virt-tar.pl:279 ../tools/virt-make-fs.pl:532
30885 #: ../tools/virt-list-partitions.pl:250
30886 msgid "SHELL QUOTING"
30890 #: ../tools/virt-win-reg.pl:733
30892 "Be careful when passing parameters containing C<\\> (backslash) in the "
30893 "shell. Usually you will have to use 'single quotes' or double backslashes "
30894 "(but not both) to protect them from the shell."
30898 #: ../tools/virt-win-reg.pl:737
30899 msgid "Paths and value names are case-insensitive."
30903 #: ../tools/virt-win-reg.pl:739 ../tools/virt-list-filesystems.pl:184
30904 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
30905 #: ../tools/virt-list-partitions.pl:252
30907 "Libvirt guest names can contain arbitrary characters, some of which have "
30908 "meaning to the shell such as C<#> and space. You may need to quote or "
30909 "escape these characters on the command line. See the shell manual page "
30910 "L<sh(1)> for details."
30914 #: ../tools/virt-win-reg.pl:746
30916 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
30917 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
30918 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
30919 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
30923 #: ../tools/virt-win-reg.pl:761 ../tools/virt-make-fs.pl:555
30925 "When reporting bugs, please enable debugging and capture the I<complete> "
30930 #: ../tools/virt-win-reg.pl:764
30933 " export LIBGUESTFS_DEBUG=1\n"
30934 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
30939 #: ../tools/virt-win-reg.pl:767
30941 "Attach /tmp/virt-win-reg.log to a new bug report at "
30942 "L<https://bugzilla.redhat.com/>"
30946 #: ../tools/virt-win-reg.pl:770 ../tools/virt-list-filesystems.pl:202
30947 #: ../tools/virt-tar.pl:301 ../tools/virt-make-fs.pl:564
30948 #: ../tools/virt-list-partitions.pl:269
30953 #: ../tools/virt-win-reg.pl:772 ../tools/virt-list-filesystems.pl:204
30954 #: ../tools/virt-tar.pl:303 ../tools/virt-make-fs.pl:566
30955 #: ../tools/virt-list-partitions.pl:271
30956 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
30960 #: ../tools/virt-win-reg.pl:776 ../tools/virt-make-fs.pl:570
30961 msgid "Copyright (C) 2010 Red Hat Inc."
30965 #: ../tools/virt-list-filesystems.pl:32
30967 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
30971 #: ../tools/virt-list-filesystems.pl:36
30974 " virt-list-filesystems [--options] domname\n"
30979 #: ../tools/virt-list-filesystems.pl:38
30982 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
30987 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
30989 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
30994 #: ../tools/virt-list-filesystems.pl:45
30996 "C<virt-list-filesystems> is a command line tool to list the filesystems that"
30997 " are contained in a virtual machine or disk image."
31001 #: ../tools/virt-list-filesystems.pl:49
31003 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
31004 "functionality. For more complex cases you should look at the "
31005 "L<guestfish(1)> tool."
31009 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
31010 msgid "B<-l> | B<--long>"
31014 #: ../tools/virt-list-filesystems.pl:108
31016 "With this option, C<virt-list-filesystems> displays the type of each "
31017 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
31021 #: ../tools/virt-list-filesystems.pl:115
31022 msgid "B<-a> | B<--all>"
31026 #: ../tools/virt-list-filesystems.pl:117
31028 "Normally we only show mountable filesystems. If this option is given then "
31029 "swap devices are shown too."
31033 #: ../tools/virt-list-filesystems.pl:191
31035 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
31036 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
31037 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31041 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:307
31042 msgid "Copyright (C) 2009 Red Hat Inc."
31046 #: ../tools/virt-tar.pl:33
31047 msgid "virt-tar - Extract or upload files to a virtual machine"
31051 #: ../tools/virt-tar.pl:37
31054 " virt-tar [--options] -x domname directory tarball\n"
31059 #: ../tools/virt-tar.pl:39
31062 " virt-tar [--options] -u domname tarball directory\n"
31067 #: ../tools/virt-tar.pl:41
31070 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
31075 #: ../tools/virt-tar.pl:43
31078 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
31083 #: ../tools/virt-tar.pl:47
31085 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
31086 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
31090 #: ../tools/virt-tar.pl:52
31091 msgid "Download C</home> from the VM into a local tarball:"
31095 #: ../tools/virt-tar.pl:54
31098 " virt-tar -x domname /home home.tar\n"
31103 #: ../tools/virt-tar.pl:56
31106 " virt-tar -zx domname /home home.tar.gz\n"
31111 #: ../tools/virt-tar.pl:58
31112 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
31116 #: ../tools/virt-tar.pl:60
31119 " virt-tar -u domname uploadstuff.tar /tmp\n"
31124 #: ../tools/virt-tar.pl:62
31127 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
31132 #: ../tools/virt-tar.pl:66
31134 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
31135 "virtual machines. If you do this, you risk disk corruption in the VM. C"
31136 "<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
31140 #: ../tools/virt-tar.pl:71
31142 "You can use I<-x> (extract) on live virtual machines, but you might get "
31143 "inconsistent results or errors if there is filesystem activity inside the "
31144 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
31145 "work, but the only way to guarantee consistent results is if the virtual "
31146 "machine is shut down."
31150 #: ../tools/virt-tar.pl:79
31152 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
31153 "parts of a guest filesystem. There are many possibilities: making backups, "
31154 "uploading data files, snooping on guest activity, fixing or customizing "
31159 #: ../tools/virt-tar.pl:84
31161 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
31162 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you"
31163 " should look at the L<guestfish(1)> tool."
31167 #: ../tools/virt-tar.pl:88
31169 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
31170 "its contents (recursively) from the virtual machine into a local tarball. "
31171 "I<-u> uploads from a local tarball, unpacking it into a directory inside the"
31172 " virtual machine. You cannot use these two options together."
31176 #: ../tools/virt-tar.pl:94
31178 "In addition, you may need to use the I<-z> (gZip) option to enable "
31179 "compression. When uploading, you have to specify I<-z> if the upload file "
31180 "is compressed because virt-tar won't detect this on its own."
31184 #: ../tools/virt-tar.pl:98
31186 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
31187 "example it cannot do PKZip files or bzip2 compression. If you want that "
31188 "then you'll have to rebuild the tarballs yourself. (This is a limitation of"
31189 " the L<libguestfs(3)> API)."
31193 #: ../tools/virt-tar.pl:156
31194 msgid "B<-x> | B<--extract> | B<--download>"
31198 #: ../tools/virt-tar.pl:158
31199 msgid "B<-u> | B<--upload>"
31203 #: ../tools/virt-tar.pl:160
31205 "Use I<-x> to extract (download) a directory from a virtual machine to a "
31210 #: ../tools/virt-tar.pl:163
31212 "Use I<-u> to upload and unpack from a local tarball into a virtual machine."
31213 " Please read the L</WARNING> section above before using this option."
31217 #: ../tools/virt-tar.pl:167
31218 msgid "You must specify exactly one of these options."
31222 #: ../tools/virt-tar.pl:173
31223 msgid "B<-z> | B<--gzip>"
31227 #: ../tools/virt-tar.pl:175
31228 msgid "Specify that the input or output tarball is gzip-compressed."
31232 #: ../tools/virt-tar.pl:288
31234 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-"
31235 "copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
31236 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
31237 "L<http://libguestfs.org/>."
31241 #: ../tools/virt-make-fs.pl:37
31242 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
31246 #: ../tools/virt-make-fs.pl:41
31249 " virt-make-fs [--options] input.tar output.img\n"
31254 #: ../tools/virt-make-fs.pl:43
31257 " virt-make-fs [--options] input.tar.gz output.img\n"
31262 #: ../tools/virt-make-fs.pl:45
31265 " virt-make-fs [--options] directory output.img\n"
31270 #: ../tools/virt-make-fs.pl:49
31272 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
31273 "archive or some files in a directory. It is similar to tools like "
31274 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
31275 "it can create common filesystem types like ext2/3 or NTFS, which can be "
31276 "useful if you want to attach these filesystems to existing virtual machines "
31277 "(eg. to import large amounts of read-only data to a VM)."
31281 #: ../tools/virt-make-fs.pl:57
31282 msgid "Basic usage is:"
31286 #: ../tools/virt-make-fs.pl:59
31289 " virt-make-fs input output\n"
31294 #: ../tools/virt-make-fs.pl:61
31296 "where C<input> is either a directory containing files that you want to add, "
31297 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
31298 "C<output> is a disk image. The input type is detected automatically. The "
31299 "output disk image defaults to a raw ext2 image unless you specify extra "
31300 "flags (see L</OPTIONS> below)."
31304 #: ../tools/virt-make-fs.pl:67
31305 msgid "EXTRA SPACE"
31309 #: ../tools/virt-make-fs.pl:69
31311 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
31312 "the files that it contains, but might have extra space. Depending on how "
31313 "you are going to use the output, you might think this extra space is wasted "
31314 "and want to minimize it, or you might want to leave space so that more files"
31315 " can be added later. Virt-make-fs defaults to minimizing the extra space, "
31316 "but you can use the I<--size> flag to leave space in the filesystem if you "
31321 #: ../tools/virt-make-fs.pl:77
31323 "An alternative way to leave extra space but not make the output image any "
31324 "bigger is to use an alternative disk image format (instead of the default "
31325 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2"
31326 " image format (check your hypervisor supports this before using it). This "
31327 "allows you to choose a large I<--size> but the extra space won't actually be"
31328 " allocated in the image until you try to store something in it."
31332 #: ../tools/virt-make-fs.pl:85
31334 "Don't forget that you can also use local commands including L<resize2fs(8)> "
31335 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
31336 "to build another image from scratch."
31340 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
31341 #: ../tools/virt-make-fs.pl:142
31346 #: ../tools/virt-make-fs.pl:91
31349 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
31354 #: ../tools/virt-make-fs.pl:93
31355 msgid "FILESYSTEM TYPE"
31359 #: ../tools/virt-make-fs.pl:95
31361 "The default filesystem type is C<ext2>. Just about any filesystem type that"
31362 " libguestfs supports can be used (but I<not> read-only formats like "
31363 "ISO9660). Here are some of the more common choices:"
31367 #: ../tools/virt-make-fs.pl:101
31372 #: ../tools/virt-make-fs.pl:103
31374 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If"
31375 " you are not going to use the filesystem in a way that requires the journal,"
31376 " then this is just wasted overhead."
31380 #: ../tools/virt-make-fs.pl:107
31381 msgid "I<ntfs> or I<vfat>"
31385 #: ../tools/virt-make-fs.pl:109
31386 msgid "Useful if exporting data to a Windows guest."
31390 #: ../tools/virt-make-fs.pl:111
31392 "I<Note for vfat>: The tar archive or local directory must only contain files"
31393 " which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
31394 "program running within libguestfs is unable to change the ownership of non-"
31395 "root files, since vfat itself does not support this."
31399 #: ../tools/virt-make-fs.pl:116
31404 #: ../tools/virt-make-fs.pl:118
31406 "Lower overhead than C<ext2>, but certain limitations on filename length and "
31407 "total filesystem size."
31411 #: ../tools/virt-make-fs.pl:125
31414 " virt-make-fs --type=minix input minixfs.img\n"
31419 #: ../tools/virt-make-fs.pl:127
31420 msgid "TO PARTITION OR NOT TO PARTITION"
31424 #: ../tools/virt-make-fs.pl:129
31425 msgid "Optionally virt-make-fs can add a partition table to the output disk."
31429 #: ../tools/virt-make-fs.pl:131
31431 "Adding a partition can make the disk image more compatible with certain "
31432 "virtualized operating systems which don't expect to see a filesystem "
31433 "directly located on a block device (Linux doesn't care and will happily "
31434 "handle both types)."
31438 #: ../tools/virt-make-fs.pl:136
31440 "On the other hand, if you have a partition table then the output image is no"
31441 " longer a straight filesystem. For example you cannot run L<fsck(8)> "
31442 "directly on a partitioned disk image. (However libguestfs tools such as "
31443 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
31447 #: ../tools/virt-make-fs.pl:144
31448 msgid "Add an MBR partition:"
31452 #: ../tools/virt-make-fs.pl:146
31455 " virt-make-fs --partition -- input disk.img\n"
31460 #: ../tools/virt-make-fs.pl:148
31462 "If the output disk image could be terabyte-sized or larger, it's better to "
31463 "use an EFI/GPT-compatible partition table:"
31467 #: ../tools/virt-make-fs.pl:151
31470 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
31475 #: ../tools/virt-make-fs.pl:179
31476 msgid "Enable debugging information."
31480 #: ../tools/virt-make-fs.pl:185
31481 msgid "B<--size=E<lt>NE<gt>>"
31485 #: ../tools/virt-make-fs.pl:187
31486 msgid "B<--size=+E<lt>NE<gt>>"
31490 #: ../tools/virt-make-fs.pl:189
31491 msgid "B<-s E<lt>NE<gt>>"
31495 #: ../tools/virt-make-fs.pl:191
31496 msgid "B<-s +E<lt>NE<gt>>"
31500 #: ../tools/virt-make-fs.pl:193
31502 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
31506 #: ../tools/virt-make-fs.pl:196
31508 "If this option is I<not> given, then the output image will be just large "
31509 "enough to contain all the files, with not much wasted space."
31513 #: ../tools/virt-make-fs.pl:199
31515 "To choose a fixed size output disk, specify an absolute number followed by "
31516 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31517 "Petabytes or Exabytes. This must be large enough to contain all the input "
31518 "files, else you will get an error."
31522 #: ../tools/virt-make-fs.pl:204
31524 "To leave extra space, specify C<+> (plus sign) and a number followed by "
31525 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
31526 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
31527 "the input files, and (approximately) an extra 200 MB free space."
31531 #: ../tools/virt-make-fs.pl:210
31533 "Note that virt-make-fs estimates free space, and therefore will not produce "
31534 "filesystems containing precisely the free space requested. (It is much more"
31535 " expensive and time-consuming to produce a filesystem which has precisely "
31536 "the desired free space)."
31540 #: ../tools/virt-make-fs.pl:219
31541 msgid "B<--format=E<lt>fmtE<gt>>"
31545 #: ../tools/virt-make-fs.pl:221
31546 msgid "B<-F E<lt>fmtE<gt>>"
31550 #: ../tools/virt-make-fs.pl:223
31551 msgid "Choose the output disk image format."
31555 #: ../tools/virt-make-fs.pl:225
31556 msgid "The default is C<raw> (raw disk image)."
31560 #: ../tools/virt-make-fs.pl:227
31562 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
31563 "that would really make sense here is C<qcow2>."
31567 #: ../tools/virt-make-fs.pl:234
31568 msgid "B<--type=E<lt>fsE<gt>>"
31572 #: ../tools/virt-make-fs.pl:236
31573 msgid "B<-t E<lt>fsE<gt>>"
31577 #: ../tools/virt-make-fs.pl:238
31578 msgid "Choose the output filesystem type."
31582 #: ../tools/virt-make-fs.pl:240
31583 msgid "The default is C<ext2>."
31587 #: ../tools/virt-make-fs.pl:242
31589 "Any filesystem which is supported read-write by libguestfs can be used here."
31593 #: ../tools/virt-make-fs.pl:249
31594 msgid "B<--partition>"
31598 #: ../tools/virt-make-fs.pl:251
31599 msgid "B<--partition=E<lt>parttypeE<gt>>"
31603 #: ../tools/virt-make-fs.pl:253
31605 "If specified, this flag adds an MBR partition table to the output disk "
31610 #: ../tools/virt-make-fs.pl:256
31612 "You can change the partition table type, eg. I<--partition=gpt> for large "
31617 #: ../tools/virt-make-fs.pl:259
31619 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
31620 "might consider the next parameter to be the partition type. For example:"
31624 #: ../tools/virt-make-fs.pl:263
31627 " virt-make-fs --partition input.tar ...\n"
31632 #: ../tools/virt-make-fs.pl:265
31634 "would cause virt-make-fs to think you wanted to use a partition type of "
31635 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
31636 "dash) between options and the input file argument:"
31640 #: ../tools/virt-make-fs.pl:269
31643 " virt-make-fs --partition -- input.tar ...\n"
31648 #: ../tools/virt-make-fs.pl:541
31650 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
31651 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
31652 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
31656 #: ../tools/virt-make-fs.pl:558
31659 " export LIBGUESTFS_DEBUG=1\n"
31660 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
31665 #: ../tools/virt-make-fs.pl:561
31667 "Attach /tmp/virt-make-fs.log to a new bug report at "
31668 "L<https://bugzilla.redhat.com/>"
31672 #: ../tools/virt-list-partitions.pl:32
31674 "virt-list-partitions - List partitions in a virtual machine or disk image"
31678 #: ../tools/virt-list-partitions.pl:36
31681 " virt-list-partitions [--options] domname\n"
31686 #: ../tools/virt-list-partitions.pl:38
31689 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
31694 #: ../tools/virt-list-partitions.pl:45
31696 "C<virt-list-partitions> is a command line tool to list the partitions that "
31697 "are contained in a virtual machine or disk image. It is mainly useful as a "
31698 "first step to using L<virt-resize(1)>."
31702 #: ../tools/virt-list-partitions.pl:50
31704 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
31705 "functionality. For more complex cases you should look at the "
31706 "L<guestfish(1)> tool."
31710 #: ../tools/virt-list-partitions.pl:107
31711 msgid "B<-h> | B<--human-readable>"
31715 #: ../tools/virt-list-partitions.pl:109
31716 msgid "Show sizes in human-readable form (eg. \"1G\")."
31720 #: ../tools/virt-list-partitions.pl:117
31722 "With this option, C<virt-list-partitions> displays the type and size of each"
31723 " partition too (where \"type\" means C<ext3>, C<pv> etc.)"
31727 #: ../tools/virt-list-partitions.pl:124
31728 msgid "B<-t> | B<--total>"
31732 #: ../tools/virt-list-partitions.pl:126
31734 "Display the total size of each block device (as a separate row or rows)."
31738 #: ../tools/virt-list-partitions.pl:259
31740 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
31741 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
31742 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
31746 #: ../tools/virt-list-partitions.pl:275
31747 msgid "Copyright (C) 2009-2010 Red Hat Inc."