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-30 15:00+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:571 ../src/guestfs-actions.pod:579
796 #: ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593
797 #: ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593
798 #: ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601
799 #: ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613
800 #: ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627
801 #: ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635
802 #: ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777
803 #: ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787
804 #: ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852
805 #: ../src/guestfs-actions.pod:1857 ../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:345 ../tools/virt-resize.pl:350
820 #: ../tools/virt-resize.pl:360
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:1844 ../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:1483 ../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:1508 ../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:128
4240 #: ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226
4241 #: ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261
4242 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295
4243 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4244 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489
4245 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4246 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635
4247 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664
4248 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
4249 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
4250 #: ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990
4251 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092
4252 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129
4253 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163
4254 #: ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264
4255 #: ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326
4256 #: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466
4257 #: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706
4258 #: ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2215
4259 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2420
4260 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3194
4261 #: ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3229
4262 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3368
4263 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3395
4264 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3446
4265 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3538
4266 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3578
4267 #: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3633
4268 #: ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3671
4269 #: ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3718
4270 #: ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3770
4271 #: ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3798
4272 #: ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3908
4273 #: ../src/guestfs-actions.pod:3928 ../src/guestfs-actions.pod:3941
4274 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4010
4275 #: ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4044
4276 #: ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4072
4277 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104
4278 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4173
4279 #: ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4223
4280 #: ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4254
4281 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:4284
4282 #: ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4314
4283 #: ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4364
4284 #: ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4398
4285 #: ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4464
4286 #: ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4515
4287 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4560
4288 #: ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4712
4289 #: ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4791
4290 #: ../src/guestfs-actions.pod:4809 ../src/guestfs-actions.pod:4841
4291 #: ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4924
4292 #: ../src/guestfs-actions.pod:4937 ../src/guestfs-actions.pod:4951
4293 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5259
4294 #: ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5285
4295 #: ../src/guestfs-actions.pod:5299 ../src/guestfs-actions.pod:5311
4296 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5341
4297 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381
4298 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5418
4299 #: ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5459
4300 #: ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5499
4301 #: ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5535
4302 #: ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5587
4303 #: ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5630
4304 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5660
4305 #: ../src/guestfs-actions.pod:5679 ../src/guestfs-actions.pod:5716
4306 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:5765
4307 #: ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5994
4308 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6019
4309 #: ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6054
4310 #: ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6080
4311 #: ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6108
4312 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6184
4313 #: ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6216
4314 #: ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6246
4315 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6302
4316 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6357
4317 #: ../src/guestfs-actions.pod:6370 ../src/guestfs-actions.pod:6388
4318 #: ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6448
4319 #: ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:6585
4320 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6654
4321 #: ../src/guestfs-actions.pod:6667 ../src/guestfs-actions.pod:6712
4322 #: ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:6799
4323 #: ../src/guestfs-actions.pod:6825 ../src/guestfs-actions.pod:6891
4324 #: ../src/guestfs-actions.pod:6910 ../src/guestfs-actions.pod:6939
4325 msgid "This function returns 0 on success or -1 on error."
4329 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242
4330 #: ../src/guestfs-actions.pod:263 ../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:245
4339 #: ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437
4340 #: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944
4341 #: ../src/guestfs-actions.pod:6833 ../src/guestfs-actions.pod:7002
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:130
4354 #: ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895
4355 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096
4356 #: ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3211
4357 #: ../src/guestfs-actions.pod:4351 ../src/guestfs-actions.pod:5420
4358 #: ../src/guestfs-actions.pod:5537 ../src/guestfs-actions.pod:5647
4359 #: ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6235
4360 #: ../src/guestfs-actions.pod:6747
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:139
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:338
4450 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681
4451 #: ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730
4452 #: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309
4453 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866
4454 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005
4455 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083
4456 #: ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2634
4457 #: ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:4487
4458 #: ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:5021
4459 #: ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:6343
4460 #: ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6771
4461 #: ../src/guestfs-actions.pod:6784
4462 msgid "On error this function returns -1."
4466 #: ../src/guestfs-actions.pod:87
4467 msgid "(Added in 1.7.4)"
4471 #: ../src/guestfs-actions.pod:89
4472 msgid "guestfs_add_domain_va"
4476 #: ../src/guestfs-actions.pod:91
4480 " guestfs_add_domain_va (guestfs_h *g,\n"
4481 " const char *dom,\n"
4487 #: ../src/guestfs-actions.pod:96
4488 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4492 #: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109
4493 #: ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213
4494 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4498 #: ../src/guestfs-actions.pod:100
4499 msgid "guestfs_add_domain_argv"
4503 #: ../src/guestfs-actions.pod:102
4507 " guestfs_add_domain_argv (guestfs_h *g,\n"
4508 " const char *dom,\n"
4509 " const struct guestfs_add_domain_argv *optargs);\n"
4514 #: ../src/guestfs-actions.pod:107
4515 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4519 #: ../src/guestfs-actions.pod:111
4520 msgid "guestfs_add_drive"
4524 #: ../src/guestfs-actions.pod:113
4528 " guestfs_add_drive (guestfs_h *g,\n"
4529 " const char *filename);\n"
4534 #: ../src/guestfs-actions.pod:117
4536 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4537 "optional parameters, so the disk is added writable, with the format being "
4538 "detected automatically."
4542 #: ../src/guestfs-actions.pod:121
4544 "Automatic detection of the format opens you up to a potential security hole "
4545 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4546 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4547 "you should think about replacing calls to this function with calls to "
4548 "C<guestfs_add_drive_opts>, and specifying the format."
4552 #: ../src/guestfs-actions.pod:132
4553 msgid "guestfs_add_drive_opts"
4557 #: ../src/guestfs-actions.pod:134
4561 " guestfs_add_drive_opts (guestfs_h *g,\n"
4562 " const char *filename,\n"
4568 #: ../src/guestfs-actions.pod:144
4571 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4572 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4573 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4578 #: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92
4580 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4581 "The first time you call this function, the disk appears as C</dev/sda>, the "
4582 "second time as C</dev/sdb>, and so on."
4586 #: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97
4588 "You don't necessarily need to be root when using libguestfs. However you "
4589 "obviously do need sufficient permissions to access the filename for whatever "
4590 "operations you want to perform (ie. read access if you just want to read the "
4591 "image or write access if you want to modify the image)."
4595 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103
4596 msgid "This call checks that C<filename> exists."
4600 #: ../src/guestfs-actions.pod:161 ../fish/guestfish-actions.pod:105
4601 msgid "The optional arguments are:"
4605 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
4610 #: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111
4612 "If true then the image is treated as read-only. Writes are still allowed, "
4613 "but they are stored in a temporary snapshot overlay which is discarded at "
4614 "the end. The disk that you add is not modified."
4618 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115
4623 #: ../src/guestfs-actions.pod:173
4625 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4626 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4627 "Possible formats include C<raw> and C<qcow2>."
4631 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:121
4633 "Automatic detection of the format opens you up to a potential security hole "
4634 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4635 "RHBZ#642934. Specifying the format closes this security hole."
4639 #: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126
4644 #: ../src/guestfs-actions.pod:184
4646 "This rarely-used option lets you emulate the behaviour of the deprecated "
4647 "C<guestfs_add_drive_with_if> call (q.v.)"
4651 #: ../src/guestfs-actions.pod:191
4652 msgid "(Added in 1.5.23)"
4656 #: ../src/guestfs-actions.pod:193
4657 msgid "guestfs_add_drive_opts_va"
4661 #: ../src/guestfs-actions.pod:195
4665 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4666 " const char *filename,\n"
4672 #: ../src/guestfs-actions.pod:200
4673 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4677 #: ../src/guestfs-actions.pod:204
4678 msgid "guestfs_add_drive_opts_argv"
4682 #: ../src/guestfs-actions.pod:206
4686 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4687 " const char *filename,\n"
4688 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4693 #: ../src/guestfs-actions.pod:211
4694 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4698 #: ../src/guestfs-actions.pod:215
4699 msgid "guestfs_add_drive_ro"
4703 #: ../src/guestfs-actions.pod:217
4707 " guestfs_add_drive_ro (guestfs_h *g,\n"
4708 " const char *filename);\n"
4713 #: ../src/guestfs-actions.pod:221
4715 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4716 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4717 "disk is added read-only, with the format being detected automatically."
4721 #: ../src/guestfs-actions.pod:228
4722 msgid "(Added in 1.0.38)"
4726 #: ../src/guestfs-actions.pod:230
4727 msgid "guestfs_add_drive_ro_with_if"
4731 #: ../src/guestfs-actions.pod:232
4735 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4736 " const char *filename,\n"
4737 " const char *iface);\n"
4742 #: ../src/guestfs-actions.pod:237
4744 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4745 "QEMU interface emulation to use at run time."
4749 #: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270
4750 #: ../src/guestfs-actions.pod:2305
4751 msgid "(Added in 1.0.84)"
4755 #: ../src/guestfs-actions.pod:251
4756 msgid "guestfs_add_drive_with_if"
4760 #: ../src/guestfs-actions.pod:253
4764 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4765 " const char *filename,\n"
4766 " const char *iface);\n"
4771 #: ../src/guestfs-actions.pod:258
4773 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4774 "QEMU interface emulation to use at run time."
4778 #: ../src/guestfs-actions.pod:272
4779 msgid "guestfs_aug_clear"
4783 #: ../src/guestfs-actions.pod:274
4787 " guestfs_aug_clear (guestfs_h *g,\n"
4788 " const char *augpath);\n"
4793 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178
4795 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4796 "L<augtool(1)> C<clear> command."
4800 #: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085
4801 msgid "(Added in 1.3.4)"
4805 #: ../src/guestfs-actions.pod:285
4806 msgid "guestfs_aug_close"
4810 #: ../src/guestfs-actions.pod:287
4814 " guestfs_aug_close (guestfs_h *g);\n"
4819 #: ../src/guestfs-actions.pod:290
4821 "Close the current Augeas handle and free up any resources used by it. After "
4822 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4823 "any other Augeas functions."
4827 #: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322
4828 #: ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354
4829 #: ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432
4830 #: ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477
4831 #: ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505
4832 #: ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537
4833 #: ../src/guestfs-actions.pod:5098
4834 msgid "(Added in 0.7)"
4838 #: ../src/guestfs-actions.pod:299
4839 msgid "guestfs_aug_defnode"
4843 #: ../src/guestfs-actions.pod:301
4846 " struct guestfs_int_bool *\n"
4847 " guestfs_aug_defnode (guestfs_h *g,\n"
4848 " const char *name,\n"
4849 " const char *expr,\n"
4850 " const char *val);\n"
4855 #: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194
4857 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4861 #: ../src/guestfs-actions.pod:310
4863 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4864 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4865 "containing that single node."
4869 #: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201
4871 "On success this returns a pair containing the number of nodes in the "
4872 "nodeset, and a boolean flag if a node was created."
4876 #: ../src/guestfs-actions.pod:318
4878 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4879 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4883 #: ../src/guestfs-actions.pod:324
4884 msgid "guestfs_aug_defvar"
4888 #: ../src/guestfs-actions.pod:326
4892 " guestfs_aug_defvar (guestfs_h *g,\n"
4893 " const char *name,\n"
4894 " const char *expr);\n"
4899 #: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209
4901 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4902 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4906 #: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213
4908 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4909 "evaluates to something which is not a nodeset."
4913 #: ../src/guestfs-actions.pod:342
4914 msgid "guestfs_aug_get"
4918 #: ../src/guestfs-actions.pod:344
4922 " guestfs_aug_get (guestfs_h *g,\n"
4923 " const char *augpath);\n"
4928 #: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220
4930 "Look up the value associated with C<path>. If C<path> matches exactly one "
4931 "node, the C<value> is returned."
4935 #: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851
4936 #: ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929
4937 #: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048
4938 #: ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195
4939 #: ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343
4940 #: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646
4941 #: ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826
4942 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938
4943 #: ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2270
4944 #: ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2558
4945 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:2716
4946 #: ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2771
4947 #: ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2856
4948 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3690
4949 #: ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3970
4950 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4826
4951 #: ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5174
4952 #: ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5786
4953 #: ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5819
4954 #: ../src/guestfs-actions.pod:5843 ../src/guestfs-actions.pod:6507
4955 #: ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6544
4956 #: ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6996
4958 "This function returns a string, or NULL on error. I<The caller must free "
4959 "the returned string after use>."
4963 #: ../src/guestfs-actions.pod:356
4964 msgid "guestfs_aug_init"
4968 #: ../src/guestfs-actions.pod:358
4972 " guestfs_aug_init (guestfs_h *g,\n"
4973 " const char *root,\n"
4979 #: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227
4981 "Create a new Augeas handle for editing configuration files. If there was "
4982 "any previous Augeas handle associated with this guestfs session, then it is "
4987 #: ../src/guestfs-actions.pod:367
4988 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4992 #: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234
4994 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4998 #: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237
5000 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5001 "logical I<or> of the following integers:"
5005 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5006 msgid "C<AUG_SAVE_BACKUP> = 1"
5010 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5011 msgid "Keep the original file with a C<.augsave> extension."
5015 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5016 msgid "C<AUG_SAVE_NEWFILE> = 2"
5020 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249
5022 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5023 "original. Overrides C<AUG_SAVE_BACKUP>."
5027 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5028 msgid "C<AUG_TYPE_CHECK> = 4"
5032 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5033 msgid "Typecheck lenses (can be expensive)."
5037 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5038 msgid "C<AUG_NO_STDINC> = 8"
5042 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5043 msgid "Do not use standard load path for modules."
5047 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5048 msgid "C<AUG_SAVE_NOOP> = 16"
5052 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5053 msgid "Make save a no-op, just record what would have been changed."
5057 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264
5058 msgid "C<AUG_NO_LOAD> = 32"
5062 #: ../src/guestfs-actions.pod:402
5063 msgid "Do not load the tree in C<guestfs_aug_init>."
5067 #: ../src/guestfs-actions.pod:406
5068 msgid "To close the handle, you can call C<guestfs_aug_close>."
5072 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272
5073 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5077 #: ../src/guestfs-actions.pod:414
5078 msgid "guestfs_aug_insert"
5082 #: ../src/guestfs-actions.pod:416
5086 " guestfs_aug_insert (guestfs_h *g,\n"
5087 " const char *augpath,\n"
5088 " const char *label,\n"
5094 #: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278
5096 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5097 "or after C<path> (depending on the boolean flag C<before>)."
5101 #: ../src/guestfs-actions.pod:426 ../fish/guestfish-actions.pod:282
5103 "C<path> must match exactly one existing node in the tree, and C<label> must "
5104 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5108 #: ../src/guestfs-actions.pod:434
5109 msgid "guestfs_aug_load"
5113 #: ../src/guestfs-actions.pod:436
5117 " guestfs_aug_load (guestfs_h *g);\n"
5122 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5123 msgid "Load files into the tree."
5127 #: ../src/guestfs-actions.pod:441 ../fish/guestfish-actions.pod:292
5128 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5132 #: ../src/guestfs-actions.pod:448
5133 msgid "guestfs_aug_ls"
5137 #: ../src/guestfs-actions.pod:450
5141 " guestfs_aug_ls (guestfs_h *g,\n"
5142 " const char *augpath);\n"
5147 #: ../src/guestfs-actions.pod:454
5149 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5150 "sorting the resulting nodes into alphabetical order."
5154 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:473
5155 #: ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:1067
5156 #: ../src/guestfs-actions.pod:1358 ../src/guestfs-actions.pod:1377
5157 #: ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1499
5158 #: ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2150
5159 #: ../src/guestfs-actions.pod:2166 ../src/guestfs-actions.pod:2185
5160 #: ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:2252
5161 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2372
5162 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2790
5163 #: ../src/guestfs-actions.pod:3005 ../src/guestfs-actions.pod:3260
5164 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3427
5165 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:4448
5166 #: ../src/guestfs-actions.pod:4968 ../src/guestfs-actions.pod:5094
5167 #: ../src/guestfs-actions.pod:5208 ../src/guestfs-actions.pod:5859
5168 #: ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:5975
5169 #: ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6145
5170 #: ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6637
5171 #: ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6849
5172 #: ../src/guestfs-actions.pod:6868 ../src/guestfs-actions.pod:6953
5173 #: ../src/guestfs-actions.pod:6972 ../src/guestfs-actions.pod:7018
5174 #: ../src/guestfs-actions.pod:7037
5176 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5177 ">), or NULL if there was an error. I<The caller must free the strings and "
5178 "the array after use>."
5182 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:992
5183 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:1415
5184 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3114
5185 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3723
5186 #: ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3943
5187 #: ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4452
5188 #: ../src/guestfs-actions.pod:4909 ../src/guestfs-actions.pod:5287
5189 #: ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:5313
5190 #: ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:6359
5191 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6601
5192 #: ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6837
5193 msgid "(Added in 0.8)"
5197 #: ../src/guestfs-actions.pod:463
5198 msgid "guestfs_aug_match"
5202 #: ../src/guestfs-actions.pod:465
5206 " guestfs_aug_match (guestfs_h *g,\n"
5207 " const char *augpath);\n"
5212 #: ../src/guestfs-actions.pod:469 ../fish/guestfish-actions.pod:306
5214 "Returns a list of paths which match the path expression C<path>. The "
5215 "returned paths are sufficiently qualified so that they match exactly one "
5216 "node in the current tree."
5220 #: ../src/guestfs-actions.pod:479
5221 msgid "guestfs_aug_mv"
5225 #: ../src/guestfs-actions.pod:481
5229 " guestfs_aug_mv (guestfs_h *g,\n"
5230 " const char *src,\n"
5231 " const char *dest);\n"
5236 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:314
5238 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5239 "C<dest> is overwritten if it exists."
5243 #: ../src/guestfs-actions.pod:493
5244 msgid "guestfs_aug_rm"
5248 #: ../src/guestfs-actions.pod:495
5252 " guestfs_aug_rm (guestfs_h *g,\n"
5253 " const char *augpath);\n"
5258 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5259 msgid "Remove C<path> and all of its children."
5263 #: ../src/guestfs-actions.pod:501 ../fish/guestfish-actions.pod:323
5264 msgid "On success this returns the number of entries which were removed."
5268 #: ../src/guestfs-actions.pod:507
5269 msgid "guestfs_aug_save"
5273 #: ../src/guestfs-actions.pod:509
5277 " guestfs_aug_save (guestfs_h *g);\n"
5282 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:329
5283 msgid "This writes all pending changes to disk."
5287 #: ../src/guestfs-actions.pod:514
5289 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5294 #: ../src/guestfs-actions.pod:521
5295 msgid "guestfs_aug_set"
5299 #: ../src/guestfs-actions.pod:523
5303 " guestfs_aug_set (guestfs_h *g,\n"
5304 " const char *augpath,\n"
5305 " const char *val);\n"
5310 #: ../src/guestfs-actions.pod:528 ../fish/guestfish-actions.pod:338
5311 msgid "Set the value associated with C<path> to C<val>."
5315 #: ../src/guestfs-actions.pod:530
5317 "In the Augeas API, it is possible to clear a node by setting the value to "
5318 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5319 "this call. Instead you must use the C<guestfs_aug_clear> call."
5323 #: ../src/guestfs-actions.pod:539
5324 msgid "guestfs_available"
5328 #: ../src/guestfs-actions.pod:541
5332 " guestfs_available (guestfs_h *g,\n"
5333 " char *const *groups);\n"
5338 #: ../src/guestfs-actions.pod:545 ../fish/guestfish-actions.pod:349
5340 "This command is used to check the availability of some groups of "
5341 "functionality in the appliance, which not all builds of the libguestfs "
5342 "appliance will be able to provide."
5346 #: ../src/guestfs-actions.pod:549
5348 "The libguestfs groups, and the functions that those groups correspond to, "
5349 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5350 "runtime by calling C<guestfs_available_all_groups>."
5354 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:358
5356 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5357 "\"]> would check for the availability of the Linux inotify functions and "
5358 "Augeas (configuration file editing) functions."
5362 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5363 msgid "The command returns no error if I<all> requested groups are available."
5367 #: ../src/guestfs-actions.pod:561 ../fish/guestfish-actions.pod:365
5369 "It fails with an error if one or more of the requested groups is unavailable "
5374 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5376 "If an unknown group name is included in the list of groups then an error is "
5381 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5386 #: ../src/guestfs-actions.pod:573
5387 msgid "You must call C<guestfs_launch> before calling this function."
5391 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:379
5393 "The reason is because we don't know what groups are supported by the "
5394 "appliance/daemon until it is running and can be queried."
5398 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:385
5400 "If a group of functions is available, this does not necessarily mean that "
5401 "they will work. You still have to check for errors when calling individual "
5402 "API functions even if they are available."
5406 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:392
5408 "It is usually the job of distro packagers to build complete functionality "
5409 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5410 "with all requirements satisfied, will support everything."
5414 #: ../src/guestfs-actions.pod:595
5416 "This call was added in version C<1.0.80>. In previous versions of "
5417 "libguestfs all you could do would be to speculatively execute a command to "
5418 "find out if the daemon implemented it. See also C<guestfs_version>."
5422 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1165
5423 msgid "(Added in 1.0.80)"
5427 #: ../src/guestfs-actions.pod:606
5428 msgid "guestfs_available_all_groups"
5432 #: ../src/guestfs-actions.pod:608
5436 " guestfs_available_all_groups (guestfs_h *g);\n"
5441 #: ../src/guestfs-actions.pod:611
5443 "This command returns a list of all optional groups that this daemon knows "
5444 "about. Note this returns both supported and unsupported groups. To find "
5445 "out which ones the daemon can actually support you have to call "
5446 "C<guestfs_available> on each member of the returned list."
5450 #: ../src/guestfs-actions.pod:617
5451 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5455 #: ../src/guestfs-actions.pod:623
5456 msgid "(Added in 1.3.15)"
5460 #: ../src/guestfs-actions.pod:625
5461 msgid "guestfs_base64_in"
5465 #: ../src/guestfs-actions.pod:627
5469 " guestfs_base64_in (guestfs_h *g,\n"
5470 " const char *base64file,\n"
5471 " const char *filename);\n"
5476 #: ../src/guestfs-actions.pod:632 ../fish/guestfish-actions.pod:422
5478 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5482 #: ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:651
5483 msgid "(Added in 1.3.5)"
5487 #: ../src/guestfs-actions.pod:639
5488 msgid "guestfs_base64_out"
5492 #: ../src/guestfs-actions.pod:641
5496 " guestfs_base64_out (guestfs_h *g,\n"
5497 " const char *filename,\n"
5498 " const char *base64file);\n"
5503 #: ../src/guestfs-actions.pod:646 ../fish/guestfish-actions.pod:431
5505 "This command downloads the contents of C<filename>, writing it out to local "
5506 "file C<base64file> encoded as base64."
5510 #: ../src/guestfs-actions.pod:653
5511 msgid "guestfs_blockdev_flushbufs"
5515 #: ../src/guestfs-actions.pod:655
5519 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5520 " const char *device);\n"
5525 #: ../src/guestfs-actions.pod:659 ../fish/guestfish-actions.pod:440
5527 "This tells the kernel to flush internal buffers associated with C<device>."
5531 #: ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:679
5532 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:710
5533 #: ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747
5534 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
5535 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
5536 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5537 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5538 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5539 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5540 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5541 msgid "This uses the L<blockdev(8)> command."
5545 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:683
5546 #: ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:714
5547 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:751
5548 #: ../src/guestfs-actions.pod:765 ../src/guestfs-actions.pod:783
5549 #: ../src/guestfs-actions.pod:797 ../src/guestfs-actions.pod:811
5550 msgid "(Added in 0.9.3)"
5554 #: ../src/guestfs-actions.pod:668
5555 msgid "guestfs_blockdev_getbsz"
5559 #: ../src/guestfs-actions.pod:670
5563 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5564 " const char *device);\n"
5569 #: ../src/guestfs-actions.pod:674 ../fish/guestfish-actions.pod:449
5570 msgid "This returns the block size of a device."
5574 #: ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:776
5575 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5577 "(Note this is different from both I<size in blocks> and I<filesystem block "
5582 #: ../src/guestfs-actions.pod:685
5583 msgid "guestfs_blockdev_getro"
5587 #: ../src/guestfs-actions.pod:687
5591 " guestfs_blockdev_getro (guestfs_h *g,\n"
5592 " const char *device);\n"
5597 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:460
5599 "Returns a boolean indicating if the block device is read-only (true if read-"
5600 "only, false if not)."
5604 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:1398
5605 #: ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1893
5606 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976
5607 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046
5608 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094
5609 #: ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3036
5610 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065
5611 #: ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3096
5612 #: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3126
5613 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3153
5614 #: ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3183
5615 #: ../src/guestfs-actions.pod:4597
5616 msgid "This function returns a C truth value on success or -1 on error."
5620 #: ../src/guestfs-actions.pod:700
5621 msgid "guestfs_blockdev_getsize64"
5625 #: ../src/guestfs-actions.pod:702
5629 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5630 " const char *device);\n"
5635 #: ../src/guestfs-actions.pod:706 ../fish/guestfish-actions.pod:469
5636 msgid "This returns the size of the device in bytes."
5640 #: ../src/guestfs-actions.pod:708
5641 msgid "See also C<guestfs_blockdev_getsz>."
5645 #: ../src/guestfs-actions.pod:716
5646 msgid "guestfs_blockdev_getss"
5650 #: ../src/guestfs-actions.pod:718
5654 " guestfs_blockdev_getss (guestfs_h *g,\n"
5655 " const char *device);\n"
5660 #: ../src/guestfs-actions.pod:722 ../fish/guestfish-actions.pod:479
5662 "This returns the size of sectors on a block device. Usually 512, but can be "
5663 "larger for modern devices."
5667 #: ../src/guestfs-actions.pod:725
5669 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5674 #: ../src/guestfs-actions.pod:734
5675 msgid "guestfs_blockdev_getsz"
5679 #: ../src/guestfs-actions.pod:736
5683 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5684 " const char *device);\n"
5689 #: ../src/guestfs-actions.pod:740 ../fish/guestfish-actions.pod:491
5691 "This returns the size of the device in units of 512-byte sectors (even if "
5692 "the sectorsize isn't 512 bytes ... weird)."
5696 #: ../src/guestfs-actions.pod:743
5698 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5699 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5703 #: ../src/guestfs-actions.pod:753
5704 msgid "guestfs_blockdev_rereadpt"
5708 #: ../src/guestfs-actions.pod:755
5712 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5713 " const char *device);\n"
5718 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:504
5719 msgid "Reread the partition table on C<device>."
5723 #: ../src/guestfs-actions.pod:767
5724 msgid "guestfs_blockdev_setbsz"
5728 #: ../src/guestfs-actions.pod:769
5732 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5733 " const char *device,\n"
5734 " int blocksize);\n"
5739 #: ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:512
5740 msgid "This sets the block size of a device."
5744 #: ../src/guestfs-actions.pod:785
5745 msgid "guestfs_blockdev_setro"
5749 #: ../src/guestfs-actions.pod:787
5753 " guestfs_blockdev_setro (guestfs_h *g,\n"
5754 " const char *device);\n"
5759 #: ../src/guestfs-actions.pod:791 ../fish/guestfish-actions.pod:523
5760 msgid "Sets the block device named C<device> to read-only."
5764 #: ../src/guestfs-actions.pod:799
5765 msgid "guestfs_blockdev_setrw"
5769 #: ../src/guestfs-actions.pod:801
5773 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5774 " const char *device);\n"
5779 #: ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:531
5780 msgid "Sets the block device named C<device> to read-write."
5784 #: ../src/guestfs-actions.pod:813
5785 msgid "guestfs_case_sensitive_path"
5789 #: ../src/guestfs-actions.pod:815
5793 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5794 " const char *path);\n"
5799 #: ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:539
5801 "This can be used to resolve case insensitive paths on a filesystem which is "
5802 "case sensitive. The use case is to resolve paths which you have read from "
5803 "Windows configuration files or the Windows Registry, to the true path."
5807 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:544
5809 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5810 "(and probably others), which is that although the underlying filesystem is "
5811 "case-insensitive, the driver exports the filesystem to Linux as case-"
5816 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:549
5818 "One consequence of this is that special directories such as C<c:\\windows> "
5819 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5820 "precise details of how they were created. In Windows itself this would not "
5825 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:555
5827 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5832 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
5834 "This function resolves the true case of each element in the path and returns "
5835 "the case-sensitive path."
5839 #: ../src/guestfs-actions.pod:841
5841 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5842 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5843 "how the directories were originally created under Windows)."
5847 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:566
5848 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5852 #: ../src/guestfs-actions.pod:849
5853 msgid "See also C<guestfs_realpath>."
5857 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:6529
5858 msgid "(Added in 1.0.75)"
5862 #: ../src/guestfs-actions.pod:856
5867 #: ../src/guestfs-actions.pod:858
5871 " guestfs_cat (guestfs_h *g,\n"
5872 " const char *path);\n"
5877 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:5084
5878 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5879 msgid "Return the contents of the file named C<path>."
5883 #: ../src/guestfs-actions.pod:864
5885 "Note that this function cannot correctly handle binary files (specifically, "
5886 "files containing C<\\0> character which is treated as end of string). For "
5887 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5888 "functions which have a more complex interface."
5892 #: ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:1051
5893 #: ../src/guestfs-actions.pod:1071 ../src/guestfs-actions.pod:1362
5894 #: ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1484
5895 #: ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1752
5896 #: ../src/guestfs-actions.pod:2170 ../src/guestfs-actions.pod:2189
5897 #: ../src/guestfs-actions.pod:2232 ../src/guestfs-actions.pod:2256
5898 #: ../src/guestfs-actions.pod:2273 ../src/guestfs-actions.pod:2302
5899 #: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4892
5900 #: ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5049
5901 #: ../src/guestfs-actions.pod:5073 ../src/guestfs-actions.pod:5924
5902 #: ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6125
5903 #: ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6801
5904 #: ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6853
5905 #: ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6957
5906 #: ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7022
5907 #: ../src/guestfs-actions.pod:7041 ../fish/guestfish-actions.pod:582
5908 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5909 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5910 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5911 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5912 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5913 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5914 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5915 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5916 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5917 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5918 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5919 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5920 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5921 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5922 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5924 "Because of the message protocol, there is a transfer limit of somewhere "
5925 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5929 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:3264
5930 #: ../src/guestfs-actions.pod:3326 ../src/guestfs-actions.pod:3343
5931 #: ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3836
5932 #: ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:4972
5933 #: ../src/guestfs-actions.pod:4986 ../src/guestfs-actions.pod:6688
5934 #: ../src/guestfs-actions.pod:6702
5935 msgid "(Added in 0.4)"
5939 #: ../src/guestfs-actions.pod:877
5940 msgid "guestfs_checksum"
5944 #: ../src/guestfs-actions.pod:879
5948 " guestfs_checksum (guestfs_h *g,\n"
5949 " const char *csumtype,\n"
5950 " const char *path);\n"
5955 #: ../src/guestfs-actions.pod:884 ../fish/guestfish-actions.pod:589
5957 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5961 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
5963 "The type of checksum to compute is given by the C<csumtype> parameter which "
5964 "must have one of the following values:"
5968 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
5973 #: ../src/guestfs-actions.pod:894 ../fish/guestfish-actions.pod:599
5975 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5980 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
5985 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
5986 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5990 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
5995 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
5996 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6000 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6005 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6006 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6010 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6015 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6016 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6020 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6025 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6026 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6030 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6035 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:624
6036 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6040 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:628
6041 msgid "The checksum is returned as a printable string."
6045 #: ../src/guestfs-actions.pod:925
6046 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6050 #: ../src/guestfs-actions.pod:927
6051 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6055 #: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:1240
6056 #: ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3038
6057 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3128
6058 #: ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:6390
6059 msgid "(Added in 1.0.2)"
6063 #: ../src/guestfs-actions.pod:934
6064 msgid "guestfs_checksum_device"
6068 #: ../src/guestfs-actions.pod:936
6072 " guestfs_checksum_device (guestfs_h *g,\n"
6073 " const char *csumtype,\n"
6074 " const char *device);\n"
6079 #: ../src/guestfs-actions.pod:941
6081 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6082 "device named C<device>. For the types of checksums supported see the "
6083 "C<guestfs_checksum> command."
6087 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:4503
6088 #: ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4599
6089 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4793
6090 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6318
6091 #: ../src/guestfs-actions.pod:6714
6092 msgid "(Added in 1.3.2)"
6096 #: ../src/guestfs-actions.pod:950
6097 msgid "guestfs_checksums_out"
6101 #: ../src/guestfs-actions.pod:952
6105 " guestfs_checksums_out (guestfs_h *g,\n"
6106 " const char *csumtype,\n"
6107 " const char *directory,\n"
6108 " const char *sumsfile);\n"
6113 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:646
6115 "This command computes the checksums of all regular files in C<directory> and "
6116 "then emits a list of those checksums to the local output file C<sumsfile>."
6120 #: ../src/guestfs-actions.pod:962 ../fish/guestfish-actions.pod:650
6122 "This can be used for verifying the integrity of a virtual machine. However "
6123 "to be properly secure you should pay attention to the output of the checksum "
6124 "command (it uses the ones from GNU coreutils). In particular when the "
6125 "filename is not printable, coreutils uses a special backslash syntax. For "
6126 "more information, see the GNU coreutils info file."
6130 #: ../src/guestfs-actions.pod:972
6131 msgid "(Added in 1.3.7)"
6135 #: ../src/guestfs-actions.pod:974
6136 msgid "guestfs_chmod"
6140 #: ../src/guestfs-actions.pod:976
6144 " guestfs_chmod (guestfs_h *g,\n"
6146 " const char *path);\n"
6151 #: ../src/guestfs-actions.pod:981 ../fish/guestfish-actions.pod:664
6153 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6158 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
6160 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6161 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6166 #: ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:4087
6167 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4221
6168 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:671
6169 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6170 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6171 msgid "The mode actually set is affected by the umask."
6175 #: ../src/guestfs-actions.pod:994
6176 msgid "guestfs_chown"
6180 #: ../src/guestfs-actions.pod:996
6184 " guestfs_chown (guestfs_h *g,\n"
6187 " const char *path);\n"
6192 #: ../src/guestfs-actions.pod:1002 ../fish/guestfish-actions.pod:677
6193 msgid "Change the file owner to C<owner> and group to C<group>."
6197 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:3225
6198 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6200 "Only numeric uid and gid are supported. If you want to use names, you will "
6201 "need to locate and parse the password file yourself (Augeas support makes "
6202 "this relatively easy)."
6206 #: ../src/guestfs-actions.pod:1012
6207 msgid "guestfs_command"
6211 #: ../src/guestfs-actions.pod:1014
6215 " guestfs_command (guestfs_h *g,\n"
6216 " char *const *arguments);\n"
6221 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:687
6223 "This call runs a command from the guest filesystem. The filesystem must be "
6224 "mounted, and must contain a compatible operating system (ie. something "
6225 "Linux, with the same or compatible processor architecture)."
6229 #: ../src/guestfs-actions.pod:1023
6231 "The single parameter is an argv-style list of arguments. The first element "
6232 "is the name of the program to run. Subsequent elements are parameters. The "
6233 "list must be non-empty (ie. must contain a program name). Note that the "
6234 "command runs directly, and is I<not> invoked via the shell (see "
6239 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:699
6240 msgid "The return value is anything printed to I<stdout> by the command."
6244 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
6246 "If the command returns a non-zero exit status, then this function returns an "
6247 "error message. The error message string is the content of I<stderr> from "
6252 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:706
6254 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6255 "bin>. If you require a program from another location, you should provide "
6256 "the full path in the first parameter."
6260 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:711
6262 "Shared libraries and data files required by the program must be available on "
6263 "filesystems which are mounted in the correct places. It is the caller's "
6264 "responsibility to ensure all filesystems that are needed are mounted at the "
6269 #: ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074
6270 #: ../src/guestfs-actions.pod:1537
6271 msgid "(Added in 0.9.1)"
6275 #: ../src/guestfs-actions.pod:1056
6276 msgid "guestfs_command_lines"
6280 #: ../src/guestfs-actions.pod:1058
6284 " guestfs_command_lines (guestfs_h *g,\n"
6285 " char *const *arguments);\n"
6290 #: ../src/guestfs-actions.pod:1062
6292 "This is the same as C<guestfs_command>, but splits the result into a list of "
6297 #: ../src/guestfs-actions.pod:1065
6298 msgid "See also: C<guestfs_sh_lines>"
6302 #: ../src/guestfs-actions.pod:1076
6303 msgid "guestfs_config"
6307 #: ../src/guestfs-actions.pod:1078
6311 " guestfs_config (guestfs_h *g,\n"
6312 " const char *qemuparam,\n"
6313 " const char *qemuvalue);\n"
6318 #: ../src/guestfs-actions.pod:1083 ../fish/guestfish-actions.pod:736
6320 "This can be used to add arbitrary qemu command line parameters of the form "
6321 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6322 "setting some parameters which would interfere with parameters that we use."
6326 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6327 msgid "The first character of C<param> string must be a C<-> (dash)."
6331 #: ../src/guestfs-actions.pod:1090 ../fish/guestfish-actions.pod:743
6332 msgid "C<value> can be NULL."
6336 #: ../src/guestfs-actions.pod:1096
6337 msgid "guestfs_copy_size"
6341 #: ../src/guestfs-actions.pod:1098
6345 " guestfs_copy_size (guestfs_h *g,\n"
6346 " const char *src,\n"
6347 " const char *dest,\n"
6353 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:749
6355 "This command copies exactly C<size> bytes from one source device or file "
6356 "C<src> to another destination device or file C<dest>."
6360 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6362 "Note this will fail if the source is too short or if the destination is not "
6367 #: ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1235
6368 #: ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1686
6369 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6893
6370 #: ../src/guestfs-actions.pod:6912
6372 "This long-running command can generate progress notification messages so "
6373 "that the caller can display a progress bar or indicator. To receive these "
6374 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6375 "guestfs_set_progress_callback>."
6379 #: ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:3863
6380 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:6621
6381 #: ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6727
6382 msgid "(Added in 1.0.87)"
6386 #: ../src/guestfs-actions.pod:1119
6391 #: ../src/guestfs-actions.pod:1121
6395 " guestfs_cp (guestfs_h *g,\n"
6396 " const char *src,\n"
6397 " const char *dest);\n"
6402 #: ../src/guestfs-actions.pod:1126 ../fish/guestfish-actions.pod:759
6404 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6405 "destination filename or destination directory."
6409 #: ../src/guestfs-actions.pod:1131 ../src/guestfs-actions.pod:1145
6410 #: ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1291
6411 #: ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:4466
6412 #: ../src/guestfs-actions.pod:4843
6413 msgid "(Added in 1.0.18)"
6417 #: ../src/guestfs-actions.pod:1133
6418 msgid "guestfs_cp_a"
6422 #: ../src/guestfs-actions.pod:1135
6426 " guestfs_cp_a (guestfs_h *g,\n"
6427 " const char *src,\n"
6428 " const char *dest);\n"
6433 #: ../src/guestfs-actions.pod:1140 ../fish/guestfish-actions.pod:766
6435 "This copies a file or directory from C<src> to C<dest> recursively using the "
6440 #: ../src/guestfs-actions.pod:1147
6445 #: ../src/guestfs-actions.pod:1149
6449 " guestfs_dd (guestfs_h *g,\n"
6450 " const char *src,\n"
6451 " const char *dest);\n"
6456 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:773
6458 "This command copies from one source device or file C<src> to another "
6459 "destination device or file C<dest>. Normally you would use this to copy to "
6460 "or from a device or partition, for example to duplicate a filesystem."
6464 #: ../src/guestfs-actions.pod:1159
6466 "If the destination is a device, it must be as large or larger than the "
6467 "source file or device, otherwise the copy will fail. This command cannot do "
6468 "partial copies (see C<guestfs_copy_size>)."
6472 #: ../src/guestfs-actions.pod:1167
6477 #: ../src/guestfs-actions.pod:1169
6481 " guestfs_df (guestfs_h *g);\n"
6486 #: ../src/guestfs-actions.pod:1172 ../fish/guestfish-actions.pod:786
6487 msgid "This command runs the C<df> command to report disk space used."
6491 #: ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1191
6492 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6494 "This command is mostly useful for interactive sessions. It is I<not> "
6495 "intended that you try to parse the output string. Use C<statvfs> from "
6500 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198
6501 #: ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:2235
6502 #: ../src/guestfs-actions.pod:2259 ../src/guestfs-actions.pod:2327
6503 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4366
6504 #: ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6152
6505 #: ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6773
6506 #: ../src/guestfs-actions.pod:6786
6507 msgid "(Added in 1.0.54)"
6511 #: ../src/guestfs-actions.pod:1183
6512 msgid "guestfs_df_h"
6516 #: ../src/guestfs-actions.pod:1185
6520 " guestfs_df_h (guestfs_h *g);\n"
6525 #: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:796
6527 "This command runs the C<df -h> command to report disk space used in human-"
6532 #: ../src/guestfs-actions.pod:1200
6533 msgid "guestfs_dmesg"
6537 #: ../src/guestfs-actions.pod:1202
6541 " guestfs_dmesg (guestfs_h *g);\n"
6546 #: ../src/guestfs-actions.pod:1205 ../fish/guestfish-actions.pod:807
6548 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6549 "This is sometimes useful for extended debugging of problems."
6553 #: ../src/guestfs-actions.pod:1209
6555 "Another way to get the same information is to enable verbose messages with "
6556 "C<guestfs_set_verbose> or by setting the environment variable "
6557 "C<LIBGUESTFS_DEBUG=1> before running the program."
6561 #: ../src/guestfs-actions.pod:1219
6562 msgid "guestfs_download"
6566 #: ../src/guestfs-actions.pod:1221
6570 " guestfs_download (guestfs_h *g,\n"
6571 " const char *remotefilename,\n"
6572 " const char *filename);\n"
6577 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1251
6578 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6580 "Download file C<remotefilename> and save it as C<filename> on the local "
6585 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:6384
6586 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6587 msgid "C<filename> can also be a named pipe."
6591 #: ../src/guestfs-actions.pod:1231
6592 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6596 #: ../src/guestfs-actions.pod:1242
6597 msgid "guestfs_download_offset"
6601 #: ../src/guestfs-actions.pod:1244
6605 " guestfs_download_offset (guestfs_h *g,\n"
6606 " const char *remotefilename,\n"
6607 " const char *filename,\n"
6608 " int64_t offset,\n"
6614 #: ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:836
6616 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6617 "region must be within the file or device)."
6621 #: ../src/guestfs-actions.pod:1257
6623 "Note that there is no limit on the amount of data that can be downloaded "
6624 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6625 "full amount unless an error occurs."
6629 #: ../src/guestfs-actions.pod:1262
6630 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6634 #: ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:6419
6635 msgid "(Added in 1.5.17)"
6639 #: ../src/guestfs-actions.pod:1273
6640 msgid "guestfs_drop_caches"
6644 #: ../src/guestfs-actions.pod:1275
6648 " guestfs_drop_caches (guestfs_h *g,\n"
6649 " int whattodrop);\n"
6654 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:852
6656 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6657 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6658 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6662 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
6663 msgid "Setting C<whattodrop> to 3 should drop everything."
6667 #: ../src/guestfs-actions.pod:1286 ../fish/guestfish-actions.pod:859
6669 "This automatically calls L<sync(2)> before the operation, so that the "
6670 "maximum guest memory is freed."
6674 #: ../src/guestfs-actions.pod:1293
6679 #: ../src/guestfs-actions.pod:1295
6683 " guestfs_du (guestfs_h *g,\n"
6684 " const char *path);\n"
6689 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:866
6691 "This command runs the C<du -s> command to estimate file space usage for "
6696 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
6698 "C<path> can be a file or a directory. If C<path> is a directory then the "
6699 "estimate includes the contents of the directory and all subdirectories "
6704 #: ../src/guestfs-actions.pod:1306 ../fish/guestfish-actions.pod:873
6706 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6710 #: ../src/guestfs-actions.pod:1313
6711 msgid "guestfs_e2fsck_f"
6715 #: ../src/guestfs-actions.pod:1315
6719 " guestfs_e2fsck_f (guestfs_h *g,\n"
6720 " const char *device);\n"
6725 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:880
6727 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6728 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6733 #: ../src/guestfs-actions.pod:1323
6735 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6736 "Normally you should use C<guestfs_fsck>."
6740 #: ../src/guestfs-actions.pod:1328
6741 msgid "(Added in 1.0.29)"
6745 #: ../src/guestfs-actions.pod:1330
6746 msgid "guestfs_echo_daemon"
6750 #: ../src/guestfs-actions.pod:1332
6754 " guestfs_echo_daemon (guestfs_h *g,\n"
6755 " char *const *words);\n"
6760 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:891
6762 "This command concatenates the list of C<words> passed with single spaces "
6763 "between them and returns the resulting string."
6767 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
6768 msgid "You can use this command to test the connection through to the daemon."
6772 #: ../src/guestfs-actions.pod:1341
6773 msgid "See also C<guestfs_ping_daemon>."
6777 #: ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:2073
6778 #: ../src/guestfs-actions.pod:5632
6779 msgid "(Added in 1.0.69)"
6783 #: ../src/guestfs-actions.pod:1348
6784 msgid "guestfs_egrep"
6788 #: ../src/guestfs-actions.pod:1350
6792 " guestfs_egrep (guestfs_h *g,\n"
6793 " const char *regex,\n"
6794 " const char *path);\n"
6799 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:902
6801 "This calls the external C<egrep> program and returns the matching lines."
6805 #: ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1384
6806 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1487
6807 #: ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:2173
6808 #: ../src/guestfs-actions.pod:2192 ../src/guestfs-actions.pod:2348
6809 #: ../src/guestfs-actions.pod:2361 ../src/guestfs-actions.pod:2376
6810 #: ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2444
6811 #: ../src/guestfs-actions.pod:2457 ../src/guestfs-actions.pod:3356
6812 #: ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:3383
6813 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:4301
6814 #: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5226
6815 #: ../src/guestfs-actions.pod:5996 ../src/guestfs-actions.pod:6008
6816 #: ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6034
6817 #: ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6069
6818 #: ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6095
6819 #: ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6875
6820 #: ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:6979
6821 #: ../src/guestfs-actions.pod:7025 ../src/guestfs-actions.pod:7044
6822 msgid "(Added in 1.0.66)"
6826 #: ../src/guestfs-actions.pod:1367
6827 msgid "guestfs_egrepi"
6831 #: ../src/guestfs-actions.pod:1369
6835 " guestfs_egrepi (guestfs_h *g,\n"
6836 " const char *regex,\n"
6837 " const char *path);\n"
6842 #: ../src/guestfs-actions.pod:1374 ../fish/guestfish-actions.pod:912
6844 "This calls the external C<egrep -i> program and returns the matching lines."
6848 #: ../src/guestfs-actions.pod:1386
6849 msgid "guestfs_equal"
6853 #: ../src/guestfs-actions.pod:1388
6857 " guestfs_equal (guestfs_h *g,\n"
6858 " const char *file1,\n"
6859 " const char *file2);\n"
6864 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:922
6866 "This compares the two files C<file1> and C<file2> and returns true if their "
6867 "content is exactly equal, or false otherwise."
6871 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
6872 msgid "The external L<cmp(1)> program is used for the comparison."
6876 #: ../src/guestfs-actions.pod:1402
6877 msgid "guestfs_exists"
6881 #: ../src/guestfs-actions.pod:1404
6885 " guestfs_exists (guestfs_h *g,\n"
6886 " const char *path);\n"
6891 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:931
6893 "This returns C<true> if and only if there is a file, directory (or anything) "
6894 "with the given C<path> name."
6898 #: ../src/guestfs-actions.pod:1411
6899 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6903 #: ../src/guestfs-actions.pod:1417
6904 msgid "guestfs_fallocate"
6908 #: ../src/guestfs-actions.pod:1419
6912 " guestfs_fallocate (guestfs_h *g,\n"
6913 " const char *path,\n"
6919 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1450
6920 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6922 "This command preallocates a file (containing zero bytes) named C<path> of "
6923 "size C<len> bytes. If the file exists already, it is overwritten."
6927 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:944
6929 "Do not confuse this with the guestfish-specific C<alloc> command which "
6930 "allocates a file in the host and attaches it as a device."
6934 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:948
6936 "This function is deprecated. In new code, use the C<fallocate64> call "
6941 #: ../src/guestfs-actions.pod:1443
6942 msgid "guestfs_fallocate64"
6946 #: ../src/guestfs-actions.pod:1445
6950 " guestfs_fallocate64 (guestfs_h *g,\n"
6951 " const char *path,\n"
6957 #: ../src/guestfs-actions.pod:1454
6959 "Note that this call allocates disk blocks for the file. To create a sparse "
6960 "file use C<guestfs_truncate_size> instead."
6964 #: ../src/guestfs-actions.pod:1457
6966 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6967 "oversight it only allowed 30 bit lengths to be specified, effectively "
6968 "limiting the maximum size of files created through that call to 1GB."
6972 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:971
6974 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6975 "commands which create a file in the host and attach it as a device."
6979 #: ../src/guestfs-actions.pod:1468
6980 msgid "(Added in 1.3.17)"
6984 #: ../src/guestfs-actions.pod:1470
6985 msgid "guestfs_fgrep"
6989 #: ../src/guestfs-actions.pod:1472
6993 " guestfs_fgrep (guestfs_h *g,\n"
6994 " const char *pattern,\n"
6995 " const char *path);\n"
7000 #: ../src/guestfs-actions.pod:1477 ../fish/guestfish-actions.pod:979
7002 "This calls the external C<fgrep> program and returns the matching lines."
7006 #: ../src/guestfs-actions.pod:1489
7007 msgid "guestfs_fgrepi"
7011 #: ../src/guestfs-actions.pod:1491
7015 " guestfs_fgrepi (guestfs_h *g,\n"
7016 " const char *pattern,\n"
7017 " const char *path);\n"
7022 #: ../src/guestfs-actions.pod:1496 ../fish/guestfish-actions.pod:989
7024 "This calls the external C<fgrep -i> program and returns the matching lines."
7028 #: ../src/guestfs-actions.pod:1508
7029 msgid "guestfs_file"
7033 #: ../src/guestfs-actions.pod:1510
7037 " guestfs_file (guestfs_h *g,\n"
7038 " const char *path);\n"
7043 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:999
7045 "This call uses the standard L<file(1)> command to determine the type or "
7046 "contents of the file."
7050 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
7052 "This call will also transparently look inside various types of compressed "
7057 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
7059 "The exact command which runs is C<file -zb path>. Note in particular that "
7060 "the filename is not prepended to the output (the C<-b> option)."
7064 #: ../src/guestfs-actions.pod:1524
7066 "This command can also be used on C</dev/> devices (and partitions, LV "
7067 "names). You can for example use this to determine if a device contains a "
7068 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7072 #: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1014
7074 "If the C<path> does not begin with C</dev/> then this command only works for "
7075 "the content of regular files. For other file types (directory, symbolic "
7076 "link etc) it will just return the string C<directory> etc."
7080 #: ../src/guestfs-actions.pod:1539
7081 msgid "guestfs_file_architecture"
7085 #: ../src/guestfs-actions.pod:1541
7089 " guestfs_file_architecture (guestfs_h *g,\n"
7090 " const char *filename);\n"
7095 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
7097 "This detects the architecture of the binary C<filename>, and returns it if "
7102 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
7103 msgid "Currently defined architectures are:"
7107 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7112 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
7114 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7115 "irrespective of the precise processor requirements of the binary."
7119 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7124 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7125 msgid "64 bit x86-64."
7129 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7134 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7135 msgid "32 bit SPARC."
7139 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7144 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7145 msgid "64 bit SPARC V9 and above."
7149 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7154 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7155 msgid "Intel Itanium."
7159 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7164 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7165 msgid "32 bit Power PC."
7169 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7174 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
7175 msgid "64 bit Power PC."
7179 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7180 msgid "Libguestfs may return other architecture strings in future."
7184 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
7185 msgid "The function works on at least the following types of files:"
7189 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
7190 msgid "many types of Un*x and Linux binary"
7194 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
7195 msgid "many types of Un*x and Linux shared library"
7199 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
7200 msgid "Windows Win32 and Win64 binaries"
7204 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7205 msgid "Windows Win32 and Win64 DLLs"
7209 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7210 msgid "Win32 binaries and DLLs return C<i386>."
7214 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
7215 msgid "Win64 binaries and DLLs return C<x86_64>."
7219 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
7220 msgid "Linux kernel modules"
7224 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
7225 msgid "Linux new-style initrd images"
7229 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
7230 msgid "some non-x86 Linux vmlinuz kernels"
7234 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
7235 msgid "What it can't do currently:"
7239 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
7240 msgid "static libraries (libfoo.a)"
7244 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
7245 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7249 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7250 msgid "x86 Linux vmlinuz kernels"
7254 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
7256 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7257 "compressed code, and are horribly hard to unpack. If you want to find the "
7258 "architecture of a kernel, use the architecture of the associated initrd or "
7259 "kernel module(s) instead."
7263 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812
7264 #: ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2480
7265 #: ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2587
7266 #: ../src/guestfs-actions.pod:2636 ../src/guestfs-actions.pod:2657
7267 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2774
7268 #: ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:3009
7269 #: ../src/guestfs-actions.pod:3141
7270 msgid "(Added in 1.5.3)"
7274 #: ../src/guestfs-actions.pod:1651
7275 msgid "guestfs_filesize"
7279 #: ../src/guestfs-actions.pod:1653
7283 " guestfs_filesize (guestfs_h *g,\n"
7284 " const char *file);\n"
7289 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
7290 msgid "This command returns the size of C<file> in bytes."
7294 #: ../src/guestfs-actions.pod:1659
7296 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7297 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7298 "devices, use C<guestfs_blockdev_getsize64>."
7302 #: ../src/guestfs-actions.pod:1665
7303 msgid "(Added in 1.0.82)"
7307 #: ../src/guestfs-actions.pod:1667
7308 msgid "guestfs_fill"
7312 #: ../src/guestfs-actions.pod:1669
7316 " guestfs_fill (guestfs_h *g,\n"
7319 " const char *path);\n"
7324 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
7326 "This command creates a new file called C<path>. The initial content of the "
7327 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7332 #: ../src/guestfs-actions.pod:1679
7334 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7335 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7336 "bytes use C<guestfs_fill_pattern>."
7340 #: ../src/guestfs-actions.pod:1691
7341 msgid "(Added in 1.0.79)"
7345 #: ../src/guestfs-actions.pod:1693
7346 msgid "guestfs_fill_pattern"
7350 #: ../src/guestfs-actions.pod:1695
7354 " guestfs_fill_pattern (guestfs_h *g,\n"
7355 " const char *pattern,\n"
7357 " const char *path);\n"
7362 #: ../src/guestfs-actions.pod:1701
7364 "This function is like C<guestfs_fill> except that it creates a new file of "
7365 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7366 "pattern is truncated if necessary to ensure the length of the file is "
7367 "exactly C<len> bytes."
7371 #: ../src/guestfs-actions.pod:1713
7372 msgid "(Added in 1.3.12)"
7376 #: ../src/guestfs-actions.pod:1715
7377 msgid "guestfs_find"
7381 #: ../src/guestfs-actions.pod:1717
7385 " guestfs_find (guestfs_h *g,\n"
7386 " const char *directory);\n"
7391 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7393 "This command lists out all files and directories, recursively, starting at "
7394 "C<directory>. It is essentially equivalent to running the shell command "
7395 "C<find directory -print> but some post-processing happens on the output, "
7400 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7402 "This returns a list of strings I<without any prefix>. Thus if the directory "
7407 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7417 #: ../src/guestfs-actions.pod:1733
7419 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7423 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7434 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7435 msgid "If C<directory> is not a directory, then this command returns an error."
7439 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7440 msgid "The returned list is sorted."
7444 #: ../src/guestfs-actions.pod:1746
7445 msgid "See also C<guestfs_find0>."
7449 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3800
7450 #: ../src/guestfs-actions.pod:5261
7451 msgid "(Added in 1.0.27)"
7455 #: ../src/guestfs-actions.pod:1757
7456 msgid "guestfs_find0"
7460 #: ../src/guestfs-actions.pod:1759
7464 " guestfs_find0 (guestfs_h *g,\n"
7465 " const char *directory,\n"
7466 " const char *files);\n"
7471 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7473 "This command lists out all files and directories, recursively, starting at "
7474 "C<directory>, placing the resulting list in the external file called "
7479 #: ../src/guestfs-actions.pod:1768
7481 "This command works the same way as C<guestfs_find> with the following "
7486 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7487 msgid "The resulting list is written to an external file."
7491 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7493 "Items (filenames) in the result are separated by C<\\0> characters. See "
7494 "L<find(1)> option I<-print0>."
7498 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7499 msgid "This command is not limited in the number of names that it can return."
7503 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7504 msgid "The result list is not sorted."
7508 #: ../src/guestfs-actions.pod:1795
7509 msgid "(Added in 1.0.74)"
7513 #: ../src/guestfs-actions.pod:1797
7514 msgid "guestfs_findfs_label"
7518 #: ../src/guestfs-actions.pod:1799
7522 " guestfs_findfs_label (guestfs_h *g,\n"
7523 " const char *label);\n"
7528 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
7530 "This command searches the filesystems and returns the one which has the "
7531 "given label. An error is returned if no such filesystem can be found."
7535 #: ../src/guestfs-actions.pod:1807
7536 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7540 #: ../src/guestfs-actions.pod:1814
7541 msgid "guestfs_findfs_uuid"
7545 #: ../src/guestfs-actions.pod:1816
7549 " guestfs_findfs_uuid (guestfs_h *g,\n"
7550 " const char *uuid);\n"
7555 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
7557 "This command searches the filesystems and returns the one which has the "
7558 "given UUID. An error is returned if no such filesystem can be found."
7562 #: ../src/guestfs-actions.pod:1824
7563 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7567 #: ../src/guestfs-actions.pod:1831
7568 msgid "guestfs_fsck"
7572 #: ../src/guestfs-actions.pod:1833
7576 " guestfs_fsck (guestfs_h *g,\n"
7577 " const char *fstype,\n"
7578 " const char *device);\n"
7583 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
7585 "This runs the filesystem checker (fsck) on C<device> which should have "
7586 "filesystem type C<fstype>."
7590 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
7592 "The returned integer is the status. See L<fsck(8)> for the list of status "
7593 "codes from C<fsck>."
7597 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
7598 msgid "Multiple status codes can be summed together."
7602 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
7604 "A non-zero return code can mean \"success\", for example if errors have been "
7605 "corrected on the filesystem."
7609 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
7610 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7614 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
7616 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7620 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:6898
7621 msgid "(Added in 1.0.16)"
7625 #: ../src/guestfs-actions.pod:1870
7626 msgid "guestfs_get_append"
7630 #: ../src/guestfs-actions.pod:1872
7634 " guestfs_get_append (guestfs_h *g);\n"
7639 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
7641 "Return the additional kernel options which are added to the guest kernel "
7646 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
7647 msgid "If C<NULL> then no options are added."
7651 #: ../src/guestfs-actions.pod:1880
7653 "This function returns a string which may be NULL. There is no way to return "
7654 "an error from this function. The string is owned by the guest handle and "
7655 "must I<not> be freed."
7659 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:4939
7660 #: ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5770
7661 #: ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5805
7662 #: ../src/guestfs-actions.pod:5822 ../src/guestfs-actions.pod:6569
7663 #: ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6941
7664 msgid "(Added in 1.0.26)"
7668 #: ../src/guestfs-actions.pod:1886
7669 msgid "guestfs_get_autosync"
7673 #: ../src/guestfs-actions.pod:1888
7677 " guestfs_get_autosync (guestfs_h *g);\n"
7682 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
7683 msgid "Get the autosync flag."
7687 #: ../src/guestfs-actions.pod:1897
7688 msgid "guestfs_get_direct"
7692 #: ../src/guestfs-actions.pod:1899
7696 " guestfs_get_direct (guestfs_h *g);\n"
7701 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
7702 msgid "Return the direct appliance mode flag."
7706 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5443
7707 msgid "(Added in 1.0.72)"
7711 #: ../src/guestfs-actions.pod:1908
7712 msgid "guestfs_get_e2label"
7716 #: ../src/guestfs-actions.pod:1910
7720 " guestfs_get_e2label (guestfs_h *g,\n"
7721 " const char *device);\n"
7726 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
7728 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7732 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1305
7734 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7738 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948
7739 #: ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:5480
7740 msgid "(Added in 1.0.15)"
7744 #: ../src/guestfs-actions.pod:1929
7745 msgid "guestfs_get_e2uuid"
7749 #: ../src/guestfs-actions.pod:1931
7753 " guestfs_get_e2uuid (guestfs_h *g,\n"
7754 " const char *device);\n"
7759 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
7761 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7765 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1319
7767 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7771 #: ../src/guestfs-actions.pod:1950
7772 msgid "guestfs_get_memsize"
7776 #: ../src/guestfs-actions.pod:1952
7780 " guestfs_get_memsize (guestfs_h *g);\n"
7785 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
7787 "This gets the memory size in megabytes allocated to the qemu subprocess."
7791 #: ../src/guestfs-actions.pod:1958
7793 "If C<guestfs_set_memsize> was not called on this handle, and if "
7794 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7795 "value for memsize."
7799 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043
7800 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5603
7801 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7802 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7804 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7808 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4091
7809 #: ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:4225
7810 #: ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4256
7811 #: ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4286
7812 #: ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5501
7813 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:6345
7814 msgid "(Added in 1.0.55)"
7818 #: ../src/guestfs-actions.pod:1969
7819 msgid "guestfs_get_network"
7823 #: ../src/guestfs-actions.pod:1971
7827 " guestfs_get_network (guestfs_h *g);\n"
7832 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
7833 msgid "This returns the enable network flag."
7837 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5520
7838 msgid "(Added in 1.5.4)"
7842 #: ../src/guestfs-actions.pod:1980
7843 msgid "guestfs_get_path"
7847 #: ../src/guestfs-actions.pod:1982
7851 " guestfs_get_path (guestfs_h *g);\n"
7856 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
7857 msgid "Return the current search path."
7861 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
7863 "This is always non-NULL. If it wasn't set already, then this will return "
7868 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
7870 "This function returns a string, or NULL on error. The string is owned by "
7871 "the guest handle and must I<not> be freed."
7875 #: ../src/guestfs-actions.pod:1995
7876 msgid "guestfs_get_pid"
7880 #: ../src/guestfs-actions.pod:1997
7884 " guestfs_get_pid (guestfs_h *g);\n"
7889 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
7891 "Return the process ID of the qemu subprocess. If there is no qemu "
7892 "subprocess, then this will return an error."
7896 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
7897 msgid "This is an internal call used for debugging and testing."
7901 #: ../src/guestfs-actions.pod:2007
7902 msgid "(Added in 1.0.56)"
7906 #: ../src/guestfs-actions.pod:2009
7907 msgid "guestfs_get_qemu"
7911 #: ../src/guestfs-actions.pod:2011
7915 " guestfs_get_qemu (guestfs_h *g);\n"
7920 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
7921 msgid "Return the current qemu binary."
7925 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
7927 "This is always non-NULL. If it wasn't set already, then this will return "
7928 "the default qemu binary name."
7932 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5565
7933 msgid "(Added in 1.0.6)"
7937 #: ../src/guestfs-actions.pod:2024
7938 msgid "guestfs_get_recovery_proc"
7942 #: ../src/guestfs-actions.pod:2026
7946 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7951 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
7952 msgid "Return the recovery process enabled flag."
7956 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3231
7957 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3898
7958 #: ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:4869
7959 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5589
7960 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6268
7961 #: ../src/guestfs-actions.pod:6450
7962 msgid "(Added in 1.0.77)"
7966 #: ../src/guestfs-actions.pod:2035
7967 msgid "guestfs_get_selinux"
7971 #: ../src/guestfs-actions.pod:2037
7975 " guestfs_get_selinux (guestfs_h *g);\n"
7980 #: ../src/guestfs-actions.pod:2040
7982 "This returns the current setting of the selinux flag which is passed to the "
7983 "appliance at boot time. See C<guestfs_set_selinux>."
7987 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111
7988 #: ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:5662
7989 msgid "(Added in 1.0.67)"
7993 #: ../src/guestfs-actions.pod:2050
7994 msgid "guestfs_get_state"
7998 #: ../src/guestfs-actions.pod:2052
8002 " guestfs_get_state (guestfs_h *g);\n"
8007 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
8009 "This returns the current state as an opaque integer. This is only useful "
8010 "for printing debug and internal error messages."
8014 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3034
8015 #: ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3124
8016 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1398
8017 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8018 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8019 msgid "For more information on states, see L<guestfs(3)>."
8023 #: ../src/guestfs-actions.pod:2064
8024 msgid "guestfs_get_trace"
8028 #: ../src/guestfs-actions.pod:2066
8032 " guestfs_get_trace (guestfs_h *g);\n"
8037 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
8038 msgid "Return the command trace flag."
8042 #: ../src/guestfs-actions.pod:2075
8043 msgid "guestfs_get_umask"
8047 #: ../src/guestfs-actions.pod:2077
8051 " guestfs_get_umask (guestfs_h *g);\n"
8056 #: ../src/guestfs-actions.pod:2080
8058 "Return the current umask. By default the umask is C<022> unless it has been "
8059 "set by calling C<guestfs_umask>."
8063 #: ../src/guestfs-actions.pod:2087
8064 msgid "guestfs_get_verbose"
8068 #: ../src/guestfs-actions.pod:2089
8072 " guestfs_get_verbose (guestfs_h *g);\n"
8077 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
8078 msgid "This returns the verbose messages flag."
8082 #: ../src/guestfs-actions.pod:2098
8083 msgid "guestfs_getcon"
8087 #: ../src/guestfs-actions.pod:2100
8091 " guestfs_getcon (guestfs_h *g);\n"
8096 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
8097 msgid "This gets the SELinux security context of the daemon."
8101 #: ../src/guestfs-actions.pod:2105
8103 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8107 #: ../src/guestfs-actions.pod:2113
8108 msgid "guestfs_getxattrs"
8112 #: ../src/guestfs-actions.pod:2115
8115 " struct guestfs_xattr_list *\n"
8116 " guestfs_getxattrs (guestfs_h *g,\n"
8117 " const char *path);\n"
8122 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1432
8124 "This call lists the extended attributes of the file or directory C<path>."
8128 #: ../src/guestfs-actions.pod:2122 ../fish/guestfish-actions.pod:1435
8130 "At the system call level, this is a combination of the L<listxattr(2)> and "
8131 "L<getxattr(2)> calls."
8135 #: ../src/guestfs-actions.pod:2125
8136 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8140 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3243
8141 #: ../src/guestfs-actions.pod:3894
8143 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8144 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8148 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:3247
8149 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3448
8150 #: ../src/guestfs-actions.pod:5242 ../src/guestfs-actions.pod:5681
8151 #: ../src/guestfs-actions.pod:7006
8152 msgid "(Added in 1.0.59)"
8156 #: ../src/guestfs-actions.pod:2133
8157 msgid "guestfs_glob_expand"
8161 #: ../src/guestfs-actions.pod:2135
8165 " guestfs_glob_expand (guestfs_h *g,\n"
8166 " const char *pattern);\n"
8171 #: ../src/guestfs-actions.pod:2139 ../fish/guestfish-actions.pod:1444
8173 "This command searches for all the pathnames matching C<pattern> according to "
8174 "the wildcard expansion rules used by the shell."
8178 #: ../src/guestfs-actions.pod:2143 ../fish/guestfish-actions.pod:1448
8180 "If no paths match, then this returns an empty list (note: not an error)."
8184 #: ../src/guestfs-actions.pod:2146 ../fish/guestfish-actions.pod:1451
8186 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8187 "GLOB_BRACE>. See that manual page for more details."
8191 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:5846
8192 #: ../src/guestfs-actions.pod:5863
8193 msgid "(Added in 1.0.50)"
8197 #: ../src/guestfs-actions.pod:2156
8198 msgid "guestfs_grep"
8202 #: ../src/guestfs-actions.pod:2158
8206 " guestfs_grep (guestfs_h *g,\n"
8207 " const char *regex,\n"
8208 " const char *path);\n"
8213 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1459
8214 msgid "This calls the external C<grep> program and returns the matching lines."
8218 #: ../src/guestfs-actions.pod:2175
8219 msgid "guestfs_grepi"
8223 #: ../src/guestfs-actions.pod:2177
8227 " guestfs_grepi (guestfs_h *g,\n"
8228 " const char *regex,\n"
8229 " const char *path);\n"
8234 #: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1469
8236 "This calls the external C<grep -i> program and returns the matching lines."
8240 #: ../src/guestfs-actions.pod:2194
8241 msgid "guestfs_grub_install"
8245 #: ../src/guestfs-actions.pod:2196
8249 " guestfs_grub_install (guestfs_h *g,\n"
8250 " const char *root,\n"
8251 " const char *device);\n"
8256 #: ../src/guestfs-actions.pod:2201 ../fish/guestfish-actions.pod:1479
8258 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8259 "the root directory being C<root>."
8263 #: ../src/guestfs-actions.pod:2204 ../fish/guestfish-actions.pod:1482
8265 "Note: If grub-install reports the error \"No suitable drive was found in the "
8266 "generated device map.\" it may be that you need to create a C</boot/grub/"
8267 "device.map> file first that contains the mapping between grub device names "
8268 "and Linux device names. It is usually sufficient to create a file "
8273 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1489
8281 #: ../src/guestfs-actions.pod:2213 ../fish/guestfish-actions.pod:1491
8282 msgid "replacing C</dev/vda> with the name of the installation device."
8286 #: ../src/guestfs-actions.pod:2217
8287 msgid "(Added in 1.0.17)"
8291 #: ../src/guestfs-actions.pod:2219
8292 msgid "guestfs_head"
8296 #: ../src/guestfs-actions.pod:2221
8300 " guestfs_head (guestfs_h *g,\n"
8301 " const char *path);\n"
8306 #: ../src/guestfs-actions.pod:2225 ../fish/guestfish-actions.pod:1497
8308 "This command returns up to the first 10 lines of a file as a list of strings."
8312 #: ../src/guestfs-actions.pod:2237
8313 msgid "guestfs_head_n"
8317 #: ../src/guestfs-actions.pod:2239
8321 " guestfs_head_n (guestfs_h *g,\n"
8323 " const char *path);\n"
8328 #: ../src/guestfs-actions.pod:2244 ../fish/guestfish-actions.pod:1507
8330 "If the parameter C<nrlines> is a positive number, this returns the first "
8331 "C<nrlines> lines of the file C<path>."
8335 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
8337 "If the parameter C<nrlines> is a negative number, this returns lines from "
8338 "the file C<path>, excluding the last C<nrlines> lines."
8342 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:6143
8343 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8344 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8348 #: ../src/guestfs-actions.pod:2261
8349 msgid "guestfs_hexdump"
8353 #: ../src/guestfs-actions.pod:2263
8357 " guestfs_hexdump (guestfs_h *g,\n"
8358 " const char *path);\n"
8363 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
8365 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8366 "readable, canonical hex dump of the file."
8370 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:5927
8371 #: ../src/guestfs-actions.pod:5982
8372 msgid "(Added in 1.0.22)"
8376 #: ../src/guestfs-actions.pod:2278
8377 msgid "guestfs_initrd_cat"
8381 #: ../src/guestfs-actions.pod:2280
8385 " guestfs_initrd_cat (guestfs_h *g,\n"
8386 " const char *initrdpath,\n"
8387 " const char *filename,\n"
8388 " size_t *size_r);\n"
8393 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1532
8395 "This command unpacks the file C<filename> from the initrd file called "
8396 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8401 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1536
8403 "For example, in guestfish you could use the following command to examine the "
8404 "boot script (usually called C</init>) contained in a Linux initrd or "
8409 #: ../src/guestfs-actions.pod:2294 ../fish/guestfish-actions.pod:1540
8412 " initrd-cat /boot/initrd-<version>.img init\n"
8417 #: ../src/guestfs-actions.pod:2296
8418 msgid "See also C<guestfs_initrd_list>."
8422 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:4862
8423 #: ../src/guestfs-actions.pod:4888 ../src/guestfs-actions.pod:5069
8425 "This function returns a buffer, or NULL on error. The size of the returned "
8426 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8431 #: ../src/guestfs-actions.pod:2307
8432 msgid "guestfs_initrd_list"
8436 #: ../src/guestfs-actions.pod:2309
8440 " guestfs_initrd_list (guestfs_h *g,\n"
8441 " const char *path);\n"
8446 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1551
8447 msgid "This command lists out files contained in an initrd."
8451 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1553
8453 "The files are listed without any initial C</> character. The files are "
8454 "listed in the order they appear (not necessarily alphabetical). Directory "
8455 "names are listed as separate items."
8459 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1557
8461 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8462 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8467 #: ../src/guestfs-actions.pod:2329
8468 msgid "guestfs_inotify_add_watch"
8472 #: ../src/guestfs-actions.pod:2331
8476 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8477 " const char *path,\n"
8483 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1565
8484 msgid "Watch C<path> for the events listed in C<mask>."
8488 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1567
8490 "Note that if C<path> is a directory then events within that directory are "
8491 "watched, but this does I<not> happen recursively (in subdirectories)."
8495 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1571
8497 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8498 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8502 #: ../src/guestfs-actions.pod:2350
8503 msgid "guestfs_inotify_close"
8507 #: ../src/guestfs-actions.pod:2352
8511 " guestfs_inotify_close (guestfs_h *g);\n"
8516 #: ../src/guestfs-actions.pod:2355 ../fish/guestfish-actions.pod:1579
8518 "This closes the inotify handle which was previously opened by inotify_init. "
8519 "It removes all watches, throws away any pending events, and deallocates all "
8524 #: ../src/guestfs-actions.pod:2363
8525 msgid "guestfs_inotify_files"
8529 #: ../src/guestfs-actions.pod:2365
8533 " guestfs_inotify_files (guestfs_h *g);\n"
8538 #: ../src/guestfs-actions.pod:2368
8540 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8541 "returns a list of pathnames of objects that were touched. The returned "
8542 "pathnames are sorted and deduplicated."
8546 #: ../src/guestfs-actions.pod:2378
8547 msgid "guestfs_inotify_init"
8551 #: ../src/guestfs-actions.pod:2380
8555 " guestfs_inotify_init (guestfs_h *g,\n"
8556 " int maxevents);\n"
8561 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1595
8563 "This command creates a new inotify handle. The inotify subsystem can be "
8564 "used to notify events which happen to objects in the guest filesystem."
8568 #: ../src/guestfs-actions.pod:2388
8570 "C<maxevents> is the maximum number of events which will be queued up between "
8571 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8572 "passed as C<0>, then the kernel (or previously set) default is used. For "
8573 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8574 "throws away events, but records the fact that it threw them away by setting "
8575 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8576 "C<guestfs_inotify_read>)."
8580 #: ../src/guestfs-actions.pod:2398
8582 "Before any events are generated, you have to add some watches to the "
8583 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8584 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8588 #: ../src/guestfs-actions.pod:2404
8590 "Queued up events should be read periodically by calling "
8591 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8592 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8593 "often enough then you risk the internal queue overflowing."
8597 #: ../src/guestfs-actions.pod:2411
8599 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8600 "This also removes any watches automatically."
8604 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1626
8606 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8607 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8608 "that there is one global inotify handle per libguestfs instance."
8612 #: ../src/guestfs-actions.pod:2424
8613 msgid "guestfs_inotify_read"
8617 #: ../src/guestfs-actions.pod:2426
8620 " struct guestfs_inotify_event_list *\n"
8621 " guestfs_inotify_read (guestfs_h *g);\n"
8626 #: ../src/guestfs-actions.pod:2429 ../fish/guestfish-actions.pod:1635
8628 "Return the complete queue of events that have happened since the previous "
8633 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1638
8634 msgid "If no events have happened, this returns an empty list."
8638 #: ../src/guestfs-actions.pod:2434 ../fish/guestfish-actions.pod:1640
8640 "I<Note>: In order to make sure that all events have been read, you must call "
8641 "this function repeatedly until it returns an empty list. The reason is that "
8642 "the call will read events up to the maximum appliance-to-host message size "
8643 "and leave remaining events in the queue."
8647 #: ../src/guestfs-actions.pod:2440
8649 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8650 "there was an error. I<The caller must call "
8651 "C<guestfs_free_inotify_event_list> after use>."
8655 #: ../src/guestfs-actions.pod:2446
8656 msgid "guestfs_inotify_rm_watch"
8660 #: ../src/guestfs-actions.pod:2448
8664 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8670 #: ../src/guestfs-actions.pod:2452
8672 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8676 #: ../src/guestfs-actions.pod:2459
8677 msgid "guestfs_inspect_get_arch"
8681 #: ../src/guestfs-actions.pod:2461
8685 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8686 " const char *root);\n"
8691 #: ../src/guestfs-actions.pod:2465 ../src/guestfs-actions.pod:2488
8692 #: ../src/guestfs-actions.pod:2569 ../src/guestfs-actions.pod:2595
8693 #: ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2644
8694 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:2698
8695 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2758
8696 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2844
8697 #: ../src/guestfs-actions.pod:2867
8699 "This function should only be called with a root device string as returned by "
8700 "C<guestfs_inspect_os>."
8704 #: ../src/guestfs-actions.pod:2468
8706 "This returns the architecture of the inspected operating system. The "
8707 "possible return values are listed under C<guestfs_file_architecture>."
8711 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1664
8713 "If the architecture could not be determined, then the string C<unknown> is "
8718 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
8719 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2632
8720 #: ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2745
8721 #: ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2788
8722 #: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2854
8723 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3001
8724 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8725 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8726 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8727 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8728 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8729 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8730 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8734 #: ../src/guestfs-actions.pod:2482
8735 msgid "guestfs_inspect_get_distro"
8739 #: ../src/guestfs-actions.pod:2484
8743 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8744 " const char *root);\n"
8749 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
8751 "This returns the distro (distribution) of the inspected operating system."
8755 #: ../src/guestfs-actions.pod:2494 ../fish/guestfish-actions.pod:1679
8756 msgid "Currently defined distros are:"
8760 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1683
8761 msgid "\"archlinux\""
8765 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1685
8770 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1687
8775 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1689
8780 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1691
8785 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1693
8790 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1695
8795 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1697
8800 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1699
8801 msgid "\"linuxmint\""
8805 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1701
8810 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1703
8811 msgid "\"mandriva\""
8815 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1705
8820 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1707
8825 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1709
8830 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1711
8835 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1713
8840 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1715
8841 msgid "\"redhat-based\""
8845 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1717
8846 msgid "Some Red Hat-derived distro."
8850 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1719
8855 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1721
8856 msgid "Red Hat Enterprise Linux and some derivatives."
8860 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1723
8865 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1725
8870 #: ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2822
8871 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8876 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1729
8877 msgid "The distro could not be determined."
8881 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2814
8882 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8887 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1733
8889 "Windows does not have distributions. This string is returned if the OS type "
8894 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2828
8895 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8897 "Future versions of libguestfs may return other strings here. The caller "
8898 "should be prepared to handle any string."
8902 #: ../src/guestfs-actions.pod:2563
8903 msgid "guestfs_inspect_get_filesystems"
8907 #: ../src/guestfs-actions.pod:2565
8911 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8912 " const char *root);\n"
8917 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1750
8919 "This returns a list of all the filesystems that we think are associated with "
8920 "this operating system. This includes the root filesystem, other ordinary "
8921 "filesystems, and non-mounted devices like swap partitions."
8925 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1755
8927 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8928 "to be shared between operating systems."
8932 #: ../src/guestfs-actions.pod:2580
8934 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8935 "C<guestfs_inspect_get_mountpoints>."
8939 #: ../src/guestfs-actions.pod:2589
8940 msgid "guestfs_inspect_get_hostname"
8944 #: ../src/guestfs-actions.pod:2591
8948 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8949 " const char *root);\n"
8954 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1768
8956 "This function returns the hostname of the operating system as found by "
8957 "inspection of the guest's configuration files."
8961 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1771
8963 "If the hostname could not be determined, then the string C<unknown> is "
8968 #: ../src/guestfs-actions.pod:2609
8969 msgid "(Added in 1.7.9)"
8973 #: ../src/guestfs-actions.pod:2611
8974 msgid "guestfs_inspect_get_major_version"
8978 #: ../src/guestfs-actions.pod:2613
8982 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8983 " const char *root);\n"
8988 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1783
8990 "This returns the major version number of the inspected operating system."
8994 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
8996 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8997 "popular public names used by the operating system. Notably the operating "
8998 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8999 "1). You can find out the real versions corresponding to releases of Windows "
9000 "by consulting Wikipedia or MSDN."
9004 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2650
9005 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
9006 msgid "If the version could not be determined, then C<0> is returned."
9010 #: ../src/guestfs-actions.pod:2638
9011 msgid "guestfs_inspect_get_minor_version"
9015 #: ../src/guestfs-actions.pod:2640
9019 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9020 " const char *root);\n"
9025 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
9027 "This returns the minor version number of the inspected operating system."
9031 #: ../src/guestfs-actions.pod:2652
9033 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9034 "C<guestfs_inspect_get_major_version>."
9038 #: ../src/guestfs-actions.pod:2659
9039 msgid "guestfs_inspect_get_mountpoints"
9043 #: ../src/guestfs-actions.pod:2661
9047 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9048 " const char *root);\n"
9053 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1819
9055 "This returns a hash of where we think the filesystems associated with this "
9056 "operating system should be mounted. Callers should note that this is at "
9057 "best an educated guess made by reading configuration files such as C</etc/"
9062 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1824
9064 "Each element in the returned hashtable has a key which is the path of the "
9065 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9066 "mounted there (eg. C</dev/sda1>)."
9070 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1829
9072 "Non-mounted devices such as swap devices are I<not> returned in this list."
9076 #: ../src/guestfs-actions.pod:2681
9078 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9079 "C<guestfs_inspect_get_filesystems>."
9083 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:3300
9084 #: ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:6284
9086 "This function returns a NULL-terminated array of strings, or NULL if there "
9087 "was an error. The array of strings will always have length C<2n+1>, where "
9088 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9089 "caller must free the strings and the array after use>."
9093 #: ../src/guestfs-actions.pod:2692
9094 msgid "guestfs_inspect_get_package_format"
9098 #: ../src/guestfs-actions.pod:2694
9102 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9103 " const char *root);\n"
9108 #: ../src/guestfs-actions.pod:2701
9110 "This function and C<guestfs_inspect_get_package_management> return the "
9111 "package format and package management tool used by the inspected operating "
9112 "system. For example for Fedora these functions would return C<rpm> (package "
9113 "format) and C<yum> (package management)."
9117 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
9119 "This returns the string C<unknown> if we could not determine the package "
9120 "format I<or> if the operating system does not have a real packaging system "
9125 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
9127 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9128 "Future versions of libguestfs may return other strings."
9132 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2750
9133 msgid "(Added in 1.7.5)"
9137 #: ../src/guestfs-actions.pod:2721
9138 msgid "guestfs_inspect_get_package_management"
9142 #: ../src/guestfs-actions.pod:2723
9146 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9147 " const char *root);\n"
9152 #: ../src/guestfs-actions.pod:2730
9154 "C<guestfs_inspect_get_package_format> and this function return the package "
9155 "format and package management tool used by the inspected operating system. "
9156 "For example for Fedora these functions would return C<rpm> (package format) "
9157 "and C<yum> (package management)."
9161 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1870
9163 "This returns the string C<unknown> if we could not determine the package "
9164 "management tool I<or> if the operating system does not have a real packaging "
9165 "system (eg. Windows)."
9169 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1874
9171 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9172 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9173 "libguestfs may return other strings."
9177 #: ../src/guestfs-actions.pod:2752
9178 msgid "guestfs_inspect_get_product_name"
9182 #: ../src/guestfs-actions.pod:2754
9186 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9187 " const char *root);\n"
9192 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1888
9194 "This returns the product name of the inspected operating system. The "
9195 "product name is generally some freeform string which can be displayed to the "
9196 "user, but should not be parsed by programs."
9200 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1893
9202 "If the product name could not be determined, then the string C<unknown> is "
9207 #: ../src/guestfs-actions.pod:2776
9208 msgid "guestfs_inspect_get_roots"
9212 #: ../src/guestfs-actions.pod:2778
9216 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9221 #: ../src/guestfs-actions.pod:2781
9223 "This function is a convenient way to get the list of root devices, as "
9224 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9225 "the whole inspection process."
9229 #: ../src/guestfs-actions.pod:2785
9231 "This returns an empty list if either no root devices were found or the "
9232 "caller has not called C<guestfs_inspect_os>."
9236 #: ../src/guestfs-actions.pod:2794
9237 msgid "(Added in 1.7.3)"
9241 #: ../src/guestfs-actions.pod:2796
9242 msgid "guestfs_inspect_get_type"
9246 #: ../src/guestfs-actions.pod:2798
9250 " guestfs_inspect_get_type (guestfs_h *g,\n"
9251 " const char *root);\n"
9256 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
9258 "This returns the type of the inspected operating system. Currently defined "
9263 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1923
9268 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
9269 msgid "Any Linux-based operating system."
9273 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1929
9274 msgid "Any Microsoft Windows operating system."
9278 #: ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1931
9283 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1933
9288 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1937
9289 msgid "The operating system type could not be determined."
9293 #: ../src/guestfs-actions.pod:2838
9294 msgid "guestfs_inspect_get_windows_systemroot"
9298 #: ../src/guestfs-actions.pod:2840
9302 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9303 " const char *root);\n"
9308 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1953
9310 "This returns the Windows systemroot of the inspected guest. The systemroot "
9311 "is a directory path such as C</WINDOWS>."
9315 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1956
9317 "This call assumes that the guest is Windows and that the systemroot could be "
9318 "determined by inspection. If this is not the case then an error is returned."
9322 #: ../src/guestfs-actions.pod:2859
9323 msgid "(Added in 1.5.25)"
9327 #: ../src/guestfs-actions.pod:2861
9328 msgid "guestfs_inspect_list_applications"
9332 #: ../src/guestfs-actions.pod:2863
9335 " struct guestfs_application_list *\n"
9336 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9337 " const char *root);\n"
9342 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1969
9343 msgid "Return the list of applications installed in the operating system."
9347 #: ../src/guestfs-actions.pod:2872
9349 "I<Note:> This call works differently from other parts of the inspection "
9350 "API. You have to call C<guestfs_inspect_os>, then "
9351 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9352 "this. Listing applications is a significantly more difficult operation "
9353 "which requires access to the full filesystem. Also note that unlike the "
9354 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9355 "the libguestfs handle, this call actually reads parts of the mounted "
9356 "filesystems during the call."
9360 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1981
9362 "This returns an empty list if the inspection code was not able to determine "
9363 "the list of applications."
9367 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:1984
9368 msgid "The application structure contains the following fields:"
9372 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1988
9377 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1990
9379 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9380 "guests, this is the package name."
9384 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1993
9385 msgid "C<app_display_name>"
9389 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1995
9391 "The display name of the application, sometimes localized to the install "
9392 "language of the guest operating system."
9396 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1998
9398 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9399 "to display something can use C<app_name> instead."
9403 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2001
9404 msgid "C<app_epoch>"
9408 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2003
9410 "For package managers which use epochs, this contains the epoch of the "
9411 "package (an integer). If unavailable, this is returned as C<0>."
9415 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2006
9416 msgid "C<app_version>"
9420 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2008
9422 "The version string of the application or package. If unavailable this is "
9423 "returned as an empty string C<\"\">."
9427 #: ../src/guestfs-actions.pod:2912 ../fish/guestfish-actions.pod:2011
9428 msgid "C<app_release>"
9432 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2013
9434 "The release string of the application or package, for package managers that "
9435 "use this. If unavailable this is returned as an empty string C<\"\">."
9439 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2017
9440 msgid "C<app_install_path>"
9444 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2019
9446 "The installation path of the application (on operating systems such as "
9447 "Windows which use installation paths). This path is in the format used by "
9448 "the guest operating system, it is not a libguestfs path."
9452 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2024
9453 msgid "If unavailable this is returned as an empty string C<\"\">."
9457 #: ../src/guestfs-actions.pod:2927 ../fish/guestfish-actions.pod:2026
9458 msgid "C<app_trans_path>"
9462 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2028
9464 "The install path translated into a libguestfs path. If unavailable this is "
9465 "returned as an empty string C<\"\">."
9469 #: ../src/guestfs-actions.pod:2932 ../fish/guestfish-actions.pod:2031
9470 msgid "C<app_publisher>"
9474 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2033
9476 "The name of the publisher of the application, for package managers that use "
9477 "this. If unavailable this is returned as an empty string C<\"\">."
9481 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2037
9486 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2039
9488 "The URL (eg. upstream URL) of the application. If unavailable this is "
9489 "returned as an empty string C<\"\">."
9493 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2042
9494 msgid "C<app_source_package>"
9498 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2044
9500 "For packaging systems which support this, the name of the source package. "
9501 "If unavailable this is returned as an empty string C<\"\">."
9505 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2047
9506 msgid "C<app_summary>"
9510 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2049
9512 "A short (usually one line) description of the application or package. If "
9513 "unavailable this is returned as an empty string C<\"\">."
9517 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2052
9518 msgid "C<app_description>"
9522 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2054
9524 "A longer description of the application or package. If unavailable this is "
9525 "returned as an empty string C<\"\">."
9529 #: ../src/guestfs-actions.pod:2962
9531 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9532 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9537 #: ../src/guestfs-actions.pod:2966
9538 msgid "(Added in 1.7.8)"
9542 #: ../src/guestfs-actions.pod:2968
9543 msgid "guestfs_inspect_os"
9547 #: ../src/guestfs-actions.pod:2970
9551 " guestfs_inspect_os (guestfs_h *g);\n"
9556 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2065
9558 "This function uses other libguestfs functions and certain heuristics to "
9559 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9560 "for operating systems."
9564 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2069
9565 msgid "The list returned is empty if no operating systems were found."
9569 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2071
9571 "If one operating system was found, then this returns a list with a single "
9572 "element, which is the name of the root filesystem of this operating system. "
9573 "It is also possible for this function to return a list containing more than "
9574 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9575 "element being the root filesystem of one of the operating systems."
9579 #: ../src/guestfs-actions.pod:2986
9581 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9582 "functions in order to query further information about each operating system, "
9583 "such as the name and version."
9587 #: ../src/guestfs-actions.pod:2991
9589 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9590 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9591 "the contents. This should be called with no disks currently mounted. The "
9592 "function may also use Augeas, so any existing Augeas handle will be closed."
9596 #: ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:2089
9598 "This function cannot decrypt encrypted disks. The caller must do that first "
9599 "(supplying the necessary keys) if the disk is encrypted."
9603 #: ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3258
9604 #: ../src/guestfs-actions.pod:3320
9605 msgid "See also C<guestfs_list_filesystems>."
9609 #: ../src/guestfs-actions.pod:3011
9610 msgid "guestfs_is_blockdev"
9614 #: ../src/guestfs-actions.pod:3013
9618 " guestfs_is_blockdev (guestfs_h *g,\n"
9619 " const char *path);\n"
9624 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2101
9626 "This returns C<true> if and only if there is a block device with the given "
9631 #: ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3049
9632 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3094
9633 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3166
9634 #: ../src/guestfs-actions.pod:3181
9635 msgid "See also C<guestfs_stat>."
9639 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3053
9640 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3170
9641 #: ../src/guestfs-actions.pod:3185
9642 msgid "(Added in 1.5.10)"
9646 #: ../src/guestfs-actions.pod:3026
9647 msgid "guestfs_is_busy"
9651 #: ../src/guestfs-actions.pod:3028
9655 " guestfs_is_busy (guestfs_h *g);\n"
9660 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2110
9662 "This returns true iff this handle is busy processing a command (in the "
9667 #: ../src/guestfs-actions.pod:3040
9668 msgid "guestfs_is_chardev"
9672 #: ../src/guestfs-actions.pod:3042
9676 " guestfs_is_chardev (guestfs_h *g,\n"
9677 " const char *path);\n"
9682 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2119
9684 "This returns C<true> if and only if there is a character device with the "
9685 "given C<path> name."
9689 #: ../src/guestfs-actions.pod:3055
9690 msgid "guestfs_is_config"
9694 #: ../src/guestfs-actions.pod:3057
9698 " guestfs_is_config (guestfs_h *g);\n"
9703 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2128
9705 "This returns true iff this handle is being configured (in the C<CONFIG> "
9710 #: ../src/guestfs-actions.pod:3069
9711 msgid "guestfs_is_dir"
9715 #: ../src/guestfs-actions.pod:3071
9719 " guestfs_is_dir (guestfs_h *g,\n"
9720 " const char *path);\n"
9725 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2137
9727 "This returns C<true> if and only if there is a directory with the given "
9728 "C<path> name. Note that it returns false for other objects like files."
9732 #: ../src/guestfs-actions.pod:3085
9733 msgid "guestfs_is_fifo"
9737 #: ../src/guestfs-actions.pod:3087
9741 " guestfs_is_fifo (guestfs_h *g,\n"
9742 " const char *path);\n"
9747 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2147
9749 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9750 "given C<path> name."
9754 #: ../src/guestfs-actions.pod:3100
9755 msgid "guestfs_is_file"
9759 #: ../src/guestfs-actions.pod:3102
9763 " guestfs_is_file (guestfs_h *g,\n"
9764 " const char *path);\n"
9769 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2156
9771 "This returns C<true> if and only if there is a regular file with the given "
9772 "C<path> name. Note that it returns false for other objects like directories."
9776 #: ../src/guestfs-actions.pod:3116
9777 msgid "guestfs_is_launching"
9781 #: ../src/guestfs-actions.pod:3118
9785 " guestfs_is_launching (guestfs_h *g);\n"
9790 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2166
9792 "This returns true iff this handle is launching the subprocess (in the "
9793 "C<LAUNCHING> state)."
9797 #: ../src/guestfs-actions.pod:3130
9798 msgid "guestfs_is_lv"
9802 #: ../src/guestfs-actions.pod:3132
9806 " guestfs_is_lv (guestfs_h *g,\n"
9807 " const char *device);\n"
9812 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2175
9814 "This command tests whether C<device> is a logical volume, and returns true "
9815 "iff this is the case."
9819 #: ../src/guestfs-actions.pod:3143
9820 msgid "guestfs_is_ready"
9824 #: ../src/guestfs-actions.pod:3145
9828 " guestfs_is_ready (guestfs_h *g);\n"
9833 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2182
9835 "This returns true iff this handle is ready to accept commands (in the "
9840 #: ../src/guestfs-actions.pod:3157
9841 msgid "guestfs_is_socket"
9845 #: ../src/guestfs-actions.pod:3159
9849 " guestfs_is_socket (guestfs_h *g,\n"
9850 " const char *path);\n"
9855 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2191
9857 "This returns C<true> if and only if there is a Unix domain socket with the "
9858 "given C<path> name."
9862 #: ../src/guestfs-actions.pod:3172
9863 msgid "guestfs_is_symlink"
9867 #: ../src/guestfs-actions.pod:3174
9871 " guestfs_is_symlink (guestfs_h *g,\n"
9872 " const char *path);\n"
9877 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2200
9879 "This returns C<true> if and only if there is a symbolic link with the given "
9884 #: ../src/guestfs-actions.pod:3187
9885 msgid "guestfs_kill_subprocess"
9889 #: ../src/guestfs-actions.pod:3189
9893 " guestfs_kill_subprocess (guestfs_h *g);\n"
9898 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2209
9899 msgid "This kills the qemu subprocess. You should never need to call this."
9903 #: ../src/guestfs-actions.pod:3198
9904 msgid "guestfs_launch"
9908 #: ../src/guestfs-actions.pod:3200
9912 " guestfs_launch (guestfs_h *g);\n"
9917 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2217
9919 "Internally libguestfs is implemented by running a virtual machine using "
9924 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2220
9926 "You should call this after configuring the handle (eg. adding drives) but "
9927 "before performing any actions."
9931 #: ../src/guestfs-actions.pod:3213
9932 msgid "guestfs_lchown"
9936 #: ../src/guestfs-actions.pod:3215
9940 " guestfs_lchown (guestfs_h *g,\n"
9943 " const char *path);\n"
9948 #: ../src/guestfs-actions.pod:3221
9950 "Change the file owner to C<owner> and group to C<group>. This is like "
9951 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9952 "changed, not the target."
9956 #: ../src/guestfs-actions.pod:3233
9957 msgid "guestfs_lgetxattrs"
9961 #: ../src/guestfs-actions.pod:3235
9964 " struct guestfs_xattr_list *\n"
9965 " guestfs_lgetxattrs (guestfs_h *g,\n"
9966 " const char *path);\n"
9971 #: ../src/guestfs-actions.pod:3239
9973 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9974 "then it returns the extended attributes of the link itself."
9978 #: ../src/guestfs-actions.pod:3249
9979 msgid "guestfs_list_devices"
9983 #: ../src/guestfs-actions.pod:3251
9987 " guestfs_list_devices (guestfs_h *g);\n"
9992 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2247
9993 msgid "List all the block devices."
9997 #: ../src/guestfs-actions.pod:3256 ../fish/guestfish-actions.pod:2249
9998 msgid "The full block device names are returned, eg. C</dev/sda>."
10002 #: ../src/guestfs-actions.pod:3266
10003 msgid "guestfs_list_filesystems"
10007 #: ../src/guestfs-actions.pod:3268
10011 " guestfs_list_filesystems (guestfs_h *g);\n"
10016 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2257
10018 "This inspection command looks for filesystems on partitions, block devices "
10019 "and logical volumes, returning a list of devices containing filesystems and "
10024 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2261
10026 "The return value is a hash, where the keys are the devices containing "
10027 "filesystems, and the values are the filesystem types. For example:"
10031 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2265
10034 " \"/dev/sda1\" => \"ntfs\"\n"
10035 " \"/dev/sda2\" => \"ext2\"\n"
10036 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10037 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10042 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2270
10044 "The value can have the special value \"unknown\", meaning the content of the "
10045 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10049 #: ../src/guestfs-actions.pod:3288
10051 "This command runs other libguestfs commands, which might include "
10052 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10053 "soon after launch and only when nothing is mounted."
10057 #: ../src/guestfs-actions.pod:3292
10059 "Not all of the filesystems returned will be mountable. In particular, swap "
10060 "partitions are returned in the list. Also this command does not check that "
10061 "each filesystem found is valid and mountable, and some filesystems might be "
10062 "mountable but require special options. Filesystems may not all belong to a "
10063 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10067 #: ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:4829
10068 msgid "(Added in 1.5.15)"
10072 #: ../src/guestfs-actions.pod:3308
10073 msgid "guestfs_list_partitions"
10077 #: ../src/guestfs-actions.pod:3310
10081 " guestfs_list_partitions (guestfs_h *g);\n"
10086 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2290
10087 msgid "List all the partitions detected on all block devices."
10091 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2292
10092 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10096 #: ../src/guestfs-actions.pod:3317
10098 "This does not return logical volumes. For that you will need to call "
10103 #: ../src/guestfs-actions.pod:3328
10108 #: ../src/guestfs-actions.pod:3330
10112 " guestfs_ll (guestfs_h *g,\n"
10113 " const char *directory);\n"
10118 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2303
10120 "List the files in C<directory> (relative to the root directory, there is no "
10121 "cwd) in the format of 'ls -la'."
10125 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2306
10127 "This command is mostly useful for interactive sessions. It is I<not> "
10128 "intended that you try to parse the output string."
10132 #: ../src/guestfs-actions.pod:3345
10137 #: ../src/guestfs-actions.pod:3347
10141 " guestfs_ln (guestfs_h *g,\n"
10142 " const char *target,\n"
10143 " const char *linkname);\n"
10148 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2313
10149 msgid "This command creates a hard link using the C<ln> command."
10153 #: ../src/guestfs-actions.pod:3358
10154 msgid "guestfs_ln_f"
10158 #: ../src/guestfs-actions.pod:3360
10162 " guestfs_ln_f (guestfs_h *g,\n"
10163 " const char *target,\n"
10164 " const char *linkname);\n"
10169 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2319
10171 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10172 "option removes the link (C<linkname>) if it exists already."
10176 #: ../src/guestfs-actions.pod:3372
10177 msgid "guestfs_ln_s"
10181 #: ../src/guestfs-actions.pod:3374
10185 " guestfs_ln_s (guestfs_h *g,\n"
10186 " const char *target,\n"
10187 " const char *linkname);\n"
10192 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2326
10193 msgid "This command creates a symbolic link using the C<ln -s> command."
10197 #: ../src/guestfs-actions.pod:3385
10198 msgid "guestfs_ln_sf"
10202 #: ../src/guestfs-actions.pod:3387
10206 " guestfs_ln_sf (guestfs_h *g,\n"
10207 " const char *target,\n"
10208 " const char *linkname);\n"
10213 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2332
10215 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10216 "option removes the link (C<linkname>) if it exists already."
10220 #: ../src/guestfs-actions.pod:3399
10221 msgid "guestfs_lremovexattr"
10225 #: ../src/guestfs-actions.pod:3401
10229 " guestfs_lremovexattr (guestfs_h *g,\n"
10230 " const char *xattr,\n"
10231 " const char *path);\n"
10236 #: ../src/guestfs-actions.pod:3406
10238 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10239 "link, then it removes an extended attribute of the link itself."
10243 #: ../src/guestfs-actions.pod:3414
10248 #: ../src/guestfs-actions.pod:3416
10252 " guestfs_ls (guestfs_h *g,\n"
10253 " const char *directory);\n"
10258 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2347
10260 "List the files in C<directory> (relative to the root directory, there is no "
10261 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10265 #: ../src/guestfs-actions.pod:3424
10267 "This command is mostly useful for interactive sessions. Programs should "
10268 "probably use C<guestfs_readdir> instead."
10272 #: ../src/guestfs-actions.pod:3433
10273 msgid "guestfs_lsetxattr"
10277 #: ../src/guestfs-actions.pod:3435
10281 " guestfs_lsetxattr (guestfs_h *g,\n"
10282 " const char *xattr,\n"
10283 " const char *val,\n"
10285 " const char *path);\n"
10290 #: ../src/guestfs-actions.pod:3442
10292 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10293 "then it sets an extended attribute of the link itself."
10297 #: ../src/guestfs-actions.pod:3450
10298 msgid "guestfs_lstat"
10302 #: ../src/guestfs-actions.pod:3452
10305 " struct guestfs_stat *\n"
10306 " guestfs_lstat (guestfs_h *g,\n"
10307 " const char *path);\n"
10312 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5883
10313 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10314 msgid "Returns file information for the given C<path>."
10318 #: ../src/guestfs-actions.pod:3458
10320 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10321 "link, then the link is stat-ed, not the file it refers to."
10325 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2372
10326 msgid "This is the same as the C<lstat(2)> system call."
10330 #: ../src/guestfs-actions.pod:3464 ../src/guestfs-actions.pod:5887
10332 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10333 "error. I<The caller must call C<guestfs_free_stat> after use>."
10337 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:5891
10338 #: ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:6290
10339 msgid "(Added in 0.9.2)"
10343 #: ../src/guestfs-actions.pod:3470
10344 msgid "guestfs_lstatlist"
10348 #: ../src/guestfs-actions.pod:3472
10351 " struct guestfs_stat_list *\n"
10352 " guestfs_lstatlist (guestfs_h *g,\n"
10353 " const char *path,\n"
10354 " char *const *names);\n"
10359 #: ../src/guestfs-actions.pod:3477
10361 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10362 "files, where all files are in the directory C<path>. C<names> is the list "
10363 "of files from this directory."
10367 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:2382
10369 "On return you get a list of stat structs, with a one-to-one correspondence "
10370 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10371 "then the C<ino> field of that structure is set to C<-1>."
10375 #: ../src/guestfs-actions.pod:3486
10377 "This call is intended for programs that want to efficiently list a directory "
10378 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10379 "for a similarly efficient call for getting extended attributes. Very long "
10380 "directory listings might cause the protocol message size to be exceeded, "
10381 "causing this call to fail. The caller must split up such requests into "
10382 "smaller groups of names."
10386 #: ../src/guestfs-actions.pod:3494
10388 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10389 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10393 #: ../src/guestfs-actions.pod:3500
10394 msgid "guestfs_luks_add_key"
10398 #: ../src/guestfs-actions.pod:3502
10402 " guestfs_luks_add_key (guestfs_h *g,\n"
10403 " const char *device,\n"
10404 " const char *key,\n"
10405 " const char *newkey,\n"
10411 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2399
10413 "This command adds a new key on LUKS device C<device>. C<key> is any "
10414 "existing key, and is used to access the device. C<newkey> is the new key to "
10415 "add. C<keyslot> is the key slot that will be replaced."
10419 #: ../src/guestfs-actions.pod:3514
10421 "Note that if C<keyslot> already contains a key, then this command will "
10422 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10426 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:3560
10427 #: ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3603
10428 #: ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:3654
10430 "This function takes a key or passphrase parameter which could contain "
10431 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10436 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3564
10437 #: ../src/guestfs-actions.pod:3587 ../src/guestfs-actions.pod:3607
10438 msgid "(Added in 1.5.2)"
10442 #: ../src/guestfs-actions.pod:3526
10443 msgid "guestfs_luks_close"
10447 #: ../src/guestfs-actions.pod:3528
10451 " guestfs_luks_close (guestfs_h *g,\n"
10452 " const char *device);\n"
10457 #: ../src/guestfs-actions.pod:3532
10459 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10460 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10461 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10462 "underlying block device."
10466 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3639
10467 #: ../src/guestfs-actions.pod:3658 ../src/guestfs-actions.pod:3708
10468 #: ../src/guestfs-actions.pod:3756
10469 msgid "(Added in 1.5.1)"
10473 #: ../src/guestfs-actions.pod:3542
10474 msgid "guestfs_luks_format"
10478 #: ../src/guestfs-actions.pod:3544
10482 " guestfs_luks_format (guestfs_h *g,\n"
10483 " const char *device,\n"
10484 " const char *key,\n"
10490 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2425
10492 "This command erases existing data on C<device> and formats the device as a "
10493 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10494 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10498 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3580
10499 #: ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:4580
10500 #: ../src/guestfs-actions.pod:5343 ../src/guestfs-actions.pod:5718
10501 #: ../src/guestfs-actions.pod:5741 ../src/guestfs-actions.pod:5767
10502 #: ../src/guestfs-actions.pod:6917 ../fish/guestfish-actions.pod:2433
10503 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10504 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10505 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10506 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10508 "B<This command is dangerous. Without careful use you can easily destroy all "
10513 #: ../src/guestfs-actions.pod:3566
10514 msgid "guestfs_luks_format_cipher"
10518 #: ../src/guestfs-actions.pod:3568
10522 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10523 " const char *device,\n"
10524 " const char *key,\n"
10526 " const char *cipher);\n"
10531 #: ../src/guestfs-actions.pod:3575
10533 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10534 "set the C<cipher> used."
10538 #: ../src/guestfs-actions.pod:3589
10539 msgid "guestfs_luks_kill_slot"
10543 #: ../src/guestfs-actions.pod:3591
10547 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10548 " const char *device,\n"
10549 " const char *key,\n"
10555 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2453
10557 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10558 "device C<device>. C<key> must be one of the I<other> keys."
10562 #: ../src/guestfs-actions.pod:3609
10563 msgid "guestfs_luks_open"
10567 #: ../src/guestfs-actions.pod:3611
10571 " guestfs_luks_open (guestfs_h *g,\n"
10572 " const char *device,\n"
10573 " const char *key,\n"
10574 " const char *mapname);\n"
10579 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2464
10581 "This command opens a block device which has been encrypted according to the "
10582 "Linux Unified Key Setup (LUKS) standard."
10586 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2467
10587 msgid "C<device> is the encrypted block device or partition."
10591 #: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2469
10593 "The caller must supply one of the keys associated with the LUKS block "
10594 "device, in the C<key> parameter."
10598 #: ../src/guestfs-actions.pod:3625 ../fish/guestfish-actions.pod:2472
10600 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10601 "writes to this block device are decrypted from and encrypted to the "
10602 "underlying C<device> respectively."
10606 #: ../src/guestfs-actions.pod:3629
10608 "If this block device contains LVM volume groups, then calling "
10609 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10614 #: ../src/guestfs-actions.pod:3641
10615 msgid "guestfs_luks_open_ro"
10619 #: ../src/guestfs-actions.pod:3643
10623 " guestfs_luks_open_ro (guestfs_h *g,\n"
10624 " const char *device,\n"
10625 " const char *key,\n"
10626 " const char *mapname);\n"
10631 #: ../src/guestfs-actions.pod:3649
10633 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10638 #: ../src/guestfs-actions.pod:3660
10639 msgid "guestfs_lvcreate"
10643 #: ../src/guestfs-actions.pod:3662
10647 " guestfs_lvcreate (guestfs_h *g,\n"
10648 " const char *logvol,\n"
10649 " const char *volgroup,\n"
10655 #: ../src/guestfs-actions.pod:3668 ../fish/guestfish-actions.pod:2497
10657 "This creates an LVM logical volume called C<logvol> on the volume group "
10658 "C<volgroup>, with C<size> megabytes."
10662 #: ../src/guestfs-actions.pod:3675
10663 msgid "guestfs_lvm_canonical_lv_name"
10667 #: ../src/guestfs-actions.pod:3677
10671 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10672 " const char *lvname);\n"
10677 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2504
10679 "This converts alternative naming schemes for LVs that you might find to the "
10680 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10685 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2508
10687 "This command returns an error if the C<lvname> parameter does not refer to a "
10692 #: ../src/guestfs-actions.pod:3688
10693 msgid "See also C<guestfs_is_lv>."
10697 #: ../src/guestfs-actions.pod:3693
10698 msgid "(Added in 1.5.24)"
10702 #: ../src/guestfs-actions.pod:3695
10703 msgid "guestfs_lvm_clear_filter"
10707 #: ../src/guestfs-actions.pod:3697
10711 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10716 #: ../src/guestfs-actions.pod:3700
10718 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10719 "see every block device."
10723 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3745
10724 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10726 "This command also clears the LVM cache and performs a volume group scan."
10730 #: ../src/guestfs-actions.pod:3710
10731 msgid "guestfs_lvm_remove_all"
10735 #: ../src/guestfs-actions.pod:3712
10739 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10744 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2527
10746 "This command removes all LVM logical volumes, volume groups and physical "
10751 #: ../src/guestfs-actions.pod:3725
10752 msgid "guestfs_lvm_set_filter"
10756 #: ../src/guestfs-actions.pod:3727
10760 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10761 " char *const *devices);\n"
10766 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2537
10768 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10769 "block devices in the list C<devices>, and will ignore all other attached "
10774 #: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2541
10776 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10777 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10778 "there are two types of duplication possible: either cloned PVs/VGs which "
10779 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10780 "same name. In normal operation you cannot create this situation, but you "
10781 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10782 "inside the LVM metadata."
10786 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2554
10787 msgid "You can filter whole block devices or individual partitions."
10791 #: ../src/guestfs-actions.pod:3750 ../fish/guestfish-actions.pod:2556
10793 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10794 "filesystem), even if you are not filtering out that VG."
10798 #: ../src/guestfs-actions.pod:3758
10799 msgid "guestfs_lvremove"
10803 #: ../src/guestfs-actions.pod:3760
10807 " guestfs_lvremove (guestfs_h *g,\n"
10808 " const char *device);\n"
10813 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2564
10815 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10816 "LV, such as C</dev/VG/LV>."
10820 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2567
10822 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10827 #: ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:4926
10828 #: ../src/guestfs-actions.pod:6656
10829 msgid "(Added in 1.0.13)"
10833 #: ../src/guestfs-actions.pod:3774
10834 msgid "guestfs_lvrename"
10838 #: ../src/guestfs-actions.pod:3776
10842 " guestfs_lvrename (guestfs_h *g,\n"
10843 " const char *logvol,\n"
10844 " const char *newlogvol);\n"
10849 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2574
10850 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10854 #: ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:6669
10855 msgid "(Added in 1.0.83)"
10859 #: ../src/guestfs-actions.pod:3787
10860 msgid "guestfs_lvresize"
10864 #: ../src/guestfs-actions.pod:3789
10868 " guestfs_lvresize (guestfs_h *g,\n"
10869 " const char *device,\n"
10875 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
10877 "This resizes (expands or shrinks) an existing LVM logical volume to "
10878 "C<mbytes>. When reducing, data in the reduced part is lost."
10882 #: ../src/guestfs-actions.pod:3802
10883 msgid "guestfs_lvresize_free"
10887 #: ../src/guestfs-actions.pod:3804
10891 " guestfs_lvresize_free (guestfs_h *g,\n"
10892 " const char *lv,\n"
10898 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2588
10900 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10901 "remaining free space in the volume group. Commonly you would call this with "
10902 "pc = 100 which expands the logical volume as much as possible, using all "
10903 "remaining free space in the volume group."
10907 #: ../src/guestfs-actions.pod:3817
10908 msgid "(Added in 1.3.3)"
10912 #: ../src/guestfs-actions.pod:3819
10913 msgid "guestfs_lvs"
10917 #: ../src/guestfs-actions.pod:3821
10921 " guestfs_lvs (guestfs_h *g);\n"
10926 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2598
10928 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10933 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2601
10935 "This returns a list of the logical volume device names (eg. C</dev/"
10936 "VolGroup00/LogVol00>)."
10940 #: ../src/guestfs-actions.pod:3830
10941 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10945 #: ../src/guestfs-actions.pod:3838
10946 msgid "guestfs_lvs_full"
10950 #: ../src/guestfs-actions.pod:3840
10953 " struct guestfs_lvm_lv_list *\n"
10954 " guestfs_lvs_full (guestfs_h *g);\n"
10959 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2610
10961 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10962 "(8)> command. The \"full\" version includes all fields."
10966 #: ../src/guestfs-actions.pod:3846
10968 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10969 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10973 #: ../src/guestfs-actions.pod:3852
10974 msgid "guestfs_lvuuid"
10978 #: ../src/guestfs-actions.pod:3854
10982 " guestfs_lvuuid (guestfs_h *g,\n"
10983 " const char *device);\n"
10988 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2617
10989 msgid "This command returns the UUID of the LVM LV C<device>."
10993 #: ../src/guestfs-actions.pod:3865
10994 msgid "guestfs_lxattrlist"
10998 #: ../src/guestfs-actions.pod:3867
11001 " struct guestfs_xattr_list *\n"
11002 " guestfs_lxattrlist (guestfs_h *g,\n"
11003 " const char *path,\n"
11004 " char *const *names);\n"
11009 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2623
11011 "This call allows you to get the extended attributes of multiple files, where "
11012 "all files are in the directory C<path>. C<names> is the list of files from "
11017 #: ../src/guestfs-actions.pod:3876 ../fish/guestfish-actions.pod:2627
11019 "On return you get a flat list of xattr structs which must be interpreted "
11020 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11021 "C<attrval> in this struct is zero-length to indicate there was an error "
11022 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11023 "number (the number of following attributes for this file, which could be C<"
11024 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11025 "for the first named file. This repeats for the second and subsequent files."
11029 #: ../src/guestfs-actions.pod:3886
11031 "This call is intended for programs that want to efficiently list a directory "
11032 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11033 "a similarly efficient call for getting standard stats. Very long directory "
11034 "listings might cause the protocol message size to be exceeded, causing this "
11035 "call to fail. The caller must split up such requests into smaller groups of "
11040 #: ../src/guestfs-actions.pod:3900
11041 msgid "guestfs_mkdir"
11045 #: ../src/guestfs-actions.pod:3902
11049 " guestfs_mkdir (guestfs_h *g,\n"
11050 " const char *path);\n"
11055 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2649
11056 msgid "Create a directory named C<path>."
11060 #: ../src/guestfs-actions.pod:3912
11061 msgid "guestfs_mkdir_mode"
11065 #: ../src/guestfs-actions.pod:3914
11069 " guestfs_mkdir_mode (guestfs_h *g,\n"
11070 " const char *path,\n"
11076 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2655
11078 "This command creates a directory, setting the initial permissions of the "
11079 "directory to C<mode>."
11083 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2658
11085 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11086 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11091 #: ../src/guestfs-actions.pod:3926
11092 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11096 #: ../src/guestfs-actions.pod:3932
11097 msgid "guestfs_mkdir_p"
11101 #: ../src/guestfs-actions.pod:3934
11105 " guestfs_mkdir_p (guestfs_h *g,\n"
11106 " const char *path);\n"
11111 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2668
11113 "Create a directory named C<path>, creating any parent directories as "
11114 "necessary. This is like the C<mkdir -p> shell command."
11118 #: ../src/guestfs-actions.pod:3945
11119 msgid "guestfs_mkdtemp"
11123 #: ../src/guestfs-actions.pod:3947
11127 " guestfs_mkdtemp (guestfs_h *g,\n"
11128 " const char *template);\n"
11133 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2675
11135 "This command creates a temporary directory. The C<template> parameter "
11136 "should be a full pathname for the temporary directory name with the final "
11137 "six characters being \"XXXXXX\"."
11141 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2680
11143 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11144 "being suitable for Windows filesystems."
11148 #: ../src/guestfs-actions.pod:3959 ../fish/guestfish-actions.pod:2683
11149 msgid "The name of the temporary directory that was created is returned."
11153 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2686
11154 msgid "The temporary directory is created with mode 0700 and is owned by root."
11158 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2689
11160 "The caller is responsible for deleting the temporary directory and its "
11161 "contents after use."
11165 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2692
11166 msgid "See also: L<mkdtemp(3)>"
11170 #: ../src/guestfs-actions.pod:3975
11171 msgid "guestfs_mke2fs_J"
11175 #: ../src/guestfs-actions.pod:3977
11179 " guestfs_mke2fs_J (guestfs_h *g,\n"
11180 " const char *fstype,\n"
11181 " int blocksize,\n"
11182 " const char *device,\n"
11183 " const char *journal);\n"
11188 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2698
11190 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11191 "C<journal>. It is equivalent to the command:"
11195 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2702
11198 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11203 #: ../src/guestfs-actions.pod:3990
11204 msgid "See also C<guestfs_mke2journal>."
11208 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4012
11209 #: ../src/guestfs-actions.pod:4030 ../src/guestfs-actions.pod:4046
11210 #: ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4074
11211 #: ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:4316
11212 msgid "(Added in 1.0.68)"
11216 #: ../src/guestfs-actions.pod:3996
11217 msgid "guestfs_mke2fs_JL"
11221 #: ../src/guestfs-actions.pod:3998
11225 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11226 " const char *fstype,\n"
11227 " int blocksize,\n"
11228 " const char *device,\n"
11229 " const char *label);\n"
11234 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2710
11236 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11237 "the journal labeled C<label>."
11241 #: ../src/guestfs-actions.pod:4008
11242 msgid "See also C<guestfs_mke2journal_L>."
11246 #: ../src/guestfs-actions.pod:4014
11247 msgid "guestfs_mke2fs_JU"
11251 #: ../src/guestfs-actions.pod:4016
11255 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11256 " const char *fstype,\n"
11257 " int blocksize,\n"
11258 " const char *device,\n"
11259 " const char *uuid);\n"
11264 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2719
11266 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11267 "the journal with UUID C<uuid>."
11271 #: ../src/guestfs-actions.pod:4026
11272 msgid "See also C<guestfs_mke2journal_U>."
11276 #: ../src/guestfs-actions.pod:4032
11277 msgid "guestfs_mke2journal"
11281 #: ../src/guestfs-actions.pod:4034
11285 " guestfs_mke2journal (guestfs_h *g,\n"
11286 " int blocksize,\n"
11287 " const char *device);\n"
11292 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2728
11294 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11299 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2731
11302 " mke2fs -O journal_dev -b blocksize device\n"
11307 #: ../src/guestfs-actions.pod:4048
11308 msgid "guestfs_mke2journal_L"
11312 #: ../src/guestfs-actions.pod:4050
11316 " guestfs_mke2journal_L (guestfs_h *g,\n"
11317 " int blocksize,\n"
11318 " const char *label,\n"
11319 " const char *device);\n"
11324 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2737
11325 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11329 #: ../src/guestfs-actions.pod:4062
11330 msgid "guestfs_mke2journal_U"
11334 #: ../src/guestfs-actions.pod:4064
11338 " guestfs_mke2journal_U (guestfs_h *g,\n"
11339 " int blocksize,\n"
11340 " const char *uuid,\n"
11341 " const char *device);\n"
11346 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2743
11347 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11351 #: ../src/guestfs-actions.pod:4076
11352 msgid "guestfs_mkfifo"
11356 #: ../src/guestfs-actions.pod:4078
11360 " guestfs_mkfifo (guestfs_h *g,\n"
11362 " const char *path);\n"
11367 #: ../src/guestfs-actions.pod:4083
11369 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11370 "is just a convenient wrapper around C<guestfs_mknod>."
11374 #: ../src/guestfs-actions.pod:4093
11375 msgid "guestfs_mkfs"
11379 #: ../src/guestfs-actions.pod:4095
11383 " guestfs_mkfs (guestfs_h *g,\n"
11384 " const char *fstype,\n"
11385 " const char *device);\n"
11390 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2759
11392 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11393 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11397 #: ../src/guestfs-actions.pod:4108
11398 msgid "guestfs_mkfs_b"
11402 #: ../src/guestfs-actions.pod:4110
11406 " guestfs_mkfs_b (guestfs_h *g,\n"
11407 " const char *fstype,\n"
11408 " int blocksize,\n"
11409 " const char *device);\n"
11414 #: ../src/guestfs-actions.pod:4116
11416 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11417 "block size of the resulting filesystem. Supported block sizes depend on the "
11418 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11422 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2772
11424 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11429 #: ../src/guestfs-actions.pod:4128
11430 msgid "guestfs_mkmountpoint"
11434 #: ../src/guestfs-actions.pod:4130
11438 " guestfs_mkmountpoint (guestfs_h *g,\n"
11439 " const char *exemptpath);\n"
11444 #: ../src/guestfs-actions.pod:4134
11446 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11447 "that can be used to create extra mountpoints before mounting the first "
11452 #: ../src/guestfs-actions.pod:4138 ../fish/guestfish-actions.pod:2783
11454 "These calls are I<only> necessary in some very limited circumstances, mainly "
11455 "the case where you want to mount a mix of unrelated and/or read-only "
11456 "filesystems together."
11460 #: ../src/guestfs-actions.pod:4142 ../fish/guestfish-actions.pod:2787
11462 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11463 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11464 "inside that. You can unpack this as follows in guestfish:"
11468 #: ../src/guestfs-actions.pod:4147 ../fish/guestfish-actions.pod:2792
11471 " add-ro Fedora-11-i686-Live.iso\n"
11473 " mkmountpoint /cd\n"
11474 " mkmountpoint /sqsh\n"
11475 " mkmountpoint /ext3fs\n"
11476 " mount /dev/sda /cd\n"
11477 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11478 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11483 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2801
11484 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11488 #: ../src/guestfs-actions.pod:4158
11490 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11491 "may get unexpected errors if you try to mix these calls. It is safest to "
11492 "manually unmount filesystems and remove mountpoints after use."
11496 #: ../src/guestfs-actions.pod:4162
11498 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11499 "first, so for this to work for manual mountpoints, you must ensure that the "
11500 "innermost mountpoints have the longest pathnames, as in the example code "
11505 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2812
11507 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11511 #: ../src/guestfs-actions.pod:4169
11513 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11514 "means that C<guestfs_umount_all> is called when the handle is closed which "
11515 "can also trigger these issues."
11519 #: ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4434
11520 #: ../src/guestfs-actions.pod:5327
11521 msgid "(Added in 1.0.62)"
11525 #: ../src/guestfs-actions.pod:4177
11526 msgid "guestfs_mknod"
11530 #: ../src/guestfs-actions.pod:4179
11534 " guestfs_mknod (guestfs_h *g,\n"
11538 " const char *path);\n"
11543 #: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2822
11545 "This call creates block or character special devices, or named pipes (FIFOs)."
11549 #: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:2825
11551 "The C<mode> parameter should be the mode, using the standard constants. "
11552 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11553 "used when creating block and character special devices."
11557 #: ../src/guestfs-actions.pod:4194
11559 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11560 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11561 "regular file). These constants are available in the standard Linux header "
11562 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11563 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11564 "the appropriate constant for you."
11568 #: ../src/guestfs-actions.pod:4208
11569 msgid "guestfs_mknod_b"
11573 #: ../src/guestfs-actions.pod:4210
11577 " guestfs_mknod_b (guestfs_h *g,\n"
11581 " const char *path);\n"
11586 #: ../src/guestfs-actions.pod:4217
11588 "This call creates a block device node called C<path> with mode C<mode> and "
11589 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11590 "wrapper around C<guestfs_mknod>."
11594 #: ../src/guestfs-actions.pod:4227
11595 msgid "guestfs_mknod_c"
11599 #: ../src/guestfs-actions.pod:4229
11603 " guestfs_mknod_c (guestfs_h *g,\n"
11607 " const char *path);\n"
11612 #: ../src/guestfs-actions.pod:4236
11614 "This call creates a char device node called C<path> with mode C<mode> and "
11615 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11616 "wrapper around C<guestfs_mknod>."
11620 #: ../src/guestfs-actions.pod:4246
11621 msgid "guestfs_mkswap"
11625 #: ../src/guestfs-actions.pod:4248
11629 " guestfs_mkswap (guestfs_h *g,\n"
11630 " const char *device);\n"
11635 #: ../src/guestfs-actions.pod:4252 ../fish/guestfish-actions.pod:2864
11636 msgid "Create a swap partition on C<device>."
11640 #: ../src/guestfs-actions.pod:4258
11641 msgid "guestfs_mkswap_L"
11645 #: ../src/guestfs-actions.pod:4260
11649 " guestfs_mkswap_L (guestfs_h *g,\n"
11650 " const char *label,\n"
11651 " const char *device);\n"
11656 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2870
11657 msgid "Create a swap partition on C<device> with label C<label>."
11661 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2872
11663 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11664 "sda>), just to a partition. This appears to be a limitation of the kernel "
11669 #: ../src/guestfs-actions.pod:4275
11670 msgid "guestfs_mkswap_U"
11674 #: ../src/guestfs-actions.pod:4277
11678 " guestfs_mkswap_U (guestfs_h *g,\n"
11679 " const char *uuid,\n"
11680 " const char *device);\n"
11685 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2880
11686 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11690 #: ../src/guestfs-actions.pod:4288
11691 msgid "guestfs_mkswap_file"
11695 #: ../src/guestfs-actions.pod:4290
11699 " guestfs_mkswap_file (guestfs_h *g,\n"
11700 " const char *path);\n"
11705 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2886
11706 msgid "Create a swap file."
11710 #: ../src/guestfs-actions.pod:4296
11712 "This command just writes a swap file signature to an existing file. To "
11713 "create the file itself, use something like C<guestfs_fallocate>."
11717 #: ../src/guestfs-actions.pod:4303
11718 msgid "guestfs_modprobe"
11722 #: ../src/guestfs-actions.pod:4305
11726 " guestfs_modprobe (guestfs_h *g,\n"
11727 " const char *modulename);\n"
11732 #: ../src/guestfs-actions.pod:4309 ../fish/guestfish-actions.pod:2895
11733 msgid "This loads a kernel module in the appliance."
11737 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2897
11739 "The kernel module must have been whitelisted when libguestfs was built (see "
11740 "C<appliance/kmod.whitelist.in> in the source)."
11744 #: ../src/guestfs-actions.pod:4318
11745 msgid "guestfs_mount"
11749 #: ../src/guestfs-actions.pod:4320
11753 " guestfs_mount (guestfs_h *g,\n"
11754 " const char *device,\n"
11755 " const char *mountpoint);\n"
11760 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2904
11762 "Mount a guest disk at a position in the filesystem. Block devices are named "
11763 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11764 "those block devices contain partitions, they will have the usual names (eg. "
11765 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11769 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2910
11771 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11772 "mounted on C</> before others can be mounted. Other filesystems can only be "
11773 "mounted on directories which already exist."
11777 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2915
11779 "The mounted filesystem is writable, if we have sufficient permissions on the "
11780 "underlying device."
11784 #: ../src/guestfs-actions.pod:4339
11786 "B<Important note:> When you use this call, the filesystem options C<sync> "
11787 "and C<noatime> are set implicitly. This was originally done because we "
11788 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11789 "very large negative performance impact and negligible effect on "
11790 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11791 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11792 "(use an empty string for the first parameter if you don't want any options)."
11796 #: ../src/guestfs-actions.pod:4353
11797 msgid "guestfs_mount_loop"
11801 #: ../src/guestfs-actions.pod:4355
11805 " guestfs_mount_loop (guestfs_h *g,\n"
11806 " const char *file,\n"
11807 " const char *mountpoint);\n"
11812 #: ../src/guestfs-actions.pod:4360 ../fish/guestfish-actions.pod:2932
11814 "This command lets you mount C<file> (a filesystem image in a file) on a "
11815 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11820 #: ../src/guestfs-actions.pod:4368
11821 msgid "guestfs_mount_options"
11825 #: ../src/guestfs-actions.pod:4370
11829 " guestfs_mount_options (guestfs_h *g,\n"
11830 " const char *options,\n"
11831 " const char *device,\n"
11832 " const char *mountpoint);\n"
11837 #: ../src/guestfs-actions.pod:4376
11839 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11840 "the mount options as for the L<mount(8)> I<-o> flag."
11844 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2944
11846 "If the C<options> parameter is an empty string, then no options are passed "
11847 "(all options default to whatever the filesystem uses)."
11851 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4400
11852 #: ../src/guestfs-actions.pod:4417
11853 msgid "(Added in 1.0.10)"
11857 #: ../src/guestfs-actions.pod:4388
11858 msgid "guestfs_mount_ro"
11862 #: ../src/guestfs-actions.pod:4390
11866 " guestfs_mount_ro (guestfs_h *g,\n"
11867 " const char *device,\n"
11868 " const char *mountpoint);\n"
11873 #: ../src/guestfs-actions.pod:4395
11875 "This is the same as the C<guestfs_mount> command, but it mounts the "
11876 "filesystem with the read-only (I<-o ro>) flag."
11880 #: ../src/guestfs-actions.pod:4402
11881 msgid "guestfs_mount_vfs"
11885 #: ../src/guestfs-actions.pod:4404
11889 " guestfs_mount_vfs (guestfs_h *g,\n"
11890 " const char *options,\n"
11891 " const char *vfstype,\n"
11892 " const char *device,\n"
11893 " const char *mountpoint);\n"
11898 #: ../src/guestfs-actions.pod:4411
11900 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11901 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11906 #: ../src/guestfs-actions.pod:4419
11907 msgid "guestfs_mountpoints"
11911 #: ../src/guestfs-actions.pod:4421
11915 " guestfs_mountpoints (guestfs_h *g);\n"
11920 #: ../src/guestfs-actions.pod:4424
11922 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11923 "devices. This one returns a hash table (map) of device name to directory "
11924 "where the device is mounted."
11928 #: ../src/guestfs-actions.pod:4436
11929 msgid "guestfs_mounts"
11933 #: ../src/guestfs-actions.pod:4438
11937 " guestfs_mounts (guestfs_h *g);\n"
11942 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2975
11944 "This returns the list of currently mounted filesystems. It returns the list "
11945 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11949 #: ../src/guestfs-actions.pod:4444 ../fish/guestfish-actions.pod:2978
11950 msgid "Some internal mounts are not shown."
11954 #: ../src/guestfs-actions.pod:4446
11955 msgid "See also: C<guestfs_mountpoints>"
11959 #: ../src/guestfs-actions.pod:4454
11964 #: ../src/guestfs-actions.pod:4456
11968 " guestfs_mv (guestfs_h *g,\n"
11969 " const char *src,\n"
11970 " const char *dest);\n"
11975 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:2986
11977 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11978 "destination filename or destination directory."
11982 #: ../src/guestfs-actions.pod:4468
11983 msgid "guestfs_ntfs_3g_probe"
11987 #: ../src/guestfs-actions.pod:4470
11991 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11993 " const char *device);\n"
11998 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:2993
12000 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12001 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
12002 "write, and some cannot be mounted at all)."
12006 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:2997
12008 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12009 "can be mounted read-write. Set it to false if you want to test if the "
12010 "volume can be mounted read-only."
12014 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3001
12016 "The return value is an integer which C<0> if the operation would succeed, or "
12017 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12021 #: ../src/guestfs-actions.pod:4489
12022 msgid "(Added in 1.0.43)"
12026 #: ../src/guestfs-actions.pod:4491
12027 msgid "guestfs_ntfsresize"
12031 #: ../src/guestfs-actions.pod:4493
12035 " guestfs_ntfsresize (guestfs_h *g,\n"
12036 " const char *device);\n"
12041 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:3009
12043 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12044 "size of the underlying device. See also L<ntfsresize(8)>."
12048 #: ../src/guestfs-actions.pod:4505
12049 msgid "guestfs_ntfsresize_size"
12053 #: ../src/guestfs-actions.pod:4507
12057 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12058 " const char *device,\n"
12059 " int64_t size);\n"
12064 #: ../src/guestfs-actions.pod:4512
12066 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12067 "to specify the new size (in bytes) explicitly."
12071 #: ../src/guestfs-actions.pod:4517 ../src/guestfs-actions.pod:4953
12072 #: ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:5275
12073 msgid "(Added in 1.3.14)"
12077 #: ../src/guestfs-actions.pod:4519
12078 msgid "guestfs_part_add"
12082 #: ../src/guestfs-actions.pod:4521
12086 " guestfs_part_add (guestfs_h *g,\n"
12087 " const char *device,\n"
12088 " const char *prlogex,\n"
12089 " int64_t startsect,\n"
12090 " int64_t endsect);\n"
12095 #: ../src/guestfs-actions.pod:4528
12097 "This command adds a partition to C<device>. If there is no partition table "
12098 "on the device, call C<guestfs_part_init> first."
12102 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3027
12104 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12105 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12106 "C<logical>) and C<e> (or C<extended>) partition types."
12110 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3032
12112 "C<startsect> and C<endsect> are the start and end of the partition in "
12113 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12114 "from the end of the disk (C<-1> is the last sector)."
12118 #: ../src/guestfs-actions.pod:4540
12120 "Creating a partition which covers the whole disk is not so easy. Use "
12121 "C<guestfs_part_disk> to do that."
12125 #: ../src/guestfs-actions.pod:4545 ../src/guestfs-actions.pod:4583
12126 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4714
12127 #: ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4771
12128 #: ../src/guestfs-actions.pod:4811
12129 msgid "(Added in 1.0.78)"
12133 #: ../src/guestfs-actions.pod:4547
12134 msgid "guestfs_part_del"
12138 #: ../src/guestfs-actions.pod:4549
12142 " guestfs_part_del (guestfs_h *g,\n"
12143 " const char *device,\n"
12149 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3043
12150 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12154 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3045
12156 "Note that in the case of MBR partitioning, deleting an extended partition "
12157 "also deletes any logical partitions it contains."
12161 #: ../src/guestfs-actions.pod:4564
12162 msgid "guestfs_part_disk"
12166 #: ../src/guestfs-actions.pod:4566
12170 " guestfs_part_disk (guestfs_h *g,\n"
12171 " const char *device,\n"
12172 " const char *parttype);\n"
12177 #: ../src/guestfs-actions.pod:4571
12179 "This command is simply a combination of C<guestfs_part_init> followed by "
12180 "C<guestfs_part_add> to create a single primary partition covering the whole "
12185 #: ../src/guestfs-actions.pod:4575
12187 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12188 "possible values are described in C<guestfs_part_init>."
12192 #: ../src/guestfs-actions.pod:4585
12193 msgid "guestfs_part_get_bootable"
12197 #: ../src/guestfs-actions.pod:4587
12201 " guestfs_part_get_bootable (guestfs_h *g,\n"
12202 " const char *device,\n"
12208 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3067
12210 "This command returns true if the partition C<partnum> on C<device> has the "
12211 "bootable flag set."
12215 #: ../src/guestfs-actions.pod:4595
12216 msgid "See also C<guestfs_part_set_bootable>."
12220 #: ../src/guestfs-actions.pod:4601
12221 msgid "guestfs_part_get_mbr_id"
12225 #: ../src/guestfs-actions.pod:4603
12229 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12230 " const char *device,\n"
12236 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3076
12238 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12239 "partition C<partnum>."
12243 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4787
12245 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12246 "undefined results for other partition table types (see "
12247 "C<guestfs_part_get_parttype>)."
12251 #: ../src/guestfs-actions.pod:4619
12252 msgid "guestfs_part_get_parttype"
12256 #: ../src/guestfs-actions.pod:4621
12260 " guestfs_part_get_parttype (guestfs_h *g,\n"
12261 " const char *device);\n"
12266 #: ../src/guestfs-actions.pod:4625 ../fish/guestfish-actions.pod:3087
12268 "This command examines the partition table on C<device> and returns the "
12269 "partition table type (format) being used."
12273 #: ../src/guestfs-actions.pod:4628
12275 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12276 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12277 "possible, although unusual. See C<guestfs_part_init> for a full list."
12281 #: ../src/guestfs-actions.pod:4638
12282 msgid "guestfs_part_init"
12286 #: ../src/guestfs-actions.pod:4640
12290 " guestfs_part_init (guestfs_h *g,\n"
12291 " const char *device,\n"
12292 " const char *parttype);\n"
12297 #: ../src/guestfs-actions.pod:4645 ../fish/guestfish-actions.pod:3099
12299 "This creates an empty partition table on C<device> of one of the partition "
12300 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12301 "(for large disks)."
12305 #: ../src/guestfs-actions.pod:4649
12307 "Initially there are no partitions. Following this, you should call "
12308 "C<guestfs_part_add> for each partition required."
12312 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3106
12313 msgid "Possible values for C<parttype> are:"
12317 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3110
12318 msgid "B<efi> | B<gpt>"
12322 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3112
12323 msgid "Intel EFI / GPT partition table."
12327 #: ../src/guestfs-actions.pod:4660 ../fish/guestfish-actions.pod:3114
12329 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12330 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12331 "the C<mbr> format."
12335 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3118
12336 msgid "B<mbr> | B<msdos>"
12340 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3120
12342 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12343 "Windows. This partition type will B<only> work for device sizes up to 2 "
12344 "TB. For large disks we recommend using C<gpt>."
12348 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3127
12350 "Other partition table types that may work but are not supported include:"
12354 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3132
12359 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3134
12360 msgid "AIX disk labels."
12364 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3136
12365 msgid "B<amiga> | B<rdb>"
12369 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3138
12370 msgid "Amiga \"Rigid Disk Block\" format."
12374 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3140
12379 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3142
12380 msgid "BSD disk labels."
12384 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3144
12389 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3146
12390 msgid "DASD, used on IBM mainframes."
12394 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3148
12399 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3150
12400 msgid "MIPS/SGI volumes."
12404 #: ../src/guestfs-actions.pod:4698 ../fish/guestfish-actions.pod:3152
12409 #: ../src/guestfs-actions.pod:4700 ../fish/guestfish-actions.pod:3154
12410 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12414 #: ../src/guestfs-actions.pod:4702 ../fish/guestfish-actions.pod:3156
12419 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3158
12420 msgid "NEC PC-98 format, common in Japan apparently."
12424 #: ../src/guestfs-actions.pod:4706 ../fish/guestfish-actions.pod:3160
12429 #: ../src/guestfs-actions.pod:4708 ../fish/guestfish-actions.pod:3162
12430 msgid "Sun disk labels."
12434 #: ../src/guestfs-actions.pod:4716
12435 msgid "guestfs_part_list"
12439 #: ../src/guestfs-actions.pod:4718
12442 " struct guestfs_partition_list *\n"
12443 " guestfs_part_list (guestfs_h *g,\n"
12444 " const char *device);\n"
12449 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3170
12451 "This command parses the partition table on C<device> and returns the list of "
12452 "partitions found."
12456 #: ../src/guestfs-actions.pod:4725 ../fish/guestfish-actions.pod:3173
12457 msgid "The fields in the returned structure are:"
12461 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3177
12462 msgid "B<part_num>"
12466 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3179
12467 msgid "Partition number, counting from 1."
12471 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3181
12472 msgid "B<part_start>"
12476 #: ../src/guestfs-actions.pod:4735
12478 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12479 "the device's sector size, see C<guestfs_blockdev_getss>."
12483 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3186
12484 msgid "B<part_end>"
12488 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3188
12489 msgid "End of the partition in bytes."
12493 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3190
12494 msgid "B<part_size>"
12498 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3192
12499 msgid "Size of the partition in bytes."
12503 #: ../src/guestfs-actions.pod:4748
12505 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12506 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12511 #: ../src/guestfs-actions.pod:4754
12512 msgid "guestfs_part_set_bootable"
12516 #: ../src/guestfs-actions.pod:4756
12520 " guestfs_part_set_bootable (guestfs_h *g,\n"
12521 " const char *device,\n"
12523 " int bootable);\n"
12528 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3200
12530 "This sets the bootable flag on partition numbered C<partnum> on device "
12531 "C<device>. Note that partitions are numbered from 1."
12535 #: ../src/guestfs-actions.pod:4765 ../fish/guestfish-actions.pod:3203
12537 "The bootable flag is used by some operating systems (notably Windows) to "
12538 "determine which partition to boot from. It is by no means universally "
12543 #: ../src/guestfs-actions.pod:4773
12544 msgid "guestfs_part_set_mbr_id"
12548 #: ../src/guestfs-actions.pod:4775
12552 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12553 " const char *device,\n"
12560 #: ../src/guestfs-actions.pod:4781 ../fish/guestfish-actions.pod:3211
12562 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12563 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12564 "documentation are in fact hexadecimal numbers, but usually documented "
12565 "without any leading \"0x\" which might be confusing."
12569 #: ../src/guestfs-actions.pod:4795
12570 msgid "guestfs_part_set_name"
12574 #: ../src/guestfs-actions.pod:4797
12578 " guestfs_part_set_name (guestfs_h *g,\n"
12579 " const char *device,\n"
12581 " const char *name);\n"
12586 #: ../src/guestfs-actions.pod:4803 ../fish/guestfish-actions.pod:3225
12588 "This sets the partition name on partition numbered C<partnum> on device "
12589 "C<device>. Note that partitions are numbered from 1."
12593 #: ../src/guestfs-actions.pod:4806 ../fish/guestfish-actions.pod:3228
12595 "The partition name can only be set on certain types of partition table. "
12596 "This works on C<gpt> but not on C<mbr> partitions."
12600 #: ../src/guestfs-actions.pod:4813
12601 msgid "guestfs_part_to_dev"
12605 #: ../src/guestfs-actions.pod:4815
12609 " guestfs_part_to_dev (guestfs_h *g,\n"
12610 " const char *partition);\n"
12615 #: ../src/guestfs-actions.pod:4819 ../fish/guestfish-actions.pod:3235
12617 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12618 "partition number, returning the device name (eg. \"/dev/sdb\")."
12622 #: ../src/guestfs-actions.pod:4823
12624 "The named partition must exist, for example as a string returned from "
12625 "C<guestfs_list_partitions>."
12629 #: ../src/guestfs-actions.pod:4831
12630 msgid "guestfs_ping_daemon"
12634 #: ../src/guestfs-actions.pod:4833
12638 " guestfs_ping_daemon (guestfs_h *g);\n"
12643 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3246
12645 "This is a test probe into the guestfs daemon running inside the qemu "
12646 "subprocess. Calling this function checks that the daemon responds to the "
12647 "ping message, without affecting the daemon or attached block device(s) in "
12652 #: ../src/guestfs-actions.pod:4845
12653 msgid "guestfs_pread"
12657 #: ../src/guestfs-actions.pod:4847
12661 " guestfs_pread (guestfs_h *g,\n"
12662 " const char *path,\n"
12664 " int64_t offset,\n"
12665 " size_t *size_r);\n"
12670 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3255
12672 "This command lets you read part of a file. It reads C<count> bytes of the "
12673 "file, starting at C<offset>, from file C<path>."
12677 #: ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4883
12678 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12680 "This may read fewer bytes than requested. For further details see the "
12681 "L<pread(2)> system call."
12685 #: ../src/guestfs-actions.pod:4860
12686 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12690 #: ../src/guestfs-actions.pod:4871
12691 msgid "guestfs_pread_device"
12695 #: ../src/guestfs-actions.pod:4873
12699 " guestfs_pread_device (guestfs_h *g,\n"
12700 " const char *device,\n"
12702 " int64_t offset,\n"
12703 " size_t *size_r);\n"
12708 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3270
12710 "This command lets you read part of a file. It reads C<count> bytes of "
12711 "C<device>, starting at C<offset>."
12715 #: ../src/guestfs-actions.pod:4886
12716 msgid "See also C<guestfs_pread>."
12720 #: ../src/guestfs-actions.pod:4895
12721 msgid "(Added in 1.5.21)"
12725 #: ../src/guestfs-actions.pod:4897
12726 msgid "guestfs_pvcreate"
12730 #: ../src/guestfs-actions.pod:4899
12734 " guestfs_pvcreate (guestfs_h *g,\n"
12735 " const char *device);\n"
12740 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3285
12742 "This creates an LVM physical volume on the named C<device>, where C<device> "
12743 "should usually be a partition name such as C</dev/sda1>."
12747 #: ../src/guestfs-actions.pod:4911
12748 msgid "guestfs_pvremove"
12752 #: ../src/guestfs-actions.pod:4913
12756 " guestfs_pvremove (guestfs_h *g,\n"
12757 " const char *device);\n"
12762 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3293
12764 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12769 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3296
12771 "The implementation uses the C<pvremove> command which refuses to wipe "
12772 "physical volumes that contain any volume groups, so you have to remove those "
12777 #: ../src/guestfs-actions.pod:4928
12778 msgid "guestfs_pvresize"
12782 #: ../src/guestfs-actions.pod:4930
12786 " guestfs_pvresize (guestfs_h *g,\n"
12787 " const char *device);\n"
12792 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3304
12794 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12795 "the new size of the underlying device."
12799 #: ../src/guestfs-actions.pod:4941
12800 msgid "guestfs_pvresize_size"
12804 #: ../src/guestfs-actions.pod:4943
12808 " guestfs_pvresize_size (guestfs_h *g,\n"
12809 " const char *device,\n"
12810 " int64_t size);\n"
12815 #: ../src/guestfs-actions.pod:4948
12817 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12818 "specify the new size (in bytes) explicitly."
12822 #: ../src/guestfs-actions.pod:4955
12823 msgid "guestfs_pvs"
12827 #: ../src/guestfs-actions.pod:4957
12831 " guestfs_pvs (guestfs_h *g);\n"
12836 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3318
12838 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12843 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3321
12845 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12850 #: ../src/guestfs-actions.pod:4966
12851 msgid "See also C<guestfs_pvs_full>."
12855 #: ../src/guestfs-actions.pod:4974
12856 msgid "guestfs_pvs_full"
12860 #: ../src/guestfs-actions.pod:4976
12863 " struct guestfs_lvm_pv_list *\n"
12864 " guestfs_pvs_full (guestfs_h *g);\n"
12869 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3330
12871 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12872 "(8)> command. The \"full\" version includes all fields."
12876 #: ../src/guestfs-actions.pod:4982
12878 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12879 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12883 #: ../src/guestfs-actions.pod:4988
12884 msgid "guestfs_pvuuid"
12888 #: ../src/guestfs-actions.pod:4990
12892 " guestfs_pvuuid (guestfs_h *g,\n"
12893 " const char *device);\n"
12898 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3337
12899 msgid "This command returns the UUID of the LVM PV C<device>."
12903 #: ../src/guestfs-actions.pod:5001
12904 msgid "guestfs_pwrite"
12908 #: ../src/guestfs-actions.pod:5003
12912 " guestfs_pwrite (guestfs_h *g,\n"
12913 " const char *path,\n"
12914 " const char *content,\n"
12915 " size_t content_size,\n"
12916 " int64_t offset);\n"
12921 #: ../src/guestfs-actions.pod:5010 ../fish/guestfish-actions.pod:3343
12923 "This command writes to part of a file. It writes the data buffer C<content> "
12924 "to the file C<path> starting at offset C<offset>."
12928 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3346
12930 "This command implements the L<pwrite(2)> system call, and like that system "
12931 "call it may not write the full data requested. The return value is the "
12932 "number of bytes that were actually written to the file. This could even be "
12933 "0, although short writes are unlikely for regular files in ordinary "
12938 #: ../src/guestfs-actions.pod:5019
12939 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12943 #: ../src/guestfs-actions.pod:5028
12944 msgid "guestfs_pwrite_device"
12948 #: ../src/guestfs-actions.pod:5030
12952 " guestfs_pwrite_device (guestfs_h *g,\n"
12953 " const char *device,\n"
12954 " const char *content,\n"
12955 " size_t content_size,\n"
12956 " int64_t offset);\n"
12961 #: ../src/guestfs-actions.pod:5037 ../fish/guestfish-actions.pod:3361
12963 "This command writes to part of a device. It writes the data buffer "
12964 "C<content> to C<device> starting at offset C<offset>."
12968 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3364
12970 "This command implements the L<pwrite(2)> system call, and like that system "
12971 "call it may not write the full data requested (although short writes to disk "
12972 "devices and partitions are probably impossible with standard Linux kernels)."
12976 #: ../src/guestfs-actions.pod:5045
12977 msgid "See also C<guestfs_pwrite>."
12981 #: ../src/guestfs-actions.pod:5052
12982 msgid "(Added in 1.5.20)"
12986 #: ../src/guestfs-actions.pod:5054
12987 msgid "guestfs_read_file"
12991 #: ../src/guestfs-actions.pod:5056
12995 " guestfs_read_file (guestfs_h *g,\n"
12996 " const char *path,\n"
12997 " size_t *size_r);\n"
13002 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3378
13003 msgid "This calls returns the contents of the file C<path> as a buffer."
13007 #: ../src/guestfs-actions.pod:5064
13009 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13010 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13011 "function is limited in the total size of file that can be handled."
13015 #: ../src/guestfs-actions.pod:5076
13016 msgid "(Added in 1.0.63)"
13020 #: ../src/guestfs-actions.pod:5078
13021 msgid "guestfs_read_lines"
13025 #: ../src/guestfs-actions.pod:5080
13029 " guestfs_read_lines (guestfs_h *g,\n"
13030 " const char *path);\n"
13035 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3395
13037 "The file contents are returned as a list of lines. Trailing C<LF> and "
13038 "C<CRLF> character sequences are I<not> returned."
13042 #: ../src/guestfs-actions.pod:5089
13044 "Note that this function cannot correctly handle binary files (specifically, "
13045 "files containing C<\\0> character which is treated as end of line). For "
13046 "those you need to use the C<guestfs_read_file> function which has a more "
13047 "complex interface."
13051 #: ../src/guestfs-actions.pod:5100
13052 msgid "guestfs_readdir"
13056 #: ../src/guestfs-actions.pod:5102
13059 " struct guestfs_dirent_list *\n"
13060 " guestfs_readdir (guestfs_h *g,\n"
13061 " const char *dir);\n"
13066 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3407
13067 msgid "This returns the list of directory entries in directory C<dir>."
13071 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3409
13073 "All entries in the directory are returned, including C<.> and C<..>. The "
13074 "entries are I<not> sorted, but returned in the same order as the underlying "
13079 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3413
13081 "Also this call returns basic file type information about each file. The "
13082 "C<ftyp> field will contain one of the following characters:"
13086 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3418
13091 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3420
13092 msgid "Block special"
13096 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3422
13101 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3424
13102 msgid "Char special"
13106 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3426
13111 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3428
13116 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3430
13121 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3432
13122 msgid "FIFO (named pipe)"
13126 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3434
13131 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3436
13132 msgid "Symbolic link"
13136 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3438
13141 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3440
13142 msgid "Regular file"
13146 #: ../src/guestfs-actions.pod:5141 ../fish/guestfish-actions.pod:3442
13151 #: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3444
13156 #: ../src/guestfs-actions.pod:5145 ../fish/guestfish-actions.pod:3446
13161 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3448
13162 msgid "Unknown file type"
13166 #: ../src/guestfs-actions.pod:5149 ../fish/guestfish-actions.pod:3450
13171 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3452
13173 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13177 #: ../src/guestfs-actions.pod:5156
13179 "This function is primarily intended for use by programs. To get a simple "
13180 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13181 "consumption, use C<guestfs_ll>."
13185 #: ../src/guestfs-actions.pod:5160
13187 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13188 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13192 #: ../src/guestfs-actions.pod:5166
13193 msgid "guestfs_readlink"
13197 #: ../src/guestfs-actions.pod:5168
13201 " guestfs_readlink (guestfs_h *g,\n"
13202 " const char *path);\n"
13207 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3465
13208 msgid "This command reads the target of a symbolic link."
13212 #: ../src/guestfs-actions.pod:5179
13213 msgid "guestfs_readlinklist"
13217 #: ../src/guestfs-actions.pod:5181
13221 " guestfs_readlinklist (guestfs_h *g,\n"
13222 " const char *path,\n"
13223 " char *const *names);\n"
13228 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3471
13230 "This call allows you to do a C<readlink> operation on multiple files, where "
13231 "all files are in the directory C<path>. C<names> is the list of files from "
13236 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3475
13238 "On return you get a list of strings, with a one-to-one correspondence to the "
13239 "C<names> list. Each string is the value of the symbolic link."
13243 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:3479
13245 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13246 "result string is the empty string C<\"\">. However the whole operation is "
13247 "completed even if there were C<readlink(2)> errors, and so you can call this "
13248 "function with names where you don't know if they are symbolic links already "
13249 "(albeit slightly less efficient)."
13253 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3486
13255 "This call is intended for programs that want to efficiently list a directory "
13256 "contents without making many round-trips. Very long directory listings "
13257 "might cause the protocol message size to be exceeded, causing this call to "
13258 "fail. The caller must split up such requests into smaller groups of names."
13262 #: ../src/guestfs-actions.pod:5214
13263 msgid "guestfs_realpath"
13267 #: ../src/guestfs-actions.pod:5216
13271 " guestfs_realpath (guestfs_h *g,\n"
13272 " const char *path);\n"
13277 #: ../src/guestfs-actions.pod:5220 ../fish/guestfish-actions.pod:3497
13279 "Return the canonicalized absolute pathname of C<path>. The returned path "
13280 "has no C<.>, C<..> or symbolic link path elements."
13284 #: ../src/guestfs-actions.pod:5228
13285 msgid "guestfs_removexattr"
13289 #: ../src/guestfs-actions.pod:5230
13293 " guestfs_removexattr (guestfs_h *g,\n"
13294 " const char *xattr,\n"
13295 " const char *path);\n"
13300 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3504
13302 "This call removes the extended attribute named C<xattr> of the file C<path>."
13306 #: ../src/guestfs-actions.pod:5238
13307 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13311 #: ../src/guestfs-actions.pod:5244
13312 msgid "guestfs_resize2fs"
13316 #: ../src/guestfs-actions.pod:5246
13320 " guestfs_resize2fs (guestfs_h *g,\n"
13321 " const char *device);\n"
13326 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3513
13328 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13329 "underlying device."
13333 #: ../src/guestfs-actions.pod:5253
13335 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13336 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13337 "sometimes gives an error about this and sometimes not. In any case, it is "
13338 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13342 #: ../src/guestfs-actions.pod:5263
13343 msgid "guestfs_resize2fs_size"
13347 #: ../src/guestfs-actions.pod:5265
13351 " guestfs_resize2fs_size (guestfs_h *g,\n"
13352 " const char *device,\n"
13353 " int64_t size);\n"
13358 #: ../src/guestfs-actions.pod:5270
13360 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13361 "to specify the new size (in bytes) explicitly."
13365 #: ../src/guestfs-actions.pod:5277
13370 #: ../src/guestfs-actions.pod:5279
13374 " guestfs_rm (guestfs_h *g,\n"
13375 " const char *path);\n"
13380 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3533
13381 msgid "Remove the single file C<path>."
13385 #: ../src/guestfs-actions.pod:5289
13386 msgid "guestfs_rm_rf"
13390 #: ../src/guestfs-actions.pod:5291
13394 " guestfs_rm_rf (guestfs_h *g,\n"
13395 " const char *path);\n"
13400 #: ../src/guestfs-actions.pod:5295 ../fish/guestfish-actions.pod:3539
13402 "Remove the file or directory C<path>, recursively removing the contents if "
13403 "its a directory. This is like the C<rm -rf> shell command."
13407 #: ../src/guestfs-actions.pod:5303
13408 msgid "guestfs_rmdir"
13412 #: ../src/guestfs-actions.pod:5305
13416 " guestfs_rmdir (guestfs_h *g,\n"
13417 " const char *path);\n"
13422 #: ../src/guestfs-actions.pod:5309 ../fish/guestfish-actions.pod:3547
13423 msgid "Remove the single directory C<path>."
13427 #: ../src/guestfs-actions.pod:5315
13428 msgid "guestfs_rmmountpoint"
13432 #: ../src/guestfs-actions.pod:5317
13436 " guestfs_rmmountpoint (guestfs_h *g,\n"
13437 " const char *exemptpath);\n"
13442 #: ../src/guestfs-actions.pod:5321
13444 "This calls removes a mountpoint that was previously created with "
13445 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13449 #: ../src/guestfs-actions.pod:5329
13450 msgid "guestfs_scrub_device"
13454 #: ../src/guestfs-actions.pod:5331
13458 " guestfs_scrub_device (guestfs_h *g,\n"
13459 " const char *device);\n"
13464 #: ../src/guestfs-actions.pod:5335 ../fish/guestfish-actions.pod:3561
13466 "This command writes patterns over C<device> to make data retrieval more "
13471 #: ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5359
13472 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3564
13473 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13475 "It is an interface to the L<scrub(1)> program. See that manual page for "
13480 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5364
13481 #: ../src/guestfs-actions.pod:5383
13482 msgid "(Added in 1.0.52)"
13486 #: ../src/guestfs-actions.pod:5348
13487 msgid "guestfs_scrub_file"
13491 #: ../src/guestfs-actions.pod:5350
13495 " guestfs_scrub_file (guestfs_h *g,\n"
13496 " const char *file);\n"
13501 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3574
13503 "This command writes patterns over a file to make data retrieval more "
13508 #: ../src/guestfs-actions.pod:5357 ../fish/guestfish-actions.pod:3577
13509 msgid "The file is I<removed> after scrubbing."
13513 #: ../src/guestfs-actions.pod:5366
13514 msgid "guestfs_scrub_freespace"
13518 #: ../src/guestfs-actions.pod:5368
13522 " guestfs_scrub_freespace (guestfs_h *g,\n"
13523 " const char *dir);\n"
13528 #: ../src/guestfs-actions.pod:5372
13530 "This command creates the directory C<dir> and then fills it with files until "
13531 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13532 "and deletes them. The intention is to scrub any free space on the partition "
13533 "containing C<dir>."
13537 #: ../src/guestfs-actions.pod:5385
13538 msgid "guestfs_set_append"
13542 #: ../src/guestfs-actions.pod:5387
13546 " guestfs_set_append (guestfs_h *g,\n"
13547 " const char *append);\n"
13552 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3601
13554 "This function is used to add additional options to the guest kernel command "
13559 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3604
13561 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13562 "environment variable."
13566 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3607
13568 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13569 "(libguestfs always adds a few of its own)."
13573 #: ../src/guestfs-actions.pod:5404
13574 msgid "guestfs_set_autosync"
13578 #: ../src/guestfs-actions.pod:5406
13582 " guestfs_set_autosync (guestfs_h *g,\n"
13583 " int autosync);\n"
13588 #: ../src/guestfs-actions.pod:5410
13590 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13591 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13592 "the handle is closed (also if the program exits without closing handles)."
13596 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3621
13598 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13599 "disabled by default)."
13603 #: ../src/guestfs-actions.pod:5422
13604 msgid "guestfs_set_direct"
13608 #: ../src/guestfs-actions.pod:5424
13612 " guestfs_set_direct (guestfs_h *g,\n"
13618 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3630
13620 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13621 "passed directly through to the appliance once it is launched."
13625 #: ../src/guestfs-actions.pod:5432
13627 "One consequence of this is that log messages aren't caught by the library "
13628 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13633 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3638
13634 msgid "You probably don't want to use this unless you know what you are doing."
13638 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3641
13639 msgid "The default is disabled."
13643 #: ../src/guestfs-actions.pod:5445
13644 msgid "guestfs_set_e2label"
13648 #: ../src/guestfs-actions.pod:5447
13652 " guestfs_set_e2label (guestfs_h *g,\n"
13653 " const char *device,\n"
13654 " const char *label);\n"
13659 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3647
13661 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13662 "C<label>. Filesystem labels are limited to 16 characters."
13666 #: ../src/guestfs-actions.pod:5456
13668 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13669 "the existing label on a filesystem."
13673 #: ../src/guestfs-actions.pod:5463
13674 msgid "guestfs_set_e2uuid"
13678 #: ../src/guestfs-actions.pod:5465
13682 " guestfs_set_e2uuid (guestfs_h *g,\n"
13683 " const char *device,\n"
13684 " const char *uuid);\n"
13689 #: ../src/guestfs-actions.pod:5470 ../fish/guestfish-actions.pod:3658
13691 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13692 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13693 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13697 #: ../src/guestfs-actions.pod:5475
13699 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13700 "the existing UUID of a filesystem."
13704 #: ../src/guestfs-actions.pod:5482
13705 msgid "guestfs_set_memsize"
13709 #: ../src/guestfs-actions.pod:5484
13713 " guestfs_set_memsize (guestfs_h *g,\n"
13719 #: ../src/guestfs-actions.pod:5488
13721 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13722 "This only has any effect if called before C<guestfs_launch>."
13726 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3676
13728 "You can also change this by setting the environment variable "
13729 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13733 #: ../src/guestfs-actions.pod:5503
13734 msgid "guestfs_set_network"
13738 #: ../src/guestfs-actions.pod:5505
13742 " guestfs_set_network (guestfs_h *g,\n"
13748 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3689
13750 "If C<network> is true, then the network is enabled in the libguestfs "
13751 "appliance. The default is false."
13755 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3692
13757 "This affects whether commands are able to access the network (see L<guestfs"
13758 "(3)/RUNNING COMMANDS>)."
13762 #: ../src/guestfs-actions.pod:5515
13764 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13769 #: ../src/guestfs-actions.pod:5522
13770 msgid "guestfs_set_path"
13774 #: ../src/guestfs-actions.pod:5524
13778 " guestfs_set_path (guestfs_h *g,\n"
13779 " const char *searchpath);\n"
13784 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3704
13785 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13789 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3706
13791 "The default is C<$libdir/guestfs> unless overridden by setting "
13792 "C<LIBGUESTFS_PATH> environment variable."
13796 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3709
13797 msgid "Setting C<path> to C<NULL> restores the default path."
13801 #: ../src/guestfs-actions.pod:5539
13802 msgid "guestfs_set_qemu"
13806 #: ../src/guestfs-actions.pod:5541
13810 " guestfs_set_qemu (guestfs_h *g,\n"
13811 " const char *qemu);\n"
13816 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3717
13817 msgid "Set the qemu binary that we will use."
13821 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3719
13823 "The default is chosen when the library was compiled by the configure script."
13827 #: ../src/guestfs-actions.pod:5550 ../fish/guestfish-actions.pod:3722
13829 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13834 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3725
13835 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13839 #: ../src/guestfs-actions.pod:5555 ../fish/guestfish-actions.pod:3727
13841 "Note that you should call this function as early as possible after creating "
13842 "the handle. This is because some pre-launch operations depend on testing "
13843 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13844 "don't retest features, and so you might see inconsistent results. Using the "
13845 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13846 "the qemu binary at the same time as the handle is created."
13850 #: ../src/guestfs-actions.pod:5567
13851 msgid "guestfs_set_recovery_proc"
13855 #: ../src/guestfs-actions.pod:5569
13859 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13860 " int recoveryproc);\n"
13865 #: ../src/guestfs-actions.pod:5573
13867 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13868 "not create a recovery process. The purpose of the recovery process is to "
13869 "stop runaway qemu processes in the case where the main program aborts "
13874 #: ../src/guestfs-actions.pod:5578
13876 "This only has any effect if called before C<guestfs_launch>, and the default "
13881 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3749
13883 "About the only time when you would want to disable this is if the main "
13884 "process will fork itself into the background (\"daemonize\" itself). In "
13885 "this case the recovery process thinks that the main program has disappeared "
13886 "and so kills qemu, which is not very helpful."
13890 #: ../src/guestfs-actions.pod:5591
13891 msgid "guestfs_set_selinux"
13895 #: ../src/guestfs-actions.pod:5593
13899 " guestfs_set_selinux (guestfs_h *g,\n"
13905 #: ../src/guestfs-actions.pod:5597 ../fish/guestfish-actions.pod:3761
13907 "This sets the selinux flag that is passed to the appliance at boot time. "
13908 "The default is C<selinux=0> (disabled)."
13912 #: ../src/guestfs-actions.pod:5600 ../fish/guestfish-actions.pod:3764
13914 "Note that if SELinux is enabled, it is always in Permissive mode "
13915 "(C<enforcing=0>)."
13919 #: ../src/guestfs-actions.pod:5610
13920 msgid "guestfs_set_trace"
13924 #: ../src/guestfs-actions.pod:5612
13928 " guestfs_set_trace (guestfs_h *g,\n"
13934 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3776
13936 "If the command trace flag is set to 1, then commands are printed on stderr "
13937 "before they are executed in a format which is very similar to the one used "
13938 "by guestfish. In other words, you can run a program with this enabled, and "
13939 "you will get out a script which you can feed to guestfish to perform the "
13940 "same set of actions."
13944 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3783
13946 "If you want to trace C API calls into libguestfs (and other libraries) then "
13947 "possibly a better way is to use the external ltrace(1) command."
13951 #: ../src/guestfs-actions.pod:5627 ../fish/guestfish-actions.pod:3787
13953 "Command traces are disabled unless the environment variable "
13954 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13958 #: ../src/guestfs-actions.pod:5634
13959 msgid "guestfs_set_verbose"
13963 #: ../src/guestfs-actions.pod:5636
13967 " guestfs_set_verbose (guestfs_h *g,\n"
13973 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:3796
13974 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13978 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3798
13980 "Verbose messages are disabled unless the environment variable "
13981 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13985 #: ../src/guestfs-actions.pod:5649
13986 msgid "guestfs_setcon"
13990 #: ../src/guestfs-actions.pod:5651
13994 " guestfs_setcon (guestfs_h *g,\n"
13995 " const char *context);\n"
14000 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3805
14002 "This sets the SELinux security context of the daemon to the string "
14007 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3808
14008 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14012 #: ../src/guestfs-actions.pod:5664
14013 msgid "guestfs_setxattr"
14017 #: ../src/guestfs-actions.pod:5666
14021 " guestfs_setxattr (guestfs_h *g,\n"
14022 " const char *xattr,\n"
14023 " const char *val,\n"
14025 " const char *path);\n"
14030 #: ../src/guestfs-actions.pod:5673 ../fish/guestfish-actions.pod:3814
14032 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14033 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14037 #: ../src/guestfs-actions.pod:5677
14038 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14042 #: ../src/guestfs-actions.pod:5683
14043 msgid "guestfs_sfdisk"
14047 #: ../src/guestfs-actions.pod:5685
14051 " guestfs_sfdisk (guestfs_h *g,\n"
14052 " const char *device,\n"
14056 " char *const *lines);\n"
14061 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3824
14063 "This is a direct interface to the L<sfdisk(8)> program for creating "
14064 "partitions on block devices."
14068 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3827
14069 msgid "C<device> should be a block device, for example C</dev/sda>."
14073 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3829
14075 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14076 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14077 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14078 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14079 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14080 "the kernel) cannot work out the right geometry and you will need to tell it."
14084 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3837
14086 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14087 "refer to the L<sfdisk(8)> manpage."
14091 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3840
14093 "To create a single partition occupying the whole disk, you would pass "
14094 "C<lines> as a single element list, when the single element being the string "
14099 #: ../src/guestfs-actions.pod:5713
14101 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14105 #: ../src/guestfs-actions.pod:5723
14106 msgid "guestfs_sfdiskM"
14110 #: ../src/guestfs-actions.pod:5725
14114 " guestfs_sfdiskM (guestfs_h *g,\n"
14115 " const char *device,\n"
14116 " char *const *lines);\n"
14121 #: ../src/guestfs-actions.pod:5730
14123 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14124 "partition sizes are specified in megabytes only (rounded to the nearest "
14125 "cylinder) and you don't need to specify the cyls, heads and sectors "
14126 "parameters which were rarely if ever used anyway."
14130 #: ../src/guestfs-actions.pod:5736
14132 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14133 "C<guestfs_part_disk>"
14137 #: ../src/guestfs-actions.pod:5746
14138 msgid "guestfs_sfdisk_N"
14142 #: ../src/guestfs-actions.pod:5748
14146 " guestfs_sfdisk_N (guestfs_h *g,\n"
14147 " const char *device,\n"
14152 " const char *line);\n"
14157 #: ../src/guestfs-actions.pod:5757 ../fish/guestfish-actions.pod:3870
14159 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14160 "(note: C<n> counts from 1)."
14164 #: ../src/guestfs-actions.pod:5760
14166 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14167 "for the cyls/heads/sectors parameters."
14171 #: ../src/guestfs-actions.pod:5763
14172 msgid "See also: C<guestfs_part_add>"
14176 #: ../src/guestfs-actions.pod:5772
14177 msgid "guestfs_sfdisk_disk_geometry"
14181 #: ../src/guestfs-actions.pod:5774
14185 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14186 " const char *device);\n"
14191 #: ../src/guestfs-actions.pod:5778
14193 "This displays the disk geometry of C<device> read from the partition table. "
14194 "Especially in the case where the underlying block device has been resized, "
14195 "this can be different from the kernel's idea of the geometry (see "
14196 "C<guestfs_sfdisk_kernel_geometry>)."
14200 #: ../src/guestfs-actions.pod:5783 ../src/guestfs-actions.pod:5799
14201 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14202 msgid "The result is in human-readable format, and not designed to be parsed."
14206 #: ../src/guestfs-actions.pod:5791
14207 msgid "guestfs_sfdisk_kernel_geometry"
14211 #: ../src/guestfs-actions.pod:5793
14215 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14216 " const char *device);\n"
14221 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3897
14222 msgid "This displays the kernel's idea of the geometry of C<device>."
14226 #: ../src/guestfs-actions.pod:5807
14227 msgid "guestfs_sfdisk_l"
14231 #: ../src/guestfs-actions.pod:5809
14235 " guestfs_sfdisk_l (guestfs_h *g,\n"
14236 " const char *device);\n"
14241 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3906
14243 "This displays the partition table on C<device>, in the human-readable output "
14244 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14248 #: ../src/guestfs-actions.pod:5817
14249 msgid "See also: C<guestfs_part_list>"
14253 #: ../src/guestfs-actions.pod:5824
14258 #: ../src/guestfs-actions.pod:5826
14262 " guestfs_sh (guestfs_h *g,\n"
14263 " const char *command);\n"
14268 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3916
14270 "This call runs a command from the guest filesystem via the guest's C</bin/"
14275 #: ../src/guestfs-actions.pod:5833
14276 msgid "This is like C<guestfs_command>, but passes the command to:"
14280 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3921
14283 " /bin/sh -c \"command\"\n"
14288 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3923
14290 "Depending on the guest's shell, this usually results in wildcards being "
14291 "expanded, shell expressions being interpolated and so on."
14295 #: ../src/guestfs-actions.pod:5841
14296 msgid "All the provisos about C<guestfs_command> apply to this call."
14300 #: ../src/guestfs-actions.pod:5848
14301 msgid "guestfs_sh_lines"
14305 #: ../src/guestfs-actions.pod:5850
14309 " guestfs_sh_lines (guestfs_h *g,\n"
14310 " const char *command);\n"
14315 #: ../src/guestfs-actions.pod:5854
14317 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14322 #: ../src/guestfs-actions.pod:5857
14323 msgid "See also: C<guestfs_command_lines>"
14327 #: ../src/guestfs-actions.pod:5865
14328 msgid "guestfs_sleep"
14332 #: ../src/guestfs-actions.pod:5867
14336 " guestfs_sleep (guestfs_h *g,\n"
14342 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3942
14343 msgid "Sleep for C<secs> seconds."
14347 #: ../src/guestfs-actions.pod:5875
14348 msgid "(Added in 1.0.41)"
14352 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-structs.pod:109
14353 msgid "guestfs_stat"
14357 #: ../src/guestfs-actions.pod:5879
14360 " struct guestfs_stat *\n"
14361 " guestfs_stat (guestfs_h *g,\n"
14362 " const char *path);\n"
14367 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3950
14368 msgid "This is the same as the C<stat(2)> system call."
14372 #: ../src/guestfs-actions.pod:5893 ../src/guestfs-structs.pod:135
14373 msgid "guestfs_statvfs"
14377 #: ../src/guestfs-actions.pod:5895
14380 " struct guestfs_statvfs *\n"
14381 " guestfs_statvfs (guestfs_h *g,\n"
14382 " const char *path);\n"
14387 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3956
14389 "Returns file system statistics for any mounted file system. C<path> should "
14390 "be a file or directory in the mounted file system (typically it is the mount "
14391 "point itself, but it doesn't need to be)."
14395 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3960
14396 msgid "This is the same as the C<statvfs(2)> system call."
14400 #: ../src/guestfs-actions.pod:5905
14402 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14403 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14407 #: ../src/guestfs-actions.pod:5911
14408 msgid "guestfs_strings"
14412 #: ../src/guestfs-actions.pod:5913
14416 " guestfs_strings (guestfs_h *g,\n"
14417 " const char *path);\n"
14422 #: ../src/guestfs-actions.pod:5917 ../fish/guestfish-actions.pod:3966
14424 "This runs the L<strings(1)> command on a file and returns the list of "
14425 "printable strings found."
14429 #: ../src/guestfs-actions.pod:5929
14430 msgid "guestfs_strings_e"
14434 #: ../src/guestfs-actions.pod:5931
14438 " guestfs_strings_e (guestfs_h *g,\n"
14439 " const char *encoding,\n"
14440 " const char *path);\n"
14445 #: ../src/guestfs-actions.pod:5936
14447 "This is like the C<guestfs_strings> command, but allows you to specify the "
14448 "encoding of strings that are looked for in the source file C<path>."
14452 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:3980
14453 msgid "Allowed encodings are:"
14457 #: ../src/guestfs-actions.pod:5944 ../fish/guestfish-actions.pod:3984
14462 #: ../src/guestfs-actions.pod:5946
14464 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14465 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14469 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:3989
14474 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3991
14475 msgid "Single 8-bit-byte characters."
14479 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3993
14484 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:3995
14485 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14489 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3998
14490 msgid "l (lower case letter L)"
14494 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4000
14496 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14497 "examining binaries in Windows guests."
14501 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:4003
14506 #: ../src/guestfs-actions.pod:5965 ../fish/guestfish-actions.pod:4005
14507 msgid "32-bit big endian such as UCS-4BE."
14511 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:4007
14516 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4009
14517 msgid "32-bit little endian such as UCS-4LE."
14521 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4013
14522 msgid "The returned strings are transcoded to UTF-8."
14526 #: ../src/guestfs-actions.pod:5984
14527 msgid "guestfs_swapoff_device"
14531 #: ../src/guestfs-actions.pod:5986
14535 " guestfs_swapoff_device (guestfs_h *g,\n"
14536 " const char *device);\n"
14541 #: ../src/guestfs-actions.pod:5990
14543 "This command disables the libguestfs appliance swap device or partition "
14544 "named C<device>. See C<guestfs_swapon_device>."
14548 #: ../src/guestfs-actions.pod:5998
14549 msgid "guestfs_swapoff_file"
14553 #: ../src/guestfs-actions.pod:6000
14557 " guestfs_swapoff_file (guestfs_h *g,\n"
14558 " const char *file);\n"
14563 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4030
14564 msgid "This command disables the libguestfs appliance swap on file."
14568 #: ../src/guestfs-actions.pod:6010
14569 msgid "guestfs_swapoff_label"
14573 #: ../src/guestfs-actions.pod:6012
14577 " guestfs_swapoff_label (guestfs_h *g,\n"
14578 " const char *label);\n"
14583 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4036
14585 "This command disables the libguestfs appliance swap on labeled swap "
14590 #: ../src/guestfs-actions.pod:6023
14591 msgid "guestfs_swapoff_uuid"
14595 #: ../src/guestfs-actions.pod:6025
14599 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14600 " const char *uuid);\n"
14605 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4043
14607 "This command disables the libguestfs appliance swap partition with the given "
14612 #: ../src/guestfs-actions.pod:6036
14613 msgid "guestfs_swapon_device"
14617 #: ../src/guestfs-actions.pod:6038
14621 " guestfs_swapon_device (guestfs_h *g,\n"
14622 " const char *device);\n"
14627 #: ../src/guestfs-actions.pod:6042
14629 "This command enables the libguestfs appliance to use the swap device or "
14630 "partition named C<device>. The increased memory is made available for all "
14631 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14635 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4055
14637 "Note that you should not swap to existing guest swap partitions unless you "
14638 "know what you are doing. They may contain hibernation information, or other "
14639 "information that the guest doesn't want you to trash. You also risk leaking "
14640 "information about the host to the guest this way. Instead, attach a new "
14641 "host device to the guest and swap on that."
14645 #: ../src/guestfs-actions.pod:6058
14646 msgid "guestfs_swapon_file"
14650 #: ../src/guestfs-actions.pod:6060
14654 " guestfs_swapon_file (guestfs_h *g,\n"
14655 " const char *file);\n"
14660 #: ../src/guestfs-actions.pod:6064
14662 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14667 #: ../src/guestfs-actions.pod:6071
14668 msgid "guestfs_swapon_label"
14672 #: ../src/guestfs-actions.pod:6073
14676 " guestfs_swapon_label (guestfs_h *g,\n"
14677 " const char *label);\n"
14682 #: ../src/guestfs-actions.pod:6077
14684 "This command enables swap to a labeled swap partition. See "
14685 "C<guestfs_swapon_device> for other notes."
14689 #: ../src/guestfs-actions.pod:6084
14690 msgid "guestfs_swapon_uuid"
14694 #: ../src/guestfs-actions.pod:6086
14698 " guestfs_swapon_uuid (guestfs_h *g,\n"
14699 " const char *uuid);\n"
14704 #: ../src/guestfs-actions.pod:6090
14706 "This command enables swap to a swap partition with the given UUID. See "
14707 "C<guestfs_swapon_device> for other notes."
14711 #: ../src/guestfs-actions.pod:6097
14712 msgid "guestfs_sync"
14716 #: ../src/guestfs-actions.pod:6099
14720 " guestfs_sync (guestfs_h *g);\n"
14725 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4087
14727 "This syncs the disk, so that any writes are flushed through to the "
14728 "underlying disk image."
14732 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4090
14734 "You should always call this if you have modified a disk image, before "
14735 "closing the handle."
14739 #: ../src/guestfs-actions.pod:6112
14740 msgid "guestfs_tail"
14744 #: ../src/guestfs-actions.pod:6114
14748 " guestfs_tail (guestfs_h *g,\n"
14749 " const char *path);\n"
14754 #: ../src/guestfs-actions.pod:6118 ../fish/guestfish-actions.pod:4097
14756 "This command returns up to the last 10 lines of a file as a list of strings."
14760 #: ../src/guestfs-actions.pod:6130
14761 msgid "guestfs_tail_n"
14765 #: ../src/guestfs-actions.pod:6132
14769 " guestfs_tail_n (guestfs_h *g,\n"
14771 " const char *path);\n"
14776 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4107
14778 "If the parameter C<nrlines> is a positive number, this returns the last "
14779 "C<nrlines> lines of the file C<path>."
14783 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4110
14785 "If the parameter C<nrlines> is a negative number, this returns lines from "
14786 "the file C<path>, starting with the C<-nrlines>th line."
14790 #: ../src/guestfs-actions.pod:6154
14791 msgid "guestfs_tar_in"
14795 #: ../src/guestfs-actions.pod:6156
14799 " guestfs_tar_in (guestfs_h *g,\n"
14800 " const char *tarfile,\n"
14801 " const char *directory);\n"
14806 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4122
14808 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14809 "tar file) into C<directory>."
14813 #: ../src/guestfs-actions.pod:6164
14815 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14819 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6186
14820 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6218
14821 msgid "(Added in 1.0.3)"
14825 #: ../src/guestfs-actions.pod:6171
14826 msgid "guestfs_tar_out"
14830 #: ../src/guestfs-actions.pod:6173
14834 " guestfs_tar_out (guestfs_h *g,\n"
14835 " const char *directory,\n"
14836 " const char *tarfile);\n"
14841 #: ../src/guestfs-actions.pod:6178 ../fish/guestfish-actions.pod:4134
14843 "This command packs the contents of C<directory> and downloads it to local "
14848 #: ../src/guestfs-actions.pod:6181
14850 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14851 "C<guestfs_txz_out>."
14855 #: ../src/guestfs-actions.pod:6188
14856 msgid "guestfs_tgz_in"
14860 #: ../src/guestfs-actions.pod:6190
14864 " guestfs_tgz_in (guestfs_h *g,\n"
14865 " const char *tarball,\n"
14866 " const char *directory);\n"
14871 #: ../src/guestfs-actions.pod:6195 ../fish/guestfish-actions.pod:4146
14873 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14874 "tar file) into C<directory>."
14878 #: ../src/guestfs-actions.pod:6198
14879 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14883 #: ../src/guestfs-actions.pod:6204
14884 msgid "guestfs_tgz_out"
14888 #: ../src/guestfs-actions.pod:6206
14892 " guestfs_tgz_out (guestfs_h *g,\n"
14893 " const char *directory,\n"
14894 " const char *tarball);\n"
14899 #: ../src/guestfs-actions.pod:6211 ../fish/guestfish-actions.pod:4157
14901 "This command packs the contents of C<directory> and downloads it to local "
14906 #: ../src/guestfs-actions.pod:6214
14907 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14911 #: ../src/guestfs-actions.pod:6220
14912 msgid "guestfs_touch"
14916 #: ../src/guestfs-actions.pod:6222
14920 " guestfs_touch (guestfs_h *g,\n"
14921 " const char *path);\n"
14926 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4168
14928 "Touch acts like the L<touch(1)> command. It can be used to update the "
14929 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14934 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4172
14936 "This command only works on regular files, and will fail on other file types "
14937 "such as directories, symbolic links, block special etc."
14941 #: ../src/guestfs-actions.pod:6237
14942 msgid "guestfs_truncate"
14946 #: ../src/guestfs-actions.pod:6239
14950 " guestfs_truncate (guestfs_h *g,\n"
14951 " const char *path);\n"
14956 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4179
14958 "This command truncates C<path> to a zero-length file. The file must exist "
14963 #: ../src/guestfs-actions.pod:6250
14964 msgid "guestfs_truncate_size"
14968 #: ../src/guestfs-actions.pod:6252
14972 " guestfs_truncate_size (guestfs_h *g,\n"
14973 " const char *path,\n"
14974 " int64_t size);\n"
14979 #: ../src/guestfs-actions.pod:6257 ../fish/guestfish-actions.pod:4186
14981 "This command truncates C<path> to size C<size> bytes. The file must exist "
14986 #: ../src/guestfs-actions.pod:6260
14988 "If the current file size is less than C<size> then the file is extended to "
14989 "the required size with zero bytes. This creates a sparse file (ie. disk "
14990 "blocks are not allocated for the file until you write to it). To create a "
14991 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14995 #: ../src/guestfs-actions.pod:6270
14996 msgid "guestfs_tune2fs_l"
15000 #: ../src/guestfs-actions.pod:6272
15004 " guestfs_tune2fs_l (guestfs_h *g,\n"
15005 " const char *device);\n"
15010 #: ../src/guestfs-actions.pod:6276 ../fish/guestfish-actions.pod:4199
15012 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15017 #: ../src/guestfs-actions.pod:6279 ../fish/guestfish-actions.pod:4202
15019 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15020 "for more details. The list of fields returned isn't clearly defined, and "
15021 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15022 "and the filesystem itself."
15026 #: ../src/guestfs-actions.pod:6292
15027 msgid "guestfs_txz_in"
15031 #: ../src/guestfs-actions.pod:6294
15035 " guestfs_txz_in (guestfs_h *g,\n"
15036 " const char *tarball,\n"
15037 " const char *directory);\n"
15042 #: ../src/guestfs-actions.pod:6299 ../fish/guestfish-actions.pod:4211
15044 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15045 "tar file) into C<directory>."
15049 #: ../src/guestfs-actions.pod:6306
15050 msgid "guestfs_txz_out"
15054 #: ../src/guestfs-actions.pod:6308
15058 " guestfs_txz_out (guestfs_h *g,\n"
15059 " const char *directory,\n"
15060 " const char *tarball);\n"
15065 #: ../src/guestfs-actions.pod:6313 ../fish/guestfish-actions.pod:4220
15067 "This command packs the contents of C<directory> and downloads it to local "
15068 "file C<tarball> (as an xz compressed tar archive)."
15072 #: ../src/guestfs-actions.pod:6320
15073 msgid "guestfs_umask"
15077 #: ../src/guestfs-actions.pod:6322
15081 " guestfs_umask (guestfs_h *g,\n"
15087 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4229
15089 "This function sets the mask used for creating new files and device nodes to "
15094 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4232
15096 "Typical umask values would be C<022> which creates new files with "
15097 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15098 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15102 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4237
15104 "The default umask is C<022>. This is important because it means that "
15105 "directories and device nodes will be created with C<0644> or C<0755> mode "
15106 "even if you specify C<0777>."
15110 #: ../src/guestfs-actions.pod:6338
15112 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15113 "C<guestfs_mkdir>."
15117 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4244
15118 msgid "This call returns the previous umask."
15122 #: ../src/guestfs-actions.pod:6347
15123 msgid "guestfs_umount"
15127 #: ../src/guestfs-actions.pod:6349
15131 " guestfs_umount (guestfs_h *g,\n"
15132 " const char *pathordevice);\n"
15137 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4252
15139 "This unmounts the given filesystem. The filesystem may be specified either "
15140 "by its mountpoint (path) or the device which contains the filesystem."
15144 #: ../src/guestfs-actions.pod:6361
15145 msgid "guestfs_umount_all"
15149 #: ../src/guestfs-actions.pod:6363
15153 " guestfs_umount_all (guestfs_h *g);\n"
15158 #: ../src/guestfs-actions.pod:6366 ../fish/guestfish-actions.pod:4262
15159 msgid "This unmounts all mounted filesystems."
15163 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4264
15164 msgid "Some internal mounts are not unmounted by this call."
15168 #: ../src/guestfs-actions.pod:6374
15169 msgid "guestfs_upload"
15173 #: ../src/guestfs-actions.pod:6376
15177 " guestfs_upload (guestfs_h *g,\n"
15178 " const char *filename,\n"
15179 " const char *remotefilename);\n"
15184 #: ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6400
15185 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15186 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15190 #: ../src/guestfs-actions.pod:6386
15191 msgid "See also C<guestfs_download>."
15195 #: ../src/guestfs-actions.pod:6392
15196 msgid "guestfs_upload_offset"
15200 #: ../src/guestfs-actions.pod:6394
15204 " guestfs_upload_offset (guestfs_h *g,\n"
15205 " const char *filename,\n"
15206 " const char *remotefilename,\n"
15207 " int64_t offset);\n"
15212 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4286
15214 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15215 "The intention is to overwrite parts of existing files or devices, although "
15216 "if a non-existant file is specified then it is created with a \"hole\" "
15217 "before C<offset>. The size of the data written is implicit in the size of "
15218 "the source C<filename>."
15222 #: ../src/guestfs-actions.pod:6410
15224 "Note that there is no limit on the amount of data that can be uploaded with "
15225 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15226 "full amount unless an error occurs."
15230 #: ../src/guestfs-actions.pod:6415
15231 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15235 #: ../src/guestfs-actions.pod:6421
15236 msgid "guestfs_utimens"
15240 #: ../src/guestfs-actions.pod:6423
15244 " guestfs_utimens (guestfs_h *g,\n"
15245 " const char *path,\n"
15246 " int64_t atsecs,\n"
15247 " int64_t atnsecs,\n"
15248 " int64_t mtsecs,\n"
15249 " int64_t mtnsecs);\n"
15254 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4306
15255 msgid "This command sets the timestamps of a file with nanosecond precision."
15259 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4309
15261 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15266 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4312
15268 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15269 "nanoseconds from the epoch."
15273 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4315
15275 "If the C<*nsecs> field contains the special value C<-1> then the "
15276 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15277 "ignored in this case)."
15281 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4319
15283 "If the C<*nsecs> field contains the special value C<-2> then the "
15284 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15289 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-structs.pod:175
15290 msgid "guestfs_version"
15294 #: ../src/guestfs-actions.pod:6454
15297 " struct guestfs_version *\n"
15298 " guestfs_version (guestfs_h *g);\n"
15303 #: ../src/guestfs-actions.pod:6457 ../fish/guestfish-actions.pod:4327
15305 "Return the libguestfs version number that the program is linked against."
15309 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4330
15311 "Note that because of dynamic linking this is not necessarily the version of "
15312 "libguestfs that you compiled against. You can compile the program, and then "
15313 "at runtime dynamically link against a completely different C<libguestfs.so> "
15318 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4335
15320 "This call was added in version C<1.0.58>. In previous versions of "
15321 "libguestfs there was no way to get the version number. From C code you can "
15322 "use dynamic linker functions to find out if this symbol exists (if it "
15323 "doesn't, then it's an earlier version)."
15327 #: ../src/guestfs-actions.pod:6471 ../fish/guestfish-actions.pod:4341
15329 "The call returns a structure with four elements. The first three (C<major>, "
15330 "C<minor> and C<release>) are numbers and correspond to the usual version "
15331 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15332 "but may be used for distro-specific information."
15336 #: ../src/guestfs-actions.pod:6477 ../fish/guestfish-actions.pod:4347
15338 "To construct the original version string: C<$major.$minor.$release$extra>"
15342 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4350
15343 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15347 #: ../src/guestfs-actions.pod:6482
15349 "I<Note:> Don't use this call to test for availability of features. In "
15350 "enterprise distributions we backport features from later versions into "
15351 "earlier versions, making this an unreliable way to test for features. Use "
15352 "C<guestfs_available> instead."
15356 #: ../src/guestfs-actions.pod:6488
15358 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15359 "error. I<The caller must call C<guestfs_free_version> after use>."
15363 #: ../src/guestfs-actions.pod:6492
15364 msgid "(Added in 1.0.58)"
15368 #: ../src/guestfs-actions.pod:6494
15369 msgid "guestfs_vfs_label"
15373 #: ../src/guestfs-actions.pod:6496
15377 " guestfs_vfs_label (guestfs_h *g,\n"
15378 " const char *device);\n"
15383 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4362
15384 msgid "This returns the filesystem label of the filesystem on C<device>."
15388 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4365
15389 msgid "If the filesystem is unlabeled, this returns the empty string."
15393 #: ../src/guestfs-actions.pod:6505
15394 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15398 #: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6547
15399 msgid "(Added in 1.3.18)"
15403 #: ../src/guestfs-actions.pod:6512
15404 msgid "guestfs_vfs_type"
15408 #: ../src/guestfs-actions.pod:6514
15412 " guestfs_vfs_type (guestfs_h *g,\n"
15413 " const char *device);\n"
15418 #: ../src/guestfs-actions.pod:6518 ../fish/guestfish-actions.pod:4373
15420 "This command gets the filesystem type corresponding to the filesystem on "
15425 #: ../src/guestfs-actions.pod:6521 ../fish/guestfish-actions.pod:4376
15427 "For most filesystems, the result is the name of the Linux VFS module which "
15428 "would be used to mount this filesystem if you mounted it without specifying "
15429 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15433 #: ../src/guestfs-actions.pod:6531
15434 msgid "guestfs_vfs_uuid"
15438 #: ../src/guestfs-actions.pod:6533
15442 " guestfs_vfs_uuid (guestfs_h *g,\n"
15443 " const char *device);\n"
15448 #: ../src/guestfs-actions.pod:6537 ../fish/guestfish-actions.pod:4385
15449 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15453 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4388
15454 msgid "If the filesystem does not have a UUID, this returns the empty string."
15458 #: ../src/guestfs-actions.pod:6542
15459 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15463 #: ../src/guestfs-actions.pod:6549
15464 msgid "guestfs_vg_activate"
15468 #: ../src/guestfs-actions.pod:6551
15472 " guestfs_vg_activate (guestfs_h *g,\n"
15474 " char *const *volgroups);\n"
15479 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4396
15481 "This command activates or (if C<activate> is false) deactivates all logical "
15482 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15483 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15484 "deactivated, then those devices disappear."
15488 #: ../src/guestfs-actions.pod:6562 ../fish/guestfish-actions.pod:4402
15489 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15493 #: ../src/guestfs-actions.pod:6564 ../fish/guestfish-actions.pod:4404
15495 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15496 "activated or deactivated."
15500 #: ../src/guestfs-actions.pod:6571
15501 msgid "guestfs_vg_activate_all"
15505 #: ../src/guestfs-actions.pod:6573
15509 " guestfs_vg_activate_all (guestfs_h *g,\n"
15510 " int activate);\n"
15515 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4411
15517 "This command activates or (if C<activate> is false) deactivates all logical "
15518 "volumes in all volume groups. If activated, then they are made known to the "
15519 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15520 "those devices disappear."
15524 #: ../src/guestfs-actions.pod:6583 ../fish/guestfish-actions.pod:4417
15525 msgid "This command is the same as running C<vgchange -a y|n>"
15529 #: ../src/guestfs-actions.pod:6589
15530 msgid "guestfs_vgcreate"
15534 #: ../src/guestfs-actions.pod:6591
15538 " guestfs_vgcreate (guestfs_h *g,\n"
15539 " const char *volgroup,\n"
15540 " char *const *physvols);\n"
15545 #: ../src/guestfs-actions.pod:6596 ../fish/guestfish-actions.pod:4423
15547 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15548 "of physical volumes C<physvols>."
15552 #: ../src/guestfs-actions.pod:6603
15553 msgid "guestfs_vglvuuids"
15557 #: ../src/guestfs-actions.pod:6605
15561 " guestfs_vglvuuids (guestfs_h *g,\n"
15562 " const char *vgname);\n"
15567 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4430
15569 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15570 "volumes created in this volume group."
15574 #: ../src/guestfs-actions.pod:6612
15576 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15577 "associate logical volumes and volume groups."
15581 #: ../src/guestfs-actions.pod:6615
15582 msgid "See also C<guestfs_vgpvuuids>."
15586 #: ../src/guestfs-actions.pod:6623
15587 msgid "guestfs_vgpvuuids"
15591 #: ../src/guestfs-actions.pod:6625
15595 " guestfs_vgpvuuids (guestfs_h *g,\n"
15596 " const char *vgname);\n"
15601 #: ../src/guestfs-actions.pod:6629 ../fish/guestfish-actions.pod:4442
15603 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15604 "volumes that this volume group resides on."
15608 #: ../src/guestfs-actions.pod:6632
15610 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15611 "associate physical volumes and volume groups."
15615 #: ../src/guestfs-actions.pod:6635
15616 msgid "See also C<guestfs_vglvuuids>."
15620 #: ../src/guestfs-actions.pod:6643
15621 msgid "guestfs_vgremove"
15625 #: ../src/guestfs-actions.pod:6645
15629 " guestfs_vgremove (guestfs_h *g,\n"
15630 " const char *vgname);\n"
15635 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4454
15636 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15640 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4456
15642 "This also forcibly removes all logical volumes in the volume group (if any)."
15646 #: ../src/guestfs-actions.pod:6658
15647 msgid "guestfs_vgrename"
15651 #: ../src/guestfs-actions.pod:6660
15655 " guestfs_vgrename (guestfs_h *g,\n"
15656 " const char *volgroup,\n"
15657 " const char *newvolgroup);\n"
15662 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4463
15663 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15667 #: ../src/guestfs-actions.pod:6671
15668 msgid "guestfs_vgs"
15672 #: ../src/guestfs-actions.pod:6673
15676 " guestfs_vgs (guestfs_h *g);\n"
15681 #: ../src/guestfs-actions.pod:6676 ../fish/guestfish-actions.pod:4469
15683 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15688 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4472
15690 "This returns a list of just the volume group names that were detected (eg. "
15695 #: ../src/guestfs-actions.pod:6682
15696 msgid "See also C<guestfs_vgs_full>."
15700 #: ../src/guestfs-actions.pod:6690
15701 msgid "guestfs_vgs_full"
15705 #: ../src/guestfs-actions.pod:6692
15708 " struct guestfs_lvm_vg_list *\n"
15709 " guestfs_vgs_full (guestfs_h *g);\n"
15714 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4481
15716 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15717 "> command. The \"full\" version includes all fields."
15721 #: ../src/guestfs-actions.pod:6698
15723 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15724 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15728 #: ../src/guestfs-actions.pod:6704
15729 msgid "guestfs_vgscan"
15733 #: ../src/guestfs-actions.pod:6706
15737 " guestfs_vgscan (guestfs_h *g);\n"
15742 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4488
15744 "This rescans all block devices and rebuilds the list of LVM physical "
15745 "volumes, volume groups and logical volumes."
15749 #: ../src/guestfs-actions.pod:6716
15750 msgid "guestfs_vguuid"
15754 #: ../src/guestfs-actions.pod:6718
15758 " guestfs_vguuid (guestfs_h *g,\n"
15759 " const char *vgname);\n"
15764 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4495
15765 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15769 #: ../src/guestfs-actions.pod:6729
15770 msgid "guestfs_wait_ready"
15774 #: ../src/guestfs-actions.pod:6731
15778 " guestfs_wait_ready (guestfs_h *g);\n"
15783 #: ../src/guestfs-actions.pod:6734
15784 msgid "This function is a no op."
15788 #: ../src/guestfs-actions.pod:6736
15790 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15791 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15792 "is no longer necessary because C<guestfs_launch> now does the waiting."
15796 #: ../src/guestfs-actions.pod:6741
15798 "If you see any calls to this function in code then you can just remove them, "
15799 "unless you want to retain compatibility with older versions of the API."
15803 #: ../src/guestfs-actions.pod:6749
15804 msgid "guestfs_wc_c"
15808 #: ../src/guestfs-actions.pod:6751
15812 " guestfs_wc_c (guestfs_h *g,\n"
15813 " const char *path);\n"
15818 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4501
15820 "This command counts the characters in a file, using the C<wc -c> external "
15825 #: ../src/guestfs-actions.pod:6762
15826 msgid "guestfs_wc_l"
15830 #: ../src/guestfs-actions.pod:6764
15834 " guestfs_wc_l (guestfs_h *g,\n"
15835 " const char *path);\n"
15840 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4508
15842 "This command counts the lines in a file, using the C<wc -l> external command."
15846 #: ../src/guestfs-actions.pod:6775
15847 msgid "guestfs_wc_w"
15851 #: ../src/guestfs-actions.pod:6777
15855 " guestfs_wc_w (guestfs_h *g,\n"
15856 " const char *path);\n"
15861 #: ../src/guestfs-actions.pod:6781 ../fish/guestfish-actions.pod:4515
15863 "This command counts the words in a file, using the C<wc -w> external command."
15867 #: ../src/guestfs-actions.pod:6788
15868 msgid "guestfs_write"
15872 #: ../src/guestfs-actions.pod:6790
15876 " guestfs_write (guestfs_h *g,\n"
15877 " const char *path,\n"
15878 " const char *content,\n"
15879 " size_t content_size);\n"
15884 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4522
15886 "This call creates a file called C<path>. The content of the file is the "
15887 "string C<content> (which can contain any 8 bit data)."
15891 #: ../src/guestfs-actions.pod:6806
15892 msgid "guestfs_write_file"
15896 #: ../src/guestfs-actions.pod:6808
15900 " guestfs_write_file (guestfs_h *g,\n"
15901 " const char *path,\n"
15902 " const char *content,\n"
15908 #: ../src/guestfs-actions.pod:6814 ../fish/guestfish-actions.pod:4532
15910 "This call creates a file called C<path>. The contents of the file is the "
15911 "string C<content> (which can contain any 8 bit data), with length C<size>."
15915 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4536
15917 "As a special case, if C<size> is C<0> then the length is calculated using "
15918 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15922 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4540
15924 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15925 "I<not> work, even if the length is specified."
15929 #: ../src/guestfs-actions.pod:6830 ../fish/guestfish-actions.pod:4546
15931 "This function is deprecated. In new code, use the C<write> call instead."
15935 #: ../src/guestfs-actions.pod:6839
15936 msgid "guestfs_zegrep"
15940 #: ../src/guestfs-actions.pod:6841
15944 " guestfs_zegrep (guestfs_h *g,\n"
15945 " const char *regex,\n"
15946 " const char *path);\n"
15951 #: ../src/guestfs-actions.pod:6846 ../fish/guestfish-actions.pod:4557
15953 "This calls the external C<zegrep> program and returns the matching lines."
15957 #: ../src/guestfs-actions.pod:6858
15958 msgid "guestfs_zegrepi"
15962 #: ../src/guestfs-actions.pod:6860
15966 " guestfs_zegrepi (guestfs_h *g,\n"
15967 " const char *regex,\n"
15968 " const char *path);\n"
15973 #: ../src/guestfs-actions.pod:6865 ../fish/guestfish-actions.pod:4567
15975 "This calls the external C<zegrep -i> program and returns the matching lines."
15979 #: ../src/guestfs-actions.pod:6877
15980 msgid "guestfs_zero"
15984 #: ../src/guestfs-actions.pod:6879
15988 " guestfs_zero (guestfs_h *g,\n"
15989 " const char *device);\n"
15994 #: ../src/guestfs-actions.pod:6883 ../fish/guestfish-actions.pod:4577
15995 msgid "This command writes zeroes over the first few blocks of C<device>."
15999 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4579
16001 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16002 "securely wipe the device). It should be sufficient to remove any partition "
16003 "tables, filesystem superblocks and so on."
16007 #: ../src/guestfs-actions.pod:6889
16008 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16012 #: ../src/guestfs-actions.pod:6900
16013 msgid "guestfs_zero_device"
16017 #: ../src/guestfs-actions.pod:6902
16021 " guestfs_zero_device (guestfs_h *g,\n"
16022 " const char *device);\n"
16027 #: ../src/guestfs-actions.pod:6906
16029 "This command writes zeroes over the entire C<device>. Compare with "
16030 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16034 #: ../src/guestfs-actions.pod:6920
16035 msgid "(Added in 1.3.1)"
16039 #: ../src/guestfs-actions.pod:6922
16040 msgid "guestfs_zerofree"
16044 #: ../src/guestfs-actions.pod:6924
16048 " guestfs_zerofree (guestfs_h *g,\n"
16049 " const char *device);\n"
16054 #: ../src/guestfs-actions.pod:6928 ../fish/guestfish-actions.pod:4600
16056 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16057 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16058 "possible to compress the filesystem more effectively."
16062 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4605
16063 msgid "You should B<not> run this program if the filesystem is mounted."
16067 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4608
16069 "It is possible that using this program can damage the filesystem or data on "
16074 #: ../src/guestfs-actions.pod:6943
16075 msgid "guestfs_zfgrep"
16079 #: ../src/guestfs-actions.pod:6945
16083 " guestfs_zfgrep (guestfs_h *g,\n"
16084 " const char *pattern,\n"
16085 " const char *path);\n"
16090 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4615
16092 "This calls the external C<zfgrep> program and returns the matching lines."
16096 #: ../src/guestfs-actions.pod:6962
16097 msgid "guestfs_zfgrepi"
16101 #: ../src/guestfs-actions.pod:6964
16105 " guestfs_zfgrepi (guestfs_h *g,\n"
16106 " const char *pattern,\n"
16107 " const char *path);\n"
16112 #: ../src/guestfs-actions.pod:6969 ../fish/guestfish-actions.pod:4625
16114 "This calls the external C<zfgrep -i> program and returns the matching lines."
16118 #: ../src/guestfs-actions.pod:6981
16119 msgid "guestfs_zfile"
16123 #: ../src/guestfs-actions.pod:6983
16127 " guestfs_zfile (guestfs_h *g,\n"
16128 " const char *meth,\n"
16129 " const char *path);\n"
16134 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4635
16136 "This command runs C<file> after first decompressing C<path> using C<method>."
16140 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4638
16141 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16145 #: ../src/guestfs-actions.pod:6993
16147 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16152 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4643
16154 "This function is deprecated. In new code, use the C<file> call instead."
16158 #: ../src/guestfs-actions.pod:7008
16159 msgid "guestfs_zgrep"
16163 #: ../src/guestfs-actions.pod:7010
16167 " guestfs_zgrep (guestfs_h *g,\n"
16168 " const char *regex,\n"
16169 " const char *path);\n"
16174 #: ../src/guestfs-actions.pod:7015 ../fish/guestfish-actions.pod:4654
16176 "This calls the external C<zgrep> program and returns the matching lines."
16180 #: ../src/guestfs-actions.pod:7027
16181 msgid "guestfs_zgrepi"
16185 #: ../src/guestfs-actions.pod:7029
16189 " guestfs_zgrepi (guestfs_h *g,\n"
16190 " const char *regex,\n"
16191 " const char *path);\n"
16196 #: ../src/guestfs-actions.pod:7034 ../fish/guestfish-actions.pod:4664
16198 "This calls the external C<zgrep -i> program and returns the matching lines."
16202 #: ../src/guestfs-availability.pod:3
16207 #: ../src/guestfs-availability.pod:5
16209 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16210 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16211 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16212 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16213 "L</guestfs_aug_save> L</guestfs_aug_set>"
16217 #: ../src/guestfs-availability.pod:21
16222 #: ../src/guestfs-availability.pod:23
16224 "The following functions: L</guestfs_inotify_add_watch> L</"
16225 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16226 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16230 #: ../src/guestfs-availability.pod:31
16231 msgid "B<linuxfsuuid>"
16235 #: ../src/guestfs-availability.pod:33
16237 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16238 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16242 #: ../src/guestfs-availability.pod:40
16243 msgid "B<linuxmodules>"
16247 #: ../src/guestfs-availability.pod:42
16248 msgid "The following functions: L</guestfs_modprobe>"
16252 #: ../src/guestfs-availability.pod:45
16253 msgid "B<linuxxattrs>"
16257 #: ../src/guestfs-availability.pod:47
16259 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16260 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16261 "guestfs_removexattr> L</guestfs_setxattr>"
16265 #: ../src/guestfs-availability.pod:56
16270 #: ../src/guestfs-availability.pod:58
16272 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16273 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16274 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16278 #: ../src/guestfs-availability.pod:67
16283 #: ../src/guestfs-availability.pod:69
16285 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16286 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16287 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16288 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16289 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16290 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16291 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16295 #: ../src/guestfs-availability.pod:92
16300 #: ../src/guestfs-availability.pod:94
16302 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16303 "guestfs_mknod_b> L</guestfs_mknod_c>"
16307 #: ../src/guestfs-availability.pod:100
16312 #: ../src/guestfs-availability.pod:102
16313 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16317 #: ../src/guestfs-availability.pod:105
16318 msgid "B<ntfsprogs>"
16322 #: ../src/guestfs-availability.pod:107
16324 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16328 #: ../src/guestfs-availability.pod:111
16329 msgid "B<realpath>"
16333 #: ../src/guestfs-availability.pod:113
16334 msgid "The following functions: L</guestfs_realpath>"
16338 #: ../src/guestfs-availability.pod:116
16343 #: ../src/guestfs-availability.pod:118
16345 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16346 "guestfs_scrub_freespace>"
16350 #: ../src/guestfs-availability.pod:123
16355 #: ../src/guestfs-availability.pod:125
16356 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16360 #: ../src/guestfs-availability.pod:129
16365 #: ../src/guestfs-availability.pod:131
16366 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16370 #: ../src/guestfs-availability.pod:135
16371 msgid "B<zerofree>"
16375 #: ../src/guestfs-availability.pod:137
16376 msgid "The following functions: L</guestfs_zerofree>"
16380 #: ../src/guestfs-structs.pod:1
16381 msgid "guestfs_int_bool"
16385 #: ../src/guestfs-structs.pod:3
16388 " struct guestfs_int_bool {\n"
16396 #: ../src/guestfs-structs.pod:8
16399 " struct guestfs_int_bool_list {\n"
16400 " uint32_t len; /* Number of elements in list. */\n"
16401 " struct guestfs_int_bool *val; /* Elements. */\n"
16407 #: ../src/guestfs-structs.pod:13
16410 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16411 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16416 #: ../src/guestfs-structs.pod:16
16417 msgid "guestfs_lvm_pv"
16421 #: ../src/guestfs-structs.pod:18
16424 " struct guestfs_lvm_pv {\n"
16425 " char *pv_name;\n"
16426 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16427 " char pv_uuid[32];\n"
16429 " uint64_t pv_size;\n"
16430 " uint64_t dev_size;\n"
16431 " uint64_t pv_free;\n"
16432 " uint64_t pv_used;\n"
16433 " char *pv_attr;\n"
16434 " int64_t pv_pe_count;\n"
16435 " int64_t pv_pe_alloc_count;\n"
16436 " char *pv_tags;\n"
16437 " uint64_t pe_start;\n"
16438 " int64_t pv_mda_count;\n"
16439 " uint64_t pv_mda_free;\n"
16445 #: ../src/guestfs-structs.pod:36
16448 " struct guestfs_lvm_pv_list {\n"
16449 " uint32_t len; /* Number of elements in list. */\n"
16450 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16456 #: ../src/guestfs-structs.pod:41
16459 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16460 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16465 #: ../src/guestfs-structs.pod:44
16466 msgid "guestfs_lvm_vg"
16470 #: ../src/guestfs-structs.pod:46
16473 " struct guestfs_lvm_vg {\n"
16474 " char *vg_name;\n"
16475 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16476 " char vg_uuid[32];\n"
16478 " char *vg_attr;\n"
16479 " uint64_t vg_size;\n"
16480 " uint64_t vg_free;\n"
16481 " char *vg_sysid;\n"
16482 " uint64_t vg_extent_size;\n"
16483 " int64_t vg_extent_count;\n"
16484 " int64_t vg_free_count;\n"
16485 " int64_t max_lv;\n"
16486 " int64_t max_pv;\n"
16487 " int64_t pv_count;\n"
16488 " int64_t lv_count;\n"
16489 " int64_t snap_count;\n"
16490 " int64_t vg_seqno;\n"
16491 " char *vg_tags;\n"
16492 " int64_t vg_mda_count;\n"
16493 " uint64_t vg_mda_free;\n"
16499 #: ../src/guestfs-structs.pod:69
16502 " struct guestfs_lvm_vg_list {\n"
16503 " uint32_t len; /* Number of elements in list. */\n"
16504 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16510 #: ../src/guestfs-structs.pod:74
16513 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16514 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16519 #: ../src/guestfs-structs.pod:77
16520 msgid "guestfs_lvm_lv"
16524 #: ../src/guestfs-structs.pod:79
16527 " struct guestfs_lvm_lv {\n"
16528 " char *lv_name;\n"
16529 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16530 " char lv_uuid[32];\n"
16531 " char *lv_attr;\n"
16532 " int64_t lv_major;\n"
16533 " int64_t lv_minor;\n"
16534 " int64_t lv_kernel_major;\n"
16535 " int64_t lv_kernel_minor;\n"
16536 " uint64_t lv_size;\n"
16537 " int64_t seg_count;\n"
16539 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16540 " float snap_percent;\n"
16541 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16542 " float copy_percent;\n"
16543 " char *move_pv;\n"
16544 " char *lv_tags;\n"
16545 " char *mirror_log;\n"
16546 " char *modules;\n"
16552 #: ../src/guestfs-structs.pod:101
16555 " struct guestfs_lvm_lv_list {\n"
16556 " uint32_t len; /* Number of elements in list. */\n"
16557 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16563 #: ../src/guestfs-structs.pod:106
16566 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16567 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16572 #: ../src/guestfs-structs.pod:111
16575 " struct guestfs_stat {\n"
16579 " int64_t nlink;\n"
16584 " int64_t blksize;\n"
16585 " int64_t blocks;\n"
16586 " int64_t atime;\n"
16587 " int64_t mtime;\n"
16588 " int64_t ctime;\n"
16594 #: ../src/guestfs-structs.pod:127
16597 " struct guestfs_stat_list {\n"
16598 " uint32_t len; /* Number of elements in list. */\n"
16599 " struct guestfs_stat *val; /* Elements. */\n"
16605 #: ../src/guestfs-structs.pod:132
16608 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16609 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16614 #: ../src/guestfs-structs.pod:137
16617 " struct guestfs_statvfs {\n"
16618 " int64_t bsize;\n"
16619 " int64_t frsize;\n"
16620 " int64_t blocks;\n"
16621 " int64_t bfree;\n"
16622 " int64_t bavail;\n"
16623 " int64_t files;\n"
16624 " int64_t ffree;\n"
16625 " int64_t favail;\n"
16628 " int64_t namemax;\n"
16634 #: ../src/guestfs-structs.pod:151
16637 " struct guestfs_statvfs_list {\n"
16638 " uint32_t len; /* Number of elements in list. */\n"
16639 " struct guestfs_statvfs *val; /* Elements. */\n"
16645 #: ../src/guestfs-structs.pod:156
16648 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16649 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16654 #: ../src/guestfs-structs.pod:159
16655 msgid "guestfs_dirent"
16659 #: ../src/guestfs-structs.pod:161
16662 " struct guestfs_dirent {\n"
16671 #: ../src/guestfs-structs.pod:167
16674 " struct guestfs_dirent_list {\n"
16675 " uint32_t len; /* Number of elements in list. */\n"
16676 " struct guestfs_dirent *val; /* Elements. */\n"
16682 #: ../src/guestfs-structs.pod:172
16685 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16686 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16691 #: ../src/guestfs-structs.pod:177
16694 " struct guestfs_version {\n"
16695 " int64_t major;\n"
16696 " int64_t minor;\n"
16697 " int64_t release;\n"
16704 #: ../src/guestfs-structs.pod:184
16707 " struct guestfs_version_list {\n"
16708 " uint32_t len; /* Number of elements in list. */\n"
16709 " struct guestfs_version *val; /* Elements. */\n"
16715 #: ../src/guestfs-structs.pod:189
16718 " void guestfs_free_version (struct guestfs_free_version *);\n"
16719 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16724 #: ../src/guestfs-structs.pod:192
16725 msgid "guestfs_xattr"
16729 #: ../src/guestfs-structs.pod:194
16732 " struct guestfs_xattr {\n"
16733 " char *attrname;\n"
16734 " /* The next two fields describe a byte array. */\n"
16735 " uint32_t attrval_len;\n"
16736 " char *attrval;\n"
16742 #: ../src/guestfs-structs.pod:201
16745 " struct guestfs_xattr_list {\n"
16746 " uint32_t len; /* Number of elements in list. */\n"
16747 " struct guestfs_xattr *val; /* Elements. */\n"
16753 #: ../src/guestfs-structs.pod:206
16756 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16757 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16762 #: ../src/guestfs-structs.pod:209
16763 msgid "guestfs_inotify_event"
16767 #: ../src/guestfs-structs.pod:211
16770 " struct guestfs_inotify_event {\n"
16771 " int64_t in_wd;\n"
16772 " uint32_t in_mask;\n"
16773 " uint32_t in_cookie;\n"
16774 " char *in_name;\n"
16780 #: ../src/guestfs-structs.pod:218
16783 " struct guestfs_inotify_event_list {\n"
16784 " uint32_t len; /* Number of elements in list. */\n"
16785 " struct guestfs_inotify_event *val; /* Elements. */\n"
16791 #: ../src/guestfs-structs.pod:223
16794 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16795 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16800 #: ../src/guestfs-structs.pod:226
16801 msgid "guestfs_partition"
16805 #: ../src/guestfs-structs.pod:228
16808 " struct guestfs_partition {\n"
16809 " int32_t part_num;\n"
16810 " uint64_t part_start;\n"
16811 " uint64_t part_end;\n"
16812 " uint64_t part_size;\n"
16818 #: ../src/guestfs-structs.pod:235
16821 " struct guestfs_partition_list {\n"
16822 " uint32_t len; /* Number of elements in list. */\n"
16823 " struct guestfs_partition *val; /* Elements. */\n"
16829 #: ../src/guestfs-structs.pod:240
16832 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16833 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16838 #: ../src/guestfs-structs.pod:243
16839 msgid "guestfs_application"
16843 #: ../src/guestfs-structs.pod:245
16846 " struct guestfs_application {\n"
16847 " char *app_name;\n"
16848 " char *app_display_name;\n"
16849 " int32_t app_epoch;\n"
16850 " char *app_version;\n"
16851 " char *app_release;\n"
16852 " char *app_install_path;\n"
16853 " char *app_trans_path;\n"
16854 " char *app_publisher;\n"
16855 " char *app_url;\n"
16856 " char *app_source_package;\n"
16857 " char *app_summary;\n"
16858 " char *app_description;\n"
16864 #: ../src/guestfs-structs.pod:260
16867 " struct guestfs_application_list {\n"
16868 " uint32_t len; /* Number of elements in list. */\n"
16869 " struct guestfs_application *val; /* Elements. */\n"
16875 #: ../src/guestfs-structs.pod:265
16878 " void guestfs_free_application (struct guestfs_free_application *);\n"
16879 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16884 #: ../fish/guestfish.pod:5
16885 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16889 #: ../fish/guestfish.pod:9
16892 " guestfish [--options] [commands]\n"
16897 #: ../fish/guestfish.pod:11
16905 #: ../fish/guestfish.pod:13
16908 " guestfish [--ro|--rw] -a disk.img\n"
16913 #: ../fish/guestfish.pod:15
16916 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16921 #: ../fish/guestfish.pod:17
16924 " guestfish -d libvirt-domain\n"
16929 #: ../fish/guestfish.pod:19
16932 " guestfish [--ro|--rw] -a disk.img -i\n"
16937 #: ../fish/guestfish.pod:21
16940 " guestfish -d libvirt-domain -i\n"
16945 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16946 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16951 #: ../fish/guestfish.pod:25
16953 "Using guestfish in read/write mode on live virtual machines can be "
16954 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16955 "option to use guestfish safely if the disk image or virtual machine might be "
16960 #: ../fish/guestfish.pod:32
16962 "Guestfish is a shell and command-line tool for examining and modifying "
16963 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16964 "functionality of the guestfs API, see L<guestfs(3)>."
16968 #: ../fish/guestfish.pod:36
16970 "Guestfish gives you structured access to the libguestfs API, from shell "
16971 "scripts or the command line or interactively. If you want to rescue a "
16972 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16977 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847
16978 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16979 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16984 #: ../fish/guestfish.pod:43
16985 msgid "As an interactive shell"
16989 #: ../fish/guestfish.pod:45
16997 #: ../fish/guestfish.pod:47
17000 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17001 " editing virtual machine filesystems.\n"
17006 #: ../fish/guestfish.pod:50
17009 " Type: 'help' for a list of commands\n"
17010 " 'man' to read the manual\n"
17011 " 'quit' to quit the shell\n"
17016 #: ../fish/guestfish.pod:54
17019 " ><fs> add-ro disk.img\n"
17021 " ><fs> list-filesystems\n"
17022 " /dev/sda1: ext4\n"
17023 " /dev/vg_guest/lv_root: ext4\n"
17024 " /dev/vg_guest/lv_swap: swap\n"
17025 " ><fs> mount /dev/vg_guest/lv_root /\n"
17026 " ><fs> cat /etc/fstab\n"
17028 " # Created by anaconda\n"
17035 #: ../fish/guestfish.pod:67
17036 msgid "From shell scripts"
17040 #: ../fish/guestfish.pod:69
17041 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17045 #: ../fish/guestfish.pod:71
17048 " guestfish <<_EOF_\n"
17051 " mount /dev/vg_guest/lv_root /\n"
17052 " write /etc/motd \"Welcome, new users\"\n"
17058 #: ../fish/guestfish.pod:78
17059 msgid "List the LVM logical volumes in a disk image:"
17063 #: ../fish/guestfish.pod:80
17066 " guestfish -a disk.img --ro <<_EOF_\n"
17074 #: ../fish/guestfish.pod:85
17075 msgid "List all the filesystems in a disk image:"
17079 #: ../fish/guestfish.pod:87
17082 " guestfish -a disk.img --ro <<_EOF_\n"
17084 " list-filesystems\n"
17090 #: ../fish/guestfish.pod:92
17091 msgid "On one command line"
17095 #: ../fish/guestfish.pod:94
17096 msgid "Update C</etc/resolv.conf> in a guest:"
17100 #: ../fish/guestfish.pod:96
17104 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17105 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17110 #: ../fish/guestfish.pod:100
17111 msgid "Edit C</boot/grub/grub.conf> interactively:"
17115 #: ../fish/guestfish.pod:102
17118 " guestfish --rw --add disk.img \\\n"
17119 " --mount /dev/vg_guest/lv_root \\\n"
17120 " --mount /dev/sda1:/boot \\\n"
17121 " edit /boot/grub/grub.conf\n"
17126 #: ../fish/guestfish.pod:107
17127 msgid "Mount disks automatically"
17131 #: ../fish/guestfish.pod:109
17133 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17137 #: ../fish/guestfish.pod:112
17140 " guestfish --ro -a disk.img -i cat /etc/group\n"
17145 #: ../fish/guestfish.pod:114
17148 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17153 #: ../fish/guestfish.pod:116
17154 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17158 #: ../fish/guestfish.pod:118
17161 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17166 #: ../fish/guestfish.pod:120
17167 msgid "As a script interpreter"
17171 #: ../fish/guestfish.pod:122
17172 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17176 #: ../fish/guestfish.pod:124
17179 " #!/usr/bin/guestfish -f\n"
17180 " sparse test1.img 100M\n"
17182 " part-disk /dev/sda mbr\n"
17183 " mkfs ext2 /dev/sda1\n"
17188 #: ../fish/guestfish.pod:130
17189 msgid "Start with a prepared disk"
17193 #: ../fish/guestfish.pod:132
17195 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17196 "single ext2-formatted partition:"
17200 #: ../fish/guestfish.pod:135
17203 " guestfish -N fs\n"
17208 #: ../fish/guestfish.pod:137
17209 msgid "To list what is available do:"
17213 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
17216 " guestfish -N help | less\n"
17221 #: ../fish/guestfish.pod:141
17222 msgid "Remote control"
17226 #: ../fish/guestfish.pod:143
17229 " eval \"`guestfish --listen`\"\n"
17230 " guestfish --remote add-ro disk.img\n"
17231 " guestfish --remote run\n"
17232 " guestfish --remote lvs\n"
17237 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17238 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
17239 #: ../tools/virt-win-reg.pl:171 ../tools/virt-resize.pl:254
17240 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
17241 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17246 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17247 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179
17248 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
17249 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
17250 #: ../tools/virt-list-partitions.pl:62
17255 #: ../fish/guestfish.pod:154
17256 msgid "Displays general help on options."
17260 #: ../fish/guestfish.pod:156
17261 msgid "B<-h> | B<--cmd-help>"
17265 #: ../fish/guestfish.pod:158
17266 msgid "Lists all available guestfish commands."
17270 #: ../fish/guestfish.pod:160
17271 msgid "B<-h cmd> | B<--cmd-help cmd>"
17275 #: ../fish/guestfish.pod:162
17276 msgid "Displays detailed help on a single command C<cmd>."
17280 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17281 msgid "B<-a image> | B<--add image>"
17285 #: ../fish/guestfish.pod:166
17286 msgid "Add a block device or virtual machine image to the shell."
17290 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17292 "The format of the disk image is auto-detected. To override this and force a "
17293 "particular format use the I<--format=..> option."
17297 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17298 msgid "B<-c URI> | B<--connect URI>"
17302 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17304 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17305 "URI to use. The default is to use the default libvirt connection."
17309 #: ../fish/guestfish.pod:177
17314 #: ../fish/guestfish.pod:179
17316 "If using the I<--listen> option and a csh-like shell, use this option. See "
17317 "section L</REMOTE CONTROL AND CSH> below."
17321 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17322 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17326 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17328 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17329 "used, then any libvirt domain can be used. However in write mode, only "
17330 "libvirt domains which are shut down can be named here."
17334 #: ../fish/guestfish.pod:188
17335 msgid "B<-D> | B<--no-dest-paths>"
17339 #: ../fish/guestfish.pod:190
17341 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17342 "to hit the tab key to complete paths on the guest filesystem, but this "
17343 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17344 "allow this feature to be disabled."
17348 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17349 msgid "B<--echo-keys>"
17353 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17355 "When prompting for keys and passphrases, guestfish normally turns echoing "
17356 "off so you cannot see what you are typing. If you are not worried about "
17357 "Tempest attacks and there is no one else in the room you can specify this "
17358 "flag to see what you are typing."
17362 #: ../fish/guestfish.pod:202
17363 msgid "B<-f file> | B<--file file>"
17367 #: ../fish/guestfish.pod:204
17368 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17372 #: ../fish/guestfish.pod:207
17375 " #!/usr/bin/guestfish -f\n"
17380 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17381 msgid "B<--format=raw|qcow2|..> | B<--format>"
17385 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17387 "The default for the I<-a> option is to auto-detect the format of the disk "
17388 "image. Using this forces the disk format for I<-a> options which follow on "
17389 "the command line. Using I<--format> with no argument switches back to auto-"
17390 "detection for subsequent I<-a> options."
17394 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17395 msgid "For example:"
17399 #: ../fish/guestfish.pod:218
17402 " guestfish --format=raw -a disk.img\n"
17407 #: ../fish/guestfish.pod:220
17408 msgid "forces raw format (no auto-detection) for C<disk.img>."
17412 #: ../fish/guestfish.pod:222
17415 " guestfish --format=raw -a disk.img --format -a another.img\n"
17420 #: ../fish/guestfish.pod:224
17422 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17423 "detection for C<another.img>."
17427 #: ../fish/guestfish.pod:227
17429 "If you have untrusted raw-format guest disk images, you should use this "
17430 "option to specify the disk format. This avoids a possible security problem "
17431 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17435 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17436 msgid "B<-i> | B<--inspector>"
17440 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17442 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17443 "system and mount filesystems as they would be mounted on the real virtual "
17448 #: ../fish/guestfish.pod:238
17449 msgid "Typical usage is either:"
17453 #: ../fish/guestfish.pod:240
17456 " guestfish -d myguest -i\n"
17461 #: ../fish/guestfish.pod:242
17462 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17466 #: ../fish/guestfish.pod:244
17469 " guestfish --ro -d myguest -i\n"
17474 #: ../fish/guestfish.pod:246
17475 msgid "(for active domains, readonly), or specify the block device directly:"
17479 #: ../fish/guestfish.pod:248
17482 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17487 #: ../fish/guestfish.pod:250
17489 "Note that the command line syntax changed slightly over older versions of "
17490 "guestfish. You can still use the old syntax:"
17494 #: ../fish/guestfish.pod:253
17497 " guestfish [--ro] -i disk.img\n"
17502 #: ../fish/guestfish.pod:255
17505 " guestfish [--ro] -i libvirt-domain\n"
17510 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17511 msgid "B<--keys-from-stdin>"
17515 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17517 "Read key or passphrase parameters from stdin. The default is to try to read "
17518 "passphrases from the user by opening C</dev/tty>."
17522 #: ../fish/guestfish.pod:262
17523 msgid "B<--listen>"
17527 #: ../fish/guestfish.pod:264
17529 "Fork into the background and listen for remote commands. See section L</"
17530 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17534 #: ../fish/guestfish.pod:267
17535 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17539 #: ../fish/guestfish.pod:269
17540 msgid "Mount the named partition or logical volume on the given mountpoint."
17544 #: ../fish/guestfish.pod:271
17545 msgid "If the mountpoint is omitted, it defaults to C</>."
17549 #: ../fish/guestfish.pod:273
17550 msgid "You have to mount something on C</> before most commands will work."
17554 #: ../fish/guestfish.pod:275
17556 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17561 #: ../fish/guestfish.pod:278
17563 "If you don't know what filesystems a disk image contains, you can either run "
17564 "guestfish without this option, then list the partitions, filesystems and LVs "
17565 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17566 "commands), or you can use the L<virt-filesystems(1)> program."
17570 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17571 msgid "B<-n> | B<--no-sync>"
17575 #: ../fish/guestfish.pod:286
17577 "Disable autosync. This is enabled by default. See the discussion of "
17578 "autosync in the L<guestfs(3)> manpage."
17582 #: ../fish/guestfish.pod:289
17583 msgid "B<-N type> | B<--new type> | B<-N help>"
17587 #: ../fish/guestfish.pod:291
17589 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17590 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17591 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17596 #: ../fish/guestfish.pod:296
17597 msgid "B<--progress-bars>"
17601 #: ../fish/guestfish.pod:298
17602 msgid "Enable progress bars, even when guestfish is used non-interactively."
17606 #: ../fish/guestfish.pod:300
17608 "Progress bars are enabled by default when guestfish is used as an "
17609 "interactive shell."
17613 #: ../fish/guestfish.pod:303
17614 msgid "B<--no-progress-bars>"
17618 #: ../fish/guestfish.pod:305
17619 msgid "Disable progress bars."
17623 #: ../fish/guestfish.pod:307
17624 msgid "B<--remote[=pid]>"
17628 #: ../fish/guestfish.pod:309
17630 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17631 "CONTROL GUESTFISH OVER A SOCKET> below."
17635 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17636 msgid "B<-r> | B<--ro>"
17640 #: ../fish/guestfish.pod:314
17642 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17643 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17647 #: ../fish/guestfish.pod:317
17649 "The option must always be used if the disk image or virtual machine might be "
17650 "running, and is generally recommended in cases where you don't need write "
17651 "access to the disk."
17655 #: ../fish/guestfish.pod:321
17657 "Note that prepared disk images created with I<-N> are not affected by the "
17662 #: ../fish/guestfish.pod:324
17663 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17667 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17668 msgid "B<--selinux>"
17672 #: ../fish/guestfish.pod:328
17673 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17677 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17678 msgid "B<-v> | B<--verbose>"
17682 #: ../fish/guestfish.pod:332
17684 "Enable very verbose messages. This is particularly useful if you find a bug."
17688 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17689 msgid "B<-V> | B<--version>"
17693 #: ../fish/guestfish.pod:337
17694 msgid "Display the guestfish / libguestfs version number and exit."
17698 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17699 msgid "B<-w> | B<--rw>"
17703 #: ../fish/guestfish.pod:341
17705 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17710 #: ../fish/guestfish.pod:344
17715 #: ../fish/guestfish.pod:346
17716 msgid "Echo each command before executing it."
17720 #: ../fish/guestfish.pod:350
17721 msgid "COMMANDS ON COMMAND LINE"
17725 #: ../fish/guestfish.pod:352
17727 "Any additional (non-option) arguments are treated as commands to execute."
17731 #: ../fish/guestfish.pod:355
17733 "Commands to execute should be separated by a colon (C<:>), where the colon "
17734 "is a separate parameter. Thus:"
17738 #: ../fish/guestfish.pod:358
17741 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17746 #: ../fish/guestfish.pod:360
17748 "If there are no additional arguments, then we enter a shell, either an "
17749 "interactive shell with a prompt (if the input is a terminal) or a non-"
17750 "interactive shell."
17754 #: ../fish/guestfish.pod:364
17756 "In either command line mode or non-interactive shell, the first command that "
17757 "gives an error causes the whole shell to exit. In interactive mode (with a "
17758 "prompt) if a command fails, you can continue to enter commands."
17762 #: ../fish/guestfish.pod:369
17763 msgid "USING launch (OR run)"
17767 #: ../fish/guestfish.pod:371
17769 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17770 "then launch it, then mount any disks you need, and finally issue actions/"
17771 "commands. So the general order of the day is:"
17775 #: ../fish/guestfish.pod:379
17776 msgid "add or -a/--add"
17780 #: ../fish/guestfish.pod:383
17781 msgid "launch (aka run)"
17785 #: ../fish/guestfish.pod:387
17786 msgid "mount or -m/--mount"
17790 #: ../fish/guestfish.pod:391
17791 msgid "any other commands"
17795 #: ../fish/guestfish.pod:395
17797 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17798 "guest before mounting or performing any other commands."
17802 #: ../fish/guestfish.pod:398
17804 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17805 "I<--new> options were given then C<run> is done automatically, simply "
17806 "because guestfish can't perform the action you asked for without doing this."
17810 #: ../fish/guestfish.pod:403
17811 msgid "OPENING DISKS FOR READ AND WRITE"
17815 #: ../fish/guestfish.pod:405
17817 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17818 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17819 "open disk images read-only or for writing."
17823 #: ../fish/guestfish.pod:409
17825 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17826 "disk images supplied on the command line for write. To open a disk image "
17827 "read-only you have to do I<-a image --ro>."
17831 #: ../fish/guestfish.pod:413
17833 "This matters: If you accidentally open a live VM disk image writable then "
17834 "you will cause irreversible disk corruption."
17838 #: ../fish/guestfish.pod:416
17840 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17841 "images will be opened read-only. You will have to either specify "
17842 "I<guestfish --rw> or change a configuration file in order to get write "
17843 "access for disk images specified by those other command line options."
17847 #: ../fish/guestfish.pod:421
17849 "This version of guestfish has a I<--rw> option which does nothing (it is "
17850 "already the default). However it is highly recommended that you use this "
17851 "option to indicate that guestfish needs write access, and to prepare your "
17852 "scripts for the day when this option will be required for write access."
17856 #: ../fish/guestfish.pod:427
17858 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17859 "other libguestfs program apart from guestfish and guestmount."
17863 #: ../fish/guestfish.pod:430
17868 #: ../fish/guestfish.pod:432
17870 "You can quote ordinary parameters using either single or double quotes. For "
17875 #: ../fish/guestfish.pod:435
17878 " add \"file with a space.img\"\n"
17883 #: ../fish/guestfish.pod:437
17886 " rm '/file name'\n"
17891 #: ../fish/guestfish.pod:439
17899 #: ../fish/guestfish.pod:441
17901 "A few commands require a list of strings to be passed. For these, use a "
17902 "whitespace-separated list, enclosed in quotes. Strings containing "
17903 "whitespace to be passed through must be enclosed in single quotes. A "
17904 "literal single quote must be escaped with a backslash."
17908 #: ../fish/guestfish.pod:446
17911 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17912 " command \"/bin/echo 'foo bar'\"\n"
17913 " command \"/bin/echo \\'foo\\'\"\n"
17918 #: ../fish/guestfish.pod:450
17919 msgid "OPTIONAL ARGUMENTS"
17923 #: ../fish/guestfish.pod:452
17925 "Some commands take optional arguments. These arguments appear in this "
17926 "documentation as C<[argname:..]>. You can use them as in these examples:"
17930 #: ../fish/guestfish.pod:456
17933 " add-drive-opts filename\n"
17938 #: ../fish/guestfish.pod:458
17941 " add-drive-opts filename readonly:true\n"
17946 #: ../fish/guestfish.pod:460
17949 " add-drive-opts filename format:qcow2 readonly:false\n"
17954 #: ../fish/guestfish.pod:462
17956 "Each optional argument can appear at most once. All optional arguments must "
17957 "appear after the required ones."
17961 #: ../fish/guestfish.pod:465
17966 #: ../fish/guestfish.pod:467
17968 "This section applies to all commands which can take integers as parameters."
17972 #: ../fish/guestfish.pod:470
17973 msgid "SIZE SUFFIX"
17977 #: ../fish/guestfish.pod:472
17979 "When the command takes a parameter measured in bytes, you can use one of the "
17980 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17984 #: ../fish/guestfish.pod:478
17985 msgid "B<k> or B<K> or B<KiB>"
17989 #: ../fish/guestfish.pod:480
17990 msgid "The size in kilobytes (multiplied by 1024)."
17994 #: ../fish/guestfish.pod:482
17999 #: ../fish/guestfish.pod:484
18000 msgid "The size in SI 1000 byte units."
18004 #: ../fish/guestfish.pod:486
18005 msgid "B<M> or B<MiB>"
18009 #: ../fish/guestfish.pod:488
18010 msgid "The size in megabytes (multiplied by 1048576)."
18014 #: ../fish/guestfish.pod:490
18019 #: ../fish/guestfish.pod:492
18020 msgid "The size in SI 1000000 byte units."
18024 #: ../fish/guestfish.pod:494
18025 msgid "B<G> or B<GiB>"
18029 #: ../fish/guestfish.pod:496
18030 msgid "The size in gigabytes (multiplied by 2**30)."
18034 #: ../fish/guestfish.pod:498
18039 #: ../fish/guestfish.pod:500
18040 msgid "The size in SI 10**9 byte units."
18044 #: ../fish/guestfish.pod:502
18045 msgid "B<T> or B<TiB>"
18049 #: ../fish/guestfish.pod:504
18050 msgid "The size in terabytes (multiplied by 2**40)."
18054 #: ../fish/guestfish.pod:506
18059 #: ../fish/guestfish.pod:508
18060 msgid "The size in SI 10**12 byte units."
18064 #: ../fish/guestfish.pod:510
18065 msgid "B<P> or B<PiB>"
18069 #: ../fish/guestfish.pod:512
18070 msgid "The size in petabytes (multiplied by 2**50)."
18074 #: ../fish/guestfish.pod:514
18079 #: ../fish/guestfish.pod:516
18080 msgid "The size in SI 10**15 byte units."
18084 #: ../fish/guestfish.pod:518
18085 msgid "B<E> or B<EiB>"
18089 #: ../fish/guestfish.pod:520
18090 msgid "The size in exabytes (multiplied by 2**60)."
18094 #: ../fish/guestfish.pod:522
18099 #: ../fish/guestfish.pod:524
18100 msgid "The size in SI 10**18 byte units."
18104 #: ../fish/guestfish.pod:526
18105 msgid "B<Z> or B<ZiB>"
18109 #: ../fish/guestfish.pod:528
18110 msgid "The size in zettabytes (multiplied by 2**70)."
18114 #: ../fish/guestfish.pod:530
18119 #: ../fish/guestfish.pod:532
18120 msgid "The size in SI 10**21 byte units."
18124 #: ../fish/guestfish.pod:534
18125 msgid "B<Y> or B<YiB>"
18129 #: ../fish/guestfish.pod:536
18130 msgid "The size in yottabytes (multiplied by 2**80)."
18134 #: ../fish/guestfish.pod:538
18139 #: ../fish/guestfish.pod:540
18140 msgid "The size in SI 10**24 byte units."
18144 #: ../fish/guestfish.pod:546
18147 " truncate-size /file 1G\n"
18152 #: ../fish/guestfish.pod:548
18153 msgid "would truncate the file to 1 gigabyte."
18157 #: ../fish/guestfish.pod:550
18159 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18160 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18161 "suffix will probably not do what you expect."
18165 #: ../fish/guestfish.pod:554
18166 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18170 #: ../fish/guestfish.pod:556
18172 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18173 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18177 #: ../fish/guestfish.pod:559
18180 " 1234 decimal number 1234\n"
18181 " 02322 octal number, equivalent to decimal 1234\n"
18182 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18187 #: ../fish/guestfish.pod:563
18189 "When using the C<chmod> command, you almost always want to specify an octal "
18190 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18191 "L<chmod(1)> program):"
18195 #: ../fish/guestfish.pod:567
18198 " chmod 0777 /public # OK\n"
18199 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18204 #: ../fish/guestfish.pod:570
18206 "Commands that return numbers usually print them in decimal, but some "
18207 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18208 "octal, preceeded by C<0>)."
18212 #: ../fish/guestfish.pod:574
18213 msgid "WILDCARDS AND GLOBBING"
18217 #: ../fish/guestfish.pod:576
18219 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18220 "(globbing) by default. So for example the following will not do what you "
18225 #: ../fish/guestfish.pod:580
18233 #: ../fish/guestfish.pod:582
18235 "Assuming you don't have a directory called literally C</home/*> then the "
18236 "above command will return an error."
18240 #: ../fish/guestfish.pod:585
18241 msgid "To perform wildcard expansion, use the C<glob> command."
18245 #: ../fish/guestfish.pod:587
18248 " glob rm-rf /home/*\n"
18253 #: ../fish/guestfish.pod:589
18255 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18256 "many times), equivalent to:"
18260 #: ../fish/guestfish.pod:592
18263 " rm-rf /home/jim\n"
18264 " rm-rf /home/joe\n"
18265 " rm-rf /home/mary\n"
18270 #: ../fish/guestfish.pod:596
18271 msgid "C<glob> only works on simple guest paths and not on device names."
18275 #: ../fish/guestfish.pod:598
18277 "If you have several parameters, each containing a wildcard, then glob will "
18278 "perform a Cartesian product."
18282 #: ../fish/guestfish.pod:601
18287 #: ../fish/guestfish.pod:603
18289 "Any line which starts with a I<#> character is treated as a comment and "
18290 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18291 "a command. For example:"
18295 #: ../fish/guestfish.pod:607
18298 " # this is a comment\n"
18299 " # this is a comment\n"
18300 " foo # NOT a comment\n"
18305 #: ../fish/guestfish.pod:611
18306 msgid "Blank lines are also ignored."
18310 #: ../fish/guestfish.pod:613
18311 msgid "RUNNING COMMANDS LOCALLY"
18315 #: ../fish/guestfish.pod:615
18317 "Any line which starts with a I<!> character is treated as a command sent to "
18318 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18322 #: ../fish/guestfish.pod:619
18326 " tgz-out /remote local/remote-data.tar.gz\n"
18331 #: ../fish/guestfish.pod:622
18333 "will create a directory C<local> on the host, and then export the contents "
18334 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18335 "(See C<tgz-out>)."
18339 #: ../fish/guestfish.pod:626
18341 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18342 "effect, due to the way that subprocesses work in Unix."
18346 #: ../fish/guestfish.pod:629
18351 #: ../fish/guestfish.pod:631
18353 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18354 "command (a guestfish command) to the second command (any host command). For "
18359 #: ../fish/guestfish.pod:635
18362 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18367 #: ../fish/guestfish.pod:637
18369 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18370 "program). The above command would list all accounts in the guest filesystem "
18371 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18375 #: ../fish/guestfish.pod:642
18378 " hexdump /bin/ls | head\n"
18379 " list-devices | tail -1\n"
18380 " tgz-out / - | tar ztf -\n"
18385 #: ../fish/guestfish.pod:646
18387 "The space before the pipe symbol is required, any space after the pipe "
18388 "symbol is optional. Everything after the pipe symbol is just passed "
18389 "straight to the host shell, so it can contain redirections, globs and "
18390 "anything else that makes sense on the host side."
18394 #: ../fish/guestfish.pod:651
18396 "To use a literal argument which begins with a pipe symbol, you have to quote "
18401 #: ../fish/guestfish.pod:654
18409 #: ../fish/guestfish.pod:656
18410 msgid "HOME DIRECTORIES"
18414 #: ../fish/guestfish.pod:658
18416 "If a parameter starts with the character C<~> then the tilde may be expanded "
18417 "as a home directory path (either C<~> for the current user's home directory, "
18418 "or C<~user> for another user)."
18422 #: ../fish/guestfish.pod:662
18424 "Note that home directory expansion happens for users known I<on the host>, "
18425 "not in the guest filesystem."
18429 #: ../fish/guestfish.pod:665
18431 "To use a literal argument which begins with a tilde, you have to quote it, "
18436 #: ../fish/guestfish.pod:668
18444 #: ../fish/guestfish.pod:672
18446 "Libguestfs has some support for Linux guests encrypted according to the "
18447 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18448 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18449 "LUKS is supported."
18453 #: ../fish/guestfish.pod:677
18454 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18458 #: ../fish/guestfish.pod:679
18461 " ><fs> vfs-type /dev/sda2\n"
18467 #: ../fish/guestfish.pod:682
18469 "Then open those devices using L</luks-open>. This creates a device-mapper "
18470 "device called C</dev/mapper/luksdev>."
18474 #: ../fish/guestfish.pod:685
18477 " ><fs> luks-open /dev/sda2 luksdev\n"
18478 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18483 #: ../fish/guestfish.pod:688
18485 "Finally you have to tell LVM to scan for volume groups on the newly created "
18490 #: ../fish/guestfish.pod:691
18494 " vg-activate-all true\n"
18499 #: ../fish/guestfish.pod:694
18500 msgid "The logical volume(s) can now be mounted in the usual way."
18504 #: ../fish/guestfish.pod:696
18506 "Before closing a LUKS device you must unmount any logical volumes on it and "
18507 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18508 "one. Then you can close the mapper device:"
18512 #: ../fish/guestfish.pod:700
18515 " vg-activate false /dev/VG\n"
18516 " luks-close /dev/mapper/luksdev\n"
18521 #: ../fish/guestfish.pod:703
18522 msgid "WINDOWS PATHS"
18526 #: ../fish/guestfish.pod:705
18528 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18529 "(with some limitations). The following commands are equivalent:"
18533 #: ../fish/guestfish.pod:708
18536 " file /WINDOWS/system32/config/system.LOG\n"
18541 #: ../fish/guestfish.pod:710
18544 " file win:/windows/system32/config/system.log\n"
18549 #: ../fish/guestfish.pod:712
18552 " file win:\\windows\\system32\\config\\system.log\n"
18557 #: ../fish/guestfish.pod:714
18560 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18565 #: ../fish/guestfish.pod:716
18567 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18568 "handles case insensitivity like Windows would. This only works in argument "
18569 "positions that expect a path."
18573 #: ../fish/guestfish.pod:720
18574 msgid "UPLOADING AND DOWNLOADING FILES"
18578 #: ../fish/guestfish.pod:722
18580 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18581 "others which upload from or download to a local file, you can use the "
18582 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18586 #: ../fish/guestfish.pod:726
18594 #: ../fish/guestfish.pod:728
18596 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18600 #: ../fish/guestfish.pod:731
18603 " tar-out /etc - | tar tf -\n"
18608 #: ../fish/guestfish.pod:733
18610 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18611 "command (see L</PIPES>)."
18615 #: ../fish/guestfish.pod:736
18617 "When using C<-> to read from stdin, the input is read up to the end of "
18618 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18619 "some arbitrary end marker:"
18623 #: ../fish/guestfish.pod:740
18626 " upload -<<END /foo\n"
18635 #: ../fish/guestfish.pod:746
18637 "Any string of characters can be used instead of C<END>. The end marker must "
18638 "appear on a line of its own, without any preceeding or following characters "
18639 "(not even spaces)."
18643 #: ../fish/guestfish.pod:750
18645 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18646 "upload local files (so-called \"FileIn\" parameters in the generator)."
18650 #: ../fish/guestfish.pod:753
18651 msgid "EXIT ON ERROR BEHAVIOUR"
18655 #: ../fish/guestfish.pod:755
18657 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18658 "taking commands from a human over a tty), and will exit on the first error "
18659 "in non-interactive mode (scripts, commands given on the command line)."
18663 #: ../fish/guestfish.pod:760
18665 "If you prefix a command with a I<-> character, then that command will not "
18666 "cause guestfish to exit, even if that (one) command returns an error."
18670 #: ../fish/guestfish.pod:764
18671 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18675 #: ../fish/guestfish.pod:766
18677 "Guestfish can be remote-controlled over a socket. This is useful "
18678 "particularly in shell scripts where you want to make several different "
18679 "changes to a filesystem, but you don't want the overhead of starting up a "
18680 "guestfish process each time."
18684 #: ../fish/guestfish.pod:771
18685 msgid "Start a guestfish server process using:"
18689 #: ../fish/guestfish.pod:773
18692 " eval \"`guestfish --listen`\"\n"
18697 #: ../fish/guestfish.pod:775
18698 msgid "and then send it commands by doing:"
18702 #: ../fish/guestfish.pod:777
18705 " guestfish --remote cmd [...]\n"
18710 #: ../fish/guestfish.pod:779
18711 msgid "To cause the server to exit, send it the exit command:"
18715 #: ../fish/guestfish.pod:781
18718 " guestfish --remote exit\n"
18723 #: ../fish/guestfish.pod:783
18725 "Note that the server will normally exit if there is an error in a command. "
18726 "You can change this in the usual way. See section L</EXIT ON ERROR "
18731 #: ../fish/guestfish.pod:787
18732 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18736 #: ../fish/guestfish.pod:789
18738 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18739 "is how the I<--remote> option knows where to send the commands. You can "
18740 "have several guestfish listener processes running using:"
18744 #: ../fish/guestfish.pod:793
18747 " eval \"`guestfish --listen`\"\n"
18748 " pid1=$GUESTFISH_PID\n"
18749 " eval \"`guestfish --listen`\"\n"
18750 " pid2=$GUESTFISH_PID\n"
18752 " guestfish --remote=$pid1 cmd\n"
18753 " guestfish --remote=$pid2 cmd\n"
18758 #: ../fish/guestfish.pod:801
18759 msgid "REMOTE CONTROL AND CSH"
18763 #: ../fish/guestfish.pod:803
18765 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18770 #: ../fish/guestfish.pod:806
18773 " eval \"`guestfish --listen --csh`\"\n"
18778 #: ../fish/guestfish.pod:808
18779 msgid "REMOTE CONTROL DETAILS"
18783 #: ../fish/guestfish.pod:810
18785 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18786 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18787 "and C<$PID> is the process ID of the server."
18791 #: ../fish/guestfish.pod:814
18792 msgid "Guestfish client and server versions must match exactly."
18796 #: ../fish/guestfish.pod:816
18797 msgid "PREPARED DISK IMAGES"
18801 #: ../fish/guestfish.pod:818
18803 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18804 "preformatted disk images that guestfish can make for you to save typing. "
18805 "This is particularly useful for testing purposes. This option is used "
18806 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18807 "can be mixed with I<-a>)."
18811 #: ../fish/guestfish.pod:824
18813 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18814 "the second and so on. Existing files in the current directory are "
18819 #: ../fish/guestfish.pod:828
18821 "The type briefly describes how the disk should be sized, partitioned, how "
18822 "filesystem(s) should be created, and how content should be added. "
18823 "Optionally the type can be followed by extra parameters, separated by C<:> "
18824 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18825 "allocated disk, containing a single partition, with the partition formatted "
18826 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18831 #: ../fish/guestfish.pod:836
18832 msgid "To list the available types and any extra parameters they take, run:"
18836 #: ../fish/guestfish.pod:840
18838 "Note that the prepared filesystem is not mounted. You would usually have to "
18839 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18843 #: ../fish/guestfish.pod:844
18845 "If any I<-N> or I<--new> options are given, the guest is automatically "
18850 #: ../fish/guestfish.pod:849
18851 msgid "Create a 100MB disk with an ext4-formatted partition:"
18855 #: ../fish/guestfish.pod:851
18858 " guestfish -N fs:ext4\n"
18863 #: ../fish/guestfish.pod:853
18864 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18868 #: ../fish/guestfish.pod:855
18871 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18876 #: ../fish/guestfish.pod:857
18877 msgid "Create a blank 200MB disk:"
18881 #: ../fish/guestfish.pod:859
18884 " guestfish -N disk:200M\n"
18889 #: ../fish/guestfish.pod:861
18890 msgid "PROGRESS BARS"
18894 #: ../fish/guestfish.pod:863
18896 "Some (not all) long-running commands send progress notification messages as "
18897 "they are running. Guestfish turns these messages into progress bars."
18901 #: ../fish/guestfish.pod:867
18903 "When a command that supports progress bars takes longer than two seconds to "
18904 "run, and if progress bars are enabled, then you will see one appearing below "
18909 #: ../fish/guestfish.pod:871
18912 " ><fs> copy-size /large-file /another-file 2048M\n"
18913 " / 10% [#####-----------------------------------------] 00:30\n"
18918 #: ../fish/guestfish.pod:874
18920 "The spinner on the left hand side moves round once for every progress "
18921 "notification received from the backend. This is a (reasonably) golden "
18922 "assurance that the command is \"doing something\" even if the progress bar "
18923 "is not moving, because the command is able to send the progress "
18924 "notifications. When the bar reaches 100% and the command finishes, the "
18925 "spinner disappears."
18929 #: ../fish/guestfish.pod:881
18931 "Progress bars are enabled by default when guestfish is used interactively. "
18932 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18933 "and you can disable them completely using I<--no-progress-bars>."
18937 #: ../fish/guestfish.pod:886
18938 msgid "GUESTFISH COMMANDS"
18942 #: ../fish/guestfish.pod:888
18944 "The commands in this section are guestfish convenience commands, in other "
18945 "words, they are not part of the L<guestfs(3)> API."
18949 #: ../fish/guestfish.pod:891
18954 #: ../fish/guestfish.pod:893
18963 #: ../fish/guestfish.pod:896
18964 msgid "Without any parameter, this provides general help."
18968 #: ../fish/guestfish.pod:898
18969 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18973 #: ../fish/guestfish.pod:900
18974 msgid "quit | exit"
18978 #: ../fish/guestfish.pod:902
18979 msgid "This exits guestfish. You can also use C<^D> key."
18983 #: ../fish/guestfish.pod:904
18984 msgid "@FISH_COMMANDS@"
18988 #: ../fish/guestfish.pod:906
18993 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18998 #: ../fish/guestfish.pod:912
19000 "guestfish returns 0 if the commands completed without error, or 1 if there "
19005 #: ../fish/guestfish.pod:919
19010 #: ../fish/guestfish.pod:921
19012 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19017 #: ../fish/guestfish.pod:924
19018 msgid "GUESTFISH_PID"
19022 #: ../fish/guestfish.pod:926
19024 "Used with the I<--remote> option to specify the remote guestfish process to "
19025 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19029 #: ../fish/guestfish.pod:930
19034 #: ../fish/guestfish.pod:932
19036 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19037 "not specified, the external L<hexedit(1)> program is used."
19041 #: ../fish/guestfish.pod:936
19046 #: ../fish/guestfish.pod:938
19048 "If compiled with GNU readline support, various files in the home directory "
19049 "can be used. See L</FILES>."
19053 #: ../fish/guestfish.pod:947
19055 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19056 "effect as using the B<-v> option."
19060 #: ../fish/guestfish.pod:959
19062 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19063 "the discussion of paths in L<guestfs(3)>."
19067 #: ../fish/guestfish.pod:970
19068 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19072 #: ../fish/guestfish.pod:972
19077 #: ../fish/guestfish.pod:974
19079 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19084 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
19089 #: ../fish/guestfish.pod:993
19090 msgid "$HOME/.guestfish"
19094 #: ../fish/guestfish.pod:995
19096 "If compiled with GNU readline support, then the command history is saved in "
19101 #: ../fish/guestfish.pod:998
19102 msgid "$HOME/.inputrc"
19106 #: ../fish/guestfish.pod:1000
19107 msgid "/etc/inputrc"
19111 #: ../fish/guestfish.pod:1002
19113 "If compiled with GNU readline support, then these files can be used to "
19114 "configure readline. For further information, please see L<readline(3)/"
19115 "INITIALIZATION FILE>."
19119 #: ../fish/guestfish.pod:1006
19120 msgid "To write rules which only apply to guestfish, use:"
19124 #: ../fish/guestfish.pod:1008
19134 #: ../fish/guestfish.pod:1012
19136 "Variables that you can set in inputrc that change the behaviour of guestfish "
19137 "in useful ways include:"
19141 #: ../fish/guestfish.pod:1017
19142 msgid "completion-ignore-case (default: on)"
19146 #: ../fish/guestfish.pod:1019
19148 "By default, guestfish will ignore case when tab-completing paths on the "
19153 #: ../fish/guestfish.pod:1022
19156 " set completion-ignore-case off\n"
19161 #: ../fish/guestfish.pod:1024
19162 msgid "to make guestfish case sensitive."
19166 #: ../fish/guestfish.pod:1028
19171 #: ../fish/guestfish.pod:1030
19172 msgid "test2.img (etc)"
19176 #: ../fish/guestfish.pod:1032
19178 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19179 "will be created in the file C<test1.img> in the current directory. The "
19180 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19181 "the same name will be overwritten."
19185 #: ../fish/guestfish.pod:1041
19187 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19188 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
19189 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
19190 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
19195 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124
19196 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
19197 #: ../tools/virt-win-reg.pl:518 ../tools/virt-resize.pl:1512
19198 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
19199 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
19201 "This program is free software; you can redistribute it and/or modify it "
19202 "under the terms of the GNU General Public License as published by the Free "
19203 "Software Foundation; either version 2 of the License, or (at your option) "
19204 "any later version."
19208 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129
19209 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
19210 #: ../tools/virt-win-reg.pl:523 ../tools/virt-resize.pl:1517
19211 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
19212 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
19214 "This program is distributed in the hope that it will be useful, but WITHOUT "
19215 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19216 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19221 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134
19222 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
19223 #: ../tools/virt-win-reg.pl:528 ../tools/virt-resize.pl:1522
19224 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
19225 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
19227 "You should have received a copy of the GNU General Public License along with "
19228 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19229 "Ave, Cambridge, MA 02139, USA."
19233 #: ../fish/guestfish-actions.pod:1
19238 #: ../fish/guestfish-actions.pod:3
19241 " add-cdrom filename\n"
19246 #: ../fish/guestfish-actions.pod:15
19248 "This call checks for the existence of C<filename>. This stops you from "
19249 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19250 "and C<http:> URLs. To specify those, use the general L</config> call "
19255 #: ../fish/guestfish-actions.pod:22
19257 "If you just want to add an ISO file (often you use this as an efficient way "
19258 "to transfer large files into the guest), then you should probably use L</add-"
19259 "drive-ro> instead."
19263 #: ../fish/guestfish-actions.pod:35
19268 #: ../fish/guestfish-actions.pod:37
19273 #: ../fish/guestfish-actions.pod:39
19276 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19281 #: ../fish/guestfish-actions.pod:41
19283 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19284 "It works by connecting to libvirt, requesting the domain and domain XML from "
19285 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19289 #: ../fish/guestfish-actions.pod:58
19291 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19292 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19293 "libvirt URI (or one set through an environment variable, see the libvirt "
19294 "documentation for full details). If you are using the C API directly then "
19295 "it is more flexible to create the libvirt connection object yourself, get "
19296 "the domain object, and call L</add-libvirt-dom>."
19300 #: ../fish/guestfish-actions.pod:66
19302 "The other optional parameters are passed directly through to L</add-drive-"
19307 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19309 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19313 #: ../fish/guestfish-actions.pod:71
19318 #: ../fish/guestfish-actions.pod:73
19321 " add-drive filename\n"
19326 #: ../fish/guestfish-actions.pod:75
19328 "This function is the equivalent of calling L</add-drive-opts> with no "
19329 "optional parameters, so the disk is added writable, with the format being "
19330 "detected automatically."
19334 #: ../fish/guestfish-actions.pod:79
19336 "Automatic detection of the format opens you up to a potential security hole "
19337 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19338 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19339 "you should think about replacing calls to this function with calls to L</add-"
19340 "drive-opts>, and specifying the format."
19344 #: ../fish/guestfish-actions.pod:86
19345 msgid "add-drive-opts"
19349 #: ../fish/guestfish-actions.pod:88
19354 #: ../fish/guestfish-actions.pod:90
19357 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19362 #: ../fish/guestfish-actions.pod:117
19364 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19365 "add-drive-ro>) then the format is automatically detected. Possible formats "
19366 "include C<raw> and C<qcow2>."
19370 #: ../fish/guestfish-actions.pod:128
19372 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19373 "add-drive-with-if> call (q.v.)"
19377 #: ../fish/guestfish-actions.pod:135
19378 msgid "add-drive-ro"
19382 #: ../fish/guestfish-actions.pod:137
19387 #: ../fish/guestfish-actions.pod:139
19390 " add-drive-ro filename\n"
19395 #: ../fish/guestfish-actions.pod:141
19397 "This function is the equivalent of calling L</add-drive-opts> with the "
19398 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19399 "is added read-only, with the format being detected automatically."
19403 #: ../fish/guestfish-actions.pod:146
19404 msgid "add-drive-ro-with-if"
19408 #: ../fish/guestfish-actions.pod:148
19411 " add-drive-ro-with-if filename iface\n"
19416 #: ../fish/guestfish-actions.pod:150
19418 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19419 "interface emulation to use at run time."
19423 #: ../fish/guestfish-actions.pod:160
19424 msgid "add-drive-with-if"
19428 #: ../fish/guestfish-actions.pod:162
19431 " add-drive-with-if filename iface\n"
19436 #: ../fish/guestfish-actions.pod:164
19438 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19439 "interface emulation to use at run time."
19443 #: ../fish/guestfish-actions.pod:174
19448 #: ../fish/guestfish-actions.pod:176
19451 " aug-clear augpath\n"
19456 #: ../fish/guestfish-actions.pod:181
19461 #: ../fish/guestfish-actions.pod:183
19469 #: ../fish/guestfish-actions.pod:185
19471 "Close the current Augeas handle and free up any resources used by it. After "
19472 "calling this, you have to call L</aug-init> again before you can use any "
19473 "other Augeas functions."
19477 #: ../fish/guestfish-actions.pod:190
19478 msgid "aug-defnode"
19482 #: ../fish/guestfish-actions.pod:192
19485 " aug-defnode name expr val\n"
19490 #: ../fish/guestfish-actions.pod:197
19492 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19493 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19494 "containing that single node."
19498 #: ../fish/guestfish-actions.pod:205
19503 #: ../fish/guestfish-actions.pod:207
19506 " aug-defvar name expr\n"
19511 #: ../fish/guestfish-actions.pod:216
19516 #: ../fish/guestfish-actions.pod:218
19519 " aug-get augpath\n"
19524 #: ../fish/guestfish-actions.pod:223
19529 #: ../fish/guestfish-actions.pod:225
19532 " aug-init root flags\n"
19537 #: ../fish/guestfish-actions.pod:231
19538 msgid "You must call this before using any other L</aug-*> commands."
19542 #: ../fish/guestfish-actions.pod:266
19543 msgid "Do not load the tree in L</aug-init>."
19547 #: ../fish/guestfish-actions.pod:270
19548 msgid "To close the handle, you can call L</aug-close>."
19552 #: ../fish/guestfish-actions.pod:274
19557 #: ../fish/guestfish-actions.pod:276
19560 " aug-insert augpath label true|false\n"
19565 #: ../fish/guestfish-actions.pod:286
19570 #: ../fish/guestfish-actions.pod:288
19578 #: ../fish/guestfish-actions.pod:295
19583 #: ../fish/guestfish-actions.pod:297
19586 " aug-ls augpath\n"
19591 #: ../fish/guestfish-actions.pod:299
19593 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19594 "resulting nodes into alphabetical order."
19598 #: ../fish/guestfish-actions.pod:302
19603 #: ../fish/guestfish-actions.pod:304
19606 " aug-match augpath\n"
19611 #: ../fish/guestfish-actions.pod:310
19616 #: ../fish/guestfish-actions.pod:312
19619 " aug-mv src dest\n"
19624 #: ../fish/guestfish-actions.pod:317
19629 #: ../fish/guestfish-actions.pod:319
19632 " aug-rm augpath\n"
19637 #: ../fish/guestfish-actions.pod:325
19642 #: ../fish/guestfish-actions.pod:327
19650 #: ../fish/guestfish-actions.pod:331
19652 "The flags which were passed to L</aug-init> affect exactly how files are "
19657 #: ../fish/guestfish-actions.pod:334
19662 #: ../fish/guestfish-actions.pod:336
19665 " aug-set augpath val\n"
19670 #: ../fish/guestfish-actions.pod:340
19672 "In the Augeas API, it is possible to clear a node by setting the value to "
19673 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19674 "this call. Instead you must use the L</aug-clear> call."
19678 #: ../fish/guestfish-actions.pod:345
19683 #: ../fish/guestfish-actions.pod:347
19686 " available 'groups ...'\n"
19691 #: ../fish/guestfish-actions.pod:353
19693 "The libguestfs groups, and the functions that those groups correspond to, "
19694 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19695 "runtime by calling L</available-all-groups>."
19699 #: ../fish/guestfish-actions.pod:377
19700 msgid "You must call L</launch> before calling this function."
19704 #: ../fish/guestfish-actions.pod:399
19706 "This call was added in version C<1.0.80>. In previous versions of "
19707 "libguestfs all you could do would be to speculatively execute a command to "
19708 "find out if the daemon implemented it. See also L</version>."
19712 #: ../fish/guestfish-actions.pod:406
19713 msgid "available-all-groups"
19717 #: ../fish/guestfish-actions.pod:408
19720 " available-all-groups\n"
19725 #: ../fish/guestfish-actions.pod:410
19727 "This command returns a list of all optional groups that this daemon knows "
19728 "about. Note this returns both supported and unsupported groups. To find "
19729 "out which ones the daemon can actually support you have to call L</"
19730 "available> on each member of the returned list."
19734 #: ../fish/guestfish-actions.pod:416
19735 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19739 #: ../fish/guestfish-actions.pod:418
19744 #: ../fish/guestfish-actions.pod:420
19747 " base64-in (base64file|-) filename\n"
19752 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19753 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19754 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19755 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19756 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19757 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19758 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19759 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19763 #: ../fish/guestfish-actions.pod:427
19768 #: ../fish/guestfish-actions.pod:429
19771 " base64-out filename (base64file|-)\n"
19776 #: ../fish/guestfish-actions.pod:436
19777 msgid "blockdev-flushbufs"
19781 #: ../fish/guestfish-actions.pod:438
19784 " blockdev-flushbufs device\n"
19789 #: ../fish/guestfish-actions.pod:445
19790 msgid "blockdev-getbsz"
19794 #: ../fish/guestfish-actions.pod:447
19797 " blockdev-getbsz device\n"
19802 #: ../fish/guestfish-actions.pod:456
19803 msgid "blockdev-getro"
19807 #: ../fish/guestfish-actions.pod:458
19810 " blockdev-getro device\n"
19815 #: ../fish/guestfish-actions.pod:465
19816 msgid "blockdev-getsize64"
19820 #: ../fish/guestfish-actions.pod:467
19823 " blockdev-getsize64 device\n"
19828 #: ../fish/guestfish-actions.pod:471
19829 msgid "See also L</blockdev-getsz>."
19833 #: ../fish/guestfish-actions.pod:475
19834 msgid "blockdev-getss"
19838 #: ../fish/guestfish-actions.pod:477
19841 " blockdev-getss device\n"
19846 #: ../fish/guestfish-actions.pod:482
19848 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19852 #: ../fish/guestfish-actions.pod:487
19853 msgid "blockdev-getsz"
19857 #: ../fish/guestfish-actions.pod:489
19860 " blockdev-getsz device\n"
19865 #: ../fish/guestfish-actions.pod:494
19867 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19868 "blockdev-getsize64> for the more useful I<size in bytes>."
19872 #: ../fish/guestfish-actions.pod:500
19873 msgid "blockdev-rereadpt"
19877 #: ../fish/guestfish-actions.pod:502
19880 " blockdev-rereadpt device\n"
19885 #: ../fish/guestfish-actions.pod:508
19886 msgid "blockdev-setbsz"
19890 #: ../fish/guestfish-actions.pod:510
19893 " blockdev-setbsz device blocksize\n"
19898 #: ../fish/guestfish-actions.pod:519
19899 msgid "blockdev-setro"
19903 #: ../fish/guestfish-actions.pod:521
19906 " blockdev-setro device\n"
19911 #: ../fish/guestfish-actions.pod:527
19912 msgid "blockdev-setrw"
19916 #: ../fish/guestfish-actions.pod:529
19919 " blockdev-setrw device\n"
19924 #: ../fish/guestfish-actions.pod:535
19925 msgid "case-sensitive-path"
19929 #: ../fish/guestfish-actions.pod:537
19932 " case-sensitive-path path\n"
19937 #: ../fish/guestfish-actions.pod:561
19939 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19940 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19941 "the directories were originally created under Windows)."
19945 #: ../fish/guestfish-actions.pod:569
19946 msgid "See also L</realpath>."
19950 #: ../fish/guestfish-actions.pod:571
19955 #: ../fish/guestfish-actions.pod:573
19963 #: ../fish/guestfish-actions.pod:577
19965 "Note that this function cannot correctly handle binary files (specifically, "
19966 "files containing C<\\0> character which is treated as end of string). For "
19967 "those you need to use the L</read-file> or L</download> functions which have "
19968 "a more complex interface."
19972 #: ../fish/guestfish-actions.pod:585
19977 #: ../fish/guestfish-actions.pod:587
19980 " checksum csumtype path\n"
19985 #: ../fish/guestfish-actions.pod:630
19986 msgid "To get the checksum for a device, use L</checksum-device>."
19990 #: ../fish/guestfish-actions.pod:632
19991 msgid "To get the checksums for many files, use L</checksums-out>."
19995 #: ../fish/guestfish-actions.pod:634
19996 msgid "checksum-device"
20000 #: ../fish/guestfish-actions.pod:636
20003 " checksum-device csumtype device\n"
20008 #: ../fish/guestfish-actions.pod:638
20010 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20011 "device named C<device>. For the types of checksums supported see the L</"
20012 "checksum> command."
20016 #: ../fish/guestfish-actions.pod:642
20017 msgid "checksums-out"
20021 #: ../fish/guestfish-actions.pod:644
20024 " checksums-out csumtype directory (sumsfile|-)\n"
20029 #: ../fish/guestfish-actions.pod:660
20034 #: ../fish/guestfish-actions.pod:662
20037 " chmod mode path\n"
20042 #: ../fish/guestfish-actions.pod:673
20047 #: ../fish/guestfish-actions.pod:675
20050 " chown owner group path\n"
20055 #: ../fish/guestfish-actions.pod:683
20060 #: ../fish/guestfish-actions.pod:685
20063 " command 'arguments ...'\n"
20068 #: ../fish/guestfish-actions.pod:692
20070 "The single parameter is an argv-style list of arguments. The first element "
20071 "is the name of the program to run. Subsequent elements are parameters. The "
20072 "list must be non-empty (ie. must contain a program name). Note that the "
20073 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20077 #: ../fish/guestfish-actions.pod:720
20078 msgid "command-lines"
20082 #: ../fish/guestfish-actions.pod:722
20085 " command-lines 'arguments ...'\n"
20090 #: ../fish/guestfish-actions.pod:724
20092 "This is the same as L</command>, but splits the result into a list of lines."
20096 #: ../fish/guestfish-actions.pod:727
20097 msgid "See also: L</sh-lines>"
20101 #: ../fish/guestfish-actions.pod:732
20106 #: ../fish/guestfish-actions.pod:734
20109 " config qemuparam qemuvalue\n"
20114 #: ../fish/guestfish-actions.pod:745
20119 #: ../fish/guestfish-actions.pod:747
20122 " copy-size src dest size\n"
20127 #: ../fish/guestfish-actions.pod:755
20132 #: ../fish/guestfish-actions.pod:757
20140 #: ../fish/guestfish-actions.pod:762
20145 #: ../fish/guestfish-actions.pod:764
20153 #: ../fish/guestfish-actions.pod:769
20158 #: ../fish/guestfish-actions.pod:771
20166 #: ../fish/guestfish-actions.pod:778
20168 "If the destination is a device, it must be as large or larger than the "
20169 "source file or device, otherwise the copy will fail. This command cannot do "
20170 "partial copies (see L</copy-size>)."
20174 #: ../fish/guestfish-actions.pod:782
20179 #: ../fish/guestfish-actions.pod:784
20187 #: ../fish/guestfish-actions.pod:792
20192 #: ../fish/guestfish-actions.pod:794
20200 #: ../fish/guestfish-actions.pod:803
20205 #: ../fish/guestfish-actions.pod:805
20213 #: ../fish/guestfish-actions.pod:811
20215 "Another way to get the same information is to enable verbose messages with "
20216 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20217 "before running the program."
20221 #: ../fish/guestfish-actions.pod:816
20226 #: ../fish/guestfish-actions.pod:818
20229 " download remotefilename (filename|-)\n"
20234 #: ../fish/guestfish-actions.pod:825
20235 msgid "See also L</upload>, L</cat>."
20239 #: ../fish/guestfish-actions.pod:829
20240 msgid "download-offset"
20244 #: ../fish/guestfish-actions.pod:831
20247 " download-offset remotefilename (filename|-) offset size\n"
20252 #: ../fish/guestfish-actions.pod:839
20254 "Note that there is no limit on the amount of data that can be downloaded "
20255 "with this call, unlike with L</pread>, and this call always reads the full "
20256 "amount unless an error occurs."
20260 #: ../fish/guestfish-actions.pod:844
20261 msgid "See also L</download>, L</pread>."
20265 #: ../fish/guestfish-actions.pod:848
20266 msgid "drop-caches"
20270 #: ../fish/guestfish-actions.pod:850
20273 " drop-caches whattodrop\n"
20278 #: ../fish/guestfish-actions.pod:862
20283 #: ../fish/guestfish-actions.pod:864
20291 #: ../fish/guestfish-actions.pod:876
20296 #: ../fish/guestfish-actions.pod:878
20299 " e2fsck-f device\n"
20304 #: ../fish/guestfish-actions.pod:884
20306 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20307 "should use L</fsck>."
20311 #: ../fish/guestfish-actions.pod:887
20312 msgid "echo-daemon"
20316 #: ../fish/guestfish-actions.pod:889
20319 " echo-daemon 'words ...'\n"
20324 #: ../fish/guestfish-actions.pod:896
20325 msgid "See also L</ping-daemon>."
20329 #: ../fish/guestfish-actions.pod:898
20334 #: ../fish/guestfish-actions.pod:900
20337 " egrep regex path\n"
20342 #: ../fish/guestfish-actions.pod:908
20347 #: ../fish/guestfish-actions.pod:910
20350 " egrepi regex path\n"
20355 #: ../fish/guestfish-actions.pod:918
20360 #: ../fish/guestfish-actions.pod:920
20363 " equal file1 file2\n"
20368 #: ../fish/guestfish-actions.pod:927
20373 #: ../fish/guestfish-actions.pod:929
20381 #: ../fish/guestfish-actions.pod:934
20382 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20386 #: ../fish/guestfish-actions.pod:936
20391 #: ../fish/guestfish-actions.pod:938
20394 " fallocate path len\n"
20399 #: ../fish/guestfish-actions.pod:955
20400 msgid "fallocate64"
20404 #: ../fish/guestfish-actions.pod:957
20407 " fallocate64 path len\n"
20412 #: ../fish/guestfish-actions.pod:963
20414 "Note that this call allocates disk blocks for the file. To create a sparse "
20415 "file use L</truncate-size> instead."
20419 #: ../fish/guestfish-actions.pod:966
20421 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20422 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20423 "maximum size of files created through that call to 1GB."
20427 #: ../fish/guestfish-actions.pod:975
20432 #: ../fish/guestfish-actions.pod:977
20435 " fgrep pattern path\n"
20440 #: ../fish/guestfish-actions.pod:985
20445 #: ../fish/guestfish-actions.pod:987
20448 " fgrepi pattern path\n"
20453 #: ../fish/guestfish-actions.pod:995
20458 #: ../fish/guestfish-actions.pod:997
20466 #: ../fish/guestfish-actions.pod:1009
20468 "This command can also be used on C</dev/> devices (and partitions, LV "
20469 "names). You can for example use this to determine if a device contains a "
20470 "filesystem, although it's usually better to use L</vfs-type>."
20474 #: ../fish/guestfish-actions.pod:1019
20475 msgid "file-architecture"
20479 #: ../fish/guestfish-actions.pod:1021
20482 " file-architecture filename\n"
20487 #: ../fish/guestfish-actions.pod:1124
20492 #: ../fish/guestfish-actions.pod:1126
20500 #: ../fish/guestfish-actions.pod:1130
20502 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20503 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20507 #: ../fish/guestfish-actions.pod:1134
20512 #: ../fish/guestfish-actions.pod:1136
20515 " fill c len path\n"
20520 #: ../fish/guestfish-actions.pod:1142
20522 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20523 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20524 "L</fill-pattern>."
20528 #: ../fish/guestfish-actions.pod:1147
20529 msgid "fill-pattern"
20533 #: ../fish/guestfish-actions.pod:1149
20536 " fill-pattern pattern len path\n"
20541 #: ../fish/guestfish-actions.pod:1151
20543 "This function is like L</fill> except that it creates a new file of length "
20544 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20545 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20550 #: ../fish/guestfish-actions.pod:1156
20555 #: ../fish/guestfish-actions.pod:1158
20558 " find directory\n"
20563 #: ../fish/guestfish-actions.pod:1172
20564 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20568 #: ../fish/guestfish-actions.pod:1185
20569 msgid "See also L</find0>."
20573 #: ../fish/guestfish-actions.pod:1190
20578 #: ../fish/guestfish-actions.pod:1192
20581 " find0 directory (files|-)\n"
20586 #: ../fish/guestfish-actions.pod:1198
20588 "This command works the same way as L</find> with the following exceptions:"
20592 #: ../fish/guestfish-actions.pod:1225
20593 msgid "findfs-label"
20597 #: ../fish/guestfish-actions.pod:1227
20600 " findfs-label label\n"
20605 #: ../fish/guestfish-actions.pod:1233
20606 msgid "To find the label of a filesystem, use L</vfs-label>."
20610 #: ../fish/guestfish-actions.pod:1235
20611 msgid "findfs-uuid"
20615 #: ../fish/guestfish-actions.pod:1237
20618 " findfs-uuid uuid\n"
20623 #: ../fish/guestfish-actions.pod:1243
20624 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20628 #: ../fish/guestfish-actions.pod:1245
20633 #: ../fish/guestfish-actions.pod:1247
20636 " fsck fstype device\n"
20641 #: ../fish/guestfish-actions.pod:1277
20646 #: ../fish/guestfish-actions.pod:1279
20654 #: ../fish/guestfish-actions.pod:1286
20655 msgid "get-autosync"
20659 #: ../fish/guestfish-actions.pod:1288
20667 #: ../fish/guestfish-actions.pod:1292
20672 #: ../fish/guestfish-actions.pod:1294
20680 #: ../fish/guestfish-actions.pod:1298
20681 msgid "get-e2label"
20685 #: ../fish/guestfish-actions.pod:1300
20688 " get-e2label device\n"
20693 #: ../fish/guestfish-actions.pod:1312
20698 #: ../fish/guestfish-actions.pod:1314
20701 " get-e2uuid device\n"
20706 #: ../fish/guestfish-actions.pod:1326
20707 msgid "get-memsize"
20711 #: ../fish/guestfish-actions.pod:1328
20719 #: ../fish/guestfish-actions.pod:1333
20721 "If L</set-memsize> was not called on this handle, and if "
20722 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20723 "value for memsize."
20727 #: ../fish/guestfish-actions.pod:1340
20728 msgid "get-network"
20732 #: ../fish/guestfish-actions.pod:1342
20740 #: ../fish/guestfish-actions.pod:1346
20745 #: ../fish/guestfish-actions.pod:1348
20753 #: ../fish/guestfish-actions.pod:1355
20758 #: ../fish/guestfish-actions.pod:1357
20763 #: ../fish/guestfish-actions.pod:1359
20771 #: ../fish/guestfish-actions.pod:1366
20776 #: ../fish/guestfish-actions.pod:1368
20784 #: ../fish/guestfish-actions.pod:1375
20785 msgid "get-recovery-proc"
20789 #: ../fish/guestfish-actions.pod:1377
20792 " get-recovery-proc\n"
20797 #: ../fish/guestfish-actions.pod:1381
20798 msgid "get-selinux"
20802 #: ../fish/guestfish-actions.pod:1383
20810 #: ../fish/guestfish-actions.pod:1385
20812 "This returns the current setting of the selinux flag which is passed to the "
20813 "appliance at boot time. See L</set-selinux>."
20817 #: ../fish/guestfish-actions.pod:1391
20822 #: ../fish/guestfish-actions.pod:1393
20830 #: ../fish/guestfish-actions.pod:1400
20835 #: ../fish/guestfish-actions.pod:1402
20843 #: ../fish/guestfish-actions.pod:1406
20848 #: ../fish/guestfish-actions.pod:1408
20856 #: ../fish/guestfish-actions.pod:1410
20858 "Return the current umask. By default the umask is C<022> unless it has been "
20859 "set by calling L</umask>."
20863 #: ../fish/guestfish-actions.pod:1413
20864 msgid "get-verbose"
20868 #: ../fish/guestfish-actions.pod:1415
20876 #: ../fish/guestfish-actions.pod:1419
20881 #: ../fish/guestfish-actions.pod:1421
20889 #: ../fish/guestfish-actions.pod:1425
20890 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20894 #: ../fish/guestfish-actions.pod:1428
20899 #: ../fish/guestfish-actions.pod:1430
20902 " getxattrs path\n"
20907 #: ../fish/guestfish-actions.pod:1438
20908 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20912 #: ../fish/guestfish-actions.pod:1440
20913 msgid "glob-expand"
20917 #: ../fish/guestfish-actions.pod:1442
20920 " glob-expand pattern\n"
20925 #: ../fish/guestfish-actions.pod:1455
20930 #: ../fish/guestfish-actions.pod:1457
20933 " grep regex path\n"
20938 #: ../fish/guestfish-actions.pod:1465
20943 #: ../fish/guestfish-actions.pod:1467
20946 " grepi regex path\n"
20951 #: ../fish/guestfish-actions.pod:1475
20952 msgid "grub-install"
20956 #: ../fish/guestfish-actions.pod:1477
20959 " grub-install root device\n"
20964 #: ../fish/guestfish-actions.pod:1493
20969 #: ../fish/guestfish-actions.pod:1495
20977 #: ../fish/guestfish-actions.pod:1503
20982 #: ../fish/guestfish-actions.pod:1505
20985 " head-n nrlines path\n"
20990 #: ../fish/guestfish-actions.pod:1518
20995 #: ../fish/guestfish-actions.pod:1520
21003 #: ../fish/guestfish-actions.pod:1528
21008 #: ../fish/guestfish-actions.pod:1530
21011 " initrd-cat initrdpath filename\n"
21016 #: ../fish/guestfish-actions.pod:1542
21017 msgid "See also L</initrd-list>."
21021 #: ../fish/guestfish-actions.pod:1547
21022 msgid "initrd-list"
21026 #: ../fish/guestfish-actions.pod:1549
21029 " initrd-list path\n"
21034 #: ../fish/guestfish-actions.pod:1561
21035 msgid "inotify-add-watch"
21039 #: ../fish/guestfish-actions.pod:1563
21042 " inotify-add-watch path mask\n"
21047 #: ../fish/guestfish-actions.pod:1575
21048 msgid "inotify-close"
21052 #: ../fish/guestfish-actions.pod:1577
21060 #: ../fish/guestfish-actions.pod:1583
21061 msgid "inotify-files"
21065 #: ../fish/guestfish-actions.pod:1585
21073 #: ../fish/guestfish-actions.pod:1587
21075 "This function is a helpful wrapper around L</inotify-read> which just "
21076 "returns a list of pathnames of objects that were touched. The returned "
21077 "pathnames are sorted and deduplicated."
21081 #: ../fish/guestfish-actions.pod:1591
21082 msgid "inotify-init"
21086 #: ../fish/guestfish-actions.pod:1593
21089 " inotify-init maxevents\n"
21094 #: ../fish/guestfish-actions.pod:1599
21096 "C<maxevents> is the maximum number of events which will be queued up between "
21097 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21098 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21099 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21100 "but records the fact that it threw them away by setting a flag "
21101 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21105 #: ../fish/guestfish-actions.pod:1609
21107 "Before any events are generated, you have to add some watches to the "
21108 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21109 "L</inotify-watch-all>."
21113 #: ../fish/guestfish-actions.pod:1615
21115 "Queued up events should be read periodically by calling L</inotify-read> (or "
21116 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21117 "If you don't read the events out often enough then you risk the internal "
21118 "queue overflowing."
21122 #: ../fish/guestfish-actions.pod:1622
21124 "The handle should be closed after use by calling L</inotify-close>. This "
21125 "also removes any watches automatically."
21129 #: ../fish/guestfish-actions.pod:1631
21130 msgid "inotify-read"
21134 #: ../fish/guestfish-actions.pod:1633
21142 #: ../fish/guestfish-actions.pod:1646
21143 msgid "inotify-rm-watch"
21147 #: ../fish/guestfish-actions.pod:1648
21150 " inotify-rm-watch wd\n"
21155 #: ../fish/guestfish-actions.pod:1650
21156 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21160 #: ../fish/guestfish-actions.pod:1653
21161 msgid "inspect-get-arch"
21165 #: ../fish/guestfish-actions.pod:1655
21168 " inspect-get-arch root\n"
21173 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21174 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21175 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21176 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21177 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21178 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21179 #: ../fish/guestfish-actions.pod:1966
21181 "This function should only be called with a root device string as returned by "
21186 #: ../fish/guestfish-actions.pod:1660
21188 "This returns the architecture of the inspected operating system. The "
21189 "possible return values are listed under L</file-architecture>."
21193 #: ../fish/guestfish-actions.pod:1669
21194 msgid "inspect-get-distro"
21198 #: ../fish/guestfish-actions.pod:1671
21201 " inspect-get-distro root\n"
21206 #: ../fish/guestfish-actions.pod:1743
21207 msgid "inspect-get-filesystems"
21211 #: ../fish/guestfish-actions.pod:1745
21214 " inspect-get-filesystems root\n"
21219 #: ../fish/guestfish-actions.pod:1758
21221 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21222 "get-mountpoints>."
21226 #: ../fish/guestfish-actions.pod:1761
21227 msgid "inspect-get-hostname"
21231 #: ../fish/guestfish-actions.pod:1763
21234 " inspect-get-hostname root\n"
21239 #: ../fish/guestfish-actions.pod:1776
21240 msgid "inspect-get-major-version"
21244 #: ../fish/guestfish-actions.pod:1778
21247 " inspect-get-major-version root\n"
21252 #: ../fish/guestfish-actions.pod:1797
21253 msgid "inspect-get-minor-version"
21257 #: ../fish/guestfish-actions.pod:1799
21260 " inspect-get-minor-version root\n"
21265 #: ../fish/guestfish-actions.pod:1809
21267 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21268 "get-major-version>."
21272 #: ../fish/guestfish-actions.pod:1812
21273 msgid "inspect-get-mountpoints"
21277 #: ../fish/guestfish-actions.pod:1814
21280 " inspect-get-mountpoints root\n"
21285 #: ../fish/guestfish-actions.pod:1832
21287 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21288 "get-filesystems>."
21292 #: ../fish/guestfish-actions.pod:1835
21293 msgid "inspect-get-package-format"
21297 #: ../fish/guestfish-actions.pod:1837
21300 " inspect-get-package-format root\n"
21305 #: ../fish/guestfish-actions.pod:1842
21307 "This function and L</inspect-get-package-management> return the package "
21308 "format and package management tool used by the inspected operating system. "
21309 "For example for Fedora these functions would return C<rpm> (package format) "
21310 "and C<yum> (package management)."
21314 #: ../fish/guestfish-actions.pod:1857
21315 msgid "inspect-get-package-management"
21319 #: ../fish/guestfish-actions.pod:1859
21322 " inspect-get-package-management root\n"
21327 #: ../fish/guestfish-actions.pod:1864
21329 "L</inspect-get-package-format> and this function return the package format "
21330 "and package management tool used by the inspected operating system. For "
21331 "example for Fedora these functions would return C<rpm> (package format) and "
21332 "C<yum> (package management)."
21336 #: ../fish/guestfish-actions.pod:1881
21337 msgid "inspect-get-product-name"
21341 #: ../fish/guestfish-actions.pod:1883
21344 " inspect-get-product-name root\n"
21349 #: ../fish/guestfish-actions.pod:1898
21350 msgid "inspect-get-roots"
21354 #: ../fish/guestfish-actions.pod:1900
21357 " inspect-get-roots\n"
21362 #: ../fish/guestfish-actions.pod:1902
21364 "This function is a convenient way to get the list of root devices, as "
21365 "returned from a previous call to L</inspect-os>, but without redoing the "
21366 "whole inspection process."
21370 #: ../fish/guestfish-actions.pod:1906
21372 "This returns an empty list if either no root devices were found or the "
21373 "caller has not called L</inspect-os>."
21377 #: ../fish/guestfish-actions.pod:1911
21378 msgid "inspect-get-type"
21382 #: ../fish/guestfish-actions.pod:1913
21385 " inspect-get-type root\n"
21390 #: ../fish/guestfish-actions.pod:1946
21391 msgid "inspect-get-windows-systemroot"
21395 #: ../fish/guestfish-actions.pod:1948
21398 " inspect-get-windows-systemroot root\n"
21403 #: ../fish/guestfish-actions.pod:1962
21404 msgid "inspect-list-applications"
21408 #: ../fish/guestfish-actions.pod:1964
21411 " inspect-list-applications root\n"
21416 #: ../fish/guestfish-actions.pod:1971
21418 "I<Note:> This call works differently from other parts of the inspection "
21419 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21420 "then mount up the disks, before calling this. Listing applications is a "
21421 "significantly more difficult operation which requires access to the full "
21422 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21423 "are just returning data cached in the libguestfs handle, this call actually "
21424 "reads parts of the mounted filesystems during the call."
21428 #: ../fish/guestfish-actions.pod:2061
21433 #: ../fish/guestfish-actions.pod:2063
21441 #: ../fish/guestfish-actions.pod:2078
21443 "You can pass the root string(s) returned to other L</inspect-get-*> "
21444 "functions in order to query further information about each operating system, "
21445 "such as the name and version."
21449 #: ../fish/guestfish-actions.pod:2083
21451 "This function uses other libguestfs features such as L</mount-ro> and L</"
21452 "umount-all> in order to mount and unmount filesystems and look at the "
21453 "contents. This should be called with no disks currently mounted. The "
21454 "function may also use Augeas, so any existing Augeas handle will be closed."
21458 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21459 #: ../fish/guestfish-actions.pod:2297
21460 msgid "See also L</list-filesystems>."
21464 #: ../fish/guestfish-actions.pod:2097
21465 msgid "is-blockdev"
21469 #: ../fish/guestfish-actions.pod:2099
21472 " is-blockdev path\n"
21477 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21478 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21479 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21480 #: ../fish/guestfish-actions.pod:2203
21481 msgid "See also L</stat>."
21485 #: ../fish/guestfish-actions.pod:2106
21490 #: ../fish/guestfish-actions.pod:2108
21498 #: ../fish/guestfish-actions.pod:2115
21503 #: ../fish/guestfish-actions.pod:2117
21506 " is-chardev path\n"
21511 #: ../fish/guestfish-actions.pod:2124
21516 #: ../fish/guestfish-actions.pod:2126
21524 #: ../fish/guestfish-actions.pod:2133
21529 #: ../fish/guestfish-actions.pod:2135
21537 #: ../fish/guestfish-actions.pod:2143
21542 #: ../fish/guestfish-actions.pod:2145
21550 #: ../fish/guestfish-actions.pod:2152
21555 #: ../fish/guestfish-actions.pod:2154
21563 #: ../fish/guestfish-actions.pod:2162
21564 msgid "is-launching"
21568 #: ../fish/guestfish-actions.pod:2164
21576 #: ../fish/guestfish-actions.pod:2171
21581 #: ../fish/guestfish-actions.pod:2173
21589 #: ../fish/guestfish-actions.pod:2178
21594 #: ../fish/guestfish-actions.pod:2180
21602 #: ../fish/guestfish-actions.pod:2187
21607 #: ../fish/guestfish-actions.pod:2189
21610 " is-socket path\n"
21615 #: ../fish/guestfish-actions.pod:2196
21620 #: ../fish/guestfish-actions.pod:2198
21623 " is-symlink path\n"
21628 #: ../fish/guestfish-actions.pod:2205
21629 msgid "kill-subprocess"
21633 #: ../fish/guestfish-actions.pod:2207
21636 " kill-subprocess\n"
21641 #: ../fish/guestfish-actions.pod:2211
21646 #: ../fish/guestfish-actions.pod:2213
21651 #: ../fish/guestfish-actions.pod:2215
21659 #: ../fish/guestfish-actions.pod:2223
21664 #: ../fish/guestfish-actions.pod:2225
21667 " lchown owner group path\n"
21672 #: ../fish/guestfish-actions.pod:2227
21674 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21675 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21680 #: ../fish/guestfish-actions.pod:2235
21685 #: ../fish/guestfish-actions.pod:2237
21688 " lgetxattrs path\n"
21693 #: ../fish/guestfish-actions.pod:2239
21695 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21696 "it returns the extended attributes of the link itself."
21700 #: ../fish/guestfish-actions.pod:2243
21701 msgid "list-devices"
21705 #: ../fish/guestfish-actions.pod:2245
21713 #: ../fish/guestfish-actions.pod:2253
21714 msgid "list-filesystems"
21718 #: ../fish/guestfish-actions.pod:2255
21721 " list-filesystems\n"
21726 #: ../fish/guestfish-actions.pod:2274
21728 "This command runs other libguestfs commands, which might include L</mount> "
21729 "and L</umount>, and therefore you should use this soon after launch and only "
21730 "when nothing is mounted."
21734 #: ../fish/guestfish-actions.pod:2278
21736 "Not all of the filesystems returned will be mountable. In particular, swap "
21737 "partitions are returned in the list. Also this command does not check that "
21738 "each filesystem found is valid and mountable, and some filesystems might be "
21739 "mountable but require special options. Filesystems may not all belong to a "
21740 "single logical operating system (use L</inspect-os> to look for OSes)."
21744 #: ../fish/guestfish-actions.pod:2286
21745 msgid "list-partitions"
21749 #: ../fish/guestfish-actions.pod:2288
21752 " list-partitions\n"
21757 #: ../fish/guestfish-actions.pod:2294
21759 "This does not return logical volumes. For that you will need to call L</"
21764 #: ../fish/guestfish-actions.pod:2299
21769 #: ../fish/guestfish-actions.pod:2301
21777 #: ../fish/guestfish-actions.pod:2309
21782 #: ../fish/guestfish-actions.pod:2311
21785 " ln target linkname\n"
21790 #: ../fish/guestfish-actions.pod:2315
21795 #: ../fish/guestfish-actions.pod:2317
21798 " ln-f target linkname\n"
21803 #: ../fish/guestfish-actions.pod:2322
21808 #: ../fish/guestfish-actions.pod:2324
21811 " ln-s target linkname\n"
21816 #: ../fish/guestfish-actions.pod:2328
21821 #: ../fish/guestfish-actions.pod:2330
21824 " ln-sf target linkname\n"
21829 #: ../fish/guestfish-actions.pod:2335
21830 msgid "lremovexattr"
21834 #: ../fish/guestfish-actions.pod:2337
21837 " lremovexattr xattr path\n"
21842 #: ../fish/guestfish-actions.pod:2339
21844 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21845 "it removes an extended attribute of the link itself."
21849 #: ../fish/guestfish-actions.pod:2343
21854 #: ../fish/guestfish-actions.pod:2345
21862 #: ../fish/guestfish-actions.pod:2351
21864 "This command is mostly useful for interactive sessions. Programs should "
21865 "probably use L</readdir> instead."
21869 #: ../fish/guestfish-actions.pod:2354
21874 #: ../fish/guestfish-actions.pod:2356
21877 " lsetxattr xattr val vallen path\n"
21882 #: ../fish/guestfish-actions.pod:2358
21884 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21885 "sets an extended attribute of the link itself."
21889 #: ../fish/guestfish-actions.pod:2362
21894 #: ../fish/guestfish-actions.pod:2364
21902 #: ../fish/guestfish-actions.pod:2368
21904 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21905 "the link is stat-ed, not the file it refers to."
21909 #: ../fish/guestfish-actions.pod:2374
21914 #: ../fish/guestfish-actions.pod:2376
21917 " lstatlist path 'names ...'\n"
21922 #: ../fish/guestfish-actions.pod:2378
21924 "This call allows you to perform the L</lstat> operation on multiple files, "
21925 "where all files are in the directory C<path>. C<names> is the list of files "
21926 "from this directory."
21930 #: ../fish/guestfish-actions.pod:2387
21932 "This call is intended for programs that want to efficiently list a directory "
21933 "contents without making many round-trips. See also L</lxattrlist> for a "
21934 "similarly efficient call for getting extended attributes. Very long "
21935 "directory listings might cause the protocol message size to be exceeded, "
21936 "causing this call to fail. The caller must split up such requests into "
21937 "smaller groups of names."
21941 #: ../fish/guestfish-actions.pod:2395
21942 msgid "luks-add-key"
21946 #: ../fish/guestfish-actions.pod:2397
21949 " luks-add-key device keyslot\n"
21954 #: ../fish/guestfish-actions.pod:2404
21956 "Note that if C<keyslot> already contains a key, then this command will "
21957 "fail. You have to use L</luks-kill-slot> first to remove that key."
21961 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21962 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21963 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21965 "This command has one or more key or passphrase parameters. Guestfish will "
21966 "prompt for these separately."
21970 #: ../fish/guestfish-actions.pod:2411
21975 #: ../fish/guestfish-actions.pod:2413
21978 " luks-close device\n"
21983 #: ../fish/guestfish-actions.pod:2415
21985 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21986 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
21987 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
21992 #: ../fish/guestfish-actions.pod:2421
21993 msgid "luks-format"
21997 #: ../fish/guestfish-actions.pod:2423
22000 " luks-format device keyslot\n"
22005 #: ../fish/guestfish-actions.pod:2436
22006 msgid "luks-format-cipher"
22010 #: ../fish/guestfish-actions.pod:2438
22013 " luks-format-cipher device keyslot cipher\n"
22018 #: ../fish/guestfish-actions.pod:2440
22020 "This command is the same as L</luks-format> but it also allows you to set "
22021 "the C<cipher> used."
22025 #: ../fish/guestfish-actions.pod:2449
22026 msgid "luks-kill-slot"
22030 #: ../fish/guestfish-actions.pod:2451
22033 " luks-kill-slot device keyslot\n"
22038 #: ../fish/guestfish-actions.pod:2460
22043 #: ../fish/guestfish-actions.pod:2462
22046 " luks-open device mapname\n"
22051 #: ../fish/guestfish-actions.pod:2476
22053 "If this block device contains LVM volume groups, then calling L</vgscan> "
22054 "followed by L</vg-activate-all> will make them visible."
22058 #: ../fish/guestfish-actions.pod:2483
22059 msgid "luks-open-ro"
22063 #: ../fish/guestfish-actions.pod:2485
22066 " luks-open-ro device mapname\n"
22071 #: ../fish/guestfish-actions.pod:2487
22073 "This is the same as L</luks-open> except that a read-only mapping is created."
22077 #: ../fish/guestfish-actions.pod:2493
22082 #: ../fish/guestfish-actions.pod:2495
22085 " lvcreate logvol volgroup mbytes\n"
22090 #: ../fish/guestfish-actions.pod:2500
22091 msgid "lvm-canonical-lv-name"
22095 #: ../fish/guestfish-actions.pod:2502
22098 " lvm-canonical-lv-name lvname\n"
22103 #: ../fish/guestfish-actions.pod:2511
22104 msgid "See also L</is-lv>."
22108 #: ../fish/guestfish-actions.pod:2513
22109 msgid "lvm-clear-filter"
22113 #: ../fish/guestfish-actions.pod:2515
22116 " lvm-clear-filter\n"
22121 #: ../fish/guestfish-actions.pod:2517
22123 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22128 #: ../fish/guestfish-actions.pod:2523
22129 msgid "lvm-remove-all"
22133 #: ../fish/guestfish-actions.pod:2525
22136 " lvm-remove-all\n"
22141 #: ../fish/guestfish-actions.pod:2533
22142 msgid "lvm-set-filter"
22146 #: ../fish/guestfish-actions.pod:2535
22149 " lvm-set-filter 'devices ...'\n"
22154 #: ../fish/guestfish-actions.pod:2560
22159 #: ../fish/guestfish-actions.pod:2562
22162 " lvremove device\n"
22167 #: ../fish/guestfish-actions.pod:2570
22172 #: ../fish/guestfish-actions.pod:2572
22175 " lvrename logvol newlogvol\n"
22180 #: ../fish/guestfish-actions.pod:2576
22185 #: ../fish/guestfish-actions.pod:2578
22188 " lvresize device mbytes\n"
22193 #: ../fish/guestfish-actions.pod:2584
22194 msgid "lvresize-free"
22198 #: ../fish/guestfish-actions.pod:2586
22201 " lvresize-free lv percent\n"
22206 #: ../fish/guestfish-actions.pod:2594
22211 #: ../fish/guestfish-actions.pod:2596
22219 #: ../fish/guestfish-actions.pod:2604
22220 msgid "See also L</lvs-full>, L</list-filesystems>."
22224 #: ../fish/guestfish-actions.pod:2606
22229 #: ../fish/guestfish-actions.pod:2608
22237 #: ../fish/guestfish-actions.pod:2613
22242 #: ../fish/guestfish-actions.pod:2615
22250 #: ../fish/guestfish-actions.pod:2619
22255 #: ../fish/guestfish-actions.pod:2621
22258 " lxattrlist path 'names ...'\n"
22263 #: ../fish/guestfish-actions.pod:2637
22265 "This call is intended for programs that want to efficiently list a directory "
22266 "contents without making many round-trips. See also L</lstatlist> for a "
22267 "similarly efficient call for getting standard stats. Very long directory "
22268 "listings might cause the protocol message size to be exceeded, causing this "
22269 "call to fail. The caller must split up such requests into smaller groups of "
22274 #: ../fish/guestfish-actions.pod:2645
22279 #: ../fish/guestfish-actions.pod:2647
22287 #: ../fish/guestfish-actions.pod:2651
22292 #: ../fish/guestfish-actions.pod:2653
22295 " mkdir-mode path mode\n"
22300 #: ../fish/guestfish-actions.pod:2662
22301 msgid "See also L</mkdir>, L</umask>"
22305 #: ../fish/guestfish-actions.pod:2664
22310 #: ../fish/guestfish-actions.pod:2666
22318 #: ../fish/guestfish-actions.pod:2671
22323 #: ../fish/guestfish-actions.pod:2673
22326 " mkdtemp template\n"
22331 #: ../fish/guestfish-actions.pod:2694
22336 #: ../fish/guestfish-actions.pod:2696
22339 " mke2fs-J fstype blocksize device journal\n"
22344 #: ../fish/guestfish-actions.pod:2704
22345 msgid "See also L</mke2journal>."
22349 #: ../fish/guestfish-actions.pod:2706
22354 #: ../fish/guestfish-actions.pod:2708
22357 " mke2fs-JL fstype blocksize device label\n"
22362 #: ../fish/guestfish-actions.pod:2713
22363 msgid "See also L</mke2journal-L>."
22367 #: ../fish/guestfish-actions.pod:2715
22372 #: ../fish/guestfish-actions.pod:2717
22375 " mke2fs-JU fstype blocksize device uuid\n"
22380 #: ../fish/guestfish-actions.pod:2722
22381 msgid "See also L</mke2journal-U>."
22385 #: ../fish/guestfish-actions.pod:2724
22386 msgid "mke2journal"
22390 #: ../fish/guestfish-actions.pod:2726
22393 " mke2journal blocksize device\n"
22398 #: ../fish/guestfish-actions.pod:2733
22399 msgid "mke2journal-L"
22403 #: ../fish/guestfish-actions.pod:2735
22406 " mke2journal-L blocksize label device\n"
22411 #: ../fish/guestfish-actions.pod:2739
22412 msgid "mke2journal-U"
22416 #: ../fish/guestfish-actions.pod:2741
22419 " mke2journal-U blocksize uuid device\n"
22424 #: ../fish/guestfish-actions.pod:2745
22429 #: ../fish/guestfish-actions.pod:2747
22432 " mkfifo mode path\n"
22437 #: ../fish/guestfish-actions.pod:2749
22439 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22440 "is just a convenient wrapper around L</mknod>."
22444 #: ../fish/guestfish-actions.pod:2755
22449 #: ../fish/guestfish-actions.pod:2757
22452 " mkfs fstype device\n"
22457 #: ../fish/guestfish-actions.pod:2763
22462 #: ../fish/guestfish-actions.pod:2765
22465 " mkfs-b fstype blocksize device\n"
22470 #: ../fish/guestfish-actions.pod:2767
22472 "This call is similar to L</mkfs>, but it allows you to control the block "
22473 "size of the resulting filesystem. Supported block sizes depend on the "
22474 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22478 #: ../fish/guestfish-actions.pod:2775
22479 msgid "mkmountpoint"
22483 #: ../fish/guestfish-actions.pod:2777
22486 " mkmountpoint exemptpath\n"
22491 #: ../fish/guestfish-actions.pod:2779
22493 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22494 "to create extra mountpoints before mounting the first filesystem."
22498 #: ../fish/guestfish-actions.pod:2803
22500 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22501 "unexpected errors if you try to mix these calls. It is safest to manually "
22502 "unmount filesystems and remove mountpoints after use."
22506 #: ../fish/guestfish-actions.pod:2807
22508 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22509 "for this to work for manual mountpoints, you must ensure that the innermost "
22510 "mountpoints have the longest pathnames, as in the example code above."
22514 #: ../fish/guestfish-actions.pod:2814
22516 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22517 "that L</umount-all> is called when the handle is closed which can also "
22518 "trigger these issues."
22522 #: ../fish/guestfish-actions.pod:2818
22527 #: ../fish/guestfish-actions.pod:2820
22530 " mknod mode devmajor devminor path\n"
22535 #: ../fish/guestfish-actions.pod:2830
22537 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22538 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22539 "regular file). These constants are available in the standard Linux header "
22540 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22541 "wrappers around this command which bitwise OR in the appropriate constant "
22546 #: ../fish/guestfish-actions.pod:2840
22551 #: ../fish/guestfish-actions.pod:2842
22554 " mknod-b mode devmajor devminor path\n"
22559 #: ../fish/guestfish-actions.pod:2844
22561 "This call creates a block device node called C<path> with mode C<mode> and "
22562 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22563 "wrapper around L</mknod>."
22567 #: ../fish/guestfish-actions.pod:2850
22572 #: ../fish/guestfish-actions.pod:2852
22575 " mknod-c mode devmajor devminor path\n"
22580 #: ../fish/guestfish-actions.pod:2854
22582 "This call creates a char device node called C<path> with mode C<mode> and "
22583 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22584 "wrapper around L</mknod>."
22588 #: ../fish/guestfish-actions.pod:2860
22593 #: ../fish/guestfish-actions.pod:2862
22601 #: ../fish/guestfish-actions.pod:2866
22606 #: ../fish/guestfish-actions.pod:2868
22609 " mkswap-L label device\n"
22614 #: ../fish/guestfish-actions.pod:2876
22619 #: ../fish/guestfish-actions.pod:2878
22622 " mkswap-U uuid device\n"
22627 #: ../fish/guestfish-actions.pod:2882
22628 msgid "mkswap-file"
22632 #: ../fish/guestfish-actions.pod:2884
22635 " mkswap-file path\n"
22640 #: ../fish/guestfish-actions.pod:2888
22642 "This command just writes a swap file signature to an existing file. To "
22643 "create the file itself, use something like L</fallocate>."
22647 #: ../fish/guestfish-actions.pod:2891
22652 #: ../fish/guestfish-actions.pod:2893
22655 " modprobe modulename\n"
22660 #: ../fish/guestfish-actions.pod:2900
22665 #: ../fish/guestfish-actions.pod:2902
22668 " mount device mountpoint\n"
22673 #: ../fish/guestfish-actions.pod:2918
22675 "B<Important note:> When you use this call, the filesystem options C<sync> "
22676 "and C<noatime> are set implicitly. This was originally done because we "
22677 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22678 "very large negative performance impact and negligible effect on "
22679 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22680 "code that needs performance, and instead use L</mount-options> (use an empty "
22681 "string for the first parameter if you don't want any options)."
22685 #: ../fish/guestfish-actions.pod:2928
22690 #: ../fish/guestfish-actions.pod:2930
22693 " mount-loop file mountpoint\n"
22698 #: ../fish/guestfish-actions.pod:2936
22699 msgid "mount-options"
22703 #: ../fish/guestfish-actions.pod:2938
22706 " mount-options options device mountpoint\n"
22711 #: ../fish/guestfish-actions.pod:2940
22713 "This is the same as the L</mount> command, but it allows you to set the "
22714 "mount options as for the L<mount(8)> I<-o> flag."
22718 #: ../fish/guestfish-actions.pod:2948
22723 #: ../fish/guestfish-actions.pod:2950
22726 " mount-ro device mountpoint\n"
22731 #: ../fish/guestfish-actions.pod:2952
22733 "This is the same as the L</mount> command, but it mounts the filesystem with "
22734 "the read-only (I<-o ro>) flag."
22738 #: ../fish/guestfish-actions.pod:2955
22743 #: ../fish/guestfish-actions.pod:2957
22746 " mount-vfs options vfstype device mountpoint\n"
22751 #: ../fish/guestfish-actions.pod:2959
22753 "This is the same as the L</mount> command, but it allows you to set both the "
22754 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22758 #: ../fish/guestfish-actions.pod:2963
22759 msgid "mountpoints"
22763 #: ../fish/guestfish-actions.pod:2965
22771 #: ../fish/guestfish-actions.pod:2967
22773 "This call is similar to L</mounts>. That call returns a list of devices. "
22774 "This one returns a hash table (map) of device name to directory where the "
22775 "device is mounted."
22779 #: ../fish/guestfish-actions.pod:2971
22784 #: ../fish/guestfish-actions.pod:2973
22792 #: ../fish/guestfish-actions.pod:2980
22793 msgid "See also: L</mountpoints>"
22797 #: ../fish/guestfish-actions.pod:2982
22802 #: ../fish/guestfish-actions.pod:2984
22810 #: ../fish/guestfish-actions.pod:2989
22811 msgid "ntfs-3g-probe"
22815 #: ../fish/guestfish-actions.pod:2991
22818 " ntfs-3g-probe true|false device\n"
22823 #: ../fish/guestfish-actions.pod:3005
22828 #: ../fish/guestfish-actions.pod:3007
22831 " ntfsresize device\n"
22836 #: ../fish/guestfish-actions.pod:3013
22837 msgid "ntfsresize-size"
22841 #: ../fish/guestfish-actions.pod:3015
22844 " ntfsresize-size device size\n"
22849 #: ../fish/guestfish-actions.pod:3017
22851 "This command is the same as L</ntfsresize> except that it allows you to "
22852 "specify the new size (in bytes) explicitly."
22856 #: ../fish/guestfish-actions.pod:3020
22861 #: ../fish/guestfish-actions.pod:3022
22864 " part-add device prlogex startsect endsect\n"
22869 #: ../fish/guestfish-actions.pod:3024
22871 "This command adds a partition to C<device>. If there is no partition table "
22872 "on the device, call L</part-init> first."
22876 #: ../fish/guestfish-actions.pod:3036
22878 "Creating a partition which covers the whole disk is not so easy. Use L</"
22879 "part-disk> to do that."
22883 #: ../fish/guestfish-actions.pod:3039
22888 #: ../fish/guestfish-actions.pod:3041
22891 " part-del device partnum\n"
22896 #: ../fish/guestfish-actions.pod:3049
22901 #: ../fish/guestfish-actions.pod:3051
22904 " part-disk device parttype\n"
22909 #: ../fish/guestfish-actions.pod:3053
22911 "This command is simply a combination of L</part-init> followed by L</part-"
22912 "add> to create a single primary partition covering the whole disk."
22916 #: ../fish/guestfish-actions.pod:3057
22918 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22919 "possible values are described in L</part-init>."
22923 #: ../fish/guestfish-actions.pod:3063
22924 msgid "part-get-bootable"
22928 #: ../fish/guestfish-actions.pod:3065
22931 " part-get-bootable device partnum\n"
22936 #: ../fish/guestfish-actions.pod:3070
22937 msgid "See also L</part-set-bootable>."
22941 #: ../fish/guestfish-actions.pod:3072
22942 msgid "part-get-mbr-id"
22946 #: ../fish/guestfish-actions.pod:3074
22949 " part-get-mbr-id device partnum\n"
22954 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22956 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22957 "undefined results for other partition table types (see L</part-get-"
22962 #: ../fish/guestfish-actions.pod:3083
22963 msgid "part-get-parttype"
22967 #: ../fish/guestfish-actions.pod:3085
22970 " part-get-parttype device\n"
22975 #: ../fish/guestfish-actions.pod:3090
22977 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22978 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22979 "possible, although unusual. See L</part-init> for a full list."
22983 #: ../fish/guestfish-actions.pod:3095
22988 #: ../fish/guestfish-actions.pod:3097
22991 " part-init device parttype\n"
22996 #: ../fish/guestfish-actions.pod:3103
22998 "Initially there are no partitions. Following this, you should call L</part-"
22999 "add> for each partition required."
23003 #: ../fish/guestfish-actions.pod:3166
23008 #: ../fish/guestfish-actions.pod:3168
23011 " part-list device\n"
23016 #: ../fish/guestfish-actions.pod:3183
23018 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23019 "the device's sector size, see L</blockdev-getss>."
23023 #: ../fish/guestfish-actions.pod:3196
23024 msgid "part-set-bootable"
23028 #: ../fish/guestfish-actions.pod:3198
23031 " part-set-bootable device partnum true|false\n"
23036 #: ../fish/guestfish-actions.pod:3207
23037 msgid "part-set-mbr-id"
23041 #: ../fish/guestfish-actions.pod:3209
23044 " part-set-mbr-id device partnum idbyte\n"
23049 #: ../fish/guestfish-actions.pod:3221
23050 msgid "part-set-name"
23054 #: ../fish/guestfish-actions.pod:3223
23057 " part-set-name device partnum name\n"
23062 #: ../fish/guestfish-actions.pod:3231
23063 msgid "part-to-dev"
23067 #: ../fish/guestfish-actions.pod:3233
23070 " part-to-dev partition\n"
23075 #: ../fish/guestfish-actions.pod:3239
23077 "The named partition must exist, for example as a string returned from L</"
23078 "list-partitions>."
23082 #: ../fish/guestfish-actions.pod:3242
23083 msgid "ping-daemon"
23087 #: ../fish/guestfish-actions.pod:3244
23095 #: ../fish/guestfish-actions.pod:3251
23100 #: ../fish/guestfish-actions.pod:3253
23103 " pread path count offset\n"
23108 #: ../fish/guestfish-actions.pod:3261
23109 msgid "See also L</pwrite>, L</pread-device>."
23113 #: ../fish/guestfish-actions.pod:3266
23114 msgid "pread-device"
23118 #: ../fish/guestfish-actions.pod:3268
23121 " pread-device device count offset\n"
23126 #: ../fish/guestfish-actions.pod:3276
23127 msgid "See also L</pread>."
23131 #: ../fish/guestfish-actions.pod:3281
23136 #: ../fish/guestfish-actions.pod:3283
23139 " pvcreate device\n"
23144 #: ../fish/guestfish-actions.pod:3289
23149 #: ../fish/guestfish-actions.pod:3291
23152 " pvremove device\n"
23157 #: ../fish/guestfish-actions.pod:3300
23162 #: ../fish/guestfish-actions.pod:3302
23165 " pvresize device\n"
23170 #: ../fish/guestfish-actions.pod:3307
23171 msgid "pvresize-size"
23175 #: ../fish/guestfish-actions.pod:3309
23178 " pvresize-size device size\n"
23183 #: ../fish/guestfish-actions.pod:3311
23185 "This command is the same as L</pvresize> except that it allows you to "
23186 "specify the new size (in bytes) explicitly."
23190 #: ../fish/guestfish-actions.pod:3314
23195 #: ../fish/guestfish-actions.pod:3316
23203 #: ../fish/guestfish-actions.pod:3324
23204 msgid "See also L</pvs-full>."
23208 #: ../fish/guestfish-actions.pod:3326
23213 #: ../fish/guestfish-actions.pod:3328
23221 #: ../fish/guestfish-actions.pod:3333
23226 #: ../fish/guestfish-actions.pod:3335
23234 #: ../fish/guestfish-actions.pod:3339
23239 #: ../fish/guestfish-actions.pod:3341
23242 " pwrite path content offset\n"
23247 #: ../fish/guestfish-actions.pod:3352
23248 msgid "See also L</pread>, L</pwrite-device>."
23252 #: ../fish/guestfish-actions.pod:3357
23253 msgid "pwrite-device"
23257 #: ../fish/guestfish-actions.pod:3359
23260 " pwrite-device device content offset\n"
23265 #: ../fish/guestfish-actions.pod:3369
23266 msgid "See also L</pwrite>."
23270 #: ../fish/guestfish-actions.pod:3374
23275 #: ../fish/guestfish-actions.pod:3376
23278 " read-file path\n"
23283 #: ../fish/guestfish-actions.pod:3381
23285 "Unlike L</cat>, this function can correctly handle files that contain "
23286 "embedded ASCII NUL characters. However unlike L</download>, this function "
23287 "is limited in the total size of file that can be handled."
23291 #: ../fish/guestfish-actions.pod:3389
23296 #: ../fish/guestfish-actions.pod:3391
23299 " read-lines path\n"
23304 #: ../fish/guestfish-actions.pod:3398
23306 "Note that this function cannot correctly handle binary files (specifically, "
23307 "files containing C<\\0> character which is treated as end of line). For "
23308 "those you need to use the L</read-file> function which has a more complex "
23313 #: ../fish/guestfish-actions.pod:3403
23318 #: ../fish/guestfish-actions.pod:3405
23326 #: ../fish/guestfish-actions.pod:3457
23328 "This function is primarily intended for use by programs. To get a simple "
23329 "list of names, use L</ls>. To get a printable directory for human "
23330 "consumption, use L</ll>."
23334 #: ../fish/guestfish-actions.pod:3461
23339 #: ../fish/guestfish-actions.pod:3463
23347 #: ../fish/guestfish-actions.pod:3467
23348 msgid "readlinklist"
23352 #: ../fish/guestfish-actions.pod:3469
23355 " readlinklist path 'names ...'\n"
23360 #: ../fish/guestfish-actions.pod:3493
23365 #: ../fish/guestfish-actions.pod:3495
23373 #: ../fish/guestfish-actions.pod:3500
23374 msgid "removexattr"
23378 #: ../fish/guestfish-actions.pod:3502
23381 " removexattr xattr path\n"
23386 #: ../fish/guestfish-actions.pod:3507
23387 msgid "See also: L</lremovexattr>, L<attr(5)>."
23391 #: ../fish/guestfish-actions.pod:3509
23396 #: ../fish/guestfish-actions.pod:3511
23399 " resize2fs device\n"
23404 #: ../fish/guestfish-actions.pod:3516
23406 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23407 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23408 "gives an error about this and sometimes not. In any case, it is always safe "
23409 "to call L</e2fsck-f> before calling this function."
23413 #: ../fish/guestfish-actions.pod:3522
23414 msgid "resize2fs-size"
23418 #: ../fish/guestfish-actions.pod:3524
23421 " resize2fs-size device size\n"
23426 #: ../fish/guestfish-actions.pod:3526
23428 "This command is the same as L</resize2fs> except that it allows you to "
23429 "specify the new size (in bytes) explicitly."
23433 #: ../fish/guestfish-actions.pod:3529
23438 #: ../fish/guestfish-actions.pod:3531
23446 #: ../fish/guestfish-actions.pod:3535
23451 #: ../fish/guestfish-actions.pod:3537
23459 #: ../fish/guestfish-actions.pod:3543
23464 #: ../fish/guestfish-actions.pod:3545
23472 #: ../fish/guestfish-actions.pod:3549
23473 msgid "rmmountpoint"
23477 #: ../fish/guestfish-actions.pod:3551
23480 " rmmountpoint exemptpath\n"
23485 #: ../fish/guestfish-actions.pod:3553
23487 "This calls removes a mountpoint that was previously created with L</"
23488 "mkmountpoint>. See L</mkmountpoint> for full details."
23492 #: ../fish/guestfish-actions.pod:3557
23493 msgid "scrub-device"
23497 #: ../fish/guestfish-actions.pod:3559
23500 " scrub-device device\n"
23505 #: ../fish/guestfish-actions.pod:3570
23510 #: ../fish/guestfish-actions.pod:3572
23513 " scrub-file file\n"
23518 #: ../fish/guestfish-actions.pod:3582
23519 msgid "scrub-freespace"
23523 #: ../fish/guestfish-actions.pod:3584
23526 " scrub-freespace dir\n"
23531 #: ../fish/guestfish-actions.pod:3586
23533 "This command creates the directory C<dir> and then fills it with files until "
23534 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23535 "deletes them. The intention is to scrub any free space on the partition "
23536 "containing C<dir>."
23540 #: ../fish/guestfish-actions.pod:3595
23545 #: ../fish/guestfish-actions.pod:3597
23550 #: ../fish/guestfish-actions.pod:3599
23553 " set-append append\n"
23558 #: ../fish/guestfish-actions.pod:3610
23559 msgid "set-autosync"
23563 #: ../fish/guestfish-actions.pod:3612
23568 #: ../fish/guestfish-actions.pod:3614
23571 " set-autosync true|false\n"
23576 #: ../fish/guestfish-actions.pod:3616
23578 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23579 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23580 "closed (also if the program exits without closing handles)."
23584 #: ../fish/guestfish-actions.pod:3624
23589 #: ../fish/guestfish-actions.pod:3626
23594 #: ../fish/guestfish-actions.pod:3628
23597 " set-direct true|false\n"
23602 #: ../fish/guestfish-actions.pod:3634
23604 "One consequence of this is that log messages aren't caught by the library "
23605 "and handled by L</set-log-message-callback>, but go straight to stdout."
23609 #: ../fish/guestfish-actions.pod:3643
23610 msgid "set-e2label"
23614 #: ../fish/guestfish-actions.pod:3645
23617 " set-e2label device label\n"
23622 #: ../fish/guestfish-actions.pod:3651
23624 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23625 "label on a filesystem."
23629 #: ../fish/guestfish-actions.pod:3654
23634 #: ../fish/guestfish-actions.pod:3656
23637 " set-e2uuid device uuid\n"
23642 #: ../fish/guestfish-actions.pod:3663
23644 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23645 "UUID of a filesystem."
23649 #: ../fish/guestfish-actions.pod:3666
23650 msgid "set-memsize"
23654 #: ../fish/guestfish-actions.pod:3668
23659 #: ../fish/guestfish-actions.pod:3670
23662 " set-memsize memsize\n"
23667 #: ../fish/guestfish-actions.pod:3672
23669 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23670 "This only has any effect if called before L</launch>."
23674 #: ../fish/guestfish-actions.pod:3683
23675 msgid "set-network"
23679 #: ../fish/guestfish-actions.pod:3685
23684 #: ../fish/guestfish-actions.pod:3687
23687 " set-network true|false\n"
23692 #: ../fish/guestfish-actions.pod:3695
23694 "You must call this before calling L</launch>, otherwise it has no effect."
23698 #: ../fish/guestfish-actions.pod:3698
23703 #: ../fish/guestfish-actions.pod:3700
23708 #: ../fish/guestfish-actions.pod:3702
23711 " set-path searchpath\n"
23716 #: ../fish/guestfish-actions.pod:3711
23721 #: ../fish/guestfish-actions.pod:3713
23726 #: ../fish/guestfish-actions.pod:3715
23734 #: ../fish/guestfish-actions.pod:3735
23735 msgid "set-recovery-proc"
23739 #: ../fish/guestfish-actions.pod:3737
23740 msgid "recovery-proc"
23744 #: ../fish/guestfish-actions.pod:3739
23747 " set-recovery-proc true|false\n"
23752 #: ../fish/guestfish-actions.pod:3741
23754 "If this is called with the parameter C<false> then L</launch> does not "
23755 "create a recovery process. The purpose of the recovery process is to stop "
23756 "runaway qemu processes in the case where the main program aborts abruptly."
23760 #: ../fish/guestfish-actions.pod:3746
23762 "This only has any effect if called before L</launch>, and the default is "
23767 #: ../fish/guestfish-actions.pod:3755
23768 msgid "set-selinux"
23772 #: ../fish/guestfish-actions.pod:3757
23777 #: ../fish/guestfish-actions.pod:3759
23780 " set-selinux true|false\n"
23785 #: ../fish/guestfish-actions.pod:3770
23790 #: ../fish/guestfish-actions.pod:3772
23795 #: ../fish/guestfish-actions.pod:3774
23798 " set-trace true|false\n"
23803 #: ../fish/guestfish-actions.pod:3790
23804 msgid "set-verbose"
23808 #: ../fish/guestfish-actions.pod:3792
23813 #: ../fish/guestfish-actions.pod:3794
23816 " set-verbose true|false\n"
23821 #: ../fish/guestfish-actions.pod:3801
23826 #: ../fish/guestfish-actions.pod:3803
23829 " setcon context\n"
23834 #: ../fish/guestfish-actions.pod:3810
23839 #: ../fish/guestfish-actions.pod:3812
23842 " setxattr xattr val vallen path\n"
23847 #: ../fish/guestfish-actions.pod:3818
23848 msgid "See also: L</lsetxattr>, L<attr(5)>."
23852 #: ../fish/guestfish-actions.pod:3820
23857 #: ../fish/guestfish-actions.pod:3822
23860 " sfdisk device cyls heads sectors 'lines ...'\n"
23865 #: ../fish/guestfish-actions.pod:3844
23866 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23870 #: ../fish/guestfish-actions.pod:3850
23875 #: ../fish/guestfish-actions.pod:3852
23878 " sfdiskM device 'lines ...'\n"
23883 #: ../fish/guestfish-actions.pod:3854
23885 "This is a simplified interface to the L</sfdisk> command, where partition "
23886 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23887 "you don't need to specify the cyls, heads and sectors parameters which were "
23888 "rarely if ever used anyway."
23892 #: ../fish/guestfish-actions.pod:3860
23893 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23897 #: ../fish/guestfish-actions.pod:3866
23902 #: ../fish/guestfish-actions.pod:3868
23905 " sfdisk-N device partnum cyls heads sectors line\n"
23910 #: ../fish/guestfish-actions.pod:3873
23912 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23913 "cyls/heads/sectors parameters."
23917 #: ../fish/guestfish-actions.pod:3876
23918 msgid "See also: L</part-add>"
23922 #: ../fish/guestfish-actions.pod:3881
23923 msgid "sfdisk-disk-geometry"
23927 #: ../fish/guestfish-actions.pod:3883
23930 " sfdisk-disk-geometry device\n"
23935 #: ../fish/guestfish-actions.pod:3885
23937 "This displays the disk geometry of C<device> read from the partition table. "
23938 "Especially in the case where the underlying block device has been resized, "
23939 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23940 "kernel-geometry>)."
23944 #: ../fish/guestfish-actions.pod:3893
23945 msgid "sfdisk-kernel-geometry"
23949 #: ../fish/guestfish-actions.pod:3895
23952 " sfdisk-kernel-geometry device\n"
23957 #: ../fish/guestfish-actions.pod:3902
23962 #: ../fish/guestfish-actions.pod:3904
23965 " sfdisk-l device\n"
23970 #: ../fish/guestfish-actions.pod:3910
23971 msgid "See also: L</part-list>"
23975 #: ../fish/guestfish-actions.pod:3912
23980 #: ../fish/guestfish-actions.pod:3914
23988 #: ../fish/guestfish-actions.pod:3919
23989 msgid "This is like L</command>, but passes the command to:"
23993 #: ../fish/guestfish-actions.pod:3927
23994 msgid "All the provisos about L</command> apply to this call."
23998 #: ../fish/guestfish-actions.pod:3929
24003 #: ../fish/guestfish-actions.pod:3931
24006 " sh-lines command\n"
24011 #: ../fish/guestfish-actions.pod:3933
24012 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24016 #: ../fish/guestfish-actions.pod:3936
24017 msgid "See also: L</command-lines>"
24021 #: ../fish/guestfish-actions.pod:3938
24026 #: ../fish/guestfish-actions.pod:3940
24034 #: ../fish/guestfish-actions.pod:3944
24039 #: ../fish/guestfish-actions.pod:3946
24047 #: ../fish/guestfish-actions.pod:3952
24052 #: ../fish/guestfish-actions.pod:3954
24060 #: ../fish/guestfish-actions.pod:3962
24065 #: ../fish/guestfish-actions.pod:3964
24073 #: ../fish/guestfish-actions.pod:3972
24078 #: ../fish/guestfish-actions.pod:3974
24081 " strings-e encoding path\n"
24086 #: ../fish/guestfish-actions.pod:3976
24088 "This is like the L</strings> command, but allows you to specify the encoding "
24089 "of strings that are looked for in the source file C<path>."
24093 #: ../fish/guestfish-actions.pod:3986
24095 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24096 "ISO-8859-X (this is what L</strings> uses)."
24100 #: ../fish/guestfish-actions.pod:4018
24101 msgid "swapoff-device"
24105 #: ../fish/guestfish-actions.pod:4020
24108 " swapoff-device device\n"
24113 #: ../fish/guestfish-actions.pod:4022
24115 "This command disables the libguestfs appliance swap device or partition "
24116 "named C<device>. See L</swapon-device>."
24120 #: ../fish/guestfish-actions.pod:4026
24121 msgid "swapoff-file"
24125 #: ../fish/guestfish-actions.pod:4028
24128 " swapoff-file file\n"
24133 #: ../fish/guestfish-actions.pod:4032
24134 msgid "swapoff-label"
24138 #: ../fish/guestfish-actions.pod:4034
24141 " swapoff-label label\n"
24146 #: ../fish/guestfish-actions.pod:4039
24147 msgid "swapoff-uuid"
24151 #: ../fish/guestfish-actions.pod:4041
24154 " swapoff-uuid uuid\n"
24159 #: ../fish/guestfish-actions.pod:4046
24160 msgid "swapon-device"
24164 #: ../fish/guestfish-actions.pod:4048
24167 " swapon-device device\n"
24172 #: ../fish/guestfish-actions.pod:4050
24174 "This command enables the libguestfs appliance to use the swap device or "
24175 "partition named C<device>. The increased memory is made available for all "
24176 "commands, for example those run using L</command> or L</sh>."
24180 #: ../fish/guestfish-actions.pod:4062
24181 msgid "swapon-file"
24185 #: ../fish/guestfish-actions.pod:4064
24188 " swapon-file file\n"
24193 #: ../fish/guestfish-actions.pod:4066
24195 "This command enables swap to a file. See L</swapon-device> for other notes."
24199 #: ../fish/guestfish-actions.pod:4069
24200 msgid "swapon-label"
24204 #: ../fish/guestfish-actions.pod:4071
24207 " swapon-label label\n"
24212 #: ../fish/guestfish-actions.pod:4073
24214 "This command enables swap to a labeled swap partition. See L</swapon-"
24215 "device> for other notes."
24219 #: ../fish/guestfish-actions.pod:4076
24220 msgid "swapon-uuid"
24224 #: ../fish/guestfish-actions.pod:4078
24227 " swapon-uuid uuid\n"
24232 #: ../fish/guestfish-actions.pod:4080
24234 "This command enables swap to a swap partition with the given UUID. See L</"
24235 "swapon-device> for other notes."
24239 #: ../fish/guestfish-actions.pod:4083
24244 #: ../fish/guestfish-actions.pod:4085
24252 #: ../fish/guestfish-actions.pod:4093
24257 #: ../fish/guestfish-actions.pod:4095
24265 #: ../fish/guestfish-actions.pod:4103
24270 #: ../fish/guestfish-actions.pod:4105
24273 " tail-n nrlines path\n"
24278 #: ../fish/guestfish-actions.pod:4118
24283 #: ../fish/guestfish-actions.pod:4120
24286 " tar-in (tarfile|-) directory\n"
24291 #: ../fish/guestfish-actions.pod:4125
24292 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24296 #: ../fish/guestfish-actions.pod:4130
24301 #: ../fish/guestfish-actions.pod:4132
24304 " tar-out directory (tarfile|-)\n"
24309 #: ../fish/guestfish-actions.pod:4137
24310 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24314 #: ../fish/guestfish-actions.pod:4142
24319 #: ../fish/guestfish-actions.pod:4144
24322 " tgz-in (tarball|-) directory\n"
24327 #: ../fish/guestfish-actions.pod:4149
24328 msgid "To upload an uncompressed tarball, use L</tar-in>."
24332 #: ../fish/guestfish-actions.pod:4153
24337 #: ../fish/guestfish-actions.pod:4155
24340 " tgz-out directory (tarball|-)\n"
24345 #: ../fish/guestfish-actions.pod:4160
24346 msgid "To download an uncompressed tarball, use L</tar-out>."
24350 #: ../fish/guestfish-actions.pod:4164
24355 #: ../fish/guestfish-actions.pod:4166
24363 #: ../fish/guestfish-actions.pod:4175
24368 #: ../fish/guestfish-actions.pod:4177
24376 #: ../fish/guestfish-actions.pod:4182
24377 msgid "truncate-size"
24381 #: ../fish/guestfish-actions.pod:4184
24384 " truncate-size path size\n"
24389 #: ../fish/guestfish-actions.pod:4189
24391 "If the current file size is less than C<size> then the file is extended to "
24392 "the required size with zero bytes. This creates a sparse file (ie. disk "
24393 "blocks are not allocated for the file until you write to it). To create a "
24394 "non-sparse file of zeroes, use L</fallocate64> instead."
24398 #: ../fish/guestfish-actions.pod:4195
24403 #: ../fish/guestfish-actions.pod:4197
24406 " tune2fs-l device\n"
24411 #: ../fish/guestfish-actions.pod:4207
24416 #: ../fish/guestfish-actions.pod:4209
24419 " txz-in (tarball|-) directory\n"
24424 #: ../fish/guestfish-actions.pod:4216
24429 #: ../fish/guestfish-actions.pod:4218
24432 " txz-out directory (tarball|-)\n"
24437 #: ../fish/guestfish-actions.pod:4225
24442 #: ../fish/guestfish-actions.pod:4227
24450 #: ../fish/guestfish-actions.pod:4241
24451 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24455 #: ../fish/guestfish-actions.pod:4246
24460 #: ../fish/guestfish-actions.pod:4248
24465 #: ../fish/guestfish-actions.pod:4250
24468 " umount pathordevice\n"
24473 #: ../fish/guestfish-actions.pod:4256
24478 #: ../fish/guestfish-actions.pod:4258
24479 msgid "unmount-all"
24483 #: ../fish/guestfish-actions.pod:4260
24491 #: ../fish/guestfish-actions.pod:4266
24496 #: ../fish/guestfish-actions.pod:4268
24499 " upload (filename|-) remotefilename\n"
24504 #: ../fish/guestfish-actions.pod:4275
24505 msgid "See also L</download>."
24509 #: ../fish/guestfish-actions.pod:4279
24510 msgid "upload-offset"
24514 #: ../fish/guestfish-actions.pod:4281
24517 " upload-offset (filename|-) remotefilename offset\n"
24522 #: ../fish/guestfish-actions.pod:4293
24524 "Note that there is no limit on the amount of data that can be uploaded with "
24525 "this call, unlike with L</pwrite>, and this call always writes the full "
24526 "amount unless an error occurs."
24530 #: ../fish/guestfish-actions.pod:4298
24531 msgid "See also L</upload>, L</pwrite>."
24535 #: ../fish/guestfish-actions.pod:4302
24540 #: ../fish/guestfish-actions.pod:4304
24543 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24548 #: ../fish/guestfish-actions.pod:4323
24553 #: ../fish/guestfish-actions.pod:4325
24561 #: ../fish/guestfish-actions.pod:4352
24563 "I<Note:> Don't use this call to test for availability of features. In "
24564 "enterprise distributions we backport features from later versions into "
24565 "earlier versions, making this an unreliable way to test for features. Use "
24566 "L</available> instead."
24570 #: ../fish/guestfish-actions.pod:4358
24575 #: ../fish/guestfish-actions.pod:4360
24578 " vfs-label device\n"
24583 #: ../fish/guestfish-actions.pod:4367
24584 msgid "To find a filesystem from the label, use L</findfs-label>."
24588 #: ../fish/guestfish-actions.pod:4369
24593 #: ../fish/guestfish-actions.pod:4371
24596 " vfs-type device\n"
24601 #: ../fish/guestfish-actions.pod:4381
24606 #: ../fish/guestfish-actions.pod:4383
24609 " vfs-uuid device\n"
24614 #: ../fish/guestfish-actions.pod:4390
24615 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24619 #: ../fish/guestfish-actions.pod:4392
24620 msgid "vg-activate"
24624 #: ../fish/guestfish-actions.pod:4394
24627 " vg-activate true|false 'volgroups ...'\n"
24632 #: ../fish/guestfish-actions.pod:4407
24633 msgid "vg-activate-all"
24637 #: ../fish/guestfish-actions.pod:4409
24640 " vg-activate-all true|false\n"
24645 #: ../fish/guestfish-actions.pod:4419
24650 #: ../fish/guestfish-actions.pod:4421
24653 " vgcreate volgroup 'physvols ...'\n"
24658 #: ../fish/guestfish-actions.pod:4426
24663 #: ../fish/guestfish-actions.pod:4428
24666 " vglvuuids vgname\n"
24671 #: ../fish/guestfish-actions.pod:4433
24673 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24674 "logical volumes and volume groups."
24678 #: ../fish/guestfish-actions.pod:4436
24679 msgid "See also L</vgpvuuids>."
24683 #: ../fish/guestfish-actions.pod:4438
24688 #: ../fish/guestfish-actions.pod:4440
24691 " vgpvuuids vgname\n"
24696 #: ../fish/guestfish-actions.pod:4445
24698 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24699 "physical volumes and volume groups."
24703 #: ../fish/guestfish-actions.pod:4448
24704 msgid "See also L</vglvuuids>."
24708 #: ../fish/guestfish-actions.pod:4450
24713 #: ../fish/guestfish-actions.pod:4452
24716 " vgremove vgname\n"
24721 #: ../fish/guestfish-actions.pod:4459
24726 #: ../fish/guestfish-actions.pod:4461
24729 " vgrename volgroup newvolgroup\n"
24734 #: ../fish/guestfish-actions.pod:4465
24739 #: ../fish/guestfish-actions.pod:4467
24747 #: ../fish/guestfish-actions.pod:4475
24748 msgid "See also L</vgs-full>."
24752 #: ../fish/guestfish-actions.pod:4477
24757 #: ../fish/guestfish-actions.pod:4479
24765 #: ../fish/guestfish-actions.pod:4484
24770 #: ../fish/guestfish-actions.pod:4486
24778 #: ../fish/guestfish-actions.pod:4491
24783 #: ../fish/guestfish-actions.pod:4493
24791 #: ../fish/guestfish-actions.pod:4497
24796 #: ../fish/guestfish-actions.pod:4499
24804 #: ../fish/guestfish-actions.pod:4504
24809 #: ../fish/guestfish-actions.pod:4506
24817 #: ../fish/guestfish-actions.pod:4511
24822 #: ../fish/guestfish-actions.pod:4513
24830 #: ../fish/guestfish-actions.pod:4518
24835 #: ../fish/guestfish-actions.pod:4520
24838 " write path content\n"
24843 #: ../fish/guestfish-actions.pod:4528
24848 #: ../fish/guestfish-actions.pod:4530
24851 " write-file path content size\n"
24856 #: ../fish/guestfish-actions.pod:4553
24861 #: ../fish/guestfish-actions.pod:4555
24864 " zegrep regex path\n"
24869 #: ../fish/guestfish-actions.pod:4563
24874 #: ../fish/guestfish-actions.pod:4565
24877 " zegrepi regex path\n"
24882 #: ../fish/guestfish-actions.pod:4573
24887 #: ../fish/guestfish-actions.pod:4575
24895 #: ../fish/guestfish-actions.pod:4583
24896 msgid "See also: L</zero-device>, L</scrub-device>."
24900 #: ../fish/guestfish-actions.pod:4585
24901 msgid "zero-device"
24905 #: ../fish/guestfish-actions.pod:4587
24908 " zero-device device\n"
24913 #: ../fish/guestfish-actions.pod:4589
24915 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24916 "which just zeroes the first few blocks of a device."
24920 #: ../fish/guestfish-actions.pod:4596
24925 #: ../fish/guestfish-actions.pod:4598
24928 " zerofree device\n"
24933 #: ../fish/guestfish-actions.pod:4611
24938 #: ../fish/guestfish-actions.pod:4613
24941 " zfgrep pattern path\n"
24946 #: ../fish/guestfish-actions.pod:4621
24951 #: ../fish/guestfish-actions.pod:4623
24954 " zfgrepi pattern path\n"
24959 #: ../fish/guestfish-actions.pod:4631
24964 #: ../fish/guestfish-actions.pod:4633
24967 " zfile meth path\n"
24972 #: ../fish/guestfish-actions.pod:4640
24974 "Since 1.0.63, use L</file> instead which can now process compressed files."
24978 #: ../fish/guestfish-actions.pod:4650
24983 #: ../fish/guestfish-actions.pod:4652
24986 " zgrep regex path\n"
24991 #: ../fish/guestfish-actions.pod:4660
24996 #: ../fish/guestfish-actions.pod:4662
24999 " zgrepi regex path\n"
25004 #: ../fish/guestfish-commands.pod:1
25009 #: ../fish/guestfish-commands.pod:3
25014 #: ../fish/guestfish-commands.pod:5
25017 " alloc filename size\n"
25022 #: ../fish/guestfish-commands.pod:7
25024 "This creates an empty (zeroed) file of the given size, and then adds so it "
25025 "can be further examined."
25029 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25030 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25034 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25035 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25039 #: ../fish/guestfish-commands.pod:14
25041 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25042 "image, see L</PREPARED DISK IMAGES>."
25046 #: ../fish/guestfish-commands.pod:17
25051 #: ../fish/guestfish-commands.pod:19
25054 " copy-in local [local ...] /remotedir\n"
25059 #: ../fish/guestfish-commands.pod:21
25061 "C<copy-in> copies local files or directories recursively into the disk "
25062 "image, placing them in the directory called C</remotedir> (which must "
25063 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25064 "other commands as necessary."
25068 #: ../fish/guestfish-commands.pod:26
25070 "Multiple local files and directories can be specified, but the last "
25071 "parameter must always be a remote directory. Wildcards cannot be used."
25075 #: ../fish/guestfish-commands.pod:30
25080 #: ../fish/guestfish-commands.pod:32
25083 " copy-out remote [remote ...] localdir\n"
25088 #: ../fish/guestfish-commands.pod:34
25090 "C<copy-out> copies remote files or directories recursively out of the disk "
25091 "image, placing them on the host disk in a local directory called C<localdir> "
25092 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25093 "download>, L</tar-out> and other commands as necessary."
25097 #: ../fish/guestfish-commands.pod:40
25099 "Multiple remote files and directories can be specified, but the last "
25100 "parameter must always be a local directory. To download to the current "
25101 "directory, use C<.> as in:"
25105 #: ../fish/guestfish-commands.pod:44
25108 " copy-out /home .\n"
25113 #: ../fish/guestfish-commands.pod:46
25115 "Wildcards cannot be used in the ordinary command, but you can use them with "
25116 "the help of L</glob> like this:"
25120 #: ../fish/guestfish-commands.pod:49
25123 " glob copy-out /home/* .\n"
25128 #: ../fish/guestfish-commands.pod:51
25133 #: ../fish/guestfish-commands.pod:53
25136 " echo [params ...]\n"
25141 #: ../fish/guestfish-commands.pod:55
25142 msgid "This echos the parameters to the terminal."
25146 #: ../fish/guestfish-commands.pod:57
25151 #: ../fish/guestfish-commands.pod:59
25156 #: ../fish/guestfish-commands.pod:61
25161 #: ../fish/guestfish-commands.pod:63
25169 #: ../fish/guestfish-commands.pod:65
25171 "This is used to edit a file. It downloads the file, edits it locally using "
25172 "your editor, then uploads the result."
25176 #: ../fish/guestfish-commands.pod:68
25178 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25179 "or C<emacs> you will get those corresponding editors."
25183 #: ../fish/guestfish-commands.pod:72
25188 #: ../fish/guestfish-commands.pod:74
25191 " glob command args...\n"
25196 #: ../fish/guestfish-commands.pod:76
25198 "Expand wildcards in any paths in the args list, and run C<command> "
25199 "repeatedly on each matching path."
25203 #: ../fish/guestfish-commands.pod:79
25204 msgid "See L</WILDCARDS AND GLOBBING>."
25208 #: ../fish/guestfish-commands.pod:81
25213 #: ../fish/guestfish-commands.pod:83
25216 " hexedit <filename|device>\n"
25217 " hexedit <filename|device> <max>\n"
25218 " hexedit <filename|device> <start> <max>\n"
25223 #: ../fish/guestfish-commands.pod:87
25225 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25230 #: ../fish/guestfish-commands.pod:90
25232 "This command works by downloading potentially the whole file or device, "
25233 "editing it locally, then uploading it. If the file or device is large, you "
25234 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25235 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25236 "usual modifiers allowed such as C<1M> (1 megabyte)."
25240 #: ../fish/guestfish-commands.pod:97
25241 msgid "For example to edit the first few sectors of a disk you might do:"
25245 #: ../fish/guestfish-commands.pod:100
25248 " hexedit /dev/sda 1M\n"
25253 #: ../fish/guestfish-commands.pod:102
25255 "which would allow you to edit anywhere within the first megabyte of the disk."
25259 #: ../fish/guestfish-commands.pod:105
25260 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25264 #: ../fish/guestfish-commands.pod:107
25267 " hexedit /dev/sda1 0x400 0x400\n"
25272 #: ../fish/guestfish-commands.pod:109
25273 msgid "(assuming the superblock is in the standard location)."
25277 #: ../fish/guestfish-commands.pod:111
25279 "This command requires the external L<hexedit(1)> program. You can specify "
25280 "another program to use by setting the C<HEXEDITOR> environment variable."
25284 #: ../fish/guestfish-commands.pod:115
25285 msgid "See also L</hexdump>."
25289 #: ../fish/guestfish-commands.pod:117
25294 #: ../fish/guestfish-commands.pod:119
25302 #: ../fish/guestfish-commands.pod:121
25304 "Change the local directory, ie. the current directory of guestfish itself."
25308 #: ../fish/guestfish-commands.pod:124
25309 msgid "Note that C<!cd> won't do what you might expect."
25313 #: ../fish/guestfish-commands.pod:126
25318 #: ../fish/guestfish-commands.pod:128
25323 #: ../fish/guestfish-commands.pod:130
25331 #: ../fish/guestfish-commands.pod:132
25332 msgid "Opens the manual page for guestfish."
25336 #: ../fish/guestfish-commands.pod:134
25341 #: ../fish/guestfish-commands.pod:136
25346 #: ../fish/guestfish-commands.pod:138
25354 #: ../fish/guestfish-commands.pod:140
25362 #: ../fish/guestfish-commands.pod:142
25363 msgid "This is used to view a file."
25367 #: ../fish/guestfish-commands.pod:144
25369 "The default viewer is C<$PAGER>. However if you use the alternate command "
25370 "C<less> you will get the C<less> command specifically."
25374 #: ../fish/guestfish-commands.pod:147
25379 #: ../fish/guestfish-commands.pod:149
25387 #: ../fish/guestfish-commands.pod:151
25389 "Close and reopen the libguestfs handle. It is not necessary to use this "
25390 "normally, because the handle is closed properly when guestfish exits. "
25391 "However this is occasionally useful for testing."
25395 #: ../fish/guestfish-commands.pod:155
25400 #: ../fish/guestfish-commands.pod:157
25403 " sparse filename size\n"
25408 #: ../fish/guestfish-commands.pod:159
25410 "This creates an empty sparse file of the given size, and then adds so it can "
25411 "be further examined."
25415 #: ../fish/guestfish-commands.pod:162
25417 "In all respects it works the same as the L</alloc> command, except that the "
25418 "image file is allocated sparsely, which means that disk blocks are not "
25419 "assigned to the file until they are needed. Sparse disk files only use "
25420 "space when written to, but they are slower and there is a danger you could "
25421 "run out of real disk space during a write operation."
25425 #: ../fish/guestfish-commands.pod:172
25430 #: ../fish/guestfish-commands.pod:174
25438 #: ../fish/guestfish-commands.pod:176
25440 "This command returns a list of the optional groups known to the daemon, and "
25441 "indicates which ones are supported by this build of the libguestfs appliance."
25445 #: ../fish/guestfish-commands.pod:180
25446 msgid "See also L<guestfs(3)/AVAILABILITY>."
25450 #: ../fish/guestfish-commands.pod:182
25455 #: ../fish/guestfish-commands.pod:184
25458 " time command args...\n"
25463 #: ../fish/guestfish-commands.pod:186
25465 "Run the command as usual, but print the elapsed time afterwards. This can "
25466 "be useful for benchmarking operations."
25470 #: ../test-tool/libguestfs-test-tool.pod:5
25471 msgid "libguestfs-test-tool - End user tests for libguestfs"
25475 #: ../test-tool/libguestfs-test-tool.pod:9
25478 " libguestfs-test-tool [--options]\n"
25483 #: ../test-tool/libguestfs-test-tool.pod:13
25485 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25486 "and developers, to allow them to check basic libguestfs functionality is "
25487 "working. This is needed because libguestfs occasionally breaks for reasons "
25488 "beyond our control: usually because of changes in the underlying qemu or "
25489 "kernel packages, or the host environment."
25493 #: ../test-tool/libguestfs-test-tool.pod:20
25494 msgid "If you suspect a problem in libguestfs, then just run:"
25498 #: ../test-tool/libguestfs-test-tool.pod:22
25501 " libguestfs-test-tool\n"
25506 #: ../test-tool/libguestfs-test-tool.pod:24
25507 msgid "It will print lots of diagnostic messages."
25511 #: ../test-tool/libguestfs-test-tool.pod:26
25512 msgid "If it runs to completion successfully, you will see this near the end:"
25516 #: ../test-tool/libguestfs-test-tool.pod:28
25519 " ===== TEST FINISHED OK =====\n"
25524 #: ../test-tool/libguestfs-test-tool.pod:30
25525 msgid "and the test tool will exit with code 0."
25529 #: ../test-tool/libguestfs-test-tool.pod:32
25531 "If it fails (and/or exits with non-zero error code), please paste the "
25532 "B<complete, unedited> output of the test tool into a bug report. More "
25533 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25538 #: ../test-tool/libguestfs-test-tool.pod:41
25543 #: ../test-tool/libguestfs-test-tool.pod:43
25544 msgid "Display short usage information and exit."
25548 #: ../test-tool/libguestfs-test-tool.pod:45
25549 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25553 #: ../test-tool/libguestfs-test-tool.pod:47
25555 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25556 "normally look in the C<$libexec> directory that was configured when the tool "
25561 #: ../test-tool/libguestfs-test-tool.pod:51
25562 msgid "I<--qemu qemu_binary>"
25566 #: ../test-tool/libguestfs-test-tool.pod:53
25568 "If you have downloaded another qemu binary, point this option at the full "
25569 "path of the binary to try it."
25573 #: ../test-tool/libguestfs-test-tool.pod:56
25574 msgid "I<--qemudir qemu_source_dir>"
25578 #: ../test-tool/libguestfs-test-tool.pod:58
25580 "If you have compiled qemu from source, point this option at the source "
25581 "directory to try it."
25585 #: ../test-tool/libguestfs-test-tool.pod:61
25586 msgid "I<--timeout N>"
25590 #: ../test-tool/libguestfs-test-tool.pod:63
25592 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25593 "does not usually need to be adjusted unless your machine is very slow."
25597 #: ../test-tool/libguestfs-test-tool.pod:69
25598 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25602 #: ../test-tool/libguestfs-test-tool.pod:71
25604 "If you have compiled another version of qemu from source and would like to "
25605 "try that, then you can use the I<--qemudir> option to point to the qemu "
25606 "source directory."
25610 #: ../test-tool/libguestfs-test-tool.pod:75
25612 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25613 "option to point to the binary."
25617 #: ../test-tool/libguestfs-test-tool.pod:78
25619 "When using an alternate qemu with libguestfs, usually you would need to "
25620 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25621 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25622 "use either of the I<--qemudir> or I<--qemu> options."
25626 #: ../test-tool/libguestfs-test-tool.pod:85
25628 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25629 "I<1> if there was an error."
25633 #: ../test-tool/libguestfs-test-tool.pod:92
25634 msgid "/usr/libexec/libguestfs-test-tool-helper"
25638 #: ../test-tool/libguestfs-test-tool.pod:94
25640 "This helper program is run inside the appliance and provides additional "
25645 #: ../test-tool/libguestfs-test-tool.pod:97
25646 msgid "/usr/bin/mkisofs"
25650 #: ../test-tool/libguestfs-test-tool.pod:99
25652 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25653 "which is used as part of the tests."
25657 #: ../test-tool/libguestfs-test-tool.pod:106
25659 "For the full list of environment variables which may affect libguestfs, "
25660 "please see the L<guestfs(3)> manual page."
25664 #: ../test-tool/libguestfs-test-tool.pod:111
25665 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25669 #: ../test-tool/libguestfs-test-tool.pod:121
25670 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25674 #: ../fuse/guestmount.pod:5
25676 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25680 #: ../fuse/guestmount.pod:9
25683 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25688 #: ../fuse/guestmount.pod:11
25691 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25696 #: ../fuse/guestmount.pod:13
25699 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25704 #: ../fuse/guestmount.pod:17
25706 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25707 "machines. If you do this, you risk disk corruption in the VM."
25711 #: ../fuse/guestmount.pod:22
25713 "The guestmount program can be used to mount virtual machine filesystems and "
25714 "other disk images on the host. It uses libguestfs for access to the guest "
25715 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25716 "a mountable device."
25720 #: ../fuse/guestmount.pod:27
25722 "Along with other options, you have to give at least one device (I<-a> "
25723 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25724 "option) or use the I<-i> inspection option. How this works is better "
25725 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25730 #: ../fuse/guestmount.pod:33
25732 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25733 "by you, and the filesystem will not be visible to any other users unless you "
25734 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25735 "the filesystem, use the C<fusermount -u> command."
25739 #: ../fuse/guestmount.pod:41
25741 "For a typical Windows guest which has its main filesystem on the first "
25746 #: ../fuse/guestmount.pod:44
25749 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25754 #: ../fuse/guestmount.pod:46
25756 "For a typical Linux guest which has a /boot filesystem on the first "
25757 "partition, and the root filesystem on a logical volume:"
25761 #: ../fuse/guestmount.pod:49
25764 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25769 #: ../fuse/guestmount.pod:51
25770 msgid "To get libguestfs to detect guest mountpoints for you:"
25774 #: ../fuse/guestmount.pod:53
25777 " guestmount -a guest.img -i --ro /mnt\n"
25782 #: ../fuse/guestmount.pod:55
25783 msgid "For a libvirt guest called \"Guest\" you could do:"
25787 #: ../fuse/guestmount.pod:57
25790 " guestmount -d Guest -i --ro /mnt\n"
25795 #: ../fuse/guestmount.pod:59
25797 "If you don't know what filesystems are contained in a guest or disk image, "
25798 "use L<virt-filesystems(1)> first:"
25802 #: ../fuse/guestmount.pod:62
25805 " virt-filesystems MyGuest\n"
25810 #: ../fuse/guestmount.pod:64
25812 "If you want to trace the libguestfs calls but without excessive debugging "
25813 "information, we recommend:"
25817 #: ../fuse/guestmount.pod:67
25820 " guestmount [...] --trace /mnt\n"
25825 #: ../fuse/guestmount.pod:69
25826 msgid "If you want to debug the program, we recommend:"
25830 #: ../fuse/guestmount.pod:71
25833 " guestmount [...] --trace --verbose /mnt\n"
25838 #: ../fuse/guestmount.pod:79
25839 msgid "Add a block device or virtual machine image."
25843 #: ../fuse/guestmount.pod:96
25844 msgid "B<--dir-cache-timeout N>"
25848 #: ../fuse/guestmount.pod:98
25850 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25851 "seconds. The readdir cache [actually, there are several semi-independent "
25852 "caches] is populated after a readdir(2) call with the stat and extended "
25853 "attributes of the files in the directory, in anticipation that they will be "
25854 "requested soon after."
25858 #: ../fuse/guestmount.pod:104
25860 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25861 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25862 "requests, only cache existing ones."
25866 #: ../fuse/guestmount.pod:122
25868 "If you have untrusted raw-format guest disk images, you should use this "
25869 "option to specify the disk format. This avoids a possible security problem "
25870 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25871 "guestfs_add_drive_opts>."
25875 #: ../fuse/guestmount.pod:127
25876 msgid "B<--fuse-help>"
25880 #: ../fuse/guestmount.pod:129
25881 msgid "Display help on special FUSE options (see I<-o> below)."
25885 #: ../fuse/guestmount.pod:133
25886 msgid "Display brief help and exit."
25890 #: ../fuse/guestmount.pod:146
25891 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25895 #: ../fuse/guestmount.pod:148
25897 "Mount the named partition or logical volume on the given mountpoint B<in the "
25898 "guest> (this has nothing to do with mountpoints in the host)."
25902 #: ../fuse/guestmount.pod:151
25904 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25905 "something on C</>."
25909 #: ../fuse/guestmount.pod:156
25911 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25912 "unmounted. If you specify this option, then we don't attempt to sync the "
25913 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25917 #: ../fuse/guestmount.pod:161
25918 msgid "B<-o option> | B<--option option>"
25922 #: ../fuse/guestmount.pod:163
25923 msgid "Pass extra options to FUSE."
25927 #: ../fuse/guestmount.pod:165
25929 "To get a list of all the extra options supported by FUSE, use the command "
25930 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25931 "of them are a good idea."
25935 #: ../fuse/guestmount.pod:169
25938 " guestmount --fuse-help\n"
25943 #: ../fuse/guestmount.pod:171
25944 msgid "Some potentially useful FUSE options:"
25948 #: ../fuse/guestmount.pod:175
25949 msgid "B<-o allow_other>"
25953 #: ../fuse/guestmount.pod:177
25954 msgid "Allow other users to see the filesystem."
25958 #: ../fuse/guestmount.pod:179
25959 msgid "B<-o attr_timeout=N>"
25963 #: ../fuse/guestmount.pod:181
25964 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25968 #: ../fuse/guestmount.pod:183
25969 msgid "B<-o kernel_cache>"
25973 #: ../fuse/guestmount.pod:185
25975 "Allow the kernel to cache files (reduces the number of reads that have to go "
25976 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25977 "afford the extra memory usage."
25981 #: ../fuse/guestmount.pod:189
25982 msgid "B<-o uid=N> B<-o gid=N>"
25986 #: ../fuse/guestmount.pod:191
25988 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25989 "the chosen values."
25993 #: ../fuse/guestmount.pod:198
25995 "Add devices and mount everything read-only. Also disallow writes and make "
25996 "the disk appear read-only to FUSE."
26000 #: ../fuse/guestmount.pod:201
26002 "This is highly recommended if you are not going to edit the guest disk. If "
26003 "the guest is running and this option is I<not> supplied, then there is a "
26004 "strong risk of disk corruption in the guest. We try to prevent this from "
26005 "happening, but it is not always possible."
26009 #: ../fuse/guestmount.pod:206
26010 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26014 #: ../fuse/guestmount.pod:210
26015 msgid "Enable SELinux support for the guest."
26019 #: ../fuse/guestmount.pod:214
26020 msgid "Enable verbose messages from underlying libguestfs."
26024 #: ../fuse/guestmount.pod:218
26025 msgid "Display the program version and exit."
26029 #: ../fuse/guestmount.pod:222
26031 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26032 "FOR READ AND WRITE>."
26036 #: ../fuse/guestmount.pod:225
26037 msgid "B<-x> | B<--trace>"
26041 #: ../fuse/guestmount.pod:227
26042 msgid "Trace libguestfs calls."
26046 #: ../fuse/guestmount.pod:229
26047 msgid "This also stops the daemon from forking into the background."
26051 #: ../fuse/guestmount.pod:235
26053 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26054 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26059 #: ../tools/virt-edit.pl:34
26060 msgid "virt-edit - Edit a file in a virtual machine"
26064 #: ../tools/virt-edit.pl:38
26067 " virt-edit [--options] domname file\n"
26072 #: ../tools/virt-edit.pl:40
26075 " virt-edit [--options] disk.img [disk.img ...] file\n"
26080 #: ../tools/virt-edit.pl:42
26083 " virt-edit [domname|disk.img] file -e 'expr'\n"
26088 #: ../tools/virt-edit.pl:46
26090 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26091 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26092 "doing this, but doesn't catch all cases."
26096 #: ../tools/virt-edit.pl:52
26098 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26099 "the named virtual machine (or disk image)."
26103 #: ../tools/virt-edit.pl:55
26105 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26106 "you should look at the L<guestfish(1)> tool."
26110 #: ../tools/virt-edit.pl:60
26111 msgid "Edit the named files interactively:"
26115 #: ../tools/virt-edit.pl:62
26118 " virt-edit mydomain /boot/grub/grub.conf\n"
26123 #: ../tools/virt-edit.pl:64
26126 " virt-edit mydomain /etc/passwd\n"
26131 #: ../tools/virt-edit.pl:66
26133 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26134 "below). To change the init default level to 5:"
26138 #: ../tools/virt-edit.pl:70
26141 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26146 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181
26147 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
26148 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
26149 msgid "Display brief help."
26153 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187
26154 #: ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69
26155 #: ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169
26156 #: ../tools/virt-list-partitions.pl:70
26157 msgid "B<--version>"
26161 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189
26162 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
26163 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
26164 #: ../tools/virt-list-partitions.pl:72
26165 msgid "Display version number and exit."
26169 #: ../tools/virt-edit.pl:96
26170 msgid "B<--backup extension> | B<-b extension>"
26174 #: ../tools/virt-edit.pl:98
26176 "Create a backup of the original file I<in the guest disk image>. The backup "
26177 "has the original filename with C<extension> added."
26181 #: ../tools/virt-edit.pl:101
26183 "Usually the first character of C<extension> would be a dot C<.> so you would "
26188 #: ../tools/virt-edit.pl:104
26191 " virt-edit -b .orig [etc]\n"
26196 #: ../tools/virt-edit.pl:106
26197 msgid "By default, no backup file is made."
26201 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203
26202 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
26203 #: ../tools/virt-list-partitions.pl:78
26204 msgid "B<--connect URI> | B<-c URI>"
26208 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205
26209 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
26210 #: ../tools/virt-list-partitions.pl:80
26212 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26213 "to the default libvirt hypervisor."
26217 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26218 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
26219 #: ../tools/virt-list-partitions.pl:83
26221 "If you specify guest block devices directly, then libvirt is not used at all."
26225 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215
26226 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
26227 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
26228 msgid "B<--format> raw"
26232 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217
26233 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
26234 #: ../tools/virt-list-partitions.pl:92
26236 "Specify the format of disk images given on the command line. If this is "
26237 "omitted then the format is autodetected from the content of the disk image."
26241 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221
26242 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
26243 #: ../tools/virt-list-partitions.pl:96
26245 "If disk images are requested from libvirt, then this program asks libvirt "
26246 "for this information. In this case, the value of the format parameter is "
26251 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225
26252 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
26253 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
26254 #: ../tools/virt-list-partitions.pl:100
26256 "If working with untrusted raw-format guest disk images, you should ensure "
26257 "the format is always specified."
26261 #: ../tools/virt-edit.pl:141
26262 msgid "B<--expr EXPR> | B<-e EXPR>"
26266 #: ../tools/virt-edit.pl:143
26268 "Instead of launching the external editor, non-interactively apply the Perl "
26269 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26274 #: ../tools/virt-edit.pl:147
26276 "Be careful to properly quote the expression to prevent it from being altered "
26281 #: ../tools/virt-edit.pl:268
26282 msgid "NON-INTERACTIVE EDITING"
26286 #: ../tools/virt-edit.pl:270
26288 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26289 "administrator can interactively edit the file."
26293 #: ../tools/virt-edit.pl:273
26295 "There are two ways also to use C<virt-edit> from scripts in order to make "
26296 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26297 "like this, it's less error-prone to write scripts directly using the "
26298 "libguestfs API and Augeas for configuration file editing.)"
26302 #: ../tools/virt-edit.pl:279
26304 "The first method is to temporarily set C<$EDITOR> to any script or program "
26305 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26306 "update C<tmpfile> in place however it likes."
26310 #: ../tools/virt-edit.pl:283
26312 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26313 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26314 "instances of C<foo> with C<bar> in a file:"
26318 #: ../tools/virt-edit.pl:287
26321 " virt-edit domname filename -e 's/foo/bar/'\n"
26326 #: ../tools/virt-edit.pl:289
26328 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26329 "For example to delete root's password you could do:"
26333 #: ../tools/virt-edit.pl:292
26336 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26341 #: ../tools/virt-edit.pl:294
26343 "What really happens is that the snippet is evaluated as a Perl expression "
26344 "for each line of the file. The line, including the final C<\\n>, is passed "
26345 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26349 #: ../tools/virt-edit.pl:299
26351 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26352 "C<apache> user account from the password file you can do:"
26356 #: ../tools/virt-edit.pl:302
26359 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26364 #: ../tools/virt-edit.pl:304
26366 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26367 "the end of the file is rather difficult this way since there is no concept "
26368 "of \"last line of the file\" - your expression just doesn't get called "
26369 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26374 #: ../tools/virt-edit.pl:310
26376 "The variable C<$lineno> contains the current line number. As is "
26377 "traditional, the first line in the file is number C<1>."
26381 #: ../tools/virt-edit.pl:313
26383 "The return value from the expression is ignored, but the expression may call "
26384 "C<die> in order to abort the whole program, leaving the original file "
26389 #: ../tools/virt-edit.pl:317
26391 "Remember when matching the end of a line that C<$_> may contain the final C<"
26392 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26393 "newline then neither of these. Thus to match or substitute some text at the "
26394 "end of a line, use this regular expression:"
26398 #: ../tools/virt-edit.pl:322
26401 " /some text(\\r?\\n)?$/\n"
26406 #: ../tools/virt-edit.pl:324
26408 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26409 "$_> itself (since that would remove all newlines from the file):"
26413 #: ../tools/virt-edit.pl:328
26416 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26421 #: ../tools/virt-edit.pl:334
26426 #: ../tools/virt-edit.pl:336
26428 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26433 #: ../tools/virt-edit.pl:339
26434 msgid "If not set, C<vi> is used."
26438 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141
26439 #: ../tools/virt-win-reg.pl:477 ../tools/virt-resize.pl:1476
26440 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274
26441 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26442 msgid "SHELL QUOTING"
26446 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479
26447 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184
26448 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:529
26449 #: ../tools/virt-list-partitions.pl:252
26451 "Libvirt guest names can contain arbitrary characters, some of which have "
26452 "meaning to the shell such as C<#> and space. You may need to quote or "
26453 "escape these characters on the command line. See the shell manual page L<sh"
26454 "(1)> for details."
26458 #: ../tools/virt-edit.pl:352
26460 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26461 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26466 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26467 #: ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202
26468 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:559
26469 #: ../tools/virt-list-partitions.pl:269
26474 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512
26475 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204
26476 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:561
26477 #: ../tools/virt-list-partitions.pl:271
26478 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26482 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
26483 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26487 #: ../tools/virt-win-reg.pl:37
26489 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26493 #: ../tools/virt-win-reg.pl:41
26496 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26501 #: ../tools/virt-win-reg.pl:43
26504 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26509 #: ../tools/virt-win-reg.pl:45
26512 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26517 #: ../tools/virt-win-reg.pl:47
26520 " virt-win-reg --merge domname [input.reg ...]\n"
26525 #: ../tools/virt-win-reg.pl:49
26528 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26533 #: ../tools/virt-win-reg.pl:53
26535 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26536 "virtual machines. If you do this, you I<will> get irreversible disk "
26537 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26538 "but doesn't catch all cases."
26542 #: ../tools/virt-win-reg.pl:58
26544 "Modifying the Windows Registry is an inherently risky operation. The format "
26545 "is deliberately obscure and undocumented, and Registry changes can leave the "
26546 "system unbootable. Therefore when using the C<--merge> option, make sure "
26547 "you have a reliable backup first."
26551 #: ../tools/virt-win-reg.pl:65
26553 "This program can export and merge Windows Registry entries from a Windows "
26558 #: ../tools/virt-win-reg.pl:68
26560 "The first parameter is the libvirt guest name or the raw disk image of a "
26565 #: ../tools/virt-win-reg.pl:71
26567 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26568 "exported (recursively). For example:"
26572 #: ../tools/virt-win-reg.pl:74
26575 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26580 #: ../tools/virt-win-reg.pl:76
26582 "You can also display single values from within registry keys, for example:"
26586 #: ../tools/virt-win-reg.pl:79
26589 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26590 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26591 " Windows 7 Enterprise\n"
26596 #: ../tools/virt-win-reg.pl:83
26598 "With C<--merge>, you can merge a textual regedit file into the Windows "
26603 #: ../tools/virt-win-reg.pl:86
26606 " $ virt-win-reg --merge Windows7 changes.reg\n"
26611 #: ../tools/virt-win-reg.pl:88
26612 msgid "SUPPORTED SYSTEMS"
26616 #: ../tools/virt-win-reg.pl:90
26618 "The program currently supports Windows NT-derived guests starting with "
26619 "Windows XP through to at least Windows 7."
26623 #: ../tools/virt-win-reg.pl:93
26625 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26626 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26627 "and C<HKEY_USERS\\.DEFAULT>."
26631 #: ../tools/virt-win-reg.pl:97
26633 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26638 #: ../tools/virt-win-reg.pl:100
26640 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26645 #: ../tools/virt-win-reg.pl:103
26650 #: ../tools/virt-win-reg.pl:105
26652 "This program is only meant for simple access to the registry. If you want "
26653 "to do complicated things with the registry, we suggest you download the "
26654 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26655 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26656 "L<hivexregedit(1)>."
26660 #: ../tools/virt-win-reg.pl:111
26665 #: ../tools/virt-win-reg.pl:113
26667 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26668 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26669 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26670 "Windows-style line endings, you may need to reencode the whole file before "
26671 "or after processing."
26675 #: ../tools/virt-win-reg.pl:119
26677 "To reencode a file from Windows format to Linux (before processing it with "
26678 "the C<--merge> option), you would do something like this:"
26682 #: ../tools/virt-win-reg.pl:122
26685 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26690 #: ../tools/virt-win-reg.pl:124
26692 "To go in the opposite direction, after exporting and before sending the file "
26693 "to a Windows user, do something like this:"
26697 #: ../tools/virt-win-reg.pl:127
26700 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26705 #: ../tools/virt-win-reg.pl:129
26706 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26710 #: ../tools/virt-win-reg.pl:131
26712 "If you are unsure about the current encoding, use the L<file(1)> command. "
26713 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26714 "style (CRLF) line endings, like this:"
26718 #: ../tools/virt-win-reg.pl:135
26721 " $ file software.reg\n"
26722 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26723 " with CRLF line terminators\n"
26728 #: ../tools/virt-win-reg.pl:139
26729 msgid "This file would need conversion before you could C<--merge> it."
26733 #: ../tools/virt-win-reg.pl:143
26735 "Be careful when passing parameters containing C<\\> (backslash) in the "
26736 "shell. Usually you will have to use 'single quotes' or double backslashes "
26737 "(but not both) to protect them from the shell."
26741 #: ../tools/virt-win-reg.pl:147
26742 msgid "Paths and value names are case-insensitive."
26746 #: ../tools/virt-win-reg.pl:149
26747 msgid "CurrentControlSet etc."
26751 #: ../tools/virt-win-reg.pl:151
26753 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26754 "Registry at the level of the hive file, and therefore you cannot modify "
26759 #: ../tools/virt-win-reg.pl:155
26761 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26762 "circumstances it might refer to another control set. The way to find out is "
26763 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26767 #: ../tools/virt-win-reg.pl:159
26770 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26771 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26772 " \"Current\"=dword:00000001\n"
26773 " \"Default\"=dword:00000001\n"
26774 " \"Failed\"=dword:00000000\n"
26775 " \"LastKnownGood\"=dword:00000002\n"
26780 #: ../tools/virt-win-reg.pl:166
26781 msgid "\"Current\" is the one which Windows will choose when it boots."
26785 #: ../tools/virt-win-reg.pl:168
26787 "Similarly, other C<Current...> keys in the path may need to be replaced."
26791 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26796 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:498
26797 msgid "Enable debugging messages."
26801 #: ../tools/virt-win-reg.pl:232
26806 #: ../tools/virt-win-reg.pl:234
26808 "In merge mode, this merges a textual regedit file into the Windows Registry "
26809 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26810 "displays or exports Registry entries instead."
26814 #: ../tools/virt-win-reg.pl:238
26816 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26817 "result in disk corruption. However exporting (without this flag) is always "
26822 #: ../tools/virt-win-reg.pl:246
26823 msgid "B<--encoding> UTF-16LE|ASCII"
26827 #: ../tools/virt-win-reg.pl:248
26829 "When merging (only), you may need to specify the encoding for strings to be "
26830 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26831 "(3)/ENCODING STRINGS>."
26835 #: ../tools/virt-win-reg.pl:252
26837 "The default is to use UTF-16LE, which should work with recent versions of "
26842 #: ../tools/virt-win-reg.pl:486
26844 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26845 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26846 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26850 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26852 "When reporting bugs, please enable debugging and capture the I<complete> "
26857 #: ../tools/virt-win-reg.pl:504
26860 " export LIBGUESTFS_DEBUG=1\n"
26861 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26866 #: ../tools/virt-win-reg.pl:507
26868 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26873 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1510
26874 #: ../tools/virt-make-fs.pl:565
26875 msgid "Copyright (C) 2010 Red Hat Inc."
26879 #: ../tools/virt-resize.pl:42
26880 msgid "virt-resize - Resize a virtual machine disk"
26884 #: ../tools/virt-resize.pl:46
26887 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26888 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26889 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26894 #: ../tools/virt-resize.pl:52
26896 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26897 "larger or smaller overall, and resizing or deleting any partitions contained "
26902 #: ../tools/virt-resize.pl:56
26904 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26905 "not> be used on live virtual machines - for consistent results, shut the "
26906 "virtual machine down before resizing it."
26910 #: ../tools/virt-resize.pl:60
26912 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26913 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26917 #: ../tools/virt-resize.pl:66
26919 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26920 "fill the extra 5GB of space."
26924 #: ../tools/virt-resize.pl:69
26927 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26928 " virt-filesystems --long --h --all -a olddisk\n"
26929 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26930 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26935 #: ../tools/virt-resize.pl:74
26937 "As above, but make the /boot partition 200MB bigger, while giving the "
26938 "remaining space to /dev/sda2:"
26942 #: ../tools/virt-resize.pl:77
26945 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26950 #: ../tools/virt-resize.pl:79
26951 msgid "As above, but the output format will be uncompressed qcow2:"
26955 #: ../tools/virt-resize.pl:81
26958 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26959 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26964 #: ../tools/virt-resize.pl:84
26965 msgid "DETAILED USAGE"
26969 #: ../tools/virt-resize.pl:86
26970 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26974 #: ../tools/virt-resize.pl:90
26975 msgid "1. Shut down the virtual machine"
26979 #: ../tools/virt-resize.pl:92
26980 msgid "2. Locate input disk image"
26984 #: ../tools/virt-resize.pl:94
26986 "Locate the input disk image (ie. the file or device on the host containing "
26987 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26988 "dumpxml> like this to find the disk image name:"
26992 #: ../tools/virt-resize.pl:98
26995 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26996 " Found 1 nodes:\n"
26998 " <source dev=\"/dev/vg/lv_guest\" />\n"
27003 #: ../tools/virt-resize.pl:103
27004 msgid "3. Look at current sizing"
27008 #: ../tools/virt-resize.pl:105
27009 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27013 #: ../tools/virt-resize.pl:108
27016 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27017 " Name Type Size Parent\n"
27018 " /dev/sda1 partition 101M /dev/sda\n"
27019 " /dev/sda2 partition 7.9G /dev/sda\n"
27020 " /dev/sda device 8.0G -\n"
27025 #: ../tools/virt-resize.pl:114
27027 "(This example is a virtual machine with an 8 GB disk which we would like to "
27028 "expand up to 10 GB)."
27032 #: ../tools/virt-resize.pl:117
27033 msgid "4. Create output disk"
27037 #: ../tools/virt-resize.pl:119
27039 "Virt-resize cannot do in-place disk modifications. You have to have space "
27040 "to store the resized output disk."
27044 #: ../tools/virt-resize.pl:122
27046 "To store the resized disk image in a file, create a file of a suitable size:"
27050 #: ../tools/virt-resize.pl:125
27053 " # rm -f outdisk\n"
27054 " # truncate -s 10G outdisk\n"
27059 #: ../tools/virt-resize.pl:128
27060 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27064 #: ../tools/virt-resize.pl:130
27067 " # lvcreate -L 10G -n lv_name vg_name\n"
27072 #: ../tools/virt-resize.pl:132
27073 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27077 #: ../tools/virt-resize.pl:134
27080 " # virsh pool-list\n"
27081 " # virsh vol-create-as poolname newvol 10G\n"
27086 #: ../tools/virt-resize.pl:137
27091 #: ../tools/virt-resize.pl:139
27093 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27094 "file) and the output disk. The output disk is the one created in the "
27099 #: ../tools/virt-resize.pl:143
27102 " # virt-resize indisk outdisk\n"
27107 #: ../tools/virt-resize.pl:145
27109 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27110 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27111 "larger, then an extra, empty partition is created at the end of the disk "
27112 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27117 #: ../tools/virt-resize.pl:151
27119 "More realistically you'd want to expand existing partitions in the disk "
27120 "image by passing extra options (for the full list see the L</OPTIONS> "
27125 #: ../tools/virt-resize.pl:155
27127 "L</--expand> is the most useful option. It expands the named partition "
27128 "within the disk to fill any extra space:"
27132 #: ../tools/virt-resize.pl:158
27135 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27140 #: ../tools/virt-resize.pl:160
27142 "(In this case, an extra partition is I<not> created at the end of the disk, "
27143 "because there will be no unused space)."
27147 #: ../tools/virt-resize.pl:163
27149 "L</--resize> is the other commonly used option. The following would "
27150 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27151 "rest of the available space:"
27155 #: ../tools/virt-resize.pl:167
27158 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27159 " indisk outdisk\n"
27164 #: ../tools/virt-resize.pl:170
27166 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27167 "if virt-resize knows how, it will resize the contents, the equivalent of "
27168 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27169 ">. However virt-resize does not know how to resize some filesystems, so you "
27170 "would have to online resize them after booting the guest."
27174 #: ../tools/virt-resize.pl:177
27175 msgid "Other options are covered below."
27179 #: ../tools/virt-resize.pl:179
27184 #: ../tools/virt-resize.pl:181
27185 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27189 #: ../tools/virt-resize.pl:183
27190 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27194 #: ../tools/virt-resize.pl:185
27197 " # virsh edit guestname\n"
27202 #: ../tools/virt-resize.pl:187
27204 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27205 "html#elementsDisks>"
27209 #: ../tools/virt-resize.pl:190
27210 msgid "Then start up the domain with the new, resized disk:"
27214 #: ../tools/virt-resize.pl:192
27217 " # virsh start guestname\n"
27222 #: ../tools/virt-resize.pl:194
27224 "and check that it still works. See also the L</NOTES> section below for "
27225 "additional information."
27229 #: ../tools/virt-resize.pl:197
27230 msgid "7. Resize LVs etc inside the guest"
27234 #: ../tools/virt-resize.pl:199
27235 msgid "(This can also be done offline using L<guestfish(1)>)"
27239 #: ../tools/virt-resize.pl:201
27241 "Once the guest has booted you should see the new space available, at least "
27242 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27243 "may need to resize LVs inside PVs, and also resize filesystem types that "
27244 "virt-resize does not know how to expand."
27248 #: ../tools/virt-resize.pl:208
27249 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27253 #: ../tools/virt-resize.pl:210
27255 "Shrinking is somewhat more complex than expanding, and only an overview is "
27260 #: ../tools/virt-resize.pl:213
27262 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27263 "filesystems). The user has to shrink content before passing the disk image "
27264 "to virt-resize, and virt-resize will check that the content has been shrunk "
27269 #: ../tools/virt-resize.pl:218
27270 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27274 #: ../tools/virt-resize.pl:220
27276 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27277 "steps 3 and 4 above to allocate a new disk image."
27281 #: ../tools/virt-resize.pl:223
27283 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27287 #: ../tools/virt-resize.pl:226
27288 msgid "IGNORING OR DELETING PARTITIONS"
27292 #: ../tools/virt-resize.pl:228
27294 "virt-resize also gives a convenient way to ignore or delete partitions when "
27295 "copying from the input disk to the output disk. Ignoring a partition speeds "
27296 "up the copy where you don't care about the existing contents of a "
27297 "partition. Deleting a partition removes it completely, but note that it "
27298 "also renumbers any partitions after the one which is deleted, which can "
27299 "leave some guests unbootable."
27303 #: ../tools/virt-resize.pl:235
27304 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27308 #: ../tools/virt-resize.pl:237
27310 "If the input disk is in qcow2 format, then you may prefer that the output is "
27311 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27312 "the fly. The output format is simply determined by the format of the empty "
27313 "output container that you provide. Thus to create qcow2 output, use:"
27317 #: ../tools/virt-resize.pl:243
27320 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27325 #: ../tools/virt-resize.pl:245
27326 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27330 #: ../tools/virt-resize.pl:247
27331 msgid "Similarly, to get non-sparse raw output use:"
27335 #: ../tools/virt-resize.pl:249
27338 " fallocate -l size outdisk\n"
27343 #: ../tools/virt-resize.pl:251
27345 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27346 "dev/zero of=outdisk bs=1M count=..>)"
27350 #: ../tools/virt-resize.pl:264
27351 msgid "Display help."
27355 #: ../tools/virt-resize.pl:278
27356 msgid "B<--resize part=size>"
27360 #: ../tools/virt-resize.pl:280
27362 "Resize the named partition (expanding or shrinking it) so that it has the "
27367 #: ../tools/virt-resize.pl:283
27369 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27370 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27371 "Exabytes; or as a percentage of the current size; or as a relative number or "
27372 "percentage. For example:"
27376 #: ../tools/virt-resize.pl:288
27379 " --resize /dev/sda2=10G\n"
27384 #: ../tools/virt-resize.pl:290
27387 " --resize /dev/sda4=90%\n"
27392 #: ../tools/virt-resize.pl:292
27395 " --resize /dev/sda2=+1G\n"
27400 #: ../tools/virt-resize.pl:294
27403 " --resize /dev/sda2=-200M\n"
27408 #: ../tools/virt-resize.pl:296
27411 " --resize /dev/sda1=+128K\n"
27416 #: ../tools/virt-resize.pl:298
27419 " --resize /dev/sda1=+10%\n"
27424 #: ../tools/virt-resize.pl:300
27427 " --resize /dev/sda1=-10%\n"
27432 #: ../tools/virt-resize.pl:302
27434 "You can increase the size of any partition. Virt-resize will expand the "
27435 "direct content of the partition if it knows how (see C<--expand> below)."
27439 #: ../tools/virt-resize.pl:306
27441 "You can only I<decrease> the size of partitions that contain filesystems or "
27442 "PVs which have already been shrunk. Virt-resize will check this has been "
27443 "done before proceeding, or else will print an error (see also C<--resize-"
27448 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
27449 #: ../tools/virt-resize.pl:420
27450 msgid "You can give this option multiple times."
27454 #: ../tools/virt-resize.pl:317
27455 msgid "B<--resize-force part=size>"
27459 #: ../tools/virt-resize.pl:319
27461 "This is the same as C<--resize> except that it will let you decrease the "
27462 "size of any partition. Generally this means you will lose any data which "
27463 "was at the end of the partition you shrink, but you may not care about that "
27464 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27465 "as a swap partition)."
27469 #: ../tools/virt-resize.pl:325
27470 msgid "See also the C<--ignore> option."
27474 #: ../tools/virt-resize.pl:331
27475 msgid "B<--expand part>"
27479 #: ../tools/virt-resize.pl:333
27481 "Expand the named partition so it uses up all extra space (space left over "
27482 "after any other resize changes that you request have been done)."
27486 #: ../tools/virt-resize.pl:336
27488 "If virt-resize knows how, it will expand the direct content of the "
27489 "partition. For example, if the partition is an LVM PV, it will expand the "
27490 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27491 "content it doesn't know about alone."
27495 #: ../tools/virt-resize.pl:341
27496 msgid "Currently virt-resize can resize:"
27500 #: ../tools/virt-resize.pl:347
27502 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27507 #: ../tools/virt-resize.pl:352
27509 "NTFS filesystems contained directly in a partition, if libguestfs was "
27510 "compiled with support for NTFS."
27514 #: ../tools/virt-resize.pl:355
27516 "The filesystem must have been shut down consistently last time it was used. "
27517 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27518 "consistency check, so at the first boot after resizing Windows will check "
27523 #: ../tools/virt-resize.pl:362
27525 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
27526 "inside the PV, but see the C<--LV-expand> option. The user could also "
27527 "resize LVs as desired after boot."
27531 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
27532 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27536 #: ../tools/virt-resize.pl:374
27537 msgid "B<--shrink part>"
27541 #: ../tools/virt-resize.pl:376
27543 "Shrink the named partition until the overall disk image fits in the "
27544 "destination. The named partition B<must> contain a filesystem or PV which "
27545 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27546 "online tools). Virt-resize will check this and give an error if it has not "
27551 #: ../tools/virt-resize.pl:382
27553 "The amount by which the overall disk must be shrunk (after carrying out all "
27554 "other operations requested by the user) is called the \"deficit\". For "
27555 "example, a straight copy (assume no other operations) from a 5GB disk image "
27556 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27557 "would give an error unless the user specified a partition to shrink and that "
27558 "partition had more than a gigabyte of free space."
27562 #: ../tools/virt-resize.pl:396
27563 msgid "B<--ignore part>"
27567 #: ../tools/virt-resize.pl:398
27569 "Ignore the named partition. Effectively this means the partition is "
27570 "allocated on the destination disk, but the content is not copied across from "
27571 "the source disk. The content of the partition will be blank (all zero "
27576 #: ../tools/virt-resize.pl:409
27577 msgid "B<--delete part>"
27581 #: ../tools/virt-resize.pl:411
27583 "Delete the named partition. It would be more accurate to describe this as "
27584 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27585 "the original disk image is left intact."
27589 #: ../tools/virt-resize.pl:415
27591 "Note that when you delete a partition, then anything contained in the "
27592 "partition is also deleted. Furthermore, this causes any partitions that "
27593 "come after to be I<renumbered>, which can easily make your guest unbootable."
27597 #: ../tools/virt-resize.pl:426
27598 msgid "B<--LV-expand logvol>"
27602 #: ../tools/virt-resize.pl:428
27604 "This takes the logical volume and, as a final step, expands it to fill all "
27605 "the space available in its volume group. A typical usage, assuming a Linux "
27606 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27607 "lv_root> would be:"
27611 #: ../tools/virt-resize.pl:433
27614 " virt-resize indisk outdisk \\\n"
27615 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27620 #: ../tools/virt-resize.pl:436
27622 "This would first expand the partition (and PV), and then expand the root "
27623 "device to fill the extra space in the PV."
27627 #: ../tools/virt-resize.pl:439
27629 "The contents of the LV are also resized if virt-resize knows how to do "
27630 "that. You can stop virt-resize from trying to expand the content by using "
27631 "the option C<--no-expand-content>."
27635 #: ../tools/virt-resize.pl:443
27636 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27640 #: ../tools/virt-resize.pl:446
27642 "You can give this option multiple times, I<but> it doesn't make sense to do "
27643 "this unless the logical volumes you specify are all in different volume "
27648 #: ../tools/virt-resize.pl:454
27649 msgid "B<--no-copy-boot-loader>"
27653 #: ../tools/virt-resize.pl:456
27655 "By default, virt-resize copies over some sectors at the start of the disk "
27656 "(up to the beginning of the first partition). Commonly these sectors "
27657 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27658 "in order for the guest to boot correctly."
27662 #: ../tools/virt-resize.pl:461
27664 "If you specify this flag, then this initial copy is not done. You may need "
27665 "to reinstall the boot loader in this case."
27669 #: ../tools/virt-resize.pl:469
27670 msgid "B<--no-extra-partition>"
27674 #: ../tools/virt-resize.pl:471
27676 "By default, virt-resize creates an extra partition if there is any extra, "
27677 "unused space after all resizing has happened. Use this option to prevent "
27678 "the extra partition from being created. If you do this then the extra space "
27679 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27680 "tool in the guest."
27684 #: ../tools/virt-resize.pl:477
27686 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27691 #: ../tools/virt-resize.pl:484
27692 msgid "B<--no-expand-content>"
27696 #: ../tools/virt-resize.pl:486
27698 "By default, virt-resize will try to expand the direct contents of "
27699 "partitions, if it knows how (see C<--expand> option above)."
27703 #: ../tools/virt-resize.pl:489
27705 "If you give the C<--no-expand-content> option then virt-resize will not "
27710 #: ../tools/virt-resize.pl:496
27711 msgid "B<-d> | B<--debug>"
27715 #: ../tools/virt-resize.pl:504
27716 msgid "B<-n> | B<--dryrun>"
27720 #: ../tools/virt-resize.pl:506
27721 msgid "Print a summary of what would be done, but don't do anything."
27725 #: ../tools/virt-resize.pl:512
27726 msgid "B<-q> | B<--quiet>"
27730 #: ../tools/virt-resize.pl:514
27731 msgid "Don't print the summary."
27735 #: ../tools/virt-resize.pl:522
27737 "Specify the format of the input disk image. If this flag is not given then "
27738 "it is auto-detected from the image itself."
27742 #: ../tools/virt-resize.pl:528
27744 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27745 "AND NON-SPARSE RAW FORMATS>."
27749 #: ../tools/virt-resize.pl:535
27750 msgid "B<--output-format> raw"
27754 #: ../tools/virt-resize.pl:537
27756 "Specify the format of the output disk image. If this flag is not given then "
27757 "it is auto-detected from the image itself."
27761 #: ../tools/virt-resize.pl:543
27763 "Note that you still need to create the output disk with the right format. "
27764 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27768 #: ../tools/virt-resize.pl:1419
27773 #: ../tools/virt-resize.pl:1421
27774 msgid "\"Partition 1 does not end on cylinder boundary.\""
27778 #: ../tools/virt-resize.pl:1423
27780 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27781 "means the partitions will not be aligned to the ancient CHS geometry. "
27782 "However CHS geometry is meaningless for disks manufactured since the early "
27783 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27784 "cylinders is not required by any modern operating system."
27788 #: ../tools/virt-resize.pl:1430
27789 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27793 #: ../tools/virt-resize.pl:1432
27795 "In Windows Vista and later versions, Microsoft switched to using a separate "
27796 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27797 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27798 "the boot partition. Doing so seems to break the guest completely. However "
27799 "expanding the second partition (ie. C: drive) should work."
27803 #: ../tools/virt-resize.pl:1439
27805 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27806 "NTFS partitions have been expanded. This is just a safety check and (unless "
27807 "it find errors) is nothing to worry about."
27811 #: ../tools/virt-resize.pl:1443
27812 msgid "GUEST BOOT STUCK AT \"GRUB\""
27816 #: ../tools/virt-resize.pl:1445
27818 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27819 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27820 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27821 "although we think is to do with partition alignment."
27825 #: ../tools/virt-resize.pl:1450
27828 " guestfish -i -a newdisk\n"
27829 " ><fs> cat /boot/grub/device.map\n"
27830 " # check the contents of this file are sensible or\n"
27831 " # edit the file if necessary\n"
27832 " ><fs> grub-install / /dev/vda\n"
27838 #: ../tools/virt-resize.pl:1457
27840 "For more flexible guest reconfiguration, including if you need to specify "
27841 "other parameters to grub-install, use L<virt-rescue(1)>."
27845 #: ../tools/virt-resize.pl:1460
27846 msgid "ALTERNATIVE TOOLS"
27850 #: ../tools/virt-resize.pl:1462
27852 "There are several proprietary tools for resizing partitions. We won't "
27853 "mention any here."
27857 #: ../tools/virt-resize.pl:1465
27859 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27860 "operations on disk images. They can resize and move partitions, but I don't "
27861 "think they can do anything with the contents, and they certainly don't "
27866 #: ../tools/virt-resize.pl:1470
27868 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27869 "but at a much lower level. You will probably end up hand-calculating sector "
27870 "offsets, which is something that virt-resize was designed to avoid. If you "
27871 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27876 #: ../tools/virt-resize.pl:1485
27878 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
27879 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
27880 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
27881 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
27882 "libguestfs.org/>."
27886 #: ../tools/virt-list-filesystems.pl:32
27888 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27892 #: ../tools/virt-list-filesystems.pl:36
27895 " virt-list-filesystems [--options] domname\n"
27900 #: ../tools/virt-list-filesystems.pl:38
27903 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27908 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27910 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27915 #: ../tools/virt-list-filesystems.pl:45
27917 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27918 "are contained in a virtual machine or disk image."
27922 #: ../tools/virt-list-filesystems.pl:49
27924 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27925 "functionality. For more complex cases you should look at the L<guestfish(1)"
27930 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27931 msgid "B<-l> | B<--long>"
27935 #: ../tools/virt-list-filesystems.pl:108
27937 "With this option, C<virt-list-filesystems> displays the type of each "
27938 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27942 #: ../tools/virt-list-filesystems.pl:115
27943 msgid "B<-a> | B<--all>"
27947 #: ../tools/virt-list-filesystems.pl:117
27949 "Normally we only show mountable filesystems. If this option is given then "
27950 "swap devices are shown too."
27954 #: ../tools/virt-list-filesystems.pl:191
27956 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
27957 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27958 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27962 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27963 msgid "Copyright (C) 2009 Red Hat Inc."
27967 #: ../tools/virt-tar.pl:33
27968 msgid "virt-tar - Extract or upload files to a virtual machine"
27972 #: ../tools/virt-tar.pl:37
27975 " virt-tar [--options] -x domname directory tarball\n"
27980 #: ../tools/virt-tar.pl:39
27983 " virt-tar [--options] -u domname tarball directory\n"
27988 #: ../tools/virt-tar.pl:41
27991 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27996 #: ../tools/virt-tar.pl:43
27999 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28004 #: ../tools/virt-tar.pl:47
28005 msgid "Download C</home> from the VM into a local tarball:"
28009 #: ../tools/virt-tar.pl:49
28012 " virt-tar -x domname /home home.tar\n"
28017 #: ../tools/virt-tar.pl:51
28020 " virt-tar -zx domname /home home.tar.gz\n"
28025 #: ../tools/virt-tar.pl:53
28026 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28030 #: ../tools/virt-tar.pl:55
28033 " virt-tar -u domname uploadstuff.tar /tmp\n"
28038 #: ../tools/virt-tar.pl:57
28041 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28046 #: ../tools/virt-tar.pl:61
28048 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28049 "virtual machines. If you do this, you risk disk corruption in the VM. "
28050 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28054 #: ../tools/virt-tar.pl:66
28056 "You can use C<-x> (extract) on live virtual machines, but you might get "
28057 "inconsistent results or errors if there is filesystem activity inside the "
28058 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28059 "work, but the only way to guarantee consistent results is if the virtual "
28060 "machine is shut down."
28064 #: ../tools/virt-tar.pl:74
28066 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28067 "parts of a guest filesystem. There are many possibilities: making backups, "
28068 "uploading data files, snooping on guest activity, fixing or customizing "
28073 #: ../tools/virt-tar.pl:79
28075 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28076 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28077 "should look at the L<guestfish(1)> tool."
28081 #: ../tools/virt-tar.pl:83
28083 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28084 "its contents (recursively) from the virtual machine into a local tarball. "
28085 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28086 "virtual machine. You cannot use these two options together."
28090 #: ../tools/virt-tar.pl:89
28092 "In addition, you may need to use the C<-z> (gZip) option to enable "
28093 "compression. When uploading, you have to specify C<-z> if the upload file "
28094 "is compressed because virt-tar won't detect this on its own."
28098 #: ../tools/virt-tar.pl:93
28100 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28101 "example it cannot do PKZip files or bzip2 compression. If you want that "
28102 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28103 "the L<libguestfs(3)> API)."
28107 #: ../tools/virt-tar.pl:151
28108 msgid "B<-x> | B<--extract> | B<--download>"
28112 #: ../tools/virt-tar.pl:153
28113 msgid "B<-u> | B<--upload>"
28117 #: ../tools/virt-tar.pl:155
28119 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28124 #: ../tools/virt-tar.pl:158
28126 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28127 "Please read the L</WARNING> section above before using this option."
28131 #: ../tools/virt-tar.pl:162
28132 msgid "You must specify exactly one of these options."
28136 #: ../tools/virt-tar.pl:168
28137 msgid "B<-z> | B<--gzip>"
28141 #: ../tools/virt-tar.pl:170
28142 msgid "Specify that the input or output tarball is gzip-compressed."
28146 #: ../tools/virt-tar.pl:283
28148 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28149 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28154 #: ../tools/virt-make-fs.pl:37
28155 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28159 #: ../tools/virt-make-fs.pl:41
28162 " virt-make-fs [--options] input.tar output.img\n"
28167 #: ../tools/virt-make-fs.pl:43
28170 " virt-make-fs [--options] input.tar.gz output.img\n"
28175 #: ../tools/virt-make-fs.pl:45
28178 " virt-make-fs [--options] directory output.img\n"
28183 #: ../tools/virt-make-fs.pl:49
28185 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28186 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28187 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28188 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28189 "you want to attach these filesystems to existing virtual machines (eg. to "
28190 "import large amounts of read-only data to a VM)."
28194 #: ../tools/virt-make-fs.pl:57
28195 msgid "Basic usage is:"
28199 #: ../tools/virt-make-fs.pl:59
28202 " virt-make-fs input output\n"
28207 #: ../tools/virt-make-fs.pl:61
28209 "where C<input> is either a directory containing files that you want to add, "
28210 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28211 "C<output> is a disk image. The input type is detected automatically. The "
28212 "output disk image defaults to a raw ext2 image unless you specify extra "
28213 "flags (see L</OPTIONS> below)."
28217 #: ../tools/virt-make-fs.pl:67
28218 msgid "EXTRA SPACE"
28222 #: ../tools/virt-make-fs.pl:69
28224 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28225 "the files that it contains, but might have extra space. Depending on how "
28226 "you are going to use the output, you might think this extra space is wasted "
28227 "and want to minimize it, or you might want to leave space so that more files "
28228 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28229 "but you can use the C<--size> flag to leave space in the filesystem if you "
28234 #: ../tools/virt-make-fs.pl:77
28236 "An alternative way to leave extra space but not make the output image any "
28237 "bigger is to use an alternative disk image format (instead of the default "
28238 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28239 "image format (check your hypervisor supports this before using it). This "
28240 "allows you to choose a large C<--size> but the extra space won't actually be "
28241 "allocated in the image until you try to store something in it."
28245 #: ../tools/virt-make-fs.pl:85
28247 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28248 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28249 "resize to build another image from scratch."
28253 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28254 #: ../tools/virt-make-fs.pl:142
28259 #: ../tools/virt-make-fs.pl:91
28262 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28267 #: ../tools/virt-make-fs.pl:93
28268 msgid "FILESYSTEM TYPE"
28272 #: ../tools/virt-make-fs.pl:95
28274 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28275 "libguestfs supports can be used (but I<not> read-only formats like "
28276 "ISO9660). Here are some of the more common choices:"
28280 #: ../tools/virt-make-fs.pl:101
28285 #: ../tools/virt-make-fs.pl:103
28287 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28288 "you are not going to use the filesystem in a way that requires the journal, "
28289 "then this is just wasted overhead."
28293 #: ../tools/virt-make-fs.pl:107
28294 msgid "I<ntfs> or I<vfat>"
28298 #: ../tools/virt-make-fs.pl:109
28299 msgid "Useful if exporting data to a Windows guest."
28303 #: ../tools/virt-make-fs.pl:111
28305 "I<Note for vfat>: The tar archive or local directory must only contain files "
28306 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28307 "program running within libguestfs is unable to change the ownership of non-"
28308 "root files, since vfat itself does not support this."
28312 #: ../tools/virt-make-fs.pl:116
28317 #: ../tools/virt-make-fs.pl:118
28319 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28320 "total filesystem size."
28324 #: ../tools/virt-make-fs.pl:125
28327 " virt-make-fs --type=minix input minixfs.img\n"
28332 #: ../tools/virt-make-fs.pl:127
28333 msgid "TO PARTITION OR NOT TO PARTITION"
28337 #: ../tools/virt-make-fs.pl:129
28338 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28342 #: ../tools/virt-make-fs.pl:131
28344 "Adding a partition can make the disk image more compatible with certain "
28345 "virtualized operating systems which don't expect to see a filesystem "
28346 "directly located on a block device (Linux doesn't care and will happily "
28347 "handle both types)."
28351 #: ../tools/virt-make-fs.pl:136
28353 "On the other hand, if you have a partition table then the output image is no "
28354 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28355 "directly on a partitioned disk image. (However libguestfs tools such as "
28356 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28360 #: ../tools/virt-make-fs.pl:144
28361 msgid "Add an MBR partition:"
28365 #: ../tools/virt-make-fs.pl:146
28368 " virt-make-fs --partition -- input disk.img\n"
28373 #: ../tools/virt-make-fs.pl:148
28375 "If the output disk image could be terabyte-sized or larger, it's better to "
28376 "use an EFI/GPT-compatible partition table:"
28380 #: ../tools/virt-make-fs.pl:151
28383 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28388 #: ../tools/virt-make-fs.pl:179
28389 msgid "Enable debugging information."
28393 #: ../tools/virt-make-fs.pl:185
28394 msgid "B<--size=E<lt>NE<gt>>"
28398 #: ../tools/virt-make-fs.pl:187
28399 msgid "B<--size=+E<lt>NE<gt>>"
28403 #: ../tools/virt-make-fs.pl:189
28404 msgid "B<-s E<lt>NE<gt>>"
28408 #: ../tools/virt-make-fs.pl:191
28409 msgid "B<-s +E<lt>NE<gt>>"
28413 #: ../tools/virt-make-fs.pl:193
28415 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28419 #: ../tools/virt-make-fs.pl:196
28421 "If this option is I<not> given, then the output image will be just large "
28422 "enough to contain all the files, with not much wasted space."
28426 #: ../tools/virt-make-fs.pl:199
28428 "To choose a fixed size output disk, specify an absolute number followed by b/"
28429 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28430 "Petabytes or Exabytes. This must be large enough to contain all the input "
28431 "files, else you will get an error."
28435 #: ../tools/virt-make-fs.pl:204
28437 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28438 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28439 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28440 "the input files, and (approximately) an extra 200 MB free space."
28444 #: ../tools/virt-make-fs.pl:210
28446 "Note that virt-make-fs estimates free space, and therefore will not produce "
28447 "filesystems containing precisely the free space requested. (It is much more "
28448 "expensive and time-consuming to produce a filesystem which has precisely the "
28449 "desired free space)."
28453 #: ../tools/virt-make-fs.pl:219
28454 msgid "B<--format=E<lt>fmtE<gt>>"
28458 #: ../tools/virt-make-fs.pl:221
28459 msgid "B<-F E<lt>fmtE<gt>>"
28463 #: ../tools/virt-make-fs.pl:223
28464 msgid "Choose the output disk image format."
28468 #: ../tools/virt-make-fs.pl:225
28469 msgid "The default is C<raw> (raw disk image)."
28473 #: ../tools/virt-make-fs.pl:227
28475 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28476 "that would really make sense here is C<qcow2>."
28480 #: ../tools/virt-make-fs.pl:234
28481 msgid "B<--type=E<lt>fsE<gt>>"
28485 #: ../tools/virt-make-fs.pl:236
28486 msgid "B<-t E<lt>fsE<gt>>"
28490 #: ../tools/virt-make-fs.pl:238
28491 msgid "Choose the output filesystem type."
28495 #: ../tools/virt-make-fs.pl:240
28496 msgid "The default is C<ext2>."
28500 #: ../tools/virt-make-fs.pl:242
28502 "Any filesystem which is supported read-write by libguestfs can be used here."
28506 #: ../tools/virt-make-fs.pl:249
28507 msgid "B<--partition>"
28511 #: ../tools/virt-make-fs.pl:251
28512 msgid "B<--partition=E<lt>parttypeE<gt>>"
28516 #: ../tools/virt-make-fs.pl:253
28518 "If specified, this flag adds an MBR partition table to the output disk image."
28522 #: ../tools/virt-make-fs.pl:256
28524 "You can change the partition table type, eg. C<--partition=gpt> for large "
28529 #: ../tools/virt-make-fs.pl:259
28531 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28532 "might consider the next parameter to be the partition type. For example:"
28536 #: ../tools/virt-make-fs.pl:263
28539 " virt-make-fs --partition input.tar ...\n"
28544 #: ../tools/virt-make-fs.pl:265
28546 "would cause virt-make-fs to think you wanted to use a partition type of "
28547 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28548 "dash) between options and the input file argument:"
28552 #: ../tools/virt-make-fs.pl:269
28555 " virt-make-fs --partition -- input.tar ...\n"
28560 #: ../tools/virt-make-fs.pl:536
28562 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28563 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28564 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28568 #: ../tools/virt-make-fs.pl:553
28571 " export LIBGUESTFS_DEBUG=1\n"
28572 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28577 #: ../tools/virt-make-fs.pl:556
28579 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28584 #: ../tools/virt-list-partitions.pl:32
28586 "virt-list-partitions - List partitions in a virtual machine or disk image"
28590 #: ../tools/virt-list-partitions.pl:36
28593 " virt-list-partitions [--options] domname\n"
28598 #: ../tools/virt-list-partitions.pl:38
28601 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28606 #: ../tools/virt-list-partitions.pl:45
28608 "C<virt-list-partitions> is a command line tool to list the partitions that "
28609 "are contained in a virtual machine or disk image. It is mainly useful as a "
28610 "first step to using L<virt-resize(1)>."
28614 #: ../tools/virt-list-partitions.pl:50
28616 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28617 "functionality. For more complex cases you should look at the L<guestfish(1)"
28622 #: ../tools/virt-list-partitions.pl:107
28623 msgid "B<-h> | B<--human-readable>"
28627 #: ../tools/virt-list-partitions.pl:109
28628 msgid "Show sizes in human-readable form (eg. \"1G\")."
28632 #: ../tools/virt-list-partitions.pl:117
28634 "With this option, C<virt-list-partitions> displays the type and size of each "
28635 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28639 #: ../tools/virt-list-partitions.pl:124
28640 msgid "B<-t> | B<--total>"
28644 #: ../tools/virt-list-partitions.pl:126
28646 "Display the total size of each block device (as a separate row or rows)."
28650 #: ../tools/virt-list-partitions.pl:259
28652 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
28653 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
28654 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."