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-26 17:27+0000\n"
11 "PO-Revision-Date: 2010-09-02 14:46+0100\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1
21 #: ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1
22 #: ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33
23 #: ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28
24 #: ../tools/virt-tar.pl:29 ../tools/virt-make-fs.pl:33
25 #: ../tools/virt-list-partitions.pl:28
30 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3
31 #: ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3
32 #: ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35
33 #: ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30
34 #: ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35
35 #: ../tools/virt-list-partitions.pl:30
40 #: ../src/guestfs.pod:5
41 msgid "guestfs - Library for accessing and modifying virtual machine images"
45 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7
46 #: ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7
47 #: ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39
48 #: ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34
49 #: ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39
50 #: ../tools/virt-list-partitions.pl:34
55 #: ../src/guestfs.pod:9
58 " #include <guestfs.h>\n"
63 #: ../src/guestfs.pod:11
66 " guestfs_h *g = guestfs_create ();\n"
67 " guestfs_add_drive (g, \"guest.img\");\n"
68 " guestfs_launch (g);\n"
69 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
70 " guestfs_touch (g, \"/hello\");\n"
71 " guestfs_umount (g, \"/\");\n"
72 " guestfs_sync (g);\n"
73 " guestfs_close (g);\n"
78 #: ../src/guestfs.pod:20
81 " cc prog.c -o prog -lguestfs\n"
83 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
88 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30
89 #: ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20
90 #: ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63
91 #: ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40
92 #: ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47
93 #: ../tools/virt-list-partitions.pl:40
98 #: ../src/guestfs.pod:26
100 "Libguestfs is a library for accessing and modifying guest disk images. "
101 "Amongst the things this is good for: making batch configuration changes to "
102 "guests, getting disk used/free statistics (see also: virt-df), migrating "
103 "between virtualization systems (see also: virt-p2v), performing partial "
104 "backups, performing partial guest clones, cloning guests and changing "
105 "registry/UUID/hostname info, and much else besides."
109 #: ../src/guestfs.pod:34
111 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
112 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
113 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
118 #: ../src/guestfs.pod:39
120 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
121 "what filesystem is in each LV, etc.). It can also run commands in the "
122 "context of the guest. Also you can access filesystems over FUSE."
126 #: ../src/guestfs.pod:44
128 "Libguestfs is a library that can be linked with C and C++ management "
129 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
130 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
135 #: ../src/guestfs.pod:49
137 "You don't need to be root to use libguestfs, although obviously you do need "
138 "enough permissions to access the disk images."
142 #: ../src/guestfs.pod:52
144 "Libguestfs is a large API because it can do many things. For a gentle "
145 "introduction, please read the L</API OVERVIEW> section next."
149 #: ../src/guestfs.pod:55
151 "There are also some example programs in the L<guestfs-examples(3)> manual "
156 #: ../src/guestfs.pod:58
161 #: ../src/guestfs.pod:60
163 "This section provides a gentler overview of the libguestfs API. We also try "
164 "to group API calls together, where that may not be obvious from reading "
165 "about the individual calls in the main section of this manual."
169 #: ../src/guestfs.pod:65
174 #: ../src/guestfs.pod:67
176 "Before you can use libguestfs calls, you have to create a handle. Then you "
177 "must add at least one disk image to the handle, followed by launching the "
178 "handle, then performing whatever operations you want, and finally closing "
179 "the handle. By convention we use the single letter C<g> for the name of the "
180 "handle variable, although of course you can use any name you want."
184 #: ../src/guestfs.pod:74
185 msgid "The general structure of all libguestfs-using programs looks like this:"
189 #: ../src/guestfs.pod:77
192 " guestfs_h *g = guestfs_create ();\n"
197 #: ../src/guestfs.pod:79
200 " /* Call guestfs_add_drive additional times if there are\n"
201 " * multiple disk images.\n"
203 " guestfs_add_drive (g, \"guest.img\");\n"
208 #: ../src/guestfs.pod:84
211 " /* Most manipulation calls won't work until you've launched\n"
212 " * the handle 'g'. You have to do this _after_ adding drives\n"
213 " * and _before_ other commands.\n"
215 " guestfs_launch (g);\n"
220 #: ../src/guestfs.pod:90
223 " /* Now you can examine what partitions, LVs etc are available.\n"
225 " char **partitions = guestfs_list_partitions (g);\n"
226 " char **logvols = guestfs_lvs (g);\n"
231 #: ../src/guestfs.pod:95
234 " /* To access a filesystem in the image, you must mount it.\n"
236 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
241 #: ../src/guestfs.pod:99
244 " /* Now you can perform filesystem actions on the guest\n"
247 " guestfs_touch (g, \"/hello\");\n"
252 #: ../src/guestfs.pod:104
255 " /* You only need to call guestfs_sync if you have made\n"
256 " * changes to the guest image. (But if you've made changes\n"
257 " * then you *must* sync). See also: guestfs_umount and\n"
258 " * guestfs_umount_all calls.\n"
260 " guestfs_sync (g);\n"
265 #: ../src/guestfs.pod:111
268 " /* Close the handle 'g'. */\n"
269 " guestfs_close (g);\n"
274 #: ../src/guestfs.pod:114
276 "The code above doesn't include any error checking. In real code you should "
277 "check return values carefully for errors. In general all functions that "
278 "return integers return C<-1> on error, and all functions that return "
279 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
280 "how to handle errors, and consult the documentation for each function call "
281 "below to see precisely how they return error indications."
285 #: ../src/guestfs.pod:122
290 #: ../src/guestfs.pod:124
292 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
293 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
294 "actual block device, or simply an empty file of zeroes that you have created "
295 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
300 #: ../src/guestfs.pod:130
302 "The call you should use in modern code for adding drives is L</"
303 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
304 "specifying that the format is raw, do:"
308 #: ../src/guestfs.pod:134
311 " guestfs_add_drive_opts (g, filename,\n"
312 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
318 #: ../src/guestfs.pod:138
319 msgid "You can add a disk read-only using:"
323 #: ../src/guestfs.pod:140
326 " guestfs_add_drive_opts (g, filename,\n"
327 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
328 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
334 #: ../src/guestfs.pod:145
336 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
337 "libguestfs won't modify the file."
341 #: ../src/guestfs.pod:148
343 "Be extremely cautious if the disk image is in use, eg. if it is being used "
344 "by a virtual machine. Adding it read-write will almost certainly cause disk "
345 "corruption, but adding it read-only is safe."
349 #: ../src/guestfs.pod:152
351 "You must add at least one disk image, and you may add multiple disk images. "
352 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
353 "first one you added), C</dev/sdb> (for the second one you added), etc."
357 #: ../src/guestfs.pod:157
359 "Once L</guestfs_launch> has been called you cannot add any more images. You "
360 "can call L</guestfs_list_devices> to get a list of the device names, in the "
361 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
365 #: ../src/guestfs.pod:162
370 #: ../src/guestfs.pod:164
372 "Before you can read or write files, create directories and so on in a disk "
373 "image that contains filesystems, you have to mount those filesystems using "
374 "L</guestfs_mount>. If you already know that a disk image contains (for "
375 "example) one partition with a filesystem on that partition, then you can "
380 #: ../src/guestfs.pod:170
383 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
388 #: ../src/guestfs.pod:172
390 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
391 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
392 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
396 #: ../src/guestfs.pod:176
398 "If you are given a disk image and you don't know what it contains then you "
399 "have to find out. Libguestfs can do that too: use L</"
400 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
401 "LVs, and either try mounting each to see what is mountable, or else examine "
402 "them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also has a "
403 "set of APIs for inspection of disk images (see L</INSPECTION> below). But "
404 "you might find it easier to look at higher level programs built on top of "
405 "libguestfs, in particular L<virt-inspector(1)>."
409 #: ../src/guestfs.pod:186
411 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
412 "several other variations of the C<guestfs_mount_*> call."
416 #: ../src/guestfs.pod:189
417 msgid "FILESYSTEM ACCESS AND MODIFICATION"
421 #: ../src/guestfs.pod:191
423 "The majority of the libguestfs API consists of fairly low-level calls for "
424 "accessing and modifying the files, directories, symlinks etc on mounted "
425 "filesystems. There are over a hundred such calls which you can find listed "
426 "in detail below in this man page, and we don't even pretend to cover them "
427 "all in this overview."
431 #: ../src/guestfs.pod:197
433 "Specify filenames as full paths, starting with C<\"/\"> and including the "
438 #: ../src/guestfs.pod:200
440 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
441 "the file called C<\"etc/passwd\"> then you could do:"
445 #: ../src/guestfs.pod:203
448 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
453 #: ../src/guestfs.pod:205
455 "This would return C<data> as a newly allocated buffer containing the full "
456 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
457 "or C<NULL> if there was an error."
461 #: ../src/guestfs.pod:209
463 "As another example, to create a top-level directory on that filesystem "
464 "called C<\"var\"> you would do:"
468 #: ../src/guestfs.pod:212
471 " guestfs_mkdir (g, \"/var\");\n"
476 #: ../src/guestfs.pod:214
477 msgid "To create a symlink you could do:"
481 #: ../src/guestfs.pod:216
484 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
485 " \"/etc/rc3.d/S30portmap\");\n"
490 #: ../src/guestfs.pod:219
492 "Libguestfs will reject attempts to use relative paths and there is no "
493 "concept of a current working directory."
497 #: ../src/guestfs.pod:222
499 "Libguestfs can return errors in many situations: for example if the "
500 "filesystem isn't writable, or if a file or directory that you requested "
501 "doesn't exist. If you are using the C API (documented here) you have to "
502 "check for those error conditions after each call. (Other language bindings "
503 "turn these errors into exceptions)."
507 #: ../src/guestfs.pod:228
509 "File writes are affected by the per-handle umask, set by calling L</"
510 "guestfs_umask> and defaulting to 022. See L</UMASK>."
514 #: ../src/guestfs.pod:231
519 #: ../src/guestfs.pod:233
521 "Libguestfs contains API calls to read, create and modify partition tables on "
526 #: ../src/guestfs.pod:236
528 "In the common case where you want to create a single partition covering the "
529 "whole disk, you should use the L</guestfs_part_disk> call:"
533 #: ../src/guestfs.pod:240
536 " const char *parttype = \"mbr\";\n"
537 " if (disk_is_larger_than_2TB)\n"
538 " parttype = \"gpt\";\n"
539 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
544 #: ../src/guestfs.pod:245
546 "Obviously this effectively wipes anything that was on that disk image before."
550 #: ../src/guestfs.pod:248
555 #: ../src/guestfs.pod:250
557 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
558 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
559 "you familiarize yourself with the concepts of physical volumes, volume "
560 "groups and logical volumes."
564 #: ../src/guestfs.pod:255
566 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
567 "tldp.org/HOWTO/LVM-HOWTO/>."
571 #: ../src/guestfs.pod:258
576 #: ../src/guestfs.pod:260
578 "Use L</guestfs_cat> to download small, text only files. This call is "
579 "limited to files which are less than 2 MB and which cannot contain any ASCII "
580 "NUL (C<\\0>) characters. However it has a very simple to use API."
584 #: ../src/guestfs.pod:265
586 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
587 "bit data, since it returns a (pointer, size) pair. However it is still "
588 "limited to \"small\" files, less than 2 MB."
592 #: ../src/guestfs.pod:269
594 "L</guestfs_download> can be used to download any file, with no limits on "
595 "content or size (even files larger than 4 GB)."
599 #: ../src/guestfs.pod:272
601 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
605 #: ../src/guestfs.pod:275
610 #: ../src/guestfs.pod:277
612 "It's often the case that you want to write a file or files to the disk image."
616 #: ../src/guestfs.pod:280
618 "To write a small file with fixed content, use L</guestfs_write>. To create "
619 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
620 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
621 "of other functions for creating test files, for example L</guestfs_fill> and "
622 "L</guestfs_fill_pattern>."
626 #: ../src/guestfs.pod:286
628 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
629 "file content or size (even files larger than 4 GB)."
633 #: ../src/guestfs.pod:289
635 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
639 #: ../src/guestfs.pod:291
641 "However the fastest way to upload I<large numbers of arbitrary files> is to "
642 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
643 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
644 "in a predictable way (eg. adding it last after all other drives) then you "
645 "can get the device name from L</guestfs_list_devices> and mount it directly "
646 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
647 "portable between kernel versions, and they don't support labels or UUIDs. "
648 "If you want to pre-build an image or you need to mount it using a label or "
649 "UUID, use an ISO image instead."
653 #: ../src/guestfs.pod:302
658 #: ../src/guestfs.pod:304
660 "There are various different commands for copying between files and devices "
661 "and in and out of the guest filesystem. These are summarised in the table "
666 #: ../src/guestfs.pod:310
667 msgid "B<file> to B<file>"
671 #: ../src/guestfs.pod:312
673 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
674 "directories recursively."
678 #: ../src/guestfs.pod:315
679 msgid "B<file or device> to B<file or device>"
683 #: ../src/guestfs.pod:317
685 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
686 "devices in the guest."
690 #: ../src/guestfs.pod:320
691 msgid "Example: duplicate the contents of an LV:"
695 #: ../src/guestfs.pod:322
698 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
703 #: ../src/guestfs.pod:324
705 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
706 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
707 "guestfs_copy_size>."
711 #: ../src/guestfs.pod:328
712 msgid "B<file on the host> to B<file or device>"
716 #: ../src/guestfs.pod:330
717 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
721 #: ../src/guestfs.pod:332
722 msgid "B<file or device> to B<file on the host>"
726 #: ../src/guestfs.pod:334
727 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
731 #: ../src/guestfs.pod:338
732 msgid "LISTING FILES"
736 #: ../src/guestfs.pod:340
738 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
739 "L<guestfish(1)>-equivalent command C<ll>)."
743 #: ../src/guestfs.pod:343
745 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
746 "programs, as a flat list of strings."
750 #: ../src/guestfs.pod:346
752 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
753 "directory, plus additional information about each one. It is more "
754 "equivalent to using the L<readdir(3)> call on a local filesystem."
758 #: ../src/guestfs.pod:350
760 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
764 #: ../src/guestfs.pod:353
765 msgid "RUNNING COMMANDS"
769 #: ../src/guestfs.pod:355
771 "Although libguestfs is primarily an API for manipulating files inside guest "
772 "images, we also provide some limited facilities for running commands inside "
777 #: ../src/guestfs.pod:359
778 msgid "There are many limitations to this:"
782 #: ../src/guestfs.pod:363 ../src/guestfs.pod:368 ../src/guestfs.pod:373
783 #: ../src/guestfs.pod:377 ../src/guestfs.pod:382 ../src/guestfs.pod:386
784 #: ../src/guestfs.pod:391 ../src/guestfs.pod:396 ../src/guestfs.pod:955
785 #: ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968
786 #: ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003
787 #: ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033
788 #: ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045
789 #: ../src/guestfs.pod:1527 ../src/guestfs.pod:1532 ../src/guestfs.pod:1536
790 #: ../src/guestfs.pod:1646 ../src/guestfs.pod:1651 ../src/guestfs.pod:1655
791 #: ../src/guestfs.pod:1999 ../src/guestfs.pod:2005 ../src/guestfs.pod:2010
792 #: ../src/guestfs.pod:2016 ../src/guestfs.pod:2128 ../src/guestfs.pod:2132
793 #: ../src/guestfs.pod:2136 ../src/guestfs.pod:2140
794 #: ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22
795 #: ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577
796 #: ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591
797 #: ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591
798 #: ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599
799 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611
800 #: ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625
801 #: ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633
802 #: ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775
803 #: ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785
804 #: ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850
805 #: ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:377
806 #: ../fish/guestfish.pod:381 ../fish/guestfish.pod:385
807 #: ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13
808 #: ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375
809 #: ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390
810 #: ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067
811 #: ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075
812 #: ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087
813 #: ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095
814 #: ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109
815 #: ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203
816 #: ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212
817 #: ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259
818 #: ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268
819 #: ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:352
820 #: ../tools/virt-resize.pl:362
825 #: ../src/guestfs.pod:365
827 "The kernel version that the command runs under will be different from what "
832 #: ../src/guestfs.pod:370
834 "If the command needs to communicate with daemons, then most likely they "
839 #: ../src/guestfs.pod:375
840 msgid "The command will be running in limited memory."
844 #: ../src/guestfs.pod:379
846 "The network may not be available unless you enable it (see L</"
847 "guestfs_set_network>)."
851 #: ../src/guestfs.pod:384
852 msgid "Only supports Linux guests (not Windows, BSD, etc)."
856 #: ../src/guestfs.pod:388
858 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
862 #: ../src/guestfs.pod:393
864 "For SELinux guests, you may need to enable SELinux and load policy first. "
865 "See L</SELINUX> in this manpage."
869 #: ../src/guestfs.pod:398
871 "I<Security:> It is not safe to run commands from untrusted, possibly "
872 "malicious guests. These commands may attempt to exploit your program by "
873 "sending unexpected output. They could also try to exploit the Linux kernel "
874 "or qemu provided by the libguestfs appliance. They could use the network "
875 "provided by the libguestfs appliance to bypass ordinary network partitions "
876 "and firewalls. They could use the elevated privileges or different SELinux "
877 "context of your program to their advantage."
881 #: ../src/guestfs.pod:407
883 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
884 "(a script which runs when the guest next boots normally), and to have this "
885 "script run the commands you want in the normal context of the running guest, "
886 "network security and so on. For information about other security issues, "
891 #: ../src/guestfs.pod:415
893 "The two main API calls to run commands are L</guestfs_command> and L</"
894 "guestfs_sh> (there are also variations)."
898 #: ../src/guestfs.pod:418
900 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
901 "shell globs, redirections, etc will work."
905 #: ../src/guestfs.pod:421
906 msgid "CONFIGURATION FILES"
910 #: ../src/guestfs.pod:423
912 "To read and write configuration files in Linux guest filesystems, we "
913 "strongly recommend using Augeas. For example, Augeas understands how to "
914 "read and write, say, a Linux shadow password file or X.org configuration "
915 "file, and so avoids you having to write that code."
919 #: ../src/guestfs.pod:428
921 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
922 "document Augeas itself here because there is excellent documentation on the "
923 "L<http://augeas.net/> website."
927 #: ../src/guestfs.pod:432
929 "If you don't want to use Augeas (you fool!) then try calling L</"
930 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
935 #: ../src/guestfs.pod:436
940 #: ../src/guestfs.pod:438
942 "We support SELinux guests. To ensure that labeling happens correctly in "
943 "SELinux guests, you need to enable SELinux and load the guest's policy:"
947 #: ../src/guestfs.pod:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279
952 #: ../src/guestfs.pod:446
953 msgid "Before launching, do:"
957 #: ../src/guestfs.pod:448
960 " guestfs_set_selinux (g, 1);\n"
965 #: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283
970 #: ../src/guestfs.pod:452
972 "After mounting the guest's filesystem(s), load the policy. This is best "
973 "done by running the L<load_policy(8)> command in the guest itself:"
977 #: ../src/guestfs.pod:456
980 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
985 #: ../src/guestfs.pod:458
987 "(Older versions of C<load_policy> require you to specify the name of the "
992 #: ../src/guestfs.pod:461 ../src/guestfs.pod:1289
997 #: ../src/guestfs.pod:463
999 "Optionally, set the security context for the API. The correct security "
1000 "context to use can only be known by inspecting the guest. As an example:"
1004 #: ../src/guestfs.pod:467
1007 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
1012 #: ../src/guestfs.pod:471
1013 msgid "This will work for running commands and editing existing files."
1017 #: ../src/guestfs.pod:473
1019 "When new files are created, you may need to label them explicitly, for "
1020 "example by running the external command C<restorecon pathname>."
1024 #: ../src/guestfs.pod:477
1029 #: ../src/guestfs.pod:479
1031 "Certain calls are affected by the current file mode creation mask (the "
1032 "\"umask\"). In particular ones which create files or directories, such as "
1033 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
1034 "either the default mode that the file is created with or modifies the mode "
1039 #: ../src/guestfs.pod:485
1041 "The default umask is C<022>, so files are created with modes such as C<0644> "
1042 "and directories with C<0755>."
1046 #: ../src/guestfs.pod:488
1048 "There are two ways to avoid being affected by umask. Either set umask to 0 "
1049 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
1050 "guestfs_chmod> after creating each file or directory."
1054 #: ../src/guestfs.pod:492
1055 msgid "For more information about umask, see L<umask(2)>."
1059 #: ../src/guestfs.pod:494 ../fish/guestfish.pod:670
1060 msgid "ENCRYPTED DISKS"
1064 #: ../src/guestfs.pod:496
1066 "Libguestfs allows you to access Linux guests which have been encrypted using "
1067 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1068 "standard. This includes nearly all whole disk encryption systems used by "
1069 "modern Linux guests."
1073 #: ../src/guestfs.pod:502
1075 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1076 "returns the string C<crypto_LUKS>)."
1080 #: ../src/guestfs.pod:505
1082 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1083 "will require the passphrase!"
1087 #: ../src/guestfs.pod:508
1089 "Opening a LUKS device creates a new device mapper device called C</dev/"
1090 "mapper/mapname> (where C<mapname> is the string you supply to L</"
1091 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
1092 "from and encrypted to the underlying block device respectively."
1096 #: ../src/guestfs.pod:514
1098 "LVM volume groups on the device can be made visible by calling L</"
1099 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
1100 "(s) can now be mounted in the usual way."
1104 #: ../src/guestfs.pod:518
1106 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1107 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1108 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
1109 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1110 "underlying encrypted block device)."
1114 #: ../src/guestfs.pod:525
1119 #: ../src/guestfs.pod:527
1121 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1122 "contains operating systems. (These APIs used to be in a separate Perl-only "
1123 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1124 "frequently used part of this library has been rewritten in C and moved into "
1129 #: ../src/guestfs.pod:533
1131 "Add all disks belonging to the unknown virtual machine and call L</"
1132 "guestfs_launch> in the usual way."
1136 #: ../src/guestfs.pod:536
1138 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1139 "and certain heuristics, and returns a list of operating systems that were "
1140 "found. An empty list means none were found. A single element is the root "
1141 "filesystem of the operating system. For dual- or multi-boot guests, "
1142 "multiple roots can be returned, each one corresponding to a separate "
1143 "operating system. (Multi-boot virtual machines are extremely rare in the "
1144 "world of virtualization, but since this scenario can happen, we have built "
1145 "libguestfs to deal with it.)"
1149 #: ../src/guestfs.pod:545
1151 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1152 "to get additional details about that operating system. For example, call L</"
1153 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1154 "Windows and Linux-based operating systems respectively."
1158 #: ../src/guestfs.pod:551
1160 "Un*x-like and Linux-based operating systems usually consist of several "
1161 "filesystems which are mounted at boot time (for example, a separate boot "
1162 "partition mounted on C</boot>). The inspection rules are able to detect how "
1163 "filesystems correspond to mount points. Call "
1164 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1165 "hash table like this example:"
1169 #: ../src/guestfs.pod:558
1172 " /boot => /dev/sda1\n"
1173 " / => /dev/vg_guest/lv_root\n"
1174 " /usr => /dev/vg_guest/lv_usr\n"
1179 #: ../src/guestfs.pod:562
1181 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1182 "filesystems as suggested."
1186 #: ../src/guestfs.pod:565
1188 "Be careful to mount filesystems in the right order (eg. C</> before C</"
1189 "usr>). Sorting the keys of the hash by length, shortest first, should work."
1193 #: ../src/guestfs.pod:569
1195 "Inspection currently only works for some common operating systems. "
1196 "Contributors are welcome to send patches for other operating systems that we "
1197 "currently cannot detect."
1201 #: ../src/guestfs.pod:573
1203 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1204 "for more details. The L</guestfs_inspect_os> function just ignores any "
1205 "encrypted devices."
1209 #: ../src/guestfs.pod:577
1211 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1212 "inspection and caches the results in the guest handle. Subsequent calls to "
1213 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
1214 "read the disks. If you change the content of the guest disks, you can redo "
1215 "inspection by calling L</guestfs_inspect_os> again. (L</"
1216 "guestfs_inspect_list_applications> works a little differently from the other "
1217 "calls and does read the disks. See documentation for that function for "
1222 #: ../src/guestfs.pod:586
1223 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1227 #: ../src/guestfs.pod:588
1229 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
1230 "ntfs-3g.org/> driver."
1234 #: ../src/guestfs.pod:591
1236 "DOS and Windows still use drive letters, and the filesystems are always "
1237 "treated as case insensitive by Windows itself, and therefore you might find "
1238 "a Windows configuration file referring to a path like C<c:\\windows"
1239 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
1240 "might be referred to as C</WINDOWS/System32>."
1244 #: ../src/guestfs.pod:597
1246 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1247 "libguestfs to read the appropriate Windows Registry and configuration files, "
1248 "to determine yourself how drives are mapped (see also L<hivex(3)> and L<virt-"
1253 #: ../src/guestfs.pod:602
1255 "Replacing backslash characters with forward slash characters is also outside "
1256 "the scope of libguestfs, but something that you can easily do."
1260 #: ../src/guestfs.pod:605
1262 "Where we can help is in resolving the case insensitivity of paths. For "
1263 "this, call L</guestfs_case_sensitive_path>."
1267 #: ../src/guestfs.pod:608
1269 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1270 "files, through the library C<hivex> which is part of the libguestfs project "
1271 "although ships as a separate tarball. You have to locate and download the "
1272 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1273 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
1274 "reg(1)> for more help on this issue."
1278 #: ../src/guestfs.pod:616
1279 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1283 #: ../src/guestfs.pod:618
1285 "Although we don't want to discourage you from using the C API, we will "
1286 "mention here that the same API is also available in other languages."
1290 #: ../src/guestfs.pod:621
1292 "The API is broadly identical in all supported languages. This means that "
1293 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, C<g."
1294 "mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1295 "words, a straightforward, predictable isomorphism between each language."
1299 #: ../src/guestfs.pod:627
1301 "Error messages are automatically transformed into exceptions if the language "
1306 #: ../src/guestfs.pod:630
1308 "We don't try to \"object orientify\" parts of the API in OO languages, "
1309 "although contributors are welcome to write higher level APIs above what we "
1310 "provide in their favourite languages if they wish."
1314 #: ../src/guestfs.pod:636
1319 #: ../src/guestfs.pod:638
1321 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1322 "identical to the C API. C++ classes and exceptions are not used."
1326 #: ../src/guestfs.pod:642
1331 #: ../src/guestfs.pod:644
1333 "The C# bindings are highly experimental. Please read the warnings at the "
1334 "top of C<csharp/Libguestfs.cs>."
1338 #: ../src/guestfs.pod:647
1343 #: ../src/guestfs.pod:649
1345 "This is the only language binding that is working but incomplete. Only "
1346 "calls which return simple integers have been bound in Haskell, and we are "
1347 "looking for help to complete this binding."
1351 #: ../src/guestfs.pod:653
1356 #: ../src/guestfs.pod:655
1358 "Full documentation is contained in the Javadoc which is distributed with "
1363 #: ../src/guestfs.pod:658
1368 #: ../src/guestfs.pod:660
1369 msgid "For documentation see L<guestfs-ocaml(3)>."
1373 #: ../src/guestfs.pod:662
1378 #: ../src/guestfs.pod:664
1379 msgid "For documentation see L<Sys::Guestfs(3)>."
1383 #: ../src/guestfs.pod:666
1388 #: ../src/guestfs.pod:668
1390 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1391 "the php-libguestfs package for your distribution."
1395 #: ../src/guestfs.pod:671
1396 msgid "The PHP binding only works correctly on 64 bit machines."
1400 #: ../src/guestfs.pod:673
1405 #: ../src/guestfs.pod:675
1406 msgid "For documentation see L<guestfs-python(3)>."
1410 #: ../src/guestfs.pod:677
1415 #: ../src/guestfs.pod:679
1416 msgid "For documentation see L<guestfs-ruby(3)>."
1420 #: ../src/guestfs.pod:681
1421 msgid "B<shell scripts>"
1425 #: ../src/guestfs.pod:683
1426 msgid "For documentation see L<guestfish(1)>."
1430 #: ../src/guestfs.pod:687
1431 msgid "LIBGUESTFS GOTCHAS"
1435 #: ../src/guestfs.pod:689
1437 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1438 "system [...] that works in the way it is documented but is counterintuitive "
1439 "and almost invites mistakes.\""
1443 #: ../src/guestfs.pod:693
1445 "Since we developed libguestfs and the associated tools, there are several "
1446 "things we would have designed differently, but are now stuck with for "
1447 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1448 "release, you can expect these to change. Beware of them."
1452 #: ../src/guestfs.pod:701
1453 msgid "Autosync / forgetting to sync."
1457 #: ../src/guestfs.pod:703
1459 "When modifying a filesystem from C or another language, you B<must> unmount "
1460 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1461 "libguestfs handle. You can also call:"
1465 #: ../src/guestfs.pod:707
1468 " guestfs_set_autosync (g, 1);\n"
1473 #: ../src/guestfs.pod:709
1475 "to have the unmount/sync done automatically for you when the handle 'g' is "
1476 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
1480 #: ../src/guestfs.pod:713
1482 "If you forget to do this, then it is entirely possible that your changes "
1483 "won't be written out, or will be partially written, or (very rarely) that "
1484 "you'll get disk corruption."
1488 #: ../src/guestfs.pod:717
1490 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1491 "guestfish scripts that forget to sync will work just fine, which can make "
1492 "this very puzzling if you are trying to debug a problem."
1496 #: ../src/guestfs.pod:721
1498 "Update: Autosync is enabled by default for all API users starting from "
1499 "libguestfs 1.5.24."
1503 #: ../src/guestfs.pod:724
1504 msgid "Mount option C<-o sync> should not be the default."
1508 #: ../src/guestfs.pod:726
1510 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1511 "However C<-o sync> does not add any reliability benefit, but does have a "
1512 "very large performance impact."
1516 #: ../src/guestfs.pod:730
1518 "The work around is to use L</guestfs_mount_options> and set the mount "
1519 "options that you actually want to use."
1523 #: ../src/guestfs.pod:733
1524 msgid "Read-only should be the default."
1528 #: ../src/guestfs.pod:735
1530 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1531 "specify I<--rw> if you want to make changes to the image."
1535 #: ../src/guestfs.pod:738
1536 msgid "This would reduce the potential to corrupt live VM images."
1540 #: ../src/guestfs.pod:740
1542 "Note that many filesystems change the disk when you just mount and unmount, "
1543 "even if you didn't perform any writes. You need to use L</"
1544 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
1548 #: ../src/guestfs.pod:744
1549 msgid "guestfish command line is hard to use."
1553 #: ../src/guestfs.pod:746
1555 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1556 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1557 "exist, so it fails. In earlier versions of guestfish the error message was "
1558 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1559 "we should have used C<guestfish -c command> to run commands."
1563 #: ../src/guestfs.pod:753
1564 msgid "guestfish megabyte modifiers don't work right on all commands"
1568 #: ../src/guestfs.pod:755
1570 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1571 "other modifiers). What guestfish actually does is to multiply the number "
1572 "part by the modifier part and pass the result to the C API. However this "
1573 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1574 "expecting some other unit (eg. megabytes)."
1578 #: ../src/guestfs.pod:762
1579 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1583 #: ../src/guestfs.pod:764
1586 " lvcreate LV VG 100M\n"
1591 #: ../src/guestfs.pod:766
1593 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1594 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1595 "megabytes * megabytes) logical volume. The error message you get from this "
1596 "is also a little obscure."
1600 #: ../src/guestfs.pod:771
1602 "This could be fixed in the generator by specially marking parameters and "
1603 "return values which take bytes or other units."
1607 #: ../src/guestfs.pod:774
1608 msgid "Ambiguity between devices and paths"
1612 #: ../src/guestfs.pod:776
1614 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
1615 "sdb2>) and a similar pathname. A file might just happen to be called "
1616 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1620 #: ../src/guestfs.pod:781
1622 "In the current API we usually resolve this ambiguity by having two separate "
1623 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1624 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1625 "detecting if the path supplied begins with C</dev/>."
1629 #: ../src/guestfs.pod:787
1631 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1632 "make paths/devices into structured names. One way to do this would be to "
1633 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1634 "aspect of grub. Another way would be to use a structured type, equivalent "
1635 "to this OCaml type:"
1639 #: ../src/guestfs.pod:793
1642 " type path = Path of string | Device of int | Partition of int * int\n"
1647 #: ../src/guestfs.pod:795
1648 msgid "which would allow you to pass arguments like:"
1652 #: ../src/guestfs.pod:797
1655 " Path \"/foo/bar\"\n"
1656 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1657 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1658 " Path \"/dev/sdb2\" (* not a device *)\n"
1663 #: ../src/guestfs.pod:802
1665 "As you can see there are still problems to resolve even with this "
1666 "representation. Also consider how it might work in guestfish."
1670 #: ../src/guestfs.pod:807
1671 msgid "PROTOCOL LIMITS"
1675 #: ../src/guestfs.pod:809
1677 "Internally libguestfs uses a message-based protocol to pass API calls and "
1678 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1679 "plenty more detail about this). The maximum message size used by the "
1680 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1681 "aware of this limit. The API calls which may be affected are individually "
1682 "documented, with a link back to this section of the documentation."
1686 #: ../src/guestfs.pod:817
1688 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1689 "a simple string. Because this string is at some point internally encoded as "
1690 "a message, the maximum size that it can return is slightly under 4 MB. If "
1691 "the requested file is larger than this then you will get an error."
1695 #: ../src/guestfs.pod:823
1697 "In order to transfer large files into and out of the guest filesystem, you "
1698 "need to use particular calls that support this. The sections L</UPLOADING> "
1699 "and L</DOWNLOADING> document how to do this."
1703 #: ../src/guestfs.pod:827
1705 "You might also consider mounting the disk image using our FUSE filesystem "
1706 "support (L<guestmount(1)>)."
1710 #: ../src/guestfs.pod:830
1711 msgid "KEYS AND PASSPHRASES"
1715 #: ../src/guestfs.pod:832
1717 "Certain libguestfs calls take a parameter that contains sensitive key "
1718 "material, passed in as a C string."
1722 #: ../src/guestfs.pod:835
1724 "In the future we would hope to change the libguestfs implementation so that "
1725 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1726 "swap. However this is I<not> done at the moment, because of the complexity "
1727 "of such an implementation."
1731 #: ../src/guestfs.pod:840
1733 "Therefore you should be aware that any key parameter you pass to libguestfs "
1734 "might end up being written out to the swap partition. If this is a concern, "
1735 "scrub the swap partition or don't use libguestfs on encrypted devices."
1739 #: ../src/guestfs.pod:845
1740 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1744 #: ../src/guestfs.pod:847
1746 "All high-level libguestfs actions are synchronous. If you want to use "
1747 "libguestfs asynchronously then you must create a thread."
1751 #: ../src/guestfs.pod:850
1753 "Only use the handle from a single thread. Either use the handle exclusively "
1754 "from one thread, or provide your own mutex so that two threads cannot issue "
1755 "calls on the same handle at the same time."
1759 #: ../src/guestfs.pod:854
1761 "See the graphical program guestfs-browser for one possible architecture for "
1762 "multithreaded programs using libvirt and libguestfs."
1766 #: ../src/guestfs.pod:857
1771 #: ../src/guestfs.pod:859
1773 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1778 #: ../src/guestfs.pod:862
1780 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
1781 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1785 #: ../src/guestfs.pod:865
1787 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1788 "to change the directories that libguestfs will search in. The value is a "
1789 "colon-separated list of paths. The current directory is I<not> searched "
1790 "unless the path contains an empty element or C<.>. For example "
1791 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1792 "then C</usr/lib/guestfs>."
1796 #: ../src/guestfs.pod:872
1797 msgid "QEMU WRAPPERS"
1801 #: ../src/guestfs.pod:874
1803 "If you want to compile your own qemu, run qemu from a non-standard location, "
1804 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1809 #: ../src/guestfs.pod:878
1811 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1812 "last command in the shell script (so that qemu replaces the shell and "
1813 "becomes the direct child of the libguestfs-using program). If you don't do "
1814 "this, then the qemu process won't be cleaned up correctly."
1818 #: ../src/guestfs.pod:883
1820 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1825 #: ../src/guestfs.pod:886
1829 " qemudir=/home/rjones/d/qemu\n"
1830 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
1835 #: ../src/guestfs.pod:890
1837 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1838 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1843 #: ../src/guestfs.pod:894
1846 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1851 #: ../src/guestfs.pod:896
1853 "Note that libguestfs also calls qemu with the -help and -version options in "
1854 "order to determine features."
1858 #: ../src/guestfs.pod:899
1859 msgid "ABI GUARANTEE"
1863 #: ../src/guestfs.pod:901
1865 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1866 "actions as outlined in this section. Although we will deprecate some "
1867 "actions, for example if they get replaced by newer calls, we will keep the "
1868 "old actions forever. This allows you the developer to program in confidence "
1869 "against the libguestfs API."
1873 #: ../src/guestfs.pod:907
1874 msgid "BLOCK DEVICE NAMING"
1878 #: ../src/guestfs.pod:909
1880 "In the kernel there is now quite a profusion of schemata for naming block "
1881 "devices (in this context, by I<block device> I mean a physical or virtual "
1882 "hard drive). The original Linux IDE driver used names starting with C</dev/"
1883 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
1884 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
1885 "for the old IDE driver (particularly for SATA devices) those devices also "
1886 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
1887 "paravirtualized drivers. This has created several different naming systems, "
1888 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
1892 #: ../src/guestfs.pod:921
1894 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1895 "Linux kernel to access block devices. We can run a variety of appliances "
1896 "based on a variety of Linux kernels."
1900 #: ../src/guestfs.pod:925
1902 "This causes a problem for libguestfs because many API calls use device or "
1903 "partition names. Working scripts and the recipe (example) scripts that we "
1904 "make available over the internet could fail if the naming scheme changes."
1908 #: ../src/guestfs.pod:930
1910 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1911 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1912 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1913 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1917 #: ../src/guestfs.pod:936
1919 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1920 "L</guestfs_list_partitions> and similar calls return the true names of the "
1921 "devices and partitions as known to the appliance."
1925 #: ../src/guestfs.pod:941
1926 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1930 #: ../src/guestfs.pod:943
1932 "Usually this translation is transparent. However in some (very rare) cases "
1933 "you may need to know the exact algorithm. Such cases include where you use "
1934 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
1935 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
1939 #: ../src/guestfs.pod:949
1941 "The algorithm is applied only to I<parameters> which are known to be either "
1942 "device or partition names. Return values from functions such as L</"
1943 "guestfs_list_devices> are never changed."
1947 #: ../src/guestfs.pod:957
1948 msgid "Is the string a parameter which is a device or partition name?"
1952 #: ../src/guestfs.pod:961
1953 msgid "Does the string begin with C</dev/sd>?"
1957 #: ../src/guestfs.pod:965
1959 "Does the named device exist? If so, we use that device. However if I<not> "
1960 "then we continue with this algorithm."
1964 #: ../src/guestfs.pod:970
1965 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1969 #: ../src/guestfs.pod:972
1970 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1974 #: ../src/guestfs.pod:974
1975 msgid "If that named device exists, use it. If not, continue."
1979 #: ../src/guestfs.pod:978
1980 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1984 #: ../src/guestfs.pod:980
1985 msgid "If that named device exists, use it. If not, return an error."
1989 #: ../src/guestfs.pod:984
1990 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1994 #: ../src/guestfs.pod:986
1996 "Although the standard naming scheme and automatic translation is useful for "
1997 "simple programs and guestfish scripts, for larger programs it is best not to "
1998 "rely on this mechanism."
2002 #: ../src/guestfs.pod:990
2004 "Where possible for maximum future portability programs using libguestfs "
2005 "should use these future-proof techniques:"
2009 #: ../src/guestfs.pod:997
2011 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
2012 "device names, and then use those names directly."
2016 #: ../src/guestfs.pod:1000
2018 "Since those device names exist by definition, they will never be translated."
2022 #: ../src/guestfs.pod:1005
2024 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
2025 "filesystem labels."
2029 #: ../src/guestfs.pod:1010
2034 #: ../src/guestfs.pod:1012
2036 "This section discusses security implications of using libguestfs, "
2037 "particularly with untrusted or malicious guests or disk images."
2041 #: ../src/guestfs.pod:1015
2042 msgid "GENERAL SECURITY CONSIDERATIONS"
2046 #: ../src/guestfs.pod:1017
2048 "Be careful with any files or data that you download from a guest (by "
2049 "\"download\" we mean not just the L</guestfs_download> command but any "
2050 "command that reads files, filenames, directories or anything else from a "
2051 "disk image). An attacker could manipulate the data to fool your program "
2052 "into doing the wrong thing. Consider cases such as:"
2056 #: ../src/guestfs.pod:1027
2057 msgid "the data (file etc) not being present"
2061 #: ../src/guestfs.pod:1031
2062 msgid "being present but empty"
2066 #: ../src/guestfs.pod:1035
2067 msgid "being much larger than normal"
2071 #: ../src/guestfs.pod:1039
2072 msgid "containing arbitrary 8 bit data"
2076 #: ../src/guestfs.pod:1043
2077 msgid "being in an unexpected character encoding"
2081 #: ../src/guestfs.pod:1047
2082 msgid "containing homoglyphs."
2086 #: ../src/guestfs.pod:1051
2087 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2091 #: ../src/guestfs.pod:1053
2093 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2094 "(VFS) module can sometimes be escalated into exploits by deliberately "
2095 "creating a malicious, malformed filesystem. These exploits are very severe "
2096 "for two reasons. Firstly there are very many filesystem drivers in the "
2097 "kernel, and many of them are infrequently used and not much developer "
2098 "attention has been paid to the code. Linux userspace helps potential "
2099 "crackers by detecting the filesystem type and automatically choosing the "
2100 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2101 "the administrator. Secondly, a kernel-level exploit is like a local root "
2102 "exploit (worse in some ways), giving immediate and total access to the "
2103 "system right down to the hardware level."
2107 #: ../src/guestfs.pod:1066
2109 "That explains why you should never mount a filesystem from an untrusted "
2110 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2111 "inside a qemu virtual machine, usually running as a non-root user. The "
2112 "attacker would need to write a filesystem which first exploited the kernel, "
2113 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2114 "the libguestfs protocol, and finally to be as serious as the host kernel "
2115 "exploit it would need to escalate its privileges to root. This multi-step "
2116 "escalation, performed by a static piece of data, is thought to be extremely "
2117 "hard to do, although we never say 'never' about security issues."
2121 #: ../src/guestfs.pod:1077
2123 "In any case callers can reduce the attack surface by forcing the filesystem "
2124 "type when mounting (use L</guestfs_mount_vfs>)."
2128 #: ../src/guestfs.pod:1080
2129 msgid "PROTOCOL SECURITY"
2133 #: ../src/guestfs.pod:1082
2135 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2136 "defined upper message size. However a program that uses libguestfs must "
2137 "also take care - for example you can write a program that downloads a binary "
2138 "from a disk image and executes it locally, and no amount of protocol "
2139 "security will save you from the consequences."
2143 #: ../src/guestfs.pod:1088
2144 msgid "INSPECTION SECURITY"
2148 #: ../src/guestfs.pod:1090
2150 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2151 "directly from the guest, and these could contain any 8 bit data. Callers "
2152 "should be careful to escape these before printing them to a structured file "
2153 "(for example, use HTML escaping if creating a web page)."
2157 #: ../src/guestfs.pod:1096
2159 "Guest configuration may be altered in unusual ways by the administrator of "
2160 "the virtual machine, and may not reflect reality (particularly for untrusted "
2161 "or actively malicious guests). For example we parse the hostname from "
2162 "configuration files like C</etc/sysconfig/network> that we find in the "
2163 "guest, but the guest administrator can easily manipulate these files to "
2164 "provide the wrong hostname."
2168 #: ../src/guestfs.pod:1104
2170 "The inspection API parses guest configuration using two external libraries: "
2171 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2172 "designed to be robust in the face of malicious data, although denial of "
2173 "service attacks are still possible, for example with oversized configuration "
2178 #: ../src/guestfs.pod:1110
2179 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2183 #: ../src/guestfs.pod:1112
2185 "Be very cautious about running commands from the guest. By running a "
2186 "command in the guest, you are giving CPU time to a binary that you do not "
2187 "control, under the same user account as the library, albeit wrapped in qemu "
2188 "virtualization. More information and alternatives can be found in the "
2189 "section L</RUNNING COMMANDS>."
2193 #: ../src/guestfs.pod:1118
2194 msgid "CVE-2010-3851"
2198 #: ../src/guestfs.pod:1120
2199 msgid "https://bugzilla.redhat.com/642934"
2203 #: ../src/guestfs.pod:1122
2205 "This security bug concerns the automatic disk format detection that qemu "
2206 "does on disk images."
2210 #: ../src/guestfs.pod:1125
2212 "A raw disk image is just the raw bytes, there is no header. Other disk "
2213 "images like qcow2 contain a special header. Qemu deals with this by looking "
2214 "for one of the known headers, and if none is found then assuming the disk "
2215 "image must be raw."
2219 #: ../src/guestfs.pod:1130
2221 "This allows a guest which has been given a raw disk image to write some "
2222 "other header. At next boot (or when the disk image is accessed by "
2223 "libguestfs) qemu would do autodetection and think the disk image format was, "
2224 "say, qcow2 based on the header written by the guest."
2228 #: ../src/guestfs.pod:1135
2230 "This in itself would not be a problem, but qcow2 offers many features, one "
2231 "of which is to allow a disk image to refer to another image (called the "
2232 "\"backing disk\"). It does this by placing the path to the backing disk "
2233 "into the qcow2 header. This path is not validated and could point to any "
2234 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2235 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2236 "control of the attacker."
2240 #: ../src/guestfs.pod:1143
2242 "In libguestfs this is rather hard to exploit except under two circumstances:"
2246 #: ../src/guestfs.pod:1150
2247 msgid "You have enabled the network or have opened the disk in write mode."
2251 #: ../src/guestfs.pod:1154
2253 "You are also running untrusted code from the guest (see L</RUNNING "
2258 #: ../src/guestfs.pod:1159
2260 "The way to avoid this is to specify the expected disk format when adding "
2261 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2262 "should always do this if the disk is raw format, and it's a good idea for "
2267 #: ../src/guestfs.pod:1164
2269 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2270 "format is fetched from libvirt and passed through."
2274 #: ../src/guestfs.pod:1167
2276 "For libguestfs tools, use the I<--format> command line parameter as "
2281 #: ../src/guestfs.pod:1170
2282 msgid "CONNECTION MANAGEMENT"
2286 #: ../src/guestfs.pod:1172
2291 #: ../src/guestfs.pod:1174
2293 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2294 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2295 "handle and release all resources used."
2299 #: ../src/guestfs.pod:1178
2301 "For information on using multiple handles and threads, see the section L</"
2302 "MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2306 #: ../src/guestfs.pod:1181
2307 msgid "guestfs_create"
2311 #: ../src/guestfs.pod:1183
2314 " guestfs_h *guestfs_create (void);\n"
2319 #: ../src/guestfs.pod:1185
2320 msgid "Create a connection handle."
2324 #: ../src/guestfs.pod:1187
2326 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2327 "on the handle at least once."
2331 #: ../src/guestfs.pod:1190
2333 "This function returns a non-NULL pointer to a handle on success or NULL on "
2338 #: ../src/guestfs.pod:1193
2339 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2343 #: ../src/guestfs.pod:1195
2345 "You may also want to configure error handling for the handle. See L</ERROR "
2346 "HANDLING> section below."
2350 #: ../src/guestfs.pod:1198
2351 msgid "guestfs_close"
2355 #: ../src/guestfs.pod:1200
2358 " void guestfs_close (guestfs_h *g);\n"
2363 #: ../src/guestfs.pod:1202
2364 msgid "This closes the connection handle and frees up all resources used."
2368 #: ../src/guestfs.pod:1204
2369 msgid "ERROR HANDLING"
2373 #: ../src/guestfs.pod:1206
2375 "API functions can return errors. For example, almost all functions that "
2376 "return C<int> will return C<-1> to indicate an error."
2380 #: ../src/guestfs.pod:1209
2382 "Additional information is available for errors: an error message string and "
2383 "optionally an error number (errno) if the thing that failed was a system "
2388 #: ../src/guestfs.pod:1213
2390 "You can get at the additional information about the last error on the handle "
2391 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2392 "up an error handler with L</guestfs_set_error_handler>."
2396 #: ../src/guestfs.pod:1218
2398 "When the handle is created, a default error handler is installed which "
2399 "prints the error message string to C<stderr>. For small short-running "
2400 "command line programs it is sufficient to do:"
2404 #: ../src/guestfs.pod:1222
2407 " if (guestfs_launch (g) == -1)\n"
2408 " exit (EXIT_FAILURE);\n"
2413 #: ../src/guestfs.pod:1225
2415 "since the default error handler will ensure that an error message has been "
2416 "printed to C<stderr> before the program exits."
2420 #: ../src/guestfs.pod:1228
2422 "For other programs the caller will almost certainly want to install an "
2423 "alternate error handler or do error handling in-line like this:"
2427 #: ../src/guestfs.pod:1231
2430 " g = guestfs_create ();\n"
2435 #: ../src/guestfs.pod:1233
2438 " /* This disables the default behaviour of printing errors\n"
2440 " guestfs_set_error_handler (g, NULL, NULL);\n"
2445 #: ../src/guestfs.pod:1237
2448 " if (guestfs_launch (g) == -1) {\n"
2449 " /* Examine the error message and print it etc. */\n"
2450 " char *msg = guestfs_last_error (g);\n"
2451 " int errnum = guestfs_last_errno (g);\n"
2452 " fprintf (stderr, \"%s\\n\", msg);\n"
2459 #: ../src/guestfs.pod:1245
2461 "Out of memory errors are handled differently. The default action is to call "
2462 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
2463 "guestfs_set_out_of_memory_handler>."
2467 #: ../src/guestfs.pod:1249
2469 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2470 "because there is no handle if this happens there is no way to get additional "
2471 "error information. However L</guestfs_create> is supposed to be a "
2472 "lightweight operation which can only fail because of insufficient memory (it "
2473 "returns NULL in this case)."
2477 #: ../src/guestfs.pod:1255
2478 msgid "guestfs_last_error"
2482 #: ../src/guestfs.pod:1257
2485 " const char *guestfs_last_error (guestfs_h *g);\n"
2490 #: ../src/guestfs.pod:1259
2492 "This returns the last error message that happened on C<g>. If there has not "
2493 "been an error since the handle was created, then this returns C<NULL>."
2497 #: ../src/guestfs.pod:1263
2499 "The lifetime of the returned string is until the next error occurs, or L</"
2500 "guestfs_close> is called."
2504 #: ../src/guestfs.pod:1266
2505 msgid "guestfs_last_errno"
2509 #: ../src/guestfs.pod:1268
2512 " int guestfs_last_errno (guestfs_h *g);\n"
2517 #: ../src/guestfs.pod:1270
2518 msgid "This returns the last error number (errno) that happened on C<g>."
2522 #: ../src/guestfs.pod:1272
2523 msgid "If successful, an errno integer not equal to zero is returned."
2527 #: ../src/guestfs.pod:1274
2529 "If no error, this returns 0. This call can return 0 in three situations:"
2533 #: ../src/guestfs.pod:1281
2534 msgid "There has not been any error on the handle."
2538 #: ../src/guestfs.pod:1285
2540 "There has been an error but the errno was meaningless. This corresponds to "
2541 "the case where the error did not come from a failed system call, but for "
2542 "some other reason."
2546 #: ../src/guestfs.pod:1291
2548 "There was an error from a failed system call, but for some reason the errno "
2549 "was not captured and returned. This usually indicates a bug in libguestfs."
2553 #: ../src/guestfs.pod:1297
2555 "Libguestfs tries to convert the errno from inside the applicance into a "
2556 "corresponding errno for the caller (not entirely trivial: the appliance "
2557 "might be running a completely different operating system from the library "
2558 "and error numbers are not standardized across Un*xen). If this could not be "
2559 "done, then the error is translated to C<EINVAL>. In practice this should "
2560 "only happen in very rare circumstances."
2564 #: ../src/guestfs.pod:1305
2565 msgid "guestfs_set_error_handler"
2569 #: ../src/guestfs.pod:1307
2572 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2574 " const char *msg);\n"
2575 " void guestfs_set_error_handler (guestfs_h *g,\n"
2576 " guestfs_error_handler_cb cb,\n"
2582 #: ../src/guestfs.pod:1314
2584 "The callback C<cb> will be called if there is an error. The parameters "
2585 "passed to the callback are an opaque data pointer and the error message "
2590 #: ../src/guestfs.pod:1318
2592 "C<errno> is not passed to the callback. To get that the callback must call "
2593 "L</guestfs_last_errno>."
2597 #: ../src/guestfs.pod:1321
2599 "Note that the message string C<msg> is freed as soon as the callback "
2600 "function returns, so if you want to stash it somewhere you must make your "
2605 #: ../src/guestfs.pod:1325
2606 msgid "The default handler prints messages on C<stderr>."
2610 #: ../src/guestfs.pod:1327
2611 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2615 #: ../src/guestfs.pod:1329
2616 msgid "guestfs_get_error_handler"
2620 #: ../src/guestfs.pod:1331
2623 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2624 " void **opaque_rtn);\n"
2629 #: ../src/guestfs.pod:1334
2630 msgid "Returns the current error handler callback."
2634 #: ../src/guestfs.pod:1336
2635 msgid "guestfs_set_out_of_memory_handler"
2639 #: ../src/guestfs.pod:1338
2642 " typedef void (*guestfs_abort_cb) (void);\n"
2643 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2644 " guestfs_abort_cb);\n"
2649 #: ../src/guestfs.pod:1342
2651 "The callback C<cb> will be called if there is an out of memory situation. "
2652 "I<Note this callback must not return>."
2656 #: ../src/guestfs.pod:1345
2657 msgid "The default is to call L<abort(3)>."
2661 #: ../src/guestfs.pod:1347
2663 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2667 #: ../src/guestfs.pod:1350
2668 msgid "guestfs_get_out_of_memory_handler"
2672 #: ../src/guestfs.pod:1352
2675 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2680 #: ../src/guestfs.pod:1354
2681 msgid "This returns the current out of memory handler."
2685 #: ../src/guestfs.pod:1356
2690 #: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908
2695 #: ../src/guestfs.pod:1360
2700 #: ../src/guestfs.pod:1362
2705 #: ../src/guestfs.pod:1364
2706 msgid "AVAILABILITY"
2710 #: ../src/guestfs.pod:1366
2711 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2715 #: ../src/guestfs.pod:1368
2717 "Using L</guestfs_available> you can test availability of the following "
2718 "groups of functions. This test queries the appliance to see if the "
2719 "appliance you are currently using supports the functionality."
2723 #: ../src/guestfs.pod:1373
2724 msgid "@AVAILABILITY@"
2728 #: ../src/guestfs.pod:1375
2729 msgid "GUESTFISH supported COMMAND"
2733 #: ../src/guestfs.pod:1377
2735 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2736 "prints out the available groups and whether they are supported by this build "
2737 "of libguestfs. Note however that you have to do C<run> first."
2741 #: ../src/guestfs.pod:1382
2742 msgid "SINGLE CALLS AT COMPILE TIME"
2746 #: ../src/guestfs.pod:1384
2748 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2749 "function, such as:"
2753 #: ../src/guestfs.pod:1387
2756 " #define LIBGUESTFS_HAVE_DD 1\n"
2761 #: ../src/guestfs.pod:1389
2762 msgid "if L</guestfs_dd> is available."
2766 #: ../src/guestfs.pod:1391
2768 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2769 "function is available at compile time, we recommended using build tools such "
2770 "as autoconf or cmake. For example in autotools you could use:"
2774 #: ../src/guestfs.pod:1396
2777 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2778 " AC_CHECK_FUNCS([guestfs_dd])\n"
2783 #: ../src/guestfs.pod:1399
2785 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2790 #: ../src/guestfs.pod:1402
2791 msgid "SINGLE CALLS AT RUN TIME"
2795 #: ../src/guestfs.pod:1404
2797 "Testing at compile time doesn't guarantee that a function really exists in "
2798 "the library. The reason is that you might be dynamically linked against a "
2799 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2800 "This situation unfortunately results in a segmentation fault, which is a "
2801 "shortcoming of the C dynamic linking system itself."
2805 #: ../src/guestfs.pod:1411
2807 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2808 "in this example program (note that you still need the compile time check as "
2813 #: ../src/guestfs.pod:1415
2816 " #include <stdio.h>\n"
2817 " #include <stdlib.h>\n"
2818 " #include <unistd.h>\n"
2819 " #include <dlfcn.h>\n"
2820 " #include <guestfs.h>\n"
2825 #: ../src/guestfs.pod:1421
2830 " #ifdef LIBGUESTFS_HAVE_DD\n"
2832 " int has_function;\n"
2837 #: ../src/guestfs.pod:1427
2840 " /* Test if the function guestfs_dd is really available. */\n"
2841 " dl = dlopen (NULL, RTLD_LAZY);\n"
2843 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2844 " exit (EXIT_FAILURE);\n"
2846 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2852 #: ../src/guestfs.pod:1436
2855 " if (!has_function)\n"
2856 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2858 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2859 " /* Now it's safe to call\n"
2860 " guestfs_dd (g, \"foo\", \"bar\");\n"
2864 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2871 #: ../src/guestfs.pod:1449
2873 "You may think the above is an awful lot of hassle, and it is. There are "
2874 "other ways outside of the C linking system to ensure that this kind of "
2875 "incompatibility never arises, such as using package versioning:"
2879 #: ../src/guestfs.pod:1454
2882 " Requires: libguestfs >= 1.0.80\n"
2887 #: ../src/guestfs.pod:1456
2888 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2892 #: ../src/guestfs.pod:1458
2894 "A recent feature of the API is the introduction of calls which take optional "
2895 "arguments. In C these are declared 3 ways. The main way is as a call which "
2896 "takes variable arguments (ie. C<...>), as in this example:"
2900 #: ../src/guestfs.pod:1463
2903 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2908 #: ../src/guestfs.pod:1465
2910 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2911 "call with no optional arguments specified:"
2915 #: ../src/guestfs.pod:1468
2918 " guestfs_add_drive_opts (g, filename, -1);\n"
2923 #: ../src/guestfs.pod:1470
2924 msgid "With a single optional argument:"
2928 #: ../src/guestfs.pod:1472
2931 " guestfs_add_drive_opts (g, filename,\n"
2932 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2938 #: ../src/guestfs.pod:1476
2943 #: ../src/guestfs.pod:1478
2946 " guestfs_add_drive_opts (g, filename,\n"
2947 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2948 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2954 #: ../src/guestfs.pod:1483
2956 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2961 #: ../src/guestfs.pod:1486
2962 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2966 #: ../src/guestfs.pod:1488
2968 "The second variant has the same name with the suffix C<_va>, which works the "
2969 "same way but takes a C<va_list>. See the C manual for details. For the "
2970 "example function, this is declared:"
2974 #: ../src/guestfs.pod:1492
2977 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2983 #: ../src/guestfs.pod:1495
2984 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2988 #: ../src/guestfs.pod:1497
2990 "The third variant is useful where you need to construct these calls. You "
2991 "pass in a structure where you fill in the optional fields. The structure "
2992 "has a bitmask as the first element which you must set to indicate which "
2993 "fields you have filled in. For our example function the structure and call "
2998 #: ../src/guestfs.pod:1503
3001 " struct guestfs_add_drive_opts_argv {\n"
3002 " uint64_t bitmask;\n"
3004 " const char *format;\n"
3007 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
3008 " const struct guestfs_add_drive_opts_argv *optargs);\n"
3013 #: ../src/guestfs.pod:1512
3014 msgid "You could call it like this:"
3018 #: ../src/guestfs.pod:1514
3021 " struct guestfs_add_drive_opts_argv optargs = {\n"
3022 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
3023 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
3025 " .format = \"qcow2\"\n"
3031 #: ../src/guestfs.pod:1521
3034 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
3039 #: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11
3040 #: ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9
3041 #: ../fish/guestfish-actions.pod:1255
3046 #: ../src/guestfs.pod:1529
3047 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
3051 #: ../src/guestfs.pod:1534
3052 msgid "You do not need to fill in all fields of the structure."
3056 #: ../src/guestfs.pod:1538
3058 "There must be a one-to-one correspondence between fields of the structure "
3059 "that are filled in, and bits set in the bitmask."
3063 #: ../src/guestfs.pod:1543
3064 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3068 #: ../src/guestfs.pod:1545
3070 "In other languages, optional arguments are expressed in the way that is "
3071 "natural for that language. We refer you to the language-specific "
3072 "documentation for more details on that."
3076 #: ../src/guestfs.pod:1549
3077 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3081 #: ../src/guestfs.pod:1551
3082 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3086 #: ../src/guestfs.pod:1553
3088 "The child process generates events in some situations. Current events "
3089 "include: receiving a log message, the child process exits."
3093 #: ../src/guestfs.pod:1556
3095 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3100 #: ../src/guestfs.pod:1559
3102 "Only I<one callback of each type> can be registered for each handle. "
3103 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3104 "that type. Cancel all callbacks of this type by calling this function with "
3105 "C<cb> set to C<NULL>."
3109 #: ../src/guestfs.pod:1564
3110 msgid "guestfs_set_log_message_callback"
3114 #: ../src/guestfs.pod:1566
3117 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3118 " char *buf, int len);\n"
3119 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3120 " guestfs_log_message_cb cb,\n"
3126 #: ../src/guestfs.pod:1572
3128 "The callback function C<cb> will be called whenever qemu or the guest writes "
3129 "anything to the console."
3133 #: ../src/guestfs.pod:1575
3134 msgid "Use this function to capture kernel messages and similar."
3138 #: ../src/guestfs.pod:1577
3140 "Normally there is no log message handler, and log messages are just "
3145 #: ../src/guestfs.pod:1580
3146 msgid "guestfs_set_subprocess_quit_callback"
3150 #: ../src/guestfs.pod:1582
3153 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3154 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3155 " guestfs_subprocess_quit_cb cb,\n"
3161 #: ../src/guestfs.pod:1587
3163 "The callback function C<cb> will be called when the child process quits, "
3164 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3165 "corresponds to a transition from any state to the CONFIG state)."
3169 #: ../src/guestfs.pod:1592
3170 msgid "guestfs_set_launch_done_callback"
3174 #: ../src/guestfs.pod:1594
3177 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3178 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3179 " guestfs_launch_done_cb cb,\n"
3185 #: ../src/guestfs.pod:1599
3187 "The callback function C<cb> will be called when the child process becomes "
3188 "ready first time after it has been launched. (This corresponds to a "
3189 "transition from LAUNCHING to the READY state)."
3193 #: ../src/guestfs.pod:1603
3194 msgid "guestfs_set_close_callback"
3198 #: ../src/guestfs.pod:1605
3201 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3202 " void guestfs_set_close_callback (guestfs_h *g,\n"
3203 " guestfs_close_cb cb,\n"
3209 #: ../src/guestfs.pod:1610
3211 "The callback function C<cb> will be called while the handle is being closed "
3212 "(synchronously from L</guestfs_close>)."
3216 #: ../src/guestfs.pod:1613
3218 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3219 "handles that are open when the program exits. This means that this callback "
3220 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3221 "problems in higher-level languages (eg. if your HLL interpreter has already "
3222 "been cleaned up by the time this is called, and if your callback then jumps "
3223 "into some HLL function)."
3227 #: ../src/guestfs.pod:1621
3228 msgid "guestfs_set_progress_callback"
3232 #: ../src/guestfs.pod:1623
3235 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3236 " int proc_nr, int serial,\n"
3237 " uint64_t position, uint64_t total);\n"
3238 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3239 " guestfs_progress_cb cb,\n"
3245 #: ../src/guestfs.pod:1630
3247 "Some long-running operations can generate progress messages. If this "
3248 "callback is registered, then it will be called each time a progress message "
3249 "is generated (usually two seconds after the operation started, and three "
3250 "times per second thereafter until it completes, although the frequency may "
3251 "change in future versions)."
3255 #: ../src/guestfs.pod:1636
3257 "The callback receives two numbers: C<position> and C<total>. The units of "
3258 "C<total> are not defined, although for some operations C<total> may relate "
3259 "in some way to the amount of data to be transferred (eg. in bytes or "
3260 "megabytes), and C<position> may be the portion which has been transferred."
3264 #: ../src/guestfs.pod:1642
3265 msgid "The only defined and stable parts of the API are:"
3269 #: ../src/guestfs.pod:1648
3271 "The callback can display to the user some type of progress bar or indicator "
3272 "which shows the ratio of C<position>:C<total>."
3276 #: ../src/guestfs.pod:1653
3277 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3281 #: ../src/guestfs.pod:1657
3283 "If any progress notification is sent during a call, then a final progress "
3284 "notification is always sent when C<position> = C<total>."
3288 #: ../src/guestfs.pod:1660
3290 "This is to simplify caller code, so callers can easily set the progress "
3291 "indicator to \"100%\" at the end of the operation, without requiring special "
3292 "code to detect this case."
3296 #: ../src/guestfs.pod:1666
3298 "The callback also receives the procedure number and serial number of the "
3299 "call. These are only useful for debugging protocol issues, and the callback "
3300 "can normally ignore them. The callback may want to print these numbers in "
3301 "error messages or debugging messages."
3305 #: ../src/guestfs.pod:1671
3306 msgid "PRIVATE DATA AREA"
3310 #: ../src/guestfs.pod:1673
3312 "You can attach named pieces of private data to the libguestfs handle, and "
3313 "fetch them by name for the lifetime of the handle. This is called the "
3314 "private data area and is only available from the C API."
3318 #: ../src/guestfs.pod:1677
3319 msgid "To attach a named piece of data, use the following call:"
3323 #: ../src/guestfs.pod:1679
3326 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3331 #: ../src/guestfs.pod:1681
3333 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3334 "pointer (which can be C<NULL>). Any previous item with the same name is "
3339 #: ../src/guestfs.pod:1685
3341 "You can use any C<key> you want, but names beginning with an underscore "
3342 "character are reserved for internal libguestfs purposes (for implementing "
3343 "language bindings). It is recommended to prefix the name with some unique "
3344 "string to avoid collisions with other users."
3348 #: ../src/guestfs.pod:1690
3349 msgid "To retrieve the pointer, use:"
3353 #: ../src/guestfs.pod:1692
3356 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3361 #: ../src/guestfs.pod:1694
3363 "This function returns C<NULL> if either no data is found associated with "
3364 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3369 #: ../src/guestfs.pod:1698
3371 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3372 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3373 "all. In particular, libguestfs does I<not> try to free the data when the "
3374 "handle is closed. If the data must be freed, then the caller must either "
3375 "free it before calling L</guestfs_close> or must set up a close callback to "
3376 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3377 "can be registered for a handle)."
3381 #: ../src/guestfs.pod:1706
3383 "The private data area is implemented using a hash table, and should be "
3384 "reasonably efficient for moderate numbers of keys."
3388 #: ../src/guestfs.pod:1709 ../src/guestfs.pod:1714
3393 #: ../src/guestfs.pod:1711
3395 "<!-- old anchor for the next section --> <a name="
3396 "\"state_machine_and_low_level_event_api\"/>"
3400 #: ../src/guestfs.pod:1716
3401 msgid "ARCHITECTURE"
3405 #: ../src/guestfs.pod:1718
3407 "Internally, libguestfs is implemented by running an appliance (a special "
3408 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3409 "process of the main program."
3413 #: ../src/guestfs.pod:1722
3416 " ___________________\n"
3418 " | main program |\n"
3420 " | | child process / appliance\n"
3421 " | | __________________________\n"
3423 " +-------------------+ RPC | +-----------------+ |\n"
3424 " | libguestfs <--------------------> guestfsd | |\n"
3425 " | | | +-----------------+ |\n"
3426 " \\___________________/ | | Linux kernel | |\n"
3427 " | +--^--------------+ |\n"
3428 " \\_________|________________/\n"
3434 " \\______________/\n"
3439 #: ../src/guestfs.pod:1742
3441 "The library, linked to the main program, creates the child process and hence "
3442 "the appliance in the L</guestfs_launch> function."
3446 #: ../src/guestfs.pod:1745
3448 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3449 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3450 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3451 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3452 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3453 "attached to the qemu process which translates device access by the "
3454 "appliance's Linux kernel into accesses to the image."
3458 #: ../src/guestfs.pod:1754
3460 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3461 "Although the disk image you are attached to might also be used by some "
3462 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3463 "care if both libguestfs's qemu process and your virtual machine are trying "
3464 "to update the disk image at the same time, since these usually results in "
3465 "massive disk corruption)."
3469 #: ../src/guestfs.pod:1761
3470 msgid "STATE MACHINE"
3474 #: ../src/guestfs.pod:1763
3475 msgid "libguestfs uses a state machine to model the child process:"
3479 #: ../src/guestfs.pod:1765
3491 " / | \\ \\ guestfs_launch\n"
3492 " / | _\\__V______\n"
3494 " / | | LAUNCHING |\n"
3495 " / | \\___________/\n"
3497 " / | guestfs_launch\n"
3499 " ______ / __|____V\n"
3500 " / \\ ------> / \\\n"
3501 " | BUSY | | READY |\n"
3502 " \\______/ <------ \\________/\n"
3507 #: ../src/guestfs.pod:1787
3509 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3510 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3511 "(3) alternating between READY and BUSY as commands are issued to, and "
3512 "carried out by, the child process."
3516 #: ../src/guestfs.pod:1792
3518 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3519 "asynchronously at any time (eg. due to some internal error), and that causes "
3520 "the state to transition back to CONFIG."
3524 #: ../src/guestfs.pod:1796
3526 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3527 "issued when in the CONFIG state."
3531 #: ../src/guestfs.pod:1799
3533 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3534 "L</guestfs_launch> blocks until the child process is READY to accept "
3535 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3536 "moves the state from CONFIG to LAUNCHING while it is running."
3540 #: ../src/guestfs.pod:1805
3542 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3543 "state. These API calls block waiting for the command to be carried out (ie. "
3544 "the state to transition to BUSY and then back to READY). There are no non-"
3545 "blocking versions, and no way to issue more than one command per handle at "
3550 #: ../src/guestfs.pod:1811
3552 "Finally, the child process sends asynchronous messages back to the main "
3553 "program, such as kernel log messages. You can register a callback to "
3554 "receive these messages."
3558 #: ../src/guestfs.pod:1815
3563 #: ../src/guestfs.pod:1817
3564 msgid "COMMUNICATION PROTOCOL"
3568 #: ../src/guestfs.pod:1819
3570 "Don't rely on using this protocol directly. This section documents how it "
3571 "currently works, but it may change at any time."
3575 #: ../src/guestfs.pod:1822
3577 "The protocol used to talk between the library and the daemon running inside "
3578 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3579 "1014, RFC 1832, RFC 4506)."
3583 #: ../src/guestfs.pod:1826
3585 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3586 "this file is automatically generated)."
3590 #: ../src/guestfs.pod:1829
3592 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3593 "and C<FileOut> parameters, which are handled with very simple request/reply "
3594 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3595 "parameters, which use the same request and reply messages, but they may also "
3596 "be followed by files sent using a chunked encoding."
3600 #: ../src/guestfs.pod:1836
3601 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3605 #: ../src/guestfs.pod:1838
3606 msgid "For ordinary functions, the request message is:"
3610 #: ../src/guestfs.pod:1840
3613 " total length (header + arguments,\n"
3614 " but not including the length word itself)\n"
3615 " struct guestfs_message_header (encoded as XDR)\n"
3616 " struct guestfs_<foo>_args (encoded as XDR)\n"
3621 #: ../src/guestfs.pod:1845
3623 "The total length field allows the daemon to allocate a fixed size buffer "
3624 "into which it slurps the rest of the message. As a result, the total length "
3625 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3626 "effective size of any request is limited to somewhere under this size."
3630 #: ../src/guestfs.pod:1851
3632 "Note also that many functions don't take any arguments, in which case the "
3633 "C<guestfs_I<foo>_args> is completely omitted."
3637 #: ../src/guestfs.pod:1854
3639 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3640 "receiver knows what type of args structure to expect, or none at all."
3644 #: ../src/guestfs.pod:1858
3645 msgid "The reply message for ordinary functions is:"
3649 #: ../src/guestfs.pod:1860
3652 " total length (header + ret,\n"
3653 " but not including the length word itself)\n"
3654 " struct guestfs_message_header (encoded as XDR)\n"
3655 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3660 #: ../src/guestfs.pod:1865
3662 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3663 "functions that return no formal return values."
3667 #: ../src/guestfs.pod:1868
3669 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3673 #: ../src/guestfs.pod:1871
3675 "In the case of an error, a flag is set in the header, and the reply message "
3676 "is slightly changed:"
3680 #: ../src/guestfs.pod:1874
3683 " total length (header + error,\n"
3684 " but not including the length word itself)\n"
3685 " struct guestfs_message_header (encoded as XDR)\n"
3686 " struct guestfs_message_error (encoded as XDR)\n"
3691 #: ../src/guestfs.pod:1879
3693 "The C<guestfs_message_error> structure contains the error message as a "
3698 #: ../src/guestfs.pod:1882
3699 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3703 #: ../src/guestfs.pod:1884
3705 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3706 "The normal request message is sent (see above). However this is followed by "
3707 "a sequence of file chunks."
3711 #: ../src/guestfs.pod:1888
3714 " total length (header + arguments,\n"
3715 " but not including the length word itself,\n"
3716 " and not including the chunks)\n"
3717 " struct guestfs_message_header (encoded as XDR)\n"
3718 " struct guestfs_<foo>_args (encoded as XDR)\n"
3719 " sequence of chunks for FileIn param #0\n"
3720 " sequence of chunks for FileIn param #1 etc.\n"
3725 #: ../src/guestfs.pod:1896
3726 msgid "The \"sequence of chunks\" is:"
3730 #: ../src/guestfs.pod:1898
3733 " length of chunk (not including length word itself)\n"
3734 " struct guestfs_chunk (encoded as XDR)\n"
3735 " length of chunk\n"
3736 " struct guestfs_chunk (encoded as XDR)\n"
3738 " length of chunk\n"
3739 " struct guestfs_chunk (with data.data_len == 0)\n"
3744 #: ../src/guestfs.pod:1906
3746 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3747 "is set in the final chunk to indicate either successful completion or early "
3752 #: ../src/guestfs.pod:1910
3754 "At time of writing there are no functions that have more than one FileIn "
3755 "parameter. However this is (theoretically) supported, by sending the "
3756 "sequence of chunks for each FileIn parameter one after another (from left to "
3761 #: ../src/guestfs.pod:1915
3763 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3764 "transfer. The library does this by sending a chunk with a special flag set "
3765 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3766 "RPC, does I<not> send any reply, and goes back to reading the next request."
3770 #: ../src/guestfs.pod:1921
3772 "The daemon may also cancel. It does this by writing a special word "
3773 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3774 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3775 "cancel chunk). The special word is chosen so that even if cancellation "
3776 "happens right at the end of the transfer (after the library has finished "
3777 "writing and has started listening for the reply), the \"spurious\" cancel "
3778 "flag will not be confused with the reply message."
3782 #: ../src/guestfs.pod:1930
3784 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3785 "limit), and also files where the size is not known in advance (eg. from "
3786 "pipes or sockets). However the chunks are rather small "
3787 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3788 "to keep much in memory."
3792 #: ../src/guestfs.pod:1936
3793 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3797 #: ../src/guestfs.pod:1938
3799 "The protocol for FileOut parameters is exactly the same as for FileIn "
3800 "parameters, but with the roles of daemon and library reversed."
3804 #: ../src/guestfs.pod:1941
3807 " total length (header + ret,\n"
3808 " but not including the length word itself,\n"
3809 " and not including the chunks)\n"
3810 " struct guestfs_message_header (encoded as XDR)\n"
3811 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3812 " sequence of chunks for FileOut param #0\n"
3813 " sequence of chunks for FileOut param #1 etc.\n"
3818 #: ../src/guestfs.pod:1949
3819 msgid "INITIAL MESSAGE"
3823 #: ../src/guestfs.pod:1951
3825 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3826 "which indicates that the guest and daemon is alive. This is what L</"
3827 "guestfs_launch> waits for."
3831 #: ../src/guestfs.pod:1955
3832 msgid "PROGRESS NOTIFICATION MESSAGES"
3836 #: ../src/guestfs.pod:1957
3838 "The daemon may send progress notification messages at any time. These are "
3839 "distinguished by the normal length word being replaced by "
3840 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3844 #: ../src/guestfs.pod:1961
3846 "The library turns them into progress callbacks (see "
3847 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3848 "discards them if not."
3852 #: ../src/guestfs.pod:1965
3854 "The daemon self-limits the frequency of progress messages it sends (see "
3855 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3860 #: ../src/guestfs.pod:1969
3861 msgid "LIBGUESTFS VERSION NUMBERS"
3865 #: ../src/guestfs.pod:1971
3867 "Since April 2010, libguestfs has started to make separate development and "
3868 "stable releases, along with corresponding branches in our git repository. "
3869 "These separate releases can be identified by version number:"
3873 #: ../src/guestfs.pod:1976
3876 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3877 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3883 " | `-------- sub-version\n"
3885 " `------ always '1' because we don't change the ABI\n"
3890 #: ../src/guestfs.pod:1987
3891 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3895 #: ../src/guestfs.pod:1989
3897 "As time passes we cherry pick fixes from the development branch and backport "
3898 "those into the stable branch, the effect being that the stable branch should "
3899 "get more stable and less buggy over time. So the stable releases are ideal "
3900 "for people who don't need new features but would just like the software to "
3905 #: ../src/guestfs.pod:1995
3906 msgid "Our criteria for backporting changes are:"
3910 #: ../src/guestfs.pod:2001
3912 "Documentation changes which don't affect any code are backported unless the "
3913 "documentation refers to a future feature which is not in stable."
3917 #: ../src/guestfs.pod:2007
3919 "Bug fixes which are not controversial, fix obvious problems, and have been "
3920 "well tested are backported."
3924 #: ../src/guestfs.pod:2012
3926 "Simple rearrangements of code which shouldn't affect how it works get "
3927 "backported. This is so that the code in the two branches doesn't get too "
3928 "far out of step, allowing us to backport future fixes more easily."
3932 #: ../src/guestfs.pod:2018
3934 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3935 "exceptional case: the new feature is required in order to implement an "
3936 "important bug fix."
3940 #: ../src/guestfs.pod:2024
3942 "A new stable branch starts when we think the new features in development are "
3943 "substantial and compelling enough over the current stable branch to warrant "
3944 "it. When that happens we create new stable and development versions 1.N.0 "
3945 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3946 "stable at this point, but by backporting fixes from development, that branch "
3947 "will stabilize over time."
3951 #: ../src/guestfs.pod:2032 ../fish/guestfish.pod:915
3952 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3953 msgid "ENVIRONMENT VARIABLES"
3957 #: ../src/guestfs.pod:2036 ../fish/guestfish.pod:941
3958 msgid "LIBGUESTFS_APPEND"
3962 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:943
3963 msgid "Pass additional options to the guest kernel."
3967 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:945
3968 msgid "LIBGUESTFS_DEBUG"
3972 #: ../src/guestfs.pod:2042
3974 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3975 "effect as calling C<guestfs_set_verbose (g, 1)>."
3979 #: ../src/guestfs.pod:2045 ../fish/guestfish.pod:950
3980 msgid "LIBGUESTFS_MEMSIZE"
3984 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:952
3986 "Set the memory allocated to the qemu process, in megabytes. For example:"
3990 #: ../src/guestfs.pod:2050 ../fish/guestfish.pod:955
3993 " LIBGUESTFS_MEMSIZE=700\n"
3998 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:957
3999 msgid "LIBGUESTFS_PATH"
4003 #: ../src/guestfs.pod:2054
4005 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4006 "the discussion of paths in section PATH above."
4010 #: ../src/guestfs.pod:2057 ../fish/guestfish.pod:962
4011 msgid "LIBGUESTFS_QEMU"
4015 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:964
4017 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4018 "which was found at compile time by the configure script is used."
4022 #: ../src/guestfs.pod:2063
4023 msgid "See also L</QEMU WRAPPERS> above."
4027 #: ../src/guestfs.pod:2065 ../fish/guestfish.pod:968
4028 msgid "LIBGUESTFS_TRACE"
4032 #: ../src/guestfs.pod:2067
4034 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4035 "effect as calling C<guestfs_set_trace (g, 1)>."
4039 #: ../src/guestfs.pod:2070 ../fish/guestfish.pod:977
4044 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:979
4045 msgid "Location of temporary directory, defaults to C</tmp>."
4049 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:981
4051 "If libguestfs was compiled to use the supermin appliance then the real "
4052 "appliance is cached in this directory, shared between all handles belonging "
4053 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4054 "use in case C</tmp> is not large enough."
4058 #: ../src/guestfs.pod:2082 ../fish/guestfish.pod:1039
4059 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
4060 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484
4061 #: ../tools/virt-resize.pl:1485 ../tools/virt-list-filesystems.pl:189
4062 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
4063 #: ../tools/virt-list-partitions.pl:257
4068 #: ../src/guestfs.pod:2084
4070 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
4071 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
4072 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
4073 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
4074 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4075 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4079 #: ../src/guestfs.pod:2107
4081 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
4082 "(8)>, L<disktype(1)>."
4086 #: ../src/guestfs.pod:2114 ../tools/virt-win-reg.pl:499
4087 #: ../tools/virt-make-fs.pl:548
4092 #: ../src/guestfs.pod:2116
4093 msgid "To get a list of bugs against libguestfs use this link:"
4097 #: ../src/guestfs.pod:2118
4099 "L<https://bugzilla.redhat.com/buglist.cgi?"
4100 "component=libguestfs&product=Virtualization+Tools>"
4104 #: ../src/guestfs.pod:2120
4105 msgid "To report a new bug against libguestfs use this link:"
4109 #: ../src/guestfs.pod:2122
4111 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
4112 "component=libguestfs&product=Virtualization+Tools>"
4116 #: ../src/guestfs.pod:2124
4117 msgid "When reporting a bug, please check:"
4121 #: ../src/guestfs.pod:2130
4122 msgid "That the bug hasn't been reported already."
4126 #: ../src/guestfs.pod:2134
4127 msgid "That you are testing a recent version."
4131 #: ../src/guestfs.pod:2138
4132 msgid "Describe the bug accurately, and give a way to reproduce it."
4136 #: ../src/guestfs.pod:2142
4138 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4143 #: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1058
4144 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4149 #: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1060
4150 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4151 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4155 #: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1062
4156 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
4157 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514
4158 #: ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:206
4159 #: ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563
4160 #: ../tools/virt-list-partitions.pl:273
4165 #: ../src/guestfs.pod:2153 ../fish/guestfish.pod:1064
4166 #: ../fuse/guestmount.pod:250
4167 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4171 #: ../src/guestfs.pod:2156
4173 "This library is free software; you can redistribute it and/or modify it "
4174 "under the terms of the GNU Lesser General Public License as published by the "
4175 "Free Software Foundation; either version 2 of the License, or (at your "
4176 "option) any later version."
4180 #: ../src/guestfs.pod:2161
4182 "This library is distributed in the hope that it will be useful, but WITHOUT "
4183 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4184 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4189 #: ../src/guestfs.pod:2166
4191 "You should have received a copy of the GNU Lesser General Public License "
4192 "along with this library; if not, write to the Free Software Foundation, "
4193 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4197 #: ../src/guestfs-actions.pod:1
4198 msgid "guestfs_add_cdrom"
4202 #: ../src/guestfs-actions.pod:3
4206 " guestfs_add_cdrom (guestfs_h *g,\n"
4207 " const char *filename);\n"
4212 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4213 msgid "This function adds a virtual CD-ROM disk image to the guest."
4217 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4218 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4222 #: ../src/guestfs-actions.pod:17
4224 "This call checks for the existence of C<filename>. This stops you from "
4225 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4226 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4231 #: ../src/guestfs-actions.pod:24
4233 "If you just want to add an ISO file (often you use this as an efficient way "
4234 "to transfer large files into the guest), then you should probably use "
4235 "C<guestfs_add_drive_ro> instead."
4239 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126
4240 #: ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224
4241 #: ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259
4242 #: ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293
4243 #: ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428
4244 #: ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487
4245 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533
4246 #: ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633
4247 #: ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662
4248 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
4249 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
4250 #: ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988
4251 #: ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090
4252 #: ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127
4253 #: ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161
4254 #: ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262
4255 #: ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324
4256 #: ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464
4257 #: ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704
4258 #: ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213
4259 #: ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418
4260 #: ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182
4261 #: ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217
4262 #: ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356
4263 #: ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383
4264 #: ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434
4265 #: ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526
4266 #: ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566
4267 #: ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621
4268 #: ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659
4269 #: ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706
4270 #: ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758
4271 #: ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786
4272 #: ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896
4273 #: ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929
4274 #: ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998
4275 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032
4276 #: ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060
4277 #: ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092
4278 #: ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161
4279 #: ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211
4280 #: ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242
4281 #: ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272
4282 #: ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302
4283 #: ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352
4284 #: ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386
4285 #: ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452
4286 #: ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503
4287 #: ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548
4288 #: ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700
4289 #: ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779
4290 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829
4291 #: ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912
4292 #: ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939
4293 #: ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247
4294 #: ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273
4295 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299
4296 #: ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329
4297 #: ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369
4298 #: ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406
4299 #: ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447
4300 #: ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487
4301 #: ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523
4302 #: ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575
4303 #: ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618
4304 #: ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648
4305 #: ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704
4306 #: ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753
4307 #: ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982
4308 #: ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007
4309 #: ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042
4310 #: ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068
4311 #: ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096
4312 #: ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172
4313 #: ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204
4314 #: ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234
4315 #: ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290
4316 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345
4317 #: ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376
4318 #: ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436
4319 #: ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573
4320 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642
4321 #: ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700
4322 #: ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787
4323 #: ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879
4324 #: ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4325 msgid "This function returns 0 on success or -1 on error."
4329 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240
4330 #: ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28
4331 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4333 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4338 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243
4339 #: ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435
4340 #: ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942
4341 #: ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990
4342 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4343 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4344 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4345 #: ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4347 "Deprecated functions will not be removed from the API, but the fact that "
4348 "they are deprecated indicates that there are problems with correct use of "
4353 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128
4354 #: ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893
4355 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094
4356 #: ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199
4357 #: ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408
4358 #: ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635
4359 #: ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223
4360 #: ../src/guestfs-actions.pod:6735
4361 msgid "(Added in 0.3)"
4365 #: ../src/guestfs-actions.pod:41
4366 msgid "guestfs_add_domain"
4370 #: ../src/guestfs-actions.pod:43
4374 " guestfs_add_domain (guestfs_h *g,\n"
4375 " const char *dom,\n"
4381 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4383 "You may supply a list of optional arguments to this call. Use zero or more "
4384 "of the following pairs of parameters, and terminate the list with C<-1> on "
4385 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4389 #: ../src/guestfs-actions.pod:53
4392 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4393 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4394 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4399 #: ../src/guestfs-actions.pod:57
4401 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4402 "It works by connecting to libvirt, requesting the domain and domain XML from "
4403 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4408 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4410 "The number of disks added is returned. This operation is atomic: if an "
4411 "error is returned, then no disks are added."
4415 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4417 "This function does some minimal checks to make sure the libvirt domain is "
4418 "not running (unless C<readonly> is true). In a future version we will try "
4419 "to acquire the libvirt lock on each disk."
4423 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4425 "Disks must be accessible locally. This often means that adding disks from a "
4426 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4427 "unless those disks are accessible via the same device path locally too."
4431 #: ../src/guestfs-actions.pod:74
4433 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4434 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4435 "libvirt URI (or one set through an environment variable, see the libvirt "
4436 "documentation for full details). If you are using the C API directly then "
4437 "it is more flexible to create the libvirt connection object yourself, get "
4438 "the domain object, and call C<guestfs_add_libvirt_dom>."
4442 #: ../src/guestfs-actions.pod:82
4444 "The other optional parameters are passed directly through to "
4445 "C<guestfs_add_drive_opts>."
4449 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336
4450 #: ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679
4451 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728
4452 #: ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307
4453 #: ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864
4454 #: ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003
4455 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081
4456 #: ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630
4457 #: ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475
4458 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009
4459 #: ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331
4460 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759
4461 #: ../src/guestfs-actions.pod:6772
4462 msgid "On error this function returns -1."
4466 #: ../src/guestfs-actions.pod:87
4467 msgid "guestfs_add_domain_va"
4471 #: ../src/guestfs-actions.pod:89
4475 " guestfs_add_domain_va (guestfs_h *g,\n"
4476 " const char *dom,\n"
4482 #: ../src/guestfs-actions.pod:94
4483 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4487 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107
4488 #: ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4489 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4493 #: ../src/guestfs-actions.pod:98
4494 msgid "guestfs_add_domain_argv"
4498 #: ../src/guestfs-actions.pod:100
4502 " guestfs_add_domain_argv (guestfs_h *g,\n"
4503 " const char *dom,\n"
4504 " const struct guestfs_add_domain_argv *optargs);\n"
4509 #: ../src/guestfs-actions.pod:105
4510 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4514 #: ../src/guestfs-actions.pod:109
4515 msgid "guestfs_add_drive"
4519 #: ../src/guestfs-actions.pod:111
4523 " guestfs_add_drive (guestfs_h *g,\n"
4524 " const char *filename);\n"
4529 #: ../src/guestfs-actions.pod:115
4531 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4532 "optional parameters, so the disk is added writable, with the format being "
4533 "detected automatically."
4537 #: ../src/guestfs-actions.pod:119
4539 "Automatic detection of the format opens you up to a potential security hole "
4540 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4541 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4542 "you should think about replacing calls to this function with calls to "
4543 "C<guestfs_add_drive_opts>, and specifying the format."
4547 #: ../src/guestfs-actions.pod:130
4548 msgid "guestfs_add_drive_opts"
4552 #: ../src/guestfs-actions.pod:132
4556 " guestfs_add_drive_opts (guestfs_h *g,\n"
4557 " const char *filename,\n"
4563 #: ../src/guestfs-actions.pod:142
4566 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4567 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4568 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4573 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4575 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4576 "The first time you call this function, the disk appears as C</dev/sda>, the "
4577 "second time as C</dev/sdb>, and so on."
4581 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4583 "You don't necessarily need to be root when using libguestfs. However you "
4584 "obviously do need sufficient permissions to access the filename for whatever "
4585 "operations you want to perform (ie. read access if you just want to read the "
4586 "image or write access if you want to modify the image)."
4590 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4591 msgid "This call checks that C<filename> exists."
4595 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4596 msgid "The optional arguments are:"
4600 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4605 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4607 "If true then the image is treated as read-only. Writes are still allowed, "
4608 "but they are stored in a temporary snapshot overlay which is discarded at "
4609 "the end. The disk that you add is not modified."
4613 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4618 #: ../src/guestfs-actions.pod:171
4620 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4621 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4622 "Possible formats include C<raw> and C<qcow2>."
4626 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4628 "Automatic detection of the format opens you up to a potential security hole "
4629 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4630 "RHBZ#642934. Specifying the format closes this security hole."
4634 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4639 #: ../src/guestfs-actions.pod:182
4641 "This rarely-used option lets you emulate the behaviour of the deprecated "
4642 "C<guestfs_add_drive_with_if> call (q.v.)"
4646 #: ../src/guestfs-actions.pod:189
4647 msgid "(Added in 1.5.23)"
4651 #: ../src/guestfs-actions.pod:191
4652 msgid "guestfs_add_drive_opts_va"
4656 #: ../src/guestfs-actions.pod:193
4660 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4661 " const char *filename,\n"
4667 #: ../src/guestfs-actions.pod:198
4668 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4672 #: ../src/guestfs-actions.pod:202
4673 msgid "guestfs_add_drive_opts_argv"
4677 #: ../src/guestfs-actions.pod:204
4681 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4682 " const char *filename,\n"
4683 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4688 #: ../src/guestfs-actions.pod:209
4689 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4693 #: ../src/guestfs-actions.pod:213
4694 msgid "guestfs_add_drive_ro"
4698 #: ../src/guestfs-actions.pod:215
4702 " guestfs_add_drive_ro (guestfs_h *g,\n"
4703 " const char *filename);\n"
4708 #: ../src/guestfs-actions.pod:219
4710 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4711 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4712 "disk is added read-only, with the format being detected automatically."
4716 #: ../src/guestfs-actions.pod:226
4717 msgid "(Added in 1.0.38)"
4721 #: ../src/guestfs-actions.pod:228
4722 msgid "guestfs_add_drive_ro_with_if"
4726 #: ../src/guestfs-actions.pod:230
4730 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4731 " const char *filename,\n"
4732 " const char *iface);\n"
4737 #: ../src/guestfs-actions.pod:235
4739 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4740 "QEMU interface emulation to use at run time."
4744 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268
4745 #: ../src/guestfs-actions.pod:2303
4746 msgid "(Added in 1.0.84)"
4750 #: ../src/guestfs-actions.pod:249
4751 msgid "guestfs_add_drive_with_if"
4755 #: ../src/guestfs-actions.pod:251
4759 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4760 " const char *filename,\n"
4761 " const char *iface);\n"
4766 #: ../src/guestfs-actions.pod:256
4768 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4769 "QEMU interface emulation to use at run time."
4773 #: ../src/guestfs-actions.pod:270
4774 msgid "guestfs_aug_clear"
4778 #: ../src/guestfs-actions.pod:272
4782 " guestfs_aug_clear (guestfs_h *g,\n"
4783 " const char *augpath);\n"
4788 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4790 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4791 "L<augtool(1)> C<clear> command."
4795 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4796 msgid "(Added in 1.3.4)"
4800 #: ../src/guestfs-actions.pod:283
4801 msgid "guestfs_aug_close"
4805 #: ../src/guestfs-actions.pod:285
4809 " guestfs_aug_close (guestfs_h *g);\n"
4814 #: ../src/guestfs-actions.pod:288
4816 "Close the current Augeas handle and free up any resources used by it. After "
4817 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4818 "any other Augeas functions."
4822 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320
4823 #: ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352
4824 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4825 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475
4826 #: ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503
4827 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4828 #: ../src/guestfs-actions.pod:5086
4829 msgid "(Added in 0.7)"
4833 #: ../src/guestfs-actions.pod:297
4834 msgid "guestfs_aug_defnode"
4838 #: ../src/guestfs-actions.pod:299
4841 " struct guestfs_int_bool *\n"
4842 " guestfs_aug_defnode (guestfs_h *g,\n"
4843 " const char *name,\n"
4844 " const char *expr,\n"
4845 " const char *val);\n"
4850 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4852 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4856 #: ../src/guestfs-actions.pod:308
4858 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4859 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4860 "containing that single node."
4864 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4866 "On success this returns a pair containing the number of nodes in the "
4867 "nodeset, and a boolean flag if a node was created."
4871 #: ../src/guestfs-actions.pod:316
4873 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4874 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4878 #: ../src/guestfs-actions.pod:322
4879 msgid "guestfs_aug_defvar"
4883 #: ../src/guestfs-actions.pod:324
4887 " guestfs_aug_defvar (guestfs_h *g,\n"
4888 " const char *name,\n"
4889 " const char *expr);\n"
4894 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4896 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4897 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4901 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4903 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4904 "evaluates to something which is not a nodeset."
4908 #: ../src/guestfs-actions.pod:340
4909 msgid "guestfs_aug_get"
4913 #: ../src/guestfs-actions.pod:342
4917 " guestfs_aug_get (guestfs_h *g,\n"
4918 " const char *augpath);\n"
4923 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4925 "Look up the value associated with C<path>. If C<path> matches exactly one "
4926 "node, the C<value> is returned."
4930 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849
4931 #: ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927
4932 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046
4933 #: ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193
4934 #: ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341
4935 #: ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644
4936 #: ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824
4937 #: ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936
4938 #: ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268
4939 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
4940 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712
4941 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763
4942 #: ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846
4943 #: ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678
4944 #: ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958
4945 #: ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814
4946 #: ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162
4947 #: ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774
4948 #: ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807
4949 #: ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495
4950 #: ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532
4951 #: ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4953 "This function returns a string, or NULL on error. I<The caller must free "
4954 "the returned string after use>."
4958 #: ../src/guestfs-actions.pod:354
4959 msgid "guestfs_aug_init"
4963 #: ../src/guestfs-actions.pod:356
4967 " guestfs_aug_init (guestfs_h *g,\n"
4968 " const char *root,\n"
4974 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4976 "Create a new Augeas handle for editing configuration files. If there was "
4977 "any previous Augeas handle associated with this guestfs session, then it is "
4982 #: ../src/guestfs-actions.pod:365
4983 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4987 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4989 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4993 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4995 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4996 "logical I<or> of the following integers:"
5000 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
5001 msgid "C<AUG_SAVE_BACKUP> = 1"
5005 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
5006 msgid "Keep the original file with a C<.augsave> extension."
5010 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
5011 msgid "C<AUG_SAVE_NEWFILE> = 2"
5015 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
5017 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5018 "original. Overrides C<AUG_SAVE_BACKUP>."
5022 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
5023 msgid "C<AUG_TYPE_CHECK> = 4"
5027 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
5028 msgid "Typecheck lenses (can be expensive)."
5032 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
5033 msgid "C<AUG_NO_STDINC> = 8"
5037 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
5038 msgid "Do not use standard load path for modules."
5042 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
5043 msgid "C<AUG_SAVE_NOOP> = 16"
5047 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
5048 msgid "Make save a no-op, just record what would have been changed."
5052 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
5053 msgid "C<AUG_NO_LOAD> = 32"
5057 #: ../src/guestfs-actions.pod:400
5058 msgid "Do not load the tree in C<guestfs_aug_init>."
5062 #: ../src/guestfs-actions.pod:404
5063 msgid "To close the handle, you can call C<guestfs_aug_close>."
5067 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
5068 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5072 #: ../src/guestfs-actions.pod:412
5073 msgid "guestfs_aug_insert"
5077 #: ../src/guestfs-actions.pod:414
5081 " guestfs_aug_insert (guestfs_h *g,\n"
5082 " const char *augpath,\n"
5083 " const char *label,\n"
5089 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
5091 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5092 "or after C<path> (depending on the boolean flag C<before>)."
5096 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
5098 "C<path> must match exactly one existing node in the tree, and C<label> must "
5099 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5103 #: ../src/guestfs-actions.pod:432
5104 msgid "guestfs_aug_load"
5108 #: ../src/guestfs-actions.pod:434
5112 " guestfs_aug_load (guestfs_h *g);\n"
5117 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
5118 msgid "Load files into the tree."
5122 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
5123 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5127 #: ../src/guestfs-actions.pod:446
5128 msgid "guestfs_aug_ls"
5132 #: ../src/guestfs-actions.pod:448
5136 " guestfs_aug_ls (guestfs_h *g,\n"
5137 " const char *augpath);\n"
5142 #: ../src/guestfs-actions.pod:452
5144 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5145 "sorting the resulting nodes into alphabetical order."
5149 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471
5150 #: ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065
5151 #: ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375
5152 #: ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497
5153 #: ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148
5154 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183
5155 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250
5156 #: ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370
5157 #: ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782
5158 #: ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248
5159 #: ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415
5160 #: ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436
5161 #: ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082
5162 #: ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847
5163 #: ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963
5164 #: ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133
5165 #: ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625
5166 #: ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837
5167 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941
5168 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006
5169 #: ../src/guestfs-actions.pod:7025
5171 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5172 ">), or NULL if there was an error. I<The caller must free the strings and "
5173 "the array after use>."
5177 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990
5178 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413
5179 #: ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102
5180 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711
5181 #: ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931
5182 #: ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440
5183 #: ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275
5184 #: ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301
5185 #: ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347
5186 #: ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589
5187 #: ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
5188 msgid "(Added in 0.8)"
5192 #: ../src/guestfs-actions.pod:461
5193 msgid "guestfs_aug_match"
5197 #: ../src/guestfs-actions.pod:463
5201 " guestfs_aug_match (guestfs_h *g,\n"
5202 " const char *augpath);\n"
5207 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
5209 "Returns a list of paths which match the path expression C<path>. The "
5210 "returned paths are sufficiently qualified so that they match exactly one "
5211 "node in the current tree."
5215 #: ../src/guestfs-actions.pod:477
5216 msgid "guestfs_aug_mv"
5220 #: ../src/guestfs-actions.pod:479
5224 " guestfs_aug_mv (guestfs_h *g,\n"
5225 " const char *src,\n"
5226 " const char *dest);\n"
5231 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
5233 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5234 "C<dest> is overwritten if it exists."
5238 #: ../src/guestfs-actions.pod:491
5239 msgid "guestfs_aug_rm"
5243 #: ../src/guestfs-actions.pod:493
5247 " guestfs_aug_rm (guestfs_h *g,\n"
5248 " const char *augpath);\n"
5253 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5254 msgid "Remove C<path> and all of its children."
5258 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5259 msgid "On success this returns the number of entries which were removed."
5263 #: ../src/guestfs-actions.pod:505
5264 msgid "guestfs_aug_save"
5268 #: ../src/guestfs-actions.pod:507
5272 " guestfs_aug_save (guestfs_h *g);\n"
5277 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5278 msgid "This writes all pending changes to disk."
5282 #: ../src/guestfs-actions.pod:512
5284 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5289 #: ../src/guestfs-actions.pod:519
5290 msgid "guestfs_aug_set"
5294 #: ../src/guestfs-actions.pod:521
5298 " guestfs_aug_set (guestfs_h *g,\n"
5299 " const char *augpath,\n"
5300 " const char *val);\n"
5305 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5306 msgid "Set the value associated with C<path> to C<val>."
5310 #: ../src/guestfs-actions.pod:528
5312 "In the Augeas API, it is possible to clear a node by setting the value to "
5313 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5314 "this call. Instead you must use the C<guestfs_aug_clear> call."
5318 #: ../src/guestfs-actions.pod:537
5319 msgid "guestfs_available"
5323 #: ../src/guestfs-actions.pod:539
5327 " guestfs_available (guestfs_h *g,\n"
5328 " char *const *groups);\n"
5333 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5335 "This command is used to check the availability of some groups of "
5336 "functionality in the appliance, which not all builds of the libguestfs "
5337 "appliance will be able to provide."
5341 #: ../src/guestfs-actions.pod:547
5343 "The libguestfs groups, and the functions that those groups correspond to, "
5344 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5345 "runtime by calling C<guestfs_available_all_groups>."
5349 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5351 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5352 "\"]> would check for the availability of the Linux inotify functions and "
5353 "Augeas (configuration file editing) functions."
5357 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5358 msgid "The command returns no error if I<all> requested groups are available."
5362 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5364 "It fails with an error if one or more of the requested groups is unavailable "
5369 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5371 "If an unknown group name is included in the list of groups then an error is "
5376 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5381 #: ../src/guestfs-actions.pod:571
5382 msgid "You must call C<guestfs_launch> before calling this function."
5386 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5388 "The reason is because we don't know what groups are supported by the "
5389 "appliance/daemon until it is running and can be queried."
5393 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5395 "If a group of functions is available, this does not necessarily mean that "
5396 "they will work. You still have to check for errors when calling individual "
5397 "API functions even if they are available."
5401 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5403 "It is usually the job of distro packagers to build complete functionality "
5404 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5405 "with all requirements satisfied, will support everything."
5409 #: ../src/guestfs-actions.pod:593
5411 "This call was added in version C<1.0.80>. In previous versions of "
5412 "libguestfs all you could do would be to speculatively execute a command to "
5413 "find out if the daemon implemented it. See also C<guestfs_version>."
5417 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5418 msgid "(Added in 1.0.80)"
5422 #: ../src/guestfs-actions.pod:604
5423 msgid "guestfs_available_all_groups"
5427 #: ../src/guestfs-actions.pod:606
5431 " guestfs_available_all_groups (guestfs_h *g);\n"
5436 #: ../src/guestfs-actions.pod:609
5438 "This command returns a list of all optional groups that this daemon knows "
5439 "about. Note this returns both supported and unsupported groups. To find "
5440 "out which ones the daemon can actually support you have to call "
5441 "C<guestfs_available> on each member of the returned list."
5445 #: ../src/guestfs-actions.pod:615
5446 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5450 #: ../src/guestfs-actions.pod:621
5451 msgid "(Added in 1.3.15)"
5455 #: ../src/guestfs-actions.pod:623
5456 msgid "guestfs_base64_in"
5460 #: ../src/guestfs-actions.pod:625
5464 " guestfs_base64_in (guestfs_h *g,\n"
5465 " const char *base64file,\n"
5466 " const char *filename);\n"
5471 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5473 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5477 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5478 msgid "(Added in 1.3.5)"
5482 #: ../src/guestfs-actions.pod:637
5483 msgid "guestfs_base64_out"
5487 #: ../src/guestfs-actions.pod:639
5491 " guestfs_base64_out (guestfs_h *g,\n"
5492 " const char *filename,\n"
5493 " const char *base64file);\n"
5498 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5500 "This command downloads the contents of C<filename>, writing it out to local "
5501 "file C<base64file> encoded as base64."
5505 #: ../src/guestfs-actions.pod:651
5506 msgid "guestfs_blockdev_flushbufs"
5510 #: ../src/guestfs-actions.pod:653
5514 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5515 " const char *device);\n"
5520 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5522 "This tells the kernel to flush internal buffers associated with C<device>."
5526 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677
5527 #: ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708
5528 #: ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745
5529 #: ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777
5530 #: ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805
5531 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5532 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5533 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5534 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5535 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5536 msgid "This uses the L<blockdev(8)> command."
5540 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681
5541 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712
5542 #: ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749
5543 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
5544 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5545 msgid "(Added in 0.9.3)"
5549 #: ../src/guestfs-actions.pod:666
5550 msgid "guestfs_blockdev_getbsz"
5554 #: ../src/guestfs-actions.pod:668
5558 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5559 " const char *device);\n"
5564 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5565 msgid "This returns the block size of a device."
5569 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774
5570 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5572 "(Note this is different from both I<size in blocks> and I<filesystem block "
5577 #: ../src/guestfs-actions.pod:683
5578 msgid "guestfs_blockdev_getro"
5582 #: ../src/guestfs-actions.pod:685
5586 " guestfs_blockdev_getro (guestfs_h *g,\n"
5587 " const char *device);\n"
5592 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5594 "Returns a boolean indicating if the block device is read-only (true if read-"
5595 "only, false if not)."
5599 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396
5600 #: ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891
5601 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974
5602 #: ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044
5603 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092
5604 #: ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024
5605 #: ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053
5606 #: ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084
5607 #: ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114
5608 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141
5609 #: ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171
5610 #: ../src/guestfs-actions.pod:4585
5611 msgid "This function returns a C truth value on success or -1 on error."
5615 #: ../src/guestfs-actions.pod:698
5616 msgid "guestfs_blockdev_getsize64"
5620 #: ../src/guestfs-actions.pod:700
5624 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5625 " const char *device);\n"
5630 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5631 msgid "This returns the size of the device in bytes."
5635 #: ../src/guestfs-actions.pod:706
5636 msgid "See also C<guestfs_blockdev_getsz>."
5640 #: ../src/guestfs-actions.pod:714
5641 msgid "guestfs_blockdev_getss"
5645 #: ../src/guestfs-actions.pod:716
5649 " guestfs_blockdev_getss (guestfs_h *g,\n"
5650 " const char *device);\n"
5655 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5657 "This returns the size of sectors on a block device. Usually 512, but can be "
5658 "larger for modern devices."
5662 #: ../src/guestfs-actions.pod:723
5664 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5669 #: ../src/guestfs-actions.pod:732
5670 msgid "guestfs_blockdev_getsz"
5674 #: ../src/guestfs-actions.pod:734
5678 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5679 " const char *device);\n"
5684 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5686 "This returns the size of the device in units of 512-byte sectors (even if "
5687 "the sectorsize isn't 512 bytes ... weird)."
5691 #: ../src/guestfs-actions.pod:741
5693 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5694 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5698 #: ../src/guestfs-actions.pod:751
5699 msgid "guestfs_blockdev_rereadpt"
5703 #: ../src/guestfs-actions.pod:753
5707 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5708 " const char *device);\n"
5713 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5714 msgid "Reread the partition table on C<device>."
5718 #: ../src/guestfs-actions.pod:765
5719 msgid "guestfs_blockdev_setbsz"
5723 #: ../src/guestfs-actions.pod:767
5727 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5728 " const char *device,\n"
5729 " int blocksize);\n"
5734 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5735 msgid "This sets the block size of a device."
5739 #: ../src/guestfs-actions.pod:783
5740 msgid "guestfs_blockdev_setro"
5744 #: ../src/guestfs-actions.pod:785
5748 " guestfs_blockdev_setro (guestfs_h *g,\n"
5749 " const char *device);\n"
5754 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5755 msgid "Sets the block device named C<device> to read-only."
5759 #: ../src/guestfs-actions.pod:797
5760 msgid "guestfs_blockdev_setrw"
5764 #: ../src/guestfs-actions.pod:799
5768 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5769 " const char *device);\n"
5774 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5775 msgid "Sets the block device named C<device> to read-write."
5779 #: ../src/guestfs-actions.pod:811
5780 msgid "guestfs_case_sensitive_path"
5784 #: ../src/guestfs-actions.pod:813
5788 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5789 " const char *path);\n"
5794 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5796 "This can be used to resolve case insensitive paths on a filesystem which is "
5797 "case sensitive. The use case is to resolve paths which you have read from "
5798 "Windows configuration files or the Windows Registry, to the true path."
5802 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5804 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5805 "(and probably others), which is that although the underlying filesystem is "
5806 "case-insensitive, the driver exports the filesystem to Linux as case-"
5811 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5813 "One consequence of this is that special directories such as C<c:\\windows> "
5814 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5815 "precise details of how they were created. In Windows itself this would not "
5820 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5822 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5827 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5829 "This function resolves the true case of each element in the path and returns "
5830 "the case-sensitive path."
5834 #: ../src/guestfs-actions.pod:839
5836 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5837 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5838 "how the directories were originally created under Windows)."
5842 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5843 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5847 #: ../src/guestfs-actions.pod:847
5848 msgid "See also C<guestfs_realpath>."
5852 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5853 msgid "(Added in 1.0.75)"
5857 #: ../src/guestfs-actions.pod:854
5862 #: ../src/guestfs-actions.pod:856
5866 " guestfs_cat (guestfs_h *g,\n"
5867 " const char *path);\n"
5872 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072
5873 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5874 msgid "Return the contents of the file named C<path>."
5878 #: ../src/guestfs-actions.pod:862
5880 "Note that this function cannot correctly handle binary files (specifically, "
5881 "files containing C<\\0> character which is treated as end of string). For "
5882 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5883 "functions which have a more complex interface."
5887 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049
5888 #: ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360
5889 #: ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482
5890 #: ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750
5891 #: ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187
5892 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254
5893 #: ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300
5894 #: ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880
5895 #: ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037
5896 #: ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912
5897 #: ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113
5898 #: ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789
5899 #: ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841
5900 #: ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945
5901 #: ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010
5902 #: ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:582
5903 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5904 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5905 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5906 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5907 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5908 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5909 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5910 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5911 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5912 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5913 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5914 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5915 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5916 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5917 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5919 "Because of the message protocol, there is a transfer limit of somewhere "
5920 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5924 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252
5925 #: ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331
5926 #: ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824
5927 #: ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960
5928 #: ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676
5929 #: ../src/guestfs-actions.pod:6690
5930 msgid "(Added in 0.4)"
5934 #: ../src/guestfs-actions.pod:875
5935 msgid "guestfs_checksum"
5939 #: ../src/guestfs-actions.pod:877
5943 " guestfs_checksum (guestfs_h *g,\n"
5944 " const char *csumtype,\n"
5945 " const char *path);\n"
5950 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5952 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5956 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5958 "The type of checksum to compute is given by the C<csumtype> parameter which "
5959 "must have one of the following values:"
5963 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5968 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5970 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5975 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5980 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5981 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5985 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5990 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5991 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5995 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
6000 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
6001 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6005 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
6010 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
6011 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6015 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
6020 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
6021 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6025 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
6030 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
6031 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6035 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
6036 msgid "The checksum is returned as a printable string."
6040 #: ../src/guestfs-actions.pod:923
6041 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6045 #: ../src/guestfs-actions.pod:925
6046 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6050 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238
6051 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026
6052 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116
6053 #: ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
6054 msgid "(Added in 1.0.2)"
6058 #: ../src/guestfs-actions.pod:932
6059 msgid "guestfs_checksum_device"
6063 #: ../src/guestfs-actions.pod:934
6067 " guestfs_checksum_device (guestfs_h *g,\n"
6068 " const char *csumtype,\n"
6069 " const char *device);\n"
6074 #: ../src/guestfs-actions.pod:939
6076 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6077 "device named C<device>. For the types of checksums supported see the "
6078 "C<guestfs_checksum> command."
6082 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491
6083 #: ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587
6084 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781
6085 #: ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306
6086 #: ../src/guestfs-actions.pod:6702
6087 msgid "(Added in 1.3.2)"
6091 #: ../src/guestfs-actions.pod:948
6092 msgid "guestfs_checksums_out"
6096 #: ../src/guestfs-actions.pod:950
6100 " guestfs_checksums_out (guestfs_h *g,\n"
6101 " const char *csumtype,\n"
6102 " const char *directory,\n"
6103 " const char *sumsfile);\n"
6108 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
6110 "This command computes the checksums of all regular files in C<directory> and "
6111 "then emits a list of those checksums to the local output file C<sumsfile>."
6115 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
6117 "This can be used for verifying the integrity of a virtual machine. However "
6118 "to be properly secure you should pay attention to the output of the checksum "
6119 "command (it uses the ones from GNU coreutils). In particular when the "
6120 "filename is not printable, coreutils uses a special backslash syntax. For "
6121 "more information, see the GNU coreutils info file."
6125 #: ../src/guestfs-actions.pod:970
6126 msgid "(Added in 1.3.7)"
6130 #: ../src/guestfs-actions.pod:972
6131 msgid "guestfs_chmod"
6135 #: ../src/guestfs-actions.pod:974
6139 " guestfs_chmod (guestfs_h *g,\n"
6141 " const char *path);\n"
6146 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
6148 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6153 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
6155 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6156 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6161 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075
6162 #: ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209
6163 #: ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671
6164 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6165 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6166 msgid "The mode actually set is affected by the umask."
6170 #: ../src/guestfs-actions.pod:992
6171 msgid "guestfs_chown"
6175 #: ../src/guestfs-actions.pod:994
6179 " guestfs_chown (guestfs_h *g,\n"
6182 " const char *path);\n"
6187 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
6188 msgid "Change the file owner to C<owner> and group to C<group>."
6192 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213
6193 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6195 "Only numeric uid and gid are supported. If you want to use names, you will "
6196 "need to locate and parse the password file yourself (Augeas support makes "
6197 "this relatively easy)."
6201 #: ../src/guestfs-actions.pod:1010
6202 msgid "guestfs_command"
6206 #: ../src/guestfs-actions.pod:1012
6210 " guestfs_command (guestfs_h *g,\n"
6211 " char *const *arguments);\n"
6216 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
6218 "This call runs a command from the guest filesystem. The filesystem must be "
6219 "mounted, and must contain a compatible operating system (ie. something "
6220 "Linux, with the same or compatible processor architecture)."
6224 #: ../src/guestfs-actions.pod:1021
6226 "The single parameter is an argv-style list of arguments. The first element "
6227 "is the name of the program to run. Subsequent elements are parameters. The "
6228 "list must be non-empty (ie. must contain a program name). Note that the "
6229 "command runs directly, and is I<not> invoked via the shell (see "
6234 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
6235 msgid "The return value is anything printed to I<stdout> by the command."
6239 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
6241 "If the command returns a non-zero exit status, then this function returns an "
6242 "error message. The error message string is the content of I<stderr> from "
6247 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
6249 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6250 "bin>. If you require a program from another location, you should provide "
6251 "the full path in the first parameter."
6255 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
6257 "Shared libraries and data files required by the program must be available on "
6258 "filesystems which are mounted in the correct places. It is the caller's "
6259 "responsibility to ensure all filesystems that are needed are mounted at the "
6264 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072
6265 #: ../src/guestfs-actions.pod:1535
6266 msgid "(Added in 0.9.1)"
6270 #: ../src/guestfs-actions.pod:1054
6271 msgid "guestfs_command_lines"
6275 #: ../src/guestfs-actions.pod:1056
6279 " guestfs_command_lines (guestfs_h *g,\n"
6280 " char *const *arguments);\n"
6285 #: ../src/guestfs-actions.pod:1060
6287 "This is the same as C<guestfs_command>, but splits the result into a list of "
6292 #: ../src/guestfs-actions.pod:1063
6293 msgid "See also: C<guestfs_sh_lines>"
6297 #: ../src/guestfs-actions.pod:1074
6298 msgid "guestfs_config"
6302 #: ../src/guestfs-actions.pod:1076
6306 " guestfs_config (guestfs_h *g,\n"
6307 " const char *qemuparam,\n"
6308 " const char *qemuvalue);\n"
6313 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
6315 "This can be used to add arbitrary qemu command line parameters of the form "
6316 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6317 "setting some parameters which would interfere with parameters that we use."
6321 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
6322 msgid "The first character of C<param> string must be a C<-> (dash)."
6326 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6327 msgid "C<value> can be NULL."
6331 #: ../src/guestfs-actions.pod:1094
6332 msgid "guestfs_copy_size"
6336 #: ../src/guestfs-actions.pod:1096
6340 " guestfs_copy_size (guestfs_h *g,\n"
6341 " const char *src,\n"
6342 " const char *dest,\n"
6348 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6350 "This command copies exactly C<size> bytes from one source device or file "
6351 "C<src> to another destination device or file C<dest>."
6355 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6357 "Note this will fail if the source is too short or if the destination is not "
6362 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233
6363 #: ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684
6364 #: ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881
6365 #: ../src/guestfs-actions.pod:6900
6367 "This long-running command can generate progress notification messages so "
6368 "that the caller can display a progress bar or indicator. To receive these "
6369 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6370 "guestfs_set_progress_callback>."
6374 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851
6375 #: ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609
6376 #: ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6377 msgid "(Added in 1.0.87)"
6381 #: ../src/guestfs-actions.pod:1117
6386 #: ../src/guestfs-actions.pod:1119
6390 " guestfs_cp (guestfs_h *g,\n"
6391 " const char *src,\n"
6392 " const char *dest);\n"
6397 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6399 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6400 "destination filename or destination directory."
6404 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143
6405 #: ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289
6406 #: ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454
6407 #: ../src/guestfs-actions.pod:4831
6408 msgid "(Added in 1.0.18)"
6412 #: ../src/guestfs-actions.pod:1131
6413 msgid "guestfs_cp_a"
6417 #: ../src/guestfs-actions.pod:1133
6421 " guestfs_cp_a (guestfs_h *g,\n"
6422 " const char *src,\n"
6423 " const char *dest);\n"
6428 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6430 "This copies a file or directory from C<src> to C<dest> recursively using the "
6435 #: ../src/guestfs-actions.pod:1145
6440 #: ../src/guestfs-actions.pod:1147
6444 " guestfs_dd (guestfs_h *g,\n"
6445 " const char *src,\n"
6446 " const char *dest);\n"
6451 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6453 "This command copies from one source device or file C<src> to another "
6454 "destination device or file C<dest>. Normally you would use this to copy to "
6455 "or from a device or partition, for example to duplicate a filesystem."
6459 #: ../src/guestfs-actions.pod:1157
6461 "If the destination is a device, it must be as large or larger than the "
6462 "source file or device, otherwise the copy will fail. This command cannot do "
6463 "partial copies (see C<guestfs_copy_size>)."
6467 #: ../src/guestfs-actions.pod:1165
6472 #: ../src/guestfs-actions.pod:1167
6476 " guestfs_df (guestfs_h *g);\n"
6481 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6482 msgid "This command runs the C<df> command to report disk space used."
6486 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189
6487 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6489 "This command is mostly useful for interactive sessions. It is I<not> "
6490 "intended that you try to parse the output string. Use C<statvfs> from "
6495 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196
6496 #: ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233
6497 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325
6498 #: ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354
6499 #: ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140
6500 #: ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761
6501 #: ../src/guestfs-actions.pod:6774
6502 msgid "(Added in 1.0.54)"
6506 #: ../src/guestfs-actions.pod:1181
6507 msgid "guestfs_df_h"
6511 #: ../src/guestfs-actions.pod:1183
6515 " guestfs_df_h (guestfs_h *g);\n"
6520 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6522 "This command runs the C<df -h> command to report disk space used in human-"
6527 #: ../src/guestfs-actions.pod:1198
6528 msgid "guestfs_dmesg"
6532 #: ../src/guestfs-actions.pod:1200
6536 " guestfs_dmesg (guestfs_h *g);\n"
6541 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6543 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6544 "This is sometimes useful for extended debugging of problems."
6548 #: ../src/guestfs-actions.pod:1207
6550 "Another way to get the same information is to enable verbose messages with "
6551 "C<guestfs_set_verbose> or by setting the environment variable "
6552 "C<LIBGUESTFS_DEBUG=1> before running the program."
6556 #: ../src/guestfs-actions.pod:1217
6557 msgid "guestfs_download"
6561 #: ../src/guestfs-actions.pod:1219
6565 " guestfs_download (guestfs_h *g,\n"
6566 " const char *remotefilename,\n"
6567 " const char *filename);\n"
6572 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249
6573 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6575 "Download file C<remotefilename> and save it as C<filename> on the local "
6580 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372
6581 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6582 msgid "C<filename> can also be a named pipe."
6586 #: ../src/guestfs-actions.pod:1229
6587 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6591 #: ../src/guestfs-actions.pod:1240
6592 msgid "guestfs_download_offset"
6596 #: ../src/guestfs-actions.pod:1242
6600 " guestfs_download_offset (guestfs_h *g,\n"
6601 " const char *remotefilename,\n"
6602 " const char *filename,\n"
6603 " int64_t offset,\n"
6609 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6611 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6612 "region must be within the file or device)."
6616 #: ../src/guestfs-actions.pod:1255
6618 "Note that there is no limit on the amount of data that can be downloaded "
6619 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6620 "full amount unless an error occurs."
6624 #: ../src/guestfs-actions.pod:1260
6625 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6629 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6630 msgid "(Added in 1.5.17)"
6634 #: ../src/guestfs-actions.pod:1271
6635 msgid "guestfs_drop_caches"
6639 #: ../src/guestfs-actions.pod:1273
6643 " guestfs_drop_caches (guestfs_h *g,\n"
6644 " int whattodrop);\n"
6649 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6651 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6652 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6653 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6657 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6658 msgid "Setting C<whattodrop> to 3 should drop everything."
6662 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6664 "This automatically calls L<sync(2)> before the operation, so that the "
6665 "maximum guest memory is freed."
6669 #: ../src/guestfs-actions.pod:1291
6674 #: ../src/guestfs-actions.pod:1293
6678 " guestfs_du (guestfs_h *g,\n"
6679 " const char *path);\n"
6684 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6686 "This command runs the C<du -s> command to estimate file space usage for "
6691 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6693 "C<path> can be a file or a directory. If C<path> is a directory then the "
6694 "estimate includes the contents of the directory and all subdirectories "
6699 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6701 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6705 #: ../src/guestfs-actions.pod:1311
6706 msgid "guestfs_e2fsck_f"
6710 #: ../src/guestfs-actions.pod:1313
6714 " guestfs_e2fsck_f (guestfs_h *g,\n"
6715 " const char *device);\n"
6720 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6722 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6723 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6728 #: ../src/guestfs-actions.pod:1321
6730 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6731 "Normally you should use C<guestfs_fsck>."
6735 #: ../src/guestfs-actions.pod:1326
6736 msgid "(Added in 1.0.29)"
6740 #: ../src/guestfs-actions.pod:1328
6741 msgid "guestfs_echo_daemon"
6745 #: ../src/guestfs-actions.pod:1330
6749 " guestfs_echo_daemon (guestfs_h *g,\n"
6750 " char *const *words);\n"
6755 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6757 "This command concatenates the list of C<words> passed with single spaces "
6758 "between them and returns the resulting string."
6762 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6763 msgid "You can use this command to test the connection through to the daemon."
6767 #: ../src/guestfs-actions.pod:1339
6768 msgid "See also C<guestfs_ping_daemon>."
6772 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071
6773 #: ../src/guestfs-actions.pod:5620
6774 msgid "(Added in 1.0.69)"
6778 #: ../src/guestfs-actions.pod:1346
6779 msgid "guestfs_egrep"
6783 #: ../src/guestfs-actions.pod:1348
6787 " guestfs_egrep (guestfs_h *g,\n"
6788 " const char *regex,\n"
6789 " const char *path);\n"
6794 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6796 "This calls the external C<egrep> program and returns the matching lines."
6800 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382
6801 #: ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485
6802 #: ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171
6803 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346
6804 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374
6805 #: ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442
6806 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344
6807 #: ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371
6808 #: ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289
6809 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214
6810 #: ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996
6811 #: ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022
6812 #: ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057
6813 #: ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083
6814 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863
6815 #: ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967
6816 #: ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6817 msgid "(Added in 1.0.66)"
6821 #: ../src/guestfs-actions.pod:1365
6822 msgid "guestfs_egrepi"
6826 #: ../src/guestfs-actions.pod:1367
6830 " guestfs_egrepi (guestfs_h *g,\n"
6831 " const char *regex,\n"
6832 " const char *path);\n"
6837 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6839 "This calls the external C<egrep -i> program and returns the matching lines."
6843 #: ../src/guestfs-actions.pod:1384
6844 msgid "guestfs_equal"
6848 #: ../src/guestfs-actions.pod:1386
6852 " guestfs_equal (guestfs_h *g,\n"
6853 " const char *file1,\n"
6854 " const char *file2);\n"
6859 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6861 "This compares the two files C<file1> and C<file2> and returns true if their "
6862 "content is exactly equal, or false otherwise."
6866 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6867 msgid "The external L<cmp(1)> program is used for the comparison."
6871 #: ../src/guestfs-actions.pod:1400
6872 msgid "guestfs_exists"
6876 #: ../src/guestfs-actions.pod:1402
6880 " guestfs_exists (guestfs_h *g,\n"
6881 " const char *path);\n"
6886 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6888 "This returns C<true> if and only if there is a file, directory (or anything) "
6889 "with the given C<path> name."
6893 #: ../src/guestfs-actions.pod:1409
6894 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6898 #: ../src/guestfs-actions.pod:1415
6899 msgid "guestfs_fallocate"
6903 #: ../src/guestfs-actions.pod:1417
6907 " guestfs_fallocate (guestfs_h *g,\n"
6908 " const char *path,\n"
6914 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448
6915 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6917 "This command preallocates a file (containing zero bytes) named C<path> of "
6918 "size C<len> bytes. If the file exists already, it is overwritten."
6922 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6924 "Do not confuse this with the guestfish-specific C<alloc> command which "
6925 "allocates a file in the host and attaches it as a device."
6929 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6931 "This function is deprecated. In new code, use the C<fallocate64> call "
6936 #: ../src/guestfs-actions.pod:1441
6937 msgid "guestfs_fallocate64"
6941 #: ../src/guestfs-actions.pod:1443
6945 " guestfs_fallocate64 (guestfs_h *g,\n"
6946 " const char *path,\n"
6952 #: ../src/guestfs-actions.pod:1452
6954 "Note that this call allocates disk blocks for the file. To create a sparse "
6955 "file use C<guestfs_truncate_size> instead."
6959 #: ../src/guestfs-actions.pod:1455
6961 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6962 "oversight it only allowed 30 bit lengths to be specified, effectively "
6963 "limiting the maximum size of files created through that call to 1GB."
6967 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6969 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6970 "commands which create a file in the host and attach it as a device."
6974 #: ../src/guestfs-actions.pod:1466
6975 msgid "(Added in 1.3.17)"
6979 #: ../src/guestfs-actions.pod:1468
6980 msgid "guestfs_fgrep"
6984 #: ../src/guestfs-actions.pod:1470
6988 " guestfs_fgrep (guestfs_h *g,\n"
6989 " const char *pattern,\n"
6990 " const char *path);\n"
6995 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6997 "This calls the external C<fgrep> program and returns the matching lines."
7001 #: ../src/guestfs-actions.pod:1487
7002 msgid "guestfs_fgrepi"
7006 #: ../src/guestfs-actions.pod:1489
7010 " guestfs_fgrepi (guestfs_h *g,\n"
7011 " const char *pattern,\n"
7012 " const char *path);\n"
7017 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
7019 "This calls the external C<fgrep -i> program and returns the matching lines."
7023 #: ../src/guestfs-actions.pod:1506
7024 msgid "guestfs_file"
7028 #: ../src/guestfs-actions.pod:1508
7032 " guestfs_file (guestfs_h *g,\n"
7033 " const char *path);\n"
7038 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
7040 "This call uses the standard L<file(1)> command to determine the type or "
7041 "contents of the file."
7045 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
7047 "This call will also transparently look inside various types of compressed "
7052 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
7054 "The exact command which runs is C<file -zb path>. Note in particular that "
7055 "the filename is not prepended to the output (the C<-b> option)."
7059 #: ../src/guestfs-actions.pod:1522
7061 "This command can also be used on C</dev/> devices (and partitions, LV "
7062 "names). You can for example use this to determine if a device contains a "
7063 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7067 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
7069 "If the C<path> does not begin with C</dev/> then this command only works for "
7070 "the content of regular files. For other file types (directory, symbolic "
7071 "link etc) it will just return the string C<directory> etc."
7075 #: ../src/guestfs-actions.pod:1537
7076 msgid "guestfs_file_architecture"
7080 #: ../src/guestfs-actions.pod:1539
7084 " guestfs_file_architecture (guestfs_h *g,\n"
7085 " const char *filename);\n"
7090 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
7092 "This detects the architecture of the binary C<filename>, and returns it if "
7097 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
7098 msgid "Currently defined architectures are:"
7102 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
7107 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
7109 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7110 "irrespective of the precise processor requirements of the binary."
7114 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
7119 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
7120 msgid "64 bit x86-64."
7124 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
7129 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
7130 msgid "32 bit SPARC."
7134 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
7139 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
7140 msgid "64 bit SPARC V9 and above."
7144 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
7149 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
7150 msgid "Intel Itanium."
7154 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
7159 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
7160 msgid "32 bit Power PC."
7164 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
7169 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
7170 msgid "64 bit Power PC."
7174 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
7175 msgid "Libguestfs may return other architecture strings in future."
7179 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
7180 msgid "The function works on at least the following types of files:"
7184 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
7185 msgid "many types of Un*x and Linux binary"
7189 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
7190 msgid "many types of Un*x and Linux shared library"
7194 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
7195 msgid "Windows Win32 and Win64 binaries"
7199 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
7200 msgid "Windows Win32 and Win64 DLLs"
7204 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
7205 msgid "Win32 binaries and DLLs return C<i386>."
7209 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
7210 msgid "Win64 binaries and DLLs return C<x86_64>."
7214 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
7215 msgid "Linux kernel modules"
7219 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
7220 msgid "Linux new-style initrd images"
7224 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
7225 msgid "some non-x86 Linux vmlinuz kernels"
7229 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
7230 msgid "What it can't do currently:"
7234 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
7235 msgid "static libraries (libfoo.a)"
7239 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
7240 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7244 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
7245 msgid "x86 Linux vmlinuz kernels"
7249 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
7251 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7252 "compressed code, and are horribly hard to unpack. If you want to find the "
7253 "architecture of a kernel, use the architecture of the associated initrd or "
7254 "kernel module(s) instead."
7258 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810
7259 #: ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478
7260 #: ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585
7261 #: ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653
7262 #: ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766
7263 #: ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997
7264 #: ../src/guestfs-actions.pod:3129
7265 msgid "(Added in 1.5.3)"
7269 #: ../src/guestfs-actions.pod:1649
7270 msgid "guestfs_filesize"
7274 #: ../src/guestfs-actions.pod:1651
7278 " guestfs_filesize (guestfs_h *g,\n"
7279 " const char *file);\n"
7284 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
7285 msgid "This command returns the size of C<file> in bytes."
7289 #: ../src/guestfs-actions.pod:1657
7291 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7292 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7293 "devices, use C<guestfs_blockdev_getsize64>."
7297 #: ../src/guestfs-actions.pod:1663
7298 msgid "(Added in 1.0.82)"
7302 #: ../src/guestfs-actions.pod:1665
7303 msgid "guestfs_fill"
7307 #: ../src/guestfs-actions.pod:1667
7311 " guestfs_fill (guestfs_h *g,\n"
7314 " const char *path);\n"
7319 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
7321 "This command creates a new file called C<path>. The initial content of the "
7322 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7327 #: ../src/guestfs-actions.pod:1677
7329 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7330 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7331 "bytes use C<guestfs_fill_pattern>."
7335 #: ../src/guestfs-actions.pod:1689
7336 msgid "(Added in 1.0.79)"
7340 #: ../src/guestfs-actions.pod:1691
7341 msgid "guestfs_fill_pattern"
7345 #: ../src/guestfs-actions.pod:1693
7349 " guestfs_fill_pattern (guestfs_h *g,\n"
7350 " const char *pattern,\n"
7352 " const char *path);\n"
7357 #: ../src/guestfs-actions.pod:1699
7359 "This function is like C<guestfs_fill> except that it creates a new file of "
7360 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7361 "pattern is truncated if necessary to ensure the length of the file is "
7362 "exactly C<len> bytes."
7366 #: ../src/guestfs-actions.pod:1711
7367 msgid "(Added in 1.3.12)"
7371 #: ../src/guestfs-actions.pod:1713
7372 msgid "guestfs_find"
7376 #: ../src/guestfs-actions.pod:1715
7380 " guestfs_find (guestfs_h *g,\n"
7381 " const char *directory);\n"
7386 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7388 "This command lists out all files and directories, recursively, starting at "
7389 "C<directory>. It is essentially equivalent to running the shell command "
7390 "C<find directory -print> but some post-processing happens on the output, "
7395 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7397 "This returns a list of strings I<without any prefix>. Thus if the directory "
7402 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7412 #: ../src/guestfs-actions.pod:1731
7414 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7418 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7429 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7430 msgid "If C<directory> is not a directory, then this command returns an error."
7434 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7435 msgid "The returned list is sorted."
7439 #: ../src/guestfs-actions.pod:1744
7440 msgid "See also C<guestfs_find0>."
7444 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788
7445 #: ../src/guestfs-actions.pod:5249
7446 msgid "(Added in 1.0.27)"
7450 #: ../src/guestfs-actions.pod:1755
7451 msgid "guestfs_find0"
7455 #: ../src/guestfs-actions.pod:1757
7459 " guestfs_find0 (guestfs_h *g,\n"
7460 " const char *directory,\n"
7461 " const char *files);\n"
7466 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7468 "This command lists out all files and directories, recursively, starting at "
7469 "C<directory>, placing the resulting list in the external file called "
7474 #: ../src/guestfs-actions.pod:1766
7476 "This command works the same way as C<guestfs_find> with the following "
7481 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7482 msgid "The resulting list is written to an external file."
7486 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7488 "Items (filenames) in the result are separated by C<\\0> characters. See "
7489 "L<find(1)> option I<-print0>."
7493 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7494 msgid "This command is not limited in the number of names that it can return."
7498 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7499 msgid "The result list is not sorted."
7503 #: ../src/guestfs-actions.pod:1793
7504 msgid "(Added in 1.0.74)"
7508 #: ../src/guestfs-actions.pod:1795
7509 msgid "guestfs_findfs_label"
7513 #: ../src/guestfs-actions.pod:1797
7517 " guestfs_findfs_label (guestfs_h *g,\n"
7518 " const char *label);\n"
7523 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7525 "This command searches the filesystems and returns the one which has the "
7526 "given label. An error is returned if no such filesystem can be found."
7530 #: ../src/guestfs-actions.pod:1805
7531 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7535 #: ../src/guestfs-actions.pod:1812
7536 msgid "guestfs_findfs_uuid"
7540 #: ../src/guestfs-actions.pod:1814
7544 " guestfs_findfs_uuid (guestfs_h *g,\n"
7545 " const char *uuid);\n"
7550 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7552 "This command searches the filesystems and returns the one which has the "
7553 "given UUID. An error is returned if no such filesystem can be found."
7557 #: ../src/guestfs-actions.pod:1822
7558 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7562 #: ../src/guestfs-actions.pod:1829
7563 msgid "guestfs_fsck"
7567 #: ../src/guestfs-actions.pod:1831
7571 " guestfs_fsck (guestfs_h *g,\n"
7572 " const char *fstype,\n"
7573 " const char *device);\n"
7578 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7580 "This runs the filesystem checker (fsck) on C<device> which should have "
7581 "filesystem type C<fstype>."
7585 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7587 "The returned integer is the status. See L<fsck(8)> for the list of status "
7588 "codes from C<fsck>."
7592 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7593 msgid "Multiple status codes can be summed together."
7597 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7599 "A non-zero return code can mean \"success\", for example if errors have been "
7600 "corrected on the filesystem."
7604 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7605 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7609 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7611 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7615 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7616 msgid "(Added in 1.0.16)"
7620 #: ../src/guestfs-actions.pod:1868
7621 msgid "guestfs_get_append"
7625 #: ../src/guestfs-actions.pod:1870
7629 " guestfs_get_append (guestfs_h *g);\n"
7634 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7636 "Return the additional kernel options which are added to the guest kernel "
7641 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7642 msgid "If C<NULL> then no options are added."
7646 #: ../src/guestfs-actions.pod:1878
7648 "This function returns a string which may be NULL. There is no way to return "
7649 "an error from this function. The string is owned by the guest handle and "
7650 "must I<not> be freed."
7654 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927
7655 #: ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758
7656 #: ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793
7657 #: ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557
7658 #: ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7659 msgid "(Added in 1.0.26)"
7663 #: ../src/guestfs-actions.pod:1884
7664 msgid "guestfs_get_autosync"
7668 #: ../src/guestfs-actions.pod:1886
7672 " guestfs_get_autosync (guestfs_h *g);\n"
7677 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7678 msgid "Get the autosync flag."
7682 #: ../src/guestfs-actions.pod:1895
7683 msgid "guestfs_get_direct"
7687 #: ../src/guestfs-actions.pod:1897
7691 " guestfs_get_direct (guestfs_h *g);\n"
7696 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7697 msgid "Return the direct appliance mode flag."
7701 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7702 msgid "(Added in 1.0.72)"
7706 #: ../src/guestfs-actions.pod:1906
7707 msgid "guestfs_get_e2label"
7711 #: ../src/guestfs-actions.pod:1908
7715 " guestfs_get_e2label (guestfs_h *g,\n"
7716 " const char *device);\n"
7721 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7723 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7727 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7729 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7733 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946
7734 #: ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7735 msgid "(Added in 1.0.15)"
7739 #: ../src/guestfs-actions.pod:1927
7740 msgid "guestfs_get_e2uuid"
7744 #: ../src/guestfs-actions.pod:1929
7748 " guestfs_get_e2uuid (guestfs_h *g,\n"
7749 " const char *device);\n"
7754 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7756 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7760 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7762 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7766 #: ../src/guestfs-actions.pod:1948
7767 msgid "guestfs_get_memsize"
7771 #: ../src/guestfs-actions.pod:1950
7775 " guestfs_get_memsize (guestfs_h *g);\n"
7780 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7782 "This gets the memory size in megabytes allocated to the qemu subprocess."
7786 #: ../src/guestfs-actions.pod:1956
7788 "If C<guestfs_set_memsize> was not called on this handle, and if "
7789 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7790 "value for memsize."
7794 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041
7795 #: ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591
7796 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7797 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7799 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7803 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079
7804 #: ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213
7805 #: ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244
7806 #: ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274
7807 #: ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489
7808 #: ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7809 msgid "(Added in 1.0.55)"
7813 #: ../src/guestfs-actions.pod:1967
7814 msgid "guestfs_get_network"
7818 #: ../src/guestfs-actions.pod:1969
7822 " guestfs_get_network (guestfs_h *g);\n"
7827 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7828 msgid "This returns the enable network flag."
7832 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7833 msgid "(Added in 1.5.4)"
7837 #: ../src/guestfs-actions.pod:1978
7838 msgid "guestfs_get_path"
7842 #: ../src/guestfs-actions.pod:1980
7846 " guestfs_get_path (guestfs_h *g);\n"
7851 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7852 msgid "Return the current search path."
7856 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7858 "This is always non-NULL. If it wasn't set already, then this will return "
7863 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7865 "This function returns a string, or NULL on error. The string is owned by "
7866 "the guest handle and must I<not> be freed."
7870 #: ../src/guestfs-actions.pod:1993
7871 msgid "guestfs_get_pid"
7875 #: ../src/guestfs-actions.pod:1995
7879 " guestfs_get_pid (guestfs_h *g);\n"
7884 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7886 "Return the process ID of the qemu subprocess. If there is no qemu "
7887 "subprocess, then this will return an error."
7891 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7892 msgid "This is an internal call used for debugging and testing."
7896 #: ../src/guestfs-actions.pod:2005
7897 msgid "(Added in 1.0.56)"
7901 #: ../src/guestfs-actions.pod:2007
7902 msgid "guestfs_get_qemu"
7906 #: ../src/guestfs-actions.pod:2009
7910 " guestfs_get_qemu (guestfs_h *g);\n"
7915 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7916 msgid "Return the current qemu binary."
7920 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7922 "This is always non-NULL. If it wasn't set already, then this will return "
7923 "the default qemu binary name."
7927 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7928 msgid "(Added in 1.0.6)"
7932 #: ../src/guestfs-actions.pod:2022
7933 msgid "guestfs_get_recovery_proc"
7937 #: ../src/guestfs-actions.pod:2024
7941 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7946 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7947 msgid "Return the recovery process enabled flag."
7951 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219
7952 #: ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886
7953 #: ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857
7954 #: ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577
7955 #: ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256
7956 #: ../src/guestfs-actions.pod:6438
7957 msgid "(Added in 1.0.77)"
7961 #: ../src/guestfs-actions.pod:2033
7962 msgid "guestfs_get_selinux"
7966 #: ../src/guestfs-actions.pod:2035
7970 " guestfs_get_selinux (guestfs_h *g);\n"
7975 #: ../src/guestfs-actions.pod:2038
7977 "This returns the current setting of the selinux flag which is passed to the "
7978 "appliance at boot time. See C<guestfs_set_selinux>."
7982 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109
7983 #: ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7984 msgid "(Added in 1.0.67)"
7988 #: ../src/guestfs-actions.pod:2048
7989 msgid "guestfs_get_state"
7993 #: ../src/guestfs-actions.pod:2050
7997 " guestfs_get_state (guestfs_h *g);\n"
8002 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
8004 "This returns the current state as an opaque integer. This is only useful "
8005 "for printing debug and internal error messages."
8009 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022
8010 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112
8011 #: ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:1398
8012 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8013 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8014 msgid "For more information on states, see L<guestfs(3)>."
8018 #: ../src/guestfs-actions.pod:2062
8019 msgid "guestfs_get_trace"
8023 #: ../src/guestfs-actions.pod:2064
8027 " guestfs_get_trace (guestfs_h *g);\n"
8032 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
8033 msgid "Return the command trace flag."
8037 #: ../src/guestfs-actions.pod:2073
8038 msgid "guestfs_get_umask"
8042 #: ../src/guestfs-actions.pod:2075
8046 " guestfs_get_umask (guestfs_h *g);\n"
8051 #: ../src/guestfs-actions.pod:2078
8053 "Return the current umask. By default the umask is C<022> unless it has been "
8054 "set by calling C<guestfs_umask>."
8058 #: ../src/guestfs-actions.pod:2085
8059 msgid "guestfs_get_verbose"
8063 #: ../src/guestfs-actions.pod:2087
8067 " guestfs_get_verbose (guestfs_h *g);\n"
8072 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
8073 msgid "This returns the verbose messages flag."
8077 #: ../src/guestfs-actions.pod:2096
8078 msgid "guestfs_getcon"
8082 #: ../src/guestfs-actions.pod:2098
8086 " guestfs_getcon (guestfs_h *g);\n"
8091 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
8092 msgid "This gets the SELinux security context of the daemon."
8096 #: ../src/guestfs-actions.pod:2103
8098 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8102 #: ../src/guestfs-actions.pod:2111
8103 msgid "guestfs_getxattrs"
8107 #: ../src/guestfs-actions.pod:2113
8110 " struct guestfs_xattr_list *\n"
8111 " guestfs_getxattrs (guestfs_h *g,\n"
8112 " const char *path);\n"
8117 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
8119 "This call lists the extended attributes of the file or directory C<path>."
8123 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
8125 "At the system call level, this is a combination of the L<listxattr(2)> and "
8126 "L<getxattr(2)> calls."
8130 #: ../src/guestfs-actions.pod:2123
8131 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8135 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231
8136 #: ../src/guestfs-actions.pod:3882
8138 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8139 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8143 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235
8144 #: ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436
8145 #: ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669
8146 #: ../src/guestfs-actions.pod:6994
8147 msgid "(Added in 1.0.59)"
8151 #: ../src/guestfs-actions.pod:2131
8152 msgid "guestfs_glob_expand"
8156 #: ../src/guestfs-actions.pod:2133
8160 " guestfs_glob_expand (guestfs_h *g,\n"
8161 " const char *pattern);\n"
8166 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
8168 "This command searches for all the pathnames matching C<pattern> according to "
8169 "the wildcard expansion rules used by the shell."
8173 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
8175 "If no paths match, then this returns an empty list (note: not an error)."
8179 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
8181 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8182 "GLOB_BRACE>. See that manual page for more details."
8186 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834
8187 #: ../src/guestfs-actions.pod:5851
8188 msgid "(Added in 1.0.50)"
8192 #: ../src/guestfs-actions.pod:2154
8193 msgid "guestfs_grep"
8197 #: ../src/guestfs-actions.pod:2156
8201 " guestfs_grep (guestfs_h *g,\n"
8202 " const char *regex,\n"
8203 " const char *path);\n"
8208 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
8209 msgid "This calls the external C<grep> program and returns the matching lines."
8213 #: ../src/guestfs-actions.pod:2173
8214 msgid "guestfs_grepi"
8218 #: ../src/guestfs-actions.pod:2175
8222 " guestfs_grepi (guestfs_h *g,\n"
8223 " const char *regex,\n"
8224 " const char *path);\n"
8229 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
8231 "This calls the external C<grep -i> program and returns the matching lines."
8235 #: ../src/guestfs-actions.pod:2192
8236 msgid "guestfs_grub_install"
8240 #: ../src/guestfs-actions.pod:2194
8244 " guestfs_grub_install (guestfs_h *g,\n"
8245 " const char *root,\n"
8246 " const char *device);\n"
8251 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
8253 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8254 "the root directory being C<root>."
8258 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
8260 "Note: If grub-install reports the error \"No suitable drive was found in the "
8261 "generated device map.\" it may be that you need to create a C</boot/grub/"
8262 "device.map> file first that contains the mapping between grub device names "
8263 "and Linux device names. It is usually sufficient to create a file "
8268 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
8276 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
8277 msgid "replacing C</dev/vda> with the name of the installation device."
8281 #: ../src/guestfs-actions.pod:2215
8282 msgid "(Added in 1.0.17)"
8286 #: ../src/guestfs-actions.pod:2217
8287 msgid "guestfs_head"
8291 #: ../src/guestfs-actions.pod:2219
8295 " guestfs_head (guestfs_h *g,\n"
8296 " const char *path);\n"
8301 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
8303 "This command returns up to the first 10 lines of a file as a list of strings."
8307 #: ../src/guestfs-actions.pod:2235
8308 msgid "guestfs_head_n"
8312 #: ../src/guestfs-actions.pod:2237
8316 " guestfs_head_n (guestfs_h *g,\n"
8318 " const char *path);\n"
8323 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
8325 "If the parameter C<nrlines> is a positive number, this returns the first "
8326 "C<nrlines> lines of the file C<path>."
8330 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
8332 "If the parameter C<nrlines> is a negative number, this returns lines from "
8333 "the file C<path>, excluding the last C<nrlines> lines."
8337 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131
8338 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8339 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8343 #: ../src/guestfs-actions.pod:2259
8344 msgid "guestfs_hexdump"
8348 #: ../src/guestfs-actions.pod:2261
8352 " guestfs_hexdump (guestfs_h *g,\n"
8353 " const char *path);\n"
8358 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
8360 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8361 "readable, canonical hex dump of the file."
8365 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915
8366 #: ../src/guestfs-actions.pod:5970
8367 msgid "(Added in 1.0.22)"
8371 #: ../src/guestfs-actions.pod:2276
8372 msgid "guestfs_initrd_cat"
8376 #: ../src/guestfs-actions.pod:2278
8380 " guestfs_initrd_cat (guestfs_h *g,\n"
8381 " const char *initrdpath,\n"
8382 " const char *filename,\n"
8383 " size_t *size_r);\n"
8388 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
8390 "This command unpacks the file C<filename> from the initrd file called "
8391 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8396 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
8398 "For example, in guestfish you could use the following command to examine the "
8399 "boot script (usually called C</init>) contained in a Linux initrd or "
8404 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
8407 " initrd-cat /boot/initrd-<version>.img init\n"
8412 #: ../src/guestfs-actions.pod:2294
8413 msgid "See also C<guestfs_initrd_list>."
8417 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850
8418 #: ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8420 "This function returns a buffer, or NULL on error. The size of the returned "
8421 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8426 #: ../src/guestfs-actions.pod:2305
8427 msgid "guestfs_initrd_list"
8431 #: ../src/guestfs-actions.pod:2307
8435 " guestfs_initrd_list (guestfs_h *g,\n"
8436 " const char *path);\n"
8441 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8442 msgid "This command lists out files contained in an initrd."
8446 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8448 "The files are listed without any initial C</> character. The files are "
8449 "listed in the order they appear (not necessarily alphabetical). Directory "
8450 "names are listed as separate items."
8454 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8456 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8457 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8462 #: ../src/guestfs-actions.pod:2327
8463 msgid "guestfs_inotify_add_watch"
8467 #: ../src/guestfs-actions.pod:2329
8471 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8472 " const char *path,\n"
8478 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8479 msgid "Watch C<path> for the events listed in C<mask>."
8483 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8485 "Note that if C<path> is a directory then events within that directory are "
8486 "watched, but this does I<not> happen recursively (in subdirectories)."
8490 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8492 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8493 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8497 #: ../src/guestfs-actions.pod:2348
8498 msgid "guestfs_inotify_close"
8502 #: ../src/guestfs-actions.pod:2350
8506 " guestfs_inotify_close (guestfs_h *g);\n"
8511 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8513 "This closes the inotify handle which was previously opened by inotify_init. "
8514 "It removes all watches, throws away any pending events, and deallocates all "
8519 #: ../src/guestfs-actions.pod:2361
8520 msgid "guestfs_inotify_files"
8524 #: ../src/guestfs-actions.pod:2363
8528 " guestfs_inotify_files (guestfs_h *g);\n"
8533 #: ../src/guestfs-actions.pod:2366
8535 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8536 "returns a list of pathnames of objects that were touched. The returned "
8537 "pathnames are sorted and deduplicated."
8541 #: ../src/guestfs-actions.pod:2376
8542 msgid "guestfs_inotify_init"
8546 #: ../src/guestfs-actions.pod:2378
8550 " guestfs_inotify_init (guestfs_h *g,\n"
8551 " int maxevents);\n"
8556 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8558 "This command creates a new inotify handle. The inotify subsystem can be "
8559 "used to notify events which happen to objects in the guest filesystem."
8563 #: ../src/guestfs-actions.pod:2386
8565 "C<maxevents> is the maximum number of events which will be queued up between "
8566 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8567 "passed as C<0>, then the kernel (or previously set) default is used. For "
8568 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8569 "throws away events, but records the fact that it threw them away by setting "
8570 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8571 "C<guestfs_inotify_read>)."
8575 #: ../src/guestfs-actions.pod:2396
8577 "Before any events are generated, you have to add some watches to the "
8578 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8579 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8583 #: ../src/guestfs-actions.pod:2402
8585 "Queued up events should be read periodically by calling "
8586 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8587 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8588 "often enough then you risk the internal queue overflowing."
8592 #: ../src/guestfs-actions.pod:2409
8594 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8595 "This also removes any watches automatically."
8599 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8601 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8602 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8603 "that there is one global inotify handle per libguestfs instance."
8607 #: ../src/guestfs-actions.pod:2422
8608 msgid "guestfs_inotify_read"
8612 #: ../src/guestfs-actions.pod:2424
8615 " struct guestfs_inotify_event_list *\n"
8616 " guestfs_inotify_read (guestfs_h *g);\n"
8621 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8623 "Return the complete queue of events that have happened since the previous "
8628 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8629 msgid "If no events have happened, this returns an empty list."
8633 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8635 "I<Note>: In order to make sure that all events have been read, you must call "
8636 "this function repeatedly until it returns an empty list. The reason is that "
8637 "the call will read events up to the maximum appliance-to-host message size "
8638 "and leave remaining events in the queue."
8642 #: ../src/guestfs-actions.pod:2438
8644 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8645 "there was an error. I<The caller must call "
8646 "C<guestfs_free_inotify_event_list> after use>."
8650 #: ../src/guestfs-actions.pod:2444
8651 msgid "guestfs_inotify_rm_watch"
8655 #: ../src/guestfs-actions.pod:2446
8659 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8665 #: ../src/guestfs-actions.pod:2450
8667 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8671 #: ../src/guestfs-actions.pod:2457
8672 msgid "guestfs_inspect_get_arch"
8676 #: ../src/guestfs-actions.pod:2459
8680 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8681 " const char *root);\n"
8686 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486
8687 #: ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593
8688 #: ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640
8689 #: ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694
8690 #: ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750
8691 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834
8692 #: ../src/guestfs-actions.pod:2857
8694 "This function should only be called with a root device string as returned by "
8695 "C<guestfs_inspect_os>."
8699 #: ../src/guestfs-actions.pod:2466
8701 "This returns the architecture of the inspected operating system. The "
8702 "possible return values are listed under C<guestfs_file_architecture>."
8706 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8708 "If the architecture could not be determined, then the string C<unknown> is "
8713 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554
8714 #: ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628
8715 #: ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739
8716 #: ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780
8717 #: ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844
8718 #: ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989
8719 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8720 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8721 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8722 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8723 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8724 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8725 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8729 #: ../src/guestfs-actions.pod:2480
8730 msgid "guestfs_inspect_get_distro"
8734 #: ../src/guestfs-actions.pod:2482
8738 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8739 " const char *root);\n"
8744 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8746 "This returns the distro (distribution) of the inspected operating system."
8750 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8751 msgid "Currently defined distros are:"
8755 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8756 msgid "\"archlinux\""
8760 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8765 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8770 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8775 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8780 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8785 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8790 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8795 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8796 msgid "\"linuxmint\""
8800 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8805 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8806 msgid "\"mandriva\""
8810 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8815 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8820 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8825 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8830 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8835 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8836 msgid "\"redhat-based\""
8840 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8841 msgid "Some Red Hat-derived distro."
8845 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8850 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8851 msgid "Red Hat Enterprise Linux and some derivatives."
8855 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8860 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8865 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812
8866 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8871 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8872 msgid "The distro could not be determined."
8876 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804
8877 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8882 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8884 "Windows does not have distributions. This string is returned if the OS type "
8889 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818
8890 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8892 "Future versions of libguestfs may return other strings here. The caller "
8893 "should be prepared to handle any string."
8897 #: ../src/guestfs-actions.pod:2561
8898 msgid "guestfs_inspect_get_filesystems"
8902 #: ../src/guestfs-actions.pod:2563
8906 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8907 " const char *root);\n"
8912 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8914 "This returns a list of all the filesystems that we think are associated with "
8915 "this operating system. This includes the root filesystem, other ordinary "
8916 "filesystems, and non-mounted devices like swap partitions."
8920 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8922 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8923 "to be shared between operating systems."
8927 #: ../src/guestfs-actions.pod:2578
8929 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8930 "C<guestfs_inspect_get_mountpoints>."
8934 #: ../src/guestfs-actions.pod:2587
8935 msgid "guestfs_inspect_get_hostname"
8939 #: ../src/guestfs-actions.pod:2589
8943 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8944 " const char *root);\n"
8949 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8951 "This function returns the hostname of the operating system as found by "
8952 "inspection of the guest's configuration files."
8956 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8958 "If the hostname could not be determined, then the string C<unknown> is "
8963 #: ../src/guestfs-actions.pod:2607
8964 msgid "guestfs_inspect_get_major_version"
8968 #: ../src/guestfs-actions.pod:2609
8972 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8973 " const char *root);\n"
8978 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8980 "This returns the major version number of the inspected operating system."
8984 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
8986 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8987 "popular public names used by the operating system. Notably the operating "
8988 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8989 "1). You can find out the real versions corresponding to releases of Windows "
8990 "by consulting Wikipedia or MSDN."
8994 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646
8995 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8996 msgid "If the version could not be determined, then C<0> is returned."
9000 #: ../src/guestfs-actions.pod:2634
9001 msgid "guestfs_inspect_get_minor_version"
9005 #: ../src/guestfs-actions.pod:2636
9009 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9010 " const char *root);\n"
9015 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
9017 "This returns the minor version number of the inspected operating system."
9021 #: ../src/guestfs-actions.pod:2648
9023 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9024 "C<guestfs_inspect_get_major_version>."
9028 #: ../src/guestfs-actions.pod:2655
9029 msgid "guestfs_inspect_get_mountpoints"
9033 #: ../src/guestfs-actions.pod:2657
9037 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9038 " const char *root);\n"
9043 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
9045 "This returns a hash of where we think the filesystems associated with this "
9046 "operating system should be mounted. Callers should note that this is at "
9047 "best an educated guess made by reading configuration files such as C</etc/"
9052 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
9054 "Each element in the returned hashtable has a key which is the path of the "
9055 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9056 "mounted there (eg. C</dev/sda1>)."
9060 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
9062 "Non-mounted devices such as swap devices are I<not> returned in this list."
9066 #: ../src/guestfs-actions.pod:2677
9068 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9069 "C<guestfs_inspect_get_filesystems>."
9073 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288
9074 #: ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
9076 "This function returns a NULL-terminated array of strings, or NULL if there "
9077 "was an error. The array of strings will always have length C<2n+1>, where "
9078 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9079 "caller must free the strings and the array after use>."
9083 #: ../src/guestfs-actions.pod:2688
9084 msgid "guestfs_inspect_get_package_format"
9088 #: ../src/guestfs-actions.pod:2690
9092 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9093 " const char *root);\n"
9098 #: ../src/guestfs-actions.pod:2697
9100 "This function and C<guestfs_inspect_get_package_management> return the "
9101 "package format and package management tool used by the inspected operating "
9102 "system. For example for Fedora these functions would return C<rpm> (package "
9103 "format) and C<yum> (package management)."
9107 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
9109 "This returns the string C<unknown> if we could not determine the package "
9110 "format I<or> if the operating system does not have a real packaging system "
9115 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
9117 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9118 "Future versions of libguestfs may return other strings."
9122 #: ../src/guestfs-actions.pod:2715
9123 msgid "guestfs_inspect_get_package_management"
9127 #: ../src/guestfs-actions.pod:2717
9131 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9132 " const char *root);\n"
9137 #: ../src/guestfs-actions.pod:2724
9139 "C<guestfs_inspect_get_package_format> and this function return the package "
9140 "format and package management tool used by the inspected operating system. "
9141 "For example for Fedora these functions would return C<rpm> (package format) "
9142 "and C<yum> (package management)."
9146 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
9148 "This returns the string C<unknown> if we could not determine the package "
9149 "management tool I<or> if the operating system does not have a real packaging "
9150 "system (eg. Windows)."
9154 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
9156 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9157 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9158 "libguestfs may return other strings."
9162 #: ../src/guestfs-actions.pod:2744
9163 msgid "guestfs_inspect_get_product_name"
9167 #: ../src/guestfs-actions.pod:2746
9171 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9172 " const char *root);\n"
9177 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
9179 "This returns the product name of the inspected operating system. The "
9180 "product name is generally some freeform string which can be displayed to the "
9181 "user, but should not be parsed by programs."
9185 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
9187 "If the product name could not be determined, then the string C<unknown> is "
9192 #: ../src/guestfs-actions.pod:2768
9193 msgid "guestfs_inspect_get_roots"
9197 #: ../src/guestfs-actions.pod:2770
9201 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9206 #: ../src/guestfs-actions.pod:2773
9208 "This function is a convenient way to get the list of root devices, as "
9209 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9210 "the whole inspection process."
9214 #: ../src/guestfs-actions.pod:2777
9216 "This returns an empty list if either no root devices were found or the "
9217 "caller has not called C<guestfs_inspect_os>."
9221 #: ../src/guestfs-actions.pod:2786
9222 msgid "guestfs_inspect_get_type"
9226 #: ../src/guestfs-actions.pod:2788
9230 " guestfs_inspect_get_type (guestfs_h *g,\n"
9231 " const char *root);\n"
9236 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
9238 "This returns the type of the inspected operating system. Currently defined "
9243 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
9248 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
9249 msgid "Any Linux-based operating system."
9253 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
9254 msgid "Any Microsoft Windows operating system."
9258 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
9263 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
9268 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
9269 msgid "The operating system type could not be determined."
9273 #: ../src/guestfs-actions.pod:2828
9274 msgid "guestfs_inspect_get_windows_systemroot"
9278 #: ../src/guestfs-actions.pod:2830
9282 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9283 " const char *root);\n"
9288 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
9290 "This returns the Windows systemroot of the inspected guest. The systemroot "
9291 "is a directory path such as C</WINDOWS>."
9295 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
9297 "This call assumes that the guest is Windows and that the systemroot could be "
9298 "determined by inspection. If this is not the case then an error is returned."
9302 #: ../src/guestfs-actions.pod:2849
9303 msgid "(Added in 1.5.25)"
9307 #: ../src/guestfs-actions.pod:2851
9308 msgid "guestfs_inspect_list_applications"
9312 #: ../src/guestfs-actions.pod:2853
9315 " struct guestfs_application_list *\n"
9316 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9317 " const char *root);\n"
9322 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
9323 msgid "Return the list of applications installed in the operating system."
9327 #: ../src/guestfs-actions.pod:2862
9329 "I<Note:> This call works differently from other parts of the inspection "
9330 "API. You have to call C<guestfs_inspect_os>, then "
9331 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9332 "this. Listing applications is a significantly more difficult operation "
9333 "which requires access to the full filesystem. Also note that unlike the "
9334 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9335 "the libguestfs handle, this call actually reads parts of the mounted "
9336 "filesystems during the call."
9340 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
9342 "This returns an empty list if the inspection code was not able to determine "
9343 "the list of applications."
9347 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
9348 msgid "The application structure contains the following fields:"
9352 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
9357 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
9359 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9360 "guests, this is the package name."
9364 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
9365 msgid "C<app_display_name>"
9369 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
9371 "The display name of the application, sometimes localized to the install "
9372 "language of the guest operating system."
9376 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
9378 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9379 "to display something can use C<app_name> instead."
9383 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
9384 msgid "C<app_epoch>"
9388 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
9390 "For package managers which use epochs, this contains the epoch of the "
9391 "package (an integer). If unavailable, this is returned as C<0>."
9395 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
9396 msgid "C<app_version>"
9400 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
9402 "The version string of the application or package. If unavailable this is "
9403 "returned as an empty string C<\"\">."
9407 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
9408 msgid "C<app_release>"
9412 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
9414 "The release string of the application or package, for package managers that "
9415 "use this. If unavailable this is returned as an empty string C<\"\">."
9419 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
9420 msgid "C<app_install_path>"
9424 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
9426 "The installation path of the application (on operating systems such as "
9427 "Windows which use installation paths). This path is in the format used by "
9428 "the guest operating system, it is not a libguestfs path."
9432 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
9433 msgid "If unavailable this is returned as an empty string C<\"\">."
9437 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
9438 msgid "C<app_trans_path>"
9442 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9444 "The install path translated into a libguestfs path. If unavailable this is "
9445 "returned as an empty string C<\"\">."
9449 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9450 msgid "C<app_publisher>"
9454 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9456 "The name of the publisher of the application, for package managers that use "
9457 "this. If unavailable this is returned as an empty string C<\"\">."
9461 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9466 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9468 "The URL (eg. upstream URL) of the application. If unavailable this is "
9469 "returned as an empty string C<\"\">."
9473 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9474 msgid "C<app_source_package>"
9478 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9480 "For packaging systems which support this, the name of the source package. "
9481 "If unavailable this is returned as an empty string C<\"\">."
9485 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9486 msgid "C<app_summary>"
9490 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9492 "A short (usually one line) description of the application or package. If "
9493 "unavailable this is returned as an empty string C<\"\">."
9497 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9498 msgid "C<app_description>"
9502 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9504 "A longer description of the application or package. If unavailable this is "
9505 "returned as an empty string C<\"\">."
9509 #: ../src/guestfs-actions.pod:2952
9511 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9512 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9517 #: ../src/guestfs-actions.pod:2956
9518 msgid "guestfs_inspect_os"
9522 #: ../src/guestfs-actions.pod:2958
9526 " guestfs_inspect_os (guestfs_h *g);\n"
9531 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9533 "This function uses other libguestfs functions and certain heuristics to "
9534 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9535 "for operating systems."
9539 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9540 msgid "The list returned is empty if no operating systems were found."
9544 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9546 "If one operating system was found, then this returns a list with a single "
9547 "element, which is the name of the root filesystem of this operating system. "
9548 "It is also possible for this function to return a list containing more than "
9549 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9550 "element being the root filesystem of one of the operating systems."
9554 #: ../src/guestfs-actions.pod:2974
9556 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9557 "functions in order to query further information about each operating system, "
9558 "such as the name and version."
9562 #: ../src/guestfs-actions.pod:2979
9564 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9565 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9566 "the contents. This should be called with no disks currently mounted. The "
9567 "function may also use Augeas, so any existing Augeas handle will be closed."
9571 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9573 "This function cannot decrypt encrypted disks. The caller must do that first "
9574 "(supplying the necessary keys) if the disk is encrypted."
9578 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246
9579 #: ../src/guestfs-actions.pod:3308
9580 msgid "See also C<guestfs_list_filesystems>."
9584 #: ../src/guestfs-actions.pod:2999
9585 msgid "guestfs_is_blockdev"
9589 #: ../src/guestfs-actions.pod:3001
9593 " guestfs_is_blockdev (guestfs_h *g,\n"
9594 " const char *path);\n"
9599 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9601 "This returns C<true> if and only if there is a block device with the given "
9606 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037
9607 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082
9608 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154
9609 #: ../src/guestfs-actions.pod:3169
9610 msgid "See also C<guestfs_stat>."
9614 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041
9615 #: ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158
9616 #: ../src/guestfs-actions.pod:3173
9617 msgid "(Added in 1.5.10)"
9621 #: ../src/guestfs-actions.pod:3014
9622 msgid "guestfs_is_busy"
9626 #: ../src/guestfs-actions.pod:3016
9630 " guestfs_is_busy (guestfs_h *g);\n"
9635 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9637 "This returns true iff this handle is busy processing a command (in the "
9642 #: ../src/guestfs-actions.pod:3028
9643 msgid "guestfs_is_chardev"
9647 #: ../src/guestfs-actions.pod:3030
9651 " guestfs_is_chardev (guestfs_h *g,\n"
9652 " const char *path);\n"
9657 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9659 "This returns C<true> if and only if there is a character device with the "
9660 "given C<path> name."
9664 #: ../src/guestfs-actions.pod:3043
9665 msgid "guestfs_is_config"
9669 #: ../src/guestfs-actions.pod:3045
9673 " guestfs_is_config (guestfs_h *g);\n"
9678 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9680 "This returns true iff this handle is being configured (in the C<CONFIG> "
9685 #: ../src/guestfs-actions.pod:3057
9686 msgid "guestfs_is_dir"
9690 #: ../src/guestfs-actions.pod:3059
9694 " guestfs_is_dir (guestfs_h *g,\n"
9695 " const char *path);\n"
9700 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9702 "This returns C<true> if and only if there is a directory with the given "
9703 "C<path> name. Note that it returns false for other objects like files."
9707 #: ../src/guestfs-actions.pod:3073
9708 msgid "guestfs_is_fifo"
9712 #: ../src/guestfs-actions.pod:3075
9716 " guestfs_is_fifo (guestfs_h *g,\n"
9717 " const char *path);\n"
9722 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9724 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9725 "given C<path> name."
9729 #: ../src/guestfs-actions.pod:3088
9730 msgid "guestfs_is_file"
9734 #: ../src/guestfs-actions.pod:3090
9738 " guestfs_is_file (guestfs_h *g,\n"
9739 " const char *path);\n"
9744 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9746 "This returns C<true> if and only if there is a regular file with the given "
9747 "C<path> name. Note that it returns false for other objects like directories."
9751 #: ../src/guestfs-actions.pod:3104
9752 msgid "guestfs_is_launching"
9756 #: ../src/guestfs-actions.pod:3106
9760 " guestfs_is_launching (guestfs_h *g);\n"
9765 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9767 "This returns true iff this handle is launching the subprocess (in the "
9768 "C<LAUNCHING> state)."
9772 #: ../src/guestfs-actions.pod:3118
9773 msgid "guestfs_is_lv"
9777 #: ../src/guestfs-actions.pod:3120
9781 " guestfs_is_lv (guestfs_h *g,\n"
9782 " const char *device);\n"
9787 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9789 "This command tests whether C<device> is a logical volume, and returns true "
9790 "iff this is the case."
9794 #: ../src/guestfs-actions.pod:3131
9795 msgid "guestfs_is_ready"
9799 #: ../src/guestfs-actions.pod:3133
9803 " guestfs_is_ready (guestfs_h *g);\n"
9808 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9810 "This returns true iff this handle is ready to accept commands (in the "
9815 #: ../src/guestfs-actions.pod:3145
9816 msgid "guestfs_is_socket"
9820 #: ../src/guestfs-actions.pod:3147
9824 " guestfs_is_socket (guestfs_h *g,\n"
9825 " const char *path);\n"
9830 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9832 "This returns C<true> if and only if there is a Unix domain socket with the "
9833 "given C<path> name."
9837 #: ../src/guestfs-actions.pod:3160
9838 msgid "guestfs_is_symlink"
9842 #: ../src/guestfs-actions.pod:3162
9846 " guestfs_is_symlink (guestfs_h *g,\n"
9847 " const char *path);\n"
9852 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9854 "This returns C<true> if and only if there is a symbolic link with the given "
9859 #: ../src/guestfs-actions.pod:3175
9860 msgid "guestfs_kill_subprocess"
9864 #: ../src/guestfs-actions.pod:3177
9868 " guestfs_kill_subprocess (guestfs_h *g);\n"
9873 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9874 msgid "This kills the qemu subprocess. You should never need to call this."
9878 #: ../src/guestfs-actions.pod:3186
9879 msgid "guestfs_launch"
9883 #: ../src/guestfs-actions.pod:3188
9887 " guestfs_launch (guestfs_h *g);\n"
9892 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9894 "Internally libguestfs is implemented by running a virtual machine using "
9899 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9901 "You should call this after configuring the handle (eg. adding drives) but "
9902 "before performing any actions."
9906 #: ../src/guestfs-actions.pod:3201
9907 msgid "guestfs_lchown"
9911 #: ../src/guestfs-actions.pod:3203
9915 " guestfs_lchown (guestfs_h *g,\n"
9918 " const char *path);\n"
9923 #: ../src/guestfs-actions.pod:3209
9925 "Change the file owner to C<owner> and group to C<group>. This is like "
9926 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9927 "changed, not the target."
9931 #: ../src/guestfs-actions.pod:3221
9932 msgid "guestfs_lgetxattrs"
9936 #: ../src/guestfs-actions.pod:3223
9939 " struct guestfs_xattr_list *\n"
9940 " guestfs_lgetxattrs (guestfs_h *g,\n"
9941 " const char *path);\n"
9946 #: ../src/guestfs-actions.pod:3227
9948 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9949 "then it returns the extended attributes of the link itself."
9953 #: ../src/guestfs-actions.pod:3237
9954 msgid "guestfs_list_devices"
9958 #: ../src/guestfs-actions.pod:3239
9962 " guestfs_list_devices (guestfs_h *g);\n"
9967 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9968 msgid "List all the block devices."
9972 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9973 msgid "The full block device names are returned, eg. C</dev/sda>."
9977 #: ../src/guestfs-actions.pod:3254
9978 msgid "guestfs_list_filesystems"
9982 #: ../src/guestfs-actions.pod:3256
9986 " guestfs_list_filesystems (guestfs_h *g);\n"
9991 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
9993 "This inspection command looks for filesystems on partitions, block devices "
9994 "and logical volumes, returning a list of devices containing filesystems and "
9999 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
10001 "The return value is a hash, where the keys are the devices containing "
10002 "filesystems, and the values are the filesystem types. For example:"
10006 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
10009 " \"/dev/sda1\" => \"ntfs\"\n"
10010 " \"/dev/sda2\" => \"ext2\"\n"
10011 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10012 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10017 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
10019 "The value can have the special value \"unknown\", meaning the content of the "
10020 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10024 #: ../src/guestfs-actions.pod:3276
10026 "This command runs other libguestfs commands, which might include "
10027 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10028 "soon after launch and only when nothing is mounted."
10032 #: ../src/guestfs-actions.pod:3280
10034 "Not all of the filesystems returned will be mountable. In particular, swap "
10035 "partitions are returned in the list. Also this command does not check that "
10036 "each filesystem found is valid and mountable, and some filesystems might be "
10037 "mountable but require special options. Filesystems may not all belong to a "
10038 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10042 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
10043 msgid "(Added in 1.5.15)"
10047 #: ../src/guestfs-actions.pod:3296
10048 msgid "guestfs_list_partitions"
10052 #: ../src/guestfs-actions.pod:3298
10056 " guestfs_list_partitions (guestfs_h *g);\n"
10061 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
10062 msgid "List all the partitions detected on all block devices."
10066 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
10067 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10071 #: ../src/guestfs-actions.pod:3305
10073 "This does not return logical volumes. For that you will need to call "
10078 #: ../src/guestfs-actions.pod:3316
10083 #: ../src/guestfs-actions.pod:3318
10087 " guestfs_ll (guestfs_h *g,\n"
10088 " const char *directory);\n"
10093 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
10095 "List the files in C<directory> (relative to the root directory, there is no "
10096 "cwd) in the format of 'ls -la'."
10100 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
10102 "This command is mostly useful for interactive sessions. It is I<not> "
10103 "intended that you try to parse the output string."
10107 #: ../src/guestfs-actions.pod:3333
10112 #: ../src/guestfs-actions.pod:3335
10116 " guestfs_ln (guestfs_h *g,\n"
10117 " const char *target,\n"
10118 " const char *linkname);\n"
10123 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
10124 msgid "This command creates a hard link using the C<ln> command."
10128 #: ../src/guestfs-actions.pod:3346
10129 msgid "guestfs_ln_f"
10133 #: ../src/guestfs-actions.pod:3348
10137 " guestfs_ln_f (guestfs_h *g,\n"
10138 " const char *target,\n"
10139 " const char *linkname);\n"
10144 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
10146 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10147 "option removes the link (C<linkname>) if it exists already."
10151 #: ../src/guestfs-actions.pod:3360
10152 msgid "guestfs_ln_s"
10156 #: ../src/guestfs-actions.pod:3362
10160 " guestfs_ln_s (guestfs_h *g,\n"
10161 " const char *target,\n"
10162 " const char *linkname);\n"
10167 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
10168 msgid "This command creates a symbolic link using the C<ln -s> command."
10172 #: ../src/guestfs-actions.pod:3373
10173 msgid "guestfs_ln_sf"
10177 #: ../src/guestfs-actions.pod:3375
10181 " guestfs_ln_sf (guestfs_h *g,\n"
10182 " const char *target,\n"
10183 " const char *linkname);\n"
10188 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
10190 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10191 "option removes the link (C<linkname>) if it exists already."
10195 #: ../src/guestfs-actions.pod:3387
10196 msgid "guestfs_lremovexattr"
10200 #: ../src/guestfs-actions.pod:3389
10204 " guestfs_lremovexattr (guestfs_h *g,\n"
10205 " const char *xattr,\n"
10206 " const char *path);\n"
10211 #: ../src/guestfs-actions.pod:3394
10213 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10214 "link, then it removes an extended attribute of the link itself."
10218 #: ../src/guestfs-actions.pod:3402
10223 #: ../src/guestfs-actions.pod:3404
10227 " guestfs_ls (guestfs_h *g,\n"
10228 " const char *directory);\n"
10233 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
10235 "List the files in C<directory> (relative to the root directory, there is no "
10236 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10240 #: ../src/guestfs-actions.pod:3412
10242 "This command is mostly useful for interactive sessions. Programs should "
10243 "probably use C<guestfs_readdir> instead."
10247 #: ../src/guestfs-actions.pod:3421
10248 msgid "guestfs_lsetxattr"
10252 #: ../src/guestfs-actions.pod:3423
10256 " guestfs_lsetxattr (guestfs_h *g,\n"
10257 " const char *xattr,\n"
10258 " const char *val,\n"
10260 " const char *path);\n"
10265 #: ../src/guestfs-actions.pod:3430
10267 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10268 "then it sets an extended attribute of the link itself."
10272 #: ../src/guestfs-actions.pod:3438
10273 msgid "guestfs_lstat"
10277 #: ../src/guestfs-actions.pod:3440
10280 " struct guestfs_stat *\n"
10281 " guestfs_lstat (guestfs_h *g,\n"
10282 " const char *path);\n"
10287 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871
10288 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10289 msgid "Returns file information for the given C<path>."
10293 #: ../src/guestfs-actions.pod:3446
10295 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10296 "link, then the link is stat-ed, not the file it refers to."
10300 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
10301 msgid "This is the same as the C<lstat(2)> system call."
10305 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
10307 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10308 "error. I<The caller must call C<guestfs_free_stat> after use>."
10312 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879
10313 #: ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
10314 msgid "(Added in 0.9.2)"
10318 #: ../src/guestfs-actions.pod:3458
10319 msgid "guestfs_lstatlist"
10323 #: ../src/guestfs-actions.pod:3460
10326 " struct guestfs_stat_list *\n"
10327 " guestfs_lstatlist (guestfs_h *g,\n"
10328 " const char *path,\n"
10329 " char *const *names);\n"
10334 #: ../src/guestfs-actions.pod:3465
10336 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10337 "files, where all files are in the directory C<path>. C<names> is the list "
10338 "of files from this directory."
10342 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
10344 "On return you get a list of stat structs, with a one-to-one correspondence "
10345 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10346 "then the C<ino> field of that structure is set to C<-1>."
10350 #: ../src/guestfs-actions.pod:3474
10352 "This call is intended for programs that want to efficiently list a directory "
10353 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10354 "for a similarly efficient call for getting extended attributes. Very long "
10355 "directory listings might cause the protocol message size to be exceeded, "
10356 "causing this call to fail. The caller must split up such requests into "
10357 "smaller groups of names."
10361 #: ../src/guestfs-actions.pod:3482
10363 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10364 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10368 #: ../src/guestfs-actions.pod:3488
10369 msgid "guestfs_luks_add_key"
10373 #: ../src/guestfs-actions.pod:3490
10377 " guestfs_luks_add_key (guestfs_h *g,\n"
10378 " const char *device,\n"
10379 " const char *key,\n"
10380 " const char *newkey,\n"
10386 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
10388 "This command adds a new key on LUKS device C<device>. C<key> is any "
10389 "existing key, and is used to access the device. C<newkey> is the new key to "
10390 "add. C<keyslot> is the key slot that will be replaced."
10394 #: ../src/guestfs-actions.pod:3502
10396 "Note that if C<keyslot> already contains a key, then this command will "
10397 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10401 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548
10402 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591
10403 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
10405 "This function takes a key or passphrase parameter which could contain "
10406 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10411 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552
10412 #: ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
10413 msgid "(Added in 1.5.2)"
10417 #: ../src/guestfs-actions.pod:3514
10418 msgid "guestfs_luks_close"
10422 #: ../src/guestfs-actions.pod:3516
10426 " guestfs_luks_close (guestfs_h *g,\n"
10427 " const char *device);\n"
10432 #: ../src/guestfs-actions.pod:3520
10434 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10435 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10436 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10437 "underlying block device."
10441 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627
10442 #: ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696
10443 #: ../src/guestfs-actions.pod:3744
10444 msgid "(Added in 1.5.1)"
10448 #: ../src/guestfs-actions.pod:3530
10449 msgid "guestfs_luks_format"
10453 #: ../src/guestfs-actions.pod:3532
10457 " guestfs_luks_format (guestfs_h *g,\n"
10458 " const char *device,\n"
10459 " const char *key,\n"
10465 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10467 "This command erases existing data on C<device> and formats the device as a "
10468 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10469 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10473 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568
10474 #: ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568
10475 #: ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706
10476 #: ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755
10477 #: ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433
10478 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10479 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10480 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10481 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10483 "B<This command is dangerous. Without careful use you can easily destroy all "
10488 #: ../src/guestfs-actions.pod:3554
10489 msgid "guestfs_luks_format_cipher"
10493 #: ../src/guestfs-actions.pod:3556
10497 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10498 " const char *device,\n"
10499 " const char *key,\n"
10501 " const char *cipher);\n"
10506 #: ../src/guestfs-actions.pod:3563
10508 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10509 "set the C<cipher> used."
10513 #: ../src/guestfs-actions.pod:3577
10514 msgid "guestfs_luks_kill_slot"
10518 #: ../src/guestfs-actions.pod:3579
10522 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10523 " const char *device,\n"
10524 " const char *key,\n"
10530 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10532 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10533 "device C<device>. C<key> must be one of the I<other> keys."
10537 #: ../src/guestfs-actions.pod:3597
10538 msgid "guestfs_luks_open"
10542 #: ../src/guestfs-actions.pod:3599
10546 " guestfs_luks_open (guestfs_h *g,\n"
10547 " const char *device,\n"
10548 " const char *key,\n"
10549 " const char *mapname);\n"
10554 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10556 "This command opens a block device which has been encrypted according to the "
10557 "Linux Unified Key Setup (LUKS) standard."
10561 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10562 msgid "C<device> is the encrypted block device or partition."
10566 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10568 "The caller must supply one of the keys associated with the LUKS block "
10569 "device, in the C<key> parameter."
10573 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10575 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10576 "writes to this block device are decrypted from and encrypted to the "
10577 "underlying C<device> respectively."
10581 #: ../src/guestfs-actions.pod:3617
10583 "If this block device contains LVM volume groups, then calling "
10584 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10589 #: ../src/guestfs-actions.pod:3629
10590 msgid "guestfs_luks_open_ro"
10594 #: ../src/guestfs-actions.pod:3631
10598 " guestfs_luks_open_ro (guestfs_h *g,\n"
10599 " const char *device,\n"
10600 " const char *key,\n"
10601 " const char *mapname);\n"
10606 #: ../src/guestfs-actions.pod:3637
10608 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10613 #: ../src/guestfs-actions.pod:3648
10614 msgid "guestfs_lvcreate"
10618 #: ../src/guestfs-actions.pod:3650
10622 " guestfs_lvcreate (guestfs_h *g,\n"
10623 " const char *logvol,\n"
10624 " const char *volgroup,\n"
10630 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10632 "This creates an LVM logical volume called C<logvol> on the volume group "
10633 "C<volgroup>, with C<size> megabytes."
10637 #: ../src/guestfs-actions.pod:3663
10638 msgid "guestfs_lvm_canonical_lv_name"
10642 #: ../src/guestfs-actions.pod:3665
10646 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10647 " const char *lvname);\n"
10652 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10654 "This converts alternative naming schemes for LVs that you might find to the "
10655 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10660 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10662 "This command returns an error if the C<lvname> parameter does not refer to a "
10667 #: ../src/guestfs-actions.pod:3676
10668 msgid "See also C<guestfs_is_lv>."
10672 #: ../src/guestfs-actions.pod:3681
10673 msgid "(Added in 1.5.24)"
10677 #: ../src/guestfs-actions.pod:3683
10678 msgid "guestfs_lvm_clear_filter"
10682 #: ../src/guestfs-actions.pod:3685
10686 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10691 #: ../src/guestfs-actions.pod:3688
10693 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10694 "see every block device."
10698 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733
10699 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10701 "This command also clears the LVM cache and performs a volume group scan."
10705 #: ../src/guestfs-actions.pod:3698
10706 msgid "guestfs_lvm_remove_all"
10710 #: ../src/guestfs-actions.pod:3700
10714 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10719 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10721 "This command removes all LVM logical volumes, volume groups and physical "
10726 #: ../src/guestfs-actions.pod:3713
10727 msgid "guestfs_lvm_set_filter"
10731 #: ../src/guestfs-actions.pod:3715
10735 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10736 " char *const *devices);\n"
10741 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10743 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10744 "block devices in the list C<devices>, and will ignore all other attached "
10749 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10751 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10752 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10753 "there are two types of duplication possible: either cloned PVs/VGs which "
10754 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10755 "same name. In normal operation you cannot create this situation, but you "
10756 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10757 "inside the LVM metadata."
10761 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10762 msgid "You can filter whole block devices or individual partitions."
10766 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10768 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10769 "filesystem), even if you are not filtering out that VG."
10773 #: ../src/guestfs-actions.pod:3746
10774 msgid "guestfs_lvremove"
10778 #: ../src/guestfs-actions.pod:3748
10782 " guestfs_lvremove (guestfs_h *g,\n"
10783 " const char *device);\n"
10788 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10790 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10791 "LV, such as C</dev/VG/LV>."
10795 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10797 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10802 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914
10803 #: ../src/guestfs-actions.pod:6644
10804 msgid "(Added in 1.0.13)"
10808 #: ../src/guestfs-actions.pod:3762
10809 msgid "guestfs_lvrename"
10813 #: ../src/guestfs-actions.pod:3764
10817 " guestfs_lvrename (guestfs_h *g,\n"
10818 " const char *logvol,\n"
10819 " const char *newlogvol);\n"
10824 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10825 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10829 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10830 msgid "(Added in 1.0.83)"
10834 #: ../src/guestfs-actions.pod:3775
10835 msgid "guestfs_lvresize"
10839 #: ../src/guestfs-actions.pod:3777
10843 " guestfs_lvresize (guestfs_h *g,\n"
10844 " const char *device,\n"
10850 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10852 "This resizes (expands or shrinks) an existing LVM logical volume to "
10853 "C<mbytes>. When reducing, data in the reduced part is lost."
10857 #: ../src/guestfs-actions.pod:3790
10858 msgid "guestfs_lvresize_free"
10862 #: ../src/guestfs-actions.pod:3792
10866 " guestfs_lvresize_free (guestfs_h *g,\n"
10867 " const char *lv,\n"
10873 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10875 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10876 "remaining free space in the volume group. Commonly you would call this with "
10877 "pc = 100 which expands the logical volume as much as possible, using all "
10878 "remaining free space in the volume group."
10882 #: ../src/guestfs-actions.pod:3805
10883 msgid "(Added in 1.3.3)"
10887 #: ../src/guestfs-actions.pod:3807
10888 msgid "guestfs_lvs"
10892 #: ../src/guestfs-actions.pod:3809
10896 " guestfs_lvs (guestfs_h *g);\n"
10901 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10903 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10908 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10910 "This returns a list of the logical volume device names (eg. C</dev/"
10911 "VolGroup00/LogVol00>)."
10915 #: ../src/guestfs-actions.pod:3818
10916 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10920 #: ../src/guestfs-actions.pod:3826
10921 msgid "guestfs_lvs_full"
10925 #: ../src/guestfs-actions.pod:3828
10928 " struct guestfs_lvm_lv_list *\n"
10929 " guestfs_lvs_full (guestfs_h *g);\n"
10934 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10936 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10937 "(8)> command. The \"full\" version includes all fields."
10941 #: ../src/guestfs-actions.pod:3834
10943 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10944 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10948 #: ../src/guestfs-actions.pod:3840
10949 msgid "guestfs_lvuuid"
10953 #: ../src/guestfs-actions.pod:3842
10957 " guestfs_lvuuid (guestfs_h *g,\n"
10958 " const char *device);\n"
10963 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10964 msgid "This command returns the UUID of the LVM LV C<device>."
10968 #: ../src/guestfs-actions.pod:3853
10969 msgid "guestfs_lxattrlist"
10973 #: ../src/guestfs-actions.pod:3855
10976 " struct guestfs_xattr_list *\n"
10977 " guestfs_lxattrlist (guestfs_h *g,\n"
10978 " const char *path,\n"
10979 " char *const *names);\n"
10984 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
10986 "This call allows you to get the extended attributes of multiple files, where "
10987 "all files are in the directory C<path>. C<names> is the list of files from "
10992 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
10994 "On return you get a flat list of xattr structs which must be interpreted "
10995 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10996 "C<attrval> in this struct is zero-length to indicate there was an error "
10997 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10998 "number (the number of following attributes for this file, which could be C<"
10999 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11000 "for the first named file. This repeats for the second and subsequent files."
11004 #: ../src/guestfs-actions.pod:3874
11006 "This call is intended for programs that want to efficiently list a directory "
11007 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11008 "a similarly efficient call for getting standard stats. Very long directory "
11009 "listings might cause the protocol message size to be exceeded, causing this "
11010 "call to fail. The caller must split up such requests into smaller groups of "
11015 #: ../src/guestfs-actions.pod:3888
11016 msgid "guestfs_mkdir"
11020 #: ../src/guestfs-actions.pod:3890
11024 " guestfs_mkdir (guestfs_h *g,\n"
11025 " const char *path);\n"
11030 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
11031 msgid "Create a directory named C<path>."
11035 #: ../src/guestfs-actions.pod:3900
11036 msgid "guestfs_mkdir_mode"
11040 #: ../src/guestfs-actions.pod:3902
11044 " guestfs_mkdir_mode (guestfs_h *g,\n"
11045 " const char *path,\n"
11051 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
11053 "This command creates a directory, setting the initial permissions of the "
11054 "directory to C<mode>."
11058 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
11060 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11061 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11066 #: ../src/guestfs-actions.pod:3914
11067 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11071 #: ../src/guestfs-actions.pod:3920
11072 msgid "guestfs_mkdir_p"
11076 #: ../src/guestfs-actions.pod:3922
11080 " guestfs_mkdir_p (guestfs_h *g,\n"
11081 " const char *path);\n"
11086 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
11088 "Create a directory named C<path>, creating any parent directories as "
11089 "necessary. This is like the C<mkdir -p> shell command."
11093 #: ../src/guestfs-actions.pod:3933
11094 msgid "guestfs_mkdtemp"
11098 #: ../src/guestfs-actions.pod:3935
11102 " guestfs_mkdtemp (guestfs_h *g,\n"
11103 " const char *template);\n"
11108 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
11110 "This command creates a temporary directory. The C<template> parameter "
11111 "should be a full pathname for the temporary directory name with the final "
11112 "six characters being \"XXXXXX\"."
11116 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
11118 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11119 "being suitable for Windows filesystems."
11123 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
11124 msgid "The name of the temporary directory that was created is returned."
11128 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
11129 msgid "The temporary directory is created with mode 0700 and is owned by root."
11133 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
11135 "The caller is responsible for deleting the temporary directory and its "
11136 "contents after use."
11140 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
11141 msgid "See also: L<mkdtemp(3)>"
11145 #: ../src/guestfs-actions.pod:3963
11146 msgid "guestfs_mke2fs_J"
11150 #: ../src/guestfs-actions.pod:3965
11154 " guestfs_mke2fs_J (guestfs_h *g,\n"
11155 " const char *fstype,\n"
11156 " int blocksize,\n"
11157 " const char *device,\n"
11158 " const char *journal);\n"
11163 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
11165 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11166 "C<journal>. It is equivalent to the command:"
11170 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
11173 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11178 #: ../src/guestfs-actions.pod:3978
11179 msgid "See also C<guestfs_mke2journal>."
11183 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000
11184 #: ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034
11185 #: ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062
11186 #: ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
11187 msgid "(Added in 1.0.68)"
11191 #: ../src/guestfs-actions.pod:3984
11192 msgid "guestfs_mke2fs_JL"
11196 #: ../src/guestfs-actions.pod:3986
11200 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11201 " const char *fstype,\n"
11202 " int blocksize,\n"
11203 " const char *device,\n"
11204 " const char *label);\n"
11209 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
11211 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11212 "the journal labeled C<label>."
11216 #: ../src/guestfs-actions.pod:3996
11217 msgid "See also C<guestfs_mke2journal_L>."
11221 #: ../src/guestfs-actions.pod:4002
11222 msgid "guestfs_mke2fs_JU"
11226 #: ../src/guestfs-actions.pod:4004
11230 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11231 " const char *fstype,\n"
11232 " int blocksize,\n"
11233 " const char *device,\n"
11234 " const char *uuid);\n"
11239 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
11241 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11242 "the journal with UUID C<uuid>."
11246 #: ../src/guestfs-actions.pod:4014
11247 msgid "See also C<guestfs_mke2journal_U>."
11251 #: ../src/guestfs-actions.pod:4020
11252 msgid "guestfs_mke2journal"
11256 #: ../src/guestfs-actions.pod:4022
11260 " guestfs_mke2journal (guestfs_h *g,\n"
11261 " int blocksize,\n"
11262 " const char *device);\n"
11267 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
11269 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11274 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
11277 " mke2fs -O journal_dev -b blocksize device\n"
11282 #: ../src/guestfs-actions.pod:4036
11283 msgid "guestfs_mke2journal_L"
11287 #: ../src/guestfs-actions.pod:4038
11291 " guestfs_mke2journal_L (guestfs_h *g,\n"
11292 " int blocksize,\n"
11293 " const char *label,\n"
11294 " const char *device);\n"
11299 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
11300 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11304 #: ../src/guestfs-actions.pod:4050
11305 msgid "guestfs_mke2journal_U"
11309 #: ../src/guestfs-actions.pod:4052
11313 " guestfs_mke2journal_U (guestfs_h *g,\n"
11314 " int blocksize,\n"
11315 " const char *uuid,\n"
11316 " const char *device);\n"
11321 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
11322 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11326 #: ../src/guestfs-actions.pod:4064
11327 msgid "guestfs_mkfifo"
11331 #: ../src/guestfs-actions.pod:4066
11335 " guestfs_mkfifo (guestfs_h *g,\n"
11337 " const char *path);\n"
11342 #: ../src/guestfs-actions.pod:4071
11344 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11345 "is just a convenient wrapper around C<guestfs_mknod>."
11349 #: ../src/guestfs-actions.pod:4081
11350 msgid "guestfs_mkfs"
11354 #: ../src/guestfs-actions.pod:4083
11358 " guestfs_mkfs (guestfs_h *g,\n"
11359 " const char *fstype,\n"
11360 " const char *device);\n"
11365 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
11367 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11368 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11372 #: ../src/guestfs-actions.pod:4096
11373 msgid "guestfs_mkfs_b"
11377 #: ../src/guestfs-actions.pod:4098
11381 " guestfs_mkfs_b (guestfs_h *g,\n"
11382 " const char *fstype,\n"
11383 " int blocksize,\n"
11384 " const char *device);\n"
11389 #: ../src/guestfs-actions.pod:4104
11391 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11392 "block size of the resulting filesystem. Supported block sizes depend on the "
11393 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11397 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
11399 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11404 #: ../src/guestfs-actions.pod:4116
11405 msgid "guestfs_mkmountpoint"
11409 #: ../src/guestfs-actions.pod:4118
11413 " guestfs_mkmountpoint (guestfs_h *g,\n"
11414 " const char *exemptpath);\n"
11419 #: ../src/guestfs-actions.pod:4122
11421 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11422 "that can be used to create extra mountpoints before mounting the first "
11427 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
11429 "These calls are I<only> necessary in some very limited circumstances, mainly "
11430 "the case where you want to mount a mix of unrelated and/or read-only "
11431 "filesystems together."
11435 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
11437 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11438 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11439 "inside that. You can unpack this as follows in guestfish:"
11443 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
11446 " add-ro Fedora-11-i686-Live.iso\n"
11448 " mkmountpoint /cd\n"
11449 " mkmountpoint /sqsh\n"
11450 " mkmountpoint /ext3fs\n"
11451 " mount /dev/sda /cd\n"
11452 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11453 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11458 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
11459 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11463 #: ../src/guestfs-actions.pod:4146
11465 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11466 "may get unexpected errors if you try to mix these calls. It is safest to "
11467 "manually unmount filesystems and remove mountpoints after use."
11471 #: ../src/guestfs-actions.pod:4150
11473 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11474 "first, so for this to work for manual mountpoints, you must ensure that the "
11475 "innermost mountpoints have the longest pathnames, as in the example code "
11480 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11482 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11486 #: ../src/guestfs-actions.pod:4157
11488 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11489 "means that C<guestfs_umount_all> is called when the handle is closed which "
11490 "can also trigger these issues."
11494 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422
11495 #: ../src/guestfs-actions.pod:5315
11496 msgid "(Added in 1.0.62)"
11500 #: ../src/guestfs-actions.pod:4165
11501 msgid "guestfs_mknod"
11505 #: ../src/guestfs-actions.pod:4167
11509 " guestfs_mknod (guestfs_h *g,\n"
11513 " const char *path);\n"
11518 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11520 "This call creates block or character special devices, or named pipes (FIFOs)."
11524 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11526 "The C<mode> parameter should be the mode, using the standard constants. "
11527 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11528 "used when creating block and character special devices."
11532 #: ../src/guestfs-actions.pod:4182
11534 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11535 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11536 "regular file). These constants are available in the standard Linux header "
11537 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11538 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11539 "the appropriate constant for you."
11543 #: ../src/guestfs-actions.pod:4196
11544 msgid "guestfs_mknod_b"
11548 #: ../src/guestfs-actions.pod:4198
11552 " guestfs_mknod_b (guestfs_h *g,\n"
11556 " const char *path);\n"
11561 #: ../src/guestfs-actions.pod:4205
11563 "This call creates a block device node called C<path> with mode C<mode> and "
11564 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11565 "wrapper around C<guestfs_mknod>."
11569 #: ../src/guestfs-actions.pod:4215
11570 msgid "guestfs_mknod_c"
11574 #: ../src/guestfs-actions.pod:4217
11578 " guestfs_mknod_c (guestfs_h *g,\n"
11582 " const char *path);\n"
11587 #: ../src/guestfs-actions.pod:4224
11589 "This call creates a char device node called C<path> with mode C<mode> and "
11590 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11591 "wrapper around C<guestfs_mknod>."
11595 #: ../src/guestfs-actions.pod:4234
11596 msgid "guestfs_mkswap"
11600 #: ../src/guestfs-actions.pod:4236
11604 " guestfs_mkswap (guestfs_h *g,\n"
11605 " const char *device);\n"
11610 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11611 msgid "Create a swap partition on C<device>."
11615 #: ../src/guestfs-actions.pod:4246
11616 msgid "guestfs_mkswap_L"
11620 #: ../src/guestfs-actions.pod:4248
11624 " guestfs_mkswap_L (guestfs_h *g,\n"
11625 " const char *label,\n"
11626 " const char *device);\n"
11631 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11632 msgid "Create a swap partition on C<device> with label C<label>."
11636 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11638 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11639 "sda>), just to a partition. This appears to be a limitation of the kernel "
11644 #: ../src/guestfs-actions.pod:4263
11645 msgid "guestfs_mkswap_U"
11649 #: ../src/guestfs-actions.pod:4265
11653 " guestfs_mkswap_U (guestfs_h *g,\n"
11654 " const char *uuid,\n"
11655 " const char *device);\n"
11660 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11661 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11665 #: ../src/guestfs-actions.pod:4276
11666 msgid "guestfs_mkswap_file"
11670 #: ../src/guestfs-actions.pod:4278
11674 " guestfs_mkswap_file (guestfs_h *g,\n"
11675 " const char *path);\n"
11680 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11681 msgid "Create a swap file."
11685 #: ../src/guestfs-actions.pod:4284
11687 "This command just writes a swap file signature to an existing file. To "
11688 "create the file itself, use something like C<guestfs_fallocate>."
11692 #: ../src/guestfs-actions.pod:4291
11693 msgid "guestfs_modprobe"
11697 #: ../src/guestfs-actions.pod:4293
11701 " guestfs_modprobe (guestfs_h *g,\n"
11702 " const char *modulename);\n"
11707 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11708 msgid "This loads a kernel module in the appliance."
11712 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11714 "The kernel module must have been whitelisted when libguestfs was built (see "
11715 "C<appliance/kmod.whitelist.in> in the source)."
11719 #: ../src/guestfs-actions.pod:4306
11720 msgid "guestfs_mount"
11724 #: ../src/guestfs-actions.pod:4308
11728 " guestfs_mount (guestfs_h *g,\n"
11729 " const char *device,\n"
11730 " const char *mountpoint);\n"
11735 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11737 "Mount a guest disk at a position in the filesystem. Block devices are named "
11738 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11739 "those block devices contain partitions, they will have the usual names (eg. "
11740 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11744 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11746 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11747 "mounted on C</> before others can be mounted. Other filesystems can only be "
11748 "mounted on directories which already exist."
11752 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11754 "The mounted filesystem is writable, if we have sufficient permissions on the "
11755 "underlying device."
11759 #: ../src/guestfs-actions.pod:4327
11761 "B<Important note:> When you use this call, the filesystem options C<sync> "
11762 "and C<noatime> are set implicitly. This was originally done because we "
11763 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11764 "very large negative performance impact and negligible effect on "
11765 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11766 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11767 "(use an empty string for the first parameter if you don't want any options)."
11771 #: ../src/guestfs-actions.pod:4341
11772 msgid "guestfs_mount_loop"
11776 #: ../src/guestfs-actions.pod:4343
11780 " guestfs_mount_loop (guestfs_h *g,\n"
11781 " const char *file,\n"
11782 " const char *mountpoint);\n"
11787 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11789 "This command lets you mount C<file> (a filesystem image in a file) on a "
11790 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11795 #: ../src/guestfs-actions.pod:4356
11796 msgid "guestfs_mount_options"
11800 #: ../src/guestfs-actions.pod:4358
11804 " guestfs_mount_options (guestfs_h *g,\n"
11805 " const char *options,\n"
11806 " const char *device,\n"
11807 " const char *mountpoint);\n"
11812 #: ../src/guestfs-actions.pod:4364
11814 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11815 "the mount options as for the L<mount(8)> I<-o> flag."
11819 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11821 "If the C<options> parameter is an empty string, then no options are passed "
11822 "(all options default to whatever the filesystem uses)."
11826 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388
11827 #: ../src/guestfs-actions.pod:4405
11828 msgid "(Added in 1.0.10)"
11832 #: ../src/guestfs-actions.pod:4376
11833 msgid "guestfs_mount_ro"
11837 #: ../src/guestfs-actions.pod:4378
11841 " guestfs_mount_ro (guestfs_h *g,\n"
11842 " const char *device,\n"
11843 " const char *mountpoint);\n"
11848 #: ../src/guestfs-actions.pod:4383
11850 "This is the same as the C<guestfs_mount> command, but it mounts the "
11851 "filesystem with the read-only (I<-o ro>) flag."
11855 #: ../src/guestfs-actions.pod:4390
11856 msgid "guestfs_mount_vfs"
11860 #: ../src/guestfs-actions.pod:4392
11864 " guestfs_mount_vfs (guestfs_h *g,\n"
11865 " const char *options,\n"
11866 " const char *vfstype,\n"
11867 " const char *device,\n"
11868 " const char *mountpoint);\n"
11873 #: ../src/guestfs-actions.pod:4399
11875 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11876 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11881 #: ../src/guestfs-actions.pod:4407
11882 msgid "guestfs_mountpoints"
11886 #: ../src/guestfs-actions.pod:4409
11890 " guestfs_mountpoints (guestfs_h *g);\n"
11895 #: ../src/guestfs-actions.pod:4412
11897 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11898 "devices. This one returns a hash table (map) of device name to directory "
11899 "where the device is mounted."
11903 #: ../src/guestfs-actions.pod:4424
11904 msgid "guestfs_mounts"
11908 #: ../src/guestfs-actions.pod:4426
11912 " guestfs_mounts (guestfs_h *g);\n"
11917 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11919 "This returns the list of currently mounted filesystems. It returns the list "
11920 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11924 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11925 msgid "Some internal mounts are not shown."
11929 #: ../src/guestfs-actions.pod:4434
11930 msgid "See also: C<guestfs_mountpoints>"
11934 #: ../src/guestfs-actions.pod:4442
11939 #: ../src/guestfs-actions.pod:4444
11943 " guestfs_mv (guestfs_h *g,\n"
11944 " const char *src,\n"
11945 " const char *dest);\n"
11950 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11952 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11953 "destination filename or destination directory."
11957 #: ../src/guestfs-actions.pod:4456
11958 msgid "guestfs_ntfs_3g_probe"
11962 #: ../src/guestfs-actions.pod:4458
11966 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11968 " const char *device);\n"
11973 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11975 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11976 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
11977 "write, and some cannot be mounted at all)."
11981 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11983 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11984 "can be mounted read-write. Set it to false if you want to test if the "
11985 "volume can be mounted read-only."
11989 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
11991 "The return value is an integer which C<0> if the operation would succeed, or "
11992 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11996 #: ../src/guestfs-actions.pod:4477
11997 msgid "(Added in 1.0.43)"
12001 #: ../src/guestfs-actions.pod:4479
12002 msgid "guestfs_ntfsresize"
12006 #: ../src/guestfs-actions.pod:4481
12010 " guestfs_ntfsresize (guestfs_h *g,\n"
12011 " const char *device);\n"
12016 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
12018 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12019 "size of the underlying device. See also L<ntfsresize(8)>."
12023 #: ../src/guestfs-actions.pod:4493
12024 msgid "guestfs_ntfsresize_size"
12028 #: ../src/guestfs-actions.pod:4495
12032 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12033 " const char *device,\n"
12034 " int64_t size);\n"
12039 #: ../src/guestfs-actions.pod:4500
12041 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12042 "to specify the new size (in bytes) explicitly."
12046 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941
12047 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
12048 msgid "(Added in 1.3.14)"
12052 #: ../src/guestfs-actions.pod:4507
12053 msgid "guestfs_part_add"
12057 #: ../src/guestfs-actions.pod:4509
12061 " guestfs_part_add (guestfs_h *g,\n"
12062 " const char *device,\n"
12063 " const char *prlogex,\n"
12064 " int64_t startsect,\n"
12065 " int64_t endsect);\n"
12070 #: ../src/guestfs-actions.pod:4516
12072 "This command adds a partition to C<device>. If there is no partition table "
12073 "on the device, call C<guestfs_part_init> first."
12077 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
12079 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12080 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12081 "C<logical>) and C<e> (or C<extended>) partition types."
12085 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
12087 "C<startsect> and C<endsect> are the start and end of the partition in "
12088 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12089 "from the end of the disk (C<-1> is the last sector)."
12093 #: ../src/guestfs-actions.pod:4528
12095 "Creating a partition which covers the whole disk is not so easy. Use "
12096 "C<guestfs_part_disk> to do that."
12100 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571
12101 #: ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702
12102 #: ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759
12103 #: ../src/guestfs-actions.pod:4799
12104 msgid "(Added in 1.0.78)"
12108 #: ../src/guestfs-actions.pod:4535
12109 msgid "guestfs_part_del"
12113 #: ../src/guestfs-actions.pod:4537
12117 " guestfs_part_del (guestfs_h *g,\n"
12118 " const char *device,\n"
12124 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
12125 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12129 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
12131 "Note that in the case of MBR partitioning, deleting an extended partition "
12132 "also deletes any logical partitions it contains."
12136 #: ../src/guestfs-actions.pod:4552
12137 msgid "guestfs_part_disk"
12141 #: ../src/guestfs-actions.pod:4554
12145 " guestfs_part_disk (guestfs_h *g,\n"
12146 " const char *device,\n"
12147 " const char *parttype);\n"
12152 #: ../src/guestfs-actions.pod:4559
12154 "This command is simply a combination of C<guestfs_part_init> followed by "
12155 "C<guestfs_part_add> to create a single primary partition covering the whole "
12160 #: ../src/guestfs-actions.pod:4563
12162 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12163 "possible values are described in C<guestfs_part_init>."
12167 #: ../src/guestfs-actions.pod:4573
12168 msgid "guestfs_part_get_bootable"
12172 #: ../src/guestfs-actions.pod:4575
12176 " guestfs_part_get_bootable (guestfs_h *g,\n"
12177 " const char *device,\n"
12183 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
12185 "This command returns true if the partition C<partnum> on C<device> has the "
12186 "bootable flag set."
12190 #: ../src/guestfs-actions.pod:4583
12191 msgid "See also C<guestfs_part_set_bootable>."
12195 #: ../src/guestfs-actions.pod:4589
12196 msgid "guestfs_part_get_mbr_id"
12200 #: ../src/guestfs-actions.pod:4591
12204 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12205 " const char *device,\n"
12211 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
12213 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12214 "partition C<partnum>."
12218 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
12220 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12221 "undefined results for other partition table types (see "
12222 "C<guestfs_part_get_parttype>)."
12226 #: ../src/guestfs-actions.pod:4607
12227 msgid "guestfs_part_get_parttype"
12231 #: ../src/guestfs-actions.pod:4609
12235 " guestfs_part_get_parttype (guestfs_h *g,\n"
12236 " const char *device);\n"
12241 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
12243 "This command examines the partition table on C<device> and returns the "
12244 "partition table type (format) being used."
12248 #: ../src/guestfs-actions.pod:4616
12250 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12251 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12252 "possible, although unusual. See C<guestfs_part_init> for a full list."
12256 #: ../src/guestfs-actions.pod:4626
12257 msgid "guestfs_part_init"
12261 #: ../src/guestfs-actions.pod:4628
12265 " guestfs_part_init (guestfs_h *g,\n"
12266 " const char *device,\n"
12267 " const char *parttype);\n"
12272 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
12274 "This creates an empty partition table on C<device> of one of the partition "
12275 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12276 "(for large disks)."
12280 #: ../src/guestfs-actions.pod:4637
12282 "Initially there are no partitions. Following this, you should call "
12283 "C<guestfs_part_add> for each partition required."
12287 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
12288 msgid "Possible values for C<parttype> are:"
12292 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
12293 msgid "B<efi> | B<gpt>"
12297 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
12298 msgid "Intel EFI / GPT partition table."
12302 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
12304 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12305 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12306 "the C<mbr> format."
12310 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
12311 msgid "B<mbr> | B<msdos>"
12315 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
12317 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12318 "Windows. This partition type will B<only> work for device sizes up to 2 "
12319 "TB. For large disks we recommend using C<gpt>."
12323 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
12325 "Other partition table types that may work but are not supported include:"
12329 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
12334 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
12335 msgid "AIX disk labels."
12339 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
12340 msgid "B<amiga> | B<rdb>"
12344 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
12345 msgid "Amiga \"Rigid Disk Block\" format."
12349 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
12354 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
12355 msgid "BSD disk labels."
12359 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
12364 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
12365 msgid "DASD, used on IBM mainframes."
12369 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
12374 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
12375 msgid "MIPS/SGI volumes."
12379 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
12384 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
12385 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12389 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
12394 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
12395 msgid "NEC PC-98 format, common in Japan apparently."
12399 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
12404 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
12405 msgid "Sun disk labels."
12409 #: ../src/guestfs-actions.pod:4704
12410 msgid "guestfs_part_list"
12414 #: ../src/guestfs-actions.pod:4706
12417 " struct guestfs_partition_list *\n"
12418 " guestfs_part_list (guestfs_h *g,\n"
12419 " const char *device);\n"
12424 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
12426 "This command parses the partition table on C<device> and returns the list of "
12427 "partitions found."
12431 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
12432 msgid "The fields in the returned structure are:"
12436 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
12437 msgid "B<part_num>"
12441 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
12442 msgid "Partition number, counting from 1."
12446 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
12447 msgid "B<part_start>"
12451 #: ../src/guestfs-actions.pod:4723
12453 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12454 "the device's sector size, see C<guestfs_blockdev_getss>."
12458 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
12459 msgid "B<part_end>"
12463 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
12464 msgid "End of the partition in bytes."
12468 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12469 msgid "B<part_size>"
12473 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12474 msgid "Size of the partition in bytes."
12478 #: ../src/guestfs-actions.pod:4736
12480 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12481 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12486 #: ../src/guestfs-actions.pod:4742
12487 msgid "guestfs_part_set_bootable"
12491 #: ../src/guestfs-actions.pod:4744
12495 " guestfs_part_set_bootable (guestfs_h *g,\n"
12496 " const char *device,\n"
12498 " int bootable);\n"
12503 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12505 "This sets the bootable flag on partition numbered C<partnum> on device "
12506 "C<device>. Note that partitions are numbered from 1."
12510 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12512 "The bootable flag is used by some operating systems (notably Windows) to "
12513 "determine which partition to boot from. It is by no means universally "
12518 #: ../src/guestfs-actions.pod:4761
12519 msgid "guestfs_part_set_mbr_id"
12523 #: ../src/guestfs-actions.pod:4763
12527 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12528 " const char *device,\n"
12535 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12537 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12538 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12539 "documentation are in fact hexadecimal numbers, but usually documented "
12540 "without any leading \"0x\" which might be confusing."
12544 #: ../src/guestfs-actions.pod:4783
12545 msgid "guestfs_part_set_name"
12549 #: ../src/guestfs-actions.pod:4785
12553 " guestfs_part_set_name (guestfs_h *g,\n"
12554 " const char *device,\n"
12556 " const char *name);\n"
12561 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12563 "This sets the partition name on partition numbered C<partnum> on device "
12564 "C<device>. Note that partitions are numbered from 1."
12568 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12570 "The partition name can only be set on certain types of partition table. "
12571 "This works on C<gpt> but not on C<mbr> partitions."
12575 #: ../src/guestfs-actions.pod:4801
12576 msgid "guestfs_part_to_dev"
12580 #: ../src/guestfs-actions.pod:4803
12584 " guestfs_part_to_dev (guestfs_h *g,\n"
12585 " const char *partition);\n"
12590 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12592 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12593 "partition number, returning the device name (eg. \"/dev/sdb\")."
12597 #: ../src/guestfs-actions.pod:4811
12599 "The named partition must exist, for example as a string returned from "
12600 "C<guestfs_list_partitions>."
12604 #: ../src/guestfs-actions.pod:4819
12605 msgid "guestfs_ping_daemon"
12609 #: ../src/guestfs-actions.pod:4821
12613 " guestfs_ping_daemon (guestfs_h *g);\n"
12618 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12620 "This is a test probe into the guestfs daemon running inside the qemu "
12621 "subprocess. Calling this function checks that the daemon responds to the "
12622 "ping message, without affecting the daemon or attached block device(s) in "
12627 #: ../src/guestfs-actions.pod:4833
12628 msgid "guestfs_pread"
12632 #: ../src/guestfs-actions.pod:4835
12636 " guestfs_pread (guestfs_h *g,\n"
12637 " const char *path,\n"
12639 " int64_t offset,\n"
12640 " size_t *size_r);\n"
12645 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12647 "This command lets you read part of a file. It reads C<count> bytes of the "
12648 "file, starting at C<offset>, from file C<path>."
12652 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871
12653 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12655 "This may read fewer bytes than requested. For further details see the "
12656 "L<pread(2)> system call."
12660 #: ../src/guestfs-actions.pod:4848
12661 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12665 #: ../src/guestfs-actions.pod:4859
12666 msgid "guestfs_pread_device"
12670 #: ../src/guestfs-actions.pod:4861
12674 " guestfs_pread_device (guestfs_h *g,\n"
12675 " const char *device,\n"
12677 " int64_t offset,\n"
12678 " size_t *size_r);\n"
12683 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12685 "This command lets you read part of a file. It reads C<count> bytes of "
12686 "C<device>, starting at C<offset>."
12690 #: ../src/guestfs-actions.pod:4874
12691 msgid "See also C<guestfs_pread>."
12695 #: ../src/guestfs-actions.pod:4883
12696 msgid "(Added in 1.5.21)"
12700 #: ../src/guestfs-actions.pod:4885
12701 msgid "guestfs_pvcreate"
12705 #: ../src/guestfs-actions.pod:4887
12709 " guestfs_pvcreate (guestfs_h *g,\n"
12710 " const char *device);\n"
12715 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12717 "This creates an LVM physical volume on the named C<device>, where C<device> "
12718 "should usually be a partition name such as C</dev/sda1>."
12722 #: ../src/guestfs-actions.pod:4899
12723 msgid "guestfs_pvremove"
12727 #: ../src/guestfs-actions.pod:4901
12731 " guestfs_pvremove (guestfs_h *g,\n"
12732 " const char *device);\n"
12737 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12739 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12744 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12746 "The implementation uses the C<pvremove> command which refuses to wipe "
12747 "physical volumes that contain any volume groups, so you have to remove those "
12752 #: ../src/guestfs-actions.pod:4916
12753 msgid "guestfs_pvresize"
12757 #: ../src/guestfs-actions.pod:4918
12761 " guestfs_pvresize (guestfs_h *g,\n"
12762 " const char *device);\n"
12767 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12769 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12770 "the new size of the underlying device."
12774 #: ../src/guestfs-actions.pod:4929
12775 msgid "guestfs_pvresize_size"
12779 #: ../src/guestfs-actions.pod:4931
12783 " guestfs_pvresize_size (guestfs_h *g,\n"
12784 " const char *device,\n"
12785 " int64_t size);\n"
12790 #: ../src/guestfs-actions.pod:4936
12792 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12793 "specify the new size (in bytes) explicitly."
12797 #: ../src/guestfs-actions.pod:4943
12798 msgid "guestfs_pvs"
12802 #: ../src/guestfs-actions.pod:4945
12806 " guestfs_pvs (guestfs_h *g);\n"
12811 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12813 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12818 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12820 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12825 #: ../src/guestfs-actions.pod:4954
12826 msgid "See also C<guestfs_pvs_full>."
12830 #: ../src/guestfs-actions.pod:4962
12831 msgid "guestfs_pvs_full"
12835 #: ../src/guestfs-actions.pod:4964
12838 " struct guestfs_lvm_pv_list *\n"
12839 " guestfs_pvs_full (guestfs_h *g);\n"
12844 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12846 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12847 "(8)> command. The \"full\" version includes all fields."
12851 #: ../src/guestfs-actions.pod:4970
12853 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12854 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12858 #: ../src/guestfs-actions.pod:4976
12859 msgid "guestfs_pvuuid"
12863 #: ../src/guestfs-actions.pod:4978
12867 " guestfs_pvuuid (guestfs_h *g,\n"
12868 " const char *device);\n"
12873 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12874 msgid "This command returns the UUID of the LVM PV C<device>."
12878 #: ../src/guestfs-actions.pod:4989
12879 msgid "guestfs_pwrite"
12883 #: ../src/guestfs-actions.pod:4991
12887 " guestfs_pwrite (guestfs_h *g,\n"
12888 " const char *path,\n"
12889 " const char *content,\n"
12890 " size_t content_size,\n"
12891 " int64_t offset);\n"
12896 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12898 "This command writes to part of a file. It writes the data buffer C<content> "
12899 "to the file C<path> starting at offset C<offset>."
12903 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12905 "This command implements the L<pwrite(2)> system call, and like that system "
12906 "call it may not write the full data requested. The return value is the "
12907 "number of bytes that were actually written to the file. This could even be "
12908 "0, although short writes are unlikely for regular files in ordinary "
12913 #: ../src/guestfs-actions.pod:5007
12914 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12918 #: ../src/guestfs-actions.pod:5016
12919 msgid "guestfs_pwrite_device"
12923 #: ../src/guestfs-actions.pod:5018
12927 " guestfs_pwrite_device (guestfs_h *g,\n"
12928 " const char *device,\n"
12929 " const char *content,\n"
12930 " size_t content_size,\n"
12931 " int64_t offset);\n"
12936 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12938 "This command writes to part of a device. It writes the data buffer "
12939 "C<content> to C<device> starting at offset C<offset>."
12943 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12945 "This command implements the L<pwrite(2)> system call, and like that system "
12946 "call it may not write the full data requested (although short writes to disk "
12947 "devices and partitions are probably impossible with standard Linux kernels)."
12951 #: ../src/guestfs-actions.pod:5033
12952 msgid "See also C<guestfs_pwrite>."
12956 #: ../src/guestfs-actions.pod:5040
12957 msgid "(Added in 1.5.20)"
12961 #: ../src/guestfs-actions.pod:5042
12962 msgid "guestfs_read_file"
12966 #: ../src/guestfs-actions.pod:5044
12970 " guestfs_read_file (guestfs_h *g,\n"
12971 " const char *path,\n"
12972 " size_t *size_r);\n"
12977 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12978 msgid "This calls returns the contents of the file C<path> as a buffer."
12982 #: ../src/guestfs-actions.pod:5052
12984 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12985 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12986 "function is limited in the total size of file that can be handled."
12990 #: ../src/guestfs-actions.pod:5064
12991 msgid "(Added in 1.0.63)"
12995 #: ../src/guestfs-actions.pod:5066
12996 msgid "guestfs_read_lines"
13000 #: ../src/guestfs-actions.pod:5068
13004 " guestfs_read_lines (guestfs_h *g,\n"
13005 " const char *path);\n"
13010 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
13012 "The file contents are returned as a list of lines. Trailing C<LF> and "
13013 "C<CRLF> character sequences are I<not> returned."
13017 #: ../src/guestfs-actions.pod:5077
13019 "Note that this function cannot correctly handle binary files (specifically, "
13020 "files containing C<\\0> character which is treated as end of line). For "
13021 "those you need to use the C<guestfs_read_file> function which has a more "
13022 "complex interface."
13026 #: ../src/guestfs-actions.pod:5088
13027 msgid "guestfs_readdir"
13031 #: ../src/guestfs-actions.pod:5090
13034 " struct guestfs_dirent_list *\n"
13035 " guestfs_readdir (guestfs_h *g,\n"
13036 " const char *dir);\n"
13041 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
13042 msgid "This returns the list of directory entries in directory C<dir>."
13046 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
13048 "All entries in the directory are returned, including C<.> and C<..>. The "
13049 "entries are I<not> sorted, but returned in the same order as the underlying "
13054 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
13056 "Also this call returns basic file type information about each file. The "
13057 "C<ftyp> field will contain one of the following characters:"
13061 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
13066 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
13067 msgid "Block special"
13071 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
13076 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
13077 msgid "Char special"
13081 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
13086 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
13091 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
13096 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
13097 msgid "FIFO (named pipe)"
13101 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
13106 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
13107 msgid "Symbolic link"
13111 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
13116 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
13117 msgid "Regular file"
13121 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
13126 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
13131 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
13136 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
13137 msgid "Unknown file type"
13141 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
13146 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
13148 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13152 #: ../src/guestfs-actions.pod:5144
13154 "This function is primarily intended for use by programs. To get a simple "
13155 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13156 "consumption, use C<guestfs_ll>."
13160 #: ../src/guestfs-actions.pod:5148
13162 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13163 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13167 #: ../src/guestfs-actions.pod:5154
13168 msgid "guestfs_readlink"
13172 #: ../src/guestfs-actions.pod:5156
13176 " guestfs_readlink (guestfs_h *g,\n"
13177 " const char *path);\n"
13182 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
13183 msgid "This command reads the target of a symbolic link."
13187 #: ../src/guestfs-actions.pod:5167
13188 msgid "guestfs_readlinklist"
13192 #: ../src/guestfs-actions.pod:5169
13196 " guestfs_readlinklist (guestfs_h *g,\n"
13197 " const char *path,\n"
13198 " char *const *names);\n"
13203 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
13205 "This call allows you to do a C<readlink> operation on multiple files, where "
13206 "all files are in the directory C<path>. C<names> is the list of files from "
13211 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
13213 "On return you get a list of strings, with a one-to-one correspondence to the "
13214 "C<names> list. Each string is the value of the symbolic link."
13218 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
13220 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13221 "result string is the empty string C<\"\">. However the whole operation is "
13222 "completed even if there were C<readlink(2)> errors, and so you can call this "
13223 "function with names where you don't know if they are symbolic links already "
13224 "(albeit slightly less efficient)."
13228 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
13230 "This call is intended for programs that want to efficiently list a directory "
13231 "contents without making many round-trips. Very long directory listings "
13232 "might cause the protocol message size to be exceeded, causing this call to "
13233 "fail. The caller must split up such requests into smaller groups of names."
13237 #: ../src/guestfs-actions.pod:5202
13238 msgid "guestfs_realpath"
13242 #: ../src/guestfs-actions.pod:5204
13246 " guestfs_realpath (guestfs_h *g,\n"
13247 " const char *path);\n"
13252 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
13254 "Return the canonicalized absolute pathname of C<path>. The returned path "
13255 "has no C<.>, C<..> or symbolic link path elements."
13259 #: ../src/guestfs-actions.pod:5216
13260 msgid "guestfs_removexattr"
13264 #: ../src/guestfs-actions.pod:5218
13268 " guestfs_removexattr (guestfs_h *g,\n"
13269 " const char *xattr,\n"
13270 " const char *path);\n"
13275 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
13277 "This call removes the extended attribute named C<xattr> of the file C<path>."
13281 #: ../src/guestfs-actions.pod:5226
13282 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13286 #: ../src/guestfs-actions.pod:5232
13287 msgid "guestfs_resize2fs"
13291 #: ../src/guestfs-actions.pod:5234
13295 " guestfs_resize2fs (guestfs_h *g,\n"
13296 " const char *device);\n"
13301 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
13303 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13304 "underlying device."
13308 #: ../src/guestfs-actions.pod:5241
13310 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13311 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13312 "sometimes gives an error about this and sometimes not. In any case, it is "
13313 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13317 #: ../src/guestfs-actions.pod:5251
13318 msgid "guestfs_resize2fs_size"
13322 #: ../src/guestfs-actions.pod:5253
13326 " guestfs_resize2fs_size (guestfs_h *g,\n"
13327 " const char *device,\n"
13328 " int64_t size);\n"
13333 #: ../src/guestfs-actions.pod:5258
13335 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13336 "to specify the new size (in bytes) explicitly."
13340 #: ../src/guestfs-actions.pod:5265
13345 #: ../src/guestfs-actions.pod:5267
13349 " guestfs_rm (guestfs_h *g,\n"
13350 " const char *path);\n"
13355 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
13356 msgid "Remove the single file C<path>."
13360 #: ../src/guestfs-actions.pod:5277
13361 msgid "guestfs_rm_rf"
13365 #: ../src/guestfs-actions.pod:5279
13369 " guestfs_rm_rf (guestfs_h *g,\n"
13370 " const char *path);\n"
13375 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
13377 "Remove the file or directory C<path>, recursively removing the contents if "
13378 "its a directory. This is like the C<rm -rf> shell command."
13382 #: ../src/guestfs-actions.pod:5291
13383 msgid "guestfs_rmdir"
13387 #: ../src/guestfs-actions.pod:5293
13391 " guestfs_rmdir (guestfs_h *g,\n"
13392 " const char *path);\n"
13397 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
13398 msgid "Remove the single directory C<path>."
13402 #: ../src/guestfs-actions.pod:5303
13403 msgid "guestfs_rmmountpoint"
13407 #: ../src/guestfs-actions.pod:5305
13411 " guestfs_rmmountpoint (guestfs_h *g,\n"
13412 " const char *exemptpath);\n"
13417 #: ../src/guestfs-actions.pod:5309
13419 "This calls removes a mountpoint that was previously created with "
13420 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13424 #: ../src/guestfs-actions.pod:5317
13425 msgid "guestfs_scrub_device"
13429 #: ../src/guestfs-actions.pod:5319
13433 " guestfs_scrub_device (guestfs_h *g,\n"
13434 " const char *device);\n"
13439 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
13441 "This command writes patterns over C<device> to make data retrieval more "
13446 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347
13447 #: ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564
13448 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13450 "It is an interface to the L<scrub(1)> program. See that manual page for "
13455 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352
13456 #: ../src/guestfs-actions.pod:5371
13457 msgid "(Added in 1.0.52)"
13461 #: ../src/guestfs-actions.pod:5336
13462 msgid "guestfs_scrub_file"
13466 #: ../src/guestfs-actions.pod:5338
13470 " guestfs_scrub_file (guestfs_h *g,\n"
13471 " const char *file);\n"
13476 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13478 "This command writes patterns over a file to make data retrieval more "
13483 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13484 msgid "The file is I<removed> after scrubbing."
13488 #: ../src/guestfs-actions.pod:5354
13489 msgid "guestfs_scrub_freespace"
13493 #: ../src/guestfs-actions.pod:5356
13497 " guestfs_scrub_freespace (guestfs_h *g,\n"
13498 " const char *dir);\n"
13503 #: ../src/guestfs-actions.pod:5360
13505 "This command creates the directory C<dir> and then fills it with files until "
13506 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13507 "and deletes them. The intention is to scrub any free space on the partition "
13508 "containing C<dir>."
13512 #: ../src/guestfs-actions.pod:5373
13513 msgid "guestfs_set_append"
13517 #: ../src/guestfs-actions.pod:5375
13521 " guestfs_set_append (guestfs_h *g,\n"
13522 " const char *append);\n"
13527 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13529 "This function is used to add additional options to the guest kernel command "
13534 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13536 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13537 "environment variable."
13541 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13543 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13544 "(libguestfs always adds a few of its own)."
13548 #: ../src/guestfs-actions.pod:5392
13549 msgid "guestfs_set_autosync"
13553 #: ../src/guestfs-actions.pod:5394
13557 " guestfs_set_autosync (guestfs_h *g,\n"
13558 " int autosync);\n"
13563 #: ../src/guestfs-actions.pod:5398
13565 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13566 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13567 "the handle is closed (also if the program exits without closing handles)."
13571 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13573 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13574 "disabled by default)."
13578 #: ../src/guestfs-actions.pod:5410
13579 msgid "guestfs_set_direct"
13583 #: ../src/guestfs-actions.pod:5412
13587 " guestfs_set_direct (guestfs_h *g,\n"
13593 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13595 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13596 "passed directly through to the appliance once it is launched."
13600 #: ../src/guestfs-actions.pod:5420
13602 "One consequence of this is that log messages aren't caught by the library "
13603 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13608 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13609 msgid "You probably don't want to use this unless you know what you are doing."
13613 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13614 msgid "The default is disabled."
13618 #: ../src/guestfs-actions.pod:5433
13619 msgid "guestfs_set_e2label"
13623 #: ../src/guestfs-actions.pod:5435
13627 " guestfs_set_e2label (guestfs_h *g,\n"
13628 " const char *device,\n"
13629 " const char *label);\n"
13634 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13636 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13637 "C<label>. Filesystem labels are limited to 16 characters."
13641 #: ../src/guestfs-actions.pod:5444
13643 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13644 "the existing label on a filesystem."
13648 #: ../src/guestfs-actions.pod:5451
13649 msgid "guestfs_set_e2uuid"
13653 #: ../src/guestfs-actions.pod:5453
13657 " guestfs_set_e2uuid (guestfs_h *g,\n"
13658 " const char *device,\n"
13659 " const char *uuid);\n"
13664 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13666 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13667 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13668 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13672 #: ../src/guestfs-actions.pod:5463
13674 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13675 "the existing UUID of a filesystem."
13679 #: ../src/guestfs-actions.pod:5470
13680 msgid "guestfs_set_memsize"
13684 #: ../src/guestfs-actions.pod:5472
13688 " guestfs_set_memsize (guestfs_h *g,\n"
13694 #: ../src/guestfs-actions.pod:5476
13696 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13697 "This only has any effect if called before C<guestfs_launch>."
13701 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13703 "You can also change this by setting the environment variable "
13704 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13708 #: ../src/guestfs-actions.pod:5491
13709 msgid "guestfs_set_network"
13713 #: ../src/guestfs-actions.pod:5493
13717 " guestfs_set_network (guestfs_h *g,\n"
13723 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13725 "If C<network> is true, then the network is enabled in the libguestfs "
13726 "appliance. The default is false."
13730 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13732 "This affects whether commands are able to access the network (see L<guestfs"
13733 "(3)/RUNNING COMMANDS>)."
13737 #: ../src/guestfs-actions.pod:5503
13739 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13744 #: ../src/guestfs-actions.pod:5510
13745 msgid "guestfs_set_path"
13749 #: ../src/guestfs-actions.pod:5512
13753 " guestfs_set_path (guestfs_h *g,\n"
13754 " const char *searchpath);\n"
13759 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13760 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13764 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13766 "The default is C<$libdir/guestfs> unless overridden by setting "
13767 "C<LIBGUESTFS_PATH> environment variable."
13771 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13772 msgid "Setting C<path> to C<NULL> restores the default path."
13776 #: ../src/guestfs-actions.pod:5527
13777 msgid "guestfs_set_qemu"
13781 #: ../src/guestfs-actions.pod:5529
13785 " guestfs_set_qemu (guestfs_h *g,\n"
13786 " const char *qemu);\n"
13791 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13792 msgid "Set the qemu binary that we will use."
13796 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13798 "The default is chosen when the library was compiled by the configure script."
13802 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13804 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13809 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13810 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13814 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13816 "Note that you should call this function as early as possible after creating "
13817 "the handle. This is because some pre-launch operations depend on testing "
13818 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13819 "don't retest features, and so you might see inconsistent results. Using the "
13820 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13821 "the qemu binary at the same time as the handle is created."
13825 #: ../src/guestfs-actions.pod:5555
13826 msgid "guestfs_set_recovery_proc"
13830 #: ../src/guestfs-actions.pod:5557
13834 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13835 " int recoveryproc);\n"
13840 #: ../src/guestfs-actions.pod:5561
13842 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13843 "not create a recovery process. The purpose of the recovery process is to "
13844 "stop runaway qemu processes in the case where the main program aborts "
13849 #: ../src/guestfs-actions.pod:5566
13851 "This only has any effect if called before C<guestfs_launch>, and the default "
13856 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13858 "About the only time when you would want to disable this is if the main "
13859 "process will fork itself into the background (\"daemonize\" itself). In "
13860 "this case the recovery process thinks that the main program has disappeared "
13861 "and so kills qemu, which is not very helpful."
13865 #: ../src/guestfs-actions.pod:5579
13866 msgid "guestfs_set_selinux"
13870 #: ../src/guestfs-actions.pod:5581
13874 " guestfs_set_selinux (guestfs_h *g,\n"
13880 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13882 "This sets the selinux flag that is passed to the appliance at boot time. "
13883 "The default is C<selinux=0> (disabled)."
13887 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13889 "Note that if SELinux is enabled, it is always in Permissive mode "
13890 "(C<enforcing=0>)."
13894 #: ../src/guestfs-actions.pod:5598
13895 msgid "guestfs_set_trace"
13899 #: ../src/guestfs-actions.pod:5600
13903 " guestfs_set_trace (guestfs_h *g,\n"
13909 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13911 "If the command trace flag is set to 1, then commands are printed on stderr "
13912 "before they are executed in a format which is very similar to the one used "
13913 "by guestfish. In other words, you can run a program with this enabled, and "
13914 "you will get out a script which you can feed to guestfish to perform the "
13915 "same set of actions."
13919 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13921 "If you want to trace C API calls into libguestfs (and other libraries) then "
13922 "possibly a better way is to use the external ltrace(1) command."
13926 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13928 "Command traces are disabled unless the environment variable "
13929 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13933 #: ../src/guestfs-actions.pod:5622
13934 msgid "guestfs_set_verbose"
13938 #: ../src/guestfs-actions.pod:5624
13942 " guestfs_set_verbose (guestfs_h *g,\n"
13948 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13949 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13953 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13955 "Verbose messages are disabled unless the environment variable "
13956 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13960 #: ../src/guestfs-actions.pod:5637
13961 msgid "guestfs_setcon"
13965 #: ../src/guestfs-actions.pod:5639
13969 " guestfs_setcon (guestfs_h *g,\n"
13970 " const char *context);\n"
13975 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13977 "This sets the SELinux security context of the daemon to the string "
13982 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13983 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13987 #: ../src/guestfs-actions.pod:5652
13988 msgid "guestfs_setxattr"
13992 #: ../src/guestfs-actions.pod:5654
13996 " guestfs_setxattr (guestfs_h *g,\n"
13997 " const char *xattr,\n"
13998 " const char *val,\n"
14000 " const char *path);\n"
14005 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
14007 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14008 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14012 #: ../src/guestfs-actions.pod:5665
14013 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14017 #: ../src/guestfs-actions.pod:5671
14018 msgid "guestfs_sfdisk"
14022 #: ../src/guestfs-actions.pod:5673
14026 " guestfs_sfdisk (guestfs_h *g,\n"
14027 " const char *device,\n"
14031 " char *const *lines);\n"
14036 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
14038 "This is a direct interface to the L<sfdisk(8)> program for creating "
14039 "partitions on block devices."
14043 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
14044 msgid "C<device> should be a block device, for example C</dev/sda>."
14048 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
14050 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14051 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14052 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14053 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14054 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14055 "the kernel) cannot work out the right geometry and you will need to tell it."
14059 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
14061 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14062 "refer to the L<sfdisk(8)> manpage."
14066 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
14068 "To create a single partition occupying the whole disk, you would pass "
14069 "C<lines> as a single element list, when the single element being the string "
14074 #: ../src/guestfs-actions.pod:5701
14076 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14080 #: ../src/guestfs-actions.pod:5711
14081 msgid "guestfs_sfdiskM"
14085 #: ../src/guestfs-actions.pod:5713
14089 " guestfs_sfdiskM (guestfs_h *g,\n"
14090 " const char *device,\n"
14091 " char *const *lines);\n"
14096 #: ../src/guestfs-actions.pod:5718
14098 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14099 "partition sizes are specified in megabytes only (rounded to the nearest "
14100 "cylinder) and you don't need to specify the cyls, heads and sectors "
14101 "parameters which were rarely if ever used anyway."
14105 #: ../src/guestfs-actions.pod:5724
14107 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14108 "C<guestfs_part_disk>"
14112 #: ../src/guestfs-actions.pod:5734
14113 msgid "guestfs_sfdisk_N"
14117 #: ../src/guestfs-actions.pod:5736
14121 " guestfs_sfdisk_N (guestfs_h *g,\n"
14122 " const char *device,\n"
14127 " const char *line);\n"
14132 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
14134 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14135 "(note: C<n> counts from 1)."
14139 #: ../src/guestfs-actions.pod:5748
14141 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14142 "for the cyls/heads/sectors parameters."
14146 #: ../src/guestfs-actions.pod:5751
14147 msgid "See also: C<guestfs_part_add>"
14151 #: ../src/guestfs-actions.pod:5760
14152 msgid "guestfs_sfdisk_disk_geometry"
14156 #: ../src/guestfs-actions.pod:5762
14160 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14161 " const char *device);\n"
14166 #: ../src/guestfs-actions.pod:5766
14168 "This displays the disk geometry of C<device> read from the partition table. "
14169 "Especially in the case where the underlying block device has been resized, "
14170 "this can be different from the kernel's idea of the geometry (see "
14171 "C<guestfs_sfdisk_kernel_geometry>)."
14175 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787
14176 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14177 msgid "The result is in human-readable format, and not designed to be parsed."
14181 #: ../src/guestfs-actions.pod:5779
14182 msgid "guestfs_sfdisk_kernel_geometry"
14186 #: ../src/guestfs-actions.pod:5781
14190 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14191 " const char *device);\n"
14196 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
14197 msgid "This displays the kernel's idea of the geometry of C<device>."
14201 #: ../src/guestfs-actions.pod:5795
14202 msgid "guestfs_sfdisk_l"
14206 #: ../src/guestfs-actions.pod:5797
14210 " guestfs_sfdisk_l (guestfs_h *g,\n"
14211 " const char *device);\n"
14216 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
14218 "This displays the partition table on C<device>, in the human-readable output "
14219 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14223 #: ../src/guestfs-actions.pod:5805
14224 msgid "See also: C<guestfs_part_list>"
14228 #: ../src/guestfs-actions.pod:5812
14233 #: ../src/guestfs-actions.pod:5814
14237 " guestfs_sh (guestfs_h *g,\n"
14238 " const char *command);\n"
14243 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
14245 "This call runs a command from the guest filesystem via the guest's C</bin/"
14250 #: ../src/guestfs-actions.pod:5821
14251 msgid "This is like C<guestfs_command>, but passes the command to:"
14255 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
14258 " /bin/sh -c \"command\"\n"
14263 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
14265 "Depending on the guest's shell, this usually results in wildcards being "
14266 "expanded, shell expressions being interpolated and so on."
14270 #: ../src/guestfs-actions.pod:5829
14271 msgid "All the provisos about C<guestfs_command> apply to this call."
14275 #: ../src/guestfs-actions.pod:5836
14276 msgid "guestfs_sh_lines"
14280 #: ../src/guestfs-actions.pod:5838
14284 " guestfs_sh_lines (guestfs_h *g,\n"
14285 " const char *command);\n"
14290 #: ../src/guestfs-actions.pod:5842
14292 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14297 #: ../src/guestfs-actions.pod:5845
14298 msgid "See also: C<guestfs_command_lines>"
14302 #: ../src/guestfs-actions.pod:5853
14303 msgid "guestfs_sleep"
14307 #: ../src/guestfs-actions.pod:5855
14311 " guestfs_sleep (guestfs_h *g,\n"
14317 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
14318 msgid "Sleep for C<secs> seconds."
14322 #: ../src/guestfs-actions.pod:5863
14323 msgid "(Added in 1.0.41)"
14327 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
14328 msgid "guestfs_stat"
14332 #: ../src/guestfs-actions.pod:5867
14335 " struct guestfs_stat *\n"
14336 " guestfs_stat (guestfs_h *g,\n"
14337 " const char *path);\n"
14342 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
14343 msgid "This is the same as the C<stat(2)> system call."
14347 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
14348 msgid "guestfs_statvfs"
14352 #: ../src/guestfs-actions.pod:5883
14355 " struct guestfs_statvfs *\n"
14356 " guestfs_statvfs (guestfs_h *g,\n"
14357 " const char *path);\n"
14362 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
14364 "Returns file system statistics for any mounted file system. C<path> should "
14365 "be a file or directory in the mounted file system (typically it is the mount "
14366 "point itself, but it doesn't need to be)."
14370 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
14371 msgid "This is the same as the C<statvfs(2)> system call."
14375 #: ../src/guestfs-actions.pod:5893
14377 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14378 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14382 #: ../src/guestfs-actions.pod:5899
14383 msgid "guestfs_strings"
14387 #: ../src/guestfs-actions.pod:5901
14391 " guestfs_strings (guestfs_h *g,\n"
14392 " const char *path);\n"
14397 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
14399 "This runs the L<strings(1)> command on a file and returns the list of "
14400 "printable strings found."
14404 #: ../src/guestfs-actions.pod:5917
14405 msgid "guestfs_strings_e"
14409 #: ../src/guestfs-actions.pod:5919
14413 " guestfs_strings_e (guestfs_h *g,\n"
14414 " const char *encoding,\n"
14415 " const char *path);\n"
14420 #: ../src/guestfs-actions.pod:5924
14422 "This is like the C<guestfs_strings> command, but allows you to specify the "
14423 "encoding of strings that are looked for in the source file C<path>."
14427 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
14428 msgid "Allowed encodings are:"
14432 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
14437 #: ../src/guestfs-actions.pod:5934
14439 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14440 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14444 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
14449 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
14450 msgid "Single 8-bit-byte characters."
14454 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
14459 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
14460 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14464 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
14465 msgid "l (lower case letter L)"
14469 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
14471 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14472 "examining binaries in Windows guests."
14476 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14481 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14482 msgid "32-bit big endian such as UCS-4BE."
14486 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14491 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14492 msgid "32-bit little endian such as UCS-4LE."
14496 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14497 msgid "The returned strings are transcoded to UTF-8."
14501 #: ../src/guestfs-actions.pod:5972
14502 msgid "guestfs_swapoff_device"
14506 #: ../src/guestfs-actions.pod:5974
14510 " guestfs_swapoff_device (guestfs_h *g,\n"
14511 " const char *device);\n"
14516 #: ../src/guestfs-actions.pod:5978
14518 "This command disables the libguestfs appliance swap device or partition "
14519 "named C<device>. See C<guestfs_swapon_device>."
14523 #: ../src/guestfs-actions.pod:5986
14524 msgid "guestfs_swapoff_file"
14528 #: ../src/guestfs-actions.pod:5988
14532 " guestfs_swapoff_file (guestfs_h *g,\n"
14533 " const char *file);\n"
14538 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14539 msgid "This command disables the libguestfs appliance swap on file."
14543 #: ../src/guestfs-actions.pod:5998
14544 msgid "guestfs_swapoff_label"
14548 #: ../src/guestfs-actions.pod:6000
14552 " guestfs_swapoff_label (guestfs_h *g,\n"
14553 " const char *label);\n"
14558 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14560 "This command disables the libguestfs appliance swap on labeled swap "
14565 #: ../src/guestfs-actions.pod:6011
14566 msgid "guestfs_swapoff_uuid"
14570 #: ../src/guestfs-actions.pod:6013
14574 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14575 " const char *uuid);\n"
14580 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14582 "This command disables the libguestfs appliance swap partition with the given "
14587 #: ../src/guestfs-actions.pod:6024
14588 msgid "guestfs_swapon_device"
14592 #: ../src/guestfs-actions.pod:6026
14596 " guestfs_swapon_device (guestfs_h *g,\n"
14597 " const char *device);\n"
14602 #: ../src/guestfs-actions.pod:6030
14604 "This command enables the libguestfs appliance to use the swap device or "
14605 "partition named C<device>. The increased memory is made available for all "
14606 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14610 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14612 "Note that you should not swap to existing guest swap partitions unless you "
14613 "know what you are doing. They may contain hibernation information, or other "
14614 "information that the guest doesn't want you to trash. You also risk leaking "
14615 "information about the host to the guest this way. Instead, attach a new "
14616 "host device to the guest and swap on that."
14620 #: ../src/guestfs-actions.pod:6046
14621 msgid "guestfs_swapon_file"
14625 #: ../src/guestfs-actions.pod:6048
14629 " guestfs_swapon_file (guestfs_h *g,\n"
14630 " const char *file);\n"
14635 #: ../src/guestfs-actions.pod:6052
14637 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14642 #: ../src/guestfs-actions.pod:6059
14643 msgid "guestfs_swapon_label"
14647 #: ../src/guestfs-actions.pod:6061
14651 " guestfs_swapon_label (guestfs_h *g,\n"
14652 " const char *label);\n"
14657 #: ../src/guestfs-actions.pod:6065
14659 "This command enables swap to a labeled swap partition. See "
14660 "C<guestfs_swapon_device> for other notes."
14664 #: ../src/guestfs-actions.pod:6072
14665 msgid "guestfs_swapon_uuid"
14669 #: ../src/guestfs-actions.pod:6074
14673 " guestfs_swapon_uuid (guestfs_h *g,\n"
14674 " const char *uuid);\n"
14679 #: ../src/guestfs-actions.pod:6078
14681 "This command enables swap to a swap partition with the given UUID. See "
14682 "C<guestfs_swapon_device> for other notes."
14686 #: ../src/guestfs-actions.pod:6085
14687 msgid "guestfs_sync"
14691 #: ../src/guestfs-actions.pod:6087
14695 " guestfs_sync (guestfs_h *g);\n"
14700 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14702 "This syncs the disk, so that any writes are flushed through to the "
14703 "underlying disk image."
14707 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14709 "You should always call this if you have modified a disk image, before "
14710 "closing the handle."
14714 #: ../src/guestfs-actions.pod:6100
14715 msgid "guestfs_tail"
14719 #: ../src/guestfs-actions.pod:6102
14723 " guestfs_tail (guestfs_h *g,\n"
14724 " const char *path);\n"
14729 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14731 "This command returns up to the last 10 lines of a file as a list of strings."
14735 #: ../src/guestfs-actions.pod:6118
14736 msgid "guestfs_tail_n"
14740 #: ../src/guestfs-actions.pod:6120
14744 " guestfs_tail_n (guestfs_h *g,\n"
14746 " const char *path);\n"
14751 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14753 "If the parameter C<nrlines> is a positive number, this returns the last "
14754 "C<nrlines> lines of the file C<path>."
14758 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14760 "If the parameter C<nrlines> is a negative number, this returns lines from "
14761 "the file C<path>, starting with the C<-nrlines>th line."
14765 #: ../src/guestfs-actions.pod:6142
14766 msgid "guestfs_tar_in"
14770 #: ../src/guestfs-actions.pod:6144
14774 " guestfs_tar_in (guestfs_h *g,\n"
14775 " const char *tarfile,\n"
14776 " const char *directory);\n"
14781 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14783 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14784 "tar file) into C<directory>."
14788 #: ../src/guestfs-actions.pod:6152
14790 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14794 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174
14795 #: ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14796 msgid "(Added in 1.0.3)"
14800 #: ../src/guestfs-actions.pod:6159
14801 msgid "guestfs_tar_out"
14805 #: ../src/guestfs-actions.pod:6161
14809 " guestfs_tar_out (guestfs_h *g,\n"
14810 " const char *directory,\n"
14811 " const char *tarfile);\n"
14816 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14818 "This command packs the contents of C<directory> and downloads it to local "
14823 #: ../src/guestfs-actions.pod:6169
14825 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14826 "C<guestfs_txz_out>."
14830 #: ../src/guestfs-actions.pod:6176
14831 msgid "guestfs_tgz_in"
14835 #: ../src/guestfs-actions.pod:6178
14839 " guestfs_tgz_in (guestfs_h *g,\n"
14840 " const char *tarball,\n"
14841 " const char *directory);\n"
14846 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14848 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14849 "tar file) into C<directory>."
14853 #: ../src/guestfs-actions.pod:6186
14854 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14858 #: ../src/guestfs-actions.pod:6192
14859 msgid "guestfs_tgz_out"
14863 #: ../src/guestfs-actions.pod:6194
14867 " guestfs_tgz_out (guestfs_h *g,\n"
14868 " const char *directory,\n"
14869 " const char *tarball);\n"
14874 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14876 "This command packs the contents of C<directory> and downloads it to local "
14881 #: ../src/guestfs-actions.pod:6202
14882 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14886 #: ../src/guestfs-actions.pod:6208
14887 msgid "guestfs_touch"
14891 #: ../src/guestfs-actions.pod:6210
14895 " guestfs_touch (guestfs_h *g,\n"
14896 " const char *path);\n"
14901 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14903 "Touch acts like the L<touch(1)> command. It can be used to update the "
14904 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14909 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14911 "This command only works on regular files, and will fail on other file types "
14912 "such as directories, symbolic links, block special etc."
14916 #: ../src/guestfs-actions.pod:6225
14917 msgid "guestfs_truncate"
14921 #: ../src/guestfs-actions.pod:6227
14925 " guestfs_truncate (guestfs_h *g,\n"
14926 " const char *path);\n"
14931 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14933 "This command truncates C<path> to a zero-length file. The file must exist "
14938 #: ../src/guestfs-actions.pod:6238
14939 msgid "guestfs_truncate_size"
14943 #: ../src/guestfs-actions.pod:6240
14947 " guestfs_truncate_size (guestfs_h *g,\n"
14948 " const char *path,\n"
14949 " int64_t size);\n"
14954 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14956 "This command truncates C<path> to size C<size> bytes. The file must exist "
14961 #: ../src/guestfs-actions.pod:6248
14963 "If the current file size is less than C<size> then the file is extended to "
14964 "the required size with zero bytes. This creates a sparse file (ie. disk "
14965 "blocks are not allocated for the file until you write to it). To create a "
14966 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14970 #: ../src/guestfs-actions.pod:6258
14971 msgid "guestfs_tune2fs_l"
14975 #: ../src/guestfs-actions.pod:6260
14979 " guestfs_tune2fs_l (guestfs_h *g,\n"
14980 " const char *device);\n"
14985 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
14987 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14992 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
14994 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14995 "for more details. The list of fields returned isn't clearly defined, and "
14996 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14997 "and the filesystem itself."
15001 #: ../src/guestfs-actions.pod:6280
15002 msgid "guestfs_txz_in"
15006 #: ../src/guestfs-actions.pod:6282
15010 " guestfs_txz_in (guestfs_h *g,\n"
15011 " const char *tarball,\n"
15012 " const char *directory);\n"
15017 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
15019 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15020 "tar file) into C<directory>."
15024 #: ../src/guestfs-actions.pod:6294
15025 msgid "guestfs_txz_out"
15029 #: ../src/guestfs-actions.pod:6296
15033 " guestfs_txz_out (guestfs_h *g,\n"
15034 " const char *directory,\n"
15035 " const char *tarball);\n"
15040 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
15042 "This command packs the contents of C<directory> and downloads it to local "
15043 "file C<tarball> (as an xz compressed tar archive)."
15047 #: ../src/guestfs-actions.pod:6308
15048 msgid "guestfs_umask"
15052 #: ../src/guestfs-actions.pod:6310
15056 " guestfs_umask (guestfs_h *g,\n"
15062 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
15064 "This function sets the mask used for creating new files and device nodes to "
15069 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
15071 "Typical umask values would be C<022> which creates new files with "
15072 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15073 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15077 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
15079 "The default umask is C<022>. This is important because it means that "
15080 "directories and device nodes will be created with C<0644> or C<0755> mode "
15081 "even if you specify C<0777>."
15085 #: ../src/guestfs-actions.pod:6326
15087 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15088 "C<guestfs_mkdir>."
15092 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
15093 msgid "This call returns the previous umask."
15097 #: ../src/guestfs-actions.pod:6335
15098 msgid "guestfs_umount"
15102 #: ../src/guestfs-actions.pod:6337
15106 " guestfs_umount (guestfs_h *g,\n"
15107 " const char *pathordevice);\n"
15112 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
15114 "This unmounts the given filesystem. The filesystem may be specified either "
15115 "by its mountpoint (path) or the device which contains the filesystem."
15119 #: ../src/guestfs-actions.pod:6349
15120 msgid "guestfs_umount_all"
15124 #: ../src/guestfs-actions.pod:6351
15128 " guestfs_umount_all (guestfs_h *g);\n"
15133 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
15134 msgid "This unmounts all mounted filesystems."
15138 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
15139 msgid "Some internal mounts are not unmounted by this call."
15143 #: ../src/guestfs-actions.pod:6362
15144 msgid "guestfs_upload"
15148 #: ../src/guestfs-actions.pod:6364
15152 " guestfs_upload (guestfs_h *g,\n"
15153 " const char *filename,\n"
15154 " const char *remotefilename);\n"
15159 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388
15160 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15161 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15165 #: ../src/guestfs-actions.pod:6374
15166 msgid "See also C<guestfs_download>."
15170 #: ../src/guestfs-actions.pod:6380
15171 msgid "guestfs_upload_offset"
15175 #: ../src/guestfs-actions.pod:6382
15179 " guestfs_upload_offset (guestfs_h *g,\n"
15180 " const char *filename,\n"
15181 " const char *remotefilename,\n"
15182 " int64_t offset);\n"
15187 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
15189 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15190 "The intention is to overwrite parts of existing files or devices, although "
15191 "if a non-existant file is specified then it is created with a \"hole\" "
15192 "before C<offset>. The size of the data written is implicit in the size of "
15193 "the source C<filename>."
15197 #: ../src/guestfs-actions.pod:6398
15199 "Note that there is no limit on the amount of data that can be uploaded with "
15200 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15201 "full amount unless an error occurs."
15205 #: ../src/guestfs-actions.pod:6403
15206 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15210 #: ../src/guestfs-actions.pod:6409
15211 msgid "guestfs_utimens"
15215 #: ../src/guestfs-actions.pod:6411
15219 " guestfs_utimens (guestfs_h *g,\n"
15220 " const char *path,\n"
15221 " int64_t atsecs,\n"
15222 " int64_t atnsecs,\n"
15223 " int64_t mtsecs,\n"
15224 " int64_t mtnsecs);\n"
15229 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
15230 msgid "This command sets the timestamps of a file with nanosecond precision."
15234 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
15236 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15241 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
15243 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15244 "nanoseconds from the epoch."
15248 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
15250 "If the C<*nsecs> field contains the special value C<-1> then the "
15251 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15252 "ignored in this case)."
15256 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
15258 "If the C<*nsecs> field contains the special value C<-2> then the "
15259 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15264 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
15265 msgid "guestfs_version"
15269 #: ../src/guestfs-actions.pod:6442
15272 " struct guestfs_version *\n"
15273 " guestfs_version (guestfs_h *g);\n"
15278 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
15280 "Return the libguestfs version number that the program is linked against."
15284 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
15286 "Note that because of dynamic linking this is not necessarily the version of "
15287 "libguestfs that you compiled against. You can compile the program, and then "
15288 "at runtime dynamically link against a completely different C<libguestfs.so> "
15293 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
15295 "This call was added in version C<1.0.58>. In previous versions of "
15296 "libguestfs there was no way to get the version number. From C code you can "
15297 "use dynamic linker functions to find out if this symbol exists (if it "
15298 "doesn't, then it's an earlier version)."
15302 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
15304 "The call returns a structure with four elements. The first three (C<major>, "
15305 "C<minor> and C<release>) are numbers and correspond to the usual version "
15306 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15307 "but may be used for distro-specific information."
15311 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
15313 "To construct the original version string: C<$major.$minor.$release$extra>"
15317 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
15318 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15322 #: ../src/guestfs-actions.pod:6470
15324 "I<Note:> Don't use this call to test for availability of features. In "
15325 "enterprise distributions we backport features from later versions into "
15326 "earlier versions, making this an unreliable way to test for features. Use "
15327 "C<guestfs_available> instead."
15331 #: ../src/guestfs-actions.pod:6476
15333 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15334 "error. I<The caller must call C<guestfs_free_version> after use>."
15338 #: ../src/guestfs-actions.pod:6480
15339 msgid "(Added in 1.0.58)"
15343 #: ../src/guestfs-actions.pod:6482
15344 msgid "guestfs_vfs_label"
15348 #: ../src/guestfs-actions.pod:6484
15352 " guestfs_vfs_label (guestfs_h *g,\n"
15353 " const char *device);\n"
15358 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
15359 msgid "This returns the filesystem label of the filesystem on C<device>."
15363 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
15364 msgid "If the filesystem is unlabeled, this returns the empty string."
15368 #: ../src/guestfs-actions.pod:6493
15369 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15373 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
15374 msgid "(Added in 1.3.18)"
15378 #: ../src/guestfs-actions.pod:6500
15379 msgid "guestfs_vfs_type"
15383 #: ../src/guestfs-actions.pod:6502
15387 " guestfs_vfs_type (guestfs_h *g,\n"
15388 " const char *device);\n"
15393 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
15395 "This command gets the filesystem type corresponding to the filesystem on "
15400 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
15402 "For most filesystems, the result is the name of the Linux VFS module which "
15403 "would be used to mount this filesystem if you mounted it without specifying "
15404 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15408 #: ../src/guestfs-actions.pod:6519
15409 msgid "guestfs_vfs_uuid"
15413 #: ../src/guestfs-actions.pod:6521
15417 " guestfs_vfs_uuid (guestfs_h *g,\n"
15418 " const char *device);\n"
15423 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
15424 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15428 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
15429 msgid "If the filesystem does not have a UUID, this returns the empty string."
15433 #: ../src/guestfs-actions.pod:6530
15434 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15438 #: ../src/guestfs-actions.pod:6537
15439 msgid "guestfs_vg_activate"
15443 #: ../src/guestfs-actions.pod:6539
15447 " guestfs_vg_activate (guestfs_h *g,\n"
15449 " char *const *volgroups);\n"
15454 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
15456 "This command activates or (if C<activate> is false) deactivates all logical "
15457 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15458 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15459 "deactivated, then those devices disappear."
15463 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
15464 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15468 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
15470 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15471 "activated or deactivated."
15475 #: ../src/guestfs-actions.pod:6559
15476 msgid "guestfs_vg_activate_all"
15480 #: ../src/guestfs-actions.pod:6561
15484 " guestfs_vg_activate_all (guestfs_h *g,\n"
15485 " int activate);\n"
15490 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15492 "This command activates or (if C<activate> is false) deactivates all logical "
15493 "volumes in all volume groups. If activated, then they are made known to the "
15494 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15495 "those devices disappear."
15499 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15500 msgid "This command is the same as running C<vgchange -a y|n>"
15504 #: ../src/guestfs-actions.pod:6577
15505 msgid "guestfs_vgcreate"
15509 #: ../src/guestfs-actions.pod:6579
15513 " guestfs_vgcreate (guestfs_h *g,\n"
15514 " const char *volgroup,\n"
15515 " char *const *physvols);\n"
15520 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15522 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15523 "of physical volumes C<physvols>."
15527 #: ../src/guestfs-actions.pod:6591
15528 msgid "guestfs_vglvuuids"
15532 #: ../src/guestfs-actions.pod:6593
15536 " guestfs_vglvuuids (guestfs_h *g,\n"
15537 " const char *vgname);\n"
15542 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15544 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15545 "volumes created in this volume group."
15549 #: ../src/guestfs-actions.pod:6600
15551 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15552 "associate logical volumes and volume groups."
15556 #: ../src/guestfs-actions.pod:6603
15557 msgid "See also C<guestfs_vgpvuuids>."
15561 #: ../src/guestfs-actions.pod:6611
15562 msgid "guestfs_vgpvuuids"
15566 #: ../src/guestfs-actions.pod:6613
15570 " guestfs_vgpvuuids (guestfs_h *g,\n"
15571 " const char *vgname);\n"
15576 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15578 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15579 "volumes that this volume group resides on."
15583 #: ../src/guestfs-actions.pod:6620
15585 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15586 "associate physical volumes and volume groups."
15590 #: ../src/guestfs-actions.pod:6623
15591 msgid "See also C<guestfs_vglvuuids>."
15595 #: ../src/guestfs-actions.pod:6631
15596 msgid "guestfs_vgremove"
15600 #: ../src/guestfs-actions.pod:6633
15604 " guestfs_vgremove (guestfs_h *g,\n"
15605 " const char *vgname);\n"
15610 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15611 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15615 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15617 "This also forcibly removes all logical volumes in the volume group (if any)."
15621 #: ../src/guestfs-actions.pod:6646
15622 msgid "guestfs_vgrename"
15626 #: ../src/guestfs-actions.pod:6648
15630 " guestfs_vgrename (guestfs_h *g,\n"
15631 " const char *volgroup,\n"
15632 " const char *newvolgroup);\n"
15637 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15638 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15642 #: ../src/guestfs-actions.pod:6659
15643 msgid "guestfs_vgs"
15647 #: ../src/guestfs-actions.pod:6661
15651 " guestfs_vgs (guestfs_h *g);\n"
15656 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15658 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15663 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15665 "This returns a list of just the volume group names that were detected (eg. "
15670 #: ../src/guestfs-actions.pod:6670
15671 msgid "See also C<guestfs_vgs_full>."
15675 #: ../src/guestfs-actions.pod:6678
15676 msgid "guestfs_vgs_full"
15680 #: ../src/guestfs-actions.pod:6680
15683 " struct guestfs_lvm_vg_list *\n"
15684 " guestfs_vgs_full (guestfs_h *g);\n"
15689 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15691 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15692 "> command. The \"full\" version includes all fields."
15696 #: ../src/guestfs-actions.pod:6686
15698 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15699 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15703 #: ../src/guestfs-actions.pod:6692
15704 msgid "guestfs_vgscan"
15708 #: ../src/guestfs-actions.pod:6694
15712 " guestfs_vgscan (guestfs_h *g);\n"
15717 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15719 "This rescans all block devices and rebuilds the list of LVM physical "
15720 "volumes, volume groups and logical volumes."
15724 #: ../src/guestfs-actions.pod:6704
15725 msgid "guestfs_vguuid"
15729 #: ../src/guestfs-actions.pod:6706
15733 " guestfs_vguuid (guestfs_h *g,\n"
15734 " const char *vgname);\n"
15739 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15740 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15744 #: ../src/guestfs-actions.pod:6717
15745 msgid "guestfs_wait_ready"
15749 #: ../src/guestfs-actions.pod:6719
15753 " guestfs_wait_ready (guestfs_h *g);\n"
15758 #: ../src/guestfs-actions.pod:6722
15759 msgid "This function is a no op."
15763 #: ../src/guestfs-actions.pod:6724
15765 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15766 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15767 "is no longer necessary because C<guestfs_launch> now does the waiting."
15771 #: ../src/guestfs-actions.pod:6729
15773 "If you see any calls to this function in code then you can just remove them, "
15774 "unless you want to retain compatibility with older versions of the API."
15778 #: ../src/guestfs-actions.pod:6737
15779 msgid "guestfs_wc_c"
15783 #: ../src/guestfs-actions.pod:6739
15787 " guestfs_wc_c (guestfs_h *g,\n"
15788 " const char *path);\n"
15793 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15795 "This command counts the characters in a file, using the C<wc -c> external "
15800 #: ../src/guestfs-actions.pod:6750
15801 msgid "guestfs_wc_l"
15805 #: ../src/guestfs-actions.pod:6752
15809 " guestfs_wc_l (guestfs_h *g,\n"
15810 " const char *path);\n"
15815 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15817 "This command counts the lines in a file, using the C<wc -l> external command."
15821 #: ../src/guestfs-actions.pod:6763
15822 msgid "guestfs_wc_w"
15826 #: ../src/guestfs-actions.pod:6765
15830 " guestfs_wc_w (guestfs_h *g,\n"
15831 " const char *path);\n"
15836 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15838 "This command counts the words in a file, using the C<wc -w> external command."
15842 #: ../src/guestfs-actions.pod:6776
15843 msgid "guestfs_write"
15847 #: ../src/guestfs-actions.pod:6778
15851 " guestfs_write (guestfs_h *g,\n"
15852 " const char *path,\n"
15853 " const char *content,\n"
15854 " size_t content_size);\n"
15859 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15861 "This call creates a file called C<path>. The content of the file is the "
15862 "string C<content> (which can contain any 8 bit data)."
15866 #: ../src/guestfs-actions.pod:6794
15867 msgid "guestfs_write_file"
15871 #: ../src/guestfs-actions.pod:6796
15875 " guestfs_write_file (guestfs_h *g,\n"
15876 " const char *path,\n"
15877 " const char *content,\n"
15883 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15885 "This call creates a file called C<path>. The contents of the file is the "
15886 "string C<content> (which can contain any 8 bit data), with length C<size>."
15890 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15892 "As a special case, if C<size> is C<0> then the length is calculated using "
15893 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15897 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15899 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15900 "I<not> work, even if the length is specified."
15904 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15906 "This function is deprecated. In new code, use the C<write> call instead."
15910 #: ../src/guestfs-actions.pod:6827
15911 msgid "guestfs_zegrep"
15915 #: ../src/guestfs-actions.pod:6829
15919 " guestfs_zegrep (guestfs_h *g,\n"
15920 " const char *regex,\n"
15921 " const char *path);\n"
15926 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15928 "This calls the external C<zegrep> program and returns the matching lines."
15932 #: ../src/guestfs-actions.pod:6846
15933 msgid "guestfs_zegrepi"
15937 #: ../src/guestfs-actions.pod:6848
15941 " guestfs_zegrepi (guestfs_h *g,\n"
15942 " const char *regex,\n"
15943 " const char *path);\n"
15948 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15950 "This calls the external C<zegrep -i> program and returns the matching lines."
15954 #: ../src/guestfs-actions.pod:6865
15955 msgid "guestfs_zero"
15959 #: ../src/guestfs-actions.pod:6867
15963 " guestfs_zero (guestfs_h *g,\n"
15964 " const char *device);\n"
15969 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15970 msgid "This command writes zeroes over the first few blocks of C<device>."
15974 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15976 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15977 "securely wipe the device). It should be sufficient to remove any partition "
15978 "tables, filesystem superblocks and so on."
15982 #: ../src/guestfs-actions.pod:6877
15983 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15987 #: ../src/guestfs-actions.pod:6888
15988 msgid "guestfs_zero_device"
15992 #: ../src/guestfs-actions.pod:6890
15996 " guestfs_zero_device (guestfs_h *g,\n"
15997 " const char *device);\n"
16002 #: ../src/guestfs-actions.pod:6894
16004 "This command writes zeroes over the entire C<device>. Compare with "
16005 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16009 #: ../src/guestfs-actions.pod:6908
16010 msgid "(Added in 1.3.1)"
16014 #: ../src/guestfs-actions.pod:6910
16015 msgid "guestfs_zerofree"
16019 #: ../src/guestfs-actions.pod:6912
16023 " guestfs_zerofree (guestfs_h *g,\n"
16024 " const char *device);\n"
16029 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
16031 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16032 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16033 "possible to compress the filesystem more effectively."
16037 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
16038 msgid "You should B<not> run this program if the filesystem is mounted."
16042 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
16044 "It is possible that using this program can damage the filesystem or data on "
16049 #: ../src/guestfs-actions.pod:6931
16050 msgid "guestfs_zfgrep"
16054 #: ../src/guestfs-actions.pod:6933
16058 " guestfs_zfgrep (guestfs_h *g,\n"
16059 " const char *pattern,\n"
16060 " const char *path);\n"
16065 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
16067 "This calls the external C<zfgrep> program and returns the matching lines."
16071 #: ../src/guestfs-actions.pod:6950
16072 msgid "guestfs_zfgrepi"
16076 #: ../src/guestfs-actions.pod:6952
16080 " guestfs_zfgrepi (guestfs_h *g,\n"
16081 " const char *pattern,\n"
16082 " const char *path);\n"
16087 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
16089 "This calls the external C<zfgrep -i> program and returns the matching lines."
16093 #: ../src/guestfs-actions.pod:6969
16094 msgid "guestfs_zfile"
16098 #: ../src/guestfs-actions.pod:6971
16102 " guestfs_zfile (guestfs_h *g,\n"
16103 " const char *meth,\n"
16104 " const char *path);\n"
16109 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
16111 "This command runs C<file> after first decompressing C<path> using C<method>."
16115 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
16116 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16120 #: ../src/guestfs-actions.pod:6981
16122 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16127 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
16129 "This function is deprecated. In new code, use the C<file> call instead."
16133 #: ../src/guestfs-actions.pod:6996
16134 msgid "guestfs_zgrep"
16138 #: ../src/guestfs-actions.pod:6998
16142 " guestfs_zgrep (guestfs_h *g,\n"
16143 " const char *regex,\n"
16144 " const char *path);\n"
16149 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
16151 "This calls the external C<zgrep> program and returns the matching lines."
16155 #: ../src/guestfs-actions.pod:7015
16156 msgid "guestfs_zgrepi"
16160 #: ../src/guestfs-actions.pod:7017
16164 " guestfs_zgrepi (guestfs_h *g,\n"
16165 " const char *regex,\n"
16166 " const char *path);\n"
16171 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
16173 "This calls the external C<zgrep -i> program and returns the matching lines."
16177 #: ../src/guestfs-availability.pod:3
16182 #: ../src/guestfs-availability.pod:5
16184 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16185 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16186 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16187 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16188 "L</guestfs_aug_save> L</guestfs_aug_set>"
16192 #: ../src/guestfs-availability.pod:21
16197 #: ../src/guestfs-availability.pod:23
16199 "The following functions: L</guestfs_inotify_add_watch> L</"
16200 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16201 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16205 #: ../src/guestfs-availability.pod:31
16206 msgid "B<linuxfsuuid>"
16210 #: ../src/guestfs-availability.pod:33
16212 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16213 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16217 #: ../src/guestfs-availability.pod:40
16218 msgid "B<linuxmodules>"
16222 #: ../src/guestfs-availability.pod:42
16223 msgid "The following functions: L</guestfs_modprobe>"
16227 #: ../src/guestfs-availability.pod:45
16228 msgid "B<linuxxattrs>"
16232 #: ../src/guestfs-availability.pod:47
16234 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16235 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16236 "guestfs_removexattr> L</guestfs_setxattr>"
16240 #: ../src/guestfs-availability.pod:56
16245 #: ../src/guestfs-availability.pod:58
16247 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16248 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16249 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16253 #: ../src/guestfs-availability.pod:67
16258 #: ../src/guestfs-availability.pod:69
16260 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16261 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16262 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16263 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16264 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16265 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16266 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16270 #: ../src/guestfs-availability.pod:92
16275 #: ../src/guestfs-availability.pod:94
16277 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16278 "guestfs_mknod_b> L</guestfs_mknod_c>"
16282 #: ../src/guestfs-availability.pod:100
16287 #: ../src/guestfs-availability.pod:102
16288 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16292 #: ../src/guestfs-availability.pod:105
16293 msgid "B<ntfsprogs>"
16297 #: ../src/guestfs-availability.pod:107
16299 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16303 #: ../src/guestfs-availability.pod:111
16304 msgid "B<realpath>"
16308 #: ../src/guestfs-availability.pod:113
16309 msgid "The following functions: L</guestfs_realpath>"
16313 #: ../src/guestfs-availability.pod:116
16318 #: ../src/guestfs-availability.pod:118
16320 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16321 "guestfs_scrub_freespace>"
16325 #: ../src/guestfs-availability.pod:123
16330 #: ../src/guestfs-availability.pod:125
16331 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16335 #: ../src/guestfs-availability.pod:129
16340 #: ../src/guestfs-availability.pod:131
16341 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16345 #: ../src/guestfs-availability.pod:135
16346 msgid "B<zerofree>"
16350 #: ../src/guestfs-availability.pod:137
16351 msgid "The following functions: L</guestfs_zerofree>"
16355 #: ../src/guestfs-structs.pod:1
16356 msgid "guestfs_int_bool"
16360 #: ../src/guestfs-structs.pod:3
16363 " struct guestfs_int_bool {\n"
16371 #: ../src/guestfs-structs.pod:8
16374 " struct guestfs_int_bool_list {\n"
16375 " uint32_t len; /* Number of elements in list. */\n"
16376 " struct guestfs_int_bool *val; /* Elements. */\n"
16382 #: ../src/guestfs-structs.pod:13
16385 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16386 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16391 #: ../src/guestfs-structs.pod:16
16392 msgid "guestfs_lvm_pv"
16396 #: ../src/guestfs-structs.pod:18
16399 " struct guestfs_lvm_pv {\n"
16400 " char *pv_name;\n"
16401 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16402 " char pv_uuid[32];\n"
16404 " uint64_t pv_size;\n"
16405 " uint64_t dev_size;\n"
16406 " uint64_t pv_free;\n"
16407 " uint64_t pv_used;\n"
16408 " char *pv_attr;\n"
16409 " int64_t pv_pe_count;\n"
16410 " int64_t pv_pe_alloc_count;\n"
16411 " char *pv_tags;\n"
16412 " uint64_t pe_start;\n"
16413 " int64_t pv_mda_count;\n"
16414 " uint64_t pv_mda_free;\n"
16420 #: ../src/guestfs-structs.pod:36
16423 " struct guestfs_lvm_pv_list {\n"
16424 " uint32_t len; /* Number of elements in list. */\n"
16425 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16431 #: ../src/guestfs-structs.pod:41
16434 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16435 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16440 #: ../src/guestfs-structs.pod:44
16441 msgid "guestfs_lvm_vg"
16445 #: ../src/guestfs-structs.pod:46
16448 " struct guestfs_lvm_vg {\n"
16449 " char *vg_name;\n"
16450 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16451 " char vg_uuid[32];\n"
16453 " char *vg_attr;\n"
16454 " uint64_t vg_size;\n"
16455 " uint64_t vg_free;\n"
16456 " char *vg_sysid;\n"
16457 " uint64_t vg_extent_size;\n"
16458 " int64_t vg_extent_count;\n"
16459 " int64_t vg_free_count;\n"
16460 " int64_t max_lv;\n"
16461 " int64_t max_pv;\n"
16462 " int64_t pv_count;\n"
16463 " int64_t lv_count;\n"
16464 " int64_t snap_count;\n"
16465 " int64_t vg_seqno;\n"
16466 " char *vg_tags;\n"
16467 " int64_t vg_mda_count;\n"
16468 " uint64_t vg_mda_free;\n"
16474 #: ../src/guestfs-structs.pod:69
16477 " struct guestfs_lvm_vg_list {\n"
16478 " uint32_t len; /* Number of elements in list. */\n"
16479 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16485 #: ../src/guestfs-structs.pod:74
16488 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16489 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16494 #: ../src/guestfs-structs.pod:77
16495 msgid "guestfs_lvm_lv"
16499 #: ../src/guestfs-structs.pod:79
16502 " struct guestfs_lvm_lv {\n"
16503 " char *lv_name;\n"
16504 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16505 " char lv_uuid[32];\n"
16506 " char *lv_attr;\n"
16507 " int64_t lv_major;\n"
16508 " int64_t lv_minor;\n"
16509 " int64_t lv_kernel_major;\n"
16510 " int64_t lv_kernel_minor;\n"
16511 " uint64_t lv_size;\n"
16512 " int64_t seg_count;\n"
16514 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16515 " float snap_percent;\n"
16516 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16517 " float copy_percent;\n"
16518 " char *move_pv;\n"
16519 " char *lv_tags;\n"
16520 " char *mirror_log;\n"
16521 " char *modules;\n"
16527 #: ../src/guestfs-structs.pod:101
16530 " struct guestfs_lvm_lv_list {\n"
16531 " uint32_t len; /* Number of elements in list. */\n"
16532 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16538 #: ../src/guestfs-structs.pod:106
16541 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16542 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16547 #: ../src/guestfs-structs.pod:111
16550 " struct guestfs_stat {\n"
16554 " int64_t nlink;\n"
16559 " int64_t blksize;\n"
16560 " int64_t blocks;\n"
16561 " int64_t atime;\n"
16562 " int64_t mtime;\n"
16563 " int64_t ctime;\n"
16569 #: ../src/guestfs-structs.pod:127
16572 " struct guestfs_stat_list {\n"
16573 " uint32_t len; /* Number of elements in list. */\n"
16574 " struct guestfs_stat *val; /* Elements. */\n"
16580 #: ../src/guestfs-structs.pod:132
16583 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16584 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16589 #: ../src/guestfs-structs.pod:137
16592 " struct guestfs_statvfs {\n"
16593 " int64_t bsize;\n"
16594 " int64_t frsize;\n"
16595 " int64_t blocks;\n"
16596 " int64_t bfree;\n"
16597 " int64_t bavail;\n"
16598 " int64_t files;\n"
16599 " int64_t ffree;\n"
16600 " int64_t favail;\n"
16603 " int64_t namemax;\n"
16609 #: ../src/guestfs-structs.pod:151
16612 " struct guestfs_statvfs_list {\n"
16613 " uint32_t len; /* Number of elements in list. */\n"
16614 " struct guestfs_statvfs *val; /* Elements. */\n"
16620 #: ../src/guestfs-structs.pod:156
16623 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16624 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16629 #: ../src/guestfs-structs.pod:159
16630 msgid "guestfs_dirent"
16634 #: ../src/guestfs-structs.pod:161
16637 " struct guestfs_dirent {\n"
16646 #: ../src/guestfs-structs.pod:167
16649 " struct guestfs_dirent_list {\n"
16650 " uint32_t len; /* Number of elements in list. */\n"
16651 " struct guestfs_dirent *val; /* Elements. */\n"
16657 #: ../src/guestfs-structs.pod:172
16660 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16661 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16666 #: ../src/guestfs-structs.pod:177
16669 " struct guestfs_version {\n"
16670 " int64_t major;\n"
16671 " int64_t minor;\n"
16672 " int64_t release;\n"
16679 #: ../src/guestfs-structs.pod:184
16682 " struct guestfs_version_list {\n"
16683 " uint32_t len; /* Number of elements in list. */\n"
16684 " struct guestfs_version *val; /* Elements. */\n"
16690 #: ../src/guestfs-structs.pod:189
16693 " void guestfs_free_version (struct guestfs_free_version *);\n"
16694 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16699 #: ../src/guestfs-structs.pod:192
16700 msgid "guestfs_xattr"
16704 #: ../src/guestfs-structs.pod:194
16707 " struct guestfs_xattr {\n"
16708 " char *attrname;\n"
16709 " /* The next two fields describe a byte array. */\n"
16710 " uint32_t attrval_len;\n"
16711 " char *attrval;\n"
16717 #: ../src/guestfs-structs.pod:201
16720 " struct guestfs_xattr_list {\n"
16721 " uint32_t len; /* Number of elements in list. */\n"
16722 " struct guestfs_xattr *val; /* Elements. */\n"
16728 #: ../src/guestfs-structs.pod:206
16731 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16732 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16737 #: ../src/guestfs-structs.pod:209
16738 msgid "guestfs_inotify_event"
16742 #: ../src/guestfs-structs.pod:211
16745 " struct guestfs_inotify_event {\n"
16746 " int64_t in_wd;\n"
16747 " uint32_t in_mask;\n"
16748 " uint32_t in_cookie;\n"
16749 " char *in_name;\n"
16755 #: ../src/guestfs-structs.pod:218
16758 " struct guestfs_inotify_event_list {\n"
16759 " uint32_t len; /* Number of elements in list. */\n"
16760 " struct guestfs_inotify_event *val; /* Elements. */\n"
16766 #: ../src/guestfs-structs.pod:223
16769 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16770 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16775 #: ../src/guestfs-structs.pod:226
16776 msgid "guestfs_partition"
16780 #: ../src/guestfs-structs.pod:228
16783 " struct guestfs_partition {\n"
16784 " int32_t part_num;\n"
16785 " uint64_t part_start;\n"
16786 " uint64_t part_end;\n"
16787 " uint64_t part_size;\n"
16793 #: ../src/guestfs-structs.pod:235
16796 " struct guestfs_partition_list {\n"
16797 " uint32_t len; /* Number of elements in list. */\n"
16798 " struct guestfs_partition *val; /* Elements. */\n"
16804 #: ../src/guestfs-structs.pod:240
16807 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16808 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16813 #: ../src/guestfs-structs.pod:243
16814 msgid "guestfs_application"
16818 #: ../src/guestfs-structs.pod:245
16821 " struct guestfs_application {\n"
16822 " char *app_name;\n"
16823 " char *app_display_name;\n"
16824 " int32_t app_epoch;\n"
16825 " char *app_version;\n"
16826 " char *app_release;\n"
16827 " char *app_install_path;\n"
16828 " char *app_trans_path;\n"
16829 " char *app_publisher;\n"
16830 " char *app_url;\n"
16831 " char *app_source_package;\n"
16832 " char *app_summary;\n"
16833 " char *app_description;\n"
16839 #: ../src/guestfs-structs.pod:260
16842 " struct guestfs_application_list {\n"
16843 " uint32_t len; /* Number of elements in list. */\n"
16844 " struct guestfs_application *val; /* Elements. */\n"
16850 #: ../src/guestfs-structs.pod:265
16853 " void guestfs_free_application (struct guestfs_free_application *);\n"
16854 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16859 #: ../fish/guestfish.pod:5
16860 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16864 #: ../fish/guestfish.pod:9
16867 " guestfish [--options] [commands]\n"
16872 #: ../fish/guestfish.pod:11
16880 #: ../fish/guestfish.pod:13
16883 " guestfish [--ro|--rw] -a disk.img\n"
16888 #: ../fish/guestfish.pod:15
16891 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16896 #: ../fish/guestfish.pod:17
16899 " guestfish -d libvirt-domain\n"
16904 #: ../fish/guestfish.pod:19
16907 " guestfish [--ro|--rw] -a disk.img -i\n"
16912 #: ../fish/guestfish.pod:21
16915 " guestfish -d libvirt-domain -i\n"
16920 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16921 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16926 #: ../fish/guestfish.pod:25
16928 "Using guestfish in read/write mode on live virtual machines can be "
16929 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16930 "option to use guestfish safely if the disk image or virtual machine might be "
16935 #: ../fish/guestfish.pod:32
16937 "Guestfish is a shell and command-line tool for examining and modifying "
16938 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16939 "functionality of the guestfs API, see L<guestfs(3)>."
16943 #: ../fish/guestfish.pod:36
16945 "Guestfish gives you structured access to the libguestfs API, from shell "
16946 "scripts or the command line or interactively. If you want to rescue a "
16947 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16952 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847
16953 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16954 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16959 #: ../fish/guestfish.pod:43
16960 msgid "As an interactive shell"
16964 #: ../fish/guestfish.pod:45
16972 #: ../fish/guestfish.pod:47
16975 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16976 " editing virtual machine filesystems.\n"
16981 #: ../fish/guestfish.pod:50
16984 " Type: 'help' for a list of commands\n"
16985 " 'man' to read the manual\n"
16986 " 'quit' to quit the shell\n"
16991 #: ../fish/guestfish.pod:54
16994 " ><fs> add-ro disk.img\n"
16996 " ><fs> list-filesystems\n"
16997 " /dev/sda1: ext4\n"
16998 " /dev/vg_guest/lv_root: ext4\n"
16999 " /dev/vg_guest/lv_swap: swap\n"
17000 " ><fs> mount /dev/vg_guest/lv_root /\n"
17001 " ><fs> cat /etc/fstab\n"
17003 " # Created by anaconda\n"
17010 #: ../fish/guestfish.pod:67
17011 msgid "From shell scripts"
17015 #: ../fish/guestfish.pod:69
17016 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17020 #: ../fish/guestfish.pod:71
17023 " guestfish <<_EOF_\n"
17026 " mount /dev/vg_guest/lv_root /\n"
17027 " write /etc/motd \"Welcome, new users\"\n"
17033 #: ../fish/guestfish.pod:78
17034 msgid "List the LVM logical volumes in a disk image:"
17038 #: ../fish/guestfish.pod:80
17041 " guestfish -a disk.img --ro <<_EOF_\n"
17049 #: ../fish/guestfish.pod:85
17050 msgid "List all the filesystems in a disk image:"
17054 #: ../fish/guestfish.pod:87
17057 " guestfish -a disk.img --ro <<_EOF_\n"
17059 " list-filesystems\n"
17065 #: ../fish/guestfish.pod:92
17066 msgid "On one command line"
17070 #: ../fish/guestfish.pod:94
17071 msgid "Update C</etc/resolv.conf> in a guest:"
17075 #: ../fish/guestfish.pod:96
17079 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17080 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17085 #: ../fish/guestfish.pod:100
17086 msgid "Edit C</boot/grub/grub.conf> interactively:"
17090 #: ../fish/guestfish.pod:102
17093 " guestfish --rw --add disk.img \\\n"
17094 " --mount /dev/vg_guest/lv_root \\\n"
17095 " --mount /dev/sda1:/boot \\\n"
17096 " edit /boot/grub/grub.conf\n"
17101 #: ../fish/guestfish.pod:107
17102 msgid "Mount disks automatically"
17106 #: ../fish/guestfish.pod:109
17108 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17112 #: ../fish/guestfish.pod:112
17115 " guestfish --ro -a disk.img -i cat /etc/group\n"
17120 #: ../fish/guestfish.pod:114
17123 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17128 #: ../fish/guestfish.pod:116
17129 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17133 #: ../fish/guestfish.pod:118
17136 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17141 #: ../fish/guestfish.pod:120
17142 msgid "As a script interpreter"
17146 #: ../fish/guestfish.pod:122
17147 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17151 #: ../fish/guestfish.pod:124
17154 " #!/usr/bin/guestfish -f\n"
17155 " sparse test1.img 100M\n"
17157 " part-disk /dev/sda mbr\n"
17158 " mkfs ext2 /dev/sda1\n"
17163 #: ../fish/guestfish.pod:130
17164 msgid "Start with a prepared disk"
17168 #: ../fish/guestfish.pod:132
17170 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17171 "single ext2-formatted partition:"
17175 #: ../fish/guestfish.pod:135
17178 " guestfish -N fs\n"
17183 #: ../fish/guestfish.pod:137
17184 msgid "To list what is available do:"
17188 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
17191 " guestfish -N help | less\n"
17196 #: ../fish/guestfish.pod:141
17197 msgid "Remote control"
17201 #: ../fish/guestfish.pod:143
17204 " eval \"`guestfish --listen`\"\n"
17205 " guestfish --remote add-ro disk.img\n"
17206 " guestfish --remote run\n"
17207 " guestfish --remote lvs\n"
17212 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17213 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
17214 #: ../tools/virt-win-reg.pl:171 ../tools/virt-resize.pl:256
17215 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
17216 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17221 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17222 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179
17223 #: ../tools/virt-resize.pl:264 ../tools/virt-list-filesystems.pl:61
17224 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
17225 #: ../tools/virt-list-partitions.pl:62
17230 #: ../fish/guestfish.pod:154
17231 msgid "Displays general help on options."
17235 #: ../fish/guestfish.pod:156
17236 msgid "B<-h> | B<--cmd-help>"
17240 #: ../fish/guestfish.pod:158
17241 msgid "Lists all available guestfish commands."
17245 #: ../fish/guestfish.pod:160
17246 msgid "B<-h cmd> | B<--cmd-help cmd>"
17250 #: ../fish/guestfish.pod:162
17251 msgid "Displays detailed help on a single command C<cmd>."
17255 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17256 msgid "B<-a image> | B<--add image>"
17260 #: ../fish/guestfish.pod:166
17261 msgid "Add a block device or virtual machine image to the shell."
17265 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17267 "The format of the disk image is auto-detected. To override this and force a "
17268 "particular format use the I<--format=..> option."
17272 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17273 msgid "B<-c URI> | B<--connect URI>"
17277 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17279 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17280 "URI to use. The default is to use the default libvirt connection."
17284 #: ../fish/guestfish.pod:177
17289 #: ../fish/guestfish.pod:179
17291 "If using the I<--listen> option and a csh-like shell, use this option. See "
17292 "section L</REMOTE CONTROL AND CSH> below."
17296 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17297 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17301 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17303 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17304 "used, then any libvirt domain can be used. However in write mode, only "
17305 "libvirt domains which are shut down can be named here."
17309 #: ../fish/guestfish.pod:188
17310 msgid "B<-D> | B<--no-dest-paths>"
17314 #: ../fish/guestfish.pod:190
17316 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17317 "to hit the tab key to complete paths on the guest filesystem, but this "
17318 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17319 "allow this feature to be disabled."
17323 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17324 msgid "B<--echo-keys>"
17328 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17330 "When prompting for keys and passphrases, guestfish normally turns echoing "
17331 "off so you cannot see what you are typing. If you are not worried about "
17332 "Tempest attacks and there is no one else in the room you can specify this "
17333 "flag to see what you are typing."
17337 #: ../fish/guestfish.pod:202
17338 msgid "B<-f file> | B<--file file>"
17342 #: ../fish/guestfish.pod:204
17343 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17347 #: ../fish/guestfish.pod:207
17350 " #!/usr/bin/guestfish -f\n"
17355 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17356 msgid "B<--format=raw|qcow2|..> | B<--format>"
17360 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17362 "The default for the I<-a> option is to auto-detect the format of the disk "
17363 "image. Using this forces the disk format for I<-a> options which follow on "
17364 "the command line. Using I<--format> with no argument switches back to auto-"
17365 "detection for subsequent I<-a> options."
17369 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17370 msgid "For example:"
17374 #: ../fish/guestfish.pod:218
17377 " guestfish --format=raw -a disk.img\n"
17382 #: ../fish/guestfish.pod:220
17383 msgid "forces raw format (no auto-detection) for C<disk.img>."
17387 #: ../fish/guestfish.pod:222
17390 " guestfish --format=raw -a disk.img --format -a another.img\n"
17395 #: ../fish/guestfish.pod:224
17397 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17398 "detection for C<another.img>."
17402 #: ../fish/guestfish.pod:227
17404 "If you have untrusted raw-format guest disk images, you should use this "
17405 "option to specify the disk format. This avoids a possible security problem "
17406 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17410 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17411 msgid "B<-i> | B<--inspector>"
17415 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17417 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17418 "system and mount filesystems as they would be mounted on the real virtual "
17423 #: ../fish/guestfish.pod:238
17424 msgid "Typical usage is either:"
17428 #: ../fish/guestfish.pod:240
17431 " guestfish -d myguest -i\n"
17436 #: ../fish/guestfish.pod:242
17437 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17441 #: ../fish/guestfish.pod:244
17444 " guestfish --ro -d myguest -i\n"
17449 #: ../fish/guestfish.pod:246
17450 msgid "(for active domains, readonly), or specify the block device directly:"
17454 #: ../fish/guestfish.pod:248
17457 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17462 #: ../fish/guestfish.pod:250
17464 "Note that the command line syntax changed slightly over older versions of "
17465 "guestfish. You can still use the old syntax:"
17469 #: ../fish/guestfish.pod:253
17472 " guestfish [--ro] -i disk.img\n"
17477 #: ../fish/guestfish.pod:255
17480 " guestfish [--ro] -i libvirt-domain\n"
17485 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17486 msgid "B<--keys-from-stdin>"
17490 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17492 "Read key or passphrase parameters from stdin. The default is to try to read "
17493 "passphrases from the user by opening C</dev/tty>."
17497 #: ../fish/guestfish.pod:262
17498 msgid "B<--listen>"
17502 #: ../fish/guestfish.pod:264
17504 "Fork into the background and listen for remote commands. See section L</"
17505 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17509 #: ../fish/guestfish.pod:267
17510 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17514 #: ../fish/guestfish.pod:269
17515 msgid "Mount the named partition or logical volume on the given mountpoint."
17519 #: ../fish/guestfish.pod:271
17520 msgid "If the mountpoint is omitted, it defaults to C</>."
17524 #: ../fish/guestfish.pod:273
17525 msgid "You have to mount something on C</> before most commands will work."
17529 #: ../fish/guestfish.pod:275
17531 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17536 #: ../fish/guestfish.pod:278
17538 "If you don't know what filesystems a disk image contains, you can either run "
17539 "guestfish without this option, then list the partitions, filesystems and LVs "
17540 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17541 "commands), or you can use the L<virt-filesystems(1)> program."
17545 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17546 msgid "B<-n> | B<--no-sync>"
17550 #: ../fish/guestfish.pod:286
17552 "Disable autosync. This is enabled by default. See the discussion of "
17553 "autosync in the L<guestfs(3)> manpage."
17557 #: ../fish/guestfish.pod:289
17558 msgid "B<-N type> | B<--new type> | B<-N help>"
17562 #: ../fish/guestfish.pod:291
17564 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17565 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17566 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17571 #: ../fish/guestfish.pod:296
17572 msgid "B<--progress-bars>"
17576 #: ../fish/guestfish.pod:298
17577 msgid "Enable progress bars, even when guestfish is used non-interactively."
17581 #: ../fish/guestfish.pod:300
17583 "Progress bars are enabled by default when guestfish is used as an "
17584 "interactive shell."
17588 #: ../fish/guestfish.pod:303
17589 msgid "B<--no-progress-bars>"
17593 #: ../fish/guestfish.pod:305
17594 msgid "Disable progress bars."
17598 #: ../fish/guestfish.pod:307
17599 msgid "B<--remote[=pid]>"
17603 #: ../fish/guestfish.pod:309
17605 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17606 "CONTROL GUESTFISH OVER A SOCKET> below."
17610 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17611 msgid "B<-r> | B<--ro>"
17615 #: ../fish/guestfish.pod:314
17617 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17618 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17622 #: ../fish/guestfish.pod:317
17624 "The option must always be used if the disk image or virtual machine might be "
17625 "running, and is generally recommended in cases where you don't need write "
17626 "access to the disk."
17630 #: ../fish/guestfish.pod:321
17632 "Note that prepared disk images created with I<-N> are not affected by the "
17637 #: ../fish/guestfish.pod:324
17638 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17642 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17643 msgid "B<--selinux>"
17647 #: ../fish/guestfish.pod:328
17648 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17652 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17653 msgid "B<-v> | B<--verbose>"
17657 #: ../fish/guestfish.pod:332
17659 "Enable very verbose messages. This is particularly useful if you find a bug."
17663 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17664 msgid "B<-V> | B<--version>"
17668 #: ../fish/guestfish.pod:337
17669 msgid "Display the guestfish / libguestfs version number and exit."
17673 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17674 msgid "B<-w> | B<--rw>"
17678 #: ../fish/guestfish.pod:341
17680 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17685 #: ../fish/guestfish.pod:344
17690 #: ../fish/guestfish.pod:346
17691 msgid "Echo each command before executing it."
17695 #: ../fish/guestfish.pod:350
17696 msgid "COMMANDS ON COMMAND LINE"
17700 #: ../fish/guestfish.pod:352
17702 "Any additional (non-option) arguments are treated as commands to execute."
17706 #: ../fish/guestfish.pod:355
17708 "Commands to execute should be separated by a colon (C<:>), where the colon "
17709 "is a separate parameter. Thus:"
17713 #: ../fish/guestfish.pod:358
17716 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17721 #: ../fish/guestfish.pod:360
17723 "If there are no additional arguments, then we enter a shell, either an "
17724 "interactive shell with a prompt (if the input is a terminal) or a non-"
17725 "interactive shell."
17729 #: ../fish/guestfish.pod:364
17731 "In either command line mode or non-interactive shell, the first command that "
17732 "gives an error causes the whole shell to exit. In interactive mode (with a "
17733 "prompt) if a command fails, you can continue to enter commands."
17737 #: ../fish/guestfish.pod:369
17738 msgid "USING launch (OR run)"
17742 #: ../fish/guestfish.pod:371
17744 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17745 "then launch it, then mount any disks you need, and finally issue actions/"
17746 "commands. So the general order of the day is:"
17750 #: ../fish/guestfish.pod:379
17751 msgid "add or -a/--add"
17755 #: ../fish/guestfish.pod:383
17756 msgid "launch (aka run)"
17760 #: ../fish/guestfish.pod:387
17761 msgid "mount or -m/--mount"
17765 #: ../fish/guestfish.pod:391
17766 msgid "any other commands"
17770 #: ../fish/guestfish.pod:395
17772 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17773 "guest before mounting or performing any other commands."
17777 #: ../fish/guestfish.pod:398
17779 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17780 "I<--new> options were given then C<run> is done automatically, simply "
17781 "because guestfish can't perform the action you asked for without doing this."
17785 #: ../fish/guestfish.pod:403
17786 msgid "OPENING DISKS FOR READ AND WRITE"
17790 #: ../fish/guestfish.pod:405
17792 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17793 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17794 "open disk images read-only or for writing."
17798 #: ../fish/guestfish.pod:409
17800 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17801 "disk images supplied on the command line for write. To open a disk image "
17802 "read-only you have to do I<-a image --ro>."
17806 #: ../fish/guestfish.pod:413
17808 "This matters: If you accidentally open a live VM disk image writable then "
17809 "you will cause irreversible disk corruption."
17813 #: ../fish/guestfish.pod:416
17815 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17816 "images will be opened read-only. You will have to either specify "
17817 "I<guestfish --rw> or change a configuration file in order to get write "
17818 "access for disk images specified by those other command line options."
17822 #: ../fish/guestfish.pod:421
17824 "This version of guestfish has a I<--rw> option which does nothing (it is "
17825 "already the default). However it is highly recommended that you use this "
17826 "option to indicate that guestfish needs write access, and to prepare your "
17827 "scripts for the day when this option will be required for write access."
17831 #: ../fish/guestfish.pod:427
17833 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17834 "other libguestfs program apart from guestfish and guestmount."
17838 #: ../fish/guestfish.pod:430
17843 #: ../fish/guestfish.pod:432
17845 "You can quote ordinary parameters using either single or double quotes. For "
17850 #: ../fish/guestfish.pod:435
17853 " add \"file with a space.img\"\n"
17858 #: ../fish/guestfish.pod:437
17861 " rm '/file name'\n"
17866 #: ../fish/guestfish.pod:439
17874 #: ../fish/guestfish.pod:441
17876 "A few commands require a list of strings to be passed. For these, use a "
17877 "whitespace-separated list, enclosed in quotes. Strings containing "
17878 "whitespace to be passed through must be enclosed in single quotes. A "
17879 "literal single quote must be escaped with a backslash."
17883 #: ../fish/guestfish.pod:446
17886 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17887 " command \"/bin/echo 'foo bar'\"\n"
17888 " command \"/bin/echo \\'foo\\'\"\n"
17893 #: ../fish/guestfish.pod:450
17894 msgid "OPTIONAL ARGUMENTS"
17898 #: ../fish/guestfish.pod:452
17900 "Some commands take optional arguments. These arguments appear in this "
17901 "documentation as C<[argname:..]>. You can use them as in these examples:"
17905 #: ../fish/guestfish.pod:456
17908 " add-drive-opts filename\n"
17913 #: ../fish/guestfish.pod:458
17916 " add-drive-opts filename readonly:true\n"
17921 #: ../fish/guestfish.pod:460
17924 " add-drive-opts filename format:qcow2 readonly:false\n"
17929 #: ../fish/guestfish.pod:462
17931 "Each optional argument can appear at most once. All optional arguments must "
17932 "appear after the required ones."
17936 #: ../fish/guestfish.pod:465
17941 #: ../fish/guestfish.pod:467
17943 "This section applies to all commands which can take integers as parameters."
17947 #: ../fish/guestfish.pod:470
17948 msgid "SIZE SUFFIX"
17952 #: ../fish/guestfish.pod:472
17954 "When the command takes a parameter measured in bytes, you can use one of the "
17955 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17959 #: ../fish/guestfish.pod:478
17960 msgid "B<k> or B<K> or B<KiB>"
17964 #: ../fish/guestfish.pod:480
17965 msgid "The size in kilobytes (multiplied by 1024)."
17969 #: ../fish/guestfish.pod:482
17974 #: ../fish/guestfish.pod:484
17975 msgid "The size in SI 1000 byte units."
17979 #: ../fish/guestfish.pod:486
17980 msgid "B<M> or B<MiB>"
17984 #: ../fish/guestfish.pod:488
17985 msgid "The size in megabytes (multiplied by 1048576)."
17989 #: ../fish/guestfish.pod:490
17994 #: ../fish/guestfish.pod:492
17995 msgid "The size in SI 1000000 byte units."
17999 #: ../fish/guestfish.pod:494
18000 msgid "B<G> or B<GiB>"
18004 #: ../fish/guestfish.pod:496
18005 msgid "The size in gigabytes (multiplied by 2**30)."
18009 #: ../fish/guestfish.pod:498
18014 #: ../fish/guestfish.pod:500
18015 msgid "The size in SI 10**9 byte units."
18019 #: ../fish/guestfish.pod:502
18020 msgid "B<T> or B<TiB>"
18024 #: ../fish/guestfish.pod:504
18025 msgid "The size in terabytes (multiplied by 2**40)."
18029 #: ../fish/guestfish.pod:506
18034 #: ../fish/guestfish.pod:508
18035 msgid "The size in SI 10**12 byte units."
18039 #: ../fish/guestfish.pod:510
18040 msgid "B<P> or B<PiB>"
18044 #: ../fish/guestfish.pod:512
18045 msgid "The size in petabytes (multiplied by 2**50)."
18049 #: ../fish/guestfish.pod:514
18054 #: ../fish/guestfish.pod:516
18055 msgid "The size in SI 10**15 byte units."
18059 #: ../fish/guestfish.pod:518
18060 msgid "B<E> or B<EiB>"
18064 #: ../fish/guestfish.pod:520
18065 msgid "The size in exabytes (multiplied by 2**60)."
18069 #: ../fish/guestfish.pod:522
18074 #: ../fish/guestfish.pod:524
18075 msgid "The size in SI 10**18 byte units."
18079 #: ../fish/guestfish.pod:526
18080 msgid "B<Z> or B<ZiB>"
18084 #: ../fish/guestfish.pod:528
18085 msgid "The size in zettabytes (multiplied by 2**70)."
18089 #: ../fish/guestfish.pod:530
18094 #: ../fish/guestfish.pod:532
18095 msgid "The size in SI 10**21 byte units."
18099 #: ../fish/guestfish.pod:534
18100 msgid "B<Y> or B<YiB>"
18104 #: ../fish/guestfish.pod:536
18105 msgid "The size in yottabytes (multiplied by 2**80)."
18109 #: ../fish/guestfish.pod:538
18114 #: ../fish/guestfish.pod:540
18115 msgid "The size in SI 10**24 byte units."
18119 #: ../fish/guestfish.pod:546
18122 " truncate-size /file 1G\n"
18127 #: ../fish/guestfish.pod:548
18128 msgid "would truncate the file to 1 gigabyte."
18132 #: ../fish/guestfish.pod:550
18134 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18135 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18136 "suffix will probably not do what you expect."
18140 #: ../fish/guestfish.pod:554
18141 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18145 #: ../fish/guestfish.pod:556
18147 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18148 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18152 #: ../fish/guestfish.pod:559
18155 " 1234 decimal number 1234\n"
18156 " 02322 octal number, equivalent to decimal 1234\n"
18157 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18162 #: ../fish/guestfish.pod:563
18164 "When using the C<chmod> command, you almost always want to specify an octal "
18165 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18166 "L<chmod(1)> program):"
18170 #: ../fish/guestfish.pod:567
18173 " chmod 0777 /public # OK\n"
18174 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18179 #: ../fish/guestfish.pod:570
18181 "Commands that return numbers usually print them in decimal, but some "
18182 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18183 "octal, preceeded by C<0>)."
18187 #: ../fish/guestfish.pod:574
18188 msgid "WILDCARDS AND GLOBBING"
18192 #: ../fish/guestfish.pod:576
18194 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18195 "(globbing) by default. So for example the following will not do what you "
18200 #: ../fish/guestfish.pod:580
18208 #: ../fish/guestfish.pod:582
18210 "Assuming you don't have a directory called literally C</home/*> then the "
18211 "above command will return an error."
18215 #: ../fish/guestfish.pod:585
18216 msgid "To perform wildcard expansion, use the C<glob> command."
18220 #: ../fish/guestfish.pod:587
18223 " glob rm-rf /home/*\n"
18228 #: ../fish/guestfish.pod:589
18230 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18231 "many times), equivalent to:"
18235 #: ../fish/guestfish.pod:592
18238 " rm-rf /home/jim\n"
18239 " rm-rf /home/joe\n"
18240 " rm-rf /home/mary\n"
18245 #: ../fish/guestfish.pod:596
18246 msgid "C<glob> only works on simple guest paths and not on device names."
18250 #: ../fish/guestfish.pod:598
18252 "If you have several parameters, each containing a wildcard, then glob will "
18253 "perform a Cartesian product."
18257 #: ../fish/guestfish.pod:601
18262 #: ../fish/guestfish.pod:603
18264 "Any line which starts with a I<#> character is treated as a comment and "
18265 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18266 "a command. For example:"
18270 #: ../fish/guestfish.pod:607
18273 " # this is a comment\n"
18274 " # this is a comment\n"
18275 " foo # NOT a comment\n"
18280 #: ../fish/guestfish.pod:611
18281 msgid "Blank lines are also ignored."
18285 #: ../fish/guestfish.pod:613
18286 msgid "RUNNING COMMANDS LOCALLY"
18290 #: ../fish/guestfish.pod:615
18292 "Any line which starts with a I<!> character is treated as a command sent to "
18293 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18297 #: ../fish/guestfish.pod:619
18301 " tgz-out /remote local/remote-data.tar.gz\n"
18306 #: ../fish/guestfish.pod:622
18308 "will create a directory C<local> on the host, and then export the contents "
18309 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18310 "(See C<tgz-out>)."
18314 #: ../fish/guestfish.pod:626
18316 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18317 "effect, due to the way that subprocesses work in Unix."
18321 #: ../fish/guestfish.pod:629
18326 #: ../fish/guestfish.pod:631
18328 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18329 "command (a guestfish command) to the second command (any host command). For "
18334 #: ../fish/guestfish.pod:635
18337 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18342 #: ../fish/guestfish.pod:637
18344 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18345 "program). The above command would list all accounts in the guest filesystem "
18346 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18350 #: ../fish/guestfish.pod:642
18353 " hexdump /bin/ls | head\n"
18354 " list-devices | tail -1\n"
18355 " tgz-out / - | tar ztf -\n"
18360 #: ../fish/guestfish.pod:646
18362 "The space before the pipe symbol is required, any space after the pipe "
18363 "symbol is optional. Everything after the pipe symbol is just passed "
18364 "straight to the host shell, so it can contain redirections, globs and "
18365 "anything else that makes sense on the host side."
18369 #: ../fish/guestfish.pod:651
18371 "To use a literal argument which begins with a pipe symbol, you have to quote "
18376 #: ../fish/guestfish.pod:654
18384 #: ../fish/guestfish.pod:656
18385 msgid "HOME DIRECTORIES"
18389 #: ../fish/guestfish.pod:658
18391 "If a parameter starts with the character C<~> then the tilde may be expanded "
18392 "as a home directory path (either C<~> for the current user's home directory, "
18393 "or C<~user> for another user)."
18397 #: ../fish/guestfish.pod:662
18399 "Note that home directory expansion happens for users known I<on the host>, "
18400 "not in the guest filesystem."
18404 #: ../fish/guestfish.pod:665
18406 "To use a literal argument which begins with a tilde, you have to quote it, "
18411 #: ../fish/guestfish.pod:668
18419 #: ../fish/guestfish.pod:672
18421 "Libguestfs has some support for Linux guests encrypted according to the "
18422 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18423 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18424 "LUKS is supported."
18428 #: ../fish/guestfish.pod:677
18429 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18433 #: ../fish/guestfish.pod:679
18436 " ><fs> vfs-type /dev/sda2\n"
18442 #: ../fish/guestfish.pod:682
18444 "Then open those devices using L</luks-open>. This creates a device-mapper "
18445 "device called C</dev/mapper/luksdev>."
18449 #: ../fish/guestfish.pod:685
18452 " ><fs> luks-open /dev/sda2 luksdev\n"
18453 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18458 #: ../fish/guestfish.pod:688
18460 "Finally you have to tell LVM to scan for volume groups on the newly created "
18465 #: ../fish/guestfish.pod:691
18469 " vg-activate-all true\n"
18474 #: ../fish/guestfish.pod:694
18475 msgid "The logical volume(s) can now be mounted in the usual way."
18479 #: ../fish/guestfish.pod:696
18481 "Before closing a LUKS device you must unmount any logical volumes on it and "
18482 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18483 "one. Then you can close the mapper device:"
18487 #: ../fish/guestfish.pod:700
18490 " vg-activate false /dev/VG\n"
18491 " luks-close /dev/mapper/luksdev\n"
18496 #: ../fish/guestfish.pod:703
18497 msgid "WINDOWS PATHS"
18501 #: ../fish/guestfish.pod:705
18503 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18504 "(with some limitations). The following commands are equivalent:"
18508 #: ../fish/guestfish.pod:708
18511 " file /WINDOWS/system32/config/system.LOG\n"
18516 #: ../fish/guestfish.pod:710
18519 " file win:/windows/system32/config/system.log\n"
18524 #: ../fish/guestfish.pod:712
18527 " file win:\\windows\\system32\\config\\system.log\n"
18532 #: ../fish/guestfish.pod:714
18535 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18540 #: ../fish/guestfish.pod:716
18542 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18543 "handles case insensitivity like Windows would. This only works in argument "
18544 "positions that expect a path."
18548 #: ../fish/guestfish.pod:720
18549 msgid "UPLOADING AND DOWNLOADING FILES"
18553 #: ../fish/guestfish.pod:722
18555 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18556 "others which upload from or download to a local file, you can use the "
18557 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18561 #: ../fish/guestfish.pod:726
18569 #: ../fish/guestfish.pod:728
18571 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18575 #: ../fish/guestfish.pod:731
18578 " tar-out /etc - | tar tf -\n"
18583 #: ../fish/guestfish.pod:733
18585 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18586 "command (see L</PIPES>)."
18590 #: ../fish/guestfish.pod:736
18592 "When using C<-> to read from stdin, the input is read up to the end of "
18593 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18594 "some arbitrary end marker:"
18598 #: ../fish/guestfish.pod:740
18601 " upload -<<END /foo\n"
18610 #: ../fish/guestfish.pod:746
18612 "Any string of characters can be used instead of C<END>. The end marker must "
18613 "appear on a line of its own, without any preceeding or following characters "
18614 "(not even spaces)."
18618 #: ../fish/guestfish.pod:750
18620 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18621 "upload local files (so-called \"FileIn\" parameters in the generator)."
18625 #: ../fish/guestfish.pod:753
18626 msgid "EXIT ON ERROR BEHAVIOUR"
18630 #: ../fish/guestfish.pod:755
18632 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18633 "taking commands from a human over a tty), and will exit on the first error "
18634 "in non-interactive mode (scripts, commands given on the command line)."
18638 #: ../fish/guestfish.pod:760
18640 "If you prefix a command with a I<-> character, then that command will not "
18641 "cause guestfish to exit, even if that (one) command returns an error."
18645 #: ../fish/guestfish.pod:764
18646 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18650 #: ../fish/guestfish.pod:766
18652 "Guestfish can be remote-controlled over a socket. This is useful "
18653 "particularly in shell scripts where you want to make several different "
18654 "changes to a filesystem, but you don't want the overhead of starting up a "
18655 "guestfish process each time."
18659 #: ../fish/guestfish.pod:771
18660 msgid "Start a guestfish server process using:"
18664 #: ../fish/guestfish.pod:773
18667 " eval \"`guestfish --listen`\"\n"
18672 #: ../fish/guestfish.pod:775
18673 msgid "and then send it commands by doing:"
18677 #: ../fish/guestfish.pod:777
18680 " guestfish --remote cmd [...]\n"
18685 #: ../fish/guestfish.pod:779
18686 msgid "To cause the server to exit, send it the exit command:"
18690 #: ../fish/guestfish.pod:781
18693 " guestfish --remote exit\n"
18698 #: ../fish/guestfish.pod:783
18700 "Note that the server will normally exit if there is an error in a command. "
18701 "You can change this in the usual way. See section L</EXIT ON ERROR "
18706 #: ../fish/guestfish.pod:787
18707 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18711 #: ../fish/guestfish.pod:789
18713 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18714 "is how the I<--remote> option knows where to send the commands. You can "
18715 "have several guestfish listener processes running using:"
18719 #: ../fish/guestfish.pod:793
18722 " eval \"`guestfish --listen`\"\n"
18723 " pid1=$GUESTFISH_PID\n"
18724 " eval \"`guestfish --listen`\"\n"
18725 " pid2=$GUESTFISH_PID\n"
18727 " guestfish --remote=$pid1 cmd\n"
18728 " guestfish --remote=$pid2 cmd\n"
18733 #: ../fish/guestfish.pod:801
18734 msgid "REMOTE CONTROL AND CSH"
18738 #: ../fish/guestfish.pod:803
18740 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18745 #: ../fish/guestfish.pod:806
18748 " eval \"`guestfish --listen --csh`\"\n"
18753 #: ../fish/guestfish.pod:808
18754 msgid "REMOTE CONTROL DETAILS"
18758 #: ../fish/guestfish.pod:810
18760 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18761 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18762 "and C<$PID> is the process ID of the server."
18766 #: ../fish/guestfish.pod:814
18767 msgid "Guestfish client and server versions must match exactly."
18771 #: ../fish/guestfish.pod:816
18772 msgid "PREPARED DISK IMAGES"
18776 #: ../fish/guestfish.pod:818
18778 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18779 "preformatted disk images that guestfish can make for you to save typing. "
18780 "This is particularly useful for testing purposes. This option is used "
18781 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18782 "can be mixed with I<-a>)."
18786 #: ../fish/guestfish.pod:824
18788 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18789 "the second and so on. Existing files in the current directory are "
18794 #: ../fish/guestfish.pod:828
18796 "The type briefly describes how the disk should be sized, partitioned, how "
18797 "filesystem(s) should be created, and how content should be added. "
18798 "Optionally the type can be followed by extra parameters, separated by C<:> "
18799 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18800 "allocated disk, containing a single partition, with the partition formatted "
18801 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18806 #: ../fish/guestfish.pod:836
18807 msgid "To list the available types and any extra parameters they take, run:"
18811 #: ../fish/guestfish.pod:840
18813 "Note that the prepared filesystem is not mounted. You would usually have to "
18814 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18818 #: ../fish/guestfish.pod:844
18820 "If any I<-N> or I<--new> options are given, the guest is automatically "
18825 #: ../fish/guestfish.pod:849
18826 msgid "Create a 100MB disk with an ext4-formatted partition:"
18830 #: ../fish/guestfish.pod:851
18833 " guestfish -N fs:ext4\n"
18838 #: ../fish/guestfish.pod:853
18839 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18843 #: ../fish/guestfish.pod:855
18846 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18851 #: ../fish/guestfish.pod:857
18852 msgid "Create a blank 200MB disk:"
18856 #: ../fish/guestfish.pod:859
18859 " guestfish -N disk:200M\n"
18864 #: ../fish/guestfish.pod:861
18865 msgid "PROGRESS BARS"
18869 #: ../fish/guestfish.pod:863
18871 "Some (not all) long-running commands send progress notification messages as "
18872 "they are running. Guestfish turns these messages into progress bars."
18876 #: ../fish/guestfish.pod:867
18878 "When a command that supports progress bars takes longer than two seconds to "
18879 "run, and if progress bars are enabled, then you will see one appearing below "
18884 #: ../fish/guestfish.pod:871
18887 " ><fs> copy-size /large-file /another-file 2048M\n"
18888 " / 10% [#####-----------------------------------------] 00:30\n"
18893 #: ../fish/guestfish.pod:874
18895 "The spinner on the left hand side moves round once for every progress "
18896 "notification received from the backend. This is a (reasonably) golden "
18897 "assurance that the command is \"doing something\" even if the progress bar "
18898 "is not moving, because the command is able to send the progress "
18899 "notifications. When the bar reaches 100% and the command finishes, the "
18900 "spinner disappears."
18904 #: ../fish/guestfish.pod:881
18906 "Progress bars are enabled by default when guestfish is used interactively. "
18907 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18908 "and you can disable them completely using I<--no-progress-bars>."
18912 #: ../fish/guestfish.pod:886
18913 msgid "GUESTFISH COMMANDS"
18917 #: ../fish/guestfish.pod:888
18919 "The commands in this section are guestfish convenience commands, in other "
18920 "words, they are not part of the L<guestfs(3)> API."
18924 #: ../fish/guestfish.pod:891
18929 #: ../fish/guestfish.pod:893
18938 #: ../fish/guestfish.pod:896
18939 msgid "Without any parameter, this provides general help."
18943 #: ../fish/guestfish.pod:898
18944 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18948 #: ../fish/guestfish.pod:900
18949 msgid "quit | exit"
18953 #: ../fish/guestfish.pod:902
18954 msgid "This exits guestfish. You can also use C<^D> key."
18958 #: ../fish/guestfish.pod:904
18959 msgid "@FISH_COMMANDS@"
18963 #: ../fish/guestfish.pod:906
18968 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18973 #: ../fish/guestfish.pod:912
18975 "guestfish returns 0 if the commands completed without error, or 1 if there "
18980 #: ../fish/guestfish.pod:919
18985 #: ../fish/guestfish.pod:921
18987 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18992 #: ../fish/guestfish.pod:924
18993 msgid "GUESTFISH_PID"
18997 #: ../fish/guestfish.pod:926
18999 "Used with the I<--remote> option to specify the remote guestfish process to "
19000 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19004 #: ../fish/guestfish.pod:930
19009 #: ../fish/guestfish.pod:932
19011 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19012 "not specified, the external L<hexedit(1)> program is used."
19016 #: ../fish/guestfish.pod:936
19021 #: ../fish/guestfish.pod:938
19023 "If compiled with GNU readline support, various files in the home directory "
19024 "can be used. See L</FILES>."
19028 #: ../fish/guestfish.pod:947
19030 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19031 "effect as using the B<-v> option."
19035 #: ../fish/guestfish.pod:959
19037 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19038 "the discussion of paths in L<guestfs(3)>."
19042 #: ../fish/guestfish.pod:970
19043 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19047 #: ../fish/guestfish.pod:972
19052 #: ../fish/guestfish.pod:974
19054 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19059 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
19064 #: ../fish/guestfish.pod:993
19065 msgid "$HOME/.guestfish"
19069 #: ../fish/guestfish.pod:995
19071 "If compiled with GNU readline support, then the command history is saved in "
19076 #: ../fish/guestfish.pod:998
19077 msgid "$HOME/.inputrc"
19081 #: ../fish/guestfish.pod:1000
19082 msgid "/etc/inputrc"
19086 #: ../fish/guestfish.pod:1002
19088 "If compiled with GNU readline support, then these files can be used to "
19089 "configure readline. For further information, please see L<readline(3)/"
19090 "INITIALIZATION FILE>."
19094 #: ../fish/guestfish.pod:1006
19095 msgid "To write rules which only apply to guestfish, use:"
19099 #: ../fish/guestfish.pod:1008
19109 #: ../fish/guestfish.pod:1012
19111 "Variables that you can set in inputrc that change the behaviour of guestfish "
19112 "in useful ways include:"
19116 #: ../fish/guestfish.pod:1017
19117 msgid "completion-ignore-case (default: on)"
19121 #: ../fish/guestfish.pod:1019
19123 "By default, guestfish will ignore case when tab-completing paths on the "
19128 #: ../fish/guestfish.pod:1022
19131 " set completion-ignore-case off\n"
19136 #: ../fish/guestfish.pod:1024
19137 msgid "to make guestfish case sensitive."
19141 #: ../fish/guestfish.pod:1028
19146 #: ../fish/guestfish.pod:1030
19147 msgid "test2.img (etc)"
19151 #: ../fish/guestfish.pod:1032
19153 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19154 "will be created in the file C<test1.img> in the current directory. The "
19155 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19156 "the same name will be overwritten."
19160 #: ../fish/guestfish.pod:1041
19162 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19163 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
19164 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
19165 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
19170 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124
19171 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
19172 #: ../tools/virt-win-reg.pl:518 ../tools/virt-resize.pl:1514
19173 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
19174 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
19176 "This program is free software; you can redistribute it and/or modify it "
19177 "under the terms of the GNU General Public License as published by the Free "
19178 "Software Foundation; either version 2 of the License, or (at your option) "
19179 "any later version."
19183 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129
19184 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
19185 #: ../tools/virt-win-reg.pl:523 ../tools/virt-resize.pl:1519
19186 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
19187 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
19189 "This program is distributed in the hope that it will be useful, but WITHOUT "
19190 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19191 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19196 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134
19197 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
19198 #: ../tools/virt-win-reg.pl:528 ../tools/virt-resize.pl:1524
19199 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
19200 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
19202 "You should have received a copy of the GNU General Public License along with "
19203 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19204 "Ave, Cambridge, MA 02139, USA."
19208 #: ../fish/guestfish-actions.pod:1
19213 #: ../fish/guestfish-actions.pod:3
19216 " add-cdrom filename\n"
19221 #: ../fish/guestfish-actions.pod:15
19223 "This call checks for the existence of C<filename>. This stops you from "
19224 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19225 "and C<http:> URLs. To specify those, use the general L</config> call "
19230 #: ../fish/guestfish-actions.pod:22
19232 "If you just want to add an ISO file (often you use this as an efficient way "
19233 "to transfer large files into the guest), then you should probably use L</add-"
19234 "drive-ro> instead."
19238 #: ../fish/guestfish-actions.pod:35
19243 #: ../fish/guestfish-actions.pod:37
19248 #: ../fish/guestfish-actions.pod:39
19251 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19256 #: ../fish/guestfish-actions.pod:41
19258 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19259 "It works by connecting to libvirt, requesting the domain and domain XML from "
19260 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19264 #: ../fish/guestfish-actions.pod:58
19266 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19267 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19268 "libvirt URI (or one set through an environment variable, see the libvirt "
19269 "documentation for full details). If you are using the C API directly then "
19270 "it is more flexible to create the libvirt connection object yourself, get "
19271 "the domain object, and call L</add-libvirt-dom>."
19275 #: ../fish/guestfish-actions.pod:66
19277 "The other optional parameters are passed directly through to L</add-drive-"
19282 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19284 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19288 #: ../fish/guestfish-actions.pod:71
19293 #: ../fish/guestfish-actions.pod:73
19296 " add-drive filename\n"
19301 #: ../fish/guestfish-actions.pod:75
19303 "This function is the equivalent of calling L</add-drive-opts> with no "
19304 "optional parameters, so the disk is added writable, with the format being "
19305 "detected automatically."
19309 #: ../fish/guestfish-actions.pod:79
19311 "Automatic detection of the format opens you up to a potential security hole "
19312 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19313 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19314 "you should think about replacing calls to this function with calls to L</add-"
19315 "drive-opts>, and specifying the format."
19319 #: ../fish/guestfish-actions.pod:86
19320 msgid "add-drive-opts"
19324 #: ../fish/guestfish-actions.pod:88
19329 #: ../fish/guestfish-actions.pod:90
19332 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19337 #: ../fish/guestfish-actions.pod:117
19339 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19340 "add-drive-ro>) then the format is automatically detected. Possible formats "
19341 "include C<raw> and C<qcow2>."
19345 #: ../fish/guestfish-actions.pod:128
19347 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19348 "add-drive-with-if> call (q.v.)"
19352 #: ../fish/guestfish-actions.pod:135
19353 msgid "add-drive-ro"
19357 #: ../fish/guestfish-actions.pod:137
19362 #: ../fish/guestfish-actions.pod:139
19365 " add-drive-ro filename\n"
19370 #: ../fish/guestfish-actions.pod:141
19372 "This function is the equivalent of calling L</add-drive-opts> with the "
19373 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19374 "is added read-only, with the format being detected automatically."
19378 #: ../fish/guestfish-actions.pod:146
19379 msgid "add-drive-ro-with-if"
19383 #: ../fish/guestfish-actions.pod:148
19386 " add-drive-ro-with-if filename iface\n"
19391 #: ../fish/guestfish-actions.pod:150
19393 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19394 "interface emulation to use at run time."
19398 #: ../fish/guestfish-actions.pod:160
19399 msgid "add-drive-with-if"
19403 #: ../fish/guestfish-actions.pod:162
19406 " add-drive-with-if filename iface\n"
19411 #: ../fish/guestfish-actions.pod:164
19413 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19414 "interface emulation to use at run time."
19418 #: ../fish/guestfish-actions.pod:174
19423 #: ../fish/guestfish-actions.pod:176
19426 " aug-clear augpath\n"
19431 #: ../fish/guestfish-actions.pod:181
19436 #: ../fish/guestfish-actions.pod:183
19444 #: ../fish/guestfish-actions.pod:185
19446 "Close the current Augeas handle and free up any resources used by it. After "
19447 "calling this, you have to call L</aug-init> again before you can use any "
19448 "other Augeas functions."
19452 #: ../fish/guestfish-actions.pod:190
19453 msgid "aug-defnode"
19457 #: ../fish/guestfish-actions.pod:192
19460 " aug-defnode name expr val\n"
19465 #: ../fish/guestfish-actions.pod:197
19467 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19468 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19469 "containing that single node."
19473 #: ../fish/guestfish-actions.pod:205
19478 #: ../fish/guestfish-actions.pod:207
19481 " aug-defvar name expr\n"
19486 #: ../fish/guestfish-actions.pod:216
19491 #: ../fish/guestfish-actions.pod:218
19494 " aug-get augpath\n"
19499 #: ../fish/guestfish-actions.pod:223
19504 #: ../fish/guestfish-actions.pod:225
19507 " aug-init root flags\n"
19512 #: ../fish/guestfish-actions.pod:231
19513 msgid "You must call this before using any other L</aug-*> commands."
19517 #: ../fish/guestfish-actions.pod:266
19518 msgid "Do not load the tree in L</aug-init>."
19522 #: ../fish/guestfish-actions.pod:270
19523 msgid "To close the handle, you can call L</aug-close>."
19527 #: ../fish/guestfish-actions.pod:274
19532 #: ../fish/guestfish-actions.pod:276
19535 " aug-insert augpath label true|false\n"
19540 #: ../fish/guestfish-actions.pod:286
19545 #: ../fish/guestfish-actions.pod:288
19553 #: ../fish/guestfish-actions.pod:295
19558 #: ../fish/guestfish-actions.pod:297
19561 " aug-ls augpath\n"
19566 #: ../fish/guestfish-actions.pod:299
19568 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19569 "resulting nodes into alphabetical order."
19573 #: ../fish/guestfish-actions.pod:302
19578 #: ../fish/guestfish-actions.pod:304
19581 " aug-match augpath\n"
19586 #: ../fish/guestfish-actions.pod:310
19591 #: ../fish/guestfish-actions.pod:312
19594 " aug-mv src dest\n"
19599 #: ../fish/guestfish-actions.pod:317
19604 #: ../fish/guestfish-actions.pod:319
19607 " aug-rm augpath\n"
19612 #: ../fish/guestfish-actions.pod:325
19617 #: ../fish/guestfish-actions.pod:327
19625 #: ../fish/guestfish-actions.pod:331
19627 "The flags which were passed to L</aug-init> affect exactly how files are "
19632 #: ../fish/guestfish-actions.pod:334
19637 #: ../fish/guestfish-actions.pod:336
19640 " aug-set augpath val\n"
19645 #: ../fish/guestfish-actions.pod:340
19647 "In the Augeas API, it is possible to clear a node by setting the value to "
19648 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19649 "this call. Instead you must use the L</aug-clear> call."
19653 #: ../fish/guestfish-actions.pod:345
19658 #: ../fish/guestfish-actions.pod:347
19661 " available 'groups ...'\n"
19666 #: ../fish/guestfish-actions.pod:353
19668 "The libguestfs groups, and the functions that those groups correspond to, "
19669 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19670 "runtime by calling L</available-all-groups>."
19674 #: ../fish/guestfish-actions.pod:377
19675 msgid "You must call L</launch> before calling this function."
19679 #: ../fish/guestfish-actions.pod:399
19681 "This call was added in version C<1.0.80>. In previous versions of "
19682 "libguestfs all you could do would be to speculatively execute a command to "
19683 "find out if the daemon implemented it. See also L</version>."
19687 #: ../fish/guestfish-actions.pod:406
19688 msgid "available-all-groups"
19692 #: ../fish/guestfish-actions.pod:408
19695 " available-all-groups\n"
19700 #: ../fish/guestfish-actions.pod:410
19702 "This command returns a list of all optional groups that this daemon knows "
19703 "about. Note this returns both supported and unsupported groups. To find "
19704 "out which ones the daemon can actually support you have to call L</"
19705 "available> on each member of the returned list."
19709 #: ../fish/guestfish-actions.pod:416
19710 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19714 #: ../fish/guestfish-actions.pod:418
19719 #: ../fish/guestfish-actions.pod:420
19722 " base64-in (base64file|-) filename\n"
19727 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19728 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19729 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19730 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19731 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19732 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19733 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19734 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19738 #: ../fish/guestfish-actions.pod:427
19743 #: ../fish/guestfish-actions.pod:429
19746 " base64-out filename (base64file|-)\n"
19751 #: ../fish/guestfish-actions.pod:436
19752 msgid "blockdev-flushbufs"
19756 #: ../fish/guestfish-actions.pod:438
19759 " blockdev-flushbufs device\n"
19764 #: ../fish/guestfish-actions.pod:445
19765 msgid "blockdev-getbsz"
19769 #: ../fish/guestfish-actions.pod:447
19772 " blockdev-getbsz device\n"
19777 #: ../fish/guestfish-actions.pod:456
19778 msgid "blockdev-getro"
19782 #: ../fish/guestfish-actions.pod:458
19785 " blockdev-getro device\n"
19790 #: ../fish/guestfish-actions.pod:465
19791 msgid "blockdev-getsize64"
19795 #: ../fish/guestfish-actions.pod:467
19798 " blockdev-getsize64 device\n"
19803 #: ../fish/guestfish-actions.pod:471
19804 msgid "See also L</blockdev-getsz>."
19808 #: ../fish/guestfish-actions.pod:475
19809 msgid "blockdev-getss"
19813 #: ../fish/guestfish-actions.pod:477
19816 " blockdev-getss device\n"
19821 #: ../fish/guestfish-actions.pod:482
19823 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19827 #: ../fish/guestfish-actions.pod:487
19828 msgid "blockdev-getsz"
19832 #: ../fish/guestfish-actions.pod:489
19835 " blockdev-getsz device\n"
19840 #: ../fish/guestfish-actions.pod:494
19842 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19843 "blockdev-getsize64> for the more useful I<size in bytes>."
19847 #: ../fish/guestfish-actions.pod:500
19848 msgid "blockdev-rereadpt"
19852 #: ../fish/guestfish-actions.pod:502
19855 " blockdev-rereadpt device\n"
19860 #: ../fish/guestfish-actions.pod:508
19861 msgid "blockdev-setbsz"
19865 #: ../fish/guestfish-actions.pod:510
19868 " blockdev-setbsz device blocksize\n"
19873 #: ../fish/guestfish-actions.pod:519
19874 msgid "blockdev-setro"
19878 #: ../fish/guestfish-actions.pod:521
19881 " blockdev-setro device\n"
19886 #: ../fish/guestfish-actions.pod:527
19887 msgid "blockdev-setrw"
19891 #: ../fish/guestfish-actions.pod:529
19894 " blockdev-setrw device\n"
19899 #: ../fish/guestfish-actions.pod:535
19900 msgid "case-sensitive-path"
19904 #: ../fish/guestfish-actions.pod:537
19907 " case-sensitive-path path\n"
19912 #: ../fish/guestfish-actions.pod:561
19914 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19915 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19916 "the directories were originally created under Windows)."
19920 #: ../fish/guestfish-actions.pod:569
19921 msgid "See also L</realpath>."
19925 #: ../fish/guestfish-actions.pod:571
19930 #: ../fish/guestfish-actions.pod:573
19938 #: ../fish/guestfish-actions.pod:577
19940 "Note that this function cannot correctly handle binary files (specifically, "
19941 "files containing C<\\0> character which is treated as end of string). For "
19942 "those you need to use the L</read-file> or L</download> functions which have "
19943 "a more complex interface."
19947 #: ../fish/guestfish-actions.pod:585
19952 #: ../fish/guestfish-actions.pod:587
19955 " checksum csumtype path\n"
19960 #: ../fish/guestfish-actions.pod:630
19961 msgid "To get the checksum for a device, use L</checksum-device>."
19965 #: ../fish/guestfish-actions.pod:632
19966 msgid "To get the checksums for many files, use L</checksums-out>."
19970 #: ../fish/guestfish-actions.pod:634
19971 msgid "checksum-device"
19975 #: ../fish/guestfish-actions.pod:636
19978 " checksum-device csumtype device\n"
19983 #: ../fish/guestfish-actions.pod:638
19985 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19986 "device named C<device>. For the types of checksums supported see the L</"
19987 "checksum> command."
19991 #: ../fish/guestfish-actions.pod:642
19992 msgid "checksums-out"
19996 #: ../fish/guestfish-actions.pod:644
19999 " checksums-out csumtype directory (sumsfile|-)\n"
20004 #: ../fish/guestfish-actions.pod:660
20009 #: ../fish/guestfish-actions.pod:662
20012 " chmod mode path\n"
20017 #: ../fish/guestfish-actions.pod:673
20022 #: ../fish/guestfish-actions.pod:675
20025 " chown owner group path\n"
20030 #: ../fish/guestfish-actions.pod:683
20035 #: ../fish/guestfish-actions.pod:685
20038 " command 'arguments ...'\n"
20043 #: ../fish/guestfish-actions.pod:692
20045 "The single parameter is an argv-style list of arguments. The first element "
20046 "is the name of the program to run. Subsequent elements are parameters. The "
20047 "list must be non-empty (ie. must contain a program name). Note that the "
20048 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20052 #: ../fish/guestfish-actions.pod:720
20053 msgid "command-lines"
20057 #: ../fish/guestfish-actions.pod:722
20060 " command-lines 'arguments ...'\n"
20065 #: ../fish/guestfish-actions.pod:724
20067 "This is the same as L</command>, but splits the result into a list of lines."
20071 #: ../fish/guestfish-actions.pod:727
20072 msgid "See also: L</sh-lines>"
20076 #: ../fish/guestfish-actions.pod:732
20081 #: ../fish/guestfish-actions.pod:734
20084 " config qemuparam qemuvalue\n"
20089 #: ../fish/guestfish-actions.pod:745
20094 #: ../fish/guestfish-actions.pod:747
20097 " copy-size src dest size\n"
20102 #: ../fish/guestfish-actions.pod:755
20107 #: ../fish/guestfish-actions.pod:757
20115 #: ../fish/guestfish-actions.pod:762
20120 #: ../fish/guestfish-actions.pod:764
20128 #: ../fish/guestfish-actions.pod:769
20133 #: ../fish/guestfish-actions.pod:771
20141 #: ../fish/guestfish-actions.pod:778
20143 "If the destination is a device, it must be as large or larger than the "
20144 "source file or device, otherwise the copy will fail. This command cannot do "
20145 "partial copies (see L</copy-size>)."
20149 #: ../fish/guestfish-actions.pod:782
20154 #: ../fish/guestfish-actions.pod:784
20162 #: ../fish/guestfish-actions.pod:792
20167 #: ../fish/guestfish-actions.pod:794
20175 #: ../fish/guestfish-actions.pod:803
20180 #: ../fish/guestfish-actions.pod:805
20188 #: ../fish/guestfish-actions.pod:811
20190 "Another way to get the same information is to enable verbose messages with "
20191 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20192 "before running the program."
20196 #: ../fish/guestfish-actions.pod:816
20201 #: ../fish/guestfish-actions.pod:818
20204 " download remotefilename (filename|-)\n"
20209 #: ../fish/guestfish-actions.pod:825
20210 msgid "See also L</upload>, L</cat>."
20214 #: ../fish/guestfish-actions.pod:829
20215 msgid "download-offset"
20219 #: ../fish/guestfish-actions.pod:831
20222 " download-offset remotefilename (filename|-) offset size\n"
20227 #: ../fish/guestfish-actions.pod:839
20229 "Note that there is no limit on the amount of data that can be downloaded "
20230 "with this call, unlike with L</pread>, and this call always reads the full "
20231 "amount unless an error occurs."
20235 #: ../fish/guestfish-actions.pod:844
20236 msgid "See also L</download>, L</pread>."
20240 #: ../fish/guestfish-actions.pod:848
20241 msgid "drop-caches"
20245 #: ../fish/guestfish-actions.pod:850
20248 " drop-caches whattodrop\n"
20253 #: ../fish/guestfish-actions.pod:862
20258 #: ../fish/guestfish-actions.pod:864
20266 #: ../fish/guestfish-actions.pod:876
20271 #: ../fish/guestfish-actions.pod:878
20274 " e2fsck-f device\n"
20279 #: ../fish/guestfish-actions.pod:884
20281 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20282 "should use L</fsck>."
20286 #: ../fish/guestfish-actions.pod:887
20287 msgid "echo-daemon"
20291 #: ../fish/guestfish-actions.pod:889
20294 " echo-daemon 'words ...'\n"
20299 #: ../fish/guestfish-actions.pod:896
20300 msgid "See also L</ping-daemon>."
20304 #: ../fish/guestfish-actions.pod:898
20309 #: ../fish/guestfish-actions.pod:900
20312 " egrep regex path\n"
20317 #: ../fish/guestfish-actions.pod:908
20322 #: ../fish/guestfish-actions.pod:910
20325 " egrepi regex path\n"
20330 #: ../fish/guestfish-actions.pod:918
20335 #: ../fish/guestfish-actions.pod:920
20338 " equal file1 file2\n"
20343 #: ../fish/guestfish-actions.pod:927
20348 #: ../fish/guestfish-actions.pod:929
20356 #: ../fish/guestfish-actions.pod:934
20357 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20361 #: ../fish/guestfish-actions.pod:936
20366 #: ../fish/guestfish-actions.pod:938
20369 " fallocate path len\n"
20374 #: ../fish/guestfish-actions.pod:955
20375 msgid "fallocate64"
20379 #: ../fish/guestfish-actions.pod:957
20382 " fallocate64 path len\n"
20387 #: ../fish/guestfish-actions.pod:963
20389 "Note that this call allocates disk blocks for the file. To create a sparse "
20390 "file use L</truncate-size> instead."
20394 #: ../fish/guestfish-actions.pod:966
20396 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20397 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20398 "maximum size of files created through that call to 1GB."
20402 #: ../fish/guestfish-actions.pod:975
20407 #: ../fish/guestfish-actions.pod:977
20410 " fgrep pattern path\n"
20415 #: ../fish/guestfish-actions.pod:985
20420 #: ../fish/guestfish-actions.pod:987
20423 " fgrepi pattern path\n"
20428 #: ../fish/guestfish-actions.pod:995
20433 #: ../fish/guestfish-actions.pod:997
20441 #: ../fish/guestfish-actions.pod:1009
20443 "This command can also be used on C</dev/> devices (and partitions, LV "
20444 "names). You can for example use this to determine if a device contains a "
20445 "filesystem, although it's usually better to use L</vfs-type>."
20449 #: ../fish/guestfish-actions.pod:1019
20450 msgid "file-architecture"
20454 #: ../fish/guestfish-actions.pod:1021
20457 " file-architecture filename\n"
20462 #: ../fish/guestfish-actions.pod:1124
20467 #: ../fish/guestfish-actions.pod:1126
20475 #: ../fish/guestfish-actions.pod:1130
20477 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20478 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20482 #: ../fish/guestfish-actions.pod:1134
20487 #: ../fish/guestfish-actions.pod:1136
20490 " fill c len path\n"
20495 #: ../fish/guestfish-actions.pod:1142
20497 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20498 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20499 "L</fill-pattern>."
20503 #: ../fish/guestfish-actions.pod:1147
20504 msgid "fill-pattern"
20508 #: ../fish/guestfish-actions.pod:1149
20511 " fill-pattern pattern len path\n"
20516 #: ../fish/guestfish-actions.pod:1151
20518 "This function is like L</fill> except that it creates a new file of length "
20519 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20520 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20525 #: ../fish/guestfish-actions.pod:1156
20530 #: ../fish/guestfish-actions.pod:1158
20533 " find directory\n"
20538 #: ../fish/guestfish-actions.pod:1172
20539 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20543 #: ../fish/guestfish-actions.pod:1185
20544 msgid "See also L</find0>."
20548 #: ../fish/guestfish-actions.pod:1190
20553 #: ../fish/guestfish-actions.pod:1192
20556 " find0 directory (files|-)\n"
20561 #: ../fish/guestfish-actions.pod:1198
20563 "This command works the same way as L</find> with the following exceptions:"
20567 #: ../fish/guestfish-actions.pod:1225
20568 msgid "findfs-label"
20572 #: ../fish/guestfish-actions.pod:1227
20575 " findfs-label label\n"
20580 #: ../fish/guestfish-actions.pod:1233
20581 msgid "To find the label of a filesystem, use L</vfs-label>."
20585 #: ../fish/guestfish-actions.pod:1235
20586 msgid "findfs-uuid"
20590 #: ../fish/guestfish-actions.pod:1237
20593 " findfs-uuid uuid\n"
20598 #: ../fish/guestfish-actions.pod:1243
20599 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20603 #: ../fish/guestfish-actions.pod:1245
20608 #: ../fish/guestfish-actions.pod:1247
20611 " fsck fstype device\n"
20616 #: ../fish/guestfish-actions.pod:1277
20621 #: ../fish/guestfish-actions.pod:1279
20629 #: ../fish/guestfish-actions.pod:1286
20630 msgid "get-autosync"
20634 #: ../fish/guestfish-actions.pod:1288
20642 #: ../fish/guestfish-actions.pod:1292
20647 #: ../fish/guestfish-actions.pod:1294
20655 #: ../fish/guestfish-actions.pod:1298
20656 msgid "get-e2label"
20660 #: ../fish/guestfish-actions.pod:1300
20663 " get-e2label device\n"
20668 #: ../fish/guestfish-actions.pod:1312
20673 #: ../fish/guestfish-actions.pod:1314
20676 " get-e2uuid device\n"
20681 #: ../fish/guestfish-actions.pod:1326
20682 msgid "get-memsize"
20686 #: ../fish/guestfish-actions.pod:1328
20694 #: ../fish/guestfish-actions.pod:1333
20696 "If L</set-memsize> was not called on this handle, and if "
20697 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20698 "value for memsize."
20702 #: ../fish/guestfish-actions.pod:1340
20703 msgid "get-network"
20707 #: ../fish/guestfish-actions.pod:1342
20715 #: ../fish/guestfish-actions.pod:1346
20720 #: ../fish/guestfish-actions.pod:1348
20728 #: ../fish/guestfish-actions.pod:1355
20733 #: ../fish/guestfish-actions.pod:1357
20738 #: ../fish/guestfish-actions.pod:1359
20746 #: ../fish/guestfish-actions.pod:1366
20751 #: ../fish/guestfish-actions.pod:1368
20759 #: ../fish/guestfish-actions.pod:1375
20760 msgid "get-recovery-proc"
20764 #: ../fish/guestfish-actions.pod:1377
20767 " get-recovery-proc\n"
20772 #: ../fish/guestfish-actions.pod:1381
20773 msgid "get-selinux"
20777 #: ../fish/guestfish-actions.pod:1383
20785 #: ../fish/guestfish-actions.pod:1385
20787 "This returns the current setting of the selinux flag which is passed to the "
20788 "appliance at boot time. See L</set-selinux>."
20792 #: ../fish/guestfish-actions.pod:1391
20797 #: ../fish/guestfish-actions.pod:1393
20805 #: ../fish/guestfish-actions.pod:1400
20810 #: ../fish/guestfish-actions.pod:1402
20818 #: ../fish/guestfish-actions.pod:1406
20823 #: ../fish/guestfish-actions.pod:1408
20831 #: ../fish/guestfish-actions.pod:1410
20833 "Return the current umask. By default the umask is C<022> unless it has been "
20834 "set by calling L</umask>."
20838 #: ../fish/guestfish-actions.pod:1413
20839 msgid "get-verbose"
20843 #: ../fish/guestfish-actions.pod:1415
20851 #: ../fish/guestfish-actions.pod:1419
20856 #: ../fish/guestfish-actions.pod:1421
20864 #: ../fish/guestfish-actions.pod:1425
20865 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20869 #: ../fish/guestfish-actions.pod:1428
20874 #: ../fish/guestfish-actions.pod:1430
20877 " getxattrs path\n"
20882 #: ../fish/guestfish-actions.pod:1438
20883 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20887 #: ../fish/guestfish-actions.pod:1440
20888 msgid "glob-expand"
20892 #: ../fish/guestfish-actions.pod:1442
20895 " glob-expand pattern\n"
20900 #: ../fish/guestfish-actions.pod:1455
20905 #: ../fish/guestfish-actions.pod:1457
20908 " grep regex path\n"
20913 #: ../fish/guestfish-actions.pod:1465
20918 #: ../fish/guestfish-actions.pod:1467
20921 " grepi regex path\n"
20926 #: ../fish/guestfish-actions.pod:1475
20927 msgid "grub-install"
20931 #: ../fish/guestfish-actions.pod:1477
20934 " grub-install root device\n"
20939 #: ../fish/guestfish-actions.pod:1493
20944 #: ../fish/guestfish-actions.pod:1495
20952 #: ../fish/guestfish-actions.pod:1503
20957 #: ../fish/guestfish-actions.pod:1505
20960 " head-n nrlines path\n"
20965 #: ../fish/guestfish-actions.pod:1518
20970 #: ../fish/guestfish-actions.pod:1520
20978 #: ../fish/guestfish-actions.pod:1528
20983 #: ../fish/guestfish-actions.pod:1530
20986 " initrd-cat initrdpath filename\n"
20991 #: ../fish/guestfish-actions.pod:1542
20992 msgid "See also L</initrd-list>."
20996 #: ../fish/guestfish-actions.pod:1547
20997 msgid "initrd-list"
21001 #: ../fish/guestfish-actions.pod:1549
21004 " initrd-list path\n"
21009 #: ../fish/guestfish-actions.pod:1561
21010 msgid "inotify-add-watch"
21014 #: ../fish/guestfish-actions.pod:1563
21017 " inotify-add-watch path mask\n"
21022 #: ../fish/guestfish-actions.pod:1575
21023 msgid "inotify-close"
21027 #: ../fish/guestfish-actions.pod:1577
21035 #: ../fish/guestfish-actions.pod:1583
21036 msgid "inotify-files"
21040 #: ../fish/guestfish-actions.pod:1585
21048 #: ../fish/guestfish-actions.pod:1587
21050 "This function is a helpful wrapper around L</inotify-read> which just "
21051 "returns a list of pathnames of objects that were touched. The returned "
21052 "pathnames are sorted and deduplicated."
21056 #: ../fish/guestfish-actions.pod:1591
21057 msgid "inotify-init"
21061 #: ../fish/guestfish-actions.pod:1593
21064 " inotify-init maxevents\n"
21069 #: ../fish/guestfish-actions.pod:1599
21071 "C<maxevents> is the maximum number of events which will be queued up between "
21072 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21073 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21074 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21075 "but records the fact that it threw them away by setting a flag "
21076 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21080 #: ../fish/guestfish-actions.pod:1609
21082 "Before any events are generated, you have to add some watches to the "
21083 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21084 "L</inotify-watch-all>."
21088 #: ../fish/guestfish-actions.pod:1615
21090 "Queued up events should be read periodically by calling L</inotify-read> (or "
21091 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21092 "If you don't read the events out often enough then you risk the internal "
21093 "queue overflowing."
21097 #: ../fish/guestfish-actions.pod:1622
21099 "The handle should be closed after use by calling L</inotify-close>. This "
21100 "also removes any watches automatically."
21104 #: ../fish/guestfish-actions.pod:1631
21105 msgid "inotify-read"
21109 #: ../fish/guestfish-actions.pod:1633
21117 #: ../fish/guestfish-actions.pod:1646
21118 msgid "inotify-rm-watch"
21122 #: ../fish/guestfish-actions.pod:1648
21125 " inotify-rm-watch wd\n"
21130 #: ../fish/guestfish-actions.pod:1650
21131 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21135 #: ../fish/guestfish-actions.pod:1653
21136 msgid "inspect-get-arch"
21140 #: ../fish/guestfish-actions.pod:1655
21143 " inspect-get-arch root\n"
21148 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21149 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21150 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21151 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21152 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21153 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21154 #: ../fish/guestfish-actions.pod:1966
21156 "This function should only be called with a root device string as returned by "
21161 #: ../fish/guestfish-actions.pod:1660
21163 "This returns the architecture of the inspected operating system. The "
21164 "possible return values are listed under L</file-architecture>."
21168 #: ../fish/guestfish-actions.pod:1669
21169 msgid "inspect-get-distro"
21173 #: ../fish/guestfish-actions.pod:1671
21176 " inspect-get-distro root\n"
21181 #: ../fish/guestfish-actions.pod:1743
21182 msgid "inspect-get-filesystems"
21186 #: ../fish/guestfish-actions.pod:1745
21189 " inspect-get-filesystems root\n"
21194 #: ../fish/guestfish-actions.pod:1758
21196 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21197 "get-mountpoints>."
21201 #: ../fish/guestfish-actions.pod:1761
21202 msgid "inspect-get-hostname"
21206 #: ../fish/guestfish-actions.pod:1763
21209 " inspect-get-hostname root\n"
21214 #: ../fish/guestfish-actions.pod:1776
21215 msgid "inspect-get-major-version"
21219 #: ../fish/guestfish-actions.pod:1778
21222 " inspect-get-major-version root\n"
21227 #: ../fish/guestfish-actions.pod:1797
21228 msgid "inspect-get-minor-version"
21232 #: ../fish/guestfish-actions.pod:1799
21235 " inspect-get-minor-version root\n"
21240 #: ../fish/guestfish-actions.pod:1809
21242 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21243 "get-major-version>."
21247 #: ../fish/guestfish-actions.pod:1812
21248 msgid "inspect-get-mountpoints"
21252 #: ../fish/guestfish-actions.pod:1814
21255 " inspect-get-mountpoints root\n"
21260 #: ../fish/guestfish-actions.pod:1832
21262 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21263 "get-filesystems>."
21267 #: ../fish/guestfish-actions.pod:1835
21268 msgid "inspect-get-package-format"
21272 #: ../fish/guestfish-actions.pod:1837
21275 " inspect-get-package-format root\n"
21280 #: ../fish/guestfish-actions.pod:1842
21282 "This function and L</inspect-get-package-management> return the package "
21283 "format and package management tool used by the inspected operating system. "
21284 "For example for Fedora these functions would return C<rpm> (package format) "
21285 "and C<yum> (package management)."
21289 #: ../fish/guestfish-actions.pod:1857
21290 msgid "inspect-get-package-management"
21294 #: ../fish/guestfish-actions.pod:1859
21297 " inspect-get-package-management root\n"
21302 #: ../fish/guestfish-actions.pod:1864
21304 "L</inspect-get-package-format> and this function return the package format "
21305 "and package management tool used by the inspected operating system. For "
21306 "example for Fedora these functions would return C<rpm> (package format) and "
21307 "C<yum> (package management)."
21311 #: ../fish/guestfish-actions.pod:1881
21312 msgid "inspect-get-product-name"
21316 #: ../fish/guestfish-actions.pod:1883
21319 " inspect-get-product-name root\n"
21324 #: ../fish/guestfish-actions.pod:1898
21325 msgid "inspect-get-roots"
21329 #: ../fish/guestfish-actions.pod:1900
21332 " inspect-get-roots\n"
21337 #: ../fish/guestfish-actions.pod:1902
21339 "This function is a convenient way to get the list of root devices, as "
21340 "returned from a previous call to L</inspect-os>, but without redoing the "
21341 "whole inspection process."
21345 #: ../fish/guestfish-actions.pod:1906
21347 "This returns an empty list if either no root devices were found or the "
21348 "caller has not called L</inspect-os>."
21352 #: ../fish/guestfish-actions.pod:1911
21353 msgid "inspect-get-type"
21357 #: ../fish/guestfish-actions.pod:1913
21360 " inspect-get-type root\n"
21365 #: ../fish/guestfish-actions.pod:1946
21366 msgid "inspect-get-windows-systemroot"
21370 #: ../fish/guestfish-actions.pod:1948
21373 " inspect-get-windows-systemroot root\n"
21378 #: ../fish/guestfish-actions.pod:1962
21379 msgid "inspect-list-applications"
21383 #: ../fish/guestfish-actions.pod:1964
21386 " inspect-list-applications root\n"
21391 #: ../fish/guestfish-actions.pod:1971
21393 "I<Note:> This call works differently from other parts of the inspection "
21394 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21395 "then mount up the disks, before calling this. Listing applications is a "
21396 "significantly more difficult operation which requires access to the full "
21397 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21398 "are just returning data cached in the libguestfs handle, this call actually "
21399 "reads parts of the mounted filesystems during the call."
21403 #: ../fish/guestfish-actions.pod:2061
21408 #: ../fish/guestfish-actions.pod:2063
21416 #: ../fish/guestfish-actions.pod:2078
21418 "You can pass the root string(s) returned to other L</inspect-get-*> "
21419 "functions in order to query further information about each operating system, "
21420 "such as the name and version."
21424 #: ../fish/guestfish-actions.pod:2083
21426 "This function uses other libguestfs features such as L</mount-ro> and L</"
21427 "umount-all> in order to mount and unmount filesystems and look at the "
21428 "contents. This should be called with no disks currently mounted. The "
21429 "function may also use Augeas, so any existing Augeas handle will be closed."
21433 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21434 #: ../fish/guestfish-actions.pod:2297
21435 msgid "See also L</list-filesystems>."
21439 #: ../fish/guestfish-actions.pod:2097
21440 msgid "is-blockdev"
21444 #: ../fish/guestfish-actions.pod:2099
21447 " is-blockdev path\n"
21452 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21453 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21454 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21455 #: ../fish/guestfish-actions.pod:2203
21456 msgid "See also L</stat>."
21460 #: ../fish/guestfish-actions.pod:2106
21465 #: ../fish/guestfish-actions.pod:2108
21473 #: ../fish/guestfish-actions.pod:2115
21478 #: ../fish/guestfish-actions.pod:2117
21481 " is-chardev path\n"
21486 #: ../fish/guestfish-actions.pod:2124
21491 #: ../fish/guestfish-actions.pod:2126
21499 #: ../fish/guestfish-actions.pod:2133
21504 #: ../fish/guestfish-actions.pod:2135
21512 #: ../fish/guestfish-actions.pod:2143
21517 #: ../fish/guestfish-actions.pod:2145
21525 #: ../fish/guestfish-actions.pod:2152
21530 #: ../fish/guestfish-actions.pod:2154
21538 #: ../fish/guestfish-actions.pod:2162
21539 msgid "is-launching"
21543 #: ../fish/guestfish-actions.pod:2164
21551 #: ../fish/guestfish-actions.pod:2171
21556 #: ../fish/guestfish-actions.pod:2173
21564 #: ../fish/guestfish-actions.pod:2178
21569 #: ../fish/guestfish-actions.pod:2180
21577 #: ../fish/guestfish-actions.pod:2187
21582 #: ../fish/guestfish-actions.pod:2189
21585 " is-socket path\n"
21590 #: ../fish/guestfish-actions.pod:2196
21595 #: ../fish/guestfish-actions.pod:2198
21598 " is-symlink path\n"
21603 #: ../fish/guestfish-actions.pod:2205
21604 msgid "kill-subprocess"
21608 #: ../fish/guestfish-actions.pod:2207
21611 " kill-subprocess\n"
21616 #: ../fish/guestfish-actions.pod:2211
21621 #: ../fish/guestfish-actions.pod:2213
21626 #: ../fish/guestfish-actions.pod:2215
21634 #: ../fish/guestfish-actions.pod:2223
21639 #: ../fish/guestfish-actions.pod:2225
21642 " lchown owner group path\n"
21647 #: ../fish/guestfish-actions.pod:2227
21649 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21650 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21655 #: ../fish/guestfish-actions.pod:2235
21660 #: ../fish/guestfish-actions.pod:2237
21663 " lgetxattrs path\n"
21668 #: ../fish/guestfish-actions.pod:2239
21670 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21671 "it returns the extended attributes of the link itself."
21675 #: ../fish/guestfish-actions.pod:2243
21676 msgid "list-devices"
21680 #: ../fish/guestfish-actions.pod:2245
21688 #: ../fish/guestfish-actions.pod:2253
21689 msgid "list-filesystems"
21693 #: ../fish/guestfish-actions.pod:2255
21696 " list-filesystems\n"
21701 #: ../fish/guestfish-actions.pod:2274
21703 "This command runs other libguestfs commands, which might include L</mount> "
21704 "and L</umount>, and therefore you should use this soon after launch and only "
21705 "when nothing is mounted."
21709 #: ../fish/guestfish-actions.pod:2278
21711 "Not all of the filesystems returned will be mountable. In particular, swap "
21712 "partitions are returned in the list. Also this command does not check that "
21713 "each filesystem found is valid and mountable, and some filesystems might be "
21714 "mountable but require special options. Filesystems may not all belong to a "
21715 "single logical operating system (use L</inspect-os> to look for OSes)."
21719 #: ../fish/guestfish-actions.pod:2286
21720 msgid "list-partitions"
21724 #: ../fish/guestfish-actions.pod:2288
21727 " list-partitions\n"
21732 #: ../fish/guestfish-actions.pod:2294
21734 "This does not return logical volumes. For that you will need to call L</"
21739 #: ../fish/guestfish-actions.pod:2299
21744 #: ../fish/guestfish-actions.pod:2301
21752 #: ../fish/guestfish-actions.pod:2309
21757 #: ../fish/guestfish-actions.pod:2311
21760 " ln target linkname\n"
21765 #: ../fish/guestfish-actions.pod:2315
21770 #: ../fish/guestfish-actions.pod:2317
21773 " ln-f target linkname\n"
21778 #: ../fish/guestfish-actions.pod:2322
21783 #: ../fish/guestfish-actions.pod:2324
21786 " ln-s target linkname\n"
21791 #: ../fish/guestfish-actions.pod:2328
21796 #: ../fish/guestfish-actions.pod:2330
21799 " ln-sf target linkname\n"
21804 #: ../fish/guestfish-actions.pod:2335
21805 msgid "lremovexattr"
21809 #: ../fish/guestfish-actions.pod:2337
21812 " lremovexattr xattr path\n"
21817 #: ../fish/guestfish-actions.pod:2339
21819 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21820 "it removes an extended attribute of the link itself."
21824 #: ../fish/guestfish-actions.pod:2343
21829 #: ../fish/guestfish-actions.pod:2345
21837 #: ../fish/guestfish-actions.pod:2351
21839 "This command is mostly useful for interactive sessions. Programs should "
21840 "probably use L</readdir> instead."
21844 #: ../fish/guestfish-actions.pod:2354
21849 #: ../fish/guestfish-actions.pod:2356
21852 " lsetxattr xattr val vallen path\n"
21857 #: ../fish/guestfish-actions.pod:2358
21859 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21860 "sets an extended attribute of the link itself."
21864 #: ../fish/guestfish-actions.pod:2362
21869 #: ../fish/guestfish-actions.pod:2364
21877 #: ../fish/guestfish-actions.pod:2368
21879 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21880 "the link is stat-ed, not the file it refers to."
21884 #: ../fish/guestfish-actions.pod:2374
21889 #: ../fish/guestfish-actions.pod:2376
21892 " lstatlist path 'names ...'\n"
21897 #: ../fish/guestfish-actions.pod:2378
21899 "This call allows you to perform the L</lstat> operation on multiple files, "
21900 "where all files are in the directory C<path>. C<names> is the list of files "
21901 "from this directory."
21905 #: ../fish/guestfish-actions.pod:2387
21907 "This call is intended for programs that want to efficiently list a directory "
21908 "contents without making many round-trips. See also L</lxattrlist> for a "
21909 "similarly efficient call for getting extended attributes. Very long "
21910 "directory listings might cause the protocol message size to be exceeded, "
21911 "causing this call to fail. The caller must split up such requests into "
21912 "smaller groups of names."
21916 #: ../fish/guestfish-actions.pod:2395
21917 msgid "luks-add-key"
21921 #: ../fish/guestfish-actions.pod:2397
21924 " luks-add-key device keyslot\n"
21929 #: ../fish/guestfish-actions.pod:2404
21931 "Note that if C<keyslot> already contains a key, then this command will "
21932 "fail. You have to use L</luks-kill-slot> first to remove that key."
21936 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21937 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21938 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21940 "This command has one or more key or passphrase parameters. Guestfish will "
21941 "prompt for these separately."
21945 #: ../fish/guestfish-actions.pod:2411
21950 #: ../fish/guestfish-actions.pod:2413
21953 " luks-close device\n"
21958 #: ../fish/guestfish-actions.pod:2415
21960 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21961 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21962 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21967 #: ../fish/guestfish-actions.pod:2421
21968 msgid "luks-format"
21972 #: ../fish/guestfish-actions.pod:2423
21975 " luks-format device keyslot\n"
21980 #: ../fish/guestfish-actions.pod:2436
21981 msgid "luks-format-cipher"
21985 #: ../fish/guestfish-actions.pod:2438
21988 " luks-format-cipher device keyslot cipher\n"
21993 #: ../fish/guestfish-actions.pod:2440
21995 "This command is the same as L</luks-format> but it also allows you to set "
21996 "the C<cipher> used."
22000 #: ../fish/guestfish-actions.pod:2449
22001 msgid "luks-kill-slot"
22005 #: ../fish/guestfish-actions.pod:2451
22008 " luks-kill-slot device keyslot\n"
22013 #: ../fish/guestfish-actions.pod:2460
22018 #: ../fish/guestfish-actions.pod:2462
22021 " luks-open device mapname\n"
22026 #: ../fish/guestfish-actions.pod:2476
22028 "If this block device contains LVM volume groups, then calling L</vgscan> "
22029 "followed by L</vg-activate-all> will make them visible."
22033 #: ../fish/guestfish-actions.pod:2483
22034 msgid "luks-open-ro"
22038 #: ../fish/guestfish-actions.pod:2485
22041 " luks-open-ro device mapname\n"
22046 #: ../fish/guestfish-actions.pod:2487
22048 "This is the same as L</luks-open> except that a read-only mapping is created."
22052 #: ../fish/guestfish-actions.pod:2493
22057 #: ../fish/guestfish-actions.pod:2495
22060 " lvcreate logvol volgroup mbytes\n"
22065 #: ../fish/guestfish-actions.pod:2500
22066 msgid "lvm-canonical-lv-name"
22070 #: ../fish/guestfish-actions.pod:2502
22073 " lvm-canonical-lv-name lvname\n"
22078 #: ../fish/guestfish-actions.pod:2511
22079 msgid "See also L</is-lv>."
22083 #: ../fish/guestfish-actions.pod:2513
22084 msgid "lvm-clear-filter"
22088 #: ../fish/guestfish-actions.pod:2515
22091 " lvm-clear-filter\n"
22096 #: ../fish/guestfish-actions.pod:2517
22098 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22103 #: ../fish/guestfish-actions.pod:2523
22104 msgid "lvm-remove-all"
22108 #: ../fish/guestfish-actions.pod:2525
22111 " lvm-remove-all\n"
22116 #: ../fish/guestfish-actions.pod:2533
22117 msgid "lvm-set-filter"
22121 #: ../fish/guestfish-actions.pod:2535
22124 " lvm-set-filter 'devices ...'\n"
22129 #: ../fish/guestfish-actions.pod:2560
22134 #: ../fish/guestfish-actions.pod:2562
22137 " lvremove device\n"
22142 #: ../fish/guestfish-actions.pod:2570
22147 #: ../fish/guestfish-actions.pod:2572
22150 " lvrename logvol newlogvol\n"
22155 #: ../fish/guestfish-actions.pod:2576
22160 #: ../fish/guestfish-actions.pod:2578
22163 " lvresize device mbytes\n"
22168 #: ../fish/guestfish-actions.pod:2584
22169 msgid "lvresize-free"
22173 #: ../fish/guestfish-actions.pod:2586
22176 " lvresize-free lv percent\n"
22181 #: ../fish/guestfish-actions.pod:2594
22186 #: ../fish/guestfish-actions.pod:2596
22194 #: ../fish/guestfish-actions.pod:2604
22195 msgid "See also L</lvs-full>, L</list-filesystems>."
22199 #: ../fish/guestfish-actions.pod:2606
22204 #: ../fish/guestfish-actions.pod:2608
22212 #: ../fish/guestfish-actions.pod:2613
22217 #: ../fish/guestfish-actions.pod:2615
22225 #: ../fish/guestfish-actions.pod:2619
22230 #: ../fish/guestfish-actions.pod:2621
22233 " lxattrlist path 'names ...'\n"
22238 #: ../fish/guestfish-actions.pod:2637
22240 "This call is intended for programs that want to efficiently list a directory "
22241 "contents without making many round-trips. See also L</lstatlist> for a "
22242 "similarly efficient call for getting standard stats. Very long directory "
22243 "listings might cause the protocol message size to be exceeded, causing this "
22244 "call to fail. The caller must split up such requests into smaller groups of "
22249 #: ../fish/guestfish-actions.pod:2645
22254 #: ../fish/guestfish-actions.pod:2647
22262 #: ../fish/guestfish-actions.pod:2651
22267 #: ../fish/guestfish-actions.pod:2653
22270 " mkdir-mode path mode\n"
22275 #: ../fish/guestfish-actions.pod:2662
22276 msgid "See also L</mkdir>, L</umask>"
22280 #: ../fish/guestfish-actions.pod:2664
22285 #: ../fish/guestfish-actions.pod:2666
22293 #: ../fish/guestfish-actions.pod:2671
22298 #: ../fish/guestfish-actions.pod:2673
22301 " mkdtemp template\n"
22306 #: ../fish/guestfish-actions.pod:2694
22311 #: ../fish/guestfish-actions.pod:2696
22314 " mke2fs-J fstype blocksize device journal\n"
22319 #: ../fish/guestfish-actions.pod:2704
22320 msgid "See also L</mke2journal>."
22324 #: ../fish/guestfish-actions.pod:2706
22329 #: ../fish/guestfish-actions.pod:2708
22332 " mke2fs-JL fstype blocksize device label\n"
22337 #: ../fish/guestfish-actions.pod:2713
22338 msgid "See also L</mke2journal-L>."
22342 #: ../fish/guestfish-actions.pod:2715
22347 #: ../fish/guestfish-actions.pod:2717
22350 " mke2fs-JU fstype blocksize device uuid\n"
22355 #: ../fish/guestfish-actions.pod:2722
22356 msgid "See also L</mke2journal-U>."
22360 #: ../fish/guestfish-actions.pod:2724
22361 msgid "mke2journal"
22365 #: ../fish/guestfish-actions.pod:2726
22368 " mke2journal blocksize device\n"
22373 #: ../fish/guestfish-actions.pod:2733
22374 msgid "mke2journal-L"
22378 #: ../fish/guestfish-actions.pod:2735
22381 " mke2journal-L blocksize label device\n"
22386 #: ../fish/guestfish-actions.pod:2739
22387 msgid "mke2journal-U"
22391 #: ../fish/guestfish-actions.pod:2741
22394 " mke2journal-U blocksize uuid device\n"
22399 #: ../fish/guestfish-actions.pod:2745
22404 #: ../fish/guestfish-actions.pod:2747
22407 " mkfifo mode path\n"
22412 #: ../fish/guestfish-actions.pod:2749
22414 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22415 "is just a convenient wrapper around L</mknod>."
22419 #: ../fish/guestfish-actions.pod:2755
22424 #: ../fish/guestfish-actions.pod:2757
22427 " mkfs fstype device\n"
22432 #: ../fish/guestfish-actions.pod:2763
22437 #: ../fish/guestfish-actions.pod:2765
22440 " mkfs-b fstype blocksize device\n"
22445 #: ../fish/guestfish-actions.pod:2767
22447 "This call is similar to L</mkfs>, but it allows you to control the block "
22448 "size of the resulting filesystem. Supported block sizes depend on the "
22449 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22453 #: ../fish/guestfish-actions.pod:2775
22454 msgid "mkmountpoint"
22458 #: ../fish/guestfish-actions.pod:2777
22461 " mkmountpoint exemptpath\n"
22466 #: ../fish/guestfish-actions.pod:2779
22468 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22469 "to create extra mountpoints before mounting the first filesystem."
22473 #: ../fish/guestfish-actions.pod:2803
22475 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22476 "unexpected errors if you try to mix these calls. It is safest to manually "
22477 "unmount filesystems and remove mountpoints after use."
22481 #: ../fish/guestfish-actions.pod:2807
22483 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22484 "for this to work for manual mountpoints, you must ensure that the innermost "
22485 "mountpoints have the longest pathnames, as in the example code above."
22489 #: ../fish/guestfish-actions.pod:2814
22491 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22492 "that L</umount-all> is called when the handle is closed which can also "
22493 "trigger these issues."
22497 #: ../fish/guestfish-actions.pod:2818
22502 #: ../fish/guestfish-actions.pod:2820
22505 " mknod mode devmajor devminor path\n"
22510 #: ../fish/guestfish-actions.pod:2830
22512 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22513 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22514 "regular file). These constants are available in the standard Linux header "
22515 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22516 "wrappers around this command which bitwise OR in the appropriate constant "
22521 #: ../fish/guestfish-actions.pod:2840
22526 #: ../fish/guestfish-actions.pod:2842
22529 " mknod-b mode devmajor devminor path\n"
22534 #: ../fish/guestfish-actions.pod:2844
22536 "This call creates a block device node called C<path> with mode C<mode> and "
22537 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22538 "wrapper around L</mknod>."
22542 #: ../fish/guestfish-actions.pod:2850
22547 #: ../fish/guestfish-actions.pod:2852
22550 " mknod-c mode devmajor devminor path\n"
22555 #: ../fish/guestfish-actions.pod:2854
22557 "This call creates a char device node called C<path> with mode C<mode> and "
22558 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22559 "wrapper around L</mknod>."
22563 #: ../fish/guestfish-actions.pod:2860
22568 #: ../fish/guestfish-actions.pod:2862
22576 #: ../fish/guestfish-actions.pod:2866
22581 #: ../fish/guestfish-actions.pod:2868
22584 " mkswap-L label device\n"
22589 #: ../fish/guestfish-actions.pod:2876
22594 #: ../fish/guestfish-actions.pod:2878
22597 " mkswap-U uuid device\n"
22602 #: ../fish/guestfish-actions.pod:2882
22603 msgid "mkswap-file"
22607 #: ../fish/guestfish-actions.pod:2884
22610 " mkswap-file path\n"
22615 #: ../fish/guestfish-actions.pod:2888
22617 "This command just writes a swap file signature to an existing file. To "
22618 "create the file itself, use something like L</fallocate>."
22622 #: ../fish/guestfish-actions.pod:2891
22627 #: ../fish/guestfish-actions.pod:2893
22630 " modprobe modulename\n"
22635 #: ../fish/guestfish-actions.pod:2900
22640 #: ../fish/guestfish-actions.pod:2902
22643 " mount device mountpoint\n"
22648 #: ../fish/guestfish-actions.pod:2918
22650 "B<Important note:> When you use this call, the filesystem options C<sync> "
22651 "and C<noatime> are set implicitly. This was originally done because we "
22652 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22653 "very large negative performance impact and negligible effect on "
22654 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22655 "code that needs performance, and instead use L</mount-options> (use an empty "
22656 "string for the first parameter if you don't want any options)."
22660 #: ../fish/guestfish-actions.pod:2928
22665 #: ../fish/guestfish-actions.pod:2930
22668 " mount-loop file mountpoint\n"
22673 #: ../fish/guestfish-actions.pod:2936
22674 msgid "mount-options"
22678 #: ../fish/guestfish-actions.pod:2938
22681 " mount-options options device mountpoint\n"
22686 #: ../fish/guestfish-actions.pod:2940
22688 "This is the same as the L</mount> command, but it allows you to set the "
22689 "mount options as for the L<mount(8)> I<-o> flag."
22693 #: ../fish/guestfish-actions.pod:2948
22698 #: ../fish/guestfish-actions.pod:2950
22701 " mount-ro device mountpoint\n"
22706 #: ../fish/guestfish-actions.pod:2952
22708 "This is the same as the L</mount> command, but it mounts the filesystem with "
22709 "the read-only (I<-o ro>) flag."
22713 #: ../fish/guestfish-actions.pod:2955
22718 #: ../fish/guestfish-actions.pod:2957
22721 " mount-vfs options vfstype device mountpoint\n"
22726 #: ../fish/guestfish-actions.pod:2959
22728 "This is the same as the L</mount> command, but it allows you to set both the "
22729 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22733 #: ../fish/guestfish-actions.pod:2963
22734 msgid "mountpoints"
22738 #: ../fish/guestfish-actions.pod:2965
22746 #: ../fish/guestfish-actions.pod:2967
22748 "This call is similar to L</mounts>. That call returns a list of devices. "
22749 "This one returns a hash table (map) of device name to directory where the "
22750 "device is mounted."
22754 #: ../fish/guestfish-actions.pod:2971
22759 #: ../fish/guestfish-actions.pod:2973
22767 #: ../fish/guestfish-actions.pod:2980
22768 msgid "See also: L</mountpoints>"
22772 #: ../fish/guestfish-actions.pod:2982
22777 #: ../fish/guestfish-actions.pod:2984
22785 #: ../fish/guestfish-actions.pod:2989
22786 msgid "ntfs-3g-probe"
22790 #: ../fish/guestfish-actions.pod:2991
22793 " ntfs-3g-probe true|false device\n"
22798 #: ../fish/guestfish-actions.pod:3005
22803 #: ../fish/guestfish-actions.pod:3007
22806 " ntfsresize device\n"
22811 #: ../fish/guestfish-actions.pod:3013
22812 msgid "ntfsresize-size"
22816 #: ../fish/guestfish-actions.pod:3015
22819 " ntfsresize-size device size\n"
22824 #: ../fish/guestfish-actions.pod:3017
22826 "This command is the same as L</ntfsresize> except that it allows you to "
22827 "specify the new size (in bytes) explicitly."
22831 #: ../fish/guestfish-actions.pod:3020
22836 #: ../fish/guestfish-actions.pod:3022
22839 " part-add device prlogex startsect endsect\n"
22844 #: ../fish/guestfish-actions.pod:3024
22846 "This command adds a partition to C<device>. If there is no partition table "
22847 "on the device, call L</part-init> first."
22851 #: ../fish/guestfish-actions.pod:3036
22853 "Creating a partition which covers the whole disk is not so easy. Use L</"
22854 "part-disk> to do that."
22858 #: ../fish/guestfish-actions.pod:3039
22863 #: ../fish/guestfish-actions.pod:3041
22866 " part-del device partnum\n"
22871 #: ../fish/guestfish-actions.pod:3049
22876 #: ../fish/guestfish-actions.pod:3051
22879 " part-disk device parttype\n"
22884 #: ../fish/guestfish-actions.pod:3053
22886 "This command is simply a combination of L</part-init> followed by L</part-"
22887 "add> to create a single primary partition covering the whole disk."
22891 #: ../fish/guestfish-actions.pod:3057
22893 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22894 "possible values are described in L</part-init>."
22898 #: ../fish/guestfish-actions.pod:3063
22899 msgid "part-get-bootable"
22903 #: ../fish/guestfish-actions.pod:3065
22906 " part-get-bootable device partnum\n"
22911 #: ../fish/guestfish-actions.pod:3070
22912 msgid "See also L</part-set-bootable>."
22916 #: ../fish/guestfish-actions.pod:3072
22917 msgid "part-get-mbr-id"
22921 #: ../fish/guestfish-actions.pod:3074
22924 " part-get-mbr-id device partnum\n"
22929 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22931 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22932 "undefined results for other partition table types (see L</part-get-"
22937 #: ../fish/guestfish-actions.pod:3083
22938 msgid "part-get-parttype"
22942 #: ../fish/guestfish-actions.pod:3085
22945 " part-get-parttype device\n"
22950 #: ../fish/guestfish-actions.pod:3090
22952 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22953 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22954 "possible, although unusual. See L</part-init> for a full list."
22958 #: ../fish/guestfish-actions.pod:3095
22963 #: ../fish/guestfish-actions.pod:3097
22966 " part-init device parttype\n"
22971 #: ../fish/guestfish-actions.pod:3103
22973 "Initially there are no partitions. Following this, you should call L</part-"
22974 "add> for each partition required."
22978 #: ../fish/guestfish-actions.pod:3166
22983 #: ../fish/guestfish-actions.pod:3168
22986 " part-list device\n"
22991 #: ../fish/guestfish-actions.pod:3183
22993 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22994 "the device's sector size, see L</blockdev-getss>."
22998 #: ../fish/guestfish-actions.pod:3196
22999 msgid "part-set-bootable"
23003 #: ../fish/guestfish-actions.pod:3198
23006 " part-set-bootable device partnum true|false\n"
23011 #: ../fish/guestfish-actions.pod:3207
23012 msgid "part-set-mbr-id"
23016 #: ../fish/guestfish-actions.pod:3209
23019 " part-set-mbr-id device partnum idbyte\n"
23024 #: ../fish/guestfish-actions.pod:3221
23025 msgid "part-set-name"
23029 #: ../fish/guestfish-actions.pod:3223
23032 " part-set-name device partnum name\n"
23037 #: ../fish/guestfish-actions.pod:3231
23038 msgid "part-to-dev"
23042 #: ../fish/guestfish-actions.pod:3233
23045 " part-to-dev partition\n"
23050 #: ../fish/guestfish-actions.pod:3239
23052 "The named partition must exist, for example as a string returned from L</"
23053 "list-partitions>."
23057 #: ../fish/guestfish-actions.pod:3242
23058 msgid "ping-daemon"
23062 #: ../fish/guestfish-actions.pod:3244
23070 #: ../fish/guestfish-actions.pod:3251
23075 #: ../fish/guestfish-actions.pod:3253
23078 " pread path count offset\n"
23083 #: ../fish/guestfish-actions.pod:3261
23084 msgid "See also L</pwrite>, L</pread-device>."
23088 #: ../fish/guestfish-actions.pod:3266
23089 msgid "pread-device"
23093 #: ../fish/guestfish-actions.pod:3268
23096 " pread-device device count offset\n"
23101 #: ../fish/guestfish-actions.pod:3276
23102 msgid "See also L</pread>."
23106 #: ../fish/guestfish-actions.pod:3281
23111 #: ../fish/guestfish-actions.pod:3283
23114 " pvcreate device\n"
23119 #: ../fish/guestfish-actions.pod:3289
23124 #: ../fish/guestfish-actions.pod:3291
23127 " pvremove device\n"
23132 #: ../fish/guestfish-actions.pod:3300
23137 #: ../fish/guestfish-actions.pod:3302
23140 " pvresize device\n"
23145 #: ../fish/guestfish-actions.pod:3307
23146 msgid "pvresize-size"
23150 #: ../fish/guestfish-actions.pod:3309
23153 " pvresize-size device size\n"
23158 #: ../fish/guestfish-actions.pod:3311
23160 "This command is the same as L</pvresize> except that it allows you to "
23161 "specify the new size (in bytes) explicitly."
23165 #: ../fish/guestfish-actions.pod:3314
23170 #: ../fish/guestfish-actions.pod:3316
23178 #: ../fish/guestfish-actions.pod:3324
23179 msgid "See also L</pvs-full>."
23183 #: ../fish/guestfish-actions.pod:3326
23188 #: ../fish/guestfish-actions.pod:3328
23196 #: ../fish/guestfish-actions.pod:3333
23201 #: ../fish/guestfish-actions.pod:3335
23209 #: ../fish/guestfish-actions.pod:3339
23214 #: ../fish/guestfish-actions.pod:3341
23217 " pwrite path content offset\n"
23222 #: ../fish/guestfish-actions.pod:3352
23223 msgid "See also L</pread>, L</pwrite-device>."
23227 #: ../fish/guestfish-actions.pod:3357
23228 msgid "pwrite-device"
23232 #: ../fish/guestfish-actions.pod:3359
23235 " pwrite-device device content offset\n"
23240 #: ../fish/guestfish-actions.pod:3369
23241 msgid "See also L</pwrite>."
23245 #: ../fish/guestfish-actions.pod:3374
23250 #: ../fish/guestfish-actions.pod:3376
23253 " read-file path\n"
23258 #: ../fish/guestfish-actions.pod:3381
23260 "Unlike L</cat>, this function can correctly handle files that contain "
23261 "embedded ASCII NUL characters. However unlike L</download>, this function "
23262 "is limited in the total size of file that can be handled."
23266 #: ../fish/guestfish-actions.pod:3389
23271 #: ../fish/guestfish-actions.pod:3391
23274 " read-lines path\n"
23279 #: ../fish/guestfish-actions.pod:3398
23281 "Note that this function cannot correctly handle binary files (specifically, "
23282 "files containing C<\\0> character which is treated as end of line). For "
23283 "those you need to use the L</read-file> function which has a more complex "
23288 #: ../fish/guestfish-actions.pod:3403
23293 #: ../fish/guestfish-actions.pod:3405
23301 #: ../fish/guestfish-actions.pod:3457
23303 "This function is primarily intended for use by programs. To get a simple "
23304 "list of names, use L</ls>. To get a printable directory for human "
23305 "consumption, use L</ll>."
23309 #: ../fish/guestfish-actions.pod:3461
23314 #: ../fish/guestfish-actions.pod:3463
23322 #: ../fish/guestfish-actions.pod:3467
23323 msgid "readlinklist"
23327 #: ../fish/guestfish-actions.pod:3469
23330 " readlinklist path 'names ...'\n"
23335 #: ../fish/guestfish-actions.pod:3493
23340 #: ../fish/guestfish-actions.pod:3495
23348 #: ../fish/guestfish-actions.pod:3500
23349 msgid "removexattr"
23353 #: ../fish/guestfish-actions.pod:3502
23356 " removexattr xattr path\n"
23361 #: ../fish/guestfish-actions.pod:3507
23362 msgid "See also: L</lremovexattr>, L<attr(5)>."
23366 #: ../fish/guestfish-actions.pod:3509
23371 #: ../fish/guestfish-actions.pod:3511
23374 " resize2fs device\n"
23379 #: ../fish/guestfish-actions.pod:3516
23381 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23382 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23383 "gives an error about this and sometimes not. In any case, it is always safe "
23384 "to call L</e2fsck-f> before calling this function."
23388 #: ../fish/guestfish-actions.pod:3522
23389 msgid "resize2fs-size"
23393 #: ../fish/guestfish-actions.pod:3524
23396 " resize2fs-size device size\n"
23401 #: ../fish/guestfish-actions.pod:3526
23403 "This command is the same as L</resize2fs> except that it allows you to "
23404 "specify the new size (in bytes) explicitly."
23408 #: ../fish/guestfish-actions.pod:3529
23413 #: ../fish/guestfish-actions.pod:3531
23421 #: ../fish/guestfish-actions.pod:3535
23426 #: ../fish/guestfish-actions.pod:3537
23434 #: ../fish/guestfish-actions.pod:3543
23439 #: ../fish/guestfish-actions.pod:3545
23447 #: ../fish/guestfish-actions.pod:3549
23448 msgid "rmmountpoint"
23452 #: ../fish/guestfish-actions.pod:3551
23455 " rmmountpoint exemptpath\n"
23460 #: ../fish/guestfish-actions.pod:3553
23462 "This calls removes a mountpoint that was previously created with L</"
23463 "mkmountpoint>. See L</mkmountpoint> for full details."
23467 #: ../fish/guestfish-actions.pod:3557
23468 msgid "scrub-device"
23472 #: ../fish/guestfish-actions.pod:3559
23475 " scrub-device device\n"
23480 #: ../fish/guestfish-actions.pod:3570
23485 #: ../fish/guestfish-actions.pod:3572
23488 " scrub-file file\n"
23493 #: ../fish/guestfish-actions.pod:3582
23494 msgid "scrub-freespace"
23498 #: ../fish/guestfish-actions.pod:3584
23501 " scrub-freespace dir\n"
23506 #: ../fish/guestfish-actions.pod:3586
23508 "This command creates the directory C<dir> and then fills it with files until "
23509 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23510 "deletes them. The intention is to scrub any free space on the partition "
23511 "containing C<dir>."
23515 #: ../fish/guestfish-actions.pod:3595
23520 #: ../fish/guestfish-actions.pod:3597
23525 #: ../fish/guestfish-actions.pod:3599
23528 " set-append append\n"
23533 #: ../fish/guestfish-actions.pod:3610
23534 msgid "set-autosync"
23538 #: ../fish/guestfish-actions.pod:3612
23543 #: ../fish/guestfish-actions.pod:3614
23546 " set-autosync true|false\n"
23551 #: ../fish/guestfish-actions.pod:3616
23553 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23554 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23555 "closed (also if the program exits without closing handles)."
23559 #: ../fish/guestfish-actions.pod:3624
23564 #: ../fish/guestfish-actions.pod:3626
23569 #: ../fish/guestfish-actions.pod:3628
23572 " set-direct true|false\n"
23577 #: ../fish/guestfish-actions.pod:3634
23579 "One consequence of this is that log messages aren't caught by the library "
23580 "and handled by L</set-log-message-callback>, but go straight to stdout."
23584 #: ../fish/guestfish-actions.pod:3643
23585 msgid "set-e2label"
23589 #: ../fish/guestfish-actions.pod:3645
23592 " set-e2label device label\n"
23597 #: ../fish/guestfish-actions.pod:3651
23599 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23600 "label on a filesystem."
23604 #: ../fish/guestfish-actions.pod:3654
23609 #: ../fish/guestfish-actions.pod:3656
23612 " set-e2uuid device uuid\n"
23617 #: ../fish/guestfish-actions.pod:3663
23619 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23620 "UUID of a filesystem."
23624 #: ../fish/guestfish-actions.pod:3666
23625 msgid "set-memsize"
23629 #: ../fish/guestfish-actions.pod:3668
23634 #: ../fish/guestfish-actions.pod:3670
23637 " set-memsize memsize\n"
23642 #: ../fish/guestfish-actions.pod:3672
23644 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23645 "This only has any effect if called before L</launch>."
23649 #: ../fish/guestfish-actions.pod:3683
23650 msgid "set-network"
23654 #: ../fish/guestfish-actions.pod:3685
23659 #: ../fish/guestfish-actions.pod:3687
23662 " set-network true|false\n"
23667 #: ../fish/guestfish-actions.pod:3695
23669 "You must call this before calling L</launch>, otherwise it has no effect."
23673 #: ../fish/guestfish-actions.pod:3698
23678 #: ../fish/guestfish-actions.pod:3700
23683 #: ../fish/guestfish-actions.pod:3702
23686 " set-path searchpath\n"
23691 #: ../fish/guestfish-actions.pod:3711
23696 #: ../fish/guestfish-actions.pod:3713
23701 #: ../fish/guestfish-actions.pod:3715
23709 #: ../fish/guestfish-actions.pod:3735
23710 msgid "set-recovery-proc"
23714 #: ../fish/guestfish-actions.pod:3737
23715 msgid "recovery-proc"
23719 #: ../fish/guestfish-actions.pod:3739
23722 " set-recovery-proc true|false\n"
23727 #: ../fish/guestfish-actions.pod:3741
23729 "If this is called with the parameter C<false> then L</launch> does not "
23730 "create a recovery process. The purpose of the recovery process is to stop "
23731 "runaway qemu processes in the case where the main program aborts abruptly."
23735 #: ../fish/guestfish-actions.pod:3746
23737 "This only has any effect if called before L</launch>, and the default is "
23742 #: ../fish/guestfish-actions.pod:3755
23743 msgid "set-selinux"
23747 #: ../fish/guestfish-actions.pod:3757
23752 #: ../fish/guestfish-actions.pod:3759
23755 " set-selinux true|false\n"
23760 #: ../fish/guestfish-actions.pod:3770
23765 #: ../fish/guestfish-actions.pod:3772
23770 #: ../fish/guestfish-actions.pod:3774
23773 " set-trace true|false\n"
23778 #: ../fish/guestfish-actions.pod:3790
23779 msgid "set-verbose"
23783 #: ../fish/guestfish-actions.pod:3792
23788 #: ../fish/guestfish-actions.pod:3794
23791 " set-verbose true|false\n"
23796 #: ../fish/guestfish-actions.pod:3801
23801 #: ../fish/guestfish-actions.pod:3803
23804 " setcon context\n"
23809 #: ../fish/guestfish-actions.pod:3810
23814 #: ../fish/guestfish-actions.pod:3812
23817 " setxattr xattr val vallen path\n"
23822 #: ../fish/guestfish-actions.pod:3818
23823 msgid "See also: L</lsetxattr>, L<attr(5)>."
23827 #: ../fish/guestfish-actions.pod:3820
23832 #: ../fish/guestfish-actions.pod:3822
23835 " sfdisk device cyls heads sectors 'lines ...'\n"
23840 #: ../fish/guestfish-actions.pod:3844
23841 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23845 #: ../fish/guestfish-actions.pod:3850
23850 #: ../fish/guestfish-actions.pod:3852
23853 " sfdiskM device 'lines ...'\n"
23858 #: ../fish/guestfish-actions.pod:3854
23860 "This is a simplified interface to the L</sfdisk> command, where partition "
23861 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23862 "you don't need to specify the cyls, heads and sectors parameters which were "
23863 "rarely if ever used anyway."
23867 #: ../fish/guestfish-actions.pod:3860
23868 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23872 #: ../fish/guestfish-actions.pod:3866
23877 #: ../fish/guestfish-actions.pod:3868
23880 " sfdisk-N device partnum cyls heads sectors line\n"
23885 #: ../fish/guestfish-actions.pod:3873
23887 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23888 "cyls/heads/sectors parameters."
23892 #: ../fish/guestfish-actions.pod:3876
23893 msgid "See also: L</part-add>"
23897 #: ../fish/guestfish-actions.pod:3881
23898 msgid "sfdisk-disk-geometry"
23902 #: ../fish/guestfish-actions.pod:3883
23905 " sfdisk-disk-geometry device\n"
23910 #: ../fish/guestfish-actions.pod:3885
23912 "This displays the disk geometry of C<device> read from the partition table. "
23913 "Especially in the case where the underlying block device has been resized, "
23914 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23915 "kernel-geometry>)."
23919 #: ../fish/guestfish-actions.pod:3893
23920 msgid "sfdisk-kernel-geometry"
23924 #: ../fish/guestfish-actions.pod:3895
23927 " sfdisk-kernel-geometry device\n"
23932 #: ../fish/guestfish-actions.pod:3902
23937 #: ../fish/guestfish-actions.pod:3904
23940 " sfdisk-l device\n"
23945 #: ../fish/guestfish-actions.pod:3910
23946 msgid "See also: L</part-list>"
23950 #: ../fish/guestfish-actions.pod:3912
23955 #: ../fish/guestfish-actions.pod:3914
23963 #: ../fish/guestfish-actions.pod:3919
23964 msgid "This is like L</command>, but passes the command to:"
23968 #: ../fish/guestfish-actions.pod:3927
23969 msgid "All the provisos about L</command> apply to this call."
23973 #: ../fish/guestfish-actions.pod:3929
23978 #: ../fish/guestfish-actions.pod:3931
23981 " sh-lines command\n"
23986 #: ../fish/guestfish-actions.pod:3933
23987 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23991 #: ../fish/guestfish-actions.pod:3936
23992 msgid "See also: L</command-lines>"
23996 #: ../fish/guestfish-actions.pod:3938
24001 #: ../fish/guestfish-actions.pod:3940
24009 #: ../fish/guestfish-actions.pod:3944
24014 #: ../fish/guestfish-actions.pod:3946
24022 #: ../fish/guestfish-actions.pod:3952
24027 #: ../fish/guestfish-actions.pod:3954
24035 #: ../fish/guestfish-actions.pod:3962
24040 #: ../fish/guestfish-actions.pod:3964
24048 #: ../fish/guestfish-actions.pod:3972
24053 #: ../fish/guestfish-actions.pod:3974
24056 " strings-e encoding path\n"
24061 #: ../fish/guestfish-actions.pod:3976
24063 "This is like the L</strings> command, but allows you to specify the encoding "
24064 "of strings that are looked for in the source file C<path>."
24068 #: ../fish/guestfish-actions.pod:3986
24070 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24071 "ISO-8859-X (this is what L</strings> uses)."
24075 #: ../fish/guestfish-actions.pod:4018
24076 msgid "swapoff-device"
24080 #: ../fish/guestfish-actions.pod:4020
24083 " swapoff-device device\n"
24088 #: ../fish/guestfish-actions.pod:4022
24090 "This command disables the libguestfs appliance swap device or partition "
24091 "named C<device>. See L</swapon-device>."
24095 #: ../fish/guestfish-actions.pod:4026
24096 msgid "swapoff-file"
24100 #: ../fish/guestfish-actions.pod:4028
24103 " swapoff-file file\n"
24108 #: ../fish/guestfish-actions.pod:4032
24109 msgid "swapoff-label"
24113 #: ../fish/guestfish-actions.pod:4034
24116 " swapoff-label label\n"
24121 #: ../fish/guestfish-actions.pod:4039
24122 msgid "swapoff-uuid"
24126 #: ../fish/guestfish-actions.pod:4041
24129 " swapoff-uuid uuid\n"
24134 #: ../fish/guestfish-actions.pod:4046
24135 msgid "swapon-device"
24139 #: ../fish/guestfish-actions.pod:4048
24142 " swapon-device device\n"
24147 #: ../fish/guestfish-actions.pod:4050
24149 "This command enables the libguestfs appliance to use the swap device or "
24150 "partition named C<device>. The increased memory is made available for all "
24151 "commands, for example those run using L</command> or L</sh>."
24155 #: ../fish/guestfish-actions.pod:4062
24156 msgid "swapon-file"
24160 #: ../fish/guestfish-actions.pod:4064
24163 " swapon-file file\n"
24168 #: ../fish/guestfish-actions.pod:4066
24170 "This command enables swap to a file. See L</swapon-device> for other notes."
24174 #: ../fish/guestfish-actions.pod:4069
24175 msgid "swapon-label"
24179 #: ../fish/guestfish-actions.pod:4071
24182 " swapon-label label\n"
24187 #: ../fish/guestfish-actions.pod:4073
24189 "This command enables swap to a labeled swap partition. See L</swapon-"
24190 "device> for other notes."
24194 #: ../fish/guestfish-actions.pod:4076
24195 msgid "swapon-uuid"
24199 #: ../fish/guestfish-actions.pod:4078
24202 " swapon-uuid uuid\n"
24207 #: ../fish/guestfish-actions.pod:4080
24209 "This command enables swap to a swap partition with the given UUID. See L</"
24210 "swapon-device> for other notes."
24214 #: ../fish/guestfish-actions.pod:4083
24219 #: ../fish/guestfish-actions.pod:4085
24227 #: ../fish/guestfish-actions.pod:4093
24232 #: ../fish/guestfish-actions.pod:4095
24240 #: ../fish/guestfish-actions.pod:4103
24245 #: ../fish/guestfish-actions.pod:4105
24248 " tail-n nrlines path\n"
24253 #: ../fish/guestfish-actions.pod:4118
24258 #: ../fish/guestfish-actions.pod:4120
24261 " tar-in (tarfile|-) directory\n"
24266 #: ../fish/guestfish-actions.pod:4125
24267 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24271 #: ../fish/guestfish-actions.pod:4130
24276 #: ../fish/guestfish-actions.pod:4132
24279 " tar-out directory (tarfile|-)\n"
24284 #: ../fish/guestfish-actions.pod:4137
24285 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24289 #: ../fish/guestfish-actions.pod:4142
24294 #: ../fish/guestfish-actions.pod:4144
24297 " tgz-in (tarball|-) directory\n"
24302 #: ../fish/guestfish-actions.pod:4149
24303 msgid "To upload an uncompressed tarball, use L</tar-in>."
24307 #: ../fish/guestfish-actions.pod:4153
24312 #: ../fish/guestfish-actions.pod:4155
24315 " tgz-out directory (tarball|-)\n"
24320 #: ../fish/guestfish-actions.pod:4160
24321 msgid "To download an uncompressed tarball, use L</tar-out>."
24325 #: ../fish/guestfish-actions.pod:4164
24330 #: ../fish/guestfish-actions.pod:4166
24338 #: ../fish/guestfish-actions.pod:4175
24343 #: ../fish/guestfish-actions.pod:4177
24351 #: ../fish/guestfish-actions.pod:4182
24352 msgid "truncate-size"
24356 #: ../fish/guestfish-actions.pod:4184
24359 " truncate-size path size\n"
24364 #: ../fish/guestfish-actions.pod:4189
24366 "If the current file size is less than C<size> then the file is extended to "
24367 "the required size with zero bytes. This creates a sparse file (ie. disk "
24368 "blocks are not allocated for the file until you write to it). To create a "
24369 "non-sparse file of zeroes, use L</fallocate64> instead."
24373 #: ../fish/guestfish-actions.pod:4195
24378 #: ../fish/guestfish-actions.pod:4197
24381 " tune2fs-l device\n"
24386 #: ../fish/guestfish-actions.pod:4207
24391 #: ../fish/guestfish-actions.pod:4209
24394 " txz-in (tarball|-) directory\n"
24399 #: ../fish/guestfish-actions.pod:4216
24404 #: ../fish/guestfish-actions.pod:4218
24407 " txz-out directory (tarball|-)\n"
24412 #: ../fish/guestfish-actions.pod:4225
24417 #: ../fish/guestfish-actions.pod:4227
24425 #: ../fish/guestfish-actions.pod:4241
24426 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24430 #: ../fish/guestfish-actions.pod:4246
24435 #: ../fish/guestfish-actions.pod:4248
24440 #: ../fish/guestfish-actions.pod:4250
24443 " umount pathordevice\n"
24448 #: ../fish/guestfish-actions.pod:4256
24453 #: ../fish/guestfish-actions.pod:4258
24454 msgid "unmount-all"
24458 #: ../fish/guestfish-actions.pod:4260
24466 #: ../fish/guestfish-actions.pod:4266
24471 #: ../fish/guestfish-actions.pod:4268
24474 " upload (filename|-) remotefilename\n"
24479 #: ../fish/guestfish-actions.pod:4275
24480 msgid "See also L</download>."
24484 #: ../fish/guestfish-actions.pod:4279
24485 msgid "upload-offset"
24489 #: ../fish/guestfish-actions.pod:4281
24492 " upload-offset (filename|-) remotefilename offset\n"
24497 #: ../fish/guestfish-actions.pod:4293
24499 "Note that there is no limit on the amount of data that can be uploaded with "
24500 "this call, unlike with L</pwrite>, and this call always writes the full "
24501 "amount unless an error occurs."
24505 #: ../fish/guestfish-actions.pod:4298
24506 msgid "See also L</upload>, L</pwrite>."
24510 #: ../fish/guestfish-actions.pod:4302
24515 #: ../fish/guestfish-actions.pod:4304
24518 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24523 #: ../fish/guestfish-actions.pod:4323
24528 #: ../fish/guestfish-actions.pod:4325
24536 #: ../fish/guestfish-actions.pod:4352
24538 "I<Note:> Don't use this call to test for availability of features. In "
24539 "enterprise distributions we backport features from later versions into "
24540 "earlier versions, making this an unreliable way to test for features. Use "
24541 "L</available> instead."
24545 #: ../fish/guestfish-actions.pod:4358
24550 #: ../fish/guestfish-actions.pod:4360
24553 " vfs-label device\n"
24558 #: ../fish/guestfish-actions.pod:4367
24559 msgid "To find a filesystem from the label, use L</findfs-label>."
24563 #: ../fish/guestfish-actions.pod:4369
24568 #: ../fish/guestfish-actions.pod:4371
24571 " vfs-type device\n"
24576 #: ../fish/guestfish-actions.pod:4381
24581 #: ../fish/guestfish-actions.pod:4383
24584 " vfs-uuid device\n"
24589 #: ../fish/guestfish-actions.pod:4390
24590 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24594 #: ../fish/guestfish-actions.pod:4392
24595 msgid "vg-activate"
24599 #: ../fish/guestfish-actions.pod:4394
24602 " vg-activate true|false 'volgroups ...'\n"
24607 #: ../fish/guestfish-actions.pod:4407
24608 msgid "vg-activate-all"
24612 #: ../fish/guestfish-actions.pod:4409
24615 " vg-activate-all true|false\n"
24620 #: ../fish/guestfish-actions.pod:4419
24625 #: ../fish/guestfish-actions.pod:4421
24628 " vgcreate volgroup 'physvols ...'\n"
24633 #: ../fish/guestfish-actions.pod:4426
24638 #: ../fish/guestfish-actions.pod:4428
24641 " vglvuuids vgname\n"
24646 #: ../fish/guestfish-actions.pod:4433
24648 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24649 "logical volumes and volume groups."
24653 #: ../fish/guestfish-actions.pod:4436
24654 msgid "See also L</vgpvuuids>."
24658 #: ../fish/guestfish-actions.pod:4438
24663 #: ../fish/guestfish-actions.pod:4440
24666 " vgpvuuids vgname\n"
24671 #: ../fish/guestfish-actions.pod:4445
24673 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24674 "physical volumes and volume groups."
24678 #: ../fish/guestfish-actions.pod:4448
24679 msgid "See also L</vglvuuids>."
24683 #: ../fish/guestfish-actions.pod:4450
24688 #: ../fish/guestfish-actions.pod:4452
24691 " vgremove vgname\n"
24696 #: ../fish/guestfish-actions.pod:4459
24701 #: ../fish/guestfish-actions.pod:4461
24704 " vgrename volgroup newvolgroup\n"
24709 #: ../fish/guestfish-actions.pod:4465
24714 #: ../fish/guestfish-actions.pod:4467
24722 #: ../fish/guestfish-actions.pod:4475
24723 msgid "See also L</vgs-full>."
24727 #: ../fish/guestfish-actions.pod:4477
24732 #: ../fish/guestfish-actions.pod:4479
24740 #: ../fish/guestfish-actions.pod:4484
24745 #: ../fish/guestfish-actions.pod:4486
24753 #: ../fish/guestfish-actions.pod:4491
24758 #: ../fish/guestfish-actions.pod:4493
24766 #: ../fish/guestfish-actions.pod:4497
24771 #: ../fish/guestfish-actions.pod:4499
24779 #: ../fish/guestfish-actions.pod:4504
24784 #: ../fish/guestfish-actions.pod:4506
24792 #: ../fish/guestfish-actions.pod:4511
24797 #: ../fish/guestfish-actions.pod:4513
24805 #: ../fish/guestfish-actions.pod:4518
24810 #: ../fish/guestfish-actions.pod:4520
24813 " write path content\n"
24818 #: ../fish/guestfish-actions.pod:4528
24823 #: ../fish/guestfish-actions.pod:4530
24826 " write-file path content size\n"
24831 #: ../fish/guestfish-actions.pod:4553
24836 #: ../fish/guestfish-actions.pod:4555
24839 " zegrep regex path\n"
24844 #: ../fish/guestfish-actions.pod:4563
24849 #: ../fish/guestfish-actions.pod:4565
24852 " zegrepi regex path\n"
24857 #: ../fish/guestfish-actions.pod:4573
24862 #: ../fish/guestfish-actions.pod:4575
24870 #: ../fish/guestfish-actions.pod:4583
24871 msgid "See also: L</zero-device>, L</scrub-device>."
24875 #: ../fish/guestfish-actions.pod:4585
24876 msgid "zero-device"
24880 #: ../fish/guestfish-actions.pod:4587
24883 " zero-device device\n"
24888 #: ../fish/guestfish-actions.pod:4589
24890 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24891 "which just zeroes the first few blocks of a device."
24895 #: ../fish/guestfish-actions.pod:4596
24900 #: ../fish/guestfish-actions.pod:4598
24903 " zerofree device\n"
24908 #: ../fish/guestfish-actions.pod:4611
24913 #: ../fish/guestfish-actions.pod:4613
24916 " zfgrep pattern path\n"
24921 #: ../fish/guestfish-actions.pod:4621
24926 #: ../fish/guestfish-actions.pod:4623
24929 " zfgrepi pattern path\n"
24934 #: ../fish/guestfish-actions.pod:4631
24939 #: ../fish/guestfish-actions.pod:4633
24942 " zfile meth path\n"
24947 #: ../fish/guestfish-actions.pod:4640
24949 "Since 1.0.63, use L</file> instead which can now process compressed files."
24953 #: ../fish/guestfish-actions.pod:4650
24958 #: ../fish/guestfish-actions.pod:4652
24961 " zgrep regex path\n"
24966 #: ../fish/guestfish-actions.pod:4660
24971 #: ../fish/guestfish-actions.pod:4662
24974 " zgrepi regex path\n"
24979 #: ../fish/guestfish-commands.pod:1
24984 #: ../fish/guestfish-commands.pod:3
24989 #: ../fish/guestfish-commands.pod:5
24992 " alloc filename size\n"
24997 #: ../fish/guestfish-commands.pod:7
24999 "This creates an empty (zeroed) file of the given size, and then adds so it "
25000 "can be further examined."
25004 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25005 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25009 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25010 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25014 #: ../fish/guestfish-commands.pod:14
25016 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25017 "image, see L</PREPARED DISK IMAGES>."
25021 #: ../fish/guestfish-commands.pod:17
25026 #: ../fish/guestfish-commands.pod:19
25029 " copy-in local [local ...] /remotedir\n"
25034 #: ../fish/guestfish-commands.pod:21
25036 "C<copy-in> copies local files or directories recursively into the disk "
25037 "image, placing them in the directory called C</remotedir> (which must "
25038 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25039 "other commands as necessary."
25043 #: ../fish/guestfish-commands.pod:26
25045 "Multiple local files and directories can be specified, but the last "
25046 "parameter must always be a remote directory. Wildcards cannot be used."
25050 #: ../fish/guestfish-commands.pod:30
25055 #: ../fish/guestfish-commands.pod:32
25058 " copy-out remote [remote ...] localdir\n"
25063 #: ../fish/guestfish-commands.pod:34
25065 "C<copy-out> copies remote files or directories recursively out of the disk "
25066 "image, placing them on the host disk in a local directory called C<localdir> "
25067 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25068 "download>, L</tar-out> and other commands as necessary."
25072 #: ../fish/guestfish-commands.pod:40
25074 "Multiple remote files and directories can be specified, but the last "
25075 "parameter must always be a local directory. To download to the current "
25076 "directory, use C<.> as in:"
25080 #: ../fish/guestfish-commands.pod:44
25083 " copy-out /home .\n"
25088 #: ../fish/guestfish-commands.pod:46
25090 "Wildcards cannot be used in the ordinary command, but you can use them with "
25091 "the help of L</glob> like this:"
25095 #: ../fish/guestfish-commands.pod:49
25098 " glob copy-out /home/* .\n"
25103 #: ../fish/guestfish-commands.pod:51
25108 #: ../fish/guestfish-commands.pod:53
25111 " echo [params ...]\n"
25116 #: ../fish/guestfish-commands.pod:55
25117 msgid "This echos the parameters to the terminal."
25121 #: ../fish/guestfish-commands.pod:57
25126 #: ../fish/guestfish-commands.pod:59
25131 #: ../fish/guestfish-commands.pod:61
25136 #: ../fish/guestfish-commands.pod:63
25144 #: ../fish/guestfish-commands.pod:65
25146 "This is used to edit a file. It downloads the file, edits it locally using "
25147 "your editor, then uploads the result."
25151 #: ../fish/guestfish-commands.pod:68
25153 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25154 "or C<emacs> you will get those corresponding editors."
25158 #: ../fish/guestfish-commands.pod:72
25163 #: ../fish/guestfish-commands.pod:74
25166 " glob command args...\n"
25171 #: ../fish/guestfish-commands.pod:76
25173 "Expand wildcards in any paths in the args list, and run C<command> "
25174 "repeatedly on each matching path."
25178 #: ../fish/guestfish-commands.pod:79
25179 msgid "See L</WILDCARDS AND GLOBBING>."
25183 #: ../fish/guestfish-commands.pod:81
25188 #: ../fish/guestfish-commands.pod:83
25191 " hexedit <filename|device>\n"
25192 " hexedit <filename|device> <max>\n"
25193 " hexedit <filename|device> <start> <max>\n"
25198 #: ../fish/guestfish-commands.pod:87
25200 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25205 #: ../fish/guestfish-commands.pod:90
25207 "This command works by downloading potentially the whole file or device, "
25208 "editing it locally, then uploading it. If the file or device is large, you "
25209 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25210 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25211 "usual modifiers allowed such as C<1M> (1 megabyte)."
25215 #: ../fish/guestfish-commands.pod:97
25216 msgid "For example to edit the first few sectors of a disk you might do:"
25220 #: ../fish/guestfish-commands.pod:100
25223 " hexedit /dev/sda 1M\n"
25228 #: ../fish/guestfish-commands.pod:102
25230 "which would allow you to edit anywhere within the first megabyte of the disk."
25234 #: ../fish/guestfish-commands.pod:105
25235 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25239 #: ../fish/guestfish-commands.pod:107
25242 " hexedit /dev/sda1 0x400 0x400\n"
25247 #: ../fish/guestfish-commands.pod:109
25248 msgid "(assuming the superblock is in the standard location)."
25252 #: ../fish/guestfish-commands.pod:111
25254 "This command requires the external L<hexedit(1)> program. You can specify "
25255 "another program to use by setting the C<HEXEDITOR> environment variable."
25259 #: ../fish/guestfish-commands.pod:115
25260 msgid "See also L</hexdump>."
25264 #: ../fish/guestfish-commands.pod:117
25269 #: ../fish/guestfish-commands.pod:119
25277 #: ../fish/guestfish-commands.pod:121
25279 "Change the local directory, ie. the current directory of guestfish itself."
25283 #: ../fish/guestfish-commands.pod:124
25284 msgid "Note that C<!cd> won't do what you might expect."
25288 #: ../fish/guestfish-commands.pod:126
25293 #: ../fish/guestfish-commands.pod:128
25298 #: ../fish/guestfish-commands.pod:130
25306 #: ../fish/guestfish-commands.pod:132
25307 msgid "Opens the manual page for guestfish."
25311 #: ../fish/guestfish-commands.pod:134
25316 #: ../fish/guestfish-commands.pod:136
25321 #: ../fish/guestfish-commands.pod:138
25329 #: ../fish/guestfish-commands.pod:140
25337 #: ../fish/guestfish-commands.pod:142
25338 msgid "This is used to view a file."
25342 #: ../fish/guestfish-commands.pod:144
25344 "The default viewer is C<$PAGER>. However if you use the alternate command "
25345 "C<less> you will get the C<less> command specifically."
25349 #: ../fish/guestfish-commands.pod:147
25354 #: ../fish/guestfish-commands.pod:149
25362 #: ../fish/guestfish-commands.pod:151
25364 "Close and reopen the libguestfs handle. It is not necessary to use this "
25365 "normally, because the handle is closed properly when guestfish exits. "
25366 "However this is occasionally useful for testing."
25370 #: ../fish/guestfish-commands.pod:155
25375 #: ../fish/guestfish-commands.pod:157
25378 " sparse filename size\n"
25383 #: ../fish/guestfish-commands.pod:159
25385 "This creates an empty sparse file of the given size, and then adds so it can "
25386 "be further examined."
25390 #: ../fish/guestfish-commands.pod:162
25392 "In all respects it works the same as the L</alloc> command, except that the "
25393 "image file is allocated sparsely, which means that disk blocks are not "
25394 "assigned to the file until they are needed. Sparse disk files only use "
25395 "space when written to, but they are slower and there is a danger you could "
25396 "run out of real disk space during a write operation."
25400 #: ../fish/guestfish-commands.pod:172
25405 #: ../fish/guestfish-commands.pod:174
25413 #: ../fish/guestfish-commands.pod:176
25415 "This command returns a list of the optional groups known to the daemon, and "
25416 "indicates which ones are supported by this build of the libguestfs appliance."
25420 #: ../fish/guestfish-commands.pod:180
25421 msgid "See also L<guestfs(3)/AVAILABILITY>."
25425 #: ../fish/guestfish-commands.pod:182
25430 #: ../fish/guestfish-commands.pod:184
25433 " time command args...\n"
25438 #: ../fish/guestfish-commands.pod:186
25440 "Run the command as usual, but print the elapsed time afterwards. This can "
25441 "be useful for benchmarking operations."
25445 #: ../test-tool/libguestfs-test-tool.pod:5
25446 msgid "libguestfs-test-tool - End user tests for libguestfs"
25450 #: ../test-tool/libguestfs-test-tool.pod:9
25453 " libguestfs-test-tool [--options]\n"
25458 #: ../test-tool/libguestfs-test-tool.pod:13
25460 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25461 "and developers, to allow them to check basic libguestfs functionality is "
25462 "working. This is needed because libguestfs occasionally breaks for reasons "
25463 "beyond our control: usually because of changes in the underlying qemu or "
25464 "kernel packages, or the host environment."
25468 #: ../test-tool/libguestfs-test-tool.pod:20
25469 msgid "If you suspect a problem in libguestfs, then just run:"
25473 #: ../test-tool/libguestfs-test-tool.pod:22
25476 " libguestfs-test-tool\n"
25481 #: ../test-tool/libguestfs-test-tool.pod:24
25482 msgid "It will print lots of diagnostic messages."
25486 #: ../test-tool/libguestfs-test-tool.pod:26
25487 msgid "If it runs to completion successfully, you will see this near the end:"
25491 #: ../test-tool/libguestfs-test-tool.pod:28
25494 " ===== TEST FINISHED OK =====\n"
25499 #: ../test-tool/libguestfs-test-tool.pod:30
25500 msgid "and the test tool will exit with code 0."
25504 #: ../test-tool/libguestfs-test-tool.pod:32
25506 "If it fails (and/or exits with non-zero error code), please paste the "
25507 "B<complete, unedited> output of the test tool into a bug report. More "
25508 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25513 #: ../test-tool/libguestfs-test-tool.pod:41
25518 #: ../test-tool/libguestfs-test-tool.pod:43
25519 msgid "Display short usage information and exit."
25523 #: ../test-tool/libguestfs-test-tool.pod:45
25524 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25528 #: ../test-tool/libguestfs-test-tool.pod:47
25530 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25531 "normally look in the C<$libexec> directory that was configured when the tool "
25536 #: ../test-tool/libguestfs-test-tool.pod:51
25537 msgid "I<--qemu qemu_binary>"
25541 #: ../test-tool/libguestfs-test-tool.pod:53
25543 "If you have downloaded another qemu binary, point this option at the full "
25544 "path of the binary to try it."
25548 #: ../test-tool/libguestfs-test-tool.pod:56
25549 msgid "I<--qemudir qemu_source_dir>"
25553 #: ../test-tool/libguestfs-test-tool.pod:58
25555 "If you have compiled qemu from source, point this option at the source "
25556 "directory to try it."
25560 #: ../test-tool/libguestfs-test-tool.pod:61
25561 msgid "I<--timeout N>"
25565 #: ../test-tool/libguestfs-test-tool.pod:63
25567 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25568 "does not usually need to be adjusted unless your machine is very slow."
25572 #: ../test-tool/libguestfs-test-tool.pod:69
25573 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25577 #: ../test-tool/libguestfs-test-tool.pod:71
25579 "If you have compiled another version of qemu from source and would like to "
25580 "try that, then you can use the I<--qemudir> option to point to the qemu "
25581 "source directory."
25585 #: ../test-tool/libguestfs-test-tool.pod:75
25587 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25588 "option to point to the binary."
25592 #: ../test-tool/libguestfs-test-tool.pod:78
25594 "When using an alternate qemu with libguestfs, usually you would need to "
25595 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25596 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25597 "use either of the I<--qemudir> or I<--qemu> options."
25601 #: ../test-tool/libguestfs-test-tool.pod:85
25603 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25604 "I<1> if there was an error."
25608 #: ../test-tool/libguestfs-test-tool.pod:92
25609 msgid "/usr/libexec/libguestfs-test-tool-helper"
25613 #: ../test-tool/libguestfs-test-tool.pod:94
25615 "This helper program is run inside the appliance and provides additional "
25620 #: ../test-tool/libguestfs-test-tool.pod:97
25621 msgid "/usr/bin/mkisofs"
25625 #: ../test-tool/libguestfs-test-tool.pod:99
25627 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25628 "which is used as part of the tests."
25632 #: ../test-tool/libguestfs-test-tool.pod:106
25634 "For the full list of environment variables which may affect libguestfs, "
25635 "please see the L<guestfs(3)> manual page."
25639 #: ../test-tool/libguestfs-test-tool.pod:111
25640 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25644 #: ../test-tool/libguestfs-test-tool.pod:121
25645 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25649 #: ../fuse/guestmount.pod:5
25651 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25655 #: ../fuse/guestmount.pod:9
25658 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25663 #: ../fuse/guestmount.pod:11
25666 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25671 #: ../fuse/guestmount.pod:13
25674 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25679 #: ../fuse/guestmount.pod:17
25681 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25682 "machines. If you do this, you risk disk corruption in the VM."
25686 #: ../fuse/guestmount.pod:22
25688 "The guestmount program can be used to mount virtual machine filesystems and "
25689 "other disk images on the host. It uses libguestfs for access to the guest "
25690 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25691 "a mountable device."
25695 #: ../fuse/guestmount.pod:27
25697 "Along with other options, you have to give at least one device (I<-a> "
25698 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25699 "option) or use the I<-i> inspection option. How this works is better "
25700 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25705 #: ../fuse/guestmount.pod:33
25707 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25708 "by you, and the filesystem will not be visible to any other users unless you "
25709 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25710 "the filesystem, use the C<fusermount -u> command."
25714 #: ../fuse/guestmount.pod:41
25716 "For a typical Windows guest which has its main filesystem on the first "
25721 #: ../fuse/guestmount.pod:44
25724 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25729 #: ../fuse/guestmount.pod:46
25731 "For a typical Linux guest which has a /boot filesystem on the first "
25732 "partition, and the root filesystem on a logical volume:"
25736 #: ../fuse/guestmount.pod:49
25739 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25744 #: ../fuse/guestmount.pod:51
25745 msgid "To get libguestfs to detect guest mountpoints for you:"
25749 #: ../fuse/guestmount.pod:53
25752 " guestmount -a guest.img -i --ro /mnt\n"
25757 #: ../fuse/guestmount.pod:55
25758 msgid "For a libvirt guest called \"Guest\" you could do:"
25762 #: ../fuse/guestmount.pod:57
25765 " guestmount -d Guest -i --ro /mnt\n"
25770 #: ../fuse/guestmount.pod:59
25772 "If you don't know what filesystems are contained in a guest or disk image, "
25773 "use L<virt-filesystems(1)> first:"
25777 #: ../fuse/guestmount.pod:62
25780 " virt-filesystems MyGuest\n"
25785 #: ../fuse/guestmount.pod:64
25787 "If you want to trace the libguestfs calls but without excessive debugging "
25788 "information, we recommend:"
25792 #: ../fuse/guestmount.pod:67
25795 " guestmount [...] --trace /mnt\n"
25800 #: ../fuse/guestmount.pod:69
25801 msgid "If you want to debug the program, we recommend:"
25805 #: ../fuse/guestmount.pod:71
25808 " guestmount [...] --trace --verbose /mnt\n"
25813 #: ../fuse/guestmount.pod:79
25814 msgid "Add a block device or virtual machine image."
25818 #: ../fuse/guestmount.pod:96
25819 msgid "B<--dir-cache-timeout N>"
25823 #: ../fuse/guestmount.pod:98
25825 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25826 "seconds. The readdir cache [actually, there are several semi-independent "
25827 "caches] is populated after a readdir(2) call with the stat and extended "
25828 "attributes of the files in the directory, in anticipation that they will be "
25829 "requested soon after."
25833 #: ../fuse/guestmount.pod:104
25835 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25836 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25837 "requests, only cache existing ones."
25841 #: ../fuse/guestmount.pod:122
25843 "If you have untrusted raw-format guest disk images, you should use this "
25844 "option to specify the disk format. This avoids a possible security problem "
25845 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25846 "guestfs_add_drive_opts>."
25850 #: ../fuse/guestmount.pod:127
25851 msgid "B<--fuse-help>"
25855 #: ../fuse/guestmount.pod:129
25856 msgid "Display help on special FUSE options (see I<-o> below)."
25860 #: ../fuse/guestmount.pod:133
25861 msgid "Display brief help and exit."
25865 #: ../fuse/guestmount.pod:146
25866 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25870 #: ../fuse/guestmount.pod:148
25872 "Mount the named partition or logical volume on the given mountpoint B<in the "
25873 "guest> (this has nothing to do with mountpoints in the host)."
25877 #: ../fuse/guestmount.pod:151
25879 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25880 "something on C</>."
25884 #: ../fuse/guestmount.pod:156
25886 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25887 "unmounted. If you specify this option, then we don't attempt to sync the "
25888 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25892 #: ../fuse/guestmount.pod:161
25893 msgid "B<-o option> | B<--option option>"
25897 #: ../fuse/guestmount.pod:163
25898 msgid "Pass extra options to FUSE."
25902 #: ../fuse/guestmount.pod:165
25904 "To get a list of all the extra options supported by FUSE, use the command "
25905 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25906 "of them are a good idea."
25910 #: ../fuse/guestmount.pod:169
25913 " guestmount --fuse-help\n"
25918 #: ../fuse/guestmount.pod:171
25919 msgid "Some potentially useful FUSE options:"
25923 #: ../fuse/guestmount.pod:175
25924 msgid "B<-o allow_other>"
25928 #: ../fuse/guestmount.pod:177
25929 msgid "Allow other users to see the filesystem."
25933 #: ../fuse/guestmount.pod:179
25934 msgid "B<-o attr_timeout=N>"
25938 #: ../fuse/guestmount.pod:181
25939 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25943 #: ../fuse/guestmount.pod:183
25944 msgid "B<-o kernel_cache>"
25948 #: ../fuse/guestmount.pod:185
25950 "Allow the kernel to cache files (reduces the number of reads that have to go "
25951 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25952 "afford the extra memory usage."
25956 #: ../fuse/guestmount.pod:189
25957 msgid "B<-o uid=N> B<-o gid=N>"
25961 #: ../fuse/guestmount.pod:191
25963 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25964 "the chosen values."
25968 #: ../fuse/guestmount.pod:198
25970 "Add devices and mount everything read-only. Also disallow writes and make "
25971 "the disk appear read-only to FUSE."
25975 #: ../fuse/guestmount.pod:201
25977 "This is highly recommended if you are not going to edit the guest disk. If "
25978 "the guest is running and this option is I<not> supplied, then there is a "
25979 "strong risk of disk corruption in the guest. We try to prevent this from "
25980 "happening, but it is not always possible."
25984 #: ../fuse/guestmount.pod:206
25985 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25989 #: ../fuse/guestmount.pod:210
25990 msgid "Enable SELinux support for the guest."
25994 #: ../fuse/guestmount.pod:214
25995 msgid "Enable verbose messages from underlying libguestfs."
25999 #: ../fuse/guestmount.pod:218
26000 msgid "Display the program version and exit."
26004 #: ../fuse/guestmount.pod:222
26006 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26007 "FOR READ AND WRITE>."
26011 #: ../fuse/guestmount.pod:225
26012 msgid "B<-x> | B<--trace>"
26016 #: ../fuse/guestmount.pod:227
26017 msgid "Trace libguestfs calls."
26021 #: ../fuse/guestmount.pod:229
26022 msgid "This also stops the daemon from forking into the background."
26026 #: ../fuse/guestmount.pod:235
26028 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26029 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26034 #: ../tools/virt-edit.pl:34
26035 msgid "virt-edit - Edit a file in a virtual machine"
26039 #: ../tools/virt-edit.pl:38
26042 " virt-edit [--options] domname file\n"
26047 #: ../tools/virt-edit.pl:40
26050 " virt-edit [--options] disk.img [disk.img ...] file\n"
26055 #: ../tools/virt-edit.pl:42
26058 " virt-edit [domname|disk.img] file -e 'expr'\n"
26063 #: ../tools/virt-edit.pl:46
26065 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26066 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26067 "doing this, but doesn't catch all cases."
26071 #: ../tools/virt-edit.pl:52
26073 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26074 "the named virtual machine (or disk image)."
26078 #: ../tools/virt-edit.pl:55
26080 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26081 "you should look at the L<guestfish(1)> tool."
26085 #: ../tools/virt-edit.pl:60
26086 msgid "Edit the named files interactively:"
26090 #: ../tools/virt-edit.pl:62
26093 " virt-edit mydomain /boot/grub/grub.conf\n"
26098 #: ../tools/virt-edit.pl:64
26101 " virt-edit mydomain /etc/passwd\n"
26106 #: ../tools/virt-edit.pl:66
26108 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26109 "below). To change the init default level to 5:"
26113 #: ../tools/virt-edit.pl:70
26116 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26121 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181
26122 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
26123 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
26124 msgid "Display brief help."
26128 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187
26129 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:69
26130 #: ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169
26131 #: ../tools/virt-list-partitions.pl:70
26132 msgid "B<--version>"
26136 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189
26137 #: ../tools/virt-resize.pl:274 ../tools/virt-list-filesystems.pl:71
26138 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
26139 #: ../tools/virt-list-partitions.pl:72
26140 msgid "Display version number and exit."
26144 #: ../tools/virt-edit.pl:96
26145 msgid "B<--backup extension> | B<-b extension>"
26149 #: ../tools/virt-edit.pl:98
26151 "Create a backup of the original file I<in the guest disk image>. The backup "
26152 "has the original filename with C<extension> added."
26156 #: ../tools/virt-edit.pl:101
26158 "Usually the first character of C<extension> would be a dot C<.> so you would "
26163 #: ../tools/virt-edit.pl:104
26166 " virt-edit -b .orig [etc]\n"
26171 #: ../tools/virt-edit.pl:106
26172 msgid "By default, no backup file is made."
26176 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203
26177 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
26178 #: ../tools/virt-list-partitions.pl:78
26179 msgid "B<--connect URI> | B<-c URI>"
26183 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205
26184 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
26185 #: ../tools/virt-list-partitions.pl:80
26187 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26188 "to the default libvirt hypervisor."
26192 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26193 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
26194 #: ../tools/virt-list-partitions.pl:83
26196 "If you specify guest block devices directly, then libvirt is not used at all."
26200 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215
26201 #: ../tools/virt-resize.pl:522 ../tools/virt-list-filesystems.pl:89
26202 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
26203 msgid "B<--format> raw"
26207 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217
26208 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
26209 #: ../tools/virt-list-partitions.pl:92
26211 "Specify the format of disk images given on the command line. If this is "
26212 "omitted then the format is autodetected from the content of the disk image."
26216 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221
26217 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
26218 #: ../tools/virt-list-partitions.pl:96
26220 "If disk images are requested from libvirt, then this program asks libvirt "
26221 "for this information. In this case, the value of the format parameter is "
26226 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225
26227 #: ../tools/virt-resize.pl:527 ../tools/virt-resize.pl:542
26228 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
26229 #: ../tools/virt-list-partitions.pl:100
26231 "If working with untrusted raw-format guest disk images, you should ensure "
26232 "the format is always specified."
26236 #: ../tools/virt-edit.pl:141
26237 msgid "B<--expr EXPR> | B<-e EXPR>"
26241 #: ../tools/virt-edit.pl:143
26243 "Instead of launching the external editor, non-interactively apply the Perl "
26244 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26249 #: ../tools/virt-edit.pl:147
26251 "Be careful to properly quote the expression to prevent it from being altered "
26256 #: ../tools/virt-edit.pl:268
26257 msgid "NON-INTERACTIVE EDITING"
26261 #: ../tools/virt-edit.pl:270
26263 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26264 "administrator can interactively edit the file."
26268 #: ../tools/virt-edit.pl:273
26270 "There are two ways also to use C<virt-edit> from scripts in order to make "
26271 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26272 "like this, it's less error-prone to write scripts directly using the "
26273 "libguestfs API and Augeas for configuration file editing.)"
26277 #: ../tools/virt-edit.pl:279
26279 "The first method is to temporarily set C<$EDITOR> to any script or program "
26280 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26281 "update C<tmpfile> in place however it likes."
26285 #: ../tools/virt-edit.pl:283
26287 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26288 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26289 "instances of C<foo> with C<bar> in a file:"
26293 #: ../tools/virt-edit.pl:287
26296 " virt-edit domname filename -e 's/foo/bar/'\n"
26301 #: ../tools/virt-edit.pl:289
26303 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26304 "For example to delete root's password you could do:"
26308 #: ../tools/virt-edit.pl:292
26311 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26316 #: ../tools/virt-edit.pl:294
26318 "What really happens is that the snippet is evaluated as a Perl expression "
26319 "for each line of the file. The line, including the final C<\\n>, is passed "
26320 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26324 #: ../tools/virt-edit.pl:299
26326 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26327 "C<apache> user account from the password file you can do:"
26331 #: ../tools/virt-edit.pl:302
26334 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26339 #: ../tools/virt-edit.pl:304
26341 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26342 "the end of the file is rather difficult this way since there is no concept "
26343 "of \"last line of the file\" - your expression just doesn't get called "
26344 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26349 #: ../tools/virt-edit.pl:310
26351 "The variable C<$lineno> contains the current line number. As is "
26352 "traditional, the first line in the file is number C<1>."
26356 #: ../tools/virt-edit.pl:313
26358 "The return value from the expression is ignored, but the expression may call "
26359 "C<die> in order to abort the whole program, leaving the original file "
26364 #: ../tools/virt-edit.pl:317
26366 "Remember when matching the end of a line that C<$_> may contain the final C<"
26367 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26368 "newline then neither of these. Thus to match or substitute some text at the "
26369 "end of a line, use this regular expression:"
26373 #: ../tools/virt-edit.pl:322
26376 " /some text(\\r?\\n)?$/\n"
26381 #: ../tools/virt-edit.pl:324
26383 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26384 "$_> itself (since that would remove all newlines from the file):"
26388 #: ../tools/virt-edit.pl:328
26391 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26396 #: ../tools/virt-edit.pl:334
26401 #: ../tools/virt-edit.pl:336
26403 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26408 #: ../tools/virt-edit.pl:339
26409 msgid "If not set, C<vi> is used."
26413 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141
26414 #: ../tools/virt-win-reg.pl:477 ../tools/virt-resize.pl:1478
26415 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274
26416 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26417 msgid "SHELL QUOTING"
26421 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479
26422 #: ../tools/virt-resize.pl:1480 ../tools/virt-list-filesystems.pl:184
26423 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:529
26424 #: ../tools/virt-list-partitions.pl:252
26426 "Libvirt guest names can contain arbitrary characters, some of which have "
26427 "meaning to the shell such as C<#> and space. You may need to quote or "
26428 "escape these characters on the command line. See the shell manual page L<sh"
26429 "(1)> for details."
26433 #: ../tools/virt-edit.pl:352
26435 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26436 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26441 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26442 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:202
26443 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:559
26444 #: ../tools/virt-list-partitions.pl:269
26449 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512
26450 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:204
26451 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:561
26452 #: ../tools/virt-list-partitions.pl:271
26453 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26457 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
26458 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26462 #: ../tools/virt-win-reg.pl:37
26464 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26468 #: ../tools/virt-win-reg.pl:41
26471 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26476 #: ../tools/virt-win-reg.pl:43
26479 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26484 #: ../tools/virt-win-reg.pl:45
26487 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26492 #: ../tools/virt-win-reg.pl:47
26495 " virt-win-reg --merge domname [input.reg ...]\n"
26500 #: ../tools/virt-win-reg.pl:49
26503 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26508 #: ../tools/virt-win-reg.pl:53
26510 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26511 "virtual machines. If you do this, you I<will> get irreversible disk "
26512 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26513 "but doesn't catch all cases."
26517 #: ../tools/virt-win-reg.pl:58
26519 "Modifying the Windows Registry is an inherently risky operation. The format "
26520 "is deliberately obscure and undocumented, and Registry changes can leave the "
26521 "system unbootable. Therefore when using the C<--merge> option, make sure "
26522 "you have a reliable backup first."
26526 #: ../tools/virt-win-reg.pl:65
26528 "This program can export and merge Windows Registry entries from a Windows "
26533 #: ../tools/virt-win-reg.pl:68
26535 "The first parameter is the libvirt guest name or the raw disk image of a "
26540 #: ../tools/virt-win-reg.pl:71
26542 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26543 "exported (recursively). For example:"
26547 #: ../tools/virt-win-reg.pl:74
26550 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26555 #: ../tools/virt-win-reg.pl:76
26557 "You can also display single values from within registry keys, for example:"
26561 #: ../tools/virt-win-reg.pl:79
26564 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26565 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26566 " Windows 7 Enterprise\n"
26571 #: ../tools/virt-win-reg.pl:83
26573 "With C<--merge>, you can merge a textual regedit file into the Windows "
26578 #: ../tools/virt-win-reg.pl:86
26581 " $ virt-win-reg --merge Windows7 changes.reg\n"
26586 #: ../tools/virt-win-reg.pl:88
26587 msgid "SUPPORTED SYSTEMS"
26591 #: ../tools/virt-win-reg.pl:90
26593 "The program currently supports Windows NT-derived guests starting with "
26594 "Windows XP through to at least Windows 7."
26598 #: ../tools/virt-win-reg.pl:93
26600 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26601 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26602 "and C<HKEY_USERS\\.DEFAULT>."
26606 #: ../tools/virt-win-reg.pl:97
26608 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26613 #: ../tools/virt-win-reg.pl:100
26615 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26620 #: ../tools/virt-win-reg.pl:103
26625 #: ../tools/virt-win-reg.pl:105
26627 "This program is only meant for simple access to the registry. If you want "
26628 "to do complicated things with the registry, we suggest you download the "
26629 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26630 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26631 "L<hivexregedit(1)>."
26635 #: ../tools/virt-win-reg.pl:111
26640 #: ../tools/virt-win-reg.pl:113
26642 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26643 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26644 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26645 "Windows-style line endings, you may need to reencode the whole file before "
26646 "or after processing."
26650 #: ../tools/virt-win-reg.pl:119
26652 "To reencode a file from Windows format to Linux (before processing it with "
26653 "the C<--merge> option), you would do something like this:"
26657 #: ../tools/virt-win-reg.pl:122
26660 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26665 #: ../tools/virt-win-reg.pl:124
26667 "To go in the opposite direction, after exporting and before sending the file "
26668 "to a Windows user, do something like this:"
26672 #: ../tools/virt-win-reg.pl:127
26675 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26680 #: ../tools/virt-win-reg.pl:129
26681 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26685 #: ../tools/virt-win-reg.pl:131
26687 "If you are unsure about the current encoding, use the L<file(1)> command. "
26688 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26689 "style (CRLF) line endings, like this:"
26693 #: ../tools/virt-win-reg.pl:135
26696 " $ file software.reg\n"
26697 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26698 " with CRLF line terminators\n"
26703 #: ../tools/virt-win-reg.pl:139
26704 msgid "This file would need conversion before you could C<--merge> it."
26708 #: ../tools/virt-win-reg.pl:143
26710 "Be careful when passing parameters containing C<\\> (backslash) in the "
26711 "shell. Usually you will have to use 'single quotes' or double backslashes "
26712 "(but not both) to protect them from the shell."
26716 #: ../tools/virt-win-reg.pl:147
26717 msgid "Paths and value names are case-insensitive."
26721 #: ../tools/virt-win-reg.pl:149
26722 msgid "CurrentControlSet etc."
26726 #: ../tools/virt-win-reg.pl:151
26728 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26729 "Registry at the level of the hive file, and therefore you cannot modify "
26734 #: ../tools/virt-win-reg.pl:155
26736 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26737 "circumstances it might refer to another control set. The way to find out is "
26738 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26742 #: ../tools/virt-win-reg.pl:159
26745 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26746 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26747 " \"Current\"=dword:00000001\n"
26748 " \"Default\"=dword:00000001\n"
26749 " \"Failed\"=dword:00000000\n"
26750 " \"LastKnownGood\"=dword:00000002\n"
26755 #: ../tools/virt-win-reg.pl:166
26756 msgid "\"Current\" is the one which Windows will choose when it boots."
26760 #: ../tools/virt-win-reg.pl:168
26762 "Similarly, other C<Current...> keys in the path may need to be replaced."
26766 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26771 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:500
26772 msgid "Enable debugging messages."
26776 #: ../tools/virt-win-reg.pl:232
26781 #: ../tools/virt-win-reg.pl:234
26783 "In merge mode, this merges a textual regedit file into the Windows Registry "
26784 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26785 "displays or exports Registry entries instead."
26789 #: ../tools/virt-win-reg.pl:238
26791 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26792 "result in disk corruption. However exporting (without this flag) is always "
26797 #: ../tools/virt-win-reg.pl:246
26798 msgid "B<--encoding> UTF-16LE|ASCII"
26802 #: ../tools/virt-win-reg.pl:248
26804 "When merging (only), you may need to specify the encoding for strings to be "
26805 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26806 "(3)/ENCODING STRINGS>."
26810 #: ../tools/virt-win-reg.pl:252
26812 "The default is to use UTF-16LE, which should work with recent versions of "
26817 #: ../tools/virt-win-reg.pl:486
26819 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26820 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26821 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26825 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26827 "When reporting bugs, please enable debugging and capture the I<complete> "
26832 #: ../tools/virt-win-reg.pl:504
26835 " export LIBGUESTFS_DEBUG=1\n"
26836 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26841 #: ../tools/virt-win-reg.pl:507
26843 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26848 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1512
26849 #: ../tools/virt-make-fs.pl:565
26850 msgid "Copyright (C) 2010 Red Hat Inc."
26854 #: ../tools/virt-resize.pl:42
26855 msgid "virt-resize - Resize a virtual machine disk"
26859 #: ../tools/virt-resize.pl:46
26862 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26863 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26864 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26869 #: ../tools/virt-resize.pl:52
26871 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26872 "larger or smaller overall, and resizing or deleting any partitions contained "
26877 #: ../tools/virt-resize.pl:56
26879 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26880 "not> be used on live virtual machines - for consistent results, shut the "
26881 "virtual machine down before resizing it."
26885 #: ../tools/virt-resize.pl:60
26887 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26888 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26892 #: ../tools/virt-resize.pl:66
26894 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26895 "fill the extra 5GB of space."
26899 #: ../tools/virt-resize.pl:69
26902 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26903 " virt-filesystems --long --h --all -a olddisk\n"
26904 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26905 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26910 #: ../tools/virt-resize.pl:74
26912 "As above, but make the /boot partition 200MB bigger, while giving the "
26913 "remaining space to /dev/sda2:"
26917 #: ../tools/virt-resize.pl:77
26920 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26925 #: ../tools/virt-resize.pl:79
26926 msgid "As above, but the output format will be uncompressed qcow2:"
26930 #: ../tools/virt-resize.pl:81
26933 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26934 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26939 #: ../tools/virt-resize.pl:84
26940 msgid "DETAILED USAGE"
26944 #: ../tools/virt-resize.pl:86
26945 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26949 #: ../tools/virt-resize.pl:90
26950 msgid "1. Shut down the virtual machine"
26954 #: ../tools/virt-resize.pl:92
26955 msgid "2. Locate input disk image"
26959 #: ../tools/virt-resize.pl:94
26961 "Locate the input disk image (ie. the file or device on the host containing "
26962 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26963 "dumpxml> like this to find the disk image name:"
26967 #: ../tools/virt-resize.pl:98
26970 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26971 " Found 1 nodes:\n"
26973 " <source dev=\"/dev/vg/lv_guest\" />\n"
26978 #: ../tools/virt-resize.pl:103
26979 msgid "3. Look at current sizing"
26983 #: ../tools/virt-resize.pl:105
26984 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
26988 #: ../tools/virt-resize.pl:108
26991 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
26992 " Name Type Size Parent\n"
26993 " /dev/sda1 partition 101M /dev/sda\n"
26994 " /dev/sda2 partition 7.9G /dev/sda\n"
26995 " /dev/sda device 8.0G -\n"
27000 #: ../tools/virt-resize.pl:114
27002 "(This example is a virtual machine with an 8 GB disk which we would like to "
27003 "expand up to 10 GB)."
27007 #: ../tools/virt-resize.pl:117
27008 msgid "4. Create output disk"
27012 #: ../tools/virt-resize.pl:119
27014 "Virt-resize cannot do in-place disk modifications. You have to have space "
27015 "to store the resized output disk."
27019 #: ../tools/virt-resize.pl:122
27021 "To store the resized disk image in a file, create a file of a suitable size:"
27025 #: ../tools/virt-resize.pl:125
27028 " # rm -f outdisk\n"
27029 " # truncate -s 10G outdisk\n"
27034 #: ../tools/virt-resize.pl:128
27035 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27039 #: ../tools/virt-resize.pl:130
27042 " # lvcreate -L 10G -n lv_name vg_name\n"
27047 #: ../tools/virt-resize.pl:132
27048 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27052 #: ../tools/virt-resize.pl:134
27055 " # virsh pool-list\n"
27056 " # virsh vol-create-as poolname newvol 10G\n"
27061 #: ../tools/virt-resize.pl:137
27066 #: ../tools/virt-resize.pl:139
27068 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27069 "file) and the output disk. The output disk is the one created in the "
27074 #: ../tools/virt-resize.pl:143
27077 " # virt-resize indisk outdisk\n"
27082 #: ../tools/virt-resize.pl:145
27084 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27085 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27086 "larger, then an extra, empty partition is created at the end of the disk "
27087 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27092 #: ../tools/virt-resize.pl:151
27094 "More realistically you'd want to expand existing partitions in the disk "
27095 "image by passing extra options (for the full list see the L</OPTIONS> "
27100 #: ../tools/virt-resize.pl:155
27102 "L</--expand> is the most useful option. It expands the named partition "
27103 "within the disk to fill any extra space:"
27107 #: ../tools/virt-resize.pl:158
27110 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27115 #: ../tools/virt-resize.pl:160
27117 "(In this case, an extra partition is I<not> created at the end of the disk, "
27118 "because there will be no unused space)."
27122 #: ../tools/virt-resize.pl:163
27124 "L</--resize> is the other commonly used option. The following would "
27125 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27126 "rest of the available space:"
27130 #: ../tools/virt-resize.pl:167
27133 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27134 " indisk outdisk\n"
27139 #: ../tools/virt-resize.pl:170
27141 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27142 "if virt-resize knows how, it will resize the contents, the equivalent of "
27143 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27144 ">. However virt-resize does not know how to resize some filesystems, so you "
27145 "would have to online resize them after booting the guest. And virt-resize "
27146 "also does not resize anything inside an LVM PV, it just resizes the PV "
27147 "itself and leaves the user to resize any LVs inside that PV as desired."
27151 #: ../tools/virt-resize.pl:179
27152 msgid "Other options are covered below."
27156 #: ../tools/virt-resize.pl:181
27161 #: ../tools/virt-resize.pl:183
27162 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27166 #: ../tools/virt-resize.pl:185
27167 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27171 #: ../tools/virt-resize.pl:187
27174 " # virsh edit guestname\n"
27179 #: ../tools/virt-resize.pl:189
27181 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27182 "html#elementsDisks>"
27186 #: ../tools/virt-resize.pl:192
27187 msgid "Then start up the domain with the new, resized disk:"
27191 #: ../tools/virt-resize.pl:194
27194 " # virsh start guestname\n"
27199 #: ../tools/virt-resize.pl:196
27201 "and check that it still works. See also the L</NOTES> section below for "
27202 "additional information."
27206 #: ../tools/virt-resize.pl:199
27207 msgid "7. Resize LVs etc inside the guest"
27211 #: ../tools/virt-resize.pl:201
27212 msgid "(This can also be done offline using L<guestfish(1)>)"
27216 #: ../tools/virt-resize.pl:203
27218 "Once the guest has booted you should see the new space available, at least "
27219 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27220 "may need to resize LVs inside PVs, and also resize filesystem types that "
27221 "virt-resize does not know how to expand."
27225 #: ../tools/virt-resize.pl:210
27226 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27230 #: ../tools/virt-resize.pl:212
27232 "Shrinking is somewhat more complex than expanding, and only an overview is "
27237 #: ../tools/virt-resize.pl:215
27239 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27240 "filesystems). The user has to shrink content before passing the disk image "
27241 "to virt-resize, and virt-resize will check that the content has been shrunk "
27246 #: ../tools/virt-resize.pl:220
27247 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27251 #: ../tools/virt-resize.pl:222
27253 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27254 "steps 3 and 4 above to allocate a new disk image."
27258 #: ../tools/virt-resize.pl:225
27260 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27264 #: ../tools/virt-resize.pl:228
27265 msgid "IGNORING OR DELETING PARTITIONS"
27269 #: ../tools/virt-resize.pl:230
27271 "virt-resize also gives a convenient way to ignore or delete partitions when "
27272 "copying from the input disk to the output disk. Ignoring a partition speeds "
27273 "up the copy where you don't care about the existing contents of a "
27274 "partition. Deleting a partition removes it completely, but note that it "
27275 "also renumbers any partitions after the one which is deleted, which can "
27276 "leave some guests unbootable."
27280 #: ../tools/virt-resize.pl:237
27281 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27285 #: ../tools/virt-resize.pl:239
27287 "If the input disk is in qcow2 format, then you may prefer that the output is "
27288 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27289 "the fly. The output format is simply determined by the format of the empty "
27290 "output container that you provide. Thus to create qcow2 output, use:"
27294 #: ../tools/virt-resize.pl:245
27297 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27302 #: ../tools/virt-resize.pl:247
27303 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27307 #: ../tools/virt-resize.pl:249
27308 msgid "Similarly, to get non-sparse raw output use:"
27312 #: ../tools/virt-resize.pl:251
27315 " fallocate -l size outdisk\n"
27320 #: ../tools/virt-resize.pl:253
27322 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27323 "dev/zero of=outdisk bs=1M count=..>)"
27327 #: ../tools/virt-resize.pl:266
27328 msgid "Display help."
27332 #: ../tools/virt-resize.pl:280
27333 msgid "B<--resize part=size>"
27337 #: ../tools/virt-resize.pl:282
27339 "Resize the named partition (expanding or shrinking it) so that it has the "
27344 #: ../tools/virt-resize.pl:285
27346 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27347 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27348 "Exabytes; or as a percentage of the current size; or as a relative number or "
27349 "percentage. For example:"
27353 #: ../tools/virt-resize.pl:290
27356 " --resize /dev/sda2=10G\n"
27361 #: ../tools/virt-resize.pl:292
27364 " --resize /dev/sda4=90%\n"
27369 #: ../tools/virt-resize.pl:294
27372 " --resize /dev/sda2=+1G\n"
27377 #: ../tools/virt-resize.pl:296
27380 " --resize /dev/sda2=-200M\n"
27385 #: ../tools/virt-resize.pl:298
27388 " --resize /dev/sda1=+128K\n"
27393 #: ../tools/virt-resize.pl:300
27396 " --resize /dev/sda1=+10%\n"
27401 #: ../tools/virt-resize.pl:302
27404 " --resize /dev/sda1=-10%\n"
27409 #: ../tools/virt-resize.pl:304
27411 "You can increase the size of any partition. Virt-resize will expand the "
27412 "direct content of the partition if it knows how (see C<--expand> below)."
27416 #: ../tools/virt-resize.pl:308
27418 "You can only I<decrease> the size of partitions that contain filesystems or "
27419 "PVs which have already been shrunk. Virt-resize will check this has been "
27420 "done before proceeding, or else will print an error (see also C<--resize-"
27425 #: ../tools/virt-resize.pl:313 ../tools/virt-resize.pl:405
27426 #: ../tools/virt-resize.pl:422
27427 msgid "You can give this option multiple times."
27431 #: ../tools/virt-resize.pl:319
27432 msgid "B<--resize-force part=size>"
27436 #: ../tools/virt-resize.pl:321
27438 "This is the same as C<--resize> except that it will let you decrease the "
27439 "size of any partition. Generally this means you will lose any data which "
27440 "was at the end of the partition you shrink, but you may not care about that "
27441 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27442 "as a swap partition)."
27446 #: ../tools/virt-resize.pl:327
27447 msgid "See also the C<--ignore> option."
27451 #: ../tools/virt-resize.pl:333
27452 msgid "B<--expand part>"
27456 #: ../tools/virt-resize.pl:335
27458 "Expand the named partition so it uses up all extra space (space left over "
27459 "after any other resize changes that you request have been done)."
27463 #: ../tools/virt-resize.pl:338
27465 "If virt-resize knows how, it will expand the direct content of the "
27466 "partition. For example, if the partition is an LVM PV, it will expand the "
27467 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27468 "content it doesn't know about alone."
27472 #: ../tools/virt-resize.pl:343
27473 msgid "Currently virt-resize can resize:"
27477 #: ../tools/virt-resize.pl:349
27479 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27484 #: ../tools/virt-resize.pl:354
27486 "NTFS filesystems contained directly in a partition, if libguestfs was "
27487 "compiled with support for NTFS."
27491 #: ../tools/virt-resize.pl:357
27493 "The filesystem must have been shut down consistently last time it was used. "
27494 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27495 "consistency check, so at the first boot after resizing Windows will check "
27500 #: ../tools/virt-resize.pl:364
27502 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27503 "inside the PV. The user will have to resize LVs as desired."
27507 #: ../tools/virt-resize.pl:370 ../tools/virt-resize.pl:392
27508 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27512 #: ../tools/virt-resize.pl:376
27513 msgid "B<--shrink part>"
27517 #: ../tools/virt-resize.pl:378
27519 "Shrink the named partition until the overall disk image fits in the "
27520 "destination. The named partition B<must> contain a filesystem or PV which "
27521 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27522 "online tools). Virt-resize will check this and give an error if it has not "
27527 #: ../tools/virt-resize.pl:384
27529 "The amount by which the overall disk must be shrunk (after carrying out all "
27530 "other operations requested by the user) is called the \"deficit\". For "
27531 "example, a straight copy (assume no other operations) from a 5GB disk image "
27532 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27533 "would give an error unless the user specified a partition to shrink and that "
27534 "partition had more than a gigabyte of free space."
27538 #: ../tools/virt-resize.pl:398
27539 msgid "B<--ignore part>"
27543 #: ../tools/virt-resize.pl:400
27545 "Ignore the named partition. Effectively this means the partition is "
27546 "allocated on the destination disk, but the content is not copied across from "
27547 "the source disk. The content of the partition will be blank (all zero "
27552 #: ../tools/virt-resize.pl:411
27553 msgid "B<--delete part>"
27557 #: ../tools/virt-resize.pl:413
27559 "Delete the named partition. It would be more accurate to describe this as "
27560 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27561 "the original disk image is left intact."
27565 #: ../tools/virt-resize.pl:417
27567 "Note that when you delete a partition, then anything contained in the "
27568 "partition is also deleted. Furthermore, this causes any partitions that "
27569 "come after to be I<renumbered>, which can easily make your guest unbootable."
27573 #: ../tools/virt-resize.pl:428
27574 msgid "B<--LV-expand logvol>"
27578 #: ../tools/virt-resize.pl:430
27580 "This takes the logical volume and, as a final step, expands it to fill all "
27581 "the space available in its volume group. A typical usage, assuming a Linux "
27582 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27583 "lv_root> would be:"
27587 #: ../tools/virt-resize.pl:435
27590 " virt-resize indisk outdisk \\\n"
27591 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27596 #: ../tools/virt-resize.pl:438
27598 "This would first expand the partition (and PV), and then expand the root "
27599 "device to fill the extra space in the PV."
27603 #: ../tools/virt-resize.pl:441
27605 "The contents of the LV are also resized if virt-resize knows how to do "
27606 "that. You can stop virt-resize from trying to expand the content by using "
27607 "the option C<--no-expand-content>."
27611 #: ../tools/virt-resize.pl:445
27612 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27616 #: ../tools/virt-resize.pl:448
27618 "You can give this option multiple times, I<but> it doesn't make sense to do "
27619 "this unless the logical volumes you specify are all in different volume "
27624 #: ../tools/virt-resize.pl:456
27625 msgid "B<--no-copy-boot-loader>"
27629 #: ../tools/virt-resize.pl:458
27631 "By default, virt-resize copies over some sectors at the start of the disk "
27632 "(up to the beginning of the first partition). Commonly these sectors "
27633 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27634 "in order for the guest to boot correctly."
27638 #: ../tools/virt-resize.pl:463
27640 "If you specify this flag, then this initial copy is not done. You may need "
27641 "to reinstall the boot loader in this case."
27645 #: ../tools/virt-resize.pl:471
27646 msgid "B<--no-extra-partition>"
27650 #: ../tools/virt-resize.pl:473
27652 "By default, virt-resize creates an extra partition if there is any extra, "
27653 "unused space after all resizing has happened. Use this option to prevent "
27654 "the extra partition from being created. If you do this then the extra space "
27655 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27656 "tool in the guest."
27660 #: ../tools/virt-resize.pl:479
27662 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27667 #: ../tools/virt-resize.pl:486
27668 msgid "B<--no-expand-content>"
27672 #: ../tools/virt-resize.pl:488
27674 "By default, virt-resize will try to expand the direct contents of "
27675 "partitions, if it knows how (see C<--expand> option above)."
27679 #: ../tools/virt-resize.pl:491
27681 "If you give the C<--no-expand-content> option then virt-resize will not "
27686 #: ../tools/virt-resize.pl:498
27687 msgid "B<-d> | B<--debug>"
27691 #: ../tools/virt-resize.pl:506
27692 msgid "B<-n> | B<--dryrun>"
27696 #: ../tools/virt-resize.pl:508
27697 msgid "Print a summary of what would be done, but don't do anything."
27701 #: ../tools/virt-resize.pl:514
27702 msgid "B<-q> | B<--quiet>"
27706 #: ../tools/virt-resize.pl:516
27707 msgid "Don't print the summary."
27711 #: ../tools/virt-resize.pl:524
27713 "Specify the format of the input disk image. If this flag is not given then "
27714 "it is auto-detected from the image itself."
27718 #: ../tools/virt-resize.pl:530
27720 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27721 "AND NON-SPARSE RAW FORMATS>."
27725 #: ../tools/virt-resize.pl:537
27726 msgid "B<--output-format> raw"
27730 #: ../tools/virt-resize.pl:539
27732 "Specify the format of the output disk image. If this flag is not given then "
27733 "it is auto-detected from the image itself."
27737 #: ../tools/virt-resize.pl:545
27739 "Note that you still need to create the output disk with the right format. "
27740 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27744 #: ../tools/virt-resize.pl:1421
27749 #: ../tools/virt-resize.pl:1423
27750 msgid "\"Partition 1 does not end on cylinder boundary.\""
27754 #: ../tools/virt-resize.pl:1425
27756 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27757 "means the partitions will not be aligned to the ancient CHS geometry. "
27758 "However CHS geometry is meaningless for disks manufactured since the early "
27759 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27760 "cylinders is not required by any modern operating system."
27764 #: ../tools/virt-resize.pl:1432
27765 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27769 #: ../tools/virt-resize.pl:1434
27771 "In Windows Vista and later versions, Microsoft switched to using a separate "
27772 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27773 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27774 "the boot partition. Doing so seems to break the guest completely. However "
27775 "expanding the second partition (ie. C: drive) should work."
27779 #: ../tools/virt-resize.pl:1441
27781 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27782 "NTFS partitions have been expanded. This is just a safety check and (unless "
27783 "it find errors) is nothing to worry about."
27787 #: ../tools/virt-resize.pl:1445
27788 msgid "GUEST BOOT STUCK AT \"GRUB\""
27792 #: ../tools/virt-resize.pl:1447
27794 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27795 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27796 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27797 "although we think is to do with partition alignment."
27801 #: ../tools/virt-resize.pl:1452
27804 " guestfish -i -a newdisk\n"
27805 " ><fs> cat /boot/grub/device.map\n"
27806 " # check the contents of this file are sensible or\n"
27807 " # edit the file if necessary\n"
27808 " ><fs> grub-install / /dev/vda\n"
27814 #: ../tools/virt-resize.pl:1459
27816 "For more flexible guest reconfiguration, including if you need to specify "
27817 "other parameters to grub-install, use L<virt-rescue(1)>."
27821 #: ../tools/virt-resize.pl:1462
27822 msgid "ALTERNATIVE TOOLS"
27826 #: ../tools/virt-resize.pl:1464
27828 "There are several proprietary tools for resizing partitions. We won't "
27829 "mention any here."
27833 #: ../tools/virt-resize.pl:1467
27835 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27836 "operations on disk images. They can resize and move partitions, but I don't "
27837 "think they can do anything with the contents, and they certainly don't "
27842 #: ../tools/virt-resize.pl:1472
27844 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27845 "but at a much lower level. You will probably end up hand-calculating sector "
27846 "offsets, which is something that virt-resize was designed to avoid. If you "
27847 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27852 #: ../tools/virt-resize.pl:1487
27854 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
27855 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
27856 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
27857 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
27858 "libguestfs.org/>."
27862 #: ../tools/virt-list-filesystems.pl:32
27864 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27868 #: ../tools/virt-list-filesystems.pl:36
27871 " virt-list-filesystems [--options] domname\n"
27876 #: ../tools/virt-list-filesystems.pl:38
27879 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27884 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27886 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27891 #: ../tools/virt-list-filesystems.pl:45
27893 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27894 "are contained in a virtual machine or disk image."
27898 #: ../tools/virt-list-filesystems.pl:49
27900 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27901 "functionality. For more complex cases you should look at the L<guestfish(1)"
27906 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27907 msgid "B<-l> | B<--long>"
27911 #: ../tools/virt-list-filesystems.pl:108
27913 "With this option, C<virt-list-filesystems> displays the type of each "
27914 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27918 #: ../tools/virt-list-filesystems.pl:115
27919 msgid "B<-a> | B<--all>"
27923 #: ../tools/virt-list-filesystems.pl:117
27925 "Normally we only show mountable filesystems. If this option is given then "
27926 "swap devices are shown too."
27930 #: ../tools/virt-list-filesystems.pl:191
27932 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
27933 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27934 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27938 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27939 msgid "Copyright (C) 2009 Red Hat Inc."
27943 #: ../tools/virt-tar.pl:33
27944 msgid "virt-tar - Extract or upload files to a virtual machine"
27948 #: ../tools/virt-tar.pl:37
27951 " virt-tar [--options] -x domname directory tarball\n"
27956 #: ../tools/virt-tar.pl:39
27959 " virt-tar [--options] -u domname tarball directory\n"
27964 #: ../tools/virt-tar.pl:41
27967 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27972 #: ../tools/virt-tar.pl:43
27975 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27980 #: ../tools/virt-tar.pl:47
27981 msgid "Download C</home> from the VM into a local tarball:"
27985 #: ../tools/virt-tar.pl:49
27988 " virt-tar -x domname /home home.tar\n"
27993 #: ../tools/virt-tar.pl:51
27996 " virt-tar -zx domname /home home.tar.gz\n"
28001 #: ../tools/virt-tar.pl:53
28002 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28006 #: ../tools/virt-tar.pl:55
28009 " virt-tar -u domname uploadstuff.tar /tmp\n"
28014 #: ../tools/virt-tar.pl:57
28017 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28022 #: ../tools/virt-tar.pl:61
28024 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28025 "virtual machines. If you do this, you risk disk corruption in the VM. "
28026 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28030 #: ../tools/virt-tar.pl:66
28032 "You can use C<-x> (extract) on live virtual machines, but you might get "
28033 "inconsistent results or errors if there is filesystem activity inside the "
28034 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28035 "work, but the only way to guarantee consistent results is if the virtual "
28036 "machine is shut down."
28040 #: ../tools/virt-tar.pl:74
28042 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28043 "parts of a guest filesystem. There are many possibilities: making backups, "
28044 "uploading data files, snooping on guest activity, fixing or customizing "
28049 #: ../tools/virt-tar.pl:79
28051 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28052 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28053 "should look at the L<guestfish(1)> tool."
28057 #: ../tools/virt-tar.pl:83
28059 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28060 "its contents (recursively) from the virtual machine into a local tarball. "
28061 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28062 "virtual machine. You cannot use these two options together."
28066 #: ../tools/virt-tar.pl:89
28068 "In addition, you may need to use the C<-z> (gZip) option to enable "
28069 "compression. When uploading, you have to specify C<-z> if the upload file "
28070 "is compressed because virt-tar won't detect this on its own."
28074 #: ../tools/virt-tar.pl:93
28076 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28077 "example it cannot do PKZip files or bzip2 compression. If you want that "
28078 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28079 "the L<libguestfs(3)> API)."
28083 #: ../tools/virt-tar.pl:151
28084 msgid "B<-x> | B<--extract> | B<--download>"
28088 #: ../tools/virt-tar.pl:153
28089 msgid "B<-u> | B<--upload>"
28093 #: ../tools/virt-tar.pl:155
28095 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28100 #: ../tools/virt-tar.pl:158
28102 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28103 "Please read the L</WARNING> section above before using this option."
28107 #: ../tools/virt-tar.pl:162
28108 msgid "You must specify exactly one of these options."
28112 #: ../tools/virt-tar.pl:168
28113 msgid "B<-z> | B<--gzip>"
28117 #: ../tools/virt-tar.pl:170
28118 msgid "Specify that the input or output tarball is gzip-compressed."
28122 #: ../tools/virt-tar.pl:283
28124 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28125 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28130 #: ../tools/virt-make-fs.pl:37
28131 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28135 #: ../tools/virt-make-fs.pl:41
28138 " virt-make-fs [--options] input.tar output.img\n"
28143 #: ../tools/virt-make-fs.pl:43
28146 " virt-make-fs [--options] input.tar.gz output.img\n"
28151 #: ../tools/virt-make-fs.pl:45
28154 " virt-make-fs [--options] directory output.img\n"
28159 #: ../tools/virt-make-fs.pl:49
28161 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28162 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28163 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28164 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28165 "you want to attach these filesystems to existing virtual machines (eg. to "
28166 "import large amounts of read-only data to a VM)."
28170 #: ../tools/virt-make-fs.pl:57
28171 msgid "Basic usage is:"
28175 #: ../tools/virt-make-fs.pl:59
28178 " virt-make-fs input output\n"
28183 #: ../tools/virt-make-fs.pl:61
28185 "where C<input> is either a directory containing files that you want to add, "
28186 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28187 "C<output> is a disk image. The input type is detected automatically. The "
28188 "output disk image defaults to a raw ext2 image unless you specify extra "
28189 "flags (see L</OPTIONS> below)."
28193 #: ../tools/virt-make-fs.pl:67
28194 msgid "EXTRA SPACE"
28198 #: ../tools/virt-make-fs.pl:69
28200 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28201 "the files that it contains, but might have extra space. Depending on how "
28202 "you are going to use the output, you might think this extra space is wasted "
28203 "and want to minimize it, or you might want to leave space so that more files "
28204 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28205 "but you can use the C<--size> flag to leave space in the filesystem if you "
28210 #: ../tools/virt-make-fs.pl:77
28212 "An alternative way to leave extra space but not make the output image any "
28213 "bigger is to use an alternative disk image format (instead of the default "
28214 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28215 "image format (check your hypervisor supports this before using it). This "
28216 "allows you to choose a large C<--size> but the extra space won't actually be "
28217 "allocated in the image until you try to store something in it."
28221 #: ../tools/virt-make-fs.pl:85
28223 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28224 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28225 "resize to build another image from scratch."
28229 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28230 #: ../tools/virt-make-fs.pl:142
28235 #: ../tools/virt-make-fs.pl:91
28238 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28243 #: ../tools/virt-make-fs.pl:93
28244 msgid "FILESYSTEM TYPE"
28248 #: ../tools/virt-make-fs.pl:95
28250 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28251 "libguestfs supports can be used (but I<not> read-only formats like "
28252 "ISO9660). Here are some of the more common choices:"
28256 #: ../tools/virt-make-fs.pl:101
28261 #: ../tools/virt-make-fs.pl:103
28263 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28264 "you are not going to use the filesystem in a way that requires the journal, "
28265 "then this is just wasted overhead."
28269 #: ../tools/virt-make-fs.pl:107
28270 msgid "I<ntfs> or I<vfat>"
28274 #: ../tools/virt-make-fs.pl:109
28275 msgid "Useful if exporting data to a Windows guest."
28279 #: ../tools/virt-make-fs.pl:111
28281 "I<Note for vfat>: The tar archive or local directory must only contain files "
28282 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28283 "program running within libguestfs is unable to change the ownership of non-"
28284 "root files, since vfat itself does not support this."
28288 #: ../tools/virt-make-fs.pl:116
28293 #: ../tools/virt-make-fs.pl:118
28295 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28296 "total filesystem size."
28300 #: ../tools/virt-make-fs.pl:125
28303 " virt-make-fs --type=minix input minixfs.img\n"
28308 #: ../tools/virt-make-fs.pl:127
28309 msgid "TO PARTITION OR NOT TO PARTITION"
28313 #: ../tools/virt-make-fs.pl:129
28314 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28318 #: ../tools/virt-make-fs.pl:131
28320 "Adding a partition can make the disk image more compatible with certain "
28321 "virtualized operating systems which don't expect to see a filesystem "
28322 "directly located on a block device (Linux doesn't care and will happily "
28323 "handle both types)."
28327 #: ../tools/virt-make-fs.pl:136
28329 "On the other hand, if you have a partition table then the output image is no "
28330 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28331 "directly on a partitioned disk image. (However libguestfs tools such as "
28332 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28336 #: ../tools/virt-make-fs.pl:144
28337 msgid "Add an MBR partition:"
28341 #: ../tools/virt-make-fs.pl:146
28344 " virt-make-fs --partition -- input disk.img\n"
28349 #: ../tools/virt-make-fs.pl:148
28351 "If the output disk image could be terabyte-sized or larger, it's better to "
28352 "use an EFI/GPT-compatible partition table:"
28356 #: ../tools/virt-make-fs.pl:151
28359 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28364 #: ../tools/virt-make-fs.pl:179
28365 msgid "Enable debugging information."
28369 #: ../tools/virt-make-fs.pl:185
28370 msgid "B<--size=E<lt>NE<gt>>"
28374 #: ../tools/virt-make-fs.pl:187
28375 msgid "B<--size=+E<lt>NE<gt>>"
28379 #: ../tools/virt-make-fs.pl:189
28380 msgid "B<-s E<lt>NE<gt>>"
28384 #: ../tools/virt-make-fs.pl:191
28385 msgid "B<-s +E<lt>NE<gt>>"
28389 #: ../tools/virt-make-fs.pl:193
28391 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28395 #: ../tools/virt-make-fs.pl:196
28397 "If this option is I<not> given, then the output image will be just large "
28398 "enough to contain all the files, with not much wasted space."
28402 #: ../tools/virt-make-fs.pl:199
28404 "To choose a fixed size output disk, specify an absolute number followed by b/"
28405 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28406 "Petabytes or Exabytes. This must be large enough to contain all the input "
28407 "files, else you will get an error."
28411 #: ../tools/virt-make-fs.pl:204
28413 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28414 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28415 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28416 "the input files, and (approximately) an extra 200 MB free space."
28420 #: ../tools/virt-make-fs.pl:210
28422 "Note that virt-make-fs estimates free space, and therefore will not produce "
28423 "filesystems containing precisely the free space requested. (It is much more "
28424 "expensive and time-consuming to produce a filesystem which has precisely the "
28425 "desired free space)."
28429 #: ../tools/virt-make-fs.pl:219
28430 msgid "B<--format=E<lt>fmtE<gt>>"
28434 #: ../tools/virt-make-fs.pl:221
28435 msgid "B<-F E<lt>fmtE<gt>>"
28439 #: ../tools/virt-make-fs.pl:223
28440 msgid "Choose the output disk image format."
28444 #: ../tools/virt-make-fs.pl:225
28445 msgid "The default is C<raw> (raw disk image)."
28449 #: ../tools/virt-make-fs.pl:227
28451 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28452 "that would really make sense here is C<qcow2>."
28456 #: ../tools/virt-make-fs.pl:234
28457 msgid "B<--type=E<lt>fsE<gt>>"
28461 #: ../tools/virt-make-fs.pl:236
28462 msgid "B<-t E<lt>fsE<gt>>"
28466 #: ../tools/virt-make-fs.pl:238
28467 msgid "Choose the output filesystem type."
28471 #: ../tools/virt-make-fs.pl:240
28472 msgid "The default is C<ext2>."
28476 #: ../tools/virt-make-fs.pl:242
28478 "Any filesystem which is supported read-write by libguestfs can be used here."
28482 #: ../tools/virt-make-fs.pl:249
28483 msgid "B<--partition>"
28487 #: ../tools/virt-make-fs.pl:251
28488 msgid "B<--partition=E<lt>parttypeE<gt>>"
28492 #: ../tools/virt-make-fs.pl:253
28494 "If specified, this flag adds an MBR partition table to the output disk image."
28498 #: ../tools/virt-make-fs.pl:256
28500 "You can change the partition table type, eg. C<--partition=gpt> for large "
28505 #: ../tools/virt-make-fs.pl:259
28507 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28508 "might consider the next parameter to be the partition type. For example:"
28512 #: ../tools/virt-make-fs.pl:263
28515 " virt-make-fs --partition input.tar ...\n"
28520 #: ../tools/virt-make-fs.pl:265
28522 "would cause virt-make-fs to think you wanted to use a partition type of "
28523 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28524 "dash) between options and the input file argument:"
28528 #: ../tools/virt-make-fs.pl:269
28531 " virt-make-fs --partition -- input.tar ...\n"
28536 #: ../tools/virt-make-fs.pl:536
28538 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28539 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28540 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28544 #: ../tools/virt-make-fs.pl:553
28547 " export LIBGUESTFS_DEBUG=1\n"
28548 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28553 #: ../tools/virt-make-fs.pl:556
28555 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28560 #: ../tools/virt-list-partitions.pl:32
28562 "virt-list-partitions - List partitions in a virtual machine or disk image"
28566 #: ../tools/virt-list-partitions.pl:36
28569 " virt-list-partitions [--options] domname\n"
28574 #: ../tools/virt-list-partitions.pl:38
28577 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28582 #: ../tools/virt-list-partitions.pl:45
28584 "C<virt-list-partitions> is a command line tool to list the partitions that "
28585 "are contained in a virtual machine or disk image. It is mainly useful as a "
28586 "first step to using L<virt-resize(1)>."
28590 #: ../tools/virt-list-partitions.pl:50
28592 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28593 "functionality. For more complex cases you should look at the L<guestfish(1)"
28598 #: ../tools/virt-list-partitions.pl:107
28599 msgid "B<-h> | B<--human-readable>"
28603 #: ../tools/virt-list-partitions.pl:109
28604 msgid "Show sizes in human-readable form (eg. \"1G\")."
28608 #: ../tools/virt-list-partitions.pl:117
28610 "With this option, C<virt-list-partitions> displays the type and size of each "
28611 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28615 #: ../tools/virt-list-partitions.pl:124
28616 msgid "B<-t> | B<--total>"
28620 #: ../tools/virt-list-partitions.pl:126
28622 "Display the total size of each block device (as a separate row or rows)."
28626 #: ../tools/virt-list-partitions.pl:259
28628 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
28629 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
28630 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."