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-25 18:53+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
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
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
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
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
151 "There are also some example programs in the L<guestfs-examples(3)> manual "
156 #: ../src/guestfs.pod:58
161 #: ../src/guestfs.pod:60
163 "This section provides a gentler overview of the libguestfs API. We also try "
164 "to group API calls together, where that may not be obvious from reading "
165 "about the individual calls in the main section of this manual."
169 #: ../src/guestfs.pod:65
174 #: ../src/guestfs.pod:67
176 "Before you can use libguestfs calls, you have to create a handle. Then you "
177 "must add at least one disk image to the handle, followed by launching the "
178 "handle, then performing whatever operations you want, and finally closing "
179 "the handle. By convention we use the single letter C<g> for the name of the "
180 "handle variable, although of course you can use any name you want."
184 #: ../src/guestfs.pod:74
185 msgid "The general structure of all libguestfs-using programs looks like this:"
189 #: ../src/guestfs.pod:77
192 " guestfs_h *g = guestfs_create ();\n"
197 #: ../src/guestfs.pod:79
200 " /* Call guestfs_add_drive additional times if there are\n"
201 " * multiple disk images.\n"
203 " guestfs_add_drive (g, \"guest.img\");\n"
208 #: ../src/guestfs.pod:84
211 " /* Most manipulation calls won't work until you've launched\n"
212 " * the handle 'g'. You have to do this _after_ adding drives\n"
213 " * and _before_ other commands.\n"
215 " guestfs_launch (g);\n"
220 #: ../src/guestfs.pod:90
223 " /* Now you can examine what partitions, LVs etc are available.\n"
225 " char **partitions = guestfs_list_partitions (g);\n"
226 " char **logvols = guestfs_lvs (g);\n"
231 #: ../src/guestfs.pod:95
234 " /* To access a filesystem in the image, you must mount it.\n"
236 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
241 #: ../src/guestfs.pod:99
244 " /* Now you can perform filesystem actions on the guest\n"
247 " guestfs_touch (g, \"/hello\");\n"
252 #: ../src/guestfs.pod:104
255 " /* You only need to call guestfs_sync if you have made\n"
256 " * changes to the guest image. (But if you've made changes\n"
257 " * then you *must* sync). See also: guestfs_umount and\n"
258 " * guestfs_umount_all calls.\n"
260 " guestfs_sync (g);\n"
265 #: ../src/guestfs.pod:111
268 " /* Close the handle 'g'. */\n"
269 " guestfs_close (g);\n"
274 #: ../src/guestfs.pod:114
276 "The code above doesn't include any error checking. In real code you should "
277 "check return values carefully for errors. In general all functions that "
278 "return integers return C<-1> on error, and all functions that return "
279 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
280 "how to handle errors, and consult the documentation for each function call "
281 "below to see precisely how they return error indications."
285 #: ../src/guestfs.pod:122
290 #: ../src/guestfs.pod:124
292 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
293 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
294 "actual block device, or simply an empty file of zeroes that you have created "
295 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
300 #: ../src/guestfs.pod:130
302 "The call you should use in modern code for adding drives is L</"
303 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
304 "specifying that the format is raw, do:"
308 #: ../src/guestfs.pod:134
311 " guestfs_add_drive_opts (g, filename,\n"
312 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
318 #: ../src/guestfs.pod:138
319 msgid "You can add a disk read-only using:"
323 #: ../src/guestfs.pod:140
326 " guestfs_add_drive_opts (g, filename,\n"
327 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
328 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
334 #: ../src/guestfs.pod:145
336 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
337 "libguestfs won't modify the file."
341 #: ../src/guestfs.pod:148
343 "Be extremely cautious if the disk image is in use, eg. if it is being used "
344 "by a virtual machine. Adding it read-write will almost certainly cause disk "
345 "corruption, but adding it read-only is safe."
349 #: ../src/guestfs.pod:152
351 "You must add at least one disk image, and you may add multiple disk images. "
352 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
353 "first one you added), C</dev/sdb> (for the second one you added), etc."
357 #: ../src/guestfs.pod:157
359 "Once L</guestfs_launch> has been called you cannot add any more images. You "
360 "can call L</guestfs_list_devices> to get a list of the device names, in the "
361 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
365 #: ../src/guestfs.pod:162
370 #: ../src/guestfs.pod:164
372 "Before you can read or write files, create directories and so on in a disk "
373 "image that contains filesystems, you have to mount those filesystems using "
374 "L</guestfs_mount>. If you already know that a disk image contains (for "
375 "example) one partition with a filesystem on that partition, then you can "
380 #: ../src/guestfs.pod:170
383 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
388 #: ../src/guestfs.pod:172
390 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
391 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
392 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
396 #: ../src/guestfs.pod:176
398 "If you are given a disk image and you don't know what it contains then you "
399 "have to find out. Libguestfs can do that too: use L</"
400 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
401 "LVs, and either try mounting each to see what is mountable, or else examine "
402 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
403 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
404 "you might find it easier to look at higher level programs built on top of "
405 "libguestfs, in particular L<virt-inspector(1)>."
409 #: ../src/guestfs.pod:186
411 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
412 "several other variations of the C<guestfs_mount_*> call."
416 #: ../src/guestfs.pod:189
417 msgid "FILESYSTEM ACCESS AND MODIFICATION"
421 #: ../src/guestfs.pod:191
423 "The majority of the libguestfs API consists of fairly low-level calls for "
424 "accessing and modifying the files, directories, symlinks etc on mounted "
425 "filesystems. There are over a hundred such calls which you can find listed "
426 "in detail below in this man page, and we don't even pretend to cover them "
427 "all in this overview."
431 #: ../src/guestfs.pod:197
433 "Specify filenames as full paths, starting with C<\"/\"> and including the "
438 #: ../src/guestfs.pod:200
440 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
441 "the file called C<\"etc/passwd\"> then you could do:"
445 #: ../src/guestfs.pod:203
448 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
453 #: ../src/guestfs.pod:205
455 "This would return C<data> as a newly allocated buffer containing the full "
456 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
457 "or C<NULL> if there was an error."
461 #: ../src/guestfs.pod:209
463 "As another example, to create a top-level directory on that filesystem "
464 "called C<\"var\"> you would do:"
468 #: ../src/guestfs.pod:212
471 " guestfs_mkdir (g, \"/var\");\n"
476 #: ../src/guestfs.pod:214
477 msgid "To create a symlink you could do:"
481 #: ../src/guestfs.pod:216
484 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
485 " \"/etc/rc3.d/S30portmap\");\n"
490 #: ../src/guestfs.pod:219
492 "Libguestfs will reject attempts to use relative paths and there is no "
493 "concept of a current working directory."
497 #: ../src/guestfs.pod:222
499 "Libguestfs can return errors in many situations: for example if the "
500 "filesystem isn't writable, or if a file or directory that you requested "
501 "doesn't exist. If you are using the C API (documented here) you have to "
502 "check for those error conditions after each call. (Other language bindings "
503 "turn these errors into exceptions)."
507 #: ../src/guestfs.pod:228
509 "File writes are affected by the per-handle umask, set by calling L</"
510 "guestfs_umask> and defaulting to 022. See L</UMASK>."
514 #: ../src/guestfs.pod:231
519 #: ../src/guestfs.pod:233
521 "Libguestfs contains API calls to read, create and modify partition tables on "
526 #: ../src/guestfs.pod:236
528 "In the common case where you want to create a single partition covering the "
529 "whole disk, you should use the L</guestfs_part_disk> call:"
533 #: ../src/guestfs.pod:240
536 " const char *parttype = \"mbr\";\n"
537 " if (disk_is_larger_than_2TB)\n"
538 " parttype = \"gpt\";\n"
539 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
544 #: ../src/guestfs.pod:245
546 "Obviously this effectively wipes anything that was on that disk image before."
550 #: ../src/guestfs.pod:248
555 #: ../src/guestfs.pod:250
557 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
558 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
559 "you familiarize yourself with the concepts of physical volumes, volume "
560 "groups and logical volumes."
564 #: ../src/guestfs.pod:255
566 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
567 "tldp.org/HOWTO/LVM-HOWTO/>."
571 #: ../src/guestfs.pod:258
576 #: ../src/guestfs.pod:260
578 "Use L</guestfs_cat> to download small, text only files. This call is "
579 "limited to files which are less than 2 MB and which cannot contain any ASCII "
580 "NUL (C<\\0>) characters. However it has a very simple to use API."
584 #: ../src/guestfs.pod:265
586 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
587 "bit data, since it returns a (pointer, size) pair. However it is still "
588 "limited to \"small\" files, less than 2 MB."
592 #: ../src/guestfs.pod:269
594 "L</guestfs_download> can be used to download any file, with no limits on "
595 "content or size (even files larger than 4 GB)."
599 #: ../src/guestfs.pod:272
601 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
605 #: ../src/guestfs.pod:275
610 #: ../src/guestfs.pod:277
612 "It's often the case that you want to write a file or files to the disk image."
616 #: ../src/guestfs.pod:280
618 "To write a small file with fixed content, use L</guestfs_write>. To create "
619 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
620 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
621 "of other functions for creating test files, for example L</guestfs_fill> and "
622 "L</guestfs_fill_pattern>."
626 #: ../src/guestfs.pod:286
628 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
629 "file content or size (even files larger than 4 GB)."
633 #: ../src/guestfs.pod:289
635 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
639 #: ../src/guestfs.pod:291
641 "However the fastest way to upload I<large numbers of arbitrary files> is to "
642 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
643 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
644 "in a predictable way (eg. adding it last after all other drives) then you "
645 "can get the device name from L</guestfs_list_devices> and mount it directly "
646 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
647 "portable between kernel versions, and they don't support labels or UUIDs. "
648 "If you want to pre-build an image or you need to mount it using a label or "
649 "UUID, use an ISO image instead."
653 #: ../src/guestfs.pod:302
658 #: ../src/guestfs.pod:304
660 "There are various different commands for copying between files and devices "
661 "and in and out of the guest filesystem. These are summarised in the table "
666 #: ../src/guestfs.pod:310
667 msgid "B<file> to B<file>"
671 #: ../src/guestfs.pod:312
673 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
674 "directories recursively."
678 #: ../src/guestfs.pod:315
679 msgid "B<file or device> to B<file or device>"
683 #: ../src/guestfs.pod:317
685 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
686 "devices in the guest."
690 #: ../src/guestfs.pod:320
691 msgid "Example: duplicate the contents of an LV:"
695 #: ../src/guestfs.pod:322
698 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
703 #: ../src/guestfs.pod:324
705 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
706 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
707 "guestfs_copy_size>."
711 #: ../src/guestfs.pod:328
712 msgid "B<file on the host> to B<file or device>"
716 #: ../src/guestfs.pod:330
717 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
721 #: ../src/guestfs.pod:332
722 msgid "B<file or device> to B<file on the host>"
726 #: ../src/guestfs.pod:334
727 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
731 #: ../src/guestfs.pod:338
732 msgid "LISTING FILES"
736 #: ../src/guestfs.pod:340
738 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
739 "L<guestfish(1)>-equivalent command C<ll>)."
743 #: ../src/guestfs.pod:343
745 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
746 "programs, as a flat list of strings."
750 #: ../src/guestfs.pod:346
752 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
753 "directory, plus additional information about each one. It is more "
754 "equivalent to using the L<readdir(3)> call on a local filesystem."
758 #: ../src/guestfs.pod:350
760 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
764 #: ../src/guestfs.pod:353
765 msgid "RUNNING COMMANDS"
769 #: ../src/guestfs.pod:355
771 "Although libguestfs is primarily an API for manipulating files inside guest "
772 "images, we also provide some limited facilities for running commands inside "
777 #: ../src/guestfs.pod:359
778 msgid "There are many limitations to this:"
782 #: ../src/guestfs.pod:363 ../src/guestfs.pod:368 ../src/guestfs.pod:373
783 #: ../src/guestfs.pod:377 ../src/guestfs.pod:382 ../src/guestfs.pod:386
784 #: ../src/guestfs.pod:391 ../src/guestfs.pod:396 ../src/guestfs.pod:955
785 #: ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968
786 #: ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003
787 #: ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033
788 #: ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045
789 #: ../src/guestfs.pod:1527 ../src/guestfs.pod:1532 ../src/guestfs.pod:1536
790 #: ../src/guestfs.pod:1646 ../src/guestfs.pod:1651 ../src/guestfs.pod:1655
791 #: ../src/guestfs.pod:1999 ../src/guestfs.pod:2005 ../src/guestfs.pod:2010
792 #: ../src/guestfs.pod:2016 ../src/guestfs.pod:2128 ../src/guestfs.pod:2132
793 #: ../src/guestfs.pod:2136 ../src/guestfs.pod:2140
794 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
795 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
796 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
797 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
798 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
799 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
800 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
801 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
802 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
803 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
804 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
805 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:377
806 #: ../fish/guestfish.pod:381 ../fish/guestfish.pod:385
807 #: ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13
808 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375
809 #: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390
810 #: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067
811 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
812 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
813 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
814 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
815 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
816 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
817 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
818 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
819 #: ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:352
820 #: ../tools/virt-resize.pl:362
825 #: ../src/guestfs.pod:365
827 "The kernel version that the command runs under will be different from what "
832 #: ../src/guestfs.pod:370
834 "If the command needs to communicate with daemons, then most likely they "
839 #: ../src/guestfs.pod:375
840 msgid "The command will be running in limited memory."
844 #: ../src/guestfs.pod:379
846 "The network may not be available unless you enable it (see L</"
847 "guestfs_set_network>)."
851 #: ../src/guestfs.pod:384
852 msgid "Only supports Linux guests (not Windows, BSD, etc)."
856 #: ../src/guestfs.pod:388
858 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
862 #: ../src/guestfs.pod:393
864 "For SELinux guests, you may need to enable SELinux and load policy first. "
865 "See L</SELINUX> in this manpage."
869 #: ../src/guestfs.pod:398
871 "I<Security:> It is not safe to run commands from untrusted, possibly "
872 "malicious guests. These commands may attempt to exploit your program by "
873 "sending unexpected output. They could also try to exploit the Linux kernel "
874 "or qemu provided by the libguestfs appliance. They could use the network "
875 "provided by the libguestfs appliance to bypass ordinary network partitions "
876 "and firewalls. They could use the elevated privileges or different SELinux "
877 "context of your program to their advantage."
881 #: ../src/guestfs.pod:407
883 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
884 "(a script which runs when the guest next boots normally), and to have this "
885 "script run the commands you want in the normal context of the running guest, "
886 "network security and so on. For information about other security issues, "
891 #: ../src/guestfs.pod:415
893 "The two main API calls to run commands are L</guestfs_command> and L</"
894 "guestfs_sh> (there are also variations)."
898 #: ../src/guestfs.pod:418
900 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
901 "shell globs, redirections, etc will work."
905 #: ../src/guestfs.pod:421
906 msgid "CONFIGURATION FILES"
910 #: ../src/guestfs.pod:423
912 "To read and write configuration files in Linux guest filesystems, we "
913 "strongly recommend using Augeas. For example, Augeas understands how to "
914 "read and write, say, a Linux shadow password file or X.org configuration "
915 "file, and so avoids you having to write that code."
919 #: ../src/guestfs.pod:428
921 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
922 "document Augeas itself here because there is excellent documentation on the "
923 "L<http://augeas.net/> website."
927 #: ../src/guestfs.pod:432
929 "If you don't want to use Augeas (you fool!) then try calling L</"
930 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
935 #: ../src/guestfs.pod:436
940 #: ../src/guestfs.pod:438
942 "We support SELinux guests. To ensure that labeling happens correctly in "
943 "SELinux guests, you need to enable SELinux and load the guest's policy:"
947 #: ../src/guestfs.pod:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279
952 #: ../src/guestfs.pod:446
953 msgid "Before launching, do:"
957 #: ../src/guestfs.pod:448
960 " guestfs_set_selinux (g, 1);\n"
965 #: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283
970 #: ../src/guestfs.pod:452
972 "After mounting the guest's filesystem(s), load the policy. This is best "
973 "done by running the L<load_policy(8)> command in the guest itself:"
977 #: ../src/guestfs.pod:456
980 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
985 #: ../src/guestfs.pod:458
987 "(Older versions of C<load_policy> require you to specify the name of the "
992 #: ../src/guestfs.pod:461 ../src/guestfs.pod:1289
997 #: ../src/guestfs.pod:463
999 "Optionally, set the security context for the API. The correct security "
1000 "context to use can only be known by inspecting the guest. As an example:"
1004 #: ../src/guestfs.pod:467
1007 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1012 #: ../src/guestfs.pod:471
1013 msgid "This will work for running commands and editing existing files."
1017 #: ../src/guestfs.pod:473
1019 "When new files are created, you may need to label them explicitly, for "
1020 "example by running the external command C<restorecon pathname>."
1024 #: ../src/guestfs.pod:477
1029 #: ../src/guestfs.pod:479
1031 "Certain calls are affected by the current file mode creation mask (the "
1032 "\"umask\"). In particular ones which create files or directories, such as "
1033 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1034 "either the default mode that the file is created with or modifies the mode "
1039 #: ../src/guestfs.pod:485
1041 "The default umask is C<022>, so files are created with modes such as C<0644> "
1042 "and directories with C<0755>."
1046 #: ../src/guestfs.pod:488
1048 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1049 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1050 "guestfs_chmod> after creating each file or directory."
1054 #: ../src/guestfs.pod:492
1055 msgid "For more information about umask, see L<umask(2)>."
1059 #: ../src/guestfs.pod:494 ../fish/guestfish.pod:670
1060 msgid "ENCRYPTED DISKS"
1064 #: ../src/guestfs.pod:496
1066 "Libguestfs allows you to access Linux guests which have been encrypted using "
1067 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1068 "standard. This includes nearly all whole disk encryption systems used by "
1069 "modern Linux guests."
1073 #: ../src/guestfs.pod:502
1075 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1076 "returns the string C<crypto_LUKS>)."
1080 #: ../src/guestfs.pod:505
1082 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1083 "will require the passphrase!"
1087 #: ../src/guestfs.pod:508
1089 "Opening a LUKS device creates a new device mapper device called C</dev/"
1090 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1091 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1092 "from and encrypted to the underlying block device respectively."
1096 #: ../src/guestfs.pod:514
1098 "LVM volume groups on the device can be made visible by calling L</"
1099 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1100 "(s) can now be mounted in the usual way."
1104 #: ../src/guestfs.pod:518
1106 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1107 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1108 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1109 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1110 "underlying encrypted block device)."
1114 #: ../src/guestfs.pod:525
1119 #: ../src/guestfs.pod:527
1121 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1122 "contains operating systems. (These APIs used to be in a separate Perl-only "
1123 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1124 "frequently used part of this library has been rewritten in C and moved into "
1129 #: ../src/guestfs.pod:533
1131 "Add all disks belonging to the unknown virtual machine and call L</"
1132 "guestfs_launch> in the usual way."
1136 #: ../src/guestfs.pod:536
1138 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1139 "and certain heuristics, and returns a list of operating systems that were "
1140 "found. An empty list means none were found. A single element is the root "
1141 "filesystem of the operating system. For dual- or multi-boot guests, "
1142 "multiple roots can be returned, each one corresponding to a separate "
1143 "operating system. (Multi-boot virtual machines are extremely rare in the "
1144 "world of virtualization, but since this scenario can happen, we have built "
1145 "libguestfs to deal with it.)"
1149 #: ../src/guestfs.pod:545
1151 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1152 "to get additional details about that operating system. For example, call L</"
1153 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1154 "Windows and Linux-based operating systems respectively."
1158 #: ../src/guestfs.pod:551
1160 "Un*x-like and Linux-based operating systems usually consist of several "
1161 "filesystems which are mounted at boot time (for example, a separate boot "
1162 "partition mounted on C</boot>). The inspection rules are able to detect how "
1163 "filesystems correspond to mount points. Call "
1164 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1165 "hash table like this example:"
1169 #: ../src/guestfs.pod:558
1172 " /boot => /dev/sda1\n"
1173 " / => /dev/vg_guest/lv_root\n"
1174 " /usr => /dev/vg_guest/lv_usr\n"
1179 #: ../src/guestfs.pod:562
1181 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1182 "filesystems as suggested."
1186 #: ../src/guestfs.pod:565
1188 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1189 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1193 #: ../src/guestfs.pod:569
1195 "Inspection currently only works for some common operating systems. "
1196 "Contributors are welcome to send patches for other operating systems that we "
1197 "currently cannot detect."
1201 #: ../src/guestfs.pod:573
1203 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1204 "for more details. The L</guestfs_inspect_os> function just ignores any "
1205 "encrypted devices."
1209 #: ../src/guestfs.pod:577
1211 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1212 "inspection and caches the results in the guest handle. Subsequent calls to "
1213 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1214 "read the disks. If you change the content of the guest disks, you can redo "
1215 "inspection by calling L</guestfs_inspect_os> again. (L</"
1216 "guestfs_inspect_list_applications> works a little differently from the other "
1217 "calls and does read the disks. See documentation for that function for "
1222 #: ../src/guestfs.pod:586
1223 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1227 #: ../src/guestfs.pod:588
1229 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1230 "ntfs-3g.org/> driver."
1234 #: ../src/guestfs.pod:591
1236 "DOS and Windows still use drive letters, and the filesystems are always "
1237 "treated as case insensitive by Windows itself, and therefore you might find "
1238 "a Windows configuration file referring to a path like C<c:\\windows"
1239 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1240 "might be referred to as C</WINDOWS/System32>."
1244 #: ../src/guestfs.pod:597
1246 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1247 "libguestfs to read the appropriate Windows Registry and configuration files, "
1248 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1253 #: ../src/guestfs.pod:602
1255 "Replacing backslash characters with forward slash characters is also outside "
1256 "the scope of libguestfs, but something that you can easily do."
1260 #: ../src/guestfs.pod:605
1262 "Where we can help is in resolving the case insensitivity of paths. For "
1263 "this, call L</guestfs_case_sensitive_path>."
1267 #: ../src/guestfs.pod:608
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1274 "reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:616
1279 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1283 #: ../src/guestfs.pod:618
1285 "Although we don't want to discourage you from using the C API, we will "
1286 "mention here that the same API is also available in other languages."
1290 #: ../src/guestfs.pod:621
1292 "The API is broadly identical in all supported languages. This means that "
1293 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1294 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1295 "words, a straightforward, predictable isomorphism between each language."
1299 #: ../src/guestfs.pod:627
1301 "Error messages are automatically transformed into exceptions if the language "
1306 #: ../src/guestfs.pod:630
1308 "We don't try to \"object orientify\" parts of the API in OO languages, "
1309 "although contributors are welcome to write higher level APIs above what we "
1310 "provide in their favourite languages if they wish."
1314 #: ../src/guestfs.pod:636
1319 #: ../src/guestfs.pod:638
1321 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1322 "identical to the C API. C++ classes and exceptions are not used."
1326 #: ../src/guestfs.pod:642
1331 #: ../src/guestfs.pod:644
1333 "The C# bindings are highly experimental. Please read the warnings at the "
1334 "top of C<csharp/Libguestfs.cs>."
1338 #: ../src/guestfs.pod:647
1343 #: ../src/guestfs.pod:649
1345 "This is the only language binding that is working but incomplete. Only "
1346 "calls which return simple integers have been bound in Haskell, and we are "
1347 "looking for help to complete this binding."
1351 #: ../src/guestfs.pod:653
1356 #: ../src/guestfs.pod:655
1358 "Full documentation is contained in the Javadoc which is distributed with "
1363 #: ../src/guestfs.pod:658
1368 #: ../src/guestfs.pod:660
1369 msgid "For documentation see L<guestfs-ocaml(3)>."
1373 #: ../src/guestfs.pod:662
1378 #: ../src/guestfs.pod:664
1379 msgid "For documentation see L<Sys::Guestfs(3)>."
1383 #: ../src/guestfs.pod:666
1388 #: ../src/guestfs.pod:668
1390 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1391 "the php-libguestfs package for your distribution."
1395 #: ../src/guestfs.pod:671
1396 msgid "The PHP binding only works correctly on 64 bit machines."
1400 #: ../src/guestfs.pod:673
1405 #: ../src/guestfs.pod:675
1406 msgid "For documentation see L<guestfs-python(3)>."
1410 #: ../src/guestfs.pod:677
1415 #: ../src/guestfs.pod:679
1416 msgid "For documentation see L<guestfs-ruby(3)>."
1420 #: ../src/guestfs.pod:681
1421 msgid "B<shell scripts>"
1425 #: ../src/guestfs.pod:683
1426 msgid "For documentation see L<guestfish(1)>."
1430 #: ../src/guestfs.pod:687
1431 msgid "LIBGUESTFS GOTCHAS"
1435 #: ../src/guestfs.pod:689
1437 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1438 "system [...] that works in the way it is documented but is counterintuitive "
1439 "and almost invites mistakes.\""
1443 #: ../src/guestfs.pod:693
1445 "Since we developed libguestfs and the associated tools, there are several "
1446 "things we would have designed differently, but are now stuck with for "
1447 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1448 "release, you can expect these to change. Beware of them."
1452 #: ../src/guestfs.pod:701
1453 msgid "Autosync / forgetting to sync."
1457 #: ../src/guestfs.pod:703
1459 "When modifying a filesystem from C or another language, you B<must> unmount "
1460 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1461 "libguestfs handle. You can also call:"
1465 #: ../src/guestfs.pod:707
1468 " guestfs_set_autosync (g, 1);\n"
1473 #: ../src/guestfs.pod:709
1475 "to have the unmount/sync done automatically for you when the handle 'g' is "
1476 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1480 #: ../src/guestfs.pod:713
1482 "If you forget to do this, then it is entirely possible that your changes "
1483 "won't be written out, or will be partially written, or (very rarely) that "
1484 "you'll get disk corruption."
1488 #: ../src/guestfs.pod:717
1490 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1491 "guestfish scripts that forget to sync will work just fine, which can make "
1492 "this very puzzling if you are trying to debug a problem."
1496 #: ../src/guestfs.pod:721
1498 "Update: Autosync is enabled by default for all API users starting from "
1499 "libguestfs 1.5.24."
1503 #: ../src/guestfs.pod:724
1504 msgid "Mount option C<-o sync> should not be the default."
1508 #: ../src/guestfs.pod:726
1510 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1511 "However C<-o sync> does not add any reliability benefit, but does have a "
1512 "very large performance impact."
1516 #: ../src/guestfs.pod:730
1518 "The work around is to use L</guestfs_mount_options> and set the mount "
1519 "options that you actually want to use."
1523 #: ../src/guestfs.pod:733
1524 msgid "Read-only should be the default."
1528 #: ../src/guestfs.pod:735
1530 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1531 "specify I<--rw> if you want to make changes to the image."
1535 #: ../src/guestfs.pod:738
1536 msgid "This would reduce the potential to corrupt live VM images."
1540 #: ../src/guestfs.pod:740
1542 "Note that many filesystems change the disk when you just mount and unmount, "
1543 "even if you didn't perform any writes. You need to use L</"
1544 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1548 #: ../src/guestfs.pod:744
1549 msgid "guestfish command line is hard to use."
1553 #: ../src/guestfs.pod:746
1555 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1556 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1557 "exist, so it fails. In earlier versions of guestfish the error message was "
1558 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1559 "we should have used C<guestfish -c command> to run commands."
1563 #: ../src/guestfs.pod:753
1564 msgid "guestfish megabyte modifiers don't work right on all commands"
1568 #: ../src/guestfs.pod:755
1570 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1571 "other modifiers). What guestfish actually does is to multiply the number "
1572 "part by the modifier part and pass the result to the C API. However this "
1573 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1574 "expecting some other unit (eg. megabytes)."
1578 #: ../src/guestfs.pod:762
1579 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1583 #: ../src/guestfs.pod:764
1586 " lvcreate LV VG 100M\n"
1591 #: ../src/guestfs.pod:766
1593 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1594 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1595 "megabytes * megabytes) logical volume. The error message you get from this "
1596 "is also a little obscure."
1600 #: ../src/guestfs.pod:771
1602 "This could be fixed in the generator by specially marking parameters and "
1603 "return values which take bytes or other units."
1607 #: ../src/guestfs.pod:774
1608 msgid "Ambiguity between devices and paths"
1612 #: ../src/guestfs.pod:776
1614 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1615 "sdb2>) and a similar pathname. A file might just happen to be called "
1616 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1620 #: ../src/guestfs.pod:781
1622 "In the current API we usually resolve this ambiguity by having two separate "
1623 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1624 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1625 "detecting if the path supplied begins with C</dev/>."
1629 #: ../src/guestfs.pod:787
1631 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1632 "make paths/devices into structured names. One way to do this would be to "
1633 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1634 "aspect of grub. Another way would be to use a structured type, equivalent "
1635 "to this OCaml type:"
1639 #: ../src/guestfs.pod:793
1642 " type path = Path of string | Device of int | Partition of int * int\n"
1647 #: ../src/guestfs.pod:795
1648 msgid "which would allow you to pass arguments like:"
1652 #: ../src/guestfs.pod:797
1655 " Path \"/foo/bar\"\n"
1656 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1657 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1658 " Path \"/dev/sdb2\" (* not a device *)\n"
1663 #: ../src/guestfs.pod:802
1665 "As you can see there are still problems to resolve even with this "
1666 "representation. Also consider how it might work in guestfish."
1670 #: ../src/guestfs.pod:807
1671 msgid "PROTOCOL LIMITS"
1675 #: ../src/guestfs.pod:809
1677 "Internally libguestfs uses a message-based protocol to pass API calls and "
1678 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1679 "plenty more detail about this). The maximum message size used by the "
1680 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1681 "aware of this limit. The API calls which may be affected are individually "
1682 "documented, with a link back to this section of the documentation."
1686 #: ../src/guestfs.pod:817
1688 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1689 "a simple string. Because this string is at some point internally encoded as "
1690 "a message, the maximum size that it can return is slightly under 4 MB. If "
1691 "the requested file is larger than this then you will get an error."
1695 #: ../src/guestfs.pod:823
1697 "In order to transfer large files into and out of the guest filesystem, you "
1698 "need to use particular calls that support this. The sections L</UPLOADING> "
1699 "and L</DOWNLOADING> document how to do this."
1703 #: ../src/guestfs.pod:827
1705 "You might also consider mounting the disk image using our FUSE filesystem "
1706 "support (L<guestmount(1)>)."
1710 #: ../src/guestfs.pod:830
1711 msgid "KEYS AND PASSPHRASES"
1715 #: ../src/guestfs.pod:832
1717 "Certain libguestfs calls take a parameter that contains sensitive key "
1718 "material, passed in as a C string."
1722 #: ../src/guestfs.pod:835
1724 "In the future we would hope to change the libguestfs implementation so that "
1725 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1726 "swap. However this is I<not> done at the moment, because of the complexity "
1727 "of such an implementation."
1731 #: ../src/guestfs.pod:840
1733 "Therefore you should be aware that any key parameter you pass to libguestfs "
1734 "might end up being written out to the swap partition. If this is a concern, "
1735 "scrub the swap partition or don't use libguestfs on encrypted devices."
1739 #: ../src/guestfs.pod:845
1740 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1744 #: ../src/guestfs.pod:847
1746 "All high-level libguestfs actions are synchronous. If you want to use "
1747 "libguestfs asynchronously then you must create a thread."
1751 #: ../src/guestfs.pod:850
1753 "Only use the handle from a single thread. Either use the handle exclusively "
1754 "from one thread, or provide your own mutex so that two threads cannot issue "
1755 "calls on the same handle at the same time."
1759 #: ../src/guestfs.pod:854
1761 "See the graphical program guestfs-browser for one possible architecture for "
1762 "multithreaded programs using libvirt and libguestfs."
1766 #: ../src/guestfs.pod:857
1771 #: ../src/guestfs.pod:859
1773 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1778 #: ../src/guestfs.pod:862
1780 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1781 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1785 #: ../src/guestfs.pod:865
1787 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1788 "to change the directories that libguestfs will search in. The value is a "
1789 "colon-separated list of paths. The current directory is I<not> searched "
1790 "unless the path contains an empty element or C<.>. For example "
1791 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1792 "then C</usr/lib/guestfs>."
1796 #: ../src/guestfs.pod:872
1797 msgid "QEMU WRAPPERS"
1801 #: ../src/guestfs.pod:874
1803 "If you want to compile your own qemu, run qemu from a non-standard location, "
1804 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1809 #: ../src/guestfs.pod:878
1811 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1812 "last command in the shell script (so that qemu replaces the shell and "
1813 "becomes the direct child of the libguestfs-using program). If you don't do "
1814 "this, then the qemu process won't be cleaned up correctly."
1818 #: ../src/guestfs.pod:883
1820 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1825 #: ../src/guestfs.pod:886
1829 " qemudir=/home/rjones/d/qemu\n"
1830 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1835 #: ../src/guestfs.pod:890
1837 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1838 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1843 #: ../src/guestfs.pod:894
1846 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1851 #: ../src/guestfs.pod:896
1853 "Note that libguestfs also calls qemu with the -help and -version options in "
1854 "order to determine features."
1858 #: ../src/guestfs.pod:899
1859 msgid "ABI GUARANTEE"
1863 #: ../src/guestfs.pod:901
1865 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1866 "actions as outlined in this section. Although we will deprecate some "
1867 "actions, for example if they get replaced by newer calls, we will keep the "
1868 "old actions forever. This allows you the developer to program in confidence "
1869 "against the libguestfs API."
1873 #: ../src/guestfs.pod:907
1874 msgid "BLOCK DEVICE NAMING"
1878 #: ../src/guestfs.pod:909
1880 "In the kernel there is now quite a profusion of schemata for naming block "
1881 "devices (in this context, by I<block device> I mean a physical or virtual "
1882 "hard drive). The original Linux IDE driver used names starting with C</dev/"
1883 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
1884 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
1885 "for the old IDE driver (particularly for SATA devices) those devices also "
1886 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
1887 "paravirtualized drivers. This has created several different naming systems, "
1888 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
1892 #: ../src/guestfs.pod:921
1894 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1895 "Linux kernel to access block devices. We can run a variety of appliances "
1896 "based on a variety of Linux kernels."
1900 #: ../src/guestfs.pod:925
1902 "This causes a problem for libguestfs because many API calls use device or "
1903 "partition names. Working scripts and the recipe (example) scripts that we "
1904 "make available over the internet could fail if the naming scheme changes."
1908 #: ../src/guestfs.pod:930
1910 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1911 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1912 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1913 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1917 #: ../src/guestfs.pod:936
1919 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1920 "L</guestfs_list_partitions> and similar calls return the true names of the "
1921 "devices and partitions as known to the appliance."
1925 #: ../src/guestfs.pod:941
1926 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1930 #: ../src/guestfs.pod:943
1932 "Usually this translation is transparent. However in some (very rare) cases "
1933 "you may need to know the exact algorithm. Such cases include where you use "
1934 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
1935 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
1939 #: ../src/guestfs.pod:949
1941 "The algorithm is applied only to I<parameters> which are known to be either "
1942 "device or partition names. Return values from functions such as L</"
1943 "guestfs_list_devices> are never changed."
1947 #: ../src/guestfs.pod:957
1948 msgid "Is the string a parameter which is a device or partition name?"
1952 #: ../src/guestfs.pod:961
1953 msgid "Does the string begin with C</dev/sd>?"
1957 #: ../src/guestfs.pod:965
1959 "Does the named device exist? If so, we use that device. However if I<not> "
1960 "then we continue with this algorithm."
1964 #: ../src/guestfs.pod:970
1965 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1969 #: ../src/guestfs.pod:972
1970 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1974 #: ../src/guestfs.pod:974
1975 msgid "If that named device exists, use it. If not, continue."
1979 #: ../src/guestfs.pod:978
1980 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1984 #: ../src/guestfs.pod:980
1985 msgid "If that named device exists, use it. If not, return an error."
1989 #: ../src/guestfs.pod:984
1990 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1994 #: ../src/guestfs.pod:986
1996 "Although the standard naming scheme and automatic translation is useful for "
1997 "simple programs and guestfish scripts, for larger programs it is best not to "
1998 "rely on this mechanism."
2002 #: ../src/guestfs.pod:990
2004 "Where possible for maximum future portability programs using libguestfs "
2005 "should use these future-proof techniques:"
2009 #: ../src/guestfs.pod:997
2011 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2012 "device names, and then use those names directly."
2016 #: ../src/guestfs.pod:1000
2018 "Since those device names exist by definition, they will never be translated."
2022 #: ../src/guestfs.pod:1005
2024 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2025 "filesystem labels."
2029 #: ../src/guestfs.pod:1010
2034 #: ../src/guestfs.pod:1012
2036 "This section discusses security implications of using libguestfs, "
2037 "particularly with untrusted or malicious guests or disk images."
2041 #: ../src/guestfs.pod:1015
2042 msgid "GENERAL SECURITY CONSIDERATIONS"
2046 #: ../src/guestfs.pod:1017
2048 "Be careful with any files or data that you download from a guest (by "
2049 "\"download\" we mean not just the L</guestfs_download> command but any "
2050 "command that reads files, filenames, directories or anything else from a "
2051 "disk image). An attacker could manipulate the data to fool your program "
2052 "into doing the wrong thing. Consider cases such as:"
2056 #: ../src/guestfs.pod:1027
2057 msgid "the data (file etc) not being present"
2061 #: ../src/guestfs.pod:1031
2062 msgid "being present but empty"
2066 #: ../src/guestfs.pod:1035
2067 msgid "being much larger than normal"
2071 #: ../src/guestfs.pod:1039
2072 msgid "containing arbitrary 8 bit data"
2076 #: ../src/guestfs.pod:1043
2077 msgid "being in an unexpected character encoding"
2081 #: ../src/guestfs.pod:1047
2082 msgid "containing homoglyphs."
2086 #: ../src/guestfs.pod:1051
2087 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2091 #: ../src/guestfs.pod:1053
2093 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2094 "(VFS) module can sometimes be escalated into exploits by deliberately "
2095 "creating a malicious, malformed filesystem. These exploits are very severe "
2096 "for two reasons. Firstly there are very many filesystem drivers in the "
2097 "kernel, and many of them are infrequently used and not much developer "
2098 "attention has been paid to the code. Linux userspace helps potential "
2099 "crackers by detecting the filesystem type and automatically choosing the "
2100 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2101 "the administrator. Secondly, a kernel-level exploit is like a local root "
2102 "exploit (worse in some ways), giving immediate and total access to the "
2103 "system right down to the hardware level."
2107 #: ../src/guestfs.pod:1066
2109 "That explains why you should never mount a filesystem from an untrusted "
2110 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2111 "inside a qemu virtual machine, usually running as a non-root user. The "
2112 "attacker would need to write a filesystem which first exploited the kernel, "
2113 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2114 "the libguestfs protocol, and finally to be as serious as the host kernel "
2115 "exploit it would need to escalate its privileges to root. This multi-step "
2116 "escalation, performed by a static piece of data, is thought to be extremely "
2117 "hard to do, although we never say 'never' about security issues."
2121 #: ../src/guestfs.pod:1077
2123 "In any case callers can reduce the attack surface by forcing the filesystem "
2124 "type when mounting (use L</guestfs_mount_vfs>)."
2128 #: ../src/guestfs.pod:1080
2129 msgid "PROTOCOL SECURITY"
2133 #: ../src/guestfs.pod:1082
2135 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2136 "defined upper message size. However a program that uses libguestfs must "
2137 "also take care - for example you can write a program that downloads a binary "
2138 "from a disk image and executes it locally, and no amount of protocol "
2139 "security will save you from the consequences."
2143 #: ../src/guestfs.pod:1088
2144 msgid "INSPECTION SECURITY"
2148 #: ../src/guestfs.pod:1090
2150 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2151 "directly from the guest, and these could contain any 8 bit data. Callers "
2152 "should be careful to escape these before printing them to a structured file "
2153 "(for example, use HTML escaping if creating a web page)."
2157 #: ../src/guestfs.pod:1096
2159 "Guest configuration may be altered in unusual ways by the administrator of "
2160 "the virtual machine, and may not reflect reality (particularly for untrusted "
2161 "or actively malicious guests). For example we parse the hostname from "
2162 "configuration files like C</etc/sysconfig/network> that we find in the "
2163 "guest, but the guest administrator can easily manipulate these files to "
2164 "provide the wrong hostname."
2168 #: ../src/guestfs.pod:1104
2170 "The inspection API parses guest configuration using two external libraries: "
2171 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2172 "designed to be robust in the face of malicious data, although denial of "
2173 "service attacks are still possible, for example with oversized configuration "
2178 #: ../src/guestfs.pod:1110
2179 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2183 #: ../src/guestfs.pod:1112
2185 "Be very cautious about running commands from the guest. By running a "
2186 "command in the guest, you are giving CPU time to a binary that you do not "
2187 "control, under the same user account as the library, albeit wrapped in qemu "
2188 "virtualization. More information and alternatives can be found in the "
2189 "section L</RUNNING COMMANDS>."
2193 #: ../src/guestfs.pod:1118
2194 msgid "CVE-2010-3851"
2198 #: ../src/guestfs.pod:1120
2199 msgid "https://bugzilla.redhat.com/642934"
2203 #: ../src/guestfs.pod:1122
2205 "This security bug concerns the automatic disk format detection that qemu "
2206 "does on disk images."
2210 #: ../src/guestfs.pod:1125
2212 "A raw disk image is just the raw bytes, there is no header. Other disk "
2213 "images like qcow2 contain a special header. Qemu deals with this by looking "
2214 "for one of the known headers, and if none is found then assuming the disk "
2215 "image must be raw."
2219 #: ../src/guestfs.pod:1130
2221 "This allows a guest which has been given a raw disk image to write some "
2222 "other header. At next boot (or when the disk image is accessed by "
2223 "libguestfs) qemu would do autodetection and think the disk image format was, "
2224 "say, qcow2 based on the header written by the guest."
2228 #: ../src/guestfs.pod:1135
2230 "This in itself would not be a problem, but qcow2 offers many features, one "
2231 "of which is to allow a disk image to refer to another image (called the "
2232 "\"backing disk\"). It does this by placing the path to the backing disk "
2233 "into the qcow2 header. This path is not validated and could point to any "
2234 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2235 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2236 "control of the attacker."
2240 #: ../src/guestfs.pod:1143
2242 "In libguestfs this is rather hard to exploit except under two circumstances:"
2246 #: ../src/guestfs.pod:1150
2247 msgid "You have enabled the network or have opened the disk in write mode."
2251 #: ../src/guestfs.pod:1154
2253 "You are also running untrusted code from the guest (see L</RUNNING "
2258 #: ../src/guestfs.pod:1159
2260 "The way to avoid this is to specify the expected disk format when adding "
2261 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2262 "should always do this if the disk is raw format, and it's a good idea for "
2267 #: ../src/guestfs.pod:1164
2269 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2270 "format is fetched from libvirt and passed through."
2274 #: ../src/guestfs.pod:1167
2276 "For libguestfs tools, use the I<--format> command line parameter as "
2281 #: ../src/guestfs.pod:1170
2282 msgid "CONNECTION MANAGEMENT"
2286 #: ../src/guestfs.pod:1172
2291 #: ../src/guestfs.pod:1174
2293 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2294 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2295 "handle and release all resources used."
2299 #: ../src/guestfs.pod:1178
2301 "For information on using multiple handles and threads, see the section L</"
2302 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2306 #: ../src/guestfs.pod:1181
2307 msgid "guestfs_create"
2311 #: ../src/guestfs.pod:1183
2314 " guestfs_h *guestfs_create (void);\n"
2319 #: ../src/guestfs.pod:1185
2320 msgid "Create a connection handle."
2324 #: ../src/guestfs.pod:1187
2326 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2327 "on the handle at least once."
2331 #: ../src/guestfs.pod:1190
2333 "This function returns a non-NULL pointer to a handle on success or NULL on "
2338 #: ../src/guestfs.pod:1193
2339 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2343 #: ../src/guestfs.pod:1195
2345 "You may also want to configure error handling for the handle. See L</ERROR "
2346 "HANDLING> section below."
2350 #: ../src/guestfs.pod:1198
2351 msgid "guestfs_close"
2355 #: ../src/guestfs.pod:1200
2358 " void guestfs_close (guestfs_h *g);\n"
2363 #: ../src/guestfs.pod:1202
2364 msgid "This closes the connection handle and frees up all resources used."
2368 #: ../src/guestfs.pod:1204
2369 msgid "ERROR HANDLING"
2373 #: ../src/guestfs.pod:1206
2375 "API functions can return errors. For example, almost all functions that "
2376 "return C<int> will return C<-1> to indicate an error."
2380 #: ../src/guestfs.pod:1209
2382 "Additional information is available for errors: an error message string and "
2383 "optionally an error number (errno) if the thing that failed was a system "
2388 #: ../src/guestfs.pod:1213
2390 "You can get at the additional information about the last error on the handle "
2391 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2392 "up an error handler with L</guestfs_set_error_handler>."
2396 #: ../src/guestfs.pod:1218
2398 "When the handle is created, a default error handler is installed which "
2399 "prints the error message string to C<stderr>. For small short-running "
2400 "command line programs it is sufficient to do:"
2404 #: ../src/guestfs.pod:1222
2407 " if (guestfs_launch (g) == -1)\n"
2408 " exit (EXIT_FAILURE);\n"
2413 #: ../src/guestfs.pod:1225
2415 "since the default error handler will ensure that an error message has been "
2416 "printed to C<stderr> before the program exits."
2420 #: ../src/guestfs.pod:1228
2422 "For other programs the caller will almost certainly want to install an "
2423 "alternate error handler or do error handling in-line like this:"
2427 #: ../src/guestfs.pod:1231
2430 " g = guestfs_create ();\n"
2435 #: ../src/guestfs.pod:1233
2438 " /* This disables the default behaviour of printing errors\n"
2440 " guestfs_set_error_handler (g, NULL, NULL);\n"
2445 #: ../src/guestfs.pod:1237
2448 " if (guestfs_launch (g) == -1) {\n"
2449 " /* Examine the error message and print it etc. */\n"
2450 " char *msg = guestfs_last_error (g);\n"
2451 " int errnum = guestfs_last_errno (g);\n"
2452 " fprintf (stderr, \"%s\\n\", msg);\n"
2459 #: ../src/guestfs.pod:1245
2461 "Out of memory errors are handled differently. The default action is to call "
2462 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2463 "guestfs_set_out_of_memory_handler>."
2467 #: ../src/guestfs.pod:1249
2469 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2470 "because there is no handle if this happens there is no way to get additional "
2471 "error information. However L</guestfs_create> is supposed to be a "
2472 "lightweight operation which can only fail because of insufficient memory (it "
2473 "returns NULL in this case)."
2477 #: ../src/guestfs.pod:1255
2478 msgid "guestfs_last_error"
2482 #: ../src/guestfs.pod:1257
2485 " const char *guestfs_last_error (guestfs_h *g);\n"
2490 #: ../src/guestfs.pod:1259
2492 "This returns the last error message that happened on C<g>. If there has not "
2493 "been an error since the handle was created, then this returns C<NULL>."
2497 #: ../src/guestfs.pod:1263
2499 "The lifetime of the returned string is until the next error occurs, or L</"
2500 "guestfs_close> is called."
2504 #: ../src/guestfs.pod:1266
2505 msgid "guestfs_last_errno"
2509 #: ../src/guestfs.pod:1268
2512 " int guestfs_last_errno (guestfs_h *g);\n"
2517 #: ../src/guestfs.pod:1270
2518 msgid "This returns the last error number (errno) that happened on C<g>."
2522 #: ../src/guestfs.pod:1272
2523 msgid "If successful, an errno integer not equal to zero is returned."
2527 #: ../src/guestfs.pod:1274
2529 "If no error, this returns 0. This call can return 0 in three situations:"
2533 #: ../src/guestfs.pod:1281
2534 msgid "There has not been any error on the handle."
2538 #: ../src/guestfs.pod:1285
2540 "There has been an error but the errno was meaningless. This corresponds to "
2541 "the case where the error did not come from a failed system call, but for "
2542 "some other reason."
2546 #: ../src/guestfs.pod:1291
2548 "There was an error from a failed system call, but for some reason the errno "
2549 "was not captured and returned. This usually indicates a bug in libguestfs."
2553 #: ../src/guestfs.pod:1297
2555 "Libguestfs tries to convert the errno from inside the applicance into a "
2556 "corresponding errno for the caller (not entirely trivial: the appliance "
2557 "might be running a completely different operating system from the library "
2558 "and error numbers are not standardized across Un*xen). If this could not be "
2559 "done, then the error is translated to C<EINVAL>. In practice this should "
2560 "only happen in very rare circumstances."
2564 #: ../src/guestfs.pod:1305
2565 msgid "guestfs_set_error_handler"
2569 #: ../src/guestfs.pod:1307
2572 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2574 " const char *msg);\n"
2575 " void guestfs_set_error_handler (guestfs_h *g,\n"
2576 " guestfs_error_handler_cb cb,\n"
2582 #: ../src/guestfs.pod:1314
2584 "The callback C<cb> will be called if there is an error. The parameters "
2585 "passed to the callback are an opaque data pointer and the error message "
2590 #: ../src/guestfs.pod:1318
2592 "C<errno> is not passed to the callback. To get that the callback must call "
2593 "L</guestfs_last_errno>."
2597 #: ../src/guestfs.pod:1321
2599 "Note that the message string C<msg> is freed as soon as the callback "
2600 "function returns, so if you want to stash it somewhere you must make your "
2605 #: ../src/guestfs.pod:1325
2606 msgid "The default handler prints messages on C<stderr>."
2610 #: ../src/guestfs.pod:1327
2611 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2615 #: ../src/guestfs.pod:1329
2616 msgid "guestfs_get_error_handler"
2620 #: ../src/guestfs.pod:1331
2623 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2624 " void **opaque_rtn);\n"
2629 #: ../src/guestfs.pod:1334
2630 msgid "Returns the current error handler callback."
2634 #: ../src/guestfs.pod:1336
2635 msgid "guestfs_set_out_of_memory_handler"
2639 #: ../src/guestfs.pod:1338
2642 " typedef void (*guestfs_abort_cb) (void);\n"
2643 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2644 " guestfs_abort_cb);\n"
2649 #: ../src/guestfs.pod:1342
2651 "The callback C<cb> will be called if there is an out of memory situation. "
2652 "I<Note this callback must not return>."
2656 #: ../src/guestfs.pod:1345
2657 msgid "The default is to call L<abort(3)>."
2661 #: ../src/guestfs.pod:1347
2663 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2667 #: ../src/guestfs.pod:1350
2668 msgid "guestfs_get_out_of_memory_handler"
2672 #: ../src/guestfs.pod:1352
2675 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2680 #: ../src/guestfs.pod:1354
2681 msgid "This returns the current out of memory handler."
2685 #: ../src/guestfs.pod:1356
2690 #: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908
2695 #: ../src/guestfs.pod:1360
2700 #: ../src/guestfs.pod:1362
2705 #: ../src/guestfs.pod:1364
2706 msgid "AVAILABILITY"
2710 #: ../src/guestfs.pod:1366
2711 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2715 #: ../src/guestfs.pod:1368
2717 "Using L</guestfs_available> you can test availability of the following "
2718 "groups of functions. This test queries the appliance to see if the "
2719 "appliance you are currently using supports the functionality."
2723 #: ../src/guestfs.pod:1373
2724 msgid "@AVAILABILITY@"
2728 #: ../src/guestfs.pod:1375
2729 msgid "GUESTFISH supported COMMAND"
2733 #: ../src/guestfs.pod:1377
2735 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2736 "prints out the available groups and whether they are supported by this build "
2737 "of libguestfs. Note however that you have to do C<run> first."
2741 #: ../src/guestfs.pod:1382
2742 msgid "SINGLE CALLS AT COMPILE TIME"
2746 #: ../src/guestfs.pod:1384
2748 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2749 "function, such as:"
2753 #: ../src/guestfs.pod:1387
2756 " #define LIBGUESTFS_HAVE_DD 1\n"
2761 #: ../src/guestfs.pod:1389
2762 msgid "if L</guestfs_dd> is available."
2766 #: ../src/guestfs.pod:1391
2768 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2769 "function is available at compile time, we recommended using build tools such "
2770 "as autoconf or cmake. For example in autotools you could use:"
2774 #: ../src/guestfs.pod:1396
2777 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2778 " AC_CHECK_FUNCS([guestfs_dd])\n"
2783 #: ../src/guestfs.pod:1399
2785 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2790 #: ../src/guestfs.pod:1402
2791 msgid "SINGLE CALLS AT RUN TIME"
2795 #: ../src/guestfs.pod:1404
2797 "Testing at compile time doesn't guarantee that a function really exists in "
2798 "the library. The reason is that you might be dynamically linked against a "
2799 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2800 "This situation unfortunately results in a segmentation fault, which is a "
2801 "shortcoming of the C dynamic linking system itself."
2805 #: ../src/guestfs.pod:1411
2807 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2808 "in this example program (note that you still need the compile time check as "
2813 #: ../src/guestfs.pod:1415
2816 " #include <stdio.h>\n"
2817 " #include <stdlib.h>\n"
2818 " #include <unistd.h>\n"
2819 " #include <dlfcn.h>\n"
2820 " #include <guestfs.h>\n"
2825 #: ../src/guestfs.pod:1421
2830 " #ifdef LIBGUESTFS_HAVE_DD\n"
2832 " int has_function;\n"
2837 #: ../src/guestfs.pod:1427
2840 " /* Test if the function guestfs_dd is really available. */\n"
2841 " dl = dlopen (NULL, RTLD_LAZY);\n"
2843 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2844 " exit (EXIT_FAILURE);\n"
2846 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2852 #: ../src/guestfs.pod:1436
2855 " if (!has_function)\n"
2856 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2858 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2859 " /* Now it's safe to call\n"
2860 " guestfs_dd (g, \"foo\", \"bar\");\n"
2864 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2871 #: ../src/guestfs.pod:1449
2873 "You may think the above is an awful lot of hassle, and it is. There are "
2874 "other ways outside of the C linking system to ensure that this kind of "
2875 "incompatibility never arises, such as using package versioning:"
2879 #: ../src/guestfs.pod:1454
2882 " Requires: libguestfs >= 1.0.80\n"
2887 #: ../src/guestfs.pod:1456
2888 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2892 #: ../src/guestfs.pod:1458
2894 "A recent feature of the API is the introduction of calls which take optional "
2895 "arguments. In C these are declared 3 ways. The main way is as a call which "
2896 "takes variable arguments (ie. C<...>), as in this example:"
2900 #: ../src/guestfs.pod:1463
2903 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2908 #: ../src/guestfs.pod:1465
2910 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2911 "call with no optional arguments specified:"
2915 #: ../src/guestfs.pod:1468
2918 " guestfs_add_drive_opts (g, filename, -1);\n"
2923 #: ../src/guestfs.pod:1470
2924 msgid "With a single optional argument:"
2928 #: ../src/guestfs.pod:1472
2931 " guestfs_add_drive_opts (g, filename,\n"
2932 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2938 #: ../src/guestfs.pod:1476
2943 #: ../src/guestfs.pod:1478
2946 " guestfs_add_drive_opts (g, filename,\n"
2947 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2948 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2954 #: ../src/guestfs.pod:1483
2956 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2961 #: ../src/guestfs.pod:1486
2962 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2966 #: ../src/guestfs.pod:1488
2968 "The second variant has the same name with the suffix C<_va>, which works the "
2969 "same way but takes a C<va_list>. See the C manual for details. For the "
2970 "example function, this is declared:"
2974 #: ../src/guestfs.pod:1492
2977 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2983 #: ../src/guestfs.pod:1495
2984 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2988 #: ../src/guestfs.pod:1497
2990 "The third variant is useful where you need to construct these calls. You "
2991 "pass in a structure where you fill in the optional fields. The structure "
2992 "has a bitmask as the first element which you must set to indicate which "
2993 "fields you have filled in. For our example function the structure and call "
2998 #: ../src/guestfs.pod:1503
3001 " struct guestfs_add_drive_opts_argv {\n"
3002 " uint64_t bitmask;\n"
3004 " const char *format;\n"
3007 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3008 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3013 #: ../src/guestfs.pod:1512
3014 msgid "You could call it like this:"
3018 #: ../src/guestfs.pod:1514
3021 " struct guestfs_add_drive_opts_argv optargs = {\n"
3022 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3023 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3025 " .format = \"qcow2\"\n"
3031 #: ../src/guestfs.pod:1521
3034 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3039 #: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11
3040 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
3041 #: ../fish/guestfish-actions.pod:1255
3046 #: ../src/guestfs.pod:1529
3047 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3051 #: ../src/guestfs.pod:1534
3052 msgid "You do not need to fill in all fields of the structure."
3056 #: ../src/guestfs.pod:1538
3058 "There must be a one-to-one correspondence between fields of the structure "
3059 "that are filled in, and bits set in the bitmask."
3063 #: ../src/guestfs.pod:1543
3064 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3068 #: ../src/guestfs.pod:1545
3070 "In other languages, optional arguments are expressed in the way that is "
3071 "natural for that language. We refer you to the language-specific "
3072 "documentation for more details on that."
3076 #: ../src/guestfs.pod:1549
3077 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3081 #: ../src/guestfs.pod:1551
3082 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3086 #: ../src/guestfs.pod:1553
3088 "The child process generates events in some situations. Current events "
3089 "include: receiving a log message, the child process exits."
3093 #: ../src/guestfs.pod:1556
3095 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3100 #: ../src/guestfs.pod:1559
3102 "Only I<one callback of each type> can be registered for each handle. "
3103 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3104 "that type. Cancel all callbacks of this type by calling this function with "
3105 "C<cb> set to C<NULL>."
3109 #: ../src/guestfs.pod:1564
3110 msgid "guestfs_set_log_message_callback"
3114 #: ../src/guestfs.pod:1566
3117 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3118 " char *buf, int len);\n"
3119 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3120 " guestfs_log_message_cb cb,\n"
3126 #: ../src/guestfs.pod:1572
3128 "The callback function C<cb> will be called whenever qemu or the guest writes "
3129 "anything to the console."
3133 #: ../src/guestfs.pod:1575
3134 msgid "Use this function to capture kernel messages and similar."
3138 #: ../src/guestfs.pod:1577
3140 "Normally there is no log message handler, and log messages are just "
3145 #: ../src/guestfs.pod:1580
3146 msgid "guestfs_set_subprocess_quit_callback"
3150 #: ../src/guestfs.pod:1582
3153 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3154 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3155 " guestfs_subprocess_quit_cb cb,\n"
3161 #: ../src/guestfs.pod:1587
3163 "The callback function C<cb> will be called when the child process quits, "
3164 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3165 "corresponds to a transition from any state to the CONFIG state)."
3169 #: ../src/guestfs.pod:1592
3170 msgid "guestfs_set_launch_done_callback"
3174 #: ../src/guestfs.pod:1594
3177 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3178 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3179 " guestfs_launch_done_cb cb,\n"
3185 #: ../src/guestfs.pod:1599
3187 "The callback function C<cb> will be called when the child process becomes "
3188 "ready first time after it has been launched. (This corresponds to a "
3189 "transition from LAUNCHING to the READY state)."
3193 #: ../src/guestfs.pod:1603
3194 msgid "guestfs_set_close_callback"
3198 #: ../src/guestfs.pod:1605
3201 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3202 " void guestfs_set_close_callback (guestfs_h *g,\n"
3203 " guestfs_close_cb cb,\n"
3209 #: ../src/guestfs.pod:1610
3211 "The callback function C<cb> will be called while the handle is being closed "
3212 "(synchronously from L</guestfs_close>)."
3216 #: ../src/guestfs.pod:1613
3218 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3219 "handles that are open when the program exits. This means that this callback "
3220 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3221 "problems in higher-level languages (eg. if your HLL interpreter has already "
3222 "been cleaned up by the time this is called, and if your callback then jumps "
3223 "into some HLL function)."
3227 #: ../src/guestfs.pod:1621
3228 msgid "guestfs_set_progress_callback"
3232 #: ../src/guestfs.pod:1623
3235 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3236 " int proc_nr, int serial,\n"
3237 " uint64_t position, uint64_t total);\n"
3238 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3239 " guestfs_progress_cb cb,\n"
3245 #: ../src/guestfs.pod:1630
3247 "Some long-running operations can generate progress messages. If this "
3248 "callback is registered, then it will be called each time a progress message "
3249 "is generated (usually two seconds after the operation started, and three "
3250 "times per second thereafter until it completes, although the frequency may "
3251 "change in future versions)."
3255 #: ../src/guestfs.pod:1636
3257 "The callback receives two numbers: C<position> and C<total>. The units of "
3258 "C<total> are not defined, although for some operations C<total> may relate "
3259 "in some way to the amount of data to be transferred (eg. in bytes or "
3260 "megabytes), and C<position> may be the portion which has been transferred."
3264 #: ../src/guestfs.pod:1642
3265 msgid "The only defined and stable parts of the API are:"
3269 #: ../src/guestfs.pod:1648
3271 "The callback can display to the user some type of progress bar or indicator "
3272 "which shows the ratio of C<position>:C<total>."
3276 #: ../src/guestfs.pod:1653
3277 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3281 #: ../src/guestfs.pod:1657
3283 "If any progress notification is sent during a call, then a final progress "
3284 "notification is always sent when C<position> = C<total>."
3288 #: ../src/guestfs.pod:1660
3290 "This is to simplify caller code, so callers can easily set the progress "
3291 "indicator to \"100%\" at the end of the operation, without requiring special "
3292 "code to detect this case."
3296 #: ../src/guestfs.pod:1666
3298 "The callback also receives the procedure number and serial number of the "
3299 "call. These are only useful for debugging protocol issues, and the callback "
3300 "can normally ignore them. The callback may want to print these numbers in "
3301 "error messages or debugging messages."
3305 #: ../src/guestfs.pod:1671
3306 msgid "PRIVATE DATA AREA"
3310 #: ../src/guestfs.pod:1673
3312 "You can attach named pieces of private data to the libguestfs handle, and "
3313 "fetch them by name for the lifetime of the handle. This is called the "
3314 "private data area and is only available from the C API."
3318 #: ../src/guestfs.pod:1677
3319 msgid "To attach a named piece of data, use the following call:"
3323 #: ../src/guestfs.pod:1679
3326 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3331 #: ../src/guestfs.pod:1681
3333 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3334 "pointer (which can be C<NULL>). Any previous item with the same name is "
3339 #: ../src/guestfs.pod:1685
3341 "You can use any C<key> you want, but names beginning with an underscore "
3342 "character are reserved for internal libguestfs purposes (for implementing "
3343 "language bindings). It is recommended to prefix the name with some unique "
3344 "string to avoid collisions with other users."
3348 #: ../src/guestfs.pod:1690
3349 msgid "To retrieve the pointer, use:"
3353 #: ../src/guestfs.pod:1692
3356 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3361 #: ../src/guestfs.pod:1694
3363 "This function returns C<NULL> if either no data is found associated with "
3364 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3369 #: ../src/guestfs.pod:1698
3371 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3372 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3373 "all. In particular, libguestfs does I<not> try to free the data when the "
3374 "handle is closed. If the data must be freed, then the caller must either "
3375 "free it before calling L</guestfs_close> or must set up a close callback to "
3376 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3377 "can be registered for a handle)."
3381 #: ../src/guestfs.pod:1706
3383 "The private data area is implemented using a hash table, and should be "
3384 "reasonably efficient for moderate numbers of keys."
3388 #: ../src/guestfs.pod:1709 ../src/guestfs.pod:1714
3393 #: ../src/guestfs.pod:1711
3395 "<!-- old anchor for the next section --> <a name="
3396 "\"state_machine_and_low_level_event_api\"/>"
3400 #: ../src/guestfs.pod:1716
3401 msgid "ARCHITECTURE"
3405 #: ../src/guestfs.pod:1718
3407 "Internally, libguestfs is implemented by running an appliance (a special "
3408 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3409 "process of the main program."
3413 #: ../src/guestfs.pod:1722
3416 " ___________________\n"
3418 " | main program |\n"
3420 " | | child process / appliance\n"
3421 " | | __________________________\n"
3423 " +-------------------+ RPC | +-----------------+ |\n"
3424 " | libguestfs <--------------------> guestfsd | |\n"
3425 " | | | +-----------------+ |\n"
3426 " \\___________________/ | | Linux kernel | |\n"
3427 " | +--^--------------+ |\n"
3428 " \\_________|________________/\n"
3434 " \\______________/\n"
3439 #: ../src/guestfs.pod:1742
3441 "The library, linked to the main program, creates the child process and hence "
3442 "the appliance in the L</guestfs_launch> function."
3446 #: ../src/guestfs.pod:1745
3448 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3449 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3450 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3451 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3452 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3453 "attached to the qemu process which translates device access by the "
3454 "appliance's Linux kernel into accesses to the image."
3458 #: ../src/guestfs.pod:1754
3460 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3461 "Although the disk image you are attached to might also be used by some "
3462 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3463 "care if both libguestfs's qemu process and your virtual machine are trying "
3464 "to update the disk image at the same time, since these usually results in "
3465 "massive disk corruption)."
3469 #: ../src/guestfs.pod:1761
3470 msgid "STATE MACHINE"
3474 #: ../src/guestfs.pod:1763
3475 msgid "libguestfs uses a state machine to model the child process:"
3479 #: ../src/guestfs.pod:1765
3491 " / | \\ \\ guestfs_launch\n"
3492 " / | _\\__V______\n"
3494 " / | | LAUNCHING |\n"
3495 " / | \\___________/\n"
3497 " / | guestfs_launch\n"
3499 " ______ / __|____V\n"
3500 " / \\ ------> / \\\n"
3501 " | BUSY | | READY |\n"
3502 " \\______/ <------ \\________/\n"
3507 #: ../src/guestfs.pod:1787
3509 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3510 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3511 "(3) alternating between READY and BUSY as commands are issued to, and "
3512 "carried out by, the child process."
3516 #: ../src/guestfs.pod:1792
3518 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3519 "asynchronously at any time (eg. due to some internal error), and that causes "
3520 "the state to transition back to CONFIG."
3524 #: ../src/guestfs.pod:1796
3526 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3527 "issued when in the CONFIG state."
3531 #: ../src/guestfs.pod:1799
3533 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3534 "L</guestfs_launch> blocks until the child process is READY to accept "
3535 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3536 "moves the state from CONFIG to LAUNCHING while it is running."
3540 #: ../src/guestfs.pod:1805
3542 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3543 "state. These API calls block waiting for the command to be carried out (ie. "
3544 "the state to transition to BUSY and then back to READY). There are no non-"
3545 "blocking versions, and no way to issue more than one command per handle at "
3550 #: ../src/guestfs.pod:1811
3552 "Finally, the child process sends asynchronous messages back to the main "
3553 "program, such as kernel log messages. You can register a callback to "
3554 "receive these messages."
3558 #: ../src/guestfs.pod:1815
3563 #: ../src/guestfs.pod:1817
3564 msgid "COMMUNICATION PROTOCOL"
3568 #: ../src/guestfs.pod:1819
3570 "Don't rely on using this protocol directly. This section documents how it "
3571 "currently works, but it may change at any time."
3575 #: ../src/guestfs.pod:1822
3577 "The protocol used to talk between the library and the daemon running inside "
3578 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3579 "1014, RFC 1832, RFC 4506)."
3583 #: ../src/guestfs.pod:1826
3585 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3586 "this file is automatically generated)."
3590 #: ../src/guestfs.pod:1829
3592 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3593 "and C<FileOut> parameters, which are handled with very simple request/reply "
3594 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3595 "parameters, which use the same request and reply messages, but they may also "
3596 "be followed by files sent using a chunked encoding."
3600 #: ../src/guestfs.pod:1836
3601 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3605 #: ../src/guestfs.pod:1838
3606 msgid "For ordinary functions, the request message is:"
3610 #: ../src/guestfs.pod:1840
3613 " total length (header + arguments,\n"
3614 " but not including the length word itself)\n"
3615 " struct guestfs_message_header (encoded as XDR)\n"
3616 " struct guestfs_<foo>_args (encoded as XDR)\n"
3621 #: ../src/guestfs.pod:1845
3623 "The total length field allows the daemon to allocate a fixed size buffer "
3624 "into which it slurps the rest of the message. As a result, the total length "
3625 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3626 "effective size of any request is limited to somewhere under this size."
3630 #: ../src/guestfs.pod:1851
3632 "Note also that many functions don't take any arguments, in which case the "
3633 "C<guestfs_I<foo>_args> is completely omitted."
3637 #: ../src/guestfs.pod:1854
3639 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3640 "receiver knows what type of args structure to expect, or none at all."
3644 #: ../src/guestfs.pod:1858
3645 msgid "The reply message for ordinary functions is:"
3649 #: ../src/guestfs.pod:1860
3652 " total length (header + ret,\n"
3653 " but not including the length word itself)\n"
3654 " struct guestfs_message_header (encoded as XDR)\n"
3655 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3660 #: ../src/guestfs.pod:1865
3662 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3663 "functions that return no formal return values."
3667 #: ../src/guestfs.pod:1868
3669 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3673 #: ../src/guestfs.pod:1871
3675 "In the case of an error, a flag is set in the header, and the reply message "
3676 "is slightly changed:"
3680 #: ../src/guestfs.pod:1874
3683 " total length (header + error,\n"
3684 " but not including the length word itself)\n"
3685 " struct guestfs_message_header (encoded as XDR)\n"
3686 " struct guestfs_message_error (encoded as XDR)\n"
3691 #: ../src/guestfs.pod:1879
3693 "The C<guestfs_message_error> structure contains the error message as a "
3698 #: ../src/guestfs.pod:1882
3699 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3703 #: ../src/guestfs.pod:1884
3705 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3706 "The normal request message is sent (see above). However this is followed by "
3707 "a sequence of file chunks."
3711 #: ../src/guestfs.pod:1888
3714 " total length (header + arguments,\n"
3715 " but not including the length word itself,\n"
3716 " and not including the chunks)\n"
3717 " struct guestfs_message_header (encoded as XDR)\n"
3718 " struct guestfs_<foo>_args (encoded as XDR)\n"
3719 " sequence of chunks for FileIn param #0\n"
3720 " sequence of chunks for FileIn param #1 etc.\n"
3725 #: ../src/guestfs.pod:1896
3726 msgid "The \"sequence of chunks\" is:"
3730 #: ../src/guestfs.pod:1898
3733 " length of chunk (not including length word itself)\n"
3734 " struct guestfs_chunk (encoded as XDR)\n"
3735 " length of chunk\n"
3736 " struct guestfs_chunk (encoded as XDR)\n"
3738 " length of chunk\n"
3739 " struct guestfs_chunk (with data.data_len == 0)\n"
3744 #: ../src/guestfs.pod:1906
3746 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3747 "is set in the final chunk to indicate either successful completion or early "
3752 #: ../src/guestfs.pod:1910
3754 "At time of writing there are no functions that have more than one FileIn "
3755 "parameter. However this is (theoretically) supported, by sending the "
3756 "sequence of chunks for each FileIn parameter one after another (from left to "
3761 #: ../src/guestfs.pod:1915
3763 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3764 "transfer. The library does this by sending a chunk with a special flag set "
3765 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3766 "RPC, does I<not> send any reply, and goes back to reading the next request."
3770 #: ../src/guestfs.pod:1921
3772 "The daemon may also cancel. It does this by writing a special word "
3773 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3774 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3775 "cancel chunk). The special word is chosen so that even if cancellation "
3776 "happens right at the end of the transfer (after the library has finished "
3777 "writing and has started listening for the reply), the \"spurious\" cancel "
3778 "flag will not be confused with the reply message."
3782 #: ../src/guestfs.pod:1930
3784 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3785 "limit), and also files where the size is not known in advance (eg. from "
3786 "pipes or sockets). However the chunks are rather small "
3787 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3788 "to keep much in memory."
3792 #: ../src/guestfs.pod:1936
3793 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3797 #: ../src/guestfs.pod:1938
3799 "The protocol for FileOut parameters is exactly the same as for FileIn "
3800 "parameters, but with the roles of daemon and library reversed."
3804 #: ../src/guestfs.pod:1941
3807 " total length (header + ret,\n"
3808 " but not including the length word itself,\n"
3809 " and not including the chunks)\n"
3810 " struct guestfs_message_header (encoded as XDR)\n"
3811 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3812 " sequence of chunks for FileOut param #0\n"
3813 " sequence of chunks for FileOut param #1 etc.\n"
3818 #: ../src/guestfs.pod:1949
3819 msgid "INITIAL MESSAGE"
3823 #: ../src/guestfs.pod:1951
3825 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3826 "which indicates that the guest and daemon is alive. This is what L</"
3827 "guestfs_launch> waits for."
3831 #: ../src/guestfs.pod:1955
3832 msgid "PROGRESS NOTIFICATION MESSAGES"
3836 #: ../src/guestfs.pod:1957
3838 "The daemon may send progress notification messages at any time. These are "
3839 "distinguished by the normal length word being replaced by "
3840 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3844 #: ../src/guestfs.pod:1961
3846 "The library turns them into progress callbacks (see "
3847 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3848 "discards them if not."
3852 #: ../src/guestfs.pod:1965
3854 "The daemon self-limits the frequency of progress messages it sends (see "
3855 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3860 #: ../src/guestfs.pod:1969
3861 msgid "LIBGUESTFS VERSION NUMBERS"
3865 #: ../src/guestfs.pod:1971
3867 "Since April 2010, libguestfs has started to make separate development and "
3868 "stable releases, along with corresponding branches in our git repository. "
3869 "These separate releases can be identified by version number:"
3873 #: ../src/guestfs.pod:1976
3876 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3877 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3883 " | `-------- sub-version\n"
3885 " `------ always '1' because we don't change the ABI\n"
3890 #: ../src/guestfs.pod:1987
3891 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3895 #: ../src/guestfs.pod:1989
3897 "As time passes we cherry pick fixes from the development branch and backport "
3898 "those into the stable branch, the effect being that the stable branch should "
3899 "get more stable and less buggy over time. So the stable releases are ideal "
3900 "for people who don't need new features but would just like the software to "
3905 #: ../src/guestfs.pod:1995
3906 msgid "Our criteria for backporting changes are:"
3910 #: ../src/guestfs.pod:2001
3912 "Documentation changes which don't affect any code are backported unless the "
3913 "documentation refers to a future feature which is not in stable."
3917 #: ../src/guestfs.pod:2007
3919 "Bug fixes which are not controversial, fix obvious problems, and have been "
3920 "well tested are backported."
3924 #: ../src/guestfs.pod:2012
3926 "Simple rearrangements of code which shouldn't affect how it works get "
3927 "backported. This is so that the code in the two branches doesn't get too "
3928 "far out of step, allowing us to backport future fixes more easily."
3932 #: ../src/guestfs.pod:2018
3934 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3935 "exceptional case: the new feature is required in order to implement an "
3936 "important bug fix."
3940 #: ../src/guestfs.pod:2024
3942 "A new stable branch starts when we think the new features in development are "
3943 "substantial and compelling enough over the current stable branch to warrant "
3944 "it. When that happens we create new stable and development versions 1.N.0 "
3945 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3946 "stable at this point, but by backporting fixes from development, that branch "
3947 "will stabilize over time."
3951 #: ../src/guestfs.pod:2032 ../fish/guestfish.pod:915
3952 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3953 #: ../tools/virt-rescue.pl:255
3954 msgid "ENVIRONMENT VARIABLES"
3958 #: ../src/guestfs.pod:2036 ../fish/guestfish.pod:941
3959 msgid "LIBGUESTFS_APPEND"
3963 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:943
3964 msgid "Pass additional options to the guest kernel."
3968 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:945
3969 msgid "LIBGUESTFS_DEBUG"
3973 #: ../src/guestfs.pod:2042
3975 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3976 "effect as calling C<guestfs_set_verbose (g, 1)>."
3980 #: ../src/guestfs.pod:2045 ../fish/guestfish.pod:950
3981 msgid "LIBGUESTFS_MEMSIZE"
3985 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:952
3987 "Set the memory allocated to the qemu process, in megabytes. For example:"
3991 #: ../src/guestfs.pod:2050 ../fish/guestfish.pod:955
3994 " LIBGUESTFS_MEMSIZE=700\n"
3999 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:957
4000 msgid "LIBGUESTFS_PATH"
4004 #: ../src/guestfs.pod:2054
4006 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4007 "the discussion of paths in section PATH above."
4011 #: ../src/guestfs.pod:2057 ../fish/guestfish.pod:962
4012 msgid "LIBGUESTFS_QEMU"
4016 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:964
4018 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4019 "which was found at compile time by the configure script is used."
4023 #: ../src/guestfs.pod:2063
4024 msgid "See also L</QEMU WRAPPERS> above."
4028 #: ../src/guestfs.pod:2065 ../fish/guestfish.pod:968
4029 msgid "LIBGUESTFS_TRACE"
4033 #: ../src/guestfs.pod:2067
4035 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4036 "effect as calling C<guestfs_set_trace (g, 1)>."
4040 #: ../src/guestfs.pod:2070 ../fish/guestfish.pod:977
4045 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:979
4046 msgid "Location of temporary directory, defaults to C</tmp>."
4050 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:981
4052 "If libguestfs was compiled to use the supermin appliance then the real "
4053 "appliance is cached in this directory, shared between all handles belonging "
4054 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4055 "use in case C</tmp> is not large enough."
4059 #: ../src/guestfs.pod:2082 ../fish/guestfish.pod:1039
4060 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
4061 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484
4062 #: ../tools/virt-resize.pl:1485 ../tools/virt-list-filesystems.pl:189
4063 #: ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267
4064 #: ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
4069 #: ../src/guestfs.pod:2084
4071 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
4072 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
4073 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
4074 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
4075 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4076 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4080 #: ../src/guestfs.pod:2107
4082 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
4083 "(8)>, L<disktype(1)>."
4087 #: ../src/guestfs.pod:2114 ../tools/virt-win-reg.pl:499
4088 #: ../tools/virt-make-fs.pl:548
4093 #: ../src/guestfs.pod:2116
4094 msgid "To get a list of bugs against libguestfs use this link:"
4098 #: ../src/guestfs.pod:2118
4100 "L<https://bugzilla.redhat.com/buglist.cgi?"
4101 "component=libguestfs&product=Virtualization+Tools>"
4105 #: ../src/guestfs.pod:2120
4106 msgid "To report a new bug against libguestfs use this link:"
4110 #: ../src/guestfs.pod:2122
4112 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
4113 "component=libguestfs&product=Virtualization+Tools>"
4117 #: ../src/guestfs.pod:2124
4118 msgid "When reporting a bug, please check:"
4122 #: ../src/guestfs.pod:2130
4123 msgid "That the bug hasn't been reported already."
4127 #: ../src/guestfs.pod:2134
4128 msgid "That you are testing a recent version."
4132 #: ../src/guestfs.pod:2138
4133 msgid "Describe the bug accurately, and give a way to reproduce it."
4137 #: ../src/guestfs.pod:2142
4139 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4144 #: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1058
4145 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4150 #: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1060
4151 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4152 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4156 #: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1062
4157 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
4158 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514
4159 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:206
4160 #: ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281
4161 #: ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
4166 #: ../src/guestfs.pod:2153 ../fish/guestfish.pod:1064
4167 #: ../fuse/guestmount.pod:250
4168 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4172 #: ../src/guestfs.pod:2156
4174 "This library is free software; you can redistribute it and/or modify it "
4175 "under the terms of the GNU Lesser General Public License as published by the "
4176 "Free Software Foundation; either version 2 of the License, or (at your "
4177 "option) any later version."
4181 #: ../src/guestfs.pod:2161
4183 "This library is distributed in the hope that it will be useful, but WITHOUT "
4184 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4185 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4190 #: ../src/guestfs.pod:2166
4192 "You should have received a copy of the GNU Lesser General Public License "
4193 "along with this library; if not, write to the Free Software Foundation, "
4194 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4198 #: ../src/guestfs-actions.pod:1
4199 msgid "guestfs_add_cdrom"
4203 #: ../src/guestfs-actions.pod:3
4207 " guestfs_add_cdrom (guestfs_h *g,\n"
4208 " const char *filename);\n"
4213 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4214 msgid "This function adds a virtual CD-ROM disk image to the guest."
4218 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4219 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4223 #: ../src/guestfs-actions.pod:17
4225 "This call checks for the existence of C<filename>. This stops you from "
4226 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4227 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4232 #: ../src/guestfs-actions.pod:24
4234 "If you just want to add an ISO file (often you use this as an efficient way "
4235 "to transfer large files into the guest), then you should probably use "
4236 "C<guestfs_add_drive_ro> instead."
4240 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
4241 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
4242 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
4243 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4244 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4245 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4246 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4247 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4248 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4249 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4250 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4251 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4252 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4253 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4254 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4255 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4256 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4257 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4258 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4259 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4260 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4261 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182
4262 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217
4263 #: ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356
4264 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383
4265 #: ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434
4266 #: ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526
4267 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566
4268 #: ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621
4269 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659
4270 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706
4271 #: ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758
4272 #: ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786
4273 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896
4274 #: ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929
4275 #: ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998
4276 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032
4277 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060
4278 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092
4279 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161
4280 #: ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211
4281 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242
4282 #: ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272
4283 #: ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302
4284 #: ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352
4285 #: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386
4286 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452
4287 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
4288 #: ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548
4289 #: ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700
4290 #: ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779
4291 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829
4292 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912
4293 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939
4294 #: ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247
4295 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273
4296 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299
4297 #: ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329
4298 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369
4299 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406
4300 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447
4301 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487
4302 #: ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523
4303 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575
4304 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618
4305 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648
4306 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704
4307 #: ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753
4308 #: ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982
4309 #: ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007
4310 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042
4311 #: ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068
4312 #: ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096
4313 #: ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172
4314 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204
4315 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234
4316 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290
4317 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345
4318 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376
4319 #: ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436
4320 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573
4321 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642
4322 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700
4323 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787
4324 #: ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879
4325 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4326 msgid "This function returns 0 on success or -1 on error."
4330 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4331 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4332 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4334 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4339 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4340 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4341 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4342 #: ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990
4343 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4344 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4345 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4346 #: ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4348 "Deprecated functions will not be removed from the API, but the fact that "
4349 "they are deprecated indicates that there are problems with correct use of "
4354 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4355 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4356 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4357 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199
4358 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408
4359 #: ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635
4360 #: ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223
4361 #: ../src/guestfs-actions.pod:6735
4362 msgid "(Added in 0.3)"
4366 #: ../src/guestfs-actions.pod:41
4367 msgid "guestfs_add_domain"
4371 #: ../src/guestfs-actions.pod:43
4375 " guestfs_add_domain (guestfs_h *g,\n"
4376 " const char *dom,\n"
4382 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4384 "You may supply a list of optional arguments to this call. Use zero or more "
4385 "of the following pairs of parameters, and terminate the list with C<-1> on "
4386 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4390 #: ../src/guestfs-actions.pod:53
4393 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4394 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4395 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4400 #: ../src/guestfs-actions.pod:57
4402 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4403 "It works by connecting to libvirt, requesting the domain and domain XML from "
4404 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4409 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4411 "The number of disks added is returned. This operation is atomic: if an "
4412 "error is returned, then no disks are added."
4416 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4418 "This function does some minimal checks to make sure the libvirt domain is "
4419 "not running (unless C<readonly> is true). In a future version we will try "
4420 "to acquire the libvirt lock on each disk."
4424 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4426 "Disks must be accessible locally. This often means that adding disks from a "
4427 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4428 "unless those disks are accessible via the same device path locally too."
4432 #: ../src/guestfs-actions.pod:74
4434 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4435 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4436 "libvirt URI (or one set through an environment variable, see the libvirt "
4437 "documentation for full details). If you are using the C API directly then "
4438 "it is more flexible to create the libvirt connection object yourself, get "
4439 "the domain object, and call C<guestfs_add_libvirt_dom>."
4443 #: ../src/guestfs-actions.pod:82
4445 "The other optional parameters are passed directly through to "
4446 "C<guestfs_add_drive_opts>."
4450 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4451 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4452 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4453 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4454 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4455 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4456 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4457 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630
4458 #: ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475
4459 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009
4460 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331
4461 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759
4462 #: ../src/guestfs-actions.pod:6772
4463 msgid "On error this function returns -1."
4467 #: ../src/guestfs-actions.pod:87
4468 msgid "guestfs_add_domain_va"
4472 #: ../src/guestfs-actions.pod:89
4476 " guestfs_add_domain_va (guestfs_h *g,\n"
4477 " const char *dom,\n"
4483 #: ../src/guestfs-actions.pod:94
4484 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4488 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4489 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4490 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4494 #: ../src/guestfs-actions.pod:98
4495 msgid "guestfs_add_domain_argv"
4499 #: ../src/guestfs-actions.pod:100
4503 " guestfs_add_domain_argv (guestfs_h *g,\n"
4504 " const char *dom,\n"
4505 " const struct guestfs_add_domain_argv *optargs);\n"
4510 #: ../src/guestfs-actions.pod:105
4511 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4515 #: ../src/guestfs-actions.pod:109
4516 msgid "guestfs_add_drive"
4520 #: ../src/guestfs-actions.pod:111
4524 " guestfs_add_drive (guestfs_h *g,\n"
4525 " const char *filename);\n"
4530 #: ../src/guestfs-actions.pod:115
4532 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4533 "optional parameters, so the disk is added writable, with the format being "
4534 "detected automatically."
4538 #: ../src/guestfs-actions.pod:119
4540 "Automatic detection of the format opens you up to a potential security hole "
4541 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4542 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4543 "you should think about replacing calls to this function with calls to "
4544 "C<guestfs_add_drive_opts>, and specifying the format."
4548 #: ../src/guestfs-actions.pod:130
4549 msgid "guestfs_add_drive_opts"
4553 #: ../src/guestfs-actions.pod:132
4557 " guestfs_add_drive_opts (guestfs_h *g,\n"
4558 " const char *filename,\n"
4564 #: ../src/guestfs-actions.pod:142
4567 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4568 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4569 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4574 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4576 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4577 "The first time you call this function, the disk appears as C</dev/sda>, the "
4578 "second time as C</dev/sdb>, and so on."
4582 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4584 "You don't necessarily need to be root when using libguestfs. However you "
4585 "obviously do need sufficient permissions to access the filename for whatever "
4586 "operations you want to perform (ie. read access if you just want to read the "
4587 "image or write access if you want to modify the image)."
4591 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4592 msgid "This call checks that C<filename> exists."
4596 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4597 msgid "The optional arguments are:"
4601 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4606 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4608 "If true then the image is treated as read-only. Writes are still allowed, "
4609 "but they are stored in a temporary snapshot overlay which is discarded at "
4610 "the end. The disk that you add is not modified."
4614 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4619 #: ../src/guestfs-actions.pod:171
4621 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4622 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4623 "Possible formats include C<raw> and C<qcow2>."
4627 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4629 "Automatic detection of the format opens you up to a potential security hole "
4630 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4631 "RHBZ#642934. Specifying the format closes this security hole."
4635 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4640 #: ../src/guestfs-actions.pod:182
4642 "This rarely-used option lets you emulate the behaviour of the deprecated "
4643 "C<guestfs_add_drive_with_if> call (q.v.)"
4647 #: ../src/guestfs-actions.pod:189
4648 msgid "(Added in 1.5.23)"
4652 #: ../src/guestfs-actions.pod:191
4653 msgid "guestfs_add_drive_opts_va"
4657 #: ../src/guestfs-actions.pod:193
4661 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4662 " const char *filename,\n"
4668 #: ../src/guestfs-actions.pod:198
4669 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4673 #: ../src/guestfs-actions.pod:202
4674 msgid "guestfs_add_drive_opts_argv"
4678 #: ../src/guestfs-actions.pod:204
4682 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4683 " const char *filename,\n"
4684 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4689 #: ../src/guestfs-actions.pod:209
4690 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4694 #: ../src/guestfs-actions.pod:213
4695 msgid "guestfs_add_drive_ro"
4699 #: ../src/guestfs-actions.pod:215
4703 " guestfs_add_drive_ro (guestfs_h *g,\n"
4704 " const char *filename);\n"
4709 #: ../src/guestfs-actions.pod:219
4711 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4712 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4713 "disk is added read-only, with the format being detected automatically."
4717 #: ../src/guestfs-actions.pod:226
4718 msgid "(Added in 1.0.38)"
4722 #: ../src/guestfs-actions.pod:228
4723 msgid "guestfs_add_drive_ro_with_if"
4727 #: ../src/guestfs-actions.pod:230
4731 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4732 " const char *filename,\n"
4733 " const char *iface);\n"
4738 #: ../src/guestfs-actions.pod:235
4740 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4741 "QEMU interface emulation to use at run time."
4745 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4746 #: ../src/guestfs-actions.pod:2303
4747 msgid "(Added in 1.0.84)"
4751 #: ../src/guestfs-actions.pod:249
4752 msgid "guestfs_add_drive_with_if"
4756 #: ../src/guestfs-actions.pod:251
4760 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4761 " const char *filename,\n"
4762 " const char *iface);\n"
4767 #: ../src/guestfs-actions.pod:256
4769 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4770 "QEMU interface emulation to use at run time."
4774 #: ../src/guestfs-actions.pod:270
4775 msgid "guestfs_aug_clear"
4779 #: ../src/guestfs-actions.pod:272
4783 " guestfs_aug_clear (guestfs_h *g,\n"
4784 " const char *augpath);\n"
4789 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4791 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4792 "L<augtool(1)> C<clear> command."
4796 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4797 msgid "(Added in 1.3.4)"
4801 #: ../src/guestfs-actions.pod:283
4802 msgid "guestfs_aug_close"
4806 #: ../src/guestfs-actions.pod:285
4810 " guestfs_aug_close (guestfs_h *g);\n"
4815 #: ../src/guestfs-actions.pod:288
4817 "Close the current Augeas handle and free up any resources used by it. After "
4818 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4819 "any other Augeas functions."
4823 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4824 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4825 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4826 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4827 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4828 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4829 #: ../src/guestfs-actions.pod:5086
4830 msgid "(Added in 0.7)"
4834 #: ../src/guestfs-actions.pod:297
4835 msgid "guestfs_aug_defnode"
4839 #: ../src/guestfs-actions.pod:299
4842 " struct guestfs_int_bool *\n"
4843 " guestfs_aug_defnode (guestfs_h *g,\n"
4844 " const char *name,\n"
4845 " const char *expr,\n"
4846 " const char *val);\n"
4851 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4853 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4857 #: ../src/guestfs-actions.pod:308
4859 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4860 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4861 "containing that single node."
4865 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4867 "On success this returns a pair containing the number of nodes in the "
4868 "nodeset, and a boolean flag if a node was created."
4872 #: ../src/guestfs-actions.pod:316
4874 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4875 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4879 #: ../src/guestfs-actions.pod:322
4880 msgid "guestfs_aug_defvar"
4884 #: ../src/guestfs-actions.pod:324
4888 " guestfs_aug_defvar (guestfs_h *g,\n"
4889 " const char *name,\n"
4890 " const char *expr);\n"
4895 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4897 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4898 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4902 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4904 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4905 "evaluates to something which is not a nodeset."
4909 #: ../src/guestfs-actions.pod:340
4910 msgid "guestfs_aug_get"
4914 #: ../src/guestfs-actions.pod:342
4918 " guestfs_aug_get (guestfs_h *g,\n"
4919 " const char *augpath);\n"
4924 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4926 "Look up the value associated with C<path>. If C<path> matches exactly one "
4927 "node, the C<value> is returned."
4931 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4932 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4933 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4934 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4935 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4936 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4937 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4938 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4939 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4940 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
4941 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712
4942 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763
4943 #: ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846
4944 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678
4945 #: ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958
4946 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814
4947 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162
4948 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774
4949 #: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807
4950 #: ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495
4951 #: ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532
4952 #: ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4954 "This function returns a string, or NULL on error. I<The caller must free "
4955 "the returned string after use>."
4959 #: ../src/guestfs-actions.pod:354
4960 msgid "guestfs_aug_init"
4964 #: ../src/guestfs-actions.pod:356
4968 " guestfs_aug_init (guestfs_h *g,\n"
4969 " const char *root,\n"
4975 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4977 "Create a new Augeas handle for editing configuration files. If there was "
4978 "any previous Augeas handle associated with this guestfs session, then it is "
4983 #: ../src/guestfs-actions.pod:365
4984 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4988 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4990 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4994 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4996 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4997 "logical I<or> of the following integers:"
5001 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
5002 msgid "C<AUG_SAVE_BACKUP> = 1"
5006 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
5007 msgid "Keep the original file with a C<.augsave> extension."
5011 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
5012 msgid "C<AUG_SAVE_NEWFILE> = 2"
5016 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
5018 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5019 "original. Overrides C<AUG_SAVE_BACKUP>."
5023 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
5024 msgid "C<AUG_TYPE_CHECK> = 4"
5028 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
5029 msgid "Typecheck lenses (can be expensive)."
5033 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
5034 msgid "C<AUG_NO_STDINC> = 8"
5038 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
5039 msgid "Do not use standard load path for modules."
5043 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
5044 msgid "C<AUG_SAVE_NOOP> = 16"
5048 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
5049 msgid "Make save a no-op, just record what would have been changed."
5053 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
5054 msgid "C<AUG_NO_LOAD> = 32"
5058 #: ../src/guestfs-actions.pod:400
5059 msgid "Do not load the tree in C<guestfs_aug_init>."
5063 #: ../src/guestfs-actions.pod:404
5064 msgid "To close the handle, you can call C<guestfs_aug_close>."
5068 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
5069 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5073 #: ../src/guestfs-actions.pod:412
5074 msgid "guestfs_aug_insert"
5078 #: ../src/guestfs-actions.pod:414
5082 " guestfs_aug_insert (guestfs_h *g,\n"
5083 " const char *augpath,\n"
5084 " const char *label,\n"
5090 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
5092 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5093 "or after C<path> (depending on the boolean flag C<before>)."
5097 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
5099 "C<path> must match exactly one existing node in the tree, and C<label> must "
5100 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5104 #: ../src/guestfs-actions.pod:432
5105 msgid "guestfs_aug_load"
5109 #: ../src/guestfs-actions.pod:434
5113 " guestfs_aug_load (guestfs_h *g);\n"
5118 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
5119 msgid "Load files into the tree."
5123 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
5124 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5128 #: ../src/guestfs-actions.pod:446
5129 msgid "guestfs_aug_ls"
5133 #: ../src/guestfs-actions.pod:448
5137 " guestfs_aug_ls (guestfs_h *g,\n"
5138 " const char *augpath);\n"
5143 #: ../src/guestfs-actions.pod:452
5145 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5146 "sorting the resulting nodes into alphabetical order."
5150 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
5151 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
5152 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
5153 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
5154 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
5155 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
5156 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
5157 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
5158 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782
5159 #: ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248
5160 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415
5161 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436
5162 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082
5163 #: ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847
5164 #: ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963
5165 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133
5166 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625
5167 #: ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837
5168 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941
5169 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006
5170 #: ../src/guestfs-actions.pod:7025
5172 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5173 ">), or NULL if there was an error. I<The caller must free the strings and "
5174 "the array after use>."
5178 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
5179 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
5180 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102
5181 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711
5182 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931
5183 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440
5184 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275
5185 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301
5186 #: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347
5187 #: ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589
5188 #: ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
5189 msgid "(Added in 0.8)"
5193 #: ../src/guestfs-actions.pod:461
5194 msgid "guestfs_aug_match"
5198 #: ../src/guestfs-actions.pod:463
5202 " guestfs_aug_match (guestfs_h *g,\n"
5203 " const char *augpath);\n"
5208 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
5210 "Returns a list of paths which match the path expression C<path>. The "
5211 "returned paths are sufficiently qualified so that they match exactly one "
5212 "node in the current tree."
5216 #: ../src/guestfs-actions.pod:477
5217 msgid "guestfs_aug_mv"
5221 #: ../src/guestfs-actions.pod:479
5225 " guestfs_aug_mv (guestfs_h *g,\n"
5226 " const char *src,\n"
5227 " const char *dest);\n"
5232 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
5234 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5235 "C<dest> is overwritten if it exists."
5239 #: ../src/guestfs-actions.pod:491
5240 msgid "guestfs_aug_rm"
5244 #: ../src/guestfs-actions.pod:493
5248 " guestfs_aug_rm (guestfs_h *g,\n"
5249 " const char *augpath);\n"
5254 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5255 msgid "Remove C<path> and all of its children."
5259 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5260 msgid "On success this returns the number of entries which were removed."
5264 #: ../src/guestfs-actions.pod:505
5265 msgid "guestfs_aug_save"
5269 #: ../src/guestfs-actions.pod:507
5273 " guestfs_aug_save (guestfs_h *g);\n"
5278 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5279 msgid "This writes all pending changes to disk."
5283 #: ../src/guestfs-actions.pod:512
5285 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5290 #: ../src/guestfs-actions.pod:519
5291 msgid "guestfs_aug_set"
5295 #: ../src/guestfs-actions.pod:521
5299 " guestfs_aug_set (guestfs_h *g,\n"
5300 " const char *augpath,\n"
5301 " const char *val);\n"
5306 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5307 msgid "Set the value associated with C<path> to C<val>."
5311 #: ../src/guestfs-actions.pod:528
5313 "In the Augeas API, it is possible to clear a node by setting the value to "
5314 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5315 "this call. Instead you must use the C<guestfs_aug_clear> call."
5319 #: ../src/guestfs-actions.pod:537
5320 msgid "guestfs_available"
5324 #: ../src/guestfs-actions.pod:539
5328 " guestfs_available (guestfs_h *g,\n"
5329 " char *const *groups);\n"
5334 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5336 "This command is used to check the availability of some groups of "
5337 "functionality in the appliance, which not all builds of the libguestfs "
5338 "appliance will be able to provide."
5342 #: ../src/guestfs-actions.pod:547
5344 "The libguestfs groups, and the functions that those groups correspond to, "
5345 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5346 "runtime by calling C<guestfs_available_all_groups>."
5350 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5352 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5353 "\"]> would check for the availability of the Linux inotify functions and "
5354 "Augeas (configuration file editing) functions."
5358 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5359 msgid "The command returns no error if I<all> requested groups are available."
5363 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5365 "It fails with an error if one or more of the requested groups is unavailable "
5370 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5372 "If an unknown group name is included in the list of groups then an error is "
5377 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5382 #: ../src/guestfs-actions.pod:571
5383 msgid "You must call C<guestfs_launch> before calling this function."
5387 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5389 "The reason is because we don't know what groups are supported by the "
5390 "appliance/daemon until it is running and can be queried."
5394 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5396 "If a group of functions is available, this does not necessarily mean that "
5397 "they will work. You still have to check for errors when calling individual "
5398 "API functions even if they are available."
5402 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5404 "It is usually the job of distro packagers to build complete functionality "
5405 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5406 "with all requirements satisfied, will support everything."
5410 #: ../src/guestfs-actions.pod:593
5412 "This call was added in version C<1.0.80>. In previous versions of "
5413 "libguestfs all you could do would be to speculatively execute a command to "
5414 "find out if the daemon implemented it. See also C<guestfs_version>."
5418 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5419 msgid "(Added in 1.0.80)"
5423 #: ../src/guestfs-actions.pod:604
5424 msgid "guestfs_available_all_groups"
5428 #: ../src/guestfs-actions.pod:606
5432 " guestfs_available_all_groups (guestfs_h *g);\n"
5437 #: ../src/guestfs-actions.pod:609
5439 "This command returns a list of all optional groups that this daemon knows "
5440 "about. Note this returns both supported and unsupported groups. To find "
5441 "out which ones the daemon can actually support you have to call "
5442 "C<guestfs_available> on each member of the returned list."
5446 #: ../src/guestfs-actions.pod:615
5447 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5451 #: ../src/guestfs-actions.pod:621
5452 msgid "(Added in 1.3.15)"
5456 #: ../src/guestfs-actions.pod:623
5457 msgid "guestfs_base64_in"
5461 #: ../src/guestfs-actions.pod:625
5465 " guestfs_base64_in (guestfs_h *g,\n"
5466 " const char *base64file,\n"
5467 " const char *filename);\n"
5472 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5474 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5478 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5479 msgid "(Added in 1.3.5)"
5483 #: ../src/guestfs-actions.pod:637
5484 msgid "guestfs_base64_out"
5488 #: ../src/guestfs-actions.pod:639
5492 " guestfs_base64_out (guestfs_h *g,\n"
5493 " const char *filename,\n"
5494 " const char *base64file);\n"
5499 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5501 "This command downloads the contents of C<filename>, writing it out to local "
5502 "file C<base64file> encoded as base64."
5506 #: ../src/guestfs-actions.pod:651
5507 msgid "guestfs_blockdev_flushbufs"
5511 #: ../src/guestfs-actions.pod:653
5515 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5516 " const char *device);\n"
5521 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5523 "This tells the kernel to flush internal buffers associated with C<device>."
5527 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5528 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5529 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5530 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5531 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5532 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5533 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5534 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5535 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5536 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5537 msgid "This uses the L<blockdev(8)> command."
5541 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5542 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5543 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5544 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5545 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5546 msgid "(Added in 0.9.3)"
5550 #: ../src/guestfs-actions.pod:666
5551 msgid "guestfs_blockdev_getbsz"
5555 #: ../src/guestfs-actions.pod:668
5559 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5560 " const char *device);\n"
5565 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5566 msgid "This returns the block size of a device."
5570 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5571 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5573 "(Note this is different from both I<size in blocks> and I<filesystem block "
5578 #: ../src/guestfs-actions.pod:683
5579 msgid "guestfs_blockdev_getro"
5583 #: ../src/guestfs-actions.pod:685
5587 " guestfs_blockdev_getro (guestfs_h *g,\n"
5588 " const char *device);\n"
5593 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5595 "Returns a boolean indicating if the block device is read-only (true if read-"
5596 "only, false if not)."
5600 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5601 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5602 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5603 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5604 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5605 #: ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024
5606 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053
5607 #: ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084
5608 #: ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114
5609 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141
5610 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171
5611 #: ../src/guestfs-actions.pod:4585
5612 msgid "This function returns a C truth value on success or -1 on error."
5616 #: ../src/guestfs-actions.pod:698
5617 msgid "guestfs_blockdev_getsize64"
5621 #: ../src/guestfs-actions.pod:700
5625 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5626 " const char *device);\n"
5631 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5632 msgid "This returns the size of the device in bytes."
5636 #: ../src/guestfs-actions.pod:706
5637 msgid "See also C<guestfs_blockdev_getsz>."
5641 #: ../src/guestfs-actions.pod:714
5642 msgid "guestfs_blockdev_getss"
5646 #: ../src/guestfs-actions.pod:716
5650 " guestfs_blockdev_getss (guestfs_h *g,\n"
5651 " const char *device);\n"
5656 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5658 "This returns the size of sectors on a block device. Usually 512, but can be "
5659 "larger for modern devices."
5663 #: ../src/guestfs-actions.pod:723
5665 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5670 #: ../src/guestfs-actions.pod:732
5671 msgid "guestfs_blockdev_getsz"
5675 #: ../src/guestfs-actions.pod:734
5679 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5680 " const char *device);\n"
5685 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5687 "This returns the size of the device in units of 512-byte sectors (even if "
5688 "the sectorsize isn't 512 bytes ... weird)."
5692 #: ../src/guestfs-actions.pod:741
5694 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5695 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5699 #: ../src/guestfs-actions.pod:751
5700 msgid "guestfs_blockdev_rereadpt"
5704 #: ../src/guestfs-actions.pod:753
5708 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5709 " const char *device);\n"
5714 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5715 msgid "Reread the partition table on C<device>."
5719 #: ../src/guestfs-actions.pod:765
5720 msgid "guestfs_blockdev_setbsz"
5724 #: ../src/guestfs-actions.pod:767
5728 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5729 " const char *device,\n"
5730 " int blocksize);\n"
5735 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5736 msgid "This sets the block size of a device."
5740 #: ../src/guestfs-actions.pod:783
5741 msgid "guestfs_blockdev_setro"
5745 #: ../src/guestfs-actions.pod:785
5749 " guestfs_blockdev_setro (guestfs_h *g,\n"
5750 " const char *device);\n"
5755 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5756 msgid "Sets the block device named C<device> to read-only."
5760 #: ../src/guestfs-actions.pod:797
5761 msgid "guestfs_blockdev_setrw"
5765 #: ../src/guestfs-actions.pod:799
5769 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5770 " const char *device);\n"
5775 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5776 msgid "Sets the block device named C<device> to read-write."
5780 #: ../src/guestfs-actions.pod:811
5781 msgid "guestfs_case_sensitive_path"
5785 #: ../src/guestfs-actions.pod:813
5789 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5790 " const char *path);\n"
5795 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5797 "This can be used to resolve case insensitive paths on a filesystem which is "
5798 "case sensitive. The use case is to resolve paths which you have read from "
5799 "Windows configuration files or the Windows Registry, to the true path."
5803 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5805 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5806 "(and probably others), which is that although the underlying filesystem is "
5807 "case-insensitive, the driver exports the filesystem to Linux as case-"
5812 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5814 "One consequence of this is that special directories such as C<c:\\windows> "
5815 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5816 "precise details of how they were created. In Windows itself this would not "
5821 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5823 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5828 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5830 "This function resolves the true case of each element in the path and returns "
5831 "the case-sensitive path."
5835 #: ../src/guestfs-actions.pod:839
5837 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5838 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5839 "how the directories were originally created under Windows)."
5843 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5844 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5848 #: ../src/guestfs-actions.pod:847
5849 msgid "See also C<guestfs_realpath>."
5853 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5854 msgid "(Added in 1.0.75)"
5858 #: ../src/guestfs-actions.pod:854
5863 #: ../src/guestfs-actions.pod:856
5867 " guestfs_cat (guestfs_h *g,\n"
5868 " const char *path);\n"
5873 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072
5874 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5875 msgid "Return the contents of the file named C<path>."
5879 #: ../src/guestfs-actions.pod:862
5881 "Note that this function cannot correctly handle binary files (specifically, "
5882 "files containing C<\\0> character which is treated as end of string). For "
5883 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5884 "functions which have a more complex interface."
5888 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5889 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5890 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5891 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5892 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5893 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5894 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5895 #: ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880
5896 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037
5897 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912
5898 #: ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113
5899 #: ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789
5900 #: ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841
5901 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945
5902 #: ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010
5903 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:582
5904 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5905 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5906 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5907 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5908 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5909 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5910 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5911 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5912 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5913 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5914 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5915 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5916 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5917 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5918 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5920 "Because of the message protocol, there is a transfer limit of somewhere "
5921 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5925 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252
5926 #: ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331
5927 #: ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824
5928 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960
5929 #: ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676
5930 #: ../src/guestfs-actions.pod:6690
5931 msgid "(Added in 0.4)"
5935 #: ../src/guestfs-actions.pod:875
5936 msgid "guestfs_checksum"
5940 #: ../src/guestfs-actions.pod:877
5944 " guestfs_checksum (guestfs_h *g,\n"
5945 " const char *csumtype,\n"
5946 " const char *path);\n"
5951 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5953 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5957 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5959 "The type of checksum to compute is given by the C<csumtype> parameter which "
5960 "must have one of the following values:"
5964 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5969 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5971 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5976 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5981 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5982 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5986 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5991 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5992 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5996 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
6001 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
6002 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6006 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
6011 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
6012 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6016 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
6021 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
6022 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6026 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
6031 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
6032 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6036 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
6037 msgid "The checksum is returned as a printable string."
6041 #: ../src/guestfs-actions.pod:923
6042 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6046 #: ../src/guestfs-actions.pod:925
6047 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6051 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
6052 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026
6053 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116
6054 #: ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
6055 msgid "(Added in 1.0.2)"
6059 #: ../src/guestfs-actions.pod:932
6060 msgid "guestfs_checksum_device"
6064 #: ../src/guestfs-actions.pod:934
6068 " guestfs_checksum_device (guestfs_h *g,\n"
6069 " const char *csumtype,\n"
6070 " const char *device);\n"
6075 #: ../src/guestfs-actions.pod:939
6077 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6078 "device named C<device>. For the types of checksums supported see the "
6079 "C<guestfs_checksum> command."
6083 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491
6084 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587
6085 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781
6086 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306
6087 #: ../src/guestfs-actions.pod:6702
6088 msgid "(Added in 1.3.2)"
6092 #: ../src/guestfs-actions.pod:948
6093 msgid "guestfs_checksums_out"
6097 #: ../src/guestfs-actions.pod:950
6101 " guestfs_checksums_out (guestfs_h *g,\n"
6102 " const char *csumtype,\n"
6103 " const char *directory,\n"
6104 " const char *sumsfile);\n"
6109 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
6111 "This command computes the checksums of all regular files in C<directory> and "
6112 "then emits a list of those checksums to the local output file C<sumsfile>."
6116 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
6118 "This can be used for verifying the integrity of a virtual machine. However "
6119 "to be properly secure you should pay attention to the output of the checksum "
6120 "command (it uses the ones from GNU coreutils). In particular when the "
6121 "filename is not printable, coreutils uses a special backslash syntax. For "
6122 "more information, see the GNU coreutils info file."
6126 #: ../src/guestfs-actions.pod:970
6127 msgid "(Added in 1.3.7)"
6131 #: ../src/guestfs-actions.pod:972
6132 msgid "guestfs_chmod"
6136 #: ../src/guestfs-actions.pod:974
6140 " guestfs_chmod (guestfs_h *g,\n"
6142 " const char *path);\n"
6147 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
6149 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6154 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
6156 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6157 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6162 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075
6163 #: ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209
6164 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671
6165 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6166 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6167 msgid "The mode actually set is affected by the umask."
6171 #: ../src/guestfs-actions.pod:992
6172 msgid "guestfs_chown"
6176 #: ../src/guestfs-actions.pod:994
6180 " guestfs_chown (guestfs_h *g,\n"
6183 " const char *path);\n"
6188 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
6189 msgid "Change the file owner to C<owner> and group to C<group>."
6193 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213
6194 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6196 "Only numeric uid and gid are supported. If you want to use names, you will "
6197 "need to locate and parse the password file yourself (Augeas support makes "
6198 "this relatively easy)."
6202 #: ../src/guestfs-actions.pod:1010
6203 msgid "guestfs_command"
6207 #: ../src/guestfs-actions.pod:1012
6211 " guestfs_command (guestfs_h *g,\n"
6212 " char *const *arguments);\n"
6217 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
6219 "This call runs a command from the guest filesystem. The filesystem must be "
6220 "mounted, and must contain a compatible operating system (ie. something "
6221 "Linux, with the same or compatible processor architecture)."
6225 #: ../src/guestfs-actions.pod:1021
6227 "The single parameter is an argv-style list of arguments. The first element "
6228 "is the name of the program to run. Subsequent elements are parameters. The "
6229 "list must be non-empty (ie. must contain a program name). Note that the "
6230 "command runs directly, and is I<not> invoked via the shell (see "
6235 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
6236 msgid "The return value is anything printed to I<stdout> by the command."
6240 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
6242 "If the command returns a non-zero exit status, then this function returns an "
6243 "error message. The error message string is the content of I<stderr> from "
6248 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6250 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6251 "bin>. If you require a program from another location, you should provide "
6252 "the full path in the first parameter."
6256 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6258 "Shared libraries and data files required by the program must be available on "
6259 "filesystems which are mounted in the correct places. It is the caller's "
6260 "responsibility to ensure all filesystems that are needed are mounted at the "
6265 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6266 #: ../src/guestfs-actions.pod:1535
6267 msgid "(Added in 0.9.1)"
6271 #: ../src/guestfs-actions.pod:1054
6272 msgid "guestfs_command_lines"
6276 #: ../src/guestfs-actions.pod:1056
6280 " guestfs_command_lines (guestfs_h *g,\n"
6281 " char *const *arguments);\n"
6286 #: ../src/guestfs-actions.pod:1060
6288 "This is the same as C<guestfs_command>, but splits the result into a list of "
6293 #: ../src/guestfs-actions.pod:1063
6294 msgid "See also: C<guestfs_sh_lines>"
6298 #: ../src/guestfs-actions.pod:1074
6299 msgid "guestfs_config"
6303 #: ../src/guestfs-actions.pod:1076
6307 " guestfs_config (guestfs_h *g,\n"
6308 " const char *qemuparam,\n"
6309 " const char *qemuvalue);\n"
6314 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6316 "This can be used to add arbitrary qemu command line parameters of the form "
6317 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6318 "setting some parameters which would interfere with parameters that we use."
6322 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6323 msgid "The first character of C<param> string must be a C<-> (dash)."
6327 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6328 msgid "C<value> can be NULL."
6332 #: ../src/guestfs-actions.pod:1094
6333 msgid "guestfs_copy_size"
6337 #: ../src/guestfs-actions.pod:1096
6341 " guestfs_copy_size (guestfs_h *g,\n"
6342 " const char *src,\n"
6343 " const char *dest,\n"
6349 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6351 "This command copies exactly C<size> bytes from one source device or file "
6352 "C<src> to another destination device or file C<dest>."
6356 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6358 "Note this will fail if the source is too short or if the destination is not "
6363 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6364 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6365 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881
6366 #: ../src/guestfs-actions.pod:6900
6368 "This long-running command can generate progress notification messages so "
6369 "that the caller can display a progress bar or indicator. To receive these "
6370 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6371 "guestfs_set_progress_callback>."
6375 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851
6376 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609
6377 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6378 msgid "(Added in 1.0.87)"
6382 #: ../src/guestfs-actions.pod:1117
6387 #: ../src/guestfs-actions.pod:1119
6391 " guestfs_cp (guestfs_h *g,\n"
6392 " const char *src,\n"
6393 " const char *dest);\n"
6398 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6400 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6401 "destination filename or destination directory."
6405 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6406 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6407 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454
6408 #: ../src/guestfs-actions.pod:4831
6409 msgid "(Added in 1.0.18)"
6413 #: ../src/guestfs-actions.pod:1131
6414 msgid "guestfs_cp_a"
6418 #: ../src/guestfs-actions.pod:1133
6422 " guestfs_cp_a (guestfs_h *g,\n"
6423 " const char *src,\n"
6424 " const char *dest);\n"
6429 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6431 "This copies a file or directory from C<src> to C<dest> recursively using the "
6436 #: ../src/guestfs-actions.pod:1145
6441 #: ../src/guestfs-actions.pod:1147
6445 " guestfs_dd (guestfs_h *g,\n"
6446 " const char *src,\n"
6447 " const char *dest);\n"
6452 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6454 "This command copies from one source device or file C<src> to another "
6455 "destination device or file C<dest>. Normally you would use this to copy to "
6456 "or from a device or partition, for example to duplicate a filesystem."
6460 #: ../src/guestfs-actions.pod:1157
6462 "If the destination is a device, it must be as large or larger than the "
6463 "source file or device, otherwise the copy will fail. This command cannot do "
6464 "partial copies (see C<guestfs_copy_size>)."
6468 #: ../src/guestfs-actions.pod:1165
6473 #: ../src/guestfs-actions.pod:1167
6477 " guestfs_df (guestfs_h *g);\n"
6482 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6483 msgid "This command runs the C<df> command to report disk space used."
6487 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6488 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6490 "This command is mostly useful for interactive sessions. It is I<not> "
6491 "intended that you try to parse the output string. Use C<statvfs> from "
6496 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6497 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6498 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6499 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354
6500 #: ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140
6501 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761
6502 #: ../src/guestfs-actions.pod:6774
6503 msgid "(Added in 1.0.54)"
6507 #: ../src/guestfs-actions.pod:1181
6508 msgid "guestfs_df_h"
6512 #: ../src/guestfs-actions.pod:1183
6516 " guestfs_df_h (guestfs_h *g);\n"
6521 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6523 "This command runs the C<df -h> command to report disk space used in human-"
6528 #: ../src/guestfs-actions.pod:1198
6529 msgid "guestfs_dmesg"
6533 #: ../src/guestfs-actions.pod:1200
6537 " guestfs_dmesg (guestfs_h *g);\n"
6542 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6544 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6545 "This is sometimes useful for extended debugging of problems."
6549 #: ../src/guestfs-actions.pod:1207
6551 "Another way to get the same information is to enable verbose messages with "
6552 "C<guestfs_set_verbose> or by setting the environment variable "
6553 "C<LIBGUESTFS_DEBUG=1> before running the program."
6557 #: ../src/guestfs-actions.pod:1217
6558 msgid "guestfs_download"
6562 #: ../src/guestfs-actions.pod:1219
6566 " guestfs_download (guestfs_h *g,\n"
6567 " const char *remotefilename,\n"
6568 " const char *filename);\n"
6573 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6574 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6576 "Download file C<remotefilename> and save it as C<filename> on the local "
6581 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372
6582 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6583 msgid "C<filename> can also be a named pipe."
6587 #: ../src/guestfs-actions.pod:1229
6588 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6592 #: ../src/guestfs-actions.pod:1240
6593 msgid "guestfs_download_offset"
6597 #: ../src/guestfs-actions.pod:1242
6601 " guestfs_download_offset (guestfs_h *g,\n"
6602 " const char *remotefilename,\n"
6603 " const char *filename,\n"
6604 " int64_t offset,\n"
6610 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6612 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6613 "region must be within the file or device)."
6617 #: ../src/guestfs-actions.pod:1255
6619 "Note that there is no limit on the amount of data that can be downloaded "
6620 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6621 "full amount unless an error occurs."
6625 #: ../src/guestfs-actions.pod:1260
6626 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6630 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6631 msgid "(Added in 1.5.17)"
6635 #: ../src/guestfs-actions.pod:1271
6636 msgid "guestfs_drop_caches"
6640 #: ../src/guestfs-actions.pod:1273
6644 " guestfs_drop_caches (guestfs_h *g,\n"
6645 " int whattodrop);\n"
6650 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6652 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6653 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6654 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6658 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6659 msgid "Setting C<whattodrop> to 3 should drop everything."
6663 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6665 "This automatically calls L<sync(2)> before the operation, so that the "
6666 "maximum guest memory is freed."
6670 #: ../src/guestfs-actions.pod:1291
6675 #: ../src/guestfs-actions.pod:1293
6679 " guestfs_du (guestfs_h *g,\n"
6680 " const char *path);\n"
6685 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6687 "This command runs the C<du -s> command to estimate file space usage for "
6692 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6694 "C<path> can be a file or a directory. If C<path> is a directory then the "
6695 "estimate includes the contents of the directory and all subdirectories "
6700 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6702 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6706 #: ../src/guestfs-actions.pod:1311
6707 msgid "guestfs_e2fsck_f"
6711 #: ../src/guestfs-actions.pod:1313
6715 " guestfs_e2fsck_f (guestfs_h *g,\n"
6716 " const char *device);\n"
6721 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6723 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6724 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6729 #: ../src/guestfs-actions.pod:1321
6731 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6732 "Normally you should use C<guestfs_fsck>."
6736 #: ../src/guestfs-actions.pod:1326
6737 msgid "(Added in 1.0.29)"
6741 #: ../src/guestfs-actions.pod:1328
6742 msgid "guestfs_echo_daemon"
6746 #: ../src/guestfs-actions.pod:1330
6750 " guestfs_echo_daemon (guestfs_h *g,\n"
6751 " char *const *words);\n"
6756 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6758 "This command concatenates the list of C<words> passed with single spaces "
6759 "between them and returns the resulting string."
6763 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6764 msgid "You can use this command to test the connection through to the daemon."
6768 #: ../src/guestfs-actions.pod:1339
6769 msgid "See also C<guestfs_ping_daemon>."
6773 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6774 #: ../src/guestfs-actions.pod:5620
6775 msgid "(Added in 1.0.69)"
6779 #: ../src/guestfs-actions.pod:1346
6780 msgid "guestfs_egrep"
6784 #: ../src/guestfs-actions.pod:1348
6788 " guestfs_egrep (guestfs_h *g,\n"
6789 " const char *regex,\n"
6790 " const char *path);\n"
6795 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6797 "This calls the external C<egrep> program and returns the matching lines."
6801 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6802 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6803 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6804 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6805 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6806 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6807 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344
6808 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371
6809 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289
6810 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214
6811 #: ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996
6812 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022
6813 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057
6814 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083
6815 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863
6816 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967
6817 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6818 msgid "(Added in 1.0.66)"
6822 #: ../src/guestfs-actions.pod:1365
6823 msgid "guestfs_egrepi"
6827 #: ../src/guestfs-actions.pod:1367
6831 " guestfs_egrepi (guestfs_h *g,\n"
6832 " const char *regex,\n"
6833 " const char *path);\n"
6838 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6840 "This calls the external C<egrep -i> program and returns the matching lines."
6844 #: ../src/guestfs-actions.pod:1384
6845 msgid "guestfs_equal"
6849 #: ../src/guestfs-actions.pod:1386
6853 " guestfs_equal (guestfs_h *g,\n"
6854 " const char *file1,\n"
6855 " const char *file2);\n"
6860 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6862 "This compares the two files C<file1> and C<file2> and returns true if their "
6863 "content is exactly equal, or false otherwise."
6867 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6868 msgid "The external L<cmp(1)> program is used for the comparison."
6872 #: ../src/guestfs-actions.pod:1400
6873 msgid "guestfs_exists"
6877 #: ../src/guestfs-actions.pod:1402
6881 " guestfs_exists (guestfs_h *g,\n"
6882 " const char *path);\n"
6887 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6889 "This returns C<true> if and only if there is a file, directory (or anything) "
6890 "with the given C<path> name."
6894 #: ../src/guestfs-actions.pod:1409
6895 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6899 #: ../src/guestfs-actions.pod:1415
6900 msgid "guestfs_fallocate"
6904 #: ../src/guestfs-actions.pod:1417
6908 " guestfs_fallocate (guestfs_h *g,\n"
6909 " const char *path,\n"
6915 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6916 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6918 "This command preallocates a file (containing zero bytes) named C<path> of "
6919 "size C<len> bytes. If the file exists already, it is overwritten."
6923 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6925 "Do not confuse this with the guestfish-specific C<alloc> command which "
6926 "allocates a file in the host and attaches it as a device."
6930 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6932 "This function is deprecated. In new code, use the C<fallocate64> call "
6937 #: ../src/guestfs-actions.pod:1441
6938 msgid "guestfs_fallocate64"
6942 #: ../src/guestfs-actions.pod:1443
6946 " guestfs_fallocate64 (guestfs_h *g,\n"
6947 " const char *path,\n"
6953 #: ../src/guestfs-actions.pod:1452
6955 "Note that this call allocates disk blocks for the file. To create a sparse "
6956 "file use C<guestfs_truncate_size> instead."
6960 #: ../src/guestfs-actions.pod:1455
6962 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6963 "oversight it only allowed 30 bit lengths to be specified, effectively "
6964 "limiting the maximum size of files created through that call to 1GB."
6968 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6970 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6971 "commands which create a file in the host and attach it as a device."
6975 #: ../src/guestfs-actions.pod:1466
6976 msgid "(Added in 1.3.17)"
6980 #: ../src/guestfs-actions.pod:1468
6981 msgid "guestfs_fgrep"
6985 #: ../src/guestfs-actions.pod:1470
6989 " guestfs_fgrep (guestfs_h *g,\n"
6990 " const char *pattern,\n"
6991 " const char *path);\n"
6996 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6998 "This calls the external C<fgrep> program and returns the matching lines."
7002 #: ../src/guestfs-actions.pod:1487
7003 msgid "guestfs_fgrepi"
7007 #: ../src/guestfs-actions.pod:1489
7011 " guestfs_fgrepi (guestfs_h *g,\n"
7012 " const char *pattern,\n"
7013 " const char *path);\n"
7018 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
7020 "This calls the external C<fgrep -i> program and returns the matching lines."
7024 #: ../src/guestfs-actions.pod:1506
7025 msgid "guestfs_file"
7029 #: ../src/guestfs-actions.pod:1508
7033 " guestfs_file (guestfs_h *g,\n"
7034 " const char *path);\n"
7039 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
7041 "This call uses the standard L<file(1)> command to determine the type or "
7042 "contents of the file."
7046 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
7048 "This call will also transparently look inside various types of compressed "
7053 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
7055 "The exact command which runs is C<file -zb path>. Note in particular that "
7056 "the filename is not prepended to the output (the C<-b> option)."
7060 #: ../src/guestfs-actions.pod:1522
7062 "This command can also be used on C</dev/> devices (and partitions, LV "
7063 "names). You can for example use this to determine if a device contains a "
7064 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7068 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
7070 "If the C<path> does not begin with C</dev/> then this command only works for "
7071 "the content of regular files. For other file types (directory, symbolic "
7072 "link etc) it will just return the string C<directory> etc."
7076 #: ../src/guestfs-actions.pod:1537
7077 msgid "guestfs_file_architecture"
7081 #: ../src/guestfs-actions.pod:1539
7085 " guestfs_file_architecture (guestfs_h *g,\n"
7086 " const char *filename);\n"
7091 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
7093 "This detects the architecture of the binary C<filename>, and returns it if "
7098 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
7099 msgid "Currently defined architectures are:"
7103 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
7108 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
7110 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7111 "irrespective of the precise processor requirements of the binary."
7115 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
7120 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
7121 msgid "64 bit x86-64."
7125 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
7130 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
7131 msgid "32 bit SPARC."
7135 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
7140 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
7141 msgid "64 bit SPARC V9 and above."
7145 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
7150 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
7151 msgid "Intel Itanium."
7155 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
7160 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
7161 msgid "32 bit Power PC."
7165 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
7170 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
7171 msgid "64 bit Power PC."
7175 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
7176 msgid "Libguestfs may return other architecture strings in future."
7180 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
7181 msgid "The function works on at least the following types of files:"
7185 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
7186 msgid "many types of Un*x and Linux binary"
7190 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
7191 msgid "many types of Un*x and Linux shared library"
7195 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
7196 msgid "Windows Win32 and Win64 binaries"
7200 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
7201 msgid "Windows Win32 and Win64 DLLs"
7205 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
7206 msgid "Win32 binaries and DLLs return C<i386>."
7210 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
7211 msgid "Win64 binaries and DLLs return C<x86_64>."
7215 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
7216 msgid "Linux kernel modules"
7220 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
7221 msgid "Linux new-style initrd images"
7225 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
7226 msgid "some non-x86 Linux vmlinuz kernels"
7230 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
7231 msgid "What it can't do currently:"
7235 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
7236 msgid "static libraries (libfoo.a)"
7240 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
7241 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7245 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7246 msgid "x86 Linux vmlinuz kernels"
7250 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7252 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7253 "compressed code, and are horribly hard to unpack. If you want to find the "
7254 "architecture of a kernel, use the architecture of the associated initrd or "
7255 "kernel module(s) instead."
7259 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7260 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7261 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
7262 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653
7263 #: ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766
7264 #: ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997
7265 #: ../src/guestfs-actions.pod:3129
7266 msgid "(Added in 1.5.3)"
7270 #: ../src/guestfs-actions.pod:1649
7271 msgid "guestfs_filesize"
7275 #: ../src/guestfs-actions.pod:1651
7279 " guestfs_filesize (guestfs_h *g,\n"
7280 " const char *file);\n"
7285 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7286 msgid "This command returns the size of C<file> in bytes."
7290 #: ../src/guestfs-actions.pod:1657
7292 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7293 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7294 "devices, use C<guestfs_blockdev_getsize64>."
7298 #: ../src/guestfs-actions.pod:1663
7299 msgid "(Added in 1.0.82)"
7303 #: ../src/guestfs-actions.pod:1665
7304 msgid "guestfs_fill"
7308 #: ../src/guestfs-actions.pod:1667
7312 " guestfs_fill (guestfs_h *g,\n"
7315 " const char *path);\n"
7320 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7322 "This command creates a new file called C<path>. The initial content of the "
7323 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7328 #: ../src/guestfs-actions.pod:1677
7330 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7331 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7332 "bytes use C<guestfs_fill_pattern>."
7336 #: ../src/guestfs-actions.pod:1689
7337 msgid "(Added in 1.0.79)"
7341 #: ../src/guestfs-actions.pod:1691
7342 msgid "guestfs_fill_pattern"
7346 #: ../src/guestfs-actions.pod:1693
7350 " guestfs_fill_pattern (guestfs_h *g,\n"
7351 " const char *pattern,\n"
7353 " const char *path);\n"
7358 #: ../src/guestfs-actions.pod:1699
7360 "This function is like C<guestfs_fill> except that it creates a new file of "
7361 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7362 "pattern is truncated if necessary to ensure the length of the file is "
7363 "exactly C<len> bytes."
7367 #: ../src/guestfs-actions.pod:1711
7368 msgid "(Added in 1.3.12)"
7372 #: ../src/guestfs-actions.pod:1713
7373 msgid "guestfs_find"
7377 #: ../src/guestfs-actions.pod:1715
7381 " guestfs_find (guestfs_h *g,\n"
7382 " const char *directory);\n"
7387 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7389 "This command lists out all files and directories, recursively, starting at "
7390 "C<directory>. It is essentially equivalent to running the shell command "
7391 "C<find directory -print> but some post-processing happens on the output, "
7396 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7398 "This returns a list of strings I<without any prefix>. Thus if the directory "
7403 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7413 #: ../src/guestfs-actions.pod:1731
7415 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7419 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7430 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7431 msgid "If C<directory> is not a directory, then this command returns an error."
7435 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7436 msgid "The returned list is sorted."
7440 #: ../src/guestfs-actions.pod:1744
7441 msgid "See also C<guestfs_find0>."
7445 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788
7446 #: ../src/guestfs-actions.pod:5249
7447 msgid "(Added in 1.0.27)"
7451 #: ../src/guestfs-actions.pod:1755
7452 msgid "guestfs_find0"
7456 #: ../src/guestfs-actions.pod:1757
7460 " guestfs_find0 (guestfs_h *g,\n"
7461 " const char *directory,\n"
7462 " const char *files);\n"
7467 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7469 "This command lists out all files and directories, recursively, starting at "
7470 "C<directory>, placing the resulting list in the external file called "
7475 #: ../src/guestfs-actions.pod:1766
7477 "This command works the same way as C<guestfs_find> with the following "
7482 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7483 msgid "The resulting list is written to an external file."
7487 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7489 "Items (filenames) in the result are separated by C<\\0> characters. See "
7490 "L<find(1)> option I<-print0>."
7494 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7495 msgid "This command is not limited in the number of names that it can return."
7499 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7500 msgid "The result list is not sorted."
7504 #: ../src/guestfs-actions.pod:1793
7505 msgid "(Added in 1.0.74)"
7509 #: ../src/guestfs-actions.pod:1795
7510 msgid "guestfs_findfs_label"
7514 #: ../src/guestfs-actions.pod:1797
7518 " guestfs_findfs_label (guestfs_h *g,\n"
7519 " const char *label);\n"
7524 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7526 "This command searches the filesystems and returns the one which has the "
7527 "given label. An error is returned if no such filesystem can be found."
7531 #: ../src/guestfs-actions.pod:1805
7532 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7536 #: ../src/guestfs-actions.pod:1812
7537 msgid "guestfs_findfs_uuid"
7541 #: ../src/guestfs-actions.pod:1814
7545 " guestfs_findfs_uuid (guestfs_h *g,\n"
7546 " const char *uuid);\n"
7551 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7553 "This command searches the filesystems and returns the one which has the "
7554 "given UUID. An error is returned if no such filesystem can be found."
7558 #: ../src/guestfs-actions.pod:1822
7559 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7563 #: ../src/guestfs-actions.pod:1829
7564 msgid "guestfs_fsck"
7568 #: ../src/guestfs-actions.pod:1831
7572 " guestfs_fsck (guestfs_h *g,\n"
7573 " const char *fstype,\n"
7574 " const char *device);\n"
7579 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7581 "This runs the filesystem checker (fsck) on C<device> which should have "
7582 "filesystem type C<fstype>."
7586 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7588 "The returned integer is the status. See L<fsck(8)> for the list of status "
7589 "codes from C<fsck>."
7593 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7594 msgid "Multiple status codes can be summed together."
7598 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7600 "A non-zero return code can mean \"success\", for example if errors have been "
7601 "corrected on the filesystem."
7605 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7606 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7610 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7612 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7616 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7617 msgid "(Added in 1.0.16)"
7621 #: ../src/guestfs-actions.pod:1868
7622 msgid "guestfs_get_append"
7626 #: ../src/guestfs-actions.pod:1870
7630 " guestfs_get_append (guestfs_h *g);\n"
7635 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7637 "Return the additional kernel options which are added to the guest kernel "
7642 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7643 msgid "If C<NULL> then no options are added."
7647 #: ../src/guestfs-actions.pod:1878
7649 "This function returns a string which may be NULL. There is no way to return "
7650 "an error from this function. The string is owned by the guest handle and "
7651 "must I<not> be freed."
7655 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927
7656 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758
7657 #: ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793
7658 #: ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557
7659 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7660 msgid "(Added in 1.0.26)"
7664 #: ../src/guestfs-actions.pod:1884
7665 msgid "guestfs_get_autosync"
7669 #: ../src/guestfs-actions.pod:1886
7673 " guestfs_get_autosync (guestfs_h *g);\n"
7678 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7679 msgid "Get the autosync flag."
7683 #: ../src/guestfs-actions.pod:1895
7684 msgid "guestfs_get_direct"
7688 #: ../src/guestfs-actions.pod:1897
7692 " guestfs_get_direct (guestfs_h *g);\n"
7697 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7698 msgid "Return the direct appliance mode flag."
7702 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7703 msgid "(Added in 1.0.72)"
7707 #: ../src/guestfs-actions.pod:1906
7708 msgid "guestfs_get_e2label"
7712 #: ../src/guestfs-actions.pod:1908
7716 " guestfs_get_e2label (guestfs_h *g,\n"
7717 " const char *device);\n"
7722 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7724 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7728 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7730 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7734 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7735 #: ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7736 msgid "(Added in 1.0.15)"
7740 #: ../src/guestfs-actions.pod:1927
7741 msgid "guestfs_get_e2uuid"
7745 #: ../src/guestfs-actions.pod:1929
7749 " guestfs_get_e2uuid (guestfs_h *g,\n"
7750 " const char *device);\n"
7755 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7757 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7761 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7763 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7767 #: ../src/guestfs-actions.pod:1948
7768 msgid "guestfs_get_memsize"
7772 #: ../src/guestfs-actions.pod:1950
7776 " guestfs_get_memsize (guestfs_h *g);\n"
7781 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7783 "This gets the memory size in megabytes allocated to the qemu subprocess."
7787 #: ../src/guestfs-actions.pod:1956
7789 "If C<guestfs_set_memsize> was not called on this handle, and if "
7790 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7791 "value for memsize."
7795 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7796 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591
7797 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7798 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7800 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7804 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079
7805 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213
7806 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244
7807 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274
7808 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489
7809 #: ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7810 msgid "(Added in 1.0.55)"
7814 #: ../src/guestfs-actions.pod:1967
7815 msgid "guestfs_get_network"
7819 #: ../src/guestfs-actions.pod:1969
7823 " guestfs_get_network (guestfs_h *g);\n"
7828 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7829 msgid "This returns the enable network flag."
7833 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7834 msgid "(Added in 1.5.4)"
7838 #: ../src/guestfs-actions.pod:1978
7839 msgid "guestfs_get_path"
7843 #: ../src/guestfs-actions.pod:1980
7847 " guestfs_get_path (guestfs_h *g);\n"
7852 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7853 msgid "Return the current search path."
7857 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7859 "This is always non-NULL. If it wasn't set already, then this will return "
7864 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7866 "This function returns a string, or NULL on error. The string is owned by "
7867 "the guest handle and must I<not> be freed."
7871 #: ../src/guestfs-actions.pod:1993
7872 msgid "guestfs_get_pid"
7876 #: ../src/guestfs-actions.pod:1995
7880 " guestfs_get_pid (guestfs_h *g);\n"
7885 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7887 "Return the process ID of the qemu subprocess. If there is no qemu "
7888 "subprocess, then this will return an error."
7892 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7893 msgid "This is an internal call used for debugging and testing."
7897 #: ../src/guestfs-actions.pod:2005
7898 msgid "(Added in 1.0.56)"
7902 #: ../src/guestfs-actions.pod:2007
7903 msgid "guestfs_get_qemu"
7907 #: ../src/guestfs-actions.pod:2009
7911 " guestfs_get_qemu (guestfs_h *g);\n"
7916 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7917 msgid "Return the current qemu binary."
7921 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7923 "This is always non-NULL. If it wasn't set already, then this will return "
7924 "the default qemu binary name."
7928 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7929 msgid "(Added in 1.0.6)"
7933 #: ../src/guestfs-actions.pod:2022
7934 msgid "guestfs_get_recovery_proc"
7938 #: ../src/guestfs-actions.pod:2024
7942 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7947 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7948 msgid "Return the recovery process enabled flag."
7952 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219
7953 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886
7954 #: ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857
7955 #: ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577
7956 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256
7957 #: ../src/guestfs-actions.pod:6438
7958 msgid "(Added in 1.0.77)"
7962 #: ../src/guestfs-actions.pod:2033
7963 msgid "guestfs_get_selinux"
7967 #: ../src/guestfs-actions.pod:2035
7971 " guestfs_get_selinux (guestfs_h *g);\n"
7976 #: ../src/guestfs-actions.pod:2038
7978 "This returns the current setting of the selinux flag which is passed to the "
7979 "appliance at boot time. See C<guestfs_set_selinux>."
7983 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7984 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7985 msgid "(Added in 1.0.67)"
7989 #: ../src/guestfs-actions.pod:2048
7990 msgid "guestfs_get_state"
7994 #: ../src/guestfs-actions.pod:2050
7998 " guestfs_get_state (guestfs_h *g);\n"
8003 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
8005 "This returns the current state as an opaque integer. This is only useful "
8006 "for printing debug and internal error messages."
8010 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022
8011 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112
8012 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:1398
8013 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8014 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8015 msgid "For more information on states, see L<guestfs(3)>."
8019 #: ../src/guestfs-actions.pod:2062
8020 msgid "guestfs_get_trace"
8024 #: ../src/guestfs-actions.pod:2064
8028 " guestfs_get_trace (guestfs_h *g);\n"
8033 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
8034 msgid "Return the command trace flag."
8038 #: ../src/guestfs-actions.pod:2073
8039 msgid "guestfs_get_umask"
8043 #: ../src/guestfs-actions.pod:2075
8047 " guestfs_get_umask (guestfs_h *g);\n"
8052 #: ../src/guestfs-actions.pod:2078
8054 "Return the current umask. By default the umask is C<022> unless it has been "
8055 "set by calling C<guestfs_umask>."
8059 #: ../src/guestfs-actions.pod:2085
8060 msgid "guestfs_get_verbose"
8064 #: ../src/guestfs-actions.pod:2087
8068 " guestfs_get_verbose (guestfs_h *g);\n"
8073 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
8074 msgid "This returns the verbose messages flag."
8078 #: ../src/guestfs-actions.pod:2096
8079 msgid "guestfs_getcon"
8083 #: ../src/guestfs-actions.pod:2098
8087 " guestfs_getcon (guestfs_h *g);\n"
8092 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
8093 msgid "This gets the SELinux security context of the daemon."
8097 #: ../src/guestfs-actions.pod:2103
8099 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8103 #: ../src/guestfs-actions.pod:2111
8104 msgid "guestfs_getxattrs"
8108 #: ../src/guestfs-actions.pod:2113
8111 " struct guestfs_xattr_list *\n"
8112 " guestfs_getxattrs (guestfs_h *g,\n"
8113 " const char *path);\n"
8118 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
8120 "This call lists the extended attributes of the file or directory C<path>."
8124 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
8126 "At the system call level, this is a combination of the L<listxattr(2)> and "
8127 "L<getxattr(2)> calls."
8131 #: ../src/guestfs-actions.pod:2123
8132 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8136 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231
8137 #: ../src/guestfs-actions.pod:3882
8139 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8140 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8144 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235
8145 #: ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436
8146 #: ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669
8147 #: ../src/guestfs-actions.pod:6994
8148 msgid "(Added in 1.0.59)"
8152 #: ../src/guestfs-actions.pod:2131
8153 msgid "guestfs_glob_expand"
8157 #: ../src/guestfs-actions.pod:2133
8161 " guestfs_glob_expand (guestfs_h *g,\n"
8162 " const char *pattern);\n"
8167 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
8169 "This command searches for all the pathnames matching C<pattern> according to "
8170 "the wildcard expansion rules used by the shell."
8174 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
8176 "If no paths match, then this returns an empty list (note: not an error)."
8180 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
8182 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8183 "GLOB_BRACE>. See that manual page for more details."
8187 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834
8188 #: ../src/guestfs-actions.pod:5851
8189 msgid "(Added in 1.0.50)"
8193 #: ../src/guestfs-actions.pod:2154
8194 msgid "guestfs_grep"
8198 #: ../src/guestfs-actions.pod:2156
8202 " guestfs_grep (guestfs_h *g,\n"
8203 " const char *regex,\n"
8204 " const char *path);\n"
8209 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
8210 msgid "This calls the external C<grep> program and returns the matching lines."
8214 #: ../src/guestfs-actions.pod:2173
8215 msgid "guestfs_grepi"
8219 #: ../src/guestfs-actions.pod:2175
8223 " guestfs_grepi (guestfs_h *g,\n"
8224 " const char *regex,\n"
8225 " const char *path);\n"
8230 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
8232 "This calls the external C<grep -i> program and returns the matching lines."
8236 #: ../src/guestfs-actions.pod:2192
8237 msgid "guestfs_grub_install"
8241 #: ../src/guestfs-actions.pod:2194
8245 " guestfs_grub_install (guestfs_h *g,\n"
8246 " const char *root,\n"
8247 " const char *device);\n"
8252 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8254 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8255 "the root directory being C<root>."
8259 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8261 "Note: If grub-install reports the error \"No suitable drive was found in the "
8262 "generated device map.\" it may be that you need to create a C</boot/grub/"
8263 "device.map> file first that contains the mapping between grub device names "
8264 "and Linux device names. It is usually sufficient to create a file "
8269 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8277 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8278 msgid "replacing C</dev/vda> with the name of the installation device."
8282 #: ../src/guestfs-actions.pod:2215
8283 msgid "(Added in 1.0.17)"
8287 #: ../src/guestfs-actions.pod:2217
8288 msgid "guestfs_head"
8292 #: ../src/guestfs-actions.pod:2219
8296 " guestfs_head (guestfs_h *g,\n"
8297 " const char *path);\n"
8302 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8304 "This command returns up to the first 10 lines of a file as a list of strings."
8308 #: ../src/guestfs-actions.pod:2235
8309 msgid "guestfs_head_n"
8313 #: ../src/guestfs-actions.pod:2237
8317 " guestfs_head_n (guestfs_h *g,\n"
8319 " const char *path);\n"
8324 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8326 "If the parameter C<nrlines> is a positive number, this returns the first "
8327 "C<nrlines> lines of the file C<path>."
8331 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8333 "If the parameter C<nrlines> is a negative number, this returns lines from "
8334 "the file C<path>, excluding the last C<nrlines> lines."
8338 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131
8339 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8340 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8344 #: ../src/guestfs-actions.pod:2259
8345 msgid "guestfs_hexdump"
8349 #: ../src/guestfs-actions.pod:2261
8353 " guestfs_hexdump (guestfs_h *g,\n"
8354 " const char *path);\n"
8359 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8361 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8362 "readable, canonical hex dump of the file."
8366 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915
8367 #: ../src/guestfs-actions.pod:5970
8368 msgid "(Added in 1.0.22)"
8372 #: ../src/guestfs-actions.pod:2276
8373 msgid "guestfs_initrd_cat"
8377 #: ../src/guestfs-actions.pod:2278
8381 " guestfs_initrd_cat (guestfs_h *g,\n"
8382 " const char *initrdpath,\n"
8383 " const char *filename,\n"
8384 " size_t *size_r);\n"
8389 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8391 "This command unpacks the file C<filename> from the initrd file called "
8392 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8397 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8399 "For example, in guestfish you could use the following command to examine the "
8400 "boot script (usually called C</init>) contained in a Linux initrd or "
8405 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8408 " initrd-cat /boot/initrd-<version>.img init\n"
8413 #: ../src/guestfs-actions.pod:2294
8414 msgid "See also C<guestfs_initrd_list>."
8418 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850
8419 #: ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8421 "This function returns a buffer, or NULL on error. The size of the returned "
8422 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8427 #: ../src/guestfs-actions.pod:2305
8428 msgid "guestfs_initrd_list"
8432 #: ../src/guestfs-actions.pod:2307
8436 " guestfs_initrd_list (guestfs_h *g,\n"
8437 " const char *path);\n"
8442 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8443 msgid "This command lists out files contained in an initrd."
8447 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8449 "The files are listed without any initial C</> character. The files are "
8450 "listed in the order they appear (not necessarily alphabetical). Directory "
8451 "names are listed as separate items."
8455 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8457 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8458 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8463 #: ../src/guestfs-actions.pod:2327
8464 msgid "guestfs_inotify_add_watch"
8468 #: ../src/guestfs-actions.pod:2329
8472 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8473 " const char *path,\n"
8479 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8480 msgid "Watch C<path> for the events listed in C<mask>."
8484 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8486 "Note that if C<path> is a directory then events within that directory are "
8487 "watched, but this does I<not> happen recursively (in subdirectories)."
8491 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8493 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8494 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8498 #: ../src/guestfs-actions.pod:2348
8499 msgid "guestfs_inotify_close"
8503 #: ../src/guestfs-actions.pod:2350
8507 " guestfs_inotify_close (guestfs_h *g);\n"
8512 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8514 "This closes the inotify handle which was previously opened by inotify_init. "
8515 "It removes all watches, throws away any pending events, and deallocates all "
8520 #: ../src/guestfs-actions.pod:2361
8521 msgid "guestfs_inotify_files"
8525 #: ../src/guestfs-actions.pod:2363
8529 " guestfs_inotify_files (guestfs_h *g);\n"
8534 #: ../src/guestfs-actions.pod:2366
8536 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8537 "returns a list of pathnames of objects that were touched. The returned "
8538 "pathnames are sorted and deduplicated."
8542 #: ../src/guestfs-actions.pod:2376
8543 msgid "guestfs_inotify_init"
8547 #: ../src/guestfs-actions.pod:2378
8551 " guestfs_inotify_init (guestfs_h *g,\n"
8552 " int maxevents);\n"
8557 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8559 "This command creates a new inotify handle. The inotify subsystem can be "
8560 "used to notify events which happen to objects in the guest filesystem."
8564 #: ../src/guestfs-actions.pod:2386
8566 "C<maxevents> is the maximum number of events which will be queued up between "
8567 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8568 "passed as C<0>, then the kernel (or previously set) default is used. For "
8569 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8570 "throws away events, but records the fact that it threw them away by setting "
8571 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8572 "C<guestfs_inotify_read>)."
8576 #: ../src/guestfs-actions.pod:2396
8578 "Before any events are generated, you have to add some watches to the "
8579 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8580 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8584 #: ../src/guestfs-actions.pod:2402
8586 "Queued up events should be read periodically by calling "
8587 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8588 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8589 "often enough then you risk the internal queue overflowing."
8593 #: ../src/guestfs-actions.pod:2409
8595 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8596 "This also removes any watches automatically."
8600 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8602 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8603 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8604 "that there is one global inotify handle per libguestfs instance."
8608 #: ../src/guestfs-actions.pod:2422
8609 msgid "guestfs_inotify_read"
8613 #: ../src/guestfs-actions.pod:2424
8616 " struct guestfs_inotify_event_list *\n"
8617 " guestfs_inotify_read (guestfs_h *g);\n"
8622 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8624 "Return the complete queue of events that have happened since the previous "
8629 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8630 msgid "If no events have happened, this returns an empty list."
8634 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8636 "I<Note>: In order to make sure that all events have been read, you must call "
8637 "this function repeatedly until it returns an empty list. The reason is that "
8638 "the call will read events up to the maximum appliance-to-host message size "
8639 "and leave remaining events in the queue."
8643 #: ../src/guestfs-actions.pod:2438
8645 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8646 "there was an error. I<The caller must call "
8647 "C<guestfs_free_inotify_event_list> after use>."
8651 #: ../src/guestfs-actions.pod:2444
8652 msgid "guestfs_inotify_rm_watch"
8656 #: ../src/guestfs-actions.pod:2446
8660 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8666 #: ../src/guestfs-actions.pod:2450
8668 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8672 #: ../src/guestfs-actions.pod:2457
8673 msgid "guestfs_inspect_get_arch"
8677 #: ../src/guestfs-actions.pod:2459
8681 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8682 " const char *root);\n"
8687 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8688 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593
8689 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640
8690 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694
8691 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750
8692 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834
8693 #: ../src/guestfs-actions.pod:2857
8695 "This function should only be called with a root device string as returned by "
8696 "C<guestfs_inspect_os>."
8700 #: ../src/guestfs-actions.pod:2466
8702 "This returns the architecture of the inspected operating system. The "
8703 "possible return values are listed under C<guestfs_file_architecture>."
8707 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8709 "If the architecture could not be determined, then the string C<unknown> is "
8714 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554
8715 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628
8716 #: ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739
8717 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780
8718 #: ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844
8719 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989
8720 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8721 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8722 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8723 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8724 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8725 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8726 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8730 #: ../src/guestfs-actions.pod:2480
8731 msgid "guestfs_inspect_get_distro"
8735 #: ../src/guestfs-actions.pod:2482
8739 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8740 " const char *root);\n"
8745 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8747 "This returns the distro (distribution) of the inspected operating system."
8751 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8752 msgid "Currently defined distros are:"
8756 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8757 msgid "\"archlinux\""
8761 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8766 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8771 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8776 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8781 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8786 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8791 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8796 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8797 msgid "\"linuxmint\""
8801 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8806 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8807 msgid "\"mandriva\""
8811 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8816 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8821 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8826 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8831 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8836 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8837 msgid "\"redhat-based\""
8841 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8842 msgid "Some Red Hat-derived distro."
8846 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8851 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8852 msgid "Red Hat Enterprise Linux and some derivatives."
8856 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8861 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8866 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812
8867 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8872 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8873 msgid "The distro could not be determined."
8877 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804
8878 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8883 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8885 "Windows does not have distributions. This string is returned if the OS type "
8890 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818
8891 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8893 "Future versions of libguestfs may return other strings here. The caller "
8894 "should be prepared to handle any string."
8898 #: ../src/guestfs-actions.pod:2561
8899 msgid "guestfs_inspect_get_filesystems"
8903 #: ../src/guestfs-actions.pod:2563
8907 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8908 " const char *root);\n"
8913 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8915 "This returns a list of all the filesystems that we think are associated with "
8916 "this operating system. This includes the root filesystem, other ordinary "
8917 "filesystems, and non-mounted devices like swap partitions."
8921 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8923 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8924 "to be shared between operating systems."
8928 #: ../src/guestfs-actions.pod:2578
8930 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8931 "C<guestfs_inspect_get_mountpoints>."
8935 #: ../src/guestfs-actions.pod:2587
8936 msgid "guestfs_inspect_get_hostname"
8940 #: ../src/guestfs-actions.pod:2589
8944 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8945 " const char *root);\n"
8950 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8952 "This function returns the hostname of the operating system as found by "
8953 "inspection of the guest's configuration files."
8957 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8959 "If the hostname could not be determined, then the string C<unknown> is "
8964 #: ../src/guestfs-actions.pod:2607
8965 msgid "guestfs_inspect_get_major_version"
8969 #: ../src/guestfs-actions.pod:2609
8973 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8974 " const char *root);\n"
8979 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8981 "This returns the major version number of the inspected operating system."
8985 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
8987 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8988 "popular public names used by the operating system. Notably the operating "
8989 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8990 "1). You can find out the real versions corresponding to releases of Windows "
8991 "by consulting Wikipedia or MSDN."
8995 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646
8996 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8997 msgid "If the version could not be determined, then C<0> is returned."
9001 #: ../src/guestfs-actions.pod:2634
9002 msgid "guestfs_inspect_get_minor_version"
9006 #: ../src/guestfs-actions.pod:2636
9010 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9011 " const char *root);\n"
9016 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
9018 "This returns the minor version number of the inspected operating system."
9022 #: ../src/guestfs-actions.pod:2648
9024 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9025 "C<guestfs_inspect_get_major_version>."
9029 #: ../src/guestfs-actions.pod:2655
9030 msgid "guestfs_inspect_get_mountpoints"
9034 #: ../src/guestfs-actions.pod:2657
9038 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9039 " const char *root);\n"
9044 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
9046 "This returns a hash of where we think the filesystems associated with this "
9047 "operating system should be mounted. Callers should note that this is at "
9048 "best an educated guess made by reading configuration files such as C</etc/"
9053 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
9055 "Each element in the returned hashtable has a key which is the path of the "
9056 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9057 "mounted there (eg. C</dev/sda1>)."
9061 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
9063 "Non-mounted devices such as swap devices are I<not> returned in this list."
9067 #: ../src/guestfs-actions.pod:2677
9069 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9070 "C<guestfs_inspect_get_filesystems>."
9074 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288
9075 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
9077 "This function returns a NULL-terminated array of strings, or NULL if there "
9078 "was an error. The array of strings will always have length C<2n+1>, where "
9079 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9080 "caller must free the strings and the array after use>."
9084 #: ../src/guestfs-actions.pod:2688
9085 msgid "guestfs_inspect_get_package_format"
9089 #: ../src/guestfs-actions.pod:2690
9093 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9094 " const char *root);\n"
9099 #: ../src/guestfs-actions.pod:2697
9101 "This function and C<guestfs_inspect_get_package_management> return the "
9102 "package format and package management tool used by the inspected operating "
9103 "system. For example for Fedora these functions would return C<rpm> (package "
9104 "format) and C<yum> (package management)."
9108 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
9110 "This returns the string C<unknown> if we could not determine the package "
9111 "format I<or> if the operating system does not have a real packaging system "
9116 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
9118 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9119 "Future versions of libguestfs may return other strings."
9123 #: ../src/guestfs-actions.pod:2715
9124 msgid "guestfs_inspect_get_package_management"
9128 #: ../src/guestfs-actions.pod:2717
9132 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9133 " const char *root);\n"
9138 #: ../src/guestfs-actions.pod:2724
9140 "C<guestfs_inspect_get_package_format> and this function return the package "
9141 "format and package management tool used by the inspected operating system. "
9142 "For example for Fedora these functions would return C<rpm> (package format) "
9143 "and C<yum> (package management)."
9147 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
9149 "This returns the string C<unknown> if we could not determine the package "
9150 "management tool I<or> if the operating system does not have a real packaging "
9151 "system (eg. Windows)."
9155 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
9157 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9158 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9159 "libguestfs may return other strings."
9163 #: ../src/guestfs-actions.pod:2744
9164 msgid "guestfs_inspect_get_product_name"
9168 #: ../src/guestfs-actions.pod:2746
9172 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9173 " const char *root);\n"
9178 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
9180 "This returns the product name of the inspected operating system. The "
9181 "product name is generally some freeform string which can be displayed to the "
9182 "user, but should not be parsed by programs."
9186 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
9188 "If the product name could not be determined, then the string C<unknown> is "
9193 #: ../src/guestfs-actions.pod:2768
9194 msgid "guestfs_inspect_get_roots"
9198 #: ../src/guestfs-actions.pod:2770
9202 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9207 #: ../src/guestfs-actions.pod:2773
9209 "This function is a convenient way to get the list of root devices, as "
9210 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9211 "the whole inspection process."
9215 #: ../src/guestfs-actions.pod:2777
9217 "This returns an empty list if either no root devices were found or the "
9218 "caller has not called C<guestfs_inspect_os>."
9222 #: ../src/guestfs-actions.pod:2786
9223 msgid "guestfs_inspect_get_type"
9227 #: ../src/guestfs-actions.pod:2788
9231 " guestfs_inspect_get_type (guestfs_h *g,\n"
9232 " const char *root);\n"
9237 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
9239 "This returns the type of the inspected operating system. Currently defined "
9244 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
9249 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
9250 msgid "Any Linux-based operating system."
9254 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
9255 msgid "Any Microsoft Windows operating system."
9259 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
9264 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
9269 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
9270 msgid "The operating system type could not be determined."
9274 #: ../src/guestfs-actions.pod:2828
9275 msgid "guestfs_inspect_get_windows_systemroot"
9279 #: ../src/guestfs-actions.pod:2830
9283 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9284 " const char *root);\n"
9289 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
9291 "This returns the Windows systemroot of the inspected guest. The systemroot "
9292 "is a directory path such as C</WINDOWS>."
9296 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
9298 "This call assumes that the guest is Windows and that the systemroot could be "
9299 "determined by inspection. If this is not the case then an error is returned."
9303 #: ../src/guestfs-actions.pod:2849
9304 msgid "(Added in 1.5.25)"
9308 #: ../src/guestfs-actions.pod:2851
9309 msgid "guestfs_inspect_list_applications"
9313 #: ../src/guestfs-actions.pod:2853
9316 " struct guestfs_application_list *\n"
9317 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9318 " const char *root);\n"
9323 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
9324 msgid "Return the list of applications installed in the operating system."
9328 #: ../src/guestfs-actions.pod:2862
9330 "I<Note:> This call works differently from other parts of the inspection "
9331 "API. You have to call C<guestfs_inspect_os>, then "
9332 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9333 "this. Listing applications is a significantly more difficult operation "
9334 "which requires access to the full filesystem. Also note that unlike the "
9335 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9336 "the libguestfs handle, this call actually reads parts of the mounted "
9337 "filesystems during the call."
9341 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
9343 "This returns an empty list if the inspection code was not able to determine "
9344 "the list of applications."
9348 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
9349 msgid "The application structure contains the following fields:"
9353 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
9358 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
9360 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9361 "guests, this is the package name."
9365 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
9366 msgid "C<app_display_name>"
9370 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
9372 "The display name of the application, sometimes localized to the install "
9373 "language of the guest operating system."
9377 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
9379 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9380 "to display something can use C<app_name> instead."
9384 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
9385 msgid "C<app_epoch>"
9389 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
9391 "For package managers which use epochs, this contains the epoch of the "
9392 "package (an integer). If unavailable, this is returned as C<0>."
9396 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
9397 msgid "C<app_version>"
9401 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
9403 "The version string of the application or package. If unavailable this is "
9404 "returned as an empty string C<\"\">."
9408 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
9409 msgid "C<app_release>"
9413 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
9415 "The release string of the application or package, for package managers that "
9416 "use this. If unavailable this is returned as an empty string C<\"\">."
9420 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
9421 msgid "C<app_install_path>"
9425 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
9427 "The installation path of the application (on operating systems such as "
9428 "Windows which use installation paths). This path is in the format used by "
9429 "the guest operating system, it is not a libguestfs path."
9433 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
9434 msgid "If unavailable this is returned as an empty string C<\"\">."
9438 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
9439 msgid "C<app_trans_path>"
9443 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9445 "The install path translated into a libguestfs path. If unavailable this is "
9446 "returned as an empty string C<\"\">."
9450 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9451 msgid "C<app_publisher>"
9455 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9457 "The name of the publisher of the application, for package managers that use "
9458 "this. If unavailable this is returned as an empty string C<\"\">."
9462 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9467 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9469 "The URL (eg. upstream URL) of the application. If unavailable this is "
9470 "returned as an empty string C<\"\">."
9474 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9475 msgid "C<app_source_package>"
9479 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9481 "For packaging systems which support this, the name of the source package. "
9482 "If unavailable this is returned as an empty string C<\"\">."
9486 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9487 msgid "C<app_summary>"
9491 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9493 "A short (usually one line) description of the application or package. If "
9494 "unavailable this is returned as an empty string C<\"\">."
9498 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9499 msgid "C<app_description>"
9503 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9505 "A longer description of the application or package. If unavailable this is "
9506 "returned as an empty string C<\"\">."
9510 #: ../src/guestfs-actions.pod:2952
9512 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9513 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9518 #: ../src/guestfs-actions.pod:2956
9519 msgid "guestfs_inspect_os"
9523 #: ../src/guestfs-actions.pod:2958
9527 " guestfs_inspect_os (guestfs_h *g);\n"
9532 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9534 "This function uses other libguestfs functions and certain heuristics to "
9535 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9536 "for operating systems."
9540 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9541 msgid "The list returned is empty if no operating systems were found."
9545 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9547 "If one operating system was found, then this returns a list with a single "
9548 "element, which is the name of the root filesystem of this operating system. "
9549 "It is also possible for this function to return a list containing more than "
9550 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9551 "element being the root filesystem of one of the operating systems."
9555 #: ../src/guestfs-actions.pod:2974
9557 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9558 "functions in order to query further information about each operating system, "
9559 "such as the name and version."
9563 #: ../src/guestfs-actions.pod:2979
9565 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9566 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9567 "the contents. This should be called with no disks currently mounted. The "
9568 "function may also use Augeas, so any existing Augeas handle will be closed."
9572 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9574 "This function cannot decrypt encrypted disks. The caller must do that first "
9575 "(supplying the necessary keys) if the disk is encrypted."
9579 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246
9580 #: ../src/guestfs-actions.pod:3308
9581 msgid "See also C<guestfs_list_filesystems>."
9585 #: ../src/guestfs-actions.pod:2999
9586 msgid "guestfs_is_blockdev"
9590 #: ../src/guestfs-actions.pod:3001
9594 " guestfs_is_blockdev (guestfs_h *g,\n"
9595 " const char *path);\n"
9600 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9602 "This returns C<true> if and only if there is a block device with the given "
9607 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037
9608 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082
9609 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154
9610 #: ../src/guestfs-actions.pod:3169
9611 msgid "See also C<guestfs_stat>."
9615 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041
9616 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158
9617 #: ../src/guestfs-actions.pod:3173
9618 msgid "(Added in 1.5.10)"
9622 #: ../src/guestfs-actions.pod:3014
9623 msgid "guestfs_is_busy"
9627 #: ../src/guestfs-actions.pod:3016
9631 " guestfs_is_busy (guestfs_h *g);\n"
9636 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9638 "This returns true iff this handle is busy processing a command (in the "
9643 #: ../src/guestfs-actions.pod:3028
9644 msgid "guestfs_is_chardev"
9648 #: ../src/guestfs-actions.pod:3030
9652 " guestfs_is_chardev (guestfs_h *g,\n"
9653 " const char *path);\n"
9658 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9660 "This returns C<true> if and only if there is a character device with the "
9661 "given C<path> name."
9665 #: ../src/guestfs-actions.pod:3043
9666 msgid "guestfs_is_config"
9670 #: ../src/guestfs-actions.pod:3045
9674 " guestfs_is_config (guestfs_h *g);\n"
9679 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9681 "This returns true iff this handle is being configured (in the C<CONFIG> "
9686 #: ../src/guestfs-actions.pod:3057
9687 msgid "guestfs_is_dir"
9691 #: ../src/guestfs-actions.pod:3059
9695 " guestfs_is_dir (guestfs_h *g,\n"
9696 " const char *path);\n"
9701 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9703 "This returns C<true> if and only if there is a directory with the given "
9704 "C<path> name. Note that it returns false for other objects like files."
9708 #: ../src/guestfs-actions.pod:3073
9709 msgid "guestfs_is_fifo"
9713 #: ../src/guestfs-actions.pod:3075
9717 " guestfs_is_fifo (guestfs_h *g,\n"
9718 " const char *path);\n"
9723 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9725 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9726 "given C<path> name."
9730 #: ../src/guestfs-actions.pod:3088
9731 msgid "guestfs_is_file"
9735 #: ../src/guestfs-actions.pod:3090
9739 " guestfs_is_file (guestfs_h *g,\n"
9740 " const char *path);\n"
9745 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9747 "This returns C<true> if and only if there is a regular file with the given "
9748 "C<path> name. Note that it returns false for other objects like directories."
9752 #: ../src/guestfs-actions.pod:3104
9753 msgid "guestfs_is_launching"
9757 #: ../src/guestfs-actions.pod:3106
9761 " guestfs_is_launching (guestfs_h *g);\n"
9766 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9768 "This returns true iff this handle is launching the subprocess (in the "
9769 "C<LAUNCHING> state)."
9773 #: ../src/guestfs-actions.pod:3118
9774 msgid "guestfs_is_lv"
9778 #: ../src/guestfs-actions.pod:3120
9782 " guestfs_is_lv (guestfs_h *g,\n"
9783 " const char *device);\n"
9788 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9790 "This command tests whether C<device> is a logical volume, and returns true "
9791 "iff this is the case."
9795 #: ../src/guestfs-actions.pod:3131
9796 msgid "guestfs_is_ready"
9800 #: ../src/guestfs-actions.pod:3133
9804 " guestfs_is_ready (guestfs_h *g);\n"
9809 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9811 "This returns true iff this handle is ready to accept commands (in the "
9816 #: ../src/guestfs-actions.pod:3145
9817 msgid "guestfs_is_socket"
9821 #: ../src/guestfs-actions.pod:3147
9825 " guestfs_is_socket (guestfs_h *g,\n"
9826 " const char *path);\n"
9831 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9833 "This returns C<true> if and only if there is a Unix domain socket with the "
9834 "given C<path> name."
9838 #: ../src/guestfs-actions.pod:3160
9839 msgid "guestfs_is_symlink"
9843 #: ../src/guestfs-actions.pod:3162
9847 " guestfs_is_symlink (guestfs_h *g,\n"
9848 " const char *path);\n"
9853 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9855 "This returns C<true> if and only if there is a symbolic link with the given "
9860 #: ../src/guestfs-actions.pod:3175
9861 msgid "guestfs_kill_subprocess"
9865 #: ../src/guestfs-actions.pod:3177
9869 " guestfs_kill_subprocess (guestfs_h *g);\n"
9874 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9875 msgid "This kills the qemu subprocess. You should never need to call this."
9879 #: ../src/guestfs-actions.pod:3186
9880 msgid "guestfs_launch"
9884 #: ../src/guestfs-actions.pod:3188
9888 " guestfs_launch (guestfs_h *g);\n"
9893 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9895 "Internally libguestfs is implemented by running a virtual machine using "
9900 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9902 "You should call this after configuring the handle (eg. adding drives) but "
9903 "before performing any actions."
9907 #: ../src/guestfs-actions.pod:3201
9908 msgid "guestfs_lchown"
9912 #: ../src/guestfs-actions.pod:3203
9916 " guestfs_lchown (guestfs_h *g,\n"
9919 " const char *path);\n"
9924 #: ../src/guestfs-actions.pod:3209
9926 "Change the file owner to C<owner> and group to C<group>. This is like "
9927 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9928 "changed, not the target."
9932 #: ../src/guestfs-actions.pod:3221
9933 msgid "guestfs_lgetxattrs"
9937 #: ../src/guestfs-actions.pod:3223
9940 " struct guestfs_xattr_list *\n"
9941 " guestfs_lgetxattrs (guestfs_h *g,\n"
9942 " const char *path);\n"
9947 #: ../src/guestfs-actions.pod:3227
9949 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9950 "then it returns the extended attributes of the link itself."
9954 #: ../src/guestfs-actions.pod:3237
9955 msgid "guestfs_list_devices"
9959 #: ../src/guestfs-actions.pod:3239
9963 " guestfs_list_devices (guestfs_h *g);\n"
9968 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9969 msgid "List all the block devices."
9973 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9974 msgid "The full block device names are returned, eg. C</dev/sda>."
9978 #: ../src/guestfs-actions.pod:3254
9979 msgid "guestfs_list_filesystems"
9983 #: ../src/guestfs-actions.pod:3256
9987 " guestfs_list_filesystems (guestfs_h *g);\n"
9992 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
9994 "This inspection command looks for filesystems on partitions, block devices "
9995 "and logical volumes, returning a list of devices containing filesystems and "
10000 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
10002 "The return value is a hash, where the keys are the devices containing "
10003 "filesystems, and the values are the filesystem types. For example:"
10007 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
10010 " \"/dev/sda1\" => \"ntfs\"\n"
10011 " \"/dev/sda2\" => \"ext2\"\n"
10012 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10013 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10018 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
10020 "The value can have the special value \"unknown\", meaning the content of the "
10021 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10025 #: ../src/guestfs-actions.pod:3276
10027 "This command runs other libguestfs commands, which might include "
10028 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10029 "soon after launch and only when nothing is mounted."
10033 #: ../src/guestfs-actions.pod:3280
10035 "Not all of the filesystems returned will be mountable. In particular, swap "
10036 "partitions are returned in the list. Also this command does not check that "
10037 "each filesystem found is valid and mountable, and some filesystems might be "
10038 "mountable but require special options. Filesystems may not all belong to a "
10039 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10043 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
10044 msgid "(Added in 1.5.15)"
10048 #: ../src/guestfs-actions.pod:3296
10049 msgid "guestfs_list_partitions"
10053 #: ../src/guestfs-actions.pod:3298
10057 " guestfs_list_partitions (guestfs_h *g);\n"
10062 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
10063 msgid "List all the partitions detected on all block devices."
10067 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
10068 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10072 #: ../src/guestfs-actions.pod:3305
10074 "This does not return logical volumes. For that you will need to call "
10079 #: ../src/guestfs-actions.pod:3316
10084 #: ../src/guestfs-actions.pod:3318
10088 " guestfs_ll (guestfs_h *g,\n"
10089 " const char *directory);\n"
10094 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
10096 "List the files in C<directory> (relative to the root directory, there is no "
10097 "cwd) in the format of 'ls -la'."
10101 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
10103 "This command is mostly useful for interactive sessions. It is I<not> "
10104 "intended that you try to parse the output string."
10108 #: ../src/guestfs-actions.pod:3333
10113 #: ../src/guestfs-actions.pod:3335
10117 " guestfs_ln (guestfs_h *g,\n"
10118 " const char *target,\n"
10119 " const char *linkname);\n"
10124 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
10125 msgid "This command creates a hard link using the C<ln> command."
10129 #: ../src/guestfs-actions.pod:3346
10130 msgid "guestfs_ln_f"
10134 #: ../src/guestfs-actions.pod:3348
10138 " guestfs_ln_f (guestfs_h *g,\n"
10139 " const char *target,\n"
10140 " const char *linkname);\n"
10145 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
10147 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10148 "option removes the link (C<linkname>) if it exists already."
10152 #: ../src/guestfs-actions.pod:3360
10153 msgid "guestfs_ln_s"
10157 #: ../src/guestfs-actions.pod:3362
10161 " guestfs_ln_s (guestfs_h *g,\n"
10162 " const char *target,\n"
10163 " const char *linkname);\n"
10168 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
10169 msgid "This command creates a symbolic link using the C<ln -s> command."
10173 #: ../src/guestfs-actions.pod:3373
10174 msgid "guestfs_ln_sf"
10178 #: ../src/guestfs-actions.pod:3375
10182 " guestfs_ln_sf (guestfs_h *g,\n"
10183 " const char *target,\n"
10184 " const char *linkname);\n"
10189 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
10191 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10192 "option removes the link (C<linkname>) if it exists already."
10196 #: ../src/guestfs-actions.pod:3387
10197 msgid "guestfs_lremovexattr"
10201 #: ../src/guestfs-actions.pod:3389
10205 " guestfs_lremovexattr (guestfs_h *g,\n"
10206 " const char *xattr,\n"
10207 " const char *path);\n"
10212 #: ../src/guestfs-actions.pod:3394
10214 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10215 "link, then it removes an extended attribute of the link itself."
10219 #: ../src/guestfs-actions.pod:3402
10224 #: ../src/guestfs-actions.pod:3404
10228 " guestfs_ls (guestfs_h *g,\n"
10229 " const char *directory);\n"
10234 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
10236 "List the files in C<directory> (relative to the root directory, there is no "
10237 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10241 #: ../src/guestfs-actions.pod:3412
10243 "This command is mostly useful for interactive sessions. Programs should "
10244 "probably use C<guestfs_readdir> instead."
10248 #: ../src/guestfs-actions.pod:3421
10249 msgid "guestfs_lsetxattr"
10253 #: ../src/guestfs-actions.pod:3423
10257 " guestfs_lsetxattr (guestfs_h *g,\n"
10258 " const char *xattr,\n"
10259 " const char *val,\n"
10261 " const char *path);\n"
10266 #: ../src/guestfs-actions.pod:3430
10268 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10269 "then it sets an extended attribute of the link itself."
10273 #: ../src/guestfs-actions.pod:3438
10274 msgid "guestfs_lstat"
10278 #: ../src/guestfs-actions.pod:3440
10281 " struct guestfs_stat *\n"
10282 " guestfs_lstat (guestfs_h *g,\n"
10283 " const char *path);\n"
10288 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871
10289 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10290 msgid "Returns file information for the given C<path>."
10294 #: ../src/guestfs-actions.pod:3446
10296 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10297 "link, then the link is stat-ed, not the file it refers to."
10301 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
10302 msgid "This is the same as the C<lstat(2)> system call."
10306 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
10308 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10309 "error. I<The caller must call C<guestfs_free_stat> after use>."
10313 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879
10314 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
10315 msgid "(Added in 0.9.2)"
10319 #: ../src/guestfs-actions.pod:3458
10320 msgid "guestfs_lstatlist"
10324 #: ../src/guestfs-actions.pod:3460
10327 " struct guestfs_stat_list *\n"
10328 " guestfs_lstatlist (guestfs_h *g,\n"
10329 " const char *path,\n"
10330 " char *const *names);\n"
10335 #: ../src/guestfs-actions.pod:3465
10337 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10338 "files, where all files are in the directory C<path>. C<names> is the list "
10339 "of files from this directory."
10343 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
10345 "On return you get a list of stat structs, with a one-to-one correspondence "
10346 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10347 "then the C<ino> field of that structure is set to C<-1>."
10351 #: ../src/guestfs-actions.pod:3474
10353 "This call is intended for programs that want to efficiently list a directory "
10354 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10355 "for a similarly efficient call for getting extended attributes. Very long "
10356 "directory listings might cause the protocol message size to be exceeded, "
10357 "causing this call to fail. The caller must split up such requests into "
10358 "smaller groups of names."
10362 #: ../src/guestfs-actions.pod:3482
10364 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10365 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10369 #: ../src/guestfs-actions.pod:3488
10370 msgid "guestfs_luks_add_key"
10374 #: ../src/guestfs-actions.pod:3490
10378 " guestfs_luks_add_key (guestfs_h *g,\n"
10379 " const char *device,\n"
10380 " const char *key,\n"
10381 " const char *newkey,\n"
10387 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
10389 "This command adds a new key on LUKS device C<device>. C<key> is any "
10390 "existing key, and is used to access the device. C<newkey> is the new key to "
10391 "add. C<keyslot> is the key slot that will be replaced."
10395 #: ../src/guestfs-actions.pod:3502
10397 "Note that if C<keyslot> already contains a key, then this command will "
10398 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10402 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548
10403 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591
10404 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
10406 "This function takes a key or passphrase parameter which could contain "
10407 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10412 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552
10413 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
10414 msgid "(Added in 1.5.2)"
10418 #: ../src/guestfs-actions.pod:3514
10419 msgid "guestfs_luks_close"
10423 #: ../src/guestfs-actions.pod:3516
10427 " guestfs_luks_close (guestfs_h *g,\n"
10428 " const char *device);\n"
10433 #: ../src/guestfs-actions.pod:3520
10435 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10436 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10437 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10438 "underlying block device."
10442 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627
10443 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696
10444 #: ../src/guestfs-actions.pod:3744
10445 msgid "(Added in 1.5.1)"
10449 #: ../src/guestfs-actions.pod:3530
10450 msgid "guestfs_luks_format"
10454 #: ../src/guestfs-actions.pod:3532
10458 " guestfs_luks_format (guestfs_h *g,\n"
10459 " const char *device,\n"
10460 " const char *key,\n"
10466 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10468 "This command erases existing data on C<device> and formats the device as a "
10469 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10470 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10474 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568
10475 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568
10476 #: ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706
10477 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755
10478 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433
10479 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10480 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10481 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10482 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10484 "B<This command is dangerous. Without careful use you can easily destroy all "
10489 #: ../src/guestfs-actions.pod:3554
10490 msgid "guestfs_luks_format_cipher"
10494 #: ../src/guestfs-actions.pod:3556
10498 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10499 " const char *device,\n"
10500 " const char *key,\n"
10502 " const char *cipher);\n"
10507 #: ../src/guestfs-actions.pod:3563
10509 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10510 "set the C<cipher> used."
10514 #: ../src/guestfs-actions.pod:3577
10515 msgid "guestfs_luks_kill_slot"
10519 #: ../src/guestfs-actions.pod:3579
10523 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10524 " const char *device,\n"
10525 " const char *key,\n"
10531 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10533 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10534 "device C<device>. C<key> must be one of the I<other> keys."
10538 #: ../src/guestfs-actions.pod:3597
10539 msgid "guestfs_luks_open"
10543 #: ../src/guestfs-actions.pod:3599
10547 " guestfs_luks_open (guestfs_h *g,\n"
10548 " const char *device,\n"
10549 " const char *key,\n"
10550 " const char *mapname);\n"
10555 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10557 "This command opens a block device which has been encrypted according to the "
10558 "Linux Unified Key Setup (LUKS) standard."
10562 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10563 msgid "C<device> is the encrypted block device or partition."
10567 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10569 "The caller must supply one of the keys associated with the LUKS block "
10570 "device, in the C<key> parameter."
10574 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10576 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10577 "writes to this block device are decrypted from and encrypted to the "
10578 "underlying C<device> respectively."
10582 #: ../src/guestfs-actions.pod:3617
10584 "If this block device contains LVM volume groups, then calling "
10585 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10590 #: ../src/guestfs-actions.pod:3629
10591 msgid "guestfs_luks_open_ro"
10595 #: ../src/guestfs-actions.pod:3631
10599 " guestfs_luks_open_ro (guestfs_h *g,\n"
10600 " const char *device,\n"
10601 " const char *key,\n"
10602 " const char *mapname);\n"
10607 #: ../src/guestfs-actions.pod:3637
10609 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10614 #: ../src/guestfs-actions.pod:3648
10615 msgid "guestfs_lvcreate"
10619 #: ../src/guestfs-actions.pod:3650
10623 " guestfs_lvcreate (guestfs_h *g,\n"
10624 " const char *logvol,\n"
10625 " const char *volgroup,\n"
10631 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10633 "This creates an LVM logical volume called C<logvol> on the volume group "
10634 "C<volgroup>, with C<size> megabytes."
10638 #: ../src/guestfs-actions.pod:3663
10639 msgid "guestfs_lvm_canonical_lv_name"
10643 #: ../src/guestfs-actions.pod:3665
10647 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10648 " const char *lvname);\n"
10653 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10655 "This converts alternative naming schemes for LVs that you might find to the "
10656 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10661 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10663 "This command returns an error if the C<lvname> parameter does not refer to a "
10668 #: ../src/guestfs-actions.pod:3676
10669 msgid "See also C<guestfs_is_lv>."
10673 #: ../src/guestfs-actions.pod:3681
10674 msgid "(Added in 1.5.24)"
10678 #: ../src/guestfs-actions.pod:3683
10679 msgid "guestfs_lvm_clear_filter"
10683 #: ../src/guestfs-actions.pod:3685
10687 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10692 #: ../src/guestfs-actions.pod:3688
10694 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10695 "see every block device."
10699 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733
10700 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10702 "This command also clears the LVM cache and performs a volume group scan."
10706 #: ../src/guestfs-actions.pod:3698
10707 msgid "guestfs_lvm_remove_all"
10711 #: ../src/guestfs-actions.pod:3700
10715 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10720 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10722 "This command removes all LVM logical volumes, volume groups and physical "
10727 #: ../src/guestfs-actions.pod:3713
10728 msgid "guestfs_lvm_set_filter"
10732 #: ../src/guestfs-actions.pod:3715
10736 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10737 " char *const *devices);\n"
10742 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10744 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10745 "block devices in the list C<devices>, and will ignore all other attached "
10750 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10752 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10753 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10754 "there are two types of duplication possible: either cloned PVs/VGs which "
10755 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10756 "same name. In normal operation you cannot create this situation, but you "
10757 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10758 "inside the LVM metadata."
10762 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10763 msgid "You can filter whole block devices or individual partitions."
10767 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10769 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10770 "filesystem), even if you are not filtering out that VG."
10774 #: ../src/guestfs-actions.pod:3746
10775 msgid "guestfs_lvremove"
10779 #: ../src/guestfs-actions.pod:3748
10783 " guestfs_lvremove (guestfs_h *g,\n"
10784 " const char *device);\n"
10789 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10791 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10792 "LV, such as C</dev/VG/LV>."
10796 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10798 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10803 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914
10804 #: ../src/guestfs-actions.pod:6644
10805 msgid "(Added in 1.0.13)"
10809 #: ../src/guestfs-actions.pod:3762
10810 msgid "guestfs_lvrename"
10814 #: ../src/guestfs-actions.pod:3764
10818 " guestfs_lvrename (guestfs_h *g,\n"
10819 " const char *logvol,\n"
10820 " const char *newlogvol);\n"
10825 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10826 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10830 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10831 msgid "(Added in 1.0.83)"
10835 #: ../src/guestfs-actions.pod:3775
10836 msgid "guestfs_lvresize"
10840 #: ../src/guestfs-actions.pod:3777
10844 " guestfs_lvresize (guestfs_h *g,\n"
10845 " const char *device,\n"
10851 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10853 "This resizes (expands or shrinks) an existing LVM logical volume to "
10854 "C<mbytes>. When reducing, data in the reduced part is lost."
10858 #: ../src/guestfs-actions.pod:3790
10859 msgid "guestfs_lvresize_free"
10863 #: ../src/guestfs-actions.pod:3792
10867 " guestfs_lvresize_free (guestfs_h *g,\n"
10868 " const char *lv,\n"
10874 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10876 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10877 "remaining free space in the volume group. Commonly you would call this with "
10878 "pc = 100 which expands the logical volume as much as possible, using all "
10879 "remaining free space in the volume group."
10883 #: ../src/guestfs-actions.pod:3805
10884 msgid "(Added in 1.3.3)"
10888 #: ../src/guestfs-actions.pod:3807
10889 msgid "guestfs_lvs"
10893 #: ../src/guestfs-actions.pod:3809
10897 " guestfs_lvs (guestfs_h *g);\n"
10902 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10904 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10909 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10911 "This returns a list of the logical volume device names (eg. C</dev/"
10912 "VolGroup00/LogVol00>)."
10916 #: ../src/guestfs-actions.pod:3818
10917 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10921 #: ../src/guestfs-actions.pod:3826
10922 msgid "guestfs_lvs_full"
10926 #: ../src/guestfs-actions.pod:3828
10929 " struct guestfs_lvm_lv_list *\n"
10930 " guestfs_lvs_full (guestfs_h *g);\n"
10935 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10937 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10938 "(8)> command. The \"full\" version includes all fields."
10942 #: ../src/guestfs-actions.pod:3834
10944 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10945 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10949 #: ../src/guestfs-actions.pod:3840
10950 msgid "guestfs_lvuuid"
10954 #: ../src/guestfs-actions.pod:3842
10958 " guestfs_lvuuid (guestfs_h *g,\n"
10959 " const char *device);\n"
10964 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10965 msgid "This command returns the UUID of the LVM LV C<device>."
10969 #: ../src/guestfs-actions.pod:3853
10970 msgid "guestfs_lxattrlist"
10974 #: ../src/guestfs-actions.pod:3855
10977 " struct guestfs_xattr_list *\n"
10978 " guestfs_lxattrlist (guestfs_h *g,\n"
10979 " const char *path,\n"
10980 " char *const *names);\n"
10985 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
10987 "This call allows you to get the extended attributes of multiple files, where "
10988 "all files are in the directory C<path>. C<names> is the list of files from "
10993 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
10995 "On return you get a flat list of xattr structs which must be interpreted "
10996 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10997 "C<attrval> in this struct is zero-length to indicate there was an error "
10998 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10999 "number (the number of following attributes for this file, which could be C<"
11000 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11001 "for the first named file. This repeats for the second and subsequent files."
11005 #: ../src/guestfs-actions.pod:3874
11007 "This call is intended for programs that want to efficiently list a directory "
11008 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11009 "a similarly efficient call for getting standard stats. Very long directory "
11010 "listings might cause the protocol message size to be exceeded, causing this "
11011 "call to fail. The caller must split up such requests into smaller groups of "
11016 #: ../src/guestfs-actions.pod:3888
11017 msgid "guestfs_mkdir"
11021 #: ../src/guestfs-actions.pod:3890
11025 " guestfs_mkdir (guestfs_h *g,\n"
11026 " const char *path);\n"
11031 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
11032 msgid "Create a directory named C<path>."
11036 #: ../src/guestfs-actions.pod:3900
11037 msgid "guestfs_mkdir_mode"
11041 #: ../src/guestfs-actions.pod:3902
11045 " guestfs_mkdir_mode (guestfs_h *g,\n"
11046 " const char *path,\n"
11052 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
11054 "This command creates a directory, setting the initial permissions of the "
11055 "directory to C<mode>."
11059 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
11061 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11062 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11067 #: ../src/guestfs-actions.pod:3914
11068 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11072 #: ../src/guestfs-actions.pod:3920
11073 msgid "guestfs_mkdir_p"
11077 #: ../src/guestfs-actions.pod:3922
11081 " guestfs_mkdir_p (guestfs_h *g,\n"
11082 " const char *path);\n"
11087 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
11089 "Create a directory named C<path>, creating any parent directories as "
11090 "necessary. This is like the C<mkdir -p> shell command."
11094 #: ../src/guestfs-actions.pod:3933
11095 msgid "guestfs_mkdtemp"
11099 #: ../src/guestfs-actions.pod:3935
11103 " guestfs_mkdtemp (guestfs_h *g,\n"
11104 " const char *template);\n"
11109 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
11111 "This command creates a temporary directory. The C<template> parameter "
11112 "should be a full pathname for the temporary directory name with the final "
11113 "six characters being \"XXXXXX\"."
11117 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
11119 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11120 "being suitable for Windows filesystems."
11124 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
11125 msgid "The name of the temporary directory that was created is returned."
11129 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
11130 msgid "The temporary directory is created with mode 0700 and is owned by root."
11134 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
11136 "The caller is responsible for deleting the temporary directory and its "
11137 "contents after use."
11141 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
11142 msgid "See also: L<mkdtemp(3)>"
11146 #: ../src/guestfs-actions.pod:3963
11147 msgid "guestfs_mke2fs_J"
11151 #: ../src/guestfs-actions.pod:3965
11155 " guestfs_mke2fs_J (guestfs_h *g,\n"
11156 " const char *fstype,\n"
11157 " int blocksize,\n"
11158 " const char *device,\n"
11159 " const char *journal);\n"
11164 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
11166 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11167 "C<journal>. It is equivalent to the command:"
11171 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
11174 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11179 #: ../src/guestfs-actions.pod:3978
11180 msgid "See also C<guestfs_mke2journal>."
11184 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000
11185 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034
11186 #: ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062
11187 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
11188 msgid "(Added in 1.0.68)"
11192 #: ../src/guestfs-actions.pod:3984
11193 msgid "guestfs_mke2fs_JL"
11197 #: ../src/guestfs-actions.pod:3986
11201 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11202 " const char *fstype,\n"
11203 " int blocksize,\n"
11204 " const char *device,\n"
11205 " const char *label);\n"
11210 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
11212 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11213 "the journal labeled C<label>."
11217 #: ../src/guestfs-actions.pod:3996
11218 msgid "See also C<guestfs_mke2journal_L>."
11222 #: ../src/guestfs-actions.pod:4002
11223 msgid "guestfs_mke2fs_JU"
11227 #: ../src/guestfs-actions.pod:4004
11231 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11232 " const char *fstype,\n"
11233 " int blocksize,\n"
11234 " const char *device,\n"
11235 " const char *uuid);\n"
11240 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
11242 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11243 "the journal with UUID C<uuid>."
11247 #: ../src/guestfs-actions.pod:4014
11248 msgid "See also C<guestfs_mke2journal_U>."
11252 #: ../src/guestfs-actions.pod:4020
11253 msgid "guestfs_mke2journal"
11257 #: ../src/guestfs-actions.pod:4022
11261 " guestfs_mke2journal (guestfs_h *g,\n"
11262 " int blocksize,\n"
11263 " const char *device);\n"
11268 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
11270 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11275 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
11278 " mke2fs -O journal_dev -b blocksize device\n"
11283 #: ../src/guestfs-actions.pod:4036
11284 msgid "guestfs_mke2journal_L"
11288 #: ../src/guestfs-actions.pod:4038
11292 " guestfs_mke2journal_L (guestfs_h *g,\n"
11293 " int blocksize,\n"
11294 " const char *label,\n"
11295 " const char *device);\n"
11300 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
11301 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11305 #: ../src/guestfs-actions.pod:4050
11306 msgid "guestfs_mke2journal_U"
11310 #: ../src/guestfs-actions.pod:4052
11314 " guestfs_mke2journal_U (guestfs_h *g,\n"
11315 " int blocksize,\n"
11316 " const char *uuid,\n"
11317 " const char *device);\n"
11322 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
11323 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11327 #: ../src/guestfs-actions.pod:4064
11328 msgid "guestfs_mkfifo"
11332 #: ../src/guestfs-actions.pod:4066
11336 " guestfs_mkfifo (guestfs_h *g,\n"
11338 " const char *path);\n"
11343 #: ../src/guestfs-actions.pod:4071
11345 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11346 "is just a convenient wrapper around C<guestfs_mknod>."
11350 #: ../src/guestfs-actions.pod:4081
11351 msgid "guestfs_mkfs"
11355 #: ../src/guestfs-actions.pod:4083
11359 " guestfs_mkfs (guestfs_h *g,\n"
11360 " const char *fstype,\n"
11361 " const char *device);\n"
11366 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
11368 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11369 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11373 #: ../src/guestfs-actions.pod:4096
11374 msgid "guestfs_mkfs_b"
11378 #: ../src/guestfs-actions.pod:4098
11382 " guestfs_mkfs_b (guestfs_h *g,\n"
11383 " const char *fstype,\n"
11384 " int blocksize,\n"
11385 " const char *device);\n"
11390 #: ../src/guestfs-actions.pod:4104
11392 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11393 "block size of the resulting filesystem. Supported block sizes depend on the "
11394 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11398 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
11400 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11405 #: ../src/guestfs-actions.pod:4116
11406 msgid "guestfs_mkmountpoint"
11410 #: ../src/guestfs-actions.pod:4118
11414 " guestfs_mkmountpoint (guestfs_h *g,\n"
11415 " const char *exemptpath);\n"
11420 #: ../src/guestfs-actions.pod:4122
11422 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11423 "that can be used to create extra mountpoints before mounting the first "
11428 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
11430 "These calls are I<only> necessary in some very limited circumstances, mainly "
11431 "the case where you want to mount a mix of unrelated and/or read-only "
11432 "filesystems together."
11436 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
11438 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11439 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11440 "inside that. You can unpack this as follows in guestfish:"
11444 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
11447 " add-ro Fedora-11-i686-Live.iso\n"
11449 " mkmountpoint /cd\n"
11450 " mkmountpoint /sqsh\n"
11451 " mkmountpoint /ext3fs\n"
11452 " mount /dev/sda /cd\n"
11453 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11454 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11459 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
11460 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11464 #: ../src/guestfs-actions.pod:4146
11466 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11467 "may get unexpected errors if you try to mix these calls. It is safest to "
11468 "manually unmount filesystems and remove mountpoints after use."
11472 #: ../src/guestfs-actions.pod:4150
11474 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11475 "first, so for this to work for manual mountpoints, you must ensure that the "
11476 "innermost mountpoints have the longest pathnames, as in the example code "
11481 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11483 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11487 #: ../src/guestfs-actions.pod:4157
11489 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11490 "means that C<guestfs_umount_all> is called when the handle is closed which "
11491 "can also trigger these issues."
11495 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422
11496 #: ../src/guestfs-actions.pod:5315
11497 msgid "(Added in 1.0.62)"
11501 #: ../src/guestfs-actions.pod:4165
11502 msgid "guestfs_mknod"
11506 #: ../src/guestfs-actions.pod:4167
11510 " guestfs_mknod (guestfs_h *g,\n"
11514 " const char *path);\n"
11519 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11521 "This call creates block or character special devices, or named pipes (FIFOs)."
11525 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11527 "The C<mode> parameter should be the mode, using the standard constants. "
11528 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11529 "used when creating block and character special devices."
11533 #: ../src/guestfs-actions.pod:4182
11535 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11536 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11537 "regular file). These constants are available in the standard Linux header "
11538 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11539 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11540 "the appropriate constant for you."
11544 #: ../src/guestfs-actions.pod:4196
11545 msgid "guestfs_mknod_b"
11549 #: ../src/guestfs-actions.pod:4198
11553 " guestfs_mknod_b (guestfs_h *g,\n"
11557 " const char *path);\n"
11562 #: ../src/guestfs-actions.pod:4205
11564 "This call creates a block device node called C<path> with mode C<mode> and "
11565 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11566 "wrapper around C<guestfs_mknod>."
11570 #: ../src/guestfs-actions.pod:4215
11571 msgid "guestfs_mknod_c"
11575 #: ../src/guestfs-actions.pod:4217
11579 " guestfs_mknod_c (guestfs_h *g,\n"
11583 " const char *path);\n"
11588 #: ../src/guestfs-actions.pod:4224
11590 "This call creates a char device node called C<path> with mode C<mode> and "
11591 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11592 "wrapper around C<guestfs_mknod>."
11596 #: ../src/guestfs-actions.pod:4234
11597 msgid "guestfs_mkswap"
11601 #: ../src/guestfs-actions.pod:4236
11605 " guestfs_mkswap (guestfs_h *g,\n"
11606 " const char *device);\n"
11611 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11612 msgid "Create a swap partition on C<device>."
11616 #: ../src/guestfs-actions.pod:4246
11617 msgid "guestfs_mkswap_L"
11621 #: ../src/guestfs-actions.pod:4248
11625 " guestfs_mkswap_L (guestfs_h *g,\n"
11626 " const char *label,\n"
11627 " const char *device);\n"
11632 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11633 msgid "Create a swap partition on C<device> with label C<label>."
11637 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11639 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11640 "sda>), just to a partition. This appears to be a limitation of the kernel "
11645 #: ../src/guestfs-actions.pod:4263
11646 msgid "guestfs_mkswap_U"
11650 #: ../src/guestfs-actions.pod:4265
11654 " guestfs_mkswap_U (guestfs_h *g,\n"
11655 " const char *uuid,\n"
11656 " const char *device);\n"
11661 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11662 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11666 #: ../src/guestfs-actions.pod:4276
11667 msgid "guestfs_mkswap_file"
11671 #: ../src/guestfs-actions.pod:4278
11675 " guestfs_mkswap_file (guestfs_h *g,\n"
11676 " const char *path);\n"
11681 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11682 msgid "Create a swap file."
11686 #: ../src/guestfs-actions.pod:4284
11688 "This command just writes a swap file signature to an existing file. To "
11689 "create the file itself, use something like C<guestfs_fallocate>."
11693 #: ../src/guestfs-actions.pod:4291
11694 msgid "guestfs_modprobe"
11698 #: ../src/guestfs-actions.pod:4293
11702 " guestfs_modprobe (guestfs_h *g,\n"
11703 " const char *modulename);\n"
11708 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11709 msgid "This loads a kernel module in the appliance."
11713 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11715 "The kernel module must have been whitelisted when libguestfs was built (see "
11716 "C<appliance/kmod.whitelist.in> in the source)."
11720 #: ../src/guestfs-actions.pod:4306
11721 msgid "guestfs_mount"
11725 #: ../src/guestfs-actions.pod:4308
11729 " guestfs_mount (guestfs_h *g,\n"
11730 " const char *device,\n"
11731 " const char *mountpoint);\n"
11736 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11738 "Mount a guest disk at a position in the filesystem. Block devices are named "
11739 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11740 "those block devices contain partitions, they will have the usual names (eg. "
11741 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11745 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11747 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11748 "mounted on C</> before others can be mounted. Other filesystems can only be "
11749 "mounted on directories which already exist."
11753 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11755 "The mounted filesystem is writable, if we have sufficient permissions on the "
11756 "underlying device."
11760 #: ../src/guestfs-actions.pod:4327
11762 "B<Important note:> When you use this call, the filesystem options C<sync> "
11763 "and C<noatime> are set implicitly. This was originally done because we "
11764 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11765 "very large negative performance impact and negligible effect on "
11766 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11767 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11768 "(use an empty string for the first parameter if you don't want any options)."
11772 #: ../src/guestfs-actions.pod:4341
11773 msgid "guestfs_mount_loop"
11777 #: ../src/guestfs-actions.pod:4343
11781 " guestfs_mount_loop (guestfs_h *g,\n"
11782 " const char *file,\n"
11783 " const char *mountpoint);\n"
11788 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11790 "This command lets you mount C<file> (a filesystem image in a file) on a "
11791 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11796 #: ../src/guestfs-actions.pod:4356
11797 msgid "guestfs_mount_options"
11801 #: ../src/guestfs-actions.pod:4358
11805 " guestfs_mount_options (guestfs_h *g,\n"
11806 " const char *options,\n"
11807 " const char *device,\n"
11808 " const char *mountpoint);\n"
11813 #: ../src/guestfs-actions.pod:4364
11815 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11816 "the mount options as for the L<mount(8)> I<-o> flag."
11820 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11822 "If the C<options> parameter is an empty string, then no options are passed "
11823 "(all options default to whatever the filesystem uses)."
11827 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388
11828 #: ../src/guestfs-actions.pod:4405
11829 msgid "(Added in 1.0.10)"
11833 #: ../src/guestfs-actions.pod:4376
11834 msgid "guestfs_mount_ro"
11838 #: ../src/guestfs-actions.pod:4378
11842 " guestfs_mount_ro (guestfs_h *g,\n"
11843 " const char *device,\n"
11844 " const char *mountpoint);\n"
11849 #: ../src/guestfs-actions.pod:4383
11851 "This is the same as the C<guestfs_mount> command, but it mounts the "
11852 "filesystem with the read-only (I<-o ro>) flag."
11856 #: ../src/guestfs-actions.pod:4390
11857 msgid "guestfs_mount_vfs"
11861 #: ../src/guestfs-actions.pod:4392
11865 " guestfs_mount_vfs (guestfs_h *g,\n"
11866 " const char *options,\n"
11867 " const char *vfstype,\n"
11868 " const char *device,\n"
11869 " const char *mountpoint);\n"
11874 #: ../src/guestfs-actions.pod:4399
11876 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11877 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11882 #: ../src/guestfs-actions.pod:4407
11883 msgid "guestfs_mountpoints"
11887 #: ../src/guestfs-actions.pod:4409
11891 " guestfs_mountpoints (guestfs_h *g);\n"
11896 #: ../src/guestfs-actions.pod:4412
11898 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11899 "devices. This one returns a hash table (map) of device name to directory "
11900 "where the device is mounted."
11904 #: ../src/guestfs-actions.pod:4424
11905 msgid "guestfs_mounts"
11909 #: ../src/guestfs-actions.pod:4426
11913 " guestfs_mounts (guestfs_h *g);\n"
11918 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11920 "This returns the list of currently mounted filesystems. It returns the list "
11921 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11925 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11926 msgid "Some internal mounts are not shown."
11930 #: ../src/guestfs-actions.pod:4434
11931 msgid "See also: C<guestfs_mountpoints>"
11935 #: ../src/guestfs-actions.pod:4442
11940 #: ../src/guestfs-actions.pod:4444
11944 " guestfs_mv (guestfs_h *g,\n"
11945 " const char *src,\n"
11946 " const char *dest);\n"
11951 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11953 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11954 "destination filename or destination directory."
11958 #: ../src/guestfs-actions.pod:4456
11959 msgid "guestfs_ntfs_3g_probe"
11963 #: ../src/guestfs-actions.pod:4458
11967 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11969 " const char *device);\n"
11974 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11976 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11977 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11978 "write, and some cannot be mounted at all)."
11982 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11984 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11985 "can be mounted read-write. Set it to false if you want to test if the "
11986 "volume can be mounted read-only."
11990 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
11992 "The return value is an integer which C<0> if the operation would succeed, or "
11993 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11997 #: ../src/guestfs-actions.pod:4477
11998 msgid "(Added in 1.0.43)"
12002 #: ../src/guestfs-actions.pod:4479
12003 msgid "guestfs_ntfsresize"
12007 #: ../src/guestfs-actions.pod:4481
12011 " guestfs_ntfsresize (guestfs_h *g,\n"
12012 " const char *device);\n"
12017 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
12019 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12020 "size of the underlying device. See also L<ntfsresize(8)>."
12024 #: ../src/guestfs-actions.pod:4493
12025 msgid "guestfs_ntfsresize_size"
12029 #: ../src/guestfs-actions.pod:4495
12033 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12034 " const char *device,\n"
12035 " int64_t size);\n"
12040 #: ../src/guestfs-actions.pod:4500
12042 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12043 "to specify the new size (in bytes) explicitly."
12047 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941
12048 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
12049 msgid "(Added in 1.3.14)"
12053 #: ../src/guestfs-actions.pod:4507
12054 msgid "guestfs_part_add"
12058 #: ../src/guestfs-actions.pod:4509
12062 " guestfs_part_add (guestfs_h *g,\n"
12063 " const char *device,\n"
12064 " const char *prlogex,\n"
12065 " int64_t startsect,\n"
12066 " int64_t endsect);\n"
12071 #: ../src/guestfs-actions.pod:4516
12073 "This command adds a partition to C<device>. If there is no partition table "
12074 "on the device, call C<guestfs_part_init> first."
12078 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
12080 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12081 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12082 "C<logical>) and C<e> (or C<extended>) partition types."
12086 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
12088 "C<startsect> and C<endsect> are the start and end of the partition in "
12089 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12090 "from the end of the disk (C<-1> is the last sector)."
12094 #: ../src/guestfs-actions.pod:4528
12096 "Creating a partition which covers the whole disk is not so easy. Use "
12097 "C<guestfs_part_disk> to do that."
12101 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571
12102 #: ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702
12103 #: ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759
12104 #: ../src/guestfs-actions.pod:4799
12105 msgid "(Added in 1.0.78)"
12109 #: ../src/guestfs-actions.pod:4535
12110 msgid "guestfs_part_del"
12114 #: ../src/guestfs-actions.pod:4537
12118 " guestfs_part_del (guestfs_h *g,\n"
12119 " const char *device,\n"
12125 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
12126 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12130 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
12132 "Note that in the case of MBR partitioning, deleting an extended partition "
12133 "also deletes any logical partitions it contains."
12137 #: ../src/guestfs-actions.pod:4552
12138 msgid "guestfs_part_disk"
12142 #: ../src/guestfs-actions.pod:4554
12146 " guestfs_part_disk (guestfs_h *g,\n"
12147 " const char *device,\n"
12148 " const char *parttype);\n"
12153 #: ../src/guestfs-actions.pod:4559
12155 "This command is simply a combination of C<guestfs_part_init> followed by "
12156 "C<guestfs_part_add> to create a single primary partition covering the whole "
12161 #: ../src/guestfs-actions.pod:4563
12163 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12164 "possible values are described in C<guestfs_part_init>."
12168 #: ../src/guestfs-actions.pod:4573
12169 msgid "guestfs_part_get_bootable"
12173 #: ../src/guestfs-actions.pod:4575
12177 " guestfs_part_get_bootable (guestfs_h *g,\n"
12178 " const char *device,\n"
12184 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
12186 "This command returns true if the partition C<partnum> on C<device> has the "
12187 "bootable flag set."
12191 #: ../src/guestfs-actions.pod:4583
12192 msgid "See also C<guestfs_part_set_bootable>."
12196 #: ../src/guestfs-actions.pod:4589
12197 msgid "guestfs_part_get_mbr_id"
12201 #: ../src/guestfs-actions.pod:4591
12205 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12206 " const char *device,\n"
12212 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
12214 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12215 "partition C<partnum>."
12219 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
12221 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12222 "undefined results for other partition table types (see "
12223 "C<guestfs_part_get_parttype>)."
12227 #: ../src/guestfs-actions.pod:4607
12228 msgid "guestfs_part_get_parttype"
12232 #: ../src/guestfs-actions.pod:4609
12236 " guestfs_part_get_parttype (guestfs_h *g,\n"
12237 " const char *device);\n"
12242 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
12244 "This command examines the partition table on C<device> and returns the "
12245 "partition table type (format) being used."
12249 #: ../src/guestfs-actions.pod:4616
12251 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12252 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12253 "possible, although unusual. See C<guestfs_part_init> for a full list."
12257 #: ../src/guestfs-actions.pod:4626
12258 msgid "guestfs_part_init"
12262 #: ../src/guestfs-actions.pod:4628
12266 " guestfs_part_init (guestfs_h *g,\n"
12267 " const char *device,\n"
12268 " const char *parttype);\n"
12273 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
12275 "This creates an empty partition table on C<device> of one of the partition "
12276 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12277 "(for large disks)."
12281 #: ../src/guestfs-actions.pod:4637
12283 "Initially there are no partitions. Following this, you should call "
12284 "C<guestfs_part_add> for each partition required."
12288 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
12289 msgid "Possible values for C<parttype> are:"
12293 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
12294 msgid "B<efi> | B<gpt>"
12298 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
12299 msgid "Intel EFI / GPT partition table."
12303 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
12305 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12306 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12307 "the C<mbr> format."
12311 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
12312 msgid "B<mbr> | B<msdos>"
12316 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
12318 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12319 "Windows. This partition type will B<only> work for device sizes up to 2 "
12320 "TB. For large disks we recommend using C<gpt>."
12324 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
12326 "Other partition table types that may work but are not supported include:"
12330 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
12335 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
12336 msgid "AIX disk labels."
12340 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
12341 msgid "B<amiga> | B<rdb>"
12345 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
12346 msgid "Amiga \"Rigid Disk Block\" format."
12350 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
12355 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
12356 msgid "BSD disk labels."
12360 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
12365 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
12366 msgid "DASD, used on IBM mainframes."
12370 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
12375 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
12376 msgid "MIPS/SGI volumes."
12380 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
12385 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
12386 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12390 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
12395 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
12396 msgid "NEC PC-98 format, common in Japan apparently."
12400 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
12405 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
12406 msgid "Sun disk labels."
12410 #: ../src/guestfs-actions.pod:4704
12411 msgid "guestfs_part_list"
12415 #: ../src/guestfs-actions.pod:4706
12418 " struct guestfs_partition_list *\n"
12419 " guestfs_part_list (guestfs_h *g,\n"
12420 " const char *device);\n"
12425 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
12427 "This command parses the partition table on C<device> and returns the list of "
12428 "partitions found."
12432 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
12433 msgid "The fields in the returned structure are:"
12437 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
12438 msgid "B<part_num>"
12442 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
12443 msgid "Partition number, counting from 1."
12447 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
12448 msgid "B<part_start>"
12452 #: ../src/guestfs-actions.pod:4723
12454 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12455 "the device's sector size, see C<guestfs_blockdev_getss>."
12459 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
12460 msgid "B<part_end>"
12464 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
12465 msgid "End of the partition in bytes."
12469 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12470 msgid "B<part_size>"
12474 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12475 msgid "Size of the partition in bytes."
12479 #: ../src/guestfs-actions.pod:4736
12481 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12482 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12487 #: ../src/guestfs-actions.pod:4742
12488 msgid "guestfs_part_set_bootable"
12492 #: ../src/guestfs-actions.pod:4744
12496 " guestfs_part_set_bootable (guestfs_h *g,\n"
12497 " const char *device,\n"
12499 " int bootable);\n"
12504 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12506 "This sets the bootable flag on partition numbered C<partnum> on device "
12507 "C<device>. Note that partitions are numbered from 1."
12511 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12513 "The bootable flag is used by some operating systems (notably Windows) to "
12514 "determine which partition to boot from. It is by no means universally "
12519 #: ../src/guestfs-actions.pod:4761
12520 msgid "guestfs_part_set_mbr_id"
12524 #: ../src/guestfs-actions.pod:4763
12528 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12529 " const char *device,\n"
12536 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12538 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12539 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12540 "documentation are in fact hexadecimal numbers, but usually documented "
12541 "without any leading \"0x\" which might be confusing."
12545 #: ../src/guestfs-actions.pod:4783
12546 msgid "guestfs_part_set_name"
12550 #: ../src/guestfs-actions.pod:4785
12554 " guestfs_part_set_name (guestfs_h *g,\n"
12555 " const char *device,\n"
12557 " const char *name);\n"
12562 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12564 "This sets the partition name on partition numbered C<partnum> on device "
12565 "C<device>. Note that partitions are numbered from 1."
12569 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12571 "The partition name can only be set on certain types of partition table. "
12572 "This works on C<gpt> but not on C<mbr> partitions."
12576 #: ../src/guestfs-actions.pod:4801
12577 msgid "guestfs_part_to_dev"
12581 #: ../src/guestfs-actions.pod:4803
12585 " guestfs_part_to_dev (guestfs_h *g,\n"
12586 " const char *partition);\n"
12591 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12593 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12594 "partition number, returning the device name (eg. \"/dev/sdb\")."
12598 #: ../src/guestfs-actions.pod:4811
12600 "The named partition must exist, for example as a string returned from "
12601 "C<guestfs_list_partitions>."
12605 #: ../src/guestfs-actions.pod:4819
12606 msgid "guestfs_ping_daemon"
12610 #: ../src/guestfs-actions.pod:4821
12614 " guestfs_ping_daemon (guestfs_h *g);\n"
12619 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12621 "This is a test probe into the guestfs daemon running inside the qemu "
12622 "subprocess. Calling this function checks that the daemon responds to the "
12623 "ping message, without affecting the daemon or attached block device(s) in "
12628 #: ../src/guestfs-actions.pod:4833
12629 msgid "guestfs_pread"
12633 #: ../src/guestfs-actions.pod:4835
12637 " guestfs_pread (guestfs_h *g,\n"
12638 " const char *path,\n"
12640 " int64_t offset,\n"
12641 " size_t *size_r);\n"
12646 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12648 "This command lets you read part of a file. It reads C<count> bytes of the "
12649 "file, starting at C<offset>, from file C<path>."
12653 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871
12654 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12656 "This may read fewer bytes than requested. For further details see the "
12657 "L<pread(2)> system call."
12661 #: ../src/guestfs-actions.pod:4848
12662 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12666 #: ../src/guestfs-actions.pod:4859
12667 msgid "guestfs_pread_device"
12671 #: ../src/guestfs-actions.pod:4861
12675 " guestfs_pread_device (guestfs_h *g,\n"
12676 " const char *device,\n"
12678 " int64_t offset,\n"
12679 " size_t *size_r);\n"
12684 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12686 "This command lets you read part of a file. It reads C<count> bytes of "
12687 "C<device>, starting at C<offset>."
12691 #: ../src/guestfs-actions.pod:4874
12692 msgid "See also C<guestfs_pread>."
12696 #: ../src/guestfs-actions.pod:4883
12697 msgid "(Added in 1.5.21)"
12701 #: ../src/guestfs-actions.pod:4885
12702 msgid "guestfs_pvcreate"
12706 #: ../src/guestfs-actions.pod:4887
12710 " guestfs_pvcreate (guestfs_h *g,\n"
12711 " const char *device);\n"
12716 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12718 "This creates an LVM physical volume on the named C<device>, where C<device> "
12719 "should usually be a partition name such as C</dev/sda1>."
12723 #: ../src/guestfs-actions.pod:4899
12724 msgid "guestfs_pvremove"
12728 #: ../src/guestfs-actions.pod:4901
12732 " guestfs_pvremove (guestfs_h *g,\n"
12733 " const char *device);\n"
12738 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12740 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12745 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12747 "The implementation uses the C<pvremove> command which refuses to wipe "
12748 "physical volumes that contain any volume groups, so you have to remove those "
12753 #: ../src/guestfs-actions.pod:4916
12754 msgid "guestfs_pvresize"
12758 #: ../src/guestfs-actions.pod:4918
12762 " guestfs_pvresize (guestfs_h *g,\n"
12763 " const char *device);\n"
12768 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12770 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12771 "the new size of the underlying device."
12775 #: ../src/guestfs-actions.pod:4929
12776 msgid "guestfs_pvresize_size"
12780 #: ../src/guestfs-actions.pod:4931
12784 " guestfs_pvresize_size (guestfs_h *g,\n"
12785 " const char *device,\n"
12786 " int64_t size);\n"
12791 #: ../src/guestfs-actions.pod:4936
12793 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12794 "specify the new size (in bytes) explicitly."
12798 #: ../src/guestfs-actions.pod:4943
12799 msgid "guestfs_pvs"
12803 #: ../src/guestfs-actions.pod:4945
12807 " guestfs_pvs (guestfs_h *g);\n"
12812 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12814 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12819 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12821 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12826 #: ../src/guestfs-actions.pod:4954
12827 msgid "See also C<guestfs_pvs_full>."
12831 #: ../src/guestfs-actions.pod:4962
12832 msgid "guestfs_pvs_full"
12836 #: ../src/guestfs-actions.pod:4964
12839 " struct guestfs_lvm_pv_list *\n"
12840 " guestfs_pvs_full (guestfs_h *g);\n"
12845 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12847 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12848 "(8)> command. The \"full\" version includes all fields."
12852 #: ../src/guestfs-actions.pod:4970
12854 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12855 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12859 #: ../src/guestfs-actions.pod:4976
12860 msgid "guestfs_pvuuid"
12864 #: ../src/guestfs-actions.pod:4978
12868 " guestfs_pvuuid (guestfs_h *g,\n"
12869 " const char *device);\n"
12874 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12875 msgid "This command returns the UUID of the LVM PV C<device>."
12879 #: ../src/guestfs-actions.pod:4989
12880 msgid "guestfs_pwrite"
12884 #: ../src/guestfs-actions.pod:4991
12888 " guestfs_pwrite (guestfs_h *g,\n"
12889 " const char *path,\n"
12890 " const char *content,\n"
12891 " size_t content_size,\n"
12892 " int64_t offset);\n"
12897 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12899 "This command writes to part of a file. It writes the data buffer C<content> "
12900 "to the file C<path> starting at offset C<offset>."
12904 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12906 "This command implements the L<pwrite(2)> system call, and like that system "
12907 "call it may not write the full data requested. The return value is the "
12908 "number of bytes that were actually written to the file. This could even be "
12909 "0, although short writes are unlikely for regular files in ordinary "
12914 #: ../src/guestfs-actions.pod:5007
12915 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12919 #: ../src/guestfs-actions.pod:5016
12920 msgid "guestfs_pwrite_device"
12924 #: ../src/guestfs-actions.pod:5018
12928 " guestfs_pwrite_device (guestfs_h *g,\n"
12929 " const char *device,\n"
12930 " const char *content,\n"
12931 " size_t content_size,\n"
12932 " int64_t offset);\n"
12937 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12939 "This command writes to part of a device. It writes the data buffer "
12940 "C<content> to C<device> starting at offset C<offset>."
12944 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12946 "This command implements the L<pwrite(2)> system call, and like that system "
12947 "call it may not write the full data requested (although short writes to disk "
12948 "devices and partitions are probably impossible with standard Linux kernels)."
12952 #: ../src/guestfs-actions.pod:5033
12953 msgid "See also C<guestfs_pwrite>."
12957 #: ../src/guestfs-actions.pod:5040
12958 msgid "(Added in 1.5.20)"
12962 #: ../src/guestfs-actions.pod:5042
12963 msgid "guestfs_read_file"
12967 #: ../src/guestfs-actions.pod:5044
12971 " guestfs_read_file (guestfs_h *g,\n"
12972 " const char *path,\n"
12973 " size_t *size_r);\n"
12978 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12979 msgid "This calls returns the contents of the file C<path> as a buffer."
12983 #: ../src/guestfs-actions.pod:5052
12985 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12986 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12987 "function is limited in the total size of file that can be handled."
12991 #: ../src/guestfs-actions.pod:5064
12992 msgid "(Added in 1.0.63)"
12996 #: ../src/guestfs-actions.pod:5066
12997 msgid "guestfs_read_lines"
13001 #: ../src/guestfs-actions.pod:5068
13005 " guestfs_read_lines (guestfs_h *g,\n"
13006 " const char *path);\n"
13011 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
13013 "The file contents are returned as a list of lines. Trailing C<LF> and "
13014 "C<CRLF> character sequences are I<not> returned."
13018 #: ../src/guestfs-actions.pod:5077
13020 "Note that this function cannot correctly handle binary files (specifically, "
13021 "files containing C<\\0> character which is treated as end of line). For "
13022 "those you need to use the C<guestfs_read_file> function which has a more "
13023 "complex interface."
13027 #: ../src/guestfs-actions.pod:5088
13028 msgid "guestfs_readdir"
13032 #: ../src/guestfs-actions.pod:5090
13035 " struct guestfs_dirent_list *\n"
13036 " guestfs_readdir (guestfs_h *g,\n"
13037 " const char *dir);\n"
13042 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
13043 msgid "This returns the list of directory entries in directory C<dir>."
13047 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
13049 "All entries in the directory are returned, including C<.> and C<..>. The "
13050 "entries are I<not> sorted, but returned in the same order as the underlying "
13055 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
13057 "Also this call returns basic file type information about each file. The "
13058 "C<ftyp> field will contain one of the following characters:"
13062 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
13067 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
13068 msgid "Block special"
13072 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
13077 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
13078 msgid "Char special"
13082 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
13087 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
13092 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
13097 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
13098 msgid "FIFO (named pipe)"
13102 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
13107 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
13108 msgid "Symbolic link"
13112 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
13117 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
13118 msgid "Regular file"
13122 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
13127 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
13132 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
13137 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
13138 msgid "Unknown file type"
13142 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
13147 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
13149 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13153 #: ../src/guestfs-actions.pod:5144
13155 "This function is primarily intended for use by programs. To get a simple "
13156 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13157 "consumption, use C<guestfs_ll>."
13161 #: ../src/guestfs-actions.pod:5148
13163 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13164 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13168 #: ../src/guestfs-actions.pod:5154
13169 msgid "guestfs_readlink"
13173 #: ../src/guestfs-actions.pod:5156
13177 " guestfs_readlink (guestfs_h *g,\n"
13178 " const char *path);\n"
13183 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
13184 msgid "This command reads the target of a symbolic link."
13188 #: ../src/guestfs-actions.pod:5167
13189 msgid "guestfs_readlinklist"
13193 #: ../src/guestfs-actions.pod:5169
13197 " guestfs_readlinklist (guestfs_h *g,\n"
13198 " const char *path,\n"
13199 " char *const *names);\n"
13204 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
13206 "This call allows you to do a C<readlink> operation on multiple files, where "
13207 "all files are in the directory C<path>. C<names> is the list of files from "
13212 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
13214 "On return you get a list of strings, with a one-to-one correspondence to the "
13215 "C<names> list. Each string is the value of the symbolic link."
13219 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
13221 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13222 "result string is the empty string C<\"\">. However the whole operation is "
13223 "completed even if there were C<readlink(2)> errors, and so you can call this "
13224 "function with names where you don't know if they are symbolic links already "
13225 "(albeit slightly less efficient)."
13229 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
13231 "This call is intended for programs that want to efficiently list a directory "
13232 "contents without making many round-trips. Very long directory listings "
13233 "might cause the protocol message size to be exceeded, causing this call to "
13234 "fail. The caller must split up such requests into smaller groups of names."
13238 #: ../src/guestfs-actions.pod:5202
13239 msgid "guestfs_realpath"
13243 #: ../src/guestfs-actions.pod:5204
13247 " guestfs_realpath (guestfs_h *g,\n"
13248 " const char *path);\n"
13253 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
13255 "Return the canonicalized absolute pathname of C<path>. The returned path "
13256 "has no C<.>, C<..> or symbolic link path elements."
13260 #: ../src/guestfs-actions.pod:5216
13261 msgid "guestfs_removexattr"
13265 #: ../src/guestfs-actions.pod:5218
13269 " guestfs_removexattr (guestfs_h *g,\n"
13270 " const char *xattr,\n"
13271 " const char *path);\n"
13276 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
13278 "This call removes the extended attribute named C<xattr> of the file C<path>."
13282 #: ../src/guestfs-actions.pod:5226
13283 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13287 #: ../src/guestfs-actions.pod:5232
13288 msgid "guestfs_resize2fs"
13292 #: ../src/guestfs-actions.pod:5234
13296 " guestfs_resize2fs (guestfs_h *g,\n"
13297 " const char *device);\n"
13302 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
13304 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13305 "underlying device."
13309 #: ../src/guestfs-actions.pod:5241
13311 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13312 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13313 "sometimes gives an error about this and sometimes not. In any case, it is "
13314 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13318 #: ../src/guestfs-actions.pod:5251
13319 msgid "guestfs_resize2fs_size"
13323 #: ../src/guestfs-actions.pod:5253
13327 " guestfs_resize2fs_size (guestfs_h *g,\n"
13328 " const char *device,\n"
13329 " int64_t size);\n"
13334 #: ../src/guestfs-actions.pod:5258
13336 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13337 "to specify the new size (in bytes) explicitly."
13341 #: ../src/guestfs-actions.pod:5265
13346 #: ../src/guestfs-actions.pod:5267
13350 " guestfs_rm (guestfs_h *g,\n"
13351 " const char *path);\n"
13356 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
13357 msgid "Remove the single file C<path>."
13361 #: ../src/guestfs-actions.pod:5277
13362 msgid "guestfs_rm_rf"
13366 #: ../src/guestfs-actions.pod:5279
13370 " guestfs_rm_rf (guestfs_h *g,\n"
13371 " const char *path);\n"
13376 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
13378 "Remove the file or directory C<path>, recursively removing the contents if "
13379 "its a directory. This is like the C<rm -rf> shell command."
13383 #: ../src/guestfs-actions.pod:5291
13384 msgid "guestfs_rmdir"
13388 #: ../src/guestfs-actions.pod:5293
13392 " guestfs_rmdir (guestfs_h *g,\n"
13393 " const char *path);\n"
13398 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
13399 msgid "Remove the single directory C<path>."
13403 #: ../src/guestfs-actions.pod:5303
13404 msgid "guestfs_rmmountpoint"
13408 #: ../src/guestfs-actions.pod:5305
13412 " guestfs_rmmountpoint (guestfs_h *g,\n"
13413 " const char *exemptpath);\n"
13418 #: ../src/guestfs-actions.pod:5309
13420 "This calls removes a mountpoint that was previously created with "
13421 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13425 #: ../src/guestfs-actions.pod:5317
13426 msgid "guestfs_scrub_device"
13430 #: ../src/guestfs-actions.pod:5319
13434 " guestfs_scrub_device (guestfs_h *g,\n"
13435 " const char *device);\n"
13440 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
13442 "This command writes patterns over C<device> to make data retrieval more "
13447 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347
13448 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564
13449 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13451 "It is an interface to the L<scrub(1)> program. See that manual page for "
13456 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352
13457 #: ../src/guestfs-actions.pod:5371
13458 msgid "(Added in 1.0.52)"
13462 #: ../src/guestfs-actions.pod:5336
13463 msgid "guestfs_scrub_file"
13467 #: ../src/guestfs-actions.pod:5338
13471 " guestfs_scrub_file (guestfs_h *g,\n"
13472 " const char *file);\n"
13477 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13479 "This command writes patterns over a file to make data retrieval more "
13484 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13485 msgid "The file is I<removed> after scrubbing."
13489 #: ../src/guestfs-actions.pod:5354
13490 msgid "guestfs_scrub_freespace"
13494 #: ../src/guestfs-actions.pod:5356
13498 " guestfs_scrub_freespace (guestfs_h *g,\n"
13499 " const char *dir);\n"
13504 #: ../src/guestfs-actions.pod:5360
13506 "This command creates the directory C<dir> and then fills it with files until "
13507 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13508 "and deletes them. The intention is to scrub any free space on the partition "
13509 "containing C<dir>."
13513 #: ../src/guestfs-actions.pod:5373
13514 msgid "guestfs_set_append"
13518 #: ../src/guestfs-actions.pod:5375
13522 " guestfs_set_append (guestfs_h *g,\n"
13523 " const char *append);\n"
13528 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13530 "This function is used to add additional options to the guest kernel command "
13535 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13537 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13538 "environment variable."
13542 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13544 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13545 "(libguestfs always adds a few of its own)."
13549 #: ../src/guestfs-actions.pod:5392
13550 msgid "guestfs_set_autosync"
13554 #: ../src/guestfs-actions.pod:5394
13558 " guestfs_set_autosync (guestfs_h *g,\n"
13559 " int autosync);\n"
13564 #: ../src/guestfs-actions.pod:5398
13566 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13567 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13568 "the handle is closed (also if the program exits without closing handles)."
13572 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13574 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13575 "disabled by default)."
13579 #: ../src/guestfs-actions.pod:5410
13580 msgid "guestfs_set_direct"
13584 #: ../src/guestfs-actions.pod:5412
13588 " guestfs_set_direct (guestfs_h *g,\n"
13594 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13596 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13597 "passed directly through to the appliance once it is launched."
13601 #: ../src/guestfs-actions.pod:5420
13603 "One consequence of this is that log messages aren't caught by the library "
13604 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13609 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13610 msgid "You probably don't want to use this unless you know what you are doing."
13614 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13615 msgid "The default is disabled."
13619 #: ../src/guestfs-actions.pod:5433
13620 msgid "guestfs_set_e2label"
13624 #: ../src/guestfs-actions.pod:5435
13628 " guestfs_set_e2label (guestfs_h *g,\n"
13629 " const char *device,\n"
13630 " const char *label);\n"
13635 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13637 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13638 "C<label>. Filesystem labels are limited to 16 characters."
13642 #: ../src/guestfs-actions.pod:5444
13644 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13645 "the existing label on a filesystem."
13649 #: ../src/guestfs-actions.pod:5451
13650 msgid "guestfs_set_e2uuid"
13654 #: ../src/guestfs-actions.pod:5453
13658 " guestfs_set_e2uuid (guestfs_h *g,\n"
13659 " const char *device,\n"
13660 " const char *uuid);\n"
13665 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13667 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13668 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13669 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13673 #: ../src/guestfs-actions.pod:5463
13675 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13676 "the existing UUID of a filesystem."
13680 #: ../src/guestfs-actions.pod:5470
13681 msgid "guestfs_set_memsize"
13685 #: ../src/guestfs-actions.pod:5472
13689 " guestfs_set_memsize (guestfs_h *g,\n"
13695 #: ../src/guestfs-actions.pod:5476
13697 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13698 "This only has any effect if called before C<guestfs_launch>."
13702 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13704 "You can also change this by setting the environment variable "
13705 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13709 #: ../src/guestfs-actions.pod:5491
13710 msgid "guestfs_set_network"
13714 #: ../src/guestfs-actions.pod:5493
13718 " guestfs_set_network (guestfs_h *g,\n"
13724 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13726 "If C<network> is true, then the network is enabled in the libguestfs "
13727 "appliance. The default is false."
13731 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13733 "This affects whether commands are able to access the network (see L<guestfs"
13734 "(3)/RUNNING COMMANDS>)."
13738 #: ../src/guestfs-actions.pod:5503
13740 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13745 #: ../src/guestfs-actions.pod:5510
13746 msgid "guestfs_set_path"
13750 #: ../src/guestfs-actions.pod:5512
13754 " guestfs_set_path (guestfs_h *g,\n"
13755 " const char *searchpath);\n"
13760 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13761 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13765 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13767 "The default is C<$libdir/guestfs> unless overridden by setting "
13768 "C<LIBGUESTFS_PATH> environment variable."
13772 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13773 msgid "Setting C<path> to C<NULL> restores the default path."
13777 #: ../src/guestfs-actions.pod:5527
13778 msgid "guestfs_set_qemu"
13782 #: ../src/guestfs-actions.pod:5529
13786 " guestfs_set_qemu (guestfs_h *g,\n"
13787 " const char *qemu);\n"
13792 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13793 msgid "Set the qemu binary that we will use."
13797 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13799 "The default is chosen when the library was compiled by the configure script."
13803 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13805 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13810 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13811 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13815 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13817 "Note that you should call this function as early as possible after creating "
13818 "the handle. This is because some pre-launch operations depend on testing "
13819 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13820 "don't retest features, and so you might see inconsistent results. Using the "
13821 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13822 "the qemu binary at the same time as the handle is created."
13826 #: ../src/guestfs-actions.pod:5555
13827 msgid "guestfs_set_recovery_proc"
13831 #: ../src/guestfs-actions.pod:5557
13835 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13836 " int recoveryproc);\n"
13841 #: ../src/guestfs-actions.pod:5561
13843 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13844 "not create a recovery process. The purpose of the recovery process is to "
13845 "stop runaway qemu processes in the case where the main program aborts "
13850 #: ../src/guestfs-actions.pod:5566
13852 "This only has any effect if called before C<guestfs_launch>, and the default "
13857 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13859 "About the only time when you would want to disable this is if the main "
13860 "process will fork itself into the background (\"daemonize\" itself). In "
13861 "this case the recovery process thinks that the main program has disappeared "
13862 "and so kills qemu, which is not very helpful."
13866 #: ../src/guestfs-actions.pod:5579
13867 msgid "guestfs_set_selinux"
13871 #: ../src/guestfs-actions.pod:5581
13875 " guestfs_set_selinux (guestfs_h *g,\n"
13881 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13883 "This sets the selinux flag that is passed to the appliance at boot time. "
13884 "The default is C<selinux=0> (disabled)."
13888 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13890 "Note that if SELinux is enabled, it is always in Permissive mode "
13891 "(C<enforcing=0>)."
13895 #: ../src/guestfs-actions.pod:5598
13896 msgid "guestfs_set_trace"
13900 #: ../src/guestfs-actions.pod:5600
13904 " guestfs_set_trace (guestfs_h *g,\n"
13910 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13912 "If the command trace flag is set to 1, then commands are printed on stderr "
13913 "before they are executed in a format which is very similar to the one used "
13914 "by guestfish. In other words, you can run a program with this enabled, and "
13915 "you will get out a script which you can feed to guestfish to perform the "
13916 "same set of actions."
13920 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13922 "If you want to trace C API calls into libguestfs (and other libraries) then "
13923 "possibly a better way is to use the external ltrace(1) command."
13927 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13929 "Command traces are disabled unless the environment variable "
13930 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13934 #: ../src/guestfs-actions.pod:5622
13935 msgid "guestfs_set_verbose"
13939 #: ../src/guestfs-actions.pod:5624
13943 " guestfs_set_verbose (guestfs_h *g,\n"
13949 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13950 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13954 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13956 "Verbose messages are disabled unless the environment variable "
13957 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13961 #: ../src/guestfs-actions.pod:5637
13962 msgid "guestfs_setcon"
13966 #: ../src/guestfs-actions.pod:5639
13970 " guestfs_setcon (guestfs_h *g,\n"
13971 " const char *context);\n"
13976 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13978 "This sets the SELinux security context of the daemon to the string "
13983 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13984 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13988 #: ../src/guestfs-actions.pod:5652
13989 msgid "guestfs_setxattr"
13993 #: ../src/guestfs-actions.pod:5654
13997 " guestfs_setxattr (guestfs_h *g,\n"
13998 " const char *xattr,\n"
13999 " const char *val,\n"
14001 " const char *path);\n"
14006 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
14008 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14009 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14013 #: ../src/guestfs-actions.pod:5665
14014 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14018 #: ../src/guestfs-actions.pod:5671
14019 msgid "guestfs_sfdisk"
14023 #: ../src/guestfs-actions.pod:5673
14027 " guestfs_sfdisk (guestfs_h *g,\n"
14028 " const char *device,\n"
14032 " char *const *lines);\n"
14037 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
14039 "This is a direct interface to the L<sfdisk(8)> program for creating "
14040 "partitions on block devices."
14044 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
14045 msgid "C<device> should be a block device, for example C</dev/sda>."
14049 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
14051 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14052 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14053 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14054 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14055 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14056 "the kernel) cannot work out the right geometry and you will need to tell it."
14060 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
14062 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14063 "refer to the L<sfdisk(8)> manpage."
14067 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
14069 "To create a single partition occupying the whole disk, you would pass "
14070 "C<lines> as a single element list, when the single element being the string "
14075 #: ../src/guestfs-actions.pod:5701
14077 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14081 #: ../src/guestfs-actions.pod:5711
14082 msgid "guestfs_sfdiskM"
14086 #: ../src/guestfs-actions.pod:5713
14090 " guestfs_sfdiskM (guestfs_h *g,\n"
14091 " const char *device,\n"
14092 " char *const *lines);\n"
14097 #: ../src/guestfs-actions.pod:5718
14099 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14100 "partition sizes are specified in megabytes only (rounded to the nearest "
14101 "cylinder) and you don't need to specify the cyls, heads and sectors "
14102 "parameters which were rarely if ever used anyway."
14106 #: ../src/guestfs-actions.pod:5724
14108 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14109 "C<guestfs_part_disk>"
14113 #: ../src/guestfs-actions.pod:5734
14114 msgid "guestfs_sfdisk_N"
14118 #: ../src/guestfs-actions.pod:5736
14122 " guestfs_sfdisk_N (guestfs_h *g,\n"
14123 " const char *device,\n"
14128 " const char *line);\n"
14133 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
14135 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14136 "(note: C<n> counts from 1)."
14140 #: ../src/guestfs-actions.pod:5748
14142 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14143 "for the cyls/heads/sectors parameters."
14147 #: ../src/guestfs-actions.pod:5751
14148 msgid "See also: C<guestfs_part_add>"
14152 #: ../src/guestfs-actions.pod:5760
14153 msgid "guestfs_sfdisk_disk_geometry"
14157 #: ../src/guestfs-actions.pod:5762
14161 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14162 " const char *device);\n"
14167 #: ../src/guestfs-actions.pod:5766
14169 "This displays the disk geometry of C<device> read from the partition table. "
14170 "Especially in the case where the underlying block device has been resized, "
14171 "this can be different from the kernel's idea of the geometry (see "
14172 "C<guestfs_sfdisk_kernel_geometry>)."
14176 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787
14177 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14178 msgid "The result is in human-readable format, and not designed to be parsed."
14182 #: ../src/guestfs-actions.pod:5779
14183 msgid "guestfs_sfdisk_kernel_geometry"
14187 #: ../src/guestfs-actions.pod:5781
14191 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14192 " const char *device);\n"
14197 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
14198 msgid "This displays the kernel's idea of the geometry of C<device>."
14202 #: ../src/guestfs-actions.pod:5795
14203 msgid "guestfs_sfdisk_l"
14207 #: ../src/guestfs-actions.pod:5797
14211 " guestfs_sfdisk_l (guestfs_h *g,\n"
14212 " const char *device);\n"
14217 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
14219 "This displays the partition table on C<device>, in the human-readable output "
14220 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14224 #: ../src/guestfs-actions.pod:5805
14225 msgid "See also: C<guestfs_part_list>"
14229 #: ../src/guestfs-actions.pod:5812
14234 #: ../src/guestfs-actions.pod:5814
14238 " guestfs_sh (guestfs_h *g,\n"
14239 " const char *command);\n"
14244 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
14246 "This call runs a command from the guest filesystem via the guest's C</bin/"
14251 #: ../src/guestfs-actions.pod:5821
14252 msgid "This is like C<guestfs_command>, but passes the command to:"
14256 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
14259 " /bin/sh -c \"command\"\n"
14264 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
14266 "Depending on the guest's shell, this usually results in wildcards being "
14267 "expanded, shell expressions being interpolated and so on."
14271 #: ../src/guestfs-actions.pod:5829
14272 msgid "All the provisos about C<guestfs_command> apply to this call."
14276 #: ../src/guestfs-actions.pod:5836
14277 msgid "guestfs_sh_lines"
14281 #: ../src/guestfs-actions.pod:5838
14285 " guestfs_sh_lines (guestfs_h *g,\n"
14286 " const char *command);\n"
14291 #: ../src/guestfs-actions.pod:5842
14293 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14298 #: ../src/guestfs-actions.pod:5845
14299 msgid "See also: C<guestfs_command_lines>"
14303 #: ../src/guestfs-actions.pod:5853
14304 msgid "guestfs_sleep"
14308 #: ../src/guestfs-actions.pod:5855
14312 " guestfs_sleep (guestfs_h *g,\n"
14318 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
14319 msgid "Sleep for C<secs> seconds."
14323 #: ../src/guestfs-actions.pod:5863
14324 msgid "(Added in 1.0.41)"
14328 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
14329 msgid "guestfs_stat"
14333 #: ../src/guestfs-actions.pod:5867
14336 " struct guestfs_stat *\n"
14337 " guestfs_stat (guestfs_h *g,\n"
14338 " const char *path);\n"
14343 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
14344 msgid "This is the same as the C<stat(2)> system call."
14348 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
14349 msgid "guestfs_statvfs"
14353 #: ../src/guestfs-actions.pod:5883
14356 " struct guestfs_statvfs *\n"
14357 " guestfs_statvfs (guestfs_h *g,\n"
14358 " const char *path);\n"
14363 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
14365 "Returns file system statistics for any mounted file system. C<path> should "
14366 "be a file or directory in the mounted file system (typically it is the mount "
14367 "point itself, but it doesn't need to be)."
14371 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
14372 msgid "This is the same as the C<statvfs(2)> system call."
14376 #: ../src/guestfs-actions.pod:5893
14378 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14379 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14383 #: ../src/guestfs-actions.pod:5899
14384 msgid "guestfs_strings"
14388 #: ../src/guestfs-actions.pod:5901
14392 " guestfs_strings (guestfs_h *g,\n"
14393 " const char *path);\n"
14398 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
14400 "This runs the L<strings(1)> command on a file and returns the list of "
14401 "printable strings found."
14405 #: ../src/guestfs-actions.pod:5917
14406 msgid "guestfs_strings_e"
14410 #: ../src/guestfs-actions.pod:5919
14414 " guestfs_strings_e (guestfs_h *g,\n"
14415 " const char *encoding,\n"
14416 " const char *path);\n"
14421 #: ../src/guestfs-actions.pod:5924
14423 "This is like the C<guestfs_strings> command, but allows you to specify the "
14424 "encoding of strings that are looked for in the source file C<path>."
14428 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
14429 msgid "Allowed encodings are:"
14433 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
14438 #: ../src/guestfs-actions.pod:5934
14440 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14441 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14445 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
14450 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
14451 msgid "Single 8-bit-byte characters."
14455 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
14460 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
14461 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14465 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
14466 msgid "l (lower case letter L)"
14470 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
14472 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14473 "examining binaries in Windows guests."
14477 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14482 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14483 msgid "32-bit big endian such as UCS-4BE."
14487 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14492 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14493 msgid "32-bit little endian such as UCS-4LE."
14497 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14498 msgid "The returned strings are transcoded to UTF-8."
14502 #: ../src/guestfs-actions.pod:5972
14503 msgid "guestfs_swapoff_device"
14507 #: ../src/guestfs-actions.pod:5974
14511 " guestfs_swapoff_device (guestfs_h *g,\n"
14512 " const char *device);\n"
14517 #: ../src/guestfs-actions.pod:5978
14519 "This command disables the libguestfs appliance swap device or partition "
14520 "named C<device>. See C<guestfs_swapon_device>."
14524 #: ../src/guestfs-actions.pod:5986
14525 msgid "guestfs_swapoff_file"
14529 #: ../src/guestfs-actions.pod:5988
14533 " guestfs_swapoff_file (guestfs_h *g,\n"
14534 " const char *file);\n"
14539 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14540 msgid "This command disables the libguestfs appliance swap on file."
14544 #: ../src/guestfs-actions.pod:5998
14545 msgid "guestfs_swapoff_label"
14549 #: ../src/guestfs-actions.pod:6000
14553 " guestfs_swapoff_label (guestfs_h *g,\n"
14554 " const char *label);\n"
14559 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14561 "This command disables the libguestfs appliance swap on labeled swap "
14566 #: ../src/guestfs-actions.pod:6011
14567 msgid "guestfs_swapoff_uuid"
14571 #: ../src/guestfs-actions.pod:6013
14575 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14576 " const char *uuid);\n"
14581 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14583 "This command disables the libguestfs appliance swap partition with the given "
14588 #: ../src/guestfs-actions.pod:6024
14589 msgid "guestfs_swapon_device"
14593 #: ../src/guestfs-actions.pod:6026
14597 " guestfs_swapon_device (guestfs_h *g,\n"
14598 " const char *device);\n"
14603 #: ../src/guestfs-actions.pod:6030
14605 "This command enables the libguestfs appliance to use the swap device or "
14606 "partition named C<device>. The increased memory is made available for all "
14607 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14611 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14613 "Note that you should not swap to existing guest swap partitions unless you "
14614 "know what you are doing. They may contain hibernation information, or other "
14615 "information that the guest doesn't want you to trash. You also risk leaking "
14616 "information about the host to the guest this way. Instead, attach a new "
14617 "host device to the guest and swap on that."
14621 #: ../src/guestfs-actions.pod:6046
14622 msgid "guestfs_swapon_file"
14626 #: ../src/guestfs-actions.pod:6048
14630 " guestfs_swapon_file (guestfs_h *g,\n"
14631 " const char *file);\n"
14636 #: ../src/guestfs-actions.pod:6052
14638 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14643 #: ../src/guestfs-actions.pod:6059
14644 msgid "guestfs_swapon_label"
14648 #: ../src/guestfs-actions.pod:6061
14652 " guestfs_swapon_label (guestfs_h *g,\n"
14653 " const char *label);\n"
14658 #: ../src/guestfs-actions.pod:6065
14660 "This command enables swap to a labeled swap partition. See "
14661 "C<guestfs_swapon_device> for other notes."
14665 #: ../src/guestfs-actions.pod:6072
14666 msgid "guestfs_swapon_uuid"
14670 #: ../src/guestfs-actions.pod:6074
14674 " guestfs_swapon_uuid (guestfs_h *g,\n"
14675 " const char *uuid);\n"
14680 #: ../src/guestfs-actions.pod:6078
14682 "This command enables swap to a swap partition with the given UUID. See "
14683 "C<guestfs_swapon_device> for other notes."
14687 #: ../src/guestfs-actions.pod:6085
14688 msgid "guestfs_sync"
14692 #: ../src/guestfs-actions.pod:6087
14696 " guestfs_sync (guestfs_h *g);\n"
14701 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14703 "This syncs the disk, so that any writes are flushed through to the "
14704 "underlying disk image."
14708 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14710 "You should always call this if you have modified a disk image, before "
14711 "closing the handle."
14715 #: ../src/guestfs-actions.pod:6100
14716 msgid "guestfs_tail"
14720 #: ../src/guestfs-actions.pod:6102
14724 " guestfs_tail (guestfs_h *g,\n"
14725 " const char *path);\n"
14730 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14732 "This command returns up to the last 10 lines of a file as a list of strings."
14736 #: ../src/guestfs-actions.pod:6118
14737 msgid "guestfs_tail_n"
14741 #: ../src/guestfs-actions.pod:6120
14745 " guestfs_tail_n (guestfs_h *g,\n"
14747 " const char *path);\n"
14752 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14754 "If the parameter C<nrlines> is a positive number, this returns the last "
14755 "C<nrlines> lines of the file C<path>."
14759 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14761 "If the parameter C<nrlines> is a negative number, this returns lines from "
14762 "the file C<path>, starting with the C<-nrlines>th line."
14766 #: ../src/guestfs-actions.pod:6142
14767 msgid "guestfs_tar_in"
14771 #: ../src/guestfs-actions.pod:6144
14775 " guestfs_tar_in (guestfs_h *g,\n"
14776 " const char *tarfile,\n"
14777 " const char *directory);\n"
14782 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14784 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14785 "tar file) into C<directory>."
14789 #: ../src/guestfs-actions.pod:6152
14791 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14795 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174
14796 #: ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14797 msgid "(Added in 1.0.3)"
14801 #: ../src/guestfs-actions.pod:6159
14802 msgid "guestfs_tar_out"
14806 #: ../src/guestfs-actions.pod:6161
14810 " guestfs_tar_out (guestfs_h *g,\n"
14811 " const char *directory,\n"
14812 " const char *tarfile);\n"
14817 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14819 "This command packs the contents of C<directory> and downloads it to local "
14824 #: ../src/guestfs-actions.pod:6169
14826 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14827 "C<guestfs_txz_out>."
14831 #: ../src/guestfs-actions.pod:6176
14832 msgid "guestfs_tgz_in"
14836 #: ../src/guestfs-actions.pod:6178
14840 " guestfs_tgz_in (guestfs_h *g,\n"
14841 " const char *tarball,\n"
14842 " const char *directory);\n"
14847 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14849 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14850 "tar file) into C<directory>."
14854 #: ../src/guestfs-actions.pod:6186
14855 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14859 #: ../src/guestfs-actions.pod:6192
14860 msgid "guestfs_tgz_out"
14864 #: ../src/guestfs-actions.pod:6194
14868 " guestfs_tgz_out (guestfs_h *g,\n"
14869 " const char *directory,\n"
14870 " const char *tarball);\n"
14875 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14877 "This command packs the contents of C<directory> and downloads it to local "
14882 #: ../src/guestfs-actions.pod:6202
14883 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14887 #: ../src/guestfs-actions.pod:6208
14888 msgid "guestfs_touch"
14892 #: ../src/guestfs-actions.pod:6210
14896 " guestfs_touch (guestfs_h *g,\n"
14897 " const char *path);\n"
14902 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14904 "Touch acts like the L<touch(1)> command. It can be used to update the "
14905 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14910 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14912 "This command only works on regular files, and will fail on other file types "
14913 "such as directories, symbolic links, block special etc."
14917 #: ../src/guestfs-actions.pod:6225
14918 msgid "guestfs_truncate"
14922 #: ../src/guestfs-actions.pod:6227
14926 " guestfs_truncate (guestfs_h *g,\n"
14927 " const char *path);\n"
14932 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14934 "This command truncates C<path> to a zero-length file. The file must exist "
14939 #: ../src/guestfs-actions.pod:6238
14940 msgid "guestfs_truncate_size"
14944 #: ../src/guestfs-actions.pod:6240
14948 " guestfs_truncate_size (guestfs_h *g,\n"
14949 " const char *path,\n"
14950 " int64_t size);\n"
14955 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14957 "This command truncates C<path> to size C<size> bytes. The file must exist "
14962 #: ../src/guestfs-actions.pod:6248
14964 "If the current file size is less than C<size> then the file is extended to "
14965 "the required size with zero bytes. This creates a sparse file (ie. disk "
14966 "blocks are not allocated for the file until you write to it). To create a "
14967 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14971 #: ../src/guestfs-actions.pod:6258
14972 msgid "guestfs_tune2fs_l"
14976 #: ../src/guestfs-actions.pod:6260
14980 " guestfs_tune2fs_l (guestfs_h *g,\n"
14981 " const char *device);\n"
14986 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
14988 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14993 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
14995 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14996 "for more details. The list of fields returned isn't clearly defined, and "
14997 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14998 "and the filesystem itself."
15002 #: ../src/guestfs-actions.pod:6280
15003 msgid "guestfs_txz_in"
15007 #: ../src/guestfs-actions.pod:6282
15011 " guestfs_txz_in (guestfs_h *g,\n"
15012 " const char *tarball,\n"
15013 " const char *directory);\n"
15018 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
15020 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15021 "tar file) into C<directory>."
15025 #: ../src/guestfs-actions.pod:6294
15026 msgid "guestfs_txz_out"
15030 #: ../src/guestfs-actions.pod:6296
15034 " guestfs_txz_out (guestfs_h *g,\n"
15035 " const char *directory,\n"
15036 " const char *tarball);\n"
15041 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
15043 "This command packs the contents of C<directory> and downloads it to local "
15044 "file C<tarball> (as an xz compressed tar archive)."
15048 #: ../src/guestfs-actions.pod:6308
15049 msgid "guestfs_umask"
15053 #: ../src/guestfs-actions.pod:6310
15057 " guestfs_umask (guestfs_h *g,\n"
15063 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
15065 "This function sets the mask used for creating new files and device nodes to "
15070 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
15072 "Typical umask values would be C<022> which creates new files with "
15073 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15074 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15078 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
15080 "The default umask is C<022>. This is important because it means that "
15081 "directories and device nodes will be created with C<0644> or C<0755> mode "
15082 "even if you specify C<0777>."
15086 #: ../src/guestfs-actions.pod:6326
15088 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15089 "C<guestfs_mkdir>."
15093 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
15094 msgid "This call returns the previous umask."
15098 #: ../src/guestfs-actions.pod:6335
15099 msgid "guestfs_umount"
15103 #: ../src/guestfs-actions.pod:6337
15107 " guestfs_umount (guestfs_h *g,\n"
15108 " const char *pathordevice);\n"
15113 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
15115 "This unmounts the given filesystem. The filesystem may be specified either "
15116 "by its mountpoint (path) or the device which contains the filesystem."
15120 #: ../src/guestfs-actions.pod:6349
15121 msgid "guestfs_umount_all"
15125 #: ../src/guestfs-actions.pod:6351
15129 " guestfs_umount_all (guestfs_h *g);\n"
15134 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
15135 msgid "This unmounts all mounted filesystems."
15139 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
15140 msgid "Some internal mounts are not unmounted by this call."
15144 #: ../src/guestfs-actions.pod:6362
15145 msgid "guestfs_upload"
15149 #: ../src/guestfs-actions.pod:6364
15153 " guestfs_upload (guestfs_h *g,\n"
15154 " const char *filename,\n"
15155 " const char *remotefilename);\n"
15160 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388
15161 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15162 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15166 #: ../src/guestfs-actions.pod:6374
15167 msgid "See also C<guestfs_download>."
15171 #: ../src/guestfs-actions.pod:6380
15172 msgid "guestfs_upload_offset"
15176 #: ../src/guestfs-actions.pod:6382
15180 " guestfs_upload_offset (guestfs_h *g,\n"
15181 " const char *filename,\n"
15182 " const char *remotefilename,\n"
15183 " int64_t offset);\n"
15188 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
15190 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15191 "The intention is to overwrite parts of existing files or devices, although "
15192 "if a non-existant file is specified then it is created with a \"hole\" "
15193 "before C<offset>. The size of the data written is implicit in the size of "
15194 "the source C<filename>."
15198 #: ../src/guestfs-actions.pod:6398
15200 "Note that there is no limit on the amount of data that can be uploaded with "
15201 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15202 "full amount unless an error occurs."
15206 #: ../src/guestfs-actions.pod:6403
15207 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15211 #: ../src/guestfs-actions.pod:6409
15212 msgid "guestfs_utimens"
15216 #: ../src/guestfs-actions.pod:6411
15220 " guestfs_utimens (guestfs_h *g,\n"
15221 " const char *path,\n"
15222 " int64_t atsecs,\n"
15223 " int64_t atnsecs,\n"
15224 " int64_t mtsecs,\n"
15225 " int64_t mtnsecs);\n"
15230 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
15231 msgid "This command sets the timestamps of a file with nanosecond precision."
15235 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
15237 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15242 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
15244 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15245 "nanoseconds from the epoch."
15249 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
15251 "If the C<*nsecs> field contains the special value C<-1> then the "
15252 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15253 "ignored in this case)."
15257 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
15259 "If the C<*nsecs> field contains the special value C<-2> then the "
15260 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15265 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
15266 msgid "guestfs_version"
15270 #: ../src/guestfs-actions.pod:6442
15273 " struct guestfs_version *\n"
15274 " guestfs_version (guestfs_h *g);\n"
15279 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
15281 "Return the libguestfs version number that the program is linked against."
15285 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
15287 "Note that because of dynamic linking this is not necessarily the version of "
15288 "libguestfs that you compiled against. You can compile the program, and then "
15289 "at runtime dynamically link against a completely different C<libguestfs.so> "
15294 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
15296 "This call was added in version C<1.0.58>. In previous versions of "
15297 "libguestfs there was no way to get the version number. From C code you can "
15298 "use dynamic linker functions to find out if this symbol exists (if it "
15299 "doesn't, then it's an earlier version)."
15303 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
15305 "The call returns a structure with four elements. The first three (C<major>, "
15306 "C<minor> and C<release>) are numbers and correspond to the usual version "
15307 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15308 "but may be used for distro-specific information."
15312 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
15314 "To construct the original version string: C<$major.$minor.$release$extra>"
15318 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
15319 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15323 #: ../src/guestfs-actions.pod:6470
15325 "I<Note:> Don't use this call to test for availability of features. In "
15326 "enterprise distributions we backport features from later versions into "
15327 "earlier versions, making this an unreliable way to test for features. Use "
15328 "C<guestfs_available> instead."
15332 #: ../src/guestfs-actions.pod:6476
15334 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15335 "error. I<The caller must call C<guestfs_free_version> after use>."
15339 #: ../src/guestfs-actions.pod:6480
15340 msgid "(Added in 1.0.58)"
15344 #: ../src/guestfs-actions.pod:6482
15345 msgid "guestfs_vfs_label"
15349 #: ../src/guestfs-actions.pod:6484
15353 " guestfs_vfs_label (guestfs_h *g,\n"
15354 " const char *device);\n"
15359 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
15360 msgid "This returns the filesystem label of the filesystem on C<device>."
15364 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
15365 msgid "If the filesystem is unlabeled, this returns the empty string."
15369 #: ../src/guestfs-actions.pod:6493
15370 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15374 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
15375 msgid "(Added in 1.3.18)"
15379 #: ../src/guestfs-actions.pod:6500
15380 msgid "guestfs_vfs_type"
15384 #: ../src/guestfs-actions.pod:6502
15388 " guestfs_vfs_type (guestfs_h *g,\n"
15389 " const char *device);\n"
15394 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
15396 "This command gets the filesystem type corresponding to the filesystem on "
15401 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
15403 "For most filesystems, the result is the name of the Linux VFS module which "
15404 "would be used to mount this filesystem if you mounted it without specifying "
15405 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15409 #: ../src/guestfs-actions.pod:6519
15410 msgid "guestfs_vfs_uuid"
15414 #: ../src/guestfs-actions.pod:6521
15418 " guestfs_vfs_uuid (guestfs_h *g,\n"
15419 " const char *device);\n"
15424 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
15425 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15429 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
15430 msgid "If the filesystem does not have a UUID, this returns the empty string."
15434 #: ../src/guestfs-actions.pod:6530
15435 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15439 #: ../src/guestfs-actions.pod:6537
15440 msgid "guestfs_vg_activate"
15444 #: ../src/guestfs-actions.pod:6539
15448 " guestfs_vg_activate (guestfs_h *g,\n"
15450 " char *const *volgroups);\n"
15455 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
15457 "This command activates or (if C<activate> is false) deactivates all logical "
15458 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15459 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15460 "deactivated, then those devices disappear."
15464 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
15465 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15469 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
15471 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15472 "activated or deactivated."
15476 #: ../src/guestfs-actions.pod:6559
15477 msgid "guestfs_vg_activate_all"
15481 #: ../src/guestfs-actions.pod:6561
15485 " guestfs_vg_activate_all (guestfs_h *g,\n"
15486 " int activate);\n"
15491 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15493 "This command activates or (if C<activate> is false) deactivates all logical "
15494 "volumes in all volume groups. If activated, then they are made known to the "
15495 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15496 "those devices disappear."
15500 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15501 msgid "This command is the same as running C<vgchange -a y|n>"
15505 #: ../src/guestfs-actions.pod:6577
15506 msgid "guestfs_vgcreate"
15510 #: ../src/guestfs-actions.pod:6579
15514 " guestfs_vgcreate (guestfs_h *g,\n"
15515 " const char *volgroup,\n"
15516 " char *const *physvols);\n"
15521 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15523 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15524 "of physical volumes C<physvols>."
15528 #: ../src/guestfs-actions.pod:6591
15529 msgid "guestfs_vglvuuids"
15533 #: ../src/guestfs-actions.pod:6593
15537 " guestfs_vglvuuids (guestfs_h *g,\n"
15538 " const char *vgname);\n"
15543 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15545 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15546 "volumes created in this volume group."
15550 #: ../src/guestfs-actions.pod:6600
15552 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15553 "associate logical volumes and volume groups."
15557 #: ../src/guestfs-actions.pod:6603
15558 msgid "See also C<guestfs_vgpvuuids>."
15562 #: ../src/guestfs-actions.pod:6611
15563 msgid "guestfs_vgpvuuids"
15567 #: ../src/guestfs-actions.pod:6613
15571 " guestfs_vgpvuuids (guestfs_h *g,\n"
15572 " const char *vgname);\n"
15577 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15579 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15580 "volumes that this volume group resides on."
15584 #: ../src/guestfs-actions.pod:6620
15586 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15587 "associate physical volumes and volume groups."
15591 #: ../src/guestfs-actions.pod:6623
15592 msgid "See also C<guestfs_vglvuuids>."
15596 #: ../src/guestfs-actions.pod:6631
15597 msgid "guestfs_vgremove"
15601 #: ../src/guestfs-actions.pod:6633
15605 " guestfs_vgremove (guestfs_h *g,\n"
15606 " const char *vgname);\n"
15611 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15612 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15616 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15618 "This also forcibly removes all logical volumes in the volume group (if any)."
15622 #: ../src/guestfs-actions.pod:6646
15623 msgid "guestfs_vgrename"
15627 #: ../src/guestfs-actions.pod:6648
15631 " guestfs_vgrename (guestfs_h *g,\n"
15632 " const char *volgroup,\n"
15633 " const char *newvolgroup);\n"
15638 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15639 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15643 #: ../src/guestfs-actions.pod:6659
15644 msgid "guestfs_vgs"
15648 #: ../src/guestfs-actions.pod:6661
15652 " guestfs_vgs (guestfs_h *g);\n"
15657 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15659 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15664 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15666 "This returns a list of just the volume group names that were detected (eg. "
15671 #: ../src/guestfs-actions.pod:6670
15672 msgid "See also C<guestfs_vgs_full>."
15676 #: ../src/guestfs-actions.pod:6678
15677 msgid "guestfs_vgs_full"
15681 #: ../src/guestfs-actions.pod:6680
15684 " struct guestfs_lvm_vg_list *\n"
15685 " guestfs_vgs_full (guestfs_h *g);\n"
15690 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15692 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15693 "> command. The \"full\" version includes all fields."
15697 #: ../src/guestfs-actions.pod:6686
15699 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15700 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15704 #: ../src/guestfs-actions.pod:6692
15705 msgid "guestfs_vgscan"
15709 #: ../src/guestfs-actions.pod:6694
15713 " guestfs_vgscan (guestfs_h *g);\n"
15718 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15720 "This rescans all block devices and rebuilds the list of LVM physical "
15721 "volumes, volume groups and logical volumes."
15725 #: ../src/guestfs-actions.pod:6704
15726 msgid "guestfs_vguuid"
15730 #: ../src/guestfs-actions.pod:6706
15734 " guestfs_vguuid (guestfs_h *g,\n"
15735 " const char *vgname);\n"
15740 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15741 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15745 #: ../src/guestfs-actions.pod:6717
15746 msgid "guestfs_wait_ready"
15750 #: ../src/guestfs-actions.pod:6719
15754 " guestfs_wait_ready (guestfs_h *g);\n"
15759 #: ../src/guestfs-actions.pod:6722
15760 msgid "This function is a no op."
15764 #: ../src/guestfs-actions.pod:6724
15766 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15767 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15768 "is no longer necessary because C<guestfs_launch> now does the waiting."
15772 #: ../src/guestfs-actions.pod:6729
15774 "If you see any calls to this function in code then you can just remove them, "
15775 "unless you want to retain compatibility with older versions of the API."
15779 #: ../src/guestfs-actions.pod:6737
15780 msgid "guestfs_wc_c"
15784 #: ../src/guestfs-actions.pod:6739
15788 " guestfs_wc_c (guestfs_h *g,\n"
15789 " const char *path);\n"
15794 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15796 "This command counts the characters in a file, using the C<wc -c> external "
15801 #: ../src/guestfs-actions.pod:6750
15802 msgid "guestfs_wc_l"
15806 #: ../src/guestfs-actions.pod:6752
15810 " guestfs_wc_l (guestfs_h *g,\n"
15811 " const char *path);\n"
15816 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15818 "This command counts the lines in a file, using the C<wc -l> external command."
15822 #: ../src/guestfs-actions.pod:6763
15823 msgid "guestfs_wc_w"
15827 #: ../src/guestfs-actions.pod:6765
15831 " guestfs_wc_w (guestfs_h *g,\n"
15832 " const char *path);\n"
15837 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15839 "This command counts the words in a file, using the C<wc -w> external command."
15843 #: ../src/guestfs-actions.pod:6776
15844 msgid "guestfs_write"
15848 #: ../src/guestfs-actions.pod:6778
15852 " guestfs_write (guestfs_h *g,\n"
15853 " const char *path,\n"
15854 " const char *content,\n"
15855 " size_t content_size);\n"
15860 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15862 "This call creates a file called C<path>. The content of the file is the "
15863 "string C<content> (which can contain any 8 bit data)."
15867 #: ../src/guestfs-actions.pod:6794
15868 msgid "guestfs_write_file"
15872 #: ../src/guestfs-actions.pod:6796
15876 " guestfs_write_file (guestfs_h *g,\n"
15877 " const char *path,\n"
15878 " const char *content,\n"
15884 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15886 "This call creates a file called C<path>. The contents of the file is the "
15887 "string C<content> (which can contain any 8 bit data), with length C<size>."
15891 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15893 "As a special case, if C<size> is C<0> then the length is calculated using "
15894 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15898 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15900 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15901 "I<not> work, even if the length is specified."
15905 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15907 "This function is deprecated. In new code, use the C<write> call instead."
15911 #: ../src/guestfs-actions.pod:6827
15912 msgid "guestfs_zegrep"
15916 #: ../src/guestfs-actions.pod:6829
15920 " guestfs_zegrep (guestfs_h *g,\n"
15921 " const char *regex,\n"
15922 " const char *path);\n"
15927 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15929 "This calls the external C<zegrep> program and returns the matching lines."
15933 #: ../src/guestfs-actions.pod:6846
15934 msgid "guestfs_zegrepi"
15938 #: ../src/guestfs-actions.pod:6848
15942 " guestfs_zegrepi (guestfs_h *g,\n"
15943 " const char *regex,\n"
15944 " const char *path);\n"
15949 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15951 "This calls the external C<zegrep -i> program and returns the matching lines."
15955 #: ../src/guestfs-actions.pod:6865
15956 msgid "guestfs_zero"
15960 #: ../src/guestfs-actions.pod:6867
15964 " guestfs_zero (guestfs_h *g,\n"
15965 " const char *device);\n"
15970 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15971 msgid "This command writes zeroes over the first few blocks of C<device>."
15975 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15977 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15978 "securely wipe the device). It should be sufficient to remove any partition "
15979 "tables, filesystem superblocks and so on."
15983 #: ../src/guestfs-actions.pod:6877
15984 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15988 #: ../src/guestfs-actions.pod:6888
15989 msgid "guestfs_zero_device"
15993 #: ../src/guestfs-actions.pod:6890
15997 " guestfs_zero_device (guestfs_h *g,\n"
15998 " const char *device);\n"
16003 #: ../src/guestfs-actions.pod:6894
16005 "This command writes zeroes over the entire C<device>. Compare with "
16006 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16010 #: ../src/guestfs-actions.pod:6908
16011 msgid "(Added in 1.3.1)"
16015 #: ../src/guestfs-actions.pod:6910
16016 msgid "guestfs_zerofree"
16020 #: ../src/guestfs-actions.pod:6912
16024 " guestfs_zerofree (guestfs_h *g,\n"
16025 " const char *device);\n"
16030 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
16032 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16033 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16034 "possible to compress the filesystem more effectively."
16038 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
16039 msgid "You should B<not> run this program if the filesystem is mounted."
16043 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
16045 "It is possible that using this program can damage the filesystem or data on "
16050 #: ../src/guestfs-actions.pod:6931
16051 msgid "guestfs_zfgrep"
16055 #: ../src/guestfs-actions.pod:6933
16059 " guestfs_zfgrep (guestfs_h *g,\n"
16060 " const char *pattern,\n"
16061 " const char *path);\n"
16066 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
16068 "This calls the external C<zfgrep> program and returns the matching lines."
16072 #: ../src/guestfs-actions.pod:6950
16073 msgid "guestfs_zfgrepi"
16077 #: ../src/guestfs-actions.pod:6952
16081 " guestfs_zfgrepi (guestfs_h *g,\n"
16082 " const char *pattern,\n"
16083 " const char *path);\n"
16088 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
16090 "This calls the external C<zfgrep -i> program and returns the matching lines."
16094 #: ../src/guestfs-actions.pod:6969
16095 msgid "guestfs_zfile"
16099 #: ../src/guestfs-actions.pod:6971
16103 " guestfs_zfile (guestfs_h *g,\n"
16104 " const char *meth,\n"
16105 " const char *path);\n"
16110 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
16112 "This command runs C<file> after first decompressing C<path> using C<method>."
16116 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
16117 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16121 #: ../src/guestfs-actions.pod:6981
16123 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16128 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
16130 "This function is deprecated. In new code, use the C<file> call instead."
16134 #: ../src/guestfs-actions.pod:6996
16135 msgid "guestfs_zgrep"
16139 #: ../src/guestfs-actions.pod:6998
16143 " guestfs_zgrep (guestfs_h *g,\n"
16144 " const char *regex,\n"
16145 " const char *path);\n"
16150 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
16152 "This calls the external C<zgrep> program and returns the matching lines."
16156 #: ../src/guestfs-actions.pod:7015
16157 msgid "guestfs_zgrepi"
16161 #: ../src/guestfs-actions.pod:7017
16165 " guestfs_zgrepi (guestfs_h *g,\n"
16166 " const char *regex,\n"
16167 " const char *path);\n"
16172 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
16174 "This calls the external C<zgrep -i> program and returns the matching lines."
16178 #: ../src/guestfs-availability.pod:3
16183 #: ../src/guestfs-availability.pod:5
16185 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16186 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16187 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16188 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16189 "L</guestfs_aug_save> L</guestfs_aug_set>"
16193 #: ../src/guestfs-availability.pod:21
16198 #: ../src/guestfs-availability.pod:23
16200 "The following functions: L</guestfs_inotify_add_watch> L</"
16201 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16202 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16206 #: ../src/guestfs-availability.pod:31
16207 msgid "B<linuxfsuuid>"
16211 #: ../src/guestfs-availability.pod:33
16213 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16214 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16218 #: ../src/guestfs-availability.pod:40
16219 msgid "B<linuxmodules>"
16223 #: ../src/guestfs-availability.pod:42
16224 msgid "The following functions: L</guestfs_modprobe>"
16228 #: ../src/guestfs-availability.pod:45
16229 msgid "B<linuxxattrs>"
16233 #: ../src/guestfs-availability.pod:47
16235 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16236 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16237 "guestfs_removexattr> L</guestfs_setxattr>"
16241 #: ../src/guestfs-availability.pod:56
16246 #: ../src/guestfs-availability.pod:58
16248 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16249 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16250 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16254 #: ../src/guestfs-availability.pod:67
16259 #: ../src/guestfs-availability.pod:69
16261 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16262 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16263 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16264 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16265 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16266 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16267 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16271 #: ../src/guestfs-availability.pod:92
16276 #: ../src/guestfs-availability.pod:94
16278 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16279 "guestfs_mknod_b> L</guestfs_mknod_c>"
16283 #: ../src/guestfs-availability.pod:100
16288 #: ../src/guestfs-availability.pod:102
16289 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16293 #: ../src/guestfs-availability.pod:105
16294 msgid "B<ntfsprogs>"
16298 #: ../src/guestfs-availability.pod:107
16300 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16304 #: ../src/guestfs-availability.pod:111
16305 msgid "B<realpath>"
16309 #: ../src/guestfs-availability.pod:113
16310 msgid "The following functions: L</guestfs_realpath>"
16314 #: ../src/guestfs-availability.pod:116
16319 #: ../src/guestfs-availability.pod:118
16321 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16322 "guestfs_scrub_freespace>"
16326 #: ../src/guestfs-availability.pod:123
16331 #: ../src/guestfs-availability.pod:125
16332 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16336 #: ../src/guestfs-availability.pod:129
16341 #: ../src/guestfs-availability.pod:131
16342 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16346 #: ../src/guestfs-availability.pod:135
16347 msgid "B<zerofree>"
16351 #: ../src/guestfs-availability.pod:137
16352 msgid "The following functions: L</guestfs_zerofree>"
16356 #: ../src/guestfs-structs.pod:1
16357 msgid "guestfs_int_bool"
16361 #: ../src/guestfs-structs.pod:3
16364 " struct guestfs_int_bool {\n"
16372 #: ../src/guestfs-structs.pod:8
16375 " struct guestfs_int_bool_list {\n"
16376 " uint32_t len; /* Number of elements in list. */\n"
16377 " struct guestfs_int_bool *val; /* Elements. */\n"
16383 #: ../src/guestfs-structs.pod:13
16386 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16387 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16392 #: ../src/guestfs-structs.pod:16
16393 msgid "guestfs_lvm_pv"
16397 #: ../src/guestfs-structs.pod:18
16400 " struct guestfs_lvm_pv {\n"
16401 " char *pv_name;\n"
16402 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16403 " char pv_uuid[32];\n"
16405 " uint64_t pv_size;\n"
16406 " uint64_t dev_size;\n"
16407 " uint64_t pv_free;\n"
16408 " uint64_t pv_used;\n"
16409 " char *pv_attr;\n"
16410 " int64_t pv_pe_count;\n"
16411 " int64_t pv_pe_alloc_count;\n"
16412 " char *pv_tags;\n"
16413 " uint64_t pe_start;\n"
16414 " int64_t pv_mda_count;\n"
16415 " uint64_t pv_mda_free;\n"
16421 #: ../src/guestfs-structs.pod:36
16424 " struct guestfs_lvm_pv_list {\n"
16425 " uint32_t len; /* Number of elements in list. */\n"
16426 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16432 #: ../src/guestfs-structs.pod:41
16435 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16436 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16441 #: ../src/guestfs-structs.pod:44
16442 msgid "guestfs_lvm_vg"
16446 #: ../src/guestfs-structs.pod:46
16449 " struct guestfs_lvm_vg {\n"
16450 " char *vg_name;\n"
16451 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16452 " char vg_uuid[32];\n"
16454 " char *vg_attr;\n"
16455 " uint64_t vg_size;\n"
16456 " uint64_t vg_free;\n"
16457 " char *vg_sysid;\n"
16458 " uint64_t vg_extent_size;\n"
16459 " int64_t vg_extent_count;\n"
16460 " int64_t vg_free_count;\n"
16461 " int64_t max_lv;\n"
16462 " int64_t max_pv;\n"
16463 " int64_t pv_count;\n"
16464 " int64_t lv_count;\n"
16465 " int64_t snap_count;\n"
16466 " int64_t vg_seqno;\n"
16467 " char *vg_tags;\n"
16468 " int64_t vg_mda_count;\n"
16469 " uint64_t vg_mda_free;\n"
16475 #: ../src/guestfs-structs.pod:69
16478 " struct guestfs_lvm_vg_list {\n"
16479 " uint32_t len; /* Number of elements in list. */\n"
16480 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16486 #: ../src/guestfs-structs.pod:74
16489 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16490 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16495 #: ../src/guestfs-structs.pod:77
16496 msgid "guestfs_lvm_lv"
16500 #: ../src/guestfs-structs.pod:79
16503 " struct guestfs_lvm_lv {\n"
16504 " char *lv_name;\n"
16505 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16506 " char lv_uuid[32];\n"
16507 " char *lv_attr;\n"
16508 " int64_t lv_major;\n"
16509 " int64_t lv_minor;\n"
16510 " int64_t lv_kernel_major;\n"
16511 " int64_t lv_kernel_minor;\n"
16512 " uint64_t lv_size;\n"
16513 " int64_t seg_count;\n"
16515 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16516 " float snap_percent;\n"
16517 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16518 " float copy_percent;\n"
16519 " char *move_pv;\n"
16520 " char *lv_tags;\n"
16521 " char *mirror_log;\n"
16522 " char *modules;\n"
16528 #: ../src/guestfs-structs.pod:101
16531 " struct guestfs_lvm_lv_list {\n"
16532 " uint32_t len; /* Number of elements in list. */\n"
16533 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16539 #: ../src/guestfs-structs.pod:106
16542 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16543 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16548 #: ../src/guestfs-structs.pod:111
16551 " struct guestfs_stat {\n"
16555 " int64_t nlink;\n"
16560 " int64_t blksize;\n"
16561 " int64_t blocks;\n"
16562 " int64_t atime;\n"
16563 " int64_t mtime;\n"
16564 " int64_t ctime;\n"
16570 #: ../src/guestfs-structs.pod:127
16573 " struct guestfs_stat_list {\n"
16574 " uint32_t len; /* Number of elements in list. */\n"
16575 " struct guestfs_stat *val; /* Elements. */\n"
16581 #: ../src/guestfs-structs.pod:132
16584 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16585 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16590 #: ../src/guestfs-structs.pod:137
16593 " struct guestfs_statvfs {\n"
16594 " int64_t bsize;\n"
16595 " int64_t frsize;\n"
16596 " int64_t blocks;\n"
16597 " int64_t bfree;\n"
16598 " int64_t bavail;\n"
16599 " int64_t files;\n"
16600 " int64_t ffree;\n"
16601 " int64_t favail;\n"
16604 " int64_t namemax;\n"
16610 #: ../src/guestfs-structs.pod:151
16613 " struct guestfs_statvfs_list {\n"
16614 " uint32_t len; /* Number of elements in list. */\n"
16615 " struct guestfs_statvfs *val; /* Elements. */\n"
16621 #: ../src/guestfs-structs.pod:156
16624 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16625 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16630 #: ../src/guestfs-structs.pod:159
16631 msgid "guestfs_dirent"
16635 #: ../src/guestfs-structs.pod:161
16638 " struct guestfs_dirent {\n"
16647 #: ../src/guestfs-structs.pod:167
16650 " struct guestfs_dirent_list {\n"
16651 " uint32_t len; /* Number of elements in list. */\n"
16652 " struct guestfs_dirent *val; /* Elements. */\n"
16658 #: ../src/guestfs-structs.pod:172
16661 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16662 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16667 #: ../src/guestfs-structs.pod:177
16670 " struct guestfs_version {\n"
16671 " int64_t major;\n"
16672 " int64_t minor;\n"
16673 " int64_t release;\n"
16680 #: ../src/guestfs-structs.pod:184
16683 " struct guestfs_version_list {\n"
16684 " uint32_t len; /* Number of elements in list. */\n"
16685 " struct guestfs_version *val; /* Elements. */\n"
16691 #: ../src/guestfs-structs.pod:189
16694 " void guestfs_free_version (struct guestfs_free_version *);\n"
16695 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16700 #: ../src/guestfs-structs.pod:192
16701 msgid "guestfs_xattr"
16705 #: ../src/guestfs-structs.pod:194
16708 " struct guestfs_xattr {\n"
16709 " char *attrname;\n"
16710 " /* The next two fields describe a byte array. */\n"
16711 " uint32_t attrval_len;\n"
16712 " char *attrval;\n"
16718 #: ../src/guestfs-structs.pod:201
16721 " struct guestfs_xattr_list {\n"
16722 " uint32_t len; /* Number of elements in list. */\n"
16723 " struct guestfs_xattr *val; /* Elements. */\n"
16729 #: ../src/guestfs-structs.pod:206
16732 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16733 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16738 #: ../src/guestfs-structs.pod:209
16739 msgid "guestfs_inotify_event"
16743 #: ../src/guestfs-structs.pod:211
16746 " struct guestfs_inotify_event {\n"
16747 " int64_t in_wd;\n"
16748 " uint32_t in_mask;\n"
16749 " uint32_t in_cookie;\n"
16750 " char *in_name;\n"
16756 #: ../src/guestfs-structs.pod:218
16759 " struct guestfs_inotify_event_list {\n"
16760 " uint32_t len; /* Number of elements in list. */\n"
16761 " struct guestfs_inotify_event *val; /* Elements. */\n"
16767 #: ../src/guestfs-structs.pod:223
16770 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16771 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16776 #: ../src/guestfs-structs.pod:226
16777 msgid "guestfs_partition"
16781 #: ../src/guestfs-structs.pod:228
16784 " struct guestfs_partition {\n"
16785 " int32_t part_num;\n"
16786 " uint64_t part_start;\n"
16787 " uint64_t part_end;\n"
16788 " uint64_t part_size;\n"
16794 #: ../src/guestfs-structs.pod:235
16797 " struct guestfs_partition_list {\n"
16798 " uint32_t len; /* Number of elements in list. */\n"
16799 " struct guestfs_partition *val; /* Elements. */\n"
16805 #: ../src/guestfs-structs.pod:240
16808 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16809 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16814 #: ../src/guestfs-structs.pod:243
16815 msgid "guestfs_application"
16819 #: ../src/guestfs-structs.pod:245
16822 " struct guestfs_application {\n"
16823 " char *app_name;\n"
16824 " char *app_display_name;\n"
16825 " int32_t app_epoch;\n"
16826 " char *app_version;\n"
16827 " char *app_release;\n"
16828 " char *app_install_path;\n"
16829 " char *app_trans_path;\n"
16830 " char *app_publisher;\n"
16831 " char *app_url;\n"
16832 " char *app_source_package;\n"
16833 " char *app_summary;\n"
16834 " char *app_description;\n"
16840 #: ../src/guestfs-structs.pod:260
16843 " struct guestfs_application_list {\n"
16844 " uint32_t len; /* Number of elements in list. */\n"
16845 " struct guestfs_application *val; /* Elements. */\n"
16851 #: ../src/guestfs-structs.pod:265
16854 " void guestfs_free_application (struct guestfs_free_application *);\n"
16855 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16860 #: ../fish/guestfish.pod:5
16861 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16865 #: ../fish/guestfish.pod:9
16868 " guestfish [--options] [commands]\n"
16873 #: ../fish/guestfish.pod:11
16881 #: ../fish/guestfish.pod:13
16884 " guestfish [--ro|--rw] -a disk.img\n"
16889 #: ../fish/guestfish.pod:15
16892 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16897 #: ../fish/guestfish.pod:17
16900 " guestfish -d libvirt-domain\n"
16905 #: ../fish/guestfish.pod:19
16908 " guestfish [--ro|--rw] -a disk.img -i\n"
16913 #: ../fish/guestfish.pod:21
16916 " guestfish -d libvirt-domain -i\n"
16921 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16922 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16923 #: ../tools/virt-rescue.pl:41
16928 #: ../fish/guestfish.pod:25
16930 "Using guestfish in read/write mode on live virtual machines can be "
16931 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16932 "option to use guestfish safely if the disk image or virtual machine might be "
16937 #: ../fish/guestfish.pod:32
16939 "Guestfish is a shell and command-line tool for examining and modifying "
16940 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16941 "functionality of the guestfs API, see L<guestfs(3)>."
16945 #: ../fish/guestfish.pod:36
16947 "Guestfish gives you structured access to the libguestfs API, from shell "
16948 "scripts or the command line or interactively. If you want to rescue a "
16949 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16954 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847
16955 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16956 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16961 #: ../fish/guestfish.pod:43
16962 msgid "As an interactive shell"
16966 #: ../fish/guestfish.pod:45
16974 #: ../fish/guestfish.pod:47
16977 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16978 " editing virtual machine filesystems.\n"
16983 #: ../fish/guestfish.pod:50
16986 " Type: 'help' for a list of commands\n"
16987 " 'man' to read the manual\n"
16988 " 'quit' to quit the shell\n"
16993 #: ../fish/guestfish.pod:54
16996 " ><fs> add-ro disk.img\n"
16998 " ><fs> list-filesystems\n"
16999 " /dev/sda1: ext4\n"
17000 " /dev/vg_guest/lv_root: ext4\n"
17001 " /dev/vg_guest/lv_swap: swap\n"
17002 " ><fs> mount /dev/vg_guest/lv_root /\n"
17003 " ><fs> cat /etc/fstab\n"
17005 " # Created by anaconda\n"
17012 #: ../fish/guestfish.pod:67
17013 msgid "From shell scripts"
17017 #: ../fish/guestfish.pod:69
17018 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17022 #: ../fish/guestfish.pod:71
17025 " guestfish <<_EOF_\n"
17028 " mount /dev/vg_guest/lv_root /\n"
17029 " write /etc/motd \"Welcome, new users\"\n"
17035 #: ../fish/guestfish.pod:78
17036 msgid "List the LVM logical volumes in a disk image:"
17040 #: ../fish/guestfish.pod:80
17043 " guestfish -a disk.img --ro <<_EOF_\n"
17051 #: ../fish/guestfish.pod:85
17052 msgid "List all the filesystems in a disk image:"
17056 #: ../fish/guestfish.pod:87
17059 " guestfish -a disk.img --ro <<_EOF_\n"
17061 " list-filesystems\n"
17067 #: ../fish/guestfish.pod:92
17068 msgid "On one command line"
17072 #: ../fish/guestfish.pod:94
17073 msgid "Update C</etc/resolv.conf> in a guest:"
17077 #: ../fish/guestfish.pod:96
17081 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17082 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17087 #: ../fish/guestfish.pod:100
17088 msgid "Edit C</boot/grub/grub.conf> interactively:"
17092 #: ../fish/guestfish.pod:102
17095 " guestfish --rw --add disk.img \\\n"
17096 " --mount /dev/vg_guest/lv_root \\\n"
17097 " --mount /dev/sda1:/boot \\\n"
17098 " edit /boot/grub/grub.conf\n"
17103 #: ../fish/guestfish.pod:107
17104 msgid "Mount disks automatically"
17108 #: ../fish/guestfish.pod:109
17110 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17114 #: ../fish/guestfish.pod:112
17117 " guestfish --ro -a disk.img -i cat /etc/group\n"
17122 #: ../fish/guestfish.pod:114
17125 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17130 #: ../fish/guestfish.pod:116
17131 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17135 #: ../fish/guestfish.pod:118
17138 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17143 #: ../fish/guestfish.pod:120
17144 msgid "As a script interpreter"
17148 #: ../fish/guestfish.pod:122
17149 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17153 #: ../fish/guestfish.pod:124
17156 " #!/usr/bin/guestfish -f\n"
17157 " sparse test1.img 100M\n"
17159 " part-disk /dev/sda mbr\n"
17160 " mkfs ext2 /dev/sda1\n"
17165 #: ../fish/guestfish.pod:130
17166 msgid "Start with a prepared disk"
17170 #: ../fish/guestfish.pod:132
17172 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17173 "single ext2-formatted partition:"
17177 #: ../fish/guestfish.pod:135
17180 " guestfish -N fs\n"
17185 #: ../fish/guestfish.pod:137
17186 msgid "To list what is available do:"
17190 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
17193 " guestfish -N help | less\n"
17198 #: ../fish/guestfish.pod:141
17199 msgid "Remote control"
17203 #: ../fish/guestfish.pod:143
17206 " eval \"`guestfish --listen`\"\n"
17207 " guestfish --remote add-ro disk.img\n"
17208 " guestfish --remote run\n"
17209 " guestfish --remote lvs\n"
17214 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17215 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
17216 #: ../tools/virt-win-reg.pl:171 ../tools/virt-resize.pl:256
17217 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
17218 #: ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153
17219 #: ../tools/virt-list-partitions.pl:54
17224 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17225 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179
17226 #: ../tools/virt-resize.pl:264 ../tools/virt-list-filesystems.pl:61
17227 #: ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111
17228 #: ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
17233 #: ../fish/guestfish.pod:154
17234 msgid "Displays general help on options."
17238 #: ../fish/guestfish.pod:156
17239 msgid "B<-h> | B<--cmd-help>"
17243 #: ../fish/guestfish.pod:158
17244 msgid "Lists all available guestfish commands."
17248 #: ../fish/guestfish.pod:160
17249 msgid "B<-h cmd> | B<--cmd-help cmd>"
17253 #: ../fish/guestfish.pod:162
17254 msgid "Displays detailed help on a single command C<cmd>."
17258 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17259 msgid "B<-a image> | B<--add image>"
17263 #: ../fish/guestfish.pod:166
17264 msgid "Add a block device or virtual machine image to the shell."
17268 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17270 "The format of the disk image is auto-detected. To override this and force a "
17271 "particular format use the I<--format=..> option."
17275 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17276 msgid "B<-c URI> | B<--connect URI>"
17280 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17282 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17283 "URI to use. The default is to use the default libvirt connection."
17287 #: ../fish/guestfish.pod:177
17292 #: ../fish/guestfish.pod:179
17294 "If using the I<--listen> option and a csh-like shell, use this option. See "
17295 "section L</REMOTE CONTROL AND CSH> below."
17299 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17300 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17304 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17306 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17307 "used, then any libvirt domain can be used. However in write mode, only "
17308 "libvirt domains which are shut down can be named here."
17312 #: ../fish/guestfish.pod:188
17313 msgid "B<-D> | B<--no-dest-paths>"
17317 #: ../fish/guestfish.pod:190
17319 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17320 "to hit the tab key to complete paths on the guest filesystem, but this "
17321 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17322 "allow this feature to be disabled."
17326 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17327 msgid "B<--echo-keys>"
17331 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17333 "When prompting for keys and passphrases, guestfish normally turns echoing "
17334 "off so you cannot see what you are typing. If you are not worried about "
17335 "Tempest attacks and there is no one else in the room you can specify this "
17336 "flag to see what you are typing."
17340 #: ../fish/guestfish.pod:202
17341 msgid "B<-f file> | B<--file file>"
17345 #: ../fish/guestfish.pod:204
17346 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17350 #: ../fish/guestfish.pod:207
17353 " #!/usr/bin/guestfish -f\n"
17358 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17359 msgid "B<--format=raw|qcow2|..> | B<--format>"
17363 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17365 "The default for the I<-a> option is to auto-detect the format of the disk "
17366 "image. Using this forces the disk format for I<-a> options which follow on "
17367 "the command line. Using I<--format> with no argument switches back to auto-"
17368 "detection for subsequent I<-a> options."
17372 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17373 msgid "For example:"
17377 #: ../fish/guestfish.pod:218
17380 " guestfish --format=raw -a disk.img\n"
17385 #: ../fish/guestfish.pod:220
17386 msgid "forces raw format (no auto-detection) for C<disk.img>."
17390 #: ../fish/guestfish.pod:222
17393 " guestfish --format=raw -a disk.img --format -a another.img\n"
17398 #: ../fish/guestfish.pod:224
17400 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17401 "detection for C<another.img>."
17405 #: ../fish/guestfish.pod:227
17407 "If you have untrusted raw-format guest disk images, you should use this "
17408 "option to specify the disk format. This avoids a possible security problem "
17409 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17413 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17414 msgid "B<-i> | B<--inspector>"
17418 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17420 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17421 "system and mount filesystems as they would be mounted on the real virtual "
17426 #: ../fish/guestfish.pod:238
17427 msgid "Typical usage is either:"
17431 #: ../fish/guestfish.pod:240
17434 " guestfish -d myguest -i\n"
17439 #: ../fish/guestfish.pod:242
17440 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17444 #: ../fish/guestfish.pod:244
17447 " guestfish --ro -d myguest -i\n"
17452 #: ../fish/guestfish.pod:246
17453 msgid "(for active domains, readonly), or specify the block device directly:"
17457 #: ../fish/guestfish.pod:248
17460 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17465 #: ../fish/guestfish.pod:250
17467 "Note that the command line syntax changed slightly over older versions of "
17468 "guestfish. You can still use the old syntax:"
17472 #: ../fish/guestfish.pod:253
17475 " guestfish [--ro] -i disk.img\n"
17480 #: ../fish/guestfish.pod:255
17483 " guestfish [--ro] -i libvirt-domain\n"
17488 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17489 msgid "B<--keys-from-stdin>"
17493 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17495 "Read key or passphrase parameters from stdin. The default is to try to read "
17496 "passphrases from the user by opening C</dev/tty>."
17500 #: ../fish/guestfish.pod:262
17501 msgid "B<--listen>"
17505 #: ../fish/guestfish.pod:264
17507 "Fork into the background and listen for remote commands. See section L</"
17508 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17512 #: ../fish/guestfish.pod:267
17513 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17517 #: ../fish/guestfish.pod:269
17518 msgid "Mount the named partition or logical volume on the given mountpoint."
17522 #: ../fish/guestfish.pod:271
17523 msgid "If the mountpoint is omitted, it defaults to C</>."
17527 #: ../fish/guestfish.pod:273
17528 msgid "You have to mount something on C</> before most commands will work."
17532 #: ../fish/guestfish.pod:275
17534 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17539 #: ../fish/guestfish.pod:278
17541 "If you don't know what filesystems a disk image contains, you can either run "
17542 "guestfish without this option, then list the partitions, filesystems and LVs "
17543 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17544 "commands), or you can use the L<virt-filesystems(1)> program."
17548 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17549 msgid "B<-n> | B<--no-sync>"
17553 #: ../fish/guestfish.pod:286
17555 "Disable autosync. This is enabled by default. See the discussion of "
17556 "autosync in the L<guestfs(3)> manpage."
17560 #: ../fish/guestfish.pod:289
17561 msgid "B<-N type> | B<--new type> | B<-N help>"
17565 #: ../fish/guestfish.pod:291
17567 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17568 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17569 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17574 #: ../fish/guestfish.pod:296
17575 msgid "B<--progress-bars>"
17579 #: ../fish/guestfish.pod:298
17580 msgid "Enable progress bars, even when guestfish is used non-interactively."
17584 #: ../fish/guestfish.pod:300
17586 "Progress bars are enabled by default when guestfish is used as an "
17587 "interactive shell."
17591 #: ../fish/guestfish.pod:303
17592 msgid "B<--no-progress-bars>"
17596 #: ../fish/guestfish.pod:305
17597 msgid "Disable progress bars."
17601 #: ../fish/guestfish.pod:307
17602 msgid "B<--remote[=pid]>"
17606 #: ../fish/guestfish.pod:309
17608 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17609 "CONTROL GUESTFISH OVER A SOCKET> below."
17613 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17614 msgid "B<-r> | B<--ro>"
17618 #: ../fish/guestfish.pod:314
17620 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17621 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17625 #: ../fish/guestfish.pod:317 ../tools/virt-rescue.pl:187
17627 "The option must always be used if the disk image or virtual machine might be "
17628 "running, and is generally recommended in cases where you don't need write "
17629 "access to the disk."
17633 #: ../fish/guestfish.pod:321
17635 "Note that prepared disk images created with I<-N> are not affected by the "
17640 #: ../fish/guestfish.pod:324
17641 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17645 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17646 #: ../tools/virt-rescue.pl:195
17647 msgid "B<--selinux>"
17651 #: ../fish/guestfish.pod:328
17652 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17656 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17657 msgid "B<-v> | B<--verbose>"
17661 #: ../fish/guestfish.pod:332
17663 "Enable very verbose messages. This is particularly useful if you find a bug."
17667 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17668 msgid "B<-V> | B<--version>"
17672 #: ../fish/guestfish.pod:337
17673 msgid "Display the guestfish / libguestfs version number and exit."
17677 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17678 msgid "B<-w> | B<--rw>"
17682 #: ../fish/guestfish.pod:341
17684 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17689 #: ../fish/guestfish.pod:344
17694 #: ../fish/guestfish.pod:346
17695 msgid "Echo each command before executing it."
17699 #: ../fish/guestfish.pod:350
17700 msgid "COMMANDS ON COMMAND LINE"
17704 #: ../fish/guestfish.pod:352
17706 "Any additional (non-option) arguments are treated as commands to execute."
17710 #: ../fish/guestfish.pod:355
17712 "Commands to execute should be separated by a colon (C<:>), where the colon "
17713 "is a separate parameter. Thus:"
17717 #: ../fish/guestfish.pod:358
17720 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17725 #: ../fish/guestfish.pod:360
17727 "If there are no additional arguments, then we enter a shell, either an "
17728 "interactive shell with a prompt (if the input is a terminal) or a non-"
17729 "interactive shell."
17733 #: ../fish/guestfish.pod:364
17735 "In either command line mode or non-interactive shell, the first command that "
17736 "gives an error causes the whole shell to exit. In interactive mode (with a "
17737 "prompt) if a command fails, you can continue to enter commands."
17741 #: ../fish/guestfish.pod:369
17742 msgid "USING launch (OR run)"
17746 #: ../fish/guestfish.pod:371
17748 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17749 "then launch it, then mount any disks you need, and finally issue actions/"
17750 "commands. So the general order of the day is:"
17754 #: ../fish/guestfish.pod:379
17755 msgid "add or -a/--add"
17759 #: ../fish/guestfish.pod:383
17760 msgid "launch (aka run)"
17764 #: ../fish/guestfish.pod:387
17765 msgid "mount or -m/--mount"
17769 #: ../fish/guestfish.pod:391
17770 msgid "any other commands"
17774 #: ../fish/guestfish.pod:395
17776 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17777 "guest before mounting or performing any other commands."
17781 #: ../fish/guestfish.pod:398
17783 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17784 "I<--new> options were given then C<run> is done automatically, simply "
17785 "because guestfish can't perform the action you asked for without doing this."
17789 #: ../fish/guestfish.pod:403
17790 msgid "OPENING DISKS FOR READ AND WRITE"
17794 #: ../fish/guestfish.pod:405
17796 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17797 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17798 "open disk images read-only or for writing."
17802 #: ../fish/guestfish.pod:409
17804 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17805 "disk images supplied on the command line for write. To open a disk image "
17806 "read-only you have to do I<-a image --ro>."
17810 #: ../fish/guestfish.pod:413
17812 "This matters: If you accidentally open a live VM disk image writable then "
17813 "you will cause irreversible disk corruption."
17817 #: ../fish/guestfish.pod:416
17819 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17820 "images will be opened read-only. You will have to either specify "
17821 "I<guestfish --rw> or change a configuration file in order to get write "
17822 "access for disk images specified by those other command line options."
17826 #: ../fish/guestfish.pod:421
17828 "This version of guestfish has a I<--rw> option which does nothing (it is "
17829 "already the default). However it is highly recommended that you use this "
17830 "option to indicate that guestfish needs write access, and to prepare your "
17831 "scripts for the day when this option will be required for write access."
17835 #: ../fish/guestfish.pod:427
17837 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17838 "other libguestfs program apart from guestfish and guestmount."
17842 #: ../fish/guestfish.pod:430
17847 #: ../fish/guestfish.pod:432
17849 "You can quote ordinary parameters using either single or double quotes. For "
17854 #: ../fish/guestfish.pod:435
17857 " add \"file with a space.img\"\n"
17862 #: ../fish/guestfish.pod:437
17865 " rm '/file name'\n"
17870 #: ../fish/guestfish.pod:439
17878 #: ../fish/guestfish.pod:441
17880 "A few commands require a list of strings to be passed. For these, use a "
17881 "whitespace-separated list, enclosed in quotes. Strings containing "
17882 "whitespace to be passed through must be enclosed in single quotes. A "
17883 "literal single quote must be escaped with a backslash."
17887 #: ../fish/guestfish.pod:446
17890 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17891 " command \"/bin/echo 'foo bar'\"\n"
17892 " command \"/bin/echo \\'foo\\'\"\n"
17897 #: ../fish/guestfish.pod:450
17898 msgid "OPTIONAL ARGUMENTS"
17902 #: ../fish/guestfish.pod:452
17904 "Some commands take optional arguments. These arguments appear in this "
17905 "documentation as C<[argname:..]>. You can use them as in these examples:"
17909 #: ../fish/guestfish.pod:456
17912 " add-drive-opts filename\n"
17917 #: ../fish/guestfish.pod:458
17920 " add-drive-opts filename readonly:true\n"
17925 #: ../fish/guestfish.pod:460
17928 " add-drive-opts filename format:qcow2 readonly:false\n"
17933 #: ../fish/guestfish.pod:462
17935 "Each optional argument can appear at most once. All optional arguments must "
17936 "appear after the required ones."
17940 #: ../fish/guestfish.pod:465
17945 #: ../fish/guestfish.pod:467
17947 "This section applies to all commands which can take integers as parameters."
17951 #: ../fish/guestfish.pod:470
17952 msgid "SIZE SUFFIX"
17956 #: ../fish/guestfish.pod:472
17958 "When the command takes a parameter measured in bytes, you can use one of the "
17959 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17963 #: ../fish/guestfish.pod:478
17964 msgid "B<k> or B<K> or B<KiB>"
17968 #: ../fish/guestfish.pod:480
17969 msgid "The size in kilobytes (multiplied by 1024)."
17973 #: ../fish/guestfish.pod:482
17978 #: ../fish/guestfish.pod:484
17979 msgid "The size in SI 1000 byte units."
17983 #: ../fish/guestfish.pod:486
17984 msgid "B<M> or B<MiB>"
17988 #: ../fish/guestfish.pod:488
17989 msgid "The size in megabytes (multiplied by 1048576)."
17993 #: ../fish/guestfish.pod:490
17998 #: ../fish/guestfish.pod:492
17999 msgid "The size in SI 1000000 byte units."
18003 #: ../fish/guestfish.pod:494
18004 msgid "B<G> or B<GiB>"
18008 #: ../fish/guestfish.pod:496
18009 msgid "The size in gigabytes (multiplied by 2**30)."
18013 #: ../fish/guestfish.pod:498
18018 #: ../fish/guestfish.pod:500
18019 msgid "The size in SI 10**9 byte units."
18023 #: ../fish/guestfish.pod:502
18024 msgid "B<T> or B<TiB>"
18028 #: ../fish/guestfish.pod:504
18029 msgid "The size in terabytes (multiplied by 2**40)."
18033 #: ../fish/guestfish.pod:506
18038 #: ../fish/guestfish.pod:508
18039 msgid "The size in SI 10**12 byte units."
18043 #: ../fish/guestfish.pod:510
18044 msgid "B<P> or B<PiB>"
18048 #: ../fish/guestfish.pod:512
18049 msgid "The size in petabytes (multiplied by 2**50)."
18053 #: ../fish/guestfish.pod:514
18058 #: ../fish/guestfish.pod:516
18059 msgid "The size in SI 10**15 byte units."
18063 #: ../fish/guestfish.pod:518
18064 msgid "B<E> or B<EiB>"
18068 #: ../fish/guestfish.pod:520
18069 msgid "The size in exabytes (multiplied by 2**60)."
18073 #: ../fish/guestfish.pod:522
18078 #: ../fish/guestfish.pod:524
18079 msgid "The size in SI 10**18 byte units."
18083 #: ../fish/guestfish.pod:526
18084 msgid "B<Z> or B<ZiB>"
18088 #: ../fish/guestfish.pod:528
18089 msgid "The size in zettabytes (multiplied by 2**70)."
18093 #: ../fish/guestfish.pod:530
18098 #: ../fish/guestfish.pod:532
18099 msgid "The size in SI 10**21 byte units."
18103 #: ../fish/guestfish.pod:534
18104 msgid "B<Y> or B<YiB>"
18108 #: ../fish/guestfish.pod:536
18109 msgid "The size in yottabytes (multiplied by 2**80)."
18113 #: ../fish/guestfish.pod:538
18118 #: ../fish/guestfish.pod:540
18119 msgid "The size in SI 10**24 byte units."
18123 #: ../fish/guestfish.pod:546
18126 " truncate-size /file 1G\n"
18131 #: ../fish/guestfish.pod:548
18132 msgid "would truncate the file to 1 gigabyte."
18136 #: ../fish/guestfish.pod:550
18138 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18139 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18140 "suffix will probably not do what you expect."
18144 #: ../fish/guestfish.pod:554
18145 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18149 #: ../fish/guestfish.pod:556
18151 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18152 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18156 #: ../fish/guestfish.pod:559
18159 " 1234 decimal number 1234\n"
18160 " 02322 octal number, equivalent to decimal 1234\n"
18161 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18166 #: ../fish/guestfish.pod:563
18168 "When using the C<chmod> command, you almost always want to specify an octal "
18169 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18170 "L<chmod(1)> program):"
18174 #: ../fish/guestfish.pod:567
18177 " chmod 0777 /public # OK\n"
18178 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18183 #: ../fish/guestfish.pod:570
18185 "Commands that return numbers usually print them in decimal, but some "
18186 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18187 "octal, preceeded by C<0>)."
18191 #: ../fish/guestfish.pod:574
18192 msgid "WILDCARDS AND GLOBBING"
18196 #: ../fish/guestfish.pod:576
18198 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18199 "(globbing) by default. So for example the following will not do what you "
18204 #: ../fish/guestfish.pod:580
18212 #: ../fish/guestfish.pod:582
18214 "Assuming you don't have a directory called literally C</home/*> then the "
18215 "above command will return an error."
18219 #: ../fish/guestfish.pod:585
18220 msgid "To perform wildcard expansion, use the C<glob> command."
18224 #: ../fish/guestfish.pod:587
18227 " glob rm-rf /home/*\n"
18232 #: ../fish/guestfish.pod:589
18234 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18235 "many times), equivalent to:"
18239 #: ../fish/guestfish.pod:592
18242 " rm-rf /home/jim\n"
18243 " rm-rf /home/joe\n"
18244 " rm-rf /home/mary\n"
18249 #: ../fish/guestfish.pod:596
18250 msgid "C<glob> only works on simple guest paths and not on device names."
18254 #: ../fish/guestfish.pod:598
18256 "If you have several parameters, each containing a wildcard, then glob will "
18257 "perform a Cartesian product."
18261 #: ../fish/guestfish.pod:601
18266 #: ../fish/guestfish.pod:603
18268 "Any line which starts with a I<#> character is treated as a comment and "
18269 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18270 "a command. For example:"
18274 #: ../fish/guestfish.pod:607
18277 " # this is a comment\n"
18278 " # this is a comment\n"
18279 " foo # NOT a comment\n"
18284 #: ../fish/guestfish.pod:611
18285 msgid "Blank lines are also ignored."
18289 #: ../fish/guestfish.pod:613
18290 msgid "RUNNING COMMANDS LOCALLY"
18294 #: ../fish/guestfish.pod:615
18296 "Any line which starts with a I<!> character is treated as a command sent to "
18297 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18301 #: ../fish/guestfish.pod:619
18305 " tgz-out /remote local/remote-data.tar.gz\n"
18310 #: ../fish/guestfish.pod:622
18312 "will create a directory C<local> on the host, and then export the contents "
18313 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18314 "(See C<tgz-out>)."
18318 #: ../fish/guestfish.pod:626
18320 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18321 "effect, due to the way that subprocesses work in Unix."
18325 #: ../fish/guestfish.pod:629
18330 #: ../fish/guestfish.pod:631
18332 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18333 "command (a guestfish command) to the second command (any host command). For "
18338 #: ../fish/guestfish.pod:635
18341 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18346 #: ../fish/guestfish.pod:637
18348 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18349 "program). The above command would list all accounts in the guest filesystem "
18350 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18354 #: ../fish/guestfish.pod:642
18357 " hexdump /bin/ls | head\n"
18358 " list-devices | tail -1\n"
18359 " tgz-out / - | tar ztf -\n"
18364 #: ../fish/guestfish.pod:646
18366 "The space before the pipe symbol is required, any space after the pipe "
18367 "symbol is optional. Everything after the pipe symbol is just passed "
18368 "straight to the host shell, so it can contain redirections, globs and "
18369 "anything else that makes sense on the host side."
18373 #: ../fish/guestfish.pod:651
18375 "To use a literal argument which begins with a pipe symbol, you have to quote "
18380 #: ../fish/guestfish.pod:654
18388 #: ../fish/guestfish.pod:656
18389 msgid "HOME DIRECTORIES"
18393 #: ../fish/guestfish.pod:658
18395 "If a parameter starts with the character C<~> then the tilde may be expanded "
18396 "as a home directory path (either C<~> for the current user's home directory, "
18397 "or C<~user> for another user)."
18401 #: ../fish/guestfish.pod:662
18403 "Note that home directory expansion happens for users known I<on the host>, "
18404 "not in the guest filesystem."
18408 #: ../fish/guestfish.pod:665
18410 "To use a literal argument which begins with a tilde, you have to quote it, "
18415 #: ../fish/guestfish.pod:668
18423 #: ../fish/guestfish.pod:672
18425 "Libguestfs has some support for Linux guests encrypted according to the "
18426 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18427 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18428 "LUKS is supported."
18432 #: ../fish/guestfish.pod:677
18433 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18437 #: ../fish/guestfish.pod:679
18440 " ><fs> vfs-type /dev/sda2\n"
18446 #: ../fish/guestfish.pod:682
18448 "Then open those devices using L</luks-open>. This creates a device-mapper "
18449 "device called C</dev/mapper/luksdev>."
18453 #: ../fish/guestfish.pod:685
18456 " ><fs> luks-open /dev/sda2 luksdev\n"
18457 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18462 #: ../fish/guestfish.pod:688
18464 "Finally you have to tell LVM to scan for volume groups on the newly created "
18469 #: ../fish/guestfish.pod:691
18473 " vg-activate-all true\n"
18478 #: ../fish/guestfish.pod:694
18479 msgid "The logical volume(s) can now be mounted in the usual way."
18483 #: ../fish/guestfish.pod:696
18485 "Before closing a LUKS device you must unmount any logical volumes on it and "
18486 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18487 "one. Then you can close the mapper device:"
18491 #: ../fish/guestfish.pod:700
18494 " vg-activate false /dev/VG\n"
18495 " luks-close /dev/mapper/luksdev\n"
18500 #: ../fish/guestfish.pod:703
18501 msgid "WINDOWS PATHS"
18505 #: ../fish/guestfish.pod:705
18507 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18508 "(with some limitations). The following commands are equivalent:"
18512 #: ../fish/guestfish.pod:708
18515 " file /WINDOWS/system32/config/system.LOG\n"
18520 #: ../fish/guestfish.pod:710
18523 " file win:/windows/system32/config/system.log\n"
18528 #: ../fish/guestfish.pod:712
18531 " file win:\\windows\\system32\\config\\system.log\n"
18536 #: ../fish/guestfish.pod:714
18539 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18544 #: ../fish/guestfish.pod:716
18546 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18547 "handles case insensitivity like Windows would. This only works in argument "
18548 "positions that expect a path."
18552 #: ../fish/guestfish.pod:720
18553 msgid "UPLOADING AND DOWNLOADING FILES"
18557 #: ../fish/guestfish.pod:722
18559 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18560 "others which upload from or download to a local file, you can use the "
18561 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18565 #: ../fish/guestfish.pod:726
18573 #: ../fish/guestfish.pod:728
18575 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18579 #: ../fish/guestfish.pod:731
18582 " tar-out /etc - | tar tf -\n"
18587 #: ../fish/guestfish.pod:733
18589 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18590 "command (see L</PIPES>)."
18594 #: ../fish/guestfish.pod:736
18596 "When using C<-> to read from stdin, the input is read up to the end of "
18597 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18598 "some arbitrary end marker:"
18602 #: ../fish/guestfish.pod:740
18605 " upload -<<END /foo\n"
18614 #: ../fish/guestfish.pod:746
18616 "Any string of characters can be used instead of C<END>. The end marker must "
18617 "appear on a line of its own, without any preceeding or following characters "
18618 "(not even spaces)."
18622 #: ../fish/guestfish.pod:750
18624 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18625 "upload local files (so-called \"FileIn\" parameters in the generator)."
18629 #: ../fish/guestfish.pod:753
18630 msgid "EXIT ON ERROR BEHAVIOUR"
18634 #: ../fish/guestfish.pod:755
18636 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18637 "taking commands from a human over a tty), and will exit on the first error "
18638 "in non-interactive mode (scripts, commands given on the command line)."
18642 #: ../fish/guestfish.pod:760
18644 "If you prefix a command with a I<-> character, then that command will not "
18645 "cause guestfish to exit, even if that (one) command returns an error."
18649 #: ../fish/guestfish.pod:764
18650 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18654 #: ../fish/guestfish.pod:766
18656 "Guestfish can be remote-controlled over a socket. This is useful "
18657 "particularly in shell scripts where you want to make several different "
18658 "changes to a filesystem, but you don't want the overhead of starting up a "
18659 "guestfish process each time."
18663 #: ../fish/guestfish.pod:771
18664 msgid "Start a guestfish server process using:"
18668 #: ../fish/guestfish.pod:773
18671 " eval \"`guestfish --listen`\"\n"
18676 #: ../fish/guestfish.pod:775
18677 msgid "and then send it commands by doing:"
18681 #: ../fish/guestfish.pod:777
18684 " guestfish --remote cmd [...]\n"
18689 #: ../fish/guestfish.pod:779
18690 msgid "To cause the server to exit, send it the exit command:"
18694 #: ../fish/guestfish.pod:781
18697 " guestfish --remote exit\n"
18702 #: ../fish/guestfish.pod:783
18704 "Note that the server will normally exit if there is an error in a command. "
18705 "You can change this in the usual way. See section L</EXIT ON ERROR "
18710 #: ../fish/guestfish.pod:787
18711 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18715 #: ../fish/guestfish.pod:789
18717 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18718 "is how the I<--remote> option knows where to send the commands. You can "
18719 "have several guestfish listener processes running using:"
18723 #: ../fish/guestfish.pod:793
18726 " eval \"`guestfish --listen`\"\n"
18727 " pid1=$GUESTFISH_PID\n"
18728 " eval \"`guestfish --listen`\"\n"
18729 " pid2=$GUESTFISH_PID\n"
18731 " guestfish --remote=$pid1 cmd\n"
18732 " guestfish --remote=$pid2 cmd\n"
18737 #: ../fish/guestfish.pod:801
18738 msgid "REMOTE CONTROL AND CSH"
18742 #: ../fish/guestfish.pod:803
18744 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18749 #: ../fish/guestfish.pod:806
18752 " eval \"`guestfish --listen --csh`\"\n"
18757 #: ../fish/guestfish.pod:808
18758 msgid "REMOTE CONTROL DETAILS"
18762 #: ../fish/guestfish.pod:810
18764 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18765 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18766 "and C<$PID> is the process ID of the server."
18770 #: ../fish/guestfish.pod:814
18771 msgid "Guestfish client and server versions must match exactly."
18775 #: ../fish/guestfish.pod:816
18776 msgid "PREPARED DISK IMAGES"
18780 #: ../fish/guestfish.pod:818
18782 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18783 "preformatted disk images that guestfish can make for you to save typing. "
18784 "This is particularly useful for testing purposes. This option is used "
18785 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18786 "can be mixed with I<-a>)."
18790 #: ../fish/guestfish.pod:824
18792 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18793 "the second and so on. Existing files in the current directory are "
18798 #: ../fish/guestfish.pod:828
18800 "The type briefly describes how the disk should be sized, partitioned, how "
18801 "filesystem(s) should be created, and how content should be added. "
18802 "Optionally the type can be followed by extra parameters, separated by C<:> "
18803 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18804 "allocated disk, containing a single partition, with the partition formatted "
18805 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18810 #: ../fish/guestfish.pod:836
18811 msgid "To list the available types and any extra parameters they take, run:"
18815 #: ../fish/guestfish.pod:840
18817 "Note that the prepared filesystem is not mounted. You would usually have to "
18818 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18822 #: ../fish/guestfish.pod:844
18824 "If any I<-N> or I<--new> options are given, the guest is automatically "
18829 #: ../fish/guestfish.pod:849
18830 msgid "Create a 100MB disk with an ext4-formatted partition:"
18834 #: ../fish/guestfish.pod:851
18837 " guestfish -N fs:ext4\n"
18842 #: ../fish/guestfish.pod:853
18843 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18847 #: ../fish/guestfish.pod:855
18850 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18855 #: ../fish/guestfish.pod:857
18856 msgid "Create a blank 200MB disk:"
18860 #: ../fish/guestfish.pod:859
18863 " guestfish -N disk:200M\n"
18868 #: ../fish/guestfish.pod:861
18869 msgid "PROGRESS BARS"
18873 #: ../fish/guestfish.pod:863
18875 "Some (not all) long-running commands send progress notification messages as "
18876 "they are running. Guestfish turns these messages into progress bars."
18880 #: ../fish/guestfish.pod:867
18882 "When a command that supports progress bars takes longer than two seconds to "
18883 "run, and if progress bars are enabled, then you will see one appearing below "
18888 #: ../fish/guestfish.pod:871
18891 " ><fs> copy-size /large-file /another-file 2048M\n"
18892 " / 10% [#####-----------------------------------------] 00:30\n"
18897 #: ../fish/guestfish.pod:874
18899 "The spinner on the left hand side moves round once for every progress "
18900 "notification received from the backend. This is a (reasonably) golden "
18901 "assurance that the command is \"doing something\" even if the progress bar "
18902 "is not moving, because the command is able to send the progress "
18903 "notifications. When the bar reaches 100% and the command finishes, the "
18904 "spinner disappears."
18908 #: ../fish/guestfish.pod:881
18910 "Progress bars are enabled by default when guestfish is used interactively. "
18911 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18912 "and you can disable them completely using I<--no-progress-bars>."
18916 #: ../fish/guestfish.pod:886
18917 msgid "GUESTFISH COMMANDS"
18921 #: ../fish/guestfish.pod:888
18923 "The commands in this section are guestfish convenience commands, in other "
18924 "words, they are not part of the L<guestfs(3)> API."
18928 #: ../fish/guestfish.pod:891
18933 #: ../fish/guestfish.pod:893
18942 #: ../fish/guestfish.pod:896
18943 msgid "Without any parameter, this provides general help."
18947 #: ../fish/guestfish.pod:898
18948 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18952 #: ../fish/guestfish.pod:900
18953 msgid "quit | exit"
18957 #: ../fish/guestfish.pod:902
18958 msgid "This exits guestfish. You can also use C<^D> key."
18962 #: ../fish/guestfish.pod:904
18963 msgid "@FISH_COMMANDS@"
18967 #: ../fish/guestfish.pod:906
18972 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18977 #: ../fish/guestfish.pod:912
18979 "guestfish returns 0 if the commands completed without error, or 1 if there "
18984 #: ../fish/guestfish.pod:919
18989 #: ../fish/guestfish.pod:921
18991 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18996 #: ../fish/guestfish.pod:924
18997 msgid "GUESTFISH_PID"
19001 #: ../fish/guestfish.pod:926
19003 "Used with the I<--remote> option to specify the remote guestfish process to "
19004 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19008 #: ../fish/guestfish.pod:930
19013 #: ../fish/guestfish.pod:932
19015 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19016 "not specified, the external L<hexedit(1)> program is used."
19020 #: ../fish/guestfish.pod:936
19025 #: ../fish/guestfish.pod:938
19027 "If compiled with GNU readline support, various files in the home directory "
19028 "can be used. See L</FILES>."
19032 #: ../fish/guestfish.pod:947
19034 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19035 "effect as using the B<-v> option."
19039 #: ../fish/guestfish.pod:959
19041 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19042 "the discussion of paths in L<guestfs(3)>."
19046 #: ../fish/guestfish.pod:970
19047 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19051 #: ../fish/guestfish.pod:972
19056 #: ../fish/guestfish.pod:974
19058 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19063 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
19068 #: ../fish/guestfish.pod:993
19069 msgid "$HOME/.guestfish"
19073 #: ../fish/guestfish.pod:995
19075 "If compiled with GNU readline support, then the command history is saved in "
19080 #: ../fish/guestfish.pod:998
19081 msgid "$HOME/.inputrc"
19085 #: ../fish/guestfish.pod:1000
19086 msgid "/etc/inputrc"
19090 #: ../fish/guestfish.pod:1002
19092 "If compiled with GNU readline support, then these files can be used to "
19093 "configure readline. For further information, please see L<readline(3)/"
19094 "INITIALIZATION FILE>."
19098 #: ../fish/guestfish.pod:1006
19099 msgid "To write rules which only apply to guestfish, use:"
19103 #: ../fish/guestfish.pod:1008
19113 #: ../fish/guestfish.pod:1012
19115 "Variables that you can set in inputrc that change the behaviour of guestfish "
19116 "in useful ways include:"
19120 #: ../fish/guestfish.pod:1017
19121 msgid "completion-ignore-case (default: on)"
19125 #: ../fish/guestfish.pod:1019
19127 "By default, guestfish will ignore case when tab-completing paths on the "
19132 #: ../fish/guestfish.pod:1022
19135 " set completion-ignore-case off\n"
19140 #: ../fish/guestfish.pod:1024
19141 msgid "to make guestfish case sensitive."
19145 #: ../fish/guestfish.pod:1028
19150 #: ../fish/guestfish.pod:1030
19151 msgid "test2.img (etc)"
19155 #: ../fish/guestfish.pod:1032
19157 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19158 "will be created in the file C<test1.img> in the current directory. The "
19159 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19160 "the same name will be overwritten."
19164 #: ../fish/guestfish.pod:1041
19166 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19167 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
19168 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
19169 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
19174 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124
19175 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
19176 #: ../tools/virt-win-reg.pl:518 ../tools/virt-resize.pl:1514
19177 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
19178 #: ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567
19179 #: ../tools/virt-list-partitions.pl:277
19181 "This program is free software; you can redistribute it and/or modify it "
19182 "under the terms of the GNU General Public License as published by the Free "
19183 "Software Foundation; either version 2 of the License, or (at your option) "
19184 "any later version."
19188 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129
19189 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
19190 #: ../tools/virt-win-reg.pl:523 ../tools/virt-resize.pl:1519
19191 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
19192 #: ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572
19193 #: ../tools/virt-list-partitions.pl:282
19195 "This program is distributed in the hope that it will be useful, but WITHOUT "
19196 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19197 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19202 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134
19203 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
19204 #: ../tools/virt-win-reg.pl:528 ../tools/virt-resize.pl:1524
19205 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
19206 #: ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577
19207 #: ../tools/virt-list-partitions.pl:287
19209 "You should have received a copy of the GNU General Public License along with "
19210 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19211 "Ave, Cambridge, MA 02139, USA."
19215 #: ../fish/guestfish-actions.pod:1
19220 #: ../fish/guestfish-actions.pod:3
19223 " add-cdrom filename\n"
19228 #: ../fish/guestfish-actions.pod:15
19230 "This call checks for the existence of C<filename>. This stops you from "
19231 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19232 "and C<http:> URLs. To specify those, use the general L</config> call "
19237 #: ../fish/guestfish-actions.pod:22
19239 "If you just want to add an ISO file (often you use this as an efficient way "
19240 "to transfer large files into the guest), then you should probably use L</add-"
19241 "drive-ro> instead."
19245 #: ../fish/guestfish-actions.pod:35
19250 #: ../fish/guestfish-actions.pod:37
19255 #: ../fish/guestfish-actions.pod:39
19258 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19263 #: ../fish/guestfish-actions.pod:41
19265 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19266 "It works by connecting to libvirt, requesting the domain and domain XML from "
19267 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19271 #: ../fish/guestfish-actions.pod:58
19273 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19274 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19275 "libvirt URI (or one set through an environment variable, see the libvirt "
19276 "documentation for full details). If you are using the C API directly then "
19277 "it is more flexible to create the libvirt connection object yourself, get "
19278 "the domain object, and call L</add-libvirt-dom>."
19282 #: ../fish/guestfish-actions.pod:66
19284 "The other optional parameters are passed directly through to L</add-drive-"
19289 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19291 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19295 #: ../fish/guestfish-actions.pod:71
19300 #: ../fish/guestfish-actions.pod:73
19303 " add-drive filename\n"
19308 #: ../fish/guestfish-actions.pod:75
19310 "This function is the equivalent of calling L</add-drive-opts> with no "
19311 "optional parameters, so the disk is added writable, with the format being "
19312 "detected automatically."
19316 #: ../fish/guestfish-actions.pod:79
19318 "Automatic detection of the format opens you up to a potential security hole "
19319 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19320 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19321 "you should think about replacing calls to this function with calls to L</add-"
19322 "drive-opts>, and specifying the format."
19326 #: ../fish/guestfish-actions.pod:86
19327 msgid "add-drive-opts"
19331 #: ../fish/guestfish-actions.pod:88
19336 #: ../fish/guestfish-actions.pod:90
19339 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19344 #: ../fish/guestfish-actions.pod:117
19346 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19347 "add-drive-ro>) then the format is automatically detected. Possible formats "
19348 "include C<raw> and C<qcow2>."
19352 #: ../fish/guestfish-actions.pod:128
19354 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19355 "add-drive-with-if> call (q.v.)"
19359 #: ../fish/guestfish-actions.pod:135
19360 msgid "add-drive-ro"
19364 #: ../fish/guestfish-actions.pod:137
19369 #: ../fish/guestfish-actions.pod:139
19372 " add-drive-ro filename\n"
19377 #: ../fish/guestfish-actions.pod:141
19379 "This function is the equivalent of calling L</add-drive-opts> with the "
19380 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19381 "is added read-only, with the format being detected automatically."
19385 #: ../fish/guestfish-actions.pod:146
19386 msgid "add-drive-ro-with-if"
19390 #: ../fish/guestfish-actions.pod:148
19393 " add-drive-ro-with-if filename iface\n"
19398 #: ../fish/guestfish-actions.pod:150
19400 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19401 "interface emulation to use at run time."
19405 #: ../fish/guestfish-actions.pod:160
19406 msgid "add-drive-with-if"
19410 #: ../fish/guestfish-actions.pod:162
19413 " add-drive-with-if filename iface\n"
19418 #: ../fish/guestfish-actions.pod:164
19420 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19421 "interface emulation to use at run time."
19425 #: ../fish/guestfish-actions.pod:174
19430 #: ../fish/guestfish-actions.pod:176
19433 " aug-clear augpath\n"
19438 #: ../fish/guestfish-actions.pod:181
19443 #: ../fish/guestfish-actions.pod:183
19451 #: ../fish/guestfish-actions.pod:185
19453 "Close the current Augeas handle and free up any resources used by it. After "
19454 "calling this, you have to call L</aug-init> again before you can use any "
19455 "other Augeas functions."
19459 #: ../fish/guestfish-actions.pod:190
19460 msgid "aug-defnode"
19464 #: ../fish/guestfish-actions.pod:192
19467 " aug-defnode name expr val\n"
19472 #: ../fish/guestfish-actions.pod:197
19474 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19475 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19476 "containing that single node."
19480 #: ../fish/guestfish-actions.pod:205
19485 #: ../fish/guestfish-actions.pod:207
19488 " aug-defvar name expr\n"
19493 #: ../fish/guestfish-actions.pod:216
19498 #: ../fish/guestfish-actions.pod:218
19501 " aug-get augpath\n"
19506 #: ../fish/guestfish-actions.pod:223
19511 #: ../fish/guestfish-actions.pod:225
19514 " aug-init root flags\n"
19519 #: ../fish/guestfish-actions.pod:231
19520 msgid "You must call this before using any other L</aug-*> commands."
19524 #: ../fish/guestfish-actions.pod:266
19525 msgid "Do not load the tree in L</aug-init>."
19529 #: ../fish/guestfish-actions.pod:270
19530 msgid "To close the handle, you can call L</aug-close>."
19534 #: ../fish/guestfish-actions.pod:274
19539 #: ../fish/guestfish-actions.pod:276
19542 " aug-insert augpath label true|false\n"
19547 #: ../fish/guestfish-actions.pod:286
19552 #: ../fish/guestfish-actions.pod:288
19560 #: ../fish/guestfish-actions.pod:295
19565 #: ../fish/guestfish-actions.pod:297
19568 " aug-ls augpath\n"
19573 #: ../fish/guestfish-actions.pod:299
19575 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19576 "resulting nodes into alphabetical order."
19580 #: ../fish/guestfish-actions.pod:302
19585 #: ../fish/guestfish-actions.pod:304
19588 " aug-match augpath\n"
19593 #: ../fish/guestfish-actions.pod:310
19598 #: ../fish/guestfish-actions.pod:312
19601 " aug-mv src dest\n"
19606 #: ../fish/guestfish-actions.pod:317
19611 #: ../fish/guestfish-actions.pod:319
19614 " aug-rm augpath\n"
19619 #: ../fish/guestfish-actions.pod:325
19624 #: ../fish/guestfish-actions.pod:327
19632 #: ../fish/guestfish-actions.pod:331
19634 "The flags which were passed to L</aug-init> affect exactly how files are "
19639 #: ../fish/guestfish-actions.pod:334
19644 #: ../fish/guestfish-actions.pod:336
19647 " aug-set augpath val\n"
19652 #: ../fish/guestfish-actions.pod:340
19654 "In the Augeas API, it is possible to clear a node by setting the value to "
19655 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19656 "this call. Instead you must use the L</aug-clear> call."
19660 #: ../fish/guestfish-actions.pod:345
19665 #: ../fish/guestfish-actions.pod:347
19668 " available 'groups ...'\n"
19673 #: ../fish/guestfish-actions.pod:353
19675 "The libguestfs groups, and the functions that those groups correspond to, "
19676 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19677 "runtime by calling L</available-all-groups>."
19681 #: ../fish/guestfish-actions.pod:377
19682 msgid "You must call L</launch> before calling this function."
19686 #: ../fish/guestfish-actions.pod:399
19688 "This call was added in version C<1.0.80>. In previous versions of "
19689 "libguestfs all you could do would be to speculatively execute a command to "
19690 "find out if the daemon implemented it. See also L</version>."
19694 #: ../fish/guestfish-actions.pod:406
19695 msgid "available-all-groups"
19699 #: ../fish/guestfish-actions.pod:408
19702 " available-all-groups\n"
19707 #: ../fish/guestfish-actions.pod:410
19709 "This command returns a list of all optional groups that this daemon knows "
19710 "about. Note this returns both supported and unsupported groups. To find "
19711 "out which ones the daemon can actually support you have to call L</"
19712 "available> on each member of the returned list."
19716 #: ../fish/guestfish-actions.pod:416
19717 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19721 #: ../fish/guestfish-actions.pod:418
19726 #: ../fish/guestfish-actions.pod:420
19729 " base64-in (base64file|-) filename\n"
19734 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19735 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19736 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19737 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19738 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19739 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19740 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19741 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19745 #: ../fish/guestfish-actions.pod:427
19750 #: ../fish/guestfish-actions.pod:429
19753 " base64-out filename (base64file|-)\n"
19758 #: ../fish/guestfish-actions.pod:436
19759 msgid "blockdev-flushbufs"
19763 #: ../fish/guestfish-actions.pod:438
19766 " blockdev-flushbufs device\n"
19771 #: ../fish/guestfish-actions.pod:445
19772 msgid "blockdev-getbsz"
19776 #: ../fish/guestfish-actions.pod:447
19779 " blockdev-getbsz device\n"
19784 #: ../fish/guestfish-actions.pod:456
19785 msgid "blockdev-getro"
19789 #: ../fish/guestfish-actions.pod:458
19792 " blockdev-getro device\n"
19797 #: ../fish/guestfish-actions.pod:465
19798 msgid "blockdev-getsize64"
19802 #: ../fish/guestfish-actions.pod:467
19805 " blockdev-getsize64 device\n"
19810 #: ../fish/guestfish-actions.pod:471
19811 msgid "See also L</blockdev-getsz>."
19815 #: ../fish/guestfish-actions.pod:475
19816 msgid "blockdev-getss"
19820 #: ../fish/guestfish-actions.pod:477
19823 " blockdev-getss device\n"
19828 #: ../fish/guestfish-actions.pod:482
19830 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19834 #: ../fish/guestfish-actions.pod:487
19835 msgid "blockdev-getsz"
19839 #: ../fish/guestfish-actions.pod:489
19842 " blockdev-getsz device\n"
19847 #: ../fish/guestfish-actions.pod:494
19849 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19850 "blockdev-getsize64> for the more useful I<size in bytes>."
19854 #: ../fish/guestfish-actions.pod:500
19855 msgid "blockdev-rereadpt"
19859 #: ../fish/guestfish-actions.pod:502
19862 " blockdev-rereadpt device\n"
19867 #: ../fish/guestfish-actions.pod:508
19868 msgid "blockdev-setbsz"
19872 #: ../fish/guestfish-actions.pod:510
19875 " blockdev-setbsz device blocksize\n"
19880 #: ../fish/guestfish-actions.pod:519
19881 msgid "blockdev-setro"
19885 #: ../fish/guestfish-actions.pod:521
19888 " blockdev-setro device\n"
19893 #: ../fish/guestfish-actions.pod:527
19894 msgid "blockdev-setrw"
19898 #: ../fish/guestfish-actions.pod:529
19901 " blockdev-setrw device\n"
19906 #: ../fish/guestfish-actions.pod:535
19907 msgid "case-sensitive-path"
19911 #: ../fish/guestfish-actions.pod:537
19914 " case-sensitive-path path\n"
19919 #: ../fish/guestfish-actions.pod:561
19921 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19922 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19923 "the directories were originally created under Windows)."
19927 #: ../fish/guestfish-actions.pod:569
19928 msgid "See also L</realpath>."
19932 #: ../fish/guestfish-actions.pod:571
19937 #: ../fish/guestfish-actions.pod:573
19945 #: ../fish/guestfish-actions.pod:577
19947 "Note that this function cannot correctly handle binary files (specifically, "
19948 "files containing C<\\0> character which is treated as end of string). For "
19949 "those you need to use the L</read-file> or L</download> functions which have "
19950 "a more complex interface."
19954 #: ../fish/guestfish-actions.pod:585
19959 #: ../fish/guestfish-actions.pod:587
19962 " checksum csumtype path\n"
19967 #: ../fish/guestfish-actions.pod:630
19968 msgid "To get the checksum for a device, use L</checksum-device>."
19972 #: ../fish/guestfish-actions.pod:632
19973 msgid "To get the checksums for many files, use L</checksums-out>."
19977 #: ../fish/guestfish-actions.pod:634
19978 msgid "checksum-device"
19982 #: ../fish/guestfish-actions.pod:636
19985 " checksum-device csumtype device\n"
19990 #: ../fish/guestfish-actions.pod:638
19992 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19993 "device named C<device>. For the types of checksums supported see the L</"
19994 "checksum> command."
19998 #: ../fish/guestfish-actions.pod:642
19999 msgid "checksums-out"
20003 #: ../fish/guestfish-actions.pod:644
20006 " checksums-out csumtype directory (sumsfile|-)\n"
20011 #: ../fish/guestfish-actions.pod:660
20016 #: ../fish/guestfish-actions.pod:662
20019 " chmod mode path\n"
20024 #: ../fish/guestfish-actions.pod:673
20029 #: ../fish/guestfish-actions.pod:675
20032 " chown owner group path\n"
20037 #: ../fish/guestfish-actions.pod:683
20042 #: ../fish/guestfish-actions.pod:685
20045 " command 'arguments ...'\n"
20050 #: ../fish/guestfish-actions.pod:692
20052 "The single parameter is an argv-style list of arguments. The first element "
20053 "is the name of the program to run. Subsequent elements are parameters. The "
20054 "list must be non-empty (ie. must contain a program name). Note that the "
20055 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20059 #: ../fish/guestfish-actions.pod:720
20060 msgid "command-lines"
20064 #: ../fish/guestfish-actions.pod:722
20067 " command-lines 'arguments ...'\n"
20072 #: ../fish/guestfish-actions.pod:724
20074 "This is the same as L</command>, but splits the result into a list of lines."
20078 #: ../fish/guestfish-actions.pod:727
20079 msgid "See also: L</sh-lines>"
20083 #: ../fish/guestfish-actions.pod:732
20088 #: ../fish/guestfish-actions.pod:734
20091 " config qemuparam qemuvalue\n"
20096 #: ../fish/guestfish-actions.pod:745
20101 #: ../fish/guestfish-actions.pod:747
20104 " copy-size src dest size\n"
20109 #: ../fish/guestfish-actions.pod:755
20114 #: ../fish/guestfish-actions.pod:757
20122 #: ../fish/guestfish-actions.pod:762
20127 #: ../fish/guestfish-actions.pod:764
20135 #: ../fish/guestfish-actions.pod:769
20140 #: ../fish/guestfish-actions.pod:771
20148 #: ../fish/guestfish-actions.pod:778
20150 "If the destination is a device, it must be as large or larger than the "
20151 "source file or device, otherwise the copy will fail. This command cannot do "
20152 "partial copies (see L</copy-size>)."
20156 #: ../fish/guestfish-actions.pod:782
20161 #: ../fish/guestfish-actions.pod:784
20169 #: ../fish/guestfish-actions.pod:792
20174 #: ../fish/guestfish-actions.pod:794
20182 #: ../fish/guestfish-actions.pod:803
20187 #: ../fish/guestfish-actions.pod:805
20195 #: ../fish/guestfish-actions.pod:811
20197 "Another way to get the same information is to enable verbose messages with "
20198 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20199 "before running the program."
20203 #: ../fish/guestfish-actions.pod:816
20208 #: ../fish/guestfish-actions.pod:818
20211 " download remotefilename (filename|-)\n"
20216 #: ../fish/guestfish-actions.pod:825
20217 msgid "See also L</upload>, L</cat>."
20221 #: ../fish/guestfish-actions.pod:829
20222 msgid "download-offset"
20226 #: ../fish/guestfish-actions.pod:831
20229 " download-offset remotefilename (filename|-) offset size\n"
20234 #: ../fish/guestfish-actions.pod:839
20236 "Note that there is no limit on the amount of data that can be downloaded "
20237 "with this call, unlike with L</pread>, and this call always reads the full "
20238 "amount unless an error occurs."
20242 #: ../fish/guestfish-actions.pod:844
20243 msgid "See also L</download>, L</pread>."
20247 #: ../fish/guestfish-actions.pod:848
20248 msgid "drop-caches"
20252 #: ../fish/guestfish-actions.pod:850
20255 " drop-caches whattodrop\n"
20260 #: ../fish/guestfish-actions.pod:862
20265 #: ../fish/guestfish-actions.pod:864
20273 #: ../fish/guestfish-actions.pod:876
20278 #: ../fish/guestfish-actions.pod:878
20281 " e2fsck-f device\n"
20286 #: ../fish/guestfish-actions.pod:884
20288 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20289 "should use L</fsck>."
20293 #: ../fish/guestfish-actions.pod:887
20294 msgid "echo-daemon"
20298 #: ../fish/guestfish-actions.pod:889
20301 " echo-daemon 'words ...'\n"
20306 #: ../fish/guestfish-actions.pod:896
20307 msgid "See also L</ping-daemon>."
20311 #: ../fish/guestfish-actions.pod:898
20316 #: ../fish/guestfish-actions.pod:900
20319 " egrep regex path\n"
20324 #: ../fish/guestfish-actions.pod:908
20329 #: ../fish/guestfish-actions.pod:910
20332 " egrepi regex path\n"
20337 #: ../fish/guestfish-actions.pod:918
20342 #: ../fish/guestfish-actions.pod:920
20345 " equal file1 file2\n"
20350 #: ../fish/guestfish-actions.pod:927
20355 #: ../fish/guestfish-actions.pod:929
20363 #: ../fish/guestfish-actions.pod:934
20364 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20368 #: ../fish/guestfish-actions.pod:936
20373 #: ../fish/guestfish-actions.pod:938
20376 " fallocate path len\n"
20381 #: ../fish/guestfish-actions.pod:955
20382 msgid "fallocate64"
20386 #: ../fish/guestfish-actions.pod:957
20389 " fallocate64 path len\n"
20394 #: ../fish/guestfish-actions.pod:963
20396 "Note that this call allocates disk blocks for the file. To create a sparse "
20397 "file use L</truncate-size> instead."
20401 #: ../fish/guestfish-actions.pod:966
20403 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20404 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20405 "maximum size of files created through that call to 1GB."
20409 #: ../fish/guestfish-actions.pod:975
20414 #: ../fish/guestfish-actions.pod:977
20417 " fgrep pattern path\n"
20422 #: ../fish/guestfish-actions.pod:985
20427 #: ../fish/guestfish-actions.pod:987
20430 " fgrepi pattern path\n"
20435 #: ../fish/guestfish-actions.pod:995
20440 #: ../fish/guestfish-actions.pod:997
20448 #: ../fish/guestfish-actions.pod:1009
20450 "This command can also be used on C</dev/> devices (and partitions, LV "
20451 "names). You can for example use this to determine if a device contains a "
20452 "filesystem, although it's usually better to use L</vfs-type>."
20456 #: ../fish/guestfish-actions.pod:1019
20457 msgid "file-architecture"
20461 #: ../fish/guestfish-actions.pod:1021
20464 " file-architecture filename\n"
20469 #: ../fish/guestfish-actions.pod:1124
20474 #: ../fish/guestfish-actions.pod:1126
20482 #: ../fish/guestfish-actions.pod:1130
20484 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20485 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20489 #: ../fish/guestfish-actions.pod:1134
20494 #: ../fish/guestfish-actions.pod:1136
20497 " fill c len path\n"
20502 #: ../fish/guestfish-actions.pod:1142
20504 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20505 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20506 "L</fill-pattern>."
20510 #: ../fish/guestfish-actions.pod:1147
20511 msgid "fill-pattern"
20515 #: ../fish/guestfish-actions.pod:1149
20518 " fill-pattern pattern len path\n"
20523 #: ../fish/guestfish-actions.pod:1151
20525 "This function is like L</fill> except that it creates a new file of length "
20526 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20527 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20532 #: ../fish/guestfish-actions.pod:1156
20537 #: ../fish/guestfish-actions.pod:1158
20540 " find directory\n"
20545 #: ../fish/guestfish-actions.pod:1172
20546 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20550 #: ../fish/guestfish-actions.pod:1185
20551 msgid "See also L</find0>."
20555 #: ../fish/guestfish-actions.pod:1190
20560 #: ../fish/guestfish-actions.pod:1192
20563 " find0 directory (files|-)\n"
20568 #: ../fish/guestfish-actions.pod:1198
20570 "This command works the same way as L</find> with the following exceptions:"
20574 #: ../fish/guestfish-actions.pod:1225
20575 msgid "findfs-label"
20579 #: ../fish/guestfish-actions.pod:1227
20582 " findfs-label label\n"
20587 #: ../fish/guestfish-actions.pod:1233
20588 msgid "To find the label of a filesystem, use L</vfs-label>."
20592 #: ../fish/guestfish-actions.pod:1235
20593 msgid "findfs-uuid"
20597 #: ../fish/guestfish-actions.pod:1237
20600 " findfs-uuid uuid\n"
20605 #: ../fish/guestfish-actions.pod:1243
20606 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20610 #: ../fish/guestfish-actions.pod:1245
20615 #: ../fish/guestfish-actions.pod:1247
20618 " fsck fstype device\n"
20623 #: ../fish/guestfish-actions.pod:1277
20628 #: ../fish/guestfish-actions.pod:1279
20636 #: ../fish/guestfish-actions.pod:1286
20637 msgid "get-autosync"
20641 #: ../fish/guestfish-actions.pod:1288
20649 #: ../fish/guestfish-actions.pod:1292
20654 #: ../fish/guestfish-actions.pod:1294
20662 #: ../fish/guestfish-actions.pod:1298
20663 msgid "get-e2label"
20667 #: ../fish/guestfish-actions.pod:1300
20670 " get-e2label device\n"
20675 #: ../fish/guestfish-actions.pod:1312
20680 #: ../fish/guestfish-actions.pod:1314
20683 " get-e2uuid device\n"
20688 #: ../fish/guestfish-actions.pod:1326
20689 msgid "get-memsize"
20693 #: ../fish/guestfish-actions.pod:1328
20701 #: ../fish/guestfish-actions.pod:1333
20703 "If L</set-memsize> was not called on this handle, and if "
20704 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20705 "value for memsize."
20709 #: ../fish/guestfish-actions.pod:1340
20710 msgid "get-network"
20714 #: ../fish/guestfish-actions.pod:1342
20722 #: ../fish/guestfish-actions.pod:1346
20727 #: ../fish/guestfish-actions.pod:1348
20735 #: ../fish/guestfish-actions.pod:1355
20740 #: ../fish/guestfish-actions.pod:1357
20745 #: ../fish/guestfish-actions.pod:1359
20753 #: ../fish/guestfish-actions.pod:1366
20758 #: ../fish/guestfish-actions.pod:1368
20766 #: ../fish/guestfish-actions.pod:1375
20767 msgid "get-recovery-proc"
20771 #: ../fish/guestfish-actions.pod:1377
20774 " get-recovery-proc\n"
20779 #: ../fish/guestfish-actions.pod:1381
20780 msgid "get-selinux"
20784 #: ../fish/guestfish-actions.pod:1383
20792 #: ../fish/guestfish-actions.pod:1385
20794 "This returns the current setting of the selinux flag which is passed to the "
20795 "appliance at boot time. See L</set-selinux>."
20799 #: ../fish/guestfish-actions.pod:1391
20804 #: ../fish/guestfish-actions.pod:1393
20812 #: ../fish/guestfish-actions.pod:1400
20817 #: ../fish/guestfish-actions.pod:1402
20825 #: ../fish/guestfish-actions.pod:1406
20830 #: ../fish/guestfish-actions.pod:1408
20838 #: ../fish/guestfish-actions.pod:1410
20840 "Return the current umask. By default the umask is C<022> unless it has been "
20841 "set by calling L</umask>."
20845 #: ../fish/guestfish-actions.pod:1413
20846 msgid "get-verbose"
20850 #: ../fish/guestfish-actions.pod:1415
20858 #: ../fish/guestfish-actions.pod:1419
20863 #: ../fish/guestfish-actions.pod:1421
20871 #: ../fish/guestfish-actions.pod:1425
20872 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20876 #: ../fish/guestfish-actions.pod:1428
20881 #: ../fish/guestfish-actions.pod:1430
20884 " getxattrs path\n"
20889 #: ../fish/guestfish-actions.pod:1438
20890 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20894 #: ../fish/guestfish-actions.pod:1440
20895 msgid "glob-expand"
20899 #: ../fish/guestfish-actions.pod:1442
20902 " glob-expand pattern\n"
20907 #: ../fish/guestfish-actions.pod:1455
20912 #: ../fish/guestfish-actions.pod:1457
20915 " grep regex path\n"
20920 #: ../fish/guestfish-actions.pod:1465
20925 #: ../fish/guestfish-actions.pod:1467
20928 " grepi regex path\n"
20933 #: ../fish/guestfish-actions.pod:1475
20934 msgid "grub-install"
20938 #: ../fish/guestfish-actions.pod:1477
20941 " grub-install root device\n"
20946 #: ../fish/guestfish-actions.pod:1493
20951 #: ../fish/guestfish-actions.pod:1495
20959 #: ../fish/guestfish-actions.pod:1503
20964 #: ../fish/guestfish-actions.pod:1505
20967 " head-n nrlines path\n"
20972 #: ../fish/guestfish-actions.pod:1518
20977 #: ../fish/guestfish-actions.pod:1520
20985 #: ../fish/guestfish-actions.pod:1528
20990 #: ../fish/guestfish-actions.pod:1530
20993 " initrd-cat initrdpath filename\n"
20998 #: ../fish/guestfish-actions.pod:1542
20999 msgid "See also L</initrd-list>."
21003 #: ../fish/guestfish-actions.pod:1547
21004 msgid "initrd-list"
21008 #: ../fish/guestfish-actions.pod:1549
21011 " initrd-list path\n"
21016 #: ../fish/guestfish-actions.pod:1561
21017 msgid "inotify-add-watch"
21021 #: ../fish/guestfish-actions.pod:1563
21024 " inotify-add-watch path mask\n"
21029 #: ../fish/guestfish-actions.pod:1575
21030 msgid "inotify-close"
21034 #: ../fish/guestfish-actions.pod:1577
21042 #: ../fish/guestfish-actions.pod:1583
21043 msgid "inotify-files"
21047 #: ../fish/guestfish-actions.pod:1585
21055 #: ../fish/guestfish-actions.pod:1587
21057 "This function is a helpful wrapper around L</inotify-read> which just "
21058 "returns a list of pathnames of objects that were touched. The returned "
21059 "pathnames are sorted and deduplicated."
21063 #: ../fish/guestfish-actions.pod:1591
21064 msgid "inotify-init"
21068 #: ../fish/guestfish-actions.pod:1593
21071 " inotify-init maxevents\n"
21076 #: ../fish/guestfish-actions.pod:1599
21078 "C<maxevents> is the maximum number of events which will be queued up between "
21079 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21080 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21081 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21082 "but records the fact that it threw them away by setting a flag "
21083 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21087 #: ../fish/guestfish-actions.pod:1609
21089 "Before any events are generated, you have to add some watches to the "
21090 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21091 "L</inotify-watch-all>."
21095 #: ../fish/guestfish-actions.pod:1615
21097 "Queued up events should be read periodically by calling L</inotify-read> (or "
21098 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21099 "If you don't read the events out often enough then you risk the internal "
21100 "queue overflowing."
21104 #: ../fish/guestfish-actions.pod:1622
21106 "The handle should be closed after use by calling L</inotify-close>. This "
21107 "also removes any watches automatically."
21111 #: ../fish/guestfish-actions.pod:1631
21112 msgid "inotify-read"
21116 #: ../fish/guestfish-actions.pod:1633
21124 #: ../fish/guestfish-actions.pod:1646
21125 msgid "inotify-rm-watch"
21129 #: ../fish/guestfish-actions.pod:1648
21132 " inotify-rm-watch wd\n"
21137 #: ../fish/guestfish-actions.pod:1650
21138 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21142 #: ../fish/guestfish-actions.pod:1653
21143 msgid "inspect-get-arch"
21147 #: ../fish/guestfish-actions.pod:1655
21150 " inspect-get-arch root\n"
21155 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21156 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21157 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21158 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21159 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21160 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21161 #: ../fish/guestfish-actions.pod:1966
21163 "This function should only be called with a root device string as returned by "
21168 #: ../fish/guestfish-actions.pod:1660
21170 "This returns the architecture of the inspected operating system. The "
21171 "possible return values are listed under L</file-architecture>."
21175 #: ../fish/guestfish-actions.pod:1669
21176 msgid "inspect-get-distro"
21180 #: ../fish/guestfish-actions.pod:1671
21183 " inspect-get-distro root\n"
21188 #: ../fish/guestfish-actions.pod:1743
21189 msgid "inspect-get-filesystems"
21193 #: ../fish/guestfish-actions.pod:1745
21196 " inspect-get-filesystems root\n"
21201 #: ../fish/guestfish-actions.pod:1758
21203 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21204 "get-mountpoints>."
21208 #: ../fish/guestfish-actions.pod:1761
21209 msgid "inspect-get-hostname"
21213 #: ../fish/guestfish-actions.pod:1763
21216 " inspect-get-hostname root\n"
21221 #: ../fish/guestfish-actions.pod:1776
21222 msgid "inspect-get-major-version"
21226 #: ../fish/guestfish-actions.pod:1778
21229 " inspect-get-major-version root\n"
21234 #: ../fish/guestfish-actions.pod:1797
21235 msgid "inspect-get-minor-version"
21239 #: ../fish/guestfish-actions.pod:1799
21242 " inspect-get-minor-version root\n"
21247 #: ../fish/guestfish-actions.pod:1809
21249 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21250 "get-major-version>."
21254 #: ../fish/guestfish-actions.pod:1812
21255 msgid "inspect-get-mountpoints"
21259 #: ../fish/guestfish-actions.pod:1814
21262 " inspect-get-mountpoints root\n"
21267 #: ../fish/guestfish-actions.pod:1832
21269 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21270 "get-filesystems>."
21274 #: ../fish/guestfish-actions.pod:1835
21275 msgid "inspect-get-package-format"
21279 #: ../fish/guestfish-actions.pod:1837
21282 " inspect-get-package-format root\n"
21287 #: ../fish/guestfish-actions.pod:1842
21289 "This function and L</inspect-get-package-management> return the package "
21290 "format and package management tool used by the inspected operating system. "
21291 "For example for Fedora these functions would return C<rpm> (package format) "
21292 "and C<yum> (package management)."
21296 #: ../fish/guestfish-actions.pod:1857
21297 msgid "inspect-get-package-management"
21301 #: ../fish/guestfish-actions.pod:1859
21304 " inspect-get-package-management root\n"
21309 #: ../fish/guestfish-actions.pod:1864
21311 "L</inspect-get-package-format> and this function return the package format "
21312 "and package management tool used by the inspected operating system. For "
21313 "example for Fedora these functions would return C<rpm> (package format) and "
21314 "C<yum> (package management)."
21318 #: ../fish/guestfish-actions.pod:1881
21319 msgid "inspect-get-product-name"
21323 #: ../fish/guestfish-actions.pod:1883
21326 " inspect-get-product-name root\n"
21331 #: ../fish/guestfish-actions.pod:1898
21332 msgid "inspect-get-roots"
21336 #: ../fish/guestfish-actions.pod:1900
21339 " inspect-get-roots\n"
21344 #: ../fish/guestfish-actions.pod:1902
21346 "This function is a convenient way to get the list of root devices, as "
21347 "returned from a previous call to L</inspect-os>, but without redoing the "
21348 "whole inspection process."
21352 #: ../fish/guestfish-actions.pod:1906
21354 "This returns an empty list if either no root devices were found or the "
21355 "caller has not called L</inspect-os>."
21359 #: ../fish/guestfish-actions.pod:1911
21360 msgid "inspect-get-type"
21364 #: ../fish/guestfish-actions.pod:1913
21367 " inspect-get-type root\n"
21372 #: ../fish/guestfish-actions.pod:1946
21373 msgid "inspect-get-windows-systemroot"
21377 #: ../fish/guestfish-actions.pod:1948
21380 " inspect-get-windows-systemroot root\n"
21385 #: ../fish/guestfish-actions.pod:1962
21386 msgid "inspect-list-applications"
21390 #: ../fish/guestfish-actions.pod:1964
21393 " inspect-list-applications root\n"
21398 #: ../fish/guestfish-actions.pod:1971
21400 "I<Note:> This call works differently from other parts of the inspection "
21401 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21402 "then mount up the disks, before calling this. Listing applications is a "
21403 "significantly more difficult operation which requires access to the full "
21404 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21405 "are just returning data cached in the libguestfs handle, this call actually "
21406 "reads parts of the mounted filesystems during the call."
21410 #: ../fish/guestfish-actions.pod:2061
21415 #: ../fish/guestfish-actions.pod:2063
21423 #: ../fish/guestfish-actions.pod:2078
21425 "You can pass the root string(s) returned to other L</inspect-get-*> "
21426 "functions in order to query further information about each operating system, "
21427 "such as the name and version."
21431 #: ../fish/guestfish-actions.pod:2083
21433 "This function uses other libguestfs features such as L</mount-ro> and L</"
21434 "umount-all> in order to mount and unmount filesystems and look at the "
21435 "contents. This should be called with no disks currently mounted. The "
21436 "function may also use Augeas, so any existing Augeas handle will be closed."
21440 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21441 #: ../fish/guestfish-actions.pod:2297
21442 msgid "See also L</list-filesystems>."
21446 #: ../fish/guestfish-actions.pod:2097
21447 msgid "is-blockdev"
21451 #: ../fish/guestfish-actions.pod:2099
21454 " is-blockdev path\n"
21459 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21460 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21461 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21462 #: ../fish/guestfish-actions.pod:2203
21463 msgid "See also L</stat>."
21467 #: ../fish/guestfish-actions.pod:2106
21472 #: ../fish/guestfish-actions.pod:2108
21480 #: ../fish/guestfish-actions.pod:2115
21485 #: ../fish/guestfish-actions.pod:2117
21488 " is-chardev path\n"
21493 #: ../fish/guestfish-actions.pod:2124
21498 #: ../fish/guestfish-actions.pod:2126
21506 #: ../fish/guestfish-actions.pod:2133
21511 #: ../fish/guestfish-actions.pod:2135
21519 #: ../fish/guestfish-actions.pod:2143
21524 #: ../fish/guestfish-actions.pod:2145
21532 #: ../fish/guestfish-actions.pod:2152
21537 #: ../fish/guestfish-actions.pod:2154
21545 #: ../fish/guestfish-actions.pod:2162
21546 msgid "is-launching"
21550 #: ../fish/guestfish-actions.pod:2164
21558 #: ../fish/guestfish-actions.pod:2171
21563 #: ../fish/guestfish-actions.pod:2173
21571 #: ../fish/guestfish-actions.pod:2178
21576 #: ../fish/guestfish-actions.pod:2180
21584 #: ../fish/guestfish-actions.pod:2187
21589 #: ../fish/guestfish-actions.pod:2189
21592 " is-socket path\n"
21597 #: ../fish/guestfish-actions.pod:2196
21602 #: ../fish/guestfish-actions.pod:2198
21605 " is-symlink path\n"
21610 #: ../fish/guestfish-actions.pod:2205
21611 msgid "kill-subprocess"
21615 #: ../fish/guestfish-actions.pod:2207
21618 " kill-subprocess\n"
21623 #: ../fish/guestfish-actions.pod:2211
21628 #: ../fish/guestfish-actions.pod:2213
21633 #: ../fish/guestfish-actions.pod:2215
21641 #: ../fish/guestfish-actions.pod:2223
21646 #: ../fish/guestfish-actions.pod:2225
21649 " lchown owner group path\n"
21654 #: ../fish/guestfish-actions.pod:2227
21656 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21657 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21662 #: ../fish/guestfish-actions.pod:2235
21667 #: ../fish/guestfish-actions.pod:2237
21670 " lgetxattrs path\n"
21675 #: ../fish/guestfish-actions.pod:2239
21677 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21678 "it returns the extended attributes of the link itself."
21682 #: ../fish/guestfish-actions.pod:2243
21683 msgid "list-devices"
21687 #: ../fish/guestfish-actions.pod:2245
21695 #: ../fish/guestfish-actions.pod:2253
21696 msgid "list-filesystems"
21700 #: ../fish/guestfish-actions.pod:2255
21703 " list-filesystems\n"
21708 #: ../fish/guestfish-actions.pod:2274
21710 "This command runs other libguestfs commands, which might include L</mount> "
21711 "and L</umount>, and therefore you should use this soon after launch and only "
21712 "when nothing is mounted."
21716 #: ../fish/guestfish-actions.pod:2278
21718 "Not all of the filesystems returned will be mountable. In particular, swap "
21719 "partitions are returned in the list. Also this command does not check that "
21720 "each filesystem found is valid and mountable, and some filesystems might be "
21721 "mountable but require special options. Filesystems may not all belong to a "
21722 "single logical operating system (use L</inspect-os> to look for OSes)."
21726 #: ../fish/guestfish-actions.pod:2286
21727 msgid "list-partitions"
21731 #: ../fish/guestfish-actions.pod:2288
21734 " list-partitions\n"
21739 #: ../fish/guestfish-actions.pod:2294
21741 "This does not return logical volumes. For that you will need to call L</"
21746 #: ../fish/guestfish-actions.pod:2299
21751 #: ../fish/guestfish-actions.pod:2301
21759 #: ../fish/guestfish-actions.pod:2309
21764 #: ../fish/guestfish-actions.pod:2311
21767 " ln target linkname\n"
21772 #: ../fish/guestfish-actions.pod:2315
21777 #: ../fish/guestfish-actions.pod:2317
21780 " ln-f target linkname\n"
21785 #: ../fish/guestfish-actions.pod:2322
21790 #: ../fish/guestfish-actions.pod:2324
21793 " ln-s target linkname\n"
21798 #: ../fish/guestfish-actions.pod:2328
21803 #: ../fish/guestfish-actions.pod:2330
21806 " ln-sf target linkname\n"
21811 #: ../fish/guestfish-actions.pod:2335
21812 msgid "lremovexattr"
21816 #: ../fish/guestfish-actions.pod:2337
21819 " lremovexattr xattr path\n"
21824 #: ../fish/guestfish-actions.pod:2339
21826 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21827 "it removes an extended attribute of the link itself."
21831 #: ../fish/guestfish-actions.pod:2343
21836 #: ../fish/guestfish-actions.pod:2345
21844 #: ../fish/guestfish-actions.pod:2351
21846 "This command is mostly useful for interactive sessions. Programs should "
21847 "probably use L</readdir> instead."
21851 #: ../fish/guestfish-actions.pod:2354
21856 #: ../fish/guestfish-actions.pod:2356
21859 " lsetxattr xattr val vallen path\n"
21864 #: ../fish/guestfish-actions.pod:2358
21866 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21867 "sets an extended attribute of the link itself."
21871 #: ../fish/guestfish-actions.pod:2362
21876 #: ../fish/guestfish-actions.pod:2364
21884 #: ../fish/guestfish-actions.pod:2368
21886 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21887 "the link is stat-ed, not the file it refers to."
21891 #: ../fish/guestfish-actions.pod:2374
21896 #: ../fish/guestfish-actions.pod:2376
21899 " lstatlist path 'names ...'\n"
21904 #: ../fish/guestfish-actions.pod:2378
21906 "This call allows you to perform the L</lstat> operation on multiple files, "
21907 "where all files are in the directory C<path>. C<names> is the list of files "
21908 "from this directory."
21912 #: ../fish/guestfish-actions.pod:2387
21914 "This call is intended for programs that want to efficiently list a directory "
21915 "contents without making many round-trips. See also L</lxattrlist> for a "
21916 "similarly efficient call for getting extended attributes. Very long "
21917 "directory listings might cause the protocol message size to be exceeded, "
21918 "causing this call to fail. The caller must split up such requests into "
21919 "smaller groups of names."
21923 #: ../fish/guestfish-actions.pod:2395
21924 msgid "luks-add-key"
21928 #: ../fish/guestfish-actions.pod:2397
21931 " luks-add-key device keyslot\n"
21936 #: ../fish/guestfish-actions.pod:2404
21938 "Note that if C<keyslot> already contains a key, then this command will "
21939 "fail. You have to use L</luks-kill-slot> first to remove that key."
21943 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21944 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21945 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21947 "This command has one or more key or passphrase parameters. Guestfish will "
21948 "prompt for these separately."
21952 #: ../fish/guestfish-actions.pod:2411
21957 #: ../fish/guestfish-actions.pod:2413
21960 " luks-close device\n"
21965 #: ../fish/guestfish-actions.pod:2415
21967 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21968 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21969 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21974 #: ../fish/guestfish-actions.pod:2421
21975 msgid "luks-format"
21979 #: ../fish/guestfish-actions.pod:2423
21982 " luks-format device keyslot\n"
21987 #: ../fish/guestfish-actions.pod:2436
21988 msgid "luks-format-cipher"
21992 #: ../fish/guestfish-actions.pod:2438
21995 " luks-format-cipher device keyslot cipher\n"
22000 #: ../fish/guestfish-actions.pod:2440
22002 "This command is the same as L</luks-format> but it also allows you to set "
22003 "the C<cipher> used."
22007 #: ../fish/guestfish-actions.pod:2449
22008 msgid "luks-kill-slot"
22012 #: ../fish/guestfish-actions.pod:2451
22015 " luks-kill-slot device keyslot\n"
22020 #: ../fish/guestfish-actions.pod:2460
22025 #: ../fish/guestfish-actions.pod:2462
22028 " luks-open device mapname\n"
22033 #: ../fish/guestfish-actions.pod:2476
22035 "If this block device contains LVM volume groups, then calling L</vgscan> "
22036 "followed by L</vg-activate-all> will make them visible."
22040 #: ../fish/guestfish-actions.pod:2483
22041 msgid "luks-open-ro"
22045 #: ../fish/guestfish-actions.pod:2485
22048 " luks-open-ro device mapname\n"
22053 #: ../fish/guestfish-actions.pod:2487
22055 "This is the same as L</luks-open> except that a read-only mapping is created."
22059 #: ../fish/guestfish-actions.pod:2493
22064 #: ../fish/guestfish-actions.pod:2495
22067 " lvcreate logvol volgroup mbytes\n"
22072 #: ../fish/guestfish-actions.pod:2500
22073 msgid "lvm-canonical-lv-name"
22077 #: ../fish/guestfish-actions.pod:2502
22080 " lvm-canonical-lv-name lvname\n"
22085 #: ../fish/guestfish-actions.pod:2511
22086 msgid "See also L</is-lv>."
22090 #: ../fish/guestfish-actions.pod:2513
22091 msgid "lvm-clear-filter"
22095 #: ../fish/guestfish-actions.pod:2515
22098 " lvm-clear-filter\n"
22103 #: ../fish/guestfish-actions.pod:2517
22105 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22110 #: ../fish/guestfish-actions.pod:2523
22111 msgid "lvm-remove-all"
22115 #: ../fish/guestfish-actions.pod:2525
22118 " lvm-remove-all\n"
22123 #: ../fish/guestfish-actions.pod:2533
22124 msgid "lvm-set-filter"
22128 #: ../fish/guestfish-actions.pod:2535
22131 " lvm-set-filter 'devices ...'\n"
22136 #: ../fish/guestfish-actions.pod:2560
22141 #: ../fish/guestfish-actions.pod:2562
22144 " lvremove device\n"
22149 #: ../fish/guestfish-actions.pod:2570
22154 #: ../fish/guestfish-actions.pod:2572
22157 " lvrename logvol newlogvol\n"
22162 #: ../fish/guestfish-actions.pod:2576
22167 #: ../fish/guestfish-actions.pod:2578
22170 " lvresize device mbytes\n"
22175 #: ../fish/guestfish-actions.pod:2584
22176 msgid "lvresize-free"
22180 #: ../fish/guestfish-actions.pod:2586
22183 " lvresize-free lv percent\n"
22188 #: ../fish/guestfish-actions.pod:2594
22193 #: ../fish/guestfish-actions.pod:2596
22201 #: ../fish/guestfish-actions.pod:2604
22202 msgid "See also L</lvs-full>, L</list-filesystems>."
22206 #: ../fish/guestfish-actions.pod:2606
22211 #: ../fish/guestfish-actions.pod:2608
22219 #: ../fish/guestfish-actions.pod:2613
22224 #: ../fish/guestfish-actions.pod:2615
22232 #: ../fish/guestfish-actions.pod:2619
22237 #: ../fish/guestfish-actions.pod:2621
22240 " lxattrlist path 'names ...'\n"
22245 #: ../fish/guestfish-actions.pod:2637
22247 "This call is intended for programs that want to efficiently list a directory "
22248 "contents without making many round-trips. See also L</lstatlist> for a "
22249 "similarly efficient call for getting standard stats. Very long directory "
22250 "listings might cause the protocol message size to be exceeded, causing this "
22251 "call to fail. The caller must split up such requests into smaller groups of "
22256 #: ../fish/guestfish-actions.pod:2645
22261 #: ../fish/guestfish-actions.pod:2647
22269 #: ../fish/guestfish-actions.pod:2651
22274 #: ../fish/guestfish-actions.pod:2653
22277 " mkdir-mode path mode\n"
22282 #: ../fish/guestfish-actions.pod:2662
22283 msgid "See also L</mkdir>, L</umask>"
22287 #: ../fish/guestfish-actions.pod:2664
22292 #: ../fish/guestfish-actions.pod:2666
22300 #: ../fish/guestfish-actions.pod:2671
22305 #: ../fish/guestfish-actions.pod:2673
22308 " mkdtemp template\n"
22313 #: ../fish/guestfish-actions.pod:2694
22318 #: ../fish/guestfish-actions.pod:2696
22321 " mke2fs-J fstype blocksize device journal\n"
22326 #: ../fish/guestfish-actions.pod:2704
22327 msgid "See also L</mke2journal>."
22331 #: ../fish/guestfish-actions.pod:2706
22336 #: ../fish/guestfish-actions.pod:2708
22339 " mke2fs-JL fstype blocksize device label\n"
22344 #: ../fish/guestfish-actions.pod:2713
22345 msgid "See also L</mke2journal-L>."
22349 #: ../fish/guestfish-actions.pod:2715
22354 #: ../fish/guestfish-actions.pod:2717
22357 " mke2fs-JU fstype blocksize device uuid\n"
22362 #: ../fish/guestfish-actions.pod:2722
22363 msgid "See also L</mke2journal-U>."
22367 #: ../fish/guestfish-actions.pod:2724
22368 msgid "mke2journal"
22372 #: ../fish/guestfish-actions.pod:2726
22375 " mke2journal blocksize device\n"
22380 #: ../fish/guestfish-actions.pod:2733
22381 msgid "mke2journal-L"
22385 #: ../fish/guestfish-actions.pod:2735
22388 " mke2journal-L blocksize label device\n"
22393 #: ../fish/guestfish-actions.pod:2739
22394 msgid "mke2journal-U"
22398 #: ../fish/guestfish-actions.pod:2741
22401 " mke2journal-U blocksize uuid device\n"
22406 #: ../fish/guestfish-actions.pod:2745
22411 #: ../fish/guestfish-actions.pod:2747
22414 " mkfifo mode path\n"
22419 #: ../fish/guestfish-actions.pod:2749
22421 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22422 "is just a convenient wrapper around L</mknod>."
22426 #: ../fish/guestfish-actions.pod:2755
22431 #: ../fish/guestfish-actions.pod:2757
22434 " mkfs fstype device\n"
22439 #: ../fish/guestfish-actions.pod:2763
22444 #: ../fish/guestfish-actions.pod:2765
22447 " mkfs-b fstype blocksize device\n"
22452 #: ../fish/guestfish-actions.pod:2767
22454 "This call is similar to L</mkfs>, but it allows you to control the block "
22455 "size of the resulting filesystem. Supported block sizes depend on the "
22456 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22460 #: ../fish/guestfish-actions.pod:2775
22461 msgid "mkmountpoint"
22465 #: ../fish/guestfish-actions.pod:2777
22468 " mkmountpoint exemptpath\n"
22473 #: ../fish/guestfish-actions.pod:2779
22475 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22476 "to create extra mountpoints before mounting the first filesystem."
22480 #: ../fish/guestfish-actions.pod:2803
22482 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22483 "unexpected errors if you try to mix these calls. It is safest to manually "
22484 "unmount filesystems and remove mountpoints after use."
22488 #: ../fish/guestfish-actions.pod:2807
22490 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22491 "for this to work for manual mountpoints, you must ensure that the innermost "
22492 "mountpoints have the longest pathnames, as in the example code above."
22496 #: ../fish/guestfish-actions.pod:2814
22498 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22499 "that L</umount-all> is called when the handle is closed which can also "
22500 "trigger these issues."
22504 #: ../fish/guestfish-actions.pod:2818
22509 #: ../fish/guestfish-actions.pod:2820
22512 " mknod mode devmajor devminor path\n"
22517 #: ../fish/guestfish-actions.pod:2830
22519 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22520 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22521 "regular file). These constants are available in the standard Linux header "
22522 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22523 "wrappers around this command which bitwise OR in the appropriate constant "
22528 #: ../fish/guestfish-actions.pod:2840
22533 #: ../fish/guestfish-actions.pod:2842
22536 " mknod-b mode devmajor devminor path\n"
22541 #: ../fish/guestfish-actions.pod:2844
22543 "This call creates a block device node called C<path> with mode C<mode> and "
22544 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22545 "wrapper around L</mknod>."
22549 #: ../fish/guestfish-actions.pod:2850
22554 #: ../fish/guestfish-actions.pod:2852
22557 " mknod-c mode devmajor devminor path\n"
22562 #: ../fish/guestfish-actions.pod:2854
22564 "This call creates a char device node called C<path> with mode C<mode> and "
22565 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22566 "wrapper around L</mknod>."
22570 #: ../fish/guestfish-actions.pod:2860
22575 #: ../fish/guestfish-actions.pod:2862
22583 #: ../fish/guestfish-actions.pod:2866
22588 #: ../fish/guestfish-actions.pod:2868
22591 " mkswap-L label device\n"
22596 #: ../fish/guestfish-actions.pod:2876
22601 #: ../fish/guestfish-actions.pod:2878
22604 " mkswap-U uuid device\n"
22609 #: ../fish/guestfish-actions.pod:2882
22610 msgid "mkswap-file"
22614 #: ../fish/guestfish-actions.pod:2884
22617 " mkswap-file path\n"
22622 #: ../fish/guestfish-actions.pod:2888
22624 "This command just writes a swap file signature to an existing file. To "
22625 "create the file itself, use something like L</fallocate>."
22629 #: ../fish/guestfish-actions.pod:2891
22634 #: ../fish/guestfish-actions.pod:2893
22637 " modprobe modulename\n"
22642 #: ../fish/guestfish-actions.pod:2900
22647 #: ../fish/guestfish-actions.pod:2902
22650 " mount device mountpoint\n"
22655 #: ../fish/guestfish-actions.pod:2918
22657 "B<Important note:> When you use this call, the filesystem options C<sync> "
22658 "and C<noatime> are set implicitly. This was originally done because we "
22659 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22660 "very large negative performance impact and negligible effect on "
22661 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22662 "code that needs performance, and instead use L</mount-options> (use an empty "
22663 "string for the first parameter if you don't want any options)."
22667 #: ../fish/guestfish-actions.pod:2928
22672 #: ../fish/guestfish-actions.pod:2930
22675 " mount-loop file mountpoint\n"
22680 #: ../fish/guestfish-actions.pod:2936
22681 msgid "mount-options"
22685 #: ../fish/guestfish-actions.pod:2938
22688 " mount-options options device mountpoint\n"
22693 #: ../fish/guestfish-actions.pod:2940
22695 "This is the same as the L</mount> command, but it allows you to set the "
22696 "mount options as for the L<mount(8)> I<-o> flag."
22700 #: ../fish/guestfish-actions.pod:2948
22705 #: ../fish/guestfish-actions.pod:2950
22708 " mount-ro device mountpoint\n"
22713 #: ../fish/guestfish-actions.pod:2952
22715 "This is the same as the L</mount> command, but it mounts the filesystem with "
22716 "the read-only (I<-o ro>) flag."
22720 #: ../fish/guestfish-actions.pod:2955
22725 #: ../fish/guestfish-actions.pod:2957
22728 " mount-vfs options vfstype device mountpoint\n"
22733 #: ../fish/guestfish-actions.pod:2959
22735 "This is the same as the L</mount> command, but it allows you to set both the "
22736 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22740 #: ../fish/guestfish-actions.pod:2963
22741 msgid "mountpoints"
22745 #: ../fish/guestfish-actions.pod:2965
22753 #: ../fish/guestfish-actions.pod:2967
22755 "This call is similar to L</mounts>. That call returns a list of devices. "
22756 "This one returns a hash table (map) of device name to directory where the "
22757 "device is mounted."
22761 #: ../fish/guestfish-actions.pod:2971
22766 #: ../fish/guestfish-actions.pod:2973
22774 #: ../fish/guestfish-actions.pod:2980
22775 msgid "See also: L</mountpoints>"
22779 #: ../fish/guestfish-actions.pod:2982
22784 #: ../fish/guestfish-actions.pod:2984
22792 #: ../fish/guestfish-actions.pod:2989
22793 msgid "ntfs-3g-probe"
22797 #: ../fish/guestfish-actions.pod:2991
22800 " ntfs-3g-probe true|false device\n"
22805 #: ../fish/guestfish-actions.pod:3005
22810 #: ../fish/guestfish-actions.pod:3007
22813 " ntfsresize device\n"
22818 #: ../fish/guestfish-actions.pod:3013
22819 msgid "ntfsresize-size"
22823 #: ../fish/guestfish-actions.pod:3015
22826 " ntfsresize-size device size\n"
22831 #: ../fish/guestfish-actions.pod:3017
22833 "This command is the same as L</ntfsresize> except that it allows you to "
22834 "specify the new size (in bytes) explicitly."
22838 #: ../fish/guestfish-actions.pod:3020
22843 #: ../fish/guestfish-actions.pod:3022
22846 " part-add device prlogex startsect endsect\n"
22851 #: ../fish/guestfish-actions.pod:3024
22853 "This command adds a partition to C<device>. If there is no partition table "
22854 "on the device, call L</part-init> first."
22858 #: ../fish/guestfish-actions.pod:3036
22860 "Creating a partition which covers the whole disk is not so easy. Use L</"
22861 "part-disk> to do that."
22865 #: ../fish/guestfish-actions.pod:3039
22870 #: ../fish/guestfish-actions.pod:3041
22873 " part-del device partnum\n"
22878 #: ../fish/guestfish-actions.pod:3049
22883 #: ../fish/guestfish-actions.pod:3051
22886 " part-disk device parttype\n"
22891 #: ../fish/guestfish-actions.pod:3053
22893 "This command is simply a combination of L</part-init> followed by L</part-"
22894 "add> to create a single primary partition covering the whole disk."
22898 #: ../fish/guestfish-actions.pod:3057
22900 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22901 "possible values are described in L</part-init>."
22905 #: ../fish/guestfish-actions.pod:3063
22906 msgid "part-get-bootable"
22910 #: ../fish/guestfish-actions.pod:3065
22913 " part-get-bootable device partnum\n"
22918 #: ../fish/guestfish-actions.pod:3070
22919 msgid "See also L</part-set-bootable>."
22923 #: ../fish/guestfish-actions.pod:3072
22924 msgid "part-get-mbr-id"
22928 #: ../fish/guestfish-actions.pod:3074
22931 " part-get-mbr-id device partnum\n"
22936 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22938 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22939 "undefined results for other partition table types (see L</part-get-"
22944 #: ../fish/guestfish-actions.pod:3083
22945 msgid "part-get-parttype"
22949 #: ../fish/guestfish-actions.pod:3085
22952 " part-get-parttype device\n"
22957 #: ../fish/guestfish-actions.pod:3090
22959 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22960 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22961 "possible, although unusual. See L</part-init> for a full list."
22965 #: ../fish/guestfish-actions.pod:3095
22970 #: ../fish/guestfish-actions.pod:3097
22973 " part-init device parttype\n"
22978 #: ../fish/guestfish-actions.pod:3103
22980 "Initially there are no partitions. Following this, you should call L</part-"
22981 "add> for each partition required."
22985 #: ../fish/guestfish-actions.pod:3166
22990 #: ../fish/guestfish-actions.pod:3168
22993 " part-list device\n"
22998 #: ../fish/guestfish-actions.pod:3183
23000 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23001 "the device's sector size, see L</blockdev-getss>."
23005 #: ../fish/guestfish-actions.pod:3196
23006 msgid "part-set-bootable"
23010 #: ../fish/guestfish-actions.pod:3198
23013 " part-set-bootable device partnum true|false\n"
23018 #: ../fish/guestfish-actions.pod:3207
23019 msgid "part-set-mbr-id"
23023 #: ../fish/guestfish-actions.pod:3209
23026 " part-set-mbr-id device partnum idbyte\n"
23031 #: ../fish/guestfish-actions.pod:3221
23032 msgid "part-set-name"
23036 #: ../fish/guestfish-actions.pod:3223
23039 " part-set-name device partnum name\n"
23044 #: ../fish/guestfish-actions.pod:3231
23045 msgid "part-to-dev"
23049 #: ../fish/guestfish-actions.pod:3233
23052 " part-to-dev partition\n"
23057 #: ../fish/guestfish-actions.pod:3239
23059 "The named partition must exist, for example as a string returned from L</"
23060 "list-partitions>."
23064 #: ../fish/guestfish-actions.pod:3242
23065 msgid "ping-daemon"
23069 #: ../fish/guestfish-actions.pod:3244
23077 #: ../fish/guestfish-actions.pod:3251
23082 #: ../fish/guestfish-actions.pod:3253
23085 " pread path count offset\n"
23090 #: ../fish/guestfish-actions.pod:3261
23091 msgid "See also L</pwrite>, L</pread-device>."
23095 #: ../fish/guestfish-actions.pod:3266
23096 msgid "pread-device"
23100 #: ../fish/guestfish-actions.pod:3268
23103 " pread-device device count offset\n"
23108 #: ../fish/guestfish-actions.pod:3276
23109 msgid "See also L</pread>."
23113 #: ../fish/guestfish-actions.pod:3281
23118 #: ../fish/guestfish-actions.pod:3283
23121 " pvcreate device\n"
23126 #: ../fish/guestfish-actions.pod:3289
23131 #: ../fish/guestfish-actions.pod:3291
23134 " pvremove device\n"
23139 #: ../fish/guestfish-actions.pod:3300
23144 #: ../fish/guestfish-actions.pod:3302
23147 " pvresize device\n"
23152 #: ../fish/guestfish-actions.pod:3307
23153 msgid "pvresize-size"
23157 #: ../fish/guestfish-actions.pod:3309
23160 " pvresize-size device size\n"
23165 #: ../fish/guestfish-actions.pod:3311
23167 "This command is the same as L</pvresize> except that it allows you to "
23168 "specify the new size (in bytes) explicitly."
23172 #: ../fish/guestfish-actions.pod:3314
23177 #: ../fish/guestfish-actions.pod:3316
23185 #: ../fish/guestfish-actions.pod:3324
23186 msgid "See also L</pvs-full>."
23190 #: ../fish/guestfish-actions.pod:3326
23195 #: ../fish/guestfish-actions.pod:3328
23203 #: ../fish/guestfish-actions.pod:3333
23208 #: ../fish/guestfish-actions.pod:3335
23216 #: ../fish/guestfish-actions.pod:3339
23221 #: ../fish/guestfish-actions.pod:3341
23224 " pwrite path content offset\n"
23229 #: ../fish/guestfish-actions.pod:3352
23230 msgid "See also L</pread>, L</pwrite-device>."
23234 #: ../fish/guestfish-actions.pod:3357
23235 msgid "pwrite-device"
23239 #: ../fish/guestfish-actions.pod:3359
23242 " pwrite-device device content offset\n"
23247 #: ../fish/guestfish-actions.pod:3369
23248 msgid "See also L</pwrite>."
23252 #: ../fish/guestfish-actions.pod:3374
23257 #: ../fish/guestfish-actions.pod:3376
23260 " read-file path\n"
23265 #: ../fish/guestfish-actions.pod:3381
23267 "Unlike L</cat>, this function can correctly handle files that contain "
23268 "embedded ASCII NUL characters. However unlike L</download>, this function "
23269 "is limited in the total size of file that can be handled."
23273 #: ../fish/guestfish-actions.pod:3389
23278 #: ../fish/guestfish-actions.pod:3391
23281 " read-lines path\n"
23286 #: ../fish/guestfish-actions.pod:3398
23288 "Note that this function cannot correctly handle binary files (specifically, "
23289 "files containing C<\\0> character which is treated as end of line). For "
23290 "those you need to use the L</read-file> function which has a more complex "
23295 #: ../fish/guestfish-actions.pod:3403
23300 #: ../fish/guestfish-actions.pod:3405
23308 #: ../fish/guestfish-actions.pod:3457
23310 "This function is primarily intended for use by programs. To get a simple "
23311 "list of names, use L</ls>. To get a printable directory for human "
23312 "consumption, use L</ll>."
23316 #: ../fish/guestfish-actions.pod:3461
23321 #: ../fish/guestfish-actions.pod:3463
23329 #: ../fish/guestfish-actions.pod:3467
23330 msgid "readlinklist"
23334 #: ../fish/guestfish-actions.pod:3469
23337 " readlinklist path 'names ...'\n"
23342 #: ../fish/guestfish-actions.pod:3493
23347 #: ../fish/guestfish-actions.pod:3495
23355 #: ../fish/guestfish-actions.pod:3500
23356 msgid "removexattr"
23360 #: ../fish/guestfish-actions.pod:3502
23363 " removexattr xattr path\n"
23368 #: ../fish/guestfish-actions.pod:3507
23369 msgid "See also: L</lremovexattr>, L<attr(5)>."
23373 #: ../fish/guestfish-actions.pod:3509
23378 #: ../fish/guestfish-actions.pod:3511
23381 " resize2fs device\n"
23386 #: ../fish/guestfish-actions.pod:3516
23388 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23389 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23390 "gives an error about this and sometimes not. In any case, it is always safe "
23391 "to call L</e2fsck-f> before calling this function."
23395 #: ../fish/guestfish-actions.pod:3522
23396 msgid "resize2fs-size"
23400 #: ../fish/guestfish-actions.pod:3524
23403 " resize2fs-size device size\n"
23408 #: ../fish/guestfish-actions.pod:3526
23410 "This command is the same as L</resize2fs> except that it allows you to "
23411 "specify the new size (in bytes) explicitly."
23415 #: ../fish/guestfish-actions.pod:3529
23420 #: ../fish/guestfish-actions.pod:3531
23428 #: ../fish/guestfish-actions.pod:3535
23433 #: ../fish/guestfish-actions.pod:3537
23441 #: ../fish/guestfish-actions.pod:3543
23446 #: ../fish/guestfish-actions.pod:3545
23454 #: ../fish/guestfish-actions.pod:3549
23455 msgid "rmmountpoint"
23459 #: ../fish/guestfish-actions.pod:3551
23462 " rmmountpoint exemptpath\n"
23467 #: ../fish/guestfish-actions.pod:3553
23469 "This calls removes a mountpoint that was previously created with L</"
23470 "mkmountpoint>. See L</mkmountpoint> for full details."
23474 #: ../fish/guestfish-actions.pod:3557
23475 msgid "scrub-device"
23479 #: ../fish/guestfish-actions.pod:3559
23482 " scrub-device device\n"
23487 #: ../fish/guestfish-actions.pod:3570
23492 #: ../fish/guestfish-actions.pod:3572
23495 " scrub-file file\n"
23500 #: ../fish/guestfish-actions.pod:3582
23501 msgid "scrub-freespace"
23505 #: ../fish/guestfish-actions.pod:3584
23508 " scrub-freespace dir\n"
23513 #: ../fish/guestfish-actions.pod:3586
23515 "This command creates the directory C<dir> and then fills it with files until "
23516 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23517 "deletes them. The intention is to scrub any free space on the partition "
23518 "containing C<dir>."
23522 #: ../fish/guestfish-actions.pod:3595
23527 #: ../fish/guestfish-actions.pod:3597
23532 #: ../fish/guestfish-actions.pod:3599
23535 " set-append append\n"
23540 #: ../fish/guestfish-actions.pod:3610
23541 msgid "set-autosync"
23545 #: ../fish/guestfish-actions.pod:3612
23550 #: ../fish/guestfish-actions.pod:3614
23553 " set-autosync true|false\n"
23558 #: ../fish/guestfish-actions.pod:3616
23560 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23561 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23562 "closed (also if the program exits without closing handles)."
23566 #: ../fish/guestfish-actions.pod:3624
23571 #: ../fish/guestfish-actions.pod:3626
23576 #: ../fish/guestfish-actions.pod:3628
23579 " set-direct true|false\n"
23584 #: ../fish/guestfish-actions.pod:3634
23586 "One consequence of this is that log messages aren't caught by the library "
23587 "and handled by L</set-log-message-callback>, but go straight to stdout."
23591 #: ../fish/guestfish-actions.pod:3643
23592 msgid "set-e2label"
23596 #: ../fish/guestfish-actions.pod:3645
23599 " set-e2label device label\n"
23604 #: ../fish/guestfish-actions.pod:3651
23606 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23607 "label on a filesystem."
23611 #: ../fish/guestfish-actions.pod:3654
23616 #: ../fish/guestfish-actions.pod:3656
23619 " set-e2uuid device uuid\n"
23624 #: ../fish/guestfish-actions.pod:3663
23626 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23627 "UUID of a filesystem."
23631 #: ../fish/guestfish-actions.pod:3666
23632 msgid "set-memsize"
23636 #: ../fish/guestfish-actions.pod:3668
23641 #: ../fish/guestfish-actions.pod:3670
23644 " set-memsize memsize\n"
23649 #: ../fish/guestfish-actions.pod:3672
23651 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23652 "This only has any effect if called before L</launch>."
23656 #: ../fish/guestfish-actions.pod:3683
23657 msgid "set-network"
23661 #: ../fish/guestfish-actions.pod:3685
23666 #: ../fish/guestfish-actions.pod:3687
23669 " set-network true|false\n"
23674 #: ../fish/guestfish-actions.pod:3695
23676 "You must call this before calling L</launch>, otherwise it has no effect."
23680 #: ../fish/guestfish-actions.pod:3698
23685 #: ../fish/guestfish-actions.pod:3700
23690 #: ../fish/guestfish-actions.pod:3702
23693 " set-path searchpath\n"
23698 #: ../fish/guestfish-actions.pod:3711
23703 #: ../fish/guestfish-actions.pod:3713
23708 #: ../fish/guestfish-actions.pod:3715
23716 #: ../fish/guestfish-actions.pod:3735
23717 msgid "set-recovery-proc"
23721 #: ../fish/guestfish-actions.pod:3737
23722 msgid "recovery-proc"
23726 #: ../fish/guestfish-actions.pod:3739
23729 " set-recovery-proc true|false\n"
23734 #: ../fish/guestfish-actions.pod:3741
23736 "If this is called with the parameter C<false> then L</launch> does not "
23737 "create a recovery process. The purpose of the recovery process is to stop "
23738 "runaway qemu processes in the case where the main program aborts abruptly."
23742 #: ../fish/guestfish-actions.pod:3746
23744 "This only has any effect if called before L</launch>, and the default is "
23749 #: ../fish/guestfish-actions.pod:3755
23750 msgid "set-selinux"
23754 #: ../fish/guestfish-actions.pod:3757
23759 #: ../fish/guestfish-actions.pod:3759
23762 " set-selinux true|false\n"
23767 #: ../fish/guestfish-actions.pod:3770
23772 #: ../fish/guestfish-actions.pod:3772
23777 #: ../fish/guestfish-actions.pod:3774
23780 " set-trace true|false\n"
23785 #: ../fish/guestfish-actions.pod:3790
23786 msgid "set-verbose"
23790 #: ../fish/guestfish-actions.pod:3792
23795 #: ../fish/guestfish-actions.pod:3794
23798 " set-verbose true|false\n"
23803 #: ../fish/guestfish-actions.pod:3801
23808 #: ../fish/guestfish-actions.pod:3803
23811 " setcon context\n"
23816 #: ../fish/guestfish-actions.pod:3810
23821 #: ../fish/guestfish-actions.pod:3812
23824 " setxattr xattr val vallen path\n"
23829 #: ../fish/guestfish-actions.pod:3818
23830 msgid "See also: L</lsetxattr>, L<attr(5)>."
23834 #: ../fish/guestfish-actions.pod:3820
23839 #: ../fish/guestfish-actions.pod:3822
23842 " sfdisk device cyls heads sectors 'lines ...'\n"
23847 #: ../fish/guestfish-actions.pod:3844
23848 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23852 #: ../fish/guestfish-actions.pod:3850
23857 #: ../fish/guestfish-actions.pod:3852
23860 " sfdiskM device 'lines ...'\n"
23865 #: ../fish/guestfish-actions.pod:3854
23867 "This is a simplified interface to the L</sfdisk> command, where partition "
23868 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23869 "you don't need to specify the cyls, heads and sectors parameters which were "
23870 "rarely if ever used anyway."
23874 #: ../fish/guestfish-actions.pod:3860
23875 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23879 #: ../fish/guestfish-actions.pod:3866
23884 #: ../fish/guestfish-actions.pod:3868
23887 " sfdisk-N device partnum cyls heads sectors line\n"
23892 #: ../fish/guestfish-actions.pod:3873
23894 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23895 "cyls/heads/sectors parameters."
23899 #: ../fish/guestfish-actions.pod:3876
23900 msgid "See also: L</part-add>"
23904 #: ../fish/guestfish-actions.pod:3881
23905 msgid "sfdisk-disk-geometry"
23909 #: ../fish/guestfish-actions.pod:3883
23912 " sfdisk-disk-geometry device\n"
23917 #: ../fish/guestfish-actions.pod:3885
23919 "This displays the disk geometry of C<device> read from the partition table. "
23920 "Especially in the case where the underlying block device has been resized, "
23921 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23922 "kernel-geometry>)."
23926 #: ../fish/guestfish-actions.pod:3893
23927 msgid "sfdisk-kernel-geometry"
23931 #: ../fish/guestfish-actions.pod:3895
23934 " sfdisk-kernel-geometry device\n"
23939 #: ../fish/guestfish-actions.pod:3902
23944 #: ../fish/guestfish-actions.pod:3904
23947 " sfdisk-l device\n"
23952 #: ../fish/guestfish-actions.pod:3910
23953 msgid "See also: L</part-list>"
23957 #: ../fish/guestfish-actions.pod:3912
23962 #: ../fish/guestfish-actions.pod:3914
23970 #: ../fish/guestfish-actions.pod:3919
23971 msgid "This is like L</command>, but passes the command to:"
23975 #: ../fish/guestfish-actions.pod:3927
23976 msgid "All the provisos about L</command> apply to this call."
23980 #: ../fish/guestfish-actions.pod:3929
23985 #: ../fish/guestfish-actions.pod:3931
23988 " sh-lines command\n"
23993 #: ../fish/guestfish-actions.pod:3933
23994 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23998 #: ../fish/guestfish-actions.pod:3936
23999 msgid "See also: L</command-lines>"
24003 #: ../fish/guestfish-actions.pod:3938
24008 #: ../fish/guestfish-actions.pod:3940
24016 #: ../fish/guestfish-actions.pod:3944
24021 #: ../fish/guestfish-actions.pod:3946
24029 #: ../fish/guestfish-actions.pod:3952
24034 #: ../fish/guestfish-actions.pod:3954
24042 #: ../fish/guestfish-actions.pod:3962
24047 #: ../fish/guestfish-actions.pod:3964
24055 #: ../fish/guestfish-actions.pod:3972
24060 #: ../fish/guestfish-actions.pod:3974
24063 " strings-e encoding path\n"
24068 #: ../fish/guestfish-actions.pod:3976
24070 "This is like the L</strings> command, but allows you to specify the encoding "
24071 "of strings that are looked for in the source file C<path>."
24075 #: ../fish/guestfish-actions.pod:3986
24077 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24078 "ISO-8859-X (this is what L</strings> uses)."
24082 #: ../fish/guestfish-actions.pod:4018
24083 msgid "swapoff-device"
24087 #: ../fish/guestfish-actions.pod:4020
24090 " swapoff-device device\n"
24095 #: ../fish/guestfish-actions.pod:4022
24097 "This command disables the libguestfs appliance swap device or partition "
24098 "named C<device>. See L</swapon-device>."
24102 #: ../fish/guestfish-actions.pod:4026
24103 msgid "swapoff-file"
24107 #: ../fish/guestfish-actions.pod:4028
24110 " swapoff-file file\n"
24115 #: ../fish/guestfish-actions.pod:4032
24116 msgid "swapoff-label"
24120 #: ../fish/guestfish-actions.pod:4034
24123 " swapoff-label label\n"
24128 #: ../fish/guestfish-actions.pod:4039
24129 msgid "swapoff-uuid"
24133 #: ../fish/guestfish-actions.pod:4041
24136 " swapoff-uuid uuid\n"
24141 #: ../fish/guestfish-actions.pod:4046
24142 msgid "swapon-device"
24146 #: ../fish/guestfish-actions.pod:4048
24149 " swapon-device device\n"
24154 #: ../fish/guestfish-actions.pod:4050
24156 "This command enables the libguestfs appliance to use the swap device or "
24157 "partition named C<device>. The increased memory is made available for all "
24158 "commands, for example those run using L</command> or L</sh>."
24162 #: ../fish/guestfish-actions.pod:4062
24163 msgid "swapon-file"
24167 #: ../fish/guestfish-actions.pod:4064
24170 " swapon-file file\n"
24175 #: ../fish/guestfish-actions.pod:4066
24177 "This command enables swap to a file. See L</swapon-device> for other notes."
24181 #: ../fish/guestfish-actions.pod:4069
24182 msgid "swapon-label"
24186 #: ../fish/guestfish-actions.pod:4071
24189 " swapon-label label\n"
24194 #: ../fish/guestfish-actions.pod:4073
24196 "This command enables swap to a labeled swap partition. See L</swapon-"
24197 "device> for other notes."
24201 #: ../fish/guestfish-actions.pod:4076
24202 msgid "swapon-uuid"
24206 #: ../fish/guestfish-actions.pod:4078
24209 " swapon-uuid uuid\n"
24214 #: ../fish/guestfish-actions.pod:4080
24216 "This command enables swap to a swap partition with the given UUID. See L</"
24217 "swapon-device> for other notes."
24221 #: ../fish/guestfish-actions.pod:4083
24226 #: ../fish/guestfish-actions.pod:4085
24234 #: ../fish/guestfish-actions.pod:4093
24239 #: ../fish/guestfish-actions.pod:4095
24247 #: ../fish/guestfish-actions.pod:4103
24252 #: ../fish/guestfish-actions.pod:4105
24255 " tail-n nrlines path\n"
24260 #: ../fish/guestfish-actions.pod:4118
24265 #: ../fish/guestfish-actions.pod:4120
24268 " tar-in (tarfile|-) directory\n"
24273 #: ../fish/guestfish-actions.pod:4125
24274 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24278 #: ../fish/guestfish-actions.pod:4130
24283 #: ../fish/guestfish-actions.pod:4132
24286 " tar-out directory (tarfile|-)\n"
24291 #: ../fish/guestfish-actions.pod:4137
24292 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24296 #: ../fish/guestfish-actions.pod:4142
24301 #: ../fish/guestfish-actions.pod:4144
24304 " tgz-in (tarball|-) directory\n"
24309 #: ../fish/guestfish-actions.pod:4149
24310 msgid "To upload an uncompressed tarball, use L</tar-in>."
24314 #: ../fish/guestfish-actions.pod:4153
24319 #: ../fish/guestfish-actions.pod:4155
24322 " tgz-out directory (tarball|-)\n"
24327 #: ../fish/guestfish-actions.pod:4160
24328 msgid "To download an uncompressed tarball, use L</tar-out>."
24332 #: ../fish/guestfish-actions.pod:4164
24337 #: ../fish/guestfish-actions.pod:4166
24345 #: ../fish/guestfish-actions.pod:4175
24350 #: ../fish/guestfish-actions.pod:4177
24358 #: ../fish/guestfish-actions.pod:4182
24359 msgid "truncate-size"
24363 #: ../fish/guestfish-actions.pod:4184
24366 " truncate-size path size\n"
24371 #: ../fish/guestfish-actions.pod:4189
24373 "If the current file size is less than C<size> then the file is extended to "
24374 "the required size with zero bytes. This creates a sparse file (ie. disk "
24375 "blocks are not allocated for the file until you write to it). To create a "
24376 "non-sparse file of zeroes, use L</fallocate64> instead."
24380 #: ../fish/guestfish-actions.pod:4195
24385 #: ../fish/guestfish-actions.pod:4197
24388 " tune2fs-l device\n"
24393 #: ../fish/guestfish-actions.pod:4207
24398 #: ../fish/guestfish-actions.pod:4209
24401 " txz-in (tarball|-) directory\n"
24406 #: ../fish/guestfish-actions.pod:4216
24411 #: ../fish/guestfish-actions.pod:4218
24414 " txz-out directory (tarball|-)\n"
24419 #: ../fish/guestfish-actions.pod:4225
24424 #: ../fish/guestfish-actions.pod:4227
24432 #: ../fish/guestfish-actions.pod:4241
24433 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24437 #: ../fish/guestfish-actions.pod:4246
24442 #: ../fish/guestfish-actions.pod:4248
24447 #: ../fish/guestfish-actions.pod:4250
24450 " umount pathordevice\n"
24455 #: ../fish/guestfish-actions.pod:4256
24460 #: ../fish/guestfish-actions.pod:4258
24461 msgid "unmount-all"
24465 #: ../fish/guestfish-actions.pod:4260
24473 #: ../fish/guestfish-actions.pod:4266
24478 #: ../fish/guestfish-actions.pod:4268
24481 " upload (filename|-) remotefilename\n"
24486 #: ../fish/guestfish-actions.pod:4275
24487 msgid "See also L</download>."
24491 #: ../fish/guestfish-actions.pod:4279
24492 msgid "upload-offset"
24496 #: ../fish/guestfish-actions.pod:4281
24499 " upload-offset (filename|-) remotefilename offset\n"
24504 #: ../fish/guestfish-actions.pod:4293
24506 "Note that there is no limit on the amount of data that can be uploaded with "
24507 "this call, unlike with L</pwrite>, and this call always writes the full "
24508 "amount unless an error occurs."
24512 #: ../fish/guestfish-actions.pod:4298
24513 msgid "See also L</upload>, L</pwrite>."
24517 #: ../fish/guestfish-actions.pod:4302
24522 #: ../fish/guestfish-actions.pod:4304
24525 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24530 #: ../fish/guestfish-actions.pod:4323
24535 #: ../fish/guestfish-actions.pod:4325
24543 #: ../fish/guestfish-actions.pod:4352
24545 "I<Note:> Don't use this call to test for availability of features. In "
24546 "enterprise distributions we backport features from later versions into "
24547 "earlier versions, making this an unreliable way to test for features. Use "
24548 "L</available> instead."
24552 #: ../fish/guestfish-actions.pod:4358
24557 #: ../fish/guestfish-actions.pod:4360
24560 " vfs-label device\n"
24565 #: ../fish/guestfish-actions.pod:4367
24566 msgid "To find a filesystem from the label, use L</findfs-label>."
24570 #: ../fish/guestfish-actions.pod:4369
24575 #: ../fish/guestfish-actions.pod:4371
24578 " vfs-type device\n"
24583 #: ../fish/guestfish-actions.pod:4381
24588 #: ../fish/guestfish-actions.pod:4383
24591 " vfs-uuid device\n"
24596 #: ../fish/guestfish-actions.pod:4390
24597 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24601 #: ../fish/guestfish-actions.pod:4392
24602 msgid "vg-activate"
24606 #: ../fish/guestfish-actions.pod:4394
24609 " vg-activate true|false 'volgroups ...'\n"
24614 #: ../fish/guestfish-actions.pod:4407
24615 msgid "vg-activate-all"
24619 #: ../fish/guestfish-actions.pod:4409
24622 " vg-activate-all true|false\n"
24627 #: ../fish/guestfish-actions.pod:4419
24632 #: ../fish/guestfish-actions.pod:4421
24635 " vgcreate volgroup 'physvols ...'\n"
24640 #: ../fish/guestfish-actions.pod:4426
24645 #: ../fish/guestfish-actions.pod:4428
24648 " vglvuuids vgname\n"
24653 #: ../fish/guestfish-actions.pod:4433
24655 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24656 "logical volumes and volume groups."
24660 #: ../fish/guestfish-actions.pod:4436
24661 msgid "See also L</vgpvuuids>."
24665 #: ../fish/guestfish-actions.pod:4438
24670 #: ../fish/guestfish-actions.pod:4440
24673 " vgpvuuids vgname\n"
24678 #: ../fish/guestfish-actions.pod:4445
24680 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24681 "physical volumes and volume groups."
24685 #: ../fish/guestfish-actions.pod:4448
24686 msgid "See also L</vglvuuids>."
24690 #: ../fish/guestfish-actions.pod:4450
24695 #: ../fish/guestfish-actions.pod:4452
24698 " vgremove vgname\n"
24703 #: ../fish/guestfish-actions.pod:4459
24708 #: ../fish/guestfish-actions.pod:4461
24711 " vgrename volgroup newvolgroup\n"
24716 #: ../fish/guestfish-actions.pod:4465
24721 #: ../fish/guestfish-actions.pod:4467
24729 #: ../fish/guestfish-actions.pod:4475
24730 msgid "See also L</vgs-full>."
24734 #: ../fish/guestfish-actions.pod:4477
24739 #: ../fish/guestfish-actions.pod:4479
24747 #: ../fish/guestfish-actions.pod:4484
24752 #: ../fish/guestfish-actions.pod:4486
24760 #: ../fish/guestfish-actions.pod:4491
24765 #: ../fish/guestfish-actions.pod:4493
24773 #: ../fish/guestfish-actions.pod:4497
24778 #: ../fish/guestfish-actions.pod:4499
24786 #: ../fish/guestfish-actions.pod:4504
24791 #: ../fish/guestfish-actions.pod:4506
24799 #: ../fish/guestfish-actions.pod:4511
24804 #: ../fish/guestfish-actions.pod:4513
24812 #: ../fish/guestfish-actions.pod:4518
24817 #: ../fish/guestfish-actions.pod:4520
24820 " write path content\n"
24825 #: ../fish/guestfish-actions.pod:4528
24830 #: ../fish/guestfish-actions.pod:4530
24833 " write-file path content size\n"
24838 #: ../fish/guestfish-actions.pod:4553
24843 #: ../fish/guestfish-actions.pod:4555
24846 " zegrep regex path\n"
24851 #: ../fish/guestfish-actions.pod:4563
24856 #: ../fish/guestfish-actions.pod:4565
24859 " zegrepi regex path\n"
24864 #: ../fish/guestfish-actions.pod:4573
24869 #: ../fish/guestfish-actions.pod:4575
24877 #: ../fish/guestfish-actions.pod:4583
24878 msgid "See also: L</zero-device>, L</scrub-device>."
24882 #: ../fish/guestfish-actions.pod:4585
24883 msgid "zero-device"
24887 #: ../fish/guestfish-actions.pod:4587
24890 " zero-device device\n"
24895 #: ../fish/guestfish-actions.pod:4589
24897 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24898 "which just zeroes the first few blocks of a device."
24902 #: ../fish/guestfish-actions.pod:4596
24907 #: ../fish/guestfish-actions.pod:4598
24910 " zerofree device\n"
24915 #: ../fish/guestfish-actions.pod:4611
24920 #: ../fish/guestfish-actions.pod:4613
24923 " zfgrep pattern path\n"
24928 #: ../fish/guestfish-actions.pod:4621
24933 #: ../fish/guestfish-actions.pod:4623
24936 " zfgrepi pattern path\n"
24941 #: ../fish/guestfish-actions.pod:4631
24946 #: ../fish/guestfish-actions.pod:4633
24949 " zfile meth path\n"
24954 #: ../fish/guestfish-actions.pod:4640
24956 "Since 1.0.63, use L</file> instead which can now process compressed files."
24960 #: ../fish/guestfish-actions.pod:4650
24965 #: ../fish/guestfish-actions.pod:4652
24968 " zgrep regex path\n"
24973 #: ../fish/guestfish-actions.pod:4660
24978 #: ../fish/guestfish-actions.pod:4662
24981 " zgrepi regex path\n"
24986 #: ../fish/guestfish-commands.pod:1
24991 #: ../fish/guestfish-commands.pod:3
24996 #: ../fish/guestfish-commands.pod:5
24999 " alloc filename size\n"
25004 #: ../fish/guestfish-commands.pod:7
25006 "This creates an empty (zeroed) file of the given size, and then adds so it "
25007 "can be further examined."
25011 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25012 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25016 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25017 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25021 #: ../fish/guestfish-commands.pod:14
25023 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25024 "image, see L</PREPARED DISK IMAGES>."
25028 #: ../fish/guestfish-commands.pod:17
25033 #: ../fish/guestfish-commands.pod:19
25036 " copy-in local [local ...] /remotedir\n"
25041 #: ../fish/guestfish-commands.pod:21
25043 "C<copy-in> copies local files or directories recursively into the disk "
25044 "image, placing them in the directory called C</remotedir> (which must "
25045 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25046 "other commands as necessary."
25050 #: ../fish/guestfish-commands.pod:26
25052 "Multiple local files and directories can be specified, but the last "
25053 "parameter must always be a remote directory. Wildcards cannot be used."
25057 #: ../fish/guestfish-commands.pod:30
25062 #: ../fish/guestfish-commands.pod:32
25065 " copy-out remote [remote ...] localdir\n"
25070 #: ../fish/guestfish-commands.pod:34
25072 "C<copy-out> copies remote files or directories recursively out of the disk "
25073 "image, placing them on the host disk in a local directory called C<localdir> "
25074 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25075 "download>, L</tar-out> and other commands as necessary."
25079 #: ../fish/guestfish-commands.pod:40
25081 "Multiple remote files and directories can be specified, but the last "
25082 "parameter must always be a local directory. To download to the current "
25083 "directory, use C<.> as in:"
25087 #: ../fish/guestfish-commands.pod:44
25090 " copy-out /home .\n"
25095 #: ../fish/guestfish-commands.pod:46
25097 "Wildcards cannot be used in the ordinary command, but you can use them with "
25098 "the help of L</glob> like this:"
25102 #: ../fish/guestfish-commands.pod:49
25105 " glob copy-out /home/* .\n"
25110 #: ../fish/guestfish-commands.pod:51
25115 #: ../fish/guestfish-commands.pod:53
25118 " echo [params ...]\n"
25123 #: ../fish/guestfish-commands.pod:55
25124 msgid "This echos the parameters to the terminal."
25128 #: ../fish/guestfish-commands.pod:57
25133 #: ../fish/guestfish-commands.pod:59
25138 #: ../fish/guestfish-commands.pod:61
25143 #: ../fish/guestfish-commands.pod:63
25151 #: ../fish/guestfish-commands.pod:65
25153 "This is used to edit a file. It downloads the file, edits it locally using "
25154 "your editor, then uploads the result."
25158 #: ../fish/guestfish-commands.pod:68
25160 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25161 "or C<emacs> you will get those corresponding editors."
25165 #: ../fish/guestfish-commands.pod:72
25170 #: ../fish/guestfish-commands.pod:74
25173 " glob command args...\n"
25178 #: ../fish/guestfish-commands.pod:76
25180 "Expand wildcards in any paths in the args list, and run C<command> "
25181 "repeatedly on each matching path."
25185 #: ../fish/guestfish-commands.pod:79
25186 msgid "See L</WILDCARDS AND GLOBBING>."
25190 #: ../fish/guestfish-commands.pod:81
25195 #: ../fish/guestfish-commands.pod:83
25198 " hexedit <filename|device>\n"
25199 " hexedit <filename|device> <max>\n"
25200 " hexedit <filename|device> <start> <max>\n"
25205 #: ../fish/guestfish-commands.pod:87
25207 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25212 #: ../fish/guestfish-commands.pod:90
25214 "This command works by downloading potentially the whole file or device, "
25215 "editing it locally, then uploading it. If the file or device is large, you "
25216 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25217 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25218 "usual modifiers allowed such as C<1M> (1 megabyte)."
25222 #: ../fish/guestfish-commands.pod:97
25223 msgid "For example to edit the first few sectors of a disk you might do:"
25227 #: ../fish/guestfish-commands.pod:100
25230 " hexedit /dev/sda 1M\n"
25235 #: ../fish/guestfish-commands.pod:102
25237 "which would allow you to edit anywhere within the first megabyte of the disk."
25241 #: ../fish/guestfish-commands.pod:105
25242 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25246 #: ../fish/guestfish-commands.pod:107
25249 " hexedit /dev/sda1 0x400 0x400\n"
25254 #: ../fish/guestfish-commands.pod:109
25255 msgid "(assuming the superblock is in the standard location)."
25259 #: ../fish/guestfish-commands.pod:111
25261 "This command requires the external L<hexedit(1)> program. You can specify "
25262 "another program to use by setting the C<HEXEDITOR> environment variable."
25266 #: ../fish/guestfish-commands.pod:115
25267 msgid "See also L</hexdump>."
25271 #: ../fish/guestfish-commands.pod:117
25276 #: ../fish/guestfish-commands.pod:119
25284 #: ../fish/guestfish-commands.pod:121
25286 "Change the local directory, ie. the current directory of guestfish itself."
25290 #: ../fish/guestfish-commands.pod:124
25291 msgid "Note that C<!cd> won't do what you might expect."
25295 #: ../fish/guestfish-commands.pod:126
25300 #: ../fish/guestfish-commands.pod:128
25305 #: ../fish/guestfish-commands.pod:130
25313 #: ../fish/guestfish-commands.pod:132
25314 msgid "Opens the manual page for guestfish."
25318 #: ../fish/guestfish-commands.pod:134
25323 #: ../fish/guestfish-commands.pod:136
25328 #: ../fish/guestfish-commands.pod:138
25336 #: ../fish/guestfish-commands.pod:140
25344 #: ../fish/guestfish-commands.pod:142
25345 msgid "This is used to view a file."
25349 #: ../fish/guestfish-commands.pod:144
25351 "The default viewer is C<$PAGER>. However if you use the alternate command "
25352 "C<less> you will get the C<less> command specifically."
25356 #: ../fish/guestfish-commands.pod:147
25361 #: ../fish/guestfish-commands.pod:149
25369 #: ../fish/guestfish-commands.pod:151
25371 "Close and reopen the libguestfs handle. It is not necessary to use this "
25372 "normally, because the handle is closed properly when guestfish exits. "
25373 "However this is occasionally useful for testing."
25377 #: ../fish/guestfish-commands.pod:155
25382 #: ../fish/guestfish-commands.pod:157
25385 " sparse filename size\n"
25390 #: ../fish/guestfish-commands.pod:159
25392 "This creates an empty sparse file of the given size, and then adds so it can "
25393 "be further examined."
25397 #: ../fish/guestfish-commands.pod:162
25399 "In all respects it works the same as the L</alloc> command, except that the "
25400 "image file is allocated sparsely, which means that disk blocks are not "
25401 "assigned to the file until they are needed. Sparse disk files only use "
25402 "space when written to, but they are slower and there is a danger you could "
25403 "run out of real disk space during a write operation."
25407 #: ../fish/guestfish-commands.pod:172
25412 #: ../fish/guestfish-commands.pod:174
25420 #: ../fish/guestfish-commands.pod:176
25422 "This command returns a list of the optional groups known to the daemon, and "
25423 "indicates which ones are supported by this build of the libguestfs appliance."
25427 #: ../fish/guestfish-commands.pod:180
25428 msgid "See also L<guestfs(3)/AVAILABILITY>."
25432 #: ../fish/guestfish-commands.pod:182
25437 #: ../fish/guestfish-commands.pod:184
25440 " time command args...\n"
25445 #: ../fish/guestfish-commands.pod:186
25447 "Run the command as usual, but print the elapsed time afterwards. This can "
25448 "be useful for benchmarking operations."
25452 #: ../test-tool/libguestfs-test-tool.pod:5
25453 msgid "libguestfs-test-tool - End user tests for libguestfs"
25457 #: ../test-tool/libguestfs-test-tool.pod:9
25460 " libguestfs-test-tool [--options]\n"
25465 #: ../test-tool/libguestfs-test-tool.pod:13
25467 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25468 "and developers, to allow them to check basic libguestfs functionality is "
25469 "working. This is needed because libguestfs occasionally breaks for reasons "
25470 "beyond our control: usually because of changes in the underlying qemu or "
25471 "kernel packages, or the host environment."
25475 #: ../test-tool/libguestfs-test-tool.pod:20
25476 msgid "If you suspect a problem in libguestfs, then just run:"
25480 #: ../test-tool/libguestfs-test-tool.pod:22
25483 " libguestfs-test-tool\n"
25488 #: ../test-tool/libguestfs-test-tool.pod:24
25489 msgid "It will print lots of diagnostic messages."
25493 #: ../test-tool/libguestfs-test-tool.pod:26
25494 msgid "If it runs to completion successfully, you will see this near the end:"
25498 #: ../test-tool/libguestfs-test-tool.pod:28
25501 " ===== TEST FINISHED OK =====\n"
25506 #: ../test-tool/libguestfs-test-tool.pod:30
25507 msgid "and the test tool will exit with code 0."
25511 #: ../test-tool/libguestfs-test-tool.pod:32
25513 "If it fails (and/or exits with non-zero error code), please paste the "
25514 "B<complete, unedited> output of the test tool into a bug report. More "
25515 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25520 #: ../test-tool/libguestfs-test-tool.pod:41
25525 #: ../test-tool/libguestfs-test-tool.pod:43
25526 msgid "Display short usage information and exit."
25530 #: ../test-tool/libguestfs-test-tool.pod:45
25531 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25535 #: ../test-tool/libguestfs-test-tool.pod:47
25537 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25538 "normally look in the C<$libexec> directory that was configured when the tool "
25543 #: ../test-tool/libguestfs-test-tool.pod:51
25544 msgid "I<--qemu qemu_binary>"
25548 #: ../test-tool/libguestfs-test-tool.pod:53
25550 "If you have downloaded another qemu binary, point this option at the full "
25551 "path of the binary to try it."
25555 #: ../test-tool/libguestfs-test-tool.pod:56
25556 msgid "I<--qemudir qemu_source_dir>"
25560 #: ../test-tool/libguestfs-test-tool.pod:58
25562 "If you have compiled qemu from source, point this option at the source "
25563 "directory to try it."
25567 #: ../test-tool/libguestfs-test-tool.pod:61
25568 msgid "I<--timeout N>"
25572 #: ../test-tool/libguestfs-test-tool.pod:63
25574 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25575 "does not usually need to be adjusted unless your machine is very slow."
25579 #: ../test-tool/libguestfs-test-tool.pod:69
25580 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25584 #: ../test-tool/libguestfs-test-tool.pod:71
25586 "If you have compiled another version of qemu from source and would like to "
25587 "try that, then you can use the I<--qemudir> option to point to the qemu "
25588 "source directory."
25592 #: ../test-tool/libguestfs-test-tool.pod:75
25594 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25595 "option to point to the binary."
25599 #: ../test-tool/libguestfs-test-tool.pod:78
25601 "When using an alternate qemu with libguestfs, usually you would need to "
25602 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25603 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25604 "use either of the I<--qemudir> or I<--qemu> options."
25608 #: ../test-tool/libguestfs-test-tool.pod:85
25610 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25611 "I<1> if there was an error."
25615 #: ../test-tool/libguestfs-test-tool.pod:92
25616 msgid "/usr/libexec/libguestfs-test-tool-helper"
25620 #: ../test-tool/libguestfs-test-tool.pod:94
25622 "This helper program is run inside the appliance and provides additional "
25627 #: ../test-tool/libguestfs-test-tool.pod:97
25628 msgid "/usr/bin/mkisofs"
25632 #: ../test-tool/libguestfs-test-tool.pod:99
25634 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25635 "which is used as part of the tests."
25639 #: ../test-tool/libguestfs-test-tool.pod:106
25641 "For the full list of environment variables which may affect libguestfs, "
25642 "please see the L<guestfs(3)> manual page."
25646 #: ../test-tool/libguestfs-test-tool.pod:111
25647 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25651 #: ../test-tool/libguestfs-test-tool.pod:121
25652 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25656 #: ../fuse/guestmount.pod:5
25658 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25662 #: ../fuse/guestmount.pod:9
25665 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25670 #: ../fuse/guestmount.pod:11
25673 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25678 #: ../fuse/guestmount.pod:13
25681 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25686 #: ../fuse/guestmount.pod:17
25688 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25689 "machines. If you do this, you risk disk corruption in the VM."
25693 #: ../fuse/guestmount.pod:22
25695 "The guestmount program can be used to mount virtual machine filesystems and "
25696 "other disk images on the host. It uses libguestfs for access to the guest "
25697 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25698 "a mountable device."
25702 #: ../fuse/guestmount.pod:27
25704 "Along with other options, you have to give at least one device (I<-a> "
25705 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25706 "option) or use the I<-i> inspection option. How this works is better "
25707 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25712 #: ../fuse/guestmount.pod:33
25714 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25715 "by you, and the filesystem will not be visible to any other users unless you "
25716 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25717 "the filesystem, use the C<fusermount -u> command."
25721 #: ../fuse/guestmount.pod:41
25723 "For a typical Windows guest which has its main filesystem on the first "
25728 #: ../fuse/guestmount.pod:44
25731 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25736 #: ../fuse/guestmount.pod:46
25738 "For a typical Linux guest which has a /boot filesystem on the first "
25739 "partition, and the root filesystem on a logical volume:"
25743 #: ../fuse/guestmount.pod:49
25746 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25751 #: ../fuse/guestmount.pod:51
25752 msgid "To get libguestfs to detect guest mountpoints for you:"
25756 #: ../fuse/guestmount.pod:53
25759 " guestmount -a guest.img -i --ro /mnt\n"
25764 #: ../fuse/guestmount.pod:55
25765 msgid "For a libvirt guest called \"Guest\" you could do:"
25769 #: ../fuse/guestmount.pod:57
25772 " guestmount -d Guest -i --ro /mnt\n"
25777 #: ../fuse/guestmount.pod:59
25779 "If you don't know what filesystems are contained in a guest or disk image, "
25780 "use L<virt-filesystems(1)> first:"
25784 #: ../fuse/guestmount.pod:62
25787 " virt-filesystems MyGuest\n"
25792 #: ../fuse/guestmount.pod:64
25794 "If you want to trace the libguestfs calls but without excessive debugging "
25795 "information, we recommend:"
25799 #: ../fuse/guestmount.pod:67
25802 " guestmount [...] --trace /mnt\n"
25807 #: ../fuse/guestmount.pod:69
25808 msgid "If you want to debug the program, we recommend:"
25812 #: ../fuse/guestmount.pod:71
25815 " guestmount [...] --trace --verbose /mnt\n"
25820 #: ../fuse/guestmount.pod:79
25821 msgid "Add a block device or virtual machine image."
25825 #: ../fuse/guestmount.pod:96
25826 msgid "B<--dir-cache-timeout N>"
25830 #: ../fuse/guestmount.pod:98
25832 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25833 "seconds. The readdir cache [actually, there are several semi-independent "
25834 "caches] is populated after a readdir(2) call with the stat and extended "
25835 "attributes of the files in the directory, in anticipation that they will be "
25836 "requested soon after."
25840 #: ../fuse/guestmount.pod:104
25842 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25843 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25844 "requests, only cache existing ones."
25848 #: ../fuse/guestmount.pod:122
25850 "If you have untrusted raw-format guest disk images, you should use this "
25851 "option to specify the disk format. This avoids a possible security problem "
25852 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25853 "guestfs_add_drive_opts>."
25857 #: ../fuse/guestmount.pod:127
25858 msgid "B<--fuse-help>"
25862 #: ../fuse/guestmount.pod:129
25863 msgid "Display help on special FUSE options (see I<-o> below)."
25867 #: ../fuse/guestmount.pod:133
25868 msgid "Display brief help and exit."
25872 #: ../fuse/guestmount.pod:146
25873 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25877 #: ../fuse/guestmount.pod:148
25879 "Mount the named partition or logical volume on the given mountpoint B<in the "
25880 "guest> (this has nothing to do with mountpoints in the host)."
25884 #: ../fuse/guestmount.pod:151
25886 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25887 "something on C</>."
25891 #: ../fuse/guestmount.pod:156
25893 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25894 "unmounted. If you specify this option, then we don't attempt to sync the "
25895 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25899 #: ../fuse/guestmount.pod:161
25900 msgid "B<-o option> | B<--option option>"
25904 #: ../fuse/guestmount.pod:163
25905 msgid "Pass extra options to FUSE."
25909 #: ../fuse/guestmount.pod:165
25911 "To get a list of all the extra options supported by FUSE, use the command "
25912 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25913 "of them are a good idea."
25917 #: ../fuse/guestmount.pod:169
25920 " guestmount --fuse-help\n"
25925 #: ../fuse/guestmount.pod:171
25926 msgid "Some potentially useful FUSE options:"
25930 #: ../fuse/guestmount.pod:175
25931 msgid "B<-o allow_other>"
25935 #: ../fuse/guestmount.pod:177
25936 msgid "Allow other users to see the filesystem."
25940 #: ../fuse/guestmount.pod:179
25941 msgid "B<-o attr_timeout=N>"
25945 #: ../fuse/guestmount.pod:181
25946 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25950 #: ../fuse/guestmount.pod:183
25951 msgid "B<-o kernel_cache>"
25955 #: ../fuse/guestmount.pod:185
25957 "Allow the kernel to cache files (reduces the number of reads that have to go "
25958 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25959 "afford the extra memory usage."
25963 #: ../fuse/guestmount.pod:189
25964 msgid "B<-o uid=N> B<-o gid=N>"
25968 #: ../fuse/guestmount.pod:191
25970 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25971 "the chosen values."
25975 #: ../fuse/guestmount.pod:198
25977 "Add devices and mount everything read-only. Also disallow writes and make "
25978 "the disk appear read-only to FUSE."
25982 #: ../fuse/guestmount.pod:201
25984 "This is highly recommended if you are not going to edit the guest disk. If "
25985 "the guest is running and this option is I<not> supplied, then there is a "
25986 "strong risk of disk corruption in the guest. We try to prevent this from "
25987 "happening, but it is not always possible."
25991 #: ../fuse/guestmount.pod:206
25992 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25996 #: ../fuse/guestmount.pod:210
25997 msgid "Enable SELinux support for the guest."
26001 #: ../fuse/guestmount.pod:214
26002 msgid "Enable verbose messages from underlying libguestfs."
26006 #: ../fuse/guestmount.pod:218
26007 msgid "Display the program version and exit."
26011 #: ../fuse/guestmount.pod:222
26013 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26014 "FOR READ AND WRITE>."
26018 #: ../fuse/guestmount.pod:225
26019 msgid "B<-x> | B<--trace>"
26023 #: ../fuse/guestmount.pod:227
26024 msgid "Trace libguestfs calls."
26028 #: ../fuse/guestmount.pod:229
26029 msgid "This also stops the daemon from forking into the background."
26033 #: ../fuse/guestmount.pod:235
26035 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26036 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26041 #: ../tools/virt-edit.pl:34
26042 msgid "virt-edit - Edit a file in a virtual machine"
26046 #: ../tools/virt-edit.pl:38
26049 " virt-edit [--options] domname file\n"
26054 #: ../tools/virt-edit.pl:40
26057 " virt-edit [--options] disk.img [disk.img ...] file\n"
26062 #: ../tools/virt-edit.pl:42
26065 " virt-edit [domname|disk.img] file -e 'expr'\n"
26070 #: ../tools/virt-edit.pl:46
26072 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26073 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26074 "doing this, but doesn't catch all cases."
26078 #: ../tools/virt-edit.pl:52
26080 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26081 "the named virtual machine (or disk image)."
26085 #: ../tools/virt-edit.pl:55
26087 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26088 "you should look at the L<guestfish(1)> tool."
26092 #: ../tools/virt-edit.pl:60
26093 msgid "Edit the named files interactively:"
26097 #: ../tools/virt-edit.pl:62
26100 " virt-edit mydomain /boot/grub/grub.conf\n"
26105 #: ../tools/virt-edit.pl:64
26108 " virt-edit mydomain /etc/passwd\n"
26113 #: ../tools/virt-edit.pl:66
26115 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26116 "below). To change the init default level to 5:"
26120 #: ../tools/virt-edit.pl:70
26123 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26128 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181
26129 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
26130 #: ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163
26131 #: ../tools/virt-list-partitions.pl:64
26132 msgid "Display brief help."
26136 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187
26137 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:69
26138 #: ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119
26139 #: ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
26140 msgid "B<--version>"
26144 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189
26145 #: ../tools/virt-resize.pl:274 ../tools/virt-list-filesystems.pl:71
26146 #: ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121
26147 #: ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
26148 msgid "Display version number and exit."
26152 #: ../tools/virt-edit.pl:96
26153 msgid "B<--backup extension> | B<-b extension>"
26157 #: ../tools/virt-edit.pl:98
26159 "Create a backup of the original file I<in the guest disk image>. The backup "
26160 "has the original filename with C<extension> added."
26164 #: ../tools/virt-edit.pl:101
26166 "Usually the first character of C<extension> would be a dot C<.> so you would "
26171 #: ../tools/virt-edit.pl:104
26174 " virt-edit -b .orig [etc]\n"
26179 #: ../tools/virt-edit.pl:106
26180 msgid "By default, no backup file is made."
26184 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203
26185 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
26186 #: ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:78
26187 msgid "B<--connect URI> | B<-c URI>"
26191 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205
26192 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
26193 #: ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:80
26195 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26196 "to the default libvirt hypervisor."
26200 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26201 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
26202 #: ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:83
26204 "If you specify guest block devices directly, then libvirt is not used at all."
26208 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215
26209 #: ../tools/virt-resize.pl:522 ../tools/virt-list-filesystems.pl:89
26210 #: ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147
26211 #: ../tools/virt-list-partitions.pl:90
26212 msgid "B<--format> raw"
26216 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217
26217 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
26218 #: ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:92
26220 "Specify the format of disk images given on the command line. If this is "
26221 "omitted then the format is autodetected from the content of the disk image."
26225 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221
26226 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
26227 #: ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:96
26229 "If disk images are requested from libvirt, then this program asks libvirt "
26230 "for this information. In this case, the value of the format parameter is "
26235 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225
26236 #: ../tools/virt-resize.pl:527 ../tools/virt-resize.pl:542
26237 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
26238 #: ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:100
26240 "If working with untrusted raw-format guest disk images, you should ensure "
26241 "the format is always specified."
26245 #: ../tools/virt-edit.pl:141
26246 msgid "B<--expr EXPR> | B<-e EXPR>"
26250 #: ../tools/virt-edit.pl:143
26252 "Instead of launching the external editor, non-interactively apply the Perl "
26253 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26258 #: ../tools/virt-edit.pl:147
26260 "Be careful to properly quote the expression to prevent it from being altered "
26265 #: ../tools/virt-edit.pl:268
26266 msgid "NON-INTERACTIVE EDITING"
26270 #: ../tools/virt-edit.pl:270
26272 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26273 "administrator can interactively edit the file."
26277 #: ../tools/virt-edit.pl:273
26279 "There are two ways also to use C<virt-edit> from scripts in order to make "
26280 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26281 "like this, it's less error-prone to write scripts directly using the "
26282 "libguestfs API and Augeas for configuration file editing.)"
26286 #: ../tools/virt-edit.pl:279
26288 "The first method is to temporarily set C<$EDITOR> to any script or program "
26289 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26290 "update C<tmpfile> in place however it likes."
26294 #: ../tools/virt-edit.pl:283
26296 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26297 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26298 "instances of C<foo> with C<bar> in a file:"
26302 #: ../tools/virt-edit.pl:287
26305 " virt-edit domname filename -e 's/foo/bar/'\n"
26310 #: ../tools/virt-edit.pl:289
26312 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26313 "For example to delete root's password you could do:"
26317 #: ../tools/virt-edit.pl:292
26320 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26325 #: ../tools/virt-edit.pl:294
26327 "What really happens is that the snippet is evaluated as a Perl expression "
26328 "for each line of the file. The line, including the final C<\\n>, is passed "
26329 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26333 #: ../tools/virt-edit.pl:299
26335 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26336 "C<apache> user account from the password file you can do:"
26340 #: ../tools/virt-edit.pl:302
26343 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26348 #: ../tools/virt-edit.pl:304
26350 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26351 "the end of the file is rather difficult this way since there is no concept "
26352 "of \"last line of the file\" - your expression just doesn't get called "
26353 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26358 #: ../tools/virt-edit.pl:310
26360 "The variable C<$lineno> contains the current line number. As is "
26361 "traditional, the first line in the file is number C<1>."
26365 #: ../tools/virt-edit.pl:313
26367 "The return value from the expression is ignored, but the expression may call "
26368 "C<die> in order to abort the whole program, leaving the original file "
26373 #: ../tools/virt-edit.pl:317
26375 "Remember when matching the end of a line that C<$_> may contain the final C<"
26376 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26377 "newline then neither of these. Thus to match or substitute some text at the "
26378 "end of a line, use this regular expression:"
26382 #: ../tools/virt-edit.pl:322
26385 " /some text(\\r?\\n)?$/\n"
26390 #: ../tools/virt-edit.pl:324
26392 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26393 "$_> itself (since that would remove all newlines from the file):"
26397 #: ../tools/virt-edit.pl:328
26400 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26405 #: ../tools/virt-edit.pl:334
26410 #: ../tools/virt-edit.pl:336
26412 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26417 #: ../tools/virt-edit.pl:339
26418 msgid "If not set, C<vi> is used."
26422 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141
26423 #: ../tools/virt-win-reg.pl:477 ../tools/virt-resize.pl:1478
26424 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274
26425 #: ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527
26426 #: ../tools/virt-list-partitions.pl:250
26427 msgid "SHELL QUOTING"
26431 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479
26432 #: ../tools/virt-resize.pl:1480 ../tools/virt-list-filesystems.pl:184
26433 #: ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262
26434 #: ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
26436 "Libvirt guest names can contain arbitrary characters, some of which have "
26437 "meaning to the shell such as C<#> and space. You may need to quote or "
26438 "escape these characters on the command line. See the shell manual page L<sh"
26439 "(1)> for details."
26443 #: ../tools/virt-edit.pl:352
26445 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26446 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26451 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26452 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:202
26453 #: ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277
26454 #: ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
26459 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512
26460 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:204
26461 #: ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279
26462 #: ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
26463 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26467 #: ../tools/virt-edit.pl:368 ../tools/virt-rescue.pl:283
26468 #: ../tools/virt-list-partitions.pl:275
26469 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26473 #: ../tools/virt-win-reg.pl:37
26475 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26479 #: ../tools/virt-win-reg.pl:41
26482 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26487 #: ../tools/virt-win-reg.pl:43
26490 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26495 #: ../tools/virt-win-reg.pl:45
26498 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26503 #: ../tools/virt-win-reg.pl:47
26506 " virt-win-reg --merge domname [input.reg ...]\n"
26511 #: ../tools/virt-win-reg.pl:49
26514 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26519 #: ../tools/virt-win-reg.pl:53
26521 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26522 "virtual machines. If you do this, you I<will> get irreversible disk "
26523 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26524 "but doesn't catch all cases."
26528 #: ../tools/virt-win-reg.pl:58
26530 "Modifying the Windows Registry is an inherently risky operation. The format "
26531 "is deliberately obscure and undocumented, and Registry changes can leave the "
26532 "system unbootable. Therefore when using the C<--merge> option, make sure "
26533 "you have a reliable backup first."
26537 #: ../tools/virt-win-reg.pl:65
26539 "This program can export and merge Windows Registry entries from a Windows "
26544 #: ../tools/virt-win-reg.pl:68
26546 "The first parameter is the libvirt guest name or the raw disk image of a "
26551 #: ../tools/virt-win-reg.pl:71
26553 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26554 "exported (recursively). For example:"
26558 #: ../tools/virt-win-reg.pl:74
26561 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26566 #: ../tools/virt-win-reg.pl:76
26568 "You can also display single values from within registry keys, for example:"
26572 #: ../tools/virt-win-reg.pl:79
26575 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26576 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26577 " Windows 7 Enterprise\n"
26582 #: ../tools/virt-win-reg.pl:83
26584 "With C<--merge>, you can merge a textual regedit file into the Windows "
26589 #: ../tools/virt-win-reg.pl:86
26592 " $ virt-win-reg --merge Windows7 changes.reg\n"
26597 #: ../tools/virt-win-reg.pl:88
26598 msgid "SUPPORTED SYSTEMS"
26602 #: ../tools/virt-win-reg.pl:90
26604 "The program currently supports Windows NT-derived guests starting with "
26605 "Windows XP through to at least Windows 7."
26609 #: ../tools/virt-win-reg.pl:93
26611 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26612 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26613 "and C<HKEY_USERS\\.DEFAULT>."
26617 #: ../tools/virt-win-reg.pl:97
26619 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26624 #: ../tools/virt-win-reg.pl:100
26626 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26631 #: ../tools/virt-win-reg.pl:103
26636 #: ../tools/virt-win-reg.pl:105
26638 "This program is only meant for simple access to the registry. If you want "
26639 "to do complicated things with the registry, we suggest you download the "
26640 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26641 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26642 "L<hivexregedit(1)>."
26646 #: ../tools/virt-win-reg.pl:111
26651 #: ../tools/virt-win-reg.pl:113
26653 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26654 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26655 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26656 "Windows-style line endings, you may need to reencode the whole file before "
26657 "or after processing."
26661 #: ../tools/virt-win-reg.pl:119
26663 "To reencode a file from Windows format to Linux (before processing it with "
26664 "the C<--merge> option), you would do something like this:"
26668 #: ../tools/virt-win-reg.pl:122
26671 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26676 #: ../tools/virt-win-reg.pl:124
26678 "To go in the opposite direction, after exporting and before sending the file "
26679 "to a Windows user, do something like this:"
26683 #: ../tools/virt-win-reg.pl:127
26686 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26691 #: ../tools/virt-win-reg.pl:129
26692 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26696 #: ../tools/virt-win-reg.pl:131
26698 "If you are unsure about the current encoding, use the L<file(1)> command. "
26699 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26700 "style (CRLF) line endings, like this:"
26704 #: ../tools/virt-win-reg.pl:135
26707 " $ file software.reg\n"
26708 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26709 " with CRLF line terminators\n"
26714 #: ../tools/virt-win-reg.pl:139
26715 msgid "This file would need conversion before you could C<--merge> it."
26719 #: ../tools/virt-win-reg.pl:143
26721 "Be careful when passing parameters containing C<\\> (backslash) in the "
26722 "shell. Usually you will have to use 'single quotes' or double backslashes "
26723 "(but not both) to protect them from the shell."
26727 #: ../tools/virt-win-reg.pl:147
26728 msgid "Paths and value names are case-insensitive."
26732 #: ../tools/virt-win-reg.pl:149
26733 msgid "CurrentControlSet etc."
26737 #: ../tools/virt-win-reg.pl:151
26739 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26740 "Registry at the level of the hive file, and therefore you cannot modify "
26745 #: ../tools/virt-win-reg.pl:155
26747 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26748 "circumstances it might refer to another control set. The way to find out is "
26749 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26753 #: ../tools/virt-win-reg.pl:159
26756 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26757 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26758 " \"Current\"=dword:00000001\n"
26759 " \"Default\"=dword:00000001\n"
26760 " \"Failed\"=dword:00000000\n"
26761 " \"LastKnownGood\"=dword:00000002\n"
26766 #: ../tools/virt-win-reg.pl:166
26767 msgid "\"Current\" is the one which Windows will choose when it boots."
26771 #: ../tools/virt-win-reg.pl:168
26773 "Similarly, other C<Current...> keys in the path may need to be replaced."
26777 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26782 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:500
26783 msgid "Enable debugging messages."
26787 #: ../tools/virt-win-reg.pl:232
26792 #: ../tools/virt-win-reg.pl:234
26794 "In merge mode, this merges a textual regedit file into the Windows Registry "
26795 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26796 "displays or exports Registry entries instead."
26800 #: ../tools/virt-win-reg.pl:238
26802 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26803 "result in disk corruption. However exporting (without this flag) is always "
26808 #: ../tools/virt-win-reg.pl:246
26809 msgid "B<--encoding> UTF-16LE|ASCII"
26813 #: ../tools/virt-win-reg.pl:248
26815 "When merging (only), you may need to specify the encoding for strings to be "
26816 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26817 "(3)/ENCODING STRINGS>."
26821 #: ../tools/virt-win-reg.pl:252
26823 "The default is to use UTF-16LE, which should work with recent versions of "
26828 #: ../tools/virt-win-reg.pl:486
26830 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26831 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26832 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26836 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26838 "When reporting bugs, please enable debugging and capture the I<complete> "
26843 #: ../tools/virt-win-reg.pl:504
26846 " export LIBGUESTFS_DEBUG=1\n"
26847 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26852 #: ../tools/virt-win-reg.pl:507
26854 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26859 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1512
26860 #: ../tools/virt-make-fs.pl:565
26861 msgid "Copyright (C) 2010 Red Hat Inc."
26865 #: ../tools/virt-resize.pl:42
26866 msgid "virt-resize - Resize a virtual machine disk"
26870 #: ../tools/virt-resize.pl:46
26873 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26874 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26875 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26880 #: ../tools/virt-resize.pl:52
26882 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26883 "larger or smaller overall, and resizing or deleting any partitions contained "
26888 #: ../tools/virt-resize.pl:56
26890 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26891 "not> be used on live virtual machines - for consistent results, shut the "
26892 "virtual machine down before resizing it."
26896 #: ../tools/virt-resize.pl:60
26898 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26899 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26903 #: ../tools/virt-resize.pl:66
26905 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26906 "fill the extra 5GB of space."
26910 #: ../tools/virt-resize.pl:69
26913 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26914 " virt-filesystems --long --h --all -a olddisk\n"
26915 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26916 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26921 #: ../tools/virt-resize.pl:74
26923 "As above, but make the /boot partition 200MB bigger, while giving the "
26924 "remaining space to /dev/sda2:"
26928 #: ../tools/virt-resize.pl:77
26931 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26936 #: ../tools/virt-resize.pl:79
26937 msgid "As above, but the output format will be uncompressed qcow2:"
26941 #: ../tools/virt-resize.pl:81
26944 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26945 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26950 #: ../tools/virt-resize.pl:84
26951 msgid "DETAILED USAGE"
26955 #: ../tools/virt-resize.pl:86
26956 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26960 #: ../tools/virt-resize.pl:90
26961 msgid "1. Shut down the virtual machine"
26965 #: ../tools/virt-resize.pl:92
26966 msgid "2. Locate input disk image"
26970 #: ../tools/virt-resize.pl:94
26972 "Locate the input disk image (ie. the file or device on the host containing "
26973 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26974 "dumpxml> like this to find the disk image name:"
26978 #: ../tools/virt-resize.pl:98
26981 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26982 " Found 1 nodes:\n"
26984 " <source dev=\"/dev/vg/lv_guest\" />\n"
26989 #: ../tools/virt-resize.pl:103
26990 msgid "3. Look at current sizing"
26994 #: ../tools/virt-resize.pl:105
26995 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
26999 #: ../tools/virt-resize.pl:108
27002 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27003 " Name Type Size Parent\n"
27004 " /dev/sda1 partition 101M /dev/sda\n"
27005 " /dev/sda2 partition 7.9G /dev/sda\n"
27006 " /dev/sda device 8.0G -\n"
27011 #: ../tools/virt-resize.pl:114
27013 "(This example is a virtual machine with an 8 GB disk which we would like to "
27014 "expand up to 10 GB)."
27018 #: ../tools/virt-resize.pl:117
27019 msgid "4. Create output disk"
27023 #: ../tools/virt-resize.pl:119
27025 "Virt-resize cannot do in-place disk modifications. You have to have space "
27026 "to store the resized output disk."
27030 #: ../tools/virt-resize.pl:122
27032 "To store the resized disk image in a file, create a file of a suitable size:"
27036 #: ../tools/virt-resize.pl:125
27039 " # rm -f outdisk\n"
27040 " # truncate -s 10G outdisk\n"
27045 #: ../tools/virt-resize.pl:128
27046 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27050 #: ../tools/virt-resize.pl:130
27053 " # lvcreate -L 10G -n lv_name vg_name\n"
27058 #: ../tools/virt-resize.pl:132
27059 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27063 #: ../tools/virt-resize.pl:134
27066 " # virsh pool-list\n"
27067 " # virsh vol-create-as poolname newvol 10G\n"
27072 #: ../tools/virt-resize.pl:137
27077 #: ../tools/virt-resize.pl:139
27079 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27080 "file) and the output disk. The output disk is the one created in the "
27085 #: ../tools/virt-resize.pl:143
27088 " # virt-resize indisk outdisk\n"
27093 #: ../tools/virt-resize.pl:145
27095 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27096 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27097 "larger, then an extra, empty partition is created at the end of the disk "
27098 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27103 #: ../tools/virt-resize.pl:151
27105 "More realistically you'd want to expand existing partitions in the disk "
27106 "image by passing extra options (for the full list see the L</OPTIONS> "
27111 #: ../tools/virt-resize.pl:155
27113 "L</--expand> is the most useful option. It expands the named partition "
27114 "within the disk to fill any extra space:"
27118 #: ../tools/virt-resize.pl:158
27121 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27126 #: ../tools/virt-resize.pl:160
27128 "(In this case, an extra partition is I<not> created at the end of the disk, "
27129 "because there will be no unused space)."
27133 #: ../tools/virt-resize.pl:163
27135 "L</--resize> is the other commonly used option. The following would "
27136 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27137 "rest of the available space:"
27141 #: ../tools/virt-resize.pl:167
27144 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27145 " indisk outdisk\n"
27150 #: ../tools/virt-resize.pl:170
27152 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27153 "if virt-resize knows how, it will resize the contents, the equivalent of "
27154 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27155 ">. However virt-resize does not know how to resize some filesystems, so you "
27156 "would have to online resize them after booting the guest. And virt-resize "
27157 "also does not resize anything inside an LVM PV, it just resizes the PV "
27158 "itself and leaves the user to resize any LVs inside that PV as desired."
27162 #: ../tools/virt-resize.pl:179
27163 msgid "Other options are covered below."
27167 #: ../tools/virt-resize.pl:181
27172 #: ../tools/virt-resize.pl:183
27173 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27177 #: ../tools/virt-resize.pl:185
27178 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27182 #: ../tools/virt-resize.pl:187
27185 " # virsh edit guestname\n"
27190 #: ../tools/virt-resize.pl:189
27192 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27193 "html#elementsDisks>"
27197 #: ../tools/virt-resize.pl:192
27198 msgid "Then start up the domain with the new, resized disk:"
27202 #: ../tools/virt-resize.pl:194
27205 " # virsh start guestname\n"
27210 #: ../tools/virt-resize.pl:196
27212 "and check that it still works. See also the L</NOTES> section below for "
27213 "additional information."
27217 #: ../tools/virt-resize.pl:199
27218 msgid "7. Resize LVs etc inside the guest"
27222 #: ../tools/virt-resize.pl:201
27223 msgid "(This can also be done offline using L<guestfish(1)>)"
27227 #: ../tools/virt-resize.pl:203
27229 "Once the guest has booted you should see the new space available, at least "
27230 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27231 "may need to resize LVs inside PVs, and also resize filesystem types that "
27232 "virt-resize does not know how to expand."
27236 #: ../tools/virt-resize.pl:210
27237 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27241 #: ../tools/virt-resize.pl:212
27243 "Shrinking is somewhat more complex than expanding, and only an overview is "
27248 #: ../tools/virt-resize.pl:215
27250 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27251 "filesystems). The user has to shrink content before passing the disk image "
27252 "to virt-resize, and virt-resize will check that the content has been shrunk "
27257 #: ../tools/virt-resize.pl:220
27258 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27262 #: ../tools/virt-resize.pl:222
27264 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27265 "steps 3 and 4 above to allocate a new disk image."
27269 #: ../tools/virt-resize.pl:225
27271 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27275 #: ../tools/virt-resize.pl:228
27276 msgid "IGNORING OR DELETING PARTITIONS"
27280 #: ../tools/virt-resize.pl:230
27282 "virt-resize also gives a convenient way to ignore or delete partitions when "
27283 "copying from the input disk to the output disk. Ignoring a partition speeds "
27284 "up the copy where you don't care about the existing contents of a "
27285 "partition. Deleting a partition removes it completely, but note that it "
27286 "also renumbers any partitions after the one which is deleted, which can "
27287 "leave some guests unbootable."
27291 #: ../tools/virt-resize.pl:237
27292 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27296 #: ../tools/virt-resize.pl:239
27298 "If the input disk is in qcow2 format, then you may prefer that the output is "
27299 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27300 "the fly. The output format is simply determined by the format of the empty "
27301 "output container that you provide. Thus to create qcow2 output, use:"
27305 #: ../tools/virt-resize.pl:245
27308 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27313 #: ../tools/virt-resize.pl:247
27314 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27318 #: ../tools/virt-resize.pl:249
27319 msgid "Similarly, to get non-sparse raw output use:"
27323 #: ../tools/virt-resize.pl:251
27326 " fallocate -l size outdisk\n"
27331 #: ../tools/virt-resize.pl:253
27333 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27334 "dev/zero of=outdisk bs=1M count=..>)"
27338 #: ../tools/virt-resize.pl:266
27339 msgid "Display help."
27343 #: ../tools/virt-resize.pl:280
27344 msgid "B<--resize part=size>"
27348 #: ../tools/virt-resize.pl:282
27350 "Resize the named partition (expanding or shrinking it) so that it has the "
27355 #: ../tools/virt-resize.pl:285
27357 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27358 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27359 "Exabytes; or as a percentage of the current size; or as a relative number or "
27360 "percentage. For example:"
27364 #: ../tools/virt-resize.pl:290
27367 " --resize /dev/sda2=10G\n"
27372 #: ../tools/virt-resize.pl:292
27375 " --resize /dev/sda4=90%\n"
27380 #: ../tools/virt-resize.pl:294
27383 " --resize /dev/sda2=+1G\n"
27388 #: ../tools/virt-resize.pl:296
27391 " --resize /dev/sda2=-200M\n"
27396 #: ../tools/virt-resize.pl:298
27399 " --resize /dev/sda1=+128K\n"
27404 #: ../tools/virt-resize.pl:300
27407 " --resize /dev/sda1=+10%\n"
27412 #: ../tools/virt-resize.pl:302
27415 " --resize /dev/sda1=-10%\n"
27420 #: ../tools/virt-resize.pl:304
27422 "You can increase the size of any partition. Virt-resize will expand the "
27423 "direct content of the partition if it knows how (see C<--expand> below)."
27427 #: ../tools/virt-resize.pl:308
27429 "You can only I<decrease> the size of partitions that contain filesystems or "
27430 "PVs which have already been shrunk. Virt-resize will check this has been "
27431 "done before proceeding, or else will print an error (see also C<--resize-"
27436 #: ../tools/virt-resize.pl:313 ../tools/virt-resize.pl:405
27437 #: ../tools/virt-resize.pl:422
27438 msgid "You can give this option multiple times."
27442 #: ../tools/virt-resize.pl:319
27443 msgid "B<--resize-force part=size>"
27447 #: ../tools/virt-resize.pl:321
27449 "This is the same as C<--resize> except that it will let you decrease the "
27450 "size of any partition. Generally this means you will lose any data which "
27451 "was at the end of the partition you shrink, but you may not care about that "
27452 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27453 "as a swap partition)."
27457 #: ../tools/virt-resize.pl:327
27458 msgid "See also the C<--ignore> option."
27462 #: ../tools/virt-resize.pl:333
27463 msgid "B<--expand part>"
27467 #: ../tools/virt-resize.pl:335
27469 "Expand the named partition so it uses up all extra space (space left over "
27470 "after any other resize changes that you request have been done)."
27474 #: ../tools/virt-resize.pl:338
27476 "If virt-resize knows how, it will expand the direct content of the "
27477 "partition. For example, if the partition is an LVM PV, it will expand the "
27478 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27479 "content it doesn't know about alone."
27483 #: ../tools/virt-resize.pl:343
27484 msgid "Currently virt-resize can resize:"
27488 #: ../tools/virt-resize.pl:349
27490 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27495 #: ../tools/virt-resize.pl:354
27497 "NTFS filesystems contained directly in a partition, if libguestfs was "
27498 "compiled with support for NTFS."
27502 #: ../tools/virt-resize.pl:357
27504 "The filesystem must have been shut down consistently last time it was used. "
27505 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27506 "consistency check, so at the first boot after resizing Windows will check "
27511 #: ../tools/virt-resize.pl:364
27513 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27514 "inside the PV. The user will have to resize LVs as desired."
27518 #: ../tools/virt-resize.pl:370 ../tools/virt-resize.pl:392
27519 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27523 #: ../tools/virt-resize.pl:376
27524 msgid "B<--shrink part>"
27528 #: ../tools/virt-resize.pl:378
27530 "Shrink the named partition until the overall disk image fits in the "
27531 "destination. The named partition B<must> contain a filesystem or PV which "
27532 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27533 "online tools). Virt-resize will check this and give an error if it has not "
27538 #: ../tools/virt-resize.pl:384
27540 "The amount by which the overall disk must be shrunk (after carrying out all "
27541 "other operations requested by the user) is called the \"deficit\". For "
27542 "example, a straight copy (assume no other operations) from a 5GB disk image "
27543 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27544 "would give an error unless the user specified a partition to shrink and that "
27545 "partition had more than a gigabyte of free space."
27549 #: ../tools/virt-resize.pl:398
27550 msgid "B<--ignore part>"
27554 #: ../tools/virt-resize.pl:400
27556 "Ignore the named partition. Effectively this means the partition is "
27557 "allocated on the destination disk, but the content is not copied across from "
27558 "the source disk. The content of the partition will be blank (all zero "
27563 #: ../tools/virt-resize.pl:411
27564 msgid "B<--delete part>"
27568 #: ../tools/virt-resize.pl:413
27570 "Delete the named partition. It would be more accurate to describe this as "
27571 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27572 "the original disk image is left intact."
27576 #: ../tools/virt-resize.pl:417
27578 "Note that when you delete a partition, then anything contained in the "
27579 "partition is also deleted. Furthermore, this causes any partitions that "
27580 "come after to be I<renumbered>, which can easily make your guest unbootable."
27584 #: ../tools/virt-resize.pl:428
27585 msgid "B<--LV-expand logvol>"
27589 #: ../tools/virt-resize.pl:430
27591 "This takes the logical volume and, as a final step, expands it to fill all "
27592 "the space available in its volume group. A typical usage, assuming a Linux "
27593 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27594 "lv_root> would be:"
27598 #: ../tools/virt-resize.pl:435
27601 " virt-resize indisk outdisk \\\n"
27602 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27607 #: ../tools/virt-resize.pl:438
27609 "This would first expand the partition (and PV), and then expand the root "
27610 "device to fill the extra space in the PV."
27614 #: ../tools/virt-resize.pl:441
27616 "The contents of the LV are also resized if virt-resize knows how to do "
27617 "that. You can stop virt-resize from trying to expand the content by using "
27618 "the option C<--no-expand-content>."
27622 #: ../tools/virt-resize.pl:445
27623 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27627 #: ../tools/virt-resize.pl:448
27629 "You can give this option multiple times, I<but> it doesn't make sense to do "
27630 "this unless the logical volumes you specify are all in different volume "
27635 #: ../tools/virt-resize.pl:456
27636 msgid "B<--no-copy-boot-loader>"
27640 #: ../tools/virt-resize.pl:458
27642 "By default, virt-resize copies over some sectors at the start of the disk "
27643 "(up to the beginning of the first partition). Commonly these sectors "
27644 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27645 "in order for the guest to boot correctly."
27649 #: ../tools/virt-resize.pl:463
27651 "If you specify this flag, then this initial copy is not done. You may need "
27652 "to reinstall the boot loader in this case."
27656 #: ../tools/virt-resize.pl:471
27657 msgid "B<--no-extra-partition>"
27661 #: ../tools/virt-resize.pl:473
27663 "By default, virt-resize creates an extra partition if there is any extra, "
27664 "unused space after all resizing has happened. Use this option to prevent "
27665 "the extra partition from being created. If you do this then the extra space "
27666 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27667 "tool in the guest."
27671 #: ../tools/virt-resize.pl:479
27673 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27678 #: ../tools/virt-resize.pl:486
27679 msgid "B<--no-expand-content>"
27683 #: ../tools/virt-resize.pl:488
27685 "By default, virt-resize will try to expand the direct contents of "
27686 "partitions, if it knows how (see C<--expand> option above)."
27690 #: ../tools/virt-resize.pl:491
27692 "If you give the C<--no-expand-content> option then virt-resize will not "
27697 #: ../tools/virt-resize.pl:498
27698 msgid "B<-d> | B<--debug>"
27702 #: ../tools/virt-resize.pl:506
27703 msgid "B<-n> | B<--dryrun>"
27707 #: ../tools/virt-resize.pl:508
27708 msgid "Print a summary of what would be done, but don't do anything."
27712 #: ../tools/virt-resize.pl:514
27713 msgid "B<-q> | B<--quiet>"
27717 #: ../tools/virt-resize.pl:516
27718 msgid "Don't print the summary."
27722 #: ../tools/virt-resize.pl:524
27724 "Specify the format of the input disk image. If this flag is not given then "
27725 "it is auto-detected from the image itself."
27729 #: ../tools/virt-resize.pl:530
27731 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27732 "AND NON-SPARSE RAW FORMATS>."
27736 #: ../tools/virt-resize.pl:537
27737 msgid "B<--output-format> raw"
27741 #: ../tools/virt-resize.pl:539
27743 "Specify the format of the output disk image. If this flag is not given then "
27744 "it is auto-detected from the image itself."
27748 #: ../tools/virt-resize.pl:545
27750 "Note that you still need to create the output disk with the right format. "
27751 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27755 #: ../tools/virt-resize.pl:1421 ../tools/virt-rescue.pl:90
27760 #: ../tools/virt-resize.pl:1423
27761 msgid "\"Partition 1 does not end on cylinder boundary.\""
27765 #: ../tools/virt-resize.pl:1425
27767 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27768 "means the partitions will not be aligned to the ancient CHS geometry. "
27769 "However CHS geometry is meaningless for disks manufactured since the early "
27770 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27771 "cylinders is not required by any modern operating system."
27775 #: ../tools/virt-resize.pl:1432
27776 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27780 #: ../tools/virt-resize.pl:1434
27782 "In Windows Vista and later versions, Microsoft switched to using a separate "
27783 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27784 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27785 "the boot partition. Doing so seems to break the guest completely. However "
27786 "expanding the second partition (ie. C: drive) should work."
27790 #: ../tools/virt-resize.pl:1441
27792 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27793 "NTFS partitions have been expanded. This is just a safety check and (unless "
27794 "it find errors) is nothing to worry about."
27798 #: ../tools/virt-resize.pl:1445
27799 msgid "GUEST BOOT STUCK AT \"GRUB\""
27803 #: ../tools/virt-resize.pl:1447
27805 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27806 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27807 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27808 "although we think is to do with partition alignment."
27812 #: ../tools/virt-resize.pl:1452
27815 " guestfish -i -a newdisk\n"
27816 " ><fs> cat /boot/grub/device.map\n"
27817 " # check the contents of this file are sensible or\n"
27818 " # edit the file if necessary\n"
27819 " ><fs> grub-install / /dev/vda\n"
27825 #: ../tools/virt-resize.pl:1459
27827 "For more flexible guest reconfiguration, including if you need to specify "
27828 "other parameters to grub-install, use L<virt-rescue(1)>."
27832 #: ../tools/virt-resize.pl:1462
27833 msgid "ALTERNATIVE TOOLS"
27837 #: ../tools/virt-resize.pl:1464
27839 "There are several proprietary tools for resizing partitions. We won't "
27840 "mention any here."
27844 #: ../tools/virt-resize.pl:1467
27846 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27847 "operations on disk images. They can resize and move partitions, but I don't "
27848 "think they can do anything with the contents, and they certainly don't "
27853 #: ../tools/virt-resize.pl:1472
27855 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27856 "but at a much lower level. You will probably end up hand-calculating sector "
27857 "offsets, which is something that virt-resize was designed to avoid. If you "
27858 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27863 #: ../tools/virt-resize.pl:1487
27865 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
27866 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
27867 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
27868 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
27869 "libguestfs.org/>."
27873 #: ../tools/virt-list-filesystems.pl:32
27875 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27879 #: ../tools/virt-list-filesystems.pl:36
27882 " virt-list-filesystems [--options] domname\n"
27887 #: ../tools/virt-list-filesystems.pl:38
27890 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27895 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27897 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27902 #: ../tools/virt-list-filesystems.pl:45
27904 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27905 "are contained in a virtual machine or disk image."
27909 #: ../tools/virt-list-filesystems.pl:49
27911 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27912 "functionality. For more complex cases you should look at the L<guestfish(1)"
27917 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27918 msgid "B<-l> | B<--long>"
27922 #: ../tools/virt-list-filesystems.pl:108
27924 "With this option, C<virt-list-filesystems> displays the type of each "
27925 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27929 #: ../tools/virt-list-filesystems.pl:115
27930 msgid "B<-a> | B<--all>"
27934 #: ../tools/virt-list-filesystems.pl:117
27936 "Normally we only show mountable filesystems. If this option is given then "
27937 "swap devices are shown too."
27941 #: ../tools/virt-list-filesystems.pl:191
27943 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
27944 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27945 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27949 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27950 msgid "Copyright (C) 2009 Red Hat Inc."
27954 #: ../tools/virt-tar.pl:33
27955 msgid "virt-tar - Extract or upload files to a virtual machine"
27959 #: ../tools/virt-tar.pl:37
27962 " virt-tar [--options] -x domname directory tarball\n"
27967 #: ../tools/virt-tar.pl:39
27970 " virt-tar [--options] -u domname tarball directory\n"
27975 #: ../tools/virt-tar.pl:41
27978 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27983 #: ../tools/virt-tar.pl:43
27986 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27991 #: ../tools/virt-tar.pl:47
27992 msgid "Download C</home> from the VM into a local tarball:"
27996 #: ../tools/virt-tar.pl:49
27999 " virt-tar -x domname /home home.tar\n"
28004 #: ../tools/virt-tar.pl:51
28007 " virt-tar -zx domname /home home.tar.gz\n"
28012 #: ../tools/virt-tar.pl:53
28013 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28017 #: ../tools/virt-tar.pl:55
28020 " virt-tar -u domname uploadstuff.tar /tmp\n"
28025 #: ../tools/virt-tar.pl:57
28028 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28033 #: ../tools/virt-tar.pl:61
28035 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28036 "virtual machines. If you do this, you risk disk corruption in the VM. "
28037 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28041 #: ../tools/virt-tar.pl:66
28043 "You can use C<-x> (extract) on live virtual machines, but you might get "
28044 "inconsistent results or errors if there is filesystem activity inside the "
28045 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28046 "work, but the only way to guarantee consistent results is if the virtual "
28047 "machine is shut down."
28051 #: ../tools/virt-tar.pl:74
28053 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28054 "parts of a guest filesystem. There are many possibilities: making backups, "
28055 "uploading data files, snooping on guest activity, fixing or customizing "
28060 #: ../tools/virt-tar.pl:79
28062 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28063 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28064 "should look at the L<guestfish(1)> tool."
28068 #: ../tools/virt-tar.pl:83
28070 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28071 "its contents (recursively) from the virtual machine into a local tarball. "
28072 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28073 "virtual machine. You cannot use these two options together."
28077 #: ../tools/virt-tar.pl:89
28079 "In addition, you may need to use the C<-z> (gZip) option to enable "
28080 "compression. When uploading, you have to specify C<-z> if the upload file "
28081 "is compressed because virt-tar won't detect this on its own."
28085 #: ../tools/virt-tar.pl:93
28087 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28088 "example it cannot do PKZip files or bzip2 compression. If you want that "
28089 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28090 "the L<libguestfs(3)> API)."
28094 #: ../tools/virt-tar.pl:151
28095 msgid "B<-x> | B<--extract> | B<--download>"
28099 #: ../tools/virt-tar.pl:153
28100 msgid "B<-u> | B<--upload>"
28104 #: ../tools/virt-tar.pl:155
28106 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28111 #: ../tools/virt-tar.pl:158
28113 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28114 "Please read the L</WARNING> section above before using this option."
28118 #: ../tools/virt-tar.pl:162
28119 msgid "You must specify exactly one of these options."
28123 #: ../tools/virt-tar.pl:168
28124 msgid "B<-z> | B<--gzip>"
28128 #: ../tools/virt-tar.pl:170
28129 msgid "Specify that the input or output tarball is gzip-compressed."
28133 #: ../tools/virt-tar.pl:283
28135 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28136 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28141 #: ../tools/virt-rescue.pl:33
28142 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28146 #: ../tools/virt-rescue.pl:37
28149 " virt-rescue [--options] domname\n"
28154 #: ../tools/virt-rescue.pl:39
28157 " virt-rescue [--options] disk.img [disk.img ...]\n"
28162 #: ../tools/virt-rescue.pl:43
28164 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28165 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28166 "you from doing this, but doesn't catch all cases."
28170 #: ../tools/virt-rescue.pl:47
28172 "However if you use the I<--ro> (read only) option, then you can attach a "
28173 "shell to a live virtual machine. The results might be strange or "
28174 "inconsistent at times but you won't get disk corruption."
28178 #: ../tools/virt-rescue.pl:53
28180 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28181 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28182 "recovery tools which you can use to examine or rescue a virtual machine or "
28187 #: ../tools/virt-rescue.pl:58
28189 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28190 "on disk image(s):"
28194 #: ../tools/virt-rescue.pl:61
28197 " virt-rescue GuestName\n"
28202 #: ../tools/virt-rescue.pl:63
28205 " virt-rescue --ro /path/to/disk.img\n"
28210 #: ../tools/virt-rescue.pl:65
28213 " virt-rescue /dev/sdc\n"
28218 #: ../tools/virt-rescue.pl:67
28219 msgid "For live VMs you I<must> use the --ro option."
28223 #: ../tools/virt-rescue.pl:69
28225 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28226 "in an interactive bash shell where you can use many ordinary Linux "
28227 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28228 "appliance. You must mount the virtual machine's filesystems by hand. There "
28229 "is an empty directory called C</sysroot> where you can mount filesystems."
28233 #: ../tools/virt-rescue.pl:76
28235 "In the example below, we list logical volumes, then choose one to mount "
28236 "under C</sysroot>:"
28240 #: ../tools/virt-rescue.pl:79
28244 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28245 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28246 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28247 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28248 " ><rescue> ls /sysroot\n"
28253 #: ../tools/virt-rescue.pl:86
28255 "If you don't know what filesystems are available on the virtual machine then "
28256 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28260 #: ../tools/virt-rescue.pl:92
28262 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28263 "virtual machine. For example you can use it on a blank file if you want to "
28264 "partition that file (although we would recommend using L<guestfish(1)> "
28265 "instead as it is more suitable for this purpose). You can even use virt-"
28266 "rescue on things like SD cards."
28270 #: ../tools/virt-rescue.pl:98
28272 "This tool is just designed for quick interactive hacking on a virtual "
28273 "machine. For more structured access to a virtual machine disk image, you "
28274 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28275 "make scripted changes to guests, use L<guestfish(1)>."
28279 #: ../tools/virt-rescue.pl:127
28280 msgid "B<--append kernelopts>"
28284 #: ../tools/virt-rescue.pl:129
28285 msgid "Pass additional options to the rescue kernel."
28289 #: ../tools/virt-rescue.pl:164
28290 msgid "B<--memsize MB> | B<-m MB>"
28294 #: ../tools/virt-rescue.pl:166
28296 "Change the amount of memory allocated to the rescue system. The default is "
28297 "set by libguestfs and is small but adequate for running system tools. The "
28298 "occasional program might need more memory. The parameter is specified in "
28303 #: ../tools/virt-rescue.pl:175
28304 msgid "B<--network>"
28308 #: ../tools/virt-rescue.pl:177
28309 msgid "Enable QEMU user networking in the guest."
28313 #: ../tools/virt-rescue.pl:183
28314 msgid "B<--ro> | B<-r>"
28318 #: ../tools/virt-rescue.pl:185
28319 msgid "Open the image read-only."
28323 #: ../tools/virt-rescue.pl:197
28325 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28326 "SELINUX> before using this option."
28330 #: ../tools/virt-rescue.pl:257
28332 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28333 "ENVIRONMENT VARIABLES> for the complete list."
28337 #: ../tools/virt-rescue.pl:269
28339 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28340 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28344 #: ../tools/virt-make-fs.pl:37
28345 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28349 #: ../tools/virt-make-fs.pl:41
28352 " virt-make-fs [--options] input.tar output.img\n"
28357 #: ../tools/virt-make-fs.pl:43
28360 " virt-make-fs [--options] input.tar.gz output.img\n"
28365 #: ../tools/virt-make-fs.pl:45
28368 " virt-make-fs [--options] directory output.img\n"
28373 #: ../tools/virt-make-fs.pl:49
28375 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28376 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28377 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28378 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28379 "you want to attach these filesystems to existing virtual machines (eg. to "
28380 "import large amounts of read-only data to a VM)."
28384 #: ../tools/virt-make-fs.pl:57
28385 msgid "Basic usage is:"
28389 #: ../tools/virt-make-fs.pl:59
28392 " virt-make-fs input output\n"
28397 #: ../tools/virt-make-fs.pl:61
28399 "where C<input> is either a directory containing files that you want to add, "
28400 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28401 "C<output> is a disk image. The input type is detected automatically. The "
28402 "output disk image defaults to a raw ext2 image unless you specify extra "
28403 "flags (see L</OPTIONS> below)."
28407 #: ../tools/virt-make-fs.pl:67
28408 msgid "EXTRA SPACE"
28412 #: ../tools/virt-make-fs.pl:69
28414 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28415 "the files that it contains, but might have extra space. Depending on how "
28416 "you are going to use the output, you might think this extra space is wasted "
28417 "and want to minimize it, or you might want to leave space so that more files "
28418 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28419 "but you can use the C<--size> flag to leave space in the filesystem if you "
28424 #: ../tools/virt-make-fs.pl:77
28426 "An alternative way to leave extra space but not make the output image any "
28427 "bigger is to use an alternative disk image format (instead of the default "
28428 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28429 "image format (check your hypervisor supports this before using it). This "
28430 "allows you to choose a large C<--size> but the extra space won't actually be "
28431 "allocated in the image until you try to store something in it."
28435 #: ../tools/virt-make-fs.pl:85
28437 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28438 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28439 "resize to build another image from scratch."
28443 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28444 #: ../tools/virt-make-fs.pl:142
28449 #: ../tools/virt-make-fs.pl:91
28452 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28457 #: ../tools/virt-make-fs.pl:93
28458 msgid "FILESYSTEM TYPE"
28462 #: ../tools/virt-make-fs.pl:95
28464 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28465 "libguestfs supports can be used (but I<not> read-only formats like "
28466 "ISO9660). Here are some of the more common choices:"
28470 #: ../tools/virt-make-fs.pl:101
28475 #: ../tools/virt-make-fs.pl:103
28477 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28478 "you are not going to use the filesystem in a way that requires the journal, "
28479 "then this is just wasted overhead."
28483 #: ../tools/virt-make-fs.pl:107
28484 msgid "I<ntfs> or I<vfat>"
28488 #: ../tools/virt-make-fs.pl:109
28489 msgid "Useful if exporting data to a Windows guest."
28493 #: ../tools/virt-make-fs.pl:111
28495 "I<Note for vfat>: The tar archive or local directory must only contain files "
28496 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28497 "program running within libguestfs is unable to change the ownership of non-"
28498 "root files, since vfat itself does not support this."
28502 #: ../tools/virt-make-fs.pl:116
28507 #: ../tools/virt-make-fs.pl:118
28509 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28510 "total filesystem size."
28514 #: ../tools/virt-make-fs.pl:125
28517 " virt-make-fs --type=minix input minixfs.img\n"
28522 #: ../tools/virt-make-fs.pl:127
28523 msgid "TO PARTITION OR NOT TO PARTITION"
28527 #: ../tools/virt-make-fs.pl:129
28528 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28532 #: ../tools/virt-make-fs.pl:131
28534 "Adding a partition can make the disk image more compatible with certain "
28535 "virtualized operating systems which don't expect to see a filesystem "
28536 "directly located on a block device (Linux doesn't care and will happily "
28537 "handle both types)."
28541 #: ../tools/virt-make-fs.pl:136
28543 "On the other hand, if you have a partition table then the output image is no "
28544 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28545 "directly on a partitioned disk image. (However libguestfs tools such as "
28546 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28550 #: ../tools/virt-make-fs.pl:144
28551 msgid "Add an MBR partition:"
28555 #: ../tools/virt-make-fs.pl:146
28558 " virt-make-fs --partition -- input disk.img\n"
28563 #: ../tools/virt-make-fs.pl:148
28565 "If the output disk image could be terabyte-sized or larger, it's better to "
28566 "use an EFI/GPT-compatible partition table:"
28570 #: ../tools/virt-make-fs.pl:151
28573 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28578 #: ../tools/virt-make-fs.pl:179
28579 msgid "Enable debugging information."
28583 #: ../tools/virt-make-fs.pl:185
28584 msgid "B<--size=E<lt>NE<gt>>"
28588 #: ../tools/virt-make-fs.pl:187
28589 msgid "B<--size=+E<lt>NE<gt>>"
28593 #: ../tools/virt-make-fs.pl:189
28594 msgid "B<-s E<lt>NE<gt>>"
28598 #: ../tools/virt-make-fs.pl:191
28599 msgid "B<-s +E<lt>NE<gt>>"
28603 #: ../tools/virt-make-fs.pl:193
28605 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28609 #: ../tools/virt-make-fs.pl:196
28611 "If this option is I<not> given, then the output image will be just large "
28612 "enough to contain all the files, with not much wasted space."
28616 #: ../tools/virt-make-fs.pl:199
28618 "To choose a fixed size output disk, specify an absolute number followed by b/"
28619 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28620 "Petabytes or Exabytes. This must be large enough to contain all the input "
28621 "files, else you will get an error."
28625 #: ../tools/virt-make-fs.pl:204
28627 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28628 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28629 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28630 "the input files, and (approximately) an extra 200 MB free space."
28634 #: ../tools/virt-make-fs.pl:210
28636 "Note that virt-make-fs estimates free space, and therefore will not produce "
28637 "filesystems containing precisely the free space requested. (It is much more "
28638 "expensive and time-consuming to produce a filesystem which has precisely the "
28639 "desired free space)."
28643 #: ../tools/virt-make-fs.pl:219
28644 msgid "B<--format=E<lt>fmtE<gt>>"
28648 #: ../tools/virt-make-fs.pl:221
28649 msgid "B<-F E<lt>fmtE<gt>>"
28653 #: ../tools/virt-make-fs.pl:223
28654 msgid "Choose the output disk image format."
28658 #: ../tools/virt-make-fs.pl:225
28659 msgid "The default is C<raw> (raw disk image)."
28663 #: ../tools/virt-make-fs.pl:227
28665 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28666 "that would really make sense here is C<qcow2>."
28670 #: ../tools/virt-make-fs.pl:234
28671 msgid "B<--type=E<lt>fsE<gt>>"
28675 #: ../tools/virt-make-fs.pl:236
28676 msgid "B<-t E<lt>fsE<gt>>"
28680 #: ../tools/virt-make-fs.pl:238
28681 msgid "Choose the output filesystem type."
28685 #: ../tools/virt-make-fs.pl:240
28686 msgid "The default is C<ext2>."
28690 #: ../tools/virt-make-fs.pl:242
28692 "Any filesystem which is supported read-write by libguestfs can be used here."
28696 #: ../tools/virt-make-fs.pl:249
28697 msgid "B<--partition>"
28701 #: ../tools/virt-make-fs.pl:251
28702 msgid "B<--partition=E<lt>parttypeE<gt>>"
28706 #: ../tools/virt-make-fs.pl:253
28708 "If specified, this flag adds an MBR partition table to the output disk image."
28712 #: ../tools/virt-make-fs.pl:256
28714 "You can change the partition table type, eg. C<--partition=gpt> for large "
28719 #: ../tools/virt-make-fs.pl:259
28721 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28722 "might consider the next parameter to be the partition type. For example:"
28726 #: ../tools/virt-make-fs.pl:263
28729 " virt-make-fs --partition input.tar ...\n"
28734 #: ../tools/virt-make-fs.pl:265
28736 "would cause virt-make-fs to think you wanted to use a partition type of "
28737 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28738 "dash) between options and the input file argument:"
28742 #: ../tools/virt-make-fs.pl:269
28745 " virt-make-fs --partition -- input.tar ...\n"
28750 #: ../tools/virt-make-fs.pl:536
28752 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28753 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28754 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28758 #: ../tools/virt-make-fs.pl:553
28761 " export LIBGUESTFS_DEBUG=1\n"
28762 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28767 #: ../tools/virt-make-fs.pl:556
28769 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28774 #: ../tools/virt-list-partitions.pl:32
28776 "virt-list-partitions - List partitions in a virtual machine or disk image"
28780 #: ../tools/virt-list-partitions.pl:36
28783 " virt-list-partitions [--options] domname\n"
28788 #: ../tools/virt-list-partitions.pl:38
28791 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28796 #: ../tools/virt-list-partitions.pl:45
28798 "C<virt-list-partitions> is a command line tool to list the partitions that "
28799 "are contained in a virtual machine or disk image. It is mainly useful as a "
28800 "first step to using L<virt-resize(1)>."
28804 #: ../tools/virt-list-partitions.pl:50
28806 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28807 "functionality. For more complex cases you should look at the L<guestfish(1)"
28812 #: ../tools/virt-list-partitions.pl:107
28813 msgid "B<-h> | B<--human-readable>"
28817 #: ../tools/virt-list-partitions.pl:109
28818 msgid "Show sizes in human-readable form (eg. \"1G\")."
28822 #: ../tools/virt-list-partitions.pl:117
28824 "With this option, C<virt-list-partitions> displays the type and size of each "
28825 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28829 #: ../tools/virt-list-partitions.pl:124
28830 msgid "B<-t> | B<--total>"
28834 #: ../tools/virt-list-partitions.pl:126
28836 "Display the total size of each block device (as a separate row or rows)."
28840 #: ../tools/virt-list-partitions.pl:259
28842 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
28843 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
28844 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."