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-24 20:19+0000\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
21 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
22 #: ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32
23 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
24 #: ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29
25 #: ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
30 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
31 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
32 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34
33 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
34 #: ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31
35 #: ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
40 #: ../src/guestfs.pod:5
41 msgid "guestfs - Library for accessing and modifying virtual machine images"
45 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
46 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
47 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38
48 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
49 #: ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35
50 #: ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
55 #: ../src/guestfs.pod:9
58 " #include <guestfs.h>\n"
63 #: ../src/guestfs.pod:11
66 " guestfs_h *g = guestfs_create ();\n"
67 " guestfs_add_drive (g, \"guest.img\");\n"
68 " guestfs_launch (g);\n"
69 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
70 " guestfs_touch (g, \"/hello\");\n"
71 " guestfs_umount (g, \"/\");\n"
72 " guestfs_sync (g);\n"
73 " guestfs_close (g);\n"
78 #: ../src/guestfs.pod:20
81 " cc prog.c -o prog -lguestfs\n"
83 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
88 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30
89 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
90 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46
91 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
92 #: ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51
93 #: ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
98 #: ../src/guestfs.pod:26
100 "Libguestfs is a library for accessing and modifying guest disk images. "
101 "Amongst the things this is good for: making batch configuration changes to "
102 "guests, getting disk used/free statistics (see also: virt-df), migrating "
103 "between virtualization systems (see also: virt-p2v), performing partial "
104 "backups, performing partial guest clones, cloning guests and changing "
105 "registry/UUID/hostname info, and much else besides."
109 #: ../src/guestfs.pod:34
111 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
112 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
113 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
118 #: ../src/guestfs.pod:39
120 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
121 "what filesystem is in each LV, etc.). It can also run commands in the "
122 "context of the guest. Also you can access filesystems over FUSE."
126 #: ../src/guestfs.pod:44
128 "Libguestfs is a library that can be linked with C and C++ management "
129 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
130 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
135 #: ../src/guestfs.pod:49
137 "You don't need to be root to use libguestfs, although obviously you do need "
138 "enough permissions to access the disk images."
142 #: ../src/guestfs.pod:52
144 "Libguestfs is a large API because it can do many things. For a gentle "
145 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:55
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-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:347
820 #: ../tools/virt-resize.pl:352 ../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-df.pl:640 ../tools/virt-resize.pl:1485
4063 #: ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281
4064 #: ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534
4065 #: ../tools/virt-list-partitions.pl:257
4070 #: ../src/guestfs.pod:2084
4072 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
4073 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
4074 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
4075 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
4076 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4077 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4081 #: ../src/guestfs.pod:2107
4083 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
4084 "(8)>, L<disktype(1)>."
4088 #: ../src/guestfs.pod:2114 ../tools/virt-win-reg.pl:499
4089 #: ../tools/virt-make-fs.pl:548
4094 #: ../src/guestfs.pod:2116
4095 msgid "To get a list of bugs against libguestfs use this link:"
4099 #: ../src/guestfs.pod:2118
4101 "L<https://bugzilla.redhat.com/buglist.cgi?"
4102 "component=libguestfs&product=Virtualization+Tools>"
4106 #: ../src/guestfs.pod:2120
4107 msgid "To report a new bug against libguestfs use this link:"
4111 #: ../src/guestfs.pod:2122
4113 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
4114 "component=libguestfs&product=Virtualization+Tools>"
4118 #: ../src/guestfs.pod:2124
4119 msgid "When reporting a bug, please check:"
4123 #: ../src/guestfs.pod:2130
4124 msgid "That the bug hasn't been reported already."
4128 #: ../src/guestfs.pod:2134
4129 msgid "That you are testing a recent version."
4133 #: ../src/guestfs.pod:2138
4134 msgid "Describe the bug accurately, and give a way to reproduce it."
4138 #: ../src/guestfs.pod:2142
4140 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4145 #: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1058
4146 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4151 #: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1060
4152 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4153 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4157 #: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1062
4158 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
4159 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514
4160 #: ../tools/virt-df.pl:653 ../tools/virt-resize.pl:1510
4161 #: ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296
4162 #: ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563
4163 #: ../tools/virt-list-partitions.pl:273
4168 #: ../src/guestfs.pod:2153 ../fish/guestfish.pod:1064
4169 #: ../fuse/guestmount.pod:250
4170 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4174 #: ../src/guestfs.pod:2156
4176 "This library is free software; you can redistribute it and/or modify it "
4177 "under the terms of the GNU Lesser General Public License as published by the "
4178 "Free Software Foundation; either version 2 of the License, or (at your "
4179 "option) any later version."
4183 #: ../src/guestfs.pod:2161
4185 "This library is distributed in the hope that it will be useful, but WITHOUT "
4186 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4187 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4192 #: ../src/guestfs.pod:2166
4194 "You should have received a copy of the GNU Lesser General Public License "
4195 "along with this library; if not, write to the Free Software Foundation, "
4196 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4200 #: ../src/guestfs-actions.pod:1
4201 msgid "guestfs_add_cdrom"
4205 #: ../src/guestfs-actions.pod:3
4209 " guestfs_add_cdrom (guestfs_h *g,\n"
4210 " const char *filename);\n"
4215 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4216 msgid "This function adds a virtual CD-ROM disk image to the guest."
4220 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4221 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4225 #: ../src/guestfs-actions.pod:17
4227 "This call checks for the existence of C<filename>. This stops you from "
4228 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4229 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4234 #: ../src/guestfs-actions.pod:24
4236 "If you just want to add an ISO file (often you use this as an efficient way "
4237 "to transfer large files into the guest), then you should probably use "
4238 "C<guestfs_add_drive_ro> instead."
4242 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
4243 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
4244 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
4245 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4246 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4247 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4248 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4249 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4250 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4251 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4252 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4253 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4254 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4255 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4256 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4257 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4258 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4259 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4260 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4261 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4262 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4263 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182
4264 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217
4265 #: ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356
4266 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383
4267 #: ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434
4268 #: ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526
4269 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566
4270 #: ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621
4271 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659
4272 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706
4273 #: ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758
4274 #: ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786
4275 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896
4276 #: ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929
4277 #: ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998
4278 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032
4279 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060
4280 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092
4281 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161
4282 #: ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211
4283 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242
4284 #: ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272
4285 #: ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302
4286 #: ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352
4287 #: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386
4288 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452
4289 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
4290 #: ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548
4291 #: ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700
4292 #: ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779
4293 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829
4294 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912
4295 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939
4296 #: ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247
4297 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273
4298 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299
4299 #: ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329
4300 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369
4301 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406
4302 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447
4303 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487
4304 #: ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523
4305 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575
4306 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618
4307 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648
4308 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704
4309 #: ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753
4310 #: ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982
4311 #: ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007
4312 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042
4313 #: ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068
4314 #: ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096
4315 #: ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172
4316 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204
4317 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234
4318 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290
4319 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345
4320 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376
4321 #: ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436
4322 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573
4323 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642
4324 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700
4325 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787
4326 #: ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879
4327 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4328 msgid "This function returns 0 on success or -1 on error."
4332 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4333 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4334 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4336 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4341 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4342 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4343 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4344 #: ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990
4345 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4346 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4347 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4348 #: ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4350 "Deprecated functions will not be removed from the API, but the fact that "
4351 "they are deprecated indicates that there are problems with correct use of "
4356 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4357 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4358 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4359 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199
4360 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408
4361 #: ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635
4362 #: ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223
4363 #: ../src/guestfs-actions.pod:6735
4364 msgid "(Added in 0.3)"
4368 #: ../src/guestfs-actions.pod:41
4369 msgid "guestfs_add_domain"
4373 #: ../src/guestfs-actions.pod:43
4377 " guestfs_add_domain (guestfs_h *g,\n"
4378 " const char *dom,\n"
4384 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4386 "You may supply a list of optional arguments to this call. Use zero or more "
4387 "of the following pairs of parameters, and terminate the list with C<-1> on "
4388 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4392 #: ../src/guestfs-actions.pod:53
4395 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4396 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4397 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4402 #: ../src/guestfs-actions.pod:57
4404 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4405 "It works by connecting to libvirt, requesting the domain and domain XML from "
4406 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4411 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4413 "The number of disks added is returned. This operation is atomic: if an "
4414 "error is returned, then no disks are added."
4418 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4420 "This function does some minimal checks to make sure the libvirt domain is "
4421 "not running (unless C<readonly> is true). In a future version we will try "
4422 "to acquire the libvirt lock on each disk."
4426 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4428 "Disks must be accessible locally. This often means that adding disks from a "
4429 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4430 "unless those disks are accessible via the same device path locally too."
4434 #: ../src/guestfs-actions.pod:74
4436 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4437 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4438 "libvirt URI (or one set through an environment variable, see the libvirt "
4439 "documentation for full details). If you are using the C API directly then "
4440 "it is more flexible to create the libvirt connection object yourself, get "
4441 "the domain object, and call C<guestfs_add_libvirt_dom>."
4445 #: ../src/guestfs-actions.pod:82
4447 "The other optional parameters are passed directly through to "
4448 "C<guestfs_add_drive_opts>."
4452 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4453 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4454 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4455 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4456 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4457 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4458 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4459 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630
4460 #: ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475
4461 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009
4462 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331
4463 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759
4464 #: ../src/guestfs-actions.pod:6772
4465 msgid "On error this function returns -1."
4469 #: ../src/guestfs-actions.pod:87
4470 msgid "guestfs_add_domain_va"
4474 #: ../src/guestfs-actions.pod:89
4478 " guestfs_add_domain_va (guestfs_h *g,\n"
4479 " const char *dom,\n"
4485 #: ../src/guestfs-actions.pod:94
4486 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4490 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4491 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4492 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4496 #: ../src/guestfs-actions.pod:98
4497 msgid "guestfs_add_domain_argv"
4501 #: ../src/guestfs-actions.pod:100
4505 " guestfs_add_domain_argv (guestfs_h *g,\n"
4506 " const char *dom,\n"
4507 " const struct guestfs_add_domain_argv *optargs);\n"
4512 #: ../src/guestfs-actions.pod:105
4513 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4517 #: ../src/guestfs-actions.pod:109
4518 msgid "guestfs_add_drive"
4522 #: ../src/guestfs-actions.pod:111
4526 " guestfs_add_drive (guestfs_h *g,\n"
4527 " const char *filename);\n"
4532 #: ../src/guestfs-actions.pod:115
4534 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4535 "optional parameters, so the disk is added writable, with the format being "
4536 "detected automatically."
4540 #: ../src/guestfs-actions.pod:119
4542 "Automatic detection of the format opens you up to a potential security hole "
4543 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4544 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4545 "you should think about replacing calls to this function with calls to "
4546 "C<guestfs_add_drive_opts>, and specifying the format."
4550 #: ../src/guestfs-actions.pod:130
4551 msgid "guestfs_add_drive_opts"
4555 #: ../src/guestfs-actions.pod:132
4559 " guestfs_add_drive_opts (guestfs_h *g,\n"
4560 " const char *filename,\n"
4566 #: ../src/guestfs-actions.pod:142
4569 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4570 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4571 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4576 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4578 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4579 "The first time you call this function, the disk appears as C</dev/sda>, the "
4580 "second time as C</dev/sdb>, and so on."
4584 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4586 "You don't necessarily need to be root when using libguestfs. However you "
4587 "obviously do need sufficient permissions to access the filename for whatever "
4588 "operations you want to perform (ie. read access if you just want to read the "
4589 "image or write access if you want to modify the image)."
4593 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4594 msgid "This call checks that C<filename> exists."
4598 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4599 msgid "The optional arguments are:"
4603 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4608 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4610 "If true then the image is treated as read-only. Writes are still allowed, "
4611 "but they are stored in a temporary snapshot overlay which is discarded at "
4612 "the end. The disk that you add is not modified."
4616 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4621 #: ../src/guestfs-actions.pod:171
4623 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4624 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4625 "Possible formats include C<raw> and C<qcow2>."
4629 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4631 "Automatic detection of the format opens you up to a potential security hole "
4632 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4633 "RHBZ#642934. Specifying the format closes this security hole."
4637 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4642 #: ../src/guestfs-actions.pod:182
4644 "This rarely-used option lets you emulate the behaviour of the deprecated "
4645 "C<guestfs_add_drive_with_if> call (q.v.)"
4649 #: ../src/guestfs-actions.pod:189
4650 msgid "(Added in 1.5.23)"
4654 #: ../src/guestfs-actions.pod:191
4655 msgid "guestfs_add_drive_opts_va"
4659 #: ../src/guestfs-actions.pod:193
4663 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4664 " const char *filename,\n"
4670 #: ../src/guestfs-actions.pod:198
4671 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4675 #: ../src/guestfs-actions.pod:202
4676 msgid "guestfs_add_drive_opts_argv"
4680 #: ../src/guestfs-actions.pod:204
4684 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4685 " const char *filename,\n"
4686 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4691 #: ../src/guestfs-actions.pod:209
4692 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4696 #: ../src/guestfs-actions.pod:213
4697 msgid "guestfs_add_drive_ro"
4701 #: ../src/guestfs-actions.pod:215
4705 " guestfs_add_drive_ro (guestfs_h *g,\n"
4706 " const char *filename);\n"
4711 #: ../src/guestfs-actions.pod:219
4713 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4714 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4715 "disk is added read-only, with the format being detected automatically."
4719 #: ../src/guestfs-actions.pod:226
4720 msgid "(Added in 1.0.38)"
4724 #: ../src/guestfs-actions.pod:228
4725 msgid "guestfs_add_drive_ro_with_if"
4729 #: ../src/guestfs-actions.pod:230
4733 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4734 " const char *filename,\n"
4735 " const char *iface);\n"
4740 #: ../src/guestfs-actions.pod:235
4742 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4743 "QEMU interface emulation to use at run time."
4747 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4748 #: ../src/guestfs-actions.pod:2303
4749 msgid "(Added in 1.0.84)"
4753 #: ../src/guestfs-actions.pod:249
4754 msgid "guestfs_add_drive_with_if"
4758 #: ../src/guestfs-actions.pod:251
4762 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4763 " const char *filename,\n"
4764 " const char *iface);\n"
4769 #: ../src/guestfs-actions.pod:256
4771 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4772 "QEMU interface emulation to use at run time."
4776 #: ../src/guestfs-actions.pod:270
4777 msgid "guestfs_aug_clear"
4781 #: ../src/guestfs-actions.pod:272
4785 " guestfs_aug_clear (guestfs_h *g,\n"
4786 " const char *augpath);\n"
4791 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4793 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4794 "L<augtool(1)> C<clear> command."
4798 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4799 msgid "(Added in 1.3.4)"
4803 #: ../src/guestfs-actions.pod:283
4804 msgid "guestfs_aug_close"
4808 #: ../src/guestfs-actions.pod:285
4812 " guestfs_aug_close (guestfs_h *g);\n"
4817 #: ../src/guestfs-actions.pod:288
4819 "Close the current Augeas handle and free up any resources used by it. After "
4820 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4821 "any other Augeas functions."
4825 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4826 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4827 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4828 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4829 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4830 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4831 #: ../src/guestfs-actions.pod:5086
4832 msgid "(Added in 0.7)"
4836 #: ../src/guestfs-actions.pod:297
4837 msgid "guestfs_aug_defnode"
4841 #: ../src/guestfs-actions.pod:299
4844 " struct guestfs_int_bool *\n"
4845 " guestfs_aug_defnode (guestfs_h *g,\n"
4846 " const char *name,\n"
4847 " const char *expr,\n"
4848 " const char *val);\n"
4853 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4855 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4859 #: ../src/guestfs-actions.pod:308
4861 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4862 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4863 "containing that single node."
4867 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4869 "On success this returns a pair containing the number of nodes in the "
4870 "nodeset, and a boolean flag if a node was created."
4874 #: ../src/guestfs-actions.pod:316
4876 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4877 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4881 #: ../src/guestfs-actions.pod:322
4882 msgid "guestfs_aug_defvar"
4886 #: ../src/guestfs-actions.pod:324
4890 " guestfs_aug_defvar (guestfs_h *g,\n"
4891 " const char *name,\n"
4892 " const char *expr);\n"
4897 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4899 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4900 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4904 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4906 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4907 "evaluates to something which is not a nodeset."
4911 #: ../src/guestfs-actions.pod:340
4912 msgid "guestfs_aug_get"
4916 #: ../src/guestfs-actions.pod:342
4920 " guestfs_aug_get (guestfs_h *g,\n"
4921 " const char *augpath);\n"
4926 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4928 "Look up the value associated with C<path>. If C<path> matches exactly one "
4929 "node, the C<value> is returned."
4933 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4934 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4935 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4936 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4937 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4938 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4939 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4940 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4941 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4942 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
4943 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712
4944 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763
4945 #: ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846
4946 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678
4947 #: ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958
4948 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814
4949 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162
4950 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774
4951 #: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807
4952 #: ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495
4953 #: ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532
4954 #: ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4956 "This function returns a string, or NULL on error. I<The caller must free "
4957 "the returned string after use>."
4961 #: ../src/guestfs-actions.pod:354
4962 msgid "guestfs_aug_init"
4966 #: ../src/guestfs-actions.pod:356
4970 " guestfs_aug_init (guestfs_h *g,\n"
4971 " const char *root,\n"
4977 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4979 "Create a new Augeas handle for editing configuration files. If there was "
4980 "any previous Augeas handle associated with this guestfs session, then it is "
4985 #: ../src/guestfs-actions.pod:365
4986 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4990 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4992 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4996 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4998 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4999 "logical I<or> of the following integers:"
5003 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
5004 msgid "C<AUG_SAVE_BACKUP> = 1"
5008 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
5009 msgid "Keep the original file with a C<.augsave> extension."
5013 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
5014 msgid "C<AUG_SAVE_NEWFILE> = 2"
5018 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
5020 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5021 "original. Overrides C<AUG_SAVE_BACKUP>."
5025 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
5026 msgid "C<AUG_TYPE_CHECK> = 4"
5030 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
5031 msgid "Typecheck lenses (can be expensive)."
5035 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
5036 msgid "C<AUG_NO_STDINC> = 8"
5040 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
5041 msgid "Do not use standard load path for modules."
5045 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
5046 msgid "C<AUG_SAVE_NOOP> = 16"
5050 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
5051 msgid "Make save a no-op, just record what would have been changed."
5055 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
5056 msgid "C<AUG_NO_LOAD> = 32"
5060 #: ../src/guestfs-actions.pod:400
5061 msgid "Do not load the tree in C<guestfs_aug_init>."
5065 #: ../src/guestfs-actions.pod:404
5066 msgid "To close the handle, you can call C<guestfs_aug_close>."
5070 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
5071 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5075 #: ../src/guestfs-actions.pod:412
5076 msgid "guestfs_aug_insert"
5080 #: ../src/guestfs-actions.pod:414
5084 " guestfs_aug_insert (guestfs_h *g,\n"
5085 " const char *augpath,\n"
5086 " const char *label,\n"
5092 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
5094 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5095 "or after C<path> (depending on the boolean flag C<before>)."
5099 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
5101 "C<path> must match exactly one existing node in the tree, and C<label> must "
5102 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5106 #: ../src/guestfs-actions.pod:432
5107 msgid "guestfs_aug_load"
5111 #: ../src/guestfs-actions.pod:434
5115 " guestfs_aug_load (guestfs_h *g);\n"
5120 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
5121 msgid "Load files into the tree."
5125 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
5126 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5130 #: ../src/guestfs-actions.pod:446
5131 msgid "guestfs_aug_ls"
5135 #: ../src/guestfs-actions.pod:448
5139 " guestfs_aug_ls (guestfs_h *g,\n"
5140 " const char *augpath);\n"
5145 #: ../src/guestfs-actions.pod:452
5147 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5148 "sorting the resulting nodes into alphabetical order."
5152 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
5153 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
5154 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
5155 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
5156 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
5157 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
5158 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
5159 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
5160 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782
5161 #: ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248
5162 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415
5163 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436
5164 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082
5165 #: ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847
5166 #: ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963
5167 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133
5168 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625
5169 #: ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837
5170 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941
5171 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006
5172 #: ../src/guestfs-actions.pod:7025
5174 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5175 ">), or NULL if there was an error. I<The caller must free the strings and "
5176 "the array after use>."
5180 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
5181 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
5182 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102
5183 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711
5184 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931
5185 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440
5186 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275
5187 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301
5188 #: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347
5189 #: ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589
5190 #: ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
5191 msgid "(Added in 0.8)"
5195 #: ../src/guestfs-actions.pod:461
5196 msgid "guestfs_aug_match"
5200 #: ../src/guestfs-actions.pod:463
5204 " guestfs_aug_match (guestfs_h *g,\n"
5205 " const char *augpath);\n"
5210 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
5212 "Returns a list of paths which match the path expression C<path>. The "
5213 "returned paths are sufficiently qualified so that they match exactly one "
5214 "node in the current tree."
5218 #: ../src/guestfs-actions.pod:477
5219 msgid "guestfs_aug_mv"
5223 #: ../src/guestfs-actions.pod:479
5227 " guestfs_aug_mv (guestfs_h *g,\n"
5228 " const char *src,\n"
5229 " const char *dest);\n"
5234 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
5236 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5237 "C<dest> is overwritten if it exists."
5241 #: ../src/guestfs-actions.pod:491
5242 msgid "guestfs_aug_rm"
5246 #: ../src/guestfs-actions.pod:493
5250 " guestfs_aug_rm (guestfs_h *g,\n"
5251 " const char *augpath);\n"
5256 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5257 msgid "Remove C<path> and all of its children."
5261 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5262 msgid "On success this returns the number of entries which were removed."
5266 #: ../src/guestfs-actions.pod:505
5267 msgid "guestfs_aug_save"
5271 #: ../src/guestfs-actions.pod:507
5275 " guestfs_aug_save (guestfs_h *g);\n"
5280 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5281 msgid "This writes all pending changes to disk."
5285 #: ../src/guestfs-actions.pod:512
5287 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5292 #: ../src/guestfs-actions.pod:519
5293 msgid "guestfs_aug_set"
5297 #: ../src/guestfs-actions.pod:521
5301 " guestfs_aug_set (guestfs_h *g,\n"
5302 " const char *augpath,\n"
5303 " const char *val);\n"
5308 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5309 msgid "Set the value associated with C<path> to C<val>."
5313 #: ../src/guestfs-actions.pod:528
5315 "In the Augeas API, it is possible to clear a node by setting the value to "
5316 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5317 "this call. Instead you must use the C<guestfs_aug_clear> call."
5321 #: ../src/guestfs-actions.pod:537
5322 msgid "guestfs_available"
5326 #: ../src/guestfs-actions.pod:539
5330 " guestfs_available (guestfs_h *g,\n"
5331 " char *const *groups);\n"
5336 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5338 "This command is used to check the availability of some groups of "
5339 "functionality in the appliance, which not all builds of the libguestfs "
5340 "appliance will be able to provide."
5344 #: ../src/guestfs-actions.pod:547
5346 "The libguestfs groups, and the functions that those groups correspond to, "
5347 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5348 "runtime by calling C<guestfs_available_all_groups>."
5352 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5354 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5355 "\"]> would check for the availability of the Linux inotify functions and "
5356 "Augeas (configuration file editing) functions."
5360 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5361 msgid "The command returns no error if I<all> requested groups are available."
5365 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5367 "It fails with an error if one or more of the requested groups is unavailable "
5372 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5374 "If an unknown group name is included in the list of groups then an error is "
5379 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5384 #: ../src/guestfs-actions.pod:571
5385 msgid "You must call C<guestfs_launch> before calling this function."
5389 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5391 "The reason is because we don't know what groups are supported by the "
5392 "appliance/daemon until it is running and can be queried."
5396 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5398 "If a group of functions is available, this does not necessarily mean that "
5399 "they will work. You still have to check for errors when calling individual "
5400 "API functions even if they are available."
5404 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5406 "It is usually the job of distro packagers to build complete functionality "
5407 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5408 "with all requirements satisfied, will support everything."
5412 #: ../src/guestfs-actions.pod:593
5414 "This call was added in version C<1.0.80>. In previous versions of "
5415 "libguestfs all you could do would be to speculatively execute a command to "
5416 "find out if the daemon implemented it. See also C<guestfs_version>."
5420 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5421 msgid "(Added in 1.0.80)"
5425 #: ../src/guestfs-actions.pod:604
5426 msgid "guestfs_available_all_groups"
5430 #: ../src/guestfs-actions.pod:606
5434 " guestfs_available_all_groups (guestfs_h *g);\n"
5439 #: ../src/guestfs-actions.pod:609
5441 "This command returns a list of all optional groups that this daemon knows "
5442 "about. Note this returns both supported and unsupported groups. To find "
5443 "out which ones the daemon can actually support you have to call "
5444 "C<guestfs_available> on each member of the returned list."
5448 #: ../src/guestfs-actions.pod:615
5449 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5453 #: ../src/guestfs-actions.pod:621
5454 msgid "(Added in 1.3.15)"
5458 #: ../src/guestfs-actions.pod:623
5459 msgid "guestfs_base64_in"
5463 #: ../src/guestfs-actions.pod:625
5467 " guestfs_base64_in (guestfs_h *g,\n"
5468 " const char *base64file,\n"
5469 " const char *filename);\n"
5474 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5476 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5480 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5481 msgid "(Added in 1.3.5)"
5485 #: ../src/guestfs-actions.pod:637
5486 msgid "guestfs_base64_out"
5490 #: ../src/guestfs-actions.pod:639
5494 " guestfs_base64_out (guestfs_h *g,\n"
5495 " const char *filename,\n"
5496 " const char *base64file);\n"
5501 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5503 "This command downloads the contents of C<filename>, writing it out to local "
5504 "file C<base64file> encoded as base64."
5508 #: ../src/guestfs-actions.pod:651
5509 msgid "guestfs_blockdev_flushbufs"
5513 #: ../src/guestfs-actions.pod:653
5517 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5518 " const char *device);\n"
5523 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5525 "This tells the kernel to flush internal buffers associated with C<device>."
5529 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5530 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5531 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5532 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5533 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5534 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5535 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5536 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5537 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5538 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5539 msgid "This uses the L<blockdev(8)> command."
5543 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5544 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5545 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5546 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5547 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5548 msgid "(Added in 0.9.3)"
5552 #: ../src/guestfs-actions.pod:666
5553 msgid "guestfs_blockdev_getbsz"
5557 #: ../src/guestfs-actions.pod:668
5561 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5562 " const char *device);\n"
5567 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5568 msgid "This returns the block size of a device."
5572 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5573 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5575 "(Note this is different from both I<size in blocks> and I<filesystem block "
5580 #: ../src/guestfs-actions.pod:683
5581 msgid "guestfs_blockdev_getro"
5585 #: ../src/guestfs-actions.pod:685
5589 " guestfs_blockdev_getro (guestfs_h *g,\n"
5590 " const char *device);\n"
5595 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5597 "Returns a boolean indicating if the block device is read-only (true if read-"
5598 "only, false if not)."
5602 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5603 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5604 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5605 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5606 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5607 #: ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024
5608 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053
5609 #: ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084
5610 #: ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114
5611 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141
5612 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171
5613 #: ../src/guestfs-actions.pod:4585
5614 msgid "This function returns a C truth value on success or -1 on error."
5618 #: ../src/guestfs-actions.pod:698
5619 msgid "guestfs_blockdev_getsize64"
5623 #: ../src/guestfs-actions.pod:700
5627 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5628 " const char *device);\n"
5633 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5634 msgid "This returns the size of the device in bytes."
5638 #: ../src/guestfs-actions.pod:706
5639 msgid "See also C<guestfs_blockdev_getsz>."
5643 #: ../src/guestfs-actions.pod:714
5644 msgid "guestfs_blockdev_getss"
5648 #: ../src/guestfs-actions.pod:716
5652 " guestfs_blockdev_getss (guestfs_h *g,\n"
5653 " const char *device);\n"
5658 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5660 "This returns the size of sectors on a block device. Usually 512, but can be "
5661 "larger for modern devices."
5665 #: ../src/guestfs-actions.pod:723
5667 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5672 #: ../src/guestfs-actions.pod:732
5673 msgid "guestfs_blockdev_getsz"
5677 #: ../src/guestfs-actions.pod:734
5681 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5682 " const char *device);\n"
5687 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5689 "This returns the size of the device in units of 512-byte sectors (even if "
5690 "the sectorsize isn't 512 bytes ... weird)."
5694 #: ../src/guestfs-actions.pod:741
5696 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5697 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5701 #: ../src/guestfs-actions.pod:751
5702 msgid "guestfs_blockdev_rereadpt"
5706 #: ../src/guestfs-actions.pod:753
5710 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5711 " const char *device);\n"
5716 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5717 msgid "Reread the partition table on C<device>."
5721 #: ../src/guestfs-actions.pod:765
5722 msgid "guestfs_blockdev_setbsz"
5726 #: ../src/guestfs-actions.pod:767
5730 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5731 " const char *device,\n"
5732 " int blocksize);\n"
5737 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5738 msgid "This sets the block size of a device."
5742 #: ../src/guestfs-actions.pod:783
5743 msgid "guestfs_blockdev_setro"
5747 #: ../src/guestfs-actions.pod:785
5751 " guestfs_blockdev_setro (guestfs_h *g,\n"
5752 " const char *device);\n"
5757 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5758 msgid "Sets the block device named C<device> to read-only."
5762 #: ../src/guestfs-actions.pod:797
5763 msgid "guestfs_blockdev_setrw"
5767 #: ../src/guestfs-actions.pod:799
5771 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5772 " const char *device);\n"
5777 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5778 msgid "Sets the block device named C<device> to read-write."
5782 #: ../src/guestfs-actions.pod:811
5783 msgid "guestfs_case_sensitive_path"
5787 #: ../src/guestfs-actions.pod:813
5791 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5792 " const char *path);\n"
5797 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5799 "This can be used to resolve case insensitive paths on a filesystem which is "
5800 "case sensitive. The use case is to resolve paths which you have read from "
5801 "Windows configuration files or the Windows Registry, to the true path."
5805 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5807 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5808 "(and probably others), which is that although the underlying filesystem is "
5809 "case-insensitive, the driver exports the filesystem to Linux as case-"
5814 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5816 "One consequence of this is that special directories such as C<c:\\windows> "
5817 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5818 "precise details of how they were created. In Windows itself this would not "
5823 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5825 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5830 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5832 "This function resolves the true case of each element in the path and returns "
5833 "the case-sensitive path."
5837 #: ../src/guestfs-actions.pod:839
5839 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5840 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5841 "how the directories were originally created under Windows)."
5845 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5846 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5850 #: ../src/guestfs-actions.pod:847
5851 msgid "See also C<guestfs_realpath>."
5855 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5856 msgid "(Added in 1.0.75)"
5860 #: ../src/guestfs-actions.pod:854
5865 #: ../src/guestfs-actions.pod:856
5869 " guestfs_cat (guestfs_h *g,\n"
5870 " const char *path);\n"
5875 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072
5876 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5877 msgid "Return the contents of the file named C<path>."
5881 #: ../src/guestfs-actions.pod:862
5883 "Note that this function cannot correctly handle binary files (specifically, "
5884 "files containing C<\\0> character which is treated as end of string). For "
5885 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5886 "functions which have a more complex interface."
5890 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5891 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5892 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5893 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5894 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5895 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5896 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5897 #: ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880
5898 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037
5899 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912
5900 #: ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113
5901 #: ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789
5902 #: ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841
5903 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945
5904 #: ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010
5905 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:582
5906 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5907 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5908 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5909 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5910 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5911 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5912 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5913 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5914 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5915 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5916 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5917 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5918 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5919 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5920 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5922 "Because of the message protocol, there is a transfer limit of somewhere "
5923 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5927 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252
5928 #: ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331
5929 #: ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824
5930 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960
5931 #: ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676
5932 #: ../src/guestfs-actions.pod:6690
5933 msgid "(Added in 0.4)"
5937 #: ../src/guestfs-actions.pod:875
5938 msgid "guestfs_checksum"
5942 #: ../src/guestfs-actions.pod:877
5946 " guestfs_checksum (guestfs_h *g,\n"
5947 " const char *csumtype,\n"
5948 " const char *path);\n"
5953 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5955 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5959 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5961 "The type of checksum to compute is given by the C<csumtype> parameter which "
5962 "must have one of the following values:"
5966 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5971 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5973 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5978 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5983 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5984 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5988 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5993 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5994 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5998 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
6003 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
6004 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6008 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
6013 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
6014 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6018 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
6023 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
6024 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6028 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
6033 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
6034 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6038 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
6039 msgid "The checksum is returned as a printable string."
6043 #: ../src/guestfs-actions.pod:923
6044 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6048 #: ../src/guestfs-actions.pod:925
6049 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6053 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
6054 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026
6055 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116
6056 #: ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
6057 msgid "(Added in 1.0.2)"
6061 #: ../src/guestfs-actions.pod:932
6062 msgid "guestfs_checksum_device"
6066 #: ../src/guestfs-actions.pod:934
6070 " guestfs_checksum_device (guestfs_h *g,\n"
6071 " const char *csumtype,\n"
6072 " const char *device);\n"
6077 #: ../src/guestfs-actions.pod:939
6079 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6080 "device named C<device>. For the types of checksums supported see the "
6081 "C<guestfs_checksum> command."
6085 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491
6086 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587
6087 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781
6088 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306
6089 #: ../src/guestfs-actions.pod:6702
6090 msgid "(Added in 1.3.2)"
6094 #: ../src/guestfs-actions.pod:948
6095 msgid "guestfs_checksums_out"
6099 #: ../src/guestfs-actions.pod:950
6103 " guestfs_checksums_out (guestfs_h *g,\n"
6104 " const char *csumtype,\n"
6105 " const char *directory,\n"
6106 " const char *sumsfile);\n"
6111 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
6113 "This command computes the checksums of all regular files in C<directory> and "
6114 "then emits a list of those checksums to the local output file C<sumsfile>."
6118 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
6120 "This can be used for verifying the integrity of a virtual machine. However "
6121 "to be properly secure you should pay attention to the output of the checksum "
6122 "command (it uses the ones from GNU coreutils). In particular when the "
6123 "filename is not printable, coreutils uses a special backslash syntax. For "
6124 "more information, see the GNU coreutils info file."
6128 #: ../src/guestfs-actions.pod:970
6129 msgid "(Added in 1.3.7)"
6133 #: ../src/guestfs-actions.pod:972
6134 msgid "guestfs_chmod"
6138 #: ../src/guestfs-actions.pod:974
6142 " guestfs_chmod (guestfs_h *g,\n"
6144 " const char *path);\n"
6149 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
6151 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6156 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
6158 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6159 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6164 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075
6165 #: ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209
6166 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671
6167 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6168 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6169 msgid "The mode actually set is affected by the umask."
6173 #: ../src/guestfs-actions.pod:992
6174 msgid "guestfs_chown"
6178 #: ../src/guestfs-actions.pod:994
6182 " guestfs_chown (guestfs_h *g,\n"
6185 " const char *path);\n"
6190 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
6191 msgid "Change the file owner to C<owner> and group to C<group>."
6195 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213
6196 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6198 "Only numeric uid and gid are supported. If you want to use names, you will "
6199 "need to locate and parse the password file yourself (Augeas support makes "
6200 "this relatively easy)."
6204 #: ../src/guestfs-actions.pod:1010
6205 msgid "guestfs_command"
6209 #: ../src/guestfs-actions.pod:1012
6213 " guestfs_command (guestfs_h *g,\n"
6214 " char *const *arguments);\n"
6219 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
6221 "This call runs a command from the guest filesystem. The filesystem must be "
6222 "mounted, and must contain a compatible operating system (ie. something "
6223 "Linux, with the same or compatible processor architecture)."
6227 #: ../src/guestfs-actions.pod:1021
6229 "The single parameter is an argv-style list of arguments. The first element "
6230 "is the name of the program to run. Subsequent elements are parameters. The "
6231 "list must be non-empty (ie. must contain a program name). Note that the "
6232 "command runs directly, and is I<not> invoked via the shell (see "
6237 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
6238 msgid "The return value is anything printed to I<stdout> by the command."
6242 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
6244 "If the command returns a non-zero exit status, then this function returns an "
6245 "error message. The error message string is the content of I<stderr> from "
6250 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6252 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6253 "bin>. If you require a program from another location, you should provide "
6254 "the full path in the first parameter."
6258 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6260 "Shared libraries and data files required by the program must be available on "
6261 "filesystems which are mounted in the correct places. It is the caller's "
6262 "responsibility to ensure all filesystems that are needed are mounted at the "
6267 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6268 #: ../src/guestfs-actions.pod:1535
6269 msgid "(Added in 0.9.1)"
6273 #: ../src/guestfs-actions.pod:1054
6274 msgid "guestfs_command_lines"
6278 #: ../src/guestfs-actions.pod:1056
6282 " guestfs_command_lines (guestfs_h *g,\n"
6283 " char *const *arguments);\n"
6288 #: ../src/guestfs-actions.pod:1060
6290 "This is the same as C<guestfs_command>, but splits the result into a list of "
6295 #: ../src/guestfs-actions.pod:1063
6296 msgid "See also: C<guestfs_sh_lines>"
6300 #: ../src/guestfs-actions.pod:1074
6301 msgid "guestfs_config"
6305 #: ../src/guestfs-actions.pod:1076
6309 " guestfs_config (guestfs_h *g,\n"
6310 " const char *qemuparam,\n"
6311 " const char *qemuvalue);\n"
6316 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6318 "This can be used to add arbitrary qemu command line parameters of the form "
6319 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6320 "setting some parameters which would interfere with parameters that we use."
6324 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6325 msgid "The first character of C<param> string must be a C<-> (dash)."
6329 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6330 msgid "C<value> can be NULL."
6334 #: ../src/guestfs-actions.pod:1094
6335 msgid "guestfs_copy_size"
6339 #: ../src/guestfs-actions.pod:1096
6343 " guestfs_copy_size (guestfs_h *g,\n"
6344 " const char *src,\n"
6345 " const char *dest,\n"
6351 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6353 "This command copies exactly C<size> bytes from one source device or file "
6354 "C<src> to another destination device or file C<dest>."
6358 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6360 "Note this will fail if the source is too short or if the destination is not "
6365 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6366 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6367 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881
6368 #: ../src/guestfs-actions.pod:6900
6370 "This long-running command can generate progress notification messages so "
6371 "that the caller can display a progress bar or indicator. To receive these "
6372 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6373 "guestfs_set_progress_callback>."
6377 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851
6378 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609
6379 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6380 msgid "(Added in 1.0.87)"
6384 #: ../src/guestfs-actions.pod:1117
6389 #: ../src/guestfs-actions.pod:1119
6393 " guestfs_cp (guestfs_h *g,\n"
6394 " const char *src,\n"
6395 " const char *dest);\n"
6400 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6402 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6403 "destination filename or destination directory."
6407 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6408 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6409 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454
6410 #: ../src/guestfs-actions.pod:4831
6411 msgid "(Added in 1.0.18)"
6415 #: ../src/guestfs-actions.pod:1131
6416 msgid "guestfs_cp_a"
6420 #: ../src/guestfs-actions.pod:1133
6424 " guestfs_cp_a (guestfs_h *g,\n"
6425 " const char *src,\n"
6426 " const char *dest);\n"
6431 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6433 "This copies a file or directory from C<src> to C<dest> recursively using the "
6438 #: ../src/guestfs-actions.pod:1145
6443 #: ../src/guestfs-actions.pod:1147
6447 " guestfs_dd (guestfs_h *g,\n"
6448 " const char *src,\n"
6449 " const char *dest);\n"
6454 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6456 "This command copies from one source device or file C<src> to another "
6457 "destination device or file C<dest>. Normally you would use this to copy to "
6458 "or from a device or partition, for example to duplicate a filesystem."
6462 #: ../src/guestfs-actions.pod:1157
6464 "If the destination is a device, it must be as large or larger than the "
6465 "source file or device, otherwise the copy will fail. This command cannot do "
6466 "partial copies (see C<guestfs_copy_size>)."
6470 #: ../src/guestfs-actions.pod:1165
6475 #: ../src/guestfs-actions.pod:1167
6479 " guestfs_df (guestfs_h *g);\n"
6484 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6485 msgid "This command runs the C<df> command to report disk space used."
6489 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6490 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6492 "This command is mostly useful for interactive sessions. It is I<not> "
6493 "intended that you try to parse the output string. Use C<statvfs> from "
6498 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6499 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6500 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6501 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354
6502 #: ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140
6503 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761
6504 #: ../src/guestfs-actions.pod:6774
6505 msgid "(Added in 1.0.54)"
6509 #: ../src/guestfs-actions.pod:1181
6510 msgid "guestfs_df_h"
6514 #: ../src/guestfs-actions.pod:1183
6518 " guestfs_df_h (guestfs_h *g);\n"
6523 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6525 "This command runs the C<df -h> command to report disk space used in human-"
6530 #: ../src/guestfs-actions.pod:1198
6531 msgid "guestfs_dmesg"
6535 #: ../src/guestfs-actions.pod:1200
6539 " guestfs_dmesg (guestfs_h *g);\n"
6544 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6546 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6547 "This is sometimes useful for extended debugging of problems."
6551 #: ../src/guestfs-actions.pod:1207
6553 "Another way to get the same information is to enable verbose messages with "
6554 "C<guestfs_set_verbose> or by setting the environment variable "
6555 "C<LIBGUESTFS_DEBUG=1> before running the program."
6559 #: ../src/guestfs-actions.pod:1217
6560 msgid "guestfs_download"
6564 #: ../src/guestfs-actions.pod:1219
6568 " guestfs_download (guestfs_h *g,\n"
6569 " const char *remotefilename,\n"
6570 " const char *filename);\n"
6575 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6576 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6578 "Download file C<remotefilename> and save it as C<filename> on the local "
6583 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372
6584 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6585 msgid "C<filename> can also be a named pipe."
6589 #: ../src/guestfs-actions.pod:1229
6590 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6594 #: ../src/guestfs-actions.pod:1240
6595 msgid "guestfs_download_offset"
6599 #: ../src/guestfs-actions.pod:1242
6603 " guestfs_download_offset (guestfs_h *g,\n"
6604 " const char *remotefilename,\n"
6605 " const char *filename,\n"
6606 " int64_t offset,\n"
6612 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6614 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6615 "region must be within the file or device)."
6619 #: ../src/guestfs-actions.pod:1255
6621 "Note that there is no limit on the amount of data that can be downloaded "
6622 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6623 "full amount unless an error occurs."
6627 #: ../src/guestfs-actions.pod:1260
6628 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6632 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6633 msgid "(Added in 1.5.17)"
6637 #: ../src/guestfs-actions.pod:1271
6638 msgid "guestfs_drop_caches"
6642 #: ../src/guestfs-actions.pod:1273
6646 " guestfs_drop_caches (guestfs_h *g,\n"
6647 " int whattodrop);\n"
6652 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6654 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6655 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6656 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6660 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6661 msgid "Setting C<whattodrop> to 3 should drop everything."
6665 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6667 "This automatically calls L<sync(2)> before the operation, so that the "
6668 "maximum guest memory is freed."
6672 #: ../src/guestfs-actions.pod:1291
6677 #: ../src/guestfs-actions.pod:1293
6681 " guestfs_du (guestfs_h *g,\n"
6682 " const char *path);\n"
6687 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6689 "This command runs the C<du -s> command to estimate file space usage for "
6694 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6696 "C<path> can be a file or a directory. If C<path> is a directory then the "
6697 "estimate includes the contents of the directory and all subdirectories "
6702 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6704 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6708 #: ../src/guestfs-actions.pod:1311
6709 msgid "guestfs_e2fsck_f"
6713 #: ../src/guestfs-actions.pod:1313
6717 " guestfs_e2fsck_f (guestfs_h *g,\n"
6718 " const char *device);\n"
6723 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6725 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6726 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6731 #: ../src/guestfs-actions.pod:1321
6733 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6734 "Normally you should use C<guestfs_fsck>."
6738 #: ../src/guestfs-actions.pod:1326
6739 msgid "(Added in 1.0.29)"
6743 #: ../src/guestfs-actions.pod:1328
6744 msgid "guestfs_echo_daemon"
6748 #: ../src/guestfs-actions.pod:1330
6752 " guestfs_echo_daemon (guestfs_h *g,\n"
6753 " char *const *words);\n"
6758 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6760 "This command concatenates the list of C<words> passed with single spaces "
6761 "between them and returns the resulting string."
6765 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6766 msgid "You can use this command to test the connection through to the daemon."
6770 #: ../src/guestfs-actions.pod:1339
6771 msgid "See also C<guestfs_ping_daemon>."
6775 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6776 #: ../src/guestfs-actions.pod:5620
6777 msgid "(Added in 1.0.69)"
6781 #: ../src/guestfs-actions.pod:1346
6782 msgid "guestfs_egrep"
6786 #: ../src/guestfs-actions.pod:1348
6790 " guestfs_egrep (guestfs_h *g,\n"
6791 " const char *regex,\n"
6792 " const char *path);\n"
6797 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6799 "This calls the external C<egrep> program and returns the matching lines."
6803 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6804 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6805 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6806 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6807 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6808 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6809 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344
6810 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371
6811 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289
6812 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214
6813 #: ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996
6814 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022
6815 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057
6816 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083
6817 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863
6818 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967
6819 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6820 msgid "(Added in 1.0.66)"
6824 #: ../src/guestfs-actions.pod:1365
6825 msgid "guestfs_egrepi"
6829 #: ../src/guestfs-actions.pod:1367
6833 " guestfs_egrepi (guestfs_h *g,\n"
6834 " const char *regex,\n"
6835 " const char *path);\n"
6840 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6842 "This calls the external C<egrep -i> program and returns the matching lines."
6846 #: ../src/guestfs-actions.pod:1384
6847 msgid "guestfs_equal"
6851 #: ../src/guestfs-actions.pod:1386
6855 " guestfs_equal (guestfs_h *g,\n"
6856 " const char *file1,\n"
6857 " const char *file2);\n"
6862 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6864 "This compares the two files C<file1> and C<file2> and returns true if their "
6865 "content is exactly equal, or false otherwise."
6869 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6870 msgid "The external L<cmp(1)> program is used for the comparison."
6874 #: ../src/guestfs-actions.pod:1400
6875 msgid "guestfs_exists"
6879 #: ../src/guestfs-actions.pod:1402
6883 " guestfs_exists (guestfs_h *g,\n"
6884 " const char *path);\n"
6889 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6891 "This returns C<true> if and only if there is a file, directory (or anything) "
6892 "with the given C<path> name."
6896 #: ../src/guestfs-actions.pod:1409
6897 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6901 #: ../src/guestfs-actions.pod:1415
6902 msgid "guestfs_fallocate"
6906 #: ../src/guestfs-actions.pod:1417
6910 " guestfs_fallocate (guestfs_h *g,\n"
6911 " const char *path,\n"
6917 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6918 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6920 "This command preallocates a file (containing zero bytes) named C<path> of "
6921 "size C<len> bytes. If the file exists already, it is overwritten."
6925 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6927 "Do not confuse this with the guestfish-specific C<alloc> command which "
6928 "allocates a file in the host and attaches it as a device."
6932 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6934 "This function is deprecated. In new code, use the C<fallocate64> call "
6939 #: ../src/guestfs-actions.pod:1441
6940 msgid "guestfs_fallocate64"
6944 #: ../src/guestfs-actions.pod:1443
6948 " guestfs_fallocate64 (guestfs_h *g,\n"
6949 " const char *path,\n"
6955 #: ../src/guestfs-actions.pod:1452
6957 "Note that this call allocates disk blocks for the file. To create a sparse "
6958 "file use C<guestfs_truncate_size> instead."
6962 #: ../src/guestfs-actions.pod:1455
6964 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6965 "oversight it only allowed 30 bit lengths to be specified, effectively "
6966 "limiting the maximum size of files created through that call to 1GB."
6970 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6972 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6973 "commands which create a file in the host and attach it as a device."
6977 #: ../src/guestfs-actions.pod:1466
6978 msgid "(Added in 1.3.17)"
6982 #: ../src/guestfs-actions.pod:1468
6983 msgid "guestfs_fgrep"
6987 #: ../src/guestfs-actions.pod:1470
6991 " guestfs_fgrep (guestfs_h *g,\n"
6992 " const char *pattern,\n"
6993 " const char *path);\n"
6998 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
7000 "This calls the external C<fgrep> program and returns the matching lines."
7004 #: ../src/guestfs-actions.pod:1487
7005 msgid "guestfs_fgrepi"
7009 #: ../src/guestfs-actions.pod:1489
7013 " guestfs_fgrepi (guestfs_h *g,\n"
7014 " const char *pattern,\n"
7015 " const char *path);\n"
7020 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
7022 "This calls the external C<fgrep -i> program and returns the matching lines."
7026 #: ../src/guestfs-actions.pod:1506
7027 msgid "guestfs_file"
7031 #: ../src/guestfs-actions.pod:1508
7035 " guestfs_file (guestfs_h *g,\n"
7036 " const char *path);\n"
7041 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
7043 "This call uses the standard L<file(1)> command to determine the type or "
7044 "contents of the file."
7048 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
7050 "This call will also transparently look inside various types of compressed "
7055 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
7057 "The exact command which runs is C<file -zb path>. Note in particular that "
7058 "the filename is not prepended to the output (the C<-b> option)."
7062 #: ../src/guestfs-actions.pod:1522
7064 "This command can also be used on C</dev/> devices (and partitions, LV "
7065 "names). You can for example use this to determine if a device contains a "
7066 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7070 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
7072 "If the C<path> does not begin with C</dev/> then this command only works for "
7073 "the content of regular files. For other file types (directory, symbolic "
7074 "link etc) it will just return the string C<directory> etc."
7078 #: ../src/guestfs-actions.pod:1537
7079 msgid "guestfs_file_architecture"
7083 #: ../src/guestfs-actions.pod:1539
7087 " guestfs_file_architecture (guestfs_h *g,\n"
7088 " const char *filename);\n"
7093 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
7095 "This detects the architecture of the binary C<filename>, and returns it if "
7100 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
7101 msgid "Currently defined architectures are:"
7105 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
7110 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
7112 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7113 "irrespective of the precise processor requirements of the binary."
7117 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
7122 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
7123 msgid "64 bit x86-64."
7127 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
7132 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
7133 msgid "32 bit SPARC."
7137 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
7142 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
7143 msgid "64 bit SPARC V9 and above."
7147 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
7152 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
7153 msgid "Intel Itanium."
7157 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
7162 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
7163 msgid "32 bit Power PC."
7167 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
7172 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
7173 msgid "64 bit Power PC."
7177 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
7178 msgid "Libguestfs may return other architecture strings in future."
7182 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
7183 msgid "The function works on at least the following types of files:"
7187 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
7188 msgid "many types of Un*x and Linux binary"
7192 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
7193 msgid "many types of Un*x and Linux shared library"
7197 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
7198 msgid "Windows Win32 and Win64 binaries"
7202 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
7203 msgid "Windows Win32 and Win64 DLLs"
7207 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
7208 msgid "Win32 binaries and DLLs return C<i386>."
7212 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
7213 msgid "Win64 binaries and DLLs return C<x86_64>."
7217 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
7218 msgid "Linux kernel modules"
7222 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
7223 msgid "Linux new-style initrd images"
7227 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
7228 msgid "some non-x86 Linux vmlinuz kernels"
7232 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
7233 msgid "What it can't do currently:"
7237 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
7238 msgid "static libraries (libfoo.a)"
7242 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
7243 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7247 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7248 msgid "x86 Linux vmlinuz kernels"
7252 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7254 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7255 "compressed code, and are horribly hard to unpack. If you want to find the "
7256 "architecture of a kernel, use the architecture of the associated initrd or "
7257 "kernel module(s) instead."
7261 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7262 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7263 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
7264 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653
7265 #: ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766
7266 #: ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997
7267 #: ../src/guestfs-actions.pod:3129
7268 msgid "(Added in 1.5.3)"
7272 #: ../src/guestfs-actions.pod:1649
7273 msgid "guestfs_filesize"
7277 #: ../src/guestfs-actions.pod:1651
7281 " guestfs_filesize (guestfs_h *g,\n"
7282 " const char *file);\n"
7287 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7288 msgid "This command returns the size of C<file> in bytes."
7292 #: ../src/guestfs-actions.pod:1657
7294 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7295 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7296 "devices, use C<guestfs_blockdev_getsize64>."
7300 #: ../src/guestfs-actions.pod:1663
7301 msgid "(Added in 1.0.82)"
7305 #: ../src/guestfs-actions.pod:1665
7306 msgid "guestfs_fill"
7310 #: ../src/guestfs-actions.pod:1667
7314 " guestfs_fill (guestfs_h *g,\n"
7317 " const char *path);\n"
7322 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7324 "This command creates a new file called C<path>. The initial content of the "
7325 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7330 #: ../src/guestfs-actions.pod:1677
7332 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7333 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7334 "bytes use C<guestfs_fill_pattern>."
7338 #: ../src/guestfs-actions.pod:1689
7339 msgid "(Added in 1.0.79)"
7343 #: ../src/guestfs-actions.pod:1691
7344 msgid "guestfs_fill_pattern"
7348 #: ../src/guestfs-actions.pod:1693
7352 " guestfs_fill_pattern (guestfs_h *g,\n"
7353 " const char *pattern,\n"
7355 " const char *path);\n"
7360 #: ../src/guestfs-actions.pod:1699
7362 "This function is like C<guestfs_fill> except that it creates a new file of "
7363 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7364 "pattern is truncated if necessary to ensure the length of the file is "
7365 "exactly C<len> bytes."
7369 #: ../src/guestfs-actions.pod:1711
7370 msgid "(Added in 1.3.12)"
7374 #: ../src/guestfs-actions.pod:1713
7375 msgid "guestfs_find"
7379 #: ../src/guestfs-actions.pod:1715
7383 " guestfs_find (guestfs_h *g,\n"
7384 " const char *directory);\n"
7389 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7391 "This command lists out all files and directories, recursively, starting at "
7392 "C<directory>. It is essentially equivalent to running the shell command "
7393 "C<find directory -print> but some post-processing happens on the output, "
7398 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7400 "This returns a list of strings I<without any prefix>. Thus if the directory "
7405 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7415 #: ../src/guestfs-actions.pod:1731
7417 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7421 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7432 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7433 msgid "If C<directory> is not a directory, then this command returns an error."
7437 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7438 msgid "The returned list is sorted."
7442 #: ../src/guestfs-actions.pod:1744
7443 msgid "See also C<guestfs_find0>."
7447 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788
7448 #: ../src/guestfs-actions.pod:5249
7449 msgid "(Added in 1.0.27)"
7453 #: ../src/guestfs-actions.pod:1755
7454 msgid "guestfs_find0"
7458 #: ../src/guestfs-actions.pod:1757
7462 " guestfs_find0 (guestfs_h *g,\n"
7463 " const char *directory,\n"
7464 " const char *files);\n"
7469 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7471 "This command lists out all files and directories, recursively, starting at "
7472 "C<directory>, placing the resulting list in the external file called "
7477 #: ../src/guestfs-actions.pod:1766
7479 "This command works the same way as C<guestfs_find> with the following "
7484 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7485 msgid "The resulting list is written to an external file."
7489 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7491 "Items (filenames) in the result are separated by C<\\0> characters. See "
7492 "L<find(1)> option I<-print0>."
7496 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7497 msgid "This command is not limited in the number of names that it can return."
7501 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7502 msgid "The result list is not sorted."
7506 #: ../src/guestfs-actions.pod:1793
7507 msgid "(Added in 1.0.74)"
7511 #: ../src/guestfs-actions.pod:1795
7512 msgid "guestfs_findfs_label"
7516 #: ../src/guestfs-actions.pod:1797
7520 " guestfs_findfs_label (guestfs_h *g,\n"
7521 " const char *label);\n"
7526 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7528 "This command searches the filesystems and returns the one which has the "
7529 "given label. An error is returned if no such filesystem can be found."
7533 #: ../src/guestfs-actions.pod:1805
7534 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7538 #: ../src/guestfs-actions.pod:1812
7539 msgid "guestfs_findfs_uuid"
7543 #: ../src/guestfs-actions.pod:1814
7547 " guestfs_findfs_uuid (guestfs_h *g,\n"
7548 " const char *uuid);\n"
7553 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7555 "This command searches the filesystems and returns the one which has the "
7556 "given UUID. An error is returned if no such filesystem can be found."
7560 #: ../src/guestfs-actions.pod:1822
7561 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7565 #: ../src/guestfs-actions.pod:1829
7566 msgid "guestfs_fsck"
7570 #: ../src/guestfs-actions.pod:1831
7574 " guestfs_fsck (guestfs_h *g,\n"
7575 " const char *fstype,\n"
7576 " const char *device);\n"
7581 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7583 "This runs the filesystem checker (fsck) on C<device> which should have "
7584 "filesystem type C<fstype>."
7588 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7590 "The returned integer is the status. See L<fsck(8)> for the list of status "
7591 "codes from C<fsck>."
7595 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7596 msgid "Multiple status codes can be summed together."
7600 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7602 "A non-zero return code can mean \"success\", for example if errors have been "
7603 "corrected on the filesystem."
7607 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7608 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7612 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7614 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7618 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7619 msgid "(Added in 1.0.16)"
7623 #: ../src/guestfs-actions.pod:1868
7624 msgid "guestfs_get_append"
7628 #: ../src/guestfs-actions.pod:1870
7632 " guestfs_get_append (guestfs_h *g);\n"
7637 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7639 "Return the additional kernel options which are added to the guest kernel "
7644 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7645 msgid "If C<NULL> then no options are added."
7649 #: ../src/guestfs-actions.pod:1878
7651 "This function returns a string which may be NULL. There is no way to return "
7652 "an error from this function. The string is owned by the guest handle and "
7653 "must I<not> be freed."
7657 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927
7658 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758
7659 #: ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793
7660 #: ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557
7661 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7662 msgid "(Added in 1.0.26)"
7666 #: ../src/guestfs-actions.pod:1884
7667 msgid "guestfs_get_autosync"
7671 #: ../src/guestfs-actions.pod:1886
7675 " guestfs_get_autosync (guestfs_h *g);\n"
7680 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7681 msgid "Get the autosync flag."
7685 #: ../src/guestfs-actions.pod:1895
7686 msgid "guestfs_get_direct"
7690 #: ../src/guestfs-actions.pod:1897
7694 " guestfs_get_direct (guestfs_h *g);\n"
7699 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7700 msgid "Return the direct appliance mode flag."
7704 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7705 msgid "(Added in 1.0.72)"
7709 #: ../src/guestfs-actions.pod:1906
7710 msgid "guestfs_get_e2label"
7714 #: ../src/guestfs-actions.pod:1908
7718 " guestfs_get_e2label (guestfs_h *g,\n"
7719 " const char *device);\n"
7724 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7726 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7730 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7732 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7736 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7737 #: ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7738 msgid "(Added in 1.0.15)"
7742 #: ../src/guestfs-actions.pod:1927
7743 msgid "guestfs_get_e2uuid"
7747 #: ../src/guestfs-actions.pod:1929
7751 " guestfs_get_e2uuid (guestfs_h *g,\n"
7752 " const char *device);\n"
7757 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7759 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7763 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7765 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7769 #: ../src/guestfs-actions.pod:1948
7770 msgid "guestfs_get_memsize"
7774 #: ../src/guestfs-actions.pod:1950
7778 " guestfs_get_memsize (guestfs_h *g);\n"
7783 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7785 "This gets the memory size in megabytes allocated to the qemu subprocess."
7789 #: ../src/guestfs-actions.pod:1956
7791 "If C<guestfs_set_memsize> was not called on this handle, and if "
7792 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7793 "value for memsize."
7797 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7798 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591
7799 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7800 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7802 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7806 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079
7807 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213
7808 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244
7809 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274
7810 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489
7811 #: ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7812 msgid "(Added in 1.0.55)"
7816 #: ../src/guestfs-actions.pod:1967
7817 msgid "guestfs_get_network"
7821 #: ../src/guestfs-actions.pod:1969
7825 " guestfs_get_network (guestfs_h *g);\n"
7830 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7831 msgid "This returns the enable network flag."
7835 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7836 msgid "(Added in 1.5.4)"
7840 #: ../src/guestfs-actions.pod:1978
7841 msgid "guestfs_get_path"
7845 #: ../src/guestfs-actions.pod:1980
7849 " guestfs_get_path (guestfs_h *g);\n"
7854 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7855 msgid "Return the current search path."
7859 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7861 "This is always non-NULL. If it wasn't set already, then this will return "
7866 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7868 "This function returns a string, or NULL on error. The string is owned by "
7869 "the guest handle and must I<not> be freed."
7873 #: ../src/guestfs-actions.pod:1993
7874 msgid "guestfs_get_pid"
7878 #: ../src/guestfs-actions.pod:1995
7882 " guestfs_get_pid (guestfs_h *g);\n"
7887 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7889 "Return the process ID of the qemu subprocess. If there is no qemu "
7890 "subprocess, then this will return an error."
7894 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7895 msgid "This is an internal call used for debugging and testing."
7899 #: ../src/guestfs-actions.pod:2005
7900 msgid "(Added in 1.0.56)"
7904 #: ../src/guestfs-actions.pod:2007
7905 msgid "guestfs_get_qemu"
7909 #: ../src/guestfs-actions.pod:2009
7913 " guestfs_get_qemu (guestfs_h *g);\n"
7918 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7919 msgid "Return the current qemu binary."
7923 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7925 "This is always non-NULL. If it wasn't set already, then this will return "
7926 "the default qemu binary name."
7930 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7931 msgid "(Added in 1.0.6)"
7935 #: ../src/guestfs-actions.pod:2022
7936 msgid "guestfs_get_recovery_proc"
7940 #: ../src/guestfs-actions.pod:2024
7944 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7949 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7950 msgid "Return the recovery process enabled flag."
7954 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219
7955 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886
7956 #: ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857
7957 #: ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577
7958 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256
7959 #: ../src/guestfs-actions.pod:6438
7960 msgid "(Added in 1.0.77)"
7964 #: ../src/guestfs-actions.pod:2033
7965 msgid "guestfs_get_selinux"
7969 #: ../src/guestfs-actions.pod:2035
7973 " guestfs_get_selinux (guestfs_h *g);\n"
7978 #: ../src/guestfs-actions.pod:2038
7980 "This returns the current setting of the selinux flag which is passed to the "
7981 "appliance at boot time. See C<guestfs_set_selinux>."
7985 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7986 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7987 msgid "(Added in 1.0.67)"
7991 #: ../src/guestfs-actions.pod:2048
7992 msgid "guestfs_get_state"
7996 #: ../src/guestfs-actions.pod:2050
8000 " guestfs_get_state (guestfs_h *g);\n"
8005 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
8007 "This returns the current state as an opaque integer. This is only useful "
8008 "for printing debug and internal error messages."
8012 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022
8013 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112
8014 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:1398
8015 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8016 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8017 msgid "For more information on states, see L<guestfs(3)>."
8021 #: ../src/guestfs-actions.pod:2062
8022 msgid "guestfs_get_trace"
8026 #: ../src/guestfs-actions.pod:2064
8030 " guestfs_get_trace (guestfs_h *g);\n"
8035 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
8036 msgid "Return the command trace flag."
8040 #: ../src/guestfs-actions.pod:2073
8041 msgid "guestfs_get_umask"
8045 #: ../src/guestfs-actions.pod:2075
8049 " guestfs_get_umask (guestfs_h *g);\n"
8054 #: ../src/guestfs-actions.pod:2078
8056 "Return the current umask. By default the umask is C<022> unless it has been "
8057 "set by calling C<guestfs_umask>."
8061 #: ../src/guestfs-actions.pod:2085
8062 msgid "guestfs_get_verbose"
8066 #: ../src/guestfs-actions.pod:2087
8070 " guestfs_get_verbose (guestfs_h *g);\n"
8075 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
8076 msgid "This returns the verbose messages flag."
8080 #: ../src/guestfs-actions.pod:2096
8081 msgid "guestfs_getcon"
8085 #: ../src/guestfs-actions.pod:2098
8089 " guestfs_getcon (guestfs_h *g);\n"
8094 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
8095 msgid "This gets the SELinux security context of the daemon."
8099 #: ../src/guestfs-actions.pod:2103
8101 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8105 #: ../src/guestfs-actions.pod:2111
8106 msgid "guestfs_getxattrs"
8110 #: ../src/guestfs-actions.pod:2113
8113 " struct guestfs_xattr_list *\n"
8114 " guestfs_getxattrs (guestfs_h *g,\n"
8115 " const char *path);\n"
8120 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
8122 "This call lists the extended attributes of the file or directory C<path>."
8126 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
8128 "At the system call level, this is a combination of the L<listxattr(2)> and "
8129 "L<getxattr(2)> calls."
8133 #: ../src/guestfs-actions.pod:2123
8134 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8138 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231
8139 #: ../src/guestfs-actions.pod:3882
8141 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8142 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8146 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235
8147 #: ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436
8148 #: ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669
8149 #: ../src/guestfs-actions.pod:6994
8150 msgid "(Added in 1.0.59)"
8154 #: ../src/guestfs-actions.pod:2131
8155 msgid "guestfs_glob_expand"
8159 #: ../src/guestfs-actions.pod:2133
8163 " guestfs_glob_expand (guestfs_h *g,\n"
8164 " const char *pattern);\n"
8169 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
8171 "This command searches for all the pathnames matching C<pattern> according to "
8172 "the wildcard expansion rules used by the shell."
8176 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
8178 "If no paths match, then this returns an empty list (note: not an error)."
8182 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
8184 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8185 "GLOB_BRACE>. See that manual page for more details."
8189 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834
8190 #: ../src/guestfs-actions.pod:5851
8191 msgid "(Added in 1.0.50)"
8195 #: ../src/guestfs-actions.pod:2154
8196 msgid "guestfs_grep"
8200 #: ../src/guestfs-actions.pod:2156
8204 " guestfs_grep (guestfs_h *g,\n"
8205 " const char *regex,\n"
8206 " const char *path);\n"
8211 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
8212 msgid "This calls the external C<grep> program and returns the matching lines."
8216 #: ../src/guestfs-actions.pod:2173
8217 msgid "guestfs_grepi"
8221 #: ../src/guestfs-actions.pod:2175
8225 " guestfs_grepi (guestfs_h *g,\n"
8226 " const char *regex,\n"
8227 " const char *path);\n"
8232 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
8234 "This calls the external C<grep -i> program and returns the matching lines."
8238 #: ../src/guestfs-actions.pod:2192
8239 msgid "guestfs_grub_install"
8243 #: ../src/guestfs-actions.pod:2194
8247 " guestfs_grub_install (guestfs_h *g,\n"
8248 " const char *root,\n"
8249 " const char *device);\n"
8254 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8256 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8257 "the root directory being C<root>."
8261 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8263 "Note: If grub-install reports the error \"No suitable drive was found in the "
8264 "generated device map.\" it may be that you need to create a C</boot/grub/"
8265 "device.map> file first that contains the mapping between grub device names "
8266 "and Linux device names. It is usually sufficient to create a file "
8271 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8279 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8280 msgid "replacing C</dev/vda> with the name of the installation device."
8284 #: ../src/guestfs-actions.pod:2215
8285 msgid "(Added in 1.0.17)"
8289 #: ../src/guestfs-actions.pod:2217
8290 msgid "guestfs_head"
8294 #: ../src/guestfs-actions.pod:2219
8298 " guestfs_head (guestfs_h *g,\n"
8299 " const char *path);\n"
8304 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8306 "This command returns up to the first 10 lines of a file as a list of strings."
8310 #: ../src/guestfs-actions.pod:2235
8311 msgid "guestfs_head_n"
8315 #: ../src/guestfs-actions.pod:2237
8319 " guestfs_head_n (guestfs_h *g,\n"
8321 " const char *path);\n"
8326 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8328 "If the parameter C<nrlines> is a positive number, this returns the first "
8329 "C<nrlines> lines of the file C<path>."
8333 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8335 "If the parameter C<nrlines> is a negative number, this returns lines from "
8336 "the file C<path>, excluding the last C<nrlines> lines."
8340 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131
8341 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8342 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8346 #: ../src/guestfs-actions.pod:2259
8347 msgid "guestfs_hexdump"
8351 #: ../src/guestfs-actions.pod:2261
8355 " guestfs_hexdump (guestfs_h *g,\n"
8356 " const char *path);\n"
8361 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8363 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8364 "readable, canonical hex dump of the file."
8368 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915
8369 #: ../src/guestfs-actions.pod:5970
8370 msgid "(Added in 1.0.22)"
8374 #: ../src/guestfs-actions.pod:2276
8375 msgid "guestfs_initrd_cat"
8379 #: ../src/guestfs-actions.pod:2278
8383 " guestfs_initrd_cat (guestfs_h *g,\n"
8384 " const char *initrdpath,\n"
8385 " const char *filename,\n"
8386 " size_t *size_r);\n"
8391 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8393 "This command unpacks the file C<filename> from the initrd file called "
8394 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8399 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8401 "For example, in guestfish you could use the following command to examine the "
8402 "boot script (usually called C</init>) contained in a Linux initrd or "
8407 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8410 " initrd-cat /boot/initrd-<version>.img init\n"
8415 #: ../src/guestfs-actions.pod:2294
8416 msgid "See also C<guestfs_initrd_list>."
8420 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850
8421 #: ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8423 "This function returns a buffer, or NULL on error. The size of the returned "
8424 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8429 #: ../src/guestfs-actions.pod:2305
8430 msgid "guestfs_initrd_list"
8434 #: ../src/guestfs-actions.pod:2307
8438 " guestfs_initrd_list (guestfs_h *g,\n"
8439 " const char *path);\n"
8444 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8445 msgid "This command lists out files contained in an initrd."
8449 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8451 "The files are listed without any initial C</> character. The files are "
8452 "listed in the order they appear (not necessarily alphabetical). Directory "
8453 "names are listed as separate items."
8457 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8459 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8460 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8465 #: ../src/guestfs-actions.pod:2327
8466 msgid "guestfs_inotify_add_watch"
8470 #: ../src/guestfs-actions.pod:2329
8474 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8475 " const char *path,\n"
8481 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8482 msgid "Watch C<path> for the events listed in C<mask>."
8486 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8488 "Note that if C<path> is a directory then events within that directory are "
8489 "watched, but this does I<not> happen recursively (in subdirectories)."
8493 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8495 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8496 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8500 #: ../src/guestfs-actions.pod:2348
8501 msgid "guestfs_inotify_close"
8505 #: ../src/guestfs-actions.pod:2350
8509 " guestfs_inotify_close (guestfs_h *g);\n"
8514 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8516 "This closes the inotify handle which was previously opened by inotify_init. "
8517 "It removes all watches, throws away any pending events, and deallocates all "
8522 #: ../src/guestfs-actions.pod:2361
8523 msgid "guestfs_inotify_files"
8527 #: ../src/guestfs-actions.pod:2363
8531 " guestfs_inotify_files (guestfs_h *g);\n"
8536 #: ../src/guestfs-actions.pod:2366
8538 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8539 "returns a list of pathnames of objects that were touched. The returned "
8540 "pathnames are sorted and deduplicated."
8544 #: ../src/guestfs-actions.pod:2376
8545 msgid "guestfs_inotify_init"
8549 #: ../src/guestfs-actions.pod:2378
8553 " guestfs_inotify_init (guestfs_h *g,\n"
8554 " int maxevents);\n"
8559 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8561 "This command creates a new inotify handle. The inotify subsystem can be "
8562 "used to notify events which happen to objects in the guest filesystem."
8566 #: ../src/guestfs-actions.pod:2386
8568 "C<maxevents> is the maximum number of events which will be queued up between "
8569 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8570 "passed as C<0>, then the kernel (or previously set) default is used. For "
8571 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8572 "throws away events, but records the fact that it threw them away by setting "
8573 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8574 "C<guestfs_inotify_read>)."
8578 #: ../src/guestfs-actions.pod:2396
8580 "Before any events are generated, you have to add some watches to the "
8581 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8582 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8586 #: ../src/guestfs-actions.pod:2402
8588 "Queued up events should be read periodically by calling "
8589 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8590 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8591 "often enough then you risk the internal queue overflowing."
8595 #: ../src/guestfs-actions.pod:2409
8597 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8598 "This also removes any watches automatically."
8602 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8604 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8605 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8606 "that there is one global inotify handle per libguestfs instance."
8610 #: ../src/guestfs-actions.pod:2422
8611 msgid "guestfs_inotify_read"
8615 #: ../src/guestfs-actions.pod:2424
8618 " struct guestfs_inotify_event_list *\n"
8619 " guestfs_inotify_read (guestfs_h *g);\n"
8624 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8626 "Return the complete queue of events that have happened since the previous "
8631 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8632 msgid "If no events have happened, this returns an empty list."
8636 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8638 "I<Note>: In order to make sure that all events have been read, you must call "
8639 "this function repeatedly until it returns an empty list. The reason is that "
8640 "the call will read events up to the maximum appliance-to-host message size "
8641 "and leave remaining events in the queue."
8645 #: ../src/guestfs-actions.pod:2438
8647 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8648 "there was an error. I<The caller must call "
8649 "C<guestfs_free_inotify_event_list> after use>."
8653 #: ../src/guestfs-actions.pod:2444
8654 msgid "guestfs_inotify_rm_watch"
8658 #: ../src/guestfs-actions.pod:2446
8662 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8668 #: ../src/guestfs-actions.pod:2450
8670 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8674 #: ../src/guestfs-actions.pod:2457
8675 msgid "guestfs_inspect_get_arch"
8679 #: ../src/guestfs-actions.pod:2459
8683 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8684 " const char *root);\n"
8689 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8690 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593
8691 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640
8692 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694
8693 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750
8694 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834
8695 #: ../src/guestfs-actions.pod:2857
8697 "This function should only be called with a root device string as returned by "
8698 "C<guestfs_inspect_os>."
8702 #: ../src/guestfs-actions.pod:2466
8704 "This returns the architecture of the inspected operating system. The "
8705 "possible return values are listed under C<guestfs_file_architecture>."
8709 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8711 "If the architecture could not be determined, then the string C<unknown> is "
8716 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554
8717 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628
8718 #: ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739
8719 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780
8720 #: ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844
8721 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989
8722 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8723 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8724 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8725 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8726 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8727 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8728 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8732 #: ../src/guestfs-actions.pod:2480
8733 msgid "guestfs_inspect_get_distro"
8737 #: ../src/guestfs-actions.pod:2482
8741 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8742 " const char *root);\n"
8747 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8749 "This returns the distro (distribution) of the inspected operating system."
8753 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8754 msgid "Currently defined distros are:"
8758 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8759 msgid "\"archlinux\""
8763 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8768 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8773 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8778 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8783 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8788 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8793 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8798 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8799 msgid "\"linuxmint\""
8803 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8808 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8809 msgid "\"mandriva\""
8813 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8818 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8823 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8828 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8833 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8838 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8839 msgid "\"redhat-based\""
8843 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8844 msgid "Some Red Hat-derived distro."
8848 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8853 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8854 msgid "Red Hat Enterprise Linux and some derivatives."
8858 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8863 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8868 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812
8869 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8874 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8875 msgid "The distro could not be determined."
8879 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804
8880 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8885 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8887 "Windows does not have distributions. This string is returned if the OS type "
8892 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818
8893 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8895 "Future versions of libguestfs may return other strings here. The caller "
8896 "should be prepared to handle any string."
8900 #: ../src/guestfs-actions.pod:2561
8901 msgid "guestfs_inspect_get_filesystems"
8905 #: ../src/guestfs-actions.pod:2563
8909 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8910 " const char *root);\n"
8915 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8917 "This returns a list of all the filesystems that we think are associated with "
8918 "this operating system. This includes the root filesystem, other ordinary "
8919 "filesystems, and non-mounted devices like swap partitions."
8923 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8925 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8926 "to be shared between operating systems."
8930 #: ../src/guestfs-actions.pod:2578
8932 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8933 "C<guestfs_inspect_get_mountpoints>."
8937 #: ../src/guestfs-actions.pod:2587
8938 msgid "guestfs_inspect_get_hostname"
8942 #: ../src/guestfs-actions.pod:2589
8946 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8947 " const char *root);\n"
8952 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8954 "This function returns the hostname of the operating system as found by "
8955 "inspection of the guest's configuration files."
8959 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8961 "If the hostname could not be determined, then the string C<unknown> is "
8966 #: ../src/guestfs-actions.pod:2607
8967 msgid "guestfs_inspect_get_major_version"
8971 #: ../src/guestfs-actions.pod:2609
8975 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8976 " const char *root);\n"
8981 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8983 "This returns the major version number of the inspected operating system."
8987 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
8989 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8990 "popular public names used by the operating system. Notably the operating "
8991 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8992 "1). You can find out the real versions corresponding to releases of Windows "
8993 "by consulting Wikipedia or MSDN."
8997 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646
8998 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8999 msgid "If the version could not be determined, then C<0> is returned."
9003 #: ../src/guestfs-actions.pod:2634
9004 msgid "guestfs_inspect_get_minor_version"
9008 #: ../src/guestfs-actions.pod:2636
9012 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9013 " const char *root);\n"
9018 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
9020 "This returns the minor version number of the inspected operating system."
9024 #: ../src/guestfs-actions.pod:2648
9026 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9027 "C<guestfs_inspect_get_major_version>."
9031 #: ../src/guestfs-actions.pod:2655
9032 msgid "guestfs_inspect_get_mountpoints"
9036 #: ../src/guestfs-actions.pod:2657
9040 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9041 " const char *root);\n"
9046 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
9048 "This returns a hash of where we think the filesystems associated with this "
9049 "operating system should be mounted. Callers should note that this is at "
9050 "best an educated guess made by reading configuration files such as C</etc/"
9055 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
9057 "Each element in the returned hashtable has a key which is the path of the "
9058 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9059 "mounted there (eg. C</dev/sda1>)."
9063 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
9065 "Non-mounted devices such as swap devices are I<not> returned in this list."
9069 #: ../src/guestfs-actions.pod:2677
9071 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9072 "C<guestfs_inspect_get_filesystems>."
9076 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288
9077 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
9079 "This function returns a NULL-terminated array of strings, or NULL if there "
9080 "was an error. The array of strings will always have length C<2n+1>, where "
9081 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9082 "caller must free the strings and the array after use>."
9086 #: ../src/guestfs-actions.pod:2688
9087 msgid "guestfs_inspect_get_package_format"
9091 #: ../src/guestfs-actions.pod:2690
9095 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9096 " const char *root);\n"
9101 #: ../src/guestfs-actions.pod:2697
9103 "This function and C<guestfs_inspect_get_package_management> return the "
9104 "package format and package management tool used by the inspected operating "
9105 "system. For example for Fedora these functions would return C<rpm> (package "
9106 "format) and C<yum> (package management)."
9110 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
9112 "This returns the string C<unknown> if we could not determine the package "
9113 "format I<or> if the operating system does not have a real packaging system "
9118 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
9120 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9121 "Future versions of libguestfs may return other strings."
9125 #: ../src/guestfs-actions.pod:2715
9126 msgid "guestfs_inspect_get_package_management"
9130 #: ../src/guestfs-actions.pod:2717
9134 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9135 " const char *root);\n"
9140 #: ../src/guestfs-actions.pod:2724
9142 "C<guestfs_inspect_get_package_format> and this function return the package "
9143 "format and package management tool used by the inspected operating system. "
9144 "For example for Fedora these functions would return C<rpm> (package format) "
9145 "and C<yum> (package management)."
9149 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
9151 "This returns the string C<unknown> if we could not determine the package "
9152 "management tool I<or> if the operating system does not have a real packaging "
9153 "system (eg. Windows)."
9157 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
9159 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9160 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9161 "libguestfs may return other strings."
9165 #: ../src/guestfs-actions.pod:2744
9166 msgid "guestfs_inspect_get_product_name"
9170 #: ../src/guestfs-actions.pod:2746
9174 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9175 " const char *root);\n"
9180 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
9182 "This returns the product name of the inspected operating system. The "
9183 "product name is generally some freeform string which can be displayed to the "
9184 "user, but should not be parsed by programs."
9188 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
9190 "If the product name could not be determined, then the string C<unknown> is "
9195 #: ../src/guestfs-actions.pod:2768
9196 msgid "guestfs_inspect_get_roots"
9200 #: ../src/guestfs-actions.pod:2770
9204 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9209 #: ../src/guestfs-actions.pod:2773
9211 "This function is a convenient way to get the list of root devices, as "
9212 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9213 "the whole inspection process."
9217 #: ../src/guestfs-actions.pod:2777
9219 "This returns an empty list if either no root devices were found or the "
9220 "caller has not called C<guestfs_inspect_os>."
9224 #: ../src/guestfs-actions.pod:2786
9225 msgid "guestfs_inspect_get_type"
9229 #: ../src/guestfs-actions.pod:2788
9233 " guestfs_inspect_get_type (guestfs_h *g,\n"
9234 " const char *root);\n"
9239 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
9241 "This returns the type of the inspected operating system. Currently defined "
9246 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
9251 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
9252 msgid "Any Linux-based operating system."
9256 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
9257 msgid "Any Microsoft Windows operating system."
9261 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
9266 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
9271 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
9272 msgid "The operating system type could not be determined."
9276 #: ../src/guestfs-actions.pod:2828
9277 msgid "guestfs_inspect_get_windows_systemroot"
9281 #: ../src/guestfs-actions.pod:2830
9285 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9286 " const char *root);\n"
9291 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
9293 "This returns the Windows systemroot of the inspected guest. The systemroot "
9294 "is a directory path such as C</WINDOWS>."
9298 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
9300 "This call assumes that the guest is Windows and that the systemroot could be "
9301 "determined by inspection. If this is not the case then an error is returned."
9305 #: ../src/guestfs-actions.pod:2849
9306 msgid "(Added in 1.5.25)"
9310 #: ../src/guestfs-actions.pod:2851
9311 msgid "guestfs_inspect_list_applications"
9315 #: ../src/guestfs-actions.pod:2853
9318 " struct guestfs_application_list *\n"
9319 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9320 " const char *root);\n"
9325 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
9326 msgid "Return the list of applications installed in the operating system."
9330 #: ../src/guestfs-actions.pod:2862
9332 "I<Note:> This call works differently from other parts of the inspection "
9333 "API. You have to call C<guestfs_inspect_os>, then "
9334 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9335 "this. Listing applications is a significantly more difficult operation "
9336 "which requires access to the full filesystem. Also note that unlike the "
9337 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9338 "the libguestfs handle, this call actually reads parts of the mounted "
9339 "filesystems during the call."
9343 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
9345 "This returns an empty list if the inspection code was not able to determine "
9346 "the list of applications."
9350 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
9351 msgid "The application structure contains the following fields:"
9355 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
9360 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
9362 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9363 "guests, this is the package name."
9367 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
9368 msgid "C<app_display_name>"
9372 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
9374 "The display name of the application, sometimes localized to the install "
9375 "language of the guest operating system."
9379 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
9381 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9382 "to display something can use C<app_name> instead."
9386 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
9387 msgid "C<app_epoch>"
9391 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
9393 "For package managers which use epochs, this contains the epoch of the "
9394 "package (an integer). If unavailable, this is returned as C<0>."
9398 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
9399 msgid "C<app_version>"
9403 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
9405 "The version string of the application or package. If unavailable this is "
9406 "returned as an empty string C<\"\">."
9410 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
9411 msgid "C<app_release>"
9415 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
9417 "The release string of the application or package, for package managers that "
9418 "use this. If unavailable this is returned as an empty string C<\"\">."
9422 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
9423 msgid "C<app_install_path>"
9427 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
9429 "The installation path of the application (on operating systems such as "
9430 "Windows which use installation paths). This path is in the format used by "
9431 "the guest operating system, it is not a libguestfs path."
9435 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
9436 msgid "If unavailable this is returned as an empty string C<\"\">."
9440 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
9441 msgid "C<app_trans_path>"
9445 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9447 "The install path translated into a libguestfs path. If unavailable this is "
9448 "returned as an empty string C<\"\">."
9452 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9453 msgid "C<app_publisher>"
9457 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9459 "The name of the publisher of the application, for package managers that use "
9460 "this. If unavailable this is returned as an empty string C<\"\">."
9464 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9469 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9471 "The URL (eg. upstream URL) of the application. If unavailable this is "
9472 "returned as an empty string C<\"\">."
9476 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9477 msgid "C<app_source_package>"
9481 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9483 "For packaging systems which support this, the name of the source package. "
9484 "If unavailable this is returned as an empty string C<\"\">."
9488 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9489 msgid "C<app_summary>"
9493 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9495 "A short (usually one line) description of the application or package. If "
9496 "unavailable this is returned as an empty string C<\"\">."
9500 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9501 msgid "C<app_description>"
9505 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9507 "A longer description of the application or package. If unavailable this is "
9508 "returned as an empty string C<\"\">."
9512 #: ../src/guestfs-actions.pod:2952
9514 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9515 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9520 #: ../src/guestfs-actions.pod:2956
9521 msgid "guestfs_inspect_os"
9525 #: ../src/guestfs-actions.pod:2958
9529 " guestfs_inspect_os (guestfs_h *g);\n"
9534 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9536 "This function uses other libguestfs functions and certain heuristics to "
9537 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9538 "for operating systems."
9542 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9543 msgid "The list returned is empty if no operating systems were found."
9547 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9549 "If one operating system was found, then this returns a list with a single "
9550 "element, which is the name of the root filesystem of this operating system. "
9551 "It is also possible for this function to return a list containing more than "
9552 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9553 "element being the root filesystem of one of the operating systems."
9557 #: ../src/guestfs-actions.pod:2974
9559 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9560 "functions in order to query further information about each operating system, "
9561 "such as the name and version."
9565 #: ../src/guestfs-actions.pod:2979
9567 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9568 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9569 "the contents. This should be called with no disks currently mounted. The "
9570 "function may also use Augeas, so any existing Augeas handle will be closed."
9574 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9576 "This function cannot decrypt encrypted disks. The caller must do that first "
9577 "(supplying the necessary keys) if the disk is encrypted."
9581 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246
9582 #: ../src/guestfs-actions.pod:3308
9583 msgid "See also C<guestfs_list_filesystems>."
9587 #: ../src/guestfs-actions.pod:2999
9588 msgid "guestfs_is_blockdev"
9592 #: ../src/guestfs-actions.pod:3001
9596 " guestfs_is_blockdev (guestfs_h *g,\n"
9597 " const char *path);\n"
9602 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9604 "This returns C<true> if and only if there is a block device with the given "
9609 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037
9610 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082
9611 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154
9612 #: ../src/guestfs-actions.pod:3169
9613 msgid "See also C<guestfs_stat>."
9617 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041
9618 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158
9619 #: ../src/guestfs-actions.pod:3173
9620 msgid "(Added in 1.5.10)"
9624 #: ../src/guestfs-actions.pod:3014
9625 msgid "guestfs_is_busy"
9629 #: ../src/guestfs-actions.pod:3016
9633 " guestfs_is_busy (guestfs_h *g);\n"
9638 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9640 "This returns true iff this handle is busy processing a command (in the "
9645 #: ../src/guestfs-actions.pod:3028
9646 msgid "guestfs_is_chardev"
9650 #: ../src/guestfs-actions.pod:3030
9654 " guestfs_is_chardev (guestfs_h *g,\n"
9655 " const char *path);\n"
9660 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9662 "This returns C<true> if and only if there is a character device with the "
9663 "given C<path> name."
9667 #: ../src/guestfs-actions.pod:3043
9668 msgid "guestfs_is_config"
9672 #: ../src/guestfs-actions.pod:3045
9676 " guestfs_is_config (guestfs_h *g);\n"
9681 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9683 "This returns true iff this handle is being configured (in the C<CONFIG> "
9688 #: ../src/guestfs-actions.pod:3057
9689 msgid "guestfs_is_dir"
9693 #: ../src/guestfs-actions.pod:3059
9697 " guestfs_is_dir (guestfs_h *g,\n"
9698 " const char *path);\n"
9703 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9705 "This returns C<true> if and only if there is a directory with the given "
9706 "C<path> name. Note that it returns false for other objects like files."
9710 #: ../src/guestfs-actions.pod:3073
9711 msgid "guestfs_is_fifo"
9715 #: ../src/guestfs-actions.pod:3075
9719 " guestfs_is_fifo (guestfs_h *g,\n"
9720 " const char *path);\n"
9725 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9727 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9728 "given C<path> name."
9732 #: ../src/guestfs-actions.pod:3088
9733 msgid "guestfs_is_file"
9737 #: ../src/guestfs-actions.pod:3090
9741 " guestfs_is_file (guestfs_h *g,\n"
9742 " const char *path);\n"
9747 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9749 "This returns C<true> if and only if there is a regular file with the given "
9750 "C<path> name. Note that it returns false for other objects like directories."
9754 #: ../src/guestfs-actions.pod:3104
9755 msgid "guestfs_is_launching"
9759 #: ../src/guestfs-actions.pod:3106
9763 " guestfs_is_launching (guestfs_h *g);\n"
9768 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9770 "This returns true iff this handle is launching the subprocess (in the "
9771 "C<LAUNCHING> state)."
9775 #: ../src/guestfs-actions.pod:3118
9776 msgid "guestfs_is_lv"
9780 #: ../src/guestfs-actions.pod:3120
9784 " guestfs_is_lv (guestfs_h *g,\n"
9785 " const char *device);\n"
9790 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9792 "This command tests whether C<device> is a logical volume, and returns true "
9793 "iff this is the case."
9797 #: ../src/guestfs-actions.pod:3131
9798 msgid "guestfs_is_ready"
9802 #: ../src/guestfs-actions.pod:3133
9806 " guestfs_is_ready (guestfs_h *g);\n"
9811 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9813 "This returns true iff this handle is ready to accept commands (in the "
9818 #: ../src/guestfs-actions.pod:3145
9819 msgid "guestfs_is_socket"
9823 #: ../src/guestfs-actions.pod:3147
9827 " guestfs_is_socket (guestfs_h *g,\n"
9828 " const char *path);\n"
9833 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9835 "This returns C<true> if and only if there is a Unix domain socket with the "
9836 "given C<path> name."
9840 #: ../src/guestfs-actions.pod:3160
9841 msgid "guestfs_is_symlink"
9845 #: ../src/guestfs-actions.pod:3162
9849 " guestfs_is_symlink (guestfs_h *g,\n"
9850 " const char *path);\n"
9855 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9857 "This returns C<true> if and only if there is a symbolic link with the given "
9862 #: ../src/guestfs-actions.pod:3175
9863 msgid "guestfs_kill_subprocess"
9867 #: ../src/guestfs-actions.pod:3177
9871 " guestfs_kill_subprocess (guestfs_h *g);\n"
9876 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9877 msgid "This kills the qemu subprocess. You should never need to call this."
9881 #: ../src/guestfs-actions.pod:3186
9882 msgid "guestfs_launch"
9886 #: ../src/guestfs-actions.pod:3188
9890 " guestfs_launch (guestfs_h *g);\n"
9895 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9897 "Internally libguestfs is implemented by running a virtual machine using "
9902 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9904 "You should call this after configuring the handle (eg. adding drives) but "
9905 "before performing any actions."
9909 #: ../src/guestfs-actions.pod:3201
9910 msgid "guestfs_lchown"
9914 #: ../src/guestfs-actions.pod:3203
9918 " guestfs_lchown (guestfs_h *g,\n"
9921 " const char *path);\n"
9926 #: ../src/guestfs-actions.pod:3209
9928 "Change the file owner to C<owner> and group to C<group>. This is like "
9929 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9930 "changed, not the target."
9934 #: ../src/guestfs-actions.pod:3221
9935 msgid "guestfs_lgetxattrs"
9939 #: ../src/guestfs-actions.pod:3223
9942 " struct guestfs_xattr_list *\n"
9943 " guestfs_lgetxattrs (guestfs_h *g,\n"
9944 " const char *path);\n"
9949 #: ../src/guestfs-actions.pod:3227
9951 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9952 "then it returns the extended attributes of the link itself."
9956 #: ../src/guestfs-actions.pod:3237
9957 msgid "guestfs_list_devices"
9961 #: ../src/guestfs-actions.pod:3239
9965 " guestfs_list_devices (guestfs_h *g);\n"
9970 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9971 msgid "List all the block devices."
9975 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9976 msgid "The full block device names are returned, eg. C</dev/sda>."
9980 #: ../src/guestfs-actions.pod:3254
9981 msgid "guestfs_list_filesystems"
9985 #: ../src/guestfs-actions.pod:3256
9989 " guestfs_list_filesystems (guestfs_h *g);\n"
9994 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
9996 "This inspection command looks for filesystems on partitions, block devices "
9997 "and logical volumes, returning a list of devices containing filesystems and "
10002 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
10004 "The return value is a hash, where the keys are the devices containing "
10005 "filesystems, and the values are the filesystem types. For example:"
10009 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
10012 " \"/dev/sda1\" => \"ntfs\"\n"
10013 " \"/dev/sda2\" => \"ext2\"\n"
10014 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10015 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10020 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
10022 "The value can have the special value \"unknown\", meaning the content of the "
10023 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10027 #: ../src/guestfs-actions.pod:3276
10029 "This command runs other libguestfs commands, which might include "
10030 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10031 "soon after launch and only when nothing is mounted."
10035 #: ../src/guestfs-actions.pod:3280
10037 "Not all of the filesystems returned will be mountable. In particular, swap "
10038 "partitions are returned in the list. Also this command does not check that "
10039 "each filesystem found is valid and mountable, and some filesystems might be "
10040 "mountable but require special options. Filesystems may not all belong to a "
10041 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10045 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
10046 msgid "(Added in 1.5.15)"
10050 #: ../src/guestfs-actions.pod:3296
10051 msgid "guestfs_list_partitions"
10055 #: ../src/guestfs-actions.pod:3298
10059 " guestfs_list_partitions (guestfs_h *g);\n"
10064 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
10065 msgid "List all the partitions detected on all block devices."
10069 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
10070 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10074 #: ../src/guestfs-actions.pod:3305
10076 "This does not return logical volumes. For that you will need to call "
10081 #: ../src/guestfs-actions.pod:3316
10086 #: ../src/guestfs-actions.pod:3318
10090 " guestfs_ll (guestfs_h *g,\n"
10091 " const char *directory);\n"
10096 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
10098 "List the files in C<directory> (relative to the root directory, there is no "
10099 "cwd) in the format of 'ls -la'."
10103 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
10105 "This command is mostly useful for interactive sessions. It is I<not> "
10106 "intended that you try to parse the output string."
10110 #: ../src/guestfs-actions.pod:3333
10115 #: ../src/guestfs-actions.pod:3335
10119 " guestfs_ln (guestfs_h *g,\n"
10120 " const char *target,\n"
10121 " const char *linkname);\n"
10126 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
10127 msgid "This command creates a hard link using the C<ln> command."
10131 #: ../src/guestfs-actions.pod:3346
10132 msgid "guestfs_ln_f"
10136 #: ../src/guestfs-actions.pod:3348
10140 " guestfs_ln_f (guestfs_h *g,\n"
10141 " const char *target,\n"
10142 " const char *linkname);\n"
10147 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
10149 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10150 "option removes the link (C<linkname>) if it exists already."
10154 #: ../src/guestfs-actions.pod:3360
10155 msgid "guestfs_ln_s"
10159 #: ../src/guestfs-actions.pod:3362
10163 " guestfs_ln_s (guestfs_h *g,\n"
10164 " const char *target,\n"
10165 " const char *linkname);\n"
10170 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
10171 msgid "This command creates a symbolic link using the C<ln -s> command."
10175 #: ../src/guestfs-actions.pod:3373
10176 msgid "guestfs_ln_sf"
10180 #: ../src/guestfs-actions.pod:3375
10184 " guestfs_ln_sf (guestfs_h *g,\n"
10185 " const char *target,\n"
10186 " const char *linkname);\n"
10191 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
10193 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10194 "option removes the link (C<linkname>) if it exists already."
10198 #: ../src/guestfs-actions.pod:3387
10199 msgid "guestfs_lremovexattr"
10203 #: ../src/guestfs-actions.pod:3389
10207 " guestfs_lremovexattr (guestfs_h *g,\n"
10208 " const char *xattr,\n"
10209 " const char *path);\n"
10214 #: ../src/guestfs-actions.pod:3394
10216 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10217 "link, then it removes an extended attribute of the link itself."
10221 #: ../src/guestfs-actions.pod:3402
10226 #: ../src/guestfs-actions.pod:3404
10230 " guestfs_ls (guestfs_h *g,\n"
10231 " const char *directory);\n"
10236 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
10238 "List the files in C<directory> (relative to the root directory, there is no "
10239 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10243 #: ../src/guestfs-actions.pod:3412
10245 "This command is mostly useful for interactive sessions. Programs should "
10246 "probably use C<guestfs_readdir> instead."
10250 #: ../src/guestfs-actions.pod:3421
10251 msgid "guestfs_lsetxattr"
10255 #: ../src/guestfs-actions.pod:3423
10259 " guestfs_lsetxattr (guestfs_h *g,\n"
10260 " const char *xattr,\n"
10261 " const char *val,\n"
10263 " const char *path);\n"
10268 #: ../src/guestfs-actions.pod:3430
10270 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10271 "then it sets an extended attribute of the link itself."
10275 #: ../src/guestfs-actions.pod:3438
10276 msgid "guestfs_lstat"
10280 #: ../src/guestfs-actions.pod:3440
10283 " struct guestfs_stat *\n"
10284 " guestfs_lstat (guestfs_h *g,\n"
10285 " const char *path);\n"
10290 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871
10291 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10292 msgid "Returns file information for the given C<path>."
10296 #: ../src/guestfs-actions.pod:3446
10298 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10299 "link, then the link is stat-ed, not the file it refers to."
10303 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
10304 msgid "This is the same as the C<lstat(2)> system call."
10308 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
10310 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10311 "error. I<The caller must call C<guestfs_free_stat> after use>."
10315 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879
10316 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
10317 msgid "(Added in 0.9.2)"
10321 #: ../src/guestfs-actions.pod:3458
10322 msgid "guestfs_lstatlist"
10326 #: ../src/guestfs-actions.pod:3460
10329 " struct guestfs_stat_list *\n"
10330 " guestfs_lstatlist (guestfs_h *g,\n"
10331 " const char *path,\n"
10332 " char *const *names);\n"
10337 #: ../src/guestfs-actions.pod:3465
10339 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10340 "files, where all files are in the directory C<path>. C<names> is the list "
10341 "of files from this directory."
10345 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
10347 "On return you get a list of stat structs, with a one-to-one correspondence "
10348 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10349 "then the C<ino> field of that structure is set to C<-1>."
10353 #: ../src/guestfs-actions.pod:3474
10355 "This call is intended for programs that want to efficiently list a directory "
10356 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10357 "for a similarly efficient call for getting extended attributes. Very long "
10358 "directory listings might cause the protocol message size to be exceeded, "
10359 "causing this call to fail. The caller must split up such requests into "
10360 "smaller groups of names."
10364 #: ../src/guestfs-actions.pod:3482
10366 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10367 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10371 #: ../src/guestfs-actions.pod:3488
10372 msgid "guestfs_luks_add_key"
10376 #: ../src/guestfs-actions.pod:3490
10380 " guestfs_luks_add_key (guestfs_h *g,\n"
10381 " const char *device,\n"
10382 " const char *key,\n"
10383 " const char *newkey,\n"
10389 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
10391 "This command adds a new key on LUKS device C<device>. C<key> is any "
10392 "existing key, and is used to access the device. C<newkey> is the new key to "
10393 "add. C<keyslot> is the key slot that will be replaced."
10397 #: ../src/guestfs-actions.pod:3502
10399 "Note that if C<keyslot> already contains a key, then this command will "
10400 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10404 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548
10405 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591
10406 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
10408 "This function takes a key or passphrase parameter which could contain "
10409 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10414 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552
10415 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
10416 msgid "(Added in 1.5.2)"
10420 #: ../src/guestfs-actions.pod:3514
10421 msgid "guestfs_luks_close"
10425 #: ../src/guestfs-actions.pod:3516
10429 " guestfs_luks_close (guestfs_h *g,\n"
10430 " const char *device);\n"
10435 #: ../src/guestfs-actions.pod:3520
10437 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10438 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10439 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10440 "underlying block device."
10444 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627
10445 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696
10446 #: ../src/guestfs-actions.pod:3744
10447 msgid "(Added in 1.5.1)"
10451 #: ../src/guestfs-actions.pod:3530
10452 msgid "guestfs_luks_format"
10456 #: ../src/guestfs-actions.pod:3532
10460 " guestfs_luks_format (guestfs_h *g,\n"
10461 " const char *device,\n"
10462 " const char *key,\n"
10468 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10470 "This command erases existing data on C<device> and formats the device as a "
10471 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10472 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10476 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568
10477 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568
10478 #: ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706
10479 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755
10480 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433
10481 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10482 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10483 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10484 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10486 "B<This command is dangerous. Without careful use you can easily destroy all "
10491 #: ../src/guestfs-actions.pod:3554
10492 msgid "guestfs_luks_format_cipher"
10496 #: ../src/guestfs-actions.pod:3556
10500 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10501 " const char *device,\n"
10502 " const char *key,\n"
10504 " const char *cipher);\n"
10509 #: ../src/guestfs-actions.pod:3563
10511 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10512 "set the C<cipher> used."
10516 #: ../src/guestfs-actions.pod:3577
10517 msgid "guestfs_luks_kill_slot"
10521 #: ../src/guestfs-actions.pod:3579
10525 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10526 " const char *device,\n"
10527 " const char *key,\n"
10533 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10535 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10536 "device C<device>. C<key> must be one of the I<other> keys."
10540 #: ../src/guestfs-actions.pod:3597
10541 msgid "guestfs_luks_open"
10545 #: ../src/guestfs-actions.pod:3599
10549 " guestfs_luks_open (guestfs_h *g,\n"
10550 " const char *device,\n"
10551 " const char *key,\n"
10552 " const char *mapname);\n"
10557 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10559 "This command opens a block device which has been encrypted according to the "
10560 "Linux Unified Key Setup (LUKS) standard."
10564 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10565 msgid "C<device> is the encrypted block device or partition."
10569 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10571 "The caller must supply one of the keys associated with the LUKS block "
10572 "device, in the C<key> parameter."
10576 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10578 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10579 "writes to this block device are decrypted from and encrypted to the "
10580 "underlying C<device> respectively."
10584 #: ../src/guestfs-actions.pod:3617
10586 "If this block device contains LVM volume groups, then calling "
10587 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10592 #: ../src/guestfs-actions.pod:3629
10593 msgid "guestfs_luks_open_ro"
10597 #: ../src/guestfs-actions.pod:3631
10601 " guestfs_luks_open_ro (guestfs_h *g,\n"
10602 " const char *device,\n"
10603 " const char *key,\n"
10604 " const char *mapname);\n"
10609 #: ../src/guestfs-actions.pod:3637
10611 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10616 #: ../src/guestfs-actions.pod:3648
10617 msgid "guestfs_lvcreate"
10621 #: ../src/guestfs-actions.pod:3650
10625 " guestfs_lvcreate (guestfs_h *g,\n"
10626 " const char *logvol,\n"
10627 " const char *volgroup,\n"
10633 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10635 "This creates an LVM logical volume called C<logvol> on the volume group "
10636 "C<volgroup>, with C<size> megabytes."
10640 #: ../src/guestfs-actions.pod:3663
10641 msgid "guestfs_lvm_canonical_lv_name"
10645 #: ../src/guestfs-actions.pod:3665
10649 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10650 " const char *lvname);\n"
10655 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10657 "This converts alternative naming schemes for LVs that you might find to the "
10658 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10663 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10665 "This command returns an error if the C<lvname> parameter does not refer to a "
10670 #: ../src/guestfs-actions.pod:3676
10671 msgid "See also C<guestfs_is_lv>."
10675 #: ../src/guestfs-actions.pod:3681
10676 msgid "(Added in 1.5.24)"
10680 #: ../src/guestfs-actions.pod:3683
10681 msgid "guestfs_lvm_clear_filter"
10685 #: ../src/guestfs-actions.pod:3685
10689 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10694 #: ../src/guestfs-actions.pod:3688
10696 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10697 "see every block device."
10701 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733
10702 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10704 "This command also clears the LVM cache and performs a volume group scan."
10708 #: ../src/guestfs-actions.pod:3698
10709 msgid "guestfs_lvm_remove_all"
10713 #: ../src/guestfs-actions.pod:3700
10717 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10722 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10724 "This command removes all LVM logical volumes, volume groups and physical "
10729 #: ../src/guestfs-actions.pod:3713
10730 msgid "guestfs_lvm_set_filter"
10734 #: ../src/guestfs-actions.pod:3715
10738 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10739 " char *const *devices);\n"
10744 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10746 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10747 "block devices in the list C<devices>, and will ignore all other attached "
10752 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10754 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10755 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10756 "there are two types of duplication possible: either cloned PVs/VGs which "
10757 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10758 "same name. In normal operation you cannot create this situation, but you "
10759 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10760 "inside the LVM metadata."
10764 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10765 msgid "You can filter whole block devices or individual partitions."
10769 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10771 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10772 "filesystem), even if you are not filtering out that VG."
10776 #: ../src/guestfs-actions.pod:3746
10777 msgid "guestfs_lvremove"
10781 #: ../src/guestfs-actions.pod:3748
10785 " guestfs_lvremove (guestfs_h *g,\n"
10786 " const char *device);\n"
10791 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10793 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10794 "LV, such as C</dev/VG/LV>."
10798 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10800 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10805 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914
10806 #: ../src/guestfs-actions.pod:6644
10807 msgid "(Added in 1.0.13)"
10811 #: ../src/guestfs-actions.pod:3762
10812 msgid "guestfs_lvrename"
10816 #: ../src/guestfs-actions.pod:3764
10820 " guestfs_lvrename (guestfs_h *g,\n"
10821 " const char *logvol,\n"
10822 " const char *newlogvol);\n"
10827 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10828 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10832 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10833 msgid "(Added in 1.0.83)"
10837 #: ../src/guestfs-actions.pod:3775
10838 msgid "guestfs_lvresize"
10842 #: ../src/guestfs-actions.pod:3777
10846 " guestfs_lvresize (guestfs_h *g,\n"
10847 " const char *device,\n"
10853 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10855 "This resizes (expands or shrinks) an existing LVM logical volume to "
10856 "C<mbytes>. When reducing, data in the reduced part is lost."
10860 #: ../src/guestfs-actions.pod:3790
10861 msgid "guestfs_lvresize_free"
10865 #: ../src/guestfs-actions.pod:3792
10869 " guestfs_lvresize_free (guestfs_h *g,\n"
10870 " const char *lv,\n"
10876 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10878 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10879 "remaining free space in the volume group. Commonly you would call this with "
10880 "pc = 100 which expands the logical volume as much as possible, using all "
10881 "remaining free space in the volume group."
10885 #: ../src/guestfs-actions.pod:3805
10886 msgid "(Added in 1.3.3)"
10890 #: ../src/guestfs-actions.pod:3807
10891 msgid "guestfs_lvs"
10895 #: ../src/guestfs-actions.pod:3809
10899 " guestfs_lvs (guestfs_h *g);\n"
10904 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10906 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10911 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10913 "This returns a list of the logical volume device names (eg. C</dev/"
10914 "VolGroup00/LogVol00>)."
10918 #: ../src/guestfs-actions.pod:3818
10919 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10923 #: ../src/guestfs-actions.pod:3826
10924 msgid "guestfs_lvs_full"
10928 #: ../src/guestfs-actions.pod:3828
10931 " struct guestfs_lvm_lv_list *\n"
10932 " guestfs_lvs_full (guestfs_h *g);\n"
10937 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10939 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10940 "(8)> command. The \"full\" version includes all fields."
10944 #: ../src/guestfs-actions.pod:3834
10946 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10947 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10951 #: ../src/guestfs-actions.pod:3840
10952 msgid "guestfs_lvuuid"
10956 #: ../src/guestfs-actions.pod:3842
10960 " guestfs_lvuuid (guestfs_h *g,\n"
10961 " const char *device);\n"
10966 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10967 msgid "This command returns the UUID of the LVM LV C<device>."
10971 #: ../src/guestfs-actions.pod:3853
10972 msgid "guestfs_lxattrlist"
10976 #: ../src/guestfs-actions.pod:3855
10979 " struct guestfs_xattr_list *\n"
10980 " guestfs_lxattrlist (guestfs_h *g,\n"
10981 " const char *path,\n"
10982 " char *const *names);\n"
10987 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
10989 "This call allows you to get the extended attributes of multiple files, where "
10990 "all files are in the directory C<path>. C<names> is the list of files from "
10995 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
10997 "On return you get a flat list of xattr structs which must be interpreted "
10998 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10999 "C<attrval> in this struct is zero-length to indicate there was an error "
11000 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11001 "number (the number of following attributes for this file, which could be C<"
11002 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11003 "for the first named file. This repeats for the second and subsequent files."
11007 #: ../src/guestfs-actions.pod:3874
11009 "This call is intended for programs that want to efficiently list a directory "
11010 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11011 "a similarly efficient call for getting standard stats. Very long directory "
11012 "listings might cause the protocol message size to be exceeded, causing this "
11013 "call to fail. The caller must split up such requests into smaller groups of "
11018 #: ../src/guestfs-actions.pod:3888
11019 msgid "guestfs_mkdir"
11023 #: ../src/guestfs-actions.pod:3890
11027 " guestfs_mkdir (guestfs_h *g,\n"
11028 " const char *path);\n"
11033 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
11034 msgid "Create a directory named C<path>."
11038 #: ../src/guestfs-actions.pod:3900
11039 msgid "guestfs_mkdir_mode"
11043 #: ../src/guestfs-actions.pod:3902
11047 " guestfs_mkdir_mode (guestfs_h *g,\n"
11048 " const char *path,\n"
11054 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
11056 "This command creates a directory, setting the initial permissions of the "
11057 "directory to C<mode>."
11061 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
11063 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11064 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11069 #: ../src/guestfs-actions.pod:3914
11070 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11074 #: ../src/guestfs-actions.pod:3920
11075 msgid "guestfs_mkdir_p"
11079 #: ../src/guestfs-actions.pod:3922
11083 " guestfs_mkdir_p (guestfs_h *g,\n"
11084 " const char *path);\n"
11089 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
11091 "Create a directory named C<path>, creating any parent directories as "
11092 "necessary. This is like the C<mkdir -p> shell command."
11096 #: ../src/guestfs-actions.pod:3933
11097 msgid "guestfs_mkdtemp"
11101 #: ../src/guestfs-actions.pod:3935
11105 " guestfs_mkdtemp (guestfs_h *g,\n"
11106 " const char *template);\n"
11111 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
11113 "This command creates a temporary directory. The C<template> parameter "
11114 "should be a full pathname for the temporary directory name with the final "
11115 "six characters being \"XXXXXX\"."
11119 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
11121 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11122 "being suitable for Windows filesystems."
11126 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
11127 msgid "The name of the temporary directory that was created is returned."
11131 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
11132 msgid "The temporary directory is created with mode 0700 and is owned by root."
11136 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
11138 "The caller is responsible for deleting the temporary directory and its "
11139 "contents after use."
11143 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
11144 msgid "See also: L<mkdtemp(3)>"
11148 #: ../src/guestfs-actions.pod:3963
11149 msgid "guestfs_mke2fs_J"
11153 #: ../src/guestfs-actions.pod:3965
11157 " guestfs_mke2fs_J (guestfs_h *g,\n"
11158 " const char *fstype,\n"
11159 " int blocksize,\n"
11160 " const char *device,\n"
11161 " const char *journal);\n"
11166 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
11168 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11169 "C<journal>. It is equivalent to the command:"
11173 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
11176 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11181 #: ../src/guestfs-actions.pod:3978
11182 msgid "See also C<guestfs_mke2journal>."
11186 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000
11187 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034
11188 #: ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062
11189 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
11190 msgid "(Added in 1.0.68)"
11194 #: ../src/guestfs-actions.pod:3984
11195 msgid "guestfs_mke2fs_JL"
11199 #: ../src/guestfs-actions.pod:3986
11203 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11204 " const char *fstype,\n"
11205 " int blocksize,\n"
11206 " const char *device,\n"
11207 " const char *label);\n"
11212 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
11214 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11215 "the journal labeled C<label>."
11219 #: ../src/guestfs-actions.pod:3996
11220 msgid "See also C<guestfs_mke2journal_L>."
11224 #: ../src/guestfs-actions.pod:4002
11225 msgid "guestfs_mke2fs_JU"
11229 #: ../src/guestfs-actions.pod:4004
11233 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11234 " const char *fstype,\n"
11235 " int blocksize,\n"
11236 " const char *device,\n"
11237 " const char *uuid);\n"
11242 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
11244 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11245 "the journal with UUID C<uuid>."
11249 #: ../src/guestfs-actions.pod:4014
11250 msgid "See also C<guestfs_mke2journal_U>."
11254 #: ../src/guestfs-actions.pod:4020
11255 msgid "guestfs_mke2journal"
11259 #: ../src/guestfs-actions.pod:4022
11263 " guestfs_mke2journal (guestfs_h *g,\n"
11264 " int blocksize,\n"
11265 " const char *device);\n"
11270 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
11272 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11277 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
11280 " mke2fs -O journal_dev -b blocksize device\n"
11285 #: ../src/guestfs-actions.pod:4036
11286 msgid "guestfs_mke2journal_L"
11290 #: ../src/guestfs-actions.pod:4038
11294 " guestfs_mke2journal_L (guestfs_h *g,\n"
11295 " int blocksize,\n"
11296 " const char *label,\n"
11297 " const char *device);\n"
11302 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
11303 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11307 #: ../src/guestfs-actions.pod:4050
11308 msgid "guestfs_mke2journal_U"
11312 #: ../src/guestfs-actions.pod:4052
11316 " guestfs_mke2journal_U (guestfs_h *g,\n"
11317 " int blocksize,\n"
11318 " const char *uuid,\n"
11319 " const char *device);\n"
11324 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
11325 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11329 #: ../src/guestfs-actions.pod:4064
11330 msgid "guestfs_mkfifo"
11334 #: ../src/guestfs-actions.pod:4066
11338 " guestfs_mkfifo (guestfs_h *g,\n"
11340 " const char *path);\n"
11345 #: ../src/guestfs-actions.pod:4071
11347 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11348 "is just a convenient wrapper around C<guestfs_mknod>."
11352 #: ../src/guestfs-actions.pod:4081
11353 msgid "guestfs_mkfs"
11357 #: ../src/guestfs-actions.pod:4083
11361 " guestfs_mkfs (guestfs_h *g,\n"
11362 " const char *fstype,\n"
11363 " const char *device);\n"
11368 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
11370 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11371 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11375 #: ../src/guestfs-actions.pod:4096
11376 msgid "guestfs_mkfs_b"
11380 #: ../src/guestfs-actions.pod:4098
11384 " guestfs_mkfs_b (guestfs_h *g,\n"
11385 " const char *fstype,\n"
11386 " int blocksize,\n"
11387 " const char *device);\n"
11392 #: ../src/guestfs-actions.pod:4104
11394 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11395 "block size of the resulting filesystem. Supported block sizes depend on the "
11396 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11400 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
11402 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11407 #: ../src/guestfs-actions.pod:4116
11408 msgid "guestfs_mkmountpoint"
11412 #: ../src/guestfs-actions.pod:4118
11416 " guestfs_mkmountpoint (guestfs_h *g,\n"
11417 " const char *exemptpath);\n"
11422 #: ../src/guestfs-actions.pod:4122
11424 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11425 "that can be used to create extra mountpoints before mounting the first "
11430 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
11432 "These calls are I<only> necessary in some very limited circumstances, mainly "
11433 "the case where you want to mount a mix of unrelated and/or read-only "
11434 "filesystems together."
11438 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
11440 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11441 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11442 "inside that. You can unpack this as follows in guestfish:"
11446 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
11449 " add-ro Fedora-11-i686-Live.iso\n"
11451 " mkmountpoint /cd\n"
11452 " mkmountpoint /sqsh\n"
11453 " mkmountpoint /ext3fs\n"
11454 " mount /dev/sda /cd\n"
11455 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11456 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11461 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
11462 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11466 #: ../src/guestfs-actions.pod:4146
11468 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11469 "may get unexpected errors if you try to mix these calls. It is safest to "
11470 "manually unmount filesystems and remove mountpoints after use."
11474 #: ../src/guestfs-actions.pod:4150
11476 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11477 "first, so for this to work for manual mountpoints, you must ensure that the "
11478 "innermost mountpoints have the longest pathnames, as in the example code "
11483 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11485 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11489 #: ../src/guestfs-actions.pod:4157
11491 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11492 "means that C<guestfs_umount_all> is called when the handle is closed which "
11493 "can also trigger these issues."
11497 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422
11498 #: ../src/guestfs-actions.pod:5315
11499 msgid "(Added in 1.0.62)"
11503 #: ../src/guestfs-actions.pod:4165
11504 msgid "guestfs_mknod"
11508 #: ../src/guestfs-actions.pod:4167
11512 " guestfs_mknod (guestfs_h *g,\n"
11516 " const char *path);\n"
11521 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11523 "This call creates block or character special devices, or named pipes (FIFOs)."
11527 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11529 "The C<mode> parameter should be the mode, using the standard constants. "
11530 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11531 "used when creating block and character special devices."
11535 #: ../src/guestfs-actions.pod:4182
11537 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11538 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11539 "regular file). These constants are available in the standard Linux header "
11540 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11541 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11542 "the appropriate constant for you."
11546 #: ../src/guestfs-actions.pod:4196
11547 msgid "guestfs_mknod_b"
11551 #: ../src/guestfs-actions.pod:4198
11555 " guestfs_mknod_b (guestfs_h *g,\n"
11559 " const char *path);\n"
11564 #: ../src/guestfs-actions.pod:4205
11566 "This call creates a block device node called C<path> with mode C<mode> and "
11567 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11568 "wrapper around C<guestfs_mknod>."
11572 #: ../src/guestfs-actions.pod:4215
11573 msgid "guestfs_mknod_c"
11577 #: ../src/guestfs-actions.pod:4217
11581 " guestfs_mknod_c (guestfs_h *g,\n"
11585 " const char *path);\n"
11590 #: ../src/guestfs-actions.pod:4224
11592 "This call creates a char device node called C<path> with mode C<mode> and "
11593 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11594 "wrapper around C<guestfs_mknod>."
11598 #: ../src/guestfs-actions.pod:4234
11599 msgid "guestfs_mkswap"
11603 #: ../src/guestfs-actions.pod:4236
11607 " guestfs_mkswap (guestfs_h *g,\n"
11608 " const char *device);\n"
11613 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11614 msgid "Create a swap partition on C<device>."
11618 #: ../src/guestfs-actions.pod:4246
11619 msgid "guestfs_mkswap_L"
11623 #: ../src/guestfs-actions.pod:4248
11627 " guestfs_mkswap_L (guestfs_h *g,\n"
11628 " const char *label,\n"
11629 " const char *device);\n"
11634 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11635 msgid "Create a swap partition on C<device> with label C<label>."
11639 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11641 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11642 "sda>), just to a partition. This appears to be a limitation of the kernel "
11647 #: ../src/guestfs-actions.pod:4263
11648 msgid "guestfs_mkswap_U"
11652 #: ../src/guestfs-actions.pod:4265
11656 " guestfs_mkswap_U (guestfs_h *g,\n"
11657 " const char *uuid,\n"
11658 " const char *device);\n"
11663 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11664 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11668 #: ../src/guestfs-actions.pod:4276
11669 msgid "guestfs_mkswap_file"
11673 #: ../src/guestfs-actions.pod:4278
11677 " guestfs_mkswap_file (guestfs_h *g,\n"
11678 " const char *path);\n"
11683 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11684 msgid "Create a swap file."
11688 #: ../src/guestfs-actions.pod:4284
11690 "This command just writes a swap file signature to an existing file. To "
11691 "create the file itself, use something like C<guestfs_fallocate>."
11695 #: ../src/guestfs-actions.pod:4291
11696 msgid "guestfs_modprobe"
11700 #: ../src/guestfs-actions.pod:4293
11704 " guestfs_modprobe (guestfs_h *g,\n"
11705 " const char *modulename);\n"
11710 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11711 msgid "This loads a kernel module in the appliance."
11715 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11717 "The kernel module must have been whitelisted when libguestfs was built (see "
11718 "C<appliance/kmod.whitelist.in> in the source)."
11722 #: ../src/guestfs-actions.pod:4306
11723 msgid "guestfs_mount"
11727 #: ../src/guestfs-actions.pod:4308
11731 " guestfs_mount (guestfs_h *g,\n"
11732 " const char *device,\n"
11733 " const char *mountpoint);\n"
11738 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11740 "Mount a guest disk at a position in the filesystem. Block devices are named "
11741 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11742 "those block devices contain partitions, they will have the usual names (eg. "
11743 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11747 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11749 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11750 "mounted on C</> before others can be mounted. Other filesystems can only be "
11751 "mounted on directories which already exist."
11755 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11757 "The mounted filesystem is writable, if we have sufficient permissions on the "
11758 "underlying device."
11762 #: ../src/guestfs-actions.pod:4327
11764 "B<Important note:> When you use this call, the filesystem options C<sync> "
11765 "and C<noatime> are set implicitly. This was originally done because we "
11766 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11767 "very large negative performance impact and negligible effect on "
11768 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11769 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11770 "(use an empty string for the first parameter if you don't want any options)."
11774 #: ../src/guestfs-actions.pod:4341
11775 msgid "guestfs_mount_loop"
11779 #: ../src/guestfs-actions.pod:4343
11783 " guestfs_mount_loop (guestfs_h *g,\n"
11784 " const char *file,\n"
11785 " const char *mountpoint);\n"
11790 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11792 "This command lets you mount C<file> (a filesystem image in a file) on a "
11793 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11798 #: ../src/guestfs-actions.pod:4356
11799 msgid "guestfs_mount_options"
11803 #: ../src/guestfs-actions.pod:4358
11807 " guestfs_mount_options (guestfs_h *g,\n"
11808 " const char *options,\n"
11809 " const char *device,\n"
11810 " const char *mountpoint);\n"
11815 #: ../src/guestfs-actions.pod:4364
11817 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11818 "the mount options as for the L<mount(8)> I<-o> flag."
11822 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11824 "If the C<options> parameter is an empty string, then no options are passed "
11825 "(all options default to whatever the filesystem uses)."
11829 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388
11830 #: ../src/guestfs-actions.pod:4405
11831 msgid "(Added in 1.0.10)"
11835 #: ../src/guestfs-actions.pod:4376
11836 msgid "guestfs_mount_ro"
11840 #: ../src/guestfs-actions.pod:4378
11844 " guestfs_mount_ro (guestfs_h *g,\n"
11845 " const char *device,\n"
11846 " const char *mountpoint);\n"
11851 #: ../src/guestfs-actions.pod:4383
11853 "This is the same as the C<guestfs_mount> command, but it mounts the "
11854 "filesystem with the read-only (I<-o ro>) flag."
11858 #: ../src/guestfs-actions.pod:4390
11859 msgid "guestfs_mount_vfs"
11863 #: ../src/guestfs-actions.pod:4392
11867 " guestfs_mount_vfs (guestfs_h *g,\n"
11868 " const char *options,\n"
11869 " const char *vfstype,\n"
11870 " const char *device,\n"
11871 " const char *mountpoint);\n"
11876 #: ../src/guestfs-actions.pod:4399
11878 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11879 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11884 #: ../src/guestfs-actions.pod:4407
11885 msgid "guestfs_mountpoints"
11889 #: ../src/guestfs-actions.pod:4409
11893 " guestfs_mountpoints (guestfs_h *g);\n"
11898 #: ../src/guestfs-actions.pod:4412
11900 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11901 "devices. This one returns a hash table (map) of device name to directory "
11902 "where the device is mounted."
11906 #: ../src/guestfs-actions.pod:4424
11907 msgid "guestfs_mounts"
11911 #: ../src/guestfs-actions.pod:4426
11915 " guestfs_mounts (guestfs_h *g);\n"
11920 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11922 "This returns the list of currently mounted filesystems. It returns the list "
11923 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11927 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11928 msgid "Some internal mounts are not shown."
11932 #: ../src/guestfs-actions.pod:4434
11933 msgid "See also: C<guestfs_mountpoints>"
11937 #: ../src/guestfs-actions.pod:4442
11942 #: ../src/guestfs-actions.pod:4444
11946 " guestfs_mv (guestfs_h *g,\n"
11947 " const char *src,\n"
11948 " const char *dest);\n"
11953 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11955 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11956 "destination filename or destination directory."
11960 #: ../src/guestfs-actions.pod:4456
11961 msgid "guestfs_ntfs_3g_probe"
11965 #: ../src/guestfs-actions.pod:4458
11969 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11971 " const char *device);\n"
11976 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11978 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11979 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11980 "write, and some cannot be mounted at all)."
11984 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11986 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11987 "can be mounted read-write. Set it to false if you want to test if the "
11988 "volume can be mounted read-only."
11992 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
11994 "The return value is an integer which C<0> if the operation would succeed, or "
11995 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11999 #: ../src/guestfs-actions.pod:4477
12000 msgid "(Added in 1.0.43)"
12004 #: ../src/guestfs-actions.pod:4479
12005 msgid "guestfs_ntfsresize"
12009 #: ../src/guestfs-actions.pod:4481
12013 " guestfs_ntfsresize (guestfs_h *g,\n"
12014 " const char *device);\n"
12019 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
12021 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12022 "size of the underlying device. See also L<ntfsresize(8)>."
12026 #: ../src/guestfs-actions.pod:4493
12027 msgid "guestfs_ntfsresize_size"
12031 #: ../src/guestfs-actions.pod:4495
12035 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12036 " const char *device,\n"
12037 " int64_t size);\n"
12042 #: ../src/guestfs-actions.pod:4500
12044 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12045 "to specify the new size (in bytes) explicitly."
12049 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941
12050 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
12051 msgid "(Added in 1.3.14)"
12055 #: ../src/guestfs-actions.pod:4507
12056 msgid "guestfs_part_add"
12060 #: ../src/guestfs-actions.pod:4509
12064 " guestfs_part_add (guestfs_h *g,\n"
12065 " const char *device,\n"
12066 " const char *prlogex,\n"
12067 " int64_t startsect,\n"
12068 " int64_t endsect);\n"
12073 #: ../src/guestfs-actions.pod:4516
12075 "This command adds a partition to C<device>. If there is no partition table "
12076 "on the device, call C<guestfs_part_init> first."
12080 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
12082 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12083 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12084 "C<logical>) and C<e> (or C<extended>) partition types."
12088 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
12090 "C<startsect> and C<endsect> are the start and end of the partition in "
12091 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12092 "from the end of the disk (C<-1> is the last sector)."
12096 #: ../src/guestfs-actions.pod:4528
12098 "Creating a partition which covers the whole disk is not so easy. Use "
12099 "C<guestfs_part_disk> to do that."
12103 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571
12104 #: ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702
12105 #: ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759
12106 #: ../src/guestfs-actions.pod:4799
12107 msgid "(Added in 1.0.78)"
12111 #: ../src/guestfs-actions.pod:4535
12112 msgid "guestfs_part_del"
12116 #: ../src/guestfs-actions.pod:4537
12120 " guestfs_part_del (guestfs_h *g,\n"
12121 " const char *device,\n"
12127 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
12128 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12132 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
12134 "Note that in the case of MBR partitioning, deleting an extended partition "
12135 "also deletes any logical partitions it contains."
12139 #: ../src/guestfs-actions.pod:4552
12140 msgid "guestfs_part_disk"
12144 #: ../src/guestfs-actions.pod:4554
12148 " guestfs_part_disk (guestfs_h *g,\n"
12149 " const char *device,\n"
12150 " const char *parttype);\n"
12155 #: ../src/guestfs-actions.pod:4559
12157 "This command is simply a combination of C<guestfs_part_init> followed by "
12158 "C<guestfs_part_add> to create a single primary partition covering the whole "
12163 #: ../src/guestfs-actions.pod:4563
12165 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12166 "possible values are described in C<guestfs_part_init>."
12170 #: ../src/guestfs-actions.pod:4573
12171 msgid "guestfs_part_get_bootable"
12175 #: ../src/guestfs-actions.pod:4575
12179 " guestfs_part_get_bootable (guestfs_h *g,\n"
12180 " const char *device,\n"
12186 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
12188 "This command returns true if the partition C<partnum> on C<device> has the "
12189 "bootable flag set."
12193 #: ../src/guestfs-actions.pod:4583
12194 msgid "See also C<guestfs_part_set_bootable>."
12198 #: ../src/guestfs-actions.pod:4589
12199 msgid "guestfs_part_get_mbr_id"
12203 #: ../src/guestfs-actions.pod:4591
12207 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12208 " const char *device,\n"
12214 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
12216 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12217 "partition C<partnum>."
12221 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
12223 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12224 "undefined results for other partition table types (see "
12225 "C<guestfs_part_get_parttype>)."
12229 #: ../src/guestfs-actions.pod:4607
12230 msgid "guestfs_part_get_parttype"
12234 #: ../src/guestfs-actions.pod:4609
12238 " guestfs_part_get_parttype (guestfs_h *g,\n"
12239 " const char *device);\n"
12244 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
12246 "This command examines the partition table on C<device> and returns the "
12247 "partition table type (format) being used."
12251 #: ../src/guestfs-actions.pod:4616
12253 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12254 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12255 "possible, although unusual. See C<guestfs_part_init> for a full list."
12259 #: ../src/guestfs-actions.pod:4626
12260 msgid "guestfs_part_init"
12264 #: ../src/guestfs-actions.pod:4628
12268 " guestfs_part_init (guestfs_h *g,\n"
12269 " const char *device,\n"
12270 " const char *parttype);\n"
12275 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
12277 "This creates an empty partition table on C<device> of one of the partition "
12278 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12279 "(for large disks)."
12283 #: ../src/guestfs-actions.pod:4637
12285 "Initially there are no partitions. Following this, you should call "
12286 "C<guestfs_part_add> for each partition required."
12290 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
12291 msgid "Possible values for C<parttype> are:"
12295 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
12296 msgid "B<efi> | B<gpt>"
12300 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
12301 msgid "Intel EFI / GPT partition table."
12305 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
12307 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12308 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12309 "the C<mbr> format."
12313 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
12314 msgid "B<mbr> | B<msdos>"
12318 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
12320 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12321 "Windows. This partition type will B<only> work for device sizes up to 2 "
12322 "TB. For large disks we recommend using C<gpt>."
12326 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
12328 "Other partition table types that may work but are not supported include:"
12332 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
12337 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
12338 msgid "AIX disk labels."
12342 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
12343 msgid "B<amiga> | B<rdb>"
12347 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
12348 msgid "Amiga \"Rigid Disk Block\" format."
12352 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
12357 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
12358 msgid "BSD disk labels."
12362 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
12367 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
12368 msgid "DASD, used on IBM mainframes."
12372 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
12377 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
12378 msgid "MIPS/SGI volumes."
12382 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
12387 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
12388 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12392 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
12397 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
12398 msgid "NEC PC-98 format, common in Japan apparently."
12402 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
12407 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
12408 msgid "Sun disk labels."
12412 #: ../src/guestfs-actions.pod:4704
12413 msgid "guestfs_part_list"
12417 #: ../src/guestfs-actions.pod:4706
12420 " struct guestfs_partition_list *\n"
12421 " guestfs_part_list (guestfs_h *g,\n"
12422 " const char *device);\n"
12427 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
12429 "This command parses the partition table on C<device> and returns the list of "
12430 "partitions found."
12434 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
12435 msgid "The fields in the returned structure are:"
12439 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
12440 msgid "B<part_num>"
12444 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
12445 msgid "Partition number, counting from 1."
12449 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
12450 msgid "B<part_start>"
12454 #: ../src/guestfs-actions.pod:4723
12456 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12457 "the device's sector size, see C<guestfs_blockdev_getss>."
12461 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
12462 msgid "B<part_end>"
12466 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
12467 msgid "End of the partition in bytes."
12471 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12472 msgid "B<part_size>"
12476 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12477 msgid "Size of the partition in bytes."
12481 #: ../src/guestfs-actions.pod:4736
12483 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12484 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12489 #: ../src/guestfs-actions.pod:4742
12490 msgid "guestfs_part_set_bootable"
12494 #: ../src/guestfs-actions.pod:4744
12498 " guestfs_part_set_bootable (guestfs_h *g,\n"
12499 " const char *device,\n"
12501 " int bootable);\n"
12506 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12508 "This sets the bootable flag on partition numbered C<partnum> on device "
12509 "C<device>. Note that partitions are numbered from 1."
12513 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12515 "The bootable flag is used by some operating systems (notably Windows) to "
12516 "determine which partition to boot from. It is by no means universally "
12521 #: ../src/guestfs-actions.pod:4761
12522 msgid "guestfs_part_set_mbr_id"
12526 #: ../src/guestfs-actions.pod:4763
12530 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12531 " const char *device,\n"
12538 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12540 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12541 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12542 "documentation are in fact hexadecimal numbers, but usually documented "
12543 "without any leading \"0x\" which might be confusing."
12547 #: ../src/guestfs-actions.pod:4783
12548 msgid "guestfs_part_set_name"
12552 #: ../src/guestfs-actions.pod:4785
12556 " guestfs_part_set_name (guestfs_h *g,\n"
12557 " const char *device,\n"
12559 " const char *name);\n"
12564 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12566 "This sets the partition name on partition numbered C<partnum> on device "
12567 "C<device>. Note that partitions are numbered from 1."
12571 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12573 "The partition name can only be set on certain types of partition table. "
12574 "This works on C<gpt> but not on C<mbr> partitions."
12578 #: ../src/guestfs-actions.pod:4801
12579 msgid "guestfs_part_to_dev"
12583 #: ../src/guestfs-actions.pod:4803
12587 " guestfs_part_to_dev (guestfs_h *g,\n"
12588 " const char *partition);\n"
12593 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12595 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12596 "partition number, returning the device name (eg. \"/dev/sdb\")."
12600 #: ../src/guestfs-actions.pod:4811
12602 "The named partition must exist, for example as a string returned from "
12603 "C<guestfs_list_partitions>."
12607 #: ../src/guestfs-actions.pod:4819
12608 msgid "guestfs_ping_daemon"
12612 #: ../src/guestfs-actions.pod:4821
12616 " guestfs_ping_daemon (guestfs_h *g);\n"
12621 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12623 "This is a test probe into the guestfs daemon running inside the qemu "
12624 "subprocess. Calling this function checks that the daemon responds to the "
12625 "ping message, without affecting the daemon or attached block device(s) in "
12630 #: ../src/guestfs-actions.pod:4833
12631 msgid "guestfs_pread"
12635 #: ../src/guestfs-actions.pod:4835
12639 " guestfs_pread (guestfs_h *g,\n"
12640 " const char *path,\n"
12642 " int64_t offset,\n"
12643 " size_t *size_r);\n"
12648 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12650 "This command lets you read part of a file. It reads C<count> bytes of the "
12651 "file, starting at C<offset>, from file C<path>."
12655 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871
12656 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12658 "This may read fewer bytes than requested. For further details see the "
12659 "L<pread(2)> system call."
12663 #: ../src/guestfs-actions.pod:4848
12664 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12668 #: ../src/guestfs-actions.pod:4859
12669 msgid "guestfs_pread_device"
12673 #: ../src/guestfs-actions.pod:4861
12677 " guestfs_pread_device (guestfs_h *g,\n"
12678 " const char *device,\n"
12680 " int64_t offset,\n"
12681 " size_t *size_r);\n"
12686 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12688 "This command lets you read part of a file. It reads C<count> bytes of "
12689 "C<device>, starting at C<offset>."
12693 #: ../src/guestfs-actions.pod:4874
12694 msgid "See also C<guestfs_pread>."
12698 #: ../src/guestfs-actions.pod:4883
12699 msgid "(Added in 1.5.21)"
12703 #: ../src/guestfs-actions.pod:4885
12704 msgid "guestfs_pvcreate"
12708 #: ../src/guestfs-actions.pod:4887
12712 " guestfs_pvcreate (guestfs_h *g,\n"
12713 " const char *device);\n"
12718 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12720 "This creates an LVM physical volume on the named C<device>, where C<device> "
12721 "should usually be a partition name such as C</dev/sda1>."
12725 #: ../src/guestfs-actions.pod:4899
12726 msgid "guestfs_pvremove"
12730 #: ../src/guestfs-actions.pod:4901
12734 " guestfs_pvremove (guestfs_h *g,\n"
12735 " const char *device);\n"
12740 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12742 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12747 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12749 "The implementation uses the C<pvremove> command which refuses to wipe "
12750 "physical volumes that contain any volume groups, so you have to remove those "
12755 #: ../src/guestfs-actions.pod:4916
12756 msgid "guestfs_pvresize"
12760 #: ../src/guestfs-actions.pod:4918
12764 " guestfs_pvresize (guestfs_h *g,\n"
12765 " const char *device);\n"
12770 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12772 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12773 "the new size of the underlying device."
12777 #: ../src/guestfs-actions.pod:4929
12778 msgid "guestfs_pvresize_size"
12782 #: ../src/guestfs-actions.pod:4931
12786 " guestfs_pvresize_size (guestfs_h *g,\n"
12787 " const char *device,\n"
12788 " int64_t size);\n"
12793 #: ../src/guestfs-actions.pod:4936
12795 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12796 "specify the new size (in bytes) explicitly."
12800 #: ../src/guestfs-actions.pod:4943
12801 msgid "guestfs_pvs"
12805 #: ../src/guestfs-actions.pod:4945
12809 " guestfs_pvs (guestfs_h *g);\n"
12814 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12816 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12821 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12823 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12828 #: ../src/guestfs-actions.pod:4954
12829 msgid "See also C<guestfs_pvs_full>."
12833 #: ../src/guestfs-actions.pod:4962
12834 msgid "guestfs_pvs_full"
12838 #: ../src/guestfs-actions.pod:4964
12841 " struct guestfs_lvm_pv_list *\n"
12842 " guestfs_pvs_full (guestfs_h *g);\n"
12847 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12849 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12850 "(8)> command. The \"full\" version includes all fields."
12854 #: ../src/guestfs-actions.pod:4970
12856 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12857 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12861 #: ../src/guestfs-actions.pod:4976
12862 msgid "guestfs_pvuuid"
12866 #: ../src/guestfs-actions.pod:4978
12870 " guestfs_pvuuid (guestfs_h *g,\n"
12871 " const char *device);\n"
12876 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12877 msgid "This command returns the UUID of the LVM PV C<device>."
12881 #: ../src/guestfs-actions.pod:4989
12882 msgid "guestfs_pwrite"
12886 #: ../src/guestfs-actions.pod:4991
12890 " guestfs_pwrite (guestfs_h *g,\n"
12891 " const char *path,\n"
12892 " const char *content,\n"
12893 " size_t content_size,\n"
12894 " int64_t offset);\n"
12899 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12901 "This command writes to part of a file. It writes the data buffer C<content> "
12902 "to the file C<path> starting at offset C<offset>."
12906 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12908 "This command implements the L<pwrite(2)> system call, and like that system "
12909 "call it may not write the full data requested. The return value is the "
12910 "number of bytes that were actually written to the file. This could even be "
12911 "0, although short writes are unlikely for regular files in ordinary "
12916 #: ../src/guestfs-actions.pod:5007
12917 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12921 #: ../src/guestfs-actions.pod:5016
12922 msgid "guestfs_pwrite_device"
12926 #: ../src/guestfs-actions.pod:5018
12930 " guestfs_pwrite_device (guestfs_h *g,\n"
12931 " const char *device,\n"
12932 " const char *content,\n"
12933 " size_t content_size,\n"
12934 " int64_t offset);\n"
12939 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12941 "This command writes to part of a device. It writes the data buffer "
12942 "C<content> to C<device> starting at offset C<offset>."
12946 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12948 "This command implements the L<pwrite(2)> system call, and like that system "
12949 "call it may not write the full data requested (although short writes to disk "
12950 "devices and partitions are probably impossible with standard Linux kernels)."
12954 #: ../src/guestfs-actions.pod:5033
12955 msgid "See also C<guestfs_pwrite>."
12959 #: ../src/guestfs-actions.pod:5040
12960 msgid "(Added in 1.5.20)"
12964 #: ../src/guestfs-actions.pod:5042
12965 msgid "guestfs_read_file"
12969 #: ../src/guestfs-actions.pod:5044
12973 " guestfs_read_file (guestfs_h *g,\n"
12974 " const char *path,\n"
12975 " size_t *size_r);\n"
12980 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12981 msgid "This calls returns the contents of the file C<path> as a buffer."
12985 #: ../src/guestfs-actions.pod:5052
12987 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12988 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12989 "function is limited in the total size of file that can be handled."
12993 #: ../src/guestfs-actions.pod:5064
12994 msgid "(Added in 1.0.63)"
12998 #: ../src/guestfs-actions.pod:5066
12999 msgid "guestfs_read_lines"
13003 #: ../src/guestfs-actions.pod:5068
13007 " guestfs_read_lines (guestfs_h *g,\n"
13008 " const char *path);\n"
13013 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
13015 "The file contents are returned as a list of lines. Trailing C<LF> and "
13016 "C<CRLF> character sequences are I<not> returned."
13020 #: ../src/guestfs-actions.pod:5077
13022 "Note that this function cannot correctly handle binary files (specifically, "
13023 "files containing C<\\0> character which is treated as end of line). For "
13024 "those you need to use the C<guestfs_read_file> function which has a more "
13025 "complex interface."
13029 #: ../src/guestfs-actions.pod:5088
13030 msgid "guestfs_readdir"
13034 #: ../src/guestfs-actions.pod:5090
13037 " struct guestfs_dirent_list *\n"
13038 " guestfs_readdir (guestfs_h *g,\n"
13039 " const char *dir);\n"
13044 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
13045 msgid "This returns the list of directory entries in directory C<dir>."
13049 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
13051 "All entries in the directory are returned, including C<.> and C<..>. The "
13052 "entries are I<not> sorted, but returned in the same order as the underlying "
13057 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
13059 "Also this call returns basic file type information about each file. The "
13060 "C<ftyp> field will contain one of the following characters:"
13064 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
13069 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
13070 msgid "Block special"
13074 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
13079 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
13080 msgid "Char special"
13084 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
13089 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
13094 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
13099 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
13100 msgid "FIFO (named pipe)"
13104 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
13109 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
13110 msgid "Symbolic link"
13114 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
13119 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
13120 msgid "Regular file"
13124 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
13129 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
13134 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
13139 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
13140 msgid "Unknown file type"
13144 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
13149 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
13151 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13155 #: ../src/guestfs-actions.pod:5144
13157 "This function is primarily intended for use by programs. To get a simple "
13158 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13159 "consumption, use C<guestfs_ll>."
13163 #: ../src/guestfs-actions.pod:5148
13165 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13166 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13170 #: ../src/guestfs-actions.pod:5154
13171 msgid "guestfs_readlink"
13175 #: ../src/guestfs-actions.pod:5156
13179 " guestfs_readlink (guestfs_h *g,\n"
13180 " const char *path);\n"
13185 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
13186 msgid "This command reads the target of a symbolic link."
13190 #: ../src/guestfs-actions.pod:5167
13191 msgid "guestfs_readlinklist"
13195 #: ../src/guestfs-actions.pod:5169
13199 " guestfs_readlinklist (guestfs_h *g,\n"
13200 " const char *path,\n"
13201 " char *const *names);\n"
13206 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
13208 "This call allows you to do a C<readlink> operation on multiple files, where "
13209 "all files are in the directory C<path>. C<names> is the list of files from "
13214 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
13216 "On return you get a list of strings, with a one-to-one correspondence to the "
13217 "C<names> list. Each string is the value of the symbolic link."
13221 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
13223 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13224 "result string is the empty string C<\"\">. However the whole operation is "
13225 "completed even if there were C<readlink(2)> errors, and so you can call this "
13226 "function with names where you don't know if they are symbolic links already "
13227 "(albeit slightly less efficient)."
13231 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
13233 "This call is intended for programs that want to efficiently list a directory "
13234 "contents without making many round-trips. Very long directory listings "
13235 "might cause the protocol message size to be exceeded, causing this call to "
13236 "fail. The caller must split up such requests into smaller groups of names."
13240 #: ../src/guestfs-actions.pod:5202
13241 msgid "guestfs_realpath"
13245 #: ../src/guestfs-actions.pod:5204
13249 " guestfs_realpath (guestfs_h *g,\n"
13250 " const char *path);\n"
13255 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
13257 "Return the canonicalized absolute pathname of C<path>. The returned path "
13258 "has no C<.>, C<..> or symbolic link path elements."
13262 #: ../src/guestfs-actions.pod:5216
13263 msgid "guestfs_removexattr"
13267 #: ../src/guestfs-actions.pod:5218
13271 " guestfs_removexattr (guestfs_h *g,\n"
13272 " const char *xattr,\n"
13273 " const char *path);\n"
13278 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
13280 "This call removes the extended attribute named C<xattr> of the file C<path>."
13284 #: ../src/guestfs-actions.pod:5226
13285 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13289 #: ../src/guestfs-actions.pod:5232
13290 msgid "guestfs_resize2fs"
13294 #: ../src/guestfs-actions.pod:5234
13298 " guestfs_resize2fs (guestfs_h *g,\n"
13299 " const char *device);\n"
13304 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
13306 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13307 "underlying device."
13311 #: ../src/guestfs-actions.pod:5241
13313 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13314 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13315 "sometimes gives an error about this and sometimes not. In any case, it is "
13316 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13320 #: ../src/guestfs-actions.pod:5251
13321 msgid "guestfs_resize2fs_size"
13325 #: ../src/guestfs-actions.pod:5253
13329 " guestfs_resize2fs_size (guestfs_h *g,\n"
13330 " const char *device,\n"
13331 " int64_t size);\n"
13336 #: ../src/guestfs-actions.pod:5258
13338 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13339 "to specify the new size (in bytes) explicitly."
13343 #: ../src/guestfs-actions.pod:5265
13348 #: ../src/guestfs-actions.pod:5267
13352 " guestfs_rm (guestfs_h *g,\n"
13353 " const char *path);\n"
13358 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
13359 msgid "Remove the single file C<path>."
13363 #: ../src/guestfs-actions.pod:5277
13364 msgid "guestfs_rm_rf"
13368 #: ../src/guestfs-actions.pod:5279
13372 " guestfs_rm_rf (guestfs_h *g,\n"
13373 " const char *path);\n"
13378 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
13380 "Remove the file or directory C<path>, recursively removing the contents if "
13381 "its a directory. This is like the C<rm -rf> shell command."
13385 #: ../src/guestfs-actions.pod:5291
13386 msgid "guestfs_rmdir"
13390 #: ../src/guestfs-actions.pod:5293
13394 " guestfs_rmdir (guestfs_h *g,\n"
13395 " const char *path);\n"
13400 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
13401 msgid "Remove the single directory C<path>."
13405 #: ../src/guestfs-actions.pod:5303
13406 msgid "guestfs_rmmountpoint"
13410 #: ../src/guestfs-actions.pod:5305
13414 " guestfs_rmmountpoint (guestfs_h *g,\n"
13415 " const char *exemptpath);\n"
13420 #: ../src/guestfs-actions.pod:5309
13422 "This calls removes a mountpoint that was previously created with "
13423 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13427 #: ../src/guestfs-actions.pod:5317
13428 msgid "guestfs_scrub_device"
13432 #: ../src/guestfs-actions.pod:5319
13436 " guestfs_scrub_device (guestfs_h *g,\n"
13437 " const char *device);\n"
13442 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
13444 "This command writes patterns over C<device> to make data retrieval more "
13449 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347
13450 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564
13451 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13453 "It is an interface to the L<scrub(1)> program. See that manual page for "
13458 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352
13459 #: ../src/guestfs-actions.pod:5371
13460 msgid "(Added in 1.0.52)"
13464 #: ../src/guestfs-actions.pod:5336
13465 msgid "guestfs_scrub_file"
13469 #: ../src/guestfs-actions.pod:5338
13473 " guestfs_scrub_file (guestfs_h *g,\n"
13474 " const char *file);\n"
13479 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13481 "This command writes patterns over a file to make data retrieval more "
13486 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13487 msgid "The file is I<removed> after scrubbing."
13491 #: ../src/guestfs-actions.pod:5354
13492 msgid "guestfs_scrub_freespace"
13496 #: ../src/guestfs-actions.pod:5356
13500 " guestfs_scrub_freespace (guestfs_h *g,\n"
13501 " const char *dir);\n"
13506 #: ../src/guestfs-actions.pod:5360
13508 "This command creates the directory C<dir> and then fills it with files until "
13509 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13510 "and deletes them. The intention is to scrub any free space on the partition "
13511 "containing C<dir>."
13515 #: ../src/guestfs-actions.pod:5373
13516 msgid "guestfs_set_append"
13520 #: ../src/guestfs-actions.pod:5375
13524 " guestfs_set_append (guestfs_h *g,\n"
13525 " const char *append);\n"
13530 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13532 "This function is used to add additional options to the guest kernel command "
13537 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13539 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13540 "environment variable."
13544 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13546 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13547 "(libguestfs always adds a few of its own)."
13551 #: ../src/guestfs-actions.pod:5392
13552 msgid "guestfs_set_autosync"
13556 #: ../src/guestfs-actions.pod:5394
13560 " guestfs_set_autosync (guestfs_h *g,\n"
13561 " int autosync);\n"
13566 #: ../src/guestfs-actions.pod:5398
13568 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13569 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13570 "the handle is closed (also if the program exits without closing handles)."
13574 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13576 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13577 "disabled by default)."
13581 #: ../src/guestfs-actions.pod:5410
13582 msgid "guestfs_set_direct"
13586 #: ../src/guestfs-actions.pod:5412
13590 " guestfs_set_direct (guestfs_h *g,\n"
13596 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13598 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13599 "passed directly through to the appliance once it is launched."
13603 #: ../src/guestfs-actions.pod:5420
13605 "One consequence of this is that log messages aren't caught by the library "
13606 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13611 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13612 msgid "You probably don't want to use this unless you know what you are doing."
13616 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13617 msgid "The default is disabled."
13621 #: ../src/guestfs-actions.pod:5433
13622 msgid "guestfs_set_e2label"
13626 #: ../src/guestfs-actions.pod:5435
13630 " guestfs_set_e2label (guestfs_h *g,\n"
13631 " const char *device,\n"
13632 " const char *label);\n"
13637 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13639 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13640 "C<label>. Filesystem labels are limited to 16 characters."
13644 #: ../src/guestfs-actions.pod:5444
13646 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13647 "the existing label on a filesystem."
13651 #: ../src/guestfs-actions.pod:5451
13652 msgid "guestfs_set_e2uuid"
13656 #: ../src/guestfs-actions.pod:5453
13660 " guestfs_set_e2uuid (guestfs_h *g,\n"
13661 " const char *device,\n"
13662 " const char *uuid);\n"
13667 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13669 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13670 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13671 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13675 #: ../src/guestfs-actions.pod:5463
13677 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13678 "the existing UUID of a filesystem."
13682 #: ../src/guestfs-actions.pod:5470
13683 msgid "guestfs_set_memsize"
13687 #: ../src/guestfs-actions.pod:5472
13691 " guestfs_set_memsize (guestfs_h *g,\n"
13697 #: ../src/guestfs-actions.pod:5476
13699 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13700 "This only has any effect if called before C<guestfs_launch>."
13704 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13706 "You can also change this by setting the environment variable "
13707 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13711 #: ../src/guestfs-actions.pod:5491
13712 msgid "guestfs_set_network"
13716 #: ../src/guestfs-actions.pod:5493
13720 " guestfs_set_network (guestfs_h *g,\n"
13726 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13728 "If C<network> is true, then the network is enabled in the libguestfs "
13729 "appliance. The default is false."
13733 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13735 "This affects whether commands are able to access the network (see L<guestfs"
13736 "(3)/RUNNING COMMANDS>)."
13740 #: ../src/guestfs-actions.pod:5503
13742 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13747 #: ../src/guestfs-actions.pod:5510
13748 msgid "guestfs_set_path"
13752 #: ../src/guestfs-actions.pod:5512
13756 " guestfs_set_path (guestfs_h *g,\n"
13757 " const char *searchpath);\n"
13762 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13763 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13767 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13769 "The default is C<$libdir/guestfs> unless overridden by setting "
13770 "C<LIBGUESTFS_PATH> environment variable."
13774 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13775 msgid "Setting C<path> to C<NULL> restores the default path."
13779 #: ../src/guestfs-actions.pod:5527
13780 msgid "guestfs_set_qemu"
13784 #: ../src/guestfs-actions.pod:5529
13788 " guestfs_set_qemu (guestfs_h *g,\n"
13789 " const char *qemu);\n"
13794 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13795 msgid "Set the qemu binary that we will use."
13799 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13801 "The default is chosen when the library was compiled by the configure script."
13805 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13807 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13812 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13813 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13817 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13819 "Note that you should call this function as early as possible after creating "
13820 "the handle. This is because some pre-launch operations depend on testing "
13821 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13822 "don't retest features, and so you might see inconsistent results. Using the "
13823 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13824 "the qemu binary at the same time as the handle is created."
13828 #: ../src/guestfs-actions.pod:5555
13829 msgid "guestfs_set_recovery_proc"
13833 #: ../src/guestfs-actions.pod:5557
13837 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13838 " int recoveryproc);\n"
13843 #: ../src/guestfs-actions.pod:5561
13845 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13846 "not create a recovery process. The purpose of the recovery process is to "
13847 "stop runaway qemu processes in the case where the main program aborts "
13852 #: ../src/guestfs-actions.pod:5566
13854 "This only has any effect if called before C<guestfs_launch>, and the default "
13859 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13861 "About the only time when you would want to disable this is if the main "
13862 "process will fork itself into the background (\"daemonize\" itself). In "
13863 "this case the recovery process thinks that the main program has disappeared "
13864 "and so kills qemu, which is not very helpful."
13868 #: ../src/guestfs-actions.pod:5579
13869 msgid "guestfs_set_selinux"
13873 #: ../src/guestfs-actions.pod:5581
13877 " guestfs_set_selinux (guestfs_h *g,\n"
13883 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13885 "This sets the selinux flag that is passed to the appliance at boot time. "
13886 "The default is C<selinux=0> (disabled)."
13890 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13892 "Note that if SELinux is enabled, it is always in Permissive mode "
13893 "(C<enforcing=0>)."
13897 #: ../src/guestfs-actions.pod:5598
13898 msgid "guestfs_set_trace"
13902 #: ../src/guestfs-actions.pod:5600
13906 " guestfs_set_trace (guestfs_h *g,\n"
13912 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13914 "If the command trace flag is set to 1, then commands are printed on stderr "
13915 "before they are executed in a format which is very similar to the one used "
13916 "by guestfish. In other words, you can run a program with this enabled, and "
13917 "you will get out a script which you can feed to guestfish to perform the "
13918 "same set of actions."
13922 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13924 "If you want to trace C API calls into libguestfs (and other libraries) then "
13925 "possibly a better way is to use the external ltrace(1) command."
13929 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13931 "Command traces are disabled unless the environment variable "
13932 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13936 #: ../src/guestfs-actions.pod:5622
13937 msgid "guestfs_set_verbose"
13941 #: ../src/guestfs-actions.pod:5624
13945 " guestfs_set_verbose (guestfs_h *g,\n"
13951 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13952 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13956 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13958 "Verbose messages are disabled unless the environment variable "
13959 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13963 #: ../src/guestfs-actions.pod:5637
13964 msgid "guestfs_setcon"
13968 #: ../src/guestfs-actions.pod:5639
13972 " guestfs_setcon (guestfs_h *g,\n"
13973 " const char *context);\n"
13978 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13980 "This sets the SELinux security context of the daemon to the string "
13985 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13986 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13990 #: ../src/guestfs-actions.pod:5652
13991 msgid "guestfs_setxattr"
13995 #: ../src/guestfs-actions.pod:5654
13999 " guestfs_setxattr (guestfs_h *g,\n"
14000 " const char *xattr,\n"
14001 " const char *val,\n"
14003 " const char *path);\n"
14008 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
14010 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14011 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14015 #: ../src/guestfs-actions.pod:5665
14016 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14020 #: ../src/guestfs-actions.pod:5671
14021 msgid "guestfs_sfdisk"
14025 #: ../src/guestfs-actions.pod:5673
14029 " guestfs_sfdisk (guestfs_h *g,\n"
14030 " const char *device,\n"
14034 " char *const *lines);\n"
14039 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
14041 "This is a direct interface to the L<sfdisk(8)> program for creating "
14042 "partitions on block devices."
14046 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
14047 msgid "C<device> should be a block device, for example C</dev/sda>."
14051 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
14053 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14054 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14055 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14056 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14057 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14058 "the kernel) cannot work out the right geometry and you will need to tell it."
14062 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
14064 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14065 "refer to the L<sfdisk(8)> manpage."
14069 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
14071 "To create a single partition occupying the whole disk, you would pass "
14072 "C<lines> as a single element list, when the single element being the string "
14077 #: ../src/guestfs-actions.pod:5701
14079 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14083 #: ../src/guestfs-actions.pod:5711
14084 msgid "guestfs_sfdiskM"
14088 #: ../src/guestfs-actions.pod:5713
14092 " guestfs_sfdiskM (guestfs_h *g,\n"
14093 " const char *device,\n"
14094 " char *const *lines);\n"
14099 #: ../src/guestfs-actions.pod:5718
14101 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14102 "partition sizes are specified in megabytes only (rounded to the nearest "
14103 "cylinder) and you don't need to specify the cyls, heads and sectors "
14104 "parameters which were rarely if ever used anyway."
14108 #: ../src/guestfs-actions.pod:5724
14110 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14111 "C<guestfs_part_disk>"
14115 #: ../src/guestfs-actions.pod:5734
14116 msgid "guestfs_sfdisk_N"
14120 #: ../src/guestfs-actions.pod:5736
14124 " guestfs_sfdisk_N (guestfs_h *g,\n"
14125 " const char *device,\n"
14130 " const char *line);\n"
14135 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
14137 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14138 "(note: C<n> counts from 1)."
14142 #: ../src/guestfs-actions.pod:5748
14144 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14145 "for the cyls/heads/sectors parameters."
14149 #: ../src/guestfs-actions.pod:5751
14150 msgid "See also: C<guestfs_part_add>"
14154 #: ../src/guestfs-actions.pod:5760
14155 msgid "guestfs_sfdisk_disk_geometry"
14159 #: ../src/guestfs-actions.pod:5762
14163 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14164 " const char *device);\n"
14169 #: ../src/guestfs-actions.pod:5766
14171 "This displays the disk geometry of C<device> read from the partition table. "
14172 "Especially in the case where the underlying block device has been resized, "
14173 "this can be different from the kernel's idea of the geometry (see "
14174 "C<guestfs_sfdisk_kernel_geometry>)."
14178 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787
14179 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14180 msgid "The result is in human-readable format, and not designed to be parsed."
14184 #: ../src/guestfs-actions.pod:5779
14185 msgid "guestfs_sfdisk_kernel_geometry"
14189 #: ../src/guestfs-actions.pod:5781
14193 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14194 " const char *device);\n"
14199 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
14200 msgid "This displays the kernel's idea of the geometry of C<device>."
14204 #: ../src/guestfs-actions.pod:5795
14205 msgid "guestfs_sfdisk_l"
14209 #: ../src/guestfs-actions.pod:5797
14213 " guestfs_sfdisk_l (guestfs_h *g,\n"
14214 " const char *device);\n"
14219 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
14221 "This displays the partition table on C<device>, in the human-readable output "
14222 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14226 #: ../src/guestfs-actions.pod:5805
14227 msgid "See also: C<guestfs_part_list>"
14231 #: ../src/guestfs-actions.pod:5812
14236 #: ../src/guestfs-actions.pod:5814
14240 " guestfs_sh (guestfs_h *g,\n"
14241 " const char *command);\n"
14246 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
14248 "This call runs a command from the guest filesystem via the guest's C</bin/"
14253 #: ../src/guestfs-actions.pod:5821
14254 msgid "This is like C<guestfs_command>, but passes the command to:"
14258 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
14261 " /bin/sh -c \"command\"\n"
14266 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
14268 "Depending on the guest's shell, this usually results in wildcards being "
14269 "expanded, shell expressions being interpolated and so on."
14273 #: ../src/guestfs-actions.pod:5829
14274 msgid "All the provisos about C<guestfs_command> apply to this call."
14278 #: ../src/guestfs-actions.pod:5836
14279 msgid "guestfs_sh_lines"
14283 #: ../src/guestfs-actions.pod:5838
14287 " guestfs_sh_lines (guestfs_h *g,\n"
14288 " const char *command);\n"
14293 #: ../src/guestfs-actions.pod:5842
14295 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14300 #: ../src/guestfs-actions.pod:5845
14301 msgid "See also: C<guestfs_command_lines>"
14305 #: ../src/guestfs-actions.pod:5853
14306 msgid "guestfs_sleep"
14310 #: ../src/guestfs-actions.pod:5855
14314 " guestfs_sleep (guestfs_h *g,\n"
14320 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
14321 msgid "Sleep for C<secs> seconds."
14325 #: ../src/guestfs-actions.pod:5863
14326 msgid "(Added in 1.0.41)"
14330 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
14331 msgid "guestfs_stat"
14335 #: ../src/guestfs-actions.pod:5867
14338 " struct guestfs_stat *\n"
14339 " guestfs_stat (guestfs_h *g,\n"
14340 " const char *path);\n"
14345 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
14346 msgid "This is the same as the C<stat(2)> system call."
14350 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
14351 msgid "guestfs_statvfs"
14355 #: ../src/guestfs-actions.pod:5883
14358 " struct guestfs_statvfs *\n"
14359 " guestfs_statvfs (guestfs_h *g,\n"
14360 " const char *path);\n"
14365 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
14367 "Returns file system statistics for any mounted file system. C<path> should "
14368 "be a file or directory in the mounted file system (typically it is the mount "
14369 "point itself, but it doesn't need to be)."
14373 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
14374 msgid "This is the same as the C<statvfs(2)> system call."
14378 #: ../src/guestfs-actions.pod:5893
14380 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14381 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14385 #: ../src/guestfs-actions.pod:5899
14386 msgid "guestfs_strings"
14390 #: ../src/guestfs-actions.pod:5901
14394 " guestfs_strings (guestfs_h *g,\n"
14395 " const char *path);\n"
14400 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
14402 "This runs the L<strings(1)> command on a file and returns the list of "
14403 "printable strings found."
14407 #: ../src/guestfs-actions.pod:5917
14408 msgid "guestfs_strings_e"
14412 #: ../src/guestfs-actions.pod:5919
14416 " guestfs_strings_e (guestfs_h *g,\n"
14417 " const char *encoding,\n"
14418 " const char *path);\n"
14423 #: ../src/guestfs-actions.pod:5924
14425 "This is like the C<guestfs_strings> command, but allows you to specify the "
14426 "encoding of strings that are looked for in the source file C<path>."
14430 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
14431 msgid "Allowed encodings are:"
14435 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
14440 #: ../src/guestfs-actions.pod:5934
14442 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14443 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14447 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
14452 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
14453 msgid "Single 8-bit-byte characters."
14457 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
14462 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
14463 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14467 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
14468 msgid "l (lower case letter L)"
14472 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
14474 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14475 "examining binaries in Windows guests."
14479 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14484 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14485 msgid "32-bit big endian such as UCS-4BE."
14489 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14494 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14495 msgid "32-bit little endian such as UCS-4LE."
14499 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14500 msgid "The returned strings are transcoded to UTF-8."
14504 #: ../src/guestfs-actions.pod:5972
14505 msgid "guestfs_swapoff_device"
14509 #: ../src/guestfs-actions.pod:5974
14513 " guestfs_swapoff_device (guestfs_h *g,\n"
14514 " const char *device);\n"
14519 #: ../src/guestfs-actions.pod:5978
14521 "This command disables the libguestfs appliance swap device or partition "
14522 "named C<device>. See C<guestfs_swapon_device>."
14526 #: ../src/guestfs-actions.pod:5986
14527 msgid "guestfs_swapoff_file"
14531 #: ../src/guestfs-actions.pod:5988
14535 " guestfs_swapoff_file (guestfs_h *g,\n"
14536 " const char *file);\n"
14541 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14542 msgid "This command disables the libguestfs appliance swap on file."
14546 #: ../src/guestfs-actions.pod:5998
14547 msgid "guestfs_swapoff_label"
14551 #: ../src/guestfs-actions.pod:6000
14555 " guestfs_swapoff_label (guestfs_h *g,\n"
14556 " const char *label);\n"
14561 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14563 "This command disables the libguestfs appliance swap on labeled swap "
14568 #: ../src/guestfs-actions.pod:6011
14569 msgid "guestfs_swapoff_uuid"
14573 #: ../src/guestfs-actions.pod:6013
14577 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14578 " const char *uuid);\n"
14583 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14585 "This command disables the libguestfs appliance swap partition with the given "
14590 #: ../src/guestfs-actions.pod:6024
14591 msgid "guestfs_swapon_device"
14595 #: ../src/guestfs-actions.pod:6026
14599 " guestfs_swapon_device (guestfs_h *g,\n"
14600 " const char *device);\n"
14605 #: ../src/guestfs-actions.pod:6030
14607 "This command enables the libguestfs appliance to use the swap device or "
14608 "partition named C<device>. The increased memory is made available for all "
14609 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14613 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14615 "Note that you should not swap to existing guest swap partitions unless you "
14616 "know what you are doing. They may contain hibernation information, or other "
14617 "information that the guest doesn't want you to trash. You also risk leaking "
14618 "information about the host to the guest this way. Instead, attach a new "
14619 "host device to the guest and swap on that."
14623 #: ../src/guestfs-actions.pod:6046
14624 msgid "guestfs_swapon_file"
14628 #: ../src/guestfs-actions.pod:6048
14632 " guestfs_swapon_file (guestfs_h *g,\n"
14633 " const char *file);\n"
14638 #: ../src/guestfs-actions.pod:6052
14640 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14645 #: ../src/guestfs-actions.pod:6059
14646 msgid "guestfs_swapon_label"
14650 #: ../src/guestfs-actions.pod:6061
14654 " guestfs_swapon_label (guestfs_h *g,\n"
14655 " const char *label);\n"
14660 #: ../src/guestfs-actions.pod:6065
14662 "This command enables swap to a labeled swap partition. See "
14663 "C<guestfs_swapon_device> for other notes."
14667 #: ../src/guestfs-actions.pod:6072
14668 msgid "guestfs_swapon_uuid"
14672 #: ../src/guestfs-actions.pod:6074
14676 " guestfs_swapon_uuid (guestfs_h *g,\n"
14677 " const char *uuid);\n"
14682 #: ../src/guestfs-actions.pod:6078
14684 "This command enables swap to a swap partition with the given UUID. See "
14685 "C<guestfs_swapon_device> for other notes."
14689 #: ../src/guestfs-actions.pod:6085
14690 msgid "guestfs_sync"
14694 #: ../src/guestfs-actions.pod:6087
14698 " guestfs_sync (guestfs_h *g);\n"
14703 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14705 "This syncs the disk, so that any writes are flushed through to the "
14706 "underlying disk image."
14710 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14712 "You should always call this if you have modified a disk image, before "
14713 "closing the handle."
14717 #: ../src/guestfs-actions.pod:6100
14718 msgid "guestfs_tail"
14722 #: ../src/guestfs-actions.pod:6102
14726 " guestfs_tail (guestfs_h *g,\n"
14727 " const char *path);\n"
14732 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14734 "This command returns up to the last 10 lines of a file as a list of strings."
14738 #: ../src/guestfs-actions.pod:6118
14739 msgid "guestfs_tail_n"
14743 #: ../src/guestfs-actions.pod:6120
14747 " guestfs_tail_n (guestfs_h *g,\n"
14749 " const char *path);\n"
14754 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14756 "If the parameter C<nrlines> is a positive number, this returns the last "
14757 "C<nrlines> lines of the file C<path>."
14761 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14763 "If the parameter C<nrlines> is a negative number, this returns lines from "
14764 "the file C<path>, starting with the C<-nrlines>th line."
14768 #: ../src/guestfs-actions.pod:6142
14769 msgid "guestfs_tar_in"
14773 #: ../src/guestfs-actions.pod:6144
14777 " guestfs_tar_in (guestfs_h *g,\n"
14778 " const char *tarfile,\n"
14779 " const char *directory);\n"
14784 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14786 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14787 "tar file) into C<directory>."
14791 #: ../src/guestfs-actions.pod:6152
14793 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14797 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174
14798 #: ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14799 msgid "(Added in 1.0.3)"
14803 #: ../src/guestfs-actions.pod:6159
14804 msgid "guestfs_tar_out"
14808 #: ../src/guestfs-actions.pod:6161
14812 " guestfs_tar_out (guestfs_h *g,\n"
14813 " const char *directory,\n"
14814 " const char *tarfile);\n"
14819 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14821 "This command packs the contents of C<directory> and downloads it to local "
14826 #: ../src/guestfs-actions.pod:6169
14828 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14829 "C<guestfs_txz_out>."
14833 #: ../src/guestfs-actions.pod:6176
14834 msgid "guestfs_tgz_in"
14838 #: ../src/guestfs-actions.pod:6178
14842 " guestfs_tgz_in (guestfs_h *g,\n"
14843 " const char *tarball,\n"
14844 " const char *directory);\n"
14849 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14851 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14852 "tar file) into C<directory>."
14856 #: ../src/guestfs-actions.pod:6186
14857 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14861 #: ../src/guestfs-actions.pod:6192
14862 msgid "guestfs_tgz_out"
14866 #: ../src/guestfs-actions.pod:6194
14870 " guestfs_tgz_out (guestfs_h *g,\n"
14871 " const char *directory,\n"
14872 " const char *tarball);\n"
14877 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14879 "This command packs the contents of C<directory> and downloads it to local "
14884 #: ../src/guestfs-actions.pod:6202
14885 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14889 #: ../src/guestfs-actions.pod:6208
14890 msgid "guestfs_touch"
14894 #: ../src/guestfs-actions.pod:6210
14898 " guestfs_touch (guestfs_h *g,\n"
14899 " const char *path);\n"
14904 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14906 "Touch acts like the L<touch(1)> command. It can be used to update the "
14907 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14912 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14914 "This command only works on regular files, and will fail on other file types "
14915 "such as directories, symbolic links, block special etc."
14919 #: ../src/guestfs-actions.pod:6225
14920 msgid "guestfs_truncate"
14924 #: ../src/guestfs-actions.pod:6227
14928 " guestfs_truncate (guestfs_h *g,\n"
14929 " const char *path);\n"
14934 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14936 "This command truncates C<path> to a zero-length file. The file must exist "
14941 #: ../src/guestfs-actions.pod:6238
14942 msgid "guestfs_truncate_size"
14946 #: ../src/guestfs-actions.pod:6240
14950 " guestfs_truncate_size (guestfs_h *g,\n"
14951 " const char *path,\n"
14952 " int64_t size);\n"
14957 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14959 "This command truncates C<path> to size C<size> bytes. The file must exist "
14964 #: ../src/guestfs-actions.pod:6248
14966 "If the current file size is less than C<size> then the file is extended to "
14967 "the required size with zero bytes. This creates a sparse file (ie. disk "
14968 "blocks are not allocated for the file until you write to it). To create a "
14969 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14973 #: ../src/guestfs-actions.pod:6258
14974 msgid "guestfs_tune2fs_l"
14978 #: ../src/guestfs-actions.pod:6260
14982 " guestfs_tune2fs_l (guestfs_h *g,\n"
14983 " const char *device);\n"
14988 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
14990 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14995 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
14997 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14998 "for more details. The list of fields returned isn't clearly defined, and "
14999 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15000 "and the filesystem itself."
15004 #: ../src/guestfs-actions.pod:6280
15005 msgid "guestfs_txz_in"
15009 #: ../src/guestfs-actions.pod:6282
15013 " guestfs_txz_in (guestfs_h *g,\n"
15014 " const char *tarball,\n"
15015 " const char *directory);\n"
15020 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
15022 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15023 "tar file) into C<directory>."
15027 #: ../src/guestfs-actions.pod:6294
15028 msgid "guestfs_txz_out"
15032 #: ../src/guestfs-actions.pod:6296
15036 " guestfs_txz_out (guestfs_h *g,\n"
15037 " const char *directory,\n"
15038 " const char *tarball);\n"
15043 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
15045 "This command packs the contents of C<directory> and downloads it to local "
15046 "file C<tarball> (as an xz compressed tar archive)."
15050 #: ../src/guestfs-actions.pod:6308
15051 msgid "guestfs_umask"
15055 #: ../src/guestfs-actions.pod:6310
15059 " guestfs_umask (guestfs_h *g,\n"
15065 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
15067 "This function sets the mask used for creating new files and device nodes to "
15072 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
15074 "Typical umask values would be C<022> which creates new files with "
15075 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15076 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15080 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
15082 "The default umask is C<022>. This is important because it means that "
15083 "directories and device nodes will be created with C<0644> or C<0755> mode "
15084 "even if you specify C<0777>."
15088 #: ../src/guestfs-actions.pod:6326
15090 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15091 "C<guestfs_mkdir>."
15095 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
15096 msgid "This call returns the previous umask."
15100 #: ../src/guestfs-actions.pod:6335
15101 msgid "guestfs_umount"
15105 #: ../src/guestfs-actions.pod:6337
15109 " guestfs_umount (guestfs_h *g,\n"
15110 " const char *pathordevice);\n"
15115 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
15117 "This unmounts the given filesystem. The filesystem may be specified either "
15118 "by its mountpoint (path) or the device which contains the filesystem."
15122 #: ../src/guestfs-actions.pod:6349
15123 msgid "guestfs_umount_all"
15127 #: ../src/guestfs-actions.pod:6351
15131 " guestfs_umount_all (guestfs_h *g);\n"
15136 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
15137 msgid "This unmounts all mounted filesystems."
15141 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
15142 msgid "Some internal mounts are not unmounted by this call."
15146 #: ../src/guestfs-actions.pod:6362
15147 msgid "guestfs_upload"
15151 #: ../src/guestfs-actions.pod:6364
15155 " guestfs_upload (guestfs_h *g,\n"
15156 " const char *filename,\n"
15157 " const char *remotefilename);\n"
15162 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388
15163 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15164 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15168 #: ../src/guestfs-actions.pod:6374
15169 msgid "See also C<guestfs_download>."
15173 #: ../src/guestfs-actions.pod:6380
15174 msgid "guestfs_upload_offset"
15178 #: ../src/guestfs-actions.pod:6382
15182 " guestfs_upload_offset (guestfs_h *g,\n"
15183 " const char *filename,\n"
15184 " const char *remotefilename,\n"
15185 " int64_t offset);\n"
15190 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
15192 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15193 "The intention is to overwrite parts of existing files or devices, although "
15194 "if a non-existant file is specified then it is created with a \"hole\" "
15195 "before C<offset>. The size of the data written is implicit in the size of "
15196 "the source C<filename>."
15200 #: ../src/guestfs-actions.pod:6398
15202 "Note that there is no limit on the amount of data that can be uploaded with "
15203 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15204 "full amount unless an error occurs."
15208 #: ../src/guestfs-actions.pod:6403
15209 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15213 #: ../src/guestfs-actions.pod:6409
15214 msgid "guestfs_utimens"
15218 #: ../src/guestfs-actions.pod:6411
15222 " guestfs_utimens (guestfs_h *g,\n"
15223 " const char *path,\n"
15224 " int64_t atsecs,\n"
15225 " int64_t atnsecs,\n"
15226 " int64_t mtsecs,\n"
15227 " int64_t mtnsecs);\n"
15232 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
15233 msgid "This command sets the timestamps of a file with nanosecond precision."
15237 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
15239 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15244 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
15246 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15247 "nanoseconds from the epoch."
15251 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
15253 "If the C<*nsecs> field contains the special value C<-1> then the "
15254 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15255 "ignored in this case)."
15259 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
15261 "If the C<*nsecs> field contains the special value C<-2> then the "
15262 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15267 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
15268 msgid "guestfs_version"
15272 #: ../src/guestfs-actions.pod:6442
15275 " struct guestfs_version *\n"
15276 " guestfs_version (guestfs_h *g);\n"
15281 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
15283 "Return the libguestfs version number that the program is linked against."
15287 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
15289 "Note that because of dynamic linking this is not necessarily the version of "
15290 "libguestfs that you compiled against. You can compile the program, and then "
15291 "at runtime dynamically link against a completely different C<libguestfs.so> "
15296 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
15298 "This call was added in version C<1.0.58>. In previous versions of "
15299 "libguestfs there was no way to get the version number. From C code you can "
15300 "use dynamic linker functions to find out if this symbol exists (if it "
15301 "doesn't, then it's an earlier version)."
15305 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
15307 "The call returns a structure with four elements. The first three (C<major>, "
15308 "C<minor> and C<release>) are numbers and correspond to the usual version "
15309 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15310 "but may be used for distro-specific information."
15314 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
15316 "To construct the original version string: C<$major.$minor.$release$extra>"
15320 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
15321 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15325 #: ../src/guestfs-actions.pod:6470
15327 "I<Note:> Don't use this call to test for availability of features. In "
15328 "enterprise distributions we backport features from later versions into "
15329 "earlier versions, making this an unreliable way to test for features. Use "
15330 "C<guestfs_available> instead."
15334 #: ../src/guestfs-actions.pod:6476
15336 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15337 "error. I<The caller must call C<guestfs_free_version> after use>."
15341 #: ../src/guestfs-actions.pod:6480
15342 msgid "(Added in 1.0.58)"
15346 #: ../src/guestfs-actions.pod:6482
15347 msgid "guestfs_vfs_label"
15351 #: ../src/guestfs-actions.pod:6484
15355 " guestfs_vfs_label (guestfs_h *g,\n"
15356 " const char *device);\n"
15361 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
15362 msgid "This returns the filesystem label of the filesystem on C<device>."
15366 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
15367 msgid "If the filesystem is unlabeled, this returns the empty string."
15371 #: ../src/guestfs-actions.pod:6493
15372 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15376 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
15377 msgid "(Added in 1.3.18)"
15381 #: ../src/guestfs-actions.pod:6500
15382 msgid "guestfs_vfs_type"
15386 #: ../src/guestfs-actions.pod:6502
15390 " guestfs_vfs_type (guestfs_h *g,\n"
15391 " const char *device);\n"
15396 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
15398 "This command gets the filesystem type corresponding to the filesystem on "
15403 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
15405 "For most filesystems, the result is the name of the Linux VFS module which "
15406 "would be used to mount this filesystem if you mounted it without specifying "
15407 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15411 #: ../src/guestfs-actions.pod:6519
15412 msgid "guestfs_vfs_uuid"
15416 #: ../src/guestfs-actions.pod:6521
15420 " guestfs_vfs_uuid (guestfs_h *g,\n"
15421 " const char *device);\n"
15426 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
15427 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15431 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
15432 msgid "If the filesystem does not have a UUID, this returns the empty string."
15436 #: ../src/guestfs-actions.pod:6530
15437 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15441 #: ../src/guestfs-actions.pod:6537
15442 msgid "guestfs_vg_activate"
15446 #: ../src/guestfs-actions.pod:6539
15450 " guestfs_vg_activate (guestfs_h *g,\n"
15452 " char *const *volgroups);\n"
15457 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
15459 "This command activates or (if C<activate> is false) deactivates all logical "
15460 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15461 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15462 "deactivated, then those devices disappear."
15466 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
15467 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15471 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
15473 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15474 "activated or deactivated."
15478 #: ../src/guestfs-actions.pod:6559
15479 msgid "guestfs_vg_activate_all"
15483 #: ../src/guestfs-actions.pod:6561
15487 " guestfs_vg_activate_all (guestfs_h *g,\n"
15488 " int activate);\n"
15493 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15495 "This command activates or (if C<activate> is false) deactivates all logical "
15496 "volumes in all volume groups. If activated, then they are made known to the "
15497 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15498 "those devices disappear."
15502 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15503 msgid "This command is the same as running C<vgchange -a y|n>"
15507 #: ../src/guestfs-actions.pod:6577
15508 msgid "guestfs_vgcreate"
15512 #: ../src/guestfs-actions.pod:6579
15516 " guestfs_vgcreate (guestfs_h *g,\n"
15517 " const char *volgroup,\n"
15518 " char *const *physvols);\n"
15523 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15525 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15526 "of physical volumes C<physvols>."
15530 #: ../src/guestfs-actions.pod:6591
15531 msgid "guestfs_vglvuuids"
15535 #: ../src/guestfs-actions.pod:6593
15539 " guestfs_vglvuuids (guestfs_h *g,\n"
15540 " const char *vgname);\n"
15545 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15547 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15548 "volumes created in this volume group."
15552 #: ../src/guestfs-actions.pod:6600
15554 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15555 "associate logical volumes and volume groups."
15559 #: ../src/guestfs-actions.pod:6603
15560 msgid "See also C<guestfs_vgpvuuids>."
15564 #: ../src/guestfs-actions.pod:6611
15565 msgid "guestfs_vgpvuuids"
15569 #: ../src/guestfs-actions.pod:6613
15573 " guestfs_vgpvuuids (guestfs_h *g,\n"
15574 " const char *vgname);\n"
15579 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15581 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15582 "volumes that this volume group resides on."
15586 #: ../src/guestfs-actions.pod:6620
15588 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15589 "associate physical volumes and volume groups."
15593 #: ../src/guestfs-actions.pod:6623
15594 msgid "See also C<guestfs_vglvuuids>."
15598 #: ../src/guestfs-actions.pod:6631
15599 msgid "guestfs_vgremove"
15603 #: ../src/guestfs-actions.pod:6633
15607 " guestfs_vgremove (guestfs_h *g,\n"
15608 " const char *vgname);\n"
15613 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15614 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15618 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15620 "This also forcibly removes all logical volumes in the volume group (if any)."
15624 #: ../src/guestfs-actions.pod:6646
15625 msgid "guestfs_vgrename"
15629 #: ../src/guestfs-actions.pod:6648
15633 " guestfs_vgrename (guestfs_h *g,\n"
15634 " const char *volgroup,\n"
15635 " const char *newvolgroup);\n"
15640 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15641 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15645 #: ../src/guestfs-actions.pod:6659
15646 msgid "guestfs_vgs"
15650 #: ../src/guestfs-actions.pod:6661
15654 " guestfs_vgs (guestfs_h *g);\n"
15659 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15661 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15666 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15668 "This returns a list of just the volume group names that were detected (eg. "
15673 #: ../src/guestfs-actions.pod:6670
15674 msgid "See also C<guestfs_vgs_full>."
15678 #: ../src/guestfs-actions.pod:6678
15679 msgid "guestfs_vgs_full"
15683 #: ../src/guestfs-actions.pod:6680
15686 " struct guestfs_lvm_vg_list *\n"
15687 " guestfs_vgs_full (guestfs_h *g);\n"
15692 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15694 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15695 "> command. The \"full\" version includes all fields."
15699 #: ../src/guestfs-actions.pod:6686
15701 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15702 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15706 #: ../src/guestfs-actions.pod:6692
15707 msgid "guestfs_vgscan"
15711 #: ../src/guestfs-actions.pod:6694
15715 " guestfs_vgscan (guestfs_h *g);\n"
15720 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15722 "This rescans all block devices and rebuilds the list of LVM physical "
15723 "volumes, volume groups and logical volumes."
15727 #: ../src/guestfs-actions.pod:6704
15728 msgid "guestfs_vguuid"
15732 #: ../src/guestfs-actions.pod:6706
15736 " guestfs_vguuid (guestfs_h *g,\n"
15737 " const char *vgname);\n"
15742 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15743 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15747 #: ../src/guestfs-actions.pod:6717
15748 msgid "guestfs_wait_ready"
15752 #: ../src/guestfs-actions.pod:6719
15756 " guestfs_wait_ready (guestfs_h *g);\n"
15761 #: ../src/guestfs-actions.pod:6722
15762 msgid "This function is a no op."
15766 #: ../src/guestfs-actions.pod:6724
15768 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15769 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15770 "is no longer necessary because C<guestfs_launch> now does the waiting."
15774 #: ../src/guestfs-actions.pod:6729
15776 "If you see any calls to this function in code then you can just remove them, "
15777 "unless you want to retain compatibility with older versions of the API."
15781 #: ../src/guestfs-actions.pod:6737
15782 msgid "guestfs_wc_c"
15786 #: ../src/guestfs-actions.pod:6739
15790 " guestfs_wc_c (guestfs_h *g,\n"
15791 " const char *path);\n"
15796 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15798 "This command counts the characters in a file, using the C<wc -c> external "
15803 #: ../src/guestfs-actions.pod:6750
15804 msgid "guestfs_wc_l"
15808 #: ../src/guestfs-actions.pod:6752
15812 " guestfs_wc_l (guestfs_h *g,\n"
15813 " const char *path);\n"
15818 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15820 "This command counts the lines in a file, using the C<wc -l> external command."
15824 #: ../src/guestfs-actions.pod:6763
15825 msgid "guestfs_wc_w"
15829 #: ../src/guestfs-actions.pod:6765
15833 " guestfs_wc_w (guestfs_h *g,\n"
15834 " const char *path);\n"
15839 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15841 "This command counts the words in a file, using the C<wc -w> external command."
15845 #: ../src/guestfs-actions.pod:6776
15846 msgid "guestfs_write"
15850 #: ../src/guestfs-actions.pod:6778
15854 " guestfs_write (guestfs_h *g,\n"
15855 " const char *path,\n"
15856 " const char *content,\n"
15857 " size_t content_size);\n"
15862 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15864 "This call creates a file called C<path>. The content of the file is the "
15865 "string C<content> (which can contain any 8 bit data)."
15869 #: ../src/guestfs-actions.pod:6794
15870 msgid "guestfs_write_file"
15874 #: ../src/guestfs-actions.pod:6796
15878 " guestfs_write_file (guestfs_h *g,\n"
15879 " const char *path,\n"
15880 " const char *content,\n"
15886 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15888 "This call creates a file called C<path>. The contents of the file is the "
15889 "string C<content> (which can contain any 8 bit data), with length C<size>."
15893 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15895 "As a special case, if C<size> is C<0> then the length is calculated using "
15896 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15900 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15902 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15903 "I<not> work, even if the length is specified."
15907 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15909 "This function is deprecated. In new code, use the C<write> call instead."
15913 #: ../src/guestfs-actions.pod:6827
15914 msgid "guestfs_zegrep"
15918 #: ../src/guestfs-actions.pod:6829
15922 " guestfs_zegrep (guestfs_h *g,\n"
15923 " const char *regex,\n"
15924 " const char *path);\n"
15929 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15931 "This calls the external C<zegrep> program and returns the matching lines."
15935 #: ../src/guestfs-actions.pod:6846
15936 msgid "guestfs_zegrepi"
15940 #: ../src/guestfs-actions.pod:6848
15944 " guestfs_zegrepi (guestfs_h *g,\n"
15945 " const char *regex,\n"
15946 " const char *path);\n"
15951 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15953 "This calls the external C<zegrep -i> program and returns the matching lines."
15957 #: ../src/guestfs-actions.pod:6865
15958 msgid "guestfs_zero"
15962 #: ../src/guestfs-actions.pod:6867
15966 " guestfs_zero (guestfs_h *g,\n"
15967 " const char *device);\n"
15972 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15973 msgid "This command writes zeroes over the first few blocks of C<device>."
15977 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15979 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15980 "securely wipe the device). It should be sufficient to remove any partition "
15981 "tables, filesystem superblocks and so on."
15985 #: ../src/guestfs-actions.pod:6877
15986 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15990 #: ../src/guestfs-actions.pod:6888
15991 msgid "guestfs_zero_device"
15995 #: ../src/guestfs-actions.pod:6890
15999 " guestfs_zero_device (guestfs_h *g,\n"
16000 " const char *device);\n"
16005 #: ../src/guestfs-actions.pod:6894
16007 "This command writes zeroes over the entire C<device>. Compare with "
16008 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16012 #: ../src/guestfs-actions.pod:6908
16013 msgid "(Added in 1.3.1)"
16017 #: ../src/guestfs-actions.pod:6910
16018 msgid "guestfs_zerofree"
16022 #: ../src/guestfs-actions.pod:6912
16026 " guestfs_zerofree (guestfs_h *g,\n"
16027 " const char *device);\n"
16032 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
16034 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16035 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16036 "possible to compress the filesystem more effectively."
16040 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
16041 msgid "You should B<not> run this program if the filesystem is mounted."
16045 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
16047 "It is possible that using this program can damage the filesystem or data on "
16052 #: ../src/guestfs-actions.pod:6931
16053 msgid "guestfs_zfgrep"
16057 #: ../src/guestfs-actions.pod:6933
16061 " guestfs_zfgrep (guestfs_h *g,\n"
16062 " const char *pattern,\n"
16063 " const char *path);\n"
16068 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
16070 "This calls the external C<zfgrep> program and returns the matching lines."
16074 #: ../src/guestfs-actions.pod:6950
16075 msgid "guestfs_zfgrepi"
16079 #: ../src/guestfs-actions.pod:6952
16083 " guestfs_zfgrepi (guestfs_h *g,\n"
16084 " const char *pattern,\n"
16085 " const char *path);\n"
16090 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
16092 "This calls the external C<zfgrep -i> program and returns the matching lines."
16096 #: ../src/guestfs-actions.pod:6969
16097 msgid "guestfs_zfile"
16101 #: ../src/guestfs-actions.pod:6971
16105 " guestfs_zfile (guestfs_h *g,\n"
16106 " const char *meth,\n"
16107 " const char *path);\n"
16112 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
16114 "This command runs C<file> after first decompressing C<path> using C<method>."
16118 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
16119 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16123 #: ../src/guestfs-actions.pod:6981
16125 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16130 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
16132 "This function is deprecated. In new code, use the C<file> call instead."
16136 #: ../src/guestfs-actions.pod:6996
16137 msgid "guestfs_zgrep"
16141 #: ../src/guestfs-actions.pod:6998
16145 " guestfs_zgrep (guestfs_h *g,\n"
16146 " const char *regex,\n"
16147 " const char *path);\n"
16152 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
16154 "This calls the external C<zgrep> program and returns the matching lines."
16158 #: ../src/guestfs-actions.pod:7015
16159 msgid "guestfs_zgrepi"
16163 #: ../src/guestfs-actions.pod:7017
16167 " guestfs_zgrepi (guestfs_h *g,\n"
16168 " const char *regex,\n"
16169 " const char *path);\n"
16174 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
16176 "This calls the external C<zgrep -i> program and returns the matching lines."
16180 #: ../src/guestfs-availability.pod:3
16185 #: ../src/guestfs-availability.pod:5
16187 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16188 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16189 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16190 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16191 "L</guestfs_aug_save> L</guestfs_aug_set>"
16195 #: ../src/guestfs-availability.pod:21
16200 #: ../src/guestfs-availability.pod:23
16202 "The following functions: L</guestfs_inotify_add_watch> L</"
16203 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16204 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16208 #: ../src/guestfs-availability.pod:31
16209 msgid "B<linuxfsuuid>"
16213 #: ../src/guestfs-availability.pod:33
16215 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16216 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16220 #: ../src/guestfs-availability.pod:40
16221 msgid "B<linuxmodules>"
16225 #: ../src/guestfs-availability.pod:42
16226 msgid "The following functions: L</guestfs_modprobe>"
16230 #: ../src/guestfs-availability.pod:45
16231 msgid "B<linuxxattrs>"
16235 #: ../src/guestfs-availability.pod:47
16237 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16238 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16239 "guestfs_removexattr> L</guestfs_setxattr>"
16243 #: ../src/guestfs-availability.pod:56
16248 #: ../src/guestfs-availability.pod:58
16250 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16251 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16252 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16256 #: ../src/guestfs-availability.pod:67
16261 #: ../src/guestfs-availability.pod:69
16263 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16264 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16265 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16266 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16267 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16268 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16269 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16273 #: ../src/guestfs-availability.pod:92
16278 #: ../src/guestfs-availability.pod:94
16280 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16281 "guestfs_mknod_b> L</guestfs_mknod_c>"
16285 #: ../src/guestfs-availability.pod:100
16290 #: ../src/guestfs-availability.pod:102
16291 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16295 #: ../src/guestfs-availability.pod:105
16296 msgid "B<ntfsprogs>"
16300 #: ../src/guestfs-availability.pod:107
16302 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16306 #: ../src/guestfs-availability.pod:111
16307 msgid "B<realpath>"
16311 #: ../src/guestfs-availability.pod:113
16312 msgid "The following functions: L</guestfs_realpath>"
16316 #: ../src/guestfs-availability.pod:116
16321 #: ../src/guestfs-availability.pod:118
16323 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16324 "guestfs_scrub_freespace>"
16328 #: ../src/guestfs-availability.pod:123
16333 #: ../src/guestfs-availability.pod:125
16334 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16338 #: ../src/guestfs-availability.pod:129
16343 #: ../src/guestfs-availability.pod:131
16344 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16348 #: ../src/guestfs-availability.pod:135
16349 msgid "B<zerofree>"
16353 #: ../src/guestfs-availability.pod:137
16354 msgid "The following functions: L</guestfs_zerofree>"
16358 #: ../src/guestfs-structs.pod:1
16359 msgid "guestfs_int_bool"
16363 #: ../src/guestfs-structs.pod:3
16366 " struct guestfs_int_bool {\n"
16374 #: ../src/guestfs-structs.pod:8
16377 " struct guestfs_int_bool_list {\n"
16378 " uint32_t len; /* Number of elements in list. */\n"
16379 " struct guestfs_int_bool *val; /* Elements. */\n"
16385 #: ../src/guestfs-structs.pod:13
16388 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16389 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16394 #: ../src/guestfs-structs.pod:16
16395 msgid "guestfs_lvm_pv"
16399 #: ../src/guestfs-structs.pod:18
16402 " struct guestfs_lvm_pv {\n"
16403 " char *pv_name;\n"
16404 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16405 " char pv_uuid[32];\n"
16407 " uint64_t pv_size;\n"
16408 " uint64_t dev_size;\n"
16409 " uint64_t pv_free;\n"
16410 " uint64_t pv_used;\n"
16411 " char *pv_attr;\n"
16412 " int64_t pv_pe_count;\n"
16413 " int64_t pv_pe_alloc_count;\n"
16414 " char *pv_tags;\n"
16415 " uint64_t pe_start;\n"
16416 " int64_t pv_mda_count;\n"
16417 " uint64_t pv_mda_free;\n"
16423 #: ../src/guestfs-structs.pod:36
16426 " struct guestfs_lvm_pv_list {\n"
16427 " uint32_t len; /* Number of elements in list. */\n"
16428 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16434 #: ../src/guestfs-structs.pod:41
16437 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16438 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16443 #: ../src/guestfs-structs.pod:44
16444 msgid "guestfs_lvm_vg"
16448 #: ../src/guestfs-structs.pod:46
16451 " struct guestfs_lvm_vg {\n"
16452 " char *vg_name;\n"
16453 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16454 " char vg_uuid[32];\n"
16456 " char *vg_attr;\n"
16457 " uint64_t vg_size;\n"
16458 " uint64_t vg_free;\n"
16459 " char *vg_sysid;\n"
16460 " uint64_t vg_extent_size;\n"
16461 " int64_t vg_extent_count;\n"
16462 " int64_t vg_free_count;\n"
16463 " int64_t max_lv;\n"
16464 " int64_t max_pv;\n"
16465 " int64_t pv_count;\n"
16466 " int64_t lv_count;\n"
16467 " int64_t snap_count;\n"
16468 " int64_t vg_seqno;\n"
16469 " char *vg_tags;\n"
16470 " int64_t vg_mda_count;\n"
16471 " uint64_t vg_mda_free;\n"
16477 #: ../src/guestfs-structs.pod:69
16480 " struct guestfs_lvm_vg_list {\n"
16481 " uint32_t len; /* Number of elements in list. */\n"
16482 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16488 #: ../src/guestfs-structs.pod:74
16491 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16492 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16497 #: ../src/guestfs-structs.pod:77
16498 msgid "guestfs_lvm_lv"
16502 #: ../src/guestfs-structs.pod:79
16505 " struct guestfs_lvm_lv {\n"
16506 " char *lv_name;\n"
16507 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16508 " char lv_uuid[32];\n"
16509 " char *lv_attr;\n"
16510 " int64_t lv_major;\n"
16511 " int64_t lv_minor;\n"
16512 " int64_t lv_kernel_major;\n"
16513 " int64_t lv_kernel_minor;\n"
16514 " uint64_t lv_size;\n"
16515 " int64_t seg_count;\n"
16517 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16518 " float snap_percent;\n"
16519 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16520 " float copy_percent;\n"
16521 " char *move_pv;\n"
16522 " char *lv_tags;\n"
16523 " char *mirror_log;\n"
16524 " char *modules;\n"
16530 #: ../src/guestfs-structs.pod:101
16533 " struct guestfs_lvm_lv_list {\n"
16534 " uint32_t len; /* Number of elements in list. */\n"
16535 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16541 #: ../src/guestfs-structs.pod:106
16544 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16545 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16550 #: ../src/guestfs-structs.pod:111
16553 " struct guestfs_stat {\n"
16557 " int64_t nlink;\n"
16562 " int64_t blksize;\n"
16563 " int64_t blocks;\n"
16564 " int64_t atime;\n"
16565 " int64_t mtime;\n"
16566 " int64_t ctime;\n"
16572 #: ../src/guestfs-structs.pod:127
16575 " struct guestfs_stat_list {\n"
16576 " uint32_t len; /* Number of elements in list. */\n"
16577 " struct guestfs_stat *val; /* Elements. */\n"
16583 #: ../src/guestfs-structs.pod:132
16586 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16587 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16592 #: ../src/guestfs-structs.pod:137
16595 " struct guestfs_statvfs {\n"
16596 " int64_t bsize;\n"
16597 " int64_t frsize;\n"
16598 " int64_t blocks;\n"
16599 " int64_t bfree;\n"
16600 " int64_t bavail;\n"
16601 " int64_t files;\n"
16602 " int64_t ffree;\n"
16603 " int64_t favail;\n"
16606 " int64_t namemax;\n"
16612 #: ../src/guestfs-structs.pod:151
16615 " struct guestfs_statvfs_list {\n"
16616 " uint32_t len; /* Number of elements in list. */\n"
16617 " struct guestfs_statvfs *val; /* Elements. */\n"
16623 #: ../src/guestfs-structs.pod:156
16626 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16627 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16632 #: ../src/guestfs-structs.pod:159
16633 msgid "guestfs_dirent"
16637 #: ../src/guestfs-structs.pod:161
16640 " struct guestfs_dirent {\n"
16649 #: ../src/guestfs-structs.pod:167
16652 " struct guestfs_dirent_list {\n"
16653 " uint32_t len; /* Number of elements in list. */\n"
16654 " struct guestfs_dirent *val; /* Elements. */\n"
16660 #: ../src/guestfs-structs.pod:172
16663 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16664 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16669 #: ../src/guestfs-structs.pod:177
16672 " struct guestfs_version {\n"
16673 " int64_t major;\n"
16674 " int64_t minor;\n"
16675 " int64_t release;\n"
16682 #: ../src/guestfs-structs.pod:184
16685 " struct guestfs_version_list {\n"
16686 " uint32_t len; /* Number of elements in list. */\n"
16687 " struct guestfs_version *val; /* Elements. */\n"
16693 #: ../src/guestfs-structs.pod:189
16696 " void guestfs_free_version (struct guestfs_free_version *);\n"
16697 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16702 #: ../src/guestfs-structs.pod:192
16703 msgid "guestfs_xattr"
16707 #: ../src/guestfs-structs.pod:194
16710 " struct guestfs_xattr {\n"
16711 " char *attrname;\n"
16712 " /* The next two fields describe a byte array. */\n"
16713 " uint32_t attrval_len;\n"
16714 " char *attrval;\n"
16720 #: ../src/guestfs-structs.pod:201
16723 " struct guestfs_xattr_list {\n"
16724 " uint32_t len; /* Number of elements in list. */\n"
16725 " struct guestfs_xattr *val; /* Elements. */\n"
16731 #: ../src/guestfs-structs.pod:206
16734 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16735 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16740 #: ../src/guestfs-structs.pod:209
16741 msgid "guestfs_inotify_event"
16745 #: ../src/guestfs-structs.pod:211
16748 " struct guestfs_inotify_event {\n"
16749 " int64_t in_wd;\n"
16750 " uint32_t in_mask;\n"
16751 " uint32_t in_cookie;\n"
16752 " char *in_name;\n"
16758 #: ../src/guestfs-structs.pod:218
16761 " struct guestfs_inotify_event_list {\n"
16762 " uint32_t len; /* Number of elements in list. */\n"
16763 " struct guestfs_inotify_event *val; /* Elements. */\n"
16769 #: ../src/guestfs-structs.pod:223
16772 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16773 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16778 #: ../src/guestfs-structs.pod:226
16779 msgid "guestfs_partition"
16783 #: ../src/guestfs-structs.pod:228
16786 " struct guestfs_partition {\n"
16787 " int32_t part_num;\n"
16788 " uint64_t part_start;\n"
16789 " uint64_t part_end;\n"
16790 " uint64_t part_size;\n"
16796 #: ../src/guestfs-structs.pod:235
16799 " struct guestfs_partition_list {\n"
16800 " uint32_t len; /* Number of elements in list. */\n"
16801 " struct guestfs_partition *val; /* Elements. */\n"
16807 #: ../src/guestfs-structs.pod:240
16810 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16811 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16816 #: ../src/guestfs-structs.pod:243
16817 msgid "guestfs_application"
16821 #: ../src/guestfs-structs.pod:245
16824 " struct guestfs_application {\n"
16825 " char *app_name;\n"
16826 " char *app_display_name;\n"
16827 " int32_t app_epoch;\n"
16828 " char *app_version;\n"
16829 " char *app_release;\n"
16830 " char *app_install_path;\n"
16831 " char *app_trans_path;\n"
16832 " char *app_publisher;\n"
16833 " char *app_url;\n"
16834 " char *app_source_package;\n"
16835 " char *app_summary;\n"
16836 " char *app_description;\n"
16842 #: ../src/guestfs-structs.pod:260
16845 " struct guestfs_application_list {\n"
16846 " uint32_t len; /* Number of elements in list. */\n"
16847 " struct guestfs_application *val; /* Elements. */\n"
16853 #: ../src/guestfs-structs.pod:265
16856 " void guestfs_free_application (struct guestfs_free_application *);\n"
16857 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16862 #: ../fish/guestfish.pod:5
16863 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16867 #: ../fish/guestfish.pod:9
16870 " guestfish [--options] [commands]\n"
16875 #: ../fish/guestfish.pod:11
16883 #: ../fish/guestfish.pod:13
16886 " guestfish [--ro|--rw] -a disk.img\n"
16891 #: ../fish/guestfish.pod:15
16894 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16899 #: ../fish/guestfish.pod:17
16902 " guestfish -d libvirt-domain\n"
16907 #: ../fish/guestfish.pod:19
16910 " guestfish [--ro|--rw] -a disk.img -i\n"
16915 #: ../fish/guestfish.pod:21
16918 " guestfish -d libvirt-domain -i\n"
16923 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16924 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16925 #: ../tools/virt-rescue.pl:41
16930 #: ../fish/guestfish.pod:25
16932 "Using guestfish in read/write mode on live virtual machines can be "
16933 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16934 "option to use guestfish safely if the disk image or virtual machine might be "
16939 #: ../fish/guestfish.pod:32
16941 "Guestfish is a shell and command-line tool for examining and modifying "
16942 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16943 "functionality of the guestfs API, see L<guestfs(3)>."
16947 #: ../fish/guestfish.pod:36
16949 "Guestfish gives you structured access to the libguestfs API, from shell "
16950 "scripts or the command line or interactively. If you want to rescue a "
16951 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16956 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847
16957 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16958 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16963 #: ../fish/guestfish.pod:43
16964 msgid "As an interactive shell"
16968 #: ../fish/guestfish.pod:45
16976 #: ../fish/guestfish.pod:47
16979 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16980 " editing virtual machine filesystems.\n"
16985 #: ../fish/guestfish.pod:50
16988 " Type: 'help' for a list of commands\n"
16989 " 'man' to read the manual\n"
16990 " 'quit' to quit the shell\n"
16995 #: ../fish/guestfish.pod:54
16998 " ><fs> add-ro disk.img\n"
17000 " ><fs> list-filesystems\n"
17001 " /dev/sda1: ext4\n"
17002 " /dev/vg_guest/lv_root: ext4\n"
17003 " /dev/vg_guest/lv_swap: swap\n"
17004 " ><fs> mount /dev/vg_guest/lv_root /\n"
17005 " ><fs> cat /etc/fstab\n"
17007 " # Created by anaconda\n"
17014 #: ../fish/guestfish.pod:67
17015 msgid "From shell scripts"
17019 #: ../fish/guestfish.pod:69
17020 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17024 #: ../fish/guestfish.pod:71
17027 " guestfish <<_EOF_\n"
17030 " mount /dev/vg_guest/lv_root /\n"
17031 " write /etc/motd \"Welcome, new users\"\n"
17037 #: ../fish/guestfish.pod:78
17038 msgid "List the LVM logical volumes in a disk image:"
17042 #: ../fish/guestfish.pod:80
17045 " guestfish -a disk.img --ro <<_EOF_\n"
17053 #: ../fish/guestfish.pod:85
17054 msgid "List all the filesystems in a disk image:"
17058 #: ../fish/guestfish.pod:87
17061 " guestfish -a disk.img --ro <<_EOF_\n"
17063 " list-filesystems\n"
17069 #: ../fish/guestfish.pod:92
17070 msgid "On one command line"
17074 #: ../fish/guestfish.pod:94
17075 msgid "Update C</etc/resolv.conf> in a guest:"
17079 #: ../fish/guestfish.pod:96
17083 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17084 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17089 #: ../fish/guestfish.pod:100
17090 msgid "Edit C</boot/grub/grub.conf> interactively:"
17094 #: ../fish/guestfish.pod:102
17097 " guestfish --rw --add disk.img \\\n"
17098 " --mount /dev/vg_guest/lv_root \\\n"
17099 " --mount /dev/sda1:/boot \\\n"
17100 " edit /boot/grub/grub.conf\n"
17105 #: ../fish/guestfish.pod:107
17106 msgid "Mount disks automatically"
17110 #: ../fish/guestfish.pod:109
17112 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17116 #: ../fish/guestfish.pod:112
17119 " guestfish --ro -a disk.img -i cat /etc/group\n"
17124 #: ../fish/guestfish.pod:114
17127 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17132 #: ../fish/guestfish.pod:116
17133 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17137 #: ../fish/guestfish.pod:118
17140 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17145 #: ../fish/guestfish.pod:120
17146 msgid "As a script interpreter"
17150 #: ../fish/guestfish.pod:122
17151 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17155 #: ../fish/guestfish.pod:124
17158 " #!/usr/bin/guestfish -f\n"
17159 " sparse test1.img 100M\n"
17161 " part-disk /dev/sda mbr\n"
17162 " mkfs ext2 /dev/sda1\n"
17167 #: ../fish/guestfish.pod:130
17168 msgid "Start with a prepared disk"
17172 #: ../fish/guestfish.pod:132
17174 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17175 "single ext2-formatted partition:"
17179 #: ../fish/guestfish.pod:135
17182 " guestfish -N fs\n"
17187 #: ../fish/guestfish.pod:137
17188 msgid "To list what is available do:"
17192 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
17195 " guestfish -N help | less\n"
17200 #: ../fish/guestfish.pod:141
17201 msgid "Remote control"
17205 #: ../fish/guestfish.pod:143
17208 " eval \"`guestfish --listen`\"\n"
17209 " guestfish --remote add-ro disk.img\n"
17210 " guestfish --remote run\n"
17211 " guestfish --remote lvs\n"
17216 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17217 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
17218 #: ../tools/virt-win-reg.pl:171 ../tools/virt-df.pl:71
17219 #: ../tools/virt-resize.pl:256 ../tools/virt-list-filesystems.pl:53
17220 #: ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103
17221 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17226 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17227 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179
17228 #: ../tools/virt-df.pl:79 ../tools/virt-resize.pl:264
17229 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106
17230 #: ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161
17231 #: ../tools/virt-list-partitions.pl:62
17236 #: ../fish/guestfish.pod:154
17237 msgid "Displays general help on options."
17241 #: ../fish/guestfish.pod:156
17242 msgid "B<-h> | B<--cmd-help>"
17246 #: ../fish/guestfish.pod:158
17247 msgid "Lists all available guestfish commands."
17251 #: ../fish/guestfish.pod:160
17252 msgid "B<-h cmd> | B<--cmd-help cmd>"
17256 #: ../fish/guestfish.pod:162
17257 msgid "Displays detailed help on a single command C<cmd>."
17261 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17262 msgid "B<-a image> | B<--add image>"
17266 #: ../fish/guestfish.pod:166
17267 msgid "Add a block device or virtual machine image to the shell."
17271 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17273 "The format of the disk image is auto-detected. To override this and force a "
17274 "particular format use the I<--format=..> option."
17278 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17279 msgid "B<-c URI> | B<--connect URI>"
17283 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17285 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17286 "URI to use. The default is to use the default libvirt connection."
17290 #: ../fish/guestfish.pod:177
17295 #: ../fish/guestfish.pod:179
17297 "If using the I<--listen> option and a csh-like shell, use this option. See "
17298 "section L</REMOTE CONTROL AND CSH> below."
17302 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17303 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17307 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17309 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17310 "used, then any libvirt domain can be used. However in write mode, only "
17311 "libvirt domains which are shut down can be named here."
17315 #: ../fish/guestfish.pod:188
17316 msgid "B<-D> | B<--no-dest-paths>"
17320 #: ../fish/guestfish.pod:190
17322 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17323 "to hit the tab key to complete paths on the guest filesystem, but this "
17324 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17325 "allow this feature to be disabled."
17329 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17330 msgid "B<--echo-keys>"
17334 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17336 "When prompting for keys and passphrases, guestfish normally turns echoing "
17337 "off so you cannot see what you are typing. If you are not worried about "
17338 "Tempest attacks and there is no one else in the room you can specify this "
17339 "flag to see what you are typing."
17343 #: ../fish/guestfish.pod:202
17344 msgid "B<-f file> | B<--file file>"
17348 #: ../fish/guestfish.pod:204
17349 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17353 #: ../fish/guestfish.pod:207
17356 " #!/usr/bin/guestfish -f\n"
17361 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17362 msgid "B<--format=raw|qcow2|..> | B<--format>"
17366 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17368 "The default for the I<-a> option is to auto-detect the format of the disk "
17369 "image. Using this forces the disk format for I<-a> options which follow on "
17370 "the command line. Using I<--format> with no argument switches back to auto-"
17371 "detection for subsequent I<-a> options."
17375 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17376 msgid "For example:"
17380 #: ../fish/guestfish.pod:218
17383 " guestfish --format=raw -a disk.img\n"
17388 #: ../fish/guestfish.pod:220
17389 msgid "forces raw format (no auto-detection) for C<disk.img>."
17393 #: ../fish/guestfish.pod:222
17396 " guestfish --format=raw -a disk.img --format -a another.img\n"
17401 #: ../fish/guestfish.pod:224
17403 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17404 "detection for C<another.img>."
17408 #: ../fish/guestfish.pod:227
17410 "If you have untrusted raw-format guest disk images, you should use this "
17411 "option to specify the disk format. This avoids a possible security problem "
17412 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17416 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17417 msgid "B<-i> | B<--inspector>"
17421 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17423 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17424 "system and mount filesystems as they would be mounted on the real virtual "
17429 #: ../fish/guestfish.pod:238
17430 msgid "Typical usage is either:"
17434 #: ../fish/guestfish.pod:240
17437 " guestfish -d myguest -i\n"
17442 #: ../fish/guestfish.pod:242
17443 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17447 #: ../fish/guestfish.pod:244
17450 " guestfish --ro -d myguest -i\n"
17455 #: ../fish/guestfish.pod:246
17456 msgid "(for active domains, readonly), or specify the block device directly:"
17460 #: ../fish/guestfish.pod:248
17463 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17468 #: ../fish/guestfish.pod:250
17470 "Note that the command line syntax changed slightly over older versions of "
17471 "guestfish. You can still use the old syntax:"
17475 #: ../fish/guestfish.pod:253
17478 " guestfish [--ro] -i disk.img\n"
17483 #: ../fish/guestfish.pod:255
17486 " guestfish [--ro] -i libvirt-domain\n"
17491 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17492 msgid "B<--keys-from-stdin>"
17496 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17498 "Read key or passphrase parameters from stdin. The default is to try to read "
17499 "passphrases from the user by opening C</dev/tty>."
17503 #: ../fish/guestfish.pod:262
17504 msgid "B<--listen>"
17508 #: ../fish/guestfish.pod:264
17510 "Fork into the background and listen for remote commands. See section L</"
17511 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17515 #: ../fish/guestfish.pod:267
17516 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17520 #: ../fish/guestfish.pod:269
17521 msgid "Mount the named partition or logical volume on the given mountpoint."
17525 #: ../fish/guestfish.pod:271
17526 msgid "If the mountpoint is omitted, it defaults to C</>."
17530 #: ../fish/guestfish.pod:273
17531 msgid "You have to mount something on C</> before most commands will work."
17535 #: ../fish/guestfish.pod:275
17537 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17542 #: ../fish/guestfish.pod:278
17544 "If you don't know what filesystems a disk image contains, you can either run "
17545 "guestfish without this option, then list the partitions, filesystems and LVs "
17546 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17547 "commands), or you can use the L<virt-filesystems(1)> program."
17551 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17552 msgid "B<-n> | B<--no-sync>"
17556 #: ../fish/guestfish.pod:286
17558 "Disable autosync. This is enabled by default. See the discussion of "
17559 "autosync in the L<guestfs(3)> manpage."
17563 #: ../fish/guestfish.pod:289
17564 msgid "B<-N type> | B<--new type> | B<-N help>"
17568 #: ../fish/guestfish.pod:291
17570 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17571 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17572 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17577 #: ../fish/guestfish.pod:296
17578 msgid "B<--progress-bars>"
17582 #: ../fish/guestfish.pod:298
17583 msgid "Enable progress bars, even when guestfish is used non-interactively."
17587 #: ../fish/guestfish.pod:300
17589 "Progress bars are enabled by default when guestfish is used as an "
17590 "interactive shell."
17594 #: ../fish/guestfish.pod:303
17595 msgid "B<--no-progress-bars>"
17599 #: ../fish/guestfish.pod:305
17600 msgid "Disable progress bars."
17604 #: ../fish/guestfish.pod:307
17605 msgid "B<--remote[=pid]>"
17609 #: ../fish/guestfish.pod:309
17611 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17612 "CONTROL GUESTFISH OVER A SOCKET> below."
17616 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17617 msgid "B<-r> | B<--ro>"
17621 #: ../fish/guestfish.pod:314
17623 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17624 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17628 #: ../fish/guestfish.pod:317 ../tools/virt-rescue.pl:187
17630 "The option must always be used if the disk image or virtual machine might be "
17631 "running, and is generally recommended in cases where you don't need write "
17632 "access to the disk."
17636 #: ../fish/guestfish.pod:321
17638 "Note that prepared disk images created with I<-N> are not affected by the "
17643 #: ../fish/guestfish.pod:324
17644 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17648 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17649 #: ../tools/virt-rescue.pl:195
17650 msgid "B<--selinux>"
17654 #: ../fish/guestfish.pod:328
17655 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17659 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17660 msgid "B<-v> | B<--verbose>"
17664 #: ../fish/guestfish.pod:332
17666 "Enable very verbose messages. This is particularly useful if you find a bug."
17670 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17671 msgid "B<-V> | B<--version>"
17675 #: ../fish/guestfish.pod:337
17676 msgid "Display the guestfish / libguestfs version number and exit."
17680 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17681 msgid "B<-w> | B<--rw>"
17685 #: ../fish/guestfish.pod:341
17687 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17692 #: ../fish/guestfish.pod:344
17697 #: ../fish/guestfish.pod:346
17698 msgid "Echo each command before executing it."
17702 #: ../fish/guestfish.pod:350
17703 msgid "COMMANDS ON COMMAND LINE"
17707 #: ../fish/guestfish.pod:352
17709 "Any additional (non-option) arguments are treated as commands to execute."
17713 #: ../fish/guestfish.pod:355
17715 "Commands to execute should be separated by a colon (C<:>), where the colon "
17716 "is a separate parameter. Thus:"
17720 #: ../fish/guestfish.pod:358
17723 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17728 #: ../fish/guestfish.pod:360
17730 "If there are no additional arguments, then we enter a shell, either an "
17731 "interactive shell with a prompt (if the input is a terminal) or a non-"
17732 "interactive shell."
17736 #: ../fish/guestfish.pod:364
17738 "In either command line mode or non-interactive shell, the first command that "
17739 "gives an error causes the whole shell to exit. In interactive mode (with a "
17740 "prompt) if a command fails, you can continue to enter commands."
17744 #: ../fish/guestfish.pod:369
17745 msgid "USING launch (OR run)"
17749 #: ../fish/guestfish.pod:371
17751 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17752 "then launch it, then mount any disks you need, and finally issue actions/"
17753 "commands. So the general order of the day is:"
17757 #: ../fish/guestfish.pod:379
17758 msgid "add or -a/--add"
17762 #: ../fish/guestfish.pod:383
17763 msgid "launch (aka run)"
17767 #: ../fish/guestfish.pod:387
17768 msgid "mount or -m/--mount"
17772 #: ../fish/guestfish.pod:391
17773 msgid "any other commands"
17777 #: ../fish/guestfish.pod:395
17779 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17780 "guest before mounting or performing any other commands."
17784 #: ../fish/guestfish.pod:398
17786 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17787 "I<--new> options were given then C<run> is done automatically, simply "
17788 "because guestfish can't perform the action you asked for without doing this."
17792 #: ../fish/guestfish.pod:403
17793 msgid "OPENING DISKS FOR READ AND WRITE"
17797 #: ../fish/guestfish.pod:405
17799 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17800 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17801 "open disk images read-only or for writing."
17805 #: ../fish/guestfish.pod:409
17807 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17808 "disk images supplied on the command line for write. To open a disk image "
17809 "read-only you have to do I<-a image --ro>."
17813 #: ../fish/guestfish.pod:413
17815 "This matters: If you accidentally open a live VM disk image writable then "
17816 "you will cause irreversible disk corruption."
17820 #: ../fish/guestfish.pod:416
17822 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17823 "images will be opened read-only. You will have to either specify "
17824 "I<guestfish --rw> or change a configuration file in order to get write "
17825 "access for disk images specified by those other command line options."
17829 #: ../fish/guestfish.pod:421
17831 "This version of guestfish has a I<--rw> option which does nothing (it is "
17832 "already the default). However it is highly recommended that you use this "
17833 "option to indicate that guestfish needs write access, and to prepare your "
17834 "scripts for the day when this option will be required for write access."
17838 #: ../fish/guestfish.pod:427
17840 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17841 "other libguestfs program apart from guestfish and guestmount."
17845 #: ../fish/guestfish.pod:430
17850 #: ../fish/guestfish.pod:432
17852 "You can quote ordinary parameters using either single or double quotes. For "
17857 #: ../fish/guestfish.pod:435
17860 " add \"file with a space.img\"\n"
17865 #: ../fish/guestfish.pod:437
17868 " rm '/file name'\n"
17873 #: ../fish/guestfish.pod:439
17881 #: ../fish/guestfish.pod:441
17883 "A few commands require a list of strings to be passed. For these, use a "
17884 "whitespace-separated list, enclosed in quotes. Strings containing "
17885 "whitespace to be passed through must be enclosed in single quotes. A "
17886 "literal single quote must be escaped with a backslash."
17890 #: ../fish/guestfish.pod:446
17893 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17894 " command \"/bin/echo 'foo bar'\"\n"
17895 " command \"/bin/echo \\'foo\\'\"\n"
17900 #: ../fish/guestfish.pod:450
17901 msgid "OPTIONAL ARGUMENTS"
17905 #: ../fish/guestfish.pod:452
17907 "Some commands take optional arguments. These arguments appear in this "
17908 "documentation as C<[argname:..]>. You can use them as in these examples:"
17912 #: ../fish/guestfish.pod:456
17915 " add-drive-opts filename\n"
17920 #: ../fish/guestfish.pod:458
17923 " add-drive-opts filename readonly:true\n"
17928 #: ../fish/guestfish.pod:460
17931 " add-drive-opts filename format:qcow2 readonly:false\n"
17936 #: ../fish/guestfish.pod:462
17938 "Each optional argument can appear at most once. All optional arguments must "
17939 "appear after the required ones."
17943 #: ../fish/guestfish.pod:465
17948 #: ../fish/guestfish.pod:467
17950 "This section applies to all commands which can take integers as parameters."
17954 #: ../fish/guestfish.pod:470
17955 msgid "SIZE SUFFIX"
17959 #: ../fish/guestfish.pod:472
17961 "When the command takes a parameter measured in bytes, you can use one of the "
17962 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17966 #: ../fish/guestfish.pod:478
17967 msgid "B<k> or B<K> or B<KiB>"
17971 #: ../fish/guestfish.pod:480
17972 msgid "The size in kilobytes (multiplied by 1024)."
17976 #: ../fish/guestfish.pod:482
17981 #: ../fish/guestfish.pod:484
17982 msgid "The size in SI 1000 byte units."
17986 #: ../fish/guestfish.pod:486
17987 msgid "B<M> or B<MiB>"
17991 #: ../fish/guestfish.pod:488
17992 msgid "The size in megabytes (multiplied by 1048576)."
17996 #: ../fish/guestfish.pod:490
18001 #: ../fish/guestfish.pod:492
18002 msgid "The size in SI 1000000 byte units."
18006 #: ../fish/guestfish.pod:494
18007 msgid "B<G> or B<GiB>"
18011 #: ../fish/guestfish.pod:496
18012 msgid "The size in gigabytes (multiplied by 2**30)."
18016 #: ../fish/guestfish.pod:498
18021 #: ../fish/guestfish.pod:500
18022 msgid "The size in SI 10**9 byte units."
18026 #: ../fish/guestfish.pod:502
18027 msgid "B<T> or B<TiB>"
18031 #: ../fish/guestfish.pod:504
18032 msgid "The size in terabytes (multiplied by 2**40)."
18036 #: ../fish/guestfish.pod:506
18041 #: ../fish/guestfish.pod:508
18042 msgid "The size in SI 10**12 byte units."
18046 #: ../fish/guestfish.pod:510
18047 msgid "B<P> or B<PiB>"
18051 #: ../fish/guestfish.pod:512
18052 msgid "The size in petabytes (multiplied by 2**50)."
18056 #: ../fish/guestfish.pod:514
18061 #: ../fish/guestfish.pod:516
18062 msgid "The size in SI 10**15 byte units."
18066 #: ../fish/guestfish.pod:518
18067 msgid "B<E> or B<EiB>"
18071 #: ../fish/guestfish.pod:520
18072 msgid "The size in exabytes (multiplied by 2**60)."
18076 #: ../fish/guestfish.pod:522
18081 #: ../fish/guestfish.pod:524
18082 msgid "The size in SI 10**18 byte units."
18086 #: ../fish/guestfish.pod:526
18087 msgid "B<Z> or B<ZiB>"
18091 #: ../fish/guestfish.pod:528
18092 msgid "The size in zettabytes (multiplied by 2**70)."
18096 #: ../fish/guestfish.pod:530
18101 #: ../fish/guestfish.pod:532
18102 msgid "The size in SI 10**21 byte units."
18106 #: ../fish/guestfish.pod:534
18107 msgid "B<Y> or B<YiB>"
18111 #: ../fish/guestfish.pod:536
18112 msgid "The size in yottabytes (multiplied by 2**80)."
18116 #: ../fish/guestfish.pod:538
18121 #: ../fish/guestfish.pod:540
18122 msgid "The size in SI 10**24 byte units."
18126 #: ../fish/guestfish.pod:546
18129 " truncate-size /file 1G\n"
18134 #: ../fish/guestfish.pod:548
18135 msgid "would truncate the file to 1 gigabyte."
18139 #: ../fish/guestfish.pod:550
18141 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18142 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18143 "suffix will probably not do what you expect."
18147 #: ../fish/guestfish.pod:554
18148 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18152 #: ../fish/guestfish.pod:556
18154 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18155 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18159 #: ../fish/guestfish.pod:559
18162 " 1234 decimal number 1234\n"
18163 " 02322 octal number, equivalent to decimal 1234\n"
18164 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18169 #: ../fish/guestfish.pod:563
18171 "When using the C<chmod> command, you almost always want to specify an octal "
18172 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18173 "L<chmod(1)> program):"
18177 #: ../fish/guestfish.pod:567
18180 " chmod 0777 /public # OK\n"
18181 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18186 #: ../fish/guestfish.pod:570
18188 "Commands that return numbers usually print them in decimal, but some "
18189 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18190 "octal, preceeded by C<0>)."
18194 #: ../fish/guestfish.pod:574
18195 msgid "WILDCARDS AND GLOBBING"
18199 #: ../fish/guestfish.pod:576
18201 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18202 "(globbing) by default. So for example the following will not do what you "
18207 #: ../fish/guestfish.pod:580
18215 #: ../fish/guestfish.pod:582
18217 "Assuming you don't have a directory called literally C</home/*> then the "
18218 "above command will return an error."
18222 #: ../fish/guestfish.pod:585
18223 msgid "To perform wildcard expansion, use the C<glob> command."
18227 #: ../fish/guestfish.pod:587
18230 " glob rm-rf /home/*\n"
18235 #: ../fish/guestfish.pod:589
18237 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18238 "many times), equivalent to:"
18242 #: ../fish/guestfish.pod:592
18245 " rm-rf /home/jim\n"
18246 " rm-rf /home/joe\n"
18247 " rm-rf /home/mary\n"
18252 #: ../fish/guestfish.pod:596
18253 msgid "C<glob> only works on simple guest paths and not on device names."
18257 #: ../fish/guestfish.pod:598
18259 "If you have several parameters, each containing a wildcard, then glob will "
18260 "perform a Cartesian product."
18264 #: ../fish/guestfish.pod:601
18269 #: ../fish/guestfish.pod:603
18271 "Any line which starts with a I<#> character is treated as a comment and "
18272 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18273 "a command. For example:"
18277 #: ../fish/guestfish.pod:607
18280 " # this is a comment\n"
18281 " # this is a comment\n"
18282 " foo # NOT a comment\n"
18287 #: ../fish/guestfish.pod:611
18288 msgid "Blank lines are also ignored."
18292 #: ../fish/guestfish.pod:613
18293 msgid "RUNNING COMMANDS LOCALLY"
18297 #: ../fish/guestfish.pod:615
18299 "Any line which starts with a I<!> character is treated as a command sent to "
18300 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18304 #: ../fish/guestfish.pod:619
18308 " tgz-out /remote local/remote-data.tar.gz\n"
18313 #: ../fish/guestfish.pod:622
18315 "will create a directory C<local> on the host, and then export the contents "
18316 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18317 "(See C<tgz-out>)."
18321 #: ../fish/guestfish.pod:626
18323 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18324 "effect, due to the way that subprocesses work in Unix."
18328 #: ../fish/guestfish.pod:629
18333 #: ../fish/guestfish.pod:631
18335 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18336 "command (a guestfish command) to the second command (any host command). For "
18341 #: ../fish/guestfish.pod:635
18344 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18349 #: ../fish/guestfish.pod:637
18351 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18352 "program). The above command would list all accounts in the guest filesystem "
18353 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18357 #: ../fish/guestfish.pod:642
18360 " hexdump /bin/ls | head\n"
18361 " list-devices | tail -1\n"
18362 " tgz-out / - | tar ztf -\n"
18367 #: ../fish/guestfish.pod:646
18369 "The space before the pipe symbol is required, any space after the pipe "
18370 "symbol is optional. Everything after the pipe symbol is just passed "
18371 "straight to the host shell, so it can contain redirections, globs and "
18372 "anything else that makes sense on the host side."
18376 #: ../fish/guestfish.pod:651
18378 "To use a literal argument which begins with a pipe symbol, you have to quote "
18383 #: ../fish/guestfish.pod:654
18391 #: ../fish/guestfish.pod:656
18392 msgid "HOME DIRECTORIES"
18396 #: ../fish/guestfish.pod:658
18398 "If a parameter starts with the character C<~> then the tilde may be expanded "
18399 "as a home directory path (either C<~> for the current user's home directory, "
18400 "or C<~user> for another user)."
18404 #: ../fish/guestfish.pod:662
18406 "Note that home directory expansion happens for users known I<on the host>, "
18407 "not in the guest filesystem."
18411 #: ../fish/guestfish.pod:665
18413 "To use a literal argument which begins with a tilde, you have to quote it, "
18418 #: ../fish/guestfish.pod:668
18426 #: ../fish/guestfish.pod:672
18428 "Libguestfs has some support for Linux guests encrypted according to the "
18429 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18430 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18431 "LUKS is supported."
18435 #: ../fish/guestfish.pod:677
18436 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18440 #: ../fish/guestfish.pod:679
18443 " ><fs> vfs-type /dev/sda2\n"
18449 #: ../fish/guestfish.pod:682
18451 "Then open those devices using L</luks-open>. This creates a device-mapper "
18452 "device called C</dev/mapper/luksdev>."
18456 #: ../fish/guestfish.pod:685
18459 " ><fs> luks-open /dev/sda2 luksdev\n"
18460 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18465 #: ../fish/guestfish.pod:688
18467 "Finally you have to tell LVM to scan for volume groups on the newly created "
18472 #: ../fish/guestfish.pod:691
18476 " vg-activate-all true\n"
18481 #: ../fish/guestfish.pod:694
18482 msgid "The logical volume(s) can now be mounted in the usual way."
18486 #: ../fish/guestfish.pod:696
18488 "Before closing a LUKS device you must unmount any logical volumes on it and "
18489 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18490 "one. Then you can close the mapper device:"
18494 #: ../fish/guestfish.pod:700
18497 " vg-activate false /dev/VG\n"
18498 " luks-close /dev/mapper/luksdev\n"
18503 #: ../fish/guestfish.pod:703
18504 msgid "WINDOWS PATHS"
18508 #: ../fish/guestfish.pod:705
18510 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18511 "(with some limitations). The following commands are equivalent:"
18515 #: ../fish/guestfish.pod:708
18518 " file /WINDOWS/system32/config/system.LOG\n"
18523 #: ../fish/guestfish.pod:710
18526 " file win:/windows/system32/config/system.log\n"
18531 #: ../fish/guestfish.pod:712
18534 " file win:\\windows\\system32\\config\\system.log\n"
18539 #: ../fish/guestfish.pod:714
18542 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18547 #: ../fish/guestfish.pod:716
18549 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18550 "handles case insensitivity like Windows would. This only works in argument "
18551 "positions that expect a path."
18555 #: ../fish/guestfish.pod:720
18556 msgid "UPLOADING AND DOWNLOADING FILES"
18560 #: ../fish/guestfish.pod:722
18562 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18563 "others which upload from or download to a local file, you can use the "
18564 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18568 #: ../fish/guestfish.pod:726
18576 #: ../fish/guestfish.pod:728
18578 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18582 #: ../fish/guestfish.pod:731
18585 " tar-out /etc - | tar tf -\n"
18590 #: ../fish/guestfish.pod:733
18592 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18593 "command (see L</PIPES>)."
18597 #: ../fish/guestfish.pod:736
18599 "When using C<-> to read from stdin, the input is read up to the end of "
18600 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18601 "some arbitrary end marker:"
18605 #: ../fish/guestfish.pod:740
18608 " upload -<<END /foo\n"
18617 #: ../fish/guestfish.pod:746
18619 "Any string of characters can be used instead of C<END>. The end marker must "
18620 "appear on a line of its own, without any preceeding or following characters "
18621 "(not even spaces)."
18625 #: ../fish/guestfish.pod:750
18627 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18628 "upload local files (so-called \"FileIn\" parameters in the generator)."
18632 #: ../fish/guestfish.pod:753
18633 msgid "EXIT ON ERROR BEHAVIOUR"
18637 #: ../fish/guestfish.pod:755
18639 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18640 "taking commands from a human over a tty), and will exit on the first error "
18641 "in non-interactive mode (scripts, commands given on the command line)."
18645 #: ../fish/guestfish.pod:760
18647 "If you prefix a command with a I<-> character, then that command will not "
18648 "cause guestfish to exit, even if that (one) command returns an error."
18652 #: ../fish/guestfish.pod:764
18653 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18657 #: ../fish/guestfish.pod:766
18659 "Guestfish can be remote-controlled over a socket. This is useful "
18660 "particularly in shell scripts where you want to make several different "
18661 "changes to a filesystem, but you don't want the overhead of starting up a "
18662 "guestfish process each time."
18666 #: ../fish/guestfish.pod:771
18667 msgid "Start a guestfish server process using:"
18671 #: ../fish/guestfish.pod:773
18674 " eval \"`guestfish --listen`\"\n"
18679 #: ../fish/guestfish.pod:775
18680 msgid "and then send it commands by doing:"
18684 #: ../fish/guestfish.pod:777
18687 " guestfish --remote cmd [...]\n"
18692 #: ../fish/guestfish.pod:779
18693 msgid "To cause the server to exit, send it the exit command:"
18697 #: ../fish/guestfish.pod:781
18700 " guestfish --remote exit\n"
18705 #: ../fish/guestfish.pod:783
18707 "Note that the server will normally exit if there is an error in a command. "
18708 "You can change this in the usual way. See section L</EXIT ON ERROR "
18713 #: ../fish/guestfish.pod:787
18714 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18718 #: ../fish/guestfish.pod:789
18720 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18721 "is how the I<--remote> option knows where to send the commands. You can "
18722 "have several guestfish listener processes running using:"
18726 #: ../fish/guestfish.pod:793
18729 " eval \"`guestfish --listen`\"\n"
18730 " pid1=$GUESTFISH_PID\n"
18731 " eval \"`guestfish --listen`\"\n"
18732 " pid2=$GUESTFISH_PID\n"
18734 " guestfish --remote=$pid1 cmd\n"
18735 " guestfish --remote=$pid2 cmd\n"
18740 #: ../fish/guestfish.pod:801
18741 msgid "REMOTE CONTROL AND CSH"
18745 #: ../fish/guestfish.pod:803
18747 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18752 #: ../fish/guestfish.pod:806
18755 " eval \"`guestfish --listen --csh`\"\n"
18760 #: ../fish/guestfish.pod:808
18761 msgid "REMOTE CONTROL DETAILS"
18765 #: ../fish/guestfish.pod:810
18767 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18768 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18769 "and C<$PID> is the process ID of the server."
18773 #: ../fish/guestfish.pod:814
18774 msgid "Guestfish client and server versions must match exactly."
18778 #: ../fish/guestfish.pod:816
18779 msgid "PREPARED DISK IMAGES"
18783 #: ../fish/guestfish.pod:818
18785 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18786 "preformatted disk images that guestfish can make for you to save typing. "
18787 "This is particularly useful for testing purposes. This option is used "
18788 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18789 "can be mixed with I<-a>)."
18793 #: ../fish/guestfish.pod:824
18795 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18796 "the second and so on. Existing files in the current directory are "
18801 #: ../fish/guestfish.pod:828
18803 "The type briefly describes how the disk should be sized, partitioned, how "
18804 "filesystem(s) should be created, and how content should be added. "
18805 "Optionally the type can be followed by extra parameters, separated by C<:> "
18806 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18807 "allocated disk, containing a single partition, with the partition formatted "
18808 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18813 #: ../fish/guestfish.pod:836
18814 msgid "To list the available types and any extra parameters they take, run:"
18818 #: ../fish/guestfish.pod:840
18820 "Note that the prepared filesystem is not mounted. You would usually have to "
18821 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18825 #: ../fish/guestfish.pod:844
18827 "If any I<-N> or I<--new> options are given, the guest is automatically "
18832 #: ../fish/guestfish.pod:849
18833 msgid "Create a 100MB disk with an ext4-formatted partition:"
18837 #: ../fish/guestfish.pod:851
18840 " guestfish -N fs:ext4\n"
18845 #: ../fish/guestfish.pod:853
18846 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18850 #: ../fish/guestfish.pod:855
18853 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18858 #: ../fish/guestfish.pod:857
18859 msgid "Create a blank 200MB disk:"
18863 #: ../fish/guestfish.pod:859
18866 " guestfish -N disk:200M\n"
18871 #: ../fish/guestfish.pod:861
18872 msgid "PROGRESS BARS"
18876 #: ../fish/guestfish.pod:863
18878 "Some (not all) long-running commands send progress notification messages as "
18879 "they are running. Guestfish turns these messages into progress bars."
18883 #: ../fish/guestfish.pod:867
18885 "When a command that supports progress bars takes longer than two seconds to "
18886 "run, and if progress bars are enabled, then you will see one appearing below "
18891 #: ../fish/guestfish.pod:871
18894 " ><fs> copy-size /large-file /another-file 2048M\n"
18895 " / 10% [#####-----------------------------------------] 00:30\n"
18900 #: ../fish/guestfish.pod:874
18902 "The spinner on the left hand side moves round once for every progress "
18903 "notification received from the backend. This is a (reasonably) golden "
18904 "assurance that the command is \"doing something\" even if the progress bar "
18905 "is not moving, because the command is able to send the progress "
18906 "notifications. When the bar reaches 100% and the command finishes, the "
18907 "spinner disappears."
18911 #: ../fish/guestfish.pod:881
18913 "Progress bars are enabled by default when guestfish is used interactively. "
18914 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18915 "and you can disable them completely using I<--no-progress-bars>."
18919 #: ../fish/guestfish.pod:886
18920 msgid "GUESTFISH COMMANDS"
18924 #: ../fish/guestfish.pod:888
18926 "The commands in this section are guestfish convenience commands, in other "
18927 "words, they are not part of the L<guestfs(3)> API."
18931 #: ../fish/guestfish.pod:891
18936 #: ../fish/guestfish.pod:893
18945 #: ../fish/guestfish.pod:896
18946 msgid "Without any parameter, this provides general help."
18950 #: ../fish/guestfish.pod:898
18951 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18955 #: ../fish/guestfish.pod:900
18956 msgid "quit | exit"
18960 #: ../fish/guestfish.pod:902
18961 msgid "This exits guestfish. You can also use C<^D> key."
18965 #: ../fish/guestfish.pod:904
18966 msgid "@FISH_COMMANDS@"
18970 #: ../fish/guestfish.pod:906
18975 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18980 #: ../fish/guestfish.pod:912
18982 "guestfish returns 0 if the commands completed without error, or 1 if there "
18987 #: ../fish/guestfish.pod:919
18992 #: ../fish/guestfish.pod:921
18994 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18999 #: ../fish/guestfish.pod:924
19000 msgid "GUESTFISH_PID"
19004 #: ../fish/guestfish.pod:926
19006 "Used with the I<--remote> option to specify the remote guestfish process to "
19007 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19011 #: ../fish/guestfish.pod:930
19016 #: ../fish/guestfish.pod:932
19018 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19019 "not specified, the external L<hexedit(1)> program is used."
19023 #: ../fish/guestfish.pod:936
19028 #: ../fish/guestfish.pod:938
19030 "If compiled with GNU readline support, various files in the home directory "
19031 "can be used. See L</FILES>."
19035 #: ../fish/guestfish.pod:947
19037 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19038 "effect as using the B<-v> option."
19042 #: ../fish/guestfish.pod:959
19044 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19045 "the discussion of paths in L<guestfs(3)>."
19049 #: ../fish/guestfish.pod:970
19050 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19054 #: ../fish/guestfish.pod:972
19059 #: ../fish/guestfish.pod:974
19061 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19066 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
19071 #: ../fish/guestfish.pod:993
19072 msgid "$HOME/.guestfish"
19076 #: ../fish/guestfish.pod:995
19078 "If compiled with GNU readline support, then the command history is saved in "
19083 #: ../fish/guestfish.pod:998
19084 msgid "$HOME/.inputrc"
19088 #: ../fish/guestfish.pod:1000
19089 msgid "/etc/inputrc"
19093 #: ../fish/guestfish.pod:1002
19095 "If compiled with GNU readline support, then these files can be used to "
19096 "configure readline. For further information, please see L<readline(3)/"
19097 "INITIALIZATION FILE>."
19101 #: ../fish/guestfish.pod:1006
19102 msgid "To write rules which only apply to guestfish, use:"
19106 #: ../fish/guestfish.pod:1008
19116 #: ../fish/guestfish.pod:1012
19118 "Variables that you can set in inputrc that change the behaviour of guestfish "
19119 "in useful ways include:"
19123 #: ../fish/guestfish.pod:1017
19124 msgid "completion-ignore-case (default: on)"
19128 #: ../fish/guestfish.pod:1019
19130 "By default, guestfish will ignore case when tab-completing paths on the "
19135 #: ../fish/guestfish.pod:1022
19138 " set completion-ignore-case off\n"
19143 #: ../fish/guestfish.pod:1024
19144 msgid "to make guestfish case sensitive."
19148 #: ../fish/guestfish.pod:1028
19153 #: ../fish/guestfish.pod:1030
19154 msgid "test2.img (etc)"
19158 #: ../fish/guestfish.pod:1032
19160 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19161 "will be created in the file C<test1.img> in the current directory. The "
19162 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19163 "the same name will be overwritten."
19167 #: ../fish/guestfish.pod:1041
19169 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19170 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
19171 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
19172 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
19177 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124
19178 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
19179 #: ../tools/virt-win-reg.pl:518 ../tools/virt-df.pl:657
19180 #: ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:210
19181 #: ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285
19182 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
19184 "This program is free software; you can redistribute it and/or modify it "
19185 "under the terms of the GNU General Public License as published by the Free "
19186 "Software Foundation; either version 2 of the License, or (at your option) "
19187 "any later version."
19191 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129
19192 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
19193 #: ../tools/virt-win-reg.pl:523 ../tools/virt-df.pl:662
19194 #: ../tools/virt-resize.pl:1519 ../tools/virt-list-filesystems.pl:215
19195 #: ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290
19196 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
19198 "This program is distributed in the hope that it will be useful, but WITHOUT "
19199 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19200 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19205 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134
19206 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
19207 #: ../tools/virt-win-reg.pl:528 ../tools/virt-df.pl:667
19208 #: ../tools/virt-resize.pl:1524 ../tools/virt-list-filesystems.pl:220
19209 #: ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295
19210 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
19212 "You should have received a copy of the GNU General Public License along with "
19213 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19214 "Ave, Cambridge, MA 02139, USA."
19218 #: ../fish/guestfish-actions.pod:1
19223 #: ../fish/guestfish-actions.pod:3
19226 " add-cdrom filename\n"
19231 #: ../fish/guestfish-actions.pod:15
19233 "This call checks for the existence of C<filename>. This stops you from "
19234 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19235 "and C<http:> URLs. To specify those, use the general L</config> call "
19240 #: ../fish/guestfish-actions.pod:22
19242 "If you just want to add an ISO file (often you use this as an efficient way "
19243 "to transfer large files into the guest), then you should probably use L</add-"
19244 "drive-ro> instead."
19248 #: ../fish/guestfish-actions.pod:35
19253 #: ../fish/guestfish-actions.pod:37
19258 #: ../fish/guestfish-actions.pod:39
19261 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19266 #: ../fish/guestfish-actions.pod:41
19268 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19269 "It works by connecting to libvirt, requesting the domain and domain XML from "
19270 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19274 #: ../fish/guestfish-actions.pod:58
19276 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19277 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19278 "libvirt URI (or one set through an environment variable, see the libvirt "
19279 "documentation for full details). If you are using the C API directly then "
19280 "it is more flexible to create the libvirt connection object yourself, get "
19281 "the domain object, and call L</add-libvirt-dom>."
19285 #: ../fish/guestfish-actions.pod:66
19287 "The other optional parameters are passed directly through to L</add-drive-"
19292 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19294 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19298 #: ../fish/guestfish-actions.pod:71
19303 #: ../fish/guestfish-actions.pod:73
19306 " add-drive filename\n"
19311 #: ../fish/guestfish-actions.pod:75
19313 "This function is the equivalent of calling L</add-drive-opts> with no "
19314 "optional parameters, so the disk is added writable, with the format being "
19315 "detected automatically."
19319 #: ../fish/guestfish-actions.pod:79
19321 "Automatic detection of the format opens you up to a potential security hole "
19322 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19323 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19324 "you should think about replacing calls to this function with calls to L</add-"
19325 "drive-opts>, and specifying the format."
19329 #: ../fish/guestfish-actions.pod:86
19330 msgid "add-drive-opts"
19334 #: ../fish/guestfish-actions.pod:88
19339 #: ../fish/guestfish-actions.pod:90
19342 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19347 #: ../fish/guestfish-actions.pod:117
19349 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19350 "add-drive-ro>) then the format is automatically detected. Possible formats "
19351 "include C<raw> and C<qcow2>."
19355 #: ../fish/guestfish-actions.pod:128
19357 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19358 "add-drive-with-if> call (q.v.)"
19362 #: ../fish/guestfish-actions.pod:135
19363 msgid "add-drive-ro"
19367 #: ../fish/guestfish-actions.pod:137
19372 #: ../fish/guestfish-actions.pod:139
19375 " add-drive-ro filename\n"
19380 #: ../fish/guestfish-actions.pod:141
19382 "This function is the equivalent of calling L</add-drive-opts> with the "
19383 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19384 "is added read-only, with the format being detected automatically."
19388 #: ../fish/guestfish-actions.pod:146
19389 msgid "add-drive-ro-with-if"
19393 #: ../fish/guestfish-actions.pod:148
19396 " add-drive-ro-with-if filename iface\n"
19401 #: ../fish/guestfish-actions.pod:150
19403 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19404 "interface emulation to use at run time."
19408 #: ../fish/guestfish-actions.pod:160
19409 msgid "add-drive-with-if"
19413 #: ../fish/guestfish-actions.pod:162
19416 " add-drive-with-if filename iface\n"
19421 #: ../fish/guestfish-actions.pod:164
19423 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19424 "interface emulation to use at run time."
19428 #: ../fish/guestfish-actions.pod:174
19433 #: ../fish/guestfish-actions.pod:176
19436 " aug-clear augpath\n"
19441 #: ../fish/guestfish-actions.pod:181
19446 #: ../fish/guestfish-actions.pod:183
19454 #: ../fish/guestfish-actions.pod:185
19456 "Close the current Augeas handle and free up any resources used by it. After "
19457 "calling this, you have to call L</aug-init> again before you can use any "
19458 "other Augeas functions."
19462 #: ../fish/guestfish-actions.pod:190
19463 msgid "aug-defnode"
19467 #: ../fish/guestfish-actions.pod:192
19470 " aug-defnode name expr val\n"
19475 #: ../fish/guestfish-actions.pod:197
19477 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19478 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19479 "containing that single node."
19483 #: ../fish/guestfish-actions.pod:205
19488 #: ../fish/guestfish-actions.pod:207
19491 " aug-defvar name expr\n"
19496 #: ../fish/guestfish-actions.pod:216
19501 #: ../fish/guestfish-actions.pod:218
19504 " aug-get augpath\n"
19509 #: ../fish/guestfish-actions.pod:223
19514 #: ../fish/guestfish-actions.pod:225
19517 " aug-init root flags\n"
19522 #: ../fish/guestfish-actions.pod:231
19523 msgid "You must call this before using any other L</aug-*> commands."
19527 #: ../fish/guestfish-actions.pod:266
19528 msgid "Do not load the tree in L</aug-init>."
19532 #: ../fish/guestfish-actions.pod:270
19533 msgid "To close the handle, you can call L</aug-close>."
19537 #: ../fish/guestfish-actions.pod:274
19542 #: ../fish/guestfish-actions.pod:276
19545 " aug-insert augpath label true|false\n"
19550 #: ../fish/guestfish-actions.pod:286
19555 #: ../fish/guestfish-actions.pod:288
19563 #: ../fish/guestfish-actions.pod:295
19568 #: ../fish/guestfish-actions.pod:297
19571 " aug-ls augpath\n"
19576 #: ../fish/guestfish-actions.pod:299
19578 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19579 "resulting nodes into alphabetical order."
19583 #: ../fish/guestfish-actions.pod:302
19588 #: ../fish/guestfish-actions.pod:304
19591 " aug-match augpath\n"
19596 #: ../fish/guestfish-actions.pod:310
19601 #: ../fish/guestfish-actions.pod:312
19604 " aug-mv src dest\n"
19609 #: ../fish/guestfish-actions.pod:317
19614 #: ../fish/guestfish-actions.pod:319
19617 " aug-rm augpath\n"
19622 #: ../fish/guestfish-actions.pod:325
19627 #: ../fish/guestfish-actions.pod:327
19635 #: ../fish/guestfish-actions.pod:331
19637 "The flags which were passed to L</aug-init> affect exactly how files are "
19642 #: ../fish/guestfish-actions.pod:334
19647 #: ../fish/guestfish-actions.pod:336
19650 " aug-set augpath val\n"
19655 #: ../fish/guestfish-actions.pod:340
19657 "In the Augeas API, it is possible to clear a node by setting the value to "
19658 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19659 "this call. Instead you must use the L</aug-clear> call."
19663 #: ../fish/guestfish-actions.pod:345
19668 #: ../fish/guestfish-actions.pod:347
19671 " available 'groups ...'\n"
19676 #: ../fish/guestfish-actions.pod:353
19678 "The libguestfs groups, and the functions that those groups correspond to, "
19679 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19680 "runtime by calling L</available-all-groups>."
19684 #: ../fish/guestfish-actions.pod:377
19685 msgid "You must call L</launch> before calling this function."
19689 #: ../fish/guestfish-actions.pod:399
19691 "This call was added in version C<1.0.80>. In previous versions of "
19692 "libguestfs all you could do would be to speculatively execute a command to "
19693 "find out if the daemon implemented it. See also L</version>."
19697 #: ../fish/guestfish-actions.pod:406
19698 msgid "available-all-groups"
19702 #: ../fish/guestfish-actions.pod:408
19705 " available-all-groups\n"
19710 #: ../fish/guestfish-actions.pod:410
19712 "This command returns a list of all optional groups that this daemon knows "
19713 "about. Note this returns both supported and unsupported groups. To find "
19714 "out which ones the daemon can actually support you have to call L</"
19715 "available> on each member of the returned list."
19719 #: ../fish/guestfish-actions.pod:416
19720 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19724 #: ../fish/guestfish-actions.pod:418
19729 #: ../fish/guestfish-actions.pod:420
19732 " base64-in (base64file|-) filename\n"
19737 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19738 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19739 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19740 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19741 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19742 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19743 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19744 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19748 #: ../fish/guestfish-actions.pod:427
19753 #: ../fish/guestfish-actions.pod:429
19756 " base64-out filename (base64file|-)\n"
19761 #: ../fish/guestfish-actions.pod:436
19762 msgid "blockdev-flushbufs"
19766 #: ../fish/guestfish-actions.pod:438
19769 " blockdev-flushbufs device\n"
19774 #: ../fish/guestfish-actions.pod:445
19775 msgid "blockdev-getbsz"
19779 #: ../fish/guestfish-actions.pod:447
19782 " blockdev-getbsz device\n"
19787 #: ../fish/guestfish-actions.pod:456
19788 msgid "blockdev-getro"
19792 #: ../fish/guestfish-actions.pod:458
19795 " blockdev-getro device\n"
19800 #: ../fish/guestfish-actions.pod:465
19801 msgid "blockdev-getsize64"
19805 #: ../fish/guestfish-actions.pod:467
19808 " blockdev-getsize64 device\n"
19813 #: ../fish/guestfish-actions.pod:471
19814 msgid "See also L</blockdev-getsz>."
19818 #: ../fish/guestfish-actions.pod:475
19819 msgid "blockdev-getss"
19823 #: ../fish/guestfish-actions.pod:477
19826 " blockdev-getss device\n"
19831 #: ../fish/guestfish-actions.pod:482
19833 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19837 #: ../fish/guestfish-actions.pod:487
19838 msgid "blockdev-getsz"
19842 #: ../fish/guestfish-actions.pod:489
19845 " blockdev-getsz device\n"
19850 #: ../fish/guestfish-actions.pod:494
19852 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19853 "blockdev-getsize64> for the more useful I<size in bytes>."
19857 #: ../fish/guestfish-actions.pod:500
19858 msgid "blockdev-rereadpt"
19862 #: ../fish/guestfish-actions.pod:502
19865 " blockdev-rereadpt device\n"
19870 #: ../fish/guestfish-actions.pod:508
19871 msgid "blockdev-setbsz"
19875 #: ../fish/guestfish-actions.pod:510
19878 " blockdev-setbsz device blocksize\n"
19883 #: ../fish/guestfish-actions.pod:519
19884 msgid "blockdev-setro"
19888 #: ../fish/guestfish-actions.pod:521
19891 " blockdev-setro device\n"
19896 #: ../fish/guestfish-actions.pod:527
19897 msgid "blockdev-setrw"
19901 #: ../fish/guestfish-actions.pod:529
19904 " blockdev-setrw device\n"
19909 #: ../fish/guestfish-actions.pod:535
19910 msgid "case-sensitive-path"
19914 #: ../fish/guestfish-actions.pod:537
19917 " case-sensitive-path path\n"
19922 #: ../fish/guestfish-actions.pod:561
19924 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19925 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19926 "the directories were originally created under Windows)."
19930 #: ../fish/guestfish-actions.pod:569
19931 msgid "See also L</realpath>."
19935 #: ../fish/guestfish-actions.pod:571
19940 #: ../fish/guestfish-actions.pod:573
19948 #: ../fish/guestfish-actions.pod:577
19950 "Note that this function cannot correctly handle binary files (specifically, "
19951 "files containing C<\\0> character which is treated as end of string). For "
19952 "those you need to use the L</read-file> or L</download> functions which have "
19953 "a more complex interface."
19957 #: ../fish/guestfish-actions.pod:585
19962 #: ../fish/guestfish-actions.pod:587
19965 " checksum csumtype path\n"
19970 #: ../fish/guestfish-actions.pod:630
19971 msgid "To get the checksum for a device, use L</checksum-device>."
19975 #: ../fish/guestfish-actions.pod:632
19976 msgid "To get the checksums for many files, use L</checksums-out>."
19980 #: ../fish/guestfish-actions.pod:634
19981 msgid "checksum-device"
19985 #: ../fish/guestfish-actions.pod:636
19988 " checksum-device csumtype device\n"
19993 #: ../fish/guestfish-actions.pod:638
19995 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19996 "device named C<device>. For the types of checksums supported see the L</"
19997 "checksum> command."
20001 #: ../fish/guestfish-actions.pod:642
20002 msgid "checksums-out"
20006 #: ../fish/guestfish-actions.pod:644
20009 " checksums-out csumtype directory (sumsfile|-)\n"
20014 #: ../fish/guestfish-actions.pod:660
20019 #: ../fish/guestfish-actions.pod:662
20022 " chmod mode path\n"
20027 #: ../fish/guestfish-actions.pod:673
20032 #: ../fish/guestfish-actions.pod:675
20035 " chown owner group path\n"
20040 #: ../fish/guestfish-actions.pod:683
20045 #: ../fish/guestfish-actions.pod:685
20048 " command 'arguments ...'\n"
20053 #: ../fish/guestfish-actions.pod:692
20055 "The single parameter is an argv-style list of arguments. The first element "
20056 "is the name of the program to run. Subsequent elements are parameters. The "
20057 "list must be non-empty (ie. must contain a program name). Note that the "
20058 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20062 #: ../fish/guestfish-actions.pod:720
20063 msgid "command-lines"
20067 #: ../fish/guestfish-actions.pod:722
20070 " command-lines 'arguments ...'\n"
20075 #: ../fish/guestfish-actions.pod:724
20077 "This is the same as L</command>, but splits the result into a list of lines."
20081 #: ../fish/guestfish-actions.pod:727
20082 msgid "See also: L</sh-lines>"
20086 #: ../fish/guestfish-actions.pod:732
20091 #: ../fish/guestfish-actions.pod:734
20094 " config qemuparam qemuvalue\n"
20099 #: ../fish/guestfish-actions.pod:745
20104 #: ../fish/guestfish-actions.pod:747
20107 " copy-size src dest size\n"
20112 #: ../fish/guestfish-actions.pod:755
20117 #: ../fish/guestfish-actions.pod:757
20125 #: ../fish/guestfish-actions.pod:762
20130 #: ../fish/guestfish-actions.pod:764
20138 #: ../fish/guestfish-actions.pod:769
20143 #: ../fish/guestfish-actions.pod:771
20151 #: ../fish/guestfish-actions.pod:778
20153 "If the destination is a device, it must be as large or larger than the "
20154 "source file or device, otherwise the copy will fail. This command cannot do "
20155 "partial copies (see L</copy-size>)."
20159 #: ../fish/guestfish-actions.pod:782
20164 #: ../fish/guestfish-actions.pod:784
20172 #: ../fish/guestfish-actions.pod:792
20177 #: ../fish/guestfish-actions.pod:794
20185 #: ../fish/guestfish-actions.pod:803
20190 #: ../fish/guestfish-actions.pod:805
20198 #: ../fish/guestfish-actions.pod:811
20200 "Another way to get the same information is to enable verbose messages with "
20201 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20202 "before running the program."
20206 #: ../fish/guestfish-actions.pod:816
20211 #: ../fish/guestfish-actions.pod:818
20214 " download remotefilename (filename|-)\n"
20219 #: ../fish/guestfish-actions.pod:825
20220 msgid "See also L</upload>, L</cat>."
20224 #: ../fish/guestfish-actions.pod:829
20225 msgid "download-offset"
20229 #: ../fish/guestfish-actions.pod:831
20232 " download-offset remotefilename (filename|-) offset size\n"
20237 #: ../fish/guestfish-actions.pod:839
20239 "Note that there is no limit on the amount of data that can be downloaded "
20240 "with this call, unlike with L</pread>, and this call always reads the full "
20241 "amount unless an error occurs."
20245 #: ../fish/guestfish-actions.pod:844
20246 msgid "See also L</download>, L</pread>."
20250 #: ../fish/guestfish-actions.pod:848
20251 msgid "drop-caches"
20255 #: ../fish/guestfish-actions.pod:850
20258 " drop-caches whattodrop\n"
20263 #: ../fish/guestfish-actions.pod:862
20268 #: ../fish/guestfish-actions.pod:864
20276 #: ../fish/guestfish-actions.pod:876
20281 #: ../fish/guestfish-actions.pod:878
20284 " e2fsck-f device\n"
20289 #: ../fish/guestfish-actions.pod:884
20291 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20292 "should use L</fsck>."
20296 #: ../fish/guestfish-actions.pod:887
20297 msgid "echo-daemon"
20301 #: ../fish/guestfish-actions.pod:889
20304 " echo-daemon 'words ...'\n"
20309 #: ../fish/guestfish-actions.pod:896
20310 msgid "See also L</ping-daemon>."
20314 #: ../fish/guestfish-actions.pod:898
20319 #: ../fish/guestfish-actions.pod:900
20322 " egrep regex path\n"
20327 #: ../fish/guestfish-actions.pod:908
20332 #: ../fish/guestfish-actions.pod:910
20335 " egrepi regex path\n"
20340 #: ../fish/guestfish-actions.pod:918
20345 #: ../fish/guestfish-actions.pod:920
20348 " equal file1 file2\n"
20353 #: ../fish/guestfish-actions.pod:927
20358 #: ../fish/guestfish-actions.pod:929
20366 #: ../fish/guestfish-actions.pod:934
20367 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20371 #: ../fish/guestfish-actions.pod:936
20376 #: ../fish/guestfish-actions.pod:938
20379 " fallocate path len\n"
20384 #: ../fish/guestfish-actions.pod:955
20385 msgid "fallocate64"
20389 #: ../fish/guestfish-actions.pod:957
20392 " fallocate64 path len\n"
20397 #: ../fish/guestfish-actions.pod:963
20399 "Note that this call allocates disk blocks for the file. To create a sparse "
20400 "file use L</truncate-size> instead."
20404 #: ../fish/guestfish-actions.pod:966
20406 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20407 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20408 "maximum size of files created through that call to 1GB."
20412 #: ../fish/guestfish-actions.pod:975
20417 #: ../fish/guestfish-actions.pod:977
20420 " fgrep pattern path\n"
20425 #: ../fish/guestfish-actions.pod:985
20430 #: ../fish/guestfish-actions.pod:987
20433 " fgrepi pattern path\n"
20438 #: ../fish/guestfish-actions.pod:995
20443 #: ../fish/guestfish-actions.pod:997
20451 #: ../fish/guestfish-actions.pod:1009
20453 "This command can also be used on C</dev/> devices (and partitions, LV "
20454 "names). You can for example use this to determine if a device contains a "
20455 "filesystem, although it's usually better to use L</vfs-type>."
20459 #: ../fish/guestfish-actions.pod:1019
20460 msgid "file-architecture"
20464 #: ../fish/guestfish-actions.pod:1021
20467 " file-architecture filename\n"
20472 #: ../fish/guestfish-actions.pod:1124
20477 #: ../fish/guestfish-actions.pod:1126
20485 #: ../fish/guestfish-actions.pod:1130
20487 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20488 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20492 #: ../fish/guestfish-actions.pod:1134
20497 #: ../fish/guestfish-actions.pod:1136
20500 " fill c len path\n"
20505 #: ../fish/guestfish-actions.pod:1142
20507 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20508 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20509 "L</fill-pattern>."
20513 #: ../fish/guestfish-actions.pod:1147
20514 msgid "fill-pattern"
20518 #: ../fish/guestfish-actions.pod:1149
20521 " fill-pattern pattern len path\n"
20526 #: ../fish/guestfish-actions.pod:1151
20528 "This function is like L</fill> except that it creates a new file of length "
20529 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20530 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20535 #: ../fish/guestfish-actions.pod:1156
20540 #: ../fish/guestfish-actions.pod:1158
20543 " find directory\n"
20548 #: ../fish/guestfish-actions.pod:1172
20549 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20553 #: ../fish/guestfish-actions.pod:1185
20554 msgid "See also L</find0>."
20558 #: ../fish/guestfish-actions.pod:1190
20563 #: ../fish/guestfish-actions.pod:1192
20566 " find0 directory (files|-)\n"
20571 #: ../fish/guestfish-actions.pod:1198
20573 "This command works the same way as L</find> with the following exceptions:"
20577 #: ../fish/guestfish-actions.pod:1225
20578 msgid "findfs-label"
20582 #: ../fish/guestfish-actions.pod:1227
20585 " findfs-label label\n"
20590 #: ../fish/guestfish-actions.pod:1233
20591 msgid "To find the label of a filesystem, use L</vfs-label>."
20595 #: ../fish/guestfish-actions.pod:1235
20596 msgid "findfs-uuid"
20600 #: ../fish/guestfish-actions.pod:1237
20603 " findfs-uuid uuid\n"
20608 #: ../fish/guestfish-actions.pod:1243
20609 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20613 #: ../fish/guestfish-actions.pod:1245
20618 #: ../fish/guestfish-actions.pod:1247
20621 " fsck fstype device\n"
20626 #: ../fish/guestfish-actions.pod:1277
20631 #: ../fish/guestfish-actions.pod:1279
20639 #: ../fish/guestfish-actions.pod:1286
20640 msgid "get-autosync"
20644 #: ../fish/guestfish-actions.pod:1288
20652 #: ../fish/guestfish-actions.pod:1292
20657 #: ../fish/guestfish-actions.pod:1294
20665 #: ../fish/guestfish-actions.pod:1298
20666 msgid "get-e2label"
20670 #: ../fish/guestfish-actions.pod:1300
20673 " get-e2label device\n"
20678 #: ../fish/guestfish-actions.pod:1312
20683 #: ../fish/guestfish-actions.pod:1314
20686 " get-e2uuid device\n"
20691 #: ../fish/guestfish-actions.pod:1326
20692 msgid "get-memsize"
20696 #: ../fish/guestfish-actions.pod:1328
20704 #: ../fish/guestfish-actions.pod:1333
20706 "If L</set-memsize> was not called on this handle, and if "
20707 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20708 "value for memsize."
20712 #: ../fish/guestfish-actions.pod:1340
20713 msgid "get-network"
20717 #: ../fish/guestfish-actions.pod:1342
20725 #: ../fish/guestfish-actions.pod:1346
20730 #: ../fish/guestfish-actions.pod:1348
20738 #: ../fish/guestfish-actions.pod:1355
20743 #: ../fish/guestfish-actions.pod:1357
20748 #: ../fish/guestfish-actions.pod:1359
20756 #: ../fish/guestfish-actions.pod:1366
20761 #: ../fish/guestfish-actions.pod:1368
20769 #: ../fish/guestfish-actions.pod:1375
20770 msgid "get-recovery-proc"
20774 #: ../fish/guestfish-actions.pod:1377
20777 " get-recovery-proc\n"
20782 #: ../fish/guestfish-actions.pod:1381
20783 msgid "get-selinux"
20787 #: ../fish/guestfish-actions.pod:1383
20795 #: ../fish/guestfish-actions.pod:1385
20797 "This returns the current setting of the selinux flag which is passed to the "
20798 "appliance at boot time. See L</set-selinux>."
20802 #: ../fish/guestfish-actions.pod:1391
20807 #: ../fish/guestfish-actions.pod:1393
20815 #: ../fish/guestfish-actions.pod:1400
20820 #: ../fish/guestfish-actions.pod:1402
20828 #: ../fish/guestfish-actions.pod:1406
20833 #: ../fish/guestfish-actions.pod:1408
20841 #: ../fish/guestfish-actions.pod:1410
20843 "Return the current umask. By default the umask is C<022> unless it has been "
20844 "set by calling L</umask>."
20848 #: ../fish/guestfish-actions.pod:1413
20849 msgid "get-verbose"
20853 #: ../fish/guestfish-actions.pod:1415
20861 #: ../fish/guestfish-actions.pod:1419
20866 #: ../fish/guestfish-actions.pod:1421
20874 #: ../fish/guestfish-actions.pod:1425
20875 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20879 #: ../fish/guestfish-actions.pod:1428
20884 #: ../fish/guestfish-actions.pod:1430
20887 " getxattrs path\n"
20892 #: ../fish/guestfish-actions.pod:1438
20893 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20897 #: ../fish/guestfish-actions.pod:1440
20898 msgid "glob-expand"
20902 #: ../fish/guestfish-actions.pod:1442
20905 " glob-expand pattern\n"
20910 #: ../fish/guestfish-actions.pod:1455
20915 #: ../fish/guestfish-actions.pod:1457
20918 " grep regex path\n"
20923 #: ../fish/guestfish-actions.pod:1465
20928 #: ../fish/guestfish-actions.pod:1467
20931 " grepi regex path\n"
20936 #: ../fish/guestfish-actions.pod:1475
20937 msgid "grub-install"
20941 #: ../fish/guestfish-actions.pod:1477
20944 " grub-install root device\n"
20949 #: ../fish/guestfish-actions.pod:1493
20954 #: ../fish/guestfish-actions.pod:1495
20962 #: ../fish/guestfish-actions.pod:1503
20967 #: ../fish/guestfish-actions.pod:1505
20970 " head-n nrlines path\n"
20975 #: ../fish/guestfish-actions.pod:1518
20980 #: ../fish/guestfish-actions.pod:1520
20988 #: ../fish/guestfish-actions.pod:1528
20993 #: ../fish/guestfish-actions.pod:1530
20996 " initrd-cat initrdpath filename\n"
21001 #: ../fish/guestfish-actions.pod:1542
21002 msgid "See also L</initrd-list>."
21006 #: ../fish/guestfish-actions.pod:1547
21007 msgid "initrd-list"
21011 #: ../fish/guestfish-actions.pod:1549
21014 " initrd-list path\n"
21019 #: ../fish/guestfish-actions.pod:1561
21020 msgid "inotify-add-watch"
21024 #: ../fish/guestfish-actions.pod:1563
21027 " inotify-add-watch path mask\n"
21032 #: ../fish/guestfish-actions.pod:1575
21033 msgid "inotify-close"
21037 #: ../fish/guestfish-actions.pod:1577
21045 #: ../fish/guestfish-actions.pod:1583
21046 msgid "inotify-files"
21050 #: ../fish/guestfish-actions.pod:1585
21058 #: ../fish/guestfish-actions.pod:1587
21060 "This function is a helpful wrapper around L</inotify-read> which just "
21061 "returns a list of pathnames of objects that were touched. The returned "
21062 "pathnames are sorted and deduplicated."
21066 #: ../fish/guestfish-actions.pod:1591
21067 msgid "inotify-init"
21071 #: ../fish/guestfish-actions.pod:1593
21074 " inotify-init maxevents\n"
21079 #: ../fish/guestfish-actions.pod:1599
21081 "C<maxevents> is the maximum number of events which will be queued up between "
21082 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21083 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21084 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21085 "but records the fact that it threw them away by setting a flag "
21086 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21090 #: ../fish/guestfish-actions.pod:1609
21092 "Before any events are generated, you have to add some watches to the "
21093 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21094 "L</inotify-watch-all>."
21098 #: ../fish/guestfish-actions.pod:1615
21100 "Queued up events should be read periodically by calling L</inotify-read> (or "
21101 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21102 "If you don't read the events out often enough then you risk the internal "
21103 "queue overflowing."
21107 #: ../fish/guestfish-actions.pod:1622
21109 "The handle should be closed after use by calling L</inotify-close>. This "
21110 "also removes any watches automatically."
21114 #: ../fish/guestfish-actions.pod:1631
21115 msgid "inotify-read"
21119 #: ../fish/guestfish-actions.pod:1633
21127 #: ../fish/guestfish-actions.pod:1646
21128 msgid "inotify-rm-watch"
21132 #: ../fish/guestfish-actions.pod:1648
21135 " inotify-rm-watch wd\n"
21140 #: ../fish/guestfish-actions.pod:1650
21141 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21145 #: ../fish/guestfish-actions.pod:1653
21146 msgid "inspect-get-arch"
21150 #: ../fish/guestfish-actions.pod:1655
21153 " inspect-get-arch root\n"
21158 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21159 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21160 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21161 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21162 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21163 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21164 #: ../fish/guestfish-actions.pod:1966
21166 "This function should only be called with a root device string as returned by "
21171 #: ../fish/guestfish-actions.pod:1660
21173 "This returns the architecture of the inspected operating system. The "
21174 "possible return values are listed under L</file-architecture>."
21178 #: ../fish/guestfish-actions.pod:1669
21179 msgid "inspect-get-distro"
21183 #: ../fish/guestfish-actions.pod:1671
21186 " inspect-get-distro root\n"
21191 #: ../fish/guestfish-actions.pod:1743
21192 msgid "inspect-get-filesystems"
21196 #: ../fish/guestfish-actions.pod:1745
21199 " inspect-get-filesystems root\n"
21204 #: ../fish/guestfish-actions.pod:1758
21206 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21207 "get-mountpoints>."
21211 #: ../fish/guestfish-actions.pod:1761
21212 msgid "inspect-get-hostname"
21216 #: ../fish/guestfish-actions.pod:1763
21219 " inspect-get-hostname root\n"
21224 #: ../fish/guestfish-actions.pod:1776
21225 msgid "inspect-get-major-version"
21229 #: ../fish/guestfish-actions.pod:1778
21232 " inspect-get-major-version root\n"
21237 #: ../fish/guestfish-actions.pod:1797
21238 msgid "inspect-get-minor-version"
21242 #: ../fish/guestfish-actions.pod:1799
21245 " inspect-get-minor-version root\n"
21250 #: ../fish/guestfish-actions.pod:1809
21252 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21253 "get-major-version>."
21257 #: ../fish/guestfish-actions.pod:1812
21258 msgid "inspect-get-mountpoints"
21262 #: ../fish/guestfish-actions.pod:1814
21265 " inspect-get-mountpoints root\n"
21270 #: ../fish/guestfish-actions.pod:1832
21272 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21273 "get-filesystems>."
21277 #: ../fish/guestfish-actions.pod:1835
21278 msgid "inspect-get-package-format"
21282 #: ../fish/guestfish-actions.pod:1837
21285 " inspect-get-package-format root\n"
21290 #: ../fish/guestfish-actions.pod:1842
21292 "This function and L</inspect-get-package-management> return the package "
21293 "format and package management tool used by the inspected operating system. "
21294 "For example for Fedora these functions would return C<rpm> (package format) "
21295 "and C<yum> (package management)."
21299 #: ../fish/guestfish-actions.pod:1857
21300 msgid "inspect-get-package-management"
21304 #: ../fish/guestfish-actions.pod:1859
21307 " inspect-get-package-management root\n"
21312 #: ../fish/guestfish-actions.pod:1864
21314 "L</inspect-get-package-format> and this function return the package format "
21315 "and package management tool used by the inspected operating system. For "
21316 "example for Fedora these functions would return C<rpm> (package format) and "
21317 "C<yum> (package management)."
21321 #: ../fish/guestfish-actions.pod:1881
21322 msgid "inspect-get-product-name"
21326 #: ../fish/guestfish-actions.pod:1883
21329 " inspect-get-product-name root\n"
21334 #: ../fish/guestfish-actions.pod:1898
21335 msgid "inspect-get-roots"
21339 #: ../fish/guestfish-actions.pod:1900
21342 " inspect-get-roots\n"
21347 #: ../fish/guestfish-actions.pod:1902
21349 "This function is a convenient way to get the list of root devices, as "
21350 "returned from a previous call to L</inspect-os>, but without redoing the "
21351 "whole inspection process."
21355 #: ../fish/guestfish-actions.pod:1906
21357 "This returns an empty list if either no root devices were found or the "
21358 "caller has not called L</inspect-os>."
21362 #: ../fish/guestfish-actions.pod:1911
21363 msgid "inspect-get-type"
21367 #: ../fish/guestfish-actions.pod:1913
21370 " inspect-get-type root\n"
21375 #: ../fish/guestfish-actions.pod:1946
21376 msgid "inspect-get-windows-systemroot"
21380 #: ../fish/guestfish-actions.pod:1948
21383 " inspect-get-windows-systemroot root\n"
21388 #: ../fish/guestfish-actions.pod:1962
21389 msgid "inspect-list-applications"
21393 #: ../fish/guestfish-actions.pod:1964
21396 " inspect-list-applications root\n"
21401 #: ../fish/guestfish-actions.pod:1971
21403 "I<Note:> This call works differently from other parts of the inspection "
21404 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21405 "then mount up the disks, before calling this. Listing applications is a "
21406 "significantly more difficult operation which requires access to the full "
21407 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21408 "are just returning data cached in the libguestfs handle, this call actually "
21409 "reads parts of the mounted filesystems during the call."
21413 #: ../fish/guestfish-actions.pod:2061
21418 #: ../fish/guestfish-actions.pod:2063
21426 #: ../fish/guestfish-actions.pod:2078
21428 "You can pass the root string(s) returned to other L</inspect-get-*> "
21429 "functions in order to query further information about each operating system, "
21430 "such as the name and version."
21434 #: ../fish/guestfish-actions.pod:2083
21436 "This function uses other libguestfs features such as L</mount-ro> and L</"
21437 "umount-all> in order to mount and unmount filesystems and look at the "
21438 "contents. This should be called with no disks currently mounted. The "
21439 "function may also use Augeas, so any existing Augeas handle will be closed."
21443 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21444 #: ../fish/guestfish-actions.pod:2297
21445 msgid "See also L</list-filesystems>."
21449 #: ../fish/guestfish-actions.pod:2097
21450 msgid "is-blockdev"
21454 #: ../fish/guestfish-actions.pod:2099
21457 " is-blockdev path\n"
21462 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21463 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21464 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21465 #: ../fish/guestfish-actions.pod:2203
21466 msgid "See also L</stat>."
21470 #: ../fish/guestfish-actions.pod:2106
21475 #: ../fish/guestfish-actions.pod:2108
21483 #: ../fish/guestfish-actions.pod:2115
21488 #: ../fish/guestfish-actions.pod:2117
21491 " is-chardev path\n"
21496 #: ../fish/guestfish-actions.pod:2124
21501 #: ../fish/guestfish-actions.pod:2126
21509 #: ../fish/guestfish-actions.pod:2133
21514 #: ../fish/guestfish-actions.pod:2135
21522 #: ../fish/guestfish-actions.pod:2143
21527 #: ../fish/guestfish-actions.pod:2145
21535 #: ../fish/guestfish-actions.pod:2152
21540 #: ../fish/guestfish-actions.pod:2154
21548 #: ../fish/guestfish-actions.pod:2162
21549 msgid "is-launching"
21553 #: ../fish/guestfish-actions.pod:2164
21561 #: ../fish/guestfish-actions.pod:2171
21566 #: ../fish/guestfish-actions.pod:2173
21574 #: ../fish/guestfish-actions.pod:2178
21579 #: ../fish/guestfish-actions.pod:2180
21587 #: ../fish/guestfish-actions.pod:2187
21592 #: ../fish/guestfish-actions.pod:2189
21595 " is-socket path\n"
21600 #: ../fish/guestfish-actions.pod:2196
21605 #: ../fish/guestfish-actions.pod:2198
21608 " is-symlink path\n"
21613 #: ../fish/guestfish-actions.pod:2205
21614 msgid "kill-subprocess"
21618 #: ../fish/guestfish-actions.pod:2207
21621 " kill-subprocess\n"
21626 #: ../fish/guestfish-actions.pod:2211
21631 #: ../fish/guestfish-actions.pod:2213
21636 #: ../fish/guestfish-actions.pod:2215
21644 #: ../fish/guestfish-actions.pod:2223
21649 #: ../fish/guestfish-actions.pod:2225
21652 " lchown owner group path\n"
21657 #: ../fish/guestfish-actions.pod:2227
21659 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21660 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21665 #: ../fish/guestfish-actions.pod:2235
21670 #: ../fish/guestfish-actions.pod:2237
21673 " lgetxattrs path\n"
21678 #: ../fish/guestfish-actions.pod:2239
21680 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21681 "it returns the extended attributes of the link itself."
21685 #: ../fish/guestfish-actions.pod:2243
21686 msgid "list-devices"
21690 #: ../fish/guestfish-actions.pod:2245
21698 #: ../fish/guestfish-actions.pod:2253
21699 msgid "list-filesystems"
21703 #: ../fish/guestfish-actions.pod:2255
21706 " list-filesystems\n"
21711 #: ../fish/guestfish-actions.pod:2274
21713 "This command runs other libguestfs commands, which might include L</mount> "
21714 "and L</umount>, and therefore you should use this soon after launch and only "
21715 "when nothing is mounted."
21719 #: ../fish/guestfish-actions.pod:2278
21721 "Not all of the filesystems returned will be mountable. In particular, swap "
21722 "partitions are returned in the list. Also this command does not check that "
21723 "each filesystem found is valid and mountable, and some filesystems might be "
21724 "mountable but require special options. Filesystems may not all belong to a "
21725 "single logical operating system (use L</inspect-os> to look for OSes)."
21729 #: ../fish/guestfish-actions.pod:2286
21730 msgid "list-partitions"
21734 #: ../fish/guestfish-actions.pod:2288
21737 " list-partitions\n"
21742 #: ../fish/guestfish-actions.pod:2294
21744 "This does not return logical volumes. For that you will need to call L</"
21749 #: ../fish/guestfish-actions.pod:2299
21754 #: ../fish/guestfish-actions.pod:2301
21762 #: ../fish/guestfish-actions.pod:2309
21767 #: ../fish/guestfish-actions.pod:2311
21770 " ln target linkname\n"
21775 #: ../fish/guestfish-actions.pod:2315
21780 #: ../fish/guestfish-actions.pod:2317
21783 " ln-f target linkname\n"
21788 #: ../fish/guestfish-actions.pod:2322
21793 #: ../fish/guestfish-actions.pod:2324
21796 " ln-s target linkname\n"
21801 #: ../fish/guestfish-actions.pod:2328
21806 #: ../fish/guestfish-actions.pod:2330
21809 " ln-sf target linkname\n"
21814 #: ../fish/guestfish-actions.pod:2335
21815 msgid "lremovexattr"
21819 #: ../fish/guestfish-actions.pod:2337
21822 " lremovexattr xattr path\n"
21827 #: ../fish/guestfish-actions.pod:2339
21829 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21830 "it removes an extended attribute of the link itself."
21834 #: ../fish/guestfish-actions.pod:2343
21839 #: ../fish/guestfish-actions.pod:2345
21847 #: ../fish/guestfish-actions.pod:2351
21849 "This command is mostly useful for interactive sessions. Programs should "
21850 "probably use L</readdir> instead."
21854 #: ../fish/guestfish-actions.pod:2354
21859 #: ../fish/guestfish-actions.pod:2356
21862 " lsetxattr xattr val vallen path\n"
21867 #: ../fish/guestfish-actions.pod:2358
21869 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21870 "sets an extended attribute of the link itself."
21874 #: ../fish/guestfish-actions.pod:2362
21879 #: ../fish/guestfish-actions.pod:2364
21887 #: ../fish/guestfish-actions.pod:2368
21889 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21890 "the link is stat-ed, not the file it refers to."
21894 #: ../fish/guestfish-actions.pod:2374
21899 #: ../fish/guestfish-actions.pod:2376
21902 " lstatlist path 'names ...'\n"
21907 #: ../fish/guestfish-actions.pod:2378
21909 "This call allows you to perform the L</lstat> operation on multiple files, "
21910 "where all files are in the directory C<path>. C<names> is the list of files "
21911 "from this directory."
21915 #: ../fish/guestfish-actions.pod:2387
21917 "This call is intended for programs that want to efficiently list a directory "
21918 "contents without making many round-trips. See also L</lxattrlist> for a "
21919 "similarly efficient call for getting extended attributes. Very long "
21920 "directory listings might cause the protocol message size to be exceeded, "
21921 "causing this call to fail. The caller must split up such requests into "
21922 "smaller groups of names."
21926 #: ../fish/guestfish-actions.pod:2395
21927 msgid "luks-add-key"
21931 #: ../fish/guestfish-actions.pod:2397
21934 " luks-add-key device keyslot\n"
21939 #: ../fish/guestfish-actions.pod:2404
21941 "Note that if C<keyslot> already contains a key, then this command will "
21942 "fail. You have to use L</luks-kill-slot> first to remove that key."
21946 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21947 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21948 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21950 "This command has one or more key or passphrase parameters. Guestfish will "
21951 "prompt for these separately."
21955 #: ../fish/guestfish-actions.pod:2411
21960 #: ../fish/guestfish-actions.pod:2413
21963 " luks-close device\n"
21968 #: ../fish/guestfish-actions.pod:2415
21970 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21971 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21972 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21977 #: ../fish/guestfish-actions.pod:2421
21978 msgid "luks-format"
21982 #: ../fish/guestfish-actions.pod:2423
21985 " luks-format device keyslot\n"
21990 #: ../fish/guestfish-actions.pod:2436
21991 msgid "luks-format-cipher"
21995 #: ../fish/guestfish-actions.pod:2438
21998 " luks-format-cipher device keyslot cipher\n"
22003 #: ../fish/guestfish-actions.pod:2440
22005 "This command is the same as L</luks-format> but it also allows you to set "
22006 "the C<cipher> used."
22010 #: ../fish/guestfish-actions.pod:2449
22011 msgid "luks-kill-slot"
22015 #: ../fish/guestfish-actions.pod:2451
22018 " luks-kill-slot device keyslot\n"
22023 #: ../fish/guestfish-actions.pod:2460
22028 #: ../fish/guestfish-actions.pod:2462
22031 " luks-open device mapname\n"
22036 #: ../fish/guestfish-actions.pod:2476
22038 "If this block device contains LVM volume groups, then calling L</vgscan> "
22039 "followed by L</vg-activate-all> will make them visible."
22043 #: ../fish/guestfish-actions.pod:2483
22044 msgid "luks-open-ro"
22048 #: ../fish/guestfish-actions.pod:2485
22051 " luks-open-ro device mapname\n"
22056 #: ../fish/guestfish-actions.pod:2487
22058 "This is the same as L</luks-open> except that a read-only mapping is created."
22062 #: ../fish/guestfish-actions.pod:2493
22067 #: ../fish/guestfish-actions.pod:2495
22070 " lvcreate logvol volgroup mbytes\n"
22075 #: ../fish/guestfish-actions.pod:2500
22076 msgid "lvm-canonical-lv-name"
22080 #: ../fish/guestfish-actions.pod:2502
22083 " lvm-canonical-lv-name lvname\n"
22088 #: ../fish/guestfish-actions.pod:2511
22089 msgid "See also L</is-lv>."
22093 #: ../fish/guestfish-actions.pod:2513
22094 msgid "lvm-clear-filter"
22098 #: ../fish/guestfish-actions.pod:2515
22101 " lvm-clear-filter\n"
22106 #: ../fish/guestfish-actions.pod:2517
22108 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22113 #: ../fish/guestfish-actions.pod:2523
22114 msgid "lvm-remove-all"
22118 #: ../fish/guestfish-actions.pod:2525
22121 " lvm-remove-all\n"
22126 #: ../fish/guestfish-actions.pod:2533
22127 msgid "lvm-set-filter"
22131 #: ../fish/guestfish-actions.pod:2535
22134 " lvm-set-filter 'devices ...'\n"
22139 #: ../fish/guestfish-actions.pod:2560
22144 #: ../fish/guestfish-actions.pod:2562
22147 " lvremove device\n"
22152 #: ../fish/guestfish-actions.pod:2570
22157 #: ../fish/guestfish-actions.pod:2572
22160 " lvrename logvol newlogvol\n"
22165 #: ../fish/guestfish-actions.pod:2576
22170 #: ../fish/guestfish-actions.pod:2578
22173 " lvresize device mbytes\n"
22178 #: ../fish/guestfish-actions.pod:2584
22179 msgid "lvresize-free"
22183 #: ../fish/guestfish-actions.pod:2586
22186 " lvresize-free lv percent\n"
22191 #: ../fish/guestfish-actions.pod:2594
22196 #: ../fish/guestfish-actions.pod:2596
22204 #: ../fish/guestfish-actions.pod:2604
22205 msgid "See also L</lvs-full>, L</list-filesystems>."
22209 #: ../fish/guestfish-actions.pod:2606
22214 #: ../fish/guestfish-actions.pod:2608
22222 #: ../fish/guestfish-actions.pod:2613
22227 #: ../fish/guestfish-actions.pod:2615
22235 #: ../fish/guestfish-actions.pod:2619
22240 #: ../fish/guestfish-actions.pod:2621
22243 " lxattrlist path 'names ...'\n"
22248 #: ../fish/guestfish-actions.pod:2637
22250 "This call is intended for programs that want to efficiently list a directory "
22251 "contents without making many round-trips. See also L</lstatlist> for a "
22252 "similarly efficient call for getting standard stats. Very long directory "
22253 "listings might cause the protocol message size to be exceeded, causing this "
22254 "call to fail. The caller must split up such requests into smaller groups of "
22259 #: ../fish/guestfish-actions.pod:2645
22264 #: ../fish/guestfish-actions.pod:2647
22272 #: ../fish/guestfish-actions.pod:2651
22277 #: ../fish/guestfish-actions.pod:2653
22280 " mkdir-mode path mode\n"
22285 #: ../fish/guestfish-actions.pod:2662
22286 msgid "See also L</mkdir>, L</umask>"
22290 #: ../fish/guestfish-actions.pod:2664
22295 #: ../fish/guestfish-actions.pod:2666
22303 #: ../fish/guestfish-actions.pod:2671
22308 #: ../fish/guestfish-actions.pod:2673
22311 " mkdtemp template\n"
22316 #: ../fish/guestfish-actions.pod:2694
22321 #: ../fish/guestfish-actions.pod:2696
22324 " mke2fs-J fstype blocksize device journal\n"
22329 #: ../fish/guestfish-actions.pod:2704
22330 msgid "See also L</mke2journal>."
22334 #: ../fish/guestfish-actions.pod:2706
22339 #: ../fish/guestfish-actions.pod:2708
22342 " mke2fs-JL fstype blocksize device label\n"
22347 #: ../fish/guestfish-actions.pod:2713
22348 msgid "See also L</mke2journal-L>."
22352 #: ../fish/guestfish-actions.pod:2715
22357 #: ../fish/guestfish-actions.pod:2717
22360 " mke2fs-JU fstype blocksize device uuid\n"
22365 #: ../fish/guestfish-actions.pod:2722
22366 msgid "See also L</mke2journal-U>."
22370 #: ../fish/guestfish-actions.pod:2724
22371 msgid "mke2journal"
22375 #: ../fish/guestfish-actions.pod:2726
22378 " mke2journal blocksize device\n"
22383 #: ../fish/guestfish-actions.pod:2733
22384 msgid "mke2journal-L"
22388 #: ../fish/guestfish-actions.pod:2735
22391 " mke2journal-L blocksize label device\n"
22396 #: ../fish/guestfish-actions.pod:2739
22397 msgid "mke2journal-U"
22401 #: ../fish/guestfish-actions.pod:2741
22404 " mke2journal-U blocksize uuid device\n"
22409 #: ../fish/guestfish-actions.pod:2745
22414 #: ../fish/guestfish-actions.pod:2747
22417 " mkfifo mode path\n"
22422 #: ../fish/guestfish-actions.pod:2749
22424 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22425 "is just a convenient wrapper around L</mknod>."
22429 #: ../fish/guestfish-actions.pod:2755
22434 #: ../fish/guestfish-actions.pod:2757
22437 " mkfs fstype device\n"
22442 #: ../fish/guestfish-actions.pod:2763
22447 #: ../fish/guestfish-actions.pod:2765
22450 " mkfs-b fstype blocksize device\n"
22455 #: ../fish/guestfish-actions.pod:2767
22457 "This call is similar to L</mkfs>, but it allows you to control the block "
22458 "size of the resulting filesystem. Supported block sizes depend on the "
22459 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22463 #: ../fish/guestfish-actions.pod:2775
22464 msgid "mkmountpoint"
22468 #: ../fish/guestfish-actions.pod:2777
22471 " mkmountpoint exemptpath\n"
22476 #: ../fish/guestfish-actions.pod:2779
22478 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22479 "to create extra mountpoints before mounting the first filesystem."
22483 #: ../fish/guestfish-actions.pod:2803
22485 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22486 "unexpected errors if you try to mix these calls. It is safest to manually "
22487 "unmount filesystems and remove mountpoints after use."
22491 #: ../fish/guestfish-actions.pod:2807
22493 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22494 "for this to work for manual mountpoints, you must ensure that the innermost "
22495 "mountpoints have the longest pathnames, as in the example code above."
22499 #: ../fish/guestfish-actions.pod:2814
22501 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22502 "that L</umount-all> is called when the handle is closed which can also "
22503 "trigger these issues."
22507 #: ../fish/guestfish-actions.pod:2818
22512 #: ../fish/guestfish-actions.pod:2820
22515 " mknod mode devmajor devminor path\n"
22520 #: ../fish/guestfish-actions.pod:2830
22522 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22523 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22524 "regular file). These constants are available in the standard Linux header "
22525 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22526 "wrappers around this command which bitwise OR in the appropriate constant "
22531 #: ../fish/guestfish-actions.pod:2840
22536 #: ../fish/guestfish-actions.pod:2842
22539 " mknod-b mode devmajor devminor path\n"
22544 #: ../fish/guestfish-actions.pod:2844
22546 "This call creates a block device node called C<path> with mode C<mode> and "
22547 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22548 "wrapper around L</mknod>."
22552 #: ../fish/guestfish-actions.pod:2850
22557 #: ../fish/guestfish-actions.pod:2852
22560 " mknod-c mode devmajor devminor path\n"
22565 #: ../fish/guestfish-actions.pod:2854
22567 "This call creates a char device node called C<path> with mode C<mode> and "
22568 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22569 "wrapper around L</mknod>."
22573 #: ../fish/guestfish-actions.pod:2860
22578 #: ../fish/guestfish-actions.pod:2862
22586 #: ../fish/guestfish-actions.pod:2866
22591 #: ../fish/guestfish-actions.pod:2868
22594 " mkswap-L label device\n"
22599 #: ../fish/guestfish-actions.pod:2876
22604 #: ../fish/guestfish-actions.pod:2878
22607 " mkswap-U uuid device\n"
22612 #: ../fish/guestfish-actions.pod:2882
22613 msgid "mkswap-file"
22617 #: ../fish/guestfish-actions.pod:2884
22620 " mkswap-file path\n"
22625 #: ../fish/guestfish-actions.pod:2888
22627 "This command just writes a swap file signature to an existing file. To "
22628 "create the file itself, use something like L</fallocate>."
22632 #: ../fish/guestfish-actions.pod:2891
22637 #: ../fish/guestfish-actions.pod:2893
22640 " modprobe modulename\n"
22645 #: ../fish/guestfish-actions.pod:2900
22650 #: ../fish/guestfish-actions.pod:2902
22653 " mount device mountpoint\n"
22658 #: ../fish/guestfish-actions.pod:2918
22660 "B<Important note:> When you use this call, the filesystem options C<sync> "
22661 "and C<noatime> are set implicitly. This was originally done because we "
22662 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22663 "very large negative performance impact and negligible effect on "
22664 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22665 "code that needs performance, and instead use L</mount-options> (use an empty "
22666 "string for the first parameter if you don't want any options)."
22670 #: ../fish/guestfish-actions.pod:2928
22675 #: ../fish/guestfish-actions.pod:2930
22678 " mount-loop file mountpoint\n"
22683 #: ../fish/guestfish-actions.pod:2936
22684 msgid "mount-options"
22688 #: ../fish/guestfish-actions.pod:2938
22691 " mount-options options device mountpoint\n"
22696 #: ../fish/guestfish-actions.pod:2940
22698 "This is the same as the L</mount> command, but it allows you to set the "
22699 "mount options as for the L<mount(8)> I<-o> flag."
22703 #: ../fish/guestfish-actions.pod:2948
22708 #: ../fish/guestfish-actions.pod:2950
22711 " mount-ro device mountpoint\n"
22716 #: ../fish/guestfish-actions.pod:2952
22718 "This is the same as the L</mount> command, but it mounts the filesystem with "
22719 "the read-only (I<-o ro>) flag."
22723 #: ../fish/guestfish-actions.pod:2955
22728 #: ../fish/guestfish-actions.pod:2957
22731 " mount-vfs options vfstype device mountpoint\n"
22736 #: ../fish/guestfish-actions.pod:2959
22738 "This is the same as the L</mount> command, but it allows you to set both the "
22739 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22743 #: ../fish/guestfish-actions.pod:2963
22744 msgid "mountpoints"
22748 #: ../fish/guestfish-actions.pod:2965
22756 #: ../fish/guestfish-actions.pod:2967
22758 "This call is similar to L</mounts>. That call returns a list of devices. "
22759 "This one returns a hash table (map) of device name to directory where the "
22760 "device is mounted."
22764 #: ../fish/guestfish-actions.pod:2971
22769 #: ../fish/guestfish-actions.pod:2973
22777 #: ../fish/guestfish-actions.pod:2980
22778 msgid "See also: L</mountpoints>"
22782 #: ../fish/guestfish-actions.pod:2982
22787 #: ../fish/guestfish-actions.pod:2984
22795 #: ../fish/guestfish-actions.pod:2989
22796 msgid "ntfs-3g-probe"
22800 #: ../fish/guestfish-actions.pod:2991
22803 " ntfs-3g-probe true|false device\n"
22808 #: ../fish/guestfish-actions.pod:3005
22813 #: ../fish/guestfish-actions.pod:3007
22816 " ntfsresize device\n"
22821 #: ../fish/guestfish-actions.pod:3013
22822 msgid "ntfsresize-size"
22826 #: ../fish/guestfish-actions.pod:3015
22829 " ntfsresize-size device size\n"
22834 #: ../fish/guestfish-actions.pod:3017
22836 "This command is the same as L</ntfsresize> except that it allows you to "
22837 "specify the new size (in bytes) explicitly."
22841 #: ../fish/guestfish-actions.pod:3020
22846 #: ../fish/guestfish-actions.pod:3022
22849 " part-add device prlogex startsect endsect\n"
22854 #: ../fish/guestfish-actions.pod:3024
22856 "This command adds a partition to C<device>. If there is no partition table "
22857 "on the device, call L</part-init> first."
22861 #: ../fish/guestfish-actions.pod:3036
22863 "Creating a partition which covers the whole disk is not so easy. Use L</"
22864 "part-disk> to do that."
22868 #: ../fish/guestfish-actions.pod:3039
22873 #: ../fish/guestfish-actions.pod:3041
22876 " part-del device partnum\n"
22881 #: ../fish/guestfish-actions.pod:3049
22886 #: ../fish/guestfish-actions.pod:3051
22889 " part-disk device parttype\n"
22894 #: ../fish/guestfish-actions.pod:3053
22896 "This command is simply a combination of L</part-init> followed by L</part-"
22897 "add> to create a single primary partition covering the whole disk."
22901 #: ../fish/guestfish-actions.pod:3057
22903 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22904 "possible values are described in L</part-init>."
22908 #: ../fish/guestfish-actions.pod:3063
22909 msgid "part-get-bootable"
22913 #: ../fish/guestfish-actions.pod:3065
22916 " part-get-bootable device partnum\n"
22921 #: ../fish/guestfish-actions.pod:3070
22922 msgid "See also L</part-set-bootable>."
22926 #: ../fish/guestfish-actions.pod:3072
22927 msgid "part-get-mbr-id"
22931 #: ../fish/guestfish-actions.pod:3074
22934 " part-get-mbr-id device partnum\n"
22939 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22941 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22942 "undefined results for other partition table types (see L</part-get-"
22947 #: ../fish/guestfish-actions.pod:3083
22948 msgid "part-get-parttype"
22952 #: ../fish/guestfish-actions.pod:3085
22955 " part-get-parttype device\n"
22960 #: ../fish/guestfish-actions.pod:3090
22962 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22963 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22964 "possible, although unusual. See L</part-init> for a full list."
22968 #: ../fish/guestfish-actions.pod:3095
22973 #: ../fish/guestfish-actions.pod:3097
22976 " part-init device parttype\n"
22981 #: ../fish/guestfish-actions.pod:3103
22983 "Initially there are no partitions. Following this, you should call L</part-"
22984 "add> for each partition required."
22988 #: ../fish/guestfish-actions.pod:3166
22993 #: ../fish/guestfish-actions.pod:3168
22996 " part-list device\n"
23001 #: ../fish/guestfish-actions.pod:3183
23003 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23004 "the device's sector size, see L</blockdev-getss>."
23008 #: ../fish/guestfish-actions.pod:3196
23009 msgid "part-set-bootable"
23013 #: ../fish/guestfish-actions.pod:3198
23016 " part-set-bootable device partnum true|false\n"
23021 #: ../fish/guestfish-actions.pod:3207
23022 msgid "part-set-mbr-id"
23026 #: ../fish/guestfish-actions.pod:3209
23029 " part-set-mbr-id device partnum idbyte\n"
23034 #: ../fish/guestfish-actions.pod:3221
23035 msgid "part-set-name"
23039 #: ../fish/guestfish-actions.pod:3223
23042 " part-set-name device partnum name\n"
23047 #: ../fish/guestfish-actions.pod:3231
23048 msgid "part-to-dev"
23052 #: ../fish/guestfish-actions.pod:3233
23055 " part-to-dev partition\n"
23060 #: ../fish/guestfish-actions.pod:3239
23062 "The named partition must exist, for example as a string returned from L</"
23063 "list-partitions>."
23067 #: ../fish/guestfish-actions.pod:3242
23068 msgid "ping-daemon"
23072 #: ../fish/guestfish-actions.pod:3244
23080 #: ../fish/guestfish-actions.pod:3251
23085 #: ../fish/guestfish-actions.pod:3253
23088 " pread path count offset\n"
23093 #: ../fish/guestfish-actions.pod:3261
23094 msgid "See also L</pwrite>, L</pread-device>."
23098 #: ../fish/guestfish-actions.pod:3266
23099 msgid "pread-device"
23103 #: ../fish/guestfish-actions.pod:3268
23106 " pread-device device count offset\n"
23111 #: ../fish/guestfish-actions.pod:3276
23112 msgid "See also L</pread>."
23116 #: ../fish/guestfish-actions.pod:3281
23121 #: ../fish/guestfish-actions.pod:3283
23124 " pvcreate device\n"
23129 #: ../fish/guestfish-actions.pod:3289
23134 #: ../fish/guestfish-actions.pod:3291
23137 " pvremove device\n"
23142 #: ../fish/guestfish-actions.pod:3300
23147 #: ../fish/guestfish-actions.pod:3302
23150 " pvresize device\n"
23155 #: ../fish/guestfish-actions.pod:3307
23156 msgid "pvresize-size"
23160 #: ../fish/guestfish-actions.pod:3309
23163 " pvresize-size device size\n"
23168 #: ../fish/guestfish-actions.pod:3311
23170 "This command is the same as L</pvresize> except that it allows you to "
23171 "specify the new size (in bytes) explicitly."
23175 #: ../fish/guestfish-actions.pod:3314
23180 #: ../fish/guestfish-actions.pod:3316
23188 #: ../fish/guestfish-actions.pod:3324
23189 msgid "See also L</pvs-full>."
23193 #: ../fish/guestfish-actions.pod:3326
23198 #: ../fish/guestfish-actions.pod:3328
23206 #: ../fish/guestfish-actions.pod:3333
23211 #: ../fish/guestfish-actions.pod:3335
23219 #: ../fish/guestfish-actions.pod:3339
23224 #: ../fish/guestfish-actions.pod:3341
23227 " pwrite path content offset\n"
23232 #: ../fish/guestfish-actions.pod:3352
23233 msgid "See also L</pread>, L</pwrite-device>."
23237 #: ../fish/guestfish-actions.pod:3357
23238 msgid "pwrite-device"
23242 #: ../fish/guestfish-actions.pod:3359
23245 " pwrite-device device content offset\n"
23250 #: ../fish/guestfish-actions.pod:3369
23251 msgid "See also L</pwrite>."
23255 #: ../fish/guestfish-actions.pod:3374
23260 #: ../fish/guestfish-actions.pod:3376
23263 " read-file path\n"
23268 #: ../fish/guestfish-actions.pod:3381
23270 "Unlike L</cat>, this function can correctly handle files that contain "
23271 "embedded ASCII NUL characters. However unlike L</download>, this function "
23272 "is limited in the total size of file that can be handled."
23276 #: ../fish/guestfish-actions.pod:3389
23281 #: ../fish/guestfish-actions.pod:3391
23284 " read-lines path\n"
23289 #: ../fish/guestfish-actions.pod:3398
23291 "Note that this function cannot correctly handle binary files (specifically, "
23292 "files containing C<\\0> character which is treated as end of line). For "
23293 "those you need to use the L</read-file> function which has a more complex "
23298 #: ../fish/guestfish-actions.pod:3403
23303 #: ../fish/guestfish-actions.pod:3405
23311 #: ../fish/guestfish-actions.pod:3457
23313 "This function is primarily intended for use by programs. To get a simple "
23314 "list of names, use L</ls>. To get a printable directory for human "
23315 "consumption, use L</ll>."
23319 #: ../fish/guestfish-actions.pod:3461
23324 #: ../fish/guestfish-actions.pod:3463
23332 #: ../fish/guestfish-actions.pod:3467
23333 msgid "readlinklist"
23337 #: ../fish/guestfish-actions.pod:3469
23340 " readlinklist path 'names ...'\n"
23345 #: ../fish/guestfish-actions.pod:3493
23350 #: ../fish/guestfish-actions.pod:3495
23358 #: ../fish/guestfish-actions.pod:3500
23359 msgid "removexattr"
23363 #: ../fish/guestfish-actions.pod:3502
23366 " removexattr xattr path\n"
23371 #: ../fish/guestfish-actions.pod:3507
23372 msgid "See also: L</lremovexattr>, L<attr(5)>."
23376 #: ../fish/guestfish-actions.pod:3509
23381 #: ../fish/guestfish-actions.pod:3511
23384 " resize2fs device\n"
23389 #: ../fish/guestfish-actions.pod:3516
23391 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23392 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23393 "gives an error about this and sometimes not. In any case, it is always safe "
23394 "to call L</e2fsck-f> before calling this function."
23398 #: ../fish/guestfish-actions.pod:3522
23399 msgid "resize2fs-size"
23403 #: ../fish/guestfish-actions.pod:3524
23406 " resize2fs-size device size\n"
23411 #: ../fish/guestfish-actions.pod:3526
23413 "This command is the same as L</resize2fs> except that it allows you to "
23414 "specify the new size (in bytes) explicitly."
23418 #: ../fish/guestfish-actions.pod:3529
23423 #: ../fish/guestfish-actions.pod:3531
23431 #: ../fish/guestfish-actions.pod:3535
23436 #: ../fish/guestfish-actions.pod:3537
23444 #: ../fish/guestfish-actions.pod:3543
23449 #: ../fish/guestfish-actions.pod:3545
23457 #: ../fish/guestfish-actions.pod:3549
23458 msgid "rmmountpoint"
23462 #: ../fish/guestfish-actions.pod:3551
23465 " rmmountpoint exemptpath\n"
23470 #: ../fish/guestfish-actions.pod:3553
23472 "This calls removes a mountpoint that was previously created with L</"
23473 "mkmountpoint>. See L</mkmountpoint> for full details."
23477 #: ../fish/guestfish-actions.pod:3557
23478 msgid "scrub-device"
23482 #: ../fish/guestfish-actions.pod:3559
23485 " scrub-device device\n"
23490 #: ../fish/guestfish-actions.pod:3570
23495 #: ../fish/guestfish-actions.pod:3572
23498 " scrub-file file\n"
23503 #: ../fish/guestfish-actions.pod:3582
23504 msgid "scrub-freespace"
23508 #: ../fish/guestfish-actions.pod:3584
23511 " scrub-freespace dir\n"
23516 #: ../fish/guestfish-actions.pod:3586
23518 "This command creates the directory C<dir> and then fills it with files until "
23519 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23520 "deletes them. The intention is to scrub any free space on the partition "
23521 "containing C<dir>."
23525 #: ../fish/guestfish-actions.pod:3595
23530 #: ../fish/guestfish-actions.pod:3597
23535 #: ../fish/guestfish-actions.pod:3599
23538 " set-append append\n"
23543 #: ../fish/guestfish-actions.pod:3610
23544 msgid "set-autosync"
23548 #: ../fish/guestfish-actions.pod:3612
23553 #: ../fish/guestfish-actions.pod:3614
23556 " set-autosync true|false\n"
23561 #: ../fish/guestfish-actions.pod:3616
23563 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23564 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23565 "closed (also if the program exits without closing handles)."
23569 #: ../fish/guestfish-actions.pod:3624
23574 #: ../fish/guestfish-actions.pod:3626
23579 #: ../fish/guestfish-actions.pod:3628
23582 " set-direct true|false\n"
23587 #: ../fish/guestfish-actions.pod:3634
23589 "One consequence of this is that log messages aren't caught by the library "
23590 "and handled by L</set-log-message-callback>, but go straight to stdout."
23594 #: ../fish/guestfish-actions.pod:3643
23595 msgid "set-e2label"
23599 #: ../fish/guestfish-actions.pod:3645
23602 " set-e2label device label\n"
23607 #: ../fish/guestfish-actions.pod:3651
23609 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23610 "label on a filesystem."
23614 #: ../fish/guestfish-actions.pod:3654
23619 #: ../fish/guestfish-actions.pod:3656
23622 " set-e2uuid device uuid\n"
23627 #: ../fish/guestfish-actions.pod:3663
23629 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23630 "UUID of a filesystem."
23634 #: ../fish/guestfish-actions.pod:3666
23635 msgid "set-memsize"
23639 #: ../fish/guestfish-actions.pod:3668
23644 #: ../fish/guestfish-actions.pod:3670
23647 " set-memsize memsize\n"
23652 #: ../fish/guestfish-actions.pod:3672
23654 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23655 "This only has any effect if called before L</launch>."
23659 #: ../fish/guestfish-actions.pod:3683
23660 msgid "set-network"
23664 #: ../fish/guestfish-actions.pod:3685
23669 #: ../fish/guestfish-actions.pod:3687
23672 " set-network true|false\n"
23677 #: ../fish/guestfish-actions.pod:3695
23679 "You must call this before calling L</launch>, otherwise it has no effect."
23683 #: ../fish/guestfish-actions.pod:3698
23688 #: ../fish/guestfish-actions.pod:3700
23693 #: ../fish/guestfish-actions.pod:3702
23696 " set-path searchpath\n"
23701 #: ../fish/guestfish-actions.pod:3711
23706 #: ../fish/guestfish-actions.pod:3713
23711 #: ../fish/guestfish-actions.pod:3715
23719 #: ../fish/guestfish-actions.pod:3735
23720 msgid "set-recovery-proc"
23724 #: ../fish/guestfish-actions.pod:3737
23725 msgid "recovery-proc"
23729 #: ../fish/guestfish-actions.pod:3739
23732 " set-recovery-proc true|false\n"
23737 #: ../fish/guestfish-actions.pod:3741
23739 "If this is called with the parameter C<false> then L</launch> does not "
23740 "create a recovery process. The purpose of the recovery process is to stop "
23741 "runaway qemu processes in the case where the main program aborts abruptly."
23745 #: ../fish/guestfish-actions.pod:3746
23747 "This only has any effect if called before L</launch>, and the default is "
23752 #: ../fish/guestfish-actions.pod:3755
23753 msgid "set-selinux"
23757 #: ../fish/guestfish-actions.pod:3757
23762 #: ../fish/guestfish-actions.pod:3759
23765 " set-selinux true|false\n"
23770 #: ../fish/guestfish-actions.pod:3770
23775 #: ../fish/guestfish-actions.pod:3772
23780 #: ../fish/guestfish-actions.pod:3774
23783 " set-trace true|false\n"
23788 #: ../fish/guestfish-actions.pod:3790
23789 msgid "set-verbose"
23793 #: ../fish/guestfish-actions.pod:3792
23798 #: ../fish/guestfish-actions.pod:3794
23801 " set-verbose true|false\n"
23806 #: ../fish/guestfish-actions.pod:3801
23811 #: ../fish/guestfish-actions.pod:3803
23814 " setcon context\n"
23819 #: ../fish/guestfish-actions.pod:3810
23824 #: ../fish/guestfish-actions.pod:3812
23827 " setxattr xattr val vallen path\n"
23832 #: ../fish/guestfish-actions.pod:3818
23833 msgid "See also: L</lsetxattr>, L<attr(5)>."
23837 #: ../fish/guestfish-actions.pod:3820
23842 #: ../fish/guestfish-actions.pod:3822
23845 " sfdisk device cyls heads sectors 'lines ...'\n"
23850 #: ../fish/guestfish-actions.pod:3844
23851 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23855 #: ../fish/guestfish-actions.pod:3850
23860 #: ../fish/guestfish-actions.pod:3852
23863 " sfdiskM device 'lines ...'\n"
23868 #: ../fish/guestfish-actions.pod:3854
23870 "This is a simplified interface to the L</sfdisk> command, where partition "
23871 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23872 "you don't need to specify the cyls, heads and sectors parameters which were "
23873 "rarely if ever used anyway."
23877 #: ../fish/guestfish-actions.pod:3860
23878 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23882 #: ../fish/guestfish-actions.pod:3866
23887 #: ../fish/guestfish-actions.pod:3868
23890 " sfdisk-N device partnum cyls heads sectors line\n"
23895 #: ../fish/guestfish-actions.pod:3873
23897 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23898 "cyls/heads/sectors parameters."
23902 #: ../fish/guestfish-actions.pod:3876
23903 msgid "See also: L</part-add>"
23907 #: ../fish/guestfish-actions.pod:3881
23908 msgid "sfdisk-disk-geometry"
23912 #: ../fish/guestfish-actions.pod:3883
23915 " sfdisk-disk-geometry device\n"
23920 #: ../fish/guestfish-actions.pod:3885
23922 "This displays the disk geometry of C<device> read from the partition table. "
23923 "Especially in the case where the underlying block device has been resized, "
23924 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23925 "kernel-geometry>)."
23929 #: ../fish/guestfish-actions.pod:3893
23930 msgid "sfdisk-kernel-geometry"
23934 #: ../fish/guestfish-actions.pod:3895
23937 " sfdisk-kernel-geometry device\n"
23942 #: ../fish/guestfish-actions.pod:3902
23947 #: ../fish/guestfish-actions.pod:3904
23950 " sfdisk-l device\n"
23955 #: ../fish/guestfish-actions.pod:3910
23956 msgid "See also: L</part-list>"
23960 #: ../fish/guestfish-actions.pod:3912
23965 #: ../fish/guestfish-actions.pod:3914
23973 #: ../fish/guestfish-actions.pod:3919
23974 msgid "This is like L</command>, but passes the command to:"
23978 #: ../fish/guestfish-actions.pod:3927
23979 msgid "All the provisos about L</command> apply to this call."
23983 #: ../fish/guestfish-actions.pod:3929
23988 #: ../fish/guestfish-actions.pod:3931
23991 " sh-lines command\n"
23996 #: ../fish/guestfish-actions.pod:3933
23997 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24001 #: ../fish/guestfish-actions.pod:3936
24002 msgid "See also: L</command-lines>"
24006 #: ../fish/guestfish-actions.pod:3938
24011 #: ../fish/guestfish-actions.pod:3940
24019 #: ../fish/guestfish-actions.pod:3944
24024 #: ../fish/guestfish-actions.pod:3946
24032 #: ../fish/guestfish-actions.pod:3952
24037 #: ../fish/guestfish-actions.pod:3954
24045 #: ../fish/guestfish-actions.pod:3962
24050 #: ../fish/guestfish-actions.pod:3964
24058 #: ../fish/guestfish-actions.pod:3972
24063 #: ../fish/guestfish-actions.pod:3974
24066 " strings-e encoding path\n"
24071 #: ../fish/guestfish-actions.pod:3976
24073 "This is like the L</strings> command, but allows you to specify the encoding "
24074 "of strings that are looked for in the source file C<path>."
24078 #: ../fish/guestfish-actions.pod:3986
24080 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24081 "ISO-8859-X (this is what L</strings> uses)."
24085 #: ../fish/guestfish-actions.pod:4018
24086 msgid "swapoff-device"
24090 #: ../fish/guestfish-actions.pod:4020
24093 " swapoff-device device\n"
24098 #: ../fish/guestfish-actions.pod:4022
24100 "This command disables the libguestfs appliance swap device or partition "
24101 "named C<device>. See L</swapon-device>."
24105 #: ../fish/guestfish-actions.pod:4026
24106 msgid "swapoff-file"
24110 #: ../fish/guestfish-actions.pod:4028
24113 " swapoff-file file\n"
24118 #: ../fish/guestfish-actions.pod:4032
24119 msgid "swapoff-label"
24123 #: ../fish/guestfish-actions.pod:4034
24126 " swapoff-label label\n"
24131 #: ../fish/guestfish-actions.pod:4039
24132 msgid "swapoff-uuid"
24136 #: ../fish/guestfish-actions.pod:4041
24139 " swapoff-uuid uuid\n"
24144 #: ../fish/guestfish-actions.pod:4046
24145 msgid "swapon-device"
24149 #: ../fish/guestfish-actions.pod:4048
24152 " swapon-device device\n"
24157 #: ../fish/guestfish-actions.pod:4050
24159 "This command enables the libguestfs appliance to use the swap device or "
24160 "partition named C<device>. The increased memory is made available for all "
24161 "commands, for example those run using L</command> or L</sh>."
24165 #: ../fish/guestfish-actions.pod:4062
24166 msgid "swapon-file"
24170 #: ../fish/guestfish-actions.pod:4064
24173 " swapon-file file\n"
24178 #: ../fish/guestfish-actions.pod:4066
24180 "This command enables swap to a file. See L</swapon-device> for other notes."
24184 #: ../fish/guestfish-actions.pod:4069
24185 msgid "swapon-label"
24189 #: ../fish/guestfish-actions.pod:4071
24192 " swapon-label label\n"
24197 #: ../fish/guestfish-actions.pod:4073
24199 "This command enables swap to a labeled swap partition. See L</swapon-"
24200 "device> for other notes."
24204 #: ../fish/guestfish-actions.pod:4076
24205 msgid "swapon-uuid"
24209 #: ../fish/guestfish-actions.pod:4078
24212 " swapon-uuid uuid\n"
24217 #: ../fish/guestfish-actions.pod:4080
24219 "This command enables swap to a swap partition with the given UUID. See L</"
24220 "swapon-device> for other notes."
24224 #: ../fish/guestfish-actions.pod:4083
24229 #: ../fish/guestfish-actions.pod:4085
24237 #: ../fish/guestfish-actions.pod:4093
24242 #: ../fish/guestfish-actions.pod:4095
24250 #: ../fish/guestfish-actions.pod:4103
24255 #: ../fish/guestfish-actions.pod:4105
24258 " tail-n nrlines path\n"
24263 #: ../fish/guestfish-actions.pod:4118
24268 #: ../fish/guestfish-actions.pod:4120
24271 " tar-in (tarfile|-) directory\n"
24276 #: ../fish/guestfish-actions.pod:4125
24277 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24281 #: ../fish/guestfish-actions.pod:4130
24286 #: ../fish/guestfish-actions.pod:4132
24289 " tar-out directory (tarfile|-)\n"
24294 #: ../fish/guestfish-actions.pod:4137
24295 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24299 #: ../fish/guestfish-actions.pod:4142
24304 #: ../fish/guestfish-actions.pod:4144
24307 " tgz-in (tarball|-) directory\n"
24312 #: ../fish/guestfish-actions.pod:4149
24313 msgid "To upload an uncompressed tarball, use L</tar-in>."
24317 #: ../fish/guestfish-actions.pod:4153
24322 #: ../fish/guestfish-actions.pod:4155
24325 " tgz-out directory (tarball|-)\n"
24330 #: ../fish/guestfish-actions.pod:4160
24331 msgid "To download an uncompressed tarball, use L</tar-out>."
24335 #: ../fish/guestfish-actions.pod:4164
24340 #: ../fish/guestfish-actions.pod:4166
24348 #: ../fish/guestfish-actions.pod:4175
24353 #: ../fish/guestfish-actions.pod:4177
24361 #: ../fish/guestfish-actions.pod:4182
24362 msgid "truncate-size"
24366 #: ../fish/guestfish-actions.pod:4184
24369 " truncate-size path size\n"
24374 #: ../fish/guestfish-actions.pod:4189
24376 "If the current file size is less than C<size> then the file is extended to "
24377 "the required size with zero bytes. This creates a sparse file (ie. disk "
24378 "blocks are not allocated for the file until you write to it). To create a "
24379 "non-sparse file of zeroes, use L</fallocate64> instead."
24383 #: ../fish/guestfish-actions.pod:4195
24388 #: ../fish/guestfish-actions.pod:4197
24391 " tune2fs-l device\n"
24396 #: ../fish/guestfish-actions.pod:4207
24401 #: ../fish/guestfish-actions.pod:4209
24404 " txz-in (tarball|-) directory\n"
24409 #: ../fish/guestfish-actions.pod:4216
24414 #: ../fish/guestfish-actions.pod:4218
24417 " txz-out directory (tarball|-)\n"
24422 #: ../fish/guestfish-actions.pod:4225
24427 #: ../fish/guestfish-actions.pod:4227
24435 #: ../fish/guestfish-actions.pod:4241
24436 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24440 #: ../fish/guestfish-actions.pod:4246
24445 #: ../fish/guestfish-actions.pod:4248
24450 #: ../fish/guestfish-actions.pod:4250
24453 " umount pathordevice\n"
24458 #: ../fish/guestfish-actions.pod:4256
24463 #: ../fish/guestfish-actions.pod:4258
24464 msgid "unmount-all"
24468 #: ../fish/guestfish-actions.pod:4260
24476 #: ../fish/guestfish-actions.pod:4266
24481 #: ../fish/guestfish-actions.pod:4268
24484 " upload (filename|-) remotefilename\n"
24489 #: ../fish/guestfish-actions.pod:4275
24490 msgid "See also L</download>."
24494 #: ../fish/guestfish-actions.pod:4279
24495 msgid "upload-offset"
24499 #: ../fish/guestfish-actions.pod:4281
24502 " upload-offset (filename|-) remotefilename offset\n"
24507 #: ../fish/guestfish-actions.pod:4293
24509 "Note that there is no limit on the amount of data that can be uploaded with "
24510 "this call, unlike with L</pwrite>, and this call always writes the full "
24511 "amount unless an error occurs."
24515 #: ../fish/guestfish-actions.pod:4298
24516 msgid "See also L</upload>, L</pwrite>."
24520 #: ../fish/guestfish-actions.pod:4302
24525 #: ../fish/guestfish-actions.pod:4304
24528 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24533 #: ../fish/guestfish-actions.pod:4323
24538 #: ../fish/guestfish-actions.pod:4325
24546 #: ../fish/guestfish-actions.pod:4352
24548 "I<Note:> Don't use this call to test for availability of features. In "
24549 "enterprise distributions we backport features from later versions into "
24550 "earlier versions, making this an unreliable way to test for features. Use "
24551 "L</available> instead."
24555 #: ../fish/guestfish-actions.pod:4358
24560 #: ../fish/guestfish-actions.pod:4360
24563 " vfs-label device\n"
24568 #: ../fish/guestfish-actions.pod:4367
24569 msgid "To find a filesystem from the label, use L</findfs-label>."
24573 #: ../fish/guestfish-actions.pod:4369
24578 #: ../fish/guestfish-actions.pod:4371
24581 " vfs-type device\n"
24586 #: ../fish/guestfish-actions.pod:4381
24591 #: ../fish/guestfish-actions.pod:4383
24594 " vfs-uuid device\n"
24599 #: ../fish/guestfish-actions.pod:4390
24600 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24604 #: ../fish/guestfish-actions.pod:4392
24605 msgid "vg-activate"
24609 #: ../fish/guestfish-actions.pod:4394
24612 " vg-activate true|false 'volgroups ...'\n"
24617 #: ../fish/guestfish-actions.pod:4407
24618 msgid "vg-activate-all"
24622 #: ../fish/guestfish-actions.pod:4409
24625 " vg-activate-all true|false\n"
24630 #: ../fish/guestfish-actions.pod:4419
24635 #: ../fish/guestfish-actions.pod:4421
24638 " vgcreate volgroup 'physvols ...'\n"
24643 #: ../fish/guestfish-actions.pod:4426
24648 #: ../fish/guestfish-actions.pod:4428
24651 " vglvuuids vgname\n"
24656 #: ../fish/guestfish-actions.pod:4433
24658 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24659 "logical volumes and volume groups."
24663 #: ../fish/guestfish-actions.pod:4436
24664 msgid "See also L</vgpvuuids>."
24668 #: ../fish/guestfish-actions.pod:4438
24673 #: ../fish/guestfish-actions.pod:4440
24676 " vgpvuuids vgname\n"
24681 #: ../fish/guestfish-actions.pod:4445
24683 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24684 "physical volumes and volume groups."
24688 #: ../fish/guestfish-actions.pod:4448
24689 msgid "See also L</vglvuuids>."
24693 #: ../fish/guestfish-actions.pod:4450
24698 #: ../fish/guestfish-actions.pod:4452
24701 " vgremove vgname\n"
24706 #: ../fish/guestfish-actions.pod:4459
24711 #: ../fish/guestfish-actions.pod:4461
24714 " vgrename volgroup newvolgroup\n"
24719 #: ../fish/guestfish-actions.pod:4465
24724 #: ../fish/guestfish-actions.pod:4467
24732 #: ../fish/guestfish-actions.pod:4475
24733 msgid "See also L</vgs-full>."
24737 #: ../fish/guestfish-actions.pod:4477
24742 #: ../fish/guestfish-actions.pod:4479
24750 #: ../fish/guestfish-actions.pod:4484
24755 #: ../fish/guestfish-actions.pod:4486
24763 #: ../fish/guestfish-actions.pod:4491
24768 #: ../fish/guestfish-actions.pod:4493
24776 #: ../fish/guestfish-actions.pod:4497
24781 #: ../fish/guestfish-actions.pod:4499
24789 #: ../fish/guestfish-actions.pod:4504
24794 #: ../fish/guestfish-actions.pod:4506
24802 #: ../fish/guestfish-actions.pod:4511
24807 #: ../fish/guestfish-actions.pod:4513
24815 #: ../fish/guestfish-actions.pod:4518
24820 #: ../fish/guestfish-actions.pod:4520
24823 " write path content\n"
24828 #: ../fish/guestfish-actions.pod:4528
24833 #: ../fish/guestfish-actions.pod:4530
24836 " write-file path content size\n"
24841 #: ../fish/guestfish-actions.pod:4553
24846 #: ../fish/guestfish-actions.pod:4555
24849 " zegrep regex path\n"
24854 #: ../fish/guestfish-actions.pod:4563
24859 #: ../fish/guestfish-actions.pod:4565
24862 " zegrepi regex path\n"
24867 #: ../fish/guestfish-actions.pod:4573
24872 #: ../fish/guestfish-actions.pod:4575
24880 #: ../fish/guestfish-actions.pod:4583
24881 msgid "See also: L</zero-device>, L</scrub-device>."
24885 #: ../fish/guestfish-actions.pod:4585
24886 msgid "zero-device"
24890 #: ../fish/guestfish-actions.pod:4587
24893 " zero-device device\n"
24898 #: ../fish/guestfish-actions.pod:4589
24900 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24901 "which just zeroes the first few blocks of a device."
24905 #: ../fish/guestfish-actions.pod:4596
24910 #: ../fish/guestfish-actions.pod:4598
24913 " zerofree device\n"
24918 #: ../fish/guestfish-actions.pod:4611
24923 #: ../fish/guestfish-actions.pod:4613
24926 " zfgrep pattern path\n"
24931 #: ../fish/guestfish-actions.pod:4621
24936 #: ../fish/guestfish-actions.pod:4623
24939 " zfgrepi pattern path\n"
24944 #: ../fish/guestfish-actions.pod:4631
24949 #: ../fish/guestfish-actions.pod:4633
24952 " zfile meth path\n"
24957 #: ../fish/guestfish-actions.pod:4640
24959 "Since 1.0.63, use L</file> instead which can now process compressed files."
24963 #: ../fish/guestfish-actions.pod:4650
24968 #: ../fish/guestfish-actions.pod:4652
24971 " zgrep regex path\n"
24976 #: ../fish/guestfish-actions.pod:4660
24981 #: ../fish/guestfish-actions.pod:4662
24984 " zgrepi regex path\n"
24989 #: ../fish/guestfish-commands.pod:1
24994 #: ../fish/guestfish-commands.pod:3
24999 #: ../fish/guestfish-commands.pod:5
25002 " alloc filename size\n"
25007 #: ../fish/guestfish-commands.pod:7
25009 "This creates an empty (zeroed) file of the given size, and then adds so it "
25010 "can be further examined."
25014 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25015 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25019 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25020 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25024 #: ../fish/guestfish-commands.pod:14
25026 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25027 "image, see L</PREPARED DISK IMAGES>."
25031 #: ../fish/guestfish-commands.pod:17
25036 #: ../fish/guestfish-commands.pod:19
25039 " copy-in local [local ...] /remotedir\n"
25044 #: ../fish/guestfish-commands.pod:21
25046 "C<copy-in> copies local files or directories recursively into the disk "
25047 "image, placing them in the directory called C</remotedir> (which must "
25048 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25049 "other commands as necessary."
25053 #: ../fish/guestfish-commands.pod:26
25055 "Multiple local files and directories can be specified, but the last "
25056 "parameter must always be a remote directory. Wildcards cannot be used."
25060 #: ../fish/guestfish-commands.pod:30
25065 #: ../fish/guestfish-commands.pod:32
25068 " copy-out remote [remote ...] localdir\n"
25073 #: ../fish/guestfish-commands.pod:34
25075 "C<copy-out> copies remote files or directories recursively out of the disk "
25076 "image, placing them on the host disk in a local directory called C<localdir> "
25077 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25078 "download>, L</tar-out> and other commands as necessary."
25082 #: ../fish/guestfish-commands.pod:40
25084 "Multiple remote files and directories can be specified, but the last "
25085 "parameter must always be a local directory. To download to the current "
25086 "directory, use C<.> as in:"
25090 #: ../fish/guestfish-commands.pod:44
25093 " copy-out /home .\n"
25098 #: ../fish/guestfish-commands.pod:46
25100 "Wildcards cannot be used in the ordinary command, but you can use them with "
25101 "the help of L</glob> like this:"
25105 #: ../fish/guestfish-commands.pod:49
25108 " glob copy-out /home/* .\n"
25113 #: ../fish/guestfish-commands.pod:51
25118 #: ../fish/guestfish-commands.pod:53
25121 " echo [params ...]\n"
25126 #: ../fish/guestfish-commands.pod:55
25127 msgid "This echos the parameters to the terminal."
25131 #: ../fish/guestfish-commands.pod:57
25136 #: ../fish/guestfish-commands.pod:59
25141 #: ../fish/guestfish-commands.pod:61
25146 #: ../fish/guestfish-commands.pod:63
25154 #: ../fish/guestfish-commands.pod:65
25156 "This is used to edit a file. It downloads the file, edits it locally using "
25157 "your editor, then uploads the result."
25161 #: ../fish/guestfish-commands.pod:68
25163 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25164 "or C<emacs> you will get those corresponding editors."
25168 #: ../fish/guestfish-commands.pod:72
25173 #: ../fish/guestfish-commands.pod:74
25176 " glob command args...\n"
25181 #: ../fish/guestfish-commands.pod:76
25183 "Expand wildcards in any paths in the args list, and run C<command> "
25184 "repeatedly on each matching path."
25188 #: ../fish/guestfish-commands.pod:79
25189 msgid "See L</WILDCARDS AND GLOBBING>."
25193 #: ../fish/guestfish-commands.pod:81
25198 #: ../fish/guestfish-commands.pod:83
25201 " hexedit <filename|device>\n"
25202 " hexedit <filename|device> <max>\n"
25203 " hexedit <filename|device> <start> <max>\n"
25208 #: ../fish/guestfish-commands.pod:87
25210 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25215 #: ../fish/guestfish-commands.pod:90
25217 "This command works by downloading potentially the whole file or device, "
25218 "editing it locally, then uploading it. If the file or device is large, you "
25219 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25220 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25221 "usual modifiers allowed such as C<1M> (1 megabyte)."
25225 #: ../fish/guestfish-commands.pod:97
25226 msgid "For example to edit the first few sectors of a disk you might do:"
25230 #: ../fish/guestfish-commands.pod:100
25233 " hexedit /dev/sda 1M\n"
25238 #: ../fish/guestfish-commands.pod:102
25240 "which would allow you to edit anywhere within the first megabyte of the disk."
25244 #: ../fish/guestfish-commands.pod:105
25245 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25249 #: ../fish/guestfish-commands.pod:107
25252 " hexedit /dev/sda1 0x400 0x400\n"
25257 #: ../fish/guestfish-commands.pod:109
25258 msgid "(assuming the superblock is in the standard location)."
25262 #: ../fish/guestfish-commands.pod:111
25264 "This command requires the external L<hexedit(1)> program. You can specify "
25265 "another program to use by setting the C<HEXEDITOR> environment variable."
25269 #: ../fish/guestfish-commands.pod:115
25270 msgid "See also L</hexdump>."
25274 #: ../fish/guestfish-commands.pod:117
25279 #: ../fish/guestfish-commands.pod:119
25287 #: ../fish/guestfish-commands.pod:121
25289 "Change the local directory, ie. the current directory of guestfish itself."
25293 #: ../fish/guestfish-commands.pod:124
25294 msgid "Note that C<!cd> won't do what you might expect."
25298 #: ../fish/guestfish-commands.pod:126
25303 #: ../fish/guestfish-commands.pod:128
25308 #: ../fish/guestfish-commands.pod:130
25316 #: ../fish/guestfish-commands.pod:132
25317 msgid "Opens the manual page for guestfish."
25321 #: ../fish/guestfish-commands.pod:134
25326 #: ../fish/guestfish-commands.pod:136
25331 #: ../fish/guestfish-commands.pod:138
25339 #: ../fish/guestfish-commands.pod:140
25347 #: ../fish/guestfish-commands.pod:142
25348 msgid "This is used to view a file."
25352 #: ../fish/guestfish-commands.pod:144
25354 "The default viewer is C<$PAGER>. However if you use the alternate command "
25355 "C<less> you will get the C<less> command specifically."
25359 #: ../fish/guestfish-commands.pod:147
25364 #: ../fish/guestfish-commands.pod:149
25372 #: ../fish/guestfish-commands.pod:151
25374 "Close and reopen the libguestfs handle. It is not necessary to use this "
25375 "normally, because the handle is closed properly when guestfish exits. "
25376 "However this is occasionally useful for testing."
25380 #: ../fish/guestfish-commands.pod:155
25385 #: ../fish/guestfish-commands.pod:157
25388 " sparse filename size\n"
25393 #: ../fish/guestfish-commands.pod:159
25395 "This creates an empty sparse file of the given size, and then adds so it can "
25396 "be further examined."
25400 #: ../fish/guestfish-commands.pod:162
25402 "In all respects it works the same as the L</alloc> command, except that the "
25403 "image file is allocated sparsely, which means that disk blocks are not "
25404 "assigned to the file until they are needed. Sparse disk files only use "
25405 "space when written to, but they are slower and there is a danger you could "
25406 "run out of real disk space during a write operation."
25410 #: ../fish/guestfish-commands.pod:172
25415 #: ../fish/guestfish-commands.pod:174
25423 #: ../fish/guestfish-commands.pod:176
25425 "This command returns a list of the optional groups known to the daemon, and "
25426 "indicates which ones are supported by this build of the libguestfs appliance."
25430 #: ../fish/guestfish-commands.pod:180
25431 msgid "See also L<guestfs(3)/AVAILABILITY>."
25435 #: ../fish/guestfish-commands.pod:182
25440 #: ../fish/guestfish-commands.pod:184
25443 " time command args...\n"
25448 #: ../fish/guestfish-commands.pod:186
25450 "Run the command as usual, but print the elapsed time afterwards. This can "
25451 "be useful for benchmarking operations."
25455 #: ../test-tool/libguestfs-test-tool.pod:5
25456 msgid "libguestfs-test-tool - End user tests for libguestfs"
25460 #: ../test-tool/libguestfs-test-tool.pod:9
25463 " libguestfs-test-tool [--options]\n"
25468 #: ../test-tool/libguestfs-test-tool.pod:13
25470 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25471 "and developers, to allow them to check basic libguestfs functionality is "
25472 "working. This is needed because libguestfs occasionally breaks for reasons "
25473 "beyond our control: usually because of changes in the underlying qemu or "
25474 "kernel packages, or the host environment."
25478 #: ../test-tool/libguestfs-test-tool.pod:20
25479 msgid "If you suspect a problem in libguestfs, then just run:"
25483 #: ../test-tool/libguestfs-test-tool.pod:22
25486 " libguestfs-test-tool\n"
25491 #: ../test-tool/libguestfs-test-tool.pod:24
25492 msgid "It will print lots of diagnostic messages."
25496 #: ../test-tool/libguestfs-test-tool.pod:26
25497 msgid "If it runs to completion successfully, you will see this near the end:"
25501 #: ../test-tool/libguestfs-test-tool.pod:28
25504 " ===== TEST FINISHED OK =====\n"
25509 #: ../test-tool/libguestfs-test-tool.pod:30
25510 msgid "and the test tool will exit with code 0."
25514 #: ../test-tool/libguestfs-test-tool.pod:32
25516 "If it fails (and/or exits with non-zero error code), please paste the "
25517 "B<complete, unedited> output of the test tool into a bug report. More "
25518 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25523 #: ../test-tool/libguestfs-test-tool.pod:41
25528 #: ../test-tool/libguestfs-test-tool.pod:43
25529 msgid "Display short usage information and exit."
25533 #: ../test-tool/libguestfs-test-tool.pod:45
25534 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25538 #: ../test-tool/libguestfs-test-tool.pod:47
25540 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25541 "normally look in the C<$libexec> directory that was configured when the tool "
25546 #: ../test-tool/libguestfs-test-tool.pod:51
25547 msgid "I<--qemu qemu_binary>"
25551 #: ../test-tool/libguestfs-test-tool.pod:53
25553 "If you have downloaded another qemu binary, point this option at the full "
25554 "path of the binary to try it."
25558 #: ../test-tool/libguestfs-test-tool.pod:56
25559 msgid "I<--qemudir qemu_source_dir>"
25563 #: ../test-tool/libguestfs-test-tool.pod:58
25565 "If you have compiled qemu from source, point this option at the source "
25566 "directory to try it."
25570 #: ../test-tool/libguestfs-test-tool.pod:61
25571 msgid "I<--timeout N>"
25575 #: ../test-tool/libguestfs-test-tool.pod:63
25577 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25578 "does not usually need to be adjusted unless your machine is very slow."
25582 #: ../test-tool/libguestfs-test-tool.pod:69
25583 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25587 #: ../test-tool/libguestfs-test-tool.pod:71
25589 "If you have compiled another version of qemu from source and would like to "
25590 "try that, then you can use the I<--qemudir> option to point to the qemu "
25591 "source directory."
25595 #: ../test-tool/libguestfs-test-tool.pod:75
25597 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25598 "option to point to the binary."
25602 #: ../test-tool/libguestfs-test-tool.pod:78
25604 "When using an alternate qemu with libguestfs, usually you would need to "
25605 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25606 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25607 "use either of the I<--qemudir> or I<--qemu> options."
25611 #: ../test-tool/libguestfs-test-tool.pod:85
25613 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25614 "I<1> if there was an error."
25618 #: ../test-tool/libguestfs-test-tool.pod:92
25619 msgid "/usr/libexec/libguestfs-test-tool-helper"
25623 #: ../test-tool/libguestfs-test-tool.pod:94
25625 "This helper program is run inside the appliance and provides additional "
25630 #: ../test-tool/libguestfs-test-tool.pod:97
25631 msgid "/usr/bin/mkisofs"
25635 #: ../test-tool/libguestfs-test-tool.pod:99
25637 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25638 "which is used as part of the tests."
25642 #: ../test-tool/libguestfs-test-tool.pod:106
25644 "For the full list of environment variables which may affect libguestfs, "
25645 "please see the L<guestfs(3)> manual page."
25649 #: ../test-tool/libguestfs-test-tool.pod:111
25650 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25654 #: ../test-tool/libguestfs-test-tool.pod:121
25655 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25659 #: ../fuse/guestmount.pod:5
25661 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25665 #: ../fuse/guestmount.pod:9
25668 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25673 #: ../fuse/guestmount.pod:11
25676 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25681 #: ../fuse/guestmount.pod:13
25684 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25689 #: ../fuse/guestmount.pod:17
25691 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25692 "machines. If you do this, you risk disk corruption in the VM."
25696 #: ../fuse/guestmount.pod:22
25698 "The guestmount program can be used to mount virtual machine filesystems and "
25699 "other disk images on the host. It uses libguestfs for access to the guest "
25700 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25701 "a mountable device."
25705 #: ../fuse/guestmount.pod:27
25707 "Along with other options, you have to give at least one device (I<-a> "
25708 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25709 "option) or use the I<-i> inspection option. How this works is better "
25710 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25715 #: ../fuse/guestmount.pod:33
25717 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25718 "by you, and the filesystem will not be visible to any other users unless you "
25719 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25720 "the filesystem, use the C<fusermount -u> command."
25724 #: ../fuse/guestmount.pod:41
25726 "For a typical Windows guest which has its main filesystem on the first "
25731 #: ../fuse/guestmount.pod:44
25734 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25739 #: ../fuse/guestmount.pod:46
25741 "For a typical Linux guest which has a /boot filesystem on the first "
25742 "partition, and the root filesystem on a logical volume:"
25746 #: ../fuse/guestmount.pod:49
25749 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25754 #: ../fuse/guestmount.pod:51
25755 msgid "To get libguestfs to detect guest mountpoints for you:"
25759 #: ../fuse/guestmount.pod:53
25762 " guestmount -a guest.img -i --ro /mnt\n"
25767 #: ../fuse/guestmount.pod:55
25768 msgid "For a libvirt guest called \"Guest\" you could do:"
25772 #: ../fuse/guestmount.pod:57
25775 " guestmount -d Guest -i --ro /mnt\n"
25780 #: ../fuse/guestmount.pod:59
25782 "If you don't know what filesystems are contained in a guest or disk image, "
25783 "use L<virt-filesystems(1)> first:"
25787 #: ../fuse/guestmount.pod:62
25790 " virt-filesystems MyGuest\n"
25795 #: ../fuse/guestmount.pod:64
25797 "If you want to trace the libguestfs calls but without excessive debugging "
25798 "information, we recommend:"
25802 #: ../fuse/guestmount.pod:67
25805 " guestmount [...] --trace /mnt\n"
25810 #: ../fuse/guestmount.pod:69
25811 msgid "If you want to debug the program, we recommend:"
25815 #: ../fuse/guestmount.pod:71
25818 " guestmount [...] --trace --verbose /mnt\n"
25823 #: ../fuse/guestmount.pod:79
25824 msgid "Add a block device or virtual machine image."
25828 #: ../fuse/guestmount.pod:96
25829 msgid "B<--dir-cache-timeout N>"
25833 #: ../fuse/guestmount.pod:98
25835 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25836 "seconds. The readdir cache [actually, there are several semi-independent "
25837 "caches] is populated after a readdir(2) call with the stat and extended "
25838 "attributes of the files in the directory, in anticipation that they will be "
25839 "requested soon after."
25843 #: ../fuse/guestmount.pod:104
25845 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25846 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25847 "requests, only cache existing ones."
25851 #: ../fuse/guestmount.pod:122
25853 "If you have untrusted raw-format guest disk images, you should use this "
25854 "option to specify the disk format. This avoids a possible security problem "
25855 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25856 "guestfs_add_drive_opts>."
25860 #: ../fuse/guestmount.pod:127
25861 msgid "B<--fuse-help>"
25865 #: ../fuse/guestmount.pod:129
25866 msgid "Display help on special FUSE options (see I<-o> below)."
25870 #: ../fuse/guestmount.pod:133
25871 msgid "Display brief help and exit."
25875 #: ../fuse/guestmount.pod:146
25876 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25880 #: ../fuse/guestmount.pod:148
25882 "Mount the named partition or logical volume on the given mountpoint B<in the "
25883 "guest> (this has nothing to do with mountpoints in the host)."
25887 #: ../fuse/guestmount.pod:151
25889 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25890 "something on C</>."
25894 #: ../fuse/guestmount.pod:156
25896 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25897 "unmounted. If you specify this option, then we don't attempt to sync the "
25898 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25902 #: ../fuse/guestmount.pod:161
25903 msgid "B<-o option> | B<--option option>"
25907 #: ../fuse/guestmount.pod:163
25908 msgid "Pass extra options to FUSE."
25912 #: ../fuse/guestmount.pod:165
25914 "To get a list of all the extra options supported by FUSE, use the command "
25915 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25916 "of them are a good idea."
25920 #: ../fuse/guestmount.pod:169
25923 " guestmount --fuse-help\n"
25928 #: ../fuse/guestmount.pod:171
25929 msgid "Some potentially useful FUSE options:"
25933 #: ../fuse/guestmount.pod:175
25934 msgid "B<-o allow_other>"
25938 #: ../fuse/guestmount.pod:177
25939 msgid "Allow other users to see the filesystem."
25943 #: ../fuse/guestmount.pod:179
25944 msgid "B<-o attr_timeout=N>"
25948 #: ../fuse/guestmount.pod:181
25949 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25953 #: ../fuse/guestmount.pod:183
25954 msgid "B<-o kernel_cache>"
25958 #: ../fuse/guestmount.pod:185
25960 "Allow the kernel to cache files (reduces the number of reads that have to go "
25961 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25962 "afford the extra memory usage."
25966 #: ../fuse/guestmount.pod:189
25967 msgid "B<-o uid=N> B<-o gid=N>"
25971 #: ../fuse/guestmount.pod:191
25973 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25974 "the chosen values."
25978 #: ../fuse/guestmount.pod:198
25980 "Add devices and mount everything read-only. Also disallow writes and make "
25981 "the disk appear read-only to FUSE."
25985 #: ../fuse/guestmount.pod:201
25987 "This is highly recommended if you are not going to edit the guest disk. If "
25988 "the guest is running and this option is I<not> supplied, then there is a "
25989 "strong risk of disk corruption in the guest. We try to prevent this from "
25990 "happening, but it is not always possible."
25994 #: ../fuse/guestmount.pod:206
25995 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25999 #: ../fuse/guestmount.pod:210
26000 msgid "Enable SELinux support for the guest."
26004 #: ../fuse/guestmount.pod:214
26005 msgid "Enable verbose messages from underlying libguestfs."
26009 #: ../fuse/guestmount.pod:218
26010 msgid "Display the program version and exit."
26014 #: ../fuse/guestmount.pod:222
26016 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26017 "FOR READ AND WRITE>."
26021 #: ../fuse/guestmount.pod:225
26022 msgid "B<-x> | B<--trace>"
26026 #: ../fuse/guestmount.pod:227
26027 msgid "Trace libguestfs calls."
26031 #: ../fuse/guestmount.pod:229
26032 msgid "This also stops the daemon from forking into the background."
26036 #: ../fuse/guestmount.pod:235
26038 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26039 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26044 #: ../tools/virt-edit.pl:34
26045 msgid "virt-edit - Edit a file in a virtual machine"
26049 #: ../tools/virt-edit.pl:38
26052 " virt-edit [--options] domname file\n"
26057 #: ../tools/virt-edit.pl:40
26060 " virt-edit [--options] disk.img [disk.img ...] file\n"
26065 #: ../tools/virt-edit.pl:42
26068 " virt-edit [domname|disk.img] file -e 'expr'\n"
26073 #: ../tools/virt-edit.pl:46
26075 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26076 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26077 "doing this, but doesn't catch all cases."
26081 #: ../tools/virt-edit.pl:52
26083 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26084 "the named virtual machine (or disk image)."
26088 #: ../tools/virt-edit.pl:55
26090 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26091 "you should look at the L<guestfish(1)> tool."
26095 #: ../tools/virt-edit.pl:60
26096 msgid "Edit the named files interactively:"
26100 #: ../tools/virt-edit.pl:62
26103 " virt-edit mydomain /boot/grub/grub.conf\n"
26108 #: ../tools/virt-edit.pl:64
26111 " virt-edit mydomain /etc/passwd\n"
26116 #: ../tools/virt-edit.pl:66
26118 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26119 "below). To change the init default level to 5:"
26123 #: ../tools/virt-edit.pl:70
26126 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26131 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181
26132 #: ../tools/virt-df.pl:81 ../tools/virt-list-filesystems.pl:63
26133 #: ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113
26134 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
26135 msgid "Display brief help."
26139 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187
26140 #: ../tools/virt-df.pl:87 ../tools/virt-resize.pl:272
26141 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114
26142 #: ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169
26143 #: ../tools/virt-list-partitions.pl:70
26144 msgid "B<--version>"
26148 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189
26149 #: ../tools/virt-df.pl:89 ../tools/virt-resize.pl:274
26150 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116
26151 #: ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171
26152 #: ../tools/virt-list-partitions.pl:72
26153 msgid "Display version number and exit."
26157 #: ../tools/virt-edit.pl:96
26158 msgid "B<--backup extension> | B<-b extension>"
26162 #: ../tools/virt-edit.pl:98
26164 "Create a backup of the original file I<in the guest disk image>. The backup "
26165 "has the original filename with C<extension> added."
26169 #: ../tools/virt-edit.pl:101
26171 "Usually the first character of C<extension> would be a dot C<.> so you would "
26176 #: ../tools/virt-edit.pl:104
26179 " virt-edit -b .orig [etc]\n"
26184 #: ../tools/virt-edit.pl:106
26185 msgid "By default, no backup file is made."
26189 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203
26190 #: ../tools/virt-df.pl:95 ../tools/virt-list-filesystems.pl:77
26191 #: ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135
26192 #: ../tools/virt-list-partitions.pl:78
26193 msgid "B<--connect URI> | B<-c URI>"
26197 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205
26198 #: ../tools/virt-df.pl:97 ../tools/virt-list-filesystems.pl:79
26199 #: ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137
26200 #: ../tools/virt-list-partitions.pl:80
26202 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26203 "to the default libvirt hypervisor."
26207 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26208 #: ../tools/virt-df.pl:100 ../tools/virt-list-filesystems.pl:82
26209 #: ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140
26210 #: ../tools/virt-list-partitions.pl:83
26212 "If you specify guest block devices directly, then libvirt is not used at all."
26216 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215
26217 #: ../tools/virt-df.pl:117 ../tools/virt-resize.pl:522
26218 #: ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134
26219 #: ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:90
26220 msgid "B<--format> raw"
26224 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217
26225 #: ../tools/virt-df.pl:119 ../tools/virt-list-filesystems.pl:91
26226 #: ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149
26227 #: ../tools/virt-list-partitions.pl:92
26229 "Specify the format of disk images given on the command line. If this is "
26230 "omitted then the format is autodetected from the content of the disk image."
26234 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221
26235 #: ../tools/virt-df.pl:123 ../tools/virt-list-filesystems.pl:95
26236 #: ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153
26237 #: ../tools/virt-list-partitions.pl:96
26239 "If disk images are requested from libvirt, then this program asks libvirt "
26240 "for this information. In this case, the value of the format parameter is "
26245 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225
26246 #: ../tools/virt-df.pl:127 ../tools/virt-resize.pl:527
26247 #: ../tools/virt-resize.pl:542 ../tools/virt-list-filesystems.pl:99
26248 #: ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157
26249 #: ../tools/virt-list-partitions.pl:100
26251 "If working with untrusted raw-format guest disk images, you should ensure "
26252 "the format is always specified."
26256 #: ../tools/virt-edit.pl:141
26257 msgid "B<--expr EXPR> | B<-e EXPR>"
26261 #: ../tools/virt-edit.pl:143
26263 "Instead of launching the external editor, non-interactively apply the Perl "
26264 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26269 #: ../tools/virt-edit.pl:147
26271 "Be careful to properly quote the expression to prevent it from being altered "
26276 #: ../tools/virt-edit.pl:268
26277 msgid "NON-INTERACTIVE EDITING"
26281 #: ../tools/virt-edit.pl:270
26283 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26284 "administrator can interactively edit the file."
26288 #: ../tools/virt-edit.pl:273
26290 "There are two ways also to use C<virt-edit> from scripts in order to make "
26291 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26292 "like this, it's less error-prone to write scripts directly using the "
26293 "libguestfs API and Augeas for configuration file editing.)"
26297 #: ../tools/virt-edit.pl:279
26299 "The first method is to temporarily set C<$EDITOR> to any script or program "
26300 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26301 "update C<tmpfile> in place however it likes."
26305 #: ../tools/virt-edit.pl:283
26307 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26308 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26309 "instances of C<foo> with C<bar> in a file:"
26313 #: ../tools/virt-edit.pl:287
26316 " virt-edit domname filename -e 's/foo/bar/'\n"
26321 #: ../tools/virt-edit.pl:289
26323 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26324 "For example to delete root's password you could do:"
26328 #: ../tools/virt-edit.pl:292
26331 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26336 #: ../tools/virt-edit.pl:294
26338 "What really happens is that the snippet is evaluated as a Perl expression "
26339 "for each line of the file. The line, including the final C<\\n>, is passed "
26340 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26344 #: ../tools/virt-edit.pl:299
26346 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26347 "C<apache> user account from the password file you can do:"
26351 #: ../tools/virt-edit.pl:302
26354 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26359 #: ../tools/virt-edit.pl:304
26361 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26362 "the end of the file is rather difficult this way since there is no concept "
26363 "of \"last line of the file\" - your expression just doesn't get called "
26364 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26369 #: ../tools/virt-edit.pl:310
26371 "The variable C<$lineno> contains the current line number. As is "
26372 "traditional, the first line in the file is number C<1>."
26376 #: ../tools/virt-edit.pl:313
26378 "The return value from the expression is ignored, but the expression may call "
26379 "C<die> in order to abort the whole program, leaving the original file "
26384 #: ../tools/virt-edit.pl:317
26386 "Remember when matching the end of a line that C<$_> may contain the final C<"
26387 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26388 "newline then neither of these. Thus to match or substitute some text at the "
26389 "end of a line, use this regular expression:"
26393 #: ../tools/virt-edit.pl:322
26396 " /some text(\\r?\\n)?$/\n"
26401 #: ../tools/virt-edit.pl:324
26403 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26404 "$_> itself (since that would remove all newlines from the file):"
26408 #: ../tools/virt-edit.pl:328
26411 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26416 #: ../tools/virt-edit.pl:334
26421 #: ../tools/virt-edit.pl:336
26423 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26428 #: ../tools/virt-edit.pl:339
26429 msgid "If not set, C<vi> is used."
26433 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141
26434 #: ../tools/virt-win-reg.pl:477 ../tools/virt-df.pl:633
26435 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:182
26436 #: ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260
26437 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26438 msgid "SHELL QUOTING"
26442 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479
26443 #: ../tools/virt-df.pl:635 ../tools/virt-resize.pl:1480
26444 #: ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276
26445 #: ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529
26446 #: ../tools/virt-list-partitions.pl:252
26448 "Libvirt guest names can contain arbitrary characters, some of which have "
26449 "meaning to the shell such as C<#> and space. You may need to quote or "
26450 "escape these characters on the command line. See the shell manual page L<sh"
26451 "(1)> for details."
26455 #: ../tools/virt-edit.pl:352
26457 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26458 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26463 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26464 #: ../tools/virt-df.pl:649 ../tools/virt-resize.pl:1506
26465 #: ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292
26466 #: ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559
26467 #: ../tools/virt-list-partitions.pl:269
26472 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512
26473 #: ../tools/virt-df.pl:651 ../tools/virt-resize.pl:1508
26474 #: ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294
26475 #: ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561
26476 #: ../tools/virt-list-partitions.pl:271
26477 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26481 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655
26482 #: ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:275
26483 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26487 #: ../tools/virt-win-reg.pl:37
26489 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26493 #: ../tools/virt-win-reg.pl:41
26496 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26501 #: ../tools/virt-win-reg.pl:43
26504 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26509 #: ../tools/virt-win-reg.pl:45
26512 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26517 #: ../tools/virt-win-reg.pl:47
26520 " virt-win-reg --merge domname [input.reg ...]\n"
26525 #: ../tools/virt-win-reg.pl:49
26528 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26533 #: ../tools/virt-win-reg.pl:53
26535 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26536 "virtual machines. If you do this, you I<will> get irreversible disk "
26537 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26538 "but doesn't catch all cases."
26542 #: ../tools/virt-win-reg.pl:58
26544 "Modifying the Windows Registry is an inherently risky operation. The format "
26545 "is deliberately obscure and undocumented, and Registry changes can leave the "
26546 "system unbootable. Therefore when using the C<--merge> option, make sure "
26547 "you have a reliable backup first."
26551 #: ../tools/virt-win-reg.pl:65
26553 "This program can export and merge Windows Registry entries from a Windows "
26558 #: ../tools/virt-win-reg.pl:68
26560 "The first parameter is the libvirt guest name or the raw disk image of a "
26565 #: ../tools/virt-win-reg.pl:71
26567 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26568 "exported (recursively). For example:"
26572 #: ../tools/virt-win-reg.pl:74
26575 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26580 #: ../tools/virt-win-reg.pl:76
26582 "You can also display single values from within registry keys, for example:"
26586 #: ../tools/virt-win-reg.pl:79
26589 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26590 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26591 " Windows 7 Enterprise\n"
26596 #: ../tools/virt-win-reg.pl:83
26598 "With C<--merge>, you can merge a textual regedit file into the Windows "
26603 #: ../tools/virt-win-reg.pl:86
26606 " $ virt-win-reg --merge Windows7 changes.reg\n"
26611 #: ../tools/virt-win-reg.pl:88
26612 msgid "SUPPORTED SYSTEMS"
26616 #: ../tools/virt-win-reg.pl:90
26618 "The program currently supports Windows NT-derived guests starting with "
26619 "Windows XP through to at least Windows 7."
26623 #: ../tools/virt-win-reg.pl:93
26625 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26626 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26627 "and C<HKEY_USERS\\.DEFAULT>."
26631 #: ../tools/virt-win-reg.pl:97
26633 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26638 #: ../tools/virt-win-reg.pl:100
26640 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26645 #: ../tools/virt-win-reg.pl:103
26650 #: ../tools/virt-win-reg.pl:105
26652 "This program is only meant for simple access to the registry. If you want "
26653 "to do complicated things with the registry, we suggest you download the "
26654 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26655 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26656 "L<hivexregedit(1)>."
26660 #: ../tools/virt-win-reg.pl:111
26665 #: ../tools/virt-win-reg.pl:113
26667 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26668 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26669 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26670 "Windows-style line endings, you may need to reencode the whole file before "
26671 "or after processing."
26675 #: ../tools/virt-win-reg.pl:119
26677 "To reencode a file from Windows format to Linux (before processing it with "
26678 "the C<--merge> option), you would do something like this:"
26682 #: ../tools/virt-win-reg.pl:122
26685 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26690 #: ../tools/virt-win-reg.pl:124
26692 "To go in the opposite direction, after exporting and before sending the file "
26693 "to a Windows user, do something like this:"
26697 #: ../tools/virt-win-reg.pl:127
26700 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26705 #: ../tools/virt-win-reg.pl:129
26706 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26710 #: ../tools/virt-win-reg.pl:131
26712 "If you are unsure about the current encoding, use the L<file(1)> command. "
26713 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26714 "style (CRLF) line endings, like this:"
26718 #: ../tools/virt-win-reg.pl:135
26721 " $ file software.reg\n"
26722 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26723 " with CRLF line terminators\n"
26728 #: ../tools/virt-win-reg.pl:139
26729 msgid "This file would need conversion before you could C<--merge> it."
26733 #: ../tools/virt-win-reg.pl:143
26735 "Be careful when passing parameters containing C<\\> (backslash) in the "
26736 "shell. Usually you will have to use 'single quotes' or double backslashes "
26737 "(but not both) to protect them from the shell."
26741 #: ../tools/virt-win-reg.pl:147
26742 msgid "Paths and value names are case-insensitive."
26746 #: ../tools/virt-win-reg.pl:149
26747 msgid "CurrentControlSet etc."
26751 #: ../tools/virt-win-reg.pl:151
26753 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26754 "Registry at the level of the hive file, and therefore you cannot modify "
26759 #: ../tools/virt-win-reg.pl:155
26761 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26762 "circumstances it might refer to another control set. The way to find out is "
26763 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26767 #: ../tools/virt-win-reg.pl:159
26770 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26771 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26772 " \"Current\"=dword:00000001\n"
26773 " \"Default\"=dword:00000001\n"
26774 " \"Failed\"=dword:00000000\n"
26775 " \"LastKnownGood\"=dword:00000002\n"
26780 #: ../tools/virt-win-reg.pl:166
26781 msgid "\"Current\" is the one which Windows will choose when it boots."
26785 #: ../tools/virt-win-reg.pl:168
26787 "Similarly, other C<Current...> keys in the path may need to be replaced."
26791 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26796 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:500
26797 msgid "Enable debugging messages."
26801 #: ../tools/virt-win-reg.pl:232
26806 #: ../tools/virt-win-reg.pl:234
26808 "In merge mode, this merges a textual regedit file into the Windows Registry "
26809 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26810 "displays or exports Registry entries instead."
26814 #: ../tools/virt-win-reg.pl:238
26816 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26817 "result in disk corruption. However exporting (without this flag) is always "
26822 #: ../tools/virt-win-reg.pl:246
26823 msgid "B<--encoding> UTF-16LE|ASCII"
26827 #: ../tools/virt-win-reg.pl:248
26829 "When merging (only), you may need to specify the encoding for strings to be "
26830 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26831 "(3)/ENCODING STRINGS>."
26835 #: ../tools/virt-win-reg.pl:252
26837 "The default is to use UTF-16LE, which should work with recent versions of "
26842 #: ../tools/virt-win-reg.pl:486
26844 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26845 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26846 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26850 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26852 "When reporting bugs, please enable debugging and capture the I<complete> "
26857 #: ../tools/virt-win-reg.pl:504
26860 " export LIBGUESTFS_DEBUG=1\n"
26861 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26866 #: ../tools/virt-win-reg.pl:507
26868 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26873 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1512
26874 #: ../tools/virt-make-fs.pl:565
26875 msgid "Copyright (C) 2010 Red Hat Inc."
26879 #: ../tools/virt-df.pl:36
26880 msgid "virt-df - Display free space on virtual filesystems"
26884 #: ../tools/virt-df.pl:40
26887 " virt-df [--options]\n"
26892 #: ../tools/virt-df.pl:42
26895 " virt-df [--options] domname\n"
26900 #: ../tools/virt-df.pl:44
26903 " virt-df [--options] disk.img [disk.img ...]\n"
26908 #: ../tools/virt-df.pl:48
26910 "C<virt-df> is a command line tool to display free space on virtual machine "
26911 "filesystems. Unlike other tools, it doesn't just display the amount of "
26912 "space allocated to a virtual machine, but can look inside the virtual "
26913 "machine to see how much space is really being used."
26917 #: ../tools/virt-df.pl:53
26919 "It is like the L<df(1)> command, but for virtual machines, except that it "
26920 "also works for Windows virtual machines."
26924 #: ../tools/virt-df.pl:56
26926 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26927 "of all active and inactive guests, and performs a C<df>-type operation on "
26928 "each one in turn, printing out the results."
26932 #: ../tools/virt-df.pl:60
26934 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26935 "either the single named libvirt domain, or on the disk image(s) listed on "
26936 "the command line (which must all belong to a single VM). In this mode (with "
26937 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26938 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26942 #: ../tools/virt-df.pl:67
26944 "Use the C<--csv> option to get a format which can be easily parsed by other "
26945 "programs. Other options are mostly similar to standard C<df> options. See "
26946 "below for the complete list."
26950 #: ../tools/virt-df.pl:107
26955 #: ../tools/virt-df.pl:109
26957 "Write out the results in CSV format (comma-separated values). This format "
26958 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26959 "ABOUT CSV FORMAT> below."
26963 #: ../tools/virt-df.pl:134
26964 msgid "B<--human-readable> | B<-h>"
26968 #: ../tools/virt-df.pl:136
26969 msgid "Print sizes in human-readable format."
26973 #: ../tools/virt-df.pl:138
26974 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26978 #: ../tools/virt-df.pl:144
26979 msgid "B<--inodes> | B<-i>"
26983 #: ../tools/virt-df.pl:146
26984 msgid "Print inodes instead of blocks."
26988 #: ../tools/virt-df.pl:152
26989 msgid "B<--one-per-guest>"
26993 #: ../tools/virt-df.pl:154
26995 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26996 "disks from several guests to a single libguestfs appliance."
27000 #: ../tools/virt-df.pl:157
27001 msgid "You might use this option in the following circumstances:"
27005 #: ../tools/virt-df.pl:163
27007 "If you think an untrusted guest might actively try to exploit the libguestfs "
27008 "appliance kernel, then this prevents one guest from interfering with the "
27009 "stats printed for another guest."
27013 #: ../tools/virt-df.pl:169
27015 "If the kernel has a bug which stops it from accessing a filesystem in one "
27016 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
27017 "and report stats for further guests."
27021 #: ../tools/virt-df.pl:180
27026 #: ../tools/virt-df.pl:182
27028 "Print UUIDs instead of names. This is useful for following a guest even "
27029 "when the guest is migrated or renamed, or when two guests happen to have the "
27034 #: ../tools/virt-df.pl:186
27036 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
27037 "images, we still print the disk image name even when this option is "
27042 #: ../tools/virt-df.pl:609
27043 msgid "NOTE ABOUT CSV FORMAT"
27047 #: ../tools/virt-df.pl:611
27049 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
27050 "should be easy to parse, but it is definitely not easy to parse."
27054 #: ../tools/virt-df.pl:614
27056 "Myth: Just split fields at commas. Reality: This does I<not> work "
27057 "reliably. This example has two columns:"
27061 #: ../tools/virt-df.pl:617
27064 " \"foo,bar\",baz\n"
27069 #: ../tools/virt-df.pl:619
27071 "Myth: Read the file one line at a time. Reality: This does I<not> work "
27072 "reliably. This example has one row:"
27076 #: ../tools/virt-df.pl:622
27085 #: ../tools/virt-df.pl:625
27087 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
27088 "packaged in major Linux distributions)."
27092 #: ../tools/virt-df.pl:628
27094 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
27095 "or Python's built-in csv library)."
27099 #: ../tools/virt-df.pl:631
27100 msgid "Most spreadsheets and databases can import CSV directly."
27104 #: ../tools/virt-df.pl:642
27106 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
27107 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27111 #: ../tools/virt-resize.pl:42
27112 msgid "virt-resize - Resize a virtual machine disk"
27116 #: ../tools/virt-resize.pl:46
27119 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27120 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27121 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27126 #: ../tools/virt-resize.pl:52
27128 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27129 "larger or smaller overall, and resizing or deleting any partitions contained "
27134 #: ../tools/virt-resize.pl:56
27136 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27137 "not> be used on live virtual machines - for consistent results, shut the "
27138 "virtual machine down before resizing it."
27142 #: ../tools/virt-resize.pl:60
27144 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
27145 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
27149 #: ../tools/virt-resize.pl:66
27151 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27152 "fill the extra 5GB of space."
27156 #: ../tools/virt-resize.pl:69
27159 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27160 " virt-filesystems --long --h --all -a olddisk\n"
27161 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27162 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27167 #: ../tools/virt-resize.pl:74
27169 "As above, but make the /boot partition 200MB bigger, while giving the "
27170 "remaining space to /dev/sda2:"
27174 #: ../tools/virt-resize.pl:77
27177 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27182 #: ../tools/virt-resize.pl:79
27183 msgid "As above, but the output format will be uncompressed qcow2:"
27187 #: ../tools/virt-resize.pl:81
27190 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27191 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27196 #: ../tools/virt-resize.pl:84
27197 msgid "DETAILED USAGE"
27201 #: ../tools/virt-resize.pl:86
27202 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27206 #: ../tools/virt-resize.pl:90
27207 msgid "1. Shut down the virtual machine"
27211 #: ../tools/virt-resize.pl:92
27212 msgid "2. Locate input disk image"
27216 #: ../tools/virt-resize.pl:94
27218 "Locate the input disk image (ie. the file or device on the host containing "
27219 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27220 "dumpxml> like this to find the disk image name:"
27224 #: ../tools/virt-resize.pl:98
27227 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27228 " Found 1 nodes:\n"
27230 " <source dev=\"/dev/vg/lv_guest\" />\n"
27235 #: ../tools/virt-resize.pl:103
27236 msgid "3. Look at current sizing"
27240 #: ../tools/virt-resize.pl:105
27241 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27245 #: ../tools/virt-resize.pl:108
27248 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27249 " Name Type Size Parent\n"
27250 " /dev/sda1 partition 101M /dev/sda\n"
27251 " /dev/sda2 partition 7.9G /dev/sda\n"
27252 " /dev/sda device 8.0G -\n"
27257 #: ../tools/virt-resize.pl:114
27259 "(This example is a virtual machine with an 8 GB disk which we would like to "
27260 "expand up to 10 GB)."
27264 #: ../tools/virt-resize.pl:117
27265 msgid "4. Create output disk"
27269 #: ../tools/virt-resize.pl:119
27271 "Virt-resize cannot do in-place disk modifications. You have to have space "
27272 "to store the resized output disk."
27276 #: ../tools/virt-resize.pl:122
27278 "To store the resized disk image in a file, create a file of a suitable size:"
27282 #: ../tools/virt-resize.pl:125
27285 " # rm -f outdisk\n"
27286 " # truncate -s 10G outdisk\n"
27291 #: ../tools/virt-resize.pl:128
27292 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27296 #: ../tools/virt-resize.pl:130
27299 " # lvcreate -L 10G -n lv_name vg_name\n"
27304 #: ../tools/virt-resize.pl:132
27305 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27309 #: ../tools/virt-resize.pl:134
27312 " # virsh pool-list\n"
27313 " # virsh vol-create-as poolname newvol 10G\n"
27318 #: ../tools/virt-resize.pl:137
27323 #: ../tools/virt-resize.pl:139
27325 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27326 "file) and the output disk. The output disk is the one created in the "
27331 #: ../tools/virt-resize.pl:143
27334 " # virt-resize indisk outdisk\n"
27339 #: ../tools/virt-resize.pl:145
27341 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27342 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27343 "larger, then an extra, empty partition is created at the end of the disk "
27344 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27349 #: ../tools/virt-resize.pl:151
27351 "More realistically you'd want to expand existing partitions in the disk "
27352 "image by passing extra options (for the full list see the L</OPTIONS> "
27357 #: ../tools/virt-resize.pl:155
27359 "L</--expand> is the most useful option. It expands the named partition "
27360 "within the disk to fill any extra space:"
27364 #: ../tools/virt-resize.pl:158
27367 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27372 #: ../tools/virt-resize.pl:160
27374 "(In this case, an extra partition is I<not> created at the end of the disk, "
27375 "because there will be no unused space)."
27379 #: ../tools/virt-resize.pl:163
27381 "L</--resize> is the other commonly used option. The following would "
27382 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27383 "rest of the available space:"
27387 #: ../tools/virt-resize.pl:167
27390 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27391 " indisk outdisk\n"
27396 #: ../tools/virt-resize.pl:170
27398 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27399 "if virt-resize knows how, it will resize the contents, the equivalent of "
27400 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27401 ">. However virt-resize does not know how to resize some filesystems, so you "
27402 "would have to online resize them after booting the guest. And virt-resize "
27403 "also does not resize anything inside an LVM PV, it just resizes the PV "
27404 "itself and leaves the user to resize any LVs inside that PV as desired."
27408 #: ../tools/virt-resize.pl:179
27409 msgid "Other options are covered below."
27413 #: ../tools/virt-resize.pl:181
27418 #: ../tools/virt-resize.pl:183
27419 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27423 #: ../tools/virt-resize.pl:185
27424 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27428 #: ../tools/virt-resize.pl:187
27431 " # virsh edit guestname\n"
27436 #: ../tools/virt-resize.pl:189
27438 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27439 "html#elementsDisks>"
27443 #: ../tools/virt-resize.pl:192
27444 msgid "Then start up the domain with the new, resized disk:"
27448 #: ../tools/virt-resize.pl:194
27451 " # virsh start guestname\n"
27456 #: ../tools/virt-resize.pl:196
27458 "and check that it still works. See also the L</NOTES> section below for "
27459 "additional information."
27463 #: ../tools/virt-resize.pl:199
27464 msgid "7. Resize LVs etc inside the guest"
27468 #: ../tools/virt-resize.pl:201
27469 msgid "(This can also be done offline using L<guestfish(1)>)"
27473 #: ../tools/virt-resize.pl:203
27475 "Once the guest has booted you should see the new space available, at least "
27476 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27477 "may need to resize LVs inside PVs, and also resize filesystem types that "
27478 "virt-resize does not know how to expand."
27482 #: ../tools/virt-resize.pl:210
27483 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27487 #: ../tools/virt-resize.pl:212
27489 "Shrinking is somewhat more complex than expanding, and only an overview is "
27494 #: ../tools/virt-resize.pl:215
27496 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27497 "filesystems). The user has to shrink content before passing the disk image "
27498 "to virt-resize, and virt-resize will check that the content has been shrunk "
27503 #: ../tools/virt-resize.pl:220
27504 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27508 #: ../tools/virt-resize.pl:222
27510 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27511 "steps 3 and 4 above to allocate a new disk image."
27515 #: ../tools/virt-resize.pl:225
27517 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27521 #: ../tools/virt-resize.pl:228
27522 msgid "IGNORING OR DELETING PARTITIONS"
27526 #: ../tools/virt-resize.pl:230
27528 "virt-resize also gives a convenient way to ignore or delete partitions when "
27529 "copying from the input disk to the output disk. Ignoring a partition speeds "
27530 "up the copy where you don't care about the existing contents of a "
27531 "partition. Deleting a partition removes it completely, but note that it "
27532 "also renumbers any partitions after the one which is deleted, which can "
27533 "leave some guests unbootable."
27537 #: ../tools/virt-resize.pl:237
27538 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27542 #: ../tools/virt-resize.pl:239
27544 "If the input disk is in qcow2 format, then you may prefer that the output is "
27545 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27546 "the fly. The output format is simply determined by the format of the empty "
27547 "output container that you provide. Thus to create qcow2 output, use:"
27551 #: ../tools/virt-resize.pl:245
27554 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27559 #: ../tools/virt-resize.pl:247
27560 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27564 #: ../tools/virt-resize.pl:249
27565 msgid "Similarly, to get non-sparse raw output use:"
27569 #: ../tools/virt-resize.pl:251
27572 " fallocate -l size outdisk\n"
27577 #: ../tools/virt-resize.pl:253
27579 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27580 "dev/zero of=outdisk bs=1M count=..>)"
27584 #: ../tools/virt-resize.pl:266
27585 msgid "Display help."
27589 #: ../tools/virt-resize.pl:280
27590 msgid "B<--resize part=size>"
27594 #: ../tools/virt-resize.pl:282
27596 "Resize the named partition (expanding or shrinking it) so that it has the "
27601 #: ../tools/virt-resize.pl:285
27603 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27604 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27605 "Exabytes; or as a percentage of the current size; or as a relative number or "
27606 "percentage. For example:"
27610 #: ../tools/virt-resize.pl:290
27613 " --resize /dev/sda2=10G\n"
27618 #: ../tools/virt-resize.pl:292
27621 " --resize /dev/sda4=90%\n"
27626 #: ../tools/virt-resize.pl:294
27629 " --resize /dev/sda2=+1G\n"
27634 #: ../tools/virt-resize.pl:296
27637 " --resize /dev/sda2=-200M\n"
27642 #: ../tools/virt-resize.pl:298
27645 " --resize /dev/sda1=+128K\n"
27650 #: ../tools/virt-resize.pl:300
27653 " --resize /dev/sda1=+10%\n"
27658 #: ../tools/virt-resize.pl:302
27661 " --resize /dev/sda1=-10%\n"
27666 #: ../tools/virt-resize.pl:304
27668 "You can increase the size of any partition. Virt-resize will expand the "
27669 "direct content of the partition if it knows how (see C<--expand> below)."
27673 #: ../tools/virt-resize.pl:308
27675 "You can only I<decrease> the size of partitions that contain filesystems or "
27676 "PVs which have already been shrunk. Virt-resize will check this has been "
27677 "done before proceeding, or else will print an error (see also C<--resize-"
27682 #: ../tools/virt-resize.pl:313 ../tools/virt-resize.pl:405
27683 #: ../tools/virt-resize.pl:422
27684 msgid "You can give this option multiple times."
27688 #: ../tools/virt-resize.pl:319
27689 msgid "B<--resize-force part=size>"
27693 #: ../tools/virt-resize.pl:321
27695 "This is the same as C<--resize> except that it will let you decrease the "
27696 "size of any partition. Generally this means you will lose any data which "
27697 "was at the end of the partition you shrink, but you may not care about that "
27698 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27699 "as a swap partition)."
27703 #: ../tools/virt-resize.pl:327
27704 msgid "See also the C<--ignore> option."
27708 #: ../tools/virt-resize.pl:333
27709 msgid "B<--expand part>"
27713 #: ../tools/virt-resize.pl:335
27715 "Expand the named partition so it uses up all extra space (space left over "
27716 "after any other resize changes that you request have been done)."
27720 #: ../tools/virt-resize.pl:338
27722 "If virt-resize knows how, it will expand the direct content of the "
27723 "partition. For example, if the partition is an LVM PV, it will expand the "
27724 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27725 "content it doesn't know about alone."
27729 #: ../tools/virt-resize.pl:343
27730 msgid "Currently virt-resize can resize:"
27734 #: ../tools/virt-resize.pl:349
27736 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27741 #: ../tools/virt-resize.pl:354
27743 "NTFS filesystems contained directly in a partition, if libguestfs was "
27744 "compiled with support for NTFS."
27748 #: ../tools/virt-resize.pl:357
27750 "The filesystem must have been shut down consistently last time it was used. "
27751 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27752 "consistency check, so at the first boot after resizing Windows will check "
27757 #: ../tools/virt-resize.pl:364
27759 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27760 "inside the PV. The user will have to resize LVs as desired."
27764 #: ../tools/virt-resize.pl:370 ../tools/virt-resize.pl:392
27765 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27769 #: ../tools/virt-resize.pl:376
27770 msgid "B<--shrink part>"
27774 #: ../tools/virt-resize.pl:378
27776 "Shrink the named partition until the overall disk image fits in the "
27777 "destination. The named partition B<must> contain a filesystem or PV which "
27778 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27779 "online tools). Virt-resize will check this and give an error if it has not "
27784 #: ../tools/virt-resize.pl:384
27786 "The amount by which the overall disk must be shrunk (after carrying out all "
27787 "other operations requested by the user) is called the \"deficit\". For "
27788 "example, a straight copy (assume no other operations) from a 5GB disk image "
27789 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27790 "would give an error unless the user specified a partition to shrink and that "
27791 "partition had more than a gigabyte of free space."
27795 #: ../tools/virt-resize.pl:398
27796 msgid "B<--ignore part>"
27800 #: ../tools/virt-resize.pl:400
27802 "Ignore the named partition. Effectively this means the partition is "
27803 "allocated on the destination disk, but the content is not copied across from "
27804 "the source disk. The content of the partition will be blank (all zero "
27809 #: ../tools/virt-resize.pl:411
27810 msgid "B<--delete part>"
27814 #: ../tools/virt-resize.pl:413
27816 "Delete the named partition. It would be more accurate to describe this as "
27817 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27818 "the original disk image is left intact."
27822 #: ../tools/virt-resize.pl:417
27824 "Note that when you delete a partition, then anything contained in the "
27825 "partition is also deleted. Furthermore, this causes any partitions that "
27826 "come after to be I<renumbered>, which can easily make your guest unbootable."
27830 #: ../tools/virt-resize.pl:428
27831 msgid "B<--LV-expand logvol>"
27835 #: ../tools/virt-resize.pl:430
27837 "This takes the logical volume and, as a final step, expands it to fill all "
27838 "the space available in its volume group. A typical usage, assuming a Linux "
27839 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27840 "lv_root> would be:"
27844 #: ../tools/virt-resize.pl:435
27847 " virt-resize indisk outdisk \\\n"
27848 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27853 #: ../tools/virt-resize.pl:438
27855 "This would first expand the partition (and PV), and then expand the root "
27856 "device to fill the extra space in the PV."
27860 #: ../tools/virt-resize.pl:441
27862 "The contents of the LV are also resized if virt-resize knows how to do "
27863 "that. You can stop virt-resize from trying to expand the content by using "
27864 "the option C<--no-expand-content>."
27868 #: ../tools/virt-resize.pl:445
27869 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27873 #: ../tools/virt-resize.pl:448
27875 "You can give this option multiple times, I<but> it doesn't make sense to do "
27876 "this unless the logical volumes you specify are all in different volume "
27881 #: ../tools/virt-resize.pl:456
27882 msgid "B<--no-copy-boot-loader>"
27886 #: ../tools/virt-resize.pl:458
27888 "By default, virt-resize copies over some sectors at the start of the disk "
27889 "(up to the beginning of the first partition). Commonly these sectors "
27890 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27891 "in order for the guest to boot correctly."
27895 #: ../tools/virt-resize.pl:463
27897 "If you specify this flag, then this initial copy is not done. You may need "
27898 "to reinstall the boot loader in this case."
27902 #: ../tools/virt-resize.pl:471
27903 msgid "B<--no-extra-partition>"
27907 #: ../tools/virt-resize.pl:473
27909 "By default, virt-resize creates an extra partition if there is any extra, "
27910 "unused space after all resizing has happened. Use this option to prevent "
27911 "the extra partition from being created. If you do this then the extra space "
27912 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27913 "tool in the guest."
27917 #: ../tools/virt-resize.pl:479
27919 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27924 #: ../tools/virt-resize.pl:486
27925 msgid "B<--no-expand-content>"
27929 #: ../tools/virt-resize.pl:488
27931 "By default, virt-resize will try to expand the direct contents of "
27932 "partitions, if it knows how (see C<--expand> option above)."
27936 #: ../tools/virt-resize.pl:491
27938 "If you give the C<--no-expand-content> option then virt-resize will not "
27943 #: ../tools/virt-resize.pl:498
27944 msgid "B<-d> | B<--debug>"
27948 #: ../tools/virt-resize.pl:506
27949 msgid "B<-n> | B<--dryrun>"
27953 #: ../tools/virt-resize.pl:508
27954 msgid "Print a summary of what would be done, but don't do anything."
27958 #: ../tools/virt-resize.pl:514
27959 msgid "B<-q> | B<--quiet>"
27963 #: ../tools/virt-resize.pl:516
27964 msgid "Don't print the summary."
27968 #: ../tools/virt-resize.pl:524
27970 "Specify the format of the input disk image. If this flag is not given then "
27971 "it is auto-detected from the image itself."
27975 #: ../tools/virt-resize.pl:530
27977 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27978 "AND NON-SPARSE RAW FORMATS>."
27982 #: ../tools/virt-resize.pl:537
27983 msgid "B<--output-format> raw"
27987 #: ../tools/virt-resize.pl:539
27989 "Specify the format of the output disk image. If this flag is not given then "
27990 "it is auto-detected from the image itself."
27994 #: ../tools/virt-resize.pl:545
27996 "Note that you still need to create the output disk with the right format. "
27997 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
28001 #: ../tools/virt-resize.pl:1421 ../tools/virt-rescue.pl:90
28006 #: ../tools/virt-resize.pl:1423
28007 msgid "\"Partition 1 does not end on cylinder boundary.\""
28011 #: ../tools/virt-resize.pl:1425
28013 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
28014 "means the partitions will not be aligned to the ancient CHS geometry. "
28015 "However CHS geometry is meaningless for disks manufactured since the early "
28016 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
28017 "cylinders is not required by any modern operating system."
28021 #: ../tools/virt-resize.pl:1432
28022 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
28026 #: ../tools/virt-resize.pl:1434
28028 "In Windows Vista and later versions, Microsoft switched to using a separate "
28029 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
28030 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
28031 "the boot partition. Doing so seems to break the guest completely. However "
28032 "expanding the second partition (ie. C: drive) should work."
28036 #: ../tools/virt-resize.pl:1441
28038 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
28039 "NTFS partitions have been expanded. This is just a safety check and (unless "
28040 "it find errors) is nothing to worry about."
28044 #: ../tools/virt-resize.pl:1445
28045 msgid "GUEST BOOT STUCK AT \"GRUB\""
28049 #: ../tools/virt-resize.pl:1447
28051 "If a Linux guest does not boot after resizing, and the boot is stuck after "
28052 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
28053 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
28054 "although we think is to do with partition alignment."
28058 #: ../tools/virt-resize.pl:1452
28061 " guestfish -i -a newdisk\n"
28062 " ><fs> cat /boot/grub/device.map\n"
28063 " # check the contents of this file are sensible or\n"
28064 " # edit the file if necessary\n"
28065 " ><fs> grub-install / /dev/vda\n"
28071 #: ../tools/virt-resize.pl:1459
28073 "For more flexible guest reconfiguration, including if you need to specify "
28074 "other parameters to grub-install, use L<virt-rescue(1)>."
28078 #: ../tools/virt-resize.pl:1462
28079 msgid "ALTERNATIVE TOOLS"
28083 #: ../tools/virt-resize.pl:1464
28085 "There are several proprietary tools for resizing partitions. We won't "
28086 "mention any here."
28090 #: ../tools/virt-resize.pl:1467
28092 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
28093 "operations on disk images. They can resize and move partitions, but I don't "
28094 "think they can do anything with the contents, and they certainly don't "
28099 #: ../tools/virt-resize.pl:1472
28101 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
28102 "but at a much lower level. You will probably end up hand-calculating sector "
28103 "offsets, which is something that virt-resize was designed to avoid. If you "
28104 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
28109 #: ../tools/virt-resize.pl:1487
28111 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
28112 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
28113 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
28114 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
28115 "libguestfs.org/>."
28119 #: ../tools/virt-list-filesystems.pl:32
28121 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28125 #: ../tools/virt-list-filesystems.pl:36
28128 " virt-list-filesystems [--options] domname\n"
28133 #: ../tools/virt-list-filesystems.pl:38
28136 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28141 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
28143 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
28148 #: ../tools/virt-list-filesystems.pl:45
28150 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28151 "are contained in a virtual machine or disk image."
28155 #: ../tools/virt-list-filesystems.pl:49
28157 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28158 "functionality. For more complex cases you should look at the L<guestfish(1)"
28163 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
28164 msgid "B<-l> | B<--long>"
28168 #: ../tools/virt-list-filesystems.pl:108
28170 "With this option, C<virt-list-filesystems> displays the type of each "
28171 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28175 #: ../tools/virt-list-filesystems.pl:115
28176 msgid "B<-a> | B<--all>"
28180 #: ../tools/virt-list-filesystems.pl:117
28182 "Normally we only show mountable filesystems. If this option is given then "
28183 "swap devices are shown too."
28187 #: ../tools/virt-list-filesystems.pl:191
28189 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
28190 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28191 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28195 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
28196 msgid "Copyright (C) 2009 Red Hat Inc."
28200 #: ../tools/virt-tar.pl:33
28201 msgid "virt-tar - Extract or upload files to a virtual machine"
28205 #: ../tools/virt-tar.pl:37
28208 " virt-tar [--options] -x domname directory tarball\n"
28213 #: ../tools/virt-tar.pl:39
28216 " virt-tar [--options] -u domname tarball directory\n"
28221 #: ../tools/virt-tar.pl:41
28224 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28229 #: ../tools/virt-tar.pl:43
28232 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28237 #: ../tools/virt-tar.pl:47
28238 msgid "Download C</home> from the VM into a local tarball:"
28242 #: ../tools/virt-tar.pl:49
28245 " virt-tar -x domname /home home.tar\n"
28250 #: ../tools/virt-tar.pl:51
28253 " virt-tar -zx domname /home home.tar.gz\n"
28258 #: ../tools/virt-tar.pl:53
28259 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28263 #: ../tools/virt-tar.pl:55
28266 " virt-tar -u domname uploadstuff.tar /tmp\n"
28271 #: ../tools/virt-tar.pl:57
28274 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28279 #: ../tools/virt-tar.pl:61
28281 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28282 "virtual machines. If you do this, you risk disk corruption in the VM. "
28283 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28287 #: ../tools/virt-tar.pl:66
28289 "You can use C<-x> (extract) on live virtual machines, but you might get "
28290 "inconsistent results or errors if there is filesystem activity inside the "
28291 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28292 "work, but the only way to guarantee consistent results is if the virtual "
28293 "machine is shut down."
28297 #: ../tools/virt-tar.pl:74
28299 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28300 "parts of a guest filesystem. There are many possibilities: making backups, "
28301 "uploading data files, snooping on guest activity, fixing or customizing "
28306 #: ../tools/virt-tar.pl:79
28308 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28309 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28310 "should look at the L<guestfish(1)> tool."
28314 #: ../tools/virt-tar.pl:83
28316 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28317 "its contents (recursively) from the virtual machine into a local tarball. "
28318 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28319 "virtual machine. You cannot use these two options together."
28323 #: ../tools/virt-tar.pl:89
28325 "In addition, you may need to use the C<-z> (gZip) option to enable "
28326 "compression. When uploading, you have to specify C<-z> if the upload file "
28327 "is compressed because virt-tar won't detect this on its own."
28331 #: ../tools/virt-tar.pl:93
28333 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28334 "example it cannot do PKZip files or bzip2 compression. If you want that "
28335 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28336 "the L<libguestfs(3)> API)."
28340 #: ../tools/virt-tar.pl:151
28341 msgid "B<-x> | B<--extract> | B<--download>"
28345 #: ../tools/virt-tar.pl:153
28346 msgid "B<-u> | B<--upload>"
28350 #: ../tools/virt-tar.pl:155
28352 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28357 #: ../tools/virt-tar.pl:158
28359 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28360 "Please read the L</WARNING> section above before using this option."
28364 #: ../tools/virt-tar.pl:162
28365 msgid "You must specify exactly one of these options."
28369 #: ../tools/virt-tar.pl:168
28370 msgid "B<-z> | B<--gzip>"
28374 #: ../tools/virt-tar.pl:170
28375 msgid "Specify that the input or output tarball is gzip-compressed."
28379 #: ../tools/virt-tar.pl:283
28381 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28382 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28387 #: ../tools/virt-rescue.pl:33
28388 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28392 #: ../tools/virt-rescue.pl:37
28395 " virt-rescue [--options] domname\n"
28400 #: ../tools/virt-rescue.pl:39
28403 " virt-rescue [--options] disk.img [disk.img ...]\n"
28408 #: ../tools/virt-rescue.pl:43
28410 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28411 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28412 "you from doing this, but doesn't catch all cases."
28416 #: ../tools/virt-rescue.pl:47
28418 "However if you use the I<--ro> (read only) option, then you can attach a "
28419 "shell to a live virtual machine. The results might be strange or "
28420 "inconsistent at times but you won't get disk corruption."
28424 #: ../tools/virt-rescue.pl:53
28426 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28427 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28428 "recovery tools which you can use to examine or rescue a virtual machine or "
28433 #: ../tools/virt-rescue.pl:58
28435 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28436 "on disk image(s):"
28440 #: ../tools/virt-rescue.pl:61
28443 " virt-rescue GuestName\n"
28448 #: ../tools/virt-rescue.pl:63
28451 " virt-rescue --ro /path/to/disk.img\n"
28456 #: ../tools/virt-rescue.pl:65
28459 " virt-rescue /dev/sdc\n"
28464 #: ../tools/virt-rescue.pl:67
28465 msgid "For live VMs you I<must> use the --ro option."
28469 #: ../tools/virt-rescue.pl:69
28471 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28472 "in an interactive bash shell where you can use many ordinary Linux "
28473 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28474 "appliance. You must mount the virtual machine's filesystems by hand. There "
28475 "is an empty directory called C</sysroot> where you can mount filesystems."
28479 #: ../tools/virt-rescue.pl:76
28481 "In the example below, we list logical volumes, then choose one to mount "
28482 "under C</sysroot>:"
28486 #: ../tools/virt-rescue.pl:79
28490 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28491 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28492 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28493 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28494 " ><rescue> ls /sysroot\n"
28499 #: ../tools/virt-rescue.pl:86
28501 "If you don't know what filesystems are available on the virtual machine then "
28502 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28506 #: ../tools/virt-rescue.pl:92
28508 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28509 "virtual machine. For example you can use it on a blank file if you want to "
28510 "partition that file (although we would recommend using L<guestfish(1)> "
28511 "instead as it is more suitable for this purpose). You can even use virt-"
28512 "rescue on things like SD cards."
28516 #: ../tools/virt-rescue.pl:98
28518 "This tool is just designed for quick interactive hacking on a virtual "
28519 "machine. For more structured access to a virtual machine disk image, you "
28520 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28521 "make scripted changes to guests, use L<guestfish(1)>."
28525 #: ../tools/virt-rescue.pl:127
28526 msgid "B<--append kernelopts>"
28530 #: ../tools/virt-rescue.pl:129
28531 msgid "Pass additional options to the rescue kernel."
28535 #: ../tools/virt-rescue.pl:164
28536 msgid "B<--memsize MB> | B<-m MB>"
28540 #: ../tools/virt-rescue.pl:166
28542 "Change the amount of memory allocated to the rescue system. The default is "
28543 "set by libguestfs and is small but adequate for running system tools. The "
28544 "occasional program might need more memory. The parameter is specified in "
28549 #: ../tools/virt-rescue.pl:175
28550 msgid "B<--network>"
28554 #: ../tools/virt-rescue.pl:177
28555 msgid "Enable QEMU user networking in the guest."
28559 #: ../tools/virt-rescue.pl:183
28560 msgid "B<--ro> | B<-r>"
28564 #: ../tools/virt-rescue.pl:185
28565 msgid "Open the image read-only."
28569 #: ../tools/virt-rescue.pl:197
28571 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
28572 "SELINUX> before using this option."
28576 #: ../tools/virt-rescue.pl:257
28578 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
28579 "ENVIRONMENT VARIABLES> for the complete list."
28583 #: ../tools/virt-rescue.pl:269
28585 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
28586 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28590 #: ../tools/virt-make-fs.pl:37
28591 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28595 #: ../tools/virt-make-fs.pl:41
28598 " virt-make-fs [--options] input.tar output.img\n"
28603 #: ../tools/virt-make-fs.pl:43
28606 " virt-make-fs [--options] input.tar.gz output.img\n"
28611 #: ../tools/virt-make-fs.pl:45
28614 " virt-make-fs [--options] directory output.img\n"
28619 #: ../tools/virt-make-fs.pl:49
28621 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28622 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28623 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28624 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28625 "you want to attach these filesystems to existing virtual machines (eg. to "
28626 "import large amounts of read-only data to a VM)."
28630 #: ../tools/virt-make-fs.pl:57
28631 msgid "Basic usage is:"
28635 #: ../tools/virt-make-fs.pl:59
28638 " virt-make-fs input output\n"
28643 #: ../tools/virt-make-fs.pl:61
28645 "where C<input> is either a directory containing files that you want to add, "
28646 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28647 "C<output> is a disk image. The input type is detected automatically. The "
28648 "output disk image defaults to a raw ext2 image unless you specify extra "
28649 "flags (see L</OPTIONS> below)."
28653 #: ../tools/virt-make-fs.pl:67
28654 msgid "EXTRA SPACE"
28658 #: ../tools/virt-make-fs.pl:69
28660 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28661 "the files that it contains, but might have extra space. Depending on how "
28662 "you are going to use the output, you might think this extra space is wasted "
28663 "and want to minimize it, or you might want to leave space so that more files "
28664 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28665 "but you can use the C<--size> flag to leave space in the filesystem if you "
28670 #: ../tools/virt-make-fs.pl:77
28672 "An alternative way to leave extra space but not make the output image any "
28673 "bigger is to use an alternative disk image format (instead of the default "
28674 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28675 "image format (check your hypervisor supports this before using it). This "
28676 "allows you to choose a large C<--size> but the extra space won't actually be "
28677 "allocated in the image until you try to store something in it."
28681 #: ../tools/virt-make-fs.pl:85
28683 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28684 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28685 "resize to build another image from scratch."
28689 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28690 #: ../tools/virt-make-fs.pl:142
28695 #: ../tools/virt-make-fs.pl:91
28698 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28703 #: ../tools/virt-make-fs.pl:93
28704 msgid "FILESYSTEM TYPE"
28708 #: ../tools/virt-make-fs.pl:95
28710 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28711 "libguestfs supports can be used (but I<not> read-only formats like "
28712 "ISO9660). Here are some of the more common choices:"
28716 #: ../tools/virt-make-fs.pl:101
28721 #: ../tools/virt-make-fs.pl:103
28723 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28724 "you are not going to use the filesystem in a way that requires the journal, "
28725 "then this is just wasted overhead."
28729 #: ../tools/virt-make-fs.pl:107
28730 msgid "I<ntfs> or I<vfat>"
28734 #: ../tools/virt-make-fs.pl:109
28735 msgid "Useful if exporting data to a Windows guest."
28739 #: ../tools/virt-make-fs.pl:111
28741 "I<Note for vfat>: The tar archive or local directory must only contain files "
28742 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28743 "program running within libguestfs is unable to change the ownership of non-"
28744 "root files, since vfat itself does not support this."
28748 #: ../tools/virt-make-fs.pl:116
28753 #: ../tools/virt-make-fs.pl:118
28755 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28756 "total filesystem size."
28760 #: ../tools/virt-make-fs.pl:125
28763 " virt-make-fs --type=minix input minixfs.img\n"
28768 #: ../tools/virt-make-fs.pl:127
28769 msgid "TO PARTITION OR NOT TO PARTITION"
28773 #: ../tools/virt-make-fs.pl:129
28774 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28778 #: ../tools/virt-make-fs.pl:131
28780 "Adding a partition can make the disk image more compatible with certain "
28781 "virtualized operating systems which don't expect to see a filesystem "
28782 "directly located on a block device (Linux doesn't care and will happily "
28783 "handle both types)."
28787 #: ../tools/virt-make-fs.pl:136
28789 "On the other hand, if you have a partition table then the output image is no "
28790 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28791 "directly on a partitioned disk image. (However libguestfs tools such as "
28792 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28796 #: ../tools/virt-make-fs.pl:144
28797 msgid "Add an MBR partition:"
28801 #: ../tools/virt-make-fs.pl:146
28804 " virt-make-fs --partition -- input disk.img\n"
28809 #: ../tools/virt-make-fs.pl:148
28811 "If the output disk image could be terabyte-sized or larger, it's better to "
28812 "use an EFI/GPT-compatible partition table:"
28816 #: ../tools/virt-make-fs.pl:151
28819 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28824 #: ../tools/virt-make-fs.pl:179
28825 msgid "Enable debugging information."
28829 #: ../tools/virt-make-fs.pl:185
28830 msgid "B<--size=E<lt>NE<gt>>"
28834 #: ../tools/virt-make-fs.pl:187
28835 msgid "B<--size=+E<lt>NE<gt>>"
28839 #: ../tools/virt-make-fs.pl:189
28840 msgid "B<-s E<lt>NE<gt>>"
28844 #: ../tools/virt-make-fs.pl:191
28845 msgid "B<-s +E<lt>NE<gt>>"
28849 #: ../tools/virt-make-fs.pl:193
28851 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28855 #: ../tools/virt-make-fs.pl:196
28857 "If this option is I<not> given, then the output image will be just large "
28858 "enough to contain all the files, with not much wasted space."
28862 #: ../tools/virt-make-fs.pl:199
28864 "To choose a fixed size output disk, specify an absolute number followed by b/"
28865 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28866 "Petabytes or Exabytes. This must be large enough to contain all the input "
28867 "files, else you will get an error."
28871 #: ../tools/virt-make-fs.pl:204
28873 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28874 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28875 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28876 "the input files, and (approximately) an extra 200 MB free space."
28880 #: ../tools/virt-make-fs.pl:210
28882 "Note that virt-make-fs estimates free space, and therefore will not produce "
28883 "filesystems containing precisely the free space requested. (It is much more "
28884 "expensive and time-consuming to produce a filesystem which has precisely the "
28885 "desired free space)."
28889 #: ../tools/virt-make-fs.pl:219
28890 msgid "B<--format=E<lt>fmtE<gt>>"
28894 #: ../tools/virt-make-fs.pl:221
28895 msgid "B<-F E<lt>fmtE<gt>>"
28899 #: ../tools/virt-make-fs.pl:223
28900 msgid "Choose the output disk image format."
28904 #: ../tools/virt-make-fs.pl:225
28905 msgid "The default is C<raw> (raw disk image)."
28909 #: ../tools/virt-make-fs.pl:227
28911 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28912 "that would really make sense here is C<qcow2>."
28916 #: ../tools/virt-make-fs.pl:234
28917 msgid "B<--type=E<lt>fsE<gt>>"
28921 #: ../tools/virt-make-fs.pl:236
28922 msgid "B<-t E<lt>fsE<gt>>"
28926 #: ../tools/virt-make-fs.pl:238
28927 msgid "Choose the output filesystem type."
28931 #: ../tools/virt-make-fs.pl:240
28932 msgid "The default is C<ext2>."
28936 #: ../tools/virt-make-fs.pl:242
28938 "Any filesystem which is supported read-write by libguestfs can be used here."
28942 #: ../tools/virt-make-fs.pl:249
28943 msgid "B<--partition>"
28947 #: ../tools/virt-make-fs.pl:251
28948 msgid "B<--partition=E<lt>parttypeE<gt>>"
28952 #: ../tools/virt-make-fs.pl:253
28954 "If specified, this flag adds an MBR partition table to the output disk image."
28958 #: ../tools/virt-make-fs.pl:256
28960 "You can change the partition table type, eg. C<--partition=gpt> for large "
28965 #: ../tools/virt-make-fs.pl:259
28967 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28968 "might consider the next parameter to be the partition type. For example:"
28972 #: ../tools/virt-make-fs.pl:263
28975 " virt-make-fs --partition input.tar ...\n"
28980 #: ../tools/virt-make-fs.pl:265
28982 "would cause virt-make-fs to think you wanted to use a partition type of "
28983 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28984 "dash) between options and the input file argument:"
28988 #: ../tools/virt-make-fs.pl:269
28991 " virt-make-fs --partition -- input.tar ...\n"
28996 #: ../tools/virt-make-fs.pl:536
28998 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28999 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
29000 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
29004 #: ../tools/virt-make-fs.pl:553
29007 " export LIBGUESTFS_DEBUG=1\n"
29008 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
29013 #: ../tools/virt-make-fs.pl:556
29015 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
29020 #: ../tools/virt-list-partitions.pl:32
29022 "virt-list-partitions - List partitions in a virtual machine or disk image"
29026 #: ../tools/virt-list-partitions.pl:36
29029 " virt-list-partitions [--options] domname\n"
29034 #: ../tools/virt-list-partitions.pl:38
29037 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
29042 #: ../tools/virt-list-partitions.pl:45
29044 "C<virt-list-partitions> is a command line tool to list the partitions that "
29045 "are contained in a virtual machine or disk image. It is mainly useful as a "
29046 "first step to using L<virt-resize(1)>."
29050 #: ../tools/virt-list-partitions.pl:50
29052 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
29053 "functionality. For more complex cases you should look at the L<guestfish(1)"
29058 #: ../tools/virt-list-partitions.pl:107
29059 msgid "B<-h> | B<--human-readable>"
29063 #: ../tools/virt-list-partitions.pl:109
29064 msgid "Show sizes in human-readable form (eg. \"1G\")."
29068 #: ../tools/virt-list-partitions.pl:117
29070 "With this option, C<virt-list-partitions> displays the type and size of each "
29071 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
29075 #: ../tools/virt-list-partitions.pl:124
29076 msgid "B<-t> | B<--total>"
29080 #: ../tools/virt-list-partitions.pl:126
29082 "Display the total size of each block device (as a separate row or rows)."
29086 #: ../tools/virt-list-partitions.pl:259
29088 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
29089 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
29090 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."