1 # SOME DESCRIPTIVE TITLE.
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: PACKAGE VERSION\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2010-11-23 10:39+0000\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
21 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
22 #: ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32
23 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
24 #: ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29
25 #: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
30 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
31 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
32 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34
33 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
34 #: ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31
35 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
40 #: ../src/guestfs.pod:5
41 msgid "guestfs - Library for accessing and modifying virtual machine images"
45 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
46 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
47 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38
48 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
49 #: ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35
50 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
55 #: ../src/guestfs.pod:9
58 " #include <guestfs.h>\n"
63 #: ../src/guestfs.pod:11
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_sync (g);\n"
73 " guestfs_close (g);\n"
78 #: ../src/guestfs.pod:20
81 " cc prog.c -o prog -lguestfs\n"
83 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
88 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30
89 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
90 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46
91 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
92 #: ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51
93 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
98 #: ../src/guestfs.pod:26
100 "Libguestfs is a library for accessing and modifying guest disk images. "
101 "Amongst the things this is good for: making batch configuration changes to "
102 "guests, getting disk used/free statistics (see also: virt-df), migrating "
103 "between virtualization systems (see also: virt-p2v), performing partial "
104 "backups, performing partial guest clones, cloning guests and changing "
105 "registry/UUID/hostname info, and much else besides."
109 #: ../src/guestfs.pod:34
111 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
112 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
113 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
118 #: ../src/guestfs.pod:39
120 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
121 "what filesystem is in each LV, etc.). It can also run commands in the "
122 "context of the guest. Also you can access filesystems over FUSE."
126 #: ../src/guestfs.pod:44
128 "Libguestfs is a library that can be linked with C and C++ management "
129 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
130 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
135 #: ../src/guestfs.pod:49
137 "You don't need to be root to use libguestfs, although obviously you do need "
138 "enough permissions to access the disk images."
142 #: ../src/guestfs.pod:52
144 "Libguestfs is a large API because it can do many things. For a gentle "
145 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:55
154 #: ../src/guestfs.pod:57
156 "This section provides a gentler overview of the libguestfs API. We also try "
157 "to group API calls together, where that may not be obvious from reading "
158 "about the individual calls in the main section of this manual."
162 #: ../src/guestfs.pod:62
167 #: ../src/guestfs.pod:64
169 "Before you can use libguestfs calls, you have to create a handle. Then you "
170 "must add at least one disk image to the handle, followed by launching the "
171 "handle, then performing whatever operations you want, and finally closing "
172 "the handle. By convention we use the single letter C<g> for the name of the "
173 "handle variable, although of course you can use any name you want."
177 #: ../src/guestfs.pod:71
178 msgid "The general structure of all libguestfs-using programs looks like this:"
182 #: ../src/guestfs.pod:74
185 " guestfs_h *g = guestfs_create ();\n"
190 #: ../src/guestfs.pod:76
193 " /* Call guestfs_add_drive additional times if there are\n"
194 " * multiple disk images.\n"
196 " guestfs_add_drive (g, \"guest.img\");\n"
201 #: ../src/guestfs.pod:81
204 " /* Most manipulation calls won't work until you've launched\n"
205 " * the handle 'g'. You have to do this _after_ adding drives\n"
206 " * and _before_ other commands.\n"
208 " guestfs_launch (g);\n"
213 #: ../src/guestfs.pod:87
216 " /* Now you can examine what partitions, LVs etc are available.\n"
218 " char **partitions = guestfs_list_partitions (g);\n"
219 " char **logvols = guestfs_lvs (g);\n"
224 #: ../src/guestfs.pod:92
227 " /* To access a filesystem in the image, you must mount it.\n"
229 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
234 #: ../src/guestfs.pod:96
237 " /* Now you can perform filesystem actions on the guest\n"
240 " guestfs_touch (g, \"/hello\");\n"
245 #: ../src/guestfs.pod:101
248 " /* You only need to call guestfs_sync if you have made\n"
249 " * changes to the guest image. (But if you've made changes\n"
250 " * then you *must* sync). See also: guestfs_umount and\n"
251 " * guestfs_umount_all calls.\n"
253 " guestfs_sync (g);\n"
258 #: ../src/guestfs.pod:108
261 " /* Close the handle 'g'. */\n"
262 " guestfs_close (g);\n"
267 #: ../src/guestfs.pod:111
269 "The code above doesn't include any error checking. In real code you should "
270 "check return values carefully for errors. In general all functions that "
271 "return integers return C<-1> on error, and all functions that return "
272 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
273 "how to handle errors, and consult the documentation for each function call "
274 "below to see precisely how they return error indications."
278 #: ../src/guestfs.pod:119
283 #: ../src/guestfs.pod:121
285 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
286 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
287 "actual block device, or simply an empty file of zeroes that you have created "
288 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
293 #: ../src/guestfs.pod:127
295 "The call you should use in modern code for adding drives is L</"
296 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
297 "specifying that the format is raw, do:"
301 #: ../src/guestfs.pod:131
304 " guestfs_add_drive_opts (g, filename,\n"
305 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
311 #: ../src/guestfs.pod:135
312 msgid "You can add a disk read-only using:"
316 #: ../src/guestfs.pod:137
319 " guestfs_add_drive_opts (g, filename,\n"
320 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
321 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
327 #: ../src/guestfs.pod:142
329 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
330 "libguestfs won't modify the file."
334 #: ../src/guestfs.pod:145
336 "Be extremely cautious if the disk image is in use, eg. if it is being used "
337 "by a virtual machine. Adding it read-write will almost certainly cause disk "
338 "corruption, but adding it read-only is safe."
342 #: ../src/guestfs.pod:149
344 "You must add at least one disk image, and you may add multiple disk images. "
345 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
346 "first one you added), C</dev/sdb> (for the second one you added), etc."
350 #: ../src/guestfs.pod:154
352 "Once L</guestfs_launch> has been called you cannot add any more images. You "
353 "can call L</guestfs_list_devices> to get a list of the device names, in the "
354 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
358 #: ../src/guestfs.pod:159
363 #: ../src/guestfs.pod:161
365 "Before you can read or write files, create directories and so on in a disk "
366 "image that contains filesystems, you have to mount those filesystems using "
367 "L</guestfs_mount>. If you already know that a disk image contains (for "
368 "example) one partition with a filesystem on that partition, then you can "
373 #: ../src/guestfs.pod:167
376 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
381 #: ../src/guestfs.pod:169
383 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
384 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
385 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
389 #: ../src/guestfs.pod:173
391 "If you are given a disk image and you don't know what it contains then you "
392 "have to find out. Libguestfs can do that too: use L</"
393 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
394 "LVs, and either try mounting each to see what is mountable, or else examine "
395 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
396 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
397 "you might find it easier to look at higher level programs built on top of "
398 "libguestfs, in particular L<virt-inspector(1)>."
402 #: ../src/guestfs.pod:183
404 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
405 "several other variations of the C<guestfs_mount_*> call."
409 #: ../src/guestfs.pod:186
410 msgid "FILESYSTEM ACCESS AND MODIFICATION"
414 #: ../src/guestfs.pod:188
416 "The majority of the libguestfs API consists of fairly low-level calls for "
417 "accessing and modifying the files, directories, symlinks etc on mounted "
418 "filesystems. There are over a hundred such calls which you can find listed "
419 "in detail below in this man page, and we don't even pretend to cover them "
420 "all in this overview."
424 #: ../src/guestfs.pod:194
426 "Specify filenames as full paths, starting with C<\"/\"> and including the "
431 #: ../src/guestfs.pod:197
433 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
434 "the file called C<\"etc/passwd\"> then you could do:"
438 #: ../src/guestfs.pod:200
441 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
446 #: ../src/guestfs.pod:202
448 "This would return C<data> as a newly allocated buffer containing the full "
449 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
450 "or C<NULL> if there was an error."
454 #: ../src/guestfs.pod:206
456 "As another example, to create a top-level directory on that filesystem "
457 "called C<\"var\"> you would do:"
461 #: ../src/guestfs.pod:209
464 " guestfs_mkdir (g, \"/var\");\n"
469 #: ../src/guestfs.pod:211
470 msgid "To create a symlink you could do:"
474 #: ../src/guestfs.pod:213
477 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
478 " \"/etc/rc3.d/S30portmap\");\n"
483 #: ../src/guestfs.pod:216
485 "Libguestfs will reject attempts to use relative paths and there is no "
486 "concept of a current working directory."
490 #: ../src/guestfs.pod:219
492 "Libguestfs can return errors in many situations: for example if the "
493 "filesystem isn't writable, or if a file or directory that you requested "
494 "doesn't exist. If you are using the C API (documented here) you have to "
495 "check for those error conditions after each call. (Other language bindings "
496 "turn these errors into exceptions)."
500 #: ../src/guestfs.pod:225
502 "File writes are affected by the per-handle umask, set by calling L</"
503 "guestfs_umask> and defaulting to 022. See L</UMASK>."
507 #: ../src/guestfs.pod:228
512 #: ../src/guestfs.pod:230
514 "Libguestfs contains API calls to read, create and modify partition tables on "
519 #: ../src/guestfs.pod:233
521 "In the common case where you want to create a single partition covering the "
522 "whole disk, you should use the L</guestfs_part_disk> call:"
526 #: ../src/guestfs.pod:237
529 " const char *parttype = \"mbr\";\n"
530 " if (disk_is_larger_than_2TB)\n"
531 " parttype = \"gpt\";\n"
532 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
537 #: ../src/guestfs.pod:242
539 "Obviously this effectively wipes anything that was on that disk image before."
543 #: ../src/guestfs.pod:245
548 #: ../src/guestfs.pod:247
550 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
551 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
552 "you familiarize yourself with the concepts of physical volumes, volume "
553 "groups and logical volumes."
557 #: ../src/guestfs.pod:252
559 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
560 "tldp.org/HOWTO/LVM-HOWTO/>."
564 #: ../src/guestfs.pod:255
569 #: ../src/guestfs.pod:257
571 "Use L</guestfs_cat> to download small, text only files. This call is "
572 "limited to files which are less than 2 MB and which cannot contain any ASCII "
573 "NUL (C<\\0>) characters. However it has a very simple to use API."
577 #: ../src/guestfs.pod:262
579 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
580 "bit data, since it returns a (pointer, size) pair. However it is still "
581 "limited to \"small\" files, less than 2 MB."
585 #: ../src/guestfs.pod:266
587 "L</guestfs_download> can be used to download any file, with no limits on "
588 "content or size (even files larger than 4 GB)."
592 #: ../src/guestfs.pod:269
594 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
598 #: ../src/guestfs.pod:272
603 #: ../src/guestfs.pod:274
605 "It's often the case that you want to write a file or files to the disk image."
609 #: ../src/guestfs.pod:277
611 "To write a small file with fixed content, use L</guestfs_write>. To create "
612 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
613 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
614 "of other functions for creating test files, for example L</guestfs_fill> and "
615 "L</guestfs_fill_pattern>."
619 #: ../src/guestfs.pod:283
621 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
622 "file content or size (even files larger than 4 GB)."
626 #: ../src/guestfs.pod:286
628 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
632 #: ../src/guestfs.pod:288
634 "However the fastest way to upload I<large numbers of arbitrary files> is to "
635 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
636 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
637 "in a predictable way (eg. adding it last after all other drives) then you "
638 "can get the device name from L</guestfs_list_devices> and mount it directly "
639 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
640 "portable between kernel versions, and they don't support labels or UUIDs. "
641 "If you want to pre-build an image or you need to mount it using a label or "
642 "UUID, use an ISO image instead."
646 #: ../src/guestfs.pod:299
651 #: ../src/guestfs.pod:301
653 "There are various different commands for copying between files and devices "
654 "and in and out of the guest filesystem. These are summarised in the table "
659 #: ../src/guestfs.pod:307
660 msgid "B<file> to B<file>"
664 #: ../src/guestfs.pod:309
666 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
667 "directories recursively."
671 #: ../src/guestfs.pod:312
672 msgid "B<file or device> to B<file or device>"
676 #: ../src/guestfs.pod:314
678 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
679 "devices in the guest."
683 #: ../src/guestfs.pod:317
684 msgid "Example: duplicate the contents of an LV:"
688 #: ../src/guestfs.pod:319
691 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
696 #: ../src/guestfs.pod:321
698 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
699 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
700 "guestfs_copy_size>."
704 #: ../src/guestfs.pod:325
705 msgid "B<file on the host> to B<file or device>"
709 #: ../src/guestfs.pod:327
710 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
714 #: ../src/guestfs.pod:329
715 msgid "B<file or device> to B<file on the host>"
719 #: ../src/guestfs.pod:331
720 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
724 #: ../src/guestfs.pod:335
725 msgid "LISTING FILES"
729 #: ../src/guestfs.pod:337
731 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
732 "L<guestfish(1)>-equivalent command C<ll>)."
736 #: ../src/guestfs.pod:340
738 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
739 "programs, as a flat list of strings."
743 #: ../src/guestfs.pod:343
745 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
746 "directory, plus additional information about each one. It is more "
747 "equivalent to using the L<readdir(3)> call on a local filesystem."
751 #: ../src/guestfs.pod:347
753 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
757 #: ../src/guestfs.pod:350
758 msgid "RUNNING COMMANDS"
762 #: ../src/guestfs.pod:352
764 "Although libguestfs is primarily an API for manipulating files inside guest "
765 "images, we also provide some limited facilities for running commands inside "
770 #: ../src/guestfs.pod:356
771 msgid "There are many limitations to this:"
775 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370
776 #: ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383
777 #: ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:957
778 #: ../src/guestfs.pod:961 ../src/guestfs.pod:965 ../src/guestfs.pod:970
779 #: ../src/guestfs.pod:978 ../src/guestfs.pod:997 ../src/guestfs.pod:1005
780 #: ../src/guestfs.pod:1027 ../src/guestfs.pod:1031 ../src/guestfs.pod:1035
781 #: ../src/guestfs.pod:1039 ../src/guestfs.pod:1043 ../src/guestfs.pod:1047
782 #: ../src/guestfs.pod:1529 ../src/guestfs.pod:1534 ../src/guestfs.pod:1538
783 #: ../src/guestfs.pod:1648 ../src/guestfs.pod:1653 ../src/guestfs.pod:1657
784 #: ../src/guestfs.pod:2001 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012
785 #: ../src/guestfs.pod:2018 ../src/guestfs.pod:2126 ../src/guestfs.pod:2130
786 #: ../src/guestfs.pod:2134 ../src/guestfs.pod:2138
787 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
788 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
789 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
790 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
791 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
792 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
793 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
794 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
795 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
796 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
797 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
798 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:377
799 #: ../fish/guestfish.pod:381 ../fish/guestfish.pod:385
800 #: ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13
801 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375
802 #: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390
803 #: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067
804 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
805 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
806 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
807 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
808 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
809 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
810 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
811 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
812 #: ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:347
813 #: ../tools/virt-resize.pl:352 ../tools/virt-resize.pl:362
818 #: ../src/guestfs.pod:362
820 "The kernel version that the command runs under will be different from what "
825 #: ../src/guestfs.pod:367
827 "If the command needs to communicate with daemons, then most likely they "
832 #: ../src/guestfs.pod:372
833 msgid "The command will be running in limited memory."
837 #: ../src/guestfs.pod:376
839 "The network may not be available unless you enable it (see L</"
840 "guestfs_set_network>)."
844 #: ../src/guestfs.pod:381
845 msgid "Only supports Linux guests (not Windows, BSD, etc)."
849 #: ../src/guestfs.pod:385
851 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
855 #: ../src/guestfs.pod:390
857 "For SELinux guests, you may need to enable SELinux and load policy first. "
858 "See L</SELINUX> in this manpage."
862 #: ../src/guestfs.pod:395
864 "I<Security:> It is not safe to run commands from untrusted, possibly "
865 "malicious guests. These commands may attempt to exploit your program by "
866 "sending unexpected output. They could also try to exploit the Linux kernel "
867 "or qemu provided by the libguestfs appliance. They could use the network "
868 "provided by the libguestfs appliance to bypass ordinary network partitions "
869 "and firewalls. They could use the elevated privileges or different SELinux "
870 "context of your program to their advantage."
874 #: ../src/guestfs.pod:404
876 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
877 "(a script which runs when the guest next boots normally), and to have this "
878 "script run the commands you want in the normal context of the running guest, "
879 "network security and so on. For information about other security issues, "
884 #: ../src/guestfs.pod:412
886 "The two main API calls to run commands are L</guestfs_command> and L</"
887 "guestfs_sh> (there are also variations)."
891 #: ../src/guestfs.pod:415
893 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
894 "shell globs, redirections, etc will work."
898 #: ../src/guestfs.pod:418
899 msgid "CONFIGURATION FILES"
903 #: ../src/guestfs.pod:420
905 "To read and write configuration files in Linux guest filesystems, we "
906 "strongly recommend using Augeas. For example, Augeas understands how to "
907 "read and write, say, a Linux shadow password file or X.org configuration "
908 "file, and so avoids you having to write that code."
912 #: ../src/guestfs.pod:425
914 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
915 "document Augeas itself here because there is excellent documentation on the "
916 "L<http://augeas.net/> website."
920 #: ../src/guestfs.pod:429
922 "If you don't want to use Augeas (you fool!) then try calling L</"
923 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
928 #: ../src/guestfs.pod:433
933 #: ../src/guestfs.pod:435
935 "We support SELinux guests. To ensure that labeling happens correctly in "
936 "SELinux guests, you need to enable SELinux and load the guest's policy:"
940 #: ../src/guestfs.pod:441 ../src/guestfs.pod:1150 ../src/guestfs.pod:1281
945 #: ../src/guestfs.pod:443
946 msgid "Before launching, do:"
950 #: ../src/guestfs.pod:445
953 " guestfs_set_selinux (g, 1);\n"
958 #: ../src/guestfs.pod:447 ../src/guestfs.pod:1154 ../src/guestfs.pod:1285
963 #: ../src/guestfs.pod:449
965 "After mounting the guest's filesystem(s), load the policy. This is best "
966 "done by running the L<load_policy(8)> command in the guest itself:"
970 #: ../src/guestfs.pod:453
973 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
978 #: ../src/guestfs.pod:455
980 "(Older versions of C<load_policy> require you to specify the name of the "
985 #: ../src/guestfs.pod:458 ../src/guestfs.pod:1291
990 #: ../src/guestfs.pod:460
992 "Optionally, set the security context for the API. The correct security "
993 "context to use can only be known by inspecting the guest. As an example:"
997 #: ../src/guestfs.pod:464
1000 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1005 #: ../src/guestfs.pod:468
1006 msgid "This will work for running commands and editing existing files."
1010 #: ../src/guestfs.pod:470
1012 "When new files are created, you may need to label them explicitly, for "
1013 "example by running the external command C<restorecon pathname>."
1017 #: ../src/guestfs.pod:474
1022 #: ../src/guestfs.pod:476
1024 "Certain calls are affected by the current file mode creation mask (the "
1025 "\"umask\"). In particular ones which create files or directories, such as "
1026 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1027 "either the default mode that the file is created with or modifies the mode "
1032 #: ../src/guestfs.pod:482
1034 "The default umask is C<022>, so files are created with modes such as C<0644> "
1035 "and directories with C<0755>."
1039 #: ../src/guestfs.pod:485
1041 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1042 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1043 "guestfs_chmod> after creating each file or directory."
1047 #: ../src/guestfs.pod:489
1048 msgid "For more information about umask, see L<umask(2)>."
1052 #: ../src/guestfs.pod:491 ../fish/guestfish.pod:670
1053 msgid "ENCRYPTED DISKS"
1057 #: ../src/guestfs.pod:493
1059 "Libguestfs allows you to access Linux guests which have been encrypted using "
1060 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1061 "standard. This includes nearly all whole disk encryption systems used by "
1062 "modern Linux guests."
1066 #: ../src/guestfs.pod:499
1068 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1069 "returns the string C<crypto_LUKS>)."
1073 #: ../src/guestfs.pod:502
1075 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1076 "will require the passphrase!"
1080 #: ../src/guestfs.pod:505
1082 "Opening a LUKS device creates a new device mapper device called C</dev/"
1083 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1084 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1085 "from and encrypted to the underlying block device respectively."
1089 #: ../src/guestfs.pod:511
1091 "LVM volume groups on the device can be made visible by calling L</"
1092 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1093 "(s) can now be mounted in the usual way."
1097 #: ../src/guestfs.pod:515
1099 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1100 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1101 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1102 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1103 "underlying encrypted block device)."
1107 #: ../src/guestfs.pod:522
1112 #: ../src/guestfs.pod:524
1114 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1115 "contains operating systems. (These APIs used to be in a separate Perl-only "
1116 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1117 "frequently used part of this library has been rewritten in C and moved into "
1122 #: ../src/guestfs.pod:530
1124 "Add all disks belonging to the unknown virtual machine and call L</"
1125 "guestfs_launch> in the usual way."
1129 #: ../src/guestfs.pod:533
1131 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1132 "and certain heuristics, and returns a list of operating systems that were "
1133 "found. An empty list means none were found. A single element is the root "
1134 "filesystem of the operating system. For dual- or multi-boot guests, "
1135 "multiple roots can be returned, each one corresponding to a separate "
1136 "operating system. (Multi-boot virtual machines are extremely rare in the "
1137 "world of virtualization, but since this scenario can happen, we have built "
1138 "libguestfs to deal with it.)"
1142 #: ../src/guestfs.pod:542
1144 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1145 "to get additional details about that operating system. For example, call L</"
1146 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1147 "Windows and Linux-based operating systems respectively."
1151 #: ../src/guestfs.pod:548
1153 "Un*x-like and Linux-based operating systems usually consist of several "
1154 "filesystems which are mounted at boot time (for example, a separate boot "
1155 "partition mounted on C</boot>). The inspection rules are able to detect how "
1156 "filesystems correspond to mount points. Call "
1157 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1158 "hash table like this example:"
1162 #: ../src/guestfs.pod:555
1165 " /boot => /dev/sda1\n"
1166 " / => /dev/vg_guest/lv_root\n"
1167 " /usr => /dev/vg_guest/lv_usr\n"
1172 #: ../src/guestfs.pod:559
1174 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1175 "filesystems as suggested."
1179 #: ../src/guestfs.pod:562
1181 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1182 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1186 #: ../src/guestfs.pod:566
1188 "Inspection currently only works for some common operating systems. "
1189 "Contributors are welcome to send patches for other operating systems that we "
1190 "currently cannot detect."
1194 #: ../src/guestfs.pod:570
1196 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1197 "for more details. The L</guestfs_inspect_os> function just ignores any "
1198 "encrypted devices."
1202 #: ../src/guestfs.pod:574
1204 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1205 "inspection and caches the results in the guest handle. Subsequent calls to "
1206 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1207 "read the disks. If you change the content of the guest disks, you can redo "
1208 "inspection by calling L</guestfs_inspect_os> again. (L</"
1209 "guestfs_inspect_list_applications> works a little differently from the other "
1210 "calls and does read the disks. See documentation for that function for "
1215 #: ../src/guestfs.pod:583
1216 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1220 #: ../src/guestfs.pod:585
1222 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1223 "ntfs-3g.org/> driver."
1227 #: ../src/guestfs.pod:588
1229 "DOS and Windows still use drive letters, and the filesystems are always "
1230 "treated as case insensitive by Windows itself, and therefore you might find "
1231 "a Windows configuration file referring to a path like C<c:\\windows"
1232 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1233 "might be referred to as C</WINDOWS/System32>."
1237 #: ../src/guestfs.pod:594
1239 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1240 "libguestfs to read the appropriate Windows Registry and configuration files, "
1241 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1246 #: ../src/guestfs.pod:599
1248 "Replacing backslash characters with forward slash characters is also outside "
1249 "the scope of libguestfs, but something that you can easily do."
1253 #: ../src/guestfs.pod:602
1255 "Where we can help is in resolving the case insensitivity of paths. For "
1256 "this, call L</guestfs_case_sensitive_path>."
1260 #: ../src/guestfs.pod:605
1262 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1263 "files, through the library C<hivex> which is part of the libguestfs project "
1264 "although ships as a separate tarball. You have to locate and download the "
1265 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1266 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1267 "reg(1)> for more help on this issue."
1271 #: ../src/guestfs.pod:613
1272 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1276 #: ../src/guestfs.pod:615
1278 "Although we don't want to discourage you from using the C API, we will "
1279 "mention here that the same API is also available in other languages."
1283 #: ../src/guestfs.pod:618
1285 "The API is broadly identical in all supported languages. This means that "
1286 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1287 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1288 "words, a straightforward, predictable isomorphism between each language."
1292 #: ../src/guestfs.pod:624
1294 "Error messages are automatically transformed into exceptions if the language "
1299 #: ../src/guestfs.pod:627
1301 "We don't try to \"object orientify\" parts of the API in OO languages, "
1302 "although contributors are welcome to write higher level APIs above what we "
1303 "provide in their favourite languages if they wish."
1307 #: ../src/guestfs.pod:633
1312 #: ../src/guestfs.pod:635
1314 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1315 "identical to the C API. C++ classes and exceptions are not used."
1319 #: ../src/guestfs.pod:639
1324 #: ../src/guestfs.pod:641
1326 "The C# bindings are highly experimental. Please read the warnings at the "
1327 "top of C<csharp/Libguestfs.cs>."
1331 #: ../src/guestfs.pod:644
1336 #: ../src/guestfs.pod:646
1338 "This is the only language binding that is working but incomplete. Only "
1339 "calls which return simple integers have been bound in Haskell, and we are "
1340 "looking for help to complete this binding."
1344 #: ../src/guestfs.pod:650
1349 #: ../src/guestfs.pod:652
1351 "Full documentation is contained in the Javadoc which is distributed with "
1356 #: ../src/guestfs.pod:655
1361 #: ../src/guestfs.pod:657
1362 msgid "For documentation see the file C<guestfs.mli>."
1366 #: ../src/guestfs.pod:659
1371 #: ../src/guestfs.pod:661
1372 msgid "For documentation see L<Sys::Guestfs(3)>."
1376 #: ../src/guestfs.pod:663
1381 #: ../src/guestfs.pod:665
1383 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1384 "the php-libguestfs package for your distribution."
1388 #: ../src/guestfs.pod:668
1389 msgid "The PHP binding only works correctly on 64 bit machines."
1393 #: ../src/guestfs.pod:670
1398 #: ../src/guestfs.pod:672
1399 msgid "For documentation do:"
1403 #: ../src/guestfs.pod:674
1407 " >>> import guestfs\n"
1408 " >>> help (guestfs)\n"
1413 #: ../src/guestfs.pod:678
1418 #: ../src/guestfs.pod:680
1420 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1421 "can find examples written in Ruby in the libguestfs source."
1425 #: ../src/guestfs.pod:683
1426 msgid "B<shell scripts>"
1430 #: ../src/guestfs.pod:685
1431 msgid "For documentation see L<guestfish(1)>."
1435 #: ../src/guestfs.pod:689
1436 msgid "LIBGUESTFS GOTCHAS"
1440 #: ../src/guestfs.pod:691
1442 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1443 "system [...] that works in the way it is documented but is counterintuitive "
1444 "and almost invites mistakes.\""
1448 #: ../src/guestfs.pod:695
1450 "Since we developed libguestfs and the associated tools, there are several "
1451 "things we would have designed differently, but are now stuck with for "
1452 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1453 "release, you can expect these to change. Beware of them."
1457 #: ../src/guestfs.pod:703
1458 msgid "Autosync / forgetting to sync."
1462 #: ../src/guestfs.pod:705
1464 "When modifying a filesystem from C or another language, you B<must> unmount "
1465 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1466 "libguestfs handle. You can also call:"
1470 #: ../src/guestfs.pod:709
1473 " guestfs_set_autosync (g, 1);\n"
1478 #: ../src/guestfs.pod:711
1480 "to have the unmount/sync done automatically for you when the handle 'g' is "
1481 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1485 #: ../src/guestfs.pod:715
1487 "If you forget to do this, then it is entirely possible that your changes "
1488 "won't be written out, or will be partially written, or (very rarely) that "
1489 "you'll get disk corruption."
1493 #: ../src/guestfs.pod:719
1495 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1496 "guestfish scripts that forget to sync will work just fine, which can make "
1497 "this very puzzling if you are trying to debug a problem."
1501 #: ../src/guestfs.pod:723
1503 "Update: Autosync is enabled by default for all API users starting from "
1504 "libguestfs 1.5.24."
1508 #: ../src/guestfs.pod:726
1509 msgid "Mount option C<-o sync> should not be the default."
1513 #: ../src/guestfs.pod:728
1515 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1516 "However C<-o sync> does not add any reliability benefit, but does have a "
1517 "very large performance impact."
1521 #: ../src/guestfs.pod:732
1523 "The work around is to use L</guestfs_mount_options> and set the mount "
1524 "options that you actually want to use."
1528 #: ../src/guestfs.pod:735
1529 msgid "Read-only should be the default."
1533 #: ../src/guestfs.pod:737
1535 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1536 "specify I<--rw> if you want to make changes to the image."
1540 #: ../src/guestfs.pod:740
1541 msgid "This would reduce the potential to corrupt live VM images."
1545 #: ../src/guestfs.pod:742
1547 "Note that many filesystems change the disk when you just mount and unmount, "
1548 "even if you didn't perform any writes. You need to use L</"
1549 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1553 #: ../src/guestfs.pod:746
1554 msgid "guestfish command line is hard to use."
1558 #: ../src/guestfs.pod:748
1560 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1561 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1562 "exist, so it fails. In earlier versions of guestfish the error message was "
1563 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1564 "we should have used C<guestfish -c command> to run commands."
1568 #: ../src/guestfs.pod:755
1569 msgid "guestfish megabyte modifiers don't work right on all commands"
1573 #: ../src/guestfs.pod:757
1575 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1576 "other modifiers). What guestfish actually does is to multiply the number "
1577 "part by the modifier part and pass the result to the C API. However this "
1578 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1579 "expecting some other unit (eg. megabytes)."
1583 #: ../src/guestfs.pod:764
1584 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1588 #: ../src/guestfs.pod:766
1591 " lvcreate LV VG 100M\n"
1596 #: ../src/guestfs.pod:768
1598 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1599 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1600 "megabytes * megabytes) logical volume. The error message you get from this "
1601 "is also a little obscure."
1605 #: ../src/guestfs.pod:773
1607 "This could be fixed in the generator by specially marking parameters and "
1608 "return values which take bytes or other units."
1612 #: ../src/guestfs.pod:776
1613 msgid "Ambiguity between devices and paths"
1617 #: ../src/guestfs.pod:778
1619 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1620 "sdb2>) and a similar pathname. A file might just happen to be called "
1621 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1625 #: ../src/guestfs.pod:783
1627 "In the current API we usually resolve this ambiguity by having two separate "
1628 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1629 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1630 "detecting if the path supplied begins with C</dev/>."
1634 #: ../src/guestfs.pod:789
1636 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1637 "make paths/devices into structured names. One way to do this would be to "
1638 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1639 "aspect of grub. Another way would be to use a structured type, equivalent "
1640 "to this OCaml type:"
1644 #: ../src/guestfs.pod:795
1647 " type path = Path of string | Device of int | Partition of int * int\n"
1652 #: ../src/guestfs.pod:797
1653 msgid "which would allow you to pass arguments like:"
1657 #: ../src/guestfs.pod:799
1660 " Path \"/foo/bar\"\n"
1661 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1662 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1663 " Path \"/dev/sdb2\" (* not a device *)\n"
1668 #: ../src/guestfs.pod:804
1670 "As you can see there are still problems to resolve even with this "
1671 "representation. Also consider how it might work in guestfish."
1675 #: ../src/guestfs.pod:809
1676 msgid "PROTOCOL LIMITS"
1680 #: ../src/guestfs.pod:811
1682 "Internally libguestfs uses a message-based protocol to pass API calls and "
1683 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1684 "plenty more detail about this). The maximum message size used by the "
1685 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1686 "aware of this limit. The API calls which may be affected are individually "
1687 "documented, with a link back to this section of the documentation."
1691 #: ../src/guestfs.pod:819
1693 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1694 "a simple string. Because this string is at some point internally encoded as "
1695 "a message, the maximum size that it can return is slightly under 4 MB. If "
1696 "the requested file is larger than this then you will get an error."
1700 #: ../src/guestfs.pod:825
1702 "In order to transfer large files into and out of the guest filesystem, you "
1703 "need to use particular calls that support this. The sections L</UPLOADING> "
1704 "and L</DOWNLOADING> document how to do this."
1708 #: ../src/guestfs.pod:829
1710 "You might also consider mounting the disk image using our FUSE filesystem "
1711 "support (L<guestmount(1)>)."
1715 #: ../src/guestfs.pod:832
1716 msgid "KEYS AND PASSPHRASES"
1720 #: ../src/guestfs.pod:834
1722 "Certain libguestfs calls take a parameter that contains sensitive key "
1723 "material, passed in as a C string."
1727 #: ../src/guestfs.pod:837
1729 "In the future we would hope to change the libguestfs implementation so that "
1730 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1731 "swap. However this is I<not> done at the moment, because of the complexity "
1732 "of such an implementation."
1736 #: ../src/guestfs.pod:842
1738 "Therefore you should be aware that any key parameter you pass to libguestfs "
1739 "might end up being written out to the swap partition. If this is a concern, "
1740 "scrub the swap partition or don't use libguestfs on encrypted devices."
1744 #: ../src/guestfs.pod:847
1745 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1749 #: ../src/guestfs.pod:849
1751 "All high-level libguestfs actions are synchronous. If you want to use "
1752 "libguestfs asynchronously then you must create a thread."
1756 #: ../src/guestfs.pod:852
1758 "Only use the handle from a single thread. Either use the handle exclusively "
1759 "from one thread, or provide your own mutex so that two threads cannot issue "
1760 "calls on the same handle at the same time."
1764 #: ../src/guestfs.pod:856
1766 "See the graphical program guestfs-browser for one possible architecture for "
1767 "multithreaded programs using libvirt and libguestfs."
1771 #: ../src/guestfs.pod:859
1776 #: ../src/guestfs.pod:861
1778 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1783 #: ../src/guestfs.pod:864
1785 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1786 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1790 #: ../src/guestfs.pod:867
1792 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1793 "to change the directories that libguestfs will search in. The value is a "
1794 "colon-separated list of paths. The current directory is I<not> searched "
1795 "unless the path contains an empty element or C<.>. For example "
1796 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1797 "then C</usr/lib/guestfs>."
1801 #: ../src/guestfs.pod:874
1802 msgid "QEMU WRAPPERS"
1806 #: ../src/guestfs.pod:876
1808 "If you want to compile your own qemu, run qemu from a non-standard location, "
1809 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1814 #: ../src/guestfs.pod:880
1816 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1817 "last command in the shell script (so that qemu replaces the shell and "
1818 "becomes the direct child of the libguestfs-using program). If you don't do "
1819 "this, then the qemu process won't be cleaned up correctly."
1823 #: ../src/guestfs.pod:885
1825 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1830 #: ../src/guestfs.pod:888
1834 " qemudir=/home/rjones/d/qemu\n"
1835 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1840 #: ../src/guestfs.pod:892
1842 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1843 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1848 #: ../src/guestfs.pod:896
1851 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1856 #: ../src/guestfs.pod:898
1858 "Note that libguestfs also calls qemu with the -help and -version options in "
1859 "order to determine features."
1863 #: ../src/guestfs.pod:901
1864 msgid "ABI GUARANTEE"
1868 #: ../src/guestfs.pod:903
1870 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1871 "actions as outlined in this section. Although we will deprecate some "
1872 "actions, for example if they get replaced by newer calls, we will keep the "
1873 "old actions forever. This allows you the developer to program in confidence "
1874 "against the libguestfs API."
1878 #: ../src/guestfs.pod:909
1879 msgid "BLOCK DEVICE NAMING"
1883 #: ../src/guestfs.pod:911
1885 "In the kernel there is now quite a profusion of schemata for naming block "
1886 "devices (in this context, by I<block device> I mean a physical or virtual "
1887 "hard drive). The original Linux IDE driver used names starting with C</dev/"
1888 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
1889 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
1890 "for the old IDE driver (particularly for SATA devices) those devices also "
1891 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
1892 "paravirtualized drivers. This has created several different naming systems, "
1893 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
1897 #: ../src/guestfs.pod:923
1899 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1900 "Linux kernel to access block devices. We can run a variety of appliances "
1901 "based on a variety of Linux kernels."
1905 #: ../src/guestfs.pod:927
1907 "This causes a problem for libguestfs because many API calls use device or "
1908 "partition names. Working scripts and the recipe (example) scripts that we "
1909 "make available over the internet could fail if the naming scheme changes."
1913 #: ../src/guestfs.pod:932
1915 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1916 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1917 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1918 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1922 #: ../src/guestfs.pod:938
1924 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1925 "L</guestfs_list_partitions> and similar calls return the true names of the "
1926 "devices and partitions as known to the appliance."
1930 #: ../src/guestfs.pod:943
1931 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1935 #: ../src/guestfs.pod:945
1937 "Usually this translation is transparent. However in some (very rare) cases "
1938 "you may need to know the exact algorithm. Such cases include where you use "
1939 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
1940 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
1944 #: ../src/guestfs.pod:951
1946 "The algorithm is applied only to I<parameters> which are known to be either "
1947 "device or partition names. Return values from functions such as L</"
1948 "guestfs_list_devices> are never changed."
1952 #: ../src/guestfs.pod:959
1953 msgid "Is the string a parameter which is a device or partition name?"
1957 #: ../src/guestfs.pod:963
1958 msgid "Does the string begin with C</dev/sd>?"
1962 #: ../src/guestfs.pod:967
1964 "Does the named device exist? If so, we use that device. However if I<not> "
1965 "then we continue with this algorithm."
1969 #: ../src/guestfs.pod:972
1970 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1974 #: ../src/guestfs.pod:974
1975 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1979 #: ../src/guestfs.pod:976
1980 msgid "If that named device exists, use it. If not, continue."
1984 #: ../src/guestfs.pod:980
1985 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1989 #: ../src/guestfs.pod:982
1990 msgid "If that named device exists, use it. If not, return an error."
1994 #: ../src/guestfs.pod:986
1995 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1999 #: ../src/guestfs.pod:988
2001 "Although the standard naming scheme and automatic translation is useful for "
2002 "simple programs and guestfish scripts, for larger programs it is best not to "
2003 "rely on this mechanism."
2007 #: ../src/guestfs.pod:992
2009 "Where possible for maximum future portability programs using libguestfs "
2010 "should use these future-proof techniques:"
2014 #: ../src/guestfs.pod:999
2016 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2017 "device names, and then use those names directly."
2021 #: ../src/guestfs.pod:1002
2023 "Since those device names exist by definition, they will never be translated."
2027 #: ../src/guestfs.pod:1007
2029 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2030 "filesystem labels."
2034 #: ../src/guestfs.pod:1012
2039 #: ../src/guestfs.pod:1014
2041 "This section discusses security implications of using libguestfs, "
2042 "particularly with untrusted or malicious guests or disk images."
2046 #: ../src/guestfs.pod:1017
2047 msgid "GENERAL SECURITY CONSIDERATIONS"
2051 #: ../src/guestfs.pod:1019
2053 "Be careful with any files or data that you download from a guest (by "
2054 "\"download\" we mean not just the L</guestfs_download> command but any "
2055 "command that reads files, filenames, directories or anything else from a "
2056 "disk image). An attacker could manipulate the data to fool your program "
2057 "into doing the wrong thing. Consider cases such as:"
2061 #: ../src/guestfs.pod:1029
2062 msgid "the data (file etc) not being present"
2066 #: ../src/guestfs.pod:1033
2067 msgid "being present but empty"
2071 #: ../src/guestfs.pod:1037
2072 msgid "being much larger than normal"
2076 #: ../src/guestfs.pod:1041
2077 msgid "containing arbitrary 8 bit data"
2081 #: ../src/guestfs.pod:1045
2082 msgid "being in an unexpected character encoding"
2086 #: ../src/guestfs.pod:1049
2087 msgid "containing homoglyphs."
2091 #: ../src/guestfs.pod:1053
2092 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2096 #: ../src/guestfs.pod:1055
2098 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2099 "(VFS) module can sometimes be escalated into exploits by deliberately "
2100 "creating a malicious, malformed filesystem. These exploits are very severe "
2101 "for two reasons. Firstly there are very many filesystem drivers in the "
2102 "kernel, and many of them are infrequently used and not much developer "
2103 "attention has been paid to the code. Linux userspace helps potential "
2104 "crackers by detecting the filesystem type and automatically choosing the "
2105 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2106 "the administrator. Secondly, a kernel-level exploit is like a local root "
2107 "exploit (worse in some ways), giving immediate and total access to the "
2108 "system right down to the hardware level."
2112 #: ../src/guestfs.pod:1068
2114 "That explains why you should never mount a filesystem from an untrusted "
2115 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2116 "inside a qemu virtual machine, usually running as a non-root user. The "
2117 "attacker would need to write a filesystem which first exploited the kernel, "
2118 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2119 "the libguestfs protocol, and finally to be as serious as the host kernel "
2120 "exploit it would need to escalate its privileges to root. This multi-step "
2121 "escalation, performed by a static piece of data, is thought to be extremely "
2122 "hard to do, although we never say 'never' about security issues."
2126 #: ../src/guestfs.pod:1079
2128 "In any case callers can reduce the attack surface by forcing the filesystem "
2129 "type when mounting (use L</guestfs_mount_vfs>)."
2133 #: ../src/guestfs.pod:1082
2134 msgid "PROTOCOL SECURITY"
2138 #: ../src/guestfs.pod:1084
2140 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2141 "defined upper message size. However a program that uses libguestfs must "
2142 "also take care - for example you can write a program that downloads a binary "
2143 "from a disk image and executes it locally, and no amount of protocol "
2144 "security will save you from the consequences."
2148 #: ../src/guestfs.pod:1090
2149 msgid "INSPECTION SECURITY"
2153 #: ../src/guestfs.pod:1092
2155 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2156 "directly from the guest, and these could contain any 8 bit data. Callers "
2157 "should be careful to escape these before printing them to a structured file "
2158 "(for example, use HTML escaping if creating a web page)."
2162 #: ../src/guestfs.pod:1098
2164 "Guest configuration may be altered in unusual ways by the administrator of "
2165 "the virtual machine, and may not reflect reality (particularly for untrusted "
2166 "or actively malicious guests). For example we parse the hostname from "
2167 "configuration files like C</etc/sysconfig/network> that we find in the "
2168 "guest, but the guest administrator can easily manipulate these files to "
2169 "provide the wrong hostname."
2173 #: ../src/guestfs.pod:1106
2175 "The inspection API parses guest configuration using two external libraries: "
2176 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2177 "designed to be robust in the face of malicious data, although denial of "
2178 "service attacks are still possible, for example with oversized configuration "
2183 #: ../src/guestfs.pod:1112
2184 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2188 #: ../src/guestfs.pod:1114
2190 "Be very cautious about running commands from the guest. By running a "
2191 "command in the guest, you are giving CPU time to a binary that you do not "
2192 "control, under the same user account as the library, albeit wrapped in qemu "
2193 "virtualization. More information and alternatives can be found in the "
2194 "section L</RUNNING COMMANDS>."
2198 #: ../src/guestfs.pod:1120
2199 msgid "CVE-2010-3851"
2203 #: ../src/guestfs.pod:1122
2204 msgid "https://bugzilla.redhat.com/642934"
2208 #: ../src/guestfs.pod:1124
2210 "This security bug concerns the automatic disk format detection that qemu "
2211 "does on disk images."
2215 #: ../src/guestfs.pod:1127
2217 "A raw disk image is just the raw bytes, there is no header. Other disk "
2218 "images like qcow2 contain a special header. Qemu deals with this by looking "
2219 "for one of the known headers, and if none is found then assuming the disk "
2220 "image must be raw."
2224 #: ../src/guestfs.pod:1132
2226 "This allows a guest which has been given a raw disk image to write some "
2227 "other header. At next boot (or when the disk image is accessed by "
2228 "libguestfs) qemu would do autodetection and think the disk image format was, "
2229 "say, qcow2 based on the header written by the guest."
2233 #: ../src/guestfs.pod:1137
2235 "This in itself would not be a problem, but qcow2 offers many features, one "
2236 "of which is to allow a disk image to refer to another image (called the "
2237 "\"backing disk\"). It does this by placing the path to the backing disk "
2238 "into the qcow2 header. This path is not validated and could point to any "
2239 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2240 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2241 "control of the attacker."
2245 #: ../src/guestfs.pod:1145
2247 "In libguestfs this is rather hard to exploit except under two circumstances:"
2251 #: ../src/guestfs.pod:1152
2252 msgid "You have enabled the network or have opened the disk in write mode."
2256 #: ../src/guestfs.pod:1156
2258 "You are also running untrusted code from the guest (see L</RUNNING "
2263 #: ../src/guestfs.pod:1161
2265 "The way to avoid this is to specify the expected disk format when adding "
2266 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2267 "should always do this if the disk is raw format, and it's a good idea for "
2272 #: ../src/guestfs.pod:1166
2274 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2275 "format is fetched from libvirt and passed through."
2279 #: ../src/guestfs.pod:1169
2281 "For libguestfs tools, use the I<--format> command line parameter as "
2286 #: ../src/guestfs.pod:1172
2287 msgid "CONNECTION MANAGEMENT"
2291 #: ../src/guestfs.pod:1174
2296 #: ../src/guestfs.pod:1176
2298 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2299 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2300 "handle and release all resources used."
2304 #: ../src/guestfs.pod:1180
2306 "For information on using multiple handles and threads, see the section L</"
2307 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2311 #: ../src/guestfs.pod:1183
2312 msgid "guestfs_create"
2316 #: ../src/guestfs.pod:1185
2319 " guestfs_h *guestfs_create (void);\n"
2324 #: ../src/guestfs.pod:1187
2325 msgid "Create a connection handle."
2329 #: ../src/guestfs.pod:1189
2331 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2332 "on the handle at least once."
2336 #: ../src/guestfs.pod:1192
2338 "This function returns a non-NULL pointer to a handle on success or NULL on "
2343 #: ../src/guestfs.pod:1195
2344 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2348 #: ../src/guestfs.pod:1197
2350 "You may also want to configure error handling for the handle. See L</ERROR "
2351 "HANDLING> section below."
2355 #: ../src/guestfs.pod:1200
2356 msgid "guestfs_close"
2360 #: ../src/guestfs.pod:1202
2363 " void guestfs_close (guestfs_h *g);\n"
2368 #: ../src/guestfs.pod:1204
2369 msgid "This closes the connection handle and frees up all resources used."
2373 #: ../src/guestfs.pod:1206
2374 msgid "ERROR HANDLING"
2378 #: ../src/guestfs.pod:1208
2380 "API functions can return errors. For example, almost all functions that "
2381 "return C<int> will return C<-1> to indicate an error."
2385 #: ../src/guestfs.pod:1211
2387 "Additional information is available for errors: an error message string and "
2388 "optionally an error number (errno) if the thing that failed was a system "
2393 #: ../src/guestfs.pod:1215
2395 "You can get at the additional information about the last error on the handle "
2396 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2397 "up an error handler with L</guestfs_set_error_handler>."
2401 #: ../src/guestfs.pod:1220
2403 "When the handle is created, a default error handler is installed which "
2404 "prints the error message string to C<stderr>. For small short-running "
2405 "command line programs it is sufficient to do:"
2409 #: ../src/guestfs.pod:1224
2412 " if (guestfs_launch (g) == -1)\n"
2413 " exit (EXIT_FAILURE);\n"
2418 #: ../src/guestfs.pod:1227
2420 "since the default error handler will ensure that an error message has been "
2421 "printed to C<stderr> before the program exits."
2425 #: ../src/guestfs.pod:1230
2427 "For other programs the caller will almost certainly want to install an "
2428 "alternate error handler or do error handling in-line like this:"
2432 #: ../src/guestfs.pod:1233
2435 " g = guestfs_create ();\n"
2440 #: ../src/guestfs.pod:1235
2443 " /* This disables the default behaviour of printing errors\n"
2445 " guestfs_set_error_handler (g, NULL, NULL);\n"
2450 #: ../src/guestfs.pod:1239
2453 " if (guestfs_launch (g) == -1) {\n"
2454 " /* Examine the error message and print it etc. */\n"
2455 " char *msg = guestfs_last_error (g);\n"
2456 " int errnum = guestfs_last_errno (g);\n"
2457 " fprintf (stderr, \"%s\\n\", msg);\n"
2464 #: ../src/guestfs.pod:1247
2466 "Out of memory errors are handled differently. The default action is to call "
2467 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2468 "guestfs_set_out_of_memory_handler>."
2472 #: ../src/guestfs.pod:1251
2474 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2475 "because there is no handle if this happens there is no way to get additional "
2476 "error information. However L</guestfs_create> is supposed to be a "
2477 "lightweight operation which can only fail because of insufficient memory (it "
2478 "returns NULL in this case)."
2482 #: ../src/guestfs.pod:1257
2483 msgid "guestfs_last_error"
2487 #: ../src/guestfs.pod:1259
2490 " const char *guestfs_last_error (guestfs_h *g);\n"
2495 #: ../src/guestfs.pod:1261
2497 "This returns the last error message that happened on C<g>. If there has not "
2498 "been an error since the handle was created, then this returns C<NULL>."
2502 #: ../src/guestfs.pod:1265
2504 "The lifetime of the returned string is until the next error occurs, or L</"
2505 "guestfs_close> is called."
2509 #: ../src/guestfs.pod:1268
2510 msgid "guestfs_last_errno"
2514 #: ../src/guestfs.pod:1270
2517 " int guestfs_last_errno (guestfs_h *g);\n"
2522 #: ../src/guestfs.pod:1272
2523 msgid "This returns the last error number (errno) that happened on C<g>."
2527 #: ../src/guestfs.pod:1274
2528 msgid "If successful, an errno integer not equal to zero is returned."
2532 #: ../src/guestfs.pod:1276
2534 "If no error, this returns 0. This call can return 0 in three situations:"
2538 #: ../src/guestfs.pod:1283
2539 msgid "There has not been any error on the handle."
2543 #: ../src/guestfs.pod:1287
2545 "There has been an error but the errno was meaningless. This corresponds to "
2546 "the case where the error did not come from a failed system call, but for "
2547 "some other reason."
2551 #: ../src/guestfs.pod:1293
2553 "There was an error from a failed system call, but for some reason the errno "
2554 "was not captured and returned. This usually indicates a bug in libguestfs."
2558 #: ../src/guestfs.pod:1299
2560 "Libguestfs tries to convert the errno from inside the applicance into a "
2561 "corresponding errno for the caller (not entirely trivial: the appliance "
2562 "might be running a completely different operating system from the library "
2563 "and error numbers are not standardized across Un*xen). If this could not be "
2564 "done, then the error is translated to C<EINVAL>. In practice this should "
2565 "only happen in very rare circumstances."
2569 #: ../src/guestfs.pod:1307
2570 msgid "guestfs_set_error_handler"
2574 #: ../src/guestfs.pod:1309
2577 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2579 " const char *msg);\n"
2580 " void guestfs_set_error_handler (guestfs_h *g,\n"
2581 " guestfs_error_handler_cb cb,\n"
2587 #: ../src/guestfs.pod:1316
2589 "The callback C<cb> will be called if there is an error. The parameters "
2590 "passed to the callback are an opaque data pointer and the error message "
2595 #: ../src/guestfs.pod:1320
2597 "C<errno> is not passed to the callback. To get that the callback must call "
2598 "L</guestfs_last_errno>."
2602 #: ../src/guestfs.pod:1323
2604 "Note that the message string C<msg> is freed as soon as the callback "
2605 "function returns, so if you want to stash it somewhere you must make your "
2610 #: ../src/guestfs.pod:1327
2611 msgid "The default handler prints messages on C<stderr>."
2615 #: ../src/guestfs.pod:1329
2616 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2620 #: ../src/guestfs.pod:1331
2621 msgid "guestfs_get_error_handler"
2625 #: ../src/guestfs.pod:1333
2628 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2629 " void **opaque_rtn);\n"
2634 #: ../src/guestfs.pod:1336
2635 msgid "Returns the current error handler callback."
2639 #: ../src/guestfs.pod:1338
2640 msgid "guestfs_set_out_of_memory_handler"
2644 #: ../src/guestfs.pod:1340
2647 " typedef void (*guestfs_abort_cb) (void);\n"
2648 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2649 " guestfs_abort_cb);\n"
2654 #: ../src/guestfs.pod:1344
2656 "The callback C<cb> will be called if there is an out of memory situation. "
2657 "I<Note this callback must not return>."
2661 #: ../src/guestfs.pod:1347
2662 msgid "The default is to call L<abort(3)>."
2666 #: ../src/guestfs.pod:1349
2668 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2672 #: ../src/guestfs.pod:1352
2673 msgid "guestfs_get_out_of_memory_handler"
2677 #: ../src/guestfs.pod:1354
2680 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2685 #: ../src/guestfs.pod:1356
2686 msgid "This returns the current out of memory handler."
2690 #: ../src/guestfs.pod:1358
2695 #: ../src/guestfs.pod:1360 ../fish/guestfish.pod:908
2700 #: ../src/guestfs.pod:1362
2705 #: ../src/guestfs.pod:1364
2710 #: ../src/guestfs.pod:1366
2711 msgid "AVAILABILITY"
2715 #: ../src/guestfs.pod:1368
2716 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2720 #: ../src/guestfs.pod:1370
2722 "Using L</guestfs_available> you can test availability of the following "
2723 "groups of functions. This test queries the appliance to see if the "
2724 "appliance you are currently using supports the functionality."
2728 #: ../src/guestfs.pod:1375
2729 msgid "@AVAILABILITY@"
2733 #: ../src/guestfs.pod:1377
2734 msgid "GUESTFISH supported COMMAND"
2738 #: ../src/guestfs.pod:1379
2740 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2741 "prints out the available groups and whether they are supported by this build "
2742 "of libguestfs. Note however that you have to do C<run> first."
2746 #: ../src/guestfs.pod:1384
2747 msgid "SINGLE CALLS AT COMPILE TIME"
2751 #: ../src/guestfs.pod:1386
2753 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2754 "function, such as:"
2758 #: ../src/guestfs.pod:1389
2761 " #define LIBGUESTFS_HAVE_DD 1\n"
2766 #: ../src/guestfs.pod:1391
2767 msgid "if L</guestfs_dd> is available."
2771 #: ../src/guestfs.pod:1393
2773 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2774 "function is available at compile time, we recommended using build tools such "
2775 "as autoconf or cmake. For example in autotools you could use:"
2779 #: ../src/guestfs.pod:1398
2782 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2783 " AC_CHECK_FUNCS([guestfs_dd])\n"
2788 #: ../src/guestfs.pod:1401
2790 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2795 #: ../src/guestfs.pod:1404
2796 msgid "SINGLE CALLS AT RUN TIME"
2800 #: ../src/guestfs.pod:1406
2802 "Testing at compile time doesn't guarantee that a function really exists in "
2803 "the library. The reason is that you might be dynamically linked against a "
2804 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2805 "This situation unfortunately results in a segmentation fault, which is a "
2806 "shortcoming of the C dynamic linking system itself."
2810 #: ../src/guestfs.pod:1413
2812 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2813 "in this example program (note that you still need the compile time check as "
2818 #: ../src/guestfs.pod:1417
2821 " #include <stdio.h>\n"
2822 " #include <stdlib.h>\n"
2823 " #include <unistd.h>\n"
2824 " #include <dlfcn.h>\n"
2825 " #include <guestfs.h>\n"
2830 #: ../src/guestfs.pod:1423
2835 " #ifdef LIBGUESTFS_HAVE_DD\n"
2837 " int has_function;\n"
2842 #: ../src/guestfs.pod:1429
2845 " /* Test if the function guestfs_dd is really available. */\n"
2846 " dl = dlopen (NULL, RTLD_LAZY);\n"
2848 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2849 " exit (EXIT_FAILURE);\n"
2851 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2857 #: ../src/guestfs.pod:1438
2860 " if (!has_function)\n"
2861 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2863 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2864 " /* Now it's safe to call\n"
2865 " guestfs_dd (g, \"foo\", \"bar\");\n"
2869 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2876 #: ../src/guestfs.pod:1451
2878 "You may think the above is an awful lot of hassle, and it is. There are "
2879 "other ways outside of the C linking system to ensure that this kind of "
2880 "incompatibility never arises, such as using package versioning:"
2884 #: ../src/guestfs.pod:1456
2887 " Requires: libguestfs >= 1.0.80\n"
2892 #: ../src/guestfs.pod:1458
2893 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2897 #: ../src/guestfs.pod:1460
2899 "A recent feature of the API is the introduction of calls which take optional "
2900 "arguments. In C these are declared 3 ways. The main way is as a call which "
2901 "takes variable arguments (ie. C<...>), as in this example:"
2905 #: ../src/guestfs.pod:1465
2908 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2913 #: ../src/guestfs.pod:1467
2915 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2916 "call with no optional arguments specified:"
2920 #: ../src/guestfs.pod:1470
2923 " guestfs_add_drive_opts (g, filename, -1);\n"
2928 #: ../src/guestfs.pod:1472
2929 msgid "With a single optional argument:"
2933 #: ../src/guestfs.pod:1474
2936 " guestfs_add_drive_opts (g, filename,\n"
2937 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2943 #: ../src/guestfs.pod:1478
2948 #: ../src/guestfs.pod:1480
2951 " guestfs_add_drive_opts (g, filename,\n"
2952 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2953 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2959 #: ../src/guestfs.pod:1485
2961 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2966 #: ../src/guestfs.pod:1488
2967 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2971 #: ../src/guestfs.pod:1490
2973 "The second variant has the same name with the suffix C<_va>, which works the "
2974 "same way but takes a C<va_list>. See the C manual for details. For the "
2975 "example function, this is declared:"
2979 #: ../src/guestfs.pod:1494
2982 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2988 #: ../src/guestfs.pod:1497
2989 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2993 #: ../src/guestfs.pod:1499
2995 "The third variant is useful where you need to construct these calls. You "
2996 "pass in a structure where you fill in the optional fields. The structure "
2997 "has a bitmask as the first element which you must set to indicate which "
2998 "fields you have filled in. For our example function the structure and call "
3003 #: ../src/guestfs.pod:1505
3006 " struct guestfs_add_drive_opts_argv {\n"
3007 " uint64_t bitmask;\n"
3009 " const char *format;\n"
3012 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3013 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3018 #: ../src/guestfs.pod:1514
3019 msgid "You could call it like this:"
3023 #: ../src/guestfs.pod:1516
3026 " struct guestfs_add_drive_opts_argv optargs = {\n"
3027 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3028 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3030 " .format = \"qcow2\"\n"
3036 #: ../src/guestfs.pod:1523
3039 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3044 #: ../src/guestfs.pod:1525 ../src/guestfs-actions.pod:11
3045 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
3046 #: ../fish/guestfish-actions.pod:1255
3051 #: ../src/guestfs.pod:1531
3052 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3056 #: ../src/guestfs.pod:1536
3057 msgid "You do not need to fill in all fields of the structure."
3061 #: ../src/guestfs.pod:1540
3063 "There must be a one-to-one correspondence between fields of the structure "
3064 "that are filled in, and bits set in the bitmask."
3068 #: ../src/guestfs.pod:1545
3069 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3073 #: ../src/guestfs.pod:1547
3075 "In other languages, optional arguments are expressed in the way that is "
3076 "natural for that language. We refer you to the language-specific "
3077 "documentation for more details on that."
3081 #: ../src/guestfs.pod:1551
3082 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3086 #: ../src/guestfs.pod:1553
3087 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3091 #: ../src/guestfs.pod:1555
3093 "The child process generates events in some situations. Current events "
3094 "include: receiving a log message, the child process exits."
3098 #: ../src/guestfs.pod:1558
3100 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3105 #: ../src/guestfs.pod:1561
3107 "Only I<one callback of each type> can be registered for each handle. "
3108 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3109 "that type. Cancel all callbacks of this type by calling this function with "
3110 "C<cb> set to C<NULL>."
3114 #: ../src/guestfs.pod:1566
3115 msgid "guestfs_set_log_message_callback"
3119 #: ../src/guestfs.pod:1568
3122 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3123 " char *buf, int len);\n"
3124 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3125 " guestfs_log_message_cb cb,\n"
3131 #: ../src/guestfs.pod:1574
3133 "The callback function C<cb> will be called whenever qemu or the guest writes "
3134 "anything to the console."
3138 #: ../src/guestfs.pod:1577
3139 msgid "Use this function to capture kernel messages and similar."
3143 #: ../src/guestfs.pod:1579
3145 "Normally there is no log message handler, and log messages are just "
3150 #: ../src/guestfs.pod:1582
3151 msgid "guestfs_set_subprocess_quit_callback"
3155 #: ../src/guestfs.pod:1584
3158 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3159 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3160 " guestfs_subprocess_quit_cb cb,\n"
3166 #: ../src/guestfs.pod:1589
3168 "The callback function C<cb> will be called when the child process quits, "
3169 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3170 "corresponds to a transition from any state to the CONFIG state)."
3174 #: ../src/guestfs.pod:1594
3175 msgid "guestfs_set_launch_done_callback"
3179 #: ../src/guestfs.pod:1596
3182 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3183 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3184 " guestfs_launch_done_cb cb,\n"
3190 #: ../src/guestfs.pod:1601
3192 "The callback function C<cb> will be called when the child process becomes "
3193 "ready first time after it has been launched. (This corresponds to a "
3194 "transition from LAUNCHING to the READY state)."
3198 #: ../src/guestfs.pod:1605
3199 msgid "guestfs_set_close_callback"
3203 #: ../src/guestfs.pod:1607
3206 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3207 " void guestfs_set_close_callback (guestfs_h *g,\n"
3208 " guestfs_close_cb cb,\n"
3214 #: ../src/guestfs.pod:1612
3216 "The callback function C<cb> will be called while the handle is being closed "
3217 "(synchronously from L</guestfs_close>)."
3221 #: ../src/guestfs.pod:1615
3223 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3224 "handles that are open when the program exits. This means that this callback "
3225 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3226 "problems in higher-level languages (eg. if your HLL interpreter has already "
3227 "been cleaned up by the time this is called, and if your callback then jumps "
3228 "into some HLL function)."
3232 #: ../src/guestfs.pod:1623
3233 msgid "guestfs_set_progress_callback"
3237 #: ../src/guestfs.pod:1625
3240 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3241 " int proc_nr, int serial,\n"
3242 " uint64_t position, uint64_t total);\n"
3243 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3244 " guestfs_progress_cb cb,\n"
3250 #: ../src/guestfs.pod:1632
3252 "Some long-running operations can generate progress messages. If this "
3253 "callback is registered, then it will be called each time a progress message "
3254 "is generated (usually two seconds after the operation started, and three "
3255 "times per second thereafter until it completes, although the frequency may "
3256 "change in future versions)."
3260 #: ../src/guestfs.pod:1638
3262 "The callback receives two numbers: C<position> and C<total>. The units of "
3263 "C<total> are not defined, although for some operations C<total> may relate "
3264 "in some way to the amount of data to be transferred (eg. in bytes or "
3265 "megabytes), and C<position> may be the portion which has been transferred."
3269 #: ../src/guestfs.pod:1644
3270 msgid "The only defined and stable parts of the API are:"
3274 #: ../src/guestfs.pod:1650
3276 "The callback can display to the user some type of progress bar or indicator "
3277 "which shows the ratio of C<position>:C<total>."
3281 #: ../src/guestfs.pod:1655
3282 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3286 #: ../src/guestfs.pod:1659
3288 "If any progress notification is sent during a call, then a final progress "
3289 "notification is always sent when C<position> = C<total>."
3293 #: ../src/guestfs.pod:1662
3295 "This is to simplify caller code, so callers can easily set the progress "
3296 "indicator to \"100%\" at the end of the operation, without requiring special "
3297 "code to detect this case."
3301 #: ../src/guestfs.pod:1668
3303 "The callback also receives the procedure number and serial number of the "
3304 "call. These are only useful for debugging protocol issues, and the callback "
3305 "can normally ignore them. The callback may want to print these numbers in "
3306 "error messages or debugging messages."
3310 #: ../src/guestfs.pod:1673
3311 msgid "PRIVATE DATA AREA"
3315 #: ../src/guestfs.pod:1675
3317 "You can attach named pieces of private data to the libguestfs handle, and "
3318 "fetch them by name for the lifetime of the handle. This is called the "
3319 "private data area and is only available from the C API."
3323 #: ../src/guestfs.pod:1679
3324 msgid "To attach a named piece of data, use the following call:"
3328 #: ../src/guestfs.pod:1681
3331 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3336 #: ../src/guestfs.pod:1683
3338 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3339 "pointer (which can be C<NULL>). Any previous item with the same name is "
3344 #: ../src/guestfs.pod:1687
3346 "You can use any C<key> you want, but names beginning with an underscore "
3347 "character are reserved for internal libguestfs purposes (for implementing "
3348 "language bindings). It is recommended to prefix the name with some unique "
3349 "string to avoid collisions with other users."
3353 #: ../src/guestfs.pod:1692
3354 msgid "To retrieve the pointer, use:"
3358 #: ../src/guestfs.pod:1694
3361 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3366 #: ../src/guestfs.pod:1696
3368 "This function returns C<NULL> if either no data is found associated with "
3369 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3374 #: ../src/guestfs.pod:1700
3376 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3377 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3378 "all. In particular, libguestfs does I<not> try to free the data when the "
3379 "handle is closed. If the data must be freed, then the caller must either "
3380 "free it before calling L</guestfs_close> or must set up a close callback to "
3381 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3382 "can be registered for a handle)."
3386 #: ../src/guestfs.pod:1708
3388 "The private data area is implemented using a hash table, and should be "
3389 "reasonably efficient for moderate numbers of keys."
3393 #: ../src/guestfs.pod:1711 ../src/guestfs.pod:1716
3398 #: ../src/guestfs.pod:1713
3400 "<!-- old anchor for the next section --> <a name="
3401 "\"state_machine_and_low_level_event_api\"/>"
3405 #: ../src/guestfs.pod:1718
3406 msgid "ARCHITECTURE"
3410 #: ../src/guestfs.pod:1720
3412 "Internally, libguestfs is implemented by running an appliance (a special "
3413 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3414 "process of the main program."
3418 #: ../src/guestfs.pod:1724
3421 " ___________________\n"
3423 " | main program |\n"
3425 " | | child process / appliance\n"
3426 " | | __________________________\n"
3428 " +-------------------+ RPC | +-----------------+ |\n"
3429 " | libguestfs <--------------------> guestfsd | |\n"
3430 " | | | +-----------------+ |\n"
3431 " \\___________________/ | | Linux kernel | |\n"
3432 " | +--^--------------+ |\n"
3433 " \\_________|________________/\n"
3439 " \\______________/\n"
3444 #: ../src/guestfs.pod:1744
3446 "The library, linked to the main program, creates the child process and hence "
3447 "the appliance in the L</guestfs_launch> function."
3451 #: ../src/guestfs.pod:1747
3453 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3454 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3455 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3456 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3457 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3458 "attached to the qemu process which translates device access by the "
3459 "appliance's Linux kernel into accesses to the image."
3463 #: ../src/guestfs.pod:1756
3465 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3466 "Although the disk image you are attached to might also be used by some "
3467 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3468 "care if both libguestfs's qemu process and your virtual machine are trying "
3469 "to update the disk image at the same time, since these usually results in "
3470 "massive disk corruption)."
3474 #: ../src/guestfs.pod:1763
3475 msgid "STATE MACHINE"
3479 #: ../src/guestfs.pod:1765
3480 msgid "libguestfs uses a state machine to model the child process:"
3484 #: ../src/guestfs.pod:1767
3496 " / | \\ \\ guestfs_launch\n"
3497 " / | _\\__V______\n"
3499 " / | | LAUNCHING |\n"
3500 " / | \\___________/\n"
3502 " / | guestfs_launch\n"
3504 " ______ / __|____V\n"
3505 " / \\ ------> / \\\n"
3506 " | BUSY | | READY |\n"
3507 " \\______/ <------ \\________/\n"
3512 #: ../src/guestfs.pod:1789
3514 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3515 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3516 "(3) alternating between READY and BUSY as commands are issued to, and "
3517 "carried out by, the child process."
3521 #: ../src/guestfs.pod:1794
3523 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3524 "asynchronously at any time (eg. due to some internal error), and that causes "
3525 "the state to transition back to CONFIG."
3529 #: ../src/guestfs.pod:1798
3531 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3532 "issued when in the CONFIG state."
3536 #: ../src/guestfs.pod:1801
3538 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3539 "L</guestfs_launch> blocks until the child process is READY to accept "
3540 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3541 "moves the state from CONFIG to LAUNCHING while it is running."
3545 #: ../src/guestfs.pod:1807
3547 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3548 "state. These API calls block waiting for the command to be carried out (ie. "
3549 "the state to transition to BUSY and then back to READY). There are no non-"
3550 "blocking versions, and no way to issue more than one command per handle at "
3555 #: ../src/guestfs.pod:1813
3557 "Finally, the child process sends asynchronous messages back to the main "
3558 "program, such as kernel log messages. You can register a callback to "
3559 "receive these messages."
3563 #: ../src/guestfs.pod:1817
3568 #: ../src/guestfs.pod:1819
3569 msgid "COMMUNICATION PROTOCOL"
3573 #: ../src/guestfs.pod:1821
3575 "Don't rely on using this protocol directly. This section documents how it "
3576 "currently works, but it may change at any time."
3580 #: ../src/guestfs.pod:1824
3582 "The protocol used to talk between the library and the daemon running inside "
3583 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3584 "1014, RFC 1832, RFC 4506)."
3588 #: ../src/guestfs.pod:1828
3590 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3591 "this file is automatically generated)."
3595 #: ../src/guestfs.pod:1831
3597 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3598 "and C<FileOut> parameters, which are handled with very simple request/reply "
3599 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3600 "parameters, which use the same request and reply messages, but they may also "
3601 "be followed by files sent using a chunked encoding."
3605 #: ../src/guestfs.pod:1838
3606 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3610 #: ../src/guestfs.pod:1840
3611 msgid "For ordinary functions, the request message is:"
3615 #: ../src/guestfs.pod:1842
3618 " total length (header + arguments,\n"
3619 " but not including the length word itself)\n"
3620 " struct guestfs_message_header (encoded as XDR)\n"
3621 " struct guestfs_<foo>_args (encoded as XDR)\n"
3626 #: ../src/guestfs.pod:1847
3628 "The total length field allows the daemon to allocate a fixed size buffer "
3629 "into which it slurps the rest of the message. As a result, the total length "
3630 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3631 "effective size of any request is limited to somewhere under this size."
3635 #: ../src/guestfs.pod:1853
3637 "Note also that many functions don't take any arguments, in which case the "
3638 "C<guestfs_I<foo>_args> is completely omitted."
3642 #: ../src/guestfs.pod:1856
3644 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3645 "receiver knows what type of args structure to expect, or none at all."
3649 #: ../src/guestfs.pod:1860
3650 msgid "The reply message for ordinary functions is:"
3654 #: ../src/guestfs.pod:1862
3657 " total length (header + ret,\n"
3658 " but not including the length word itself)\n"
3659 " struct guestfs_message_header (encoded as XDR)\n"
3660 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3665 #: ../src/guestfs.pod:1867
3667 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3668 "functions that return no formal return values."
3672 #: ../src/guestfs.pod:1870
3674 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3678 #: ../src/guestfs.pod:1873
3680 "In the case of an error, a flag is set in the header, and the reply message "
3681 "is slightly changed:"
3685 #: ../src/guestfs.pod:1876
3688 " total length (header + error,\n"
3689 " but not including the length word itself)\n"
3690 " struct guestfs_message_header (encoded as XDR)\n"
3691 " struct guestfs_message_error (encoded as XDR)\n"
3696 #: ../src/guestfs.pod:1881
3698 "The C<guestfs_message_error> structure contains the error message as a "
3703 #: ../src/guestfs.pod:1884
3704 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3708 #: ../src/guestfs.pod:1886
3710 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3711 "The normal request message is sent (see above). However this is followed by "
3712 "a sequence of file chunks."
3716 #: ../src/guestfs.pod:1890
3719 " total length (header + arguments,\n"
3720 " but not including the length word itself,\n"
3721 " and not including the chunks)\n"
3722 " struct guestfs_message_header (encoded as XDR)\n"
3723 " struct guestfs_<foo>_args (encoded as XDR)\n"
3724 " sequence of chunks for FileIn param #0\n"
3725 " sequence of chunks for FileIn param #1 etc.\n"
3730 #: ../src/guestfs.pod:1898
3731 msgid "The \"sequence of chunks\" is:"
3735 #: ../src/guestfs.pod:1900
3738 " length of chunk (not including length word itself)\n"
3739 " struct guestfs_chunk (encoded as XDR)\n"
3740 " length of chunk\n"
3741 " struct guestfs_chunk (encoded as XDR)\n"
3743 " length of chunk\n"
3744 " struct guestfs_chunk (with data.data_len == 0)\n"
3749 #: ../src/guestfs.pod:1908
3751 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3752 "is set in the final chunk to indicate either successful completion or early "
3757 #: ../src/guestfs.pod:1912
3759 "At time of writing there are no functions that have more than one FileIn "
3760 "parameter. However this is (theoretically) supported, by sending the "
3761 "sequence of chunks for each FileIn parameter one after another (from left to "
3766 #: ../src/guestfs.pod:1917
3768 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3769 "transfer. The library does this by sending a chunk with a special flag set "
3770 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3771 "RPC, does I<not> send any reply, and goes back to reading the next request."
3775 #: ../src/guestfs.pod:1923
3777 "The daemon may also cancel. It does this by writing a special word "
3778 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3779 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3780 "cancel chunk). The special word is chosen so that even if cancellation "
3781 "happens right at the end of the transfer (after the library has finished "
3782 "writing and has started listening for the reply), the \"spurious\" cancel "
3783 "flag will not be confused with the reply message."
3787 #: ../src/guestfs.pod:1932
3789 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3790 "limit), and also files where the size is not known in advance (eg. from "
3791 "pipes or sockets). However the chunks are rather small "
3792 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3793 "to keep much in memory."
3797 #: ../src/guestfs.pod:1938
3798 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3802 #: ../src/guestfs.pod:1940
3804 "The protocol for FileOut parameters is exactly the same as for FileIn "
3805 "parameters, but with the roles of daemon and library reversed."
3809 #: ../src/guestfs.pod:1943
3812 " total length (header + ret,\n"
3813 " but not including the length word itself,\n"
3814 " and not including the chunks)\n"
3815 " struct guestfs_message_header (encoded as XDR)\n"
3816 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3817 " sequence of chunks for FileOut param #0\n"
3818 " sequence of chunks for FileOut param #1 etc.\n"
3823 #: ../src/guestfs.pod:1951
3824 msgid "INITIAL MESSAGE"
3828 #: ../src/guestfs.pod:1953
3830 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3831 "which indicates that the guest and daemon is alive. This is what L</"
3832 "guestfs_launch> waits for."
3836 #: ../src/guestfs.pod:1957
3837 msgid "PROGRESS NOTIFICATION MESSAGES"
3841 #: ../src/guestfs.pod:1959
3843 "The daemon may send progress notification messages at any time. These are "
3844 "distinguished by the normal length word being replaced by "
3845 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3849 #: ../src/guestfs.pod:1963
3851 "The library turns them into progress callbacks (see "
3852 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3853 "discards them if not."
3857 #: ../src/guestfs.pod:1967
3859 "The daemon self-limits the frequency of progress messages it sends (see "
3860 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3865 #: ../src/guestfs.pod:1971
3866 msgid "LIBGUESTFS VERSION NUMBERS"
3870 #: ../src/guestfs.pod:1973
3872 "Since April 2010, libguestfs has started to make separate development and "
3873 "stable releases, along with corresponding branches in our git repository. "
3874 "These separate releases can be identified by version number:"
3878 #: ../src/guestfs.pod:1978
3881 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3882 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3888 " | `-------- sub-version\n"
3890 " `------ always '1' because we don't change the ABI\n"
3895 #: ../src/guestfs.pod:1989
3896 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3900 #: ../src/guestfs.pod:1991
3902 "As time passes we cherry pick fixes from the development branch and backport "
3903 "those into the stable branch, the effect being that the stable branch should "
3904 "get more stable and less buggy over time. So the stable releases are ideal "
3905 "for people who don't need new features but would just like the software to "
3910 #: ../src/guestfs.pod:1997
3911 msgid "Our criteria for backporting changes are:"
3915 #: ../src/guestfs.pod:2003
3917 "Documentation changes which don't affect any code are backported unless the "
3918 "documentation refers to a future feature which is not in stable."
3922 #: ../src/guestfs.pod:2009
3924 "Bug fixes which are not controversial, fix obvious problems, and have been "
3925 "well tested are backported."
3929 #: ../src/guestfs.pod:2014
3931 "Simple rearrangements of code which shouldn't affect how it works get "
3932 "backported. This is so that the code in the two branches doesn't get too "
3933 "far out of step, allowing us to backport future fixes more easily."
3937 #: ../src/guestfs.pod:2020
3939 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3940 "exceptional case: the new feature is required in order to implement an "
3941 "important bug fix."
3945 #: ../src/guestfs.pod:2026
3947 "A new stable branch starts when we think the new features in development are "
3948 "substantial and compelling enough over the current stable branch to warrant "
3949 "it. When that happens we create new stable and development versions 1.N.0 "
3950 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3951 "stable at this point, but by backporting fixes from development, that branch "
3952 "will stabilize over time."
3956 #: ../src/guestfs.pod:2034 ../fish/guestfish.pod:915
3957 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3958 #: ../tools/virt-rescue.pl:255
3959 msgid "ENVIRONMENT VARIABLES"
3963 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:941
3964 msgid "LIBGUESTFS_APPEND"
3968 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:943
3969 msgid "Pass additional options to the guest kernel."
3973 #: ../src/guestfs.pod:2042 ../fish/guestfish.pod:945
3974 msgid "LIBGUESTFS_DEBUG"
3978 #: ../src/guestfs.pod:2044
3980 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3981 "effect as calling C<guestfs_set_verbose (g, 1)>."
3985 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:950
3986 msgid "LIBGUESTFS_MEMSIZE"
3990 #: ../src/guestfs.pod:2049 ../fish/guestfish.pod:952
3992 "Set the memory allocated to the qemu process, in megabytes. For example:"
3996 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:955
3999 " LIBGUESTFS_MEMSIZE=700\n"
4004 #: ../src/guestfs.pod:2054 ../fish/guestfish.pod:957
4005 msgid "LIBGUESTFS_PATH"
4009 #: ../src/guestfs.pod:2056
4011 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4012 "the discussion of paths in section PATH above."
4016 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:962
4017 msgid "LIBGUESTFS_QEMU"
4021 #: ../src/guestfs.pod:2061 ../fish/guestfish.pod:964
4023 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4024 "which was found at compile time by the configure script is used."
4028 #: ../src/guestfs.pod:2065
4029 msgid "See also L</QEMU WRAPPERS> above."
4033 #: ../src/guestfs.pod:2067 ../fish/guestfish.pod:968
4034 msgid "LIBGUESTFS_TRACE"
4038 #: ../src/guestfs.pod:2069
4040 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4041 "effect as calling C<guestfs_set_trace (g, 1)>."
4045 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:977
4050 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:979
4051 msgid "Location of temporary directory, defaults to C</tmp>."
4055 #: ../src/guestfs.pod:2076 ../fish/guestfish.pod:981
4057 "If libguestfs was compiled to use the supermin appliance then the real "
4058 "appliance is cached in this directory, shared between all handles belonging "
4059 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4060 "use in case C</tmp> is not large enough."
4064 #: ../src/guestfs.pod:2084 ../fish/guestfish.pod:1039
4065 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
4066 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484
4067 #: ../tools/virt-df.pl:640 ../tools/virt-resize.pl:1485
4068 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281
4069 #: ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534
4070 #: ../tools/virt-list-partitions.pl:257
4075 #: ../src/guestfs.pod:2086
4077 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-edit"
4078 "(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems"
4079 "(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-"
4080 "rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)"
4081 ">, L<hivex(3)>, L<http://libguestfs.org/>."
4085 #: ../src/guestfs.pod:2105
4087 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
4088 "(8)>, L<disktype(1)>."
4092 #: ../src/guestfs.pod:2112 ../tools/virt-win-reg.pl:499
4093 #: ../tools/virt-make-fs.pl:548
4098 #: ../src/guestfs.pod:2114
4099 msgid "To get a list of bugs against libguestfs use this link:"
4103 #: ../src/guestfs.pod:2116
4105 "L<https://bugzilla.redhat.com/buglist.cgi?"
4106 "component=libguestfs&product=Virtualization+Tools>"
4110 #: ../src/guestfs.pod:2118
4111 msgid "To report a new bug against libguestfs use this link:"
4115 #: ../src/guestfs.pod:2120
4117 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
4118 "component=libguestfs&product=Virtualization+Tools>"
4122 #: ../src/guestfs.pod:2122
4123 msgid "When reporting a bug, please check:"
4127 #: ../src/guestfs.pod:2128
4128 msgid "That the bug hasn't been reported already."
4132 #: ../src/guestfs.pod:2132
4133 msgid "That you are testing a recent version."
4137 #: ../src/guestfs.pod:2136
4138 msgid "Describe the bug accurately, and give a way to reproduce it."
4142 #: ../src/guestfs.pod:2140
4144 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4149 #: ../src/guestfs.pod:2145 ../fish/guestfish.pod:1058
4150 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4155 #: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1060
4156 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4157 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4161 #: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1062
4162 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
4163 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514
4164 #: ../tools/virt-df.pl:653 ../tools/virt-resize.pl:1510
4165 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296
4166 #: ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563
4167 #: ../tools/virt-list-partitions.pl:273
4172 #: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1064
4173 #: ../fuse/guestmount.pod:250
4174 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4178 #: ../src/guestfs.pod:2154
4180 "This library is free software; you can redistribute it and/or modify it "
4181 "under the terms of the GNU Lesser General Public License as published by the "
4182 "Free Software Foundation; either version 2 of the License, or (at your "
4183 "option) any later version."
4187 #: ../src/guestfs.pod:2159
4189 "This library is distributed in the hope that it will be useful, but WITHOUT "
4190 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4191 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4196 #: ../src/guestfs.pod:2164
4198 "You should have received a copy of the GNU Lesser General Public License "
4199 "along with this library; if not, write to the Free Software Foundation, "
4200 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4204 #: ../src/guestfs-actions.pod:1
4205 msgid "guestfs_add_cdrom"
4209 #: ../src/guestfs-actions.pod:3
4213 " guestfs_add_cdrom (guestfs_h *g,\n"
4214 " const char *filename);\n"
4219 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4220 msgid "This function adds a virtual CD-ROM disk image to the guest."
4224 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4225 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4229 #: ../src/guestfs-actions.pod:17
4231 "This call checks for the existence of C<filename>. This stops you from "
4232 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4233 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4238 #: ../src/guestfs-actions.pod:24
4240 "If you just want to add an ISO file (often you use this as an efficient way "
4241 "to transfer large files into the guest), then you should probably use "
4242 "C<guestfs_add_drive_ro> instead."
4246 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
4247 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
4248 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
4249 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4250 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4251 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4252 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4253 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4254 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4255 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4256 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4257 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4258 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4259 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4260 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4261 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4262 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4263 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4264 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4265 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4266 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4267 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182
4268 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217
4269 #: ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356
4270 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383
4271 #: ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434
4272 #: ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526
4273 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566
4274 #: ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621
4275 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659
4276 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706
4277 #: ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758
4278 #: ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786
4279 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896
4280 #: ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929
4281 #: ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998
4282 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032
4283 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060
4284 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092
4285 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161
4286 #: ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211
4287 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242
4288 #: ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272
4289 #: ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302
4290 #: ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352
4291 #: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386
4292 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452
4293 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
4294 #: ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548
4295 #: ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700
4296 #: ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779
4297 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829
4298 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912
4299 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939
4300 #: ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247
4301 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273
4302 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299
4303 #: ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329
4304 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369
4305 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406
4306 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447
4307 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487
4308 #: ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523
4309 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575
4310 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618
4311 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648
4312 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704
4313 #: ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753
4314 #: ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982
4315 #: ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007
4316 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042
4317 #: ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068
4318 #: ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096
4319 #: ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172
4320 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204
4321 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234
4322 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290
4323 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345
4324 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376
4325 #: ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436
4326 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573
4327 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642
4328 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700
4329 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787
4330 #: ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879
4331 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4332 msgid "This function returns 0 on success or -1 on error."
4336 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4337 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4338 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4340 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4345 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4346 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4347 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4348 #: ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990
4349 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4350 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4351 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4352 #: ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4354 "Deprecated functions will not be removed from the API, but the fact that "
4355 "they are deprecated indicates that there are problems with correct use of "
4360 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4361 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4362 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4363 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199
4364 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408
4365 #: ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635
4366 #: ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223
4367 #: ../src/guestfs-actions.pod:6735
4368 msgid "(Added in 0.3)"
4372 #: ../src/guestfs-actions.pod:41
4373 msgid "guestfs_add_domain"
4377 #: ../src/guestfs-actions.pod:43
4381 " guestfs_add_domain (guestfs_h *g,\n"
4382 " const char *dom,\n"
4388 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4390 "You may supply a list of optional arguments to this call. Use zero or more "
4391 "of the following pairs of parameters, and terminate the list with C<-1> on "
4392 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4396 #: ../src/guestfs-actions.pod:53
4399 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4400 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4401 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4406 #: ../src/guestfs-actions.pod:57
4408 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4409 "It works by connecting to libvirt, requesting the domain and domain XML from "
4410 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4415 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4417 "The number of disks added is returned. This operation is atomic: if an "
4418 "error is returned, then no disks are added."
4422 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4424 "This function does some minimal checks to make sure the libvirt domain is "
4425 "not running (unless C<readonly> is true). In a future version we will try "
4426 "to acquire the libvirt lock on each disk."
4430 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4432 "Disks must be accessible locally. This often means that adding disks from a "
4433 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4434 "unless those disks are accessible via the same device path locally too."
4438 #: ../src/guestfs-actions.pod:74
4440 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4441 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4442 "libvirt URI (or one set through an environment variable, see the libvirt "
4443 "documentation for full details). If you are using the C API directly then "
4444 "it is more flexible to create the libvirt connection object yourself, get "
4445 "the domain object, and call C<guestfs_add_libvirt_dom>."
4449 #: ../src/guestfs-actions.pod:82
4451 "The other optional parameters are passed directly through to "
4452 "C<guestfs_add_drive_opts>."
4456 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4457 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4458 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4459 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4460 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4461 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4462 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4463 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630
4464 #: ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475
4465 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009
4466 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331
4467 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759
4468 #: ../src/guestfs-actions.pod:6772
4469 msgid "On error this function returns -1."
4473 #: ../src/guestfs-actions.pod:87
4474 msgid "guestfs_add_domain_va"
4478 #: ../src/guestfs-actions.pod:89
4482 " guestfs_add_domain_va (guestfs_h *g,\n"
4483 " const char *dom,\n"
4489 #: ../src/guestfs-actions.pod:94
4490 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4494 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4495 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4496 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4500 #: ../src/guestfs-actions.pod:98
4501 msgid "guestfs_add_domain_argv"
4505 #: ../src/guestfs-actions.pod:100
4509 " guestfs_add_domain_argv (guestfs_h *g,\n"
4510 " const char *dom,\n"
4511 " const struct guestfs_add_domain_argv *optargs);\n"
4516 #: ../src/guestfs-actions.pod:105
4517 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4521 #: ../src/guestfs-actions.pod:109
4522 msgid "guestfs_add_drive"
4526 #: ../src/guestfs-actions.pod:111
4530 " guestfs_add_drive (guestfs_h *g,\n"
4531 " const char *filename);\n"
4536 #: ../src/guestfs-actions.pod:115
4538 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4539 "optional parameters, so the disk is added writable, with the format being "
4540 "detected automatically."
4544 #: ../src/guestfs-actions.pod:119
4546 "Automatic detection of the format opens you up to a potential security hole "
4547 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4548 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4549 "you should think about replacing calls to this function with calls to "
4550 "C<guestfs_add_drive_opts>, and specifying the format."
4554 #: ../src/guestfs-actions.pod:130
4555 msgid "guestfs_add_drive_opts"
4559 #: ../src/guestfs-actions.pod:132
4563 " guestfs_add_drive_opts (guestfs_h *g,\n"
4564 " const char *filename,\n"
4570 #: ../src/guestfs-actions.pod:142
4573 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4574 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4575 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4580 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4582 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4583 "The first time you call this function, the disk appears as C</dev/sda>, the "
4584 "second time as C</dev/sdb>, and so on."
4588 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4590 "You don't necessarily need to be root when using libguestfs. However you "
4591 "obviously do need sufficient permissions to access the filename for whatever "
4592 "operations you want to perform (ie. read access if you just want to read the "
4593 "image or write access if you want to modify the image)."
4597 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4598 msgid "This call checks that C<filename> exists."
4602 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4603 msgid "The optional arguments are:"
4607 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4612 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4614 "If true then the image is treated as read-only. Writes are still allowed, "
4615 "but they are stored in a temporary snapshot overlay which is discarded at "
4616 "the end. The disk that you add is not modified."
4620 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4625 #: ../src/guestfs-actions.pod:171
4627 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4628 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4629 "Possible formats include C<raw> and C<qcow2>."
4633 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4635 "Automatic detection of the format opens you up to a potential security hole "
4636 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4637 "RHBZ#642934. Specifying the format closes this security hole."
4641 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4646 #: ../src/guestfs-actions.pod:182
4648 "This rarely-used option lets you emulate the behaviour of the deprecated "
4649 "C<guestfs_add_drive_with_if> call (q.v.)"
4653 #: ../src/guestfs-actions.pod:189
4654 msgid "(Added in 1.5.23)"
4658 #: ../src/guestfs-actions.pod:191
4659 msgid "guestfs_add_drive_opts_va"
4663 #: ../src/guestfs-actions.pod:193
4667 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4668 " const char *filename,\n"
4674 #: ../src/guestfs-actions.pod:198
4675 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4679 #: ../src/guestfs-actions.pod:202
4680 msgid "guestfs_add_drive_opts_argv"
4684 #: ../src/guestfs-actions.pod:204
4688 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4689 " const char *filename,\n"
4690 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4695 #: ../src/guestfs-actions.pod:209
4696 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4700 #: ../src/guestfs-actions.pod:213
4701 msgid "guestfs_add_drive_ro"
4705 #: ../src/guestfs-actions.pod:215
4709 " guestfs_add_drive_ro (guestfs_h *g,\n"
4710 " const char *filename);\n"
4715 #: ../src/guestfs-actions.pod:219
4717 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4718 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4719 "disk is added read-only, with the format being detected automatically."
4723 #: ../src/guestfs-actions.pod:226
4724 msgid "(Added in 1.0.38)"
4728 #: ../src/guestfs-actions.pod:228
4729 msgid "guestfs_add_drive_ro_with_if"
4733 #: ../src/guestfs-actions.pod:230
4737 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4738 " const char *filename,\n"
4739 " const char *iface);\n"
4744 #: ../src/guestfs-actions.pod:235
4746 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4747 "QEMU interface emulation to use at run time."
4751 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4752 #: ../src/guestfs-actions.pod:2303
4753 msgid "(Added in 1.0.84)"
4757 #: ../src/guestfs-actions.pod:249
4758 msgid "guestfs_add_drive_with_if"
4762 #: ../src/guestfs-actions.pod:251
4766 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4767 " const char *filename,\n"
4768 " const char *iface);\n"
4773 #: ../src/guestfs-actions.pod:256
4775 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4776 "QEMU interface emulation to use at run time."
4780 #: ../src/guestfs-actions.pod:270
4781 msgid "guestfs_aug_clear"
4785 #: ../src/guestfs-actions.pod:272
4789 " guestfs_aug_clear (guestfs_h *g,\n"
4790 " const char *augpath);\n"
4795 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4797 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4798 "L<augtool(1)> C<clear> command."
4802 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4803 msgid "(Added in 1.3.4)"
4807 #: ../src/guestfs-actions.pod:283
4808 msgid "guestfs_aug_close"
4812 #: ../src/guestfs-actions.pod:285
4816 " guestfs_aug_close (guestfs_h *g);\n"
4821 #: ../src/guestfs-actions.pod:288
4823 "Close the current Augeas handle and free up any resources used by it. After "
4824 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4825 "any other Augeas functions."
4829 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4830 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4831 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4832 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4833 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4834 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4835 #: ../src/guestfs-actions.pod:5086
4836 msgid "(Added in 0.7)"
4840 #: ../src/guestfs-actions.pod:297
4841 msgid "guestfs_aug_defnode"
4845 #: ../src/guestfs-actions.pod:299
4848 " struct guestfs_int_bool *\n"
4849 " guestfs_aug_defnode (guestfs_h *g,\n"
4850 " const char *name,\n"
4851 " const char *expr,\n"
4852 " const char *val);\n"
4857 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4859 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4863 #: ../src/guestfs-actions.pod:308
4865 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4866 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4867 "containing that single node."
4871 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4873 "On success this returns a pair containing the number of nodes in the "
4874 "nodeset, and a boolean flag if a node was created."
4878 #: ../src/guestfs-actions.pod:316
4880 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4881 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4885 #: ../src/guestfs-actions.pod:322
4886 msgid "guestfs_aug_defvar"
4890 #: ../src/guestfs-actions.pod:324
4894 " guestfs_aug_defvar (guestfs_h *g,\n"
4895 " const char *name,\n"
4896 " const char *expr);\n"
4901 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4903 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4904 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4908 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4910 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4911 "evaluates to something which is not a nodeset."
4915 #: ../src/guestfs-actions.pod:340
4916 msgid "guestfs_aug_get"
4920 #: ../src/guestfs-actions.pod:342
4924 " guestfs_aug_get (guestfs_h *g,\n"
4925 " const char *augpath);\n"
4930 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4932 "Look up the value associated with C<path>. If C<path> matches exactly one "
4933 "node, the C<value> is returned."
4937 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4938 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4939 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4940 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4941 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4942 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4943 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4944 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4945 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4946 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
4947 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712
4948 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763
4949 #: ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846
4950 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678
4951 #: ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958
4952 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814
4953 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162
4954 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774
4955 #: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807
4956 #: ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495
4957 #: ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532
4958 #: ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4960 "This function returns a string, or NULL on error. I<The caller must free "
4961 "the returned string after use>."
4965 #: ../src/guestfs-actions.pod:354
4966 msgid "guestfs_aug_init"
4970 #: ../src/guestfs-actions.pod:356
4974 " guestfs_aug_init (guestfs_h *g,\n"
4975 " const char *root,\n"
4981 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4983 "Create a new Augeas handle for editing configuration files. If there was "
4984 "any previous Augeas handle associated with this guestfs session, then it is "
4989 #: ../src/guestfs-actions.pod:365
4990 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4994 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4996 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5000 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
5002 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5003 "logical I<or> of the following integers:"
5007 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
5008 msgid "C<AUG_SAVE_BACKUP> = 1"
5012 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
5013 msgid "Keep the original file with a C<.augsave> extension."
5017 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
5018 msgid "C<AUG_SAVE_NEWFILE> = 2"
5022 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
5024 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5025 "original. Overrides C<AUG_SAVE_BACKUP>."
5029 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
5030 msgid "C<AUG_TYPE_CHECK> = 4"
5034 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
5035 msgid "Typecheck lenses (can be expensive)."
5039 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
5040 msgid "C<AUG_NO_STDINC> = 8"
5044 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
5045 msgid "Do not use standard load path for modules."
5049 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
5050 msgid "C<AUG_SAVE_NOOP> = 16"
5054 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
5055 msgid "Make save a no-op, just record what would have been changed."
5059 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
5060 msgid "C<AUG_NO_LOAD> = 32"
5064 #: ../src/guestfs-actions.pod:400
5065 msgid "Do not load the tree in C<guestfs_aug_init>."
5069 #: ../src/guestfs-actions.pod:404
5070 msgid "To close the handle, you can call C<guestfs_aug_close>."
5074 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
5075 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5079 #: ../src/guestfs-actions.pod:412
5080 msgid "guestfs_aug_insert"
5084 #: ../src/guestfs-actions.pod:414
5088 " guestfs_aug_insert (guestfs_h *g,\n"
5089 " const char *augpath,\n"
5090 " const char *label,\n"
5096 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
5098 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5099 "or after C<path> (depending on the boolean flag C<before>)."
5103 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
5105 "C<path> must match exactly one existing node in the tree, and C<label> must "
5106 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5110 #: ../src/guestfs-actions.pod:432
5111 msgid "guestfs_aug_load"
5115 #: ../src/guestfs-actions.pod:434
5119 " guestfs_aug_load (guestfs_h *g);\n"
5124 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
5125 msgid "Load files into the tree."
5129 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
5130 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5134 #: ../src/guestfs-actions.pod:446
5135 msgid "guestfs_aug_ls"
5139 #: ../src/guestfs-actions.pod:448
5143 " guestfs_aug_ls (guestfs_h *g,\n"
5144 " const char *augpath);\n"
5149 #: ../src/guestfs-actions.pod:452
5151 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5152 "sorting the resulting nodes into alphabetical order."
5156 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
5157 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
5158 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
5159 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
5160 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
5161 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
5162 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
5163 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
5164 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782
5165 #: ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248
5166 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415
5167 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436
5168 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082
5169 #: ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847
5170 #: ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963
5171 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133
5172 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625
5173 #: ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837
5174 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941
5175 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006
5176 #: ../src/guestfs-actions.pod:7025
5178 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5179 ">), or NULL if there was an error. I<The caller must free the strings and "
5180 "the array after use>."
5184 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
5185 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
5186 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102
5187 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711
5188 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931
5189 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440
5190 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275
5191 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301
5192 #: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347
5193 #: ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589
5194 #: ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
5195 msgid "(Added in 0.8)"
5199 #: ../src/guestfs-actions.pod:461
5200 msgid "guestfs_aug_match"
5204 #: ../src/guestfs-actions.pod:463
5208 " guestfs_aug_match (guestfs_h *g,\n"
5209 " const char *augpath);\n"
5214 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
5216 "Returns a list of paths which match the path expression C<path>. The "
5217 "returned paths are sufficiently qualified so that they match exactly one "
5218 "node in the current tree."
5222 #: ../src/guestfs-actions.pod:477
5223 msgid "guestfs_aug_mv"
5227 #: ../src/guestfs-actions.pod:479
5231 " guestfs_aug_mv (guestfs_h *g,\n"
5232 " const char *src,\n"
5233 " const char *dest);\n"
5238 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
5240 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5241 "C<dest> is overwritten if it exists."
5245 #: ../src/guestfs-actions.pod:491
5246 msgid "guestfs_aug_rm"
5250 #: ../src/guestfs-actions.pod:493
5254 " guestfs_aug_rm (guestfs_h *g,\n"
5255 " const char *augpath);\n"
5260 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5261 msgid "Remove C<path> and all of its children."
5265 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5266 msgid "On success this returns the number of entries which were removed."
5270 #: ../src/guestfs-actions.pod:505
5271 msgid "guestfs_aug_save"
5275 #: ../src/guestfs-actions.pod:507
5279 " guestfs_aug_save (guestfs_h *g);\n"
5284 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5285 msgid "This writes all pending changes to disk."
5289 #: ../src/guestfs-actions.pod:512
5291 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5296 #: ../src/guestfs-actions.pod:519
5297 msgid "guestfs_aug_set"
5301 #: ../src/guestfs-actions.pod:521
5305 " guestfs_aug_set (guestfs_h *g,\n"
5306 " const char *augpath,\n"
5307 " const char *val);\n"
5312 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5313 msgid "Set the value associated with C<path> to C<val>."
5317 #: ../src/guestfs-actions.pod:528
5319 "In the Augeas API, it is possible to clear a node by setting the value to "
5320 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5321 "this call. Instead you must use the C<guestfs_aug_clear> call."
5325 #: ../src/guestfs-actions.pod:537
5326 msgid "guestfs_available"
5330 #: ../src/guestfs-actions.pod:539
5334 " guestfs_available (guestfs_h *g,\n"
5335 " char *const *groups);\n"
5340 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5342 "This command is used to check the availability of some groups of "
5343 "functionality in the appliance, which not all builds of the libguestfs "
5344 "appliance will be able to provide."
5348 #: ../src/guestfs-actions.pod:547
5350 "The libguestfs groups, and the functions that those groups correspond to, "
5351 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5352 "runtime by calling C<guestfs_available_all_groups>."
5356 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5358 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5359 "\"]> would check for the availability of the Linux inotify functions and "
5360 "Augeas (configuration file editing) functions."
5364 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5365 msgid "The command returns no error if I<all> requested groups are available."
5369 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5371 "It fails with an error if one or more of the requested groups is unavailable "
5376 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5378 "If an unknown group name is included in the list of groups then an error is "
5383 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5388 #: ../src/guestfs-actions.pod:571
5389 msgid "You must call C<guestfs_launch> before calling this function."
5393 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5395 "The reason is because we don't know what groups are supported by the "
5396 "appliance/daemon until it is running and can be queried."
5400 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5402 "If a group of functions is available, this does not necessarily mean that "
5403 "they will work. You still have to check for errors when calling individual "
5404 "API functions even if they are available."
5408 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5410 "It is usually the job of distro packagers to build complete functionality "
5411 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5412 "with all requirements satisfied, will support everything."
5416 #: ../src/guestfs-actions.pod:593
5418 "This call was added in version C<1.0.80>. In previous versions of "
5419 "libguestfs all you could do would be to speculatively execute a command to "
5420 "find out if the daemon implemented it. See also C<guestfs_version>."
5424 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5425 msgid "(Added in 1.0.80)"
5429 #: ../src/guestfs-actions.pod:604
5430 msgid "guestfs_available_all_groups"
5434 #: ../src/guestfs-actions.pod:606
5438 " guestfs_available_all_groups (guestfs_h *g);\n"
5443 #: ../src/guestfs-actions.pod:609
5445 "This command returns a list of all optional groups that this daemon knows "
5446 "about. Note this returns both supported and unsupported groups. To find "
5447 "out which ones the daemon can actually support you have to call "
5448 "C<guestfs_available> on each member of the returned list."
5452 #: ../src/guestfs-actions.pod:615
5453 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5457 #: ../src/guestfs-actions.pod:621
5458 msgid "(Added in 1.3.15)"
5462 #: ../src/guestfs-actions.pod:623
5463 msgid "guestfs_base64_in"
5467 #: ../src/guestfs-actions.pod:625
5471 " guestfs_base64_in (guestfs_h *g,\n"
5472 " const char *base64file,\n"
5473 " const char *filename);\n"
5478 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5480 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5484 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5485 msgid "(Added in 1.3.5)"
5489 #: ../src/guestfs-actions.pod:637
5490 msgid "guestfs_base64_out"
5494 #: ../src/guestfs-actions.pod:639
5498 " guestfs_base64_out (guestfs_h *g,\n"
5499 " const char *filename,\n"
5500 " const char *base64file);\n"
5505 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5507 "This command downloads the contents of C<filename>, writing it out to local "
5508 "file C<base64file> encoded as base64."
5512 #: ../src/guestfs-actions.pod:651
5513 msgid "guestfs_blockdev_flushbufs"
5517 #: ../src/guestfs-actions.pod:653
5521 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5522 " const char *device);\n"
5527 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5529 "This tells the kernel to flush internal buffers associated with C<device>."
5533 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5534 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5535 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5536 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5537 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5538 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5539 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5540 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5541 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5542 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5543 msgid "This uses the L<blockdev(8)> command."
5547 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5548 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5549 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5550 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5551 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5552 msgid "(Added in 0.9.3)"
5556 #: ../src/guestfs-actions.pod:666
5557 msgid "guestfs_blockdev_getbsz"
5561 #: ../src/guestfs-actions.pod:668
5565 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5566 " const char *device);\n"
5571 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5572 msgid "This returns the block size of a device."
5576 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5577 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5579 "(Note this is different from both I<size in blocks> and I<filesystem block "
5584 #: ../src/guestfs-actions.pod:683
5585 msgid "guestfs_blockdev_getro"
5589 #: ../src/guestfs-actions.pod:685
5593 " guestfs_blockdev_getro (guestfs_h *g,\n"
5594 " const char *device);\n"
5599 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5601 "Returns a boolean indicating if the block device is read-only (true if read-"
5602 "only, false if not)."
5606 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5607 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5608 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5609 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5610 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5611 #: ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024
5612 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053
5613 #: ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084
5614 #: ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114
5615 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141
5616 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171
5617 #: ../src/guestfs-actions.pod:4585
5618 msgid "This function returns a C truth value on success or -1 on error."
5622 #: ../src/guestfs-actions.pod:698
5623 msgid "guestfs_blockdev_getsize64"
5627 #: ../src/guestfs-actions.pod:700
5631 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5632 " const char *device);\n"
5637 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5638 msgid "This returns the size of the device in bytes."
5642 #: ../src/guestfs-actions.pod:706
5643 msgid "See also C<guestfs_blockdev_getsz>."
5647 #: ../src/guestfs-actions.pod:714
5648 msgid "guestfs_blockdev_getss"
5652 #: ../src/guestfs-actions.pod:716
5656 " guestfs_blockdev_getss (guestfs_h *g,\n"
5657 " const char *device);\n"
5662 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5664 "This returns the size of sectors on a block device. Usually 512, but can be "
5665 "larger for modern devices."
5669 #: ../src/guestfs-actions.pod:723
5671 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5676 #: ../src/guestfs-actions.pod:732
5677 msgid "guestfs_blockdev_getsz"
5681 #: ../src/guestfs-actions.pod:734
5685 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5686 " const char *device);\n"
5691 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5693 "This returns the size of the device in units of 512-byte sectors (even if "
5694 "the sectorsize isn't 512 bytes ... weird)."
5698 #: ../src/guestfs-actions.pod:741
5700 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5701 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5705 #: ../src/guestfs-actions.pod:751
5706 msgid "guestfs_blockdev_rereadpt"
5710 #: ../src/guestfs-actions.pod:753
5714 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5715 " const char *device);\n"
5720 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5721 msgid "Reread the partition table on C<device>."
5725 #: ../src/guestfs-actions.pod:765
5726 msgid "guestfs_blockdev_setbsz"
5730 #: ../src/guestfs-actions.pod:767
5734 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5735 " const char *device,\n"
5736 " int blocksize);\n"
5741 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5742 msgid "This sets the block size of a device."
5746 #: ../src/guestfs-actions.pod:783
5747 msgid "guestfs_blockdev_setro"
5751 #: ../src/guestfs-actions.pod:785
5755 " guestfs_blockdev_setro (guestfs_h *g,\n"
5756 " const char *device);\n"
5761 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5762 msgid "Sets the block device named C<device> to read-only."
5766 #: ../src/guestfs-actions.pod:797
5767 msgid "guestfs_blockdev_setrw"
5771 #: ../src/guestfs-actions.pod:799
5775 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5776 " const char *device);\n"
5781 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5782 msgid "Sets the block device named C<device> to read-write."
5786 #: ../src/guestfs-actions.pod:811
5787 msgid "guestfs_case_sensitive_path"
5791 #: ../src/guestfs-actions.pod:813
5795 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5796 " const char *path);\n"
5801 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5803 "This can be used to resolve case insensitive paths on a filesystem which is "
5804 "case sensitive. The use case is to resolve paths which you have read from "
5805 "Windows configuration files or the Windows Registry, to the true path."
5809 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5811 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5812 "(and probably others), which is that although the underlying filesystem is "
5813 "case-insensitive, the driver exports the filesystem to Linux as case-"
5818 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5820 "One consequence of this is that special directories such as C<c:\\windows> "
5821 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5822 "precise details of how they were created. In Windows itself this would not "
5827 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5829 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5834 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5836 "This function resolves the true case of each element in the path and returns "
5837 "the case-sensitive path."
5841 #: ../src/guestfs-actions.pod:839
5843 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5844 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5845 "how the directories were originally created under Windows)."
5849 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5850 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5854 #: ../src/guestfs-actions.pod:847
5855 msgid "See also C<guestfs_realpath>."
5859 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5860 msgid "(Added in 1.0.75)"
5864 #: ../src/guestfs-actions.pod:854
5869 #: ../src/guestfs-actions.pod:856
5873 " guestfs_cat (guestfs_h *g,\n"
5874 " const char *path);\n"
5879 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072
5880 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5881 msgid "Return the contents of the file named C<path>."
5885 #: ../src/guestfs-actions.pod:862
5887 "Note that this function cannot correctly handle binary files (specifically, "
5888 "files containing C<\\0> character which is treated as end of string). For "
5889 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5890 "functions which have a more complex interface."
5894 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5895 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5896 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5897 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5898 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5899 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5900 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5901 #: ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880
5902 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037
5903 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912
5904 #: ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113
5905 #: ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789
5906 #: ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841
5907 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945
5908 #: ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010
5909 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:582
5910 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5911 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5912 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5913 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5914 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5915 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5916 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5917 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5918 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5919 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5920 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5921 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5922 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5923 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5924 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5926 "Because of the message protocol, there is a transfer limit of somewhere "
5927 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5931 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252
5932 #: ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331
5933 #: ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824
5934 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960
5935 #: ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676
5936 #: ../src/guestfs-actions.pod:6690
5937 msgid "(Added in 0.4)"
5941 #: ../src/guestfs-actions.pod:875
5942 msgid "guestfs_checksum"
5946 #: ../src/guestfs-actions.pod:877
5950 " guestfs_checksum (guestfs_h *g,\n"
5951 " const char *csumtype,\n"
5952 " const char *path);\n"
5957 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5959 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5963 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5965 "The type of checksum to compute is given by the C<csumtype> parameter which "
5966 "must have one of the following values:"
5970 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5975 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5977 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5982 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5987 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5988 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5992 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5997 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5998 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6002 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
6007 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
6008 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6012 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
6017 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
6018 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6022 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
6027 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
6028 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6032 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
6037 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
6038 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6042 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
6043 msgid "The checksum is returned as a printable string."
6047 #: ../src/guestfs-actions.pod:923
6048 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6052 #: ../src/guestfs-actions.pod:925
6053 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6057 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
6058 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026
6059 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116
6060 #: ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
6061 msgid "(Added in 1.0.2)"
6065 #: ../src/guestfs-actions.pod:932
6066 msgid "guestfs_checksum_device"
6070 #: ../src/guestfs-actions.pod:934
6074 " guestfs_checksum_device (guestfs_h *g,\n"
6075 " const char *csumtype,\n"
6076 " const char *device);\n"
6081 #: ../src/guestfs-actions.pod:939
6083 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6084 "device named C<device>. For the types of checksums supported see the "
6085 "C<guestfs_checksum> command."
6089 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491
6090 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587
6091 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781
6092 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306
6093 #: ../src/guestfs-actions.pod:6702
6094 msgid "(Added in 1.3.2)"
6098 #: ../src/guestfs-actions.pod:948
6099 msgid "guestfs_checksums_out"
6103 #: ../src/guestfs-actions.pod:950
6107 " guestfs_checksums_out (guestfs_h *g,\n"
6108 " const char *csumtype,\n"
6109 " const char *directory,\n"
6110 " const char *sumsfile);\n"
6115 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
6117 "This command computes the checksums of all regular files in C<directory> and "
6118 "then emits a list of those checksums to the local output file C<sumsfile>."
6122 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
6124 "This can be used for verifying the integrity of a virtual machine. However "
6125 "to be properly secure you should pay attention to the output of the checksum "
6126 "command (it uses the ones from GNU coreutils). In particular when the "
6127 "filename is not printable, coreutils uses a special backslash syntax. For "
6128 "more information, see the GNU coreutils info file."
6132 #: ../src/guestfs-actions.pod:970
6133 msgid "(Added in 1.3.7)"
6137 #: ../src/guestfs-actions.pod:972
6138 msgid "guestfs_chmod"
6142 #: ../src/guestfs-actions.pod:974
6146 " guestfs_chmod (guestfs_h *g,\n"
6148 " const char *path);\n"
6153 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
6155 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6160 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
6162 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6163 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6168 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075
6169 #: ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209
6170 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671
6171 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6172 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6173 msgid "The mode actually set is affected by the umask."
6177 #: ../src/guestfs-actions.pod:992
6178 msgid "guestfs_chown"
6182 #: ../src/guestfs-actions.pod:994
6186 " guestfs_chown (guestfs_h *g,\n"
6189 " const char *path);\n"
6194 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
6195 msgid "Change the file owner to C<owner> and group to C<group>."
6199 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213
6200 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6202 "Only numeric uid and gid are supported. If you want to use names, you will "
6203 "need to locate and parse the password file yourself (Augeas support makes "
6204 "this relatively easy)."
6208 #: ../src/guestfs-actions.pod:1010
6209 msgid "guestfs_command"
6213 #: ../src/guestfs-actions.pod:1012
6217 " guestfs_command (guestfs_h *g,\n"
6218 " char *const *arguments);\n"
6223 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
6225 "This call runs a command from the guest filesystem. The filesystem must be "
6226 "mounted, and must contain a compatible operating system (ie. something "
6227 "Linux, with the same or compatible processor architecture)."
6231 #: ../src/guestfs-actions.pod:1021
6233 "The single parameter is an argv-style list of arguments. The first element "
6234 "is the name of the program to run. Subsequent elements are parameters. The "
6235 "list must be non-empty (ie. must contain a program name). Note that the "
6236 "command runs directly, and is I<not> invoked via the shell (see "
6241 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
6242 msgid "The return value is anything printed to I<stdout> by the command."
6246 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
6248 "If the command returns a non-zero exit status, then this function returns an "
6249 "error message. The error message string is the content of I<stderr> from "
6254 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6256 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6257 "bin>. If you require a program from another location, you should provide "
6258 "the full path in the first parameter."
6262 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6264 "Shared libraries and data files required by the program must be available on "
6265 "filesystems which are mounted in the correct places. It is the caller's "
6266 "responsibility to ensure all filesystems that are needed are mounted at the "
6271 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6272 #: ../src/guestfs-actions.pod:1535
6273 msgid "(Added in 0.9.1)"
6277 #: ../src/guestfs-actions.pod:1054
6278 msgid "guestfs_command_lines"
6282 #: ../src/guestfs-actions.pod:1056
6286 " guestfs_command_lines (guestfs_h *g,\n"
6287 " char *const *arguments);\n"
6292 #: ../src/guestfs-actions.pod:1060
6294 "This is the same as C<guestfs_command>, but splits the result into a list of "
6299 #: ../src/guestfs-actions.pod:1063
6300 msgid "See also: C<guestfs_sh_lines>"
6304 #: ../src/guestfs-actions.pod:1074
6305 msgid "guestfs_config"
6309 #: ../src/guestfs-actions.pod:1076
6313 " guestfs_config (guestfs_h *g,\n"
6314 " const char *qemuparam,\n"
6315 " const char *qemuvalue);\n"
6320 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6322 "This can be used to add arbitrary qemu command line parameters of the form "
6323 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6324 "setting some parameters which would interfere with parameters that we use."
6328 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6329 msgid "The first character of C<param> string must be a C<-> (dash)."
6333 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6334 msgid "C<value> can be NULL."
6338 #: ../src/guestfs-actions.pod:1094
6339 msgid "guestfs_copy_size"
6343 #: ../src/guestfs-actions.pod:1096
6347 " guestfs_copy_size (guestfs_h *g,\n"
6348 " const char *src,\n"
6349 " const char *dest,\n"
6355 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6357 "This command copies exactly C<size> bytes from one source device or file "
6358 "C<src> to another destination device or file C<dest>."
6362 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6364 "Note this will fail if the source is too short or if the destination is not "
6369 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6370 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6371 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881
6372 #: ../src/guestfs-actions.pod:6900
6374 "This long-running command can generate progress notification messages so "
6375 "that the caller can display a progress bar or indicator. To receive these "
6376 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6377 "guestfs_set_progress_callback>."
6381 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851
6382 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609
6383 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6384 msgid "(Added in 1.0.87)"
6388 #: ../src/guestfs-actions.pod:1117
6393 #: ../src/guestfs-actions.pod:1119
6397 " guestfs_cp (guestfs_h *g,\n"
6398 " const char *src,\n"
6399 " const char *dest);\n"
6404 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6406 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6407 "destination filename or destination directory."
6411 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6412 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6413 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454
6414 #: ../src/guestfs-actions.pod:4831
6415 msgid "(Added in 1.0.18)"
6419 #: ../src/guestfs-actions.pod:1131
6420 msgid "guestfs_cp_a"
6424 #: ../src/guestfs-actions.pod:1133
6428 " guestfs_cp_a (guestfs_h *g,\n"
6429 " const char *src,\n"
6430 " const char *dest);\n"
6435 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6437 "This copies a file or directory from C<src> to C<dest> recursively using the "
6442 #: ../src/guestfs-actions.pod:1145
6447 #: ../src/guestfs-actions.pod:1147
6451 " guestfs_dd (guestfs_h *g,\n"
6452 " const char *src,\n"
6453 " const char *dest);\n"
6458 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6460 "This command copies from one source device or file C<src> to another "
6461 "destination device or file C<dest>. Normally you would use this to copy to "
6462 "or from a device or partition, for example to duplicate a filesystem."
6466 #: ../src/guestfs-actions.pod:1157
6468 "If the destination is a device, it must be as large or larger than the "
6469 "source file or device, otherwise the copy will fail. This command cannot do "
6470 "partial copies (see C<guestfs_copy_size>)."
6474 #: ../src/guestfs-actions.pod:1165
6479 #: ../src/guestfs-actions.pod:1167
6483 " guestfs_df (guestfs_h *g);\n"
6488 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6489 msgid "This command runs the C<df> command to report disk space used."
6493 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6494 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6496 "This command is mostly useful for interactive sessions. It is I<not> "
6497 "intended that you try to parse the output string. Use C<statvfs> from "
6502 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6503 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6504 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6505 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354
6506 #: ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140
6507 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761
6508 #: ../src/guestfs-actions.pod:6774
6509 msgid "(Added in 1.0.54)"
6513 #: ../src/guestfs-actions.pod:1181
6514 msgid "guestfs_df_h"
6518 #: ../src/guestfs-actions.pod:1183
6522 " guestfs_df_h (guestfs_h *g);\n"
6527 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6529 "This command runs the C<df -h> command to report disk space used in human-"
6534 #: ../src/guestfs-actions.pod:1198
6535 msgid "guestfs_dmesg"
6539 #: ../src/guestfs-actions.pod:1200
6543 " guestfs_dmesg (guestfs_h *g);\n"
6548 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6550 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6551 "This is sometimes useful for extended debugging of problems."
6555 #: ../src/guestfs-actions.pod:1207
6557 "Another way to get the same information is to enable verbose messages with "
6558 "C<guestfs_set_verbose> or by setting the environment variable "
6559 "C<LIBGUESTFS_DEBUG=1> before running the program."
6563 #: ../src/guestfs-actions.pod:1217
6564 msgid "guestfs_download"
6568 #: ../src/guestfs-actions.pod:1219
6572 " guestfs_download (guestfs_h *g,\n"
6573 " const char *remotefilename,\n"
6574 " const char *filename);\n"
6579 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6580 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6582 "Download file C<remotefilename> and save it as C<filename> on the local "
6587 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372
6588 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6589 msgid "C<filename> can also be a named pipe."
6593 #: ../src/guestfs-actions.pod:1229
6594 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6598 #: ../src/guestfs-actions.pod:1240
6599 msgid "guestfs_download_offset"
6603 #: ../src/guestfs-actions.pod:1242
6607 " guestfs_download_offset (guestfs_h *g,\n"
6608 " const char *remotefilename,\n"
6609 " const char *filename,\n"
6610 " int64_t offset,\n"
6616 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6618 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6619 "region must be within the file or device)."
6623 #: ../src/guestfs-actions.pod:1255
6625 "Note that there is no limit on the amount of data that can be downloaded "
6626 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6627 "full amount unless an error occurs."
6631 #: ../src/guestfs-actions.pod:1260
6632 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6636 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6637 msgid "(Added in 1.5.17)"
6641 #: ../src/guestfs-actions.pod:1271
6642 msgid "guestfs_drop_caches"
6646 #: ../src/guestfs-actions.pod:1273
6650 " guestfs_drop_caches (guestfs_h *g,\n"
6651 " int whattodrop);\n"
6656 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6658 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6659 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6660 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6664 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6665 msgid "Setting C<whattodrop> to 3 should drop everything."
6669 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6671 "This automatically calls L<sync(2)> before the operation, so that the "
6672 "maximum guest memory is freed."
6676 #: ../src/guestfs-actions.pod:1291
6681 #: ../src/guestfs-actions.pod:1293
6685 " guestfs_du (guestfs_h *g,\n"
6686 " const char *path);\n"
6691 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6693 "This command runs the C<du -s> command to estimate file space usage for "
6698 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6700 "C<path> can be a file or a directory. If C<path> is a directory then the "
6701 "estimate includes the contents of the directory and all subdirectories "
6706 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6708 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6712 #: ../src/guestfs-actions.pod:1311
6713 msgid "guestfs_e2fsck_f"
6717 #: ../src/guestfs-actions.pod:1313
6721 " guestfs_e2fsck_f (guestfs_h *g,\n"
6722 " const char *device);\n"
6727 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6729 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6730 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6735 #: ../src/guestfs-actions.pod:1321
6737 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6738 "Normally you should use C<guestfs_fsck>."
6742 #: ../src/guestfs-actions.pod:1326
6743 msgid "(Added in 1.0.29)"
6747 #: ../src/guestfs-actions.pod:1328
6748 msgid "guestfs_echo_daemon"
6752 #: ../src/guestfs-actions.pod:1330
6756 " guestfs_echo_daemon (guestfs_h *g,\n"
6757 " char *const *words);\n"
6762 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6764 "This command concatenates the list of C<words> passed with single spaces "
6765 "between them and returns the resulting string."
6769 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6770 msgid "You can use this command to test the connection through to the daemon."
6774 #: ../src/guestfs-actions.pod:1339
6775 msgid "See also C<guestfs_ping_daemon>."
6779 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6780 #: ../src/guestfs-actions.pod:5620
6781 msgid "(Added in 1.0.69)"
6785 #: ../src/guestfs-actions.pod:1346
6786 msgid "guestfs_egrep"
6790 #: ../src/guestfs-actions.pod:1348
6794 " guestfs_egrep (guestfs_h *g,\n"
6795 " const char *regex,\n"
6796 " const char *path);\n"
6801 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6803 "This calls the external C<egrep> program and returns the matching lines."
6807 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6808 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6809 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6810 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6811 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6812 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6813 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344
6814 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371
6815 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289
6816 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214
6817 #: ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996
6818 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022
6819 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057
6820 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083
6821 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863
6822 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967
6823 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6824 msgid "(Added in 1.0.66)"
6828 #: ../src/guestfs-actions.pod:1365
6829 msgid "guestfs_egrepi"
6833 #: ../src/guestfs-actions.pod:1367
6837 " guestfs_egrepi (guestfs_h *g,\n"
6838 " const char *regex,\n"
6839 " const char *path);\n"
6844 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6846 "This calls the external C<egrep -i> program and returns the matching lines."
6850 #: ../src/guestfs-actions.pod:1384
6851 msgid "guestfs_equal"
6855 #: ../src/guestfs-actions.pod:1386
6859 " guestfs_equal (guestfs_h *g,\n"
6860 " const char *file1,\n"
6861 " const char *file2);\n"
6866 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6868 "This compares the two files C<file1> and C<file2> and returns true if their "
6869 "content is exactly equal, or false otherwise."
6873 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6874 msgid "The external L<cmp(1)> program is used for the comparison."
6878 #: ../src/guestfs-actions.pod:1400
6879 msgid "guestfs_exists"
6883 #: ../src/guestfs-actions.pod:1402
6887 " guestfs_exists (guestfs_h *g,\n"
6888 " const char *path);\n"
6893 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6895 "This returns C<true> if and only if there is a file, directory (or anything) "
6896 "with the given C<path> name."
6900 #: ../src/guestfs-actions.pod:1409
6901 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6905 #: ../src/guestfs-actions.pod:1415
6906 msgid "guestfs_fallocate"
6910 #: ../src/guestfs-actions.pod:1417
6914 " guestfs_fallocate (guestfs_h *g,\n"
6915 " const char *path,\n"
6921 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6922 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6924 "This command preallocates a file (containing zero bytes) named C<path> of "
6925 "size C<len> bytes. If the file exists already, it is overwritten."
6929 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6931 "Do not confuse this with the guestfish-specific C<alloc> command which "
6932 "allocates a file in the host and attaches it as a device."
6936 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6938 "This function is deprecated. In new code, use the C<fallocate64> call "
6943 #: ../src/guestfs-actions.pod:1441
6944 msgid "guestfs_fallocate64"
6948 #: ../src/guestfs-actions.pod:1443
6952 " guestfs_fallocate64 (guestfs_h *g,\n"
6953 " const char *path,\n"
6959 #: ../src/guestfs-actions.pod:1452
6961 "Note that this call allocates disk blocks for the file. To create a sparse "
6962 "file use C<guestfs_truncate_size> instead."
6966 #: ../src/guestfs-actions.pod:1455
6968 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6969 "oversight it only allowed 30 bit lengths to be specified, effectively "
6970 "limiting the maximum size of files created through that call to 1GB."
6974 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6976 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6977 "commands which create a file in the host and attach it as a device."
6981 #: ../src/guestfs-actions.pod:1466
6982 msgid "(Added in 1.3.17)"
6986 #: ../src/guestfs-actions.pod:1468
6987 msgid "guestfs_fgrep"
6991 #: ../src/guestfs-actions.pod:1470
6995 " guestfs_fgrep (guestfs_h *g,\n"
6996 " const char *pattern,\n"
6997 " const char *path);\n"
7002 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
7004 "This calls the external C<fgrep> program and returns the matching lines."
7008 #: ../src/guestfs-actions.pod:1487
7009 msgid "guestfs_fgrepi"
7013 #: ../src/guestfs-actions.pod:1489
7017 " guestfs_fgrepi (guestfs_h *g,\n"
7018 " const char *pattern,\n"
7019 " const char *path);\n"
7024 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
7026 "This calls the external C<fgrep -i> program and returns the matching lines."
7030 #: ../src/guestfs-actions.pod:1506
7031 msgid "guestfs_file"
7035 #: ../src/guestfs-actions.pod:1508
7039 " guestfs_file (guestfs_h *g,\n"
7040 " const char *path);\n"
7045 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
7047 "This call uses the standard L<file(1)> command to determine the type or "
7048 "contents of the file."
7052 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
7054 "This call will also transparently look inside various types of compressed "
7059 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
7061 "The exact command which runs is C<file -zb path>. Note in particular that "
7062 "the filename is not prepended to the output (the C<-b> option)."
7066 #: ../src/guestfs-actions.pod:1522
7068 "This command can also be used on C</dev/> devices (and partitions, LV "
7069 "names). You can for example use this to determine if a device contains a "
7070 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7074 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
7076 "If the C<path> does not begin with C</dev/> then this command only works for "
7077 "the content of regular files. For other file types (directory, symbolic "
7078 "link etc) it will just return the string C<directory> etc."
7082 #: ../src/guestfs-actions.pod:1537
7083 msgid "guestfs_file_architecture"
7087 #: ../src/guestfs-actions.pod:1539
7091 " guestfs_file_architecture (guestfs_h *g,\n"
7092 " const char *filename);\n"
7097 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
7099 "This detects the architecture of the binary C<filename>, and returns it if "
7104 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
7105 msgid "Currently defined architectures are:"
7109 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
7114 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
7116 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7117 "irrespective of the precise processor requirements of the binary."
7121 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
7126 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
7127 msgid "64 bit x86-64."
7131 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
7136 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
7137 msgid "32 bit SPARC."
7141 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
7146 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
7147 msgid "64 bit SPARC V9 and above."
7151 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
7156 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
7157 msgid "Intel Itanium."
7161 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
7166 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
7167 msgid "32 bit Power PC."
7171 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
7176 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
7177 msgid "64 bit Power PC."
7181 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
7182 msgid "Libguestfs may return other architecture strings in future."
7186 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
7187 msgid "The function works on at least the following types of files:"
7191 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
7192 msgid "many types of Un*x and Linux binary"
7196 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
7197 msgid "many types of Un*x and Linux shared library"
7201 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
7202 msgid "Windows Win32 and Win64 binaries"
7206 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
7207 msgid "Windows Win32 and Win64 DLLs"
7211 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
7212 msgid "Win32 binaries and DLLs return C<i386>."
7216 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
7217 msgid "Win64 binaries and DLLs return C<x86_64>."
7221 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
7222 msgid "Linux kernel modules"
7226 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
7227 msgid "Linux new-style initrd images"
7231 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
7232 msgid "some non-x86 Linux vmlinuz kernels"
7236 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
7237 msgid "What it can't do currently:"
7241 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
7242 msgid "static libraries (libfoo.a)"
7246 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
7247 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7251 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7252 msgid "x86 Linux vmlinuz kernels"
7256 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7258 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7259 "compressed code, and are horribly hard to unpack. If you want to find the "
7260 "architecture of a kernel, use the architecture of the associated initrd or "
7261 "kernel module(s) instead."
7265 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7266 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7267 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
7268 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653
7269 #: ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766
7270 #: ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997
7271 #: ../src/guestfs-actions.pod:3129
7272 msgid "(Added in 1.5.3)"
7276 #: ../src/guestfs-actions.pod:1649
7277 msgid "guestfs_filesize"
7281 #: ../src/guestfs-actions.pod:1651
7285 " guestfs_filesize (guestfs_h *g,\n"
7286 " const char *file);\n"
7291 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7292 msgid "This command returns the size of C<file> in bytes."
7296 #: ../src/guestfs-actions.pod:1657
7298 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7299 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7300 "devices, use C<guestfs_blockdev_getsize64>."
7304 #: ../src/guestfs-actions.pod:1663
7305 msgid "(Added in 1.0.82)"
7309 #: ../src/guestfs-actions.pod:1665
7310 msgid "guestfs_fill"
7314 #: ../src/guestfs-actions.pod:1667
7318 " guestfs_fill (guestfs_h *g,\n"
7321 " const char *path);\n"
7326 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7328 "This command creates a new file called C<path>. The initial content of the "
7329 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7334 #: ../src/guestfs-actions.pod:1677
7336 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7337 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7338 "bytes use C<guestfs_fill_pattern>."
7342 #: ../src/guestfs-actions.pod:1689
7343 msgid "(Added in 1.0.79)"
7347 #: ../src/guestfs-actions.pod:1691
7348 msgid "guestfs_fill_pattern"
7352 #: ../src/guestfs-actions.pod:1693
7356 " guestfs_fill_pattern (guestfs_h *g,\n"
7357 " const char *pattern,\n"
7359 " const char *path);\n"
7364 #: ../src/guestfs-actions.pod:1699
7366 "This function is like C<guestfs_fill> except that it creates a new file of "
7367 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7368 "pattern is truncated if necessary to ensure the length of the file is "
7369 "exactly C<len> bytes."
7373 #: ../src/guestfs-actions.pod:1711
7374 msgid "(Added in 1.3.12)"
7378 #: ../src/guestfs-actions.pod:1713
7379 msgid "guestfs_find"
7383 #: ../src/guestfs-actions.pod:1715
7387 " guestfs_find (guestfs_h *g,\n"
7388 " const char *directory);\n"
7393 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7395 "This command lists out all files and directories, recursively, starting at "
7396 "C<directory>. It is essentially equivalent to running the shell command "
7397 "C<find directory -print> but some post-processing happens on the output, "
7402 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7404 "This returns a list of strings I<without any prefix>. Thus if the directory "
7409 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7419 #: ../src/guestfs-actions.pod:1731
7421 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7425 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7436 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7437 msgid "If C<directory> is not a directory, then this command returns an error."
7441 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7442 msgid "The returned list is sorted."
7446 #: ../src/guestfs-actions.pod:1744
7447 msgid "See also C<guestfs_find0>."
7451 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788
7452 #: ../src/guestfs-actions.pod:5249
7453 msgid "(Added in 1.0.27)"
7457 #: ../src/guestfs-actions.pod:1755
7458 msgid "guestfs_find0"
7462 #: ../src/guestfs-actions.pod:1757
7466 " guestfs_find0 (guestfs_h *g,\n"
7467 " const char *directory,\n"
7468 " const char *files);\n"
7473 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7475 "This command lists out all files and directories, recursively, starting at "
7476 "C<directory>, placing the resulting list in the external file called "
7481 #: ../src/guestfs-actions.pod:1766
7483 "This command works the same way as C<guestfs_find> with the following "
7488 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7489 msgid "The resulting list is written to an external file."
7493 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7495 "Items (filenames) in the result are separated by C<\\0> characters. See "
7496 "L<find(1)> option I<-print0>."
7500 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7501 msgid "This command is not limited in the number of names that it can return."
7505 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7506 msgid "The result list is not sorted."
7510 #: ../src/guestfs-actions.pod:1793
7511 msgid "(Added in 1.0.74)"
7515 #: ../src/guestfs-actions.pod:1795
7516 msgid "guestfs_findfs_label"
7520 #: ../src/guestfs-actions.pod:1797
7524 " guestfs_findfs_label (guestfs_h *g,\n"
7525 " const char *label);\n"
7530 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7532 "This command searches the filesystems and returns the one which has the "
7533 "given label. An error is returned if no such filesystem can be found."
7537 #: ../src/guestfs-actions.pod:1805
7538 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7542 #: ../src/guestfs-actions.pod:1812
7543 msgid "guestfs_findfs_uuid"
7547 #: ../src/guestfs-actions.pod:1814
7551 " guestfs_findfs_uuid (guestfs_h *g,\n"
7552 " const char *uuid);\n"
7557 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7559 "This command searches the filesystems and returns the one which has the "
7560 "given UUID. An error is returned if no such filesystem can be found."
7564 #: ../src/guestfs-actions.pod:1822
7565 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7569 #: ../src/guestfs-actions.pod:1829
7570 msgid "guestfs_fsck"
7574 #: ../src/guestfs-actions.pod:1831
7578 " guestfs_fsck (guestfs_h *g,\n"
7579 " const char *fstype,\n"
7580 " const char *device);\n"
7585 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7587 "This runs the filesystem checker (fsck) on C<device> which should have "
7588 "filesystem type C<fstype>."
7592 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7594 "The returned integer is the status. See L<fsck(8)> for the list of status "
7595 "codes from C<fsck>."
7599 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7600 msgid "Multiple status codes can be summed together."
7604 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7606 "A non-zero return code can mean \"success\", for example if errors have been "
7607 "corrected on the filesystem."
7611 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7612 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7616 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7618 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7622 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7623 msgid "(Added in 1.0.16)"
7627 #: ../src/guestfs-actions.pod:1868
7628 msgid "guestfs_get_append"
7632 #: ../src/guestfs-actions.pod:1870
7636 " guestfs_get_append (guestfs_h *g);\n"
7641 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7643 "Return the additional kernel options which are added to the guest kernel "
7648 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7649 msgid "If C<NULL> then no options are added."
7653 #: ../src/guestfs-actions.pod:1878
7655 "This function returns a string which may be NULL. There is no way to return "
7656 "an error from this function. The string is owned by the guest handle and "
7657 "must I<not> be freed."
7661 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927
7662 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758
7663 #: ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793
7664 #: ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557
7665 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7666 msgid "(Added in 1.0.26)"
7670 #: ../src/guestfs-actions.pod:1884
7671 msgid "guestfs_get_autosync"
7675 #: ../src/guestfs-actions.pod:1886
7679 " guestfs_get_autosync (guestfs_h *g);\n"
7684 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7685 msgid "Get the autosync flag."
7689 #: ../src/guestfs-actions.pod:1895
7690 msgid "guestfs_get_direct"
7694 #: ../src/guestfs-actions.pod:1897
7698 " guestfs_get_direct (guestfs_h *g);\n"
7703 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7704 msgid "Return the direct appliance mode flag."
7708 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7709 msgid "(Added in 1.0.72)"
7713 #: ../src/guestfs-actions.pod:1906
7714 msgid "guestfs_get_e2label"
7718 #: ../src/guestfs-actions.pod:1908
7722 " guestfs_get_e2label (guestfs_h *g,\n"
7723 " const char *device);\n"
7728 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7730 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7734 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7736 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7740 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7741 #: ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7742 msgid "(Added in 1.0.15)"
7746 #: ../src/guestfs-actions.pod:1927
7747 msgid "guestfs_get_e2uuid"
7751 #: ../src/guestfs-actions.pod:1929
7755 " guestfs_get_e2uuid (guestfs_h *g,\n"
7756 " const char *device);\n"
7761 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7763 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7767 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7769 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7773 #: ../src/guestfs-actions.pod:1948
7774 msgid "guestfs_get_memsize"
7778 #: ../src/guestfs-actions.pod:1950
7782 " guestfs_get_memsize (guestfs_h *g);\n"
7787 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7789 "This gets the memory size in megabytes allocated to the qemu subprocess."
7793 #: ../src/guestfs-actions.pod:1956
7795 "If C<guestfs_set_memsize> was not called on this handle, and if "
7796 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7797 "value for memsize."
7801 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7802 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591
7803 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7804 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7806 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7810 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079
7811 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213
7812 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244
7813 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274
7814 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489
7815 #: ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7816 msgid "(Added in 1.0.55)"
7820 #: ../src/guestfs-actions.pod:1967
7821 msgid "guestfs_get_network"
7825 #: ../src/guestfs-actions.pod:1969
7829 " guestfs_get_network (guestfs_h *g);\n"
7834 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7835 msgid "This returns the enable network flag."
7839 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7840 msgid "(Added in 1.5.4)"
7844 #: ../src/guestfs-actions.pod:1978
7845 msgid "guestfs_get_path"
7849 #: ../src/guestfs-actions.pod:1980
7853 " guestfs_get_path (guestfs_h *g);\n"
7858 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7859 msgid "Return the current search path."
7863 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7865 "This is always non-NULL. If it wasn't set already, then this will return "
7870 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7872 "This function returns a string, or NULL on error. The string is owned by "
7873 "the guest handle and must I<not> be freed."
7877 #: ../src/guestfs-actions.pod:1993
7878 msgid "guestfs_get_pid"
7882 #: ../src/guestfs-actions.pod:1995
7886 " guestfs_get_pid (guestfs_h *g);\n"
7891 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7893 "Return the process ID of the qemu subprocess. If there is no qemu "
7894 "subprocess, then this will return an error."
7898 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7899 msgid "This is an internal call used for debugging and testing."
7903 #: ../src/guestfs-actions.pod:2005
7904 msgid "(Added in 1.0.56)"
7908 #: ../src/guestfs-actions.pod:2007
7909 msgid "guestfs_get_qemu"
7913 #: ../src/guestfs-actions.pod:2009
7917 " guestfs_get_qemu (guestfs_h *g);\n"
7922 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7923 msgid "Return the current qemu binary."
7927 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7929 "This is always non-NULL. If it wasn't set already, then this will return "
7930 "the default qemu binary name."
7934 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7935 msgid "(Added in 1.0.6)"
7939 #: ../src/guestfs-actions.pod:2022
7940 msgid "guestfs_get_recovery_proc"
7944 #: ../src/guestfs-actions.pod:2024
7948 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7953 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7954 msgid "Return the recovery process enabled flag."
7958 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219
7959 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886
7960 #: ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857
7961 #: ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577
7962 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256
7963 #: ../src/guestfs-actions.pod:6438
7964 msgid "(Added in 1.0.77)"
7968 #: ../src/guestfs-actions.pod:2033
7969 msgid "guestfs_get_selinux"
7973 #: ../src/guestfs-actions.pod:2035
7977 " guestfs_get_selinux (guestfs_h *g);\n"
7982 #: ../src/guestfs-actions.pod:2038
7984 "This returns the current setting of the selinux flag which is passed to the "
7985 "appliance at boot time. See C<guestfs_set_selinux>."
7989 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7990 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7991 msgid "(Added in 1.0.67)"
7995 #: ../src/guestfs-actions.pod:2048
7996 msgid "guestfs_get_state"
8000 #: ../src/guestfs-actions.pod:2050
8004 " guestfs_get_state (guestfs_h *g);\n"
8009 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
8011 "This returns the current state as an opaque integer. This is only useful "
8012 "for printing debug and internal error messages."
8016 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022
8017 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112
8018 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:1398
8019 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8020 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8021 msgid "For more information on states, see L<guestfs(3)>."
8025 #: ../src/guestfs-actions.pod:2062
8026 msgid "guestfs_get_trace"
8030 #: ../src/guestfs-actions.pod:2064
8034 " guestfs_get_trace (guestfs_h *g);\n"
8039 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
8040 msgid "Return the command trace flag."
8044 #: ../src/guestfs-actions.pod:2073
8045 msgid "guestfs_get_umask"
8049 #: ../src/guestfs-actions.pod:2075
8053 " guestfs_get_umask (guestfs_h *g);\n"
8058 #: ../src/guestfs-actions.pod:2078
8060 "Return the current umask. By default the umask is C<022> unless it has been "
8061 "set by calling C<guestfs_umask>."
8065 #: ../src/guestfs-actions.pod:2085
8066 msgid "guestfs_get_verbose"
8070 #: ../src/guestfs-actions.pod:2087
8074 " guestfs_get_verbose (guestfs_h *g);\n"
8079 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
8080 msgid "This returns the verbose messages flag."
8084 #: ../src/guestfs-actions.pod:2096
8085 msgid "guestfs_getcon"
8089 #: ../src/guestfs-actions.pod:2098
8093 " guestfs_getcon (guestfs_h *g);\n"
8098 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
8099 msgid "This gets the SELinux security context of the daemon."
8103 #: ../src/guestfs-actions.pod:2103
8105 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8109 #: ../src/guestfs-actions.pod:2111
8110 msgid "guestfs_getxattrs"
8114 #: ../src/guestfs-actions.pod:2113
8117 " struct guestfs_xattr_list *\n"
8118 " guestfs_getxattrs (guestfs_h *g,\n"
8119 " const char *path);\n"
8124 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
8126 "This call lists the extended attributes of the file or directory C<path>."
8130 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
8132 "At the system call level, this is a combination of the L<listxattr(2)> and "
8133 "L<getxattr(2)> calls."
8137 #: ../src/guestfs-actions.pod:2123
8138 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8142 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231
8143 #: ../src/guestfs-actions.pod:3882
8145 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8146 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8150 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235
8151 #: ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436
8152 #: ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669
8153 #: ../src/guestfs-actions.pod:6994
8154 msgid "(Added in 1.0.59)"
8158 #: ../src/guestfs-actions.pod:2131
8159 msgid "guestfs_glob_expand"
8163 #: ../src/guestfs-actions.pod:2133
8167 " guestfs_glob_expand (guestfs_h *g,\n"
8168 " const char *pattern);\n"
8173 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
8175 "This command searches for all the pathnames matching C<pattern> according to "
8176 "the wildcard expansion rules used by the shell."
8180 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
8182 "If no paths match, then this returns an empty list (note: not an error)."
8186 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
8188 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8189 "GLOB_BRACE>. See that manual page for more details."
8193 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834
8194 #: ../src/guestfs-actions.pod:5851
8195 msgid "(Added in 1.0.50)"
8199 #: ../src/guestfs-actions.pod:2154
8200 msgid "guestfs_grep"
8204 #: ../src/guestfs-actions.pod:2156
8208 " guestfs_grep (guestfs_h *g,\n"
8209 " const char *regex,\n"
8210 " const char *path);\n"
8215 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
8216 msgid "This calls the external C<grep> program and returns the matching lines."
8220 #: ../src/guestfs-actions.pod:2173
8221 msgid "guestfs_grepi"
8225 #: ../src/guestfs-actions.pod:2175
8229 " guestfs_grepi (guestfs_h *g,\n"
8230 " const char *regex,\n"
8231 " const char *path);\n"
8236 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
8238 "This calls the external C<grep -i> program and returns the matching lines."
8242 #: ../src/guestfs-actions.pod:2192
8243 msgid "guestfs_grub_install"
8247 #: ../src/guestfs-actions.pod:2194
8251 " guestfs_grub_install (guestfs_h *g,\n"
8252 " const char *root,\n"
8253 " const char *device);\n"
8258 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8260 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8261 "the root directory being C<root>."
8265 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8267 "Note: If grub-install reports the error \"No suitable drive was found in the "
8268 "generated device map.\" it may be that you need to create a C</boot/grub/"
8269 "device.map> file first that contains the mapping between grub device names "
8270 "and Linux device names. It is usually sufficient to create a file "
8275 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8283 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8284 msgid "replacing C</dev/vda> with the name of the installation device."
8288 #: ../src/guestfs-actions.pod:2215
8289 msgid "(Added in 1.0.17)"
8293 #: ../src/guestfs-actions.pod:2217
8294 msgid "guestfs_head"
8298 #: ../src/guestfs-actions.pod:2219
8302 " guestfs_head (guestfs_h *g,\n"
8303 " const char *path);\n"
8308 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8310 "This command returns up to the first 10 lines of a file as a list of strings."
8314 #: ../src/guestfs-actions.pod:2235
8315 msgid "guestfs_head_n"
8319 #: ../src/guestfs-actions.pod:2237
8323 " guestfs_head_n (guestfs_h *g,\n"
8325 " const char *path);\n"
8330 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8332 "If the parameter C<nrlines> is a positive number, this returns the first "
8333 "C<nrlines> lines of the file C<path>."
8337 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8339 "If the parameter C<nrlines> is a negative number, this returns lines from "
8340 "the file C<path>, excluding the last C<nrlines> lines."
8344 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131
8345 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8346 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8350 #: ../src/guestfs-actions.pod:2259
8351 msgid "guestfs_hexdump"
8355 #: ../src/guestfs-actions.pod:2261
8359 " guestfs_hexdump (guestfs_h *g,\n"
8360 " const char *path);\n"
8365 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8367 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8368 "readable, canonical hex dump of the file."
8372 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915
8373 #: ../src/guestfs-actions.pod:5970
8374 msgid "(Added in 1.0.22)"
8378 #: ../src/guestfs-actions.pod:2276
8379 msgid "guestfs_initrd_cat"
8383 #: ../src/guestfs-actions.pod:2278
8387 " guestfs_initrd_cat (guestfs_h *g,\n"
8388 " const char *initrdpath,\n"
8389 " const char *filename,\n"
8390 " size_t *size_r);\n"
8395 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8397 "This command unpacks the file C<filename> from the initrd file called "
8398 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8403 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8405 "For example, in guestfish you could use the following command to examine the "
8406 "boot script (usually called C</init>) contained in a Linux initrd or "
8411 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8414 " initrd-cat /boot/initrd-<version>.img init\n"
8419 #: ../src/guestfs-actions.pod:2294
8420 msgid "See also C<guestfs_initrd_list>."
8424 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850
8425 #: ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8427 "This function returns a buffer, or NULL on error. The size of the returned "
8428 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8433 #: ../src/guestfs-actions.pod:2305
8434 msgid "guestfs_initrd_list"
8438 #: ../src/guestfs-actions.pod:2307
8442 " guestfs_initrd_list (guestfs_h *g,\n"
8443 " const char *path);\n"
8448 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8449 msgid "This command lists out files contained in an initrd."
8453 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8455 "The files are listed without any initial C</> character. The files are "
8456 "listed in the order they appear (not necessarily alphabetical). Directory "
8457 "names are listed as separate items."
8461 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8463 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8464 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8469 #: ../src/guestfs-actions.pod:2327
8470 msgid "guestfs_inotify_add_watch"
8474 #: ../src/guestfs-actions.pod:2329
8478 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8479 " const char *path,\n"
8485 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8486 msgid "Watch C<path> for the events listed in C<mask>."
8490 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8492 "Note that if C<path> is a directory then events within that directory are "
8493 "watched, but this does I<not> happen recursively (in subdirectories)."
8497 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8499 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8500 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8504 #: ../src/guestfs-actions.pod:2348
8505 msgid "guestfs_inotify_close"
8509 #: ../src/guestfs-actions.pod:2350
8513 " guestfs_inotify_close (guestfs_h *g);\n"
8518 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8520 "This closes the inotify handle which was previously opened by inotify_init. "
8521 "It removes all watches, throws away any pending events, and deallocates all "
8526 #: ../src/guestfs-actions.pod:2361
8527 msgid "guestfs_inotify_files"
8531 #: ../src/guestfs-actions.pod:2363
8535 " guestfs_inotify_files (guestfs_h *g);\n"
8540 #: ../src/guestfs-actions.pod:2366
8542 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8543 "returns a list of pathnames of objects that were touched. The returned "
8544 "pathnames are sorted and deduplicated."
8548 #: ../src/guestfs-actions.pod:2376
8549 msgid "guestfs_inotify_init"
8553 #: ../src/guestfs-actions.pod:2378
8557 " guestfs_inotify_init (guestfs_h *g,\n"
8558 " int maxevents);\n"
8563 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8565 "This command creates a new inotify handle. The inotify subsystem can be "
8566 "used to notify events which happen to objects in the guest filesystem."
8570 #: ../src/guestfs-actions.pod:2386
8572 "C<maxevents> is the maximum number of events which will be queued up between "
8573 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8574 "passed as C<0>, then the kernel (or previously set) default is used. For "
8575 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8576 "throws away events, but records the fact that it threw them away by setting "
8577 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8578 "C<guestfs_inotify_read>)."
8582 #: ../src/guestfs-actions.pod:2396
8584 "Before any events are generated, you have to add some watches to the "
8585 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8586 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8590 #: ../src/guestfs-actions.pod:2402
8592 "Queued up events should be read periodically by calling "
8593 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8594 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8595 "often enough then you risk the internal queue overflowing."
8599 #: ../src/guestfs-actions.pod:2409
8601 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8602 "This also removes any watches automatically."
8606 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8608 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8609 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8610 "that there is one global inotify handle per libguestfs instance."
8614 #: ../src/guestfs-actions.pod:2422
8615 msgid "guestfs_inotify_read"
8619 #: ../src/guestfs-actions.pod:2424
8622 " struct guestfs_inotify_event_list *\n"
8623 " guestfs_inotify_read (guestfs_h *g);\n"
8628 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8630 "Return the complete queue of events that have happened since the previous "
8635 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8636 msgid "If no events have happened, this returns an empty list."
8640 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8642 "I<Note>: In order to make sure that all events have been read, you must call "
8643 "this function repeatedly until it returns an empty list. The reason is that "
8644 "the call will read events up to the maximum appliance-to-host message size "
8645 "and leave remaining events in the queue."
8649 #: ../src/guestfs-actions.pod:2438
8651 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8652 "there was an error. I<The caller must call "
8653 "C<guestfs_free_inotify_event_list> after use>."
8657 #: ../src/guestfs-actions.pod:2444
8658 msgid "guestfs_inotify_rm_watch"
8662 #: ../src/guestfs-actions.pod:2446
8666 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8672 #: ../src/guestfs-actions.pod:2450
8674 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8678 #: ../src/guestfs-actions.pod:2457
8679 msgid "guestfs_inspect_get_arch"
8683 #: ../src/guestfs-actions.pod:2459
8687 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8688 " const char *root);\n"
8693 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8694 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593
8695 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640
8696 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694
8697 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750
8698 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834
8699 #: ../src/guestfs-actions.pod:2857
8701 "This function should only be called with a root device string as returned by "
8702 "C<guestfs_inspect_os>."
8706 #: ../src/guestfs-actions.pod:2466
8708 "This returns the architecture of the inspected operating system. The "
8709 "possible return values are listed under C<guestfs_file_architecture>."
8713 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8715 "If the architecture could not be determined, then the string C<unknown> is "
8720 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554
8721 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628
8722 #: ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739
8723 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780
8724 #: ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844
8725 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989
8726 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8727 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8728 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8729 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8730 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8731 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8732 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8736 #: ../src/guestfs-actions.pod:2480
8737 msgid "guestfs_inspect_get_distro"
8741 #: ../src/guestfs-actions.pod:2482
8745 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8746 " const char *root);\n"
8751 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8753 "This returns the distro (distribution) of the inspected operating system."
8757 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8758 msgid "Currently defined distros are:"
8762 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8763 msgid "\"archlinux\""
8767 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8772 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8777 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8782 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8787 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8792 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8797 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8802 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8803 msgid "\"linuxmint\""
8807 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8812 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8813 msgid "\"mandriva\""
8817 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8822 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8827 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8832 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8837 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8842 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8843 msgid "\"redhat-based\""
8847 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8848 msgid "Some Red Hat-derived distro."
8852 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8857 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8858 msgid "Red Hat Enterprise Linux and some derivatives."
8862 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8867 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8872 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812
8873 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8878 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8879 msgid "The distro could not be determined."
8883 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804
8884 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8889 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8891 "Windows does not have distributions. This string is returned if the OS type "
8896 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818
8897 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8899 "Future versions of libguestfs may return other strings here. The caller "
8900 "should be prepared to handle any string."
8904 #: ../src/guestfs-actions.pod:2561
8905 msgid "guestfs_inspect_get_filesystems"
8909 #: ../src/guestfs-actions.pod:2563
8913 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8914 " const char *root);\n"
8919 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8921 "This returns a list of all the filesystems that we think are associated with "
8922 "this operating system. This includes the root filesystem, other ordinary "
8923 "filesystems, and non-mounted devices like swap partitions."
8927 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8929 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8930 "to be shared between operating systems."
8934 #: ../src/guestfs-actions.pod:2578
8936 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8937 "C<guestfs_inspect_get_mountpoints>."
8941 #: ../src/guestfs-actions.pod:2587
8942 msgid "guestfs_inspect_get_hostname"
8946 #: ../src/guestfs-actions.pod:2589
8950 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8951 " const char *root);\n"
8956 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8958 "This function returns the hostname of the operating system as found by "
8959 "inspection of the guest's configuration files."
8963 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8965 "If the hostname could not be determined, then the string C<unknown> is "
8970 #: ../src/guestfs-actions.pod:2607
8971 msgid "guestfs_inspect_get_major_version"
8975 #: ../src/guestfs-actions.pod:2609
8979 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8980 " const char *root);\n"
8985 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8987 "This returns the major version number of the inspected operating system."
8991 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
8993 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8994 "popular public names used by the operating system. Notably the operating "
8995 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8996 "1). You can find out the real versions corresponding to releases of Windows "
8997 "by consulting Wikipedia or MSDN."
9001 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646
9002 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
9003 msgid "If the version could not be determined, then C<0> is returned."
9007 #: ../src/guestfs-actions.pod:2634
9008 msgid "guestfs_inspect_get_minor_version"
9012 #: ../src/guestfs-actions.pod:2636
9016 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9017 " const char *root);\n"
9022 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
9024 "This returns the minor version number of the inspected operating system."
9028 #: ../src/guestfs-actions.pod:2648
9030 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9031 "C<guestfs_inspect_get_major_version>."
9035 #: ../src/guestfs-actions.pod:2655
9036 msgid "guestfs_inspect_get_mountpoints"
9040 #: ../src/guestfs-actions.pod:2657
9044 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9045 " const char *root);\n"
9050 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
9052 "This returns a hash of where we think the filesystems associated with this "
9053 "operating system should be mounted. Callers should note that this is at "
9054 "best an educated guess made by reading configuration files such as C</etc/"
9059 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
9061 "Each element in the returned hashtable has a key which is the path of the "
9062 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9063 "mounted there (eg. C</dev/sda1>)."
9067 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
9069 "Non-mounted devices such as swap devices are I<not> returned in this list."
9073 #: ../src/guestfs-actions.pod:2677
9075 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9076 "C<guestfs_inspect_get_filesystems>."
9080 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288
9081 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
9083 "This function returns a NULL-terminated array of strings, or NULL if there "
9084 "was an error. The array of strings will always have length C<2n+1>, where "
9085 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9086 "caller must free the strings and the array after use>."
9090 #: ../src/guestfs-actions.pod:2688
9091 msgid "guestfs_inspect_get_package_format"
9095 #: ../src/guestfs-actions.pod:2690
9099 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9100 " const char *root);\n"
9105 #: ../src/guestfs-actions.pod:2697
9107 "This function and C<guestfs_inspect_get_package_management> return the "
9108 "package format and package management tool used by the inspected operating "
9109 "system. For example for Fedora these functions would return C<rpm> (package "
9110 "format) and C<yum> (package management)."
9114 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
9116 "This returns the string C<unknown> if we could not determine the package "
9117 "format I<or> if the operating system does not have a real packaging system "
9122 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
9124 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9125 "Future versions of libguestfs may return other strings."
9129 #: ../src/guestfs-actions.pod:2715
9130 msgid "guestfs_inspect_get_package_management"
9134 #: ../src/guestfs-actions.pod:2717
9138 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9139 " const char *root);\n"
9144 #: ../src/guestfs-actions.pod:2724
9146 "C<guestfs_inspect_get_package_format> and this function return the package "
9147 "format and package management tool used by the inspected operating system. "
9148 "For example for Fedora these functions would return C<rpm> (package format) "
9149 "and C<yum> (package management)."
9153 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
9155 "This returns the string C<unknown> if we could not determine the package "
9156 "management tool I<or> if the operating system does not have a real packaging "
9157 "system (eg. Windows)."
9161 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
9163 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9164 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9165 "libguestfs may return other strings."
9169 #: ../src/guestfs-actions.pod:2744
9170 msgid "guestfs_inspect_get_product_name"
9174 #: ../src/guestfs-actions.pod:2746
9178 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9179 " const char *root);\n"
9184 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
9186 "This returns the product name of the inspected operating system. The "
9187 "product name is generally some freeform string which can be displayed to the "
9188 "user, but should not be parsed by programs."
9192 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
9194 "If the product name could not be determined, then the string C<unknown> is "
9199 #: ../src/guestfs-actions.pod:2768
9200 msgid "guestfs_inspect_get_roots"
9204 #: ../src/guestfs-actions.pod:2770
9208 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9213 #: ../src/guestfs-actions.pod:2773
9215 "This function is a convenient way to get the list of root devices, as "
9216 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9217 "the whole inspection process."
9221 #: ../src/guestfs-actions.pod:2777
9223 "This returns an empty list if either no root devices were found or the "
9224 "caller has not called C<guestfs_inspect_os>."
9228 #: ../src/guestfs-actions.pod:2786
9229 msgid "guestfs_inspect_get_type"
9233 #: ../src/guestfs-actions.pod:2788
9237 " guestfs_inspect_get_type (guestfs_h *g,\n"
9238 " const char *root);\n"
9243 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
9245 "This returns the type of the inspected operating system. Currently defined "
9250 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
9255 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
9256 msgid "Any Linux-based operating system."
9260 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
9261 msgid "Any Microsoft Windows operating system."
9265 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
9270 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
9275 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
9276 msgid "The operating system type could not be determined."
9280 #: ../src/guestfs-actions.pod:2828
9281 msgid "guestfs_inspect_get_windows_systemroot"
9285 #: ../src/guestfs-actions.pod:2830
9289 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9290 " const char *root);\n"
9295 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
9297 "This returns the Windows systemroot of the inspected guest. The systemroot "
9298 "is a directory path such as C</WINDOWS>."
9302 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
9304 "This call assumes that the guest is Windows and that the systemroot could be "
9305 "determined by inspection. If this is not the case then an error is returned."
9309 #: ../src/guestfs-actions.pod:2849
9310 msgid "(Added in 1.5.25)"
9314 #: ../src/guestfs-actions.pod:2851
9315 msgid "guestfs_inspect_list_applications"
9319 #: ../src/guestfs-actions.pod:2853
9322 " struct guestfs_application_list *\n"
9323 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9324 " const char *root);\n"
9329 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
9330 msgid "Return the list of applications installed in the operating system."
9334 #: ../src/guestfs-actions.pod:2862
9336 "I<Note:> This call works differently from other parts of the inspection "
9337 "API. You have to call C<guestfs_inspect_os>, then "
9338 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9339 "this. Listing applications is a significantly more difficult operation "
9340 "which requires access to the full filesystem. Also note that unlike the "
9341 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9342 "the libguestfs handle, this call actually reads parts of the mounted "
9343 "filesystems during the call."
9347 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
9349 "This returns an empty list if the inspection code was not able to determine "
9350 "the list of applications."
9354 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
9355 msgid "The application structure contains the following fields:"
9359 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
9364 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
9366 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9367 "guests, this is the package name."
9371 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
9372 msgid "C<app_display_name>"
9376 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
9378 "The display name of the application, sometimes localized to the install "
9379 "language of the guest operating system."
9383 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
9385 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9386 "to display something can use C<app_name> instead."
9390 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
9391 msgid "C<app_epoch>"
9395 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
9397 "For package managers which use epochs, this contains the epoch of the "
9398 "package (an integer). If unavailable, this is returned as C<0>."
9402 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
9403 msgid "C<app_version>"
9407 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
9409 "The version string of the application or package. If unavailable this is "
9410 "returned as an empty string C<\"\">."
9414 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
9415 msgid "C<app_release>"
9419 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
9421 "The release string of the application or package, for package managers that "
9422 "use this. If unavailable this is returned as an empty string C<\"\">."
9426 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
9427 msgid "C<app_install_path>"
9431 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
9433 "The installation path of the application (on operating systems such as "
9434 "Windows which use installation paths). This path is in the format used by "
9435 "the guest operating system, it is not a libguestfs path."
9439 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
9440 msgid "If unavailable this is returned as an empty string C<\"\">."
9444 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
9445 msgid "C<app_trans_path>"
9449 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9451 "The install path translated into a libguestfs path. If unavailable this is "
9452 "returned as an empty string C<\"\">."
9456 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9457 msgid "C<app_publisher>"
9461 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9463 "The name of the publisher of the application, for package managers that use "
9464 "this. If unavailable this is returned as an empty string C<\"\">."
9468 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9473 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9475 "The URL (eg. upstream URL) of the application. If unavailable this is "
9476 "returned as an empty string C<\"\">."
9480 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9481 msgid "C<app_source_package>"
9485 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9487 "For packaging systems which support this, the name of the source package. "
9488 "If unavailable this is returned as an empty string C<\"\">."
9492 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9493 msgid "C<app_summary>"
9497 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9499 "A short (usually one line) description of the application or package. If "
9500 "unavailable this is returned as an empty string C<\"\">."
9504 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9505 msgid "C<app_description>"
9509 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9511 "A longer description of the application or package. If unavailable this is "
9512 "returned as an empty string C<\"\">."
9516 #: ../src/guestfs-actions.pod:2952
9518 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9519 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9524 #: ../src/guestfs-actions.pod:2956
9525 msgid "guestfs_inspect_os"
9529 #: ../src/guestfs-actions.pod:2958
9533 " guestfs_inspect_os (guestfs_h *g);\n"
9538 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9540 "This function uses other libguestfs functions and certain heuristics to "
9541 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9542 "for operating systems."
9546 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9547 msgid "The list returned is empty if no operating systems were found."
9551 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9553 "If one operating system was found, then this returns a list with a single "
9554 "element, which is the name of the root filesystem of this operating system. "
9555 "It is also possible for this function to return a list containing more than "
9556 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9557 "element being the root filesystem of one of the operating systems."
9561 #: ../src/guestfs-actions.pod:2974
9563 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9564 "functions in order to query further information about each operating system, "
9565 "such as the name and version."
9569 #: ../src/guestfs-actions.pod:2979
9571 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9572 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9573 "the contents. This should be called with no disks currently mounted. The "
9574 "function may also use Augeas, so any existing Augeas handle will be closed."
9578 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9580 "This function cannot decrypt encrypted disks. The caller must do that first "
9581 "(supplying the necessary keys) if the disk is encrypted."
9585 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246
9586 #: ../src/guestfs-actions.pod:3308
9587 msgid "See also C<guestfs_list_filesystems>."
9591 #: ../src/guestfs-actions.pod:2999
9592 msgid "guestfs_is_blockdev"
9596 #: ../src/guestfs-actions.pod:3001
9600 " guestfs_is_blockdev (guestfs_h *g,\n"
9601 " const char *path);\n"
9606 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9608 "This returns C<true> if and only if there is a block device with the given "
9613 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037
9614 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082
9615 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154
9616 #: ../src/guestfs-actions.pod:3169
9617 msgid "See also C<guestfs_stat>."
9621 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041
9622 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158
9623 #: ../src/guestfs-actions.pod:3173
9624 msgid "(Added in 1.5.10)"
9628 #: ../src/guestfs-actions.pod:3014
9629 msgid "guestfs_is_busy"
9633 #: ../src/guestfs-actions.pod:3016
9637 " guestfs_is_busy (guestfs_h *g);\n"
9642 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9644 "This returns true iff this handle is busy processing a command (in the "
9649 #: ../src/guestfs-actions.pod:3028
9650 msgid "guestfs_is_chardev"
9654 #: ../src/guestfs-actions.pod:3030
9658 " guestfs_is_chardev (guestfs_h *g,\n"
9659 " const char *path);\n"
9664 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9666 "This returns C<true> if and only if there is a character device with the "
9667 "given C<path> name."
9671 #: ../src/guestfs-actions.pod:3043
9672 msgid "guestfs_is_config"
9676 #: ../src/guestfs-actions.pod:3045
9680 " guestfs_is_config (guestfs_h *g);\n"
9685 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9687 "This returns true iff this handle is being configured (in the C<CONFIG> "
9692 #: ../src/guestfs-actions.pod:3057
9693 msgid "guestfs_is_dir"
9697 #: ../src/guestfs-actions.pod:3059
9701 " guestfs_is_dir (guestfs_h *g,\n"
9702 " const char *path);\n"
9707 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9709 "This returns C<true> if and only if there is a directory with the given "
9710 "C<path> name. Note that it returns false for other objects like files."
9714 #: ../src/guestfs-actions.pod:3073
9715 msgid "guestfs_is_fifo"
9719 #: ../src/guestfs-actions.pod:3075
9723 " guestfs_is_fifo (guestfs_h *g,\n"
9724 " const char *path);\n"
9729 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9731 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9732 "given C<path> name."
9736 #: ../src/guestfs-actions.pod:3088
9737 msgid "guestfs_is_file"
9741 #: ../src/guestfs-actions.pod:3090
9745 " guestfs_is_file (guestfs_h *g,\n"
9746 " const char *path);\n"
9751 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9753 "This returns C<true> if and only if there is a regular file with the given "
9754 "C<path> name. Note that it returns false for other objects like directories."
9758 #: ../src/guestfs-actions.pod:3104
9759 msgid "guestfs_is_launching"
9763 #: ../src/guestfs-actions.pod:3106
9767 " guestfs_is_launching (guestfs_h *g);\n"
9772 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9774 "This returns true iff this handle is launching the subprocess (in the "
9775 "C<LAUNCHING> state)."
9779 #: ../src/guestfs-actions.pod:3118
9780 msgid "guestfs_is_lv"
9784 #: ../src/guestfs-actions.pod:3120
9788 " guestfs_is_lv (guestfs_h *g,\n"
9789 " const char *device);\n"
9794 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9796 "This command tests whether C<device> is a logical volume, and returns true "
9797 "iff this is the case."
9801 #: ../src/guestfs-actions.pod:3131
9802 msgid "guestfs_is_ready"
9806 #: ../src/guestfs-actions.pod:3133
9810 " guestfs_is_ready (guestfs_h *g);\n"
9815 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9817 "This returns true iff this handle is ready to accept commands (in the "
9822 #: ../src/guestfs-actions.pod:3145
9823 msgid "guestfs_is_socket"
9827 #: ../src/guestfs-actions.pod:3147
9831 " guestfs_is_socket (guestfs_h *g,\n"
9832 " const char *path);\n"
9837 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9839 "This returns C<true> if and only if there is a Unix domain socket with the "
9840 "given C<path> name."
9844 #: ../src/guestfs-actions.pod:3160
9845 msgid "guestfs_is_symlink"
9849 #: ../src/guestfs-actions.pod:3162
9853 " guestfs_is_symlink (guestfs_h *g,\n"
9854 " const char *path);\n"
9859 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9861 "This returns C<true> if and only if there is a symbolic link with the given "
9866 #: ../src/guestfs-actions.pod:3175
9867 msgid "guestfs_kill_subprocess"
9871 #: ../src/guestfs-actions.pod:3177
9875 " guestfs_kill_subprocess (guestfs_h *g);\n"
9880 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9881 msgid "This kills the qemu subprocess. You should never need to call this."
9885 #: ../src/guestfs-actions.pod:3186
9886 msgid "guestfs_launch"
9890 #: ../src/guestfs-actions.pod:3188
9894 " guestfs_launch (guestfs_h *g);\n"
9899 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9901 "Internally libguestfs is implemented by running a virtual machine using "
9906 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9908 "You should call this after configuring the handle (eg. adding drives) but "
9909 "before performing any actions."
9913 #: ../src/guestfs-actions.pod:3201
9914 msgid "guestfs_lchown"
9918 #: ../src/guestfs-actions.pod:3203
9922 " guestfs_lchown (guestfs_h *g,\n"
9925 " const char *path);\n"
9930 #: ../src/guestfs-actions.pod:3209
9932 "Change the file owner to C<owner> and group to C<group>. This is like "
9933 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9934 "changed, not the target."
9938 #: ../src/guestfs-actions.pod:3221
9939 msgid "guestfs_lgetxattrs"
9943 #: ../src/guestfs-actions.pod:3223
9946 " struct guestfs_xattr_list *\n"
9947 " guestfs_lgetxattrs (guestfs_h *g,\n"
9948 " const char *path);\n"
9953 #: ../src/guestfs-actions.pod:3227
9955 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9956 "then it returns the extended attributes of the link itself."
9960 #: ../src/guestfs-actions.pod:3237
9961 msgid "guestfs_list_devices"
9965 #: ../src/guestfs-actions.pod:3239
9969 " guestfs_list_devices (guestfs_h *g);\n"
9974 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9975 msgid "List all the block devices."
9979 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9980 msgid "The full block device names are returned, eg. C</dev/sda>."
9984 #: ../src/guestfs-actions.pod:3254
9985 msgid "guestfs_list_filesystems"
9989 #: ../src/guestfs-actions.pod:3256
9993 " guestfs_list_filesystems (guestfs_h *g);\n"
9998 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
10000 "This inspection command looks for filesystems on partitions, block devices "
10001 "and logical volumes, returning a list of devices containing filesystems and "
10006 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
10008 "The return value is a hash, where the keys are the devices containing "
10009 "filesystems, and the values are the filesystem types. For example:"
10013 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
10016 " \"/dev/sda1\" => \"ntfs\"\n"
10017 " \"/dev/sda2\" => \"ext2\"\n"
10018 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10019 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10024 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
10026 "The value can have the special value \"unknown\", meaning the content of the "
10027 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10031 #: ../src/guestfs-actions.pod:3276
10033 "This command runs other libguestfs commands, which might include "
10034 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10035 "soon after launch and only when nothing is mounted."
10039 #: ../src/guestfs-actions.pod:3280
10041 "Not all of the filesystems returned will be mountable. In particular, swap "
10042 "partitions are returned in the list. Also this command does not check that "
10043 "each filesystem found is valid and mountable, and some filesystems might be "
10044 "mountable but require special options. Filesystems may not all belong to a "
10045 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10049 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
10050 msgid "(Added in 1.5.15)"
10054 #: ../src/guestfs-actions.pod:3296
10055 msgid "guestfs_list_partitions"
10059 #: ../src/guestfs-actions.pod:3298
10063 " guestfs_list_partitions (guestfs_h *g);\n"
10068 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
10069 msgid "List all the partitions detected on all block devices."
10073 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
10074 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10078 #: ../src/guestfs-actions.pod:3305
10080 "This does not return logical volumes. For that you will need to call "
10085 #: ../src/guestfs-actions.pod:3316
10090 #: ../src/guestfs-actions.pod:3318
10094 " guestfs_ll (guestfs_h *g,\n"
10095 " const char *directory);\n"
10100 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
10102 "List the files in C<directory> (relative to the root directory, there is no "
10103 "cwd) in the format of 'ls -la'."
10107 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
10109 "This command is mostly useful for interactive sessions. It is I<not> "
10110 "intended that you try to parse the output string."
10114 #: ../src/guestfs-actions.pod:3333
10119 #: ../src/guestfs-actions.pod:3335
10123 " guestfs_ln (guestfs_h *g,\n"
10124 " const char *target,\n"
10125 " const char *linkname);\n"
10130 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
10131 msgid "This command creates a hard link using the C<ln> command."
10135 #: ../src/guestfs-actions.pod:3346
10136 msgid "guestfs_ln_f"
10140 #: ../src/guestfs-actions.pod:3348
10144 " guestfs_ln_f (guestfs_h *g,\n"
10145 " const char *target,\n"
10146 " const char *linkname);\n"
10151 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
10153 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10154 "option removes the link (C<linkname>) if it exists already."
10158 #: ../src/guestfs-actions.pod:3360
10159 msgid "guestfs_ln_s"
10163 #: ../src/guestfs-actions.pod:3362
10167 " guestfs_ln_s (guestfs_h *g,\n"
10168 " const char *target,\n"
10169 " const char *linkname);\n"
10174 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
10175 msgid "This command creates a symbolic link using the C<ln -s> command."
10179 #: ../src/guestfs-actions.pod:3373
10180 msgid "guestfs_ln_sf"
10184 #: ../src/guestfs-actions.pod:3375
10188 " guestfs_ln_sf (guestfs_h *g,\n"
10189 " const char *target,\n"
10190 " const char *linkname);\n"
10195 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
10197 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10198 "option removes the link (C<linkname>) if it exists already."
10202 #: ../src/guestfs-actions.pod:3387
10203 msgid "guestfs_lremovexattr"
10207 #: ../src/guestfs-actions.pod:3389
10211 " guestfs_lremovexattr (guestfs_h *g,\n"
10212 " const char *xattr,\n"
10213 " const char *path);\n"
10218 #: ../src/guestfs-actions.pod:3394
10220 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10221 "link, then it removes an extended attribute of the link itself."
10225 #: ../src/guestfs-actions.pod:3402
10230 #: ../src/guestfs-actions.pod:3404
10234 " guestfs_ls (guestfs_h *g,\n"
10235 " const char *directory);\n"
10240 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
10242 "List the files in C<directory> (relative to the root directory, there is no "
10243 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10247 #: ../src/guestfs-actions.pod:3412
10249 "This command is mostly useful for interactive sessions. Programs should "
10250 "probably use C<guestfs_readdir> instead."
10254 #: ../src/guestfs-actions.pod:3421
10255 msgid "guestfs_lsetxattr"
10259 #: ../src/guestfs-actions.pod:3423
10263 " guestfs_lsetxattr (guestfs_h *g,\n"
10264 " const char *xattr,\n"
10265 " const char *val,\n"
10267 " const char *path);\n"
10272 #: ../src/guestfs-actions.pod:3430
10274 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10275 "then it sets an extended attribute of the link itself."
10279 #: ../src/guestfs-actions.pod:3438
10280 msgid "guestfs_lstat"
10284 #: ../src/guestfs-actions.pod:3440
10287 " struct guestfs_stat *\n"
10288 " guestfs_lstat (guestfs_h *g,\n"
10289 " const char *path);\n"
10294 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871
10295 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10296 msgid "Returns file information for the given C<path>."
10300 #: ../src/guestfs-actions.pod:3446
10302 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10303 "link, then the link is stat-ed, not the file it refers to."
10307 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
10308 msgid "This is the same as the C<lstat(2)> system call."
10312 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
10314 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10315 "error. I<The caller must call C<guestfs_free_stat> after use>."
10319 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879
10320 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
10321 msgid "(Added in 0.9.2)"
10325 #: ../src/guestfs-actions.pod:3458
10326 msgid "guestfs_lstatlist"
10330 #: ../src/guestfs-actions.pod:3460
10333 " struct guestfs_stat_list *\n"
10334 " guestfs_lstatlist (guestfs_h *g,\n"
10335 " const char *path,\n"
10336 " char *const *names);\n"
10341 #: ../src/guestfs-actions.pod:3465
10343 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10344 "files, where all files are in the directory C<path>. C<names> is the list "
10345 "of files from this directory."
10349 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
10351 "On return you get a list of stat structs, with a one-to-one correspondence "
10352 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10353 "then the C<ino> field of that structure is set to C<-1>."
10357 #: ../src/guestfs-actions.pod:3474
10359 "This call is intended for programs that want to efficiently list a directory "
10360 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10361 "for a similarly efficient call for getting extended attributes. Very long "
10362 "directory listings might cause the protocol message size to be exceeded, "
10363 "causing this call to fail. The caller must split up such requests into "
10364 "smaller groups of names."
10368 #: ../src/guestfs-actions.pod:3482
10370 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10371 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10375 #: ../src/guestfs-actions.pod:3488
10376 msgid "guestfs_luks_add_key"
10380 #: ../src/guestfs-actions.pod:3490
10384 " guestfs_luks_add_key (guestfs_h *g,\n"
10385 " const char *device,\n"
10386 " const char *key,\n"
10387 " const char *newkey,\n"
10393 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
10395 "This command adds a new key on LUKS device C<device>. C<key> is any "
10396 "existing key, and is used to access the device. C<newkey> is the new key to "
10397 "add. C<keyslot> is the key slot that will be replaced."
10401 #: ../src/guestfs-actions.pod:3502
10403 "Note that if C<keyslot> already contains a key, then this command will "
10404 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10408 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548
10409 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591
10410 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
10412 "This function takes a key or passphrase parameter which could contain "
10413 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10418 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552
10419 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
10420 msgid "(Added in 1.5.2)"
10424 #: ../src/guestfs-actions.pod:3514
10425 msgid "guestfs_luks_close"
10429 #: ../src/guestfs-actions.pod:3516
10433 " guestfs_luks_close (guestfs_h *g,\n"
10434 " const char *device);\n"
10439 #: ../src/guestfs-actions.pod:3520
10441 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10442 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10443 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10444 "underlying block device."
10448 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627
10449 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696
10450 #: ../src/guestfs-actions.pod:3744
10451 msgid "(Added in 1.5.1)"
10455 #: ../src/guestfs-actions.pod:3530
10456 msgid "guestfs_luks_format"
10460 #: ../src/guestfs-actions.pod:3532
10464 " guestfs_luks_format (guestfs_h *g,\n"
10465 " const char *device,\n"
10466 " const char *key,\n"
10472 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10474 "This command erases existing data on C<device> and formats the device as a "
10475 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10476 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10480 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568
10481 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568
10482 #: ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706
10483 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755
10484 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433
10485 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10486 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10487 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10488 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10490 "B<This command is dangerous. Without careful use you can easily destroy all "
10495 #: ../src/guestfs-actions.pod:3554
10496 msgid "guestfs_luks_format_cipher"
10500 #: ../src/guestfs-actions.pod:3556
10504 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10505 " const char *device,\n"
10506 " const char *key,\n"
10508 " const char *cipher);\n"
10513 #: ../src/guestfs-actions.pod:3563
10515 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10516 "set the C<cipher> used."
10520 #: ../src/guestfs-actions.pod:3577
10521 msgid "guestfs_luks_kill_slot"
10525 #: ../src/guestfs-actions.pod:3579
10529 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10530 " const char *device,\n"
10531 " const char *key,\n"
10537 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10539 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10540 "device C<device>. C<key> must be one of the I<other> keys."
10544 #: ../src/guestfs-actions.pod:3597
10545 msgid "guestfs_luks_open"
10549 #: ../src/guestfs-actions.pod:3599
10553 " guestfs_luks_open (guestfs_h *g,\n"
10554 " const char *device,\n"
10555 " const char *key,\n"
10556 " const char *mapname);\n"
10561 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10563 "This command opens a block device which has been encrypted according to the "
10564 "Linux Unified Key Setup (LUKS) standard."
10568 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10569 msgid "C<device> is the encrypted block device or partition."
10573 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10575 "The caller must supply one of the keys associated with the LUKS block "
10576 "device, in the C<key> parameter."
10580 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10582 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10583 "writes to this block device are decrypted from and encrypted to the "
10584 "underlying C<device> respectively."
10588 #: ../src/guestfs-actions.pod:3617
10590 "If this block device contains LVM volume groups, then calling "
10591 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10596 #: ../src/guestfs-actions.pod:3629
10597 msgid "guestfs_luks_open_ro"
10601 #: ../src/guestfs-actions.pod:3631
10605 " guestfs_luks_open_ro (guestfs_h *g,\n"
10606 " const char *device,\n"
10607 " const char *key,\n"
10608 " const char *mapname);\n"
10613 #: ../src/guestfs-actions.pod:3637
10615 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10620 #: ../src/guestfs-actions.pod:3648
10621 msgid "guestfs_lvcreate"
10625 #: ../src/guestfs-actions.pod:3650
10629 " guestfs_lvcreate (guestfs_h *g,\n"
10630 " const char *logvol,\n"
10631 " const char *volgroup,\n"
10637 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10639 "This creates an LVM logical volume called C<logvol> on the volume group "
10640 "C<volgroup>, with C<size> megabytes."
10644 #: ../src/guestfs-actions.pod:3663
10645 msgid "guestfs_lvm_canonical_lv_name"
10649 #: ../src/guestfs-actions.pod:3665
10653 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10654 " const char *lvname);\n"
10659 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10661 "This converts alternative naming schemes for LVs that you might find to the "
10662 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10667 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10669 "This command returns an error if the C<lvname> parameter does not refer to a "
10674 #: ../src/guestfs-actions.pod:3676
10675 msgid "See also C<guestfs_is_lv>."
10679 #: ../src/guestfs-actions.pod:3681
10680 msgid "(Added in 1.5.24)"
10684 #: ../src/guestfs-actions.pod:3683
10685 msgid "guestfs_lvm_clear_filter"
10689 #: ../src/guestfs-actions.pod:3685
10693 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10698 #: ../src/guestfs-actions.pod:3688
10700 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10701 "see every block device."
10705 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733
10706 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10708 "This command also clears the LVM cache and performs a volume group scan."
10712 #: ../src/guestfs-actions.pod:3698
10713 msgid "guestfs_lvm_remove_all"
10717 #: ../src/guestfs-actions.pod:3700
10721 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10726 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10728 "This command removes all LVM logical volumes, volume groups and physical "
10733 #: ../src/guestfs-actions.pod:3713
10734 msgid "guestfs_lvm_set_filter"
10738 #: ../src/guestfs-actions.pod:3715
10742 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10743 " char *const *devices);\n"
10748 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10750 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10751 "block devices in the list C<devices>, and will ignore all other attached "
10756 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10758 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10759 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10760 "there are two types of duplication possible: either cloned PVs/VGs which "
10761 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10762 "same name. In normal operation you cannot create this situation, but you "
10763 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10764 "inside the LVM metadata."
10768 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10769 msgid "You can filter whole block devices or individual partitions."
10773 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10775 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10776 "filesystem), even if you are not filtering out that VG."
10780 #: ../src/guestfs-actions.pod:3746
10781 msgid "guestfs_lvremove"
10785 #: ../src/guestfs-actions.pod:3748
10789 " guestfs_lvremove (guestfs_h *g,\n"
10790 " const char *device);\n"
10795 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10797 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10798 "LV, such as C</dev/VG/LV>."
10802 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10804 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10809 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914
10810 #: ../src/guestfs-actions.pod:6644
10811 msgid "(Added in 1.0.13)"
10815 #: ../src/guestfs-actions.pod:3762
10816 msgid "guestfs_lvrename"
10820 #: ../src/guestfs-actions.pod:3764
10824 " guestfs_lvrename (guestfs_h *g,\n"
10825 " const char *logvol,\n"
10826 " const char *newlogvol);\n"
10831 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10832 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10836 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10837 msgid "(Added in 1.0.83)"
10841 #: ../src/guestfs-actions.pod:3775
10842 msgid "guestfs_lvresize"
10846 #: ../src/guestfs-actions.pod:3777
10850 " guestfs_lvresize (guestfs_h *g,\n"
10851 " const char *device,\n"
10857 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10859 "This resizes (expands or shrinks) an existing LVM logical volume to "
10860 "C<mbytes>. When reducing, data in the reduced part is lost."
10864 #: ../src/guestfs-actions.pod:3790
10865 msgid "guestfs_lvresize_free"
10869 #: ../src/guestfs-actions.pod:3792
10873 " guestfs_lvresize_free (guestfs_h *g,\n"
10874 " const char *lv,\n"
10880 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10882 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10883 "remaining free space in the volume group. Commonly you would call this with "
10884 "pc = 100 which expands the logical volume as much as possible, using all "
10885 "remaining free space in the volume group."
10889 #: ../src/guestfs-actions.pod:3805
10890 msgid "(Added in 1.3.3)"
10894 #: ../src/guestfs-actions.pod:3807
10895 msgid "guestfs_lvs"
10899 #: ../src/guestfs-actions.pod:3809
10903 " guestfs_lvs (guestfs_h *g);\n"
10908 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10910 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10915 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10917 "This returns a list of the logical volume device names (eg. C</dev/"
10918 "VolGroup00/LogVol00>)."
10922 #: ../src/guestfs-actions.pod:3818
10923 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10927 #: ../src/guestfs-actions.pod:3826
10928 msgid "guestfs_lvs_full"
10932 #: ../src/guestfs-actions.pod:3828
10935 " struct guestfs_lvm_lv_list *\n"
10936 " guestfs_lvs_full (guestfs_h *g);\n"
10941 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10943 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10944 "(8)> command. The \"full\" version includes all fields."
10948 #: ../src/guestfs-actions.pod:3834
10950 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10951 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10955 #: ../src/guestfs-actions.pod:3840
10956 msgid "guestfs_lvuuid"
10960 #: ../src/guestfs-actions.pod:3842
10964 " guestfs_lvuuid (guestfs_h *g,\n"
10965 " const char *device);\n"
10970 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10971 msgid "This command returns the UUID of the LVM LV C<device>."
10975 #: ../src/guestfs-actions.pod:3853
10976 msgid "guestfs_lxattrlist"
10980 #: ../src/guestfs-actions.pod:3855
10983 " struct guestfs_xattr_list *\n"
10984 " guestfs_lxattrlist (guestfs_h *g,\n"
10985 " const char *path,\n"
10986 " char *const *names);\n"
10991 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
10993 "This call allows you to get the extended attributes of multiple files, where "
10994 "all files are in the directory C<path>. C<names> is the list of files from "
10999 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
11001 "On return you get a flat list of xattr structs which must be interpreted "
11002 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11003 "C<attrval> in this struct is zero-length to indicate there was an error "
11004 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11005 "number (the number of following attributes for this file, which could be C<"
11006 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11007 "for the first named file. This repeats for the second and subsequent files."
11011 #: ../src/guestfs-actions.pod:3874
11013 "This call is intended for programs that want to efficiently list a directory "
11014 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11015 "a similarly efficient call for getting standard stats. Very long directory "
11016 "listings might cause the protocol message size to be exceeded, causing this "
11017 "call to fail. The caller must split up such requests into smaller groups of "
11022 #: ../src/guestfs-actions.pod:3888
11023 msgid "guestfs_mkdir"
11027 #: ../src/guestfs-actions.pod:3890
11031 " guestfs_mkdir (guestfs_h *g,\n"
11032 " const char *path);\n"
11037 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
11038 msgid "Create a directory named C<path>."
11042 #: ../src/guestfs-actions.pod:3900
11043 msgid "guestfs_mkdir_mode"
11047 #: ../src/guestfs-actions.pod:3902
11051 " guestfs_mkdir_mode (guestfs_h *g,\n"
11052 " const char *path,\n"
11058 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
11060 "This command creates a directory, setting the initial permissions of the "
11061 "directory to C<mode>."
11065 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
11067 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11068 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11073 #: ../src/guestfs-actions.pod:3914
11074 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11078 #: ../src/guestfs-actions.pod:3920
11079 msgid "guestfs_mkdir_p"
11083 #: ../src/guestfs-actions.pod:3922
11087 " guestfs_mkdir_p (guestfs_h *g,\n"
11088 " const char *path);\n"
11093 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
11095 "Create a directory named C<path>, creating any parent directories as "
11096 "necessary. This is like the C<mkdir -p> shell command."
11100 #: ../src/guestfs-actions.pod:3933
11101 msgid "guestfs_mkdtemp"
11105 #: ../src/guestfs-actions.pod:3935
11109 " guestfs_mkdtemp (guestfs_h *g,\n"
11110 " const char *template);\n"
11115 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
11117 "This command creates a temporary directory. The C<template> parameter "
11118 "should be a full pathname for the temporary directory name with the final "
11119 "six characters being \"XXXXXX\"."
11123 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
11125 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11126 "being suitable for Windows filesystems."
11130 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
11131 msgid "The name of the temporary directory that was created is returned."
11135 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
11136 msgid "The temporary directory is created with mode 0700 and is owned by root."
11140 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
11142 "The caller is responsible for deleting the temporary directory and its "
11143 "contents after use."
11147 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
11148 msgid "See also: L<mkdtemp(3)>"
11152 #: ../src/guestfs-actions.pod:3963
11153 msgid "guestfs_mke2fs_J"
11157 #: ../src/guestfs-actions.pod:3965
11161 " guestfs_mke2fs_J (guestfs_h *g,\n"
11162 " const char *fstype,\n"
11163 " int blocksize,\n"
11164 " const char *device,\n"
11165 " const char *journal);\n"
11170 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
11172 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11173 "C<journal>. It is equivalent to the command:"
11177 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
11180 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11185 #: ../src/guestfs-actions.pod:3978
11186 msgid "See also C<guestfs_mke2journal>."
11190 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000
11191 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034
11192 #: ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062
11193 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
11194 msgid "(Added in 1.0.68)"
11198 #: ../src/guestfs-actions.pod:3984
11199 msgid "guestfs_mke2fs_JL"
11203 #: ../src/guestfs-actions.pod:3986
11207 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11208 " const char *fstype,\n"
11209 " int blocksize,\n"
11210 " const char *device,\n"
11211 " const char *label);\n"
11216 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
11218 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11219 "the journal labeled C<label>."
11223 #: ../src/guestfs-actions.pod:3996
11224 msgid "See also C<guestfs_mke2journal_L>."
11228 #: ../src/guestfs-actions.pod:4002
11229 msgid "guestfs_mke2fs_JU"
11233 #: ../src/guestfs-actions.pod:4004
11237 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11238 " const char *fstype,\n"
11239 " int blocksize,\n"
11240 " const char *device,\n"
11241 " const char *uuid);\n"
11246 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
11248 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11249 "the journal with UUID C<uuid>."
11253 #: ../src/guestfs-actions.pod:4014
11254 msgid "See also C<guestfs_mke2journal_U>."
11258 #: ../src/guestfs-actions.pod:4020
11259 msgid "guestfs_mke2journal"
11263 #: ../src/guestfs-actions.pod:4022
11267 " guestfs_mke2journal (guestfs_h *g,\n"
11268 " int blocksize,\n"
11269 " const char *device);\n"
11274 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
11276 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11281 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
11284 " mke2fs -O journal_dev -b blocksize device\n"
11289 #: ../src/guestfs-actions.pod:4036
11290 msgid "guestfs_mke2journal_L"
11294 #: ../src/guestfs-actions.pod:4038
11298 " guestfs_mke2journal_L (guestfs_h *g,\n"
11299 " int blocksize,\n"
11300 " const char *label,\n"
11301 " const char *device);\n"
11306 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
11307 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11311 #: ../src/guestfs-actions.pod:4050
11312 msgid "guestfs_mke2journal_U"
11316 #: ../src/guestfs-actions.pod:4052
11320 " guestfs_mke2journal_U (guestfs_h *g,\n"
11321 " int blocksize,\n"
11322 " const char *uuid,\n"
11323 " const char *device);\n"
11328 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
11329 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11333 #: ../src/guestfs-actions.pod:4064
11334 msgid "guestfs_mkfifo"
11338 #: ../src/guestfs-actions.pod:4066
11342 " guestfs_mkfifo (guestfs_h *g,\n"
11344 " const char *path);\n"
11349 #: ../src/guestfs-actions.pod:4071
11351 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11352 "is just a convenient wrapper around C<guestfs_mknod>."
11356 #: ../src/guestfs-actions.pod:4081
11357 msgid "guestfs_mkfs"
11361 #: ../src/guestfs-actions.pod:4083
11365 " guestfs_mkfs (guestfs_h *g,\n"
11366 " const char *fstype,\n"
11367 " const char *device);\n"
11372 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
11374 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11375 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11379 #: ../src/guestfs-actions.pod:4096
11380 msgid "guestfs_mkfs_b"
11384 #: ../src/guestfs-actions.pod:4098
11388 " guestfs_mkfs_b (guestfs_h *g,\n"
11389 " const char *fstype,\n"
11390 " int blocksize,\n"
11391 " const char *device);\n"
11396 #: ../src/guestfs-actions.pod:4104
11398 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11399 "block size of the resulting filesystem. Supported block sizes depend on the "
11400 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11404 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
11406 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11411 #: ../src/guestfs-actions.pod:4116
11412 msgid "guestfs_mkmountpoint"
11416 #: ../src/guestfs-actions.pod:4118
11420 " guestfs_mkmountpoint (guestfs_h *g,\n"
11421 " const char *exemptpath);\n"
11426 #: ../src/guestfs-actions.pod:4122
11428 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11429 "that can be used to create extra mountpoints before mounting the first "
11434 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
11436 "These calls are I<only> necessary in some very limited circumstances, mainly "
11437 "the case where you want to mount a mix of unrelated and/or read-only "
11438 "filesystems together."
11442 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
11444 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11445 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11446 "inside that. You can unpack this as follows in guestfish:"
11450 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
11453 " add-ro Fedora-11-i686-Live.iso\n"
11455 " mkmountpoint /cd\n"
11456 " mkmountpoint /sqsh\n"
11457 " mkmountpoint /ext3fs\n"
11458 " mount /dev/sda /cd\n"
11459 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11460 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11465 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
11466 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11470 #: ../src/guestfs-actions.pod:4146
11472 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11473 "may get unexpected errors if you try to mix these calls. It is safest to "
11474 "manually unmount filesystems and remove mountpoints after use."
11478 #: ../src/guestfs-actions.pod:4150
11480 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11481 "first, so for this to work for manual mountpoints, you must ensure that the "
11482 "innermost mountpoints have the longest pathnames, as in the example code "
11487 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11489 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11493 #: ../src/guestfs-actions.pod:4157
11495 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11496 "means that C<guestfs_umount_all> is called when the handle is closed which "
11497 "can also trigger these issues."
11501 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422
11502 #: ../src/guestfs-actions.pod:5315
11503 msgid "(Added in 1.0.62)"
11507 #: ../src/guestfs-actions.pod:4165
11508 msgid "guestfs_mknod"
11512 #: ../src/guestfs-actions.pod:4167
11516 " guestfs_mknod (guestfs_h *g,\n"
11520 " const char *path);\n"
11525 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11527 "This call creates block or character special devices, or named pipes (FIFOs)."
11531 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11533 "The C<mode> parameter should be the mode, using the standard constants. "
11534 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11535 "used when creating block and character special devices."
11539 #: ../src/guestfs-actions.pod:4182
11541 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11542 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11543 "regular file). These constants are available in the standard Linux header "
11544 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11545 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11546 "the appropriate constant for you."
11550 #: ../src/guestfs-actions.pod:4196
11551 msgid "guestfs_mknod_b"
11555 #: ../src/guestfs-actions.pod:4198
11559 " guestfs_mknod_b (guestfs_h *g,\n"
11563 " const char *path);\n"
11568 #: ../src/guestfs-actions.pod:4205
11570 "This call creates a block device node called C<path> with mode C<mode> and "
11571 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11572 "wrapper around C<guestfs_mknod>."
11576 #: ../src/guestfs-actions.pod:4215
11577 msgid "guestfs_mknod_c"
11581 #: ../src/guestfs-actions.pod:4217
11585 " guestfs_mknod_c (guestfs_h *g,\n"
11589 " const char *path);\n"
11594 #: ../src/guestfs-actions.pod:4224
11596 "This call creates a char device node called C<path> with mode C<mode> and "
11597 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11598 "wrapper around C<guestfs_mknod>."
11602 #: ../src/guestfs-actions.pod:4234
11603 msgid "guestfs_mkswap"
11607 #: ../src/guestfs-actions.pod:4236
11611 " guestfs_mkswap (guestfs_h *g,\n"
11612 " const char *device);\n"
11617 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11618 msgid "Create a swap partition on C<device>."
11622 #: ../src/guestfs-actions.pod:4246
11623 msgid "guestfs_mkswap_L"
11627 #: ../src/guestfs-actions.pod:4248
11631 " guestfs_mkswap_L (guestfs_h *g,\n"
11632 " const char *label,\n"
11633 " const char *device);\n"
11638 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11639 msgid "Create a swap partition on C<device> with label C<label>."
11643 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11645 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11646 "sda>), just to a partition. This appears to be a limitation of the kernel "
11651 #: ../src/guestfs-actions.pod:4263
11652 msgid "guestfs_mkswap_U"
11656 #: ../src/guestfs-actions.pod:4265
11660 " guestfs_mkswap_U (guestfs_h *g,\n"
11661 " const char *uuid,\n"
11662 " const char *device);\n"
11667 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11668 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11672 #: ../src/guestfs-actions.pod:4276
11673 msgid "guestfs_mkswap_file"
11677 #: ../src/guestfs-actions.pod:4278
11681 " guestfs_mkswap_file (guestfs_h *g,\n"
11682 " const char *path);\n"
11687 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11688 msgid "Create a swap file."
11692 #: ../src/guestfs-actions.pod:4284
11694 "This command just writes a swap file signature to an existing file. To "
11695 "create the file itself, use something like C<guestfs_fallocate>."
11699 #: ../src/guestfs-actions.pod:4291
11700 msgid "guestfs_modprobe"
11704 #: ../src/guestfs-actions.pod:4293
11708 " guestfs_modprobe (guestfs_h *g,\n"
11709 " const char *modulename);\n"
11714 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11715 msgid "This loads a kernel module in the appliance."
11719 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11721 "The kernel module must have been whitelisted when libguestfs was built (see "
11722 "C<appliance/kmod.whitelist.in> in the source)."
11726 #: ../src/guestfs-actions.pod:4306
11727 msgid "guestfs_mount"
11731 #: ../src/guestfs-actions.pod:4308
11735 " guestfs_mount (guestfs_h *g,\n"
11736 " const char *device,\n"
11737 " const char *mountpoint);\n"
11742 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11744 "Mount a guest disk at a position in the filesystem. Block devices are named "
11745 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11746 "those block devices contain partitions, they will have the usual names (eg. "
11747 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11751 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11753 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11754 "mounted on C</> before others can be mounted. Other filesystems can only be "
11755 "mounted on directories which already exist."
11759 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11761 "The mounted filesystem is writable, if we have sufficient permissions on the "
11762 "underlying device."
11766 #: ../src/guestfs-actions.pod:4327
11768 "B<Important note:> When you use this call, the filesystem options C<sync> "
11769 "and C<noatime> are set implicitly. This was originally done because we "
11770 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11771 "very large negative performance impact and negligible effect on "
11772 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11773 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11774 "(use an empty string for the first parameter if you don't want any options)."
11778 #: ../src/guestfs-actions.pod:4341
11779 msgid "guestfs_mount_loop"
11783 #: ../src/guestfs-actions.pod:4343
11787 " guestfs_mount_loop (guestfs_h *g,\n"
11788 " const char *file,\n"
11789 " const char *mountpoint);\n"
11794 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11796 "This command lets you mount C<file> (a filesystem image in a file) on a "
11797 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11802 #: ../src/guestfs-actions.pod:4356
11803 msgid "guestfs_mount_options"
11807 #: ../src/guestfs-actions.pod:4358
11811 " guestfs_mount_options (guestfs_h *g,\n"
11812 " const char *options,\n"
11813 " const char *device,\n"
11814 " const char *mountpoint);\n"
11819 #: ../src/guestfs-actions.pod:4364
11821 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11822 "the mount options as for the L<mount(8)> I<-o> flag."
11826 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11828 "If the C<options> parameter is an empty string, then no options are passed "
11829 "(all options default to whatever the filesystem uses)."
11833 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388
11834 #: ../src/guestfs-actions.pod:4405
11835 msgid "(Added in 1.0.10)"
11839 #: ../src/guestfs-actions.pod:4376
11840 msgid "guestfs_mount_ro"
11844 #: ../src/guestfs-actions.pod:4378
11848 " guestfs_mount_ro (guestfs_h *g,\n"
11849 " const char *device,\n"
11850 " const char *mountpoint);\n"
11855 #: ../src/guestfs-actions.pod:4383
11857 "This is the same as the C<guestfs_mount> command, but it mounts the "
11858 "filesystem with the read-only (I<-o ro>) flag."
11862 #: ../src/guestfs-actions.pod:4390
11863 msgid "guestfs_mount_vfs"
11867 #: ../src/guestfs-actions.pod:4392
11871 " guestfs_mount_vfs (guestfs_h *g,\n"
11872 " const char *options,\n"
11873 " const char *vfstype,\n"
11874 " const char *device,\n"
11875 " const char *mountpoint);\n"
11880 #: ../src/guestfs-actions.pod:4399
11882 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11883 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11888 #: ../src/guestfs-actions.pod:4407
11889 msgid "guestfs_mountpoints"
11893 #: ../src/guestfs-actions.pod:4409
11897 " guestfs_mountpoints (guestfs_h *g);\n"
11902 #: ../src/guestfs-actions.pod:4412
11904 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11905 "devices. This one returns a hash table (map) of device name to directory "
11906 "where the device is mounted."
11910 #: ../src/guestfs-actions.pod:4424
11911 msgid "guestfs_mounts"
11915 #: ../src/guestfs-actions.pod:4426
11919 " guestfs_mounts (guestfs_h *g);\n"
11924 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11926 "This returns the list of currently mounted filesystems. It returns the list "
11927 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11931 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11932 msgid "Some internal mounts are not shown."
11936 #: ../src/guestfs-actions.pod:4434
11937 msgid "See also: C<guestfs_mountpoints>"
11941 #: ../src/guestfs-actions.pod:4442
11946 #: ../src/guestfs-actions.pod:4444
11950 " guestfs_mv (guestfs_h *g,\n"
11951 " const char *src,\n"
11952 " const char *dest);\n"
11957 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11959 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11960 "destination filename or destination directory."
11964 #: ../src/guestfs-actions.pod:4456
11965 msgid "guestfs_ntfs_3g_probe"
11969 #: ../src/guestfs-actions.pod:4458
11973 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11975 " const char *device);\n"
11980 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11982 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11983 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11984 "write, and some cannot be mounted at all)."
11988 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11990 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11991 "can be mounted read-write. Set it to false if you want to test if the "
11992 "volume can be mounted read-only."
11996 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
11998 "The return value is an integer which C<0> if the operation would succeed, or "
11999 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12003 #: ../src/guestfs-actions.pod:4477
12004 msgid "(Added in 1.0.43)"
12008 #: ../src/guestfs-actions.pod:4479
12009 msgid "guestfs_ntfsresize"
12013 #: ../src/guestfs-actions.pod:4481
12017 " guestfs_ntfsresize (guestfs_h *g,\n"
12018 " const char *device);\n"
12023 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
12025 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12026 "size of the underlying device. See also L<ntfsresize(8)>."
12030 #: ../src/guestfs-actions.pod:4493
12031 msgid "guestfs_ntfsresize_size"
12035 #: ../src/guestfs-actions.pod:4495
12039 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12040 " const char *device,\n"
12041 " int64_t size);\n"
12046 #: ../src/guestfs-actions.pod:4500
12048 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12049 "to specify the new size (in bytes) explicitly."
12053 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941
12054 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
12055 msgid "(Added in 1.3.14)"
12059 #: ../src/guestfs-actions.pod:4507
12060 msgid "guestfs_part_add"
12064 #: ../src/guestfs-actions.pod:4509
12068 " guestfs_part_add (guestfs_h *g,\n"
12069 " const char *device,\n"
12070 " const char *prlogex,\n"
12071 " int64_t startsect,\n"
12072 " int64_t endsect);\n"
12077 #: ../src/guestfs-actions.pod:4516
12079 "This command adds a partition to C<device>. If there is no partition table "
12080 "on the device, call C<guestfs_part_init> first."
12084 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
12086 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12087 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12088 "C<logical>) and C<e> (or C<extended>) partition types."
12092 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
12094 "C<startsect> and C<endsect> are the start and end of the partition in "
12095 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12096 "from the end of the disk (C<-1> is the last sector)."
12100 #: ../src/guestfs-actions.pod:4528
12102 "Creating a partition which covers the whole disk is not so easy. Use "
12103 "C<guestfs_part_disk> to do that."
12107 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571
12108 #: ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702
12109 #: ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759
12110 #: ../src/guestfs-actions.pod:4799
12111 msgid "(Added in 1.0.78)"
12115 #: ../src/guestfs-actions.pod:4535
12116 msgid "guestfs_part_del"
12120 #: ../src/guestfs-actions.pod:4537
12124 " guestfs_part_del (guestfs_h *g,\n"
12125 " const char *device,\n"
12131 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
12132 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12136 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
12138 "Note that in the case of MBR partitioning, deleting an extended partition "
12139 "also deletes any logical partitions it contains."
12143 #: ../src/guestfs-actions.pod:4552
12144 msgid "guestfs_part_disk"
12148 #: ../src/guestfs-actions.pod:4554
12152 " guestfs_part_disk (guestfs_h *g,\n"
12153 " const char *device,\n"
12154 " const char *parttype);\n"
12159 #: ../src/guestfs-actions.pod:4559
12161 "This command is simply a combination of C<guestfs_part_init> followed by "
12162 "C<guestfs_part_add> to create a single primary partition covering the whole "
12167 #: ../src/guestfs-actions.pod:4563
12169 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12170 "possible values are described in C<guestfs_part_init>."
12174 #: ../src/guestfs-actions.pod:4573
12175 msgid "guestfs_part_get_bootable"
12179 #: ../src/guestfs-actions.pod:4575
12183 " guestfs_part_get_bootable (guestfs_h *g,\n"
12184 " const char *device,\n"
12190 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
12192 "This command returns true if the partition C<partnum> on C<device> has the "
12193 "bootable flag set."
12197 #: ../src/guestfs-actions.pod:4583
12198 msgid "See also C<guestfs_part_set_bootable>."
12202 #: ../src/guestfs-actions.pod:4589
12203 msgid "guestfs_part_get_mbr_id"
12207 #: ../src/guestfs-actions.pod:4591
12211 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12212 " const char *device,\n"
12218 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
12220 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12221 "partition C<partnum>."
12225 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
12227 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12228 "undefined results for other partition table types (see "
12229 "C<guestfs_part_get_parttype>)."
12233 #: ../src/guestfs-actions.pod:4607
12234 msgid "guestfs_part_get_parttype"
12238 #: ../src/guestfs-actions.pod:4609
12242 " guestfs_part_get_parttype (guestfs_h *g,\n"
12243 " const char *device);\n"
12248 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
12250 "This command examines the partition table on C<device> and returns the "
12251 "partition table type (format) being used."
12255 #: ../src/guestfs-actions.pod:4616
12257 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12258 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12259 "possible, although unusual. See C<guestfs_part_init> for a full list."
12263 #: ../src/guestfs-actions.pod:4626
12264 msgid "guestfs_part_init"
12268 #: ../src/guestfs-actions.pod:4628
12272 " guestfs_part_init (guestfs_h *g,\n"
12273 " const char *device,\n"
12274 " const char *parttype);\n"
12279 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
12281 "This creates an empty partition table on C<device> of one of the partition "
12282 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12283 "(for large disks)."
12287 #: ../src/guestfs-actions.pod:4637
12289 "Initially there are no partitions. Following this, you should call "
12290 "C<guestfs_part_add> for each partition required."
12294 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
12295 msgid "Possible values for C<parttype> are:"
12299 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
12300 msgid "B<efi> | B<gpt>"
12304 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
12305 msgid "Intel EFI / GPT partition table."
12309 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
12311 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12312 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12313 "the C<mbr> format."
12317 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
12318 msgid "B<mbr> | B<msdos>"
12322 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
12324 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12325 "Windows. This partition type will B<only> work for device sizes up to 2 "
12326 "TB. For large disks we recommend using C<gpt>."
12330 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
12332 "Other partition table types that may work but are not supported include:"
12336 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
12341 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
12342 msgid "AIX disk labels."
12346 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
12347 msgid "B<amiga> | B<rdb>"
12351 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
12352 msgid "Amiga \"Rigid Disk Block\" format."
12356 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
12361 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
12362 msgid "BSD disk labels."
12366 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
12371 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
12372 msgid "DASD, used on IBM mainframes."
12376 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
12381 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
12382 msgid "MIPS/SGI volumes."
12386 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
12391 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
12392 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12396 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
12401 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
12402 msgid "NEC PC-98 format, common in Japan apparently."
12406 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
12411 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
12412 msgid "Sun disk labels."
12416 #: ../src/guestfs-actions.pod:4704
12417 msgid "guestfs_part_list"
12421 #: ../src/guestfs-actions.pod:4706
12424 " struct guestfs_partition_list *\n"
12425 " guestfs_part_list (guestfs_h *g,\n"
12426 " const char *device);\n"
12431 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
12433 "This command parses the partition table on C<device> and returns the list of "
12434 "partitions found."
12438 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
12439 msgid "The fields in the returned structure are:"
12443 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
12444 msgid "B<part_num>"
12448 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
12449 msgid "Partition number, counting from 1."
12453 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
12454 msgid "B<part_start>"
12458 #: ../src/guestfs-actions.pod:4723
12460 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12461 "the device's sector size, see C<guestfs_blockdev_getss>."
12465 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
12466 msgid "B<part_end>"
12470 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
12471 msgid "End of the partition in bytes."
12475 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12476 msgid "B<part_size>"
12480 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12481 msgid "Size of the partition in bytes."
12485 #: ../src/guestfs-actions.pod:4736
12487 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12488 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12493 #: ../src/guestfs-actions.pod:4742
12494 msgid "guestfs_part_set_bootable"
12498 #: ../src/guestfs-actions.pod:4744
12502 " guestfs_part_set_bootable (guestfs_h *g,\n"
12503 " const char *device,\n"
12505 " int bootable);\n"
12510 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12512 "This sets the bootable flag on partition numbered C<partnum> on device "
12513 "C<device>. Note that partitions are numbered from 1."
12517 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12519 "The bootable flag is used by some operating systems (notably Windows) to "
12520 "determine which partition to boot from. It is by no means universally "
12525 #: ../src/guestfs-actions.pod:4761
12526 msgid "guestfs_part_set_mbr_id"
12530 #: ../src/guestfs-actions.pod:4763
12534 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12535 " const char *device,\n"
12542 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12544 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12545 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12546 "documentation are in fact hexadecimal numbers, but usually documented "
12547 "without any leading \"0x\" which might be confusing."
12551 #: ../src/guestfs-actions.pod:4783
12552 msgid "guestfs_part_set_name"
12556 #: ../src/guestfs-actions.pod:4785
12560 " guestfs_part_set_name (guestfs_h *g,\n"
12561 " const char *device,\n"
12563 " const char *name);\n"
12568 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12570 "This sets the partition name on partition numbered C<partnum> on device "
12571 "C<device>. Note that partitions are numbered from 1."
12575 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12577 "The partition name can only be set on certain types of partition table. "
12578 "This works on C<gpt> but not on C<mbr> partitions."
12582 #: ../src/guestfs-actions.pod:4801
12583 msgid "guestfs_part_to_dev"
12587 #: ../src/guestfs-actions.pod:4803
12591 " guestfs_part_to_dev (guestfs_h *g,\n"
12592 " const char *partition);\n"
12597 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12599 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12600 "partition number, returning the device name (eg. \"/dev/sdb\")."
12604 #: ../src/guestfs-actions.pod:4811
12606 "The named partition must exist, for example as a string returned from "
12607 "C<guestfs_list_partitions>."
12611 #: ../src/guestfs-actions.pod:4819
12612 msgid "guestfs_ping_daemon"
12616 #: ../src/guestfs-actions.pod:4821
12620 " guestfs_ping_daemon (guestfs_h *g);\n"
12625 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12627 "This is a test probe into the guestfs daemon running inside the qemu "
12628 "subprocess. Calling this function checks that the daemon responds to the "
12629 "ping message, without affecting the daemon or attached block device(s) in "
12634 #: ../src/guestfs-actions.pod:4833
12635 msgid "guestfs_pread"
12639 #: ../src/guestfs-actions.pod:4835
12643 " guestfs_pread (guestfs_h *g,\n"
12644 " const char *path,\n"
12646 " int64_t offset,\n"
12647 " size_t *size_r);\n"
12652 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12654 "This command lets you read part of a file. It reads C<count> bytes of the "
12655 "file, starting at C<offset>, from file C<path>."
12659 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871
12660 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12662 "This may read fewer bytes than requested. For further details see the "
12663 "L<pread(2)> system call."
12667 #: ../src/guestfs-actions.pod:4848
12668 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12672 #: ../src/guestfs-actions.pod:4859
12673 msgid "guestfs_pread_device"
12677 #: ../src/guestfs-actions.pod:4861
12681 " guestfs_pread_device (guestfs_h *g,\n"
12682 " const char *device,\n"
12684 " int64_t offset,\n"
12685 " size_t *size_r);\n"
12690 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12692 "This command lets you read part of a file. It reads C<count> bytes of "
12693 "C<device>, starting at C<offset>."
12697 #: ../src/guestfs-actions.pod:4874
12698 msgid "See also C<guestfs_pread>."
12702 #: ../src/guestfs-actions.pod:4883
12703 msgid "(Added in 1.5.21)"
12707 #: ../src/guestfs-actions.pod:4885
12708 msgid "guestfs_pvcreate"
12712 #: ../src/guestfs-actions.pod:4887
12716 " guestfs_pvcreate (guestfs_h *g,\n"
12717 " const char *device);\n"
12722 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12724 "This creates an LVM physical volume on the named C<device>, where C<device> "
12725 "should usually be a partition name such as C</dev/sda1>."
12729 #: ../src/guestfs-actions.pod:4899
12730 msgid "guestfs_pvremove"
12734 #: ../src/guestfs-actions.pod:4901
12738 " guestfs_pvremove (guestfs_h *g,\n"
12739 " const char *device);\n"
12744 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12746 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12751 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12753 "The implementation uses the C<pvremove> command which refuses to wipe "
12754 "physical volumes that contain any volume groups, so you have to remove those "
12759 #: ../src/guestfs-actions.pod:4916
12760 msgid "guestfs_pvresize"
12764 #: ../src/guestfs-actions.pod:4918
12768 " guestfs_pvresize (guestfs_h *g,\n"
12769 " const char *device);\n"
12774 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12776 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12777 "the new size of the underlying device."
12781 #: ../src/guestfs-actions.pod:4929
12782 msgid "guestfs_pvresize_size"
12786 #: ../src/guestfs-actions.pod:4931
12790 " guestfs_pvresize_size (guestfs_h *g,\n"
12791 " const char *device,\n"
12792 " int64_t size);\n"
12797 #: ../src/guestfs-actions.pod:4936
12799 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12800 "specify the new size (in bytes) explicitly."
12804 #: ../src/guestfs-actions.pod:4943
12805 msgid "guestfs_pvs"
12809 #: ../src/guestfs-actions.pod:4945
12813 " guestfs_pvs (guestfs_h *g);\n"
12818 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12820 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12825 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12827 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12832 #: ../src/guestfs-actions.pod:4954
12833 msgid "See also C<guestfs_pvs_full>."
12837 #: ../src/guestfs-actions.pod:4962
12838 msgid "guestfs_pvs_full"
12842 #: ../src/guestfs-actions.pod:4964
12845 " struct guestfs_lvm_pv_list *\n"
12846 " guestfs_pvs_full (guestfs_h *g);\n"
12851 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12853 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12854 "(8)> command. The \"full\" version includes all fields."
12858 #: ../src/guestfs-actions.pod:4970
12860 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12861 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12865 #: ../src/guestfs-actions.pod:4976
12866 msgid "guestfs_pvuuid"
12870 #: ../src/guestfs-actions.pod:4978
12874 " guestfs_pvuuid (guestfs_h *g,\n"
12875 " const char *device);\n"
12880 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12881 msgid "This command returns the UUID of the LVM PV C<device>."
12885 #: ../src/guestfs-actions.pod:4989
12886 msgid "guestfs_pwrite"
12890 #: ../src/guestfs-actions.pod:4991
12894 " guestfs_pwrite (guestfs_h *g,\n"
12895 " const char *path,\n"
12896 " const char *content,\n"
12897 " size_t content_size,\n"
12898 " int64_t offset);\n"
12903 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12905 "This command writes to part of a file. It writes the data buffer C<content> "
12906 "to the file C<path> starting at offset C<offset>."
12910 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12912 "This command implements the L<pwrite(2)> system call, and like that system "
12913 "call it may not write the full data requested. The return value is the "
12914 "number of bytes that were actually written to the file. This could even be "
12915 "0, although short writes are unlikely for regular files in ordinary "
12920 #: ../src/guestfs-actions.pod:5007
12921 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12925 #: ../src/guestfs-actions.pod:5016
12926 msgid "guestfs_pwrite_device"
12930 #: ../src/guestfs-actions.pod:5018
12934 " guestfs_pwrite_device (guestfs_h *g,\n"
12935 " const char *device,\n"
12936 " const char *content,\n"
12937 " size_t content_size,\n"
12938 " int64_t offset);\n"
12943 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12945 "This command writes to part of a device. It writes the data buffer "
12946 "C<content> to C<device> starting at offset C<offset>."
12950 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12952 "This command implements the L<pwrite(2)> system call, and like that system "
12953 "call it may not write the full data requested (although short writes to disk "
12954 "devices and partitions are probably impossible with standard Linux kernels)."
12958 #: ../src/guestfs-actions.pod:5033
12959 msgid "See also C<guestfs_pwrite>."
12963 #: ../src/guestfs-actions.pod:5040
12964 msgid "(Added in 1.5.20)"
12968 #: ../src/guestfs-actions.pod:5042
12969 msgid "guestfs_read_file"
12973 #: ../src/guestfs-actions.pod:5044
12977 " guestfs_read_file (guestfs_h *g,\n"
12978 " const char *path,\n"
12979 " size_t *size_r);\n"
12984 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12985 msgid "This calls returns the contents of the file C<path> as a buffer."
12989 #: ../src/guestfs-actions.pod:5052
12991 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12992 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12993 "function is limited in the total size of file that can be handled."
12997 #: ../src/guestfs-actions.pod:5064
12998 msgid "(Added in 1.0.63)"
13002 #: ../src/guestfs-actions.pod:5066
13003 msgid "guestfs_read_lines"
13007 #: ../src/guestfs-actions.pod:5068
13011 " guestfs_read_lines (guestfs_h *g,\n"
13012 " const char *path);\n"
13017 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
13019 "The file contents are returned as a list of lines. Trailing C<LF> and "
13020 "C<CRLF> character sequences are I<not> returned."
13024 #: ../src/guestfs-actions.pod:5077
13026 "Note that this function cannot correctly handle binary files (specifically, "
13027 "files containing C<\\0> character which is treated as end of line). For "
13028 "those you need to use the C<guestfs_read_file> function which has a more "
13029 "complex interface."
13033 #: ../src/guestfs-actions.pod:5088
13034 msgid "guestfs_readdir"
13038 #: ../src/guestfs-actions.pod:5090
13041 " struct guestfs_dirent_list *\n"
13042 " guestfs_readdir (guestfs_h *g,\n"
13043 " const char *dir);\n"
13048 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
13049 msgid "This returns the list of directory entries in directory C<dir>."
13053 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
13055 "All entries in the directory are returned, including C<.> and C<..>. The "
13056 "entries are I<not> sorted, but returned in the same order as the underlying "
13061 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
13063 "Also this call returns basic file type information about each file. The "
13064 "C<ftyp> field will contain one of the following characters:"
13068 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
13073 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
13074 msgid "Block special"
13078 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
13083 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
13084 msgid "Char special"
13088 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
13093 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
13098 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
13103 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
13104 msgid "FIFO (named pipe)"
13108 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
13113 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
13114 msgid "Symbolic link"
13118 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
13123 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
13124 msgid "Regular file"
13128 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
13133 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
13138 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
13143 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
13144 msgid "Unknown file type"
13148 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
13153 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
13155 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13159 #: ../src/guestfs-actions.pod:5144
13161 "This function is primarily intended for use by programs. To get a simple "
13162 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13163 "consumption, use C<guestfs_ll>."
13167 #: ../src/guestfs-actions.pod:5148
13169 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13170 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13174 #: ../src/guestfs-actions.pod:5154
13175 msgid "guestfs_readlink"
13179 #: ../src/guestfs-actions.pod:5156
13183 " guestfs_readlink (guestfs_h *g,\n"
13184 " const char *path);\n"
13189 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
13190 msgid "This command reads the target of a symbolic link."
13194 #: ../src/guestfs-actions.pod:5167
13195 msgid "guestfs_readlinklist"
13199 #: ../src/guestfs-actions.pod:5169
13203 " guestfs_readlinklist (guestfs_h *g,\n"
13204 " const char *path,\n"
13205 " char *const *names);\n"
13210 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
13212 "This call allows you to do a C<readlink> operation on multiple files, where "
13213 "all files are in the directory C<path>. C<names> is the list of files from "
13218 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
13220 "On return you get a list of strings, with a one-to-one correspondence to the "
13221 "C<names> list. Each string is the value of the symbolic link."
13225 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
13227 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13228 "result string is the empty string C<\"\">. However the whole operation is "
13229 "completed even if there were C<readlink(2)> errors, and so you can call this "
13230 "function with names where you don't know if they are symbolic links already "
13231 "(albeit slightly less efficient)."
13235 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
13237 "This call is intended for programs that want to efficiently list a directory "
13238 "contents without making many round-trips. Very long directory listings "
13239 "might cause the protocol message size to be exceeded, causing this call to "
13240 "fail. The caller must split up such requests into smaller groups of names."
13244 #: ../src/guestfs-actions.pod:5202
13245 msgid "guestfs_realpath"
13249 #: ../src/guestfs-actions.pod:5204
13253 " guestfs_realpath (guestfs_h *g,\n"
13254 " const char *path);\n"
13259 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
13261 "Return the canonicalized absolute pathname of C<path>. The returned path "
13262 "has no C<.>, C<..> or symbolic link path elements."
13266 #: ../src/guestfs-actions.pod:5216
13267 msgid "guestfs_removexattr"
13271 #: ../src/guestfs-actions.pod:5218
13275 " guestfs_removexattr (guestfs_h *g,\n"
13276 " const char *xattr,\n"
13277 " const char *path);\n"
13282 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
13284 "This call removes the extended attribute named C<xattr> of the file C<path>."
13288 #: ../src/guestfs-actions.pod:5226
13289 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13293 #: ../src/guestfs-actions.pod:5232
13294 msgid "guestfs_resize2fs"
13298 #: ../src/guestfs-actions.pod:5234
13302 " guestfs_resize2fs (guestfs_h *g,\n"
13303 " const char *device);\n"
13308 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
13310 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13311 "underlying device."
13315 #: ../src/guestfs-actions.pod:5241
13317 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13318 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13319 "sometimes gives an error about this and sometimes not. In any case, it is "
13320 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13324 #: ../src/guestfs-actions.pod:5251
13325 msgid "guestfs_resize2fs_size"
13329 #: ../src/guestfs-actions.pod:5253
13333 " guestfs_resize2fs_size (guestfs_h *g,\n"
13334 " const char *device,\n"
13335 " int64_t size);\n"
13340 #: ../src/guestfs-actions.pod:5258
13342 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13343 "to specify the new size (in bytes) explicitly."
13347 #: ../src/guestfs-actions.pod:5265
13352 #: ../src/guestfs-actions.pod:5267
13356 " guestfs_rm (guestfs_h *g,\n"
13357 " const char *path);\n"
13362 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
13363 msgid "Remove the single file C<path>."
13367 #: ../src/guestfs-actions.pod:5277
13368 msgid "guestfs_rm_rf"
13372 #: ../src/guestfs-actions.pod:5279
13376 " guestfs_rm_rf (guestfs_h *g,\n"
13377 " const char *path);\n"
13382 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
13384 "Remove the file or directory C<path>, recursively removing the contents if "
13385 "its a directory. This is like the C<rm -rf> shell command."
13389 #: ../src/guestfs-actions.pod:5291
13390 msgid "guestfs_rmdir"
13394 #: ../src/guestfs-actions.pod:5293
13398 " guestfs_rmdir (guestfs_h *g,\n"
13399 " const char *path);\n"
13404 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
13405 msgid "Remove the single directory C<path>."
13409 #: ../src/guestfs-actions.pod:5303
13410 msgid "guestfs_rmmountpoint"
13414 #: ../src/guestfs-actions.pod:5305
13418 " guestfs_rmmountpoint (guestfs_h *g,\n"
13419 " const char *exemptpath);\n"
13424 #: ../src/guestfs-actions.pod:5309
13426 "This calls removes a mountpoint that was previously created with "
13427 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13431 #: ../src/guestfs-actions.pod:5317
13432 msgid "guestfs_scrub_device"
13436 #: ../src/guestfs-actions.pod:5319
13440 " guestfs_scrub_device (guestfs_h *g,\n"
13441 " const char *device);\n"
13446 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
13448 "This command writes patterns over C<device> to make data retrieval more "
13453 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347
13454 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564
13455 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13457 "It is an interface to the L<scrub(1)> program. See that manual page for "
13462 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352
13463 #: ../src/guestfs-actions.pod:5371
13464 msgid "(Added in 1.0.52)"
13468 #: ../src/guestfs-actions.pod:5336
13469 msgid "guestfs_scrub_file"
13473 #: ../src/guestfs-actions.pod:5338
13477 " guestfs_scrub_file (guestfs_h *g,\n"
13478 " const char *file);\n"
13483 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13485 "This command writes patterns over a file to make data retrieval more "
13490 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13491 msgid "The file is I<removed> after scrubbing."
13495 #: ../src/guestfs-actions.pod:5354
13496 msgid "guestfs_scrub_freespace"
13500 #: ../src/guestfs-actions.pod:5356
13504 " guestfs_scrub_freespace (guestfs_h *g,\n"
13505 " const char *dir);\n"
13510 #: ../src/guestfs-actions.pod:5360
13512 "This command creates the directory C<dir> and then fills it with files until "
13513 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13514 "and deletes them. The intention is to scrub any free space on the partition "
13515 "containing C<dir>."
13519 #: ../src/guestfs-actions.pod:5373
13520 msgid "guestfs_set_append"
13524 #: ../src/guestfs-actions.pod:5375
13528 " guestfs_set_append (guestfs_h *g,\n"
13529 " const char *append);\n"
13534 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13536 "This function is used to add additional options to the guest kernel command "
13541 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13543 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13544 "environment variable."
13548 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13550 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13551 "(libguestfs always adds a few of its own)."
13555 #: ../src/guestfs-actions.pod:5392
13556 msgid "guestfs_set_autosync"
13560 #: ../src/guestfs-actions.pod:5394
13564 " guestfs_set_autosync (guestfs_h *g,\n"
13565 " int autosync);\n"
13570 #: ../src/guestfs-actions.pod:5398
13572 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13573 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13574 "the handle is closed (also if the program exits without closing handles)."
13578 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13580 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13581 "disabled by default)."
13585 #: ../src/guestfs-actions.pod:5410
13586 msgid "guestfs_set_direct"
13590 #: ../src/guestfs-actions.pod:5412
13594 " guestfs_set_direct (guestfs_h *g,\n"
13600 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13602 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13603 "passed directly through to the appliance once it is launched."
13607 #: ../src/guestfs-actions.pod:5420
13609 "One consequence of this is that log messages aren't caught by the library "
13610 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13615 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13616 msgid "You probably don't want to use this unless you know what you are doing."
13620 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13621 msgid "The default is disabled."
13625 #: ../src/guestfs-actions.pod:5433
13626 msgid "guestfs_set_e2label"
13630 #: ../src/guestfs-actions.pod:5435
13634 " guestfs_set_e2label (guestfs_h *g,\n"
13635 " const char *device,\n"
13636 " const char *label);\n"
13641 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13643 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13644 "C<label>. Filesystem labels are limited to 16 characters."
13648 #: ../src/guestfs-actions.pod:5444
13650 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13651 "the existing label on a filesystem."
13655 #: ../src/guestfs-actions.pod:5451
13656 msgid "guestfs_set_e2uuid"
13660 #: ../src/guestfs-actions.pod:5453
13664 " guestfs_set_e2uuid (guestfs_h *g,\n"
13665 " const char *device,\n"
13666 " const char *uuid);\n"
13671 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13673 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13674 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13675 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13679 #: ../src/guestfs-actions.pod:5463
13681 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13682 "the existing UUID of a filesystem."
13686 #: ../src/guestfs-actions.pod:5470
13687 msgid "guestfs_set_memsize"
13691 #: ../src/guestfs-actions.pod:5472
13695 " guestfs_set_memsize (guestfs_h *g,\n"
13701 #: ../src/guestfs-actions.pod:5476
13703 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13704 "This only has any effect if called before C<guestfs_launch>."
13708 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13710 "You can also change this by setting the environment variable "
13711 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13715 #: ../src/guestfs-actions.pod:5491
13716 msgid "guestfs_set_network"
13720 #: ../src/guestfs-actions.pod:5493
13724 " guestfs_set_network (guestfs_h *g,\n"
13730 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13732 "If C<network> is true, then the network is enabled in the libguestfs "
13733 "appliance. The default is false."
13737 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13739 "This affects whether commands are able to access the network (see L<guestfs"
13740 "(3)/RUNNING COMMANDS>)."
13744 #: ../src/guestfs-actions.pod:5503
13746 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13751 #: ../src/guestfs-actions.pod:5510
13752 msgid "guestfs_set_path"
13756 #: ../src/guestfs-actions.pod:5512
13760 " guestfs_set_path (guestfs_h *g,\n"
13761 " const char *searchpath);\n"
13766 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13767 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13771 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13773 "The default is C<$libdir/guestfs> unless overridden by setting "
13774 "C<LIBGUESTFS_PATH> environment variable."
13778 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13779 msgid "Setting C<path> to C<NULL> restores the default path."
13783 #: ../src/guestfs-actions.pod:5527
13784 msgid "guestfs_set_qemu"
13788 #: ../src/guestfs-actions.pod:5529
13792 " guestfs_set_qemu (guestfs_h *g,\n"
13793 " const char *qemu);\n"
13798 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13799 msgid "Set the qemu binary that we will use."
13803 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13805 "The default is chosen when the library was compiled by the configure script."
13809 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13811 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13816 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13817 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13821 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13823 "Note that you should call this function as early as possible after creating "
13824 "the handle. This is because some pre-launch operations depend on testing "
13825 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13826 "don't retest features, and so you might see inconsistent results. Using the "
13827 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13828 "the qemu binary at the same time as the handle is created."
13832 #: ../src/guestfs-actions.pod:5555
13833 msgid "guestfs_set_recovery_proc"
13837 #: ../src/guestfs-actions.pod:5557
13841 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13842 " int recoveryproc);\n"
13847 #: ../src/guestfs-actions.pod:5561
13849 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13850 "not create a recovery process. The purpose of the recovery process is to "
13851 "stop runaway qemu processes in the case where the main program aborts "
13856 #: ../src/guestfs-actions.pod:5566
13858 "This only has any effect if called before C<guestfs_launch>, and the default "
13863 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13865 "About the only time when you would want to disable this is if the main "
13866 "process will fork itself into the background (\"daemonize\" itself). In "
13867 "this case the recovery process thinks that the main program has disappeared "
13868 "and so kills qemu, which is not very helpful."
13872 #: ../src/guestfs-actions.pod:5579
13873 msgid "guestfs_set_selinux"
13877 #: ../src/guestfs-actions.pod:5581
13881 " guestfs_set_selinux (guestfs_h *g,\n"
13887 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13889 "This sets the selinux flag that is passed to the appliance at boot time. "
13890 "The default is C<selinux=0> (disabled)."
13894 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13896 "Note that if SELinux is enabled, it is always in Permissive mode "
13897 "(C<enforcing=0>)."
13901 #: ../src/guestfs-actions.pod:5598
13902 msgid "guestfs_set_trace"
13906 #: ../src/guestfs-actions.pod:5600
13910 " guestfs_set_trace (guestfs_h *g,\n"
13916 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13918 "If the command trace flag is set to 1, then commands are printed on stderr "
13919 "before they are executed in a format which is very similar to the one used "
13920 "by guestfish. In other words, you can run a program with this enabled, and "
13921 "you will get out a script which you can feed to guestfish to perform the "
13922 "same set of actions."
13926 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13928 "If you want to trace C API calls into libguestfs (and other libraries) then "
13929 "possibly a better way is to use the external ltrace(1) command."
13933 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13935 "Command traces are disabled unless the environment variable "
13936 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13940 #: ../src/guestfs-actions.pod:5622
13941 msgid "guestfs_set_verbose"
13945 #: ../src/guestfs-actions.pod:5624
13949 " guestfs_set_verbose (guestfs_h *g,\n"
13955 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13956 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13960 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13962 "Verbose messages are disabled unless the environment variable "
13963 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13967 #: ../src/guestfs-actions.pod:5637
13968 msgid "guestfs_setcon"
13972 #: ../src/guestfs-actions.pod:5639
13976 " guestfs_setcon (guestfs_h *g,\n"
13977 " const char *context);\n"
13982 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13984 "This sets the SELinux security context of the daemon to the string "
13989 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13990 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13994 #: ../src/guestfs-actions.pod:5652
13995 msgid "guestfs_setxattr"
13999 #: ../src/guestfs-actions.pod:5654
14003 " guestfs_setxattr (guestfs_h *g,\n"
14004 " const char *xattr,\n"
14005 " const char *val,\n"
14007 " const char *path);\n"
14012 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
14014 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14015 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14019 #: ../src/guestfs-actions.pod:5665
14020 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14024 #: ../src/guestfs-actions.pod:5671
14025 msgid "guestfs_sfdisk"
14029 #: ../src/guestfs-actions.pod:5673
14033 " guestfs_sfdisk (guestfs_h *g,\n"
14034 " const char *device,\n"
14038 " char *const *lines);\n"
14043 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
14045 "This is a direct interface to the L<sfdisk(8)> program for creating "
14046 "partitions on block devices."
14050 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
14051 msgid "C<device> should be a block device, for example C</dev/sda>."
14055 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
14057 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14058 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14059 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14060 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14061 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14062 "the kernel) cannot work out the right geometry and you will need to tell it."
14066 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
14068 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14069 "refer to the L<sfdisk(8)> manpage."
14073 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
14075 "To create a single partition occupying the whole disk, you would pass "
14076 "C<lines> as a single element list, when the single element being the string "
14081 #: ../src/guestfs-actions.pod:5701
14083 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14087 #: ../src/guestfs-actions.pod:5711
14088 msgid "guestfs_sfdiskM"
14092 #: ../src/guestfs-actions.pod:5713
14096 " guestfs_sfdiskM (guestfs_h *g,\n"
14097 " const char *device,\n"
14098 " char *const *lines);\n"
14103 #: ../src/guestfs-actions.pod:5718
14105 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14106 "partition sizes are specified in megabytes only (rounded to the nearest "
14107 "cylinder) and you don't need to specify the cyls, heads and sectors "
14108 "parameters which were rarely if ever used anyway."
14112 #: ../src/guestfs-actions.pod:5724
14114 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14115 "C<guestfs_part_disk>"
14119 #: ../src/guestfs-actions.pod:5734
14120 msgid "guestfs_sfdisk_N"
14124 #: ../src/guestfs-actions.pod:5736
14128 " guestfs_sfdisk_N (guestfs_h *g,\n"
14129 " const char *device,\n"
14134 " const char *line);\n"
14139 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
14141 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14142 "(note: C<n> counts from 1)."
14146 #: ../src/guestfs-actions.pod:5748
14148 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14149 "for the cyls/heads/sectors parameters."
14153 #: ../src/guestfs-actions.pod:5751
14154 msgid "See also: C<guestfs_part_add>"
14158 #: ../src/guestfs-actions.pod:5760
14159 msgid "guestfs_sfdisk_disk_geometry"
14163 #: ../src/guestfs-actions.pod:5762
14167 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14168 " const char *device);\n"
14173 #: ../src/guestfs-actions.pod:5766
14175 "This displays the disk geometry of C<device> read from the partition table. "
14176 "Especially in the case where the underlying block device has been resized, "
14177 "this can be different from the kernel's idea of the geometry (see "
14178 "C<guestfs_sfdisk_kernel_geometry>)."
14182 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787
14183 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14184 msgid "The result is in human-readable format, and not designed to be parsed."
14188 #: ../src/guestfs-actions.pod:5779
14189 msgid "guestfs_sfdisk_kernel_geometry"
14193 #: ../src/guestfs-actions.pod:5781
14197 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14198 " const char *device);\n"
14203 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
14204 msgid "This displays the kernel's idea of the geometry of C<device>."
14208 #: ../src/guestfs-actions.pod:5795
14209 msgid "guestfs_sfdisk_l"
14213 #: ../src/guestfs-actions.pod:5797
14217 " guestfs_sfdisk_l (guestfs_h *g,\n"
14218 " const char *device);\n"
14223 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
14225 "This displays the partition table on C<device>, in the human-readable output "
14226 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14230 #: ../src/guestfs-actions.pod:5805
14231 msgid "See also: C<guestfs_part_list>"
14235 #: ../src/guestfs-actions.pod:5812
14240 #: ../src/guestfs-actions.pod:5814
14244 " guestfs_sh (guestfs_h *g,\n"
14245 " const char *command);\n"
14250 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
14252 "This call runs a command from the guest filesystem via the guest's C</bin/"
14257 #: ../src/guestfs-actions.pod:5821
14258 msgid "This is like C<guestfs_command>, but passes the command to:"
14262 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
14265 " /bin/sh -c \"command\"\n"
14270 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
14272 "Depending on the guest's shell, this usually results in wildcards being "
14273 "expanded, shell expressions being interpolated and so on."
14277 #: ../src/guestfs-actions.pod:5829
14278 msgid "All the provisos about C<guestfs_command> apply to this call."
14282 #: ../src/guestfs-actions.pod:5836
14283 msgid "guestfs_sh_lines"
14287 #: ../src/guestfs-actions.pod:5838
14291 " guestfs_sh_lines (guestfs_h *g,\n"
14292 " const char *command);\n"
14297 #: ../src/guestfs-actions.pod:5842
14299 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14304 #: ../src/guestfs-actions.pod:5845
14305 msgid "See also: C<guestfs_command_lines>"
14309 #: ../src/guestfs-actions.pod:5853
14310 msgid "guestfs_sleep"
14314 #: ../src/guestfs-actions.pod:5855
14318 " guestfs_sleep (guestfs_h *g,\n"
14324 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
14325 msgid "Sleep for C<secs> seconds."
14329 #: ../src/guestfs-actions.pod:5863
14330 msgid "(Added in 1.0.41)"
14334 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
14335 msgid "guestfs_stat"
14339 #: ../src/guestfs-actions.pod:5867
14342 " struct guestfs_stat *\n"
14343 " guestfs_stat (guestfs_h *g,\n"
14344 " const char *path);\n"
14349 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
14350 msgid "This is the same as the C<stat(2)> system call."
14354 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
14355 msgid "guestfs_statvfs"
14359 #: ../src/guestfs-actions.pod:5883
14362 " struct guestfs_statvfs *\n"
14363 " guestfs_statvfs (guestfs_h *g,\n"
14364 " const char *path);\n"
14369 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
14371 "Returns file system statistics for any mounted file system. C<path> should "
14372 "be a file or directory in the mounted file system (typically it is the mount "
14373 "point itself, but it doesn't need to be)."
14377 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
14378 msgid "This is the same as the C<statvfs(2)> system call."
14382 #: ../src/guestfs-actions.pod:5893
14384 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14385 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14389 #: ../src/guestfs-actions.pod:5899
14390 msgid "guestfs_strings"
14394 #: ../src/guestfs-actions.pod:5901
14398 " guestfs_strings (guestfs_h *g,\n"
14399 " const char *path);\n"
14404 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
14406 "This runs the L<strings(1)> command on a file and returns the list of "
14407 "printable strings found."
14411 #: ../src/guestfs-actions.pod:5917
14412 msgid "guestfs_strings_e"
14416 #: ../src/guestfs-actions.pod:5919
14420 " guestfs_strings_e (guestfs_h *g,\n"
14421 " const char *encoding,\n"
14422 " const char *path);\n"
14427 #: ../src/guestfs-actions.pod:5924
14429 "This is like the C<guestfs_strings> command, but allows you to specify the "
14430 "encoding of strings that are looked for in the source file C<path>."
14434 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
14435 msgid "Allowed encodings are:"
14439 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
14444 #: ../src/guestfs-actions.pod:5934
14446 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14447 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14451 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
14456 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
14457 msgid "Single 8-bit-byte characters."
14461 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
14466 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
14467 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14471 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
14472 msgid "l (lower case letter L)"
14476 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
14478 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14479 "examining binaries in Windows guests."
14483 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14488 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14489 msgid "32-bit big endian such as UCS-4BE."
14493 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14498 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14499 msgid "32-bit little endian such as UCS-4LE."
14503 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14504 msgid "The returned strings are transcoded to UTF-8."
14508 #: ../src/guestfs-actions.pod:5972
14509 msgid "guestfs_swapoff_device"
14513 #: ../src/guestfs-actions.pod:5974
14517 " guestfs_swapoff_device (guestfs_h *g,\n"
14518 " const char *device);\n"
14523 #: ../src/guestfs-actions.pod:5978
14525 "This command disables the libguestfs appliance swap device or partition "
14526 "named C<device>. See C<guestfs_swapon_device>."
14530 #: ../src/guestfs-actions.pod:5986
14531 msgid "guestfs_swapoff_file"
14535 #: ../src/guestfs-actions.pod:5988
14539 " guestfs_swapoff_file (guestfs_h *g,\n"
14540 " const char *file);\n"
14545 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14546 msgid "This command disables the libguestfs appliance swap on file."
14550 #: ../src/guestfs-actions.pod:5998
14551 msgid "guestfs_swapoff_label"
14555 #: ../src/guestfs-actions.pod:6000
14559 " guestfs_swapoff_label (guestfs_h *g,\n"
14560 " const char *label);\n"
14565 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14567 "This command disables the libguestfs appliance swap on labeled swap "
14572 #: ../src/guestfs-actions.pod:6011
14573 msgid "guestfs_swapoff_uuid"
14577 #: ../src/guestfs-actions.pod:6013
14581 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14582 " const char *uuid);\n"
14587 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14589 "This command disables the libguestfs appliance swap partition with the given "
14594 #: ../src/guestfs-actions.pod:6024
14595 msgid "guestfs_swapon_device"
14599 #: ../src/guestfs-actions.pod:6026
14603 " guestfs_swapon_device (guestfs_h *g,\n"
14604 " const char *device);\n"
14609 #: ../src/guestfs-actions.pod:6030
14611 "This command enables the libguestfs appliance to use the swap device or "
14612 "partition named C<device>. The increased memory is made available for all "
14613 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14617 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14619 "Note that you should not swap to existing guest swap partitions unless you "
14620 "know what you are doing. They may contain hibernation information, or other "
14621 "information that the guest doesn't want you to trash. You also risk leaking "
14622 "information about the host to the guest this way. Instead, attach a new "
14623 "host device to the guest and swap on that."
14627 #: ../src/guestfs-actions.pod:6046
14628 msgid "guestfs_swapon_file"
14632 #: ../src/guestfs-actions.pod:6048
14636 " guestfs_swapon_file (guestfs_h *g,\n"
14637 " const char *file);\n"
14642 #: ../src/guestfs-actions.pod:6052
14644 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14649 #: ../src/guestfs-actions.pod:6059
14650 msgid "guestfs_swapon_label"
14654 #: ../src/guestfs-actions.pod:6061
14658 " guestfs_swapon_label (guestfs_h *g,\n"
14659 " const char *label);\n"
14664 #: ../src/guestfs-actions.pod:6065
14666 "This command enables swap to a labeled swap partition. See "
14667 "C<guestfs_swapon_device> for other notes."
14671 #: ../src/guestfs-actions.pod:6072
14672 msgid "guestfs_swapon_uuid"
14676 #: ../src/guestfs-actions.pod:6074
14680 " guestfs_swapon_uuid (guestfs_h *g,\n"
14681 " const char *uuid);\n"
14686 #: ../src/guestfs-actions.pod:6078
14688 "This command enables swap to a swap partition with the given UUID. See "
14689 "C<guestfs_swapon_device> for other notes."
14693 #: ../src/guestfs-actions.pod:6085
14694 msgid "guestfs_sync"
14698 #: ../src/guestfs-actions.pod:6087
14702 " guestfs_sync (guestfs_h *g);\n"
14707 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14709 "This syncs the disk, so that any writes are flushed through to the "
14710 "underlying disk image."
14714 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14716 "You should always call this if you have modified a disk image, before "
14717 "closing the handle."
14721 #: ../src/guestfs-actions.pod:6100
14722 msgid "guestfs_tail"
14726 #: ../src/guestfs-actions.pod:6102
14730 " guestfs_tail (guestfs_h *g,\n"
14731 " const char *path);\n"
14736 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14738 "This command returns up to the last 10 lines of a file as a list of strings."
14742 #: ../src/guestfs-actions.pod:6118
14743 msgid "guestfs_tail_n"
14747 #: ../src/guestfs-actions.pod:6120
14751 " guestfs_tail_n (guestfs_h *g,\n"
14753 " const char *path);\n"
14758 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14760 "If the parameter C<nrlines> is a positive number, this returns the last "
14761 "C<nrlines> lines of the file C<path>."
14765 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14767 "If the parameter C<nrlines> is a negative number, this returns lines from "
14768 "the file C<path>, starting with the C<-nrlines>th line."
14772 #: ../src/guestfs-actions.pod:6142
14773 msgid "guestfs_tar_in"
14777 #: ../src/guestfs-actions.pod:6144
14781 " guestfs_tar_in (guestfs_h *g,\n"
14782 " const char *tarfile,\n"
14783 " const char *directory);\n"
14788 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14790 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14791 "tar file) into C<directory>."
14795 #: ../src/guestfs-actions.pod:6152
14797 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14801 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174
14802 #: ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14803 msgid "(Added in 1.0.3)"
14807 #: ../src/guestfs-actions.pod:6159
14808 msgid "guestfs_tar_out"
14812 #: ../src/guestfs-actions.pod:6161
14816 " guestfs_tar_out (guestfs_h *g,\n"
14817 " const char *directory,\n"
14818 " const char *tarfile);\n"
14823 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14825 "This command packs the contents of C<directory> and downloads it to local "
14830 #: ../src/guestfs-actions.pod:6169
14832 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14833 "C<guestfs_txz_out>."
14837 #: ../src/guestfs-actions.pod:6176
14838 msgid "guestfs_tgz_in"
14842 #: ../src/guestfs-actions.pod:6178
14846 " guestfs_tgz_in (guestfs_h *g,\n"
14847 " const char *tarball,\n"
14848 " const char *directory);\n"
14853 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14855 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14856 "tar file) into C<directory>."
14860 #: ../src/guestfs-actions.pod:6186
14861 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14865 #: ../src/guestfs-actions.pod:6192
14866 msgid "guestfs_tgz_out"
14870 #: ../src/guestfs-actions.pod:6194
14874 " guestfs_tgz_out (guestfs_h *g,\n"
14875 " const char *directory,\n"
14876 " const char *tarball);\n"
14881 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14883 "This command packs the contents of C<directory> and downloads it to local "
14888 #: ../src/guestfs-actions.pod:6202
14889 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14893 #: ../src/guestfs-actions.pod:6208
14894 msgid "guestfs_touch"
14898 #: ../src/guestfs-actions.pod:6210
14902 " guestfs_touch (guestfs_h *g,\n"
14903 " const char *path);\n"
14908 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14910 "Touch acts like the L<touch(1)> command. It can be used to update the "
14911 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14916 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14918 "This command only works on regular files, and will fail on other file types "
14919 "such as directories, symbolic links, block special etc."
14923 #: ../src/guestfs-actions.pod:6225
14924 msgid "guestfs_truncate"
14928 #: ../src/guestfs-actions.pod:6227
14932 " guestfs_truncate (guestfs_h *g,\n"
14933 " const char *path);\n"
14938 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14940 "This command truncates C<path> to a zero-length file. The file must exist "
14945 #: ../src/guestfs-actions.pod:6238
14946 msgid "guestfs_truncate_size"
14950 #: ../src/guestfs-actions.pod:6240
14954 " guestfs_truncate_size (guestfs_h *g,\n"
14955 " const char *path,\n"
14956 " int64_t size);\n"
14961 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14963 "This command truncates C<path> to size C<size> bytes. The file must exist "
14968 #: ../src/guestfs-actions.pod:6248
14970 "If the current file size is less than C<size> then the file is extended to "
14971 "the required size with zero bytes. This creates a sparse file (ie. disk "
14972 "blocks are not allocated for the file until you write to it). To create a "
14973 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14977 #: ../src/guestfs-actions.pod:6258
14978 msgid "guestfs_tune2fs_l"
14982 #: ../src/guestfs-actions.pod:6260
14986 " guestfs_tune2fs_l (guestfs_h *g,\n"
14987 " const char *device);\n"
14992 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
14994 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14999 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
15001 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15002 "for more details. The list of fields returned isn't clearly defined, and "
15003 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15004 "and the filesystem itself."
15008 #: ../src/guestfs-actions.pod:6280
15009 msgid "guestfs_txz_in"
15013 #: ../src/guestfs-actions.pod:6282
15017 " guestfs_txz_in (guestfs_h *g,\n"
15018 " const char *tarball,\n"
15019 " const char *directory);\n"
15024 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
15026 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15027 "tar file) into C<directory>."
15031 #: ../src/guestfs-actions.pod:6294
15032 msgid "guestfs_txz_out"
15036 #: ../src/guestfs-actions.pod:6296
15040 " guestfs_txz_out (guestfs_h *g,\n"
15041 " const char *directory,\n"
15042 " const char *tarball);\n"
15047 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
15049 "This command packs the contents of C<directory> and downloads it to local "
15050 "file C<tarball> (as an xz compressed tar archive)."
15054 #: ../src/guestfs-actions.pod:6308
15055 msgid "guestfs_umask"
15059 #: ../src/guestfs-actions.pod:6310
15063 " guestfs_umask (guestfs_h *g,\n"
15069 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
15071 "This function sets the mask used for creating new files and device nodes to "
15076 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
15078 "Typical umask values would be C<022> which creates new files with "
15079 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15080 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15084 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
15086 "The default umask is C<022>. This is important because it means that "
15087 "directories and device nodes will be created with C<0644> or C<0755> mode "
15088 "even if you specify C<0777>."
15092 #: ../src/guestfs-actions.pod:6326
15094 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15095 "C<guestfs_mkdir>."
15099 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
15100 msgid "This call returns the previous umask."
15104 #: ../src/guestfs-actions.pod:6335
15105 msgid "guestfs_umount"
15109 #: ../src/guestfs-actions.pod:6337
15113 " guestfs_umount (guestfs_h *g,\n"
15114 " const char *pathordevice);\n"
15119 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
15121 "This unmounts the given filesystem. The filesystem may be specified either "
15122 "by its mountpoint (path) or the device which contains the filesystem."
15126 #: ../src/guestfs-actions.pod:6349
15127 msgid "guestfs_umount_all"
15131 #: ../src/guestfs-actions.pod:6351
15135 " guestfs_umount_all (guestfs_h *g);\n"
15140 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
15141 msgid "This unmounts all mounted filesystems."
15145 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
15146 msgid "Some internal mounts are not unmounted by this call."
15150 #: ../src/guestfs-actions.pod:6362
15151 msgid "guestfs_upload"
15155 #: ../src/guestfs-actions.pod:6364
15159 " guestfs_upload (guestfs_h *g,\n"
15160 " const char *filename,\n"
15161 " const char *remotefilename);\n"
15166 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388
15167 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15168 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15172 #: ../src/guestfs-actions.pod:6374
15173 msgid "See also C<guestfs_download>."
15177 #: ../src/guestfs-actions.pod:6380
15178 msgid "guestfs_upload_offset"
15182 #: ../src/guestfs-actions.pod:6382
15186 " guestfs_upload_offset (guestfs_h *g,\n"
15187 " const char *filename,\n"
15188 " const char *remotefilename,\n"
15189 " int64_t offset);\n"
15194 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
15196 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15197 "The intention is to overwrite parts of existing files or devices, although "
15198 "if a non-existant file is specified then it is created with a \"hole\" "
15199 "before C<offset>. The size of the data written is implicit in the size of "
15200 "the source C<filename>."
15204 #: ../src/guestfs-actions.pod:6398
15206 "Note that there is no limit on the amount of data that can be uploaded with "
15207 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15208 "full amount unless an error occurs."
15212 #: ../src/guestfs-actions.pod:6403
15213 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15217 #: ../src/guestfs-actions.pod:6409
15218 msgid "guestfs_utimens"
15222 #: ../src/guestfs-actions.pod:6411
15226 " guestfs_utimens (guestfs_h *g,\n"
15227 " const char *path,\n"
15228 " int64_t atsecs,\n"
15229 " int64_t atnsecs,\n"
15230 " int64_t mtsecs,\n"
15231 " int64_t mtnsecs);\n"
15236 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
15237 msgid "This command sets the timestamps of a file with nanosecond precision."
15241 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
15243 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15248 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
15250 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15251 "nanoseconds from the epoch."
15255 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
15257 "If the C<*nsecs> field contains the special value C<-1> then the "
15258 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15259 "ignored in this case)."
15263 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
15265 "If the C<*nsecs> field contains the special value C<-2> then the "
15266 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15271 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
15272 msgid "guestfs_version"
15276 #: ../src/guestfs-actions.pod:6442
15279 " struct guestfs_version *\n"
15280 " guestfs_version (guestfs_h *g);\n"
15285 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
15287 "Return the libguestfs version number that the program is linked against."
15291 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
15293 "Note that because of dynamic linking this is not necessarily the version of "
15294 "libguestfs that you compiled against. You can compile the program, and then "
15295 "at runtime dynamically link against a completely different C<libguestfs.so> "
15300 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
15302 "This call was added in version C<1.0.58>. In previous versions of "
15303 "libguestfs there was no way to get the version number. From C code you can "
15304 "use dynamic linker functions to find out if this symbol exists (if it "
15305 "doesn't, then it's an earlier version)."
15309 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
15311 "The call returns a structure with four elements. The first three (C<major>, "
15312 "C<minor> and C<release>) are numbers and correspond to the usual version "
15313 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15314 "but may be used for distro-specific information."
15318 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
15320 "To construct the original version string: C<$major.$minor.$release$extra>"
15324 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
15325 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15329 #: ../src/guestfs-actions.pod:6470
15331 "I<Note:> Don't use this call to test for availability of features. In "
15332 "enterprise distributions we backport features from later versions into "
15333 "earlier versions, making this an unreliable way to test for features. Use "
15334 "C<guestfs_available> instead."
15338 #: ../src/guestfs-actions.pod:6476
15340 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15341 "error. I<The caller must call C<guestfs_free_version> after use>."
15345 #: ../src/guestfs-actions.pod:6480
15346 msgid "(Added in 1.0.58)"
15350 #: ../src/guestfs-actions.pod:6482
15351 msgid "guestfs_vfs_label"
15355 #: ../src/guestfs-actions.pod:6484
15359 " guestfs_vfs_label (guestfs_h *g,\n"
15360 " const char *device);\n"
15365 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
15366 msgid "This returns the filesystem label of the filesystem on C<device>."
15370 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
15371 msgid "If the filesystem is unlabeled, this returns the empty string."
15375 #: ../src/guestfs-actions.pod:6493
15376 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15380 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
15381 msgid "(Added in 1.3.18)"
15385 #: ../src/guestfs-actions.pod:6500
15386 msgid "guestfs_vfs_type"
15390 #: ../src/guestfs-actions.pod:6502
15394 " guestfs_vfs_type (guestfs_h *g,\n"
15395 " const char *device);\n"
15400 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
15402 "This command gets the filesystem type corresponding to the filesystem on "
15407 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
15409 "For most filesystems, the result is the name of the Linux VFS module which "
15410 "would be used to mount this filesystem if you mounted it without specifying "
15411 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15415 #: ../src/guestfs-actions.pod:6519
15416 msgid "guestfs_vfs_uuid"
15420 #: ../src/guestfs-actions.pod:6521
15424 " guestfs_vfs_uuid (guestfs_h *g,\n"
15425 " const char *device);\n"
15430 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
15431 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15435 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
15436 msgid "If the filesystem does not have a UUID, this returns the empty string."
15440 #: ../src/guestfs-actions.pod:6530
15441 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15445 #: ../src/guestfs-actions.pod:6537
15446 msgid "guestfs_vg_activate"
15450 #: ../src/guestfs-actions.pod:6539
15454 " guestfs_vg_activate (guestfs_h *g,\n"
15456 " char *const *volgroups);\n"
15461 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
15463 "This command activates or (if C<activate> is false) deactivates all logical "
15464 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15465 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15466 "deactivated, then those devices disappear."
15470 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
15471 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15475 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
15477 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15478 "activated or deactivated."
15482 #: ../src/guestfs-actions.pod:6559
15483 msgid "guestfs_vg_activate_all"
15487 #: ../src/guestfs-actions.pod:6561
15491 " guestfs_vg_activate_all (guestfs_h *g,\n"
15492 " int activate);\n"
15497 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15499 "This command activates or (if C<activate> is false) deactivates all logical "
15500 "volumes in all volume groups. If activated, then they are made known to the "
15501 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15502 "those devices disappear."
15506 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15507 msgid "This command is the same as running C<vgchange -a y|n>"
15511 #: ../src/guestfs-actions.pod:6577
15512 msgid "guestfs_vgcreate"
15516 #: ../src/guestfs-actions.pod:6579
15520 " guestfs_vgcreate (guestfs_h *g,\n"
15521 " const char *volgroup,\n"
15522 " char *const *physvols);\n"
15527 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15529 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15530 "of physical volumes C<physvols>."
15534 #: ../src/guestfs-actions.pod:6591
15535 msgid "guestfs_vglvuuids"
15539 #: ../src/guestfs-actions.pod:6593
15543 " guestfs_vglvuuids (guestfs_h *g,\n"
15544 " const char *vgname);\n"
15549 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15551 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15552 "volumes created in this volume group."
15556 #: ../src/guestfs-actions.pod:6600
15558 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15559 "associate logical volumes and volume groups."
15563 #: ../src/guestfs-actions.pod:6603
15564 msgid "See also C<guestfs_vgpvuuids>."
15568 #: ../src/guestfs-actions.pod:6611
15569 msgid "guestfs_vgpvuuids"
15573 #: ../src/guestfs-actions.pod:6613
15577 " guestfs_vgpvuuids (guestfs_h *g,\n"
15578 " const char *vgname);\n"
15583 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15585 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15586 "volumes that this volume group resides on."
15590 #: ../src/guestfs-actions.pod:6620
15592 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15593 "associate physical volumes and volume groups."
15597 #: ../src/guestfs-actions.pod:6623
15598 msgid "See also C<guestfs_vglvuuids>."
15602 #: ../src/guestfs-actions.pod:6631
15603 msgid "guestfs_vgremove"
15607 #: ../src/guestfs-actions.pod:6633
15611 " guestfs_vgremove (guestfs_h *g,\n"
15612 " const char *vgname);\n"
15617 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15618 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15622 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15624 "This also forcibly removes all logical volumes in the volume group (if any)."
15628 #: ../src/guestfs-actions.pod:6646
15629 msgid "guestfs_vgrename"
15633 #: ../src/guestfs-actions.pod:6648
15637 " guestfs_vgrename (guestfs_h *g,\n"
15638 " const char *volgroup,\n"
15639 " const char *newvolgroup);\n"
15644 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15645 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15649 #: ../src/guestfs-actions.pod:6659
15650 msgid "guestfs_vgs"
15654 #: ../src/guestfs-actions.pod:6661
15658 " guestfs_vgs (guestfs_h *g);\n"
15663 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15665 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15670 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15672 "This returns a list of just the volume group names that were detected (eg. "
15677 #: ../src/guestfs-actions.pod:6670
15678 msgid "See also C<guestfs_vgs_full>."
15682 #: ../src/guestfs-actions.pod:6678
15683 msgid "guestfs_vgs_full"
15687 #: ../src/guestfs-actions.pod:6680
15690 " struct guestfs_lvm_vg_list *\n"
15691 " guestfs_vgs_full (guestfs_h *g);\n"
15696 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15698 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15699 "> command. The \"full\" version includes all fields."
15703 #: ../src/guestfs-actions.pod:6686
15705 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15706 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15710 #: ../src/guestfs-actions.pod:6692
15711 msgid "guestfs_vgscan"
15715 #: ../src/guestfs-actions.pod:6694
15719 " guestfs_vgscan (guestfs_h *g);\n"
15724 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15726 "This rescans all block devices and rebuilds the list of LVM physical "
15727 "volumes, volume groups and logical volumes."
15731 #: ../src/guestfs-actions.pod:6704
15732 msgid "guestfs_vguuid"
15736 #: ../src/guestfs-actions.pod:6706
15740 " guestfs_vguuid (guestfs_h *g,\n"
15741 " const char *vgname);\n"
15746 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15747 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15751 #: ../src/guestfs-actions.pod:6717
15752 msgid "guestfs_wait_ready"
15756 #: ../src/guestfs-actions.pod:6719
15760 " guestfs_wait_ready (guestfs_h *g);\n"
15765 #: ../src/guestfs-actions.pod:6722
15766 msgid "This function is a no op."
15770 #: ../src/guestfs-actions.pod:6724
15772 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15773 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15774 "is no longer necessary because C<guestfs_launch> now does the waiting."
15778 #: ../src/guestfs-actions.pod:6729
15780 "If you see any calls to this function in code then you can just remove them, "
15781 "unless you want to retain compatibility with older versions of the API."
15785 #: ../src/guestfs-actions.pod:6737
15786 msgid "guestfs_wc_c"
15790 #: ../src/guestfs-actions.pod:6739
15794 " guestfs_wc_c (guestfs_h *g,\n"
15795 " const char *path);\n"
15800 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15802 "This command counts the characters in a file, using the C<wc -c> external "
15807 #: ../src/guestfs-actions.pod:6750
15808 msgid "guestfs_wc_l"
15812 #: ../src/guestfs-actions.pod:6752
15816 " guestfs_wc_l (guestfs_h *g,\n"
15817 " const char *path);\n"
15822 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15824 "This command counts the lines in a file, using the C<wc -l> external command."
15828 #: ../src/guestfs-actions.pod:6763
15829 msgid "guestfs_wc_w"
15833 #: ../src/guestfs-actions.pod:6765
15837 " guestfs_wc_w (guestfs_h *g,\n"
15838 " const char *path);\n"
15843 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15845 "This command counts the words in a file, using the C<wc -w> external command."
15849 #: ../src/guestfs-actions.pod:6776
15850 msgid "guestfs_write"
15854 #: ../src/guestfs-actions.pod:6778
15858 " guestfs_write (guestfs_h *g,\n"
15859 " const char *path,\n"
15860 " const char *content,\n"
15861 " size_t content_size);\n"
15866 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15868 "This call creates a file called C<path>. The content of the file is the "
15869 "string C<content> (which can contain any 8 bit data)."
15873 #: ../src/guestfs-actions.pod:6794
15874 msgid "guestfs_write_file"
15878 #: ../src/guestfs-actions.pod:6796
15882 " guestfs_write_file (guestfs_h *g,\n"
15883 " const char *path,\n"
15884 " const char *content,\n"
15890 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15892 "This call creates a file called C<path>. The contents of the file is the "
15893 "string C<content> (which can contain any 8 bit data), with length C<size>."
15897 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15899 "As a special case, if C<size> is C<0> then the length is calculated using "
15900 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15904 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15906 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15907 "I<not> work, even if the length is specified."
15911 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15913 "This function is deprecated. In new code, use the C<write> call instead."
15917 #: ../src/guestfs-actions.pod:6827
15918 msgid "guestfs_zegrep"
15922 #: ../src/guestfs-actions.pod:6829
15926 " guestfs_zegrep (guestfs_h *g,\n"
15927 " const char *regex,\n"
15928 " const char *path);\n"
15933 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15935 "This calls the external C<zegrep> program and returns the matching lines."
15939 #: ../src/guestfs-actions.pod:6846
15940 msgid "guestfs_zegrepi"
15944 #: ../src/guestfs-actions.pod:6848
15948 " guestfs_zegrepi (guestfs_h *g,\n"
15949 " const char *regex,\n"
15950 " const char *path);\n"
15955 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15957 "This calls the external C<zegrep -i> program and returns the matching lines."
15961 #: ../src/guestfs-actions.pod:6865
15962 msgid "guestfs_zero"
15966 #: ../src/guestfs-actions.pod:6867
15970 " guestfs_zero (guestfs_h *g,\n"
15971 " const char *device);\n"
15976 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15977 msgid "This command writes zeroes over the first few blocks of C<device>."
15981 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15983 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15984 "securely wipe the device). It should be sufficient to remove any partition "
15985 "tables, filesystem superblocks and so on."
15989 #: ../src/guestfs-actions.pod:6877
15990 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15994 #: ../src/guestfs-actions.pod:6888
15995 msgid "guestfs_zero_device"
15999 #: ../src/guestfs-actions.pod:6890
16003 " guestfs_zero_device (guestfs_h *g,\n"
16004 " const char *device);\n"
16009 #: ../src/guestfs-actions.pod:6894
16011 "This command writes zeroes over the entire C<device>. Compare with "
16012 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16016 #: ../src/guestfs-actions.pod:6908
16017 msgid "(Added in 1.3.1)"
16021 #: ../src/guestfs-actions.pod:6910
16022 msgid "guestfs_zerofree"
16026 #: ../src/guestfs-actions.pod:6912
16030 " guestfs_zerofree (guestfs_h *g,\n"
16031 " const char *device);\n"
16036 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
16038 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16039 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16040 "possible to compress the filesystem more effectively."
16044 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
16045 msgid "You should B<not> run this program if the filesystem is mounted."
16049 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
16051 "It is possible that using this program can damage the filesystem or data on "
16056 #: ../src/guestfs-actions.pod:6931
16057 msgid "guestfs_zfgrep"
16061 #: ../src/guestfs-actions.pod:6933
16065 " guestfs_zfgrep (guestfs_h *g,\n"
16066 " const char *pattern,\n"
16067 " const char *path);\n"
16072 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
16074 "This calls the external C<zfgrep> program and returns the matching lines."
16078 #: ../src/guestfs-actions.pod:6950
16079 msgid "guestfs_zfgrepi"
16083 #: ../src/guestfs-actions.pod:6952
16087 " guestfs_zfgrepi (guestfs_h *g,\n"
16088 " const char *pattern,\n"
16089 " const char *path);\n"
16094 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
16096 "This calls the external C<zfgrep -i> program and returns the matching lines."
16100 #: ../src/guestfs-actions.pod:6969
16101 msgid "guestfs_zfile"
16105 #: ../src/guestfs-actions.pod:6971
16109 " guestfs_zfile (guestfs_h *g,\n"
16110 " const char *meth,\n"
16111 " const char *path);\n"
16116 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
16118 "This command runs C<file> after first decompressing C<path> using C<method>."
16122 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
16123 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16127 #: ../src/guestfs-actions.pod:6981
16129 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16134 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
16136 "This function is deprecated. In new code, use the C<file> call instead."
16140 #: ../src/guestfs-actions.pod:6996
16141 msgid "guestfs_zgrep"
16145 #: ../src/guestfs-actions.pod:6998
16149 " guestfs_zgrep (guestfs_h *g,\n"
16150 " const char *regex,\n"
16151 " const char *path);\n"
16156 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
16158 "This calls the external C<zgrep> program and returns the matching lines."
16162 #: ../src/guestfs-actions.pod:7015
16163 msgid "guestfs_zgrepi"
16167 #: ../src/guestfs-actions.pod:7017
16171 " guestfs_zgrepi (guestfs_h *g,\n"
16172 " const char *regex,\n"
16173 " const char *path);\n"
16178 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
16180 "This calls the external C<zgrep -i> program and returns the matching lines."
16184 #: ../src/guestfs-availability.pod:3
16189 #: ../src/guestfs-availability.pod:5
16191 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16192 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16193 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16194 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16195 "L</guestfs_aug_save> L</guestfs_aug_set>"
16199 #: ../src/guestfs-availability.pod:21
16204 #: ../src/guestfs-availability.pod:23
16206 "The following functions: L</guestfs_inotify_add_watch> L</"
16207 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16208 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16212 #: ../src/guestfs-availability.pod:31
16213 msgid "B<linuxfsuuid>"
16217 #: ../src/guestfs-availability.pod:33
16219 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16220 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16224 #: ../src/guestfs-availability.pod:40
16225 msgid "B<linuxmodules>"
16229 #: ../src/guestfs-availability.pod:42
16230 msgid "The following functions: L</guestfs_modprobe>"
16234 #: ../src/guestfs-availability.pod:45
16235 msgid "B<linuxxattrs>"
16239 #: ../src/guestfs-availability.pod:47
16241 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16242 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16243 "guestfs_removexattr> L</guestfs_setxattr>"
16247 #: ../src/guestfs-availability.pod:56
16252 #: ../src/guestfs-availability.pod:58
16254 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16255 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16256 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16260 #: ../src/guestfs-availability.pod:67
16265 #: ../src/guestfs-availability.pod:69
16267 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16268 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16269 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16270 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16271 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16272 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16273 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16277 #: ../src/guestfs-availability.pod:92
16282 #: ../src/guestfs-availability.pod:94
16284 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16285 "guestfs_mknod_b> L</guestfs_mknod_c>"
16289 #: ../src/guestfs-availability.pod:100
16294 #: ../src/guestfs-availability.pod:102
16295 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16299 #: ../src/guestfs-availability.pod:105
16300 msgid "B<ntfsprogs>"
16304 #: ../src/guestfs-availability.pod:107
16306 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16310 #: ../src/guestfs-availability.pod:111
16311 msgid "B<realpath>"
16315 #: ../src/guestfs-availability.pod:113
16316 msgid "The following functions: L</guestfs_realpath>"
16320 #: ../src/guestfs-availability.pod:116
16325 #: ../src/guestfs-availability.pod:118
16327 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16328 "guestfs_scrub_freespace>"
16332 #: ../src/guestfs-availability.pod:123
16337 #: ../src/guestfs-availability.pod:125
16338 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16342 #: ../src/guestfs-availability.pod:129
16347 #: ../src/guestfs-availability.pod:131
16348 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16352 #: ../src/guestfs-availability.pod:135
16353 msgid "B<zerofree>"
16357 #: ../src/guestfs-availability.pod:137
16358 msgid "The following functions: L</guestfs_zerofree>"
16362 #: ../src/guestfs-structs.pod:1
16363 msgid "guestfs_int_bool"
16367 #: ../src/guestfs-structs.pod:3
16370 " struct guestfs_int_bool {\n"
16378 #: ../src/guestfs-structs.pod:8
16381 " struct guestfs_int_bool_list {\n"
16382 " uint32_t len; /* Number of elements in list. */\n"
16383 " struct guestfs_int_bool *val; /* Elements. */\n"
16389 #: ../src/guestfs-structs.pod:13
16392 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16393 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16398 #: ../src/guestfs-structs.pod:16
16399 msgid "guestfs_lvm_pv"
16403 #: ../src/guestfs-structs.pod:18
16406 " struct guestfs_lvm_pv {\n"
16407 " char *pv_name;\n"
16408 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16409 " char pv_uuid[32];\n"
16411 " uint64_t pv_size;\n"
16412 " uint64_t dev_size;\n"
16413 " uint64_t pv_free;\n"
16414 " uint64_t pv_used;\n"
16415 " char *pv_attr;\n"
16416 " int64_t pv_pe_count;\n"
16417 " int64_t pv_pe_alloc_count;\n"
16418 " char *pv_tags;\n"
16419 " uint64_t pe_start;\n"
16420 " int64_t pv_mda_count;\n"
16421 " uint64_t pv_mda_free;\n"
16427 #: ../src/guestfs-structs.pod:36
16430 " struct guestfs_lvm_pv_list {\n"
16431 " uint32_t len; /* Number of elements in list. */\n"
16432 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16438 #: ../src/guestfs-structs.pod:41
16441 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16442 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16447 #: ../src/guestfs-structs.pod:44
16448 msgid "guestfs_lvm_vg"
16452 #: ../src/guestfs-structs.pod:46
16455 " struct guestfs_lvm_vg {\n"
16456 " char *vg_name;\n"
16457 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16458 " char vg_uuid[32];\n"
16460 " char *vg_attr;\n"
16461 " uint64_t vg_size;\n"
16462 " uint64_t vg_free;\n"
16463 " char *vg_sysid;\n"
16464 " uint64_t vg_extent_size;\n"
16465 " int64_t vg_extent_count;\n"
16466 " int64_t vg_free_count;\n"
16467 " int64_t max_lv;\n"
16468 " int64_t max_pv;\n"
16469 " int64_t pv_count;\n"
16470 " int64_t lv_count;\n"
16471 " int64_t snap_count;\n"
16472 " int64_t vg_seqno;\n"
16473 " char *vg_tags;\n"
16474 " int64_t vg_mda_count;\n"
16475 " uint64_t vg_mda_free;\n"
16481 #: ../src/guestfs-structs.pod:69
16484 " struct guestfs_lvm_vg_list {\n"
16485 " uint32_t len; /* Number of elements in list. */\n"
16486 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16492 #: ../src/guestfs-structs.pod:74
16495 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16496 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16501 #: ../src/guestfs-structs.pod:77
16502 msgid "guestfs_lvm_lv"
16506 #: ../src/guestfs-structs.pod:79
16509 " struct guestfs_lvm_lv {\n"
16510 " char *lv_name;\n"
16511 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16512 " char lv_uuid[32];\n"
16513 " char *lv_attr;\n"
16514 " int64_t lv_major;\n"
16515 " int64_t lv_minor;\n"
16516 " int64_t lv_kernel_major;\n"
16517 " int64_t lv_kernel_minor;\n"
16518 " uint64_t lv_size;\n"
16519 " int64_t seg_count;\n"
16521 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16522 " float snap_percent;\n"
16523 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16524 " float copy_percent;\n"
16525 " char *move_pv;\n"
16526 " char *lv_tags;\n"
16527 " char *mirror_log;\n"
16528 " char *modules;\n"
16534 #: ../src/guestfs-structs.pod:101
16537 " struct guestfs_lvm_lv_list {\n"
16538 " uint32_t len; /* Number of elements in list. */\n"
16539 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16545 #: ../src/guestfs-structs.pod:106
16548 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16549 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16554 #: ../src/guestfs-structs.pod:111
16557 " struct guestfs_stat {\n"
16561 " int64_t nlink;\n"
16566 " int64_t blksize;\n"
16567 " int64_t blocks;\n"
16568 " int64_t atime;\n"
16569 " int64_t mtime;\n"
16570 " int64_t ctime;\n"
16576 #: ../src/guestfs-structs.pod:127
16579 " struct guestfs_stat_list {\n"
16580 " uint32_t len; /* Number of elements in list. */\n"
16581 " struct guestfs_stat *val; /* Elements. */\n"
16587 #: ../src/guestfs-structs.pod:132
16590 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16591 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16596 #: ../src/guestfs-structs.pod:137
16599 " struct guestfs_statvfs {\n"
16600 " int64_t bsize;\n"
16601 " int64_t frsize;\n"
16602 " int64_t blocks;\n"
16603 " int64_t bfree;\n"
16604 " int64_t bavail;\n"
16605 " int64_t files;\n"
16606 " int64_t ffree;\n"
16607 " int64_t favail;\n"
16610 " int64_t namemax;\n"
16616 #: ../src/guestfs-structs.pod:151
16619 " struct guestfs_statvfs_list {\n"
16620 " uint32_t len; /* Number of elements in list. */\n"
16621 " struct guestfs_statvfs *val; /* Elements. */\n"
16627 #: ../src/guestfs-structs.pod:156
16630 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16631 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16636 #: ../src/guestfs-structs.pod:159
16637 msgid "guestfs_dirent"
16641 #: ../src/guestfs-structs.pod:161
16644 " struct guestfs_dirent {\n"
16653 #: ../src/guestfs-structs.pod:167
16656 " struct guestfs_dirent_list {\n"
16657 " uint32_t len; /* Number of elements in list. */\n"
16658 " struct guestfs_dirent *val; /* Elements. */\n"
16664 #: ../src/guestfs-structs.pod:172
16667 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16668 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16673 #: ../src/guestfs-structs.pod:177
16676 " struct guestfs_version {\n"
16677 " int64_t major;\n"
16678 " int64_t minor;\n"
16679 " int64_t release;\n"
16686 #: ../src/guestfs-structs.pod:184
16689 " struct guestfs_version_list {\n"
16690 " uint32_t len; /* Number of elements in list. */\n"
16691 " struct guestfs_version *val; /* Elements. */\n"
16697 #: ../src/guestfs-structs.pod:189
16700 " void guestfs_free_version (struct guestfs_free_version *);\n"
16701 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16706 #: ../src/guestfs-structs.pod:192
16707 msgid "guestfs_xattr"
16711 #: ../src/guestfs-structs.pod:194
16714 " struct guestfs_xattr {\n"
16715 " char *attrname;\n"
16716 " /* The next two fields describe a byte array. */\n"
16717 " uint32_t attrval_len;\n"
16718 " char *attrval;\n"
16724 #: ../src/guestfs-structs.pod:201
16727 " struct guestfs_xattr_list {\n"
16728 " uint32_t len; /* Number of elements in list. */\n"
16729 " struct guestfs_xattr *val; /* Elements. */\n"
16735 #: ../src/guestfs-structs.pod:206
16738 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16739 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16744 #: ../src/guestfs-structs.pod:209
16745 msgid "guestfs_inotify_event"
16749 #: ../src/guestfs-structs.pod:211
16752 " struct guestfs_inotify_event {\n"
16753 " int64_t in_wd;\n"
16754 " uint32_t in_mask;\n"
16755 " uint32_t in_cookie;\n"
16756 " char *in_name;\n"
16762 #: ../src/guestfs-structs.pod:218
16765 " struct guestfs_inotify_event_list {\n"
16766 " uint32_t len; /* Number of elements in list. */\n"
16767 " struct guestfs_inotify_event *val; /* Elements. */\n"
16773 #: ../src/guestfs-structs.pod:223
16776 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16777 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16782 #: ../src/guestfs-structs.pod:226
16783 msgid "guestfs_partition"
16787 #: ../src/guestfs-structs.pod:228
16790 " struct guestfs_partition {\n"
16791 " int32_t part_num;\n"
16792 " uint64_t part_start;\n"
16793 " uint64_t part_end;\n"
16794 " uint64_t part_size;\n"
16800 #: ../src/guestfs-structs.pod:235
16803 " struct guestfs_partition_list {\n"
16804 " uint32_t len; /* Number of elements in list. */\n"
16805 " struct guestfs_partition *val; /* Elements. */\n"
16811 #: ../src/guestfs-structs.pod:240
16814 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16815 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16820 #: ../src/guestfs-structs.pod:243
16821 msgid "guestfs_application"
16825 #: ../src/guestfs-structs.pod:245
16828 " struct guestfs_application {\n"
16829 " char *app_name;\n"
16830 " char *app_display_name;\n"
16831 " int32_t app_epoch;\n"
16832 " char *app_version;\n"
16833 " char *app_release;\n"
16834 " char *app_install_path;\n"
16835 " char *app_trans_path;\n"
16836 " char *app_publisher;\n"
16837 " char *app_url;\n"
16838 " char *app_source_package;\n"
16839 " char *app_summary;\n"
16840 " char *app_description;\n"
16846 #: ../src/guestfs-structs.pod:260
16849 " struct guestfs_application_list {\n"
16850 " uint32_t len; /* Number of elements in list. */\n"
16851 " struct guestfs_application *val; /* Elements. */\n"
16857 #: ../src/guestfs-structs.pod:265
16860 " void guestfs_free_application (struct guestfs_free_application *);\n"
16861 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16866 #: ../fish/guestfish.pod:5
16867 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16871 #: ../fish/guestfish.pod:9
16874 " guestfish [--options] [commands]\n"
16879 #: ../fish/guestfish.pod:11
16887 #: ../fish/guestfish.pod:13
16890 " guestfish [--ro|--rw] -a disk.img\n"
16895 #: ../fish/guestfish.pod:15
16898 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16903 #: ../fish/guestfish.pod:17
16906 " guestfish -d libvirt-domain\n"
16911 #: ../fish/guestfish.pod:19
16914 " guestfish [--ro|--rw] -a disk.img -i\n"
16919 #: ../fish/guestfish.pod:21
16922 " guestfish -d libvirt-domain -i\n"
16927 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16928 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16929 #: ../tools/virt-rescue.pl:41
16934 #: ../fish/guestfish.pod:25
16936 "Using guestfish in read/write mode on live virtual machines can be "
16937 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16938 "option to use guestfish safely if the disk image or virtual machine might be "
16943 #: ../fish/guestfish.pod:32
16945 "Guestfish is a shell and command-line tool for examining and modifying "
16946 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16947 "functionality of the guestfs API, see L<guestfs(3)>."
16951 #: ../fish/guestfish.pod:36
16953 "Guestfish gives you structured access to the libguestfs API, from shell "
16954 "scripts or the command line or interactively. If you want to rescue a "
16955 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16960 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847
16961 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16962 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16967 #: ../fish/guestfish.pod:43
16968 msgid "As an interactive shell"
16972 #: ../fish/guestfish.pod:45
16980 #: ../fish/guestfish.pod:47
16983 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16984 " editing virtual machine filesystems.\n"
16989 #: ../fish/guestfish.pod:50
16992 " Type: 'help' for a list of commands\n"
16993 " 'man' to read the manual\n"
16994 " 'quit' to quit the shell\n"
16999 #: ../fish/guestfish.pod:54
17002 " ><fs> add-ro disk.img\n"
17004 " ><fs> list-filesystems\n"
17005 " /dev/sda1: ext4\n"
17006 " /dev/vg_guest/lv_root: ext4\n"
17007 " /dev/vg_guest/lv_swap: swap\n"
17008 " ><fs> mount /dev/vg_guest/lv_root /\n"
17009 " ><fs> cat /etc/fstab\n"
17011 " # Created by anaconda\n"
17018 #: ../fish/guestfish.pod:67
17019 msgid "From shell scripts"
17023 #: ../fish/guestfish.pod:69
17024 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17028 #: ../fish/guestfish.pod:71
17031 " guestfish <<_EOF_\n"
17034 " mount /dev/vg_guest/lv_root /\n"
17035 " write /etc/motd \"Welcome, new users\"\n"
17041 #: ../fish/guestfish.pod:78
17042 msgid "List the LVM logical volumes in a disk image:"
17046 #: ../fish/guestfish.pod:80
17049 " guestfish -a disk.img --ro <<_EOF_\n"
17057 #: ../fish/guestfish.pod:85
17058 msgid "List all the filesystems in a disk image:"
17062 #: ../fish/guestfish.pod:87
17065 " guestfish -a disk.img --ro <<_EOF_\n"
17067 " list-filesystems\n"
17073 #: ../fish/guestfish.pod:92
17074 msgid "On one command line"
17078 #: ../fish/guestfish.pod:94
17079 msgid "Update C</etc/resolv.conf> in a guest:"
17083 #: ../fish/guestfish.pod:96
17087 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17088 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17093 #: ../fish/guestfish.pod:100
17094 msgid "Edit C</boot/grub/grub.conf> interactively:"
17098 #: ../fish/guestfish.pod:102
17101 " guestfish --rw --add disk.img \\\n"
17102 " --mount /dev/vg_guest/lv_root \\\n"
17103 " --mount /dev/sda1:/boot \\\n"
17104 " edit /boot/grub/grub.conf\n"
17109 #: ../fish/guestfish.pod:107
17110 msgid "Mount disks automatically"
17114 #: ../fish/guestfish.pod:109
17116 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17120 #: ../fish/guestfish.pod:112
17123 " guestfish --ro -a disk.img -i cat /etc/group\n"
17128 #: ../fish/guestfish.pod:114
17131 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17136 #: ../fish/guestfish.pod:116
17137 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17141 #: ../fish/guestfish.pod:118
17144 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17149 #: ../fish/guestfish.pod:120
17150 msgid "As a script interpreter"
17154 #: ../fish/guestfish.pod:122
17155 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17159 #: ../fish/guestfish.pod:124
17162 " #!/usr/bin/guestfish -f\n"
17163 " sparse test1.img 100M\n"
17165 " part-disk /dev/sda mbr\n"
17166 " mkfs ext2 /dev/sda1\n"
17171 #: ../fish/guestfish.pod:130
17172 msgid "Start with a prepared disk"
17176 #: ../fish/guestfish.pod:132
17178 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17179 "single ext2-formatted partition:"
17183 #: ../fish/guestfish.pod:135
17186 " guestfish -N fs\n"
17191 #: ../fish/guestfish.pod:137
17192 msgid "To list what is available do:"
17196 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
17199 " guestfish -N help | less\n"
17204 #: ../fish/guestfish.pod:141
17205 msgid "Remote control"
17209 #: ../fish/guestfish.pod:143
17212 " eval \"`guestfish --listen`\"\n"
17213 " guestfish --remote add-ro disk.img\n"
17214 " guestfish --remote run\n"
17215 " guestfish --remote lvs\n"
17220 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17221 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
17222 #: ../tools/virt-win-reg.pl:171 ../tools/virt-df.pl:71
17223 #: ../tools/virt-resize.pl:256 ../tools/virt-list-filesystems.pl:53
17224 #: ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103
17225 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17230 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17231 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179
17232 #: ../tools/virt-df.pl:79 ../tools/virt-resize.pl:264
17233 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106
17234 #: ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161
17235 #: ../tools/virt-list-partitions.pl:62
17240 #: ../fish/guestfish.pod:154
17241 msgid "Displays general help on options."
17245 #: ../fish/guestfish.pod:156
17246 msgid "B<-h> | B<--cmd-help>"
17250 #: ../fish/guestfish.pod:158
17251 msgid "Lists all available guestfish commands."
17255 #: ../fish/guestfish.pod:160
17256 msgid "B<-h cmd> | B<--cmd-help cmd>"
17260 #: ../fish/guestfish.pod:162
17261 msgid "Displays detailed help on a single command C<cmd>."
17265 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17266 msgid "B<-a image> | B<--add image>"
17270 #: ../fish/guestfish.pod:166
17271 msgid "Add a block device or virtual machine image to the shell."
17275 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17277 "The format of the disk image is auto-detected. To override this and force a "
17278 "particular format use the I<--format=..> option."
17282 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17283 msgid "B<-c URI> | B<--connect URI>"
17287 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17289 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17290 "URI to use. The default is to use the default libvirt connection."
17294 #: ../fish/guestfish.pod:177
17299 #: ../fish/guestfish.pod:179
17301 "If using the I<--listen> option and a csh-like shell, use this option. See "
17302 "section L</REMOTE CONTROL AND CSH> below."
17306 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17307 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17311 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17313 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17314 "used, then any libvirt domain can be used. However in write mode, only "
17315 "libvirt domains which are shut down can be named here."
17319 #: ../fish/guestfish.pod:188
17320 msgid "B<-D> | B<--no-dest-paths>"
17324 #: ../fish/guestfish.pod:190
17326 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17327 "to hit the tab key to complete paths on the guest filesystem, but this "
17328 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17329 "allow this feature to be disabled."
17333 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17334 msgid "B<--echo-keys>"
17338 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17340 "When prompting for keys and passphrases, guestfish normally turns echoing "
17341 "off so you cannot see what you are typing. If you are not worried about "
17342 "Tempest attacks and there is no one else in the room you can specify this "
17343 "flag to see what you are typing."
17347 #: ../fish/guestfish.pod:202
17348 msgid "B<-f file> | B<--file file>"
17352 #: ../fish/guestfish.pod:204
17353 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17357 #: ../fish/guestfish.pod:207
17360 " #!/usr/bin/guestfish -f\n"
17365 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17366 msgid "B<--format=raw|qcow2|..> | B<--format>"
17370 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17372 "The default for the I<-a> option is to auto-detect the format of the disk "
17373 "image. Using this forces the disk format for I<-a> options which follow on "
17374 "the command line. Using I<--format> with no argument switches back to auto-"
17375 "detection for subsequent I<-a> options."
17379 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17380 msgid "For example:"
17384 #: ../fish/guestfish.pod:218
17387 " guestfish --format=raw -a disk.img\n"
17392 #: ../fish/guestfish.pod:220
17393 msgid "forces raw format (no auto-detection) for C<disk.img>."
17397 #: ../fish/guestfish.pod:222
17400 " guestfish --format=raw -a disk.img --format -a another.img\n"
17405 #: ../fish/guestfish.pod:224
17407 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17408 "detection for C<another.img>."
17412 #: ../fish/guestfish.pod:227
17414 "If you have untrusted raw-format guest disk images, you should use this "
17415 "option to specify the disk format. This avoids a possible security problem "
17416 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17420 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17421 msgid "B<-i> | B<--inspector>"
17425 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17427 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17428 "system and mount filesystems as they would be mounted on the real virtual "
17433 #: ../fish/guestfish.pod:238
17434 msgid "Typical usage is either:"
17438 #: ../fish/guestfish.pod:240
17441 " guestfish -d myguest -i\n"
17446 #: ../fish/guestfish.pod:242
17447 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17451 #: ../fish/guestfish.pod:244
17454 " guestfish --ro -d myguest -i\n"
17459 #: ../fish/guestfish.pod:246
17460 msgid "(for active domains, readonly), or specify the block device directly:"
17464 #: ../fish/guestfish.pod:248
17467 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17472 #: ../fish/guestfish.pod:250
17474 "Note that the command line syntax changed slightly over older versions of "
17475 "guestfish. You can still use the old syntax:"
17479 #: ../fish/guestfish.pod:253
17482 " guestfish [--ro] -i disk.img\n"
17487 #: ../fish/guestfish.pod:255
17490 " guestfish [--ro] -i libvirt-domain\n"
17495 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17496 msgid "B<--keys-from-stdin>"
17500 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17502 "Read key or passphrase parameters from stdin. The default is to try to read "
17503 "passphrases from the user by opening C</dev/tty>."
17507 #: ../fish/guestfish.pod:262
17508 msgid "B<--listen>"
17512 #: ../fish/guestfish.pod:264
17514 "Fork into the background and listen for remote commands. See section L</"
17515 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17519 #: ../fish/guestfish.pod:267
17520 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17524 #: ../fish/guestfish.pod:269
17525 msgid "Mount the named partition or logical volume on the given mountpoint."
17529 #: ../fish/guestfish.pod:271
17530 msgid "If the mountpoint is omitted, it defaults to C</>."
17534 #: ../fish/guestfish.pod:273
17535 msgid "You have to mount something on C</> before most commands will work."
17539 #: ../fish/guestfish.pod:275
17541 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17546 #: ../fish/guestfish.pod:278
17548 "If you don't know what filesystems a disk image contains, you can either run "
17549 "guestfish without this option, then list the partitions, filesystems and LVs "
17550 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17551 "commands), or you can use the L<virt-filesystems(1)> program."
17555 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17556 msgid "B<-n> | B<--no-sync>"
17560 #: ../fish/guestfish.pod:286
17562 "Disable autosync. This is enabled by default. See the discussion of "
17563 "autosync in the L<guestfs(3)> manpage."
17567 #: ../fish/guestfish.pod:289
17568 msgid "B<-N type> | B<--new type> | B<-N help>"
17572 #: ../fish/guestfish.pod:291
17574 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17575 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17576 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17581 #: ../fish/guestfish.pod:296
17582 msgid "B<--progress-bars>"
17586 #: ../fish/guestfish.pod:298
17587 msgid "Enable progress bars, even when guestfish is used non-interactively."
17591 #: ../fish/guestfish.pod:300
17593 "Progress bars are enabled by default when guestfish is used as an "
17594 "interactive shell."
17598 #: ../fish/guestfish.pod:303
17599 msgid "B<--no-progress-bars>"
17603 #: ../fish/guestfish.pod:305
17604 msgid "Disable progress bars."
17608 #: ../fish/guestfish.pod:307
17609 msgid "B<--remote[=pid]>"
17613 #: ../fish/guestfish.pod:309
17615 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17616 "CONTROL GUESTFISH OVER A SOCKET> below."
17620 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17621 msgid "B<-r> | B<--ro>"
17625 #: ../fish/guestfish.pod:314
17627 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17628 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17632 #: ../fish/guestfish.pod:317 ../tools/virt-rescue.pl:187
17634 "The option must always be used if the disk image or virtual machine might be "
17635 "running, and is generally recommended in cases where you don't need write "
17636 "access to the disk."
17640 #: ../fish/guestfish.pod:321
17642 "Note that prepared disk images created with I<-N> are not affected by the "
17647 #: ../fish/guestfish.pod:324
17648 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17652 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17653 #: ../tools/virt-rescue.pl:195
17654 msgid "B<--selinux>"
17658 #: ../fish/guestfish.pod:328
17659 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17663 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17664 msgid "B<-v> | B<--verbose>"
17668 #: ../fish/guestfish.pod:332
17670 "Enable very verbose messages. This is particularly useful if you find a bug."
17674 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17675 msgid "B<-V> | B<--version>"
17679 #: ../fish/guestfish.pod:337
17680 msgid "Display the guestfish / libguestfs version number and exit."
17684 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17685 msgid "B<-w> | B<--rw>"
17689 #: ../fish/guestfish.pod:341
17691 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17696 #: ../fish/guestfish.pod:344
17701 #: ../fish/guestfish.pod:346
17702 msgid "Echo each command before executing it."
17706 #: ../fish/guestfish.pod:350
17707 msgid "COMMANDS ON COMMAND LINE"
17711 #: ../fish/guestfish.pod:352
17713 "Any additional (non-option) arguments are treated as commands to execute."
17717 #: ../fish/guestfish.pod:355
17719 "Commands to execute should be separated by a colon (C<:>), where the colon "
17720 "is a separate parameter. Thus:"
17724 #: ../fish/guestfish.pod:358
17727 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17732 #: ../fish/guestfish.pod:360
17734 "If there are no additional arguments, then we enter a shell, either an "
17735 "interactive shell with a prompt (if the input is a terminal) or a non-"
17736 "interactive shell."
17740 #: ../fish/guestfish.pod:364
17742 "In either command line mode or non-interactive shell, the first command that "
17743 "gives an error causes the whole shell to exit. In interactive mode (with a "
17744 "prompt) if a command fails, you can continue to enter commands."
17748 #: ../fish/guestfish.pod:369
17749 msgid "USING launch (OR run)"
17753 #: ../fish/guestfish.pod:371
17755 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17756 "then launch it, then mount any disks you need, and finally issue actions/"
17757 "commands. So the general order of the day is:"
17761 #: ../fish/guestfish.pod:379
17762 msgid "add or -a/--add"
17766 #: ../fish/guestfish.pod:383
17767 msgid "launch (aka run)"
17771 #: ../fish/guestfish.pod:387
17772 msgid "mount or -m/--mount"
17776 #: ../fish/guestfish.pod:391
17777 msgid "any other commands"
17781 #: ../fish/guestfish.pod:395
17783 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17784 "guest before mounting or performing any other commands."
17788 #: ../fish/guestfish.pod:398
17790 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17791 "I<--new> options were given then C<run> is done automatically, simply "
17792 "because guestfish can't perform the action you asked for without doing this."
17796 #: ../fish/guestfish.pod:403
17797 msgid "OPENING DISKS FOR READ AND WRITE"
17801 #: ../fish/guestfish.pod:405
17803 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17804 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17805 "open disk images read-only or for writing."
17809 #: ../fish/guestfish.pod:409
17811 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17812 "disk images supplied on the command line for write. To open a disk image "
17813 "read-only you have to do I<-a image --ro>."
17817 #: ../fish/guestfish.pod:413
17819 "This matters: If you accidentally open a live VM disk image writable then "
17820 "you will cause irreversible disk corruption."
17824 #: ../fish/guestfish.pod:416
17826 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17827 "images will be opened read-only. You will have to either specify "
17828 "I<guestfish --rw> or change a configuration file in order to get write "
17829 "access for disk images specified by those other command line options."
17833 #: ../fish/guestfish.pod:421
17835 "This version of guestfish has a I<--rw> option which does nothing (it is "
17836 "already the default). However it is highly recommended that you use this "
17837 "option to indicate that guestfish needs write access, and to prepare your "
17838 "scripts for the day when this option will be required for write access."
17842 #: ../fish/guestfish.pod:427
17844 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17845 "other libguestfs program apart from guestfish and guestmount."
17849 #: ../fish/guestfish.pod:430
17854 #: ../fish/guestfish.pod:432
17856 "You can quote ordinary parameters using either single or double quotes. For "
17861 #: ../fish/guestfish.pod:435
17864 " add \"file with a space.img\"\n"
17869 #: ../fish/guestfish.pod:437
17872 " rm '/file name'\n"
17877 #: ../fish/guestfish.pod:439
17885 #: ../fish/guestfish.pod:441
17887 "A few commands require a list of strings to be passed. For these, use a "
17888 "whitespace-separated list, enclosed in quotes. Strings containing "
17889 "whitespace to be passed through must be enclosed in single quotes. A "
17890 "literal single quote must be escaped with a backslash."
17894 #: ../fish/guestfish.pod:446
17897 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17898 " command \"/bin/echo 'foo bar'\"\n"
17899 " command \"/bin/echo \\'foo\\'\"\n"
17904 #: ../fish/guestfish.pod:450
17905 msgid "OPTIONAL ARGUMENTS"
17909 #: ../fish/guestfish.pod:452
17911 "Some commands take optional arguments. These arguments appear in this "
17912 "documentation as C<[argname:..]>. You can use them as in these examples:"
17916 #: ../fish/guestfish.pod:456
17919 " add-drive-opts filename\n"
17924 #: ../fish/guestfish.pod:458
17927 " add-drive-opts filename readonly:true\n"
17932 #: ../fish/guestfish.pod:460
17935 " add-drive-opts filename format:qcow2 readonly:false\n"
17940 #: ../fish/guestfish.pod:462
17942 "Each optional argument can appear at most once. All optional arguments must "
17943 "appear after the required ones."
17947 #: ../fish/guestfish.pod:465
17952 #: ../fish/guestfish.pod:467
17954 "This section applies to all commands which can take integers as parameters."
17958 #: ../fish/guestfish.pod:470
17959 msgid "SIZE SUFFIX"
17963 #: ../fish/guestfish.pod:472
17965 "When the command takes a parameter measured in bytes, you can use one of the "
17966 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17970 #: ../fish/guestfish.pod:478
17971 msgid "B<k> or B<K> or B<KiB>"
17975 #: ../fish/guestfish.pod:480
17976 msgid "The size in kilobytes (multiplied by 1024)."
17980 #: ../fish/guestfish.pod:482
17985 #: ../fish/guestfish.pod:484
17986 msgid "The size in SI 1000 byte units."
17990 #: ../fish/guestfish.pod:486
17991 msgid "B<M> or B<MiB>"
17995 #: ../fish/guestfish.pod:488
17996 msgid "The size in megabytes (multiplied by 1048576)."
18000 #: ../fish/guestfish.pod:490
18005 #: ../fish/guestfish.pod:492
18006 msgid "The size in SI 1000000 byte units."
18010 #: ../fish/guestfish.pod:494
18011 msgid "B<G> or B<GiB>"
18015 #: ../fish/guestfish.pod:496
18016 msgid "The size in gigabytes (multiplied by 2**30)."
18020 #: ../fish/guestfish.pod:498
18025 #: ../fish/guestfish.pod:500
18026 msgid "The size in SI 10**9 byte units."
18030 #: ../fish/guestfish.pod:502
18031 msgid "B<T> or B<TiB>"
18035 #: ../fish/guestfish.pod:504
18036 msgid "The size in terabytes (multiplied by 2**40)."
18040 #: ../fish/guestfish.pod:506
18045 #: ../fish/guestfish.pod:508
18046 msgid "The size in SI 10**12 byte units."
18050 #: ../fish/guestfish.pod:510
18051 msgid "B<P> or B<PiB>"
18055 #: ../fish/guestfish.pod:512
18056 msgid "The size in petabytes (multiplied by 2**50)."
18060 #: ../fish/guestfish.pod:514
18065 #: ../fish/guestfish.pod:516
18066 msgid "The size in SI 10**15 byte units."
18070 #: ../fish/guestfish.pod:518
18071 msgid "B<E> or B<EiB>"
18075 #: ../fish/guestfish.pod:520
18076 msgid "The size in exabytes (multiplied by 2**60)."
18080 #: ../fish/guestfish.pod:522
18085 #: ../fish/guestfish.pod:524
18086 msgid "The size in SI 10**18 byte units."
18090 #: ../fish/guestfish.pod:526
18091 msgid "B<Z> or B<ZiB>"
18095 #: ../fish/guestfish.pod:528
18096 msgid "The size in zettabytes (multiplied by 2**70)."
18100 #: ../fish/guestfish.pod:530
18105 #: ../fish/guestfish.pod:532
18106 msgid "The size in SI 10**21 byte units."
18110 #: ../fish/guestfish.pod:534
18111 msgid "B<Y> or B<YiB>"
18115 #: ../fish/guestfish.pod:536
18116 msgid "The size in yottabytes (multiplied by 2**80)."
18120 #: ../fish/guestfish.pod:538
18125 #: ../fish/guestfish.pod:540
18126 msgid "The size in SI 10**24 byte units."
18130 #: ../fish/guestfish.pod:546
18133 " truncate-size /file 1G\n"
18138 #: ../fish/guestfish.pod:548
18139 msgid "would truncate the file to 1 gigabyte."
18143 #: ../fish/guestfish.pod:550
18145 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18146 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18147 "suffix will probably not do what you expect."
18151 #: ../fish/guestfish.pod:554
18152 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18156 #: ../fish/guestfish.pod:556
18158 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18159 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18163 #: ../fish/guestfish.pod:559
18166 " 1234 decimal number 1234\n"
18167 " 02322 octal number, equivalent to decimal 1234\n"
18168 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18173 #: ../fish/guestfish.pod:563
18175 "When using the C<chmod> command, you almost always want to specify an octal "
18176 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18177 "L<chmod(1)> program):"
18181 #: ../fish/guestfish.pod:567
18184 " chmod 0777 /public # OK\n"
18185 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18190 #: ../fish/guestfish.pod:570
18192 "Commands that return numbers usually print them in decimal, but some "
18193 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18194 "octal, preceeded by C<0>)."
18198 #: ../fish/guestfish.pod:574
18199 msgid "WILDCARDS AND GLOBBING"
18203 #: ../fish/guestfish.pod:576
18205 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18206 "(globbing) by default. So for example the following will not do what you "
18211 #: ../fish/guestfish.pod:580
18219 #: ../fish/guestfish.pod:582
18221 "Assuming you don't have a directory called literally C</home/*> then the "
18222 "above command will return an error."
18226 #: ../fish/guestfish.pod:585
18227 msgid "To perform wildcard expansion, use the C<glob> command."
18231 #: ../fish/guestfish.pod:587
18234 " glob rm-rf /home/*\n"
18239 #: ../fish/guestfish.pod:589
18241 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18242 "many times), equivalent to:"
18246 #: ../fish/guestfish.pod:592
18249 " rm-rf /home/jim\n"
18250 " rm-rf /home/joe\n"
18251 " rm-rf /home/mary\n"
18256 #: ../fish/guestfish.pod:596
18257 msgid "C<glob> only works on simple guest paths and not on device names."
18261 #: ../fish/guestfish.pod:598
18263 "If you have several parameters, each containing a wildcard, then glob will "
18264 "perform a Cartesian product."
18268 #: ../fish/guestfish.pod:601
18273 #: ../fish/guestfish.pod:603
18275 "Any line which starts with a I<#> character is treated as a comment and "
18276 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18277 "a command. For example:"
18281 #: ../fish/guestfish.pod:607
18284 " # this is a comment\n"
18285 " # this is a comment\n"
18286 " foo # NOT a comment\n"
18291 #: ../fish/guestfish.pod:611
18292 msgid "Blank lines are also ignored."
18296 #: ../fish/guestfish.pod:613
18297 msgid "RUNNING COMMANDS LOCALLY"
18301 #: ../fish/guestfish.pod:615
18303 "Any line which starts with a I<!> character is treated as a command sent to "
18304 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18308 #: ../fish/guestfish.pod:619
18312 " tgz-out /remote local/remote-data.tar.gz\n"
18317 #: ../fish/guestfish.pod:622
18319 "will create a directory C<local> on the host, and then export the contents "
18320 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18321 "(See C<tgz-out>)."
18325 #: ../fish/guestfish.pod:626
18327 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18328 "effect, due to the way that subprocesses work in Unix."
18332 #: ../fish/guestfish.pod:629
18337 #: ../fish/guestfish.pod:631
18339 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18340 "command (a guestfish command) to the second command (any host command). For "
18345 #: ../fish/guestfish.pod:635
18348 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18353 #: ../fish/guestfish.pod:637
18355 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18356 "program). The above command would list all accounts in the guest filesystem "
18357 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18361 #: ../fish/guestfish.pod:642
18364 " hexdump /bin/ls | head\n"
18365 " list-devices | tail -1\n"
18366 " tgz-out / - | tar ztf -\n"
18371 #: ../fish/guestfish.pod:646
18373 "The space before the pipe symbol is required, any space after the pipe "
18374 "symbol is optional. Everything after the pipe symbol is just passed "
18375 "straight to the host shell, so it can contain redirections, globs and "
18376 "anything else that makes sense on the host side."
18380 #: ../fish/guestfish.pod:651
18382 "To use a literal argument which begins with a pipe symbol, you have to quote "
18387 #: ../fish/guestfish.pod:654
18395 #: ../fish/guestfish.pod:656
18396 msgid "HOME DIRECTORIES"
18400 #: ../fish/guestfish.pod:658
18402 "If a parameter starts with the character C<~> then the tilde may be expanded "
18403 "as a home directory path (either C<~> for the current user's home directory, "
18404 "or C<~user> for another user)."
18408 #: ../fish/guestfish.pod:662
18410 "Note that home directory expansion happens for users known I<on the host>, "
18411 "not in the guest filesystem."
18415 #: ../fish/guestfish.pod:665
18417 "To use a literal argument which begins with a tilde, you have to quote it, "
18422 #: ../fish/guestfish.pod:668
18430 #: ../fish/guestfish.pod:672
18432 "Libguestfs has some support for Linux guests encrypted according to the "
18433 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18434 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18435 "LUKS is supported."
18439 #: ../fish/guestfish.pod:677
18440 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18444 #: ../fish/guestfish.pod:679
18447 " ><fs> vfs-type /dev/sda2\n"
18453 #: ../fish/guestfish.pod:682
18455 "Then open those devices using L</luks-open>. This creates a device-mapper "
18456 "device called C</dev/mapper/luksdev>."
18460 #: ../fish/guestfish.pod:685
18463 " ><fs> luks-open /dev/sda2 luksdev\n"
18464 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18469 #: ../fish/guestfish.pod:688
18471 "Finally you have to tell LVM to scan for volume groups on the newly created "
18476 #: ../fish/guestfish.pod:691
18480 " vg-activate-all true\n"
18485 #: ../fish/guestfish.pod:694
18486 msgid "The logical volume(s) can now be mounted in the usual way."
18490 #: ../fish/guestfish.pod:696
18492 "Before closing a LUKS device you must unmount any logical volumes on it and "
18493 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18494 "one. Then you can close the mapper device:"
18498 #: ../fish/guestfish.pod:700
18501 " vg-activate false /dev/VG\n"
18502 " luks-close /dev/mapper/luksdev\n"
18507 #: ../fish/guestfish.pod:703
18508 msgid "WINDOWS PATHS"
18512 #: ../fish/guestfish.pod:705
18514 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18515 "(with some limitations). The following commands are equivalent:"
18519 #: ../fish/guestfish.pod:708
18522 " file /WINDOWS/system32/config/system.LOG\n"
18527 #: ../fish/guestfish.pod:710
18530 " file win:/windows/system32/config/system.log\n"
18535 #: ../fish/guestfish.pod:712
18538 " file win:\\windows\\system32\\config\\system.log\n"
18543 #: ../fish/guestfish.pod:714
18546 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18551 #: ../fish/guestfish.pod:716
18553 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18554 "handles case insensitivity like Windows would. This only works in argument "
18555 "positions that expect a path."
18559 #: ../fish/guestfish.pod:720
18560 msgid "UPLOADING AND DOWNLOADING FILES"
18564 #: ../fish/guestfish.pod:722
18566 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18567 "others which upload from or download to a local file, you can use the "
18568 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18572 #: ../fish/guestfish.pod:726
18580 #: ../fish/guestfish.pod:728
18582 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18586 #: ../fish/guestfish.pod:731
18589 " tar-out /etc - | tar tf -\n"
18594 #: ../fish/guestfish.pod:733
18596 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18597 "command (see L</PIPES>)."
18601 #: ../fish/guestfish.pod:736
18603 "When using C<-> to read from stdin, the input is read up to the end of "
18604 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18605 "some arbitrary end marker:"
18609 #: ../fish/guestfish.pod:740
18612 " upload -<<END /foo\n"
18621 #: ../fish/guestfish.pod:746
18623 "Any string of characters can be used instead of C<END>. The end marker must "
18624 "appear on a line of its own, without any preceeding or following characters "
18625 "(not even spaces)."
18629 #: ../fish/guestfish.pod:750
18631 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18632 "upload local files (so-called \"FileIn\" parameters in the generator)."
18636 #: ../fish/guestfish.pod:753
18637 msgid "EXIT ON ERROR BEHAVIOUR"
18641 #: ../fish/guestfish.pod:755
18643 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18644 "taking commands from a human over a tty), and will exit on the first error "
18645 "in non-interactive mode (scripts, commands given on the command line)."
18649 #: ../fish/guestfish.pod:760
18651 "If you prefix a command with a I<-> character, then that command will not "
18652 "cause guestfish to exit, even if that (one) command returns an error."
18656 #: ../fish/guestfish.pod:764
18657 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18661 #: ../fish/guestfish.pod:766
18663 "Guestfish can be remote-controlled over a socket. This is useful "
18664 "particularly in shell scripts where you want to make several different "
18665 "changes to a filesystem, but you don't want the overhead of starting up a "
18666 "guestfish process each time."
18670 #: ../fish/guestfish.pod:771
18671 msgid "Start a guestfish server process using:"
18675 #: ../fish/guestfish.pod:773
18678 " eval \"`guestfish --listen`\"\n"
18683 #: ../fish/guestfish.pod:775
18684 msgid "and then send it commands by doing:"
18688 #: ../fish/guestfish.pod:777
18691 " guestfish --remote cmd [...]\n"
18696 #: ../fish/guestfish.pod:779
18697 msgid "To cause the server to exit, send it the exit command:"
18701 #: ../fish/guestfish.pod:781
18704 " guestfish --remote exit\n"
18709 #: ../fish/guestfish.pod:783
18711 "Note that the server will normally exit if there is an error in a command. "
18712 "You can change this in the usual way. See section L</EXIT ON ERROR "
18717 #: ../fish/guestfish.pod:787
18718 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18722 #: ../fish/guestfish.pod:789
18724 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18725 "is how the I<--remote> option knows where to send the commands. You can "
18726 "have several guestfish listener processes running using:"
18730 #: ../fish/guestfish.pod:793
18733 " eval \"`guestfish --listen`\"\n"
18734 " pid1=$GUESTFISH_PID\n"
18735 " eval \"`guestfish --listen`\"\n"
18736 " pid2=$GUESTFISH_PID\n"
18738 " guestfish --remote=$pid1 cmd\n"
18739 " guestfish --remote=$pid2 cmd\n"
18744 #: ../fish/guestfish.pod:801
18745 msgid "REMOTE CONTROL AND CSH"
18749 #: ../fish/guestfish.pod:803
18751 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18756 #: ../fish/guestfish.pod:806
18759 " eval \"`guestfish --listen --csh`\"\n"
18764 #: ../fish/guestfish.pod:808
18765 msgid "REMOTE CONTROL DETAILS"
18769 #: ../fish/guestfish.pod:810
18771 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18772 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18773 "and C<$PID> is the process ID of the server."
18777 #: ../fish/guestfish.pod:814
18778 msgid "Guestfish client and server versions must match exactly."
18782 #: ../fish/guestfish.pod:816
18783 msgid "PREPARED DISK IMAGES"
18787 #: ../fish/guestfish.pod:818
18789 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18790 "preformatted disk images that guestfish can make for you to save typing. "
18791 "This is particularly useful for testing purposes. This option is used "
18792 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18793 "can be mixed with I<-a>)."
18797 #: ../fish/guestfish.pod:824
18799 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18800 "the second and so on. Existing files in the current directory are "
18805 #: ../fish/guestfish.pod:828
18807 "The type briefly describes how the disk should be sized, partitioned, how "
18808 "filesystem(s) should be created, and how content should be added. "
18809 "Optionally the type can be followed by extra parameters, separated by C<:> "
18810 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18811 "allocated disk, containing a single partition, with the partition formatted "
18812 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18817 #: ../fish/guestfish.pod:836
18818 msgid "To list the available types and any extra parameters they take, run:"
18822 #: ../fish/guestfish.pod:840
18824 "Note that the prepared filesystem is not mounted. You would usually have to "
18825 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18829 #: ../fish/guestfish.pod:844
18831 "If any I<-N> or I<--new> options are given, the guest is automatically "
18836 #: ../fish/guestfish.pod:849
18837 msgid "Create a 100MB disk with an ext4-formatted partition:"
18841 #: ../fish/guestfish.pod:851
18844 " guestfish -N fs:ext4\n"
18849 #: ../fish/guestfish.pod:853
18850 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18854 #: ../fish/guestfish.pod:855
18857 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18862 #: ../fish/guestfish.pod:857
18863 msgid "Create a blank 200MB disk:"
18867 #: ../fish/guestfish.pod:859
18870 " guestfish -N disk:200M\n"
18875 #: ../fish/guestfish.pod:861
18876 msgid "PROGRESS BARS"
18880 #: ../fish/guestfish.pod:863
18882 "Some (not all) long-running commands send progress notification messages as "
18883 "they are running. Guestfish turns these messages into progress bars."
18887 #: ../fish/guestfish.pod:867
18889 "When a command that supports progress bars takes longer than two seconds to "
18890 "run, and if progress bars are enabled, then you will see one appearing below "
18895 #: ../fish/guestfish.pod:871
18898 " ><fs> copy-size /large-file /another-file 2048M\n"
18899 " / 10% [#####-----------------------------------------] 00:30\n"
18904 #: ../fish/guestfish.pod:874
18906 "The spinner on the left hand side moves round once for every progress "
18907 "notification received from the backend. This is a (reasonably) golden "
18908 "assurance that the command is \"doing something\" even if the progress bar "
18909 "is not moving, because the command is able to send the progress "
18910 "notifications. When the bar reaches 100% and the command finishes, the "
18911 "spinner disappears."
18915 #: ../fish/guestfish.pod:881
18917 "Progress bars are enabled by default when guestfish is used interactively. "
18918 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18919 "and you can disable them completely using I<--no-progress-bars>."
18923 #: ../fish/guestfish.pod:886
18924 msgid "GUESTFISH COMMANDS"
18928 #: ../fish/guestfish.pod:888
18930 "The commands in this section are guestfish convenience commands, in other "
18931 "words, they are not part of the L<guestfs(3)> API."
18935 #: ../fish/guestfish.pod:891
18940 #: ../fish/guestfish.pod:893
18949 #: ../fish/guestfish.pod:896
18950 msgid "Without any parameter, this provides general help."
18954 #: ../fish/guestfish.pod:898
18955 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18959 #: ../fish/guestfish.pod:900
18960 msgid "quit | exit"
18964 #: ../fish/guestfish.pod:902
18965 msgid "This exits guestfish. You can also use C<^D> key."
18969 #: ../fish/guestfish.pod:904
18970 msgid "@FISH_COMMANDS@"
18974 #: ../fish/guestfish.pod:906
18979 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18984 #: ../fish/guestfish.pod:912
18986 "guestfish returns 0 if the commands completed without error, or 1 if there "
18991 #: ../fish/guestfish.pod:919
18996 #: ../fish/guestfish.pod:921
18998 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19003 #: ../fish/guestfish.pod:924
19004 msgid "GUESTFISH_PID"
19008 #: ../fish/guestfish.pod:926
19010 "Used with the I<--remote> option to specify the remote guestfish process to "
19011 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19015 #: ../fish/guestfish.pod:930
19020 #: ../fish/guestfish.pod:932
19022 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19023 "not specified, the external L<hexedit(1)> program is used."
19027 #: ../fish/guestfish.pod:936
19032 #: ../fish/guestfish.pod:938
19034 "If compiled with GNU readline support, various files in the home directory "
19035 "can be used. See L</FILES>."
19039 #: ../fish/guestfish.pod:947
19041 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19042 "effect as using the B<-v> option."
19046 #: ../fish/guestfish.pod:959
19048 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19049 "the discussion of paths in L<guestfs(3)>."
19053 #: ../fish/guestfish.pod:970
19054 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19058 #: ../fish/guestfish.pod:972
19063 #: ../fish/guestfish.pod:974
19065 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19070 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
19075 #: ../fish/guestfish.pod:993
19076 msgid "$HOME/.guestfish"
19080 #: ../fish/guestfish.pod:995
19082 "If compiled with GNU readline support, then the command history is saved in "
19087 #: ../fish/guestfish.pod:998
19088 msgid "$HOME/.inputrc"
19092 #: ../fish/guestfish.pod:1000
19093 msgid "/etc/inputrc"
19097 #: ../fish/guestfish.pod:1002
19099 "If compiled with GNU readline support, then these files can be used to "
19100 "configure readline. For further information, please see L<readline(3)/"
19101 "INITIALIZATION FILE>."
19105 #: ../fish/guestfish.pod:1006
19106 msgid "To write rules which only apply to guestfish, use:"
19110 #: ../fish/guestfish.pod:1008
19120 #: ../fish/guestfish.pod:1012
19122 "Variables that you can set in inputrc that change the behaviour of guestfish "
19123 "in useful ways include:"
19127 #: ../fish/guestfish.pod:1017
19128 msgid "completion-ignore-case (default: on)"
19132 #: ../fish/guestfish.pod:1019
19134 "By default, guestfish will ignore case when tab-completing paths on the "
19139 #: ../fish/guestfish.pod:1022
19142 " set completion-ignore-case off\n"
19147 #: ../fish/guestfish.pod:1024
19148 msgid "to make guestfish case sensitive."
19152 #: ../fish/guestfish.pod:1028
19157 #: ../fish/guestfish.pod:1030
19158 msgid "test2.img (etc)"
19162 #: ../fish/guestfish.pod:1032
19164 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19165 "will be created in the file C<test1.img> in the current directory. The "
19166 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19167 "the same name will be overwritten."
19171 #: ../fish/guestfish.pod:1041
19173 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19174 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
19175 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
19176 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
19181 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124
19182 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
19183 #: ../tools/virt-win-reg.pl:518 ../tools/virt-df.pl:657
19184 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:210
19185 #: ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285
19186 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
19188 "This program is free software; you can redistribute it and/or modify it "
19189 "under the terms of the GNU General Public License as published by the Free "
19190 "Software Foundation; either version 2 of the License, or (at your option) "
19191 "any later version."
19195 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129
19196 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
19197 #: ../tools/virt-win-reg.pl:523 ../tools/virt-df.pl:662
19198 #: ../tools/virt-resize.pl:1519 ../tools/virt-list-filesystems.pl:215
19199 #: ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290
19200 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
19202 "This program is distributed in the hope that it will be useful, but WITHOUT "
19203 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19204 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19209 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134
19210 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
19211 #: ../tools/virt-win-reg.pl:528 ../tools/virt-df.pl:667
19212 #: ../tools/virt-resize.pl:1524 ../tools/virt-list-filesystems.pl:220
19213 #: ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295
19214 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
19216 "You should have received a copy of the GNU General Public License along with "
19217 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19218 "Ave, Cambridge, MA 02139, USA."
19222 #: ../fish/guestfish-actions.pod:1
19227 #: ../fish/guestfish-actions.pod:3
19230 " add-cdrom filename\n"
19235 #: ../fish/guestfish-actions.pod:15
19237 "This call checks for the existence of C<filename>. This stops you from "
19238 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19239 "and C<http:> URLs. To specify those, use the general L</config> call "
19244 #: ../fish/guestfish-actions.pod:22
19246 "If you just want to add an ISO file (often you use this as an efficient way "
19247 "to transfer large files into the guest), then you should probably use L</add-"
19248 "drive-ro> instead."
19252 #: ../fish/guestfish-actions.pod:35
19257 #: ../fish/guestfish-actions.pod:37
19262 #: ../fish/guestfish-actions.pod:39
19265 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19270 #: ../fish/guestfish-actions.pod:41
19272 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19273 "It works by connecting to libvirt, requesting the domain and domain XML from "
19274 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19278 #: ../fish/guestfish-actions.pod:58
19280 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19281 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19282 "libvirt URI (or one set through an environment variable, see the libvirt "
19283 "documentation for full details). If you are using the C API directly then "
19284 "it is more flexible to create the libvirt connection object yourself, get "
19285 "the domain object, and call L</add-libvirt-dom>."
19289 #: ../fish/guestfish-actions.pod:66
19291 "The other optional parameters are passed directly through to L</add-drive-"
19296 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19298 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19302 #: ../fish/guestfish-actions.pod:71
19307 #: ../fish/guestfish-actions.pod:73
19310 " add-drive filename\n"
19315 #: ../fish/guestfish-actions.pod:75
19317 "This function is the equivalent of calling L</add-drive-opts> with no "
19318 "optional parameters, so the disk is added writable, with the format being "
19319 "detected automatically."
19323 #: ../fish/guestfish-actions.pod:79
19325 "Automatic detection of the format opens you up to a potential security hole "
19326 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19327 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19328 "you should think about replacing calls to this function with calls to L</add-"
19329 "drive-opts>, and specifying the format."
19333 #: ../fish/guestfish-actions.pod:86
19334 msgid "add-drive-opts"
19338 #: ../fish/guestfish-actions.pod:88
19343 #: ../fish/guestfish-actions.pod:90
19346 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19351 #: ../fish/guestfish-actions.pod:117
19353 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19354 "add-drive-ro>) then the format is automatically detected. Possible formats "
19355 "include C<raw> and C<qcow2>."
19359 #: ../fish/guestfish-actions.pod:128
19361 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19362 "add-drive-with-if> call (q.v.)"
19366 #: ../fish/guestfish-actions.pod:135
19367 msgid "add-drive-ro"
19371 #: ../fish/guestfish-actions.pod:137
19376 #: ../fish/guestfish-actions.pod:139
19379 " add-drive-ro filename\n"
19384 #: ../fish/guestfish-actions.pod:141
19386 "This function is the equivalent of calling L</add-drive-opts> with the "
19387 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19388 "is added read-only, with the format being detected automatically."
19392 #: ../fish/guestfish-actions.pod:146
19393 msgid "add-drive-ro-with-if"
19397 #: ../fish/guestfish-actions.pod:148
19400 " add-drive-ro-with-if filename iface\n"
19405 #: ../fish/guestfish-actions.pod:150
19407 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19408 "interface emulation to use at run time."
19412 #: ../fish/guestfish-actions.pod:160
19413 msgid "add-drive-with-if"
19417 #: ../fish/guestfish-actions.pod:162
19420 " add-drive-with-if filename iface\n"
19425 #: ../fish/guestfish-actions.pod:164
19427 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19428 "interface emulation to use at run time."
19432 #: ../fish/guestfish-actions.pod:174
19437 #: ../fish/guestfish-actions.pod:176
19440 " aug-clear augpath\n"
19445 #: ../fish/guestfish-actions.pod:181
19450 #: ../fish/guestfish-actions.pod:183
19458 #: ../fish/guestfish-actions.pod:185
19460 "Close the current Augeas handle and free up any resources used by it. After "
19461 "calling this, you have to call L</aug-init> again before you can use any "
19462 "other Augeas functions."
19466 #: ../fish/guestfish-actions.pod:190
19467 msgid "aug-defnode"
19471 #: ../fish/guestfish-actions.pod:192
19474 " aug-defnode name expr val\n"
19479 #: ../fish/guestfish-actions.pod:197
19481 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19482 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19483 "containing that single node."
19487 #: ../fish/guestfish-actions.pod:205
19492 #: ../fish/guestfish-actions.pod:207
19495 " aug-defvar name expr\n"
19500 #: ../fish/guestfish-actions.pod:216
19505 #: ../fish/guestfish-actions.pod:218
19508 " aug-get augpath\n"
19513 #: ../fish/guestfish-actions.pod:223
19518 #: ../fish/guestfish-actions.pod:225
19521 " aug-init root flags\n"
19526 #: ../fish/guestfish-actions.pod:231
19527 msgid "You must call this before using any other L</aug-*> commands."
19531 #: ../fish/guestfish-actions.pod:266
19532 msgid "Do not load the tree in L</aug-init>."
19536 #: ../fish/guestfish-actions.pod:270
19537 msgid "To close the handle, you can call L</aug-close>."
19541 #: ../fish/guestfish-actions.pod:274
19546 #: ../fish/guestfish-actions.pod:276
19549 " aug-insert augpath label true|false\n"
19554 #: ../fish/guestfish-actions.pod:286
19559 #: ../fish/guestfish-actions.pod:288
19567 #: ../fish/guestfish-actions.pod:295
19572 #: ../fish/guestfish-actions.pod:297
19575 " aug-ls augpath\n"
19580 #: ../fish/guestfish-actions.pod:299
19582 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19583 "resulting nodes into alphabetical order."
19587 #: ../fish/guestfish-actions.pod:302
19592 #: ../fish/guestfish-actions.pod:304
19595 " aug-match augpath\n"
19600 #: ../fish/guestfish-actions.pod:310
19605 #: ../fish/guestfish-actions.pod:312
19608 " aug-mv src dest\n"
19613 #: ../fish/guestfish-actions.pod:317
19618 #: ../fish/guestfish-actions.pod:319
19621 " aug-rm augpath\n"
19626 #: ../fish/guestfish-actions.pod:325
19631 #: ../fish/guestfish-actions.pod:327
19639 #: ../fish/guestfish-actions.pod:331
19641 "The flags which were passed to L</aug-init> affect exactly how files are "
19646 #: ../fish/guestfish-actions.pod:334
19651 #: ../fish/guestfish-actions.pod:336
19654 " aug-set augpath val\n"
19659 #: ../fish/guestfish-actions.pod:340
19661 "In the Augeas API, it is possible to clear a node by setting the value to "
19662 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19663 "this call. Instead you must use the L</aug-clear> call."
19667 #: ../fish/guestfish-actions.pod:345
19672 #: ../fish/guestfish-actions.pod:347
19675 " available 'groups ...'\n"
19680 #: ../fish/guestfish-actions.pod:353
19682 "The libguestfs groups, and the functions that those groups correspond to, "
19683 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19684 "runtime by calling L</available-all-groups>."
19688 #: ../fish/guestfish-actions.pod:377
19689 msgid "You must call L</launch> before calling this function."
19693 #: ../fish/guestfish-actions.pod:399
19695 "This call was added in version C<1.0.80>. In previous versions of "
19696 "libguestfs all you could do would be to speculatively execute a command to "
19697 "find out if the daemon implemented it. See also L</version>."
19701 #: ../fish/guestfish-actions.pod:406
19702 msgid "available-all-groups"
19706 #: ../fish/guestfish-actions.pod:408
19709 " available-all-groups\n"
19714 #: ../fish/guestfish-actions.pod:410
19716 "This command returns a list of all optional groups that this daemon knows "
19717 "about. Note this returns both supported and unsupported groups. To find "
19718 "out which ones the daemon can actually support you have to call L</"
19719 "available> on each member of the returned list."
19723 #: ../fish/guestfish-actions.pod:416
19724 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19728 #: ../fish/guestfish-actions.pod:418
19733 #: ../fish/guestfish-actions.pod:420
19736 " base64-in (base64file|-) filename\n"
19741 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19742 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19743 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19744 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19745 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19746 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19747 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19748 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19752 #: ../fish/guestfish-actions.pod:427
19757 #: ../fish/guestfish-actions.pod:429
19760 " base64-out filename (base64file|-)\n"
19765 #: ../fish/guestfish-actions.pod:436
19766 msgid "blockdev-flushbufs"
19770 #: ../fish/guestfish-actions.pod:438
19773 " blockdev-flushbufs device\n"
19778 #: ../fish/guestfish-actions.pod:445
19779 msgid "blockdev-getbsz"
19783 #: ../fish/guestfish-actions.pod:447
19786 " blockdev-getbsz device\n"
19791 #: ../fish/guestfish-actions.pod:456
19792 msgid "blockdev-getro"
19796 #: ../fish/guestfish-actions.pod:458
19799 " blockdev-getro device\n"
19804 #: ../fish/guestfish-actions.pod:465
19805 msgid "blockdev-getsize64"
19809 #: ../fish/guestfish-actions.pod:467
19812 " blockdev-getsize64 device\n"
19817 #: ../fish/guestfish-actions.pod:471
19818 msgid "See also L</blockdev-getsz>."
19822 #: ../fish/guestfish-actions.pod:475
19823 msgid "blockdev-getss"
19827 #: ../fish/guestfish-actions.pod:477
19830 " blockdev-getss device\n"
19835 #: ../fish/guestfish-actions.pod:482
19837 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19841 #: ../fish/guestfish-actions.pod:487
19842 msgid "blockdev-getsz"
19846 #: ../fish/guestfish-actions.pod:489
19849 " blockdev-getsz device\n"
19854 #: ../fish/guestfish-actions.pod:494
19856 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19857 "blockdev-getsize64> for the more useful I<size in bytes>."
19861 #: ../fish/guestfish-actions.pod:500
19862 msgid "blockdev-rereadpt"
19866 #: ../fish/guestfish-actions.pod:502
19869 " blockdev-rereadpt device\n"
19874 #: ../fish/guestfish-actions.pod:508
19875 msgid "blockdev-setbsz"
19879 #: ../fish/guestfish-actions.pod:510
19882 " blockdev-setbsz device blocksize\n"
19887 #: ../fish/guestfish-actions.pod:519
19888 msgid "blockdev-setro"
19892 #: ../fish/guestfish-actions.pod:521
19895 " blockdev-setro device\n"
19900 #: ../fish/guestfish-actions.pod:527
19901 msgid "blockdev-setrw"
19905 #: ../fish/guestfish-actions.pod:529
19908 " blockdev-setrw device\n"
19913 #: ../fish/guestfish-actions.pod:535
19914 msgid "case-sensitive-path"
19918 #: ../fish/guestfish-actions.pod:537
19921 " case-sensitive-path path\n"
19926 #: ../fish/guestfish-actions.pod:561
19928 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19929 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19930 "the directories were originally created under Windows)."
19934 #: ../fish/guestfish-actions.pod:569
19935 msgid "See also L</realpath>."
19939 #: ../fish/guestfish-actions.pod:571
19944 #: ../fish/guestfish-actions.pod:573
19952 #: ../fish/guestfish-actions.pod:577
19954 "Note that this function cannot correctly handle binary files (specifically, "
19955 "files containing C<\\0> character which is treated as end of string). For "
19956 "those you need to use the L</read-file> or L</download> functions which have "
19957 "a more complex interface."
19961 #: ../fish/guestfish-actions.pod:585
19966 #: ../fish/guestfish-actions.pod:587
19969 " checksum csumtype path\n"
19974 #: ../fish/guestfish-actions.pod:630
19975 msgid "To get the checksum for a device, use L</checksum-device>."
19979 #: ../fish/guestfish-actions.pod:632
19980 msgid "To get the checksums for many files, use L</checksums-out>."
19984 #: ../fish/guestfish-actions.pod:634
19985 msgid "checksum-device"
19989 #: ../fish/guestfish-actions.pod:636
19992 " checksum-device csumtype device\n"
19997 #: ../fish/guestfish-actions.pod:638
19999 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20000 "device named C<device>. For the types of checksums supported see the L</"
20001 "checksum> command."
20005 #: ../fish/guestfish-actions.pod:642
20006 msgid "checksums-out"
20010 #: ../fish/guestfish-actions.pod:644
20013 " checksums-out csumtype directory (sumsfile|-)\n"
20018 #: ../fish/guestfish-actions.pod:660
20023 #: ../fish/guestfish-actions.pod:662
20026 " chmod mode path\n"
20031 #: ../fish/guestfish-actions.pod:673
20036 #: ../fish/guestfish-actions.pod:675
20039 " chown owner group path\n"
20044 #: ../fish/guestfish-actions.pod:683
20049 #: ../fish/guestfish-actions.pod:685
20052 " command 'arguments ...'\n"
20057 #: ../fish/guestfish-actions.pod:692
20059 "The single parameter is an argv-style list of arguments. The first element "
20060 "is the name of the program to run. Subsequent elements are parameters. The "
20061 "list must be non-empty (ie. must contain a program name). Note that the "
20062 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20066 #: ../fish/guestfish-actions.pod:720
20067 msgid "command-lines"
20071 #: ../fish/guestfish-actions.pod:722
20074 " command-lines 'arguments ...'\n"
20079 #: ../fish/guestfish-actions.pod:724
20081 "This is the same as L</command>, but splits the result into a list of lines."
20085 #: ../fish/guestfish-actions.pod:727
20086 msgid "See also: L</sh-lines>"
20090 #: ../fish/guestfish-actions.pod:732
20095 #: ../fish/guestfish-actions.pod:734
20098 " config qemuparam qemuvalue\n"
20103 #: ../fish/guestfish-actions.pod:745
20108 #: ../fish/guestfish-actions.pod:747
20111 " copy-size src dest size\n"
20116 #: ../fish/guestfish-actions.pod:755
20121 #: ../fish/guestfish-actions.pod:757
20129 #: ../fish/guestfish-actions.pod:762
20134 #: ../fish/guestfish-actions.pod:764
20142 #: ../fish/guestfish-actions.pod:769
20147 #: ../fish/guestfish-actions.pod:771
20155 #: ../fish/guestfish-actions.pod:778
20157 "If the destination is a device, it must be as large or larger than the "
20158 "source file or device, otherwise the copy will fail. This command cannot do "
20159 "partial copies (see L</copy-size>)."
20163 #: ../fish/guestfish-actions.pod:782
20168 #: ../fish/guestfish-actions.pod:784
20176 #: ../fish/guestfish-actions.pod:792
20181 #: ../fish/guestfish-actions.pod:794
20189 #: ../fish/guestfish-actions.pod:803
20194 #: ../fish/guestfish-actions.pod:805
20202 #: ../fish/guestfish-actions.pod:811
20204 "Another way to get the same information is to enable verbose messages with "
20205 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20206 "before running the program."
20210 #: ../fish/guestfish-actions.pod:816
20215 #: ../fish/guestfish-actions.pod:818
20218 " download remotefilename (filename|-)\n"
20223 #: ../fish/guestfish-actions.pod:825
20224 msgid "See also L</upload>, L</cat>."
20228 #: ../fish/guestfish-actions.pod:829
20229 msgid "download-offset"
20233 #: ../fish/guestfish-actions.pod:831
20236 " download-offset remotefilename (filename|-) offset size\n"
20241 #: ../fish/guestfish-actions.pod:839
20243 "Note that there is no limit on the amount of data that can be downloaded "
20244 "with this call, unlike with L</pread>, and this call always reads the full "
20245 "amount unless an error occurs."
20249 #: ../fish/guestfish-actions.pod:844
20250 msgid "See also L</download>, L</pread>."
20254 #: ../fish/guestfish-actions.pod:848
20255 msgid "drop-caches"
20259 #: ../fish/guestfish-actions.pod:850
20262 " drop-caches whattodrop\n"
20267 #: ../fish/guestfish-actions.pod:862
20272 #: ../fish/guestfish-actions.pod:864
20280 #: ../fish/guestfish-actions.pod:876
20285 #: ../fish/guestfish-actions.pod:878
20288 " e2fsck-f device\n"
20293 #: ../fish/guestfish-actions.pod:884
20295 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20296 "should use L</fsck>."
20300 #: ../fish/guestfish-actions.pod:887
20301 msgid "echo-daemon"
20305 #: ../fish/guestfish-actions.pod:889
20308 " echo-daemon 'words ...'\n"
20313 #: ../fish/guestfish-actions.pod:896
20314 msgid "See also L</ping-daemon>."
20318 #: ../fish/guestfish-actions.pod:898
20323 #: ../fish/guestfish-actions.pod:900
20326 " egrep regex path\n"
20331 #: ../fish/guestfish-actions.pod:908
20336 #: ../fish/guestfish-actions.pod:910
20339 " egrepi regex path\n"
20344 #: ../fish/guestfish-actions.pod:918
20349 #: ../fish/guestfish-actions.pod:920
20352 " equal file1 file2\n"
20357 #: ../fish/guestfish-actions.pod:927
20362 #: ../fish/guestfish-actions.pod:929
20370 #: ../fish/guestfish-actions.pod:934
20371 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20375 #: ../fish/guestfish-actions.pod:936
20380 #: ../fish/guestfish-actions.pod:938
20383 " fallocate path len\n"
20388 #: ../fish/guestfish-actions.pod:955
20389 msgid "fallocate64"
20393 #: ../fish/guestfish-actions.pod:957
20396 " fallocate64 path len\n"
20401 #: ../fish/guestfish-actions.pod:963
20403 "Note that this call allocates disk blocks for the file. To create a sparse "
20404 "file use L</truncate-size> instead."
20408 #: ../fish/guestfish-actions.pod:966
20410 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20411 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20412 "maximum size of files created through that call to 1GB."
20416 #: ../fish/guestfish-actions.pod:975
20421 #: ../fish/guestfish-actions.pod:977
20424 " fgrep pattern path\n"
20429 #: ../fish/guestfish-actions.pod:985
20434 #: ../fish/guestfish-actions.pod:987
20437 " fgrepi pattern path\n"
20442 #: ../fish/guestfish-actions.pod:995
20447 #: ../fish/guestfish-actions.pod:997
20455 #: ../fish/guestfish-actions.pod:1009
20457 "This command can also be used on C</dev/> devices (and partitions, LV "
20458 "names). You can for example use this to determine if a device contains a "
20459 "filesystem, although it's usually better to use L</vfs-type>."
20463 #: ../fish/guestfish-actions.pod:1019
20464 msgid "file-architecture"
20468 #: ../fish/guestfish-actions.pod:1021
20471 " file-architecture filename\n"
20476 #: ../fish/guestfish-actions.pod:1124
20481 #: ../fish/guestfish-actions.pod:1126
20489 #: ../fish/guestfish-actions.pod:1130
20491 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20492 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20496 #: ../fish/guestfish-actions.pod:1134
20501 #: ../fish/guestfish-actions.pod:1136
20504 " fill c len path\n"
20509 #: ../fish/guestfish-actions.pod:1142
20511 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20512 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20513 "L</fill-pattern>."
20517 #: ../fish/guestfish-actions.pod:1147
20518 msgid "fill-pattern"
20522 #: ../fish/guestfish-actions.pod:1149
20525 " fill-pattern pattern len path\n"
20530 #: ../fish/guestfish-actions.pod:1151
20532 "This function is like L</fill> except that it creates a new file of length "
20533 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20534 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20539 #: ../fish/guestfish-actions.pod:1156
20544 #: ../fish/guestfish-actions.pod:1158
20547 " find directory\n"
20552 #: ../fish/guestfish-actions.pod:1172
20553 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20557 #: ../fish/guestfish-actions.pod:1185
20558 msgid "See also L</find0>."
20562 #: ../fish/guestfish-actions.pod:1190
20567 #: ../fish/guestfish-actions.pod:1192
20570 " find0 directory (files|-)\n"
20575 #: ../fish/guestfish-actions.pod:1198
20577 "This command works the same way as L</find> with the following exceptions:"
20581 #: ../fish/guestfish-actions.pod:1225
20582 msgid "findfs-label"
20586 #: ../fish/guestfish-actions.pod:1227
20589 " findfs-label label\n"
20594 #: ../fish/guestfish-actions.pod:1233
20595 msgid "To find the label of a filesystem, use L</vfs-label>."
20599 #: ../fish/guestfish-actions.pod:1235
20600 msgid "findfs-uuid"
20604 #: ../fish/guestfish-actions.pod:1237
20607 " findfs-uuid uuid\n"
20612 #: ../fish/guestfish-actions.pod:1243
20613 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20617 #: ../fish/guestfish-actions.pod:1245
20622 #: ../fish/guestfish-actions.pod:1247
20625 " fsck fstype device\n"
20630 #: ../fish/guestfish-actions.pod:1277
20635 #: ../fish/guestfish-actions.pod:1279
20643 #: ../fish/guestfish-actions.pod:1286
20644 msgid "get-autosync"
20648 #: ../fish/guestfish-actions.pod:1288
20656 #: ../fish/guestfish-actions.pod:1292
20661 #: ../fish/guestfish-actions.pod:1294
20669 #: ../fish/guestfish-actions.pod:1298
20670 msgid "get-e2label"
20674 #: ../fish/guestfish-actions.pod:1300
20677 " get-e2label device\n"
20682 #: ../fish/guestfish-actions.pod:1312
20687 #: ../fish/guestfish-actions.pod:1314
20690 " get-e2uuid device\n"
20695 #: ../fish/guestfish-actions.pod:1326
20696 msgid "get-memsize"
20700 #: ../fish/guestfish-actions.pod:1328
20708 #: ../fish/guestfish-actions.pod:1333
20710 "If L</set-memsize> was not called on this handle, and if "
20711 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20712 "value for memsize."
20716 #: ../fish/guestfish-actions.pod:1340
20717 msgid "get-network"
20721 #: ../fish/guestfish-actions.pod:1342
20729 #: ../fish/guestfish-actions.pod:1346
20734 #: ../fish/guestfish-actions.pod:1348
20742 #: ../fish/guestfish-actions.pod:1355
20747 #: ../fish/guestfish-actions.pod:1357
20752 #: ../fish/guestfish-actions.pod:1359
20760 #: ../fish/guestfish-actions.pod:1366
20765 #: ../fish/guestfish-actions.pod:1368
20773 #: ../fish/guestfish-actions.pod:1375
20774 msgid "get-recovery-proc"
20778 #: ../fish/guestfish-actions.pod:1377
20781 " get-recovery-proc\n"
20786 #: ../fish/guestfish-actions.pod:1381
20787 msgid "get-selinux"
20791 #: ../fish/guestfish-actions.pod:1383
20799 #: ../fish/guestfish-actions.pod:1385
20801 "This returns the current setting of the selinux flag which is passed to the "
20802 "appliance at boot time. See L</set-selinux>."
20806 #: ../fish/guestfish-actions.pod:1391
20811 #: ../fish/guestfish-actions.pod:1393
20819 #: ../fish/guestfish-actions.pod:1400
20824 #: ../fish/guestfish-actions.pod:1402
20832 #: ../fish/guestfish-actions.pod:1406
20837 #: ../fish/guestfish-actions.pod:1408
20845 #: ../fish/guestfish-actions.pod:1410
20847 "Return the current umask. By default the umask is C<022> unless it has been "
20848 "set by calling L</umask>."
20852 #: ../fish/guestfish-actions.pod:1413
20853 msgid "get-verbose"
20857 #: ../fish/guestfish-actions.pod:1415
20865 #: ../fish/guestfish-actions.pod:1419
20870 #: ../fish/guestfish-actions.pod:1421
20878 #: ../fish/guestfish-actions.pod:1425
20879 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20883 #: ../fish/guestfish-actions.pod:1428
20888 #: ../fish/guestfish-actions.pod:1430
20891 " getxattrs path\n"
20896 #: ../fish/guestfish-actions.pod:1438
20897 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20901 #: ../fish/guestfish-actions.pod:1440
20902 msgid "glob-expand"
20906 #: ../fish/guestfish-actions.pod:1442
20909 " glob-expand pattern\n"
20914 #: ../fish/guestfish-actions.pod:1455
20919 #: ../fish/guestfish-actions.pod:1457
20922 " grep regex path\n"
20927 #: ../fish/guestfish-actions.pod:1465
20932 #: ../fish/guestfish-actions.pod:1467
20935 " grepi regex path\n"
20940 #: ../fish/guestfish-actions.pod:1475
20941 msgid "grub-install"
20945 #: ../fish/guestfish-actions.pod:1477
20948 " grub-install root device\n"
20953 #: ../fish/guestfish-actions.pod:1493
20958 #: ../fish/guestfish-actions.pod:1495
20966 #: ../fish/guestfish-actions.pod:1503
20971 #: ../fish/guestfish-actions.pod:1505
20974 " head-n nrlines path\n"
20979 #: ../fish/guestfish-actions.pod:1518
20984 #: ../fish/guestfish-actions.pod:1520
20992 #: ../fish/guestfish-actions.pod:1528
20997 #: ../fish/guestfish-actions.pod:1530
21000 " initrd-cat initrdpath filename\n"
21005 #: ../fish/guestfish-actions.pod:1542
21006 msgid "See also L</initrd-list>."
21010 #: ../fish/guestfish-actions.pod:1547
21011 msgid "initrd-list"
21015 #: ../fish/guestfish-actions.pod:1549
21018 " initrd-list path\n"
21023 #: ../fish/guestfish-actions.pod:1561
21024 msgid "inotify-add-watch"
21028 #: ../fish/guestfish-actions.pod:1563
21031 " inotify-add-watch path mask\n"
21036 #: ../fish/guestfish-actions.pod:1575
21037 msgid "inotify-close"
21041 #: ../fish/guestfish-actions.pod:1577
21049 #: ../fish/guestfish-actions.pod:1583
21050 msgid "inotify-files"
21054 #: ../fish/guestfish-actions.pod:1585
21062 #: ../fish/guestfish-actions.pod:1587
21064 "This function is a helpful wrapper around L</inotify-read> which just "
21065 "returns a list of pathnames of objects that were touched. The returned "
21066 "pathnames are sorted and deduplicated."
21070 #: ../fish/guestfish-actions.pod:1591
21071 msgid "inotify-init"
21075 #: ../fish/guestfish-actions.pod:1593
21078 " inotify-init maxevents\n"
21083 #: ../fish/guestfish-actions.pod:1599
21085 "C<maxevents> is the maximum number of events which will be queued up between "
21086 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21087 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21088 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21089 "but records the fact that it threw them away by setting a flag "
21090 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21094 #: ../fish/guestfish-actions.pod:1609
21096 "Before any events are generated, you have to add some watches to the "
21097 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21098 "L</inotify-watch-all>."
21102 #: ../fish/guestfish-actions.pod:1615
21104 "Queued up events should be read periodically by calling L</inotify-read> (or "
21105 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21106 "If you don't read the events out often enough then you risk the internal "
21107 "queue overflowing."
21111 #: ../fish/guestfish-actions.pod:1622
21113 "The handle should be closed after use by calling L</inotify-close>. This "
21114 "also removes any watches automatically."
21118 #: ../fish/guestfish-actions.pod:1631
21119 msgid "inotify-read"
21123 #: ../fish/guestfish-actions.pod:1633
21131 #: ../fish/guestfish-actions.pod:1646
21132 msgid "inotify-rm-watch"
21136 #: ../fish/guestfish-actions.pod:1648
21139 " inotify-rm-watch wd\n"
21144 #: ../fish/guestfish-actions.pod:1650
21145 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21149 #: ../fish/guestfish-actions.pod:1653
21150 msgid "inspect-get-arch"
21154 #: ../fish/guestfish-actions.pod:1655
21157 " inspect-get-arch root\n"
21162 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21163 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21164 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21165 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21166 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21167 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21168 #: ../fish/guestfish-actions.pod:1966
21170 "This function should only be called with a root device string as returned by "
21175 #: ../fish/guestfish-actions.pod:1660
21177 "This returns the architecture of the inspected operating system. The "
21178 "possible return values are listed under L</file-architecture>."
21182 #: ../fish/guestfish-actions.pod:1669
21183 msgid "inspect-get-distro"
21187 #: ../fish/guestfish-actions.pod:1671
21190 " inspect-get-distro root\n"
21195 #: ../fish/guestfish-actions.pod:1743
21196 msgid "inspect-get-filesystems"
21200 #: ../fish/guestfish-actions.pod:1745
21203 " inspect-get-filesystems root\n"
21208 #: ../fish/guestfish-actions.pod:1758
21210 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21211 "get-mountpoints>."
21215 #: ../fish/guestfish-actions.pod:1761
21216 msgid "inspect-get-hostname"
21220 #: ../fish/guestfish-actions.pod:1763
21223 " inspect-get-hostname root\n"
21228 #: ../fish/guestfish-actions.pod:1776
21229 msgid "inspect-get-major-version"
21233 #: ../fish/guestfish-actions.pod:1778
21236 " inspect-get-major-version root\n"
21241 #: ../fish/guestfish-actions.pod:1797
21242 msgid "inspect-get-minor-version"
21246 #: ../fish/guestfish-actions.pod:1799
21249 " inspect-get-minor-version root\n"
21254 #: ../fish/guestfish-actions.pod:1809
21256 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21257 "get-major-version>."
21261 #: ../fish/guestfish-actions.pod:1812
21262 msgid "inspect-get-mountpoints"
21266 #: ../fish/guestfish-actions.pod:1814
21269 " inspect-get-mountpoints root\n"
21274 #: ../fish/guestfish-actions.pod:1832
21276 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21277 "get-filesystems>."
21281 #: ../fish/guestfish-actions.pod:1835
21282 msgid "inspect-get-package-format"
21286 #: ../fish/guestfish-actions.pod:1837
21289 " inspect-get-package-format root\n"
21294 #: ../fish/guestfish-actions.pod:1842
21296 "This function and L</inspect-get-package-management> return the package "
21297 "format and package management tool used by the inspected operating system. "
21298 "For example for Fedora these functions would return C<rpm> (package format) "
21299 "and C<yum> (package management)."
21303 #: ../fish/guestfish-actions.pod:1857
21304 msgid "inspect-get-package-management"
21308 #: ../fish/guestfish-actions.pod:1859
21311 " inspect-get-package-management root\n"
21316 #: ../fish/guestfish-actions.pod:1864
21318 "L</inspect-get-package-format> and this function return the package format "
21319 "and package management tool used by the inspected operating system. For "
21320 "example for Fedora these functions would return C<rpm> (package format) and "
21321 "C<yum> (package management)."
21325 #: ../fish/guestfish-actions.pod:1881
21326 msgid "inspect-get-product-name"
21330 #: ../fish/guestfish-actions.pod:1883
21333 " inspect-get-product-name root\n"
21338 #: ../fish/guestfish-actions.pod:1898
21339 msgid "inspect-get-roots"
21343 #: ../fish/guestfish-actions.pod:1900
21346 " inspect-get-roots\n"
21351 #: ../fish/guestfish-actions.pod:1902
21353 "This function is a convenient way to get the list of root devices, as "
21354 "returned from a previous call to L</inspect-os>, but without redoing the "
21355 "whole inspection process."
21359 #: ../fish/guestfish-actions.pod:1906
21361 "This returns an empty list if either no root devices were found or the "
21362 "caller has not called L</inspect-os>."
21366 #: ../fish/guestfish-actions.pod:1911
21367 msgid "inspect-get-type"
21371 #: ../fish/guestfish-actions.pod:1913
21374 " inspect-get-type root\n"
21379 #: ../fish/guestfish-actions.pod:1946
21380 msgid "inspect-get-windows-systemroot"
21384 #: ../fish/guestfish-actions.pod:1948
21387 " inspect-get-windows-systemroot root\n"
21392 #: ../fish/guestfish-actions.pod:1962
21393 msgid "inspect-list-applications"
21397 #: ../fish/guestfish-actions.pod:1964
21400 " inspect-list-applications root\n"
21405 #: ../fish/guestfish-actions.pod:1971
21407 "I<Note:> This call works differently from other parts of the inspection "
21408 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21409 "then mount up the disks, before calling this. Listing applications is a "
21410 "significantly more difficult operation which requires access to the full "
21411 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21412 "are just returning data cached in the libguestfs handle, this call actually "
21413 "reads parts of the mounted filesystems during the call."
21417 #: ../fish/guestfish-actions.pod:2061
21422 #: ../fish/guestfish-actions.pod:2063
21430 #: ../fish/guestfish-actions.pod:2078
21432 "You can pass the root string(s) returned to other L</inspect-get-*> "
21433 "functions in order to query further information about each operating system, "
21434 "such as the name and version."
21438 #: ../fish/guestfish-actions.pod:2083
21440 "This function uses other libguestfs features such as L</mount-ro> and L</"
21441 "umount-all> in order to mount and unmount filesystems and look at the "
21442 "contents. This should be called with no disks currently mounted. The "
21443 "function may also use Augeas, so any existing Augeas handle will be closed."
21447 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21448 #: ../fish/guestfish-actions.pod:2297
21449 msgid "See also L</list-filesystems>."
21453 #: ../fish/guestfish-actions.pod:2097
21454 msgid "is-blockdev"
21458 #: ../fish/guestfish-actions.pod:2099
21461 " is-blockdev path\n"
21466 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21467 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21468 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21469 #: ../fish/guestfish-actions.pod:2203
21470 msgid "See also L</stat>."
21474 #: ../fish/guestfish-actions.pod:2106
21479 #: ../fish/guestfish-actions.pod:2108
21487 #: ../fish/guestfish-actions.pod:2115
21492 #: ../fish/guestfish-actions.pod:2117
21495 " is-chardev path\n"
21500 #: ../fish/guestfish-actions.pod:2124
21505 #: ../fish/guestfish-actions.pod:2126
21513 #: ../fish/guestfish-actions.pod:2133
21518 #: ../fish/guestfish-actions.pod:2135
21526 #: ../fish/guestfish-actions.pod:2143
21531 #: ../fish/guestfish-actions.pod:2145
21539 #: ../fish/guestfish-actions.pod:2152
21544 #: ../fish/guestfish-actions.pod:2154
21552 #: ../fish/guestfish-actions.pod:2162
21553 msgid "is-launching"
21557 #: ../fish/guestfish-actions.pod:2164
21565 #: ../fish/guestfish-actions.pod:2171
21570 #: ../fish/guestfish-actions.pod:2173
21578 #: ../fish/guestfish-actions.pod:2178
21583 #: ../fish/guestfish-actions.pod:2180
21591 #: ../fish/guestfish-actions.pod:2187
21596 #: ../fish/guestfish-actions.pod:2189
21599 " is-socket path\n"
21604 #: ../fish/guestfish-actions.pod:2196
21609 #: ../fish/guestfish-actions.pod:2198
21612 " is-symlink path\n"
21617 #: ../fish/guestfish-actions.pod:2205
21618 msgid "kill-subprocess"
21622 #: ../fish/guestfish-actions.pod:2207
21625 " kill-subprocess\n"
21630 #: ../fish/guestfish-actions.pod:2211
21635 #: ../fish/guestfish-actions.pod:2213
21640 #: ../fish/guestfish-actions.pod:2215
21648 #: ../fish/guestfish-actions.pod:2223
21653 #: ../fish/guestfish-actions.pod:2225
21656 " lchown owner group path\n"
21661 #: ../fish/guestfish-actions.pod:2227
21663 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21664 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21669 #: ../fish/guestfish-actions.pod:2235
21674 #: ../fish/guestfish-actions.pod:2237
21677 " lgetxattrs path\n"
21682 #: ../fish/guestfish-actions.pod:2239
21684 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21685 "it returns the extended attributes of the link itself."
21689 #: ../fish/guestfish-actions.pod:2243
21690 msgid "list-devices"
21694 #: ../fish/guestfish-actions.pod:2245
21702 #: ../fish/guestfish-actions.pod:2253
21703 msgid "list-filesystems"
21707 #: ../fish/guestfish-actions.pod:2255
21710 " list-filesystems\n"
21715 #: ../fish/guestfish-actions.pod:2274
21717 "This command runs other libguestfs commands, which might include L</mount> "
21718 "and L</umount>, and therefore you should use this soon after launch and only "
21719 "when nothing is mounted."
21723 #: ../fish/guestfish-actions.pod:2278
21725 "Not all of the filesystems returned will be mountable. In particular, swap "
21726 "partitions are returned in the list. Also this command does not check that "
21727 "each filesystem found is valid and mountable, and some filesystems might be "
21728 "mountable but require special options. Filesystems may not all belong to a "
21729 "single logical operating system (use L</inspect-os> to look for OSes)."
21733 #: ../fish/guestfish-actions.pod:2286
21734 msgid "list-partitions"
21738 #: ../fish/guestfish-actions.pod:2288
21741 " list-partitions\n"
21746 #: ../fish/guestfish-actions.pod:2294
21748 "This does not return logical volumes. For that you will need to call L</"
21753 #: ../fish/guestfish-actions.pod:2299
21758 #: ../fish/guestfish-actions.pod:2301
21766 #: ../fish/guestfish-actions.pod:2309
21771 #: ../fish/guestfish-actions.pod:2311
21774 " ln target linkname\n"
21779 #: ../fish/guestfish-actions.pod:2315
21784 #: ../fish/guestfish-actions.pod:2317
21787 " ln-f target linkname\n"
21792 #: ../fish/guestfish-actions.pod:2322
21797 #: ../fish/guestfish-actions.pod:2324
21800 " ln-s target linkname\n"
21805 #: ../fish/guestfish-actions.pod:2328
21810 #: ../fish/guestfish-actions.pod:2330
21813 " ln-sf target linkname\n"
21818 #: ../fish/guestfish-actions.pod:2335
21819 msgid "lremovexattr"
21823 #: ../fish/guestfish-actions.pod:2337
21826 " lremovexattr xattr path\n"
21831 #: ../fish/guestfish-actions.pod:2339
21833 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21834 "it removes an extended attribute of the link itself."
21838 #: ../fish/guestfish-actions.pod:2343
21843 #: ../fish/guestfish-actions.pod:2345
21851 #: ../fish/guestfish-actions.pod:2351
21853 "This command is mostly useful for interactive sessions. Programs should "
21854 "probably use L</readdir> instead."
21858 #: ../fish/guestfish-actions.pod:2354
21863 #: ../fish/guestfish-actions.pod:2356
21866 " lsetxattr xattr val vallen path\n"
21871 #: ../fish/guestfish-actions.pod:2358
21873 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21874 "sets an extended attribute of the link itself."
21878 #: ../fish/guestfish-actions.pod:2362
21883 #: ../fish/guestfish-actions.pod:2364
21891 #: ../fish/guestfish-actions.pod:2368
21893 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21894 "the link is stat-ed, not the file it refers to."
21898 #: ../fish/guestfish-actions.pod:2374
21903 #: ../fish/guestfish-actions.pod:2376
21906 " lstatlist path 'names ...'\n"
21911 #: ../fish/guestfish-actions.pod:2378
21913 "This call allows you to perform the L</lstat> operation on multiple files, "
21914 "where all files are in the directory C<path>. C<names> is the list of files "
21915 "from this directory."
21919 #: ../fish/guestfish-actions.pod:2387
21921 "This call is intended for programs that want to efficiently list a directory "
21922 "contents without making many round-trips. See also L</lxattrlist> for a "
21923 "similarly efficient call for getting extended attributes. Very long "
21924 "directory listings might cause the protocol message size to be exceeded, "
21925 "causing this call to fail. The caller must split up such requests into "
21926 "smaller groups of names."
21930 #: ../fish/guestfish-actions.pod:2395
21931 msgid "luks-add-key"
21935 #: ../fish/guestfish-actions.pod:2397
21938 " luks-add-key device keyslot\n"
21943 #: ../fish/guestfish-actions.pod:2404
21945 "Note that if C<keyslot> already contains a key, then this command will "
21946 "fail. You have to use L</luks-kill-slot> first to remove that key."
21950 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21951 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21952 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21954 "This command has one or more key or passphrase parameters. Guestfish will "
21955 "prompt for these separately."
21959 #: ../fish/guestfish-actions.pod:2411
21964 #: ../fish/guestfish-actions.pod:2413
21967 " luks-close device\n"
21972 #: ../fish/guestfish-actions.pod:2415
21974 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21975 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21976 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21981 #: ../fish/guestfish-actions.pod:2421
21982 msgid "luks-format"
21986 #: ../fish/guestfish-actions.pod:2423
21989 " luks-format device keyslot\n"
21994 #: ../fish/guestfish-actions.pod:2436
21995 msgid "luks-format-cipher"
21999 #: ../fish/guestfish-actions.pod:2438
22002 " luks-format-cipher device keyslot cipher\n"
22007 #: ../fish/guestfish-actions.pod:2440
22009 "This command is the same as L</luks-format> but it also allows you to set "
22010 "the C<cipher> used."
22014 #: ../fish/guestfish-actions.pod:2449
22015 msgid "luks-kill-slot"
22019 #: ../fish/guestfish-actions.pod:2451
22022 " luks-kill-slot device keyslot\n"
22027 #: ../fish/guestfish-actions.pod:2460
22032 #: ../fish/guestfish-actions.pod:2462
22035 " luks-open device mapname\n"
22040 #: ../fish/guestfish-actions.pod:2476
22042 "If this block device contains LVM volume groups, then calling L</vgscan> "
22043 "followed by L</vg-activate-all> will make them visible."
22047 #: ../fish/guestfish-actions.pod:2483
22048 msgid "luks-open-ro"
22052 #: ../fish/guestfish-actions.pod:2485
22055 " luks-open-ro device mapname\n"
22060 #: ../fish/guestfish-actions.pod:2487
22062 "This is the same as L</luks-open> except that a read-only mapping is created."
22066 #: ../fish/guestfish-actions.pod:2493
22071 #: ../fish/guestfish-actions.pod:2495
22074 " lvcreate logvol volgroup mbytes\n"
22079 #: ../fish/guestfish-actions.pod:2500
22080 msgid "lvm-canonical-lv-name"
22084 #: ../fish/guestfish-actions.pod:2502
22087 " lvm-canonical-lv-name lvname\n"
22092 #: ../fish/guestfish-actions.pod:2511
22093 msgid "See also L</is-lv>."
22097 #: ../fish/guestfish-actions.pod:2513
22098 msgid "lvm-clear-filter"
22102 #: ../fish/guestfish-actions.pod:2515
22105 " lvm-clear-filter\n"
22110 #: ../fish/guestfish-actions.pod:2517
22112 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22117 #: ../fish/guestfish-actions.pod:2523
22118 msgid "lvm-remove-all"
22122 #: ../fish/guestfish-actions.pod:2525
22125 " lvm-remove-all\n"
22130 #: ../fish/guestfish-actions.pod:2533
22131 msgid "lvm-set-filter"
22135 #: ../fish/guestfish-actions.pod:2535
22138 " lvm-set-filter 'devices ...'\n"
22143 #: ../fish/guestfish-actions.pod:2560
22148 #: ../fish/guestfish-actions.pod:2562
22151 " lvremove device\n"
22156 #: ../fish/guestfish-actions.pod:2570
22161 #: ../fish/guestfish-actions.pod:2572
22164 " lvrename logvol newlogvol\n"
22169 #: ../fish/guestfish-actions.pod:2576
22174 #: ../fish/guestfish-actions.pod:2578
22177 " lvresize device mbytes\n"
22182 #: ../fish/guestfish-actions.pod:2584
22183 msgid "lvresize-free"
22187 #: ../fish/guestfish-actions.pod:2586
22190 " lvresize-free lv percent\n"
22195 #: ../fish/guestfish-actions.pod:2594
22200 #: ../fish/guestfish-actions.pod:2596
22208 #: ../fish/guestfish-actions.pod:2604
22209 msgid "See also L</lvs-full>, L</list-filesystems>."
22213 #: ../fish/guestfish-actions.pod:2606
22218 #: ../fish/guestfish-actions.pod:2608
22226 #: ../fish/guestfish-actions.pod:2613
22231 #: ../fish/guestfish-actions.pod:2615
22239 #: ../fish/guestfish-actions.pod:2619
22244 #: ../fish/guestfish-actions.pod:2621
22247 " lxattrlist path 'names ...'\n"
22252 #: ../fish/guestfish-actions.pod:2637
22254 "This call is intended for programs that want to efficiently list a directory "
22255 "contents without making many round-trips. See also L</lstatlist> for a "
22256 "similarly efficient call for getting standard stats. Very long directory "
22257 "listings might cause the protocol message size to be exceeded, causing this "
22258 "call to fail. The caller must split up such requests into smaller groups of "
22263 #: ../fish/guestfish-actions.pod:2645
22268 #: ../fish/guestfish-actions.pod:2647
22276 #: ../fish/guestfish-actions.pod:2651
22281 #: ../fish/guestfish-actions.pod:2653
22284 " mkdir-mode path mode\n"
22289 #: ../fish/guestfish-actions.pod:2662
22290 msgid "See also L</mkdir>, L</umask>"
22294 #: ../fish/guestfish-actions.pod:2664
22299 #: ../fish/guestfish-actions.pod:2666
22307 #: ../fish/guestfish-actions.pod:2671
22312 #: ../fish/guestfish-actions.pod:2673
22315 " mkdtemp template\n"
22320 #: ../fish/guestfish-actions.pod:2694
22325 #: ../fish/guestfish-actions.pod:2696
22328 " mke2fs-J fstype blocksize device journal\n"
22333 #: ../fish/guestfish-actions.pod:2704
22334 msgid "See also L</mke2journal>."
22338 #: ../fish/guestfish-actions.pod:2706
22343 #: ../fish/guestfish-actions.pod:2708
22346 " mke2fs-JL fstype blocksize device label\n"
22351 #: ../fish/guestfish-actions.pod:2713
22352 msgid "See also L</mke2journal-L>."
22356 #: ../fish/guestfish-actions.pod:2715
22361 #: ../fish/guestfish-actions.pod:2717
22364 " mke2fs-JU fstype blocksize device uuid\n"
22369 #: ../fish/guestfish-actions.pod:2722
22370 msgid "See also L</mke2journal-U>."
22374 #: ../fish/guestfish-actions.pod:2724
22375 msgid "mke2journal"
22379 #: ../fish/guestfish-actions.pod:2726
22382 " mke2journal blocksize device\n"
22387 #: ../fish/guestfish-actions.pod:2733
22388 msgid "mke2journal-L"
22392 #: ../fish/guestfish-actions.pod:2735
22395 " mke2journal-L blocksize label device\n"
22400 #: ../fish/guestfish-actions.pod:2739
22401 msgid "mke2journal-U"
22405 #: ../fish/guestfish-actions.pod:2741
22408 " mke2journal-U blocksize uuid device\n"
22413 #: ../fish/guestfish-actions.pod:2745
22418 #: ../fish/guestfish-actions.pod:2747
22421 " mkfifo mode path\n"
22426 #: ../fish/guestfish-actions.pod:2749
22428 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22429 "is just a convenient wrapper around L</mknod>."
22433 #: ../fish/guestfish-actions.pod:2755
22438 #: ../fish/guestfish-actions.pod:2757
22441 " mkfs fstype device\n"
22446 #: ../fish/guestfish-actions.pod:2763
22451 #: ../fish/guestfish-actions.pod:2765
22454 " mkfs-b fstype blocksize device\n"
22459 #: ../fish/guestfish-actions.pod:2767
22461 "This call is similar to L</mkfs>, but it allows you to control the block "
22462 "size of the resulting filesystem. Supported block sizes depend on the "
22463 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22467 #: ../fish/guestfish-actions.pod:2775
22468 msgid "mkmountpoint"
22472 #: ../fish/guestfish-actions.pod:2777
22475 " mkmountpoint exemptpath\n"
22480 #: ../fish/guestfish-actions.pod:2779
22482 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22483 "to create extra mountpoints before mounting the first filesystem."
22487 #: ../fish/guestfish-actions.pod:2803
22489 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22490 "unexpected errors if you try to mix these calls. It is safest to manually "
22491 "unmount filesystems and remove mountpoints after use."
22495 #: ../fish/guestfish-actions.pod:2807
22497 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22498 "for this to work for manual mountpoints, you must ensure that the innermost "
22499 "mountpoints have the longest pathnames, as in the example code above."
22503 #: ../fish/guestfish-actions.pod:2814
22505 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22506 "that L</umount-all> is called when the handle is closed which can also "
22507 "trigger these issues."
22511 #: ../fish/guestfish-actions.pod:2818
22516 #: ../fish/guestfish-actions.pod:2820
22519 " mknod mode devmajor devminor path\n"
22524 #: ../fish/guestfish-actions.pod:2830
22526 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22527 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22528 "regular file). These constants are available in the standard Linux header "
22529 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22530 "wrappers around this command which bitwise OR in the appropriate constant "
22535 #: ../fish/guestfish-actions.pod:2840
22540 #: ../fish/guestfish-actions.pod:2842
22543 " mknod-b mode devmajor devminor path\n"
22548 #: ../fish/guestfish-actions.pod:2844
22550 "This call creates a block device node called C<path> with mode C<mode> and "
22551 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22552 "wrapper around L</mknod>."
22556 #: ../fish/guestfish-actions.pod:2850
22561 #: ../fish/guestfish-actions.pod:2852
22564 " mknod-c mode devmajor devminor path\n"
22569 #: ../fish/guestfish-actions.pod:2854
22571 "This call creates a char device node called C<path> with mode C<mode> and "
22572 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22573 "wrapper around L</mknod>."
22577 #: ../fish/guestfish-actions.pod:2860
22582 #: ../fish/guestfish-actions.pod:2862
22590 #: ../fish/guestfish-actions.pod:2866
22595 #: ../fish/guestfish-actions.pod:2868
22598 " mkswap-L label device\n"
22603 #: ../fish/guestfish-actions.pod:2876
22608 #: ../fish/guestfish-actions.pod:2878
22611 " mkswap-U uuid device\n"
22616 #: ../fish/guestfish-actions.pod:2882
22617 msgid "mkswap-file"
22621 #: ../fish/guestfish-actions.pod:2884
22624 " mkswap-file path\n"
22629 #: ../fish/guestfish-actions.pod:2888
22631 "This command just writes a swap file signature to an existing file. To "
22632 "create the file itself, use something like L</fallocate>."
22636 #: ../fish/guestfish-actions.pod:2891
22641 #: ../fish/guestfish-actions.pod:2893
22644 " modprobe modulename\n"
22649 #: ../fish/guestfish-actions.pod:2900
22654 #: ../fish/guestfish-actions.pod:2902
22657 " mount device mountpoint\n"
22662 #: ../fish/guestfish-actions.pod:2918
22664 "B<Important note:> When you use this call, the filesystem options C<sync> "
22665 "and C<noatime> are set implicitly. This was originally done because we "
22666 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22667 "very large negative performance impact and negligible effect on "
22668 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22669 "code that needs performance, and instead use L</mount-options> (use an empty "
22670 "string for the first parameter if you don't want any options)."
22674 #: ../fish/guestfish-actions.pod:2928
22679 #: ../fish/guestfish-actions.pod:2930
22682 " mount-loop file mountpoint\n"
22687 #: ../fish/guestfish-actions.pod:2936
22688 msgid "mount-options"
22692 #: ../fish/guestfish-actions.pod:2938
22695 " mount-options options device mountpoint\n"
22700 #: ../fish/guestfish-actions.pod:2940
22702 "This is the same as the L</mount> command, but it allows you to set the "
22703 "mount options as for the L<mount(8)> I<-o> flag."
22707 #: ../fish/guestfish-actions.pod:2948
22712 #: ../fish/guestfish-actions.pod:2950
22715 " mount-ro device mountpoint\n"
22720 #: ../fish/guestfish-actions.pod:2952
22722 "This is the same as the L</mount> command, but it mounts the filesystem with "
22723 "the read-only (I<-o ro>) flag."
22727 #: ../fish/guestfish-actions.pod:2955
22732 #: ../fish/guestfish-actions.pod:2957
22735 " mount-vfs options vfstype device mountpoint\n"
22740 #: ../fish/guestfish-actions.pod:2959
22742 "This is the same as the L</mount> command, but it allows you to set both the "
22743 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22747 #: ../fish/guestfish-actions.pod:2963
22748 msgid "mountpoints"
22752 #: ../fish/guestfish-actions.pod:2965
22760 #: ../fish/guestfish-actions.pod:2967
22762 "This call is similar to L</mounts>. That call returns a list of devices. "
22763 "This one returns a hash table (map) of device name to directory where the "
22764 "device is mounted."
22768 #: ../fish/guestfish-actions.pod:2971
22773 #: ../fish/guestfish-actions.pod:2973
22781 #: ../fish/guestfish-actions.pod:2980
22782 msgid "See also: L</mountpoints>"
22786 #: ../fish/guestfish-actions.pod:2982
22791 #: ../fish/guestfish-actions.pod:2984
22799 #: ../fish/guestfish-actions.pod:2989
22800 msgid "ntfs-3g-probe"
22804 #: ../fish/guestfish-actions.pod:2991
22807 " ntfs-3g-probe true|false device\n"
22812 #: ../fish/guestfish-actions.pod:3005
22817 #: ../fish/guestfish-actions.pod:3007
22820 " ntfsresize device\n"
22825 #: ../fish/guestfish-actions.pod:3013
22826 msgid "ntfsresize-size"
22830 #: ../fish/guestfish-actions.pod:3015
22833 " ntfsresize-size device size\n"
22838 #: ../fish/guestfish-actions.pod:3017
22840 "This command is the same as L</ntfsresize> except that it allows you to "
22841 "specify the new size (in bytes) explicitly."
22845 #: ../fish/guestfish-actions.pod:3020
22850 #: ../fish/guestfish-actions.pod:3022
22853 " part-add device prlogex startsect endsect\n"
22858 #: ../fish/guestfish-actions.pod:3024
22860 "This command adds a partition to C<device>. If there is no partition table "
22861 "on the device, call L</part-init> first."
22865 #: ../fish/guestfish-actions.pod:3036
22867 "Creating a partition which covers the whole disk is not so easy. Use L</"
22868 "part-disk> to do that."
22872 #: ../fish/guestfish-actions.pod:3039
22877 #: ../fish/guestfish-actions.pod:3041
22880 " part-del device partnum\n"
22885 #: ../fish/guestfish-actions.pod:3049
22890 #: ../fish/guestfish-actions.pod:3051
22893 " part-disk device parttype\n"
22898 #: ../fish/guestfish-actions.pod:3053
22900 "This command is simply a combination of L</part-init> followed by L</part-"
22901 "add> to create a single primary partition covering the whole disk."
22905 #: ../fish/guestfish-actions.pod:3057
22907 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22908 "possible values are described in L</part-init>."
22912 #: ../fish/guestfish-actions.pod:3063
22913 msgid "part-get-bootable"
22917 #: ../fish/guestfish-actions.pod:3065
22920 " part-get-bootable device partnum\n"
22925 #: ../fish/guestfish-actions.pod:3070
22926 msgid "See also L</part-set-bootable>."
22930 #: ../fish/guestfish-actions.pod:3072
22931 msgid "part-get-mbr-id"
22935 #: ../fish/guestfish-actions.pod:3074
22938 " part-get-mbr-id device partnum\n"
22943 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22945 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22946 "undefined results for other partition table types (see L</part-get-"
22951 #: ../fish/guestfish-actions.pod:3083
22952 msgid "part-get-parttype"
22956 #: ../fish/guestfish-actions.pod:3085
22959 " part-get-parttype device\n"
22964 #: ../fish/guestfish-actions.pod:3090
22966 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22967 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22968 "possible, although unusual. See L</part-init> for a full list."
22972 #: ../fish/guestfish-actions.pod:3095
22977 #: ../fish/guestfish-actions.pod:3097
22980 " part-init device parttype\n"
22985 #: ../fish/guestfish-actions.pod:3103
22987 "Initially there are no partitions. Following this, you should call L</part-"
22988 "add> for each partition required."
22992 #: ../fish/guestfish-actions.pod:3166
22997 #: ../fish/guestfish-actions.pod:3168
23000 " part-list device\n"
23005 #: ../fish/guestfish-actions.pod:3183
23007 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23008 "the device's sector size, see L</blockdev-getss>."
23012 #: ../fish/guestfish-actions.pod:3196
23013 msgid "part-set-bootable"
23017 #: ../fish/guestfish-actions.pod:3198
23020 " part-set-bootable device partnum true|false\n"
23025 #: ../fish/guestfish-actions.pod:3207
23026 msgid "part-set-mbr-id"
23030 #: ../fish/guestfish-actions.pod:3209
23033 " part-set-mbr-id device partnum idbyte\n"
23038 #: ../fish/guestfish-actions.pod:3221
23039 msgid "part-set-name"
23043 #: ../fish/guestfish-actions.pod:3223
23046 " part-set-name device partnum name\n"
23051 #: ../fish/guestfish-actions.pod:3231
23052 msgid "part-to-dev"
23056 #: ../fish/guestfish-actions.pod:3233
23059 " part-to-dev partition\n"
23064 #: ../fish/guestfish-actions.pod:3239
23066 "The named partition must exist, for example as a string returned from L</"
23067 "list-partitions>."
23071 #: ../fish/guestfish-actions.pod:3242
23072 msgid "ping-daemon"
23076 #: ../fish/guestfish-actions.pod:3244
23084 #: ../fish/guestfish-actions.pod:3251
23089 #: ../fish/guestfish-actions.pod:3253
23092 " pread path count offset\n"
23097 #: ../fish/guestfish-actions.pod:3261
23098 msgid "See also L</pwrite>, L</pread-device>."
23102 #: ../fish/guestfish-actions.pod:3266
23103 msgid "pread-device"
23107 #: ../fish/guestfish-actions.pod:3268
23110 " pread-device device count offset\n"
23115 #: ../fish/guestfish-actions.pod:3276
23116 msgid "See also L</pread>."
23120 #: ../fish/guestfish-actions.pod:3281
23125 #: ../fish/guestfish-actions.pod:3283
23128 " pvcreate device\n"
23133 #: ../fish/guestfish-actions.pod:3289
23138 #: ../fish/guestfish-actions.pod:3291
23141 " pvremove device\n"
23146 #: ../fish/guestfish-actions.pod:3300
23151 #: ../fish/guestfish-actions.pod:3302
23154 " pvresize device\n"
23159 #: ../fish/guestfish-actions.pod:3307
23160 msgid "pvresize-size"
23164 #: ../fish/guestfish-actions.pod:3309
23167 " pvresize-size device size\n"
23172 #: ../fish/guestfish-actions.pod:3311
23174 "This command is the same as L</pvresize> except that it allows you to "
23175 "specify the new size (in bytes) explicitly."
23179 #: ../fish/guestfish-actions.pod:3314
23184 #: ../fish/guestfish-actions.pod:3316
23192 #: ../fish/guestfish-actions.pod:3324
23193 msgid "See also L</pvs-full>."
23197 #: ../fish/guestfish-actions.pod:3326
23202 #: ../fish/guestfish-actions.pod:3328
23210 #: ../fish/guestfish-actions.pod:3333
23215 #: ../fish/guestfish-actions.pod:3335
23223 #: ../fish/guestfish-actions.pod:3339
23228 #: ../fish/guestfish-actions.pod:3341
23231 " pwrite path content offset\n"
23236 #: ../fish/guestfish-actions.pod:3352
23237 msgid "See also L</pread>, L</pwrite-device>."
23241 #: ../fish/guestfish-actions.pod:3357
23242 msgid "pwrite-device"
23246 #: ../fish/guestfish-actions.pod:3359
23249 " pwrite-device device content offset\n"
23254 #: ../fish/guestfish-actions.pod:3369
23255 msgid "See also L</pwrite>."
23259 #: ../fish/guestfish-actions.pod:3374
23264 #: ../fish/guestfish-actions.pod:3376
23267 " read-file path\n"
23272 #: ../fish/guestfish-actions.pod:3381
23274 "Unlike L</cat>, this function can correctly handle files that contain "
23275 "embedded ASCII NUL characters. However unlike L</download>, this function "
23276 "is limited in the total size of file that can be handled."
23280 #: ../fish/guestfish-actions.pod:3389
23285 #: ../fish/guestfish-actions.pod:3391
23288 " read-lines path\n"
23293 #: ../fish/guestfish-actions.pod:3398
23295 "Note that this function cannot correctly handle binary files (specifically, "
23296 "files containing C<\\0> character which is treated as end of line). For "
23297 "those you need to use the L</read-file> function which has a more complex "
23302 #: ../fish/guestfish-actions.pod:3403
23307 #: ../fish/guestfish-actions.pod:3405
23315 #: ../fish/guestfish-actions.pod:3457
23317 "This function is primarily intended for use by programs. To get a simple "
23318 "list of names, use L</ls>. To get a printable directory for human "
23319 "consumption, use L</ll>."
23323 #: ../fish/guestfish-actions.pod:3461
23328 #: ../fish/guestfish-actions.pod:3463
23336 #: ../fish/guestfish-actions.pod:3467
23337 msgid "readlinklist"
23341 #: ../fish/guestfish-actions.pod:3469
23344 " readlinklist path 'names ...'\n"
23349 #: ../fish/guestfish-actions.pod:3493
23354 #: ../fish/guestfish-actions.pod:3495
23362 #: ../fish/guestfish-actions.pod:3500
23363 msgid "removexattr"
23367 #: ../fish/guestfish-actions.pod:3502
23370 " removexattr xattr path\n"
23375 #: ../fish/guestfish-actions.pod:3507
23376 msgid "See also: L</lremovexattr>, L<attr(5)>."
23380 #: ../fish/guestfish-actions.pod:3509
23385 #: ../fish/guestfish-actions.pod:3511
23388 " resize2fs device\n"
23393 #: ../fish/guestfish-actions.pod:3516
23395 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23396 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23397 "gives an error about this and sometimes not. In any case, it is always safe "
23398 "to call L</e2fsck-f> before calling this function."
23402 #: ../fish/guestfish-actions.pod:3522
23403 msgid "resize2fs-size"
23407 #: ../fish/guestfish-actions.pod:3524
23410 " resize2fs-size device size\n"
23415 #: ../fish/guestfish-actions.pod:3526
23417 "This command is the same as L</resize2fs> except that it allows you to "
23418 "specify the new size (in bytes) explicitly."
23422 #: ../fish/guestfish-actions.pod:3529
23427 #: ../fish/guestfish-actions.pod:3531
23435 #: ../fish/guestfish-actions.pod:3535
23440 #: ../fish/guestfish-actions.pod:3537
23448 #: ../fish/guestfish-actions.pod:3543
23453 #: ../fish/guestfish-actions.pod:3545
23461 #: ../fish/guestfish-actions.pod:3549
23462 msgid "rmmountpoint"
23466 #: ../fish/guestfish-actions.pod:3551
23469 " rmmountpoint exemptpath\n"
23474 #: ../fish/guestfish-actions.pod:3553
23476 "This calls removes a mountpoint that was previously created with L</"
23477 "mkmountpoint>. See L</mkmountpoint> for full details."
23481 #: ../fish/guestfish-actions.pod:3557
23482 msgid "scrub-device"
23486 #: ../fish/guestfish-actions.pod:3559
23489 " scrub-device device\n"
23494 #: ../fish/guestfish-actions.pod:3570
23499 #: ../fish/guestfish-actions.pod:3572
23502 " scrub-file file\n"
23507 #: ../fish/guestfish-actions.pod:3582
23508 msgid "scrub-freespace"
23512 #: ../fish/guestfish-actions.pod:3584
23515 " scrub-freespace dir\n"
23520 #: ../fish/guestfish-actions.pod:3586
23522 "This command creates the directory C<dir> and then fills it with files until "
23523 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23524 "deletes them. The intention is to scrub any free space on the partition "
23525 "containing C<dir>."
23529 #: ../fish/guestfish-actions.pod:3595
23534 #: ../fish/guestfish-actions.pod:3597
23539 #: ../fish/guestfish-actions.pod:3599
23542 " set-append append\n"
23547 #: ../fish/guestfish-actions.pod:3610
23548 msgid "set-autosync"
23552 #: ../fish/guestfish-actions.pod:3612
23557 #: ../fish/guestfish-actions.pod:3614
23560 " set-autosync true|false\n"
23565 #: ../fish/guestfish-actions.pod:3616
23567 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23568 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23569 "closed (also if the program exits without closing handles)."
23573 #: ../fish/guestfish-actions.pod:3624
23578 #: ../fish/guestfish-actions.pod:3626
23583 #: ../fish/guestfish-actions.pod:3628
23586 " set-direct true|false\n"
23591 #: ../fish/guestfish-actions.pod:3634
23593 "One consequence of this is that log messages aren't caught by the library "
23594 "and handled by L</set-log-message-callback>, but go straight to stdout."
23598 #: ../fish/guestfish-actions.pod:3643
23599 msgid "set-e2label"
23603 #: ../fish/guestfish-actions.pod:3645
23606 " set-e2label device label\n"
23611 #: ../fish/guestfish-actions.pod:3651
23613 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23614 "label on a filesystem."
23618 #: ../fish/guestfish-actions.pod:3654
23623 #: ../fish/guestfish-actions.pod:3656
23626 " set-e2uuid device uuid\n"
23631 #: ../fish/guestfish-actions.pod:3663
23633 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23634 "UUID of a filesystem."
23638 #: ../fish/guestfish-actions.pod:3666
23639 msgid "set-memsize"
23643 #: ../fish/guestfish-actions.pod:3668
23648 #: ../fish/guestfish-actions.pod:3670
23651 " set-memsize memsize\n"
23656 #: ../fish/guestfish-actions.pod:3672
23658 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23659 "This only has any effect if called before L</launch>."
23663 #: ../fish/guestfish-actions.pod:3683
23664 msgid "set-network"
23668 #: ../fish/guestfish-actions.pod:3685
23673 #: ../fish/guestfish-actions.pod:3687
23676 " set-network true|false\n"
23681 #: ../fish/guestfish-actions.pod:3695
23683 "You must call this before calling L</launch>, otherwise it has no effect."
23687 #: ../fish/guestfish-actions.pod:3698
23692 #: ../fish/guestfish-actions.pod:3700
23697 #: ../fish/guestfish-actions.pod:3702
23700 " set-path searchpath\n"
23705 #: ../fish/guestfish-actions.pod:3711
23710 #: ../fish/guestfish-actions.pod:3713
23715 #: ../fish/guestfish-actions.pod:3715
23723 #: ../fish/guestfish-actions.pod:3735
23724 msgid "set-recovery-proc"
23728 #: ../fish/guestfish-actions.pod:3737
23729 msgid "recovery-proc"
23733 #: ../fish/guestfish-actions.pod:3739
23736 " set-recovery-proc true|false\n"
23741 #: ../fish/guestfish-actions.pod:3741
23743 "If this is called with the parameter C<false> then L</launch> does not "
23744 "create a recovery process. The purpose of the recovery process is to stop "
23745 "runaway qemu processes in the case where the main program aborts abruptly."
23749 #: ../fish/guestfish-actions.pod:3746
23751 "This only has any effect if called before L</launch>, and the default is "
23756 #: ../fish/guestfish-actions.pod:3755
23757 msgid "set-selinux"
23761 #: ../fish/guestfish-actions.pod:3757
23766 #: ../fish/guestfish-actions.pod:3759
23769 " set-selinux true|false\n"
23774 #: ../fish/guestfish-actions.pod:3770
23779 #: ../fish/guestfish-actions.pod:3772
23784 #: ../fish/guestfish-actions.pod:3774
23787 " set-trace true|false\n"
23792 #: ../fish/guestfish-actions.pod:3790
23793 msgid "set-verbose"
23797 #: ../fish/guestfish-actions.pod:3792
23802 #: ../fish/guestfish-actions.pod:3794
23805 " set-verbose true|false\n"
23810 #: ../fish/guestfish-actions.pod:3801
23815 #: ../fish/guestfish-actions.pod:3803
23818 " setcon context\n"
23823 #: ../fish/guestfish-actions.pod:3810
23828 #: ../fish/guestfish-actions.pod:3812
23831 " setxattr xattr val vallen path\n"
23836 #: ../fish/guestfish-actions.pod:3818
23837 msgid "See also: L</lsetxattr>, L<attr(5)>."
23841 #: ../fish/guestfish-actions.pod:3820
23846 #: ../fish/guestfish-actions.pod:3822
23849 " sfdisk device cyls heads sectors 'lines ...'\n"
23854 #: ../fish/guestfish-actions.pod:3844
23855 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23859 #: ../fish/guestfish-actions.pod:3850
23864 #: ../fish/guestfish-actions.pod:3852
23867 " sfdiskM device 'lines ...'\n"
23872 #: ../fish/guestfish-actions.pod:3854
23874 "This is a simplified interface to the L</sfdisk> command, where partition "
23875 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23876 "you don't need to specify the cyls, heads and sectors parameters which were "
23877 "rarely if ever used anyway."
23881 #: ../fish/guestfish-actions.pod:3860
23882 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23886 #: ../fish/guestfish-actions.pod:3866
23891 #: ../fish/guestfish-actions.pod:3868
23894 " sfdisk-N device partnum cyls heads sectors line\n"
23899 #: ../fish/guestfish-actions.pod:3873
23901 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23902 "cyls/heads/sectors parameters."
23906 #: ../fish/guestfish-actions.pod:3876
23907 msgid "See also: L</part-add>"
23911 #: ../fish/guestfish-actions.pod:3881
23912 msgid "sfdisk-disk-geometry"
23916 #: ../fish/guestfish-actions.pod:3883
23919 " sfdisk-disk-geometry device\n"
23924 #: ../fish/guestfish-actions.pod:3885
23926 "This displays the disk geometry of C<device> read from the partition table. "
23927 "Especially in the case where the underlying block device has been resized, "
23928 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23929 "kernel-geometry>)."
23933 #: ../fish/guestfish-actions.pod:3893
23934 msgid "sfdisk-kernel-geometry"
23938 #: ../fish/guestfish-actions.pod:3895
23941 " sfdisk-kernel-geometry device\n"
23946 #: ../fish/guestfish-actions.pod:3902
23951 #: ../fish/guestfish-actions.pod:3904
23954 " sfdisk-l device\n"
23959 #: ../fish/guestfish-actions.pod:3910
23960 msgid "See also: L</part-list>"
23964 #: ../fish/guestfish-actions.pod:3912
23969 #: ../fish/guestfish-actions.pod:3914
23977 #: ../fish/guestfish-actions.pod:3919
23978 msgid "This is like L</command>, but passes the command to:"
23982 #: ../fish/guestfish-actions.pod:3927
23983 msgid "All the provisos about L</command> apply to this call."
23987 #: ../fish/guestfish-actions.pod:3929
23992 #: ../fish/guestfish-actions.pod:3931
23995 " sh-lines command\n"
24000 #: ../fish/guestfish-actions.pod:3933
24001 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24005 #: ../fish/guestfish-actions.pod:3936
24006 msgid "See also: L</command-lines>"
24010 #: ../fish/guestfish-actions.pod:3938
24015 #: ../fish/guestfish-actions.pod:3940
24023 #: ../fish/guestfish-actions.pod:3944
24028 #: ../fish/guestfish-actions.pod:3946
24036 #: ../fish/guestfish-actions.pod:3952
24041 #: ../fish/guestfish-actions.pod:3954
24049 #: ../fish/guestfish-actions.pod:3962
24054 #: ../fish/guestfish-actions.pod:3964
24062 #: ../fish/guestfish-actions.pod:3972
24067 #: ../fish/guestfish-actions.pod:3974
24070 " strings-e encoding path\n"
24075 #: ../fish/guestfish-actions.pod:3976
24077 "This is like the L</strings> command, but allows you to specify the encoding "
24078 "of strings that are looked for in the source file C<path>."
24082 #: ../fish/guestfish-actions.pod:3986
24084 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24085 "ISO-8859-X (this is what L</strings> uses)."
24089 #: ../fish/guestfish-actions.pod:4018
24090 msgid "swapoff-device"
24094 #: ../fish/guestfish-actions.pod:4020
24097 " swapoff-device device\n"
24102 #: ../fish/guestfish-actions.pod:4022
24104 "This command disables the libguestfs appliance swap device or partition "
24105 "named C<device>. See L</swapon-device>."
24109 #: ../fish/guestfish-actions.pod:4026
24110 msgid "swapoff-file"
24114 #: ../fish/guestfish-actions.pod:4028
24117 " swapoff-file file\n"
24122 #: ../fish/guestfish-actions.pod:4032
24123 msgid "swapoff-label"
24127 #: ../fish/guestfish-actions.pod:4034
24130 " swapoff-label label\n"
24135 #: ../fish/guestfish-actions.pod:4039
24136 msgid "swapoff-uuid"
24140 #: ../fish/guestfish-actions.pod:4041
24143 " swapoff-uuid uuid\n"
24148 #: ../fish/guestfish-actions.pod:4046
24149 msgid "swapon-device"
24153 #: ../fish/guestfish-actions.pod:4048
24156 " swapon-device device\n"
24161 #: ../fish/guestfish-actions.pod:4050
24163 "This command enables the libguestfs appliance to use the swap device or "
24164 "partition named C<device>. The increased memory is made available for all "
24165 "commands, for example those run using L</command> or L</sh>."
24169 #: ../fish/guestfish-actions.pod:4062
24170 msgid "swapon-file"
24174 #: ../fish/guestfish-actions.pod:4064
24177 " swapon-file file\n"
24182 #: ../fish/guestfish-actions.pod:4066
24184 "This command enables swap to a file. See L</swapon-device> for other notes."
24188 #: ../fish/guestfish-actions.pod:4069
24189 msgid "swapon-label"
24193 #: ../fish/guestfish-actions.pod:4071
24196 " swapon-label label\n"
24201 #: ../fish/guestfish-actions.pod:4073
24203 "This command enables swap to a labeled swap partition. See L</swapon-"
24204 "device> for other notes."
24208 #: ../fish/guestfish-actions.pod:4076
24209 msgid "swapon-uuid"
24213 #: ../fish/guestfish-actions.pod:4078
24216 " swapon-uuid uuid\n"
24221 #: ../fish/guestfish-actions.pod:4080
24223 "This command enables swap to a swap partition with the given UUID. See L</"
24224 "swapon-device> for other notes."
24228 #: ../fish/guestfish-actions.pod:4083
24233 #: ../fish/guestfish-actions.pod:4085
24241 #: ../fish/guestfish-actions.pod:4093
24246 #: ../fish/guestfish-actions.pod:4095
24254 #: ../fish/guestfish-actions.pod:4103
24259 #: ../fish/guestfish-actions.pod:4105
24262 " tail-n nrlines path\n"
24267 #: ../fish/guestfish-actions.pod:4118
24272 #: ../fish/guestfish-actions.pod:4120
24275 " tar-in (tarfile|-) directory\n"
24280 #: ../fish/guestfish-actions.pod:4125
24281 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24285 #: ../fish/guestfish-actions.pod:4130
24290 #: ../fish/guestfish-actions.pod:4132
24293 " tar-out directory (tarfile|-)\n"
24298 #: ../fish/guestfish-actions.pod:4137
24299 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24303 #: ../fish/guestfish-actions.pod:4142
24308 #: ../fish/guestfish-actions.pod:4144
24311 " tgz-in (tarball|-) directory\n"
24316 #: ../fish/guestfish-actions.pod:4149
24317 msgid "To upload an uncompressed tarball, use L</tar-in>."
24321 #: ../fish/guestfish-actions.pod:4153
24326 #: ../fish/guestfish-actions.pod:4155
24329 " tgz-out directory (tarball|-)\n"
24334 #: ../fish/guestfish-actions.pod:4160
24335 msgid "To download an uncompressed tarball, use L</tar-out>."
24339 #: ../fish/guestfish-actions.pod:4164
24344 #: ../fish/guestfish-actions.pod:4166
24352 #: ../fish/guestfish-actions.pod:4175
24357 #: ../fish/guestfish-actions.pod:4177
24365 #: ../fish/guestfish-actions.pod:4182
24366 msgid "truncate-size"
24370 #: ../fish/guestfish-actions.pod:4184
24373 " truncate-size path size\n"
24378 #: ../fish/guestfish-actions.pod:4189
24380 "If the current file size is less than C<size> then the file is extended to "
24381 "the required size with zero bytes. This creates a sparse file (ie. disk "
24382 "blocks are not allocated for the file until you write to it). To create a "
24383 "non-sparse file of zeroes, use L</fallocate64> instead."
24387 #: ../fish/guestfish-actions.pod:4195
24392 #: ../fish/guestfish-actions.pod:4197
24395 " tune2fs-l device\n"
24400 #: ../fish/guestfish-actions.pod:4207
24405 #: ../fish/guestfish-actions.pod:4209
24408 " txz-in (tarball|-) directory\n"
24413 #: ../fish/guestfish-actions.pod:4216
24418 #: ../fish/guestfish-actions.pod:4218
24421 " txz-out directory (tarball|-)\n"
24426 #: ../fish/guestfish-actions.pod:4225
24431 #: ../fish/guestfish-actions.pod:4227
24439 #: ../fish/guestfish-actions.pod:4241
24440 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24444 #: ../fish/guestfish-actions.pod:4246
24449 #: ../fish/guestfish-actions.pod:4248
24454 #: ../fish/guestfish-actions.pod:4250
24457 " umount pathordevice\n"
24462 #: ../fish/guestfish-actions.pod:4256
24467 #: ../fish/guestfish-actions.pod:4258
24468 msgid "unmount-all"
24472 #: ../fish/guestfish-actions.pod:4260
24480 #: ../fish/guestfish-actions.pod:4266
24485 #: ../fish/guestfish-actions.pod:4268
24488 " upload (filename|-) remotefilename\n"
24493 #: ../fish/guestfish-actions.pod:4275
24494 msgid "See also L</download>."
24498 #: ../fish/guestfish-actions.pod:4279
24499 msgid "upload-offset"
24503 #: ../fish/guestfish-actions.pod:4281
24506 " upload-offset (filename|-) remotefilename offset\n"
24511 #: ../fish/guestfish-actions.pod:4293
24513 "Note that there is no limit on the amount of data that can be uploaded with "
24514 "this call, unlike with L</pwrite>, and this call always writes the full "
24515 "amount unless an error occurs."
24519 #: ../fish/guestfish-actions.pod:4298
24520 msgid "See also L</upload>, L</pwrite>."
24524 #: ../fish/guestfish-actions.pod:4302
24529 #: ../fish/guestfish-actions.pod:4304
24532 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24537 #: ../fish/guestfish-actions.pod:4323
24542 #: ../fish/guestfish-actions.pod:4325
24550 #: ../fish/guestfish-actions.pod:4352
24552 "I<Note:> Don't use this call to test for availability of features. In "
24553 "enterprise distributions we backport features from later versions into "
24554 "earlier versions, making this an unreliable way to test for features. Use "
24555 "L</available> instead."
24559 #: ../fish/guestfish-actions.pod:4358
24564 #: ../fish/guestfish-actions.pod:4360
24567 " vfs-label device\n"
24572 #: ../fish/guestfish-actions.pod:4367
24573 msgid "To find a filesystem from the label, use L</findfs-label>."
24577 #: ../fish/guestfish-actions.pod:4369
24582 #: ../fish/guestfish-actions.pod:4371
24585 " vfs-type device\n"
24590 #: ../fish/guestfish-actions.pod:4381
24595 #: ../fish/guestfish-actions.pod:4383
24598 " vfs-uuid device\n"
24603 #: ../fish/guestfish-actions.pod:4390
24604 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24608 #: ../fish/guestfish-actions.pod:4392
24609 msgid "vg-activate"
24613 #: ../fish/guestfish-actions.pod:4394
24616 " vg-activate true|false 'volgroups ...'\n"
24621 #: ../fish/guestfish-actions.pod:4407
24622 msgid "vg-activate-all"
24626 #: ../fish/guestfish-actions.pod:4409
24629 " vg-activate-all true|false\n"
24634 #: ../fish/guestfish-actions.pod:4419
24639 #: ../fish/guestfish-actions.pod:4421
24642 " vgcreate volgroup 'physvols ...'\n"
24647 #: ../fish/guestfish-actions.pod:4426
24652 #: ../fish/guestfish-actions.pod:4428
24655 " vglvuuids vgname\n"
24660 #: ../fish/guestfish-actions.pod:4433
24662 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24663 "logical volumes and volume groups."
24667 #: ../fish/guestfish-actions.pod:4436
24668 msgid "See also L</vgpvuuids>."
24672 #: ../fish/guestfish-actions.pod:4438
24677 #: ../fish/guestfish-actions.pod:4440
24680 " vgpvuuids vgname\n"
24685 #: ../fish/guestfish-actions.pod:4445
24687 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24688 "physical volumes and volume groups."
24692 #: ../fish/guestfish-actions.pod:4448
24693 msgid "See also L</vglvuuids>."
24697 #: ../fish/guestfish-actions.pod:4450
24702 #: ../fish/guestfish-actions.pod:4452
24705 " vgremove vgname\n"
24710 #: ../fish/guestfish-actions.pod:4459
24715 #: ../fish/guestfish-actions.pod:4461
24718 " vgrename volgroup newvolgroup\n"
24723 #: ../fish/guestfish-actions.pod:4465
24728 #: ../fish/guestfish-actions.pod:4467
24736 #: ../fish/guestfish-actions.pod:4475
24737 msgid "See also L</vgs-full>."
24741 #: ../fish/guestfish-actions.pod:4477
24746 #: ../fish/guestfish-actions.pod:4479
24754 #: ../fish/guestfish-actions.pod:4484
24759 #: ../fish/guestfish-actions.pod:4486
24767 #: ../fish/guestfish-actions.pod:4491
24772 #: ../fish/guestfish-actions.pod:4493
24780 #: ../fish/guestfish-actions.pod:4497
24785 #: ../fish/guestfish-actions.pod:4499
24793 #: ../fish/guestfish-actions.pod:4504
24798 #: ../fish/guestfish-actions.pod:4506
24806 #: ../fish/guestfish-actions.pod:4511
24811 #: ../fish/guestfish-actions.pod:4513
24819 #: ../fish/guestfish-actions.pod:4518
24824 #: ../fish/guestfish-actions.pod:4520
24827 " write path content\n"
24832 #: ../fish/guestfish-actions.pod:4528
24837 #: ../fish/guestfish-actions.pod:4530
24840 " write-file path content size\n"
24845 #: ../fish/guestfish-actions.pod:4553
24850 #: ../fish/guestfish-actions.pod:4555
24853 " zegrep regex path\n"
24858 #: ../fish/guestfish-actions.pod:4563
24863 #: ../fish/guestfish-actions.pod:4565
24866 " zegrepi regex path\n"
24871 #: ../fish/guestfish-actions.pod:4573
24876 #: ../fish/guestfish-actions.pod:4575
24884 #: ../fish/guestfish-actions.pod:4583
24885 msgid "See also: L</zero-device>, L</scrub-device>."
24889 #: ../fish/guestfish-actions.pod:4585
24890 msgid "zero-device"
24894 #: ../fish/guestfish-actions.pod:4587
24897 " zero-device device\n"
24902 #: ../fish/guestfish-actions.pod:4589
24904 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24905 "which just zeroes the first few blocks of a device."
24909 #: ../fish/guestfish-actions.pod:4596
24914 #: ../fish/guestfish-actions.pod:4598
24917 " zerofree device\n"
24922 #: ../fish/guestfish-actions.pod:4611
24927 #: ../fish/guestfish-actions.pod:4613
24930 " zfgrep pattern path\n"
24935 #: ../fish/guestfish-actions.pod:4621
24940 #: ../fish/guestfish-actions.pod:4623
24943 " zfgrepi pattern path\n"
24948 #: ../fish/guestfish-actions.pod:4631
24953 #: ../fish/guestfish-actions.pod:4633
24956 " zfile meth path\n"
24961 #: ../fish/guestfish-actions.pod:4640
24963 "Since 1.0.63, use L</file> instead which can now process compressed files."
24967 #: ../fish/guestfish-actions.pod:4650
24972 #: ../fish/guestfish-actions.pod:4652
24975 " zgrep regex path\n"
24980 #: ../fish/guestfish-actions.pod:4660
24985 #: ../fish/guestfish-actions.pod:4662
24988 " zgrepi regex path\n"
24993 #: ../fish/guestfish-commands.pod:1
24998 #: ../fish/guestfish-commands.pod:3
25003 #: ../fish/guestfish-commands.pod:5
25006 " alloc filename size\n"
25011 #: ../fish/guestfish-commands.pod:7
25013 "This creates an empty (zeroed) file of the given size, and then adds so it "
25014 "can be further examined."
25018 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25019 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25023 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25024 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25028 #: ../fish/guestfish-commands.pod:14
25030 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25031 "image, see L</PREPARED DISK IMAGES>."
25035 #: ../fish/guestfish-commands.pod:17
25040 #: ../fish/guestfish-commands.pod:19
25043 " copy-in local [local ...] /remotedir\n"
25048 #: ../fish/guestfish-commands.pod:21
25050 "C<copy-in> copies local files or directories recursively into the disk "
25051 "image, placing them in the directory called C</remotedir> (which must "
25052 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25053 "other commands as necessary."
25057 #: ../fish/guestfish-commands.pod:26
25059 "Multiple local files and directories can be specified, but the last "
25060 "parameter must always be a remote directory. Wildcards cannot be used."
25064 #: ../fish/guestfish-commands.pod:30
25069 #: ../fish/guestfish-commands.pod:32
25072 " copy-out remote [remote ...] localdir\n"
25077 #: ../fish/guestfish-commands.pod:34
25079 "C<copy-out> copies remote files or directories recursively out of the disk "
25080 "image, placing them on the host disk in a local directory called C<localdir> "
25081 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25082 "download>, L</tar-out> and other commands as necessary."
25086 #: ../fish/guestfish-commands.pod:40
25088 "Multiple remote files and directories can be specified, but the last "
25089 "parameter must always be a local directory. To download to the current "
25090 "directory, use C<.> as in:"
25094 #: ../fish/guestfish-commands.pod:44
25097 " copy-out /home .\n"
25102 #: ../fish/guestfish-commands.pod:46
25104 "Wildcards cannot be used in the ordinary command, but you can use them with "
25105 "the help of L</glob> like this:"
25109 #: ../fish/guestfish-commands.pod:49
25112 " glob copy-out /home/* .\n"
25117 #: ../fish/guestfish-commands.pod:51
25122 #: ../fish/guestfish-commands.pod:53
25125 " echo [params ...]\n"
25130 #: ../fish/guestfish-commands.pod:55
25131 msgid "This echos the parameters to the terminal."
25135 #: ../fish/guestfish-commands.pod:57
25140 #: ../fish/guestfish-commands.pod:59
25145 #: ../fish/guestfish-commands.pod:61
25150 #: ../fish/guestfish-commands.pod:63
25158 #: ../fish/guestfish-commands.pod:65
25160 "This is used to edit a file. It downloads the file, edits it locally using "
25161 "your editor, then uploads the result."
25165 #: ../fish/guestfish-commands.pod:68
25167 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25168 "or C<emacs> you will get those corresponding editors."
25172 #: ../fish/guestfish-commands.pod:72
25177 #: ../fish/guestfish-commands.pod:74
25180 " glob command args...\n"
25185 #: ../fish/guestfish-commands.pod:76
25187 "Expand wildcards in any paths in the args list, and run C<command> "
25188 "repeatedly on each matching path."
25192 #: ../fish/guestfish-commands.pod:79
25193 msgid "See L</WILDCARDS AND GLOBBING>."
25197 #: ../fish/guestfish-commands.pod:81
25202 #: ../fish/guestfish-commands.pod:83
25205 " hexedit <filename|device>\n"
25206 " hexedit <filename|device> <max>\n"
25207 " hexedit <filename|device> <start> <max>\n"
25212 #: ../fish/guestfish-commands.pod:87
25214 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25219 #: ../fish/guestfish-commands.pod:90
25221 "This command works by downloading potentially the whole file or device, "
25222 "editing it locally, then uploading it. If the file or device is large, you "
25223 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25224 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25225 "usual modifiers allowed such as C<1M> (1 megabyte)."
25229 #: ../fish/guestfish-commands.pod:97
25230 msgid "For example to edit the first few sectors of a disk you might do:"
25234 #: ../fish/guestfish-commands.pod:100
25237 " hexedit /dev/sda 1M\n"
25242 #: ../fish/guestfish-commands.pod:102
25244 "which would allow you to edit anywhere within the first megabyte of the disk."
25248 #: ../fish/guestfish-commands.pod:105
25249 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25253 #: ../fish/guestfish-commands.pod:107
25256 " hexedit /dev/sda1 0x400 0x400\n"
25261 #: ../fish/guestfish-commands.pod:109
25262 msgid "(assuming the superblock is in the standard location)."
25266 #: ../fish/guestfish-commands.pod:111
25268 "This command requires the external L<hexedit(1)> program. You can specify "
25269 "another program to use by setting the C<HEXEDITOR> environment variable."
25273 #: ../fish/guestfish-commands.pod:115
25274 msgid "See also L</hexdump>."
25278 #: ../fish/guestfish-commands.pod:117
25283 #: ../fish/guestfish-commands.pod:119
25291 #: ../fish/guestfish-commands.pod:121
25293 "Change the local directory, ie. the current directory of guestfish itself."
25297 #: ../fish/guestfish-commands.pod:124
25298 msgid "Note that C<!cd> won't do what you might expect."
25302 #: ../fish/guestfish-commands.pod:126
25307 #: ../fish/guestfish-commands.pod:128
25312 #: ../fish/guestfish-commands.pod:130
25320 #: ../fish/guestfish-commands.pod:132
25321 msgid "Opens the manual page for guestfish."
25325 #: ../fish/guestfish-commands.pod:134
25330 #: ../fish/guestfish-commands.pod:136
25335 #: ../fish/guestfish-commands.pod:138
25343 #: ../fish/guestfish-commands.pod:140
25351 #: ../fish/guestfish-commands.pod:142
25352 msgid "This is used to view a file."
25356 #: ../fish/guestfish-commands.pod:144
25358 "The default viewer is C<$PAGER>. However if you use the alternate command "
25359 "C<less> you will get the C<less> command specifically."
25363 #: ../fish/guestfish-commands.pod:147
25368 #: ../fish/guestfish-commands.pod:149
25376 #: ../fish/guestfish-commands.pod:151
25378 "Close and reopen the libguestfs handle. It is not necessary to use this "
25379 "normally, because the handle is closed properly when guestfish exits. "
25380 "However this is occasionally useful for testing."
25384 #: ../fish/guestfish-commands.pod:155
25389 #: ../fish/guestfish-commands.pod:157
25392 " sparse filename size\n"
25397 #: ../fish/guestfish-commands.pod:159
25399 "This creates an empty sparse file of the given size, and then adds so it can "
25400 "be further examined."
25404 #: ../fish/guestfish-commands.pod:162
25406 "In all respects it works the same as the L</alloc> command, except that the "
25407 "image file is allocated sparsely, which means that disk blocks are not "
25408 "assigned to the file until they are needed. Sparse disk files only use "
25409 "space when written to, but they are slower and there is a danger you could "
25410 "run out of real disk space during a write operation."
25414 #: ../fish/guestfish-commands.pod:172
25419 #: ../fish/guestfish-commands.pod:174
25427 #: ../fish/guestfish-commands.pod:176
25429 "This command returns a list of the optional groups known to the daemon, and "
25430 "indicates which ones are supported by this build of the libguestfs appliance."
25434 #: ../fish/guestfish-commands.pod:180
25435 msgid "See also L<guestfs(3)/AVAILABILITY>."
25439 #: ../fish/guestfish-commands.pod:182
25444 #: ../fish/guestfish-commands.pod:184
25447 " time command args...\n"
25452 #: ../fish/guestfish-commands.pod:186
25454 "Run the command as usual, but print the elapsed time afterwards. This can "
25455 "be useful for benchmarking operations."
25459 #: ../test-tool/libguestfs-test-tool.pod:5
25460 msgid "libguestfs-test-tool - End user tests for libguestfs"
25464 #: ../test-tool/libguestfs-test-tool.pod:9
25467 " libguestfs-test-tool [--options]\n"
25472 #: ../test-tool/libguestfs-test-tool.pod:13
25474 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25475 "and developers, to allow them to check basic libguestfs functionality is "
25476 "working. This is needed because libguestfs occasionally breaks for reasons "
25477 "beyond our control: usually because of changes in the underlying qemu or "
25478 "kernel packages, or the host environment."
25482 #: ../test-tool/libguestfs-test-tool.pod:20
25483 msgid "If you suspect a problem in libguestfs, then just run:"
25487 #: ../test-tool/libguestfs-test-tool.pod:22
25490 " libguestfs-test-tool\n"
25495 #: ../test-tool/libguestfs-test-tool.pod:24
25496 msgid "It will print lots of diagnostic messages."
25500 #: ../test-tool/libguestfs-test-tool.pod:26
25501 msgid "If it runs to completion successfully, you will see this near the end:"
25505 #: ../test-tool/libguestfs-test-tool.pod:28
25508 " ===== TEST FINISHED OK =====\n"
25513 #: ../test-tool/libguestfs-test-tool.pod:30
25514 msgid "and the test tool will exit with code 0."
25518 #: ../test-tool/libguestfs-test-tool.pod:32
25520 "If it fails (and/or exits with non-zero error code), please paste the "
25521 "B<complete, unedited> output of the test tool into a bug report. More "
25522 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25527 #: ../test-tool/libguestfs-test-tool.pod:41
25532 #: ../test-tool/libguestfs-test-tool.pod:43
25533 msgid "Display short usage information and exit."
25537 #: ../test-tool/libguestfs-test-tool.pod:45
25538 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25542 #: ../test-tool/libguestfs-test-tool.pod:47
25544 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25545 "normally look in the C<$libexec> directory that was configured when the tool "
25550 #: ../test-tool/libguestfs-test-tool.pod:51
25551 msgid "I<--qemu qemu_binary>"
25555 #: ../test-tool/libguestfs-test-tool.pod:53
25557 "If you have downloaded another qemu binary, point this option at the full "
25558 "path of the binary to try it."
25562 #: ../test-tool/libguestfs-test-tool.pod:56
25563 msgid "I<--qemudir qemu_source_dir>"
25567 #: ../test-tool/libguestfs-test-tool.pod:58
25569 "If you have compiled qemu from source, point this option at the source "
25570 "directory to try it."
25574 #: ../test-tool/libguestfs-test-tool.pod:61
25575 msgid "I<--timeout N>"
25579 #: ../test-tool/libguestfs-test-tool.pod:63
25581 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25582 "does not usually need to be adjusted unless your machine is very slow."
25586 #: ../test-tool/libguestfs-test-tool.pod:69
25587 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25591 #: ../test-tool/libguestfs-test-tool.pod:71
25593 "If you have compiled another version of qemu from source and would like to "
25594 "try that, then you can use the I<--qemudir> option to point to the qemu "
25595 "source directory."
25599 #: ../test-tool/libguestfs-test-tool.pod:75
25601 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25602 "option to point to the binary."
25606 #: ../test-tool/libguestfs-test-tool.pod:78
25608 "When using an alternate qemu with libguestfs, usually you would need to "
25609 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25610 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25611 "use either of the I<--qemudir> or I<--qemu> options."
25615 #: ../test-tool/libguestfs-test-tool.pod:85
25617 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25618 "I<1> if there was an error."
25622 #: ../test-tool/libguestfs-test-tool.pod:92
25623 msgid "/usr/libexec/libguestfs-test-tool-helper"
25627 #: ../test-tool/libguestfs-test-tool.pod:94
25629 "This helper program is run inside the appliance and provides additional "
25634 #: ../test-tool/libguestfs-test-tool.pod:97
25635 msgid "/usr/bin/mkisofs"
25639 #: ../test-tool/libguestfs-test-tool.pod:99
25641 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25642 "which is used as part of the tests."
25646 #: ../test-tool/libguestfs-test-tool.pod:106
25648 "For the full list of environment variables which may affect libguestfs, "
25649 "please see the L<guestfs(3)> manual page."
25653 #: ../test-tool/libguestfs-test-tool.pod:111
25654 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25658 #: ../test-tool/libguestfs-test-tool.pod:121
25659 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25663 #: ../fuse/guestmount.pod:5
25665 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25669 #: ../fuse/guestmount.pod:9
25672 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25677 #: ../fuse/guestmount.pod:11
25680 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25685 #: ../fuse/guestmount.pod:13
25688 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25693 #: ../fuse/guestmount.pod:17
25695 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25696 "machines. If you do this, you risk disk corruption in the VM."
25700 #: ../fuse/guestmount.pod:22
25702 "The guestmount program can be used to mount virtual machine filesystems and "
25703 "other disk images on the host. It uses libguestfs for access to the guest "
25704 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25705 "a mountable device."
25709 #: ../fuse/guestmount.pod:27
25711 "Along with other options, you have to give at least one device (I<-a> "
25712 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25713 "option) or use the I<-i> inspection option. How this works is better "
25714 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25719 #: ../fuse/guestmount.pod:33
25721 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25722 "by you, and the filesystem will not be visible to any other users unless you "
25723 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25724 "the filesystem, use the C<fusermount -u> command."
25728 #: ../fuse/guestmount.pod:41
25730 "For a typical Windows guest which has its main filesystem on the first "
25735 #: ../fuse/guestmount.pod:44
25738 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25743 #: ../fuse/guestmount.pod:46
25745 "For a typical Linux guest which has a /boot filesystem on the first "
25746 "partition, and the root filesystem on a logical volume:"
25750 #: ../fuse/guestmount.pod:49
25753 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25758 #: ../fuse/guestmount.pod:51
25759 msgid "To get libguestfs to detect guest mountpoints for you:"
25763 #: ../fuse/guestmount.pod:53
25766 " guestmount -a guest.img -i --ro /mnt\n"
25771 #: ../fuse/guestmount.pod:55
25772 msgid "For a libvirt guest called \"Guest\" you could do:"
25776 #: ../fuse/guestmount.pod:57
25779 " guestmount -d Guest -i --ro /mnt\n"
25784 #: ../fuse/guestmount.pod:59
25786 "If you don't know what filesystems are contained in a guest or disk image, "
25787 "use L<virt-filesystems(1)> first:"
25791 #: ../fuse/guestmount.pod:62
25794 " virt-filesystems MyGuest\n"
25799 #: ../fuse/guestmount.pod:64
25801 "If you want to trace the libguestfs calls but without excessive debugging "
25802 "information, we recommend:"
25806 #: ../fuse/guestmount.pod:67
25809 " guestmount [...] --trace /mnt\n"
25814 #: ../fuse/guestmount.pod:69
25815 msgid "If you want to debug the program, we recommend:"
25819 #: ../fuse/guestmount.pod:71
25822 " guestmount [...] --trace --verbose /mnt\n"
25827 #: ../fuse/guestmount.pod:79
25828 msgid "Add a block device or virtual machine image."
25832 #: ../fuse/guestmount.pod:96
25833 msgid "B<--dir-cache-timeout N>"
25837 #: ../fuse/guestmount.pod:98
25839 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25840 "seconds. The readdir cache [actually, there are several semi-independent "
25841 "caches] is populated after a readdir(2) call with the stat and extended "
25842 "attributes of the files in the directory, in anticipation that they will be "
25843 "requested soon after."
25847 #: ../fuse/guestmount.pod:104
25849 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25850 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25851 "requests, only cache existing ones."
25855 #: ../fuse/guestmount.pod:122
25857 "If you have untrusted raw-format guest disk images, you should use this "
25858 "option to specify the disk format. This avoids a possible security problem "
25859 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25860 "guestfs_add_drive_opts>."
25864 #: ../fuse/guestmount.pod:127
25865 msgid "B<--fuse-help>"
25869 #: ../fuse/guestmount.pod:129
25870 msgid "Display help on special FUSE options (see I<-o> below)."
25874 #: ../fuse/guestmount.pod:133
25875 msgid "Display brief help and exit."
25879 #: ../fuse/guestmount.pod:146
25880 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25884 #: ../fuse/guestmount.pod:148
25886 "Mount the named partition or logical volume on the given mountpoint B<in the "
25887 "guest> (this has nothing to do with mountpoints in the host)."
25891 #: ../fuse/guestmount.pod:151
25893 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25894 "something on C</>."
25898 #: ../fuse/guestmount.pod:156
25900 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25901 "unmounted. If you specify this option, then we don't attempt to sync the "
25902 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25906 #: ../fuse/guestmount.pod:161
25907 msgid "B<-o option> | B<--option option>"
25911 #: ../fuse/guestmount.pod:163
25912 msgid "Pass extra options to FUSE."
25916 #: ../fuse/guestmount.pod:165
25918 "To get a list of all the extra options supported by FUSE, use the command "
25919 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25920 "of them are a good idea."
25924 #: ../fuse/guestmount.pod:169
25927 " guestmount --fuse-help\n"
25932 #: ../fuse/guestmount.pod:171
25933 msgid "Some potentially useful FUSE options:"
25937 #: ../fuse/guestmount.pod:175
25938 msgid "B<-o allow_other>"
25942 #: ../fuse/guestmount.pod:177
25943 msgid "Allow other users to see the filesystem."
25947 #: ../fuse/guestmount.pod:179
25948 msgid "B<-o attr_timeout=N>"
25952 #: ../fuse/guestmount.pod:181
25953 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25957 #: ../fuse/guestmount.pod:183
25958 msgid "B<-o kernel_cache>"
25962 #: ../fuse/guestmount.pod:185
25964 "Allow the kernel to cache files (reduces the number of reads that have to go "
25965 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25966 "afford the extra memory usage."
25970 #: ../fuse/guestmount.pod:189
25971 msgid "B<-o uid=N> B<-o gid=N>"
25975 #: ../fuse/guestmount.pod:191
25977 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25978 "the chosen values."
25982 #: ../fuse/guestmount.pod:198
25984 "Add devices and mount everything read-only. Also disallow writes and make "
25985 "the disk appear read-only to FUSE."
25989 #: ../fuse/guestmount.pod:201
25991 "This is highly recommended if you are not going to edit the guest disk. If "
25992 "the guest is running and this option is I<not> supplied, then there is a "
25993 "strong risk of disk corruption in the guest. We try to prevent this from "
25994 "happening, but it is not always possible."
25998 #: ../fuse/guestmount.pod:206
25999 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26003 #: ../fuse/guestmount.pod:210
26004 msgid "Enable SELinux support for the guest."
26008 #: ../fuse/guestmount.pod:214
26009 msgid "Enable verbose messages from underlying libguestfs."
26013 #: ../fuse/guestmount.pod:218
26014 msgid "Display the program version and exit."
26018 #: ../fuse/guestmount.pod:222
26020 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26021 "FOR READ AND WRITE>."
26025 #: ../fuse/guestmount.pod:225
26026 msgid "B<-x> | B<--trace>"
26030 #: ../fuse/guestmount.pod:227
26031 msgid "Trace libguestfs calls."
26035 #: ../fuse/guestmount.pod:229
26036 msgid "This also stops the daemon from forking into the background."
26040 #: ../fuse/guestmount.pod:235
26042 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26043 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26048 #: ../tools/virt-edit.pl:34
26049 msgid "virt-edit - Edit a file in a virtual machine"
26053 #: ../tools/virt-edit.pl:38
26056 " virt-edit [--options] domname file\n"
26061 #: ../tools/virt-edit.pl:40
26064 " virt-edit [--options] disk.img [disk.img ...] file\n"
26069 #: ../tools/virt-edit.pl:42
26072 " virt-edit [domname|disk.img] file -e 'expr'\n"
26077 #: ../tools/virt-edit.pl:46
26079 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26080 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26081 "doing this, but doesn't catch all cases."
26085 #: ../tools/virt-edit.pl:52
26087 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26088 "the named virtual machine (or disk image)."
26092 #: ../tools/virt-edit.pl:55
26094 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26095 "you should look at the L<guestfish(1)> tool."
26099 #: ../tools/virt-edit.pl:60
26100 msgid "Edit the named files interactively:"
26104 #: ../tools/virt-edit.pl:62
26107 " virt-edit mydomain /boot/grub/grub.conf\n"
26112 #: ../tools/virt-edit.pl:64
26115 " virt-edit mydomain /etc/passwd\n"
26120 #: ../tools/virt-edit.pl:66
26122 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26123 "below). To change the init default level to 5:"
26127 #: ../tools/virt-edit.pl:70
26130 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26135 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181
26136 #: ../tools/virt-df.pl:81 ../tools/virt-list-filesystems.pl:63
26137 #: ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113
26138 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
26139 msgid "Display brief help."
26143 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187
26144 #: ../tools/virt-df.pl:87 ../tools/virt-resize.pl:272
26145 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114
26146 #: ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169
26147 #: ../tools/virt-list-partitions.pl:70
26148 msgid "B<--version>"
26152 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189
26153 #: ../tools/virt-df.pl:89 ../tools/virt-resize.pl:274
26154 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116
26155 #: ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171
26156 #: ../tools/virt-list-partitions.pl:72
26157 msgid "Display version number and exit."
26161 #: ../tools/virt-edit.pl:96
26162 msgid "B<--backup extension> | B<-b extension>"
26166 #: ../tools/virt-edit.pl:98
26168 "Create a backup of the original file I<in the guest disk image>. The backup "
26169 "has the original filename with C<extension> added."
26173 #: ../tools/virt-edit.pl:101
26175 "Usually the first character of C<extension> would be a dot C<.> so you would "
26180 #: ../tools/virt-edit.pl:104
26183 " virt-edit -b .orig [etc]\n"
26188 #: ../tools/virt-edit.pl:106
26189 msgid "By default, no backup file is made."
26193 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203
26194 #: ../tools/virt-df.pl:95 ../tools/virt-list-filesystems.pl:77
26195 #: ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135
26196 #: ../tools/virt-list-partitions.pl:78
26197 msgid "B<--connect URI> | B<-c URI>"
26201 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205
26202 #: ../tools/virt-df.pl:97 ../tools/virt-list-filesystems.pl:79
26203 #: ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137
26204 #: ../tools/virt-list-partitions.pl:80
26206 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26207 "to the default libvirt hypervisor."
26211 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26212 #: ../tools/virt-df.pl:100 ../tools/virt-list-filesystems.pl:82
26213 #: ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140
26214 #: ../tools/virt-list-partitions.pl:83
26216 "If you specify guest block devices directly, then libvirt is not used at all."
26220 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215
26221 #: ../tools/virt-df.pl:117 ../tools/virt-resize.pl:522
26222 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134
26223 #: ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:90
26224 msgid "B<--format> raw"
26228 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217
26229 #: ../tools/virt-df.pl:119 ../tools/virt-list-filesystems.pl:91
26230 #: ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149
26231 #: ../tools/virt-list-partitions.pl:92
26233 "Specify the format of disk images given on the command line. If this is "
26234 "omitted then the format is autodetected from the content of the disk image."
26238 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221
26239 #: ../tools/virt-df.pl:123 ../tools/virt-list-filesystems.pl:95
26240 #: ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153
26241 #: ../tools/virt-list-partitions.pl:96
26243 "If disk images are requested from libvirt, then this program asks libvirt "
26244 "for this information. In this case, the value of the format parameter is "
26249 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225
26250 #: ../tools/virt-df.pl:127 ../tools/virt-resize.pl:527
26251 #: ../tools/virt-resize.pl:542 ../tools/virt-list-filesystems.pl:99
26252 #: ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157
26253 #: ../tools/virt-list-partitions.pl:100
26255 "If working with untrusted raw-format guest disk images, you should ensure "
26256 "the format is always specified."
26260 #: ../tools/virt-edit.pl:141
26261 msgid "B<--expr EXPR> | B<-e EXPR>"
26265 #: ../tools/virt-edit.pl:143
26267 "Instead of launching the external editor, non-interactively apply the Perl "
26268 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26273 #: ../tools/virt-edit.pl:147
26275 "Be careful to properly quote the expression to prevent it from being altered "
26280 #: ../tools/virt-edit.pl:268
26281 msgid "NON-INTERACTIVE EDITING"
26285 #: ../tools/virt-edit.pl:270
26287 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26288 "administrator can interactively edit the file."
26292 #: ../tools/virt-edit.pl:273
26294 "There are two ways also to use C<virt-edit> from scripts in order to make "
26295 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26296 "like this, it's less error-prone to write scripts directly using the "
26297 "libguestfs API and Augeas for configuration file editing.)"
26301 #: ../tools/virt-edit.pl:279
26303 "The first method is to temporarily set C<$EDITOR> to any script or program "
26304 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26305 "update C<tmpfile> in place however it likes."
26309 #: ../tools/virt-edit.pl:283
26311 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26312 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26313 "instances of C<foo> with C<bar> in a file:"
26317 #: ../tools/virt-edit.pl:287
26320 " virt-edit domname filename -e 's/foo/bar/'\n"
26325 #: ../tools/virt-edit.pl:289
26327 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26328 "For example to delete root's password you could do:"
26332 #: ../tools/virt-edit.pl:292
26335 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26340 #: ../tools/virt-edit.pl:294
26342 "What really happens is that the snippet is evaluated as a Perl expression "
26343 "for each line of the file. The line, including the final C<\\n>, is passed "
26344 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26348 #: ../tools/virt-edit.pl:299
26350 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26351 "C<apache> user account from the password file you can do:"
26355 #: ../tools/virt-edit.pl:302
26358 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26363 #: ../tools/virt-edit.pl:304
26365 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26366 "the end of the file is rather difficult this way since there is no concept "
26367 "of \"last line of the file\" - your expression just doesn't get called "
26368 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26373 #: ../tools/virt-edit.pl:310
26375 "The variable C<$lineno> contains the current line number. As is "
26376 "traditional, the first line in the file is number C<1>."
26380 #: ../tools/virt-edit.pl:313
26382 "The return value from the expression is ignored, but the expression may call "
26383 "C<die> in order to abort the whole program, leaving the original file "
26388 #: ../tools/virt-edit.pl:317
26390 "Remember when matching the end of a line that C<$_> may contain the final C<"
26391 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26392 "newline then neither of these. Thus to match or substitute some text at the "
26393 "end of a line, use this regular expression:"
26397 #: ../tools/virt-edit.pl:322
26400 " /some text(\\r?\\n)?$/\n"
26405 #: ../tools/virt-edit.pl:324
26407 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26408 "$_> itself (since that would remove all newlines from the file):"
26412 #: ../tools/virt-edit.pl:328
26415 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26420 #: ../tools/virt-edit.pl:334
26425 #: ../tools/virt-edit.pl:336
26427 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26432 #: ../tools/virt-edit.pl:339
26433 msgid "If not set, C<vi> is used."
26437 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141
26438 #: ../tools/virt-win-reg.pl:477 ../tools/virt-df.pl:633
26439 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:182
26440 #: ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260
26441 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26442 msgid "SHELL QUOTING"
26446 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479
26447 #: ../tools/virt-df.pl:635 ../tools/virt-resize.pl:1480
26448 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276
26449 #: ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529
26450 #: ../tools/virt-list-partitions.pl:252
26452 "Libvirt guest names can contain arbitrary characters, some of which have "
26453 "meaning to the shell such as C<#> and space. You may need to quote or "
26454 "escape these characters on the command line. See the shell manual page L<sh"
26455 "(1)> for details."
26459 #: ../tools/virt-edit.pl:352
26461 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26462 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26467 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26468 #: ../tools/virt-df.pl:649 ../tools/virt-resize.pl:1506
26469 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292
26470 #: ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559
26471 #: ../tools/virt-list-partitions.pl:269
26476 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512
26477 #: ../tools/virt-df.pl:651 ../tools/virt-resize.pl:1508
26478 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294
26479 #: ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561
26480 #: ../tools/virt-list-partitions.pl:271
26481 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26485 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
26486 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:275
26487 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26491 #: ../tools/virt-win-reg.pl:37
26493 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26497 #: ../tools/virt-win-reg.pl:41
26500 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26505 #: ../tools/virt-win-reg.pl:43
26508 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26513 #: ../tools/virt-win-reg.pl:45
26516 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26521 #: ../tools/virt-win-reg.pl:47
26524 " virt-win-reg --merge domname [input.reg ...]\n"
26529 #: ../tools/virt-win-reg.pl:49
26532 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26537 #: ../tools/virt-win-reg.pl:53
26539 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26540 "virtual machines. If you do this, you I<will> get irreversible disk "
26541 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26542 "but doesn't catch all cases."
26546 #: ../tools/virt-win-reg.pl:58
26548 "Modifying the Windows Registry is an inherently risky operation. The format "
26549 "is deliberately obscure and undocumented, and Registry changes can leave the "
26550 "system unbootable. Therefore when using the C<--merge> option, make sure "
26551 "you have a reliable backup first."
26555 #: ../tools/virt-win-reg.pl:65
26557 "This program can export and merge Windows Registry entries from a Windows "
26562 #: ../tools/virt-win-reg.pl:68
26564 "The first parameter is the libvirt guest name or the raw disk image of a "
26569 #: ../tools/virt-win-reg.pl:71
26571 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26572 "exported (recursively). For example:"
26576 #: ../tools/virt-win-reg.pl:74
26579 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26584 #: ../tools/virt-win-reg.pl:76
26586 "You can also display single values from within registry keys, for example:"
26590 #: ../tools/virt-win-reg.pl:79
26593 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26594 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26595 " Windows 7 Enterprise\n"
26600 #: ../tools/virt-win-reg.pl:83
26602 "With C<--merge>, you can merge a textual regedit file into the Windows "
26607 #: ../tools/virt-win-reg.pl:86
26610 " $ virt-win-reg --merge Windows7 changes.reg\n"
26615 #: ../tools/virt-win-reg.pl:88
26616 msgid "SUPPORTED SYSTEMS"
26620 #: ../tools/virt-win-reg.pl:90
26622 "The program currently supports Windows NT-derived guests starting with "
26623 "Windows XP through to at least Windows 7."
26627 #: ../tools/virt-win-reg.pl:93
26629 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26630 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26631 "and C<HKEY_USERS\\.DEFAULT>."
26635 #: ../tools/virt-win-reg.pl:97
26637 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26642 #: ../tools/virt-win-reg.pl:100
26644 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26649 #: ../tools/virt-win-reg.pl:103
26654 #: ../tools/virt-win-reg.pl:105
26656 "This program is only meant for simple access to the registry. If you want "
26657 "to do complicated things with the registry, we suggest you download the "
26658 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26659 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26660 "L<hivexregedit(1)>."
26664 #: ../tools/virt-win-reg.pl:111
26669 #: ../tools/virt-win-reg.pl:113
26671 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26672 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26673 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26674 "Windows-style line endings, you may need to reencode the whole file before "
26675 "or after processing."
26679 #: ../tools/virt-win-reg.pl:119
26681 "To reencode a file from Windows format to Linux (before processing it with "
26682 "the C<--merge> option), you would do something like this:"
26686 #: ../tools/virt-win-reg.pl:122
26689 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26694 #: ../tools/virt-win-reg.pl:124
26696 "To go in the opposite direction, after exporting and before sending the file "
26697 "to a Windows user, do something like this:"
26701 #: ../tools/virt-win-reg.pl:127
26704 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26709 #: ../tools/virt-win-reg.pl:129
26710 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26714 #: ../tools/virt-win-reg.pl:131
26716 "If you are unsure about the current encoding, use the L<file(1)> command. "
26717 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26718 "style (CRLF) line endings, like this:"
26722 #: ../tools/virt-win-reg.pl:135
26725 " $ file software.reg\n"
26726 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26727 " with CRLF line terminators\n"
26732 #: ../tools/virt-win-reg.pl:139
26733 msgid "This file would need conversion before you could C<--merge> it."
26737 #: ../tools/virt-win-reg.pl:143
26739 "Be careful when passing parameters containing C<\\> (backslash) in the "
26740 "shell. Usually you will have to use 'single quotes' or double backslashes "
26741 "(but not both) to protect them from the shell."
26745 #: ../tools/virt-win-reg.pl:147
26746 msgid "Paths and value names are case-insensitive."
26750 #: ../tools/virt-win-reg.pl:149
26751 msgid "CurrentControlSet etc."
26755 #: ../tools/virt-win-reg.pl:151
26757 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26758 "Registry at the level of the hive file, and therefore you cannot modify "
26763 #: ../tools/virt-win-reg.pl:155
26765 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26766 "circumstances it might refer to another control set. The way to find out is "
26767 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26771 #: ../tools/virt-win-reg.pl:159
26774 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26775 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26776 " \"Current\"=dword:00000001\n"
26777 " \"Default\"=dword:00000001\n"
26778 " \"Failed\"=dword:00000000\n"
26779 " \"LastKnownGood\"=dword:00000002\n"
26784 #: ../tools/virt-win-reg.pl:166
26785 msgid "\"Current\" is the one which Windows will choose when it boots."
26789 #: ../tools/virt-win-reg.pl:168
26791 "Similarly, other C<Current...> keys in the path may need to be replaced."
26795 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26800 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:500
26801 msgid "Enable debugging messages."
26805 #: ../tools/virt-win-reg.pl:232
26810 #: ../tools/virt-win-reg.pl:234
26812 "In merge mode, this merges a textual regedit file into the Windows Registry "
26813 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26814 "displays or exports Registry entries instead."
26818 #: ../tools/virt-win-reg.pl:238
26820 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26821 "result in disk corruption. However exporting (without this flag) is always "
26826 #: ../tools/virt-win-reg.pl:246
26827 msgid "B<--encoding> UTF-16LE|ASCII"
26831 #: ../tools/virt-win-reg.pl:248
26833 "When merging (only), you may need to specify the encoding for strings to be "
26834 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26835 "(3)/ENCODING STRINGS>."
26839 #: ../tools/virt-win-reg.pl:252
26841 "The default is to use UTF-16LE, which should work with recent versions of "
26846 #: ../tools/virt-win-reg.pl:486
26848 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26849 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26850 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26854 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26856 "When reporting bugs, please enable debugging and capture the I<complete> "
26861 #: ../tools/virt-win-reg.pl:504
26864 " export LIBGUESTFS_DEBUG=1\n"
26865 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26870 #: ../tools/virt-win-reg.pl:507
26872 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26877 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1512
26878 #: ../tools/virt-make-fs.pl:565
26879 msgid "Copyright (C) 2010 Red Hat Inc."
26883 #: ../tools/virt-df.pl:36
26884 msgid "virt-df - Display free space on virtual filesystems"
26888 #: ../tools/virt-df.pl:40
26891 " virt-df [--options]\n"
26896 #: ../tools/virt-df.pl:42
26899 " virt-df [--options] domname\n"
26904 #: ../tools/virt-df.pl:44
26907 " virt-df [--options] disk.img [disk.img ...]\n"
26912 #: ../tools/virt-df.pl:48
26914 "C<virt-df> is a command line tool to display free space on virtual machine "
26915 "filesystems. Unlike other tools, it doesn't just display the amount of "
26916 "space allocated to a virtual machine, but can look inside the virtual "
26917 "machine to see how much space is really being used."
26921 #: ../tools/virt-df.pl:53
26923 "It is like the L<df(1)> command, but for virtual machines, except that it "
26924 "also works for Windows virtual machines."
26928 #: ../tools/virt-df.pl:56
26930 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26931 "of all active and inactive guests, and performs a C<df>-type operation on "
26932 "each one in turn, printing out the results."
26936 #: ../tools/virt-df.pl:60
26938 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26939 "either the single named libvirt domain, or on the disk image(s) listed on "
26940 "the command line (which must all belong to a single VM). In this mode (with "
26941 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26942 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26946 #: ../tools/virt-df.pl:67
26948 "Use the C<--csv> option to get a format which can be easily parsed by other "
26949 "programs. Other options are mostly similar to standard C<df> options. See "
26950 "below for the complete list."
26954 #: ../tools/virt-df.pl:107
26959 #: ../tools/virt-df.pl:109
26961 "Write out the results in CSV format (comma-separated values). This format "
26962 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26963 "ABOUT CSV FORMAT> below."
26967 #: ../tools/virt-df.pl:134
26968 msgid "B<--human-readable> | B<-h>"
26972 #: ../tools/virt-df.pl:136
26973 msgid "Print sizes in human-readable format."
26977 #: ../tools/virt-df.pl:138
26978 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26982 #: ../tools/virt-df.pl:144
26983 msgid "B<--inodes> | B<-i>"
26987 #: ../tools/virt-df.pl:146
26988 msgid "Print inodes instead of blocks."
26992 #: ../tools/virt-df.pl:152
26993 msgid "B<--one-per-guest>"
26997 #: ../tools/virt-df.pl:154
26999 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
27000 "disks from several guests to a single libguestfs appliance."
27004 #: ../tools/virt-df.pl:157
27005 msgid "You might use this option in the following circumstances:"
27009 #: ../tools/virt-df.pl:163
27011 "If you think an untrusted guest might actively try to exploit the libguestfs "
27012 "appliance kernel, then this prevents one guest from interfering with the "
27013 "stats printed for another guest."
27017 #: ../tools/virt-df.pl:169
27019 "If the kernel has a bug which stops it from accessing a filesystem in one "
27020 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
27021 "and report stats for further guests."
27025 #: ../tools/virt-df.pl:180
27030 #: ../tools/virt-df.pl:182
27032 "Print UUIDs instead of names. This is useful for following a guest even "
27033 "when the guest is migrated or renamed, or when two guests happen to have the "
27038 #: ../tools/virt-df.pl:186
27040 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
27041 "images, we still print the disk image name even when this option is "
27046 #: ../tools/virt-df.pl:609
27047 msgid "NOTE ABOUT CSV FORMAT"
27051 #: ../tools/virt-df.pl:611
27053 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
27054 "should be easy to parse, but it is definitely not easy to parse."
27058 #: ../tools/virt-df.pl:614
27060 "Myth: Just split fields at commas. Reality: This does I<not> work "
27061 "reliably. This example has two columns:"
27065 #: ../tools/virt-df.pl:617
27068 " \"foo,bar\",baz\n"
27073 #: ../tools/virt-df.pl:619
27075 "Myth: Read the file one line at a time. Reality: This does I<not> work "
27076 "reliably. This example has one row:"
27080 #: ../tools/virt-df.pl:622
27089 #: ../tools/virt-df.pl:625
27091 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
27092 "packaged in major Linux distributions)."
27096 #: ../tools/virt-df.pl:628
27098 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
27099 "or Python's built-in csv library)."
27103 #: ../tools/virt-df.pl:631
27104 msgid "Most spreadsheets and databases can import CSV directly."
27108 #: ../tools/virt-df.pl:642
27110 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27111 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27115 #: ../tools/virt-resize.pl:42
27116 msgid "virt-resize - Resize a virtual machine disk"
27120 #: ../tools/virt-resize.pl:46
27123 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27124 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27125 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27130 #: ../tools/virt-resize.pl:52
27132 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27133 "larger or smaller overall, and resizing or deleting any partitions contained "
27138 #: ../tools/virt-resize.pl:56
27140 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27141 "not> be used on live virtual machines - for consistent results, shut the "
27142 "virtual machine down before resizing it."
27146 #: ../tools/virt-resize.pl:60
27148 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27149 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27153 #: ../tools/virt-resize.pl:66
27155 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27156 "fill the extra 5GB of space."
27160 #: ../tools/virt-resize.pl:69
27163 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27164 " virt-filesystems --long --h --all -a olddisk\n"
27165 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27166 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27171 #: ../tools/virt-resize.pl:74
27173 "As above, but make the /boot partition 200MB bigger, while giving the "
27174 "remaining space to /dev/sda2:"
27178 #: ../tools/virt-resize.pl:77
27181 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27186 #: ../tools/virt-resize.pl:79
27187 msgid "As above, but the output format will be uncompressed qcow2:"
27191 #: ../tools/virt-resize.pl:81
27194 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27195 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27200 #: ../tools/virt-resize.pl:84
27201 msgid "DETAILED USAGE"
27205 #: ../tools/virt-resize.pl:86
27206 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27210 #: ../tools/virt-resize.pl:90
27211 msgid "1. Shut down the virtual machine"
27215 #: ../tools/virt-resize.pl:92
27216 msgid "2. Locate input disk image"
27220 #: ../tools/virt-resize.pl:94
27222 "Locate the input disk image (ie. the file or device on the host containing "
27223 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27224 "dumpxml> like this to find the disk image name:"
27228 #: ../tools/virt-resize.pl:98
27231 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27232 " Found 1 nodes:\n"
27234 " <source dev=\"/dev/vg/lv_guest\" />\n"
27239 #: ../tools/virt-resize.pl:103
27240 msgid "3. Look at current sizing"
27244 #: ../tools/virt-resize.pl:105
27245 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27249 #: ../tools/virt-resize.pl:108
27252 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27253 " Name Type Size Parent\n"
27254 " /dev/sda1 partition 101M /dev/sda\n"
27255 " /dev/sda2 partition 7.9G /dev/sda\n"
27256 " /dev/sda device 8.0G -\n"
27261 #: ../tools/virt-resize.pl:114
27263 "(This example is a virtual machine with an 8 GB disk which we would like to "
27264 "expand up to 10 GB)."
27268 #: ../tools/virt-resize.pl:117
27269 msgid "4. Create output disk"
27273 #: ../tools/virt-resize.pl:119
27275 "Virt-resize cannot do in-place disk modifications. You have to have space "
27276 "to store the resized output disk."
27280 #: ../tools/virt-resize.pl:122
27282 "To store the resized disk image in a file, create a file of a suitable size:"
27286 #: ../tools/virt-resize.pl:125
27289 " # rm -f outdisk\n"
27290 " # truncate -s 10G outdisk\n"
27295 #: ../tools/virt-resize.pl:128
27296 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27300 #: ../tools/virt-resize.pl:130
27303 " # lvcreate -L 10G -n lv_name vg_name\n"
27308 #: ../tools/virt-resize.pl:132
27309 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27313 #: ../tools/virt-resize.pl:134
27316 " # virsh pool-list\n"
27317 " # virsh vol-create-as poolname newvol 10G\n"
27322 #: ../tools/virt-resize.pl:137
27327 #: ../tools/virt-resize.pl:139
27329 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27330 "file) and the output disk. The output disk is the one created in the "
27335 #: ../tools/virt-resize.pl:143
27338 " # virt-resize indisk outdisk\n"
27343 #: ../tools/virt-resize.pl:145
27345 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27346 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27347 "larger, then an extra, empty partition is created at the end of the disk "
27348 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27353 #: ../tools/virt-resize.pl:151
27355 "More realistically you'd want to expand existing partitions in the disk "
27356 "image by passing extra options (for the full list see the L</OPTIONS> "
27361 #: ../tools/virt-resize.pl:155
27363 "L</--expand> is the most useful option. It expands the named partition "
27364 "within the disk to fill any extra space:"
27368 #: ../tools/virt-resize.pl:158
27371 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27376 #: ../tools/virt-resize.pl:160
27378 "(In this case, an extra partition is I<not> created at the end of the disk, "
27379 "because there will be no unused space)."
27383 #: ../tools/virt-resize.pl:163
27385 "L</--resize> is the other commonly used option. The following would "
27386 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27387 "rest of the available space:"
27391 #: ../tools/virt-resize.pl:167
27394 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27395 " indisk outdisk\n"
27400 #: ../tools/virt-resize.pl:170
27402 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27403 "if virt-resize knows how, it will resize the contents, the equivalent of "
27404 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27405 ">. However virt-resize does not know how to resize some filesystems, so you "
27406 "would have to online resize them after booting the guest. And virt-resize "
27407 "also does not resize anything inside an LVM PV, it just resizes the PV "
27408 "itself and leaves the user to resize any LVs inside that PV as desired."
27412 #: ../tools/virt-resize.pl:179
27413 msgid "Other options are covered below."
27417 #: ../tools/virt-resize.pl:181
27422 #: ../tools/virt-resize.pl:183
27423 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27427 #: ../tools/virt-resize.pl:185
27428 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27432 #: ../tools/virt-resize.pl:187
27435 " # virsh edit guestname\n"
27440 #: ../tools/virt-resize.pl:189
27442 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27443 "html#elementsDisks>"
27447 #: ../tools/virt-resize.pl:192
27448 msgid "Then start up the domain with the new, resized disk:"
27452 #: ../tools/virt-resize.pl:194
27455 " # virsh start guestname\n"
27460 #: ../tools/virt-resize.pl:196
27462 "and check that it still works. See also the L</NOTES> section below for "
27463 "additional information."
27467 #: ../tools/virt-resize.pl:199
27468 msgid "7. Resize LVs etc inside the guest"
27472 #: ../tools/virt-resize.pl:201
27473 msgid "(This can also be done offline using L<guestfish(1)>)"
27477 #: ../tools/virt-resize.pl:203
27479 "Once the guest has booted you should see the new space available, at least "
27480 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27481 "may need to resize LVs inside PVs, and also resize filesystem types that "
27482 "virt-resize does not know how to expand."
27486 #: ../tools/virt-resize.pl:210
27487 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27491 #: ../tools/virt-resize.pl:212
27493 "Shrinking is somewhat more complex than expanding, and only an overview is "
27498 #: ../tools/virt-resize.pl:215
27500 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27501 "filesystems). The user has to shrink content before passing the disk image "
27502 "to virt-resize, and virt-resize will check that the content has been shrunk "
27507 #: ../tools/virt-resize.pl:220
27508 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27512 #: ../tools/virt-resize.pl:222
27514 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27515 "steps 3 and 4 above to allocate a new disk image."
27519 #: ../tools/virt-resize.pl:225
27521 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27525 #: ../tools/virt-resize.pl:228
27526 msgid "IGNORING OR DELETING PARTITIONS"
27530 #: ../tools/virt-resize.pl:230
27532 "virt-resize also gives a convenient way to ignore or delete partitions when "
27533 "copying from the input disk to the output disk. Ignoring a partition speeds "
27534 "up the copy where you don't care about the existing contents of a "
27535 "partition. Deleting a partition removes it completely, but note that it "
27536 "also renumbers any partitions after the one which is deleted, which can "
27537 "leave some guests unbootable."
27541 #: ../tools/virt-resize.pl:237
27542 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27546 #: ../tools/virt-resize.pl:239
27548 "If the input disk is in qcow2 format, then you may prefer that the output is "
27549 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27550 "the fly. The output format is simply determined by the format of the empty "
27551 "output container that you provide. Thus to create qcow2 output, use:"
27555 #: ../tools/virt-resize.pl:245
27558 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27563 #: ../tools/virt-resize.pl:247
27564 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27568 #: ../tools/virt-resize.pl:249
27569 msgid "Similarly, to get non-sparse raw output use:"
27573 #: ../tools/virt-resize.pl:251
27576 " fallocate -l size outdisk\n"
27581 #: ../tools/virt-resize.pl:253
27583 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27584 "dev/zero of=outdisk bs=1M count=..>)"
27588 #: ../tools/virt-resize.pl:266
27589 msgid "Display help."
27593 #: ../tools/virt-resize.pl:280
27594 msgid "B<--resize part=size>"
27598 #: ../tools/virt-resize.pl:282
27600 "Resize the named partition (expanding or shrinking it) so that it has the "
27605 #: ../tools/virt-resize.pl:285
27607 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27608 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27609 "Exabytes; or as a percentage of the current size; or as a relative number or "
27610 "percentage. For example:"
27614 #: ../tools/virt-resize.pl:290
27617 " --resize /dev/sda2=10G\n"
27622 #: ../tools/virt-resize.pl:292
27625 " --resize /dev/sda4=90%\n"
27630 #: ../tools/virt-resize.pl:294
27633 " --resize /dev/sda2=+1G\n"
27638 #: ../tools/virt-resize.pl:296
27641 " --resize /dev/sda2=-200M\n"
27646 #: ../tools/virt-resize.pl:298
27649 " --resize /dev/sda1=+128K\n"
27654 #: ../tools/virt-resize.pl:300
27657 " --resize /dev/sda1=+10%\n"
27662 #: ../tools/virt-resize.pl:302
27665 " --resize /dev/sda1=-10%\n"
27670 #: ../tools/virt-resize.pl:304
27672 "You can increase the size of any partition. Virt-resize will expand the "
27673 "direct content of the partition if it knows how (see C<--expand> below)."
27677 #: ../tools/virt-resize.pl:308
27679 "You can only I<decrease> the size of partitions that contain filesystems or "
27680 "PVs which have already been shrunk. Virt-resize will check this has been "
27681 "done before proceeding, or else will print an error (see also C<--resize-"
27686 #: ../tools/virt-resize.pl:313 ../tools/virt-resize.pl:405
27687 #: ../tools/virt-resize.pl:422
27688 msgid "You can give this option multiple times."
27692 #: ../tools/virt-resize.pl:319
27693 msgid "B<--resize-force part=size>"
27697 #: ../tools/virt-resize.pl:321
27699 "This is the same as C<--resize> except that it will let you decrease the "
27700 "size of any partition. Generally this means you will lose any data which "
27701 "was at the end of the partition you shrink, but you may not care about that "
27702 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27703 "as a swap partition)."
27707 #: ../tools/virt-resize.pl:327
27708 msgid "See also the C<--ignore> option."
27712 #: ../tools/virt-resize.pl:333
27713 msgid "B<--expand part>"
27717 #: ../tools/virt-resize.pl:335
27719 "Expand the named partition so it uses up all extra space (space left over "
27720 "after any other resize changes that you request have been done)."
27724 #: ../tools/virt-resize.pl:338
27726 "If virt-resize knows how, it will expand the direct content of the "
27727 "partition. For example, if the partition is an LVM PV, it will expand the "
27728 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27729 "content it doesn't know about alone."
27733 #: ../tools/virt-resize.pl:343
27734 msgid "Currently virt-resize can resize:"
27738 #: ../tools/virt-resize.pl:349
27740 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27745 #: ../tools/virt-resize.pl:354
27747 "NTFS filesystems contained directly in a partition, if libguestfs was "
27748 "compiled with support for NTFS."
27752 #: ../tools/virt-resize.pl:357
27754 "The filesystem must have been shut down consistently last time it was used. "
27755 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27756 "consistency check, so at the first boot after resizing Windows will check "
27761 #: ../tools/virt-resize.pl:364
27763 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27764 "inside the PV. The user will have to resize LVs as desired."
27768 #: ../tools/virt-resize.pl:370 ../tools/virt-resize.pl:392
27769 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27773 #: ../tools/virt-resize.pl:376
27774 msgid "B<--shrink part>"
27778 #: ../tools/virt-resize.pl:378
27780 "Shrink the named partition until the overall disk image fits in the "
27781 "destination. The named partition B<must> contain a filesystem or PV which "
27782 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27783 "online tools). Virt-resize will check this and give an error if it has not "
27788 #: ../tools/virt-resize.pl:384
27790 "The amount by which the overall disk must be shrunk (after carrying out all "
27791 "other operations requested by the user) is called the \"deficit\". For "
27792 "example, a straight copy (assume no other operations) from a 5GB disk image "
27793 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27794 "would give an error unless the user specified a partition to shrink and that "
27795 "partition had more than a gigabyte of free space."
27799 #: ../tools/virt-resize.pl:398
27800 msgid "B<--ignore part>"
27804 #: ../tools/virt-resize.pl:400
27806 "Ignore the named partition. Effectively this means the partition is "
27807 "allocated on the destination disk, but the content is not copied across from "
27808 "the source disk. The content of the partition will be blank (all zero "
27813 #: ../tools/virt-resize.pl:411
27814 msgid "B<--delete part>"
27818 #: ../tools/virt-resize.pl:413
27820 "Delete the named partition. It would be more accurate to describe this as "
27821 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27822 "the original disk image is left intact."
27826 #: ../tools/virt-resize.pl:417
27828 "Note that when you delete a partition, then anything contained in the "
27829 "partition is also deleted. Furthermore, this causes any partitions that "
27830 "come after to be I<renumbered>, which can easily make your guest unbootable."
27834 #: ../tools/virt-resize.pl:428
27835 msgid "B<--LV-expand logvol>"
27839 #: ../tools/virt-resize.pl:430
27841 "This takes the logical volume and, as a final step, expands it to fill all "
27842 "the space available in its volume group. A typical usage, assuming a Linux "
27843 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27844 "lv_root> would be:"
27848 #: ../tools/virt-resize.pl:435
27851 " virt-resize indisk outdisk \\\n"
27852 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27857 #: ../tools/virt-resize.pl:438
27859 "This would first expand the partition (and PV), and then expand the root "
27860 "device to fill the extra space in the PV."
27864 #: ../tools/virt-resize.pl:441
27866 "The contents of the LV are also resized if virt-resize knows how to do "
27867 "that. You can stop virt-resize from trying to expand the content by using "
27868 "the option C<--no-expand-content>."
27872 #: ../tools/virt-resize.pl:445
27873 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27877 #: ../tools/virt-resize.pl:448
27879 "You can give this option multiple times, I<but> it doesn't make sense to do "
27880 "this unless the logical volumes you specify are all in different volume "
27885 #: ../tools/virt-resize.pl:456
27886 msgid "B<--no-copy-boot-loader>"
27890 #: ../tools/virt-resize.pl:458
27892 "By default, virt-resize copies over some sectors at the start of the disk "
27893 "(up to the beginning of the first partition). Commonly these sectors "
27894 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27895 "in order for the guest to boot correctly."
27899 #: ../tools/virt-resize.pl:463
27901 "If you specify this flag, then this initial copy is not done. You may need "
27902 "to reinstall the boot loader in this case."
27906 #: ../tools/virt-resize.pl:471
27907 msgid "B<--no-extra-partition>"
27911 #: ../tools/virt-resize.pl:473
27913 "By default, virt-resize creates an extra partition if there is any extra, "
27914 "unused space after all resizing has happened. Use this option to prevent "
27915 "the extra partition from being created. If you do this then the extra space "
27916 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27917 "tool in the guest."
27921 #: ../tools/virt-resize.pl:479
27923 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27928 #: ../tools/virt-resize.pl:486
27929 msgid "B<--no-expand-content>"
27933 #: ../tools/virt-resize.pl:488
27935 "By default, virt-resize will try to expand the direct contents of "
27936 "partitions, if it knows how (see C<--expand> option above)."
27940 #: ../tools/virt-resize.pl:491
27942 "If you give the C<--no-expand-content> option then virt-resize will not "
27947 #: ../tools/virt-resize.pl:498
27948 msgid "B<-d> | B<--debug>"
27952 #: ../tools/virt-resize.pl:506
27953 msgid "B<-n> | B<--dryrun>"
27957 #: ../tools/virt-resize.pl:508
27958 msgid "Print a summary of what would be done, but don't do anything."
27962 #: ../tools/virt-resize.pl:514
27963 msgid "B<-q> | B<--quiet>"
27967 #: ../tools/virt-resize.pl:516
27968 msgid "Don't print the summary."
27972 #: ../tools/virt-resize.pl:524
27974 "Specify the format of the input disk image. If this flag is not given then "
27975 "it is auto-detected from the image itself."
27979 #: ../tools/virt-resize.pl:530
27981 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27982 "AND NON-SPARSE RAW FORMATS>."
27986 #: ../tools/virt-resize.pl:537
27987 msgid "B<--output-format> raw"
27991 #: ../tools/virt-resize.pl:539
27993 "Specify the format of the output disk image. If this flag is not given then "
27994 "it is auto-detected from the image itself."
27998 #: ../tools/virt-resize.pl:545
28000 "Note that you still need to create the output disk with the right format. "
28001 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28005 #: ../tools/virt-resize.pl:1421 ../tools/virt-rescue.pl:90
28010 #: ../tools/virt-resize.pl:1423
28011 msgid "\"Partition 1 does not end on cylinder boundary.\""
28015 #: ../tools/virt-resize.pl:1425
28017 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28018 "means the partitions will not be aligned to the ancient CHS geometry. "
28019 "However CHS geometry is meaningless for disks manufactured since the early "
28020 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28021 "cylinders is not required by any modern operating system."
28025 #: ../tools/virt-resize.pl:1432
28026 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28030 #: ../tools/virt-resize.pl:1434
28032 "In Windows Vista and later versions, Microsoft switched to using a separate "
28033 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28034 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28035 "the boot partition. Doing so seems to break the guest completely. However "
28036 "expanding the second partition (ie. C: drive) should work."
28040 #: ../tools/virt-resize.pl:1441
28042 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28043 "NTFS partitions have been expanded. This is just a safety check and (unless "
28044 "it find errors) is nothing to worry about."
28048 #: ../tools/virt-resize.pl:1445
28049 msgid "GUEST BOOT STUCK AT \"GRUB\""
28053 #: ../tools/virt-resize.pl:1447
28055 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28056 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28057 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28058 "although we think is to do with partition alignment."
28062 #: ../tools/virt-resize.pl:1452
28065 " guestfish -i -a newdisk\n"
28066 " ><fs> cat /boot/grub/device.map\n"
28067 " # check the contents of this file are sensible or\n"
28068 " # edit the file if necessary\n"
28069 " ><fs> grub-install / /dev/vda\n"
28075 #: ../tools/virt-resize.pl:1459
28077 "For more flexible guest reconfiguration, including if you need to specify "
28078 "other parameters to grub-install, use L<virt-rescue(1)>."
28082 #: ../tools/virt-resize.pl:1462
28083 msgid "ALTERNATIVE TOOLS"
28087 #: ../tools/virt-resize.pl:1464
28089 "There are several proprietary tools for resizing partitions. We won't "
28090 "mention any here."
28094 #: ../tools/virt-resize.pl:1467
28096 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28097 "operations on disk images. They can resize and move partitions, but I don't "
28098 "think they can do anything with the contents, and they certainly don't "
28103 #: ../tools/virt-resize.pl:1472
28105 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28106 "but at a much lower level. You will probably end up hand-calculating sector "
28107 "offsets, which is something that virt-resize was designed to avoid. If you "
28108 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28113 #: ../tools/virt-resize.pl:1487
28115 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
28116 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
28117 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
28118 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
28119 "libguestfs.org/>."
28123 #: ../tools/virt-list-filesystems.pl:32
28125 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28129 #: ../tools/virt-list-filesystems.pl:36
28132 " virt-list-filesystems [--options] domname\n"
28137 #: ../tools/virt-list-filesystems.pl:38
28140 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28145 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28147 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28152 #: ../tools/virt-list-filesystems.pl:45
28154 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28155 "are contained in a virtual machine or disk image."
28159 #: ../tools/virt-list-filesystems.pl:49
28161 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28162 "functionality. For more complex cases you should look at the L<guestfish(1)"
28167 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28168 msgid "B<-l> | B<--long>"
28172 #: ../tools/virt-list-filesystems.pl:108
28174 "With this option, C<virt-list-filesystems> displays the type of each "
28175 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28179 #: ../tools/virt-list-filesystems.pl:115
28180 msgid "B<-a> | B<--all>"
28184 #: ../tools/virt-list-filesystems.pl:117
28186 "Normally we only show mountable filesystems. If this option is given then "
28187 "swap devices are shown too."
28191 #: ../tools/virt-list-filesystems.pl:191
28193 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
28194 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28195 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28199 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
28200 msgid "Copyright (C) 2009 Red Hat Inc."
28204 #: ../tools/virt-tar.pl:33
28205 msgid "virt-tar - Extract or upload files to a virtual machine"
28209 #: ../tools/virt-tar.pl:37
28212 " virt-tar [--options] -x domname directory tarball\n"
28217 #: ../tools/virt-tar.pl:39
28220 " virt-tar [--options] -u domname tarball directory\n"
28225 #: ../tools/virt-tar.pl:41
28228 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28233 #: ../tools/virt-tar.pl:43
28236 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28241 #: ../tools/virt-tar.pl:47
28242 msgid "Download C</home> from the VM into a local tarball:"
28246 #: ../tools/virt-tar.pl:49
28249 " virt-tar -x domname /home home.tar\n"
28254 #: ../tools/virt-tar.pl:51
28257 " virt-tar -zx domname /home home.tar.gz\n"
28262 #: ../tools/virt-tar.pl:53
28263 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28267 #: ../tools/virt-tar.pl:55
28270 " virt-tar -u domname uploadstuff.tar /tmp\n"
28275 #: ../tools/virt-tar.pl:57
28278 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28283 #: ../tools/virt-tar.pl:61
28285 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28286 "virtual machines. If you do this, you risk disk corruption in the VM. "
28287 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28291 #: ../tools/virt-tar.pl:66
28293 "You can use C<-x> (extract) on live virtual machines, but you might get "
28294 "inconsistent results or errors if there is filesystem activity inside the "
28295 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28296 "work, but the only way to guarantee consistent results is if the virtual "
28297 "machine is shut down."
28301 #: ../tools/virt-tar.pl:74
28303 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28304 "parts of a guest filesystem. There are many possibilities: making backups, "
28305 "uploading data files, snooping on guest activity, fixing or customizing "
28310 #: ../tools/virt-tar.pl:79
28312 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28313 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28314 "should look at the L<guestfish(1)> tool."
28318 #: ../tools/virt-tar.pl:83
28320 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28321 "its contents (recursively) from the virtual machine into a local tarball. "
28322 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28323 "virtual machine. You cannot use these two options together."
28327 #: ../tools/virt-tar.pl:89
28329 "In addition, you may need to use the C<-z> (gZip) option to enable "
28330 "compression. When uploading, you have to specify C<-z> if the upload file "
28331 "is compressed because virt-tar won't detect this on its own."
28335 #: ../tools/virt-tar.pl:93
28337 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28338 "example it cannot do PKZip files or bzip2 compression. If you want that "
28339 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28340 "the L<libguestfs(3)> API)."
28344 #: ../tools/virt-tar.pl:151
28345 msgid "B<-x> | B<--extract> | B<--download>"
28349 #: ../tools/virt-tar.pl:153
28350 msgid "B<-u> | B<--upload>"
28354 #: ../tools/virt-tar.pl:155
28356 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28361 #: ../tools/virt-tar.pl:158
28363 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28364 "Please read the L</WARNING> section above before using this option."
28368 #: ../tools/virt-tar.pl:162
28369 msgid "You must specify exactly one of these options."
28373 #: ../tools/virt-tar.pl:168
28374 msgid "B<-z> | B<--gzip>"
28378 #: ../tools/virt-tar.pl:170
28379 msgid "Specify that the input or output tarball is gzip-compressed."
28383 #: ../tools/virt-tar.pl:283
28385 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28386 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28391 #: ../tools/virt-rescue.pl:33
28392 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28396 #: ../tools/virt-rescue.pl:37
28399 " virt-rescue [--options] domname\n"
28404 #: ../tools/virt-rescue.pl:39
28407 " virt-rescue [--options] disk.img [disk.img ...]\n"
28412 #: ../tools/virt-rescue.pl:43
28414 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28415 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28416 "you from doing this, but doesn't catch all cases."
28420 #: ../tools/virt-rescue.pl:47
28422 "However if you use the I<--ro> (read only) option, then you can attach a "
28423 "shell to a live virtual machine. The results might be strange or "
28424 "inconsistent at times but you won't get disk corruption."
28428 #: ../tools/virt-rescue.pl:53
28430 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28431 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28432 "recovery tools which you can use to examine or rescue a virtual machine or "
28437 #: ../tools/virt-rescue.pl:58
28439 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28440 "on disk image(s):"
28444 #: ../tools/virt-rescue.pl:61
28447 " virt-rescue GuestName\n"
28452 #: ../tools/virt-rescue.pl:63
28455 " virt-rescue --ro /path/to/disk.img\n"
28460 #: ../tools/virt-rescue.pl:65
28463 " virt-rescue /dev/sdc\n"
28468 #: ../tools/virt-rescue.pl:67
28469 msgid "For live VMs you I<must> use the --ro option."
28473 #: ../tools/virt-rescue.pl:69
28475 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28476 "in an interactive bash shell where you can use many ordinary Linux "
28477 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28478 "appliance. You must mount the virtual machine's filesystems by hand. There "
28479 "is an empty directory called C</sysroot> where you can mount filesystems."
28483 #: ../tools/virt-rescue.pl:76
28485 "In the example below, we list logical volumes, then choose one to mount "
28486 "under C</sysroot>:"
28490 #: ../tools/virt-rescue.pl:79
28494 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28495 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28496 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28497 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28498 " ><rescue> ls /sysroot\n"
28503 #: ../tools/virt-rescue.pl:86
28505 "If you don't know what filesystems are available on the virtual machine then "
28506 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28510 #: ../tools/virt-rescue.pl:92
28512 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28513 "virtual machine. For example you can use it on a blank file if you want to "
28514 "partition that file (although we would recommend using L<guestfish(1)> "
28515 "instead as it is more suitable for this purpose). You can even use virt-"
28516 "rescue on things like SD cards."
28520 #: ../tools/virt-rescue.pl:98
28522 "This tool is just designed for quick interactive hacking on a virtual "
28523 "machine. For more structured access to a virtual machine disk image, you "
28524 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28525 "make scripted changes to guests, use L<guestfish(1)>."
28529 #: ../tools/virt-rescue.pl:127
28530 msgid "B<--append kernelopts>"
28534 #: ../tools/virt-rescue.pl:129
28535 msgid "Pass additional options to the rescue kernel."
28539 #: ../tools/virt-rescue.pl:164
28540 msgid "B<--memsize MB> | B<-m MB>"
28544 #: ../tools/virt-rescue.pl:166
28546 "Change the amount of memory allocated to the rescue system. The default is "
28547 "set by libguestfs and is small but adequate for running system tools. The "
28548 "occasional program might need more memory. The parameter is specified in "
28553 #: ../tools/virt-rescue.pl:175
28554 msgid "B<--network>"
28558 #: ../tools/virt-rescue.pl:177
28559 msgid "Enable QEMU user networking in the guest."
28563 #: ../tools/virt-rescue.pl:183
28564 msgid "B<--ro> | B<-r>"
28568 #: ../tools/virt-rescue.pl:185
28569 msgid "Open the image read-only."
28573 #: ../tools/virt-rescue.pl:197
28575 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28576 "SELINUX> before using this option."
28580 #: ../tools/virt-rescue.pl:257
28582 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28583 "ENVIRONMENT VARIABLES> for the complete list."
28587 #: ../tools/virt-rescue.pl:269
28589 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28590 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28594 #: ../tools/virt-make-fs.pl:37
28595 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28599 #: ../tools/virt-make-fs.pl:41
28602 " virt-make-fs [--options] input.tar output.img\n"
28607 #: ../tools/virt-make-fs.pl:43
28610 " virt-make-fs [--options] input.tar.gz output.img\n"
28615 #: ../tools/virt-make-fs.pl:45
28618 " virt-make-fs [--options] directory output.img\n"
28623 #: ../tools/virt-make-fs.pl:49
28625 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28626 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28627 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28628 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28629 "you want to attach these filesystems to existing virtual machines (eg. to "
28630 "import large amounts of read-only data to a VM)."
28634 #: ../tools/virt-make-fs.pl:57
28635 msgid "Basic usage is:"
28639 #: ../tools/virt-make-fs.pl:59
28642 " virt-make-fs input output\n"
28647 #: ../tools/virt-make-fs.pl:61
28649 "where C<input> is either a directory containing files that you want to add, "
28650 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28651 "C<output> is a disk image. The input type is detected automatically. The "
28652 "output disk image defaults to a raw ext2 image unless you specify extra "
28653 "flags (see L</OPTIONS> below)."
28657 #: ../tools/virt-make-fs.pl:67
28658 msgid "EXTRA SPACE"
28662 #: ../tools/virt-make-fs.pl:69
28664 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28665 "the files that it contains, but might have extra space. Depending on how "
28666 "you are going to use the output, you might think this extra space is wasted "
28667 "and want to minimize it, or you might want to leave space so that more files "
28668 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28669 "but you can use the C<--size> flag to leave space in the filesystem if you "
28674 #: ../tools/virt-make-fs.pl:77
28676 "An alternative way to leave extra space but not make the output image any "
28677 "bigger is to use an alternative disk image format (instead of the default "
28678 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28679 "image format (check your hypervisor supports this before using it). This "
28680 "allows you to choose a large C<--size> but the extra space won't actually be "
28681 "allocated in the image until you try to store something in it."
28685 #: ../tools/virt-make-fs.pl:85
28687 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28688 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28689 "resize to build another image from scratch."
28693 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28694 #: ../tools/virt-make-fs.pl:142
28699 #: ../tools/virt-make-fs.pl:91
28702 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28707 #: ../tools/virt-make-fs.pl:93
28708 msgid "FILESYSTEM TYPE"
28712 #: ../tools/virt-make-fs.pl:95
28714 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28715 "libguestfs supports can be used (but I<not> read-only formats like "
28716 "ISO9660). Here are some of the more common choices:"
28720 #: ../tools/virt-make-fs.pl:101
28725 #: ../tools/virt-make-fs.pl:103
28727 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28728 "you are not going to use the filesystem in a way that requires the journal, "
28729 "then this is just wasted overhead."
28733 #: ../tools/virt-make-fs.pl:107
28734 msgid "I<ntfs> or I<vfat>"
28738 #: ../tools/virt-make-fs.pl:109
28739 msgid "Useful if exporting data to a Windows guest."
28743 #: ../tools/virt-make-fs.pl:111
28745 "I<Note for vfat>: The tar archive or local directory must only contain files "
28746 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28747 "program running within libguestfs is unable to change the ownership of non-"
28748 "root files, since vfat itself does not support this."
28752 #: ../tools/virt-make-fs.pl:116
28757 #: ../tools/virt-make-fs.pl:118
28759 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28760 "total filesystem size."
28764 #: ../tools/virt-make-fs.pl:125
28767 " virt-make-fs --type=minix input minixfs.img\n"
28772 #: ../tools/virt-make-fs.pl:127
28773 msgid "TO PARTITION OR NOT TO PARTITION"
28777 #: ../tools/virt-make-fs.pl:129
28778 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28782 #: ../tools/virt-make-fs.pl:131
28784 "Adding a partition can make the disk image more compatible with certain "
28785 "virtualized operating systems which don't expect to see a filesystem "
28786 "directly located on a block device (Linux doesn't care and will happily "
28787 "handle both types)."
28791 #: ../tools/virt-make-fs.pl:136
28793 "On the other hand, if you have a partition table then the output image is no "
28794 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28795 "directly on a partitioned disk image. (However libguestfs tools such as "
28796 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28800 #: ../tools/virt-make-fs.pl:144
28801 msgid "Add an MBR partition:"
28805 #: ../tools/virt-make-fs.pl:146
28808 " virt-make-fs --partition -- input disk.img\n"
28813 #: ../tools/virt-make-fs.pl:148
28815 "If the output disk image could be terabyte-sized or larger, it's better to "
28816 "use an EFI/GPT-compatible partition table:"
28820 #: ../tools/virt-make-fs.pl:151
28823 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28828 #: ../tools/virt-make-fs.pl:179
28829 msgid "Enable debugging information."
28833 #: ../tools/virt-make-fs.pl:185
28834 msgid "B<--size=E<lt>NE<gt>>"
28838 #: ../tools/virt-make-fs.pl:187
28839 msgid "B<--size=+E<lt>NE<gt>>"
28843 #: ../tools/virt-make-fs.pl:189
28844 msgid "B<-s E<lt>NE<gt>>"
28848 #: ../tools/virt-make-fs.pl:191
28849 msgid "B<-s +E<lt>NE<gt>>"
28853 #: ../tools/virt-make-fs.pl:193
28855 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28859 #: ../tools/virt-make-fs.pl:196
28861 "If this option is I<not> given, then the output image will be just large "
28862 "enough to contain all the files, with not much wasted space."
28866 #: ../tools/virt-make-fs.pl:199
28868 "To choose a fixed size output disk, specify an absolute number followed by b/"
28869 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28870 "Petabytes or Exabytes. This must be large enough to contain all the input "
28871 "files, else you will get an error."
28875 #: ../tools/virt-make-fs.pl:204
28877 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28878 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28879 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28880 "the input files, and (approximately) an extra 200 MB free space."
28884 #: ../tools/virt-make-fs.pl:210
28886 "Note that virt-make-fs estimates free space, and therefore will not produce "
28887 "filesystems containing precisely the free space requested. (It is much more "
28888 "expensive and time-consuming to produce a filesystem which has precisely the "
28889 "desired free space)."
28893 #: ../tools/virt-make-fs.pl:219
28894 msgid "B<--format=E<lt>fmtE<gt>>"
28898 #: ../tools/virt-make-fs.pl:221
28899 msgid "B<-F E<lt>fmtE<gt>>"
28903 #: ../tools/virt-make-fs.pl:223
28904 msgid "Choose the output disk image format."
28908 #: ../tools/virt-make-fs.pl:225
28909 msgid "The default is C<raw> (raw disk image)."
28913 #: ../tools/virt-make-fs.pl:227
28915 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28916 "that would really make sense here is C<qcow2>."
28920 #: ../tools/virt-make-fs.pl:234
28921 msgid "B<--type=E<lt>fsE<gt>>"
28925 #: ../tools/virt-make-fs.pl:236
28926 msgid "B<-t E<lt>fsE<gt>>"
28930 #: ../tools/virt-make-fs.pl:238
28931 msgid "Choose the output filesystem type."
28935 #: ../tools/virt-make-fs.pl:240
28936 msgid "The default is C<ext2>."
28940 #: ../tools/virt-make-fs.pl:242
28942 "Any filesystem which is supported read-write by libguestfs can be used here."
28946 #: ../tools/virt-make-fs.pl:249
28947 msgid "B<--partition>"
28951 #: ../tools/virt-make-fs.pl:251
28952 msgid "B<--partition=E<lt>parttypeE<gt>>"
28956 #: ../tools/virt-make-fs.pl:253
28958 "If specified, this flag adds an MBR partition table to the output disk image."
28962 #: ../tools/virt-make-fs.pl:256
28964 "You can change the partition table type, eg. C<--partition=gpt> for large "
28969 #: ../tools/virt-make-fs.pl:259
28971 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28972 "might consider the next parameter to be the partition type. For example:"
28976 #: ../tools/virt-make-fs.pl:263
28979 " virt-make-fs --partition input.tar ...\n"
28984 #: ../tools/virt-make-fs.pl:265
28986 "would cause virt-make-fs to think you wanted to use a partition type of "
28987 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28988 "dash) between options and the input file argument:"
28992 #: ../tools/virt-make-fs.pl:269
28995 " virt-make-fs --partition -- input.tar ...\n"
29000 #: ../tools/virt-make-fs.pl:536
29002 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
29003 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
29004 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29008 #: ../tools/virt-make-fs.pl:553
29011 " export LIBGUESTFS_DEBUG=1\n"
29012 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29017 #: ../tools/virt-make-fs.pl:556
29019 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
29024 #: ../tools/virt-list-partitions.pl:32
29026 "virt-list-partitions - List partitions in a virtual machine or disk image"
29030 #: ../tools/virt-list-partitions.pl:36
29033 " virt-list-partitions [--options] domname\n"
29038 #: ../tools/virt-list-partitions.pl:38
29041 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29046 #: ../tools/virt-list-partitions.pl:45
29048 "C<virt-list-partitions> is a command line tool to list the partitions that "
29049 "are contained in a virtual machine or disk image. It is mainly useful as a "
29050 "first step to using L<virt-resize(1)>."
29054 #: ../tools/virt-list-partitions.pl:50
29056 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29057 "functionality. For more complex cases you should look at the L<guestfish(1)"
29062 #: ../tools/virt-list-partitions.pl:107
29063 msgid "B<-h> | B<--human-readable>"
29067 #: ../tools/virt-list-partitions.pl:109
29068 msgid "Show sizes in human-readable form (eg. \"1G\")."
29072 #: ../tools/virt-list-partitions.pl:117
29074 "With this option, C<virt-list-partitions> displays the type and size of each "
29075 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29079 #: ../tools/virt-list-partitions.pl:124
29080 msgid "B<-t> | B<--total>"
29084 #: ../tools/virt-list-partitions.pl:126
29086 "Display the total size of each block device (as a separate row or rows)."
29090 #: ../tools/virt-list-partitions.pl:259
29092 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
29093 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
29094 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."