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-12-01 17:35+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:2007 ../src/guestfs.pod:2013 ../src/guestfs.pod:2018
792 #: ../src/guestfs.pod:2024 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140
793 #: ../src/guestfs.pod:2144 ../src/guestfs.pod:2148
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
3646 "For functions that take optional arguments, the optional arguments are "
3647 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3648 "arguments. A bitmask in the header indicates which optional arguments are "
3649 "meaningful. The bitmask is also checked to see if it contains bits set "
3650 "which the daemon does not know about (eg. if more optional arguments were "
3651 "added in a later version of the library), and this causes the call to be "
3656 #: ../src/guestfs.pod:1866
3657 msgid "The reply message for ordinary functions is:"
3661 #: ../src/guestfs.pod:1868
3664 " total length (header + ret,\n"
3665 " but not including the length word itself)\n"
3666 " struct guestfs_message_header (encoded as XDR)\n"
3667 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3672 #: ../src/guestfs.pod:1873
3674 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3675 "functions that return no formal return values."
3679 #: ../src/guestfs.pod:1876
3681 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3685 #: ../src/guestfs.pod:1879
3687 "In the case of an error, a flag is set in the header, and the reply message "
3688 "is slightly changed:"
3692 #: ../src/guestfs.pod:1882
3695 " total length (header + error,\n"
3696 " but not including the length word itself)\n"
3697 " struct guestfs_message_header (encoded as XDR)\n"
3698 " struct guestfs_message_error (encoded as XDR)\n"
3703 #: ../src/guestfs.pod:1887
3705 "The C<guestfs_message_error> structure contains the error message as a "
3710 #: ../src/guestfs.pod:1890
3711 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3715 #: ../src/guestfs.pod:1892
3717 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3718 "The normal request message is sent (see above). However this is followed by "
3719 "a sequence of file chunks."
3723 #: ../src/guestfs.pod:1896
3726 " total length (header + arguments,\n"
3727 " but not including the length word itself,\n"
3728 " and not including the chunks)\n"
3729 " struct guestfs_message_header (encoded as XDR)\n"
3730 " struct guestfs_<foo>_args (encoded as XDR)\n"
3731 " sequence of chunks for FileIn param #0\n"
3732 " sequence of chunks for FileIn param #1 etc.\n"
3737 #: ../src/guestfs.pod:1904
3738 msgid "The \"sequence of chunks\" is:"
3742 #: ../src/guestfs.pod:1906
3745 " length of chunk (not including length word itself)\n"
3746 " struct guestfs_chunk (encoded as XDR)\n"
3747 " length of chunk\n"
3748 " struct guestfs_chunk (encoded as XDR)\n"
3750 " length of chunk\n"
3751 " struct guestfs_chunk (with data.data_len == 0)\n"
3756 #: ../src/guestfs.pod:1914
3758 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3759 "is set in the final chunk to indicate either successful completion or early "
3764 #: ../src/guestfs.pod:1918
3766 "At time of writing there are no functions that have more than one FileIn "
3767 "parameter. However this is (theoretically) supported, by sending the "
3768 "sequence of chunks for each FileIn parameter one after another (from left to "
3773 #: ../src/guestfs.pod:1923
3775 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3776 "transfer. The library does this by sending a chunk with a special flag set "
3777 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3778 "RPC, does I<not> send any reply, and goes back to reading the next request."
3782 #: ../src/guestfs.pod:1929
3784 "The daemon may also cancel. It does this by writing a special word "
3785 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3786 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3787 "cancel chunk). The special word is chosen so that even if cancellation "
3788 "happens right at the end of the transfer (after the library has finished "
3789 "writing and has started listening for the reply), the \"spurious\" cancel "
3790 "flag will not be confused with the reply message."
3794 #: ../src/guestfs.pod:1938
3796 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3797 "limit), and also files where the size is not known in advance (eg. from "
3798 "pipes or sockets). However the chunks are rather small "
3799 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3800 "to keep much in memory."
3804 #: ../src/guestfs.pod:1944
3805 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3809 #: ../src/guestfs.pod:1946
3811 "The protocol for FileOut parameters is exactly the same as for FileIn "
3812 "parameters, but with the roles of daemon and library reversed."
3816 #: ../src/guestfs.pod:1949
3819 " total length (header + ret,\n"
3820 " but not including the length word itself,\n"
3821 " and not including the chunks)\n"
3822 " struct guestfs_message_header (encoded as XDR)\n"
3823 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3824 " sequence of chunks for FileOut param #0\n"
3825 " sequence of chunks for FileOut param #1 etc.\n"
3830 #: ../src/guestfs.pod:1957
3831 msgid "INITIAL MESSAGE"
3835 #: ../src/guestfs.pod:1959
3837 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3838 "which indicates that the guest and daemon is alive. This is what L</"
3839 "guestfs_launch> waits for."
3843 #: ../src/guestfs.pod:1963
3844 msgid "PROGRESS NOTIFICATION MESSAGES"
3848 #: ../src/guestfs.pod:1965
3850 "The daemon may send progress notification messages at any time. These are "
3851 "distinguished by the normal length word being replaced by "
3852 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3856 #: ../src/guestfs.pod:1969
3858 "The library turns them into progress callbacks (see "
3859 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3860 "discards them if not."
3864 #: ../src/guestfs.pod:1973
3866 "The daemon self-limits the frequency of progress messages it sends (see "
3867 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3872 #: ../src/guestfs.pod:1977
3873 msgid "LIBGUESTFS VERSION NUMBERS"
3877 #: ../src/guestfs.pod:1979
3879 "Since April 2010, libguestfs has started to make separate development and "
3880 "stable releases, along with corresponding branches in our git repository. "
3881 "These separate releases can be identified by version number:"
3885 #: ../src/guestfs.pod:1984
3888 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3889 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3895 " | `-------- sub-version\n"
3897 " `------ always '1' because we don't change the ABI\n"
3902 #: ../src/guestfs.pod:1995
3903 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3907 #: ../src/guestfs.pod:1997
3909 "As time passes we cherry pick fixes from the development branch and backport "
3910 "those into the stable branch, the effect being that the stable branch should "
3911 "get more stable and less buggy over time. So the stable releases are ideal "
3912 "for people who don't need new features but would just like the software to "
3917 #: ../src/guestfs.pod:2003
3918 msgid "Our criteria for backporting changes are:"
3922 #: ../src/guestfs.pod:2009
3924 "Documentation changes which don't affect any code are backported unless the "
3925 "documentation refers to a future feature which is not in stable."
3929 #: ../src/guestfs.pod:2015
3931 "Bug fixes which are not controversial, fix obvious problems, and have been "
3932 "well tested are backported."
3936 #: ../src/guestfs.pod:2020
3938 "Simple rearrangements of code which shouldn't affect how it works get "
3939 "backported. This is so that the code in the two branches doesn't get too "
3940 "far out of step, allowing us to backport future fixes more easily."
3944 #: ../src/guestfs.pod:2026
3946 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3947 "exceptional case: the new feature is required in order to implement an "
3948 "important bug fix."
3952 #: ../src/guestfs.pod:2032
3954 "A new stable branch starts when we think the new features in development are "
3955 "substantial and compelling enough over the current stable branch to warrant "
3956 "it. When that happens we create new stable and development versions 1.N.0 "
3957 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3958 "stable at this point, but by backporting fixes from development, that branch "
3959 "will stabilize over time."
3963 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:915
3964 #: ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3965 msgid "ENVIRONMENT VARIABLES"
3969 #: ../src/guestfs.pod:2044 ../fish/guestfish.pod:941
3970 msgid "LIBGUESTFS_APPEND"
3974 #: ../src/guestfs.pod:2046 ../fish/guestfish.pod:943
3975 msgid "Pass additional options to the guest kernel."
3979 #: ../src/guestfs.pod:2048 ../fish/guestfish.pod:945
3980 msgid "LIBGUESTFS_DEBUG"
3984 #: ../src/guestfs.pod:2050
3986 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3987 "effect as calling C<guestfs_set_verbose (g, 1)>."
3991 #: ../src/guestfs.pod:2053 ../fish/guestfish.pod:950
3992 msgid "LIBGUESTFS_MEMSIZE"
3996 #: ../src/guestfs.pod:2055 ../fish/guestfish.pod:952
3998 "Set the memory allocated to the qemu process, in megabytes. For example:"
4002 #: ../src/guestfs.pod:2058 ../fish/guestfish.pod:955
4005 " LIBGUESTFS_MEMSIZE=700\n"
4010 #: ../src/guestfs.pod:2060 ../fish/guestfish.pod:957
4011 msgid "LIBGUESTFS_PATH"
4015 #: ../src/guestfs.pod:2062
4017 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
4018 "the discussion of paths in section PATH above."
4022 #: ../src/guestfs.pod:2065 ../fish/guestfish.pod:962
4023 msgid "LIBGUESTFS_QEMU"
4027 #: ../src/guestfs.pod:2067 ../fish/guestfish.pod:964
4029 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
4030 "which was found at compile time by the configure script is used."
4034 #: ../src/guestfs.pod:2071
4035 msgid "See also L</QEMU WRAPPERS> above."
4039 #: ../src/guestfs.pod:2073 ../fish/guestfish.pod:968
4040 msgid "LIBGUESTFS_TRACE"
4044 #: ../src/guestfs.pod:2075
4046 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
4047 "effect as calling C<guestfs_set_trace (g, 1)>."
4051 #: ../src/guestfs.pod:2078 ../fish/guestfish.pod:977
4056 #: ../src/guestfs.pod:2080 ../fish/guestfish.pod:979
4057 msgid "Location of temporary directory, defaults to C</tmp>."
4061 #: ../src/guestfs.pod:2082 ../fish/guestfish.pod:981
4063 "If libguestfs was compiled to use the supermin appliance then the real "
4064 "appliance is cached in this directory, shared between all handles belonging "
4065 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4066 "use in case C</tmp> is not large enough."
4070 #: ../src/guestfs.pod:2090 ../fish/guestfish.pod:1039
4071 #: ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233
4072 #: ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484
4073 #: ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189
4074 #: ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534
4075 #: ../tools/virt-list-partitions.pl:257
4080 #: ../src/guestfs.pod:2092
4082 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
4083 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
4084 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
4085 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
4086 ">, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4087 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4091 #: ../src/guestfs.pod:2115
4093 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
4094 "(8)>, L<disktype(1)>."
4098 #: ../src/guestfs.pod:2122 ../tools/virt-win-reg.pl:499
4099 #: ../tools/virt-make-fs.pl:548
4104 #: ../src/guestfs.pod:2124
4105 msgid "To get a list of bugs against libguestfs use this link:"
4109 #: ../src/guestfs.pod:2126
4111 "L<https://bugzilla.redhat.com/buglist.cgi?"
4112 "component=libguestfs&product=Virtualization+Tools>"
4116 #: ../src/guestfs.pod:2128
4117 msgid "To report a new bug against libguestfs use this link:"
4121 #: ../src/guestfs.pod:2130
4123 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
4124 "component=libguestfs&product=Virtualization+Tools>"
4128 #: ../src/guestfs.pod:2132
4129 msgid "When reporting a bug, please check:"
4133 #: ../src/guestfs.pod:2138
4134 msgid "That the bug hasn't been reported already."
4138 #: ../src/guestfs.pod:2142
4139 msgid "That you are testing a recent version."
4143 #: ../src/guestfs.pod:2146
4144 msgid "Describe the bug accurately, and give a way to reproduce it."
4148 #: ../src/guestfs.pod:2150
4150 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4155 #: ../src/guestfs.pod:2155 ../fish/guestfish.pod:1058
4156 #: ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4161 #: ../src/guestfs.pod:2157 ../fish/guestfish.pod:1060
4162 #: ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4163 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4167 #: ../src/guestfs.pod:2159 ../fish/guestfish.pod:1062
4168 #: ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248
4169 #: ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514
4170 #: ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206
4171 #: ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563
4172 #: ../tools/virt-list-partitions.pl:273
4177 #: ../src/guestfs.pod:2161 ../fish/guestfish.pod:1064
4178 #: ../fuse/guestmount.pod:250
4179 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4183 #: ../src/guestfs.pod:2164
4185 "This library is free software; you can redistribute it and/or modify it "
4186 "under the terms of the GNU Lesser General Public License as published by the "
4187 "Free Software Foundation; either version 2 of the License, or (at your "
4188 "option) any later version."
4192 #: ../src/guestfs.pod:2169
4194 "This library is distributed in the hope that it will be useful, but WITHOUT "
4195 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4196 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4201 #: ../src/guestfs.pod:2174
4203 "You should have received a copy of the GNU Lesser General Public License "
4204 "along with this library; if not, write to the Free Software Foundation, "
4205 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4209 #: ../src/guestfs-actions.pod:1
4210 msgid "guestfs_add_cdrom"
4214 #: ../src/guestfs-actions.pod:3
4218 " guestfs_add_cdrom (guestfs_h *g,\n"
4219 " const char *filename);\n"
4224 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4225 msgid "This function adds a virtual CD-ROM disk image to the guest."
4229 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4230 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4234 #: ../src/guestfs-actions.pod:17
4236 "This call checks for the existence of C<filename>. This stops you from "
4237 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4238 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4243 #: ../src/guestfs-actions.pod:24
4245 "If you just want to add an ISO file (often you use this as an efficient way "
4246 "to transfer large files into the guest), then you should probably use "
4247 "C<guestfs_add_drive_ro> instead."
4251 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:128
4252 #: ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226
4253 #: ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261
4254 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295
4255 #: ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430
4256 #: ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489
4257 #: ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535
4258 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635
4259 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664
4260 #: ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781
4261 #: ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
4262 #: ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990
4263 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092
4264 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129
4265 #: ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163
4266 #: ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264
4267 #: ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326
4268 #: ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466
4269 #: ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706
4270 #: ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2215
4271 #: ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2420
4272 #: ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3194
4273 #: ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3229
4274 #: ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3368
4275 #: ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3395
4276 #: ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3446
4277 #: ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3538
4278 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3578
4279 #: ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3633
4280 #: ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3671
4281 #: ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3718
4282 #: ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3770
4283 #: ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3798
4284 #: ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3908
4285 #: ../src/guestfs-actions.pod:3928 ../src/guestfs-actions.pod:3941
4286 #: ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4010
4287 #: ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4044
4288 #: ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4072
4289 #: ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104
4290 #: ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4173
4291 #: ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4223
4292 #: ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4254
4293 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:4284
4294 #: ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4314
4295 #: ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4364
4296 #: ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4398
4297 #: ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4464
4298 #: ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4515
4299 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4560
4300 #: ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4712
4301 #: ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4791
4302 #: ../src/guestfs-actions.pod:4809 ../src/guestfs-actions.pod:4841
4303 #: ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4924
4304 #: ../src/guestfs-actions.pod:4937 ../src/guestfs-actions.pod:4951
4305 #: ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5259
4306 #: ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5285
4307 #: ../src/guestfs-actions.pod:5299 ../src/guestfs-actions.pod:5311
4308 #: ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5341
4309 #: ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381
4310 #: ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5418
4311 #: ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5459
4312 #: ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5499
4313 #: ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5535
4314 #: ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5587
4315 #: ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5630
4316 #: ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5660
4317 #: ../src/guestfs-actions.pod:5679 ../src/guestfs-actions.pod:5716
4318 #: ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:5765
4319 #: ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5994
4320 #: ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6019
4321 #: ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6054
4322 #: ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6080
4323 #: ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6108
4324 #: ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6184
4325 #: ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6216
4326 #: ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6246
4327 #: ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6302
4328 #: ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6357
4329 #: ../src/guestfs-actions.pod:6370 ../src/guestfs-actions.pod:6388
4330 #: ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6458
4331 #: ../src/guestfs-actions.pod:6577 ../src/guestfs-actions.pod:6595
4332 #: ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6664
4333 #: ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6722
4334 #: ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6809
4335 #: ../src/guestfs-actions.pod:6835 ../src/guestfs-actions.pod:6901
4336 #: ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6949
4337 msgid "This function returns 0 on success or -1 on error."
4341 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242
4342 #: ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:28
4343 #: ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4345 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4350 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:245
4351 #: ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437
4352 #: ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944
4353 #: ../src/guestfs-actions.pod:6843 ../src/guestfs-actions.pod:7012
4354 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156
4355 #: ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951
4356 #: ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322
4357 #: ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4359 "Deprecated functions will not be removed from the API, but the fact that "
4360 "they are deprecated indicates that there are problems with correct use of "
4365 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:130
4366 #: ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895
4367 #: ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096
4368 #: ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3211
4369 #: ../src/guestfs-actions.pod:4351 ../src/guestfs-actions.pod:5420
4370 #: ../src/guestfs-actions.pod:5537 ../src/guestfs-actions.pod:5647
4371 #: ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6235
4372 #: ../src/guestfs-actions.pod:6757
4373 msgid "(Added in 0.3)"
4377 #: ../src/guestfs-actions.pod:41
4378 msgid "guestfs_add_domain"
4382 #: ../src/guestfs-actions.pod:43
4386 " guestfs_add_domain (guestfs_h *g,\n"
4387 " const char *dom,\n"
4393 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:139
4395 "You may supply a list of optional arguments to this call. Use zero or more "
4396 "of the following pairs of parameters, and terminate the list with C<-1> on "
4397 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4401 #: ../src/guestfs-actions.pod:53
4404 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4405 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4406 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4411 #: ../src/guestfs-actions.pod:57
4413 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4414 "It works by connecting to libvirt, requesting the domain and domain XML from "
4415 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4420 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4422 "The number of disks added is returned. This operation is atomic: if an "
4423 "error is returned, then no disks are added."
4427 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4429 "This function does some minimal checks to make sure the libvirt domain is "
4430 "not running (unless C<readonly> is true). In a future version we will try "
4431 "to acquire the libvirt lock on each disk."
4435 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4437 "Disks must be accessible locally. This often means that adding disks from a "
4438 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4439 "unless those disks are accessible via the same device path locally too."
4443 #: ../src/guestfs-actions.pod:74
4445 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
4446 "libvirt.org/uri.html>). If this is not set then we connect to the default "
4447 "libvirt URI (or one set through an environment variable, see the libvirt "
4448 "documentation for full details). If you are using the C API directly then "
4449 "it is more flexible to create the libvirt connection object yourself, get "
4450 "the domain object, and call C<guestfs_add_libvirt_dom>."
4454 #: ../src/guestfs-actions.pod:82
4456 "The other optional parameters are passed directly through to "
4457 "C<guestfs_add_drive_opts>."
4461 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:338
4462 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681
4463 #: ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730
4464 #: ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309
4465 #: ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866
4466 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005
4467 #: ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083
4468 #: ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2634
4469 #: ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:4487
4470 #: ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:5021
4471 #: ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:6343
4472 #: ../src/guestfs-actions.pod:6768 ../src/guestfs-actions.pod:6781
4473 #: ../src/guestfs-actions.pod:6794
4474 msgid "On error this function returns -1."
4478 #: ../src/guestfs-actions.pod:87
4479 msgid "(Added in 1.7.4)"
4483 #: ../src/guestfs-actions.pod:89
4484 msgid "guestfs_add_domain_va"
4488 #: ../src/guestfs-actions.pod:91
4492 " guestfs_add_domain_va (guestfs_h *g,\n"
4493 " const char *dom,\n"
4499 #: ../src/guestfs-actions.pod:96
4500 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4504 #: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109
4505 #: ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213
4506 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4510 #: ../src/guestfs-actions.pod:100
4511 msgid "guestfs_add_domain_argv"
4515 #: ../src/guestfs-actions.pod:102
4519 " guestfs_add_domain_argv (guestfs_h *g,\n"
4520 " const char *dom,\n"
4521 " const struct guestfs_add_domain_argv *optargs);\n"
4526 #: ../src/guestfs-actions.pod:107
4527 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4531 #: ../src/guestfs-actions.pod:111
4532 msgid "guestfs_add_drive"
4536 #: ../src/guestfs-actions.pod:113
4540 " guestfs_add_drive (guestfs_h *g,\n"
4541 " const char *filename);\n"
4546 #: ../src/guestfs-actions.pod:117
4548 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4549 "optional parameters, so the disk is added writable, with the format being "
4550 "detected automatically."
4554 #: ../src/guestfs-actions.pod:121
4556 "Automatic detection of the format opens you up to a potential security hole "
4557 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4558 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4559 "you should think about replacing calls to this function with calls to "
4560 "C<guestfs_add_drive_opts>, and specifying the format."
4564 #: ../src/guestfs-actions.pod:132
4565 msgid "guestfs_add_drive_opts"
4569 #: ../src/guestfs-actions.pod:134
4573 " guestfs_add_drive_opts (guestfs_h *g,\n"
4574 " const char *filename,\n"
4580 #: ../src/guestfs-actions.pod:144
4583 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4584 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4585 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4590 #: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92
4592 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4593 "The first time you call this function, the disk appears as C</dev/sda>, the "
4594 "second time as C</dev/sdb>, and so on."
4598 #: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97
4600 "You don't necessarily need to be root when using libguestfs. However you "
4601 "obviously do need sufficient permissions to access the filename for whatever "
4602 "operations you want to perform (ie. read access if you just want to read the "
4603 "image or write access if you want to modify the image)."
4607 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103
4608 msgid "This call checks that C<filename> exists."
4612 #: ../src/guestfs-actions.pod:161 ../fish/guestfish-actions.pod:105
4613 msgid "The optional arguments are:"
4617 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
4622 #: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111
4624 "If true then the image is treated as read-only. Writes are still allowed, "
4625 "but they are stored in a temporary snapshot overlay which is discarded at "
4626 "the end. The disk that you add is not modified."
4630 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115
4635 #: ../src/guestfs-actions.pod:173
4637 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4638 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4639 "Possible formats include C<raw> and C<qcow2>."
4643 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:121
4645 "Automatic detection of the format opens you up to a potential security hole "
4646 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4647 "RHBZ#642934. Specifying the format closes this security hole."
4651 #: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126
4656 #: ../src/guestfs-actions.pod:184
4658 "This rarely-used option lets you emulate the behaviour of the deprecated "
4659 "C<guestfs_add_drive_with_if> call (q.v.)"
4663 #: ../src/guestfs-actions.pod:191
4664 msgid "(Added in 1.5.23)"
4668 #: ../src/guestfs-actions.pod:193
4669 msgid "guestfs_add_drive_opts_va"
4673 #: ../src/guestfs-actions.pod:195
4677 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4678 " const char *filename,\n"
4684 #: ../src/guestfs-actions.pod:200
4685 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4689 #: ../src/guestfs-actions.pod:204
4690 msgid "guestfs_add_drive_opts_argv"
4694 #: ../src/guestfs-actions.pod:206
4698 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4699 " const char *filename,\n"
4700 " const struct guestfs_add_drive_opts_argv *optargs);\n"
4705 #: ../src/guestfs-actions.pod:211
4706 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4710 #: ../src/guestfs-actions.pod:215
4711 msgid "guestfs_add_drive_ro"
4715 #: ../src/guestfs-actions.pod:217
4719 " guestfs_add_drive_ro (guestfs_h *g,\n"
4720 " const char *filename);\n"
4725 #: ../src/guestfs-actions.pod:221
4727 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4728 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4729 "disk is added read-only, with the format being detected automatically."
4733 #: ../src/guestfs-actions.pod:228
4734 msgid "(Added in 1.0.38)"
4738 #: ../src/guestfs-actions.pod:230
4739 msgid "guestfs_add_drive_ro_with_if"
4743 #: ../src/guestfs-actions.pod:232
4747 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4748 " const char *filename,\n"
4749 " const char *iface);\n"
4754 #: ../src/guestfs-actions.pod:237
4756 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4757 "QEMU interface emulation to use at run time."
4761 #: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270
4762 #: ../src/guestfs-actions.pod:2305
4763 msgid "(Added in 1.0.84)"
4767 #: ../src/guestfs-actions.pod:251
4768 msgid "guestfs_add_drive_with_if"
4772 #: ../src/guestfs-actions.pod:253
4776 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4777 " const char *filename,\n"
4778 " const char *iface);\n"
4783 #: ../src/guestfs-actions.pod:258
4785 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4786 "QEMU interface emulation to use at run time."
4790 #: ../src/guestfs-actions.pod:272
4791 msgid "guestfs_aug_clear"
4795 #: ../src/guestfs-actions.pod:274
4799 " guestfs_aug_clear (guestfs_h *g,\n"
4800 " const char *augpath);\n"
4805 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178
4807 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4808 "L<augtool(1)> C<clear> command."
4812 #: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085
4813 msgid "(Added in 1.3.4)"
4817 #: ../src/guestfs-actions.pod:285
4818 msgid "guestfs_aug_close"
4822 #: ../src/guestfs-actions.pod:287
4826 " guestfs_aug_close (guestfs_h *g);\n"
4831 #: ../src/guestfs-actions.pod:290
4833 "Close the current Augeas handle and free up any resources used by it. After "
4834 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4835 "any other Augeas functions."
4839 #: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322
4840 #: ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354
4841 #: ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432
4842 #: ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477
4843 #: ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505
4844 #: ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537
4845 #: ../src/guestfs-actions.pod:5098
4846 msgid "(Added in 0.7)"
4850 #: ../src/guestfs-actions.pod:299
4851 msgid "guestfs_aug_defnode"
4855 #: ../src/guestfs-actions.pod:301
4858 " struct guestfs_int_bool *\n"
4859 " guestfs_aug_defnode (guestfs_h *g,\n"
4860 " const char *name,\n"
4861 " const char *expr,\n"
4862 " const char *val);\n"
4867 #: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194
4869 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4873 #: ../src/guestfs-actions.pod:310
4875 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4876 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4877 "containing that single node."
4881 #: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201
4883 "On success this returns a pair containing the number of nodes in the "
4884 "nodeset, and a boolean flag if a node was created."
4888 #: ../src/guestfs-actions.pod:318
4890 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4891 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4895 #: ../src/guestfs-actions.pod:324
4896 msgid "guestfs_aug_defvar"
4900 #: ../src/guestfs-actions.pod:326
4904 " guestfs_aug_defvar (guestfs_h *g,\n"
4905 " const char *name,\n"
4906 " const char *expr);\n"
4911 #: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209
4913 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4914 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4918 #: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213
4920 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4921 "evaluates to something which is not a nodeset."
4925 #: ../src/guestfs-actions.pod:342
4926 msgid "guestfs_aug_get"
4930 #: ../src/guestfs-actions.pod:344
4934 " guestfs_aug_get (guestfs_h *g,\n"
4935 " const char *augpath);\n"
4940 #: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220
4942 "Look up the value associated with C<path>. If C<path> matches exactly one "
4943 "node, the C<value> is returned."
4947 #: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851
4948 #: ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929
4949 #: ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048
4950 #: ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195
4951 #: ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343
4952 #: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646
4953 #: ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826
4954 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938
4955 #: ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2270
4956 #: ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2558
4957 #: ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:2716
4958 #: ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2771
4959 #: ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2856
4960 #: ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3690
4961 #: ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3970
4962 #: ../src/guestfs-actions.pod:4633 ../src/guestfs-actions.pod:4826
4963 #: ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5174
4964 #: ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5786
4965 #: ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5819
4966 #: ../src/guestfs-actions.pod:5843 ../src/guestfs-actions.pod:6517
4967 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6554
4968 #: ../src/guestfs-actions.pod:6734 ../src/guestfs-actions.pod:7006
4970 "This function returns a string, or NULL on error. I<The caller must free "
4971 "the returned string after use>."
4975 #: ../src/guestfs-actions.pod:356
4976 msgid "guestfs_aug_init"
4980 #: ../src/guestfs-actions.pod:358
4984 " guestfs_aug_init (guestfs_h *g,\n"
4985 " const char *root,\n"
4991 #: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227
4993 "Create a new Augeas handle for editing configuration files. If there was "
4994 "any previous Augeas handle associated with this guestfs session, then it is "
4999 #: ../src/guestfs-actions.pod:367
5000 msgid "You must call this before using any other C<guestfs_aug_*> commands."
5004 #: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234
5006 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5010 #: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237
5012 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5013 "logical I<or> of the following integers:"
5017 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
5018 msgid "C<AUG_SAVE_BACKUP> = 1"
5022 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
5023 msgid "Keep the original file with a C<.augsave> extension."
5027 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
5028 msgid "C<AUG_SAVE_NEWFILE> = 2"
5032 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249
5034 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5035 "original. Overrides C<AUG_SAVE_BACKUP>."
5039 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
5040 msgid "C<AUG_TYPE_CHECK> = 4"
5044 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
5045 msgid "Typecheck lenses (can be expensive)."
5049 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
5050 msgid "C<AUG_NO_STDINC> = 8"
5054 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
5055 msgid "Do not use standard load path for modules."
5059 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
5060 msgid "C<AUG_SAVE_NOOP> = 16"
5064 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
5065 msgid "Make save a no-op, just record what would have been changed."
5069 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264
5070 msgid "C<AUG_NO_LOAD> = 32"
5074 #: ../src/guestfs-actions.pod:402
5075 msgid "Do not load the tree in C<guestfs_aug_init>."
5079 #: ../src/guestfs-actions.pod:406
5080 msgid "To close the handle, you can call C<guestfs_aug_close>."
5084 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272
5085 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5089 #: ../src/guestfs-actions.pod:414
5090 msgid "guestfs_aug_insert"
5094 #: ../src/guestfs-actions.pod:416
5098 " guestfs_aug_insert (guestfs_h *g,\n"
5099 " const char *augpath,\n"
5100 " const char *label,\n"
5106 #: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278
5108 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5109 "or after C<path> (depending on the boolean flag C<before>)."
5113 #: ../src/guestfs-actions.pod:426 ../fish/guestfish-actions.pod:282
5115 "C<path> must match exactly one existing node in the tree, and C<label> must "
5116 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5120 #: ../src/guestfs-actions.pod:434
5121 msgid "guestfs_aug_load"
5125 #: ../src/guestfs-actions.pod:436
5129 " guestfs_aug_load (guestfs_h *g);\n"
5134 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
5135 msgid "Load files into the tree."
5139 #: ../src/guestfs-actions.pod:441 ../fish/guestfish-actions.pod:292
5140 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5144 #: ../src/guestfs-actions.pod:448
5145 msgid "guestfs_aug_ls"
5149 #: ../src/guestfs-actions.pod:450
5153 " guestfs_aug_ls (guestfs_h *g,\n"
5154 " const char *augpath);\n"
5159 #: ../src/guestfs-actions.pod:454
5161 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
5162 "sorting the resulting nodes into alphabetical order."
5166 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:473
5167 #: ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:1067
5168 #: ../src/guestfs-actions.pod:1358 ../src/guestfs-actions.pod:1377
5169 #: ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1499
5170 #: ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2150
5171 #: ../src/guestfs-actions.pod:2166 ../src/guestfs-actions.pod:2185
5172 #: ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:2252
5173 #: ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2372
5174 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2790
5175 #: ../src/guestfs-actions.pod:3005 ../src/guestfs-actions.pod:3260
5176 #: ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3427
5177 #: ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:4448
5178 #: ../src/guestfs-actions.pod:4968 ../src/guestfs-actions.pod:5094
5179 #: ../src/guestfs-actions.pod:5208 ../src/guestfs-actions.pod:5859
5180 #: ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:5975
5181 #: ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6145
5182 #: ../src/guestfs-actions.pod:6627 ../src/guestfs-actions.pod:6647
5183 #: ../src/guestfs-actions.pod:6694 ../src/guestfs-actions.pod:6859
5184 #: ../src/guestfs-actions.pod:6878 ../src/guestfs-actions.pod:6963
5185 #: ../src/guestfs-actions.pod:6982 ../src/guestfs-actions.pod:7028
5186 #: ../src/guestfs-actions.pod:7047
5188 "This function returns a NULL-terminated array of strings (like L<environ(3)"
5189 ">), or NULL if there was an error. I<The caller must free the strings and "
5190 "the array after use>."
5194 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:992
5195 #: ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:1415
5196 #: ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3114
5197 #: ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3723
5198 #: ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3943
5199 #: ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4452
5200 #: ../src/guestfs-actions.pod:4909 ../src/guestfs-actions.pod:5287
5201 #: ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:5313
5202 #: ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:6359
5203 #: ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6611
5204 #: ../src/guestfs-actions.pod:6814 ../src/guestfs-actions.pod:6847
5205 msgid "(Added in 0.8)"
5209 #: ../src/guestfs-actions.pod:463
5210 msgid "guestfs_aug_match"
5214 #: ../src/guestfs-actions.pod:465
5218 " guestfs_aug_match (guestfs_h *g,\n"
5219 " const char *augpath);\n"
5224 #: ../src/guestfs-actions.pod:469 ../fish/guestfish-actions.pod:306
5226 "Returns a list of paths which match the path expression C<path>. The "
5227 "returned paths are sufficiently qualified so that they match exactly one "
5228 "node in the current tree."
5232 #: ../src/guestfs-actions.pod:479
5233 msgid "guestfs_aug_mv"
5237 #: ../src/guestfs-actions.pod:481
5241 " guestfs_aug_mv (guestfs_h *g,\n"
5242 " const char *src,\n"
5243 " const char *dest);\n"
5248 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:314
5250 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5251 "C<dest> is overwritten if it exists."
5255 #: ../src/guestfs-actions.pod:493
5256 msgid "guestfs_aug_rm"
5260 #: ../src/guestfs-actions.pod:495
5264 " guestfs_aug_rm (guestfs_h *g,\n"
5265 " const char *augpath);\n"
5270 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5271 msgid "Remove C<path> and all of its children."
5275 #: ../src/guestfs-actions.pod:501 ../fish/guestfish-actions.pod:323
5276 msgid "On success this returns the number of entries which were removed."
5280 #: ../src/guestfs-actions.pod:507
5281 msgid "guestfs_aug_save"
5285 #: ../src/guestfs-actions.pod:509
5289 " guestfs_aug_save (guestfs_h *g);\n"
5294 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:329
5295 msgid "This writes all pending changes to disk."
5299 #: ../src/guestfs-actions.pod:514
5301 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5306 #: ../src/guestfs-actions.pod:521
5307 msgid "guestfs_aug_set"
5311 #: ../src/guestfs-actions.pod:523
5315 " guestfs_aug_set (guestfs_h *g,\n"
5316 " const char *augpath,\n"
5317 " const char *val);\n"
5322 #: ../src/guestfs-actions.pod:528 ../fish/guestfish-actions.pod:338
5323 msgid "Set the value associated with C<path> to C<val>."
5327 #: ../src/guestfs-actions.pod:530
5329 "In the Augeas API, it is possible to clear a node by setting the value to "
5330 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5331 "this call. Instead you must use the C<guestfs_aug_clear> call."
5335 #: ../src/guestfs-actions.pod:539
5336 msgid "guestfs_available"
5340 #: ../src/guestfs-actions.pod:541
5344 " guestfs_available (guestfs_h *g,\n"
5345 " char *const *groups);\n"
5350 #: ../src/guestfs-actions.pod:545 ../fish/guestfish-actions.pod:349
5352 "This command is used to check the availability of some groups of "
5353 "functionality in the appliance, which not all builds of the libguestfs "
5354 "appliance will be able to provide."
5358 #: ../src/guestfs-actions.pod:549
5360 "The libguestfs groups, and the functions that those groups correspond to, "
5361 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5362 "runtime by calling C<guestfs_available_all_groups>."
5366 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:358
5368 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
5369 "\"]> would check for the availability of the Linux inotify functions and "
5370 "Augeas (configuration file editing) functions."
5374 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5375 msgid "The command returns no error if I<all> requested groups are available."
5379 #: ../src/guestfs-actions.pod:561 ../fish/guestfish-actions.pod:365
5381 "It fails with an error if one or more of the requested groups is unavailable "
5386 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5388 "If an unknown group name is included in the list of groups then an error is "
5393 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5398 #: ../src/guestfs-actions.pod:573
5399 msgid "You must call C<guestfs_launch> before calling this function."
5403 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:379
5405 "The reason is because we don't know what groups are supported by the "
5406 "appliance/daemon until it is running and can be queried."
5410 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:385
5412 "If a group of functions is available, this does not necessarily mean that "
5413 "they will work. You still have to check for errors when calling individual "
5414 "API functions even if they are available."
5418 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:392
5420 "It is usually the job of distro packagers to build complete functionality "
5421 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5422 "with all requirements satisfied, will support everything."
5426 #: ../src/guestfs-actions.pod:595
5428 "This call was added in version C<1.0.80>. In previous versions of "
5429 "libguestfs all you could do would be to speculatively execute a command to "
5430 "find out if the daemon implemented it. See also C<guestfs_version>."
5434 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1165
5435 msgid "(Added in 1.0.80)"
5439 #: ../src/guestfs-actions.pod:606
5440 msgid "guestfs_available_all_groups"
5444 #: ../src/guestfs-actions.pod:608
5448 " guestfs_available_all_groups (guestfs_h *g);\n"
5453 #: ../src/guestfs-actions.pod:611
5455 "This command returns a list of all optional groups that this daemon knows "
5456 "about. Note this returns both supported and unsupported groups. To find "
5457 "out which ones the daemon can actually support you have to call "
5458 "C<guestfs_available> on each member of the returned list."
5462 #: ../src/guestfs-actions.pod:617
5463 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5467 #: ../src/guestfs-actions.pod:623
5468 msgid "(Added in 1.3.15)"
5472 #: ../src/guestfs-actions.pod:625
5473 msgid "guestfs_base64_in"
5477 #: ../src/guestfs-actions.pod:627
5481 " guestfs_base64_in (guestfs_h *g,\n"
5482 " const char *base64file,\n"
5483 " const char *filename);\n"
5488 #: ../src/guestfs-actions.pod:632 ../fish/guestfish-actions.pod:422
5490 "This command uploads base64-encoded data from C<base64file> to C<filename>."
5494 #: ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:651
5495 msgid "(Added in 1.3.5)"
5499 #: ../src/guestfs-actions.pod:639
5500 msgid "guestfs_base64_out"
5504 #: ../src/guestfs-actions.pod:641
5508 " guestfs_base64_out (guestfs_h *g,\n"
5509 " const char *filename,\n"
5510 " const char *base64file);\n"
5515 #: ../src/guestfs-actions.pod:646 ../fish/guestfish-actions.pod:431
5517 "This command downloads the contents of C<filename>, writing it out to local "
5518 "file C<base64file> encoded as base64."
5522 #: ../src/guestfs-actions.pod:653
5523 msgid "guestfs_blockdev_flushbufs"
5527 #: ../src/guestfs-actions.pod:655
5531 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5532 " const char *device);\n"
5537 #: ../src/guestfs-actions.pod:659 ../fish/guestfish-actions.pod:440
5539 "This tells the kernel to flush internal buffers associated with C<device>."
5543 #: ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:679
5544 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:710
5545 #: ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747
5546 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779
5547 #: ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807
5548 #: ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454
5549 #: ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473
5550 #: ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498
5551 #: ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517
5552 #: ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5553 msgid "This uses the L<blockdev(8)> command."
5557 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:683
5558 #: ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:714
5559 #: ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:751
5560 #: ../src/guestfs-actions.pod:765 ../src/guestfs-actions.pod:783
5561 #: ../src/guestfs-actions.pod:797 ../src/guestfs-actions.pod:811
5562 msgid "(Added in 0.9.3)"
5566 #: ../src/guestfs-actions.pod:668
5567 msgid "guestfs_blockdev_getbsz"
5571 #: ../src/guestfs-actions.pod:670
5575 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5576 " const char *device);\n"
5581 #: ../src/guestfs-actions.pod:674 ../fish/guestfish-actions.pod:449
5582 msgid "This returns the block size of a device."
5586 #: ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:776
5587 #: ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5589 "(Note this is different from both I<size in blocks> and I<filesystem block "
5594 #: ../src/guestfs-actions.pod:685
5595 msgid "guestfs_blockdev_getro"
5599 #: ../src/guestfs-actions.pod:687
5603 " guestfs_blockdev_getro (guestfs_h *g,\n"
5604 " const char *device);\n"
5609 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:460
5611 "Returns a boolean indicating if the block device is read-only (true if read-"
5612 "only, false if not)."
5616 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:1398
5617 #: ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1893
5618 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976
5619 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046
5620 #: ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094
5621 #: ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3036
5622 #: ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065
5623 #: ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3096
5624 #: ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3126
5625 #: ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3153
5626 #: ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3183
5627 #: ../src/guestfs-actions.pod:4597
5628 msgid "This function returns a C truth value on success or -1 on error."
5632 #: ../src/guestfs-actions.pod:700
5633 msgid "guestfs_blockdev_getsize64"
5637 #: ../src/guestfs-actions.pod:702
5641 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5642 " const char *device);\n"
5647 #: ../src/guestfs-actions.pod:706 ../fish/guestfish-actions.pod:469
5648 msgid "This returns the size of the device in bytes."
5652 #: ../src/guestfs-actions.pod:708
5653 msgid "See also C<guestfs_blockdev_getsz>."
5657 #: ../src/guestfs-actions.pod:716
5658 msgid "guestfs_blockdev_getss"
5662 #: ../src/guestfs-actions.pod:718
5666 " guestfs_blockdev_getss (guestfs_h *g,\n"
5667 " const char *device);\n"
5672 #: ../src/guestfs-actions.pod:722 ../fish/guestfish-actions.pod:479
5674 "This returns the size of sectors on a block device. Usually 512, but can be "
5675 "larger for modern devices."
5679 #: ../src/guestfs-actions.pod:725
5681 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5686 #: ../src/guestfs-actions.pod:734
5687 msgid "guestfs_blockdev_getsz"
5691 #: ../src/guestfs-actions.pod:736
5695 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5696 " const char *device);\n"
5701 #: ../src/guestfs-actions.pod:740 ../fish/guestfish-actions.pod:491
5703 "This returns the size of the device in units of 512-byte sectors (even if "
5704 "the sectorsize isn't 512 bytes ... weird)."
5708 #: ../src/guestfs-actions.pod:743
5710 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5711 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5715 #: ../src/guestfs-actions.pod:753
5716 msgid "guestfs_blockdev_rereadpt"
5720 #: ../src/guestfs-actions.pod:755
5724 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5725 " const char *device);\n"
5730 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:504
5731 msgid "Reread the partition table on C<device>."
5735 #: ../src/guestfs-actions.pod:767
5736 msgid "guestfs_blockdev_setbsz"
5740 #: ../src/guestfs-actions.pod:769
5744 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5745 " const char *device,\n"
5746 " int blocksize);\n"
5751 #: ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:512
5752 msgid "This sets the block size of a device."
5756 #: ../src/guestfs-actions.pod:785
5757 msgid "guestfs_blockdev_setro"
5761 #: ../src/guestfs-actions.pod:787
5765 " guestfs_blockdev_setro (guestfs_h *g,\n"
5766 " const char *device);\n"
5771 #: ../src/guestfs-actions.pod:791 ../fish/guestfish-actions.pod:523
5772 msgid "Sets the block device named C<device> to read-only."
5776 #: ../src/guestfs-actions.pod:799
5777 msgid "guestfs_blockdev_setrw"
5781 #: ../src/guestfs-actions.pod:801
5785 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5786 " const char *device);\n"
5791 #: ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:531
5792 msgid "Sets the block device named C<device> to read-write."
5796 #: ../src/guestfs-actions.pod:813
5797 msgid "guestfs_case_sensitive_path"
5801 #: ../src/guestfs-actions.pod:815
5805 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5806 " const char *path);\n"
5811 #: ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:539
5813 "This can be used to resolve case insensitive paths on a filesystem which is "
5814 "case sensitive. The use case is to resolve paths which you have read from "
5815 "Windows configuration files or the Windows Registry, to the true path."
5819 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:544
5821 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5822 "(and probably others), which is that although the underlying filesystem is "
5823 "case-insensitive, the driver exports the filesystem to Linux as case-"
5828 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:549
5830 "One consequence of this is that special directories such as C<c:\\windows> "
5831 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5832 "precise details of how they were created. In Windows itself this would not "
5837 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:555
5839 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
5844 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
5846 "This function resolves the true case of each element in the path and returns "
5847 "the case-sensitive path."
5851 #: ../src/guestfs-actions.pod:841
5853 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
5854 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5855 "how the directories were originally created under Windows)."
5859 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:566
5860 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5864 #: ../src/guestfs-actions.pod:849
5865 msgid "See also C<guestfs_realpath>."
5869 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:6539
5870 msgid "(Added in 1.0.75)"
5874 #: ../src/guestfs-actions.pod:856
5879 #: ../src/guestfs-actions.pod:858
5883 " guestfs_cat (guestfs_h *g,\n"
5884 " const char *path);\n"
5889 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:5084
5890 #: ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5891 msgid "Return the contents of the file named C<path>."
5895 #: ../src/guestfs-actions.pod:864
5897 "Note that this function cannot correctly handle binary files (specifically, "
5898 "files containing C<\\0> character which is treated as end of string). For "
5899 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5900 "functions which have a more complex interface."
5904 #: ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:1051
5905 #: ../src/guestfs-actions.pod:1071 ../src/guestfs-actions.pod:1362
5906 #: ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1484
5907 #: ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1752
5908 #: ../src/guestfs-actions.pod:2170 ../src/guestfs-actions.pod:2189
5909 #: ../src/guestfs-actions.pod:2232 ../src/guestfs-actions.pod:2256
5910 #: ../src/guestfs-actions.pod:2273 ../src/guestfs-actions.pod:2302
5911 #: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4892
5912 #: ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5049
5913 #: ../src/guestfs-actions.pod:5073 ../src/guestfs-actions.pod:5924
5914 #: ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6125
5915 #: ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6811
5916 #: ../src/guestfs-actions.pod:6837 ../src/guestfs-actions.pod:6863
5917 #: ../src/guestfs-actions.pod:6882 ../src/guestfs-actions.pod:6967
5918 #: ../src/guestfs-actions.pod:6986 ../src/guestfs-actions.pod:7032
5919 #: ../src/guestfs-actions.pod:7051 ../fish/guestfish-actions.pod:582
5920 #: ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729
5921 #: ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915
5922 #: ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992
5923 #: ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462
5924 #: ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500
5925 #: ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525
5926 #: ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263
5927 #: ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354
5928 #: ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386
5929 #: ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015
5930 #: ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115
5931 #: ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543
5932 #: ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570
5933 #: ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628
5934 #: ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5936 "Because of the message protocol, there is a transfer limit of somewhere "
5937 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5941 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:3264
5942 #: ../src/guestfs-actions.pod:3326 ../src/guestfs-actions.pod:3343
5943 #: ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3836
5944 #: ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:4972
5945 #: ../src/guestfs-actions.pod:4986 ../src/guestfs-actions.pod:6698
5946 #: ../src/guestfs-actions.pod:6712
5947 msgid "(Added in 0.4)"
5951 #: ../src/guestfs-actions.pod:877
5952 msgid "guestfs_checksum"
5956 #: ../src/guestfs-actions.pod:879
5960 " guestfs_checksum (guestfs_h *g,\n"
5961 " const char *csumtype,\n"
5962 " const char *path);\n"
5967 #: ../src/guestfs-actions.pod:884 ../fish/guestfish-actions.pod:589
5969 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5973 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
5975 "The type of checksum to compute is given by the C<csumtype> parameter which "
5976 "must have one of the following values:"
5980 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
5985 #: ../src/guestfs-actions.pod:894 ../fish/guestfish-actions.pod:599
5987 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5992 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
5997 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
5998 msgid "Compute the MD5 hash (using the C<md5sum> program)."
6002 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
6007 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
6008 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
6012 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
6017 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
6018 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
6022 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
6027 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
6028 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
6032 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
6037 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
6038 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
6042 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
6047 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:624
6048 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
6052 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:628
6053 msgid "The checksum is returned as a printable string."
6057 #: ../src/guestfs-actions.pod:925
6058 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
6062 #: ../src/guestfs-actions.pod:927
6063 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
6067 #: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:1240
6068 #: ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3038
6069 #: ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3128
6070 #: ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:6395
6071 msgid "(Added in 1.0.2)"
6075 #: ../src/guestfs-actions.pod:934
6076 msgid "guestfs_checksum_device"
6080 #: ../src/guestfs-actions.pod:936
6084 " guestfs_checksum_device (guestfs_h *g,\n"
6085 " const char *csumtype,\n"
6086 " const char *device);\n"
6091 #: ../src/guestfs-actions.pod:941
6093 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
6094 "device named C<device>. For the types of checksums supported see the "
6095 "C<guestfs_checksum> command."
6099 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:4503
6100 #: ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4599
6101 #: ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4793
6102 #: ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6318
6103 #: ../src/guestfs-actions.pod:6724
6104 msgid "(Added in 1.3.2)"
6108 #: ../src/guestfs-actions.pod:950
6109 msgid "guestfs_checksums_out"
6113 #: ../src/guestfs-actions.pod:952
6117 " guestfs_checksums_out (guestfs_h *g,\n"
6118 " const char *csumtype,\n"
6119 " const char *directory,\n"
6120 " const char *sumsfile);\n"
6125 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:646
6127 "This command computes the checksums of all regular files in C<directory> and "
6128 "then emits a list of those checksums to the local output file C<sumsfile>."
6132 #: ../src/guestfs-actions.pod:962 ../fish/guestfish-actions.pod:650
6134 "This can be used for verifying the integrity of a virtual machine. However "
6135 "to be properly secure you should pay attention to the output of the checksum "
6136 "command (it uses the ones from GNU coreutils). In particular when the "
6137 "filename is not printable, coreutils uses a special backslash syntax. For "
6138 "more information, see the GNU coreutils info file."
6142 #: ../src/guestfs-actions.pod:972
6143 msgid "(Added in 1.3.7)"
6147 #: ../src/guestfs-actions.pod:974
6148 msgid "guestfs_chmod"
6152 #: ../src/guestfs-actions.pod:976
6156 " guestfs_chmod (guestfs_h *g,\n"
6158 " const char *path);\n"
6163 #: ../src/guestfs-actions.pod:981 ../fish/guestfish-actions.pod:664
6165 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
6170 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
6172 "I<Note>: When using this command from guestfish, C<mode> by default would be "
6173 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
6178 #: ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:4087
6179 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4221
6180 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:671
6181 #: ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838
6182 #: ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
6183 msgid "The mode actually set is affected by the umask."
6187 #: ../src/guestfs-actions.pod:994
6188 msgid "guestfs_chown"
6192 #: ../src/guestfs-actions.pod:996
6196 " guestfs_chown (guestfs_h *g,\n"
6199 " const char *path);\n"
6204 #: ../src/guestfs-actions.pod:1002 ../fish/guestfish-actions.pod:677
6205 msgid "Change the file owner to C<owner> and group to C<group>."
6209 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:3225
6210 #: ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
6212 "Only numeric uid and gid are supported. If you want to use names, you will "
6213 "need to locate and parse the password file yourself (Augeas support makes "
6214 "this relatively easy)."
6218 #: ../src/guestfs-actions.pod:1012
6219 msgid "guestfs_command"
6223 #: ../src/guestfs-actions.pod:1014
6227 " guestfs_command (guestfs_h *g,\n"
6228 " char *const *arguments);\n"
6233 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:687
6235 "This call runs a command from the guest filesystem. The filesystem must be "
6236 "mounted, and must contain a compatible operating system (ie. something "
6237 "Linux, with the same or compatible processor architecture)."
6241 #: ../src/guestfs-actions.pod:1023
6243 "The single parameter is an argv-style list of arguments. The first element "
6244 "is the name of the program to run. Subsequent elements are parameters. The "
6245 "list must be non-empty (ie. must contain a program name). Note that the "
6246 "command runs directly, and is I<not> invoked via the shell (see "
6251 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:699
6252 msgid "The return value is anything printed to I<stdout> by the command."
6256 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
6258 "If the command returns a non-zero exit status, then this function returns an "
6259 "error message. The error message string is the content of I<stderr> from "
6264 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:706
6266 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
6267 "bin>. If you require a program from another location, you should provide "
6268 "the full path in the first parameter."
6272 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:711
6274 "Shared libraries and data files required by the program must be available on "
6275 "filesystems which are mounted in the correct places. It is the caller's "
6276 "responsibility to ensure all filesystems that are needed are mounted at the "
6281 #: ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074
6282 #: ../src/guestfs-actions.pod:1537
6283 msgid "(Added in 0.9.1)"
6287 #: ../src/guestfs-actions.pod:1056
6288 msgid "guestfs_command_lines"
6292 #: ../src/guestfs-actions.pod:1058
6296 " guestfs_command_lines (guestfs_h *g,\n"
6297 " char *const *arguments);\n"
6302 #: ../src/guestfs-actions.pod:1062
6304 "This is the same as C<guestfs_command>, but splits the result into a list of "
6309 #: ../src/guestfs-actions.pod:1065
6310 msgid "See also: C<guestfs_sh_lines>"
6314 #: ../src/guestfs-actions.pod:1076
6315 msgid "guestfs_config"
6319 #: ../src/guestfs-actions.pod:1078
6323 " guestfs_config (guestfs_h *g,\n"
6324 " const char *qemuparam,\n"
6325 " const char *qemuvalue);\n"
6330 #: ../src/guestfs-actions.pod:1083 ../fish/guestfish-actions.pod:736
6332 "This can be used to add arbitrary qemu command line parameters of the form "
6333 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6334 "setting some parameters which would interfere with parameters that we use."
6338 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6339 msgid "The first character of C<param> string must be a C<-> (dash)."
6343 #: ../src/guestfs-actions.pod:1090 ../fish/guestfish-actions.pod:743
6344 msgid "C<value> can be NULL."
6348 #: ../src/guestfs-actions.pod:1096
6349 msgid "guestfs_copy_size"
6353 #: ../src/guestfs-actions.pod:1098
6357 " guestfs_copy_size (guestfs_h *g,\n"
6358 " const char *src,\n"
6359 " const char *dest,\n"
6365 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:749
6367 "This command copies exactly C<size> bytes from one source device or file "
6368 "C<src> to another destination device or file C<dest>."
6372 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6374 "Note this will fail if the source is too short or if the destination is not "
6379 #: ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1235
6380 #: ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1686
6381 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6390
6382 #: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6903
6383 #: ../src/guestfs-actions.pod:6922
6385 "This long-running command can generate progress notification messages so "
6386 "that the caller can display a progress bar or indicator. To receive these "
6387 "messages, the caller must register a progress callback. See L<guestfs(3)/"
6388 "guestfs_set_progress_callback>."
6392 #: ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:3863
6393 #: ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:6631
6394 #: ../src/guestfs-actions.pod:6651 ../src/guestfs-actions.pod:6737
6395 msgid "(Added in 1.0.87)"
6399 #: ../src/guestfs-actions.pod:1119
6404 #: ../src/guestfs-actions.pod:1121
6408 " guestfs_cp (guestfs_h *g,\n"
6409 " const char *src,\n"
6410 " const char *dest);\n"
6415 #: ../src/guestfs-actions.pod:1126 ../fish/guestfish-actions.pod:759
6417 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6418 "destination filename or destination directory."
6422 #: ../src/guestfs-actions.pod:1131 ../src/guestfs-actions.pod:1145
6423 #: ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1291
6424 #: ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:4466
6425 #: ../src/guestfs-actions.pod:4843
6426 msgid "(Added in 1.0.18)"
6430 #: ../src/guestfs-actions.pod:1133
6431 msgid "guestfs_cp_a"
6435 #: ../src/guestfs-actions.pod:1135
6439 " guestfs_cp_a (guestfs_h *g,\n"
6440 " const char *src,\n"
6441 " const char *dest);\n"
6446 #: ../src/guestfs-actions.pod:1140 ../fish/guestfish-actions.pod:766
6448 "This copies a file or directory from C<src> to C<dest> recursively using the "
6453 #: ../src/guestfs-actions.pod:1147
6458 #: ../src/guestfs-actions.pod:1149
6462 " guestfs_dd (guestfs_h *g,\n"
6463 " const char *src,\n"
6464 " const char *dest);\n"
6469 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:773
6471 "This command copies from one source device or file C<src> to another "
6472 "destination device or file C<dest>. Normally you would use this to copy to "
6473 "or from a device or partition, for example to duplicate a filesystem."
6477 #: ../src/guestfs-actions.pod:1159
6479 "If the destination is a device, it must be as large or larger than the "
6480 "source file or device, otherwise the copy will fail. This command cannot do "
6481 "partial copies (see C<guestfs_copy_size>)."
6485 #: ../src/guestfs-actions.pod:1167
6490 #: ../src/guestfs-actions.pod:1169
6494 " guestfs_df (guestfs_h *g);\n"
6499 #: ../src/guestfs-actions.pod:1172 ../fish/guestfish-actions.pod:786
6500 msgid "This command runs the C<df> command to report disk space used."
6504 #: ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1191
6505 #: ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6507 "This command is mostly useful for interactive sessions. It is I<not> "
6508 "intended that you try to parse the output string. Use C<statvfs> from "
6513 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198
6514 #: ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:2235
6515 #: ../src/guestfs-actions.pod:2259 ../src/guestfs-actions.pod:2327
6516 #: ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4366
6517 #: ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6152
6518 #: ../src/guestfs-actions.pod:6770 ../src/guestfs-actions.pod:6783
6519 #: ../src/guestfs-actions.pod:6796
6520 msgid "(Added in 1.0.54)"
6524 #: ../src/guestfs-actions.pod:1183
6525 msgid "guestfs_df_h"
6529 #: ../src/guestfs-actions.pod:1185
6533 " guestfs_df_h (guestfs_h *g);\n"
6538 #: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:796
6540 "This command runs the C<df -h> command to report disk space used in human-"
6545 #: ../src/guestfs-actions.pod:1200
6546 msgid "guestfs_dmesg"
6550 #: ../src/guestfs-actions.pod:1202
6554 " guestfs_dmesg (guestfs_h *g);\n"
6559 #: ../src/guestfs-actions.pod:1205 ../fish/guestfish-actions.pod:807
6561 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6562 "This is sometimes useful for extended debugging of problems."
6566 #: ../src/guestfs-actions.pod:1209
6568 "Another way to get the same information is to enable verbose messages with "
6569 "C<guestfs_set_verbose> or by setting the environment variable "
6570 "C<LIBGUESTFS_DEBUG=1> before running the program."
6574 #: ../src/guestfs-actions.pod:1219
6575 msgid "guestfs_download"
6579 #: ../src/guestfs-actions.pod:1221
6583 " guestfs_download (guestfs_h *g,\n"
6584 " const char *remotefilename,\n"
6585 " const char *filename);\n"
6590 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1251
6591 #: ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6593 "Download file C<remotefilename> and save it as C<filename> on the local "
6598 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:6384
6599 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6600 msgid "C<filename> can also be a named pipe."
6604 #: ../src/guestfs-actions.pod:1231
6605 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6609 #: ../src/guestfs-actions.pod:1242
6610 msgid "guestfs_download_offset"
6614 #: ../src/guestfs-actions.pod:1244
6618 " guestfs_download_offset (guestfs_h *g,\n"
6619 " const char *remotefilename,\n"
6620 " const char *filename,\n"
6621 " int64_t offset,\n"
6627 #: ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:836
6629 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6630 "region must be within the file or device)."
6634 #: ../src/guestfs-actions.pod:1257
6636 "Note that there is no limit on the amount of data that can be downloaded "
6637 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6638 "full amount unless an error occurs."
6642 #: ../src/guestfs-actions.pod:1262
6643 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6647 #: ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:6429
6648 msgid "(Added in 1.5.17)"
6652 #: ../src/guestfs-actions.pod:1273
6653 msgid "guestfs_drop_caches"
6657 #: ../src/guestfs-actions.pod:1275
6661 " guestfs_drop_caches (guestfs_h *g,\n"
6662 " int whattodrop);\n"
6667 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:852
6669 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6670 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6671 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6675 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
6676 msgid "Setting C<whattodrop> to 3 should drop everything."
6680 #: ../src/guestfs-actions.pod:1286 ../fish/guestfish-actions.pod:859
6682 "This automatically calls L<sync(2)> before the operation, so that the "
6683 "maximum guest memory is freed."
6687 #: ../src/guestfs-actions.pod:1293
6692 #: ../src/guestfs-actions.pod:1295
6696 " guestfs_du (guestfs_h *g,\n"
6697 " const char *path);\n"
6702 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:866
6704 "This command runs the C<du -s> command to estimate file space usage for "
6709 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
6711 "C<path> can be a file or a directory. If C<path> is a directory then the "
6712 "estimate includes the contents of the directory and all subdirectories "
6717 #: ../src/guestfs-actions.pod:1306 ../fish/guestfish-actions.pod:873
6719 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6723 #: ../src/guestfs-actions.pod:1313
6724 msgid "guestfs_e2fsck_f"
6728 #: ../src/guestfs-actions.pod:1315
6732 " guestfs_e2fsck_f (guestfs_h *g,\n"
6733 " const char *device);\n"
6738 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:880
6740 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6741 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6746 #: ../src/guestfs-actions.pod:1323
6748 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6749 "Normally you should use C<guestfs_fsck>."
6753 #: ../src/guestfs-actions.pod:1328
6754 msgid "(Added in 1.0.29)"
6758 #: ../src/guestfs-actions.pod:1330
6759 msgid "guestfs_echo_daemon"
6763 #: ../src/guestfs-actions.pod:1332
6767 " guestfs_echo_daemon (guestfs_h *g,\n"
6768 " char *const *words);\n"
6773 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:891
6775 "This command concatenates the list of C<words> passed with single spaces "
6776 "between them and returns the resulting string."
6780 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
6781 msgid "You can use this command to test the connection through to the daemon."
6785 #: ../src/guestfs-actions.pod:1341
6786 msgid "See also C<guestfs_ping_daemon>."
6790 #: ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:2073
6791 #: ../src/guestfs-actions.pod:5632
6792 msgid "(Added in 1.0.69)"
6796 #: ../src/guestfs-actions.pod:1348
6797 msgid "guestfs_egrep"
6801 #: ../src/guestfs-actions.pod:1350
6805 " guestfs_egrep (guestfs_h *g,\n"
6806 " const char *regex,\n"
6807 " const char *path);\n"
6812 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:902
6814 "This calls the external C<egrep> program and returns the matching lines."
6818 #: ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1384
6819 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1487
6820 #: ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:2173
6821 #: ../src/guestfs-actions.pod:2192 ../src/guestfs-actions.pod:2348
6822 #: ../src/guestfs-actions.pod:2361 ../src/guestfs-actions.pod:2376
6823 #: ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2444
6824 #: ../src/guestfs-actions.pod:2457 ../src/guestfs-actions.pod:3356
6825 #: ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:3383
6826 #: ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:4301
6827 #: ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5226
6828 #: ../src/guestfs-actions.pod:5996 ../src/guestfs-actions.pod:6008
6829 #: ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6034
6830 #: ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6069
6831 #: ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6095
6832 #: ../src/guestfs-actions.pod:6866 ../src/guestfs-actions.pod:6885
6833 #: ../src/guestfs-actions.pod:6970 ../src/guestfs-actions.pod:6989
6834 #: ../src/guestfs-actions.pod:7035 ../src/guestfs-actions.pod:7054
6835 msgid "(Added in 1.0.66)"
6839 #: ../src/guestfs-actions.pod:1367
6840 msgid "guestfs_egrepi"
6844 #: ../src/guestfs-actions.pod:1369
6848 " guestfs_egrepi (guestfs_h *g,\n"
6849 " const char *regex,\n"
6850 " const char *path);\n"
6855 #: ../src/guestfs-actions.pod:1374 ../fish/guestfish-actions.pod:912
6857 "This calls the external C<egrep -i> program and returns the matching lines."
6861 #: ../src/guestfs-actions.pod:1386
6862 msgid "guestfs_equal"
6866 #: ../src/guestfs-actions.pod:1388
6870 " guestfs_equal (guestfs_h *g,\n"
6871 " const char *file1,\n"
6872 " const char *file2);\n"
6877 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:922
6879 "This compares the two files C<file1> and C<file2> and returns true if their "
6880 "content is exactly equal, or false otherwise."
6884 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
6885 msgid "The external L<cmp(1)> program is used for the comparison."
6889 #: ../src/guestfs-actions.pod:1402
6890 msgid "guestfs_exists"
6894 #: ../src/guestfs-actions.pod:1404
6898 " guestfs_exists (guestfs_h *g,\n"
6899 " const char *path);\n"
6904 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:931
6906 "This returns C<true> if and only if there is a file, directory (or anything) "
6907 "with the given C<path> name."
6911 #: ../src/guestfs-actions.pod:1411
6912 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6916 #: ../src/guestfs-actions.pod:1417
6917 msgid "guestfs_fallocate"
6921 #: ../src/guestfs-actions.pod:1419
6925 " guestfs_fallocate (guestfs_h *g,\n"
6926 " const char *path,\n"
6932 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1450
6933 #: ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6935 "This command preallocates a file (containing zero bytes) named C<path> of "
6936 "size C<len> bytes. If the file exists already, it is overwritten."
6940 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:944
6942 "Do not confuse this with the guestfish-specific C<alloc> command which "
6943 "allocates a file in the host and attaches it as a device."
6947 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:948
6949 "This function is deprecated. In new code, use the C<fallocate64> call "
6954 #: ../src/guestfs-actions.pod:1443
6955 msgid "guestfs_fallocate64"
6959 #: ../src/guestfs-actions.pod:1445
6963 " guestfs_fallocate64 (guestfs_h *g,\n"
6964 " const char *path,\n"
6970 #: ../src/guestfs-actions.pod:1454
6972 "Note that this call allocates disk blocks for the file. To create a sparse "
6973 "file use C<guestfs_truncate_size> instead."
6977 #: ../src/guestfs-actions.pod:1457
6979 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6980 "oversight it only allowed 30 bit lengths to be specified, effectively "
6981 "limiting the maximum size of files created through that call to 1GB."
6985 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:971
6987 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6988 "commands which create a file in the host and attach it as a device."
6992 #: ../src/guestfs-actions.pod:1468
6993 msgid "(Added in 1.3.17)"
6997 #: ../src/guestfs-actions.pod:1470
6998 msgid "guestfs_fgrep"
7002 #: ../src/guestfs-actions.pod:1472
7006 " guestfs_fgrep (guestfs_h *g,\n"
7007 " const char *pattern,\n"
7008 " const char *path);\n"
7013 #: ../src/guestfs-actions.pod:1477 ../fish/guestfish-actions.pod:979
7015 "This calls the external C<fgrep> program and returns the matching lines."
7019 #: ../src/guestfs-actions.pod:1489
7020 msgid "guestfs_fgrepi"
7024 #: ../src/guestfs-actions.pod:1491
7028 " guestfs_fgrepi (guestfs_h *g,\n"
7029 " const char *pattern,\n"
7030 " const char *path);\n"
7035 #: ../src/guestfs-actions.pod:1496 ../fish/guestfish-actions.pod:989
7037 "This calls the external C<fgrep -i> program and returns the matching lines."
7041 #: ../src/guestfs-actions.pod:1508
7042 msgid "guestfs_file"
7046 #: ../src/guestfs-actions.pod:1510
7050 " guestfs_file (guestfs_h *g,\n"
7051 " const char *path);\n"
7056 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:999
7058 "This call uses the standard L<file(1)> command to determine the type or "
7059 "contents of the file."
7063 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
7065 "This call will also transparently look inside various types of compressed "
7070 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
7072 "The exact command which runs is C<file -zb path>. Note in particular that "
7073 "the filename is not prepended to the output (the C<-b> option)."
7077 #: ../src/guestfs-actions.pod:1524
7079 "This command can also be used on C</dev/> devices (and partitions, LV "
7080 "names). You can for example use this to determine if a device contains a "
7081 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
7085 #: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1014
7087 "If the C<path> does not begin with C</dev/> then this command only works for "
7088 "the content of regular files. For other file types (directory, symbolic "
7089 "link etc) it will just return the string C<directory> etc."
7093 #: ../src/guestfs-actions.pod:1539
7094 msgid "guestfs_file_architecture"
7098 #: ../src/guestfs-actions.pod:1541
7102 " guestfs_file_architecture (guestfs_h *g,\n"
7103 " const char *filename);\n"
7108 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
7110 "This detects the architecture of the binary C<filename>, and returns it if "
7115 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
7116 msgid "Currently defined architectures are:"
7120 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
7125 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
7127 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
7128 "irrespective of the precise processor requirements of the binary."
7132 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
7137 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
7138 msgid "64 bit x86-64."
7142 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
7147 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
7148 msgid "32 bit SPARC."
7152 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
7157 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
7158 msgid "64 bit SPARC V9 and above."
7162 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
7167 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
7168 msgid "Intel Itanium."
7172 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
7177 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
7178 msgid "32 bit Power PC."
7182 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
7187 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
7188 msgid "64 bit Power PC."
7192 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
7193 msgid "Libguestfs may return other architecture strings in future."
7197 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
7198 msgid "The function works on at least the following types of files:"
7202 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
7203 msgid "many types of Un*x and Linux binary"
7207 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
7208 msgid "many types of Un*x and Linux shared library"
7212 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
7213 msgid "Windows Win32 and Win64 binaries"
7217 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
7218 msgid "Windows Win32 and Win64 DLLs"
7222 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
7223 msgid "Win32 binaries and DLLs return C<i386>."
7227 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
7228 msgid "Win64 binaries and DLLs return C<x86_64>."
7232 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
7233 msgid "Linux kernel modules"
7237 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
7238 msgid "Linux new-style initrd images"
7242 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
7243 msgid "some non-x86 Linux vmlinuz kernels"
7247 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
7248 msgid "What it can't do currently:"
7252 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
7253 msgid "static libraries (libfoo.a)"
7257 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
7258 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
7262 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
7263 msgid "x86 Linux vmlinuz kernels"
7267 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
7269 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
7270 "compressed code, and are horribly hard to unpack. If you want to find the "
7271 "architecture of a kernel, use the architecture of the associated initrd or "
7272 "kernel module(s) instead."
7276 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812
7277 #: ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2480
7278 #: ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2587
7279 #: ../src/guestfs-actions.pod:2636 ../src/guestfs-actions.pod:2657
7280 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2774
7281 #: ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:3009
7282 #: ../src/guestfs-actions.pod:3141
7283 msgid "(Added in 1.5.3)"
7287 #: ../src/guestfs-actions.pod:1651
7288 msgid "guestfs_filesize"
7292 #: ../src/guestfs-actions.pod:1653
7296 " guestfs_filesize (guestfs_h *g,\n"
7297 " const char *file);\n"
7302 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
7303 msgid "This command returns the size of C<file> in bytes."
7307 #: ../src/guestfs-actions.pod:1659
7309 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
7310 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
7311 "devices, use C<guestfs_blockdev_getsize64>."
7315 #: ../src/guestfs-actions.pod:1665
7316 msgid "(Added in 1.0.82)"
7320 #: ../src/guestfs-actions.pod:1667
7321 msgid "guestfs_fill"
7325 #: ../src/guestfs-actions.pod:1669
7329 " guestfs_fill (guestfs_h *g,\n"
7332 " const char *path);\n"
7337 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
7339 "This command creates a new file called C<path>. The initial content of the "
7340 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
7345 #: ../src/guestfs-actions.pod:1679
7347 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
7348 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
7349 "bytes use C<guestfs_fill_pattern>."
7353 #: ../src/guestfs-actions.pod:1691
7354 msgid "(Added in 1.0.79)"
7358 #: ../src/guestfs-actions.pod:1693
7359 msgid "guestfs_fill_pattern"
7363 #: ../src/guestfs-actions.pod:1695
7367 " guestfs_fill_pattern (guestfs_h *g,\n"
7368 " const char *pattern,\n"
7370 " const char *path);\n"
7375 #: ../src/guestfs-actions.pod:1701
7377 "This function is like C<guestfs_fill> except that it creates a new file of "
7378 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7379 "pattern is truncated if necessary to ensure the length of the file is "
7380 "exactly C<len> bytes."
7384 #: ../src/guestfs-actions.pod:1713
7385 msgid "(Added in 1.3.12)"
7389 #: ../src/guestfs-actions.pod:1715
7390 msgid "guestfs_find"
7394 #: ../src/guestfs-actions.pod:1717
7398 " guestfs_find (guestfs_h *g,\n"
7399 " const char *directory);\n"
7404 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7406 "This command lists out all files and directories, recursively, starting at "
7407 "C<directory>. It is essentially equivalent to running the shell command "
7408 "C<find directory -print> but some post-processing happens on the output, "
7413 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7415 "This returns a list of strings I<without any prefix>. Thus if the directory "
7420 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7430 #: ../src/guestfs-actions.pod:1733
7432 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7436 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7447 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7448 msgid "If C<directory> is not a directory, then this command returns an error."
7452 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7453 msgid "The returned list is sorted."
7457 #: ../src/guestfs-actions.pod:1746
7458 msgid "See also C<guestfs_find0>."
7462 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3800
7463 #: ../src/guestfs-actions.pod:5261
7464 msgid "(Added in 1.0.27)"
7468 #: ../src/guestfs-actions.pod:1757
7469 msgid "guestfs_find0"
7473 #: ../src/guestfs-actions.pod:1759
7477 " guestfs_find0 (guestfs_h *g,\n"
7478 " const char *directory,\n"
7479 " const char *files);\n"
7484 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7486 "This command lists out all files and directories, recursively, starting at "
7487 "C<directory>, placing the resulting list in the external file called "
7492 #: ../src/guestfs-actions.pod:1768
7494 "This command works the same way as C<guestfs_find> with the following "
7499 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7500 msgid "The resulting list is written to an external file."
7504 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7506 "Items (filenames) in the result are separated by C<\\0> characters. See "
7507 "L<find(1)> option I<-print0>."
7511 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7512 msgid "This command is not limited in the number of names that it can return."
7516 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7517 msgid "The result list is not sorted."
7521 #: ../src/guestfs-actions.pod:1795
7522 msgid "(Added in 1.0.74)"
7526 #: ../src/guestfs-actions.pod:1797
7527 msgid "guestfs_findfs_label"
7531 #: ../src/guestfs-actions.pod:1799
7535 " guestfs_findfs_label (guestfs_h *g,\n"
7536 " const char *label);\n"
7541 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
7543 "This command searches the filesystems and returns the one which has the "
7544 "given label. An error is returned if no such filesystem can be found."
7548 #: ../src/guestfs-actions.pod:1807
7549 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7553 #: ../src/guestfs-actions.pod:1814
7554 msgid "guestfs_findfs_uuid"
7558 #: ../src/guestfs-actions.pod:1816
7562 " guestfs_findfs_uuid (guestfs_h *g,\n"
7563 " const char *uuid);\n"
7568 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
7570 "This command searches the filesystems and returns the one which has the "
7571 "given UUID. An error is returned if no such filesystem can be found."
7575 #: ../src/guestfs-actions.pod:1824
7576 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7580 #: ../src/guestfs-actions.pod:1831
7581 msgid "guestfs_fsck"
7585 #: ../src/guestfs-actions.pod:1833
7589 " guestfs_fsck (guestfs_h *g,\n"
7590 " const char *fstype,\n"
7591 " const char *device);\n"
7596 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
7598 "This runs the filesystem checker (fsck) on C<device> which should have "
7599 "filesystem type C<fstype>."
7603 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
7605 "The returned integer is the status. See L<fsck(8)> for the list of status "
7606 "codes from C<fsck>."
7610 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
7611 msgid "Multiple status codes can be summed together."
7615 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
7617 "A non-zero return code can mean \"success\", for example if errors have been "
7618 "corrected on the filesystem."
7622 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
7623 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7627 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
7629 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7633 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:6908
7634 msgid "(Added in 1.0.16)"
7638 #: ../src/guestfs-actions.pod:1870
7639 msgid "guestfs_get_append"
7643 #: ../src/guestfs-actions.pod:1872
7647 " guestfs_get_append (guestfs_h *g);\n"
7652 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
7654 "Return the additional kernel options which are added to the guest kernel "
7659 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
7660 msgid "If C<NULL> then no options are added."
7664 #: ../src/guestfs-actions.pod:1880
7666 "This function returns a string which may be NULL. There is no way to return "
7667 "an error from this function. The string is owned by the guest handle and "
7668 "must I<not> be freed."
7672 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:4939
7673 #: ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5770
7674 #: ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5805
7675 #: ../src/guestfs-actions.pod:5822 ../src/guestfs-actions.pod:6579
7676 #: ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6951
7677 msgid "(Added in 1.0.26)"
7681 #: ../src/guestfs-actions.pod:1886
7682 msgid "guestfs_get_autosync"
7686 #: ../src/guestfs-actions.pod:1888
7690 " guestfs_get_autosync (guestfs_h *g);\n"
7695 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
7696 msgid "Get the autosync flag."
7700 #: ../src/guestfs-actions.pod:1897
7701 msgid "guestfs_get_direct"
7705 #: ../src/guestfs-actions.pod:1899
7709 " guestfs_get_direct (guestfs_h *g);\n"
7714 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
7715 msgid "Return the direct appliance mode flag."
7719 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5443
7720 msgid "(Added in 1.0.72)"
7724 #: ../src/guestfs-actions.pod:1908
7725 msgid "guestfs_get_e2label"
7729 #: ../src/guestfs-actions.pod:1910
7733 " guestfs_get_e2label (guestfs_h *g,\n"
7734 " const char *device);\n"
7739 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
7741 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7745 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1305
7747 "This function is deprecated. In new code, use the C<vfs_label> call instead."
7751 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948
7752 #: ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:5480
7753 msgid "(Added in 1.0.15)"
7757 #: ../src/guestfs-actions.pod:1929
7758 msgid "guestfs_get_e2uuid"
7762 #: ../src/guestfs-actions.pod:1931
7766 " guestfs_get_e2uuid (guestfs_h *g,\n"
7767 " const char *device);\n"
7772 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
7774 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7778 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1319
7780 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7784 #: ../src/guestfs-actions.pod:1950
7785 msgid "guestfs_get_memsize"
7789 #: ../src/guestfs-actions.pod:1952
7793 " guestfs_get_memsize (guestfs_h *g);\n"
7798 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
7800 "This gets the memory size in megabytes allocated to the qemu subprocess."
7804 #: ../src/guestfs-actions.pod:1958
7806 "If C<guestfs_set_memsize> was not called on this handle, and if "
7807 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7808 "value for memsize."
7812 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043
7813 #: ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5603
7814 #: ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388
7815 #: ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7817 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7821 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4091
7822 #: ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:4225
7823 #: ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4256
7824 #: ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4286
7825 #: ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5501
7826 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:6345
7827 msgid "(Added in 1.0.55)"
7831 #: ../src/guestfs-actions.pod:1969
7832 msgid "guestfs_get_network"
7836 #: ../src/guestfs-actions.pod:1971
7840 " guestfs_get_network (guestfs_h *g);\n"
7845 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
7846 msgid "This returns the enable network flag."
7850 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5520
7851 msgid "(Added in 1.5.4)"
7855 #: ../src/guestfs-actions.pod:1980
7856 msgid "guestfs_get_path"
7860 #: ../src/guestfs-actions.pod:1982
7864 " guestfs_get_path (guestfs_h *g);\n"
7869 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
7870 msgid "Return the current search path."
7874 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
7876 "This is always non-NULL. If it wasn't set already, then this will return "
7881 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
7883 "This function returns a string, or NULL on error. The string is owned by "
7884 "the guest handle and must I<not> be freed."
7888 #: ../src/guestfs-actions.pod:1995
7889 msgid "guestfs_get_pid"
7893 #: ../src/guestfs-actions.pod:1997
7897 " guestfs_get_pid (guestfs_h *g);\n"
7902 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
7904 "Return the process ID of the qemu subprocess. If there is no qemu "
7905 "subprocess, then this will return an error."
7909 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
7910 msgid "This is an internal call used for debugging and testing."
7914 #: ../src/guestfs-actions.pod:2007
7915 msgid "(Added in 1.0.56)"
7919 #: ../src/guestfs-actions.pod:2009
7920 msgid "guestfs_get_qemu"
7924 #: ../src/guestfs-actions.pod:2011
7928 " guestfs_get_qemu (guestfs_h *g);\n"
7933 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
7934 msgid "Return the current qemu binary."
7938 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
7940 "This is always non-NULL. If it wasn't set already, then this will return "
7941 "the default qemu binary name."
7945 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5565
7946 msgid "(Added in 1.0.6)"
7950 #: ../src/guestfs-actions.pod:2024
7951 msgid "guestfs_get_recovery_proc"
7955 #: ../src/guestfs-actions.pod:2026
7959 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7964 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
7965 msgid "Return the recovery process enabled flag."
7969 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3231
7970 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3898
7971 #: ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:4869
7972 #: ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5589
7973 #: ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6268
7974 #: ../src/guestfs-actions.pod:6460
7975 msgid "(Added in 1.0.77)"
7979 #: ../src/guestfs-actions.pod:2035
7980 msgid "guestfs_get_selinux"
7984 #: ../src/guestfs-actions.pod:2037
7988 " guestfs_get_selinux (guestfs_h *g);\n"
7993 #: ../src/guestfs-actions.pod:2040
7995 "This returns the current setting of the selinux flag which is passed to the "
7996 "appliance at boot time. See C<guestfs_set_selinux>."
8000 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111
8001 #: ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:5662
8002 msgid "(Added in 1.0.67)"
8006 #: ../src/guestfs-actions.pod:2050
8007 msgid "guestfs_get_state"
8011 #: ../src/guestfs-actions.pod:2052
8015 " guestfs_get_state (guestfs_h *g);\n"
8020 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
8022 "This returns the current state as an opaque integer. This is only useful "
8023 "for printing debug and internal error messages."
8027 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3034
8028 #: ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3124
8029 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1398
8030 #: ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131
8031 #: ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
8032 msgid "For more information on states, see L<guestfs(3)>."
8036 #: ../src/guestfs-actions.pod:2064
8037 msgid "guestfs_get_trace"
8041 #: ../src/guestfs-actions.pod:2066
8045 " guestfs_get_trace (guestfs_h *g);\n"
8050 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
8051 msgid "Return the command trace flag."
8055 #: ../src/guestfs-actions.pod:2075
8056 msgid "guestfs_get_umask"
8060 #: ../src/guestfs-actions.pod:2077
8064 " guestfs_get_umask (guestfs_h *g);\n"
8069 #: ../src/guestfs-actions.pod:2080
8071 "Return the current umask. By default the umask is C<022> unless it has been "
8072 "set by calling C<guestfs_umask>."
8076 #: ../src/guestfs-actions.pod:2087
8077 msgid "guestfs_get_verbose"
8081 #: ../src/guestfs-actions.pod:2089
8085 " guestfs_get_verbose (guestfs_h *g);\n"
8090 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
8091 msgid "This returns the verbose messages flag."
8095 #: ../src/guestfs-actions.pod:2098
8096 msgid "guestfs_getcon"
8100 #: ../src/guestfs-actions.pod:2100
8104 " guestfs_getcon (guestfs_h *g);\n"
8109 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
8110 msgid "This gets the SELinux security context of the daemon."
8114 #: ../src/guestfs-actions.pod:2105
8116 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
8120 #: ../src/guestfs-actions.pod:2113
8121 msgid "guestfs_getxattrs"
8125 #: ../src/guestfs-actions.pod:2115
8128 " struct guestfs_xattr_list *\n"
8129 " guestfs_getxattrs (guestfs_h *g,\n"
8130 " const char *path);\n"
8135 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1432
8137 "This call lists the extended attributes of the file or directory C<path>."
8141 #: ../src/guestfs-actions.pod:2122 ../fish/guestfish-actions.pod:1435
8143 "At the system call level, this is a combination of the L<listxattr(2)> and "
8144 "L<getxattr(2)> calls."
8148 #: ../src/guestfs-actions.pod:2125
8149 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
8153 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3243
8154 #: ../src/guestfs-actions.pod:3894
8156 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
8157 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
8161 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:3247
8162 #: ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3448
8163 #: ../src/guestfs-actions.pod:5242 ../src/guestfs-actions.pod:5681
8164 #: ../src/guestfs-actions.pod:7016
8165 msgid "(Added in 1.0.59)"
8169 #: ../src/guestfs-actions.pod:2133
8170 msgid "guestfs_glob_expand"
8174 #: ../src/guestfs-actions.pod:2135
8178 " guestfs_glob_expand (guestfs_h *g,\n"
8179 " const char *pattern);\n"
8184 #: ../src/guestfs-actions.pod:2139 ../fish/guestfish-actions.pod:1444
8186 "This command searches for all the pathnames matching C<pattern> according to "
8187 "the wildcard expansion rules used by the shell."
8191 #: ../src/guestfs-actions.pod:2143 ../fish/guestfish-actions.pod:1448
8193 "If no paths match, then this returns an empty list (note: not an error)."
8197 #: ../src/guestfs-actions.pod:2146 ../fish/guestfish-actions.pod:1451
8199 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
8200 "GLOB_BRACE>. See that manual page for more details."
8204 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:5846
8205 #: ../src/guestfs-actions.pod:5863
8206 msgid "(Added in 1.0.50)"
8210 #: ../src/guestfs-actions.pod:2156
8211 msgid "guestfs_grep"
8215 #: ../src/guestfs-actions.pod:2158
8219 " guestfs_grep (guestfs_h *g,\n"
8220 " const char *regex,\n"
8221 " const char *path);\n"
8226 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1459
8227 msgid "This calls the external C<grep> program and returns the matching lines."
8231 #: ../src/guestfs-actions.pod:2175
8232 msgid "guestfs_grepi"
8236 #: ../src/guestfs-actions.pod:2177
8240 " guestfs_grepi (guestfs_h *g,\n"
8241 " const char *regex,\n"
8242 " const char *path);\n"
8247 #: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1469
8249 "This calls the external C<grep -i> program and returns the matching lines."
8253 #: ../src/guestfs-actions.pod:2194
8254 msgid "guestfs_grub_install"
8258 #: ../src/guestfs-actions.pod:2196
8262 " guestfs_grub_install (guestfs_h *g,\n"
8263 " const char *root,\n"
8264 " const char *device);\n"
8269 #: ../src/guestfs-actions.pod:2201 ../fish/guestfish-actions.pod:1479
8271 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
8272 "the root directory being C<root>."
8276 #: ../src/guestfs-actions.pod:2204 ../fish/guestfish-actions.pod:1482
8278 "Note: If grub-install reports the error \"No suitable drive was found in the "
8279 "generated device map.\" it may be that you need to create a C</boot/grub/"
8280 "device.map> file first that contains the mapping between grub device names "
8281 "and Linux device names. It is usually sufficient to create a file "
8286 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1489
8294 #: ../src/guestfs-actions.pod:2213 ../fish/guestfish-actions.pod:1491
8295 msgid "replacing C</dev/vda> with the name of the installation device."
8299 #: ../src/guestfs-actions.pod:2217
8300 msgid "(Added in 1.0.17)"
8304 #: ../src/guestfs-actions.pod:2219
8305 msgid "guestfs_head"
8309 #: ../src/guestfs-actions.pod:2221
8313 " guestfs_head (guestfs_h *g,\n"
8314 " const char *path);\n"
8319 #: ../src/guestfs-actions.pod:2225 ../fish/guestfish-actions.pod:1497
8321 "This command returns up to the first 10 lines of a file as a list of strings."
8325 #: ../src/guestfs-actions.pod:2237
8326 msgid "guestfs_head_n"
8330 #: ../src/guestfs-actions.pod:2239
8334 " guestfs_head_n (guestfs_h *g,\n"
8336 " const char *path);\n"
8341 #: ../src/guestfs-actions.pod:2244 ../fish/guestfish-actions.pod:1507
8343 "If the parameter C<nrlines> is a positive number, this returns the first "
8344 "C<nrlines> lines of the file C<path>."
8348 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
8350 "If the parameter C<nrlines> is a negative number, this returns lines from "
8351 "the file C<path>, excluding the last C<nrlines> lines."
8355 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:6143
8356 #: ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
8357 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
8361 #: ../src/guestfs-actions.pod:2261
8362 msgid "guestfs_hexdump"
8366 #: ../src/guestfs-actions.pod:2263
8370 " guestfs_hexdump (guestfs_h *g,\n"
8371 " const char *path);\n"
8376 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
8378 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
8379 "readable, canonical hex dump of the file."
8383 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:5927
8384 #: ../src/guestfs-actions.pod:5982
8385 msgid "(Added in 1.0.22)"
8389 #: ../src/guestfs-actions.pod:2278
8390 msgid "guestfs_initrd_cat"
8394 #: ../src/guestfs-actions.pod:2280
8398 " guestfs_initrd_cat (guestfs_h *g,\n"
8399 " const char *initrdpath,\n"
8400 " const char *filename,\n"
8401 " size_t *size_r);\n"
8406 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1532
8408 "This command unpacks the file C<filename> from the initrd file called "
8409 "C<initrdpath>. The filename must be given I<without> the initial C</> "
8414 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1536
8416 "For example, in guestfish you could use the following command to examine the "
8417 "boot script (usually called C</init>) contained in a Linux initrd or "
8422 #: ../src/guestfs-actions.pod:2294 ../fish/guestfish-actions.pod:1540
8425 " initrd-cat /boot/initrd-<version>.img init\n"
8430 #: ../src/guestfs-actions.pod:2296
8431 msgid "See also C<guestfs_initrd_list>."
8435 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:4862
8436 #: ../src/guestfs-actions.pod:4888 ../src/guestfs-actions.pod:5069
8438 "This function returns a buffer, or NULL on error. The size of the returned "
8439 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8444 #: ../src/guestfs-actions.pod:2307
8445 msgid "guestfs_initrd_list"
8449 #: ../src/guestfs-actions.pod:2309
8453 " guestfs_initrd_list (guestfs_h *g,\n"
8454 " const char *path);\n"
8459 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1551
8460 msgid "This command lists out files contained in an initrd."
8464 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1553
8466 "The files are listed without any initial C</> character. The files are "
8467 "listed in the order they appear (not necessarily alphabetical). Directory "
8468 "names are listed as separate items."
8472 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1557
8474 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8475 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8480 #: ../src/guestfs-actions.pod:2329
8481 msgid "guestfs_inotify_add_watch"
8485 #: ../src/guestfs-actions.pod:2331
8489 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8490 " const char *path,\n"
8496 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1565
8497 msgid "Watch C<path> for the events listed in C<mask>."
8501 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1567
8503 "Note that if C<path> is a directory then events within that directory are "
8504 "watched, but this does I<not> happen recursively (in subdirectories)."
8508 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1571
8510 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8511 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8515 #: ../src/guestfs-actions.pod:2350
8516 msgid "guestfs_inotify_close"
8520 #: ../src/guestfs-actions.pod:2352
8524 " guestfs_inotify_close (guestfs_h *g);\n"
8529 #: ../src/guestfs-actions.pod:2355 ../fish/guestfish-actions.pod:1579
8531 "This closes the inotify handle which was previously opened by inotify_init. "
8532 "It removes all watches, throws away any pending events, and deallocates all "
8537 #: ../src/guestfs-actions.pod:2363
8538 msgid "guestfs_inotify_files"
8542 #: ../src/guestfs-actions.pod:2365
8546 " guestfs_inotify_files (guestfs_h *g);\n"
8551 #: ../src/guestfs-actions.pod:2368
8553 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8554 "returns a list of pathnames of objects that were touched. The returned "
8555 "pathnames are sorted and deduplicated."
8559 #: ../src/guestfs-actions.pod:2378
8560 msgid "guestfs_inotify_init"
8564 #: ../src/guestfs-actions.pod:2380
8568 " guestfs_inotify_init (guestfs_h *g,\n"
8569 " int maxevents);\n"
8574 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1595
8576 "This command creates a new inotify handle. The inotify subsystem can be "
8577 "used to notify events which happen to objects in the guest filesystem."
8581 #: ../src/guestfs-actions.pod:2388
8583 "C<maxevents> is the maximum number of events which will be queued up between "
8584 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8585 "passed as C<0>, then the kernel (or previously set) default is used. For "
8586 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8587 "throws away events, but records the fact that it threw them away by setting "
8588 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8589 "C<guestfs_inotify_read>)."
8593 #: ../src/guestfs-actions.pod:2398
8595 "Before any events are generated, you have to add some watches to the "
8596 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8597 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8601 #: ../src/guestfs-actions.pod:2404
8603 "Queued up events should be read periodically by calling "
8604 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8605 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8606 "often enough then you risk the internal queue overflowing."
8610 #: ../src/guestfs-actions.pod:2411
8612 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8613 "This also removes any watches automatically."
8617 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1626
8619 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8620 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8621 "that there is one global inotify handle per libguestfs instance."
8625 #: ../src/guestfs-actions.pod:2424
8626 msgid "guestfs_inotify_read"
8630 #: ../src/guestfs-actions.pod:2426
8633 " struct guestfs_inotify_event_list *\n"
8634 " guestfs_inotify_read (guestfs_h *g);\n"
8639 #: ../src/guestfs-actions.pod:2429 ../fish/guestfish-actions.pod:1635
8641 "Return the complete queue of events that have happened since the previous "
8646 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1638
8647 msgid "If no events have happened, this returns an empty list."
8651 #: ../src/guestfs-actions.pod:2434 ../fish/guestfish-actions.pod:1640
8653 "I<Note>: In order to make sure that all events have been read, you must call "
8654 "this function repeatedly until it returns an empty list. The reason is that "
8655 "the call will read events up to the maximum appliance-to-host message size "
8656 "and leave remaining events in the queue."
8660 #: ../src/guestfs-actions.pod:2440
8662 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8663 "there was an error. I<The caller must call "
8664 "C<guestfs_free_inotify_event_list> after use>."
8668 #: ../src/guestfs-actions.pod:2446
8669 msgid "guestfs_inotify_rm_watch"
8673 #: ../src/guestfs-actions.pod:2448
8677 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8683 #: ../src/guestfs-actions.pod:2452
8685 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
8689 #: ../src/guestfs-actions.pod:2459
8690 msgid "guestfs_inspect_get_arch"
8694 #: ../src/guestfs-actions.pod:2461
8698 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8699 " const char *root);\n"
8704 #: ../src/guestfs-actions.pod:2465 ../src/guestfs-actions.pod:2488
8705 #: ../src/guestfs-actions.pod:2569 ../src/guestfs-actions.pod:2595
8706 #: ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2644
8707 #: ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:2698
8708 #: ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2758
8709 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2844
8710 #: ../src/guestfs-actions.pod:2867
8712 "This function should only be called with a root device string as returned by "
8713 "C<guestfs_inspect_os>."
8717 #: ../src/guestfs-actions.pod:2468
8719 "This returns the architecture of the inspected operating system. The "
8720 "possible return values are listed under C<guestfs_file_architecture>."
8724 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1664
8726 "If the architecture could not be determined, then the string C<unknown> is "
8731 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556
8732 #: ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2632
8733 #: ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2745
8734 #: ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2788
8735 #: ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2854
8736 #: ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3001
8737 #: ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741
8738 #: ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795
8739 #: ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879
8740 #: ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909
8741 #: ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960
8742 #: ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8743 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8747 #: ../src/guestfs-actions.pod:2482
8748 msgid "guestfs_inspect_get_distro"
8752 #: ../src/guestfs-actions.pod:2484
8756 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8757 " const char *root);\n"
8762 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
8764 "This returns the distro (distribution) of the inspected operating system."
8768 #: ../src/guestfs-actions.pod:2494 ../fish/guestfish-actions.pod:1679
8769 msgid "Currently defined distros are:"
8773 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1683
8774 msgid "\"archlinux\""
8778 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1685
8783 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1687
8788 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1689
8793 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1691
8798 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1693
8803 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1695
8808 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1697
8813 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1699
8814 msgid "\"linuxmint\""
8818 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1701
8823 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1703
8824 msgid "\"mandriva\""
8828 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1705
8833 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1707
8838 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1709
8843 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1711
8848 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1713
8853 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1715
8854 msgid "\"redhat-based\""
8858 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1717
8859 msgid "Some Red Hat-derived distro."
8863 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1719
8868 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1721
8869 msgid "Red Hat Enterprise Linux and some derivatives."
8873 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1723
8878 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1725
8883 #: ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2822
8884 #: ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8889 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1729
8890 msgid "The distro could not be determined."
8894 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2814
8895 #: ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8900 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1733
8902 "Windows does not have distributions. This string is returned if the OS type "
8907 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2828
8908 #: ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8910 "Future versions of libguestfs may return other strings here. The caller "
8911 "should be prepared to handle any string."
8915 #: ../src/guestfs-actions.pod:2563
8916 msgid "guestfs_inspect_get_filesystems"
8920 #: ../src/guestfs-actions.pod:2565
8924 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8925 " const char *root);\n"
8930 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1750
8932 "This returns a list of all the filesystems that we think are associated with "
8933 "this operating system. This includes the root filesystem, other ordinary "
8934 "filesystems, and non-mounted devices like swap partitions."
8938 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1755
8940 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8941 "to be shared between operating systems."
8945 #: ../src/guestfs-actions.pod:2580
8947 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8948 "C<guestfs_inspect_get_mountpoints>."
8952 #: ../src/guestfs-actions.pod:2589
8953 msgid "guestfs_inspect_get_hostname"
8957 #: ../src/guestfs-actions.pod:2591
8961 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8962 " const char *root);\n"
8967 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1768
8969 "This function returns the hostname of the operating system as found by "
8970 "inspection of the guest's configuration files."
8974 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1771
8976 "If the hostname could not be determined, then the string C<unknown> is "
8981 #: ../src/guestfs-actions.pod:2609
8982 msgid "(Added in 1.7.9)"
8986 #: ../src/guestfs-actions.pod:2611
8987 msgid "guestfs_inspect_get_major_version"
8991 #: ../src/guestfs-actions.pod:2613
8995 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8996 " const char *root);\n"
9001 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1783
9003 "This returns the major version number of the inspected operating system."
9007 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
9009 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
9010 "popular public names used by the operating system. Notably the operating "
9011 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
9012 "1). You can find out the real versions corresponding to releases of Windows "
9013 "by consulting Wikipedia or MSDN."
9017 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2650
9018 #: ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
9019 msgid "If the version could not be determined, then C<0> is returned."
9023 #: ../src/guestfs-actions.pod:2638
9024 msgid "guestfs_inspect_get_minor_version"
9028 #: ../src/guestfs-actions.pod:2640
9032 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
9033 " const char *root);\n"
9038 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
9040 "This returns the minor version number of the inspected operating system."
9044 #: ../src/guestfs-actions.pod:2652
9046 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9047 "C<guestfs_inspect_get_major_version>."
9051 #: ../src/guestfs-actions.pod:2659
9052 msgid "guestfs_inspect_get_mountpoints"
9056 #: ../src/guestfs-actions.pod:2661
9060 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
9061 " const char *root);\n"
9066 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1819
9068 "This returns a hash of where we think the filesystems associated with this "
9069 "operating system should be mounted. Callers should note that this is at "
9070 "best an educated guess made by reading configuration files such as C</etc/"
9075 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1824
9077 "Each element in the returned hashtable has a key which is the path of the "
9078 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
9079 "mounted there (eg. C</dev/sda1>)."
9083 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1829
9085 "Non-mounted devices such as swap devices are I<not> returned in this list."
9089 #: ../src/guestfs-actions.pod:2681
9091 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
9092 "C<guestfs_inspect_get_filesystems>."
9096 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:3300
9097 #: ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:6284
9099 "This function returns a NULL-terminated array of strings, or NULL if there "
9100 "was an error. The array of strings will always have length C<2n+1>, where "
9101 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
9102 "caller must free the strings and the array after use>."
9106 #: ../src/guestfs-actions.pod:2692
9107 msgid "guestfs_inspect_get_package_format"
9111 #: ../src/guestfs-actions.pod:2694
9115 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
9116 " const char *root);\n"
9121 #: ../src/guestfs-actions.pod:2701
9123 "This function and C<guestfs_inspect_get_package_management> return the "
9124 "package format and package management tool used by the inspected operating "
9125 "system. For example for Fedora these functions would return C<rpm> (package "
9126 "format) and C<yum> (package management)."
9130 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
9132 "This returns the string C<unknown> if we could not determine the package "
9133 "format I<or> if the operating system does not have a real packaging system "
9138 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
9140 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
9141 "Future versions of libguestfs may return other strings."
9145 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2750
9146 msgid "(Added in 1.7.5)"
9150 #: ../src/guestfs-actions.pod:2721
9151 msgid "guestfs_inspect_get_package_management"
9155 #: ../src/guestfs-actions.pod:2723
9159 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
9160 " const char *root);\n"
9165 #: ../src/guestfs-actions.pod:2730
9167 "C<guestfs_inspect_get_package_format> and this function return the package "
9168 "format and package management tool used by the inspected operating system. "
9169 "For example for Fedora these functions would return C<rpm> (package format) "
9170 "and C<yum> (package management)."
9174 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1870
9176 "This returns the string C<unknown> if we could not determine the package "
9177 "management tool I<or> if the operating system does not have a real packaging "
9178 "system (eg. Windows)."
9182 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1874
9184 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
9185 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
9186 "libguestfs may return other strings."
9190 #: ../src/guestfs-actions.pod:2752
9191 msgid "guestfs_inspect_get_product_name"
9195 #: ../src/guestfs-actions.pod:2754
9199 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
9200 " const char *root);\n"
9205 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1888
9207 "This returns the product name of the inspected operating system. The "
9208 "product name is generally some freeform string which can be displayed to the "
9209 "user, but should not be parsed by programs."
9213 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1893
9215 "If the product name could not be determined, then the string C<unknown> is "
9220 #: ../src/guestfs-actions.pod:2776
9221 msgid "guestfs_inspect_get_roots"
9225 #: ../src/guestfs-actions.pod:2778
9229 " guestfs_inspect_get_roots (guestfs_h *g);\n"
9234 #: ../src/guestfs-actions.pod:2781
9236 "This function is a convenient way to get the list of root devices, as "
9237 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
9238 "the whole inspection process."
9242 #: ../src/guestfs-actions.pod:2785
9244 "This returns an empty list if either no root devices were found or the "
9245 "caller has not called C<guestfs_inspect_os>."
9249 #: ../src/guestfs-actions.pod:2794
9250 msgid "(Added in 1.7.3)"
9254 #: ../src/guestfs-actions.pod:2796
9255 msgid "guestfs_inspect_get_type"
9259 #: ../src/guestfs-actions.pod:2798
9263 " guestfs_inspect_get_type (guestfs_h *g,\n"
9264 " const char *root);\n"
9269 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
9271 "This returns the type of the inspected operating system. Currently defined "
9276 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1923
9281 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
9282 msgid "Any Linux-based operating system."
9286 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1929
9287 msgid "Any Microsoft Windows operating system."
9291 #: ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1931
9296 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1933
9301 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1937
9302 msgid "The operating system type could not be determined."
9306 #: ../src/guestfs-actions.pod:2838
9307 msgid "guestfs_inspect_get_windows_systemroot"
9311 #: ../src/guestfs-actions.pod:2840
9315 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
9316 " const char *root);\n"
9321 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1953
9323 "This returns the Windows systemroot of the inspected guest. The systemroot "
9324 "is a directory path such as C</WINDOWS>."
9328 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1956
9330 "This call assumes that the guest is Windows and that the systemroot could be "
9331 "determined by inspection. If this is not the case then an error is returned."
9335 #: ../src/guestfs-actions.pod:2859
9336 msgid "(Added in 1.5.25)"
9340 #: ../src/guestfs-actions.pod:2861
9341 msgid "guestfs_inspect_list_applications"
9345 #: ../src/guestfs-actions.pod:2863
9348 " struct guestfs_application_list *\n"
9349 " guestfs_inspect_list_applications (guestfs_h *g,\n"
9350 " const char *root);\n"
9355 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1969
9356 msgid "Return the list of applications installed in the operating system."
9360 #: ../src/guestfs-actions.pod:2872
9362 "I<Note:> This call works differently from other parts of the inspection "
9363 "API. You have to call C<guestfs_inspect_os>, then "
9364 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
9365 "this. Listing applications is a significantly more difficult operation "
9366 "which requires access to the full filesystem. Also note that unlike the "
9367 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
9368 "the libguestfs handle, this call actually reads parts of the mounted "
9369 "filesystems during the call."
9373 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1981
9375 "This returns an empty list if the inspection code was not able to determine "
9376 "the list of applications."
9380 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:1984
9381 msgid "The application structure contains the following fields:"
9385 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1988
9390 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1990
9392 "The name of the application. For Red Hat-derived and Debian-derived Linux "
9393 "guests, this is the package name."
9397 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1993
9398 msgid "C<app_display_name>"
9402 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1995
9404 "The display name of the application, sometimes localized to the install "
9405 "language of the guest operating system."
9409 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1998
9411 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
9412 "to display something can use C<app_name> instead."
9416 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2001
9417 msgid "C<app_epoch>"
9421 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2003
9423 "For package managers which use epochs, this contains the epoch of the "
9424 "package (an integer). If unavailable, this is returned as C<0>."
9428 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2006
9429 msgid "C<app_version>"
9433 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2008
9435 "The version string of the application or package. If unavailable this is "
9436 "returned as an empty string C<\"\">."
9440 #: ../src/guestfs-actions.pod:2912 ../fish/guestfish-actions.pod:2011
9441 msgid "C<app_release>"
9445 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2013
9447 "The release string of the application or package, for package managers that "
9448 "use this. If unavailable this is returned as an empty string C<\"\">."
9452 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2017
9453 msgid "C<app_install_path>"
9457 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2019
9459 "The installation path of the application (on operating systems such as "
9460 "Windows which use installation paths). This path is in the format used by "
9461 "the guest operating system, it is not a libguestfs path."
9465 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2024
9466 msgid "If unavailable this is returned as an empty string C<\"\">."
9470 #: ../src/guestfs-actions.pod:2927 ../fish/guestfish-actions.pod:2026
9471 msgid "C<app_trans_path>"
9475 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2028
9477 "The install path translated into a libguestfs path. If unavailable this is "
9478 "returned as an empty string C<\"\">."
9482 #: ../src/guestfs-actions.pod:2932 ../fish/guestfish-actions.pod:2031
9483 msgid "C<app_publisher>"
9487 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2033
9489 "The name of the publisher of the application, for package managers that use "
9490 "this. If unavailable this is returned as an empty string C<\"\">."
9494 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2037
9499 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2039
9501 "The URL (eg. upstream URL) of the application. If unavailable this is "
9502 "returned as an empty string C<\"\">."
9506 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2042
9507 msgid "C<app_source_package>"
9511 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2044
9513 "For packaging systems which support this, the name of the source package. "
9514 "If unavailable this is returned as an empty string C<\"\">."
9518 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2047
9519 msgid "C<app_summary>"
9523 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2049
9525 "A short (usually one line) description of the application or package. If "
9526 "unavailable this is returned as an empty string C<\"\">."
9530 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2052
9531 msgid "C<app_description>"
9535 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2054
9537 "A longer description of the application or package. If unavailable this is "
9538 "returned as an empty string C<\"\">."
9542 #: ../src/guestfs-actions.pod:2962
9544 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9545 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9550 #: ../src/guestfs-actions.pod:2966
9551 msgid "(Added in 1.7.8)"
9555 #: ../src/guestfs-actions.pod:2968
9556 msgid "guestfs_inspect_os"
9560 #: ../src/guestfs-actions.pod:2970
9564 " guestfs_inspect_os (guestfs_h *g);\n"
9569 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2065
9571 "This function uses other libguestfs functions and certain heuristics to "
9572 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9573 "for operating systems."
9577 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2069
9578 msgid "The list returned is empty if no operating systems were found."
9582 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2071
9584 "If one operating system was found, then this returns a list with a single "
9585 "element, which is the name of the root filesystem of this operating system. "
9586 "It is also possible for this function to return a list containing more than "
9587 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9588 "element being the root filesystem of one of the operating systems."
9592 #: ../src/guestfs-actions.pod:2986
9594 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9595 "functions in order to query further information about each operating system, "
9596 "such as the name and version."
9600 #: ../src/guestfs-actions.pod:2991
9602 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9603 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9604 "the contents. This should be called with no disks currently mounted. The "
9605 "function may also use Augeas, so any existing Augeas handle will be closed."
9609 #: ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:2089
9611 "This function cannot decrypt encrypted disks. The caller must do that first "
9612 "(supplying the necessary keys) if the disk is encrypted."
9616 #: ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3258
9617 #: ../src/guestfs-actions.pod:3320
9618 msgid "See also C<guestfs_list_filesystems>."
9622 #: ../src/guestfs-actions.pod:3011
9623 msgid "guestfs_is_blockdev"
9627 #: ../src/guestfs-actions.pod:3013
9631 " guestfs_is_blockdev (guestfs_h *g,\n"
9632 " const char *path);\n"
9637 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2101
9639 "This returns C<true> if and only if there is a block device with the given "
9644 #: ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3049
9645 #: ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3094
9646 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3166
9647 #: ../src/guestfs-actions.pod:3181
9648 msgid "See also C<guestfs_stat>."
9652 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3053
9653 #: ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3170
9654 #: ../src/guestfs-actions.pod:3185
9655 msgid "(Added in 1.5.10)"
9659 #: ../src/guestfs-actions.pod:3026
9660 msgid "guestfs_is_busy"
9664 #: ../src/guestfs-actions.pod:3028
9668 " guestfs_is_busy (guestfs_h *g);\n"
9673 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2110
9675 "This returns true iff this handle is busy processing a command (in the "
9680 #: ../src/guestfs-actions.pod:3040
9681 msgid "guestfs_is_chardev"
9685 #: ../src/guestfs-actions.pod:3042
9689 " guestfs_is_chardev (guestfs_h *g,\n"
9690 " const char *path);\n"
9695 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2119
9697 "This returns C<true> if and only if there is a character device with the "
9698 "given C<path> name."
9702 #: ../src/guestfs-actions.pod:3055
9703 msgid "guestfs_is_config"
9707 #: ../src/guestfs-actions.pod:3057
9711 " guestfs_is_config (guestfs_h *g);\n"
9716 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2128
9718 "This returns true iff this handle is being configured (in the C<CONFIG> "
9723 #: ../src/guestfs-actions.pod:3069
9724 msgid "guestfs_is_dir"
9728 #: ../src/guestfs-actions.pod:3071
9732 " guestfs_is_dir (guestfs_h *g,\n"
9733 " const char *path);\n"
9738 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2137
9740 "This returns C<true> if and only if there is a directory with the given "
9741 "C<path> name. Note that it returns false for other objects like files."
9745 #: ../src/guestfs-actions.pod:3085
9746 msgid "guestfs_is_fifo"
9750 #: ../src/guestfs-actions.pod:3087
9754 " guestfs_is_fifo (guestfs_h *g,\n"
9755 " const char *path);\n"
9760 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2147
9762 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9763 "given C<path> name."
9767 #: ../src/guestfs-actions.pod:3100
9768 msgid "guestfs_is_file"
9772 #: ../src/guestfs-actions.pod:3102
9776 " guestfs_is_file (guestfs_h *g,\n"
9777 " const char *path);\n"
9782 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2156
9784 "This returns C<true> if and only if there is a regular file with the given "
9785 "C<path> name. Note that it returns false for other objects like directories."
9789 #: ../src/guestfs-actions.pod:3116
9790 msgid "guestfs_is_launching"
9794 #: ../src/guestfs-actions.pod:3118
9798 " guestfs_is_launching (guestfs_h *g);\n"
9803 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2166
9805 "This returns true iff this handle is launching the subprocess (in the "
9806 "C<LAUNCHING> state)."
9810 #: ../src/guestfs-actions.pod:3130
9811 msgid "guestfs_is_lv"
9815 #: ../src/guestfs-actions.pod:3132
9819 " guestfs_is_lv (guestfs_h *g,\n"
9820 " const char *device);\n"
9825 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2175
9827 "This command tests whether C<device> is a logical volume, and returns true "
9828 "iff this is the case."
9832 #: ../src/guestfs-actions.pod:3143
9833 msgid "guestfs_is_ready"
9837 #: ../src/guestfs-actions.pod:3145
9841 " guestfs_is_ready (guestfs_h *g);\n"
9846 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2182
9848 "This returns true iff this handle is ready to accept commands (in the "
9853 #: ../src/guestfs-actions.pod:3157
9854 msgid "guestfs_is_socket"
9858 #: ../src/guestfs-actions.pod:3159
9862 " guestfs_is_socket (guestfs_h *g,\n"
9863 " const char *path);\n"
9868 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2191
9870 "This returns C<true> if and only if there is a Unix domain socket with the "
9871 "given C<path> name."
9875 #: ../src/guestfs-actions.pod:3172
9876 msgid "guestfs_is_symlink"
9880 #: ../src/guestfs-actions.pod:3174
9884 " guestfs_is_symlink (guestfs_h *g,\n"
9885 " const char *path);\n"
9890 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2200
9892 "This returns C<true> if and only if there is a symbolic link with the given "
9897 #: ../src/guestfs-actions.pod:3187
9898 msgid "guestfs_kill_subprocess"
9902 #: ../src/guestfs-actions.pod:3189
9906 " guestfs_kill_subprocess (guestfs_h *g);\n"
9911 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2209
9912 msgid "This kills the qemu subprocess. You should never need to call this."
9916 #: ../src/guestfs-actions.pod:3198
9917 msgid "guestfs_launch"
9921 #: ../src/guestfs-actions.pod:3200
9925 " guestfs_launch (guestfs_h *g);\n"
9930 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2217
9932 "Internally libguestfs is implemented by running a virtual machine using "
9937 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2220
9939 "You should call this after configuring the handle (eg. adding drives) but "
9940 "before performing any actions."
9944 #: ../src/guestfs-actions.pod:3213
9945 msgid "guestfs_lchown"
9949 #: ../src/guestfs-actions.pod:3215
9953 " guestfs_lchown (guestfs_h *g,\n"
9956 " const char *path);\n"
9961 #: ../src/guestfs-actions.pod:3221
9963 "Change the file owner to C<owner> and group to C<group>. This is like "
9964 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9965 "changed, not the target."
9969 #: ../src/guestfs-actions.pod:3233
9970 msgid "guestfs_lgetxattrs"
9974 #: ../src/guestfs-actions.pod:3235
9977 " struct guestfs_xattr_list *\n"
9978 " guestfs_lgetxattrs (guestfs_h *g,\n"
9979 " const char *path);\n"
9984 #: ../src/guestfs-actions.pod:3239
9986 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9987 "then it returns the extended attributes of the link itself."
9991 #: ../src/guestfs-actions.pod:3249
9992 msgid "guestfs_list_devices"
9996 #: ../src/guestfs-actions.pod:3251
10000 " guestfs_list_devices (guestfs_h *g);\n"
10005 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2247
10006 msgid "List all the block devices."
10010 #: ../src/guestfs-actions.pod:3256 ../fish/guestfish-actions.pod:2249
10011 msgid "The full block device names are returned, eg. C</dev/sda>."
10015 #: ../src/guestfs-actions.pod:3266
10016 msgid "guestfs_list_filesystems"
10020 #: ../src/guestfs-actions.pod:3268
10024 " guestfs_list_filesystems (guestfs_h *g);\n"
10029 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2257
10031 "This inspection command looks for filesystems on partitions, block devices "
10032 "and logical volumes, returning a list of devices containing filesystems and "
10037 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2261
10039 "The return value is a hash, where the keys are the devices containing "
10040 "filesystems, and the values are the filesystem types. For example:"
10044 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2265
10047 " \"/dev/sda1\" => \"ntfs\"\n"
10048 " \"/dev/sda2\" => \"ext2\"\n"
10049 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
10050 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
10055 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2270
10057 "The value can have the special value \"unknown\", meaning the content of the "
10058 "device is undetermined or empty. \"swap\" means a Linux swap partition."
10062 #: ../src/guestfs-actions.pod:3288
10064 "This command runs other libguestfs commands, which might include "
10065 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
10066 "soon after launch and only when nothing is mounted."
10070 #: ../src/guestfs-actions.pod:3292
10072 "Not all of the filesystems returned will be mountable. In particular, swap "
10073 "partitions are returned in the list. Also this command does not check that "
10074 "each filesystem found is valid and mountable, and some filesystems might be "
10075 "mountable but require special options. Filesystems may not all belong to a "
10076 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
10080 #: ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:4829
10081 msgid "(Added in 1.5.15)"
10085 #: ../src/guestfs-actions.pod:3308
10086 msgid "guestfs_list_partitions"
10090 #: ../src/guestfs-actions.pod:3310
10094 " guestfs_list_partitions (guestfs_h *g);\n"
10099 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2290
10100 msgid "List all the partitions detected on all block devices."
10104 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2292
10105 msgid "The full partition device names are returned, eg. C</dev/sda1>"
10109 #: ../src/guestfs-actions.pod:3317
10111 "This does not return logical volumes. For that you will need to call "
10116 #: ../src/guestfs-actions.pod:3328
10121 #: ../src/guestfs-actions.pod:3330
10125 " guestfs_ll (guestfs_h *g,\n"
10126 " const char *directory);\n"
10131 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2303
10133 "List the files in C<directory> (relative to the root directory, there is no "
10134 "cwd) in the format of 'ls -la'."
10138 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2306
10140 "This command is mostly useful for interactive sessions. It is I<not> "
10141 "intended that you try to parse the output string."
10145 #: ../src/guestfs-actions.pod:3345
10150 #: ../src/guestfs-actions.pod:3347
10154 " guestfs_ln (guestfs_h *g,\n"
10155 " const char *target,\n"
10156 " const char *linkname);\n"
10161 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2313
10162 msgid "This command creates a hard link using the C<ln> command."
10166 #: ../src/guestfs-actions.pod:3358
10167 msgid "guestfs_ln_f"
10171 #: ../src/guestfs-actions.pod:3360
10175 " guestfs_ln_f (guestfs_h *g,\n"
10176 " const char *target,\n"
10177 " const char *linkname);\n"
10182 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2319
10184 "This command creates a hard link using the C<ln -f> command. The C<-f> "
10185 "option removes the link (C<linkname>) if it exists already."
10189 #: ../src/guestfs-actions.pod:3372
10190 msgid "guestfs_ln_s"
10194 #: ../src/guestfs-actions.pod:3374
10198 " guestfs_ln_s (guestfs_h *g,\n"
10199 " const char *target,\n"
10200 " const char *linkname);\n"
10205 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2326
10206 msgid "This command creates a symbolic link using the C<ln -s> command."
10210 #: ../src/guestfs-actions.pod:3385
10211 msgid "guestfs_ln_sf"
10215 #: ../src/guestfs-actions.pod:3387
10219 " guestfs_ln_sf (guestfs_h *g,\n"
10220 " const char *target,\n"
10221 " const char *linkname);\n"
10226 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2332
10228 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
10229 "option removes the link (C<linkname>) if it exists already."
10233 #: ../src/guestfs-actions.pod:3399
10234 msgid "guestfs_lremovexattr"
10238 #: ../src/guestfs-actions.pod:3401
10242 " guestfs_lremovexattr (guestfs_h *g,\n"
10243 " const char *xattr,\n"
10244 " const char *path);\n"
10249 #: ../src/guestfs-actions.pod:3406
10251 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
10252 "link, then it removes an extended attribute of the link itself."
10256 #: ../src/guestfs-actions.pod:3414
10261 #: ../src/guestfs-actions.pod:3416
10265 " guestfs_ls (guestfs_h *g,\n"
10266 " const char *directory);\n"
10271 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2347
10273 "List the files in C<directory> (relative to the root directory, there is no "
10274 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
10278 #: ../src/guestfs-actions.pod:3424
10280 "This command is mostly useful for interactive sessions. Programs should "
10281 "probably use C<guestfs_readdir> instead."
10285 #: ../src/guestfs-actions.pod:3433
10286 msgid "guestfs_lsetxattr"
10290 #: ../src/guestfs-actions.pod:3435
10294 " guestfs_lsetxattr (guestfs_h *g,\n"
10295 " const char *xattr,\n"
10296 " const char *val,\n"
10298 " const char *path);\n"
10303 #: ../src/guestfs-actions.pod:3442
10305 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
10306 "then it sets an extended attribute of the link itself."
10310 #: ../src/guestfs-actions.pod:3450
10311 msgid "guestfs_lstat"
10315 #: ../src/guestfs-actions.pod:3452
10318 " struct guestfs_stat *\n"
10319 " guestfs_lstat (guestfs_h *g,\n"
10320 " const char *path);\n"
10325 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5883
10326 #: ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
10327 msgid "Returns file information for the given C<path>."
10331 #: ../src/guestfs-actions.pod:3458
10333 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
10334 "link, then the link is stat-ed, not the file it refers to."
10338 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2372
10339 msgid "This is the same as the C<lstat(2)> system call."
10343 #: ../src/guestfs-actions.pod:3464 ../src/guestfs-actions.pod:5887
10345 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
10346 "error. I<The caller must call C<guestfs_free_stat> after use>."
10350 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:5891
10351 #: ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:6290
10352 msgid "(Added in 0.9.2)"
10356 #: ../src/guestfs-actions.pod:3470
10357 msgid "guestfs_lstatlist"
10361 #: ../src/guestfs-actions.pod:3472
10364 " struct guestfs_stat_list *\n"
10365 " guestfs_lstatlist (guestfs_h *g,\n"
10366 " const char *path,\n"
10367 " char *const *names);\n"
10372 #: ../src/guestfs-actions.pod:3477
10374 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
10375 "files, where all files are in the directory C<path>. C<names> is the list "
10376 "of files from this directory."
10380 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:2382
10382 "On return you get a list of stat structs, with a one-to-one correspondence "
10383 "to the C<names> list. If any name did not exist or could not be lstat'd, "
10384 "then the C<ino> field of that structure is set to C<-1>."
10388 #: ../src/guestfs-actions.pod:3486
10390 "This call is intended for programs that want to efficiently list a directory "
10391 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
10392 "for a similarly efficient call for getting extended attributes. Very long "
10393 "directory listings might cause the protocol message size to be exceeded, "
10394 "causing this call to fail. The caller must split up such requests into "
10395 "smaller groups of names."
10399 #: ../src/guestfs-actions.pod:3494
10401 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
10402 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
10406 #: ../src/guestfs-actions.pod:3500
10407 msgid "guestfs_luks_add_key"
10411 #: ../src/guestfs-actions.pod:3502
10415 " guestfs_luks_add_key (guestfs_h *g,\n"
10416 " const char *device,\n"
10417 " const char *key,\n"
10418 " const char *newkey,\n"
10424 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2399
10426 "This command adds a new key on LUKS device C<device>. C<key> is any "
10427 "existing key, and is used to access the device. C<newkey> is the new key to "
10428 "add. C<keyslot> is the key slot that will be replaced."
10432 #: ../src/guestfs-actions.pod:3514
10434 "Note that if C<keyslot> already contains a key, then this command will "
10435 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
10439 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:3560
10440 #: ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3603
10441 #: ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:3654
10443 "This function takes a key or passphrase parameter which could contain "
10444 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10449 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3564
10450 #: ../src/guestfs-actions.pod:3587 ../src/guestfs-actions.pod:3607
10451 msgid "(Added in 1.5.2)"
10455 #: ../src/guestfs-actions.pod:3526
10456 msgid "guestfs_luks_close"
10460 #: ../src/guestfs-actions.pod:3528
10464 " guestfs_luks_close (guestfs_h *g,\n"
10465 " const char *device);\n"
10470 #: ../src/guestfs-actions.pod:3532
10472 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10473 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10474 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10475 "underlying block device."
10479 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3639
10480 #: ../src/guestfs-actions.pod:3658 ../src/guestfs-actions.pod:3708
10481 #: ../src/guestfs-actions.pod:3756
10482 msgid "(Added in 1.5.1)"
10486 #: ../src/guestfs-actions.pod:3542
10487 msgid "guestfs_luks_format"
10491 #: ../src/guestfs-actions.pod:3544
10495 " guestfs_luks_format (guestfs_h *g,\n"
10496 " const char *device,\n"
10497 " const char *key,\n"
10503 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2425
10505 "This command erases existing data on C<device> and formats the device as a "
10506 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10507 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10511 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3580
10512 #: ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:4580
10513 #: ../src/guestfs-actions.pod:5343 ../src/guestfs-actions.pod:5718
10514 #: ../src/guestfs-actions.pod:5741 ../src/guestfs-actions.pod:5767
10515 #: ../src/guestfs-actions.pod:6927 ../fish/guestfish-actions.pod:2433
10516 #: ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530
10517 #: ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567
10518 #: ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863
10519 #: ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10521 "B<This command is dangerous. Without careful use you can easily destroy all "
10526 #: ../src/guestfs-actions.pod:3566
10527 msgid "guestfs_luks_format_cipher"
10531 #: ../src/guestfs-actions.pod:3568
10535 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10536 " const char *device,\n"
10537 " const char *key,\n"
10539 " const char *cipher);\n"
10544 #: ../src/guestfs-actions.pod:3575
10546 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10547 "set the C<cipher> used."
10551 #: ../src/guestfs-actions.pod:3589
10552 msgid "guestfs_luks_kill_slot"
10556 #: ../src/guestfs-actions.pod:3591
10560 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10561 " const char *device,\n"
10562 " const char *key,\n"
10568 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2453
10570 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10571 "device C<device>. C<key> must be one of the I<other> keys."
10575 #: ../src/guestfs-actions.pod:3609
10576 msgid "guestfs_luks_open"
10580 #: ../src/guestfs-actions.pod:3611
10584 " guestfs_luks_open (guestfs_h *g,\n"
10585 " const char *device,\n"
10586 " const char *key,\n"
10587 " const char *mapname);\n"
10592 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2464
10594 "This command opens a block device which has been encrypted according to the "
10595 "Linux Unified Key Setup (LUKS) standard."
10599 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2467
10600 msgid "C<device> is the encrypted block device or partition."
10604 #: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2469
10606 "The caller must supply one of the keys associated with the LUKS block "
10607 "device, in the C<key> parameter."
10611 #: ../src/guestfs-actions.pod:3625 ../fish/guestfish-actions.pod:2472
10613 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10614 "writes to this block device are decrypted from and encrypted to the "
10615 "underlying C<device> respectively."
10619 #: ../src/guestfs-actions.pod:3629
10621 "If this block device contains LVM volume groups, then calling "
10622 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10627 #: ../src/guestfs-actions.pod:3641
10628 msgid "guestfs_luks_open_ro"
10632 #: ../src/guestfs-actions.pod:3643
10636 " guestfs_luks_open_ro (guestfs_h *g,\n"
10637 " const char *device,\n"
10638 " const char *key,\n"
10639 " const char *mapname);\n"
10644 #: ../src/guestfs-actions.pod:3649
10646 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10651 #: ../src/guestfs-actions.pod:3660
10652 msgid "guestfs_lvcreate"
10656 #: ../src/guestfs-actions.pod:3662
10660 " guestfs_lvcreate (guestfs_h *g,\n"
10661 " const char *logvol,\n"
10662 " const char *volgroup,\n"
10668 #: ../src/guestfs-actions.pod:3668 ../fish/guestfish-actions.pod:2497
10670 "This creates an LVM logical volume called C<logvol> on the volume group "
10671 "C<volgroup>, with C<size> megabytes."
10675 #: ../src/guestfs-actions.pod:3675
10676 msgid "guestfs_lvm_canonical_lv_name"
10680 #: ../src/guestfs-actions.pod:3677
10684 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10685 " const char *lvname);\n"
10690 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2504
10692 "This converts alternative naming schemes for LVs that you might find to the "
10693 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
10698 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2508
10700 "This command returns an error if the C<lvname> parameter does not refer to a "
10705 #: ../src/guestfs-actions.pod:3688
10706 msgid "See also C<guestfs_is_lv>."
10710 #: ../src/guestfs-actions.pod:3693
10711 msgid "(Added in 1.5.24)"
10715 #: ../src/guestfs-actions.pod:3695
10716 msgid "guestfs_lvm_clear_filter"
10720 #: ../src/guestfs-actions.pod:3697
10724 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10729 #: ../src/guestfs-actions.pod:3700
10731 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10732 "see every block device."
10736 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3745
10737 #: ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10739 "This command also clears the LVM cache and performs a volume group scan."
10743 #: ../src/guestfs-actions.pod:3710
10744 msgid "guestfs_lvm_remove_all"
10748 #: ../src/guestfs-actions.pod:3712
10752 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10757 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2527
10759 "This command removes all LVM logical volumes, volume groups and physical "
10764 #: ../src/guestfs-actions.pod:3725
10765 msgid "guestfs_lvm_set_filter"
10769 #: ../src/guestfs-actions.pod:3727
10773 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10774 " char *const *devices);\n"
10779 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2537
10781 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10782 "block devices in the list C<devices>, and will ignore all other attached "
10787 #: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2541
10789 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10790 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10791 "there are two types of duplication possible: either cloned PVs/VGs which "
10792 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10793 "same name. In normal operation you cannot create this situation, but you "
10794 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10795 "inside the LVM metadata."
10799 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2554
10800 msgid "You can filter whole block devices or individual partitions."
10804 #: ../src/guestfs-actions.pod:3750 ../fish/guestfish-actions.pod:2556
10806 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10807 "filesystem), even if you are not filtering out that VG."
10811 #: ../src/guestfs-actions.pod:3758
10812 msgid "guestfs_lvremove"
10816 #: ../src/guestfs-actions.pod:3760
10820 " guestfs_lvremove (guestfs_h *g,\n"
10821 " const char *device);\n"
10826 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2564
10828 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10829 "LV, such as C</dev/VG/LV>."
10833 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2567
10835 "You can also remove all LVs in a volume group by specifying the VG name, C</"
10840 #: ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:4926
10841 #: ../src/guestfs-actions.pod:6666
10842 msgid "(Added in 1.0.13)"
10846 #: ../src/guestfs-actions.pod:3774
10847 msgid "guestfs_lvrename"
10851 #: ../src/guestfs-actions.pod:3776
10855 " guestfs_lvrename (guestfs_h *g,\n"
10856 " const char *logvol,\n"
10857 " const char *newlogvol);\n"
10862 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2574
10863 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10867 #: ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:6679
10868 msgid "(Added in 1.0.83)"
10872 #: ../src/guestfs-actions.pod:3787
10873 msgid "guestfs_lvresize"
10877 #: ../src/guestfs-actions.pod:3789
10881 " guestfs_lvresize (guestfs_h *g,\n"
10882 " const char *device,\n"
10888 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
10890 "This resizes (expands or shrinks) an existing LVM logical volume to "
10891 "C<mbytes>. When reducing, data in the reduced part is lost."
10895 #: ../src/guestfs-actions.pod:3802
10896 msgid "guestfs_lvresize_free"
10900 #: ../src/guestfs-actions.pod:3804
10904 " guestfs_lvresize_free (guestfs_h *g,\n"
10905 " const char *lv,\n"
10911 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2588
10913 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10914 "remaining free space in the volume group. Commonly you would call this with "
10915 "pc = 100 which expands the logical volume as much as possible, using all "
10916 "remaining free space in the volume group."
10920 #: ../src/guestfs-actions.pod:3817
10921 msgid "(Added in 1.3.3)"
10925 #: ../src/guestfs-actions.pod:3819
10926 msgid "guestfs_lvs"
10930 #: ../src/guestfs-actions.pod:3821
10934 " guestfs_lvs (guestfs_h *g);\n"
10939 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2598
10941 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10946 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2601
10948 "This returns a list of the logical volume device names (eg. C</dev/"
10949 "VolGroup00/LogVol00>)."
10953 #: ../src/guestfs-actions.pod:3830
10954 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10958 #: ../src/guestfs-actions.pod:3838
10959 msgid "guestfs_lvs_full"
10963 #: ../src/guestfs-actions.pod:3840
10966 " struct guestfs_lvm_lv_list *\n"
10967 " guestfs_lvs_full (guestfs_h *g);\n"
10972 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2610
10974 "List all the logical volumes detected. This is the equivalent of the L<lvs"
10975 "(8)> command. The \"full\" version includes all fields."
10979 #: ../src/guestfs-actions.pod:3846
10981 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10982 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
10986 #: ../src/guestfs-actions.pod:3852
10987 msgid "guestfs_lvuuid"
10991 #: ../src/guestfs-actions.pod:3854
10995 " guestfs_lvuuid (guestfs_h *g,\n"
10996 " const char *device);\n"
11001 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2617
11002 msgid "This command returns the UUID of the LVM LV C<device>."
11006 #: ../src/guestfs-actions.pod:3865
11007 msgid "guestfs_lxattrlist"
11011 #: ../src/guestfs-actions.pod:3867
11014 " struct guestfs_xattr_list *\n"
11015 " guestfs_lxattrlist (guestfs_h *g,\n"
11016 " const char *path,\n"
11017 " char *const *names);\n"
11022 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2623
11024 "This call allows you to get the extended attributes of multiple files, where "
11025 "all files are in the directory C<path>. C<names> is the list of files from "
11030 #: ../src/guestfs-actions.pod:3876 ../fish/guestfish-actions.pod:2627
11032 "On return you get a flat list of xattr structs which must be interpreted "
11033 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
11034 "C<attrval> in this struct is zero-length to indicate there was an error "
11035 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
11036 "number (the number of following attributes for this file, which could be C<"
11037 "\"0\">). Then after the first xattr struct are the zero or more attributes "
11038 "for the first named file. This repeats for the second and subsequent files."
11042 #: ../src/guestfs-actions.pod:3886
11044 "This call is intended for programs that want to efficiently list a directory "
11045 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
11046 "a similarly efficient call for getting standard stats. Very long directory "
11047 "listings might cause the protocol message size to be exceeded, causing this "
11048 "call to fail. The caller must split up such requests into smaller groups of "
11053 #: ../src/guestfs-actions.pod:3900
11054 msgid "guestfs_mkdir"
11058 #: ../src/guestfs-actions.pod:3902
11062 " guestfs_mkdir (guestfs_h *g,\n"
11063 " const char *path);\n"
11068 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2649
11069 msgid "Create a directory named C<path>."
11073 #: ../src/guestfs-actions.pod:3912
11074 msgid "guestfs_mkdir_mode"
11078 #: ../src/guestfs-actions.pod:3914
11082 " guestfs_mkdir_mode (guestfs_h *g,\n"
11083 " const char *path,\n"
11089 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2655
11091 "This command creates a directory, setting the initial permissions of the "
11092 "directory to C<mode>."
11096 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2658
11098 "For common Linux filesystems, the actual mode which is set will be C<mode & "
11099 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
11104 #: ../src/guestfs-actions.pod:3926
11105 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
11109 #: ../src/guestfs-actions.pod:3932
11110 msgid "guestfs_mkdir_p"
11114 #: ../src/guestfs-actions.pod:3934
11118 " guestfs_mkdir_p (guestfs_h *g,\n"
11119 " const char *path);\n"
11124 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2668
11126 "Create a directory named C<path>, creating any parent directories as "
11127 "necessary. This is like the C<mkdir -p> shell command."
11131 #: ../src/guestfs-actions.pod:3945
11132 msgid "guestfs_mkdtemp"
11136 #: ../src/guestfs-actions.pod:3947
11140 " guestfs_mkdtemp (guestfs_h *g,\n"
11141 " const char *template);\n"
11146 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2675
11148 "This command creates a temporary directory. The C<template> parameter "
11149 "should be a full pathname for the temporary directory name with the final "
11150 "six characters being \"XXXXXX\"."
11154 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2680
11156 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
11157 "being suitable for Windows filesystems."
11161 #: ../src/guestfs-actions.pod:3959 ../fish/guestfish-actions.pod:2683
11162 msgid "The name of the temporary directory that was created is returned."
11166 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2686
11167 msgid "The temporary directory is created with mode 0700 and is owned by root."
11171 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2689
11173 "The caller is responsible for deleting the temporary directory and its "
11174 "contents after use."
11178 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2692
11179 msgid "See also: L<mkdtemp(3)>"
11183 #: ../src/guestfs-actions.pod:3975
11184 msgid "guestfs_mke2fs_J"
11188 #: ../src/guestfs-actions.pod:3977
11192 " guestfs_mke2fs_J (guestfs_h *g,\n"
11193 " const char *fstype,\n"
11194 " int blocksize,\n"
11195 " const char *device,\n"
11196 " const char *journal);\n"
11201 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2698
11203 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11204 "C<journal>. It is equivalent to the command:"
11208 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2702
11211 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
11216 #: ../src/guestfs-actions.pod:3990
11217 msgid "See also C<guestfs_mke2journal>."
11221 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4012
11222 #: ../src/guestfs-actions.pod:4030 ../src/guestfs-actions.pod:4046
11223 #: ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4074
11224 #: ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:4316
11225 msgid "(Added in 1.0.68)"
11229 #: ../src/guestfs-actions.pod:3996
11230 msgid "guestfs_mke2fs_JL"
11234 #: ../src/guestfs-actions.pod:3998
11238 " guestfs_mke2fs_JL (guestfs_h *g,\n"
11239 " const char *fstype,\n"
11240 " int blocksize,\n"
11241 " const char *device,\n"
11242 " const char *label);\n"
11247 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2710
11249 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11250 "the journal labeled C<label>."
11254 #: ../src/guestfs-actions.pod:4008
11255 msgid "See also C<guestfs_mke2journal_L>."
11259 #: ../src/guestfs-actions.pod:4014
11260 msgid "guestfs_mke2fs_JU"
11264 #: ../src/guestfs-actions.pod:4016
11268 " guestfs_mke2fs_JU (guestfs_h *g,\n"
11269 " const char *fstype,\n"
11270 " int blocksize,\n"
11271 " const char *device,\n"
11272 " const char *uuid);\n"
11277 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2719
11279 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
11280 "the journal with UUID C<uuid>."
11284 #: ../src/guestfs-actions.pod:4026
11285 msgid "See also C<guestfs_mke2journal_U>."
11289 #: ../src/guestfs-actions.pod:4032
11290 msgid "guestfs_mke2journal"
11294 #: ../src/guestfs-actions.pod:4034
11298 " guestfs_mke2journal (guestfs_h *g,\n"
11299 " int blocksize,\n"
11300 " const char *device);\n"
11305 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2728
11307 "This creates an ext2 external journal on C<device>. It is equivalent to the "
11312 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2731
11315 " mke2fs -O journal_dev -b blocksize device\n"
11320 #: ../src/guestfs-actions.pod:4048
11321 msgid "guestfs_mke2journal_L"
11325 #: ../src/guestfs-actions.pod:4050
11329 " guestfs_mke2journal_L (guestfs_h *g,\n"
11330 " int blocksize,\n"
11331 " const char *label,\n"
11332 " const char *device);\n"
11337 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2737
11338 msgid "This creates an ext2 external journal on C<device> with label C<label>."
11342 #: ../src/guestfs-actions.pod:4062
11343 msgid "guestfs_mke2journal_U"
11347 #: ../src/guestfs-actions.pod:4064
11351 " guestfs_mke2journal_U (guestfs_h *g,\n"
11352 " int blocksize,\n"
11353 " const char *uuid,\n"
11354 " const char *device);\n"
11359 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2743
11360 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
11364 #: ../src/guestfs-actions.pod:4076
11365 msgid "guestfs_mkfifo"
11369 #: ../src/guestfs-actions.pod:4078
11373 " guestfs_mkfifo (guestfs_h *g,\n"
11375 " const char *path);\n"
11380 #: ../src/guestfs-actions.pod:4083
11382 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
11383 "is just a convenient wrapper around C<guestfs_mknod>."
11387 #: ../src/guestfs-actions.pod:4093
11388 msgid "guestfs_mkfs"
11392 #: ../src/guestfs-actions.pod:4095
11396 " guestfs_mkfs (guestfs_h *g,\n"
11397 " const char *fstype,\n"
11398 " const char *device);\n"
11403 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2759
11405 "This creates a filesystem on C<device> (usually a partition or LVM logical "
11406 "volume). The filesystem type is C<fstype>, for example C<ext3>."
11410 #: ../src/guestfs-actions.pod:4108
11411 msgid "guestfs_mkfs_b"
11415 #: ../src/guestfs-actions.pod:4110
11419 " guestfs_mkfs_b (guestfs_h *g,\n"
11420 " const char *fstype,\n"
11421 " int blocksize,\n"
11422 " const char *device);\n"
11427 #: ../src/guestfs-actions.pod:4116
11429 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
11430 "block size of the resulting filesystem. Supported block sizes depend on the "
11431 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
11435 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2772
11437 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
11442 #: ../src/guestfs-actions.pod:4128
11443 msgid "guestfs_mkmountpoint"
11447 #: ../src/guestfs-actions.pod:4130
11451 " guestfs_mkmountpoint (guestfs_h *g,\n"
11452 " const char *exemptpath);\n"
11457 #: ../src/guestfs-actions.pod:4134
11459 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11460 "that can be used to create extra mountpoints before mounting the first "
11465 #: ../src/guestfs-actions.pod:4138 ../fish/guestfish-actions.pod:2783
11467 "These calls are I<only> necessary in some very limited circumstances, mainly "
11468 "the case where you want to mount a mix of unrelated and/or read-only "
11469 "filesystems together."
11473 #: ../src/guestfs-actions.pod:4142 ../fish/guestfish-actions.pod:2787
11475 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11476 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11477 "inside that. You can unpack this as follows in guestfish:"
11481 #: ../src/guestfs-actions.pod:4147 ../fish/guestfish-actions.pod:2792
11484 " add-ro Fedora-11-i686-Live.iso\n"
11486 " mkmountpoint /cd\n"
11487 " mkmountpoint /sqsh\n"
11488 " mkmountpoint /ext3fs\n"
11489 " mount /dev/sda /cd\n"
11490 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11491 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11496 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2801
11497 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11501 #: ../src/guestfs-actions.pod:4158
11503 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11504 "may get unexpected errors if you try to mix these calls. It is safest to "
11505 "manually unmount filesystems and remove mountpoints after use."
11509 #: ../src/guestfs-actions.pod:4162
11511 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11512 "first, so for this to work for manual mountpoints, you must ensure that the "
11513 "innermost mountpoints have the longest pathnames, as in the example code "
11518 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2812
11520 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11524 #: ../src/guestfs-actions.pod:4169
11526 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11527 "means that C<guestfs_umount_all> is called when the handle is closed which "
11528 "can also trigger these issues."
11532 #: ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4434
11533 #: ../src/guestfs-actions.pod:5327
11534 msgid "(Added in 1.0.62)"
11538 #: ../src/guestfs-actions.pod:4177
11539 msgid "guestfs_mknod"
11543 #: ../src/guestfs-actions.pod:4179
11547 " guestfs_mknod (guestfs_h *g,\n"
11551 " const char *path);\n"
11556 #: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2822
11558 "This call creates block or character special devices, or named pipes (FIFOs)."
11562 #: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:2825
11564 "The C<mode> parameter should be the mode, using the standard constants. "
11565 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11566 "used when creating block and character special devices."
11570 #: ../src/guestfs-actions.pod:4194
11572 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11573 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11574 "regular file). These constants are available in the standard Linux header "
11575 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11576 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11577 "the appropriate constant for you."
11581 #: ../src/guestfs-actions.pod:4208
11582 msgid "guestfs_mknod_b"
11586 #: ../src/guestfs-actions.pod:4210
11590 " guestfs_mknod_b (guestfs_h *g,\n"
11594 " const char *path);\n"
11599 #: ../src/guestfs-actions.pod:4217
11601 "This call creates a block device node called C<path> with mode C<mode> and "
11602 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11603 "wrapper around C<guestfs_mknod>."
11607 #: ../src/guestfs-actions.pod:4227
11608 msgid "guestfs_mknod_c"
11612 #: ../src/guestfs-actions.pod:4229
11616 " guestfs_mknod_c (guestfs_h *g,\n"
11620 " const char *path);\n"
11625 #: ../src/guestfs-actions.pod:4236
11627 "This call creates a char device node called C<path> with mode C<mode> and "
11628 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11629 "wrapper around C<guestfs_mknod>."
11633 #: ../src/guestfs-actions.pod:4246
11634 msgid "guestfs_mkswap"
11638 #: ../src/guestfs-actions.pod:4248
11642 " guestfs_mkswap (guestfs_h *g,\n"
11643 " const char *device);\n"
11648 #: ../src/guestfs-actions.pod:4252 ../fish/guestfish-actions.pod:2864
11649 msgid "Create a swap partition on C<device>."
11653 #: ../src/guestfs-actions.pod:4258
11654 msgid "guestfs_mkswap_L"
11658 #: ../src/guestfs-actions.pod:4260
11662 " guestfs_mkswap_L (guestfs_h *g,\n"
11663 " const char *label,\n"
11664 " const char *device);\n"
11669 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2870
11670 msgid "Create a swap partition on C<device> with label C<label>."
11674 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2872
11676 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
11677 "sda>), just to a partition. This appears to be a limitation of the kernel "
11682 #: ../src/guestfs-actions.pod:4275
11683 msgid "guestfs_mkswap_U"
11687 #: ../src/guestfs-actions.pod:4277
11691 " guestfs_mkswap_U (guestfs_h *g,\n"
11692 " const char *uuid,\n"
11693 " const char *device);\n"
11698 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2880
11699 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11703 #: ../src/guestfs-actions.pod:4288
11704 msgid "guestfs_mkswap_file"
11708 #: ../src/guestfs-actions.pod:4290
11712 " guestfs_mkswap_file (guestfs_h *g,\n"
11713 " const char *path);\n"
11718 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2886
11719 msgid "Create a swap file."
11723 #: ../src/guestfs-actions.pod:4296
11725 "This command just writes a swap file signature to an existing file. To "
11726 "create the file itself, use something like C<guestfs_fallocate>."
11730 #: ../src/guestfs-actions.pod:4303
11731 msgid "guestfs_modprobe"
11735 #: ../src/guestfs-actions.pod:4305
11739 " guestfs_modprobe (guestfs_h *g,\n"
11740 " const char *modulename);\n"
11745 #: ../src/guestfs-actions.pod:4309 ../fish/guestfish-actions.pod:2895
11746 msgid "This loads a kernel module in the appliance."
11750 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2897
11752 "The kernel module must have been whitelisted when libguestfs was built (see "
11753 "C<appliance/kmod.whitelist.in> in the source)."
11757 #: ../src/guestfs-actions.pod:4318
11758 msgid "guestfs_mount"
11762 #: ../src/guestfs-actions.pod:4320
11766 " guestfs_mount (guestfs_h *g,\n"
11767 " const char *device,\n"
11768 " const char *mountpoint);\n"
11773 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2904
11775 "Mount a guest disk at a position in the filesystem. Block devices are named "
11776 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11777 "those block devices contain partitions, they will have the usual names (eg. "
11778 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11782 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2910
11784 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11785 "mounted on C</> before others can be mounted. Other filesystems can only be "
11786 "mounted on directories which already exist."
11790 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2915
11792 "The mounted filesystem is writable, if we have sufficient permissions on the "
11793 "underlying device."
11797 #: ../src/guestfs-actions.pod:4339
11799 "B<Important note:> When you use this call, the filesystem options C<sync> "
11800 "and C<noatime> are set implicitly. This was originally done because we "
11801 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11802 "very large negative performance impact and negligible effect on "
11803 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11804 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11805 "(use an empty string for the first parameter if you don't want any options)."
11809 #: ../src/guestfs-actions.pod:4353
11810 msgid "guestfs_mount_loop"
11814 #: ../src/guestfs-actions.pod:4355
11818 " guestfs_mount_loop (guestfs_h *g,\n"
11819 " const char *file,\n"
11820 " const char *mountpoint);\n"
11825 #: ../src/guestfs-actions.pod:4360 ../fish/guestfish-actions.pod:2932
11827 "This command lets you mount C<file> (a filesystem image in a file) on a "
11828 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11833 #: ../src/guestfs-actions.pod:4368
11834 msgid "guestfs_mount_options"
11838 #: ../src/guestfs-actions.pod:4370
11842 " guestfs_mount_options (guestfs_h *g,\n"
11843 " const char *options,\n"
11844 " const char *device,\n"
11845 " const char *mountpoint);\n"
11850 #: ../src/guestfs-actions.pod:4376
11852 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11853 "the mount options as for the L<mount(8)> I<-o> flag."
11857 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2944
11859 "If the C<options> parameter is an empty string, then no options are passed "
11860 "(all options default to whatever the filesystem uses)."
11864 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4400
11865 #: ../src/guestfs-actions.pod:4417
11866 msgid "(Added in 1.0.10)"
11870 #: ../src/guestfs-actions.pod:4388
11871 msgid "guestfs_mount_ro"
11875 #: ../src/guestfs-actions.pod:4390
11879 " guestfs_mount_ro (guestfs_h *g,\n"
11880 " const char *device,\n"
11881 " const char *mountpoint);\n"
11886 #: ../src/guestfs-actions.pod:4395
11888 "This is the same as the C<guestfs_mount> command, but it mounts the "
11889 "filesystem with the read-only (I<-o ro>) flag."
11893 #: ../src/guestfs-actions.pod:4402
11894 msgid "guestfs_mount_vfs"
11898 #: ../src/guestfs-actions.pod:4404
11902 " guestfs_mount_vfs (guestfs_h *g,\n"
11903 " const char *options,\n"
11904 " const char *vfstype,\n"
11905 " const char *device,\n"
11906 " const char *mountpoint);\n"
11911 #: ../src/guestfs-actions.pod:4411
11913 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11914 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
11919 #: ../src/guestfs-actions.pod:4419
11920 msgid "guestfs_mountpoints"
11924 #: ../src/guestfs-actions.pod:4421
11928 " guestfs_mountpoints (guestfs_h *g);\n"
11933 #: ../src/guestfs-actions.pod:4424
11935 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11936 "devices. This one returns a hash table (map) of device name to directory "
11937 "where the device is mounted."
11941 #: ../src/guestfs-actions.pod:4436
11942 msgid "guestfs_mounts"
11946 #: ../src/guestfs-actions.pod:4438
11950 " guestfs_mounts (guestfs_h *g);\n"
11955 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2975
11957 "This returns the list of currently mounted filesystems. It returns the list "
11958 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11962 #: ../src/guestfs-actions.pod:4444 ../fish/guestfish-actions.pod:2978
11963 msgid "Some internal mounts are not shown."
11967 #: ../src/guestfs-actions.pod:4446
11968 msgid "See also: C<guestfs_mountpoints>"
11972 #: ../src/guestfs-actions.pod:4454
11977 #: ../src/guestfs-actions.pod:4456
11981 " guestfs_mv (guestfs_h *g,\n"
11982 " const char *src,\n"
11983 " const char *dest);\n"
11988 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:2986
11990 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11991 "destination filename or destination directory."
11995 #: ../src/guestfs-actions.pod:4468
11996 msgid "guestfs_ntfs_3g_probe"
12000 #: ../src/guestfs-actions.pod:4470
12004 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
12006 " const char *device);\n"
12011 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:2993
12013 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
12014 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
12015 "write, and some cannot be mounted at all)."
12019 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:2997
12021 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
12022 "can be mounted read-write. Set it to false if you want to test if the "
12023 "volume can be mounted read-only."
12027 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3001
12029 "The return value is an integer which C<0> if the operation would succeed, or "
12030 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
12034 #: ../src/guestfs-actions.pod:4489
12035 msgid "(Added in 1.0.43)"
12039 #: ../src/guestfs-actions.pod:4491
12040 msgid "guestfs_ntfsresize"
12044 #: ../src/guestfs-actions.pod:4493
12048 " guestfs_ntfsresize (guestfs_h *g,\n"
12049 " const char *device);\n"
12054 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:3009
12056 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
12057 "size of the underlying device. See also L<ntfsresize(8)>."
12061 #: ../src/guestfs-actions.pod:4505
12062 msgid "guestfs_ntfsresize_size"
12066 #: ../src/guestfs-actions.pod:4507
12070 " guestfs_ntfsresize_size (guestfs_h *g,\n"
12071 " const char *device,\n"
12072 " int64_t size);\n"
12077 #: ../src/guestfs-actions.pod:4512
12079 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
12080 "to specify the new size (in bytes) explicitly."
12084 #: ../src/guestfs-actions.pod:4517 ../src/guestfs-actions.pod:4953
12085 #: ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:5275
12086 msgid "(Added in 1.3.14)"
12090 #: ../src/guestfs-actions.pod:4519
12091 msgid "guestfs_part_add"
12095 #: ../src/guestfs-actions.pod:4521
12099 " guestfs_part_add (guestfs_h *g,\n"
12100 " const char *device,\n"
12101 " const char *prlogex,\n"
12102 " int64_t startsect,\n"
12103 " int64_t endsect);\n"
12108 #: ../src/guestfs-actions.pod:4528
12110 "This command adds a partition to C<device>. If there is no partition table "
12111 "on the device, call C<guestfs_part_init> first."
12115 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3027
12117 "The C<prlogex> parameter is the type of partition. Normally you should pass "
12118 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
12119 "C<logical>) and C<e> (or C<extended>) partition types."
12123 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3032
12125 "C<startsect> and C<endsect> are the start and end of the partition in "
12126 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
12127 "from the end of the disk (C<-1> is the last sector)."
12131 #: ../src/guestfs-actions.pod:4540
12133 "Creating a partition which covers the whole disk is not so easy. Use "
12134 "C<guestfs_part_disk> to do that."
12138 #: ../src/guestfs-actions.pod:4545 ../src/guestfs-actions.pod:4583
12139 #: ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4714
12140 #: ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4771
12141 #: ../src/guestfs-actions.pod:4811
12142 msgid "(Added in 1.0.78)"
12146 #: ../src/guestfs-actions.pod:4547
12147 msgid "guestfs_part_del"
12151 #: ../src/guestfs-actions.pod:4549
12155 " guestfs_part_del (guestfs_h *g,\n"
12156 " const char *device,\n"
12162 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3043
12163 msgid "This command deletes the partition numbered C<partnum> on C<device>."
12167 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3045
12169 "Note that in the case of MBR partitioning, deleting an extended partition "
12170 "also deletes any logical partitions it contains."
12174 #: ../src/guestfs-actions.pod:4564
12175 msgid "guestfs_part_disk"
12179 #: ../src/guestfs-actions.pod:4566
12183 " guestfs_part_disk (guestfs_h *g,\n"
12184 " const char *device,\n"
12185 " const char *parttype);\n"
12190 #: ../src/guestfs-actions.pod:4571
12192 "This command is simply a combination of C<guestfs_part_init> followed by "
12193 "C<guestfs_part_add> to create a single primary partition covering the whole "
12198 #: ../src/guestfs-actions.pod:4575
12200 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
12201 "possible values are described in C<guestfs_part_init>."
12205 #: ../src/guestfs-actions.pod:4585
12206 msgid "guestfs_part_get_bootable"
12210 #: ../src/guestfs-actions.pod:4587
12214 " guestfs_part_get_bootable (guestfs_h *g,\n"
12215 " const char *device,\n"
12221 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3067
12223 "This command returns true if the partition C<partnum> on C<device> has the "
12224 "bootable flag set."
12228 #: ../src/guestfs-actions.pod:4595
12229 msgid "See also C<guestfs_part_set_bootable>."
12233 #: ../src/guestfs-actions.pod:4601
12234 msgid "guestfs_part_get_mbr_id"
12238 #: ../src/guestfs-actions.pod:4603
12242 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
12243 " const char *device,\n"
12249 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3076
12251 "Returns the MBR type byte (also known as the ID byte) from the numbered "
12252 "partition C<partnum>."
12256 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4787
12258 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
12259 "undefined results for other partition table types (see "
12260 "C<guestfs_part_get_parttype>)."
12264 #: ../src/guestfs-actions.pod:4619
12265 msgid "guestfs_part_get_parttype"
12269 #: ../src/guestfs-actions.pod:4621
12273 " guestfs_part_get_parttype (guestfs_h *g,\n"
12274 " const char *device);\n"
12279 #: ../src/guestfs-actions.pod:4625 ../fish/guestfish-actions.pod:3087
12281 "This command examines the partition table on C<device> and returns the "
12282 "partition table type (format) being used."
12286 #: ../src/guestfs-actions.pod:4628
12288 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
12289 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
12290 "possible, although unusual. See C<guestfs_part_init> for a full list."
12294 #: ../src/guestfs-actions.pod:4638
12295 msgid "guestfs_part_init"
12299 #: ../src/guestfs-actions.pod:4640
12303 " guestfs_part_init (guestfs_h *g,\n"
12304 " const char *device,\n"
12305 " const char *parttype);\n"
12310 #: ../src/guestfs-actions.pod:4645 ../fish/guestfish-actions.pod:3099
12312 "This creates an empty partition table on C<device> of one of the partition "
12313 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
12314 "(for large disks)."
12318 #: ../src/guestfs-actions.pod:4649
12320 "Initially there are no partitions. Following this, you should call "
12321 "C<guestfs_part_add> for each partition required."
12325 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3106
12326 msgid "Possible values for C<parttype> are:"
12330 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3110
12331 msgid "B<efi> | B<gpt>"
12335 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3112
12336 msgid "Intel EFI / GPT partition table."
12340 #: ../src/guestfs-actions.pod:4660 ../fish/guestfish-actions.pod:3114
12342 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
12343 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
12344 "the C<mbr> format."
12348 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3118
12349 msgid "B<mbr> | B<msdos>"
12353 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3120
12355 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
12356 "Windows. This partition type will B<only> work for device sizes up to 2 "
12357 "TB. For large disks we recommend using C<gpt>."
12361 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3127
12363 "Other partition table types that may work but are not supported include:"
12367 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3132
12372 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3134
12373 msgid "AIX disk labels."
12377 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3136
12378 msgid "B<amiga> | B<rdb>"
12382 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3138
12383 msgid "Amiga \"Rigid Disk Block\" format."
12387 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3140
12392 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3142
12393 msgid "BSD disk labels."
12397 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3144
12402 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3146
12403 msgid "DASD, used on IBM mainframes."
12407 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3148
12412 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3150
12413 msgid "MIPS/SGI volumes."
12417 #: ../src/guestfs-actions.pod:4698 ../fish/guestfish-actions.pod:3152
12422 #: ../src/guestfs-actions.pod:4700 ../fish/guestfish-actions.pod:3154
12423 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12427 #: ../src/guestfs-actions.pod:4702 ../fish/guestfish-actions.pod:3156
12432 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3158
12433 msgid "NEC PC-98 format, common in Japan apparently."
12437 #: ../src/guestfs-actions.pod:4706 ../fish/guestfish-actions.pod:3160
12442 #: ../src/guestfs-actions.pod:4708 ../fish/guestfish-actions.pod:3162
12443 msgid "Sun disk labels."
12447 #: ../src/guestfs-actions.pod:4716
12448 msgid "guestfs_part_list"
12452 #: ../src/guestfs-actions.pod:4718
12455 " struct guestfs_partition_list *\n"
12456 " guestfs_part_list (guestfs_h *g,\n"
12457 " const char *device);\n"
12462 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3170
12464 "This command parses the partition table on C<device> and returns the list of "
12465 "partitions found."
12469 #: ../src/guestfs-actions.pod:4725 ../fish/guestfish-actions.pod:3173
12470 msgid "The fields in the returned structure are:"
12474 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3177
12475 msgid "B<part_num>"
12479 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3179
12480 msgid "Partition number, counting from 1."
12484 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3181
12485 msgid "B<part_start>"
12489 #: ../src/guestfs-actions.pod:4735
12491 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12492 "the device's sector size, see C<guestfs_blockdev_getss>."
12496 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3186
12497 msgid "B<part_end>"
12501 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3188
12502 msgid "End of the partition in bytes."
12506 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3190
12507 msgid "B<part_size>"
12511 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3192
12512 msgid "Size of the partition in bytes."
12516 #: ../src/guestfs-actions.pod:4748
12518 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12519 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12524 #: ../src/guestfs-actions.pod:4754
12525 msgid "guestfs_part_set_bootable"
12529 #: ../src/guestfs-actions.pod:4756
12533 " guestfs_part_set_bootable (guestfs_h *g,\n"
12534 " const char *device,\n"
12536 " int bootable);\n"
12541 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3200
12543 "This sets the bootable flag on partition numbered C<partnum> on device "
12544 "C<device>. Note that partitions are numbered from 1."
12548 #: ../src/guestfs-actions.pod:4765 ../fish/guestfish-actions.pod:3203
12550 "The bootable flag is used by some operating systems (notably Windows) to "
12551 "determine which partition to boot from. It is by no means universally "
12556 #: ../src/guestfs-actions.pod:4773
12557 msgid "guestfs_part_set_mbr_id"
12561 #: ../src/guestfs-actions.pod:4775
12565 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12566 " const char *device,\n"
12573 #: ../src/guestfs-actions.pod:4781 ../fish/guestfish-actions.pod:3211
12575 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12576 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12577 "documentation are in fact hexadecimal numbers, but usually documented "
12578 "without any leading \"0x\" which might be confusing."
12582 #: ../src/guestfs-actions.pod:4795
12583 msgid "guestfs_part_set_name"
12587 #: ../src/guestfs-actions.pod:4797
12591 " guestfs_part_set_name (guestfs_h *g,\n"
12592 " const char *device,\n"
12594 " const char *name);\n"
12599 #: ../src/guestfs-actions.pod:4803 ../fish/guestfish-actions.pod:3225
12601 "This sets the partition name on partition numbered C<partnum> on device "
12602 "C<device>. Note that partitions are numbered from 1."
12606 #: ../src/guestfs-actions.pod:4806 ../fish/guestfish-actions.pod:3228
12608 "The partition name can only be set on certain types of partition table. "
12609 "This works on C<gpt> but not on C<mbr> partitions."
12613 #: ../src/guestfs-actions.pod:4813
12614 msgid "guestfs_part_to_dev"
12618 #: ../src/guestfs-actions.pod:4815
12622 " guestfs_part_to_dev (guestfs_h *g,\n"
12623 " const char *partition);\n"
12628 #: ../src/guestfs-actions.pod:4819 ../fish/guestfish-actions.pod:3235
12630 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12631 "partition number, returning the device name (eg. \"/dev/sdb\")."
12635 #: ../src/guestfs-actions.pod:4823
12637 "The named partition must exist, for example as a string returned from "
12638 "C<guestfs_list_partitions>."
12642 #: ../src/guestfs-actions.pod:4831
12643 msgid "guestfs_ping_daemon"
12647 #: ../src/guestfs-actions.pod:4833
12651 " guestfs_ping_daemon (guestfs_h *g);\n"
12656 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3246
12658 "This is a test probe into the guestfs daemon running inside the qemu "
12659 "subprocess. Calling this function checks that the daemon responds to the "
12660 "ping message, without affecting the daemon or attached block device(s) in "
12665 #: ../src/guestfs-actions.pod:4845
12666 msgid "guestfs_pread"
12670 #: ../src/guestfs-actions.pod:4847
12674 " guestfs_pread (guestfs_h *g,\n"
12675 " const char *path,\n"
12677 " int64_t offset,\n"
12678 " size_t *size_r);\n"
12683 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3255
12685 "This command lets you read part of a file. It reads C<count> bytes of the "
12686 "file, starting at C<offset>, from file C<path>."
12690 #: ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4883
12691 #: ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12693 "This may read fewer bytes than requested. For further details see the "
12694 "L<pread(2)> system call."
12698 #: ../src/guestfs-actions.pod:4860
12699 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12703 #: ../src/guestfs-actions.pod:4871
12704 msgid "guestfs_pread_device"
12708 #: ../src/guestfs-actions.pod:4873
12712 " guestfs_pread_device (guestfs_h *g,\n"
12713 " const char *device,\n"
12715 " int64_t offset,\n"
12716 " size_t *size_r);\n"
12721 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3270
12723 "This command lets you read part of a file. It reads C<count> bytes of "
12724 "C<device>, starting at C<offset>."
12728 #: ../src/guestfs-actions.pod:4886
12729 msgid "See also C<guestfs_pread>."
12733 #: ../src/guestfs-actions.pod:4895
12734 msgid "(Added in 1.5.21)"
12738 #: ../src/guestfs-actions.pod:4897
12739 msgid "guestfs_pvcreate"
12743 #: ../src/guestfs-actions.pod:4899
12747 " guestfs_pvcreate (guestfs_h *g,\n"
12748 " const char *device);\n"
12753 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3285
12755 "This creates an LVM physical volume on the named C<device>, where C<device> "
12756 "should usually be a partition name such as C</dev/sda1>."
12760 #: ../src/guestfs-actions.pod:4911
12761 msgid "guestfs_pvremove"
12765 #: ../src/guestfs-actions.pod:4913
12769 " guestfs_pvremove (guestfs_h *g,\n"
12770 " const char *device);\n"
12775 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3293
12777 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12782 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3296
12784 "The implementation uses the C<pvremove> command which refuses to wipe "
12785 "physical volumes that contain any volume groups, so you have to remove those "
12790 #: ../src/guestfs-actions.pod:4928
12791 msgid "guestfs_pvresize"
12795 #: ../src/guestfs-actions.pod:4930
12799 " guestfs_pvresize (guestfs_h *g,\n"
12800 " const char *device);\n"
12805 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3304
12807 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12808 "the new size of the underlying device."
12812 #: ../src/guestfs-actions.pod:4941
12813 msgid "guestfs_pvresize_size"
12817 #: ../src/guestfs-actions.pod:4943
12821 " guestfs_pvresize_size (guestfs_h *g,\n"
12822 " const char *device,\n"
12823 " int64_t size);\n"
12828 #: ../src/guestfs-actions.pod:4948
12830 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12831 "specify the new size (in bytes) explicitly."
12835 #: ../src/guestfs-actions.pod:4955
12836 msgid "guestfs_pvs"
12840 #: ../src/guestfs-actions.pod:4957
12844 " guestfs_pvs (guestfs_h *g);\n"
12849 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3318
12851 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12856 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3321
12858 "This returns a list of just the device names that contain PVs (eg. C</dev/"
12863 #: ../src/guestfs-actions.pod:4966
12864 msgid "See also C<guestfs_pvs_full>."
12868 #: ../src/guestfs-actions.pod:4974
12869 msgid "guestfs_pvs_full"
12873 #: ../src/guestfs-actions.pod:4976
12876 " struct guestfs_lvm_pv_list *\n"
12877 " guestfs_pvs_full (guestfs_h *g);\n"
12882 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3330
12884 "List all the physical volumes detected. This is the equivalent of the L<pvs"
12885 "(8)> command. The \"full\" version includes all fields."
12889 #: ../src/guestfs-actions.pod:4982
12891 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12892 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
12896 #: ../src/guestfs-actions.pod:4988
12897 msgid "guestfs_pvuuid"
12901 #: ../src/guestfs-actions.pod:4990
12905 " guestfs_pvuuid (guestfs_h *g,\n"
12906 " const char *device);\n"
12911 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3337
12912 msgid "This command returns the UUID of the LVM PV C<device>."
12916 #: ../src/guestfs-actions.pod:5001
12917 msgid "guestfs_pwrite"
12921 #: ../src/guestfs-actions.pod:5003
12925 " guestfs_pwrite (guestfs_h *g,\n"
12926 " const char *path,\n"
12927 " const char *content,\n"
12928 " size_t content_size,\n"
12929 " int64_t offset);\n"
12934 #: ../src/guestfs-actions.pod:5010 ../fish/guestfish-actions.pod:3343
12936 "This command writes to part of a file. It writes the data buffer C<content> "
12937 "to the file C<path> starting at offset C<offset>."
12941 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3346
12943 "This command implements the L<pwrite(2)> system call, and like that system "
12944 "call it may not write the full data requested. The return value is the "
12945 "number of bytes that were actually written to the file. This could even be "
12946 "0, although short writes are unlikely for regular files in ordinary "
12951 #: ../src/guestfs-actions.pod:5019
12952 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12956 #: ../src/guestfs-actions.pod:5028
12957 msgid "guestfs_pwrite_device"
12961 #: ../src/guestfs-actions.pod:5030
12965 " guestfs_pwrite_device (guestfs_h *g,\n"
12966 " const char *device,\n"
12967 " const char *content,\n"
12968 " size_t content_size,\n"
12969 " int64_t offset);\n"
12974 #: ../src/guestfs-actions.pod:5037 ../fish/guestfish-actions.pod:3361
12976 "This command writes to part of a device. It writes the data buffer "
12977 "C<content> to C<device> starting at offset C<offset>."
12981 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3364
12983 "This command implements the L<pwrite(2)> system call, and like that system "
12984 "call it may not write the full data requested (although short writes to disk "
12985 "devices and partitions are probably impossible with standard Linux kernels)."
12989 #: ../src/guestfs-actions.pod:5045
12990 msgid "See also C<guestfs_pwrite>."
12994 #: ../src/guestfs-actions.pod:5052
12995 msgid "(Added in 1.5.20)"
12999 #: ../src/guestfs-actions.pod:5054
13000 msgid "guestfs_read_file"
13004 #: ../src/guestfs-actions.pod:5056
13008 " guestfs_read_file (guestfs_h *g,\n"
13009 " const char *path,\n"
13010 " size_t *size_r);\n"
13015 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3378
13016 msgid "This calls returns the contents of the file C<path> as a buffer."
13020 #: ../src/guestfs-actions.pod:5064
13022 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
13023 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
13024 "function is limited in the total size of file that can be handled."
13028 #: ../src/guestfs-actions.pod:5076
13029 msgid "(Added in 1.0.63)"
13033 #: ../src/guestfs-actions.pod:5078
13034 msgid "guestfs_read_lines"
13038 #: ../src/guestfs-actions.pod:5080
13042 " guestfs_read_lines (guestfs_h *g,\n"
13043 " const char *path);\n"
13048 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3395
13050 "The file contents are returned as a list of lines. Trailing C<LF> and "
13051 "C<CRLF> character sequences are I<not> returned."
13055 #: ../src/guestfs-actions.pod:5089
13057 "Note that this function cannot correctly handle binary files (specifically, "
13058 "files containing C<\\0> character which is treated as end of line). For "
13059 "those you need to use the C<guestfs_read_file> function which has a more "
13060 "complex interface."
13064 #: ../src/guestfs-actions.pod:5100
13065 msgid "guestfs_readdir"
13069 #: ../src/guestfs-actions.pod:5102
13072 " struct guestfs_dirent_list *\n"
13073 " guestfs_readdir (guestfs_h *g,\n"
13074 " const char *dir);\n"
13079 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3407
13080 msgid "This returns the list of directory entries in directory C<dir>."
13084 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3409
13086 "All entries in the directory are returned, including C<.> and C<..>. The "
13087 "entries are I<not> sorted, but returned in the same order as the underlying "
13092 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3413
13094 "Also this call returns basic file type information about each file. The "
13095 "C<ftyp> field will contain one of the following characters:"
13099 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3418
13104 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3420
13105 msgid "Block special"
13109 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3422
13114 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3424
13115 msgid "Char special"
13119 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3426
13124 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3428
13129 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3430
13134 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3432
13135 msgid "FIFO (named pipe)"
13139 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3434
13144 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3436
13145 msgid "Symbolic link"
13149 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3438
13154 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3440
13155 msgid "Regular file"
13159 #: ../src/guestfs-actions.pod:5141 ../fish/guestfish-actions.pod:3442
13164 #: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3444
13169 #: ../src/guestfs-actions.pod:5145 ../fish/guestfish-actions.pod:3446
13174 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3448
13175 msgid "Unknown file type"
13179 #: ../src/guestfs-actions.pod:5149 ../fish/guestfish-actions.pod:3450
13184 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3452
13186 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
13190 #: ../src/guestfs-actions.pod:5156
13192 "This function is primarily intended for use by programs. To get a simple "
13193 "list of names, use C<guestfs_ls>. To get a printable directory for human "
13194 "consumption, use C<guestfs_ll>."
13198 #: ../src/guestfs-actions.pod:5160
13200 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
13201 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
13205 #: ../src/guestfs-actions.pod:5166
13206 msgid "guestfs_readlink"
13210 #: ../src/guestfs-actions.pod:5168
13214 " guestfs_readlink (guestfs_h *g,\n"
13215 " const char *path);\n"
13220 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3465
13221 msgid "This command reads the target of a symbolic link."
13225 #: ../src/guestfs-actions.pod:5179
13226 msgid "guestfs_readlinklist"
13230 #: ../src/guestfs-actions.pod:5181
13234 " guestfs_readlinklist (guestfs_h *g,\n"
13235 " const char *path,\n"
13236 " char *const *names);\n"
13241 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3471
13243 "This call allows you to do a C<readlink> operation on multiple files, where "
13244 "all files are in the directory C<path>. C<names> is the list of files from "
13249 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3475
13251 "On return you get a list of strings, with a one-to-one correspondence to the "
13252 "C<names> list. Each string is the value of the symbolic link."
13256 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:3479
13258 "If the C<readlink(2)> operation fails on any name, then the corresponding "
13259 "result string is the empty string C<\"\">. However the whole operation is "
13260 "completed even if there were C<readlink(2)> errors, and so you can call this "
13261 "function with names where you don't know if they are symbolic links already "
13262 "(albeit slightly less efficient)."
13266 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3486
13268 "This call is intended for programs that want to efficiently list a directory "
13269 "contents without making many round-trips. Very long directory listings "
13270 "might cause the protocol message size to be exceeded, causing this call to "
13271 "fail. The caller must split up such requests into smaller groups of names."
13275 #: ../src/guestfs-actions.pod:5214
13276 msgid "guestfs_realpath"
13280 #: ../src/guestfs-actions.pod:5216
13284 " guestfs_realpath (guestfs_h *g,\n"
13285 " const char *path);\n"
13290 #: ../src/guestfs-actions.pod:5220 ../fish/guestfish-actions.pod:3497
13292 "Return the canonicalized absolute pathname of C<path>. The returned path "
13293 "has no C<.>, C<..> or symbolic link path elements."
13297 #: ../src/guestfs-actions.pod:5228
13298 msgid "guestfs_removexattr"
13302 #: ../src/guestfs-actions.pod:5230
13306 " guestfs_removexattr (guestfs_h *g,\n"
13307 " const char *xattr,\n"
13308 " const char *path);\n"
13313 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3504
13315 "This call removes the extended attribute named C<xattr> of the file C<path>."
13319 #: ../src/guestfs-actions.pod:5238
13320 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
13324 #: ../src/guestfs-actions.pod:5244
13325 msgid "guestfs_resize2fs"
13329 #: ../src/guestfs-actions.pod:5246
13333 " guestfs_resize2fs (guestfs_h *g,\n"
13334 " const char *device);\n"
13339 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3513
13341 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
13342 "underlying device."
13346 #: ../src/guestfs-actions.pod:5253
13348 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
13349 "C<device> before calling this command. For unknown reasons C<resize2fs> "
13350 "sometimes gives an error about this and sometimes not. In any case, it is "
13351 "always safe to call C<guestfs_e2fsck_f> before calling this function."
13355 #: ../src/guestfs-actions.pod:5263
13356 msgid "guestfs_resize2fs_size"
13360 #: ../src/guestfs-actions.pod:5265
13364 " guestfs_resize2fs_size (guestfs_h *g,\n"
13365 " const char *device,\n"
13366 " int64_t size);\n"
13371 #: ../src/guestfs-actions.pod:5270
13373 "This command is the same as C<guestfs_resize2fs> except that it allows you "
13374 "to specify the new size (in bytes) explicitly."
13378 #: ../src/guestfs-actions.pod:5277
13383 #: ../src/guestfs-actions.pod:5279
13387 " guestfs_rm (guestfs_h *g,\n"
13388 " const char *path);\n"
13393 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3533
13394 msgid "Remove the single file C<path>."
13398 #: ../src/guestfs-actions.pod:5289
13399 msgid "guestfs_rm_rf"
13403 #: ../src/guestfs-actions.pod:5291
13407 " guestfs_rm_rf (guestfs_h *g,\n"
13408 " const char *path);\n"
13413 #: ../src/guestfs-actions.pod:5295 ../fish/guestfish-actions.pod:3539
13415 "Remove the file or directory C<path>, recursively removing the contents if "
13416 "its a directory. This is like the C<rm -rf> shell command."
13420 #: ../src/guestfs-actions.pod:5303
13421 msgid "guestfs_rmdir"
13425 #: ../src/guestfs-actions.pod:5305
13429 " guestfs_rmdir (guestfs_h *g,\n"
13430 " const char *path);\n"
13435 #: ../src/guestfs-actions.pod:5309 ../fish/guestfish-actions.pod:3547
13436 msgid "Remove the single directory C<path>."
13440 #: ../src/guestfs-actions.pod:5315
13441 msgid "guestfs_rmmountpoint"
13445 #: ../src/guestfs-actions.pod:5317
13449 " guestfs_rmmountpoint (guestfs_h *g,\n"
13450 " const char *exemptpath);\n"
13455 #: ../src/guestfs-actions.pod:5321
13457 "This calls removes a mountpoint that was previously created with "
13458 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13462 #: ../src/guestfs-actions.pod:5329
13463 msgid "guestfs_scrub_device"
13467 #: ../src/guestfs-actions.pod:5331
13471 " guestfs_scrub_device (guestfs_h *g,\n"
13472 " const char *device);\n"
13477 #: ../src/guestfs-actions.pod:5335 ../fish/guestfish-actions.pod:3561
13479 "This command writes patterns over C<device> to make data retrieval more "
13484 #: ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5359
13485 #: ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3564
13486 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13488 "It is an interface to the L<scrub(1)> program. See that manual page for "
13493 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5364
13494 #: ../src/guestfs-actions.pod:5383
13495 msgid "(Added in 1.0.52)"
13499 #: ../src/guestfs-actions.pod:5348
13500 msgid "guestfs_scrub_file"
13504 #: ../src/guestfs-actions.pod:5350
13508 " guestfs_scrub_file (guestfs_h *g,\n"
13509 " const char *file);\n"
13514 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3574
13516 "This command writes patterns over a file to make data retrieval more "
13521 #: ../src/guestfs-actions.pod:5357 ../fish/guestfish-actions.pod:3577
13522 msgid "The file is I<removed> after scrubbing."
13526 #: ../src/guestfs-actions.pod:5366
13527 msgid "guestfs_scrub_freespace"
13531 #: ../src/guestfs-actions.pod:5368
13535 " guestfs_scrub_freespace (guestfs_h *g,\n"
13536 " const char *dir);\n"
13541 #: ../src/guestfs-actions.pod:5372
13543 "This command creates the directory C<dir> and then fills it with files until "
13544 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13545 "and deletes them. The intention is to scrub any free space on the partition "
13546 "containing C<dir>."
13550 #: ../src/guestfs-actions.pod:5385
13551 msgid "guestfs_set_append"
13555 #: ../src/guestfs-actions.pod:5387
13559 " guestfs_set_append (guestfs_h *g,\n"
13560 " const char *append);\n"
13565 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3601
13567 "This function is used to add additional options to the guest kernel command "
13572 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3604
13574 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13575 "environment variable."
13579 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3607
13581 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13582 "(libguestfs always adds a few of its own)."
13586 #: ../src/guestfs-actions.pod:5404
13587 msgid "guestfs_set_autosync"
13591 #: ../src/guestfs-actions.pod:5406
13595 " guestfs_set_autosync (guestfs_h *g,\n"
13596 " int autosync);\n"
13601 #: ../src/guestfs-actions.pod:5410
13603 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13604 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13605 "the handle is closed (also if the program exits without closing handles)."
13609 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3621
13611 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13612 "disabled by default)."
13616 #: ../src/guestfs-actions.pod:5422
13617 msgid "guestfs_set_direct"
13621 #: ../src/guestfs-actions.pod:5424
13625 " guestfs_set_direct (guestfs_h *g,\n"
13631 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3630
13633 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13634 "passed directly through to the appliance once it is launched."
13638 #: ../src/guestfs-actions.pod:5432
13640 "One consequence of this is that log messages aren't caught by the library "
13641 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13646 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3638
13647 msgid "You probably don't want to use this unless you know what you are doing."
13651 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3641
13652 msgid "The default is disabled."
13656 #: ../src/guestfs-actions.pod:5445
13657 msgid "guestfs_set_e2label"
13661 #: ../src/guestfs-actions.pod:5447
13665 " guestfs_set_e2label (guestfs_h *g,\n"
13666 " const char *device,\n"
13667 " const char *label);\n"
13672 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3647
13674 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13675 "C<label>. Filesystem labels are limited to 16 characters."
13679 #: ../src/guestfs-actions.pod:5456
13681 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13682 "the existing label on a filesystem."
13686 #: ../src/guestfs-actions.pod:5463
13687 msgid "guestfs_set_e2uuid"
13691 #: ../src/guestfs-actions.pod:5465
13695 " guestfs_set_e2uuid (guestfs_h *g,\n"
13696 " const char *device,\n"
13697 " const char *uuid);\n"
13702 #: ../src/guestfs-actions.pod:5470 ../fish/guestfish-actions.pod:3658
13704 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13705 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13706 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13710 #: ../src/guestfs-actions.pod:5475
13712 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13713 "the existing UUID of a filesystem."
13717 #: ../src/guestfs-actions.pod:5482
13718 msgid "guestfs_set_memsize"
13722 #: ../src/guestfs-actions.pod:5484
13726 " guestfs_set_memsize (guestfs_h *g,\n"
13732 #: ../src/guestfs-actions.pod:5488
13734 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13735 "This only has any effect if called before C<guestfs_launch>."
13739 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3676
13741 "You can also change this by setting the environment variable "
13742 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13746 #: ../src/guestfs-actions.pod:5503
13747 msgid "guestfs_set_network"
13751 #: ../src/guestfs-actions.pod:5505
13755 " guestfs_set_network (guestfs_h *g,\n"
13761 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3689
13763 "If C<network> is true, then the network is enabled in the libguestfs "
13764 "appliance. The default is false."
13768 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3692
13770 "This affects whether commands are able to access the network (see L<guestfs"
13771 "(3)/RUNNING COMMANDS>)."
13775 #: ../src/guestfs-actions.pod:5515
13777 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13782 #: ../src/guestfs-actions.pod:5522
13783 msgid "guestfs_set_path"
13787 #: ../src/guestfs-actions.pod:5524
13791 " guestfs_set_path (guestfs_h *g,\n"
13792 " const char *searchpath);\n"
13797 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3704
13798 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13802 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3706
13804 "The default is C<$libdir/guestfs> unless overridden by setting "
13805 "C<LIBGUESTFS_PATH> environment variable."
13809 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3709
13810 msgid "Setting C<path> to C<NULL> restores the default path."
13814 #: ../src/guestfs-actions.pod:5539
13815 msgid "guestfs_set_qemu"
13819 #: ../src/guestfs-actions.pod:5541
13823 " guestfs_set_qemu (guestfs_h *g,\n"
13824 " const char *qemu);\n"
13829 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3717
13830 msgid "Set the qemu binary that we will use."
13834 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3719
13836 "The default is chosen when the library was compiled by the configure script."
13840 #: ../src/guestfs-actions.pod:5550 ../fish/guestfish-actions.pod:3722
13842 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13847 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3725
13848 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13852 #: ../src/guestfs-actions.pod:5555 ../fish/guestfish-actions.pod:3727
13854 "Note that you should call this function as early as possible after creating "
13855 "the handle. This is because some pre-launch operations depend on testing "
13856 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13857 "don't retest features, and so you might see inconsistent results. Using the "
13858 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13859 "the qemu binary at the same time as the handle is created."
13863 #: ../src/guestfs-actions.pod:5567
13864 msgid "guestfs_set_recovery_proc"
13868 #: ../src/guestfs-actions.pod:5569
13872 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13873 " int recoveryproc);\n"
13878 #: ../src/guestfs-actions.pod:5573
13880 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13881 "not create a recovery process. The purpose of the recovery process is to "
13882 "stop runaway qemu processes in the case where the main program aborts "
13887 #: ../src/guestfs-actions.pod:5578
13889 "This only has any effect if called before C<guestfs_launch>, and the default "
13894 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3749
13896 "About the only time when you would want to disable this is if the main "
13897 "process will fork itself into the background (\"daemonize\" itself). In "
13898 "this case the recovery process thinks that the main program has disappeared "
13899 "and so kills qemu, which is not very helpful."
13903 #: ../src/guestfs-actions.pod:5591
13904 msgid "guestfs_set_selinux"
13908 #: ../src/guestfs-actions.pod:5593
13912 " guestfs_set_selinux (guestfs_h *g,\n"
13918 #: ../src/guestfs-actions.pod:5597 ../fish/guestfish-actions.pod:3761
13920 "This sets the selinux flag that is passed to the appliance at boot time. "
13921 "The default is C<selinux=0> (disabled)."
13925 #: ../src/guestfs-actions.pod:5600 ../fish/guestfish-actions.pod:3764
13927 "Note that if SELinux is enabled, it is always in Permissive mode "
13928 "(C<enforcing=0>)."
13932 #: ../src/guestfs-actions.pod:5610
13933 msgid "guestfs_set_trace"
13937 #: ../src/guestfs-actions.pod:5612
13941 " guestfs_set_trace (guestfs_h *g,\n"
13947 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3776
13949 "If the command trace flag is set to 1, then commands are printed on stderr "
13950 "before they are executed in a format which is very similar to the one used "
13951 "by guestfish. In other words, you can run a program with this enabled, and "
13952 "you will get out a script which you can feed to guestfish to perform the "
13953 "same set of actions."
13957 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3783
13959 "If you want to trace C API calls into libguestfs (and other libraries) then "
13960 "possibly a better way is to use the external ltrace(1) command."
13964 #: ../src/guestfs-actions.pod:5627 ../fish/guestfish-actions.pod:3787
13966 "Command traces are disabled unless the environment variable "
13967 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13971 #: ../src/guestfs-actions.pod:5634
13972 msgid "guestfs_set_verbose"
13976 #: ../src/guestfs-actions.pod:5636
13980 " guestfs_set_verbose (guestfs_h *g,\n"
13986 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:3796
13987 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13991 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3798
13993 "Verbose messages are disabled unless the environment variable "
13994 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13998 #: ../src/guestfs-actions.pod:5649
13999 msgid "guestfs_setcon"
14003 #: ../src/guestfs-actions.pod:5651
14007 " guestfs_setcon (guestfs_h *g,\n"
14008 " const char *context);\n"
14013 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3805
14015 "This sets the SELinux security context of the daemon to the string "
14020 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3808
14021 msgid "See the documentation about SELINUX in L<guestfs(3)>."
14025 #: ../src/guestfs-actions.pod:5664
14026 msgid "guestfs_setxattr"
14030 #: ../src/guestfs-actions.pod:5666
14034 " guestfs_setxattr (guestfs_h *g,\n"
14035 " const char *xattr,\n"
14036 " const char *val,\n"
14038 " const char *path);\n"
14043 #: ../src/guestfs-actions.pod:5673 ../fish/guestfish-actions.pod:3814
14045 "This call sets the extended attribute named C<xattr> of the file C<path> to "
14046 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
14050 #: ../src/guestfs-actions.pod:5677
14051 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
14055 #: ../src/guestfs-actions.pod:5683
14056 msgid "guestfs_sfdisk"
14060 #: ../src/guestfs-actions.pod:5685
14064 " guestfs_sfdisk (guestfs_h *g,\n"
14065 " const char *device,\n"
14069 " char *const *lines);\n"
14074 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3824
14076 "This is a direct interface to the L<sfdisk(8)> program for creating "
14077 "partitions on block devices."
14081 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3827
14082 msgid "C<device> should be a block device, for example C</dev/sda>."
14086 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3829
14088 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
14089 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
14090 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
14091 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
14092 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
14093 "the kernel) cannot work out the right geometry and you will need to tell it."
14097 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3837
14099 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
14100 "refer to the L<sfdisk(8)> manpage."
14104 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3840
14106 "To create a single partition occupying the whole disk, you would pass "
14107 "C<lines> as a single element list, when the single element being the string "
14112 #: ../src/guestfs-actions.pod:5713
14114 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
14118 #: ../src/guestfs-actions.pod:5723
14119 msgid "guestfs_sfdiskM"
14123 #: ../src/guestfs-actions.pod:5725
14127 " guestfs_sfdiskM (guestfs_h *g,\n"
14128 " const char *device,\n"
14129 " char *const *lines);\n"
14134 #: ../src/guestfs-actions.pod:5730
14136 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
14137 "partition sizes are specified in megabytes only (rounded to the nearest "
14138 "cylinder) and you don't need to specify the cyls, heads and sectors "
14139 "parameters which were rarely if ever used anyway."
14143 #: ../src/guestfs-actions.pod:5736
14145 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
14146 "C<guestfs_part_disk>"
14150 #: ../src/guestfs-actions.pod:5746
14151 msgid "guestfs_sfdisk_N"
14155 #: ../src/guestfs-actions.pod:5748
14159 " guestfs_sfdisk_N (guestfs_h *g,\n"
14160 " const char *device,\n"
14165 " const char *line);\n"
14170 #: ../src/guestfs-actions.pod:5757 ../fish/guestfish-actions.pod:3870
14172 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
14173 "(note: C<n> counts from 1)."
14177 #: ../src/guestfs-actions.pod:5760
14179 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
14180 "for the cyls/heads/sectors parameters."
14184 #: ../src/guestfs-actions.pod:5763
14185 msgid "See also: C<guestfs_part_add>"
14189 #: ../src/guestfs-actions.pod:5772
14190 msgid "guestfs_sfdisk_disk_geometry"
14194 #: ../src/guestfs-actions.pod:5774
14198 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
14199 " const char *device);\n"
14204 #: ../src/guestfs-actions.pod:5778
14206 "This displays the disk geometry of C<device> read from the partition table. "
14207 "Especially in the case where the underlying block device has been resized, "
14208 "this can be different from the kernel's idea of the geometry (see "
14209 "C<guestfs_sfdisk_kernel_geometry>)."
14213 #: ../src/guestfs-actions.pod:5783 ../src/guestfs-actions.pod:5799
14214 #: ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
14215 msgid "The result is in human-readable format, and not designed to be parsed."
14219 #: ../src/guestfs-actions.pod:5791
14220 msgid "guestfs_sfdisk_kernel_geometry"
14224 #: ../src/guestfs-actions.pod:5793
14228 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
14229 " const char *device);\n"
14234 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3897
14235 msgid "This displays the kernel's idea of the geometry of C<device>."
14239 #: ../src/guestfs-actions.pod:5807
14240 msgid "guestfs_sfdisk_l"
14244 #: ../src/guestfs-actions.pod:5809
14248 " guestfs_sfdisk_l (guestfs_h *g,\n"
14249 " const char *device);\n"
14254 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3906
14256 "This displays the partition table on C<device>, in the human-readable output "
14257 "of the L<sfdisk(8)> command. It is not intended to be parsed."
14261 #: ../src/guestfs-actions.pod:5817
14262 msgid "See also: C<guestfs_part_list>"
14266 #: ../src/guestfs-actions.pod:5824
14271 #: ../src/guestfs-actions.pod:5826
14275 " guestfs_sh (guestfs_h *g,\n"
14276 " const char *command);\n"
14281 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3916
14283 "This call runs a command from the guest filesystem via the guest's C</bin/"
14288 #: ../src/guestfs-actions.pod:5833
14289 msgid "This is like C<guestfs_command>, but passes the command to:"
14293 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3921
14296 " /bin/sh -c \"command\"\n"
14301 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3923
14303 "Depending on the guest's shell, this usually results in wildcards being "
14304 "expanded, shell expressions being interpolated and so on."
14308 #: ../src/guestfs-actions.pod:5841
14309 msgid "All the provisos about C<guestfs_command> apply to this call."
14313 #: ../src/guestfs-actions.pod:5848
14314 msgid "guestfs_sh_lines"
14318 #: ../src/guestfs-actions.pod:5850
14322 " guestfs_sh_lines (guestfs_h *g,\n"
14323 " const char *command);\n"
14328 #: ../src/guestfs-actions.pod:5854
14330 "This is the same as C<guestfs_sh>, but splits the result into a list of "
14335 #: ../src/guestfs-actions.pod:5857
14336 msgid "See also: C<guestfs_command_lines>"
14340 #: ../src/guestfs-actions.pod:5865
14341 msgid "guestfs_sleep"
14345 #: ../src/guestfs-actions.pod:5867
14349 " guestfs_sleep (guestfs_h *g,\n"
14355 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3942
14356 msgid "Sleep for C<secs> seconds."
14360 #: ../src/guestfs-actions.pod:5875
14361 msgid "(Added in 1.0.41)"
14365 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-structs.pod:109
14366 msgid "guestfs_stat"
14370 #: ../src/guestfs-actions.pod:5879
14373 " struct guestfs_stat *\n"
14374 " guestfs_stat (guestfs_h *g,\n"
14375 " const char *path);\n"
14380 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3950
14381 msgid "This is the same as the C<stat(2)> system call."
14385 #: ../src/guestfs-actions.pod:5893 ../src/guestfs-structs.pod:135
14386 msgid "guestfs_statvfs"
14390 #: ../src/guestfs-actions.pod:5895
14393 " struct guestfs_statvfs *\n"
14394 " guestfs_statvfs (guestfs_h *g,\n"
14395 " const char *path);\n"
14400 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3956
14402 "Returns file system statistics for any mounted file system. C<path> should "
14403 "be a file or directory in the mounted file system (typically it is the mount "
14404 "point itself, but it doesn't need to be)."
14408 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3960
14409 msgid "This is the same as the C<statvfs(2)> system call."
14413 #: ../src/guestfs-actions.pod:5905
14415 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14416 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14420 #: ../src/guestfs-actions.pod:5911
14421 msgid "guestfs_strings"
14425 #: ../src/guestfs-actions.pod:5913
14429 " guestfs_strings (guestfs_h *g,\n"
14430 " const char *path);\n"
14435 #: ../src/guestfs-actions.pod:5917 ../fish/guestfish-actions.pod:3966
14437 "This runs the L<strings(1)> command on a file and returns the list of "
14438 "printable strings found."
14442 #: ../src/guestfs-actions.pod:5929
14443 msgid "guestfs_strings_e"
14447 #: ../src/guestfs-actions.pod:5931
14451 " guestfs_strings_e (guestfs_h *g,\n"
14452 " const char *encoding,\n"
14453 " const char *path);\n"
14458 #: ../src/guestfs-actions.pod:5936
14460 "This is like the C<guestfs_strings> command, but allows you to specify the "
14461 "encoding of strings that are looked for in the source file C<path>."
14465 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:3980
14466 msgid "Allowed encodings are:"
14470 #: ../src/guestfs-actions.pod:5944 ../fish/guestfish-actions.pod:3984
14475 #: ../src/guestfs-actions.pod:5946
14477 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14478 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14482 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:3989
14487 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3991
14488 msgid "Single 8-bit-byte characters."
14492 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3993
14497 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:3995
14498 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14502 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3998
14503 msgid "l (lower case letter L)"
14507 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4000
14509 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14510 "examining binaries in Windows guests."
14514 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:4003
14519 #: ../src/guestfs-actions.pod:5965 ../fish/guestfish-actions.pod:4005
14520 msgid "32-bit big endian such as UCS-4BE."
14524 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:4007
14529 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4009
14530 msgid "32-bit little endian such as UCS-4LE."
14534 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4013
14535 msgid "The returned strings are transcoded to UTF-8."
14539 #: ../src/guestfs-actions.pod:5984
14540 msgid "guestfs_swapoff_device"
14544 #: ../src/guestfs-actions.pod:5986
14548 " guestfs_swapoff_device (guestfs_h *g,\n"
14549 " const char *device);\n"
14554 #: ../src/guestfs-actions.pod:5990
14556 "This command disables the libguestfs appliance swap device or partition "
14557 "named C<device>. See C<guestfs_swapon_device>."
14561 #: ../src/guestfs-actions.pod:5998
14562 msgid "guestfs_swapoff_file"
14566 #: ../src/guestfs-actions.pod:6000
14570 " guestfs_swapoff_file (guestfs_h *g,\n"
14571 " const char *file);\n"
14576 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4030
14577 msgid "This command disables the libguestfs appliance swap on file."
14581 #: ../src/guestfs-actions.pod:6010
14582 msgid "guestfs_swapoff_label"
14586 #: ../src/guestfs-actions.pod:6012
14590 " guestfs_swapoff_label (guestfs_h *g,\n"
14591 " const char *label);\n"
14596 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4036
14598 "This command disables the libguestfs appliance swap on labeled swap "
14603 #: ../src/guestfs-actions.pod:6023
14604 msgid "guestfs_swapoff_uuid"
14608 #: ../src/guestfs-actions.pod:6025
14612 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14613 " const char *uuid);\n"
14618 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4043
14620 "This command disables the libguestfs appliance swap partition with the given "
14625 #: ../src/guestfs-actions.pod:6036
14626 msgid "guestfs_swapon_device"
14630 #: ../src/guestfs-actions.pod:6038
14634 " guestfs_swapon_device (guestfs_h *g,\n"
14635 " const char *device);\n"
14640 #: ../src/guestfs-actions.pod:6042
14642 "This command enables the libguestfs appliance to use the swap device or "
14643 "partition named C<device>. The increased memory is made available for all "
14644 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14648 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4055
14650 "Note that you should not swap to existing guest swap partitions unless you "
14651 "know what you are doing. They may contain hibernation information, or other "
14652 "information that the guest doesn't want you to trash. You also risk leaking "
14653 "information about the host to the guest this way. Instead, attach a new "
14654 "host device to the guest and swap on that."
14658 #: ../src/guestfs-actions.pod:6058
14659 msgid "guestfs_swapon_file"
14663 #: ../src/guestfs-actions.pod:6060
14667 " guestfs_swapon_file (guestfs_h *g,\n"
14668 " const char *file);\n"
14673 #: ../src/guestfs-actions.pod:6064
14675 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14680 #: ../src/guestfs-actions.pod:6071
14681 msgid "guestfs_swapon_label"
14685 #: ../src/guestfs-actions.pod:6073
14689 " guestfs_swapon_label (guestfs_h *g,\n"
14690 " const char *label);\n"
14695 #: ../src/guestfs-actions.pod:6077
14697 "This command enables swap to a labeled swap partition. See "
14698 "C<guestfs_swapon_device> for other notes."
14702 #: ../src/guestfs-actions.pod:6084
14703 msgid "guestfs_swapon_uuid"
14707 #: ../src/guestfs-actions.pod:6086
14711 " guestfs_swapon_uuid (guestfs_h *g,\n"
14712 " const char *uuid);\n"
14717 #: ../src/guestfs-actions.pod:6090
14719 "This command enables swap to a swap partition with the given UUID. See "
14720 "C<guestfs_swapon_device> for other notes."
14724 #: ../src/guestfs-actions.pod:6097
14725 msgid "guestfs_sync"
14729 #: ../src/guestfs-actions.pod:6099
14733 " guestfs_sync (guestfs_h *g);\n"
14738 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4087
14740 "This syncs the disk, so that any writes are flushed through to the "
14741 "underlying disk image."
14745 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4090
14747 "You should always call this if you have modified a disk image, before "
14748 "closing the handle."
14752 #: ../src/guestfs-actions.pod:6112
14753 msgid "guestfs_tail"
14757 #: ../src/guestfs-actions.pod:6114
14761 " guestfs_tail (guestfs_h *g,\n"
14762 " const char *path);\n"
14767 #: ../src/guestfs-actions.pod:6118 ../fish/guestfish-actions.pod:4097
14769 "This command returns up to the last 10 lines of a file as a list of strings."
14773 #: ../src/guestfs-actions.pod:6130
14774 msgid "guestfs_tail_n"
14778 #: ../src/guestfs-actions.pod:6132
14782 " guestfs_tail_n (guestfs_h *g,\n"
14784 " const char *path);\n"
14789 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4107
14791 "If the parameter C<nrlines> is a positive number, this returns the last "
14792 "C<nrlines> lines of the file C<path>."
14796 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4110
14798 "If the parameter C<nrlines> is a negative number, this returns lines from "
14799 "the file C<path>, starting with the C<-nrlines>th line."
14803 #: ../src/guestfs-actions.pod:6154
14804 msgid "guestfs_tar_in"
14808 #: ../src/guestfs-actions.pod:6156
14812 " guestfs_tar_in (guestfs_h *g,\n"
14813 " const char *tarfile,\n"
14814 " const char *directory);\n"
14819 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4122
14821 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14822 "tar file) into C<directory>."
14826 #: ../src/guestfs-actions.pod:6164
14828 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14832 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6186
14833 #: ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6218
14834 msgid "(Added in 1.0.3)"
14838 #: ../src/guestfs-actions.pod:6171
14839 msgid "guestfs_tar_out"
14843 #: ../src/guestfs-actions.pod:6173
14847 " guestfs_tar_out (guestfs_h *g,\n"
14848 " const char *directory,\n"
14849 " const char *tarfile);\n"
14854 #: ../src/guestfs-actions.pod:6178 ../fish/guestfish-actions.pod:4134
14856 "This command packs the contents of C<directory> and downloads it to local "
14861 #: ../src/guestfs-actions.pod:6181
14863 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14864 "C<guestfs_txz_out>."
14868 #: ../src/guestfs-actions.pod:6188
14869 msgid "guestfs_tgz_in"
14873 #: ../src/guestfs-actions.pod:6190
14877 " guestfs_tgz_in (guestfs_h *g,\n"
14878 " const char *tarball,\n"
14879 " const char *directory);\n"
14884 #: ../src/guestfs-actions.pod:6195 ../fish/guestfish-actions.pod:4146
14886 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14887 "tar file) into C<directory>."
14891 #: ../src/guestfs-actions.pod:6198
14892 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14896 #: ../src/guestfs-actions.pod:6204
14897 msgid "guestfs_tgz_out"
14901 #: ../src/guestfs-actions.pod:6206
14905 " guestfs_tgz_out (guestfs_h *g,\n"
14906 " const char *directory,\n"
14907 " const char *tarball);\n"
14912 #: ../src/guestfs-actions.pod:6211 ../fish/guestfish-actions.pod:4157
14914 "This command packs the contents of C<directory> and downloads it to local "
14919 #: ../src/guestfs-actions.pod:6214
14920 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14924 #: ../src/guestfs-actions.pod:6220
14925 msgid "guestfs_touch"
14929 #: ../src/guestfs-actions.pod:6222
14933 " guestfs_touch (guestfs_h *g,\n"
14934 " const char *path);\n"
14939 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4168
14941 "Touch acts like the L<touch(1)> command. It can be used to update the "
14942 "timestamps on a file, or, if the file does not exist, to create a new zero-"
14947 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4172
14949 "This command only works on regular files, and will fail on other file types "
14950 "such as directories, symbolic links, block special etc."
14954 #: ../src/guestfs-actions.pod:6237
14955 msgid "guestfs_truncate"
14959 #: ../src/guestfs-actions.pod:6239
14963 " guestfs_truncate (guestfs_h *g,\n"
14964 " const char *path);\n"
14969 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4179
14971 "This command truncates C<path> to a zero-length file. The file must exist "
14976 #: ../src/guestfs-actions.pod:6250
14977 msgid "guestfs_truncate_size"
14981 #: ../src/guestfs-actions.pod:6252
14985 " guestfs_truncate_size (guestfs_h *g,\n"
14986 " const char *path,\n"
14987 " int64_t size);\n"
14992 #: ../src/guestfs-actions.pod:6257 ../fish/guestfish-actions.pod:4186
14994 "This command truncates C<path> to size C<size> bytes. The file must exist "
14999 #: ../src/guestfs-actions.pod:6260
15001 "If the current file size is less than C<size> then the file is extended to "
15002 "the required size with zero bytes. This creates a sparse file (ie. disk "
15003 "blocks are not allocated for the file until you write to it). To create a "
15004 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
15008 #: ../src/guestfs-actions.pod:6270
15009 msgid "guestfs_tune2fs_l"
15013 #: ../src/guestfs-actions.pod:6272
15017 " guestfs_tune2fs_l (guestfs_h *g,\n"
15018 " const char *device);\n"
15023 #: ../src/guestfs-actions.pod:6276 ../fish/guestfish-actions.pod:4199
15025 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
15030 #: ../src/guestfs-actions.pod:6279 ../fish/guestfish-actions.pod:4202
15032 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
15033 "for more details. The list of fields returned isn't clearly defined, and "
15034 "depends on both the version of C<tune2fs> that libguestfs was built against, "
15035 "and the filesystem itself."
15039 #: ../src/guestfs-actions.pod:6292
15040 msgid "guestfs_txz_in"
15044 #: ../src/guestfs-actions.pod:6294
15048 " guestfs_txz_in (guestfs_h *g,\n"
15049 " const char *tarball,\n"
15050 " const char *directory);\n"
15055 #: ../src/guestfs-actions.pod:6299 ../fish/guestfish-actions.pod:4211
15057 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
15058 "tar file) into C<directory>."
15062 #: ../src/guestfs-actions.pod:6306
15063 msgid "guestfs_txz_out"
15067 #: ../src/guestfs-actions.pod:6308
15071 " guestfs_txz_out (guestfs_h *g,\n"
15072 " const char *directory,\n"
15073 " const char *tarball);\n"
15078 #: ../src/guestfs-actions.pod:6313 ../fish/guestfish-actions.pod:4220
15080 "This command packs the contents of C<directory> and downloads it to local "
15081 "file C<tarball> (as an xz compressed tar archive)."
15085 #: ../src/guestfs-actions.pod:6320
15086 msgid "guestfs_umask"
15090 #: ../src/guestfs-actions.pod:6322
15094 " guestfs_umask (guestfs_h *g,\n"
15100 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4229
15102 "This function sets the mask used for creating new files and device nodes to "
15107 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4232
15109 "Typical umask values would be C<022> which creates new files with "
15110 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
15111 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
15115 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4237
15117 "The default umask is C<022>. This is important because it means that "
15118 "directories and device nodes will be created with C<0644> or C<0755> mode "
15119 "even if you specify C<0777>."
15123 #: ../src/guestfs-actions.pod:6338
15125 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
15126 "C<guestfs_mkdir>."
15130 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4244
15131 msgid "This call returns the previous umask."
15135 #: ../src/guestfs-actions.pod:6347
15136 msgid "guestfs_umount"
15140 #: ../src/guestfs-actions.pod:6349
15144 " guestfs_umount (guestfs_h *g,\n"
15145 " const char *pathordevice);\n"
15150 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4252
15152 "This unmounts the given filesystem. The filesystem may be specified either "
15153 "by its mountpoint (path) or the device which contains the filesystem."
15157 #: ../src/guestfs-actions.pod:6361
15158 msgid "guestfs_umount_all"
15162 #: ../src/guestfs-actions.pod:6363
15166 " guestfs_umount_all (guestfs_h *g);\n"
15171 #: ../src/guestfs-actions.pod:6366 ../fish/guestfish-actions.pod:4262
15172 msgid "This unmounts all mounted filesystems."
15176 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4264
15177 msgid "Some internal mounts are not unmounted by this call."
15181 #: ../src/guestfs-actions.pod:6374
15182 msgid "guestfs_upload"
15186 #: ../src/guestfs-actions.pod:6376
15190 " guestfs_upload (guestfs_h *g,\n"
15191 " const char *filename,\n"
15192 " const char *remotefilename);\n"
15197 #: ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6405
15198 #: ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
15199 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
15203 #: ../src/guestfs-actions.pod:6386
15204 msgid "See also C<guestfs_download>."
15208 #: ../src/guestfs-actions.pod:6397
15209 msgid "guestfs_upload_offset"
15213 #: ../src/guestfs-actions.pod:6399
15217 " guestfs_upload_offset (guestfs_h *g,\n"
15218 " const char *filename,\n"
15219 " const char *remotefilename,\n"
15220 " int64_t offset);\n"
15225 #: ../src/guestfs-actions.pod:6408 ../fish/guestfish-actions.pod:4286
15227 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
15228 "The intention is to overwrite parts of existing files or devices, although "
15229 "if a non-existant file is specified then it is created with a \"hole\" "
15230 "before C<offset>. The size of the data written is implicit in the size of "
15231 "the source C<filename>."
15235 #: ../src/guestfs-actions.pod:6415
15237 "Note that there is no limit on the amount of data that can be uploaded with "
15238 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
15239 "full amount unless an error occurs."
15243 #: ../src/guestfs-actions.pod:6420
15244 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
15248 #: ../src/guestfs-actions.pod:6431
15249 msgid "guestfs_utimens"
15253 #: ../src/guestfs-actions.pod:6433
15257 " guestfs_utimens (guestfs_h *g,\n"
15258 " const char *path,\n"
15259 " int64_t atsecs,\n"
15260 " int64_t atnsecs,\n"
15261 " int64_t mtsecs,\n"
15262 " int64_t mtnsecs);\n"
15267 #: ../src/guestfs-actions.pod:6441 ../fish/guestfish-actions.pod:4306
15268 msgid "This command sets the timestamps of a file with nanosecond precision."
15272 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4309
15274 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
15279 #: ../src/guestfs-actions.pod:6447 ../fish/guestfish-actions.pod:4312
15281 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
15282 "nanoseconds from the epoch."
15286 #: ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:4315
15288 "If the C<*nsecs> field contains the special value C<-1> then the "
15289 "corresponding timestamp is set to the current time. (The C<*secs> field is "
15290 "ignored in this case)."
15294 #: ../src/guestfs-actions.pod:6454 ../fish/guestfish-actions.pod:4319
15296 "If the C<*nsecs> field contains the special value C<-2> then the "
15297 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
15302 #: ../src/guestfs-actions.pod:6462 ../src/guestfs-structs.pod:175
15303 msgid "guestfs_version"
15307 #: ../src/guestfs-actions.pod:6464
15310 " struct guestfs_version *\n"
15311 " guestfs_version (guestfs_h *g);\n"
15316 #: ../src/guestfs-actions.pod:6467 ../fish/guestfish-actions.pod:4327
15318 "Return the libguestfs version number that the program is linked against."
15322 #: ../src/guestfs-actions.pod:6470 ../fish/guestfish-actions.pod:4330
15324 "Note that because of dynamic linking this is not necessarily the version of "
15325 "libguestfs that you compiled against. You can compile the program, and then "
15326 "at runtime dynamically link against a completely different C<libguestfs.so> "
15331 #: ../src/guestfs-actions.pod:6475 ../fish/guestfish-actions.pod:4335
15333 "This call was added in version C<1.0.58>. In previous versions of "
15334 "libguestfs there was no way to get the version number. From C code you can "
15335 "use dynamic linker functions to find out if this symbol exists (if it "
15336 "doesn't, then it's an earlier version)."
15340 #: ../src/guestfs-actions.pod:6481 ../fish/guestfish-actions.pod:4341
15342 "The call returns a structure with four elements. The first three (C<major>, "
15343 "C<minor> and C<release>) are numbers and correspond to the usual version "
15344 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
15345 "but may be used for distro-specific information."
15349 #: ../src/guestfs-actions.pod:6487 ../fish/guestfish-actions.pod:4347
15351 "To construct the original version string: C<$major.$minor.$release$extra>"
15355 #: ../src/guestfs-actions.pod:6490 ../fish/guestfish-actions.pod:4350
15356 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
15360 #: ../src/guestfs-actions.pod:6492
15362 "I<Note:> Don't use this call to test for availability of features. In "
15363 "enterprise distributions we backport features from later versions into "
15364 "earlier versions, making this an unreliable way to test for features. Use "
15365 "C<guestfs_available> instead."
15369 #: ../src/guestfs-actions.pod:6498
15371 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
15372 "error. I<The caller must call C<guestfs_free_version> after use>."
15376 #: ../src/guestfs-actions.pod:6502
15377 msgid "(Added in 1.0.58)"
15381 #: ../src/guestfs-actions.pod:6504
15382 msgid "guestfs_vfs_label"
15386 #: ../src/guestfs-actions.pod:6506
15390 " guestfs_vfs_label (guestfs_h *g,\n"
15391 " const char *device);\n"
15396 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4362
15397 msgid "This returns the filesystem label of the filesystem on C<device>."
15401 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4365
15402 msgid "If the filesystem is unlabeled, this returns the empty string."
15406 #: ../src/guestfs-actions.pod:6515
15407 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15411 #: ../src/guestfs-actions.pod:6520 ../src/guestfs-actions.pod:6557
15412 msgid "(Added in 1.3.18)"
15416 #: ../src/guestfs-actions.pod:6522
15417 msgid "guestfs_vfs_type"
15421 #: ../src/guestfs-actions.pod:6524
15425 " guestfs_vfs_type (guestfs_h *g,\n"
15426 " const char *device);\n"
15431 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4373
15433 "This command gets the filesystem type corresponding to the filesystem on "
15438 #: ../src/guestfs-actions.pod:6531 ../fish/guestfish-actions.pod:4376
15440 "For most filesystems, the result is the name of the Linux VFS module which "
15441 "would be used to mount this filesystem if you mounted it without specifying "
15442 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15446 #: ../src/guestfs-actions.pod:6541
15447 msgid "guestfs_vfs_uuid"
15451 #: ../src/guestfs-actions.pod:6543
15455 " guestfs_vfs_uuid (guestfs_h *g,\n"
15456 " const char *device);\n"
15461 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4385
15462 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15466 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4388
15467 msgid "If the filesystem does not have a UUID, this returns the empty string."
15471 #: ../src/guestfs-actions.pod:6552
15472 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15476 #: ../src/guestfs-actions.pod:6559
15477 msgid "guestfs_vg_activate"
15481 #: ../src/guestfs-actions.pod:6561
15485 " guestfs_vg_activate (guestfs_h *g,\n"
15487 " char *const *volgroups);\n"
15492 #: ../src/guestfs-actions.pod:6566 ../fish/guestfish-actions.pod:4396
15494 "This command activates or (if C<activate> is false) deactivates all logical "
15495 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15496 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15497 "deactivated, then those devices disappear."
15501 #: ../src/guestfs-actions.pod:6572 ../fish/guestfish-actions.pod:4402
15502 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15506 #: ../src/guestfs-actions.pod:6574 ../fish/guestfish-actions.pod:4404
15508 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15509 "activated or deactivated."
15513 #: ../src/guestfs-actions.pod:6581
15514 msgid "guestfs_vg_activate_all"
15518 #: ../src/guestfs-actions.pod:6583
15522 " guestfs_vg_activate_all (guestfs_h *g,\n"
15523 " int activate);\n"
15528 #: ../src/guestfs-actions.pod:6587 ../fish/guestfish-actions.pod:4411
15530 "This command activates or (if C<activate> is false) deactivates all logical "
15531 "volumes in all volume groups. If activated, then they are made known to the "
15532 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15533 "those devices disappear."
15537 #: ../src/guestfs-actions.pod:6593 ../fish/guestfish-actions.pod:4417
15538 msgid "This command is the same as running C<vgchange -a y|n>"
15542 #: ../src/guestfs-actions.pod:6599
15543 msgid "guestfs_vgcreate"
15547 #: ../src/guestfs-actions.pod:6601
15551 " guestfs_vgcreate (guestfs_h *g,\n"
15552 " const char *volgroup,\n"
15553 " char *const *physvols);\n"
15558 #: ../src/guestfs-actions.pod:6606 ../fish/guestfish-actions.pod:4423
15560 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15561 "of physical volumes C<physvols>."
15565 #: ../src/guestfs-actions.pod:6613
15566 msgid "guestfs_vglvuuids"
15570 #: ../src/guestfs-actions.pod:6615
15574 " guestfs_vglvuuids (guestfs_h *g,\n"
15575 " const char *vgname);\n"
15580 #: ../src/guestfs-actions.pod:6619 ../fish/guestfish-actions.pod:4430
15582 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15583 "volumes created in this volume group."
15587 #: ../src/guestfs-actions.pod:6622
15589 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15590 "associate logical volumes and volume groups."
15594 #: ../src/guestfs-actions.pod:6625
15595 msgid "See also C<guestfs_vgpvuuids>."
15599 #: ../src/guestfs-actions.pod:6633
15600 msgid "guestfs_vgpvuuids"
15604 #: ../src/guestfs-actions.pod:6635
15608 " guestfs_vgpvuuids (guestfs_h *g,\n"
15609 " const char *vgname);\n"
15614 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4442
15616 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15617 "volumes that this volume group resides on."
15621 #: ../src/guestfs-actions.pod:6642
15623 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15624 "associate physical volumes and volume groups."
15628 #: ../src/guestfs-actions.pod:6645
15629 msgid "See also C<guestfs_vglvuuids>."
15633 #: ../src/guestfs-actions.pod:6653
15634 msgid "guestfs_vgremove"
15638 #: ../src/guestfs-actions.pod:6655
15642 " guestfs_vgremove (guestfs_h *g,\n"
15643 " const char *vgname);\n"
15648 #: ../src/guestfs-actions.pod:6659 ../fish/guestfish-actions.pod:4454
15649 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15653 #: ../src/guestfs-actions.pod:6661 ../fish/guestfish-actions.pod:4456
15655 "This also forcibly removes all logical volumes in the volume group (if any)."
15659 #: ../src/guestfs-actions.pod:6668
15660 msgid "guestfs_vgrename"
15664 #: ../src/guestfs-actions.pod:6670
15668 " guestfs_vgrename (guestfs_h *g,\n"
15669 " const char *volgroup,\n"
15670 " const char *newvolgroup);\n"
15675 #: ../src/guestfs-actions.pod:6675 ../fish/guestfish-actions.pod:4463
15676 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15680 #: ../src/guestfs-actions.pod:6681
15681 msgid "guestfs_vgs"
15685 #: ../src/guestfs-actions.pod:6683
15689 " guestfs_vgs (guestfs_h *g);\n"
15694 #: ../src/guestfs-actions.pod:6686 ../fish/guestfish-actions.pod:4469
15696 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15701 #: ../src/guestfs-actions.pod:6689 ../fish/guestfish-actions.pod:4472
15703 "This returns a list of just the volume group names that were detected (eg. "
15708 #: ../src/guestfs-actions.pod:6692
15709 msgid "See also C<guestfs_vgs_full>."
15713 #: ../src/guestfs-actions.pod:6700
15714 msgid "guestfs_vgs_full"
15718 #: ../src/guestfs-actions.pod:6702
15721 " struct guestfs_lvm_vg_list *\n"
15722 " guestfs_vgs_full (guestfs_h *g);\n"
15727 #: ../src/guestfs-actions.pod:6705 ../fish/guestfish-actions.pod:4481
15729 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
15730 "> command. The \"full\" version includes all fields."
15734 #: ../src/guestfs-actions.pod:6708
15736 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15737 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
15741 #: ../src/guestfs-actions.pod:6714
15742 msgid "guestfs_vgscan"
15746 #: ../src/guestfs-actions.pod:6716
15750 " guestfs_vgscan (guestfs_h *g);\n"
15755 #: ../src/guestfs-actions.pod:6719 ../fish/guestfish-actions.pod:4488
15757 "This rescans all block devices and rebuilds the list of LVM physical "
15758 "volumes, volume groups and logical volumes."
15762 #: ../src/guestfs-actions.pod:6726
15763 msgid "guestfs_vguuid"
15767 #: ../src/guestfs-actions.pod:6728
15771 " guestfs_vguuid (guestfs_h *g,\n"
15772 " const char *vgname);\n"
15777 #: ../src/guestfs-actions.pod:6732 ../fish/guestfish-actions.pod:4495
15778 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15782 #: ../src/guestfs-actions.pod:6739
15783 msgid "guestfs_wait_ready"
15787 #: ../src/guestfs-actions.pod:6741
15791 " guestfs_wait_ready (guestfs_h *g);\n"
15796 #: ../src/guestfs-actions.pod:6744
15797 msgid "This function is a no op."
15801 #: ../src/guestfs-actions.pod:6746
15803 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15804 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15805 "is no longer necessary because C<guestfs_launch> now does the waiting."
15809 #: ../src/guestfs-actions.pod:6751
15811 "If you see any calls to this function in code then you can just remove them, "
15812 "unless you want to retain compatibility with older versions of the API."
15816 #: ../src/guestfs-actions.pod:6759
15817 msgid "guestfs_wc_c"
15821 #: ../src/guestfs-actions.pod:6761
15825 " guestfs_wc_c (guestfs_h *g,\n"
15826 " const char *path);\n"
15831 #: ../src/guestfs-actions.pod:6765 ../fish/guestfish-actions.pod:4501
15833 "This command counts the characters in a file, using the C<wc -c> external "
15838 #: ../src/guestfs-actions.pod:6772
15839 msgid "guestfs_wc_l"
15843 #: ../src/guestfs-actions.pod:6774
15847 " guestfs_wc_l (guestfs_h *g,\n"
15848 " const char *path);\n"
15853 #: ../src/guestfs-actions.pod:6778 ../fish/guestfish-actions.pod:4508
15855 "This command counts the lines in a file, using the C<wc -l> external command."
15859 #: ../src/guestfs-actions.pod:6785
15860 msgid "guestfs_wc_w"
15864 #: ../src/guestfs-actions.pod:6787
15868 " guestfs_wc_w (guestfs_h *g,\n"
15869 " const char *path);\n"
15874 #: ../src/guestfs-actions.pod:6791 ../fish/guestfish-actions.pod:4515
15876 "This command counts the words in a file, using the C<wc -w> external command."
15880 #: ../src/guestfs-actions.pod:6798
15881 msgid "guestfs_write"
15885 #: ../src/guestfs-actions.pod:6800
15889 " guestfs_write (guestfs_h *g,\n"
15890 " const char *path,\n"
15891 " const char *content,\n"
15892 " size_t content_size);\n"
15897 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4522
15899 "This call creates a file called C<path>. The content of the file is the "
15900 "string C<content> (which can contain any 8 bit data)."
15904 #: ../src/guestfs-actions.pod:6816
15905 msgid "guestfs_write_file"
15909 #: ../src/guestfs-actions.pod:6818
15913 " guestfs_write_file (guestfs_h *g,\n"
15914 " const char *path,\n"
15915 " const char *content,\n"
15921 #: ../src/guestfs-actions.pod:6824 ../fish/guestfish-actions.pod:4532
15923 "This call creates a file called C<path>. The contents of the file is the "
15924 "string C<content> (which can contain any 8 bit data), with length C<size>."
15928 #: ../src/guestfs-actions.pod:6828 ../fish/guestfish-actions.pod:4536
15930 "As a special case, if C<size> is C<0> then the length is calculated using "
15931 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15935 #: ../src/guestfs-actions.pod:6832 ../fish/guestfish-actions.pod:4540
15937 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15938 "I<not> work, even if the length is specified."
15942 #: ../src/guestfs-actions.pod:6840 ../fish/guestfish-actions.pod:4546
15944 "This function is deprecated. In new code, use the C<write> call instead."
15948 #: ../src/guestfs-actions.pod:6849
15949 msgid "guestfs_zegrep"
15953 #: ../src/guestfs-actions.pod:6851
15957 " guestfs_zegrep (guestfs_h *g,\n"
15958 " const char *regex,\n"
15959 " const char *path);\n"
15964 #: ../src/guestfs-actions.pod:6856 ../fish/guestfish-actions.pod:4557
15966 "This calls the external C<zegrep> program and returns the matching lines."
15970 #: ../src/guestfs-actions.pod:6868
15971 msgid "guestfs_zegrepi"
15975 #: ../src/guestfs-actions.pod:6870
15979 " guestfs_zegrepi (guestfs_h *g,\n"
15980 " const char *regex,\n"
15981 " const char *path);\n"
15986 #: ../src/guestfs-actions.pod:6875 ../fish/guestfish-actions.pod:4567
15988 "This calls the external C<zegrep -i> program and returns the matching lines."
15992 #: ../src/guestfs-actions.pod:6887
15993 msgid "guestfs_zero"
15997 #: ../src/guestfs-actions.pod:6889
16001 " guestfs_zero (guestfs_h *g,\n"
16002 " const char *device);\n"
16007 #: ../src/guestfs-actions.pod:6893 ../fish/guestfish-actions.pod:4577
16008 msgid "This command writes zeroes over the first few blocks of C<device>."
16012 #: ../src/guestfs-actions.pod:6895 ../fish/guestfish-actions.pod:4579
16014 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
16015 "securely wipe the device). It should be sufficient to remove any partition "
16016 "tables, filesystem superblocks and so on."
16020 #: ../src/guestfs-actions.pod:6899
16021 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
16025 #: ../src/guestfs-actions.pod:6910
16026 msgid "guestfs_zero_device"
16030 #: ../src/guestfs-actions.pod:6912
16034 " guestfs_zero_device (guestfs_h *g,\n"
16035 " const char *device);\n"
16040 #: ../src/guestfs-actions.pod:6916
16042 "This command writes zeroes over the entire C<device>. Compare with "
16043 "C<guestfs_zero> which just zeroes the first few blocks of a device."
16047 #: ../src/guestfs-actions.pod:6930
16048 msgid "(Added in 1.3.1)"
16052 #: ../src/guestfs-actions.pod:6932
16053 msgid "guestfs_zerofree"
16057 #: ../src/guestfs-actions.pod:6934
16061 " guestfs_zerofree (guestfs_h *g,\n"
16062 " const char *device);\n"
16067 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4600
16069 "This runs the I<zerofree> program on C<device>. This program claims to zero "
16070 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
16071 "possible to compress the filesystem more effectively."
16075 #: ../src/guestfs-actions.pod:6943 ../fish/guestfish-actions.pod:4605
16076 msgid "You should B<not> run this program if the filesystem is mounted."
16080 #: ../src/guestfs-actions.pod:6946 ../fish/guestfish-actions.pod:4608
16082 "It is possible that using this program can damage the filesystem or data on "
16087 #: ../src/guestfs-actions.pod:6953
16088 msgid "guestfs_zfgrep"
16092 #: ../src/guestfs-actions.pod:6955
16096 " guestfs_zfgrep (guestfs_h *g,\n"
16097 " const char *pattern,\n"
16098 " const char *path);\n"
16103 #: ../src/guestfs-actions.pod:6960 ../fish/guestfish-actions.pod:4615
16105 "This calls the external C<zfgrep> program and returns the matching lines."
16109 #: ../src/guestfs-actions.pod:6972
16110 msgid "guestfs_zfgrepi"
16114 #: ../src/guestfs-actions.pod:6974
16118 " guestfs_zfgrepi (guestfs_h *g,\n"
16119 " const char *pattern,\n"
16120 " const char *path);\n"
16125 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4625
16127 "This calls the external C<zfgrep -i> program and returns the matching lines."
16131 #: ../src/guestfs-actions.pod:6991
16132 msgid "guestfs_zfile"
16136 #: ../src/guestfs-actions.pod:6993
16140 " guestfs_zfile (guestfs_h *g,\n"
16141 " const char *meth,\n"
16142 " const char *path);\n"
16147 #: ../src/guestfs-actions.pod:6998 ../fish/guestfish-actions.pod:4635
16149 "This command runs C<file> after first decompressing C<path> using C<method>."
16153 #: ../src/guestfs-actions.pod:7001 ../fish/guestfish-actions.pod:4638
16154 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
16158 #: ../src/guestfs-actions.pod:7003
16160 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
16165 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4643
16167 "This function is deprecated. In new code, use the C<file> call instead."
16171 #: ../src/guestfs-actions.pod:7018
16172 msgid "guestfs_zgrep"
16176 #: ../src/guestfs-actions.pod:7020
16180 " guestfs_zgrep (guestfs_h *g,\n"
16181 " const char *regex,\n"
16182 " const char *path);\n"
16187 #: ../src/guestfs-actions.pod:7025 ../fish/guestfish-actions.pod:4654
16189 "This calls the external C<zgrep> program and returns the matching lines."
16193 #: ../src/guestfs-actions.pod:7037
16194 msgid "guestfs_zgrepi"
16198 #: ../src/guestfs-actions.pod:7039
16202 " guestfs_zgrepi (guestfs_h *g,\n"
16203 " const char *regex,\n"
16204 " const char *path);\n"
16209 #: ../src/guestfs-actions.pod:7044 ../fish/guestfish-actions.pod:4664
16211 "This calls the external C<zgrep -i> program and returns the matching lines."
16215 #: ../src/guestfs-availability.pod:3
16220 #: ../src/guestfs-availability.pod:5
16222 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
16223 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
16224 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
16225 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
16226 "L</guestfs_aug_save> L</guestfs_aug_set>"
16230 #: ../src/guestfs-availability.pod:21
16235 #: ../src/guestfs-availability.pod:23
16237 "The following functions: L</guestfs_inotify_add_watch> L</"
16238 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
16239 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
16243 #: ../src/guestfs-availability.pod:31
16244 msgid "B<linuxfsuuid>"
16248 #: ../src/guestfs-availability.pod:33
16250 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
16251 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
16255 #: ../src/guestfs-availability.pod:40
16256 msgid "B<linuxmodules>"
16260 #: ../src/guestfs-availability.pod:42
16261 msgid "The following functions: L</guestfs_modprobe>"
16265 #: ../src/guestfs-availability.pod:45
16266 msgid "B<linuxxattrs>"
16270 #: ../src/guestfs-availability.pod:47
16272 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> L</"
16273 "guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</"
16274 "guestfs_removexattr> L</guestfs_setxattr>"
16278 #: ../src/guestfs-availability.pod:56
16283 #: ../src/guestfs-availability.pod:58
16285 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
16286 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
16287 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
16291 #: ../src/guestfs-availability.pod:67
16296 #: ../src/guestfs-availability.pod:69
16298 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
16299 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
16300 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
16301 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
16302 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
16303 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
16304 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
16308 #: ../src/guestfs-availability.pod:92
16313 #: ../src/guestfs-availability.pod:94
16315 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
16316 "guestfs_mknod_b> L</guestfs_mknod_c>"
16320 #: ../src/guestfs-availability.pod:100
16325 #: ../src/guestfs-availability.pod:102
16326 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
16330 #: ../src/guestfs-availability.pod:105
16331 msgid "B<ntfsprogs>"
16335 #: ../src/guestfs-availability.pod:107
16337 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
16341 #: ../src/guestfs-availability.pod:111
16342 msgid "B<realpath>"
16346 #: ../src/guestfs-availability.pod:113
16347 msgid "The following functions: L</guestfs_realpath>"
16351 #: ../src/guestfs-availability.pod:116
16356 #: ../src/guestfs-availability.pod:118
16358 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
16359 "guestfs_scrub_freespace>"
16363 #: ../src/guestfs-availability.pod:123
16368 #: ../src/guestfs-availability.pod:125
16369 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
16373 #: ../src/guestfs-availability.pod:129
16378 #: ../src/guestfs-availability.pod:131
16379 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
16383 #: ../src/guestfs-availability.pod:135
16384 msgid "B<zerofree>"
16388 #: ../src/guestfs-availability.pod:137
16389 msgid "The following functions: L</guestfs_zerofree>"
16393 #: ../src/guestfs-structs.pod:1
16394 msgid "guestfs_int_bool"
16398 #: ../src/guestfs-structs.pod:3
16401 " struct guestfs_int_bool {\n"
16409 #: ../src/guestfs-structs.pod:8
16412 " struct guestfs_int_bool_list {\n"
16413 " uint32_t len; /* Number of elements in list. */\n"
16414 " struct guestfs_int_bool *val; /* Elements. */\n"
16420 #: ../src/guestfs-structs.pod:13
16423 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16424 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16429 #: ../src/guestfs-structs.pod:16
16430 msgid "guestfs_lvm_pv"
16434 #: ../src/guestfs-structs.pod:18
16437 " struct guestfs_lvm_pv {\n"
16438 " char *pv_name;\n"
16439 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16440 " char pv_uuid[32];\n"
16442 " uint64_t pv_size;\n"
16443 " uint64_t dev_size;\n"
16444 " uint64_t pv_free;\n"
16445 " uint64_t pv_used;\n"
16446 " char *pv_attr;\n"
16447 " int64_t pv_pe_count;\n"
16448 " int64_t pv_pe_alloc_count;\n"
16449 " char *pv_tags;\n"
16450 " uint64_t pe_start;\n"
16451 " int64_t pv_mda_count;\n"
16452 " uint64_t pv_mda_free;\n"
16458 #: ../src/guestfs-structs.pod:36
16461 " struct guestfs_lvm_pv_list {\n"
16462 " uint32_t len; /* Number of elements in list. */\n"
16463 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16469 #: ../src/guestfs-structs.pod:41
16472 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16473 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16478 #: ../src/guestfs-structs.pod:44
16479 msgid "guestfs_lvm_vg"
16483 #: ../src/guestfs-structs.pod:46
16486 " struct guestfs_lvm_vg {\n"
16487 " char *vg_name;\n"
16488 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16489 " char vg_uuid[32];\n"
16491 " char *vg_attr;\n"
16492 " uint64_t vg_size;\n"
16493 " uint64_t vg_free;\n"
16494 " char *vg_sysid;\n"
16495 " uint64_t vg_extent_size;\n"
16496 " int64_t vg_extent_count;\n"
16497 " int64_t vg_free_count;\n"
16498 " int64_t max_lv;\n"
16499 " int64_t max_pv;\n"
16500 " int64_t pv_count;\n"
16501 " int64_t lv_count;\n"
16502 " int64_t snap_count;\n"
16503 " int64_t vg_seqno;\n"
16504 " char *vg_tags;\n"
16505 " int64_t vg_mda_count;\n"
16506 " uint64_t vg_mda_free;\n"
16512 #: ../src/guestfs-structs.pod:69
16515 " struct guestfs_lvm_vg_list {\n"
16516 " uint32_t len; /* Number of elements in list. */\n"
16517 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16523 #: ../src/guestfs-structs.pod:74
16526 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16527 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16532 #: ../src/guestfs-structs.pod:77
16533 msgid "guestfs_lvm_lv"
16537 #: ../src/guestfs-structs.pod:79
16540 " struct guestfs_lvm_lv {\n"
16541 " char *lv_name;\n"
16542 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
16543 " char lv_uuid[32];\n"
16544 " char *lv_attr;\n"
16545 " int64_t lv_major;\n"
16546 " int64_t lv_minor;\n"
16547 " int64_t lv_kernel_major;\n"
16548 " int64_t lv_kernel_minor;\n"
16549 " uint64_t lv_size;\n"
16550 " int64_t seg_count;\n"
16552 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16553 " float snap_percent;\n"
16554 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16555 " float copy_percent;\n"
16556 " char *move_pv;\n"
16557 " char *lv_tags;\n"
16558 " char *mirror_log;\n"
16559 " char *modules;\n"
16565 #: ../src/guestfs-structs.pod:101
16568 " struct guestfs_lvm_lv_list {\n"
16569 " uint32_t len; /* Number of elements in list. */\n"
16570 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16576 #: ../src/guestfs-structs.pod:106
16579 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16580 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16585 #: ../src/guestfs-structs.pod:111
16588 " struct guestfs_stat {\n"
16592 " int64_t nlink;\n"
16597 " int64_t blksize;\n"
16598 " int64_t blocks;\n"
16599 " int64_t atime;\n"
16600 " int64_t mtime;\n"
16601 " int64_t ctime;\n"
16607 #: ../src/guestfs-structs.pod:127
16610 " struct guestfs_stat_list {\n"
16611 " uint32_t len; /* Number of elements in list. */\n"
16612 " struct guestfs_stat *val; /* Elements. */\n"
16618 #: ../src/guestfs-structs.pod:132
16621 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16622 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16627 #: ../src/guestfs-structs.pod:137
16630 " struct guestfs_statvfs {\n"
16631 " int64_t bsize;\n"
16632 " int64_t frsize;\n"
16633 " int64_t blocks;\n"
16634 " int64_t bfree;\n"
16635 " int64_t bavail;\n"
16636 " int64_t files;\n"
16637 " int64_t ffree;\n"
16638 " int64_t favail;\n"
16641 " int64_t namemax;\n"
16647 #: ../src/guestfs-structs.pod:151
16650 " struct guestfs_statvfs_list {\n"
16651 " uint32_t len; /* Number of elements in list. */\n"
16652 " struct guestfs_statvfs *val; /* Elements. */\n"
16658 #: ../src/guestfs-structs.pod:156
16661 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16662 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16667 #: ../src/guestfs-structs.pod:159
16668 msgid "guestfs_dirent"
16672 #: ../src/guestfs-structs.pod:161
16675 " struct guestfs_dirent {\n"
16684 #: ../src/guestfs-structs.pod:167
16687 " struct guestfs_dirent_list {\n"
16688 " uint32_t len; /* Number of elements in list. */\n"
16689 " struct guestfs_dirent *val; /* Elements. */\n"
16695 #: ../src/guestfs-structs.pod:172
16698 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16699 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16704 #: ../src/guestfs-structs.pod:177
16707 " struct guestfs_version {\n"
16708 " int64_t major;\n"
16709 " int64_t minor;\n"
16710 " int64_t release;\n"
16717 #: ../src/guestfs-structs.pod:184
16720 " struct guestfs_version_list {\n"
16721 " uint32_t len; /* Number of elements in list. */\n"
16722 " struct guestfs_version *val; /* Elements. */\n"
16728 #: ../src/guestfs-structs.pod:189
16731 " void guestfs_free_version (struct guestfs_free_version *);\n"
16732 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16737 #: ../src/guestfs-structs.pod:192
16738 msgid "guestfs_xattr"
16742 #: ../src/guestfs-structs.pod:194
16745 " struct guestfs_xattr {\n"
16746 " char *attrname;\n"
16747 " /* The next two fields describe a byte array. */\n"
16748 " uint32_t attrval_len;\n"
16749 " char *attrval;\n"
16755 #: ../src/guestfs-structs.pod:201
16758 " struct guestfs_xattr_list {\n"
16759 " uint32_t len; /* Number of elements in list. */\n"
16760 " struct guestfs_xattr *val; /* Elements. */\n"
16766 #: ../src/guestfs-structs.pod:206
16769 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16770 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16775 #: ../src/guestfs-structs.pod:209
16776 msgid "guestfs_inotify_event"
16780 #: ../src/guestfs-structs.pod:211
16783 " struct guestfs_inotify_event {\n"
16784 " int64_t in_wd;\n"
16785 " uint32_t in_mask;\n"
16786 " uint32_t in_cookie;\n"
16787 " char *in_name;\n"
16793 #: ../src/guestfs-structs.pod:218
16796 " struct guestfs_inotify_event_list {\n"
16797 " uint32_t len; /* Number of elements in list. */\n"
16798 " struct guestfs_inotify_event *val; /* Elements. */\n"
16804 #: ../src/guestfs-structs.pod:223
16807 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16808 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
16813 #: ../src/guestfs-structs.pod:226
16814 msgid "guestfs_partition"
16818 #: ../src/guestfs-structs.pod:228
16821 " struct guestfs_partition {\n"
16822 " int32_t part_num;\n"
16823 " uint64_t part_start;\n"
16824 " uint64_t part_end;\n"
16825 " uint64_t part_size;\n"
16831 #: ../src/guestfs-structs.pod:235
16834 " struct guestfs_partition_list {\n"
16835 " uint32_t len; /* Number of elements in list. */\n"
16836 " struct guestfs_partition *val; /* Elements. */\n"
16842 #: ../src/guestfs-structs.pod:240
16845 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16846 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16851 #: ../src/guestfs-structs.pod:243
16852 msgid "guestfs_application"
16856 #: ../src/guestfs-structs.pod:245
16859 " struct guestfs_application {\n"
16860 " char *app_name;\n"
16861 " char *app_display_name;\n"
16862 " int32_t app_epoch;\n"
16863 " char *app_version;\n"
16864 " char *app_release;\n"
16865 " char *app_install_path;\n"
16866 " char *app_trans_path;\n"
16867 " char *app_publisher;\n"
16868 " char *app_url;\n"
16869 " char *app_source_package;\n"
16870 " char *app_summary;\n"
16871 " char *app_description;\n"
16877 #: ../src/guestfs-structs.pod:260
16880 " struct guestfs_application_list {\n"
16881 " uint32_t len; /* Number of elements in list. */\n"
16882 " struct guestfs_application *val; /* Elements. */\n"
16888 #: ../src/guestfs-structs.pod:265
16891 " void guestfs_free_application (struct guestfs_free_application *);\n"
16892 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
16897 #: ../fish/guestfish.pod:5
16898 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16902 #: ../fish/guestfish.pod:9
16905 " guestfish [--options] [commands]\n"
16910 #: ../fish/guestfish.pod:11
16918 #: ../fish/guestfish.pod:13
16921 " guestfish [--ro|--rw] -a disk.img\n"
16926 #: ../fish/guestfish.pod:15
16929 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16934 #: ../fish/guestfish.pod:17
16937 " guestfish -d libvirt-domain\n"
16942 #: ../fish/guestfish.pod:19
16945 " guestfish [--ro|--rw] -a disk.img -i\n"
16950 #: ../fish/guestfish.pod:21
16953 " guestfish -d libvirt-domain -i\n"
16958 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44
16959 #: ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16964 #: ../fish/guestfish.pod:25
16966 "Using guestfish in read/write mode on live virtual machines can be "
16967 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16968 "option to use guestfish safely if the disk image or virtual machine might be "
16973 #: ../fish/guestfish.pod:32
16975 "Guestfish is a shell and command-line tool for examining and modifying "
16976 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16977 "functionality of the guestfs API, see L<guestfs(3)>."
16981 #: ../fish/guestfish.pod:36
16983 "Guestfish gives you structured access to the libguestfs API, from shell "
16984 "scripts or the command line or interactively. If you want to rescue a "
16985 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16990 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847
16991 #: ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58
16992 #: ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16997 #: ../fish/guestfish.pod:43
16998 msgid "As an interactive shell"
17002 #: ../fish/guestfish.pod:45
17010 #: ../fish/guestfish.pod:47
17013 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
17014 " editing virtual machine filesystems.\n"
17019 #: ../fish/guestfish.pod:50
17022 " Type: 'help' for a list of commands\n"
17023 " 'man' to read the manual\n"
17024 " 'quit' to quit the shell\n"
17029 #: ../fish/guestfish.pod:54
17032 " ><fs> add-ro disk.img\n"
17034 " ><fs> list-filesystems\n"
17035 " /dev/sda1: ext4\n"
17036 " /dev/vg_guest/lv_root: ext4\n"
17037 " /dev/vg_guest/lv_swap: swap\n"
17038 " ><fs> mount /dev/vg_guest/lv_root /\n"
17039 " ><fs> cat /etc/fstab\n"
17041 " # Created by anaconda\n"
17048 #: ../fish/guestfish.pod:67
17049 msgid "From shell scripts"
17053 #: ../fish/guestfish.pod:69
17054 msgid "Create a new C</etc/motd> file in a guest or disk image:"
17058 #: ../fish/guestfish.pod:71
17061 " guestfish <<_EOF_\n"
17064 " mount /dev/vg_guest/lv_root /\n"
17065 " write /etc/motd \"Welcome, new users\"\n"
17071 #: ../fish/guestfish.pod:78
17072 msgid "List the LVM logical volumes in a disk image:"
17076 #: ../fish/guestfish.pod:80
17079 " guestfish -a disk.img --ro <<_EOF_\n"
17087 #: ../fish/guestfish.pod:85
17088 msgid "List all the filesystems in a disk image:"
17092 #: ../fish/guestfish.pod:87
17095 " guestfish -a disk.img --ro <<_EOF_\n"
17097 " list-filesystems\n"
17103 #: ../fish/guestfish.pod:92
17104 msgid "On one command line"
17108 #: ../fish/guestfish.pod:94
17109 msgid "Update C</etc/resolv.conf> in a guest:"
17113 #: ../fish/guestfish.pod:96
17117 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
17118 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
17123 #: ../fish/guestfish.pod:100
17124 msgid "Edit C</boot/grub/grub.conf> interactively:"
17128 #: ../fish/guestfish.pod:102
17131 " guestfish --rw --add disk.img \\\n"
17132 " --mount /dev/vg_guest/lv_root \\\n"
17133 " --mount /dev/sda1:/boot \\\n"
17134 " edit /boot/grub/grub.conf\n"
17139 #: ../fish/guestfish.pod:107
17140 msgid "Mount disks automatically"
17144 #: ../fish/guestfish.pod:109
17146 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
17150 #: ../fish/guestfish.pod:112
17153 " guestfish --ro -a disk.img -i cat /etc/group\n"
17158 #: ../fish/guestfish.pod:114
17161 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
17166 #: ../fish/guestfish.pod:116
17167 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
17171 #: ../fish/guestfish.pod:118
17174 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
17179 #: ../fish/guestfish.pod:120
17180 msgid "As a script interpreter"
17184 #: ../fish/guestfish.pod:122
17185 msgid "Create a 100MB disk containing an ext2-formatted partition:"
17189 #: ../fish/guestfish.pod:124
17192 " #!/usr/bin/guestfish -f\n"
17193 " sparse test1.img 100M\n"
17195 " part-disk /dev/sda mbr\n"
17196 " mkfs ext2 /dev/sda1\n"
17201 #: ../fish/guestfish.pod:130
17202 msgid "Start with a prepared disk"
17206 #: ../fish/guestfish.pod:132
17208 "An alternate way to create a 100MB disk called C<test1.img> containing a "
17209 "single ext2-formatted partition:"
17213 #: ../fish/guestfish.pod:135
17216 " guestfish -N fs\n"
17221 #: ../fish/guestfish.pod:137
17222 msgid "To list what is available do:"
17226 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
17229 " guestfish -N help | less\n"
17234 #: ../fish/guestfish.pod:141
17235 msgid "Remote control"
17239 #: ../fish/guestfish.pod:143
17242 " eval \"`guestfish --listen`\"\n"
17243 " guestfish --remote add-ro disk.img\n"
17244 " guestfish --remote run\n"
17245 " guestfish --remote lvs\n"
17250 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37
17251 #: ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72
17252 #: ../tools/virt-win-reg.pl:171 ../tools/virt-resize.pl:254
17253 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98
17254 #: ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
17259 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131
17260 #: ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179
17261 #: ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61
17262 #: ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161
17263 #: ../tools/virt-list-partitions.pl:62
17268 #: ../fish/guestfish.pod:154
17269 msgid "Displays general help on options."
17273 #: ../fish/guestfish.pod:156
17274 msgid "B<-h> | B<--cmd-help>"
17278 #: ../fish/guestfish.pod:158
17279 msgid "Lists all available guestfish commands."
17283 #: ../fish/guestfish.pod:160
17284 msgid "B<-h cmd> | B<--cmd-help cmd>"
17288 #: ../fish/guestfish.pod:162
17289 msgid "Displays detailed help on a single command C<cmd>."
17293 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
17294 msgid "B<-a image> | B<--add image>"
17298 #: ../fish/guestfish.pod:166
17299 msgid "Add a block device or virtual machine image to the shell."
17303 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
17305 "The format of the disk image is auto-detected. To override this and force a "
17306 "particular format use the I<--format=..> option."
17310 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
17311 msgid "B<-c URI> | B<--connect URI>"
17315 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
17317 "When used in conjunction with the I<-d> option, this specifies the libvirt "
17318 "URI to use. The default is to use the default libvirt connection."
17322 #: ../fish/guestfish.pod:177
17327 #: ../fish/guestfish.pod:179
17329 "If using the I<--listen> option and a csh-like shell, use this option. See "
17330 "section L</REMOTE CONTROL AND CSH> below."
17334 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
17335 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
17339 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
17341 "Add disks from the named libvirt domain. If the I<--ro> option is also "
17342 "used, then any libvirt domain can be used. However in write mode, only "
17343 "libvirt domains which are shut down can be named here."
17347 #: ../fish/guestfish.pod:188
17348 msgid "B<-D> | B<--no-dest-paths>"
17352 #: ../fish/guestfish.pod:190
17354 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17355 "to hit the tab key to complete paths on the guest filesystem, but this "
17356 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17357 "allow this feature to be disabled."
17361 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
17362 msgid "B<--echo-keys>"
17366 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
17368 "When prompting for keys and passphrases, guestfish normally turns echoing "
17369 "off so you cannot see what you are typing. If you are not worried about "
17370 "Tempest attacks and there is no one else in the room you can specify this "
17371 "flag to see what you are typing."
17375 #: ../fish/guestfish.pod:202
17376 msgid "B<-f file> | B<--file file>"
17380 #: ../fish/guestfish.pod:204
17381 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17385 #: ../fish/guestfish.pod:207
17388 " #!/usr/bin/guestfish -f\n"
17393 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
17394 msgid "B<--format=raw|qcow2|..> | B<--format>"
17398 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17400 "The default for the I<-a> option is to auto-detect the format of the disk "
17401 "image. Using this forces the disk format for I<-a> options which follow on "
17402 "the command line. Using I<--format> with no argument switches back to auto-"
17403 "detection for subsequent I<-a> options."
17407 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17408 msgid "For example:"
17412 #: ../fish/guestfish.pod:218
17415 " guestfish --format=raw -a disk.img\n"
17420 #: ../fish/guestfish.pod:220
17421 msgid "forces raw format (no auto-detection) for C<disk.img>."
17425 #: ../fish/guestfish.pod:222
17428 " guestfish --format=raw -a disk.img --format -a another.img\n"
17433 #: ../fish/guestfish.pod:224
17435 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
17436 "detection for C<another.img>."
17440 #: ../fish/guestfish.pod:227
17442 "If you have untrusted raw-format guest disk images, you should use this "
17443 "option to specify the disk format. This avoids a possible security problem "
17444 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17448 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17449 msgid "B<-i> | B<--inspector>"
17453 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17455 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17456 "system and mount filesystems as they would be mounted on the real virtual "
17461 #: ../fish/guestfish.pod:238
17462 msgid "Typical usage is either:"
17466 #: ../fish/guestfish.pod:240
17469 " guestfish -d myguest -i\n"
17474 #: ../fish/guestfish.pod:242
17475 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17479 #: ../fish/guestfish.pod:244
17482 " guestfish --ro -d myguest -i\n"
17487 #: ../fish/guestfish.pod:246
17488 msgid "(for active domains, readonly), or specify the block device directly:"
17492 #: ../fish/guestfish.pod:248
17495 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17500 #: ../fish/guestfish.pod:250
17502 "Note that the command line syntax changed slightly over older versions of "
17503 "guestfish. You can still use the old syntax:"
17507 #: ../fish/guestfish.pod:253
17510 " guestfish [--ro] -i disk.img\n"
17515 #: ../fish/guestfish.pod:255
17518 " guestfish [--ro] -i libvirt-domain\n"
17523 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17524 msgid "B<--keys-from-stdin>"
17528 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17530 "Read key or passphrase parameters from stdin. The default is to try to read "
17531 "passphrases from the user by opening C</dev/tty>."
17535 #: ../fish/guestfish.pod:262
17536 msgid "B<--listen>"
17540 #: ../fish/guestfish.pod:264
17542 "Fork into the background and listen for remote commands. See section L</"
17543 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17547 #: ../fish/guestfish.pod:267
17548 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17552 #: ../fish/guestfish.pod:269
17553 msgid "Mount the named partition or logical volume on the given mountpoint."
17557 #: ../fish/guestfish.pod:271
17558 msgid "If the mountpoint is omitted, it defaults to C</>."
17562 #: ../fish/guestfish.pod:273
17563 msgid "You have to mount something on C</> before most commands will work."
17567 #: ../fish/guestfish.pod:275
17569 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17574 #: ../fish/guestfish.pod:278
17576 "If you don't know what filesystems a disk image contains, you can either run "
17577 "guestfish without this option, then list the partitions, filesystems and LVs "
17578 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17579 "commands), or you can use the L<virt-filesystems(1)> program."
17583 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17584 msgid "B<-n> | B<--no-sync>"
17588 #: ../fish/guestfish.pod:286
17590 "Disable autosync. This is enabled by default. See the discussion of "
17591 "autosync in the L<guestfs(3)> manpage."
17595 #: ../fish/guestfish.pod:289
17596 msgid "B<-N type> | B<--new type> | B<-N help>"
17600 #: ../fish/guestfish.pod:291
17602 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17603 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17604 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17609 #: ../fish/guestfish.pod:296
17610 msgid "B<--progress-bars>"
17614 #: ../fish/guestfish.pod:298
17615 msgid "Enable progress bars, even when guestfish is used non-interactively."
17619 #: ../fish/guestfish.pod:300
17621 "Progress bars are enabled by default when guestfish is used as an "
17622 "interactive shell."
17626 #: ../fish/guestfish.pod:303
17627 msgid "B<--no-progress-bars>"
17631 #: ../fish/guestfish.pod:305
17632 msgid "Disable progress bars."
17636 #: ../fish/guestfish.pod:307
17637 msgid "B<--remote[=pid]>"
17641 #: ../fish/guestfish.pod:309
17643 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17644 "CONTROL GUESTFISH OVER A SOCKET> below."
17648 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17649 msgid "B<-r> | B<--ro>"
17653 #: ../fish/guestfish.pod:314
17655 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17656 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17660 #: ../fish/guestfish.pod:317
17662 "The option must always be used if the disk image or virtual machine might be "
17663 "running, and is generally recommended in cases where you don't need write "
17664 "access to the disk."
17668 #: ../fish/guestfish.pod:321
17670 "Note that prepared disk images created with I<-N> are not affected by the "
17675 #: ../fish/guestfish.pod:324
17676 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17680 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17681 msgid "B<--selinux>"
17685 #: ../fish/guestfish.pod:328
17686 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17690 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17691 msgid "B<-v> | B<--verbose>"
17695 #: ../fish/guestfish.pod:332
17697 "Enable very verbose messages. This is particularly useful if you find a bug."
17701 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17702 msgid "B<-V> | B<--version>"
17706 #: ../fish/guestfish.pod:337
17707 msgid "Display the guestfish / libguestfs version number and exit."
17711 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17712 msgid "B<-w> | B<--rw>"
17716 #: ../fish/guestfish.pod:341
17718 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17723 #: ../fish/guestfish.pod:344
17728 #: ../fish/guestfish.pod:346
17729 msgid "Echo each command before executing it."
17733 #: ../fish/guestfish.pod:350
17734 msgid "COMMANDS ON COMMAND LINE"
17738 #: ../fish/guestfish.pod:352
17740 "Any additional (non-option) arguments are treated as commands to execute."
17744 #: ../fish/guestfish.pod:355
17746 "Commands to execute should be separated by a colon (C<:>), where the colon "
17747 "is a separate parameter. Thus:"
17751 #: ../fish/guestfish.pod:358
17754 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17759 #: ../fish/guestfish.pod:360
17761 "If there are no additional arguments, then we enter a shell, either an "
17762 "interactive shell with a prompt (if the input is a terminal) or a non-"
17763 "interactive shell."
17767 #: ../fish/guestfish.pod:364
17769 "In either command line mode or non-interactive shell, the first command that "
17770 "gives an error causes the whole shell to exit. In interactive mode (with a "
17771 "prompt) if a command fails, you can continue to enter commands."
17775 #: ../fish/guestfish.pod:369
17776 msgid "USING launch (OR run)"
17780 #: ../fish/guestfish.pod:371
17782 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17783 "then launch it, then mount any disks you need, and finally issue actions/"
17784 "commands. So the general order of the day is:"
17788 #: ../fish/guestfish.pod:379
17789 msgid "add or -a/--add"
17793 #: ../fish/guestfish.pod:383
17794 msgid "launch (aka run)"
17798 #: ../fish/guestfish.pod:387
17799 msgid "mount or -m/--mount"
17803 #: ../fish/guestfish.pod:391
17804 msgid "any other commands"
17808 #: ../fish/guestfish.pod:395
17810 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17811 "guest before mounting or performing any other commands."
17815 #: ../fish/guestfish.pod:398
17817 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17818 "I<--new> options were given then C<run> is done automatically, simply "
17819 "because guestfish can't perform the action you asked for without doing this."
17823 #: ../fish/guestfish.pod:403
17824 msgid "OPENING DISKS FOR READ AND WRITE"
17828 #: ../fish/guestfish.pod:405
17830 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17831 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17832 "open disk images read-only or for writing."
17836 #: ../fish/guestfish.pod:409
17838 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17839 "disk images supplied on the command line for write. To open a disk image "
17840 "read-only you have to do I<-a image --ro>."
17844 #: ../fish/guestfish.pod:413
17846 "This matters: If you accidentally open a live VM disk image writable then "
17847 "you will cause irreversible disk corruption."
17851 #: ../fish/guestfish.pod:416
17853 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17854 "images will be opened read-only. You will have to either specify "
17855 "I<guestfish --rw> or change a configuration file in order to get write "
17856 "access for disk images specified by those other command line options."
17860 #: ../fish/guestfish.pod:421
17862 "This version of guestfish has a I<--rw> option which does nothing (it is "
17863 "already the default). However it is highly recommended that you use this "
17864 "option to indicate that guestfish needs write access, and to prepare your "
17865 "scripts for the day when this option will be required for write access."
17869 #: ../fish/guestfish.pod:427
17871 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17872 "other libguestfs program apart from guestfish and guestmount."
17876 #: ../fish/guestfish.pod:430
17881 #: ../fish/guestfish.pod:432
17883 "You can quote ordinary parameters using either single or double quotes. For "
17888 #: ../fish/guestfish.pod:435
17891 " add \"file with a space.img\"\n"
17896 #: ../fish/guestfish.pod:437
17899 " rm '/file name'\n"
17904 #: ../fish/guestfish.pod:439
17912 #: ../fish/guestfish.pod:441
17914 "A few commands require a list of strings to be passed. For these, use a "
17915 "whitespace-separated list, enclosed in quotes. Strings containing "
17916 "whitespace to be passed through must be enclosed in single quotes. A "
17917 "literal single quote must be escaped with a backslash."
17921 #: ../fish/guestfish.pod:446
17924 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17925 " command \"/bin/echo 'foo bar'\"\n"
17926 " command \"/bin/echo \\'foo\\'\"\n"
17931 #: ../fish/guestfish.pod:450
17932 msgid "OPTIONAL ARGUMENTS"
17936 #: ../fish/guestfish.pod:452
17938 "Some commands take optional arguments. These arguments appear in this "
17939 "documentation as C<[argname:..]>. You can use them as in these examples:"
17943 #: ../fish/guestfish.pod:456
17946 " add-drive-opts filename\n"
17951 #: ../fish/guestfish.pod:458
17954 " add-drive-opts filename readonly:true\n"
17959 #: ../fish/guestfish.pod:460
17962 " add-drive-opts filename format:qcow2 readonly:false\n"
17967 #: ../fish/guestfish.pod:462
17969 "Each optional argument can appear at most once. All optional arguments must "
17970 "appear after the required ones."
17974 #: ../fish/guestfish.pod:465
17979 #: ../fish/guestfish.pod:467
17981 "This section applies to all commands which can take integers as parameters."
17985 #: ../fish/guestfish.pod:470
17986 msgid "SIZE SUFFIX"
17990 #: ../fish/guestfish.pod:472
17992 "When the command takes a parameter measured in bytes, you can use one of the "
17993 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17997 #: ../fish/guestfish.pod:478
17998 msgid "B<k> or B<K> or B<KiB>"
18002 #: ../fish/guestfish.pod:480
18003 msgid "The size in kilobytes (multiplied by 1024)."
18007 #: ../fish/guestfish.pod:482
18012 #: ../fish/guestfish.pod:484
18013 msgid "The size in SI 1000 byte units."
18017 #: ../fish/guestfish.pod:486
18018 msgid "B<M> or B<MiB>"
18022 #: ../fish/guestfish.pod:488
18023 msgid "The size in megabytes (multiplied by 1048576)."
18027 #: ../fish/guestfish.pod:490
18032 #: ../fish/guestfish.pod:492
18033 msgid "The size in SI 1000000 byte units."
18037 #: ../fish/guestfish.pod:494
18038 msgid "B<G> or B<GiB>"
18042 #: ../fish/guestfish.pod:496
18043 msgid "The size in gigabytes (multiplied by 2**30)."
18047 #: ../fish/guestfish.pod:498
18052 #: ../fish/guestfish.pod:500
18053 msgid "The size in SI 10**9 byte units."
18057 #: ../fish/guestfish.pod:502
18058 msgid "B<T> or B<TiB>"
18062 #: ../fish/guestfish.pod:504
18063 msgid "The size in terabytes (multiplied by 2**40)."
18067 #: ../fish/guestfish.pod:506
18072 #: ../fish/guestfish.pod:508
18073 msgid "The size in SI 10**12 byte units."
18077 #: ../fish/guestfish.pod:510
18078 msgid "B<P> or B<PiB>"
18082 #: ../fish/guestfish.pod:512
18083 msgid "The size in petabytes (multiplied by 2**50)."
18087 #: ../fish/guestfish.pod:514
18092 #: ../fish/guestfish.pod:516
18093 msgid "The size in SI 10**15 byte units."
18097 #: ../fish/guestfish.pod:518
18098 msgid "B<E> or B<EiB>"
18102 #: ../fish/guestfish.pod:520
18103 msgid "The size in exabytes (multiplied by 2**60)."
18107 #: ../fish/guestfish.pod:522
18112 #: ../fish/guestfish.pod:524
18113 msgid "The size in SI 10**18 byte units."
18117 #: ../fish/guestfish.pod:526
18118 msgid "B<Z> or B<ZiB>"
18122 #: ../fish/guestfish.pod:528
18123 msgid "The size in zettabytes (multiplied by 2**70)."
18127 #: ../fish/guestfish.pod:530
18132 #: ../fish/guestfish.pod:532
18133 msgid "The size in SI 10**21 byte units."
18137 #: ../fish/guestfish.pod:534
18138 msgid "B<Y> or B<YiB>"
18142 #: ../fish/guestfish.pod:536
18143 msgid "The size in yottabytes (multiplied by 2**80)."
18147 #: ../fish/guestfish.pod:538
18152 #: ../fish/guestfish.pod:540
18153 msgid "The size in SI 10**24 byte units."
18157 #: ../fish/guestfish.pod:546
18160 " truncate-size /file 1G\n"
18165 #: ../fish/guestfish.pod:548
18166 msgid "would truncate the file to 1 gigabyte."
18170 #: ../fish/guestfish.pod:550
18172 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
18173 "the parameter to L</memsize> is specified in megabytes already). Adding a "
18174 "suffix will probably not do what you expect."
18178 #: ../fish/guestfish.pod:554
18179 msgid "OCTAL AND HEXADECIMAL NUMBERS"
18183 #: ../fish/guestfish.pod:556
18185 "For specifying the radix (base) use the C convention: C<0> to prefix an "
18186 "octal number or C<0x> to prefix a hexadecimal number. For example:"
18190 #: ../fish/guestfish.pod:559
18193 " 1234 decimal number 1234\n"
18194 " 02322 octal number, equivalent to decimal 1234\n"
18195 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
18200 #: ../fish/guestfish.pod:563
18202 "When using the C<chmod> command, you almost always want to specify an octal "
18203 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
18204 "L<chmod(1)> program):"
18208 #: ../fish/guestfish.pod:567
18211 " chmod 0777 /public # OK\n"
18212 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
18217 #: ../fish/guestfish.pod:570
18219 "Commands that return numbers usually print them in decimal, but some "
18220 "commands print numbers in other radices (eg. C<umask> prints the mode in "
18221 "octal, preceeded by C<0>)."
18225 #: ../fish/guestfish.pod:574
18226 msgid "WILDCARDS AND GLOBBING"
18230 #: ../fish/guestfish.pod:576
18232 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
18233 "(globbing) by default. So for example the following will not do what you "
18238 #: ../fish/guestfish.pod:580
18246 #: ../fish/guestfish.pod:582
18248 "Assuming you don't have a directory called literally C</home/*> then the "
18249 "above command will return an error."
18253 #: ../fish/guestfish.pod:585
18254 msgid "To perform wildcard expansion, use the C<glob> command."
18258 #: ../fish/guestfish.pod:587
18261 " glob rm-rf /home/*\n"
18266 #: ../fish/guestfish.pod:589
18268 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
18269 "many times), equivalent to:"
18273 #: ../fish/guestfish.pod:592
18276 " rm-rf /home/jim\n"
18277 " rm-rf /home/joe\n"
18278 " rm-rf /home/mary\n"
18283 #: ../fish/guestfish.pod:596
18284 msgid "C<glob> only works on simple guest paths and not on device names."
18288 #: ../fish/guestfish.pod:598
18290 "If you have several parameters, each containing a wildcard, then glob will "
18291 "perform a Cartesian product."
18295 #: ../fish/guestfish.pod:601
18300 #: ../fish/guestfish.pod:603
18302 "Any line which starts with a I<#> character is treated as a comment and "
18303 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18304 "a command. For example:"
18308 #: ../fish/guestfish.pod:607
18311 " # this is a comment\n"
18312 " # this is a comment\n"
18313 " foo # NOT a comment\n"
18318 #: ../fish/guestfish.pod:611
18319 msgid "Blank lines are also ignored."
18323 #: ../fish/guestfish.pod:613
18324 msgid "RUNNING COMMANDS LOCALLY"
18328 #: ../fish/guestfish.pod:615
18330 "Any line which starts with a I<!> character is treated as a command sent to "
18331 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18335 #: ../fish/guestfish.pod:619
18339 " tgz-out /remote local/remote-data.tar.gz\n"
18344 #: ../fish/guestfish.pod:622
18346 "will create a directory C<local> on the host, and then export the contents "
18347 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18348 "(See C<tgz-out>)."
18352 #: ../fish/guestfish.pod:626
18354 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18355 "effect, due to the way that subprocesses work in Unix."
18359 #: ../fish/guestfish.pod:629
18364 #: ../fish/guestfish.pod:631
18366 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18367 "command (a guestfish command) to the second command (any host command). For "
18372 #: ../fish/guestfish.pod:635
18375 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18380 #: ../fish/guestfish.pod:637
18382 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18383 "program). The above command would list all accounts in the guest filesystem "
18384 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18388 #: ../fish/guestfish.pod:642
18391 " hexdump /bin/ls | head\n"
18392 " list-devices | tail -1\n"
18393 " tgz-out / - | tar ztf -\n"
18398 #: ../fish/guestfish.pod:646
18400 "The space before the pipe symbol is required, any space after the pipe "
18401 "symbol is optional. Everything after the pipe symbol is just passed "
18402 "straight to the host shell, so it can contain redirections, globs and "
18403 "anything else that makes sense on the host side."
18407 #: ../fish/guestfish.pod:651
18409 "To use a literal argument which begins with a pipe symbol, you have to quote "
18414 #: ../fish/guestfish.pod:654
18422 #: ../fish/guestfish.pod:656
18423 msgid "HOME DIRECTORIES"
18427 #: ../fish/guestfish.pod:658
18429 "If a parameter starts with the character C<~> then the tilde may be expanded "
18430 "as a home directory path (either C<~> for the current user's home directory, "
18431 "or C<~user> for another user)."
18435 #: ../fish/guestfish.pod:662
18437 "Note that home directory expansion happens for users known I<on the host>, "
18438 "not in the guest filesystem."
18442 #: ../fish/guestfish.pod:665
18444 "To use a literal argument which begins with a tilde, you have to quote it, "
18449 #: ../fish/guestfish.pod:668
18457 #: ../fish/guestfish.pod:672
18459 "Libguestfs has some support for Linux guests encrypted according to the "
18460 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18461 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
18462 "LUKS is supported."
18466 #: ../fish/guestfish.pod:677
18467 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18471 #: ../fish/guestfish.pod:679
18474 " ><fs> vfs-type /dev/sda2\n"
18480 #: ../fish/guestfish.pod:682
18482 "Then open those devices using L</luks-open>. This creates a device-mapper "
18483 "device called C</dev/mapper/luksdev>."
18487 #: ../fish/guestfish.pod:685
18490 " ><fs> luks-open /dev/sda2 luksdev\n"
18491 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18496 #: ../fish/guestfish.pod:688
18498 "Finally you have to tell LVM to scan for volume groups on the newly created "
18503 #: ../fish/guestfish.pod:691
18507 " vg-activate-all true\n"
18512 #: ../fish/guestfish.pod:694
18513 msgid "The logical volume(s) can now be mounted in the usual way."
18517 #: ../fish/guestfish.pod:696
18519 "Before closing a LUKS device you must unmount any logical volumes on it and "
18520 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18521 "one. Then you can close the mapper device:"
18525 #: ../fish/guestfish.pod:700
18528 " vg-activate false /dev/VG\n"
18529 " luks-close /dev/mapper/luksdev\n"
18534 #: ../fish/guestfish.pod:703
18535 msgid "WINDOWS PATHS"
18539 #: ../fish/guestfish.pod:705
18541 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18542 "(with some limitations). The following commands are equivalent:"
18546 #: ../fish/guestfish.pod:708
18549 " file /WINDOWS/system32/config/system.LOG\n"
18554 #: ../fish/guestfish.pod:710
18557 " file win:/windows/system32/config/system.log\n"
18562 #: ../fish/guestfish.pod:712
18565 " file win:\\windows\\system32\\config\\system.log\n"
18570 #: ../fish/guestfish.pod:714
18573 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18578 #: ../fish/guestfish.pod:716
18580 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18581 "handles case insensitivity like Windows would. This only works in argument "
18582 "positions that expect a path."
18586 #: ../fish/guestfish.pod:720
18587 msgid "UPLOADING AND DOWNLOADING FILES"
18591 #: ../fish/guestfish.pod:722
18593 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18594 "others which upload from or download to a local file, you can use the "
18595 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18599 #: ../fish/guestfish.pod:726
18607 #: ../fish/guestfish.pod:728
18609 "reads stdin and creates from that a file C</foo> in the disk image, and:"
18613 #: ../fish/guestfish.pod:731
18616 " tar-out /etc - | tar tf -\n"
18621 #: ../fish/guestfish.pod:733
18623 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18624 "command (see L</PIPES>)."
18628 #: ../fish/guestfish.pod:736
18630 "When using C<-> to read from stdin, the input is read up to the end of "
18631 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18632 "some arbitrary end marker:"
18636 #: ../fish/guestfish.pod:740
18639 " upload -<<END /foo\n"
18648 #: ../fish/guestfish.pod:746
18650 "Any string of characters can be used instead of C<END>. The end marker must "
18651 "appear on a line of its own, without any preceeding or following characters "
18652 "(not even spaces)."
18656 #: ../fish/guestfish.pod:750
18658 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18659 "upload local files (so-called \"FileIn\" parameters in the generator)."
18663 #: ../fish/guestfish.pod:753
18664 msgid "EXIT ON ERROR BEHAVIOUR"
18668 #: ../fish/guestfish.pod:755
18670 "By default, guestfish will ignore any errors when in interactive mode (ie. "
18671 "taking commands from a human over a tty), and will exit on the first error "
18672 "in non-interactive mode (scripts, commands given on the command line)."
18676 #: ../fish/guestfish.pod:760
18678 "If you prefix a command with a I<-> character, then that command will not "
18679 "cause guestfish to exit, even if that (one) command returns an error."
18683 #: ../fish/guestfish.pod:764
18684 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18688 #: ../fish/guestfish.pod:766
18690 "Guestfish can be remote-controlled over a socket. This is useful "
18691 "particularly in shell scripts where you want to make several different "
18692 "changes to a filesystem, but you don't want the overhead of starting up a "
18693 "guestfish process each time."
18697 #: ../fish/guestfish.pod:771
18698 msgid "Start a guestfish server process using:"
18702 #: ../fish/guestfish.pod:773
18705 " eval \"`guestfish --listen`\"\n"
18710 #: ../fish/guestfish.pod:775
18711 msgid "and then send it commands by doing:"
18715 #: ../fish/guestfish.pod:777
18718 " guestfish --remote cmd [...]\n"
18723 #: ../fish/guestfish.pod:779
18724 msgid "To cause the server to exit, send it the exit command:"
18728 #: ../fish/guestfish.pod:781
18731 " guestfish --remote exit\n"
18736 #: ../fish/guestfish.pod:783
18738 "Note that the server will normally exit if there is an error in a command. "
18739 "You can change this in the usual way. See section L</EXIT ON ERROR "
18744 #: ../fish/guestfish.pod:787
18745 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18749 #: ../fish/guestfish.pod:789
18751 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18752 "is how the I<--remote> option knows where to send the commands. You can "
18753 "have several guestfish listener processes running using:"
18757 #: ../fish/guestfish.pod:793
18760 " eval \"`guestfish --listen`\"\n"
18761 " pid1=$GUESTFISH_PID\n"
18762 " eval \"`guestfish --listen`\"\n"
18763 " pid2=$GUESTFISH_PID\n"
18765 " guestfish --remote=$pid1 cmd\n"
18766 " guestfish --remote=$pid2 cmd\n"
18771 #: ../fish/guestfish.pod:801
18772 msgid "REMOTE CONTROL AND CSH"
18776 #: ../fish/guestfish.pod:803
18778 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18783 #: ../fish/guestfish.pod:806
18786 " eval \"`guestfish --listen --csh`\"\n"
18791 #: ../fish/guestfish.pod:808
18792 msgid "REMOTE CONTROL DETAILS"
18796 #: ../fish/guestfish.pod:810
18798 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
18799 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
18800 "and C<$PID> is the process ID of the server."
18804 #: ../fish/guestfish.pod:814
18805 msgid "Guestfish client and server versions must match exactly."
18809 #: ../fish/guestfish.pod:816
18810 msgid "PREPARED DISK IMAGES"
18814 #: ../fish/guestfish.pod:818
18816 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18817 "preformatted disk images that guestfish can make for you to save typing. "
18818 "This is particularly useful for testing purposes. This option is used "
18819 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18820 "can be mixed with I<-a>)."
18824 #: ../fish/guestfish.pod:824
18826 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18827 "the second and so on. Existing files in the current directory are "
18832 #: ../fish/guestfish.pod:828
18834 "The type briefly describes how the disk should be sized, partitioned, how "
18835 "filesystem(s) should be created, and how content should be added. "
18836 "Optionally the type can be followed by extra parameters, separated by C<:> "
18837 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
18838 "allocated disk, containing a single partition, with the partition formatted "
18839 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
18844 #: ../fish/guestfish.pod:836
18845 msgid "To list the available types and any extra parameters they take, run:"
18849 #: ../fish/guestfish.pod:840
18851 "Note that the prepared filesystem is not mounted. You would usually have to "
18852 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18856 #: ../fish/guestfish.pod:844
18858 "If any I<-N> or I<--new> options are given, the guest is automatically "
18863 #: ../fish/guestfish.pod:849
18864 msgid "Create a 100MB disk with an ext4-formatted partition:"
18868 #: ../fish/guestfish.pod:851
18871 " guestfish -N fs:ext4\n"
18876 #: ../fish/guestfish.pod:853
18877 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18881 #: ../fish/guestfish.pod:855
18884 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18889 #: ../fish/guestfish.pod:857
18890 msgid "Create a blank 200MB disk:"
18894 #: ../fish/guestfish.pod:859
18897 " guestfish -N disk:200M\n"
18902 #: ../fish/guestfish.pod:861
18903 msgid "PROGRESS BARS"
18907 #: ../fish/guestfish.pod:863
18909 "Some (not all) long-running commands send progress notification messages as "
18910 "they are running. Guestfish turns these messages into progress bars."
18914 #: ../fish/guestfish.pod:867
18916 "When a command that supports progress bars takes longer than two seconds to "
18917 "run, and if progress bars are enabled, then you will see one appearing below "
18922 #: ../fish/guestfish.pod:871
18925 " ><fs> copy-size /large-file /another-file 2048M\n"
18926 " / 10% [#####-----------------------------------------] 00:30\n"
18931 #: ../fish/guestfish.pod:874
18933 "The spinner on the left hand side moves round once for every progress "
18934 "notification received from the backend. This is a (reasonably) golden "
18935 "assurance that the command is \"doing something\" even if the progress bar "
18936 "is not moving, because the command is able to send the progress "
18937 "notifications. When the bar reaches 100% and the command finishes, the "
18938 "spinner disappears."
18942 #: ../fish/guestfish.pod:881
18944 "Progress bars are enabled by default when guestfish is used interactively. "
18945 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18946 "and you can disable them completely using I<--no-progress-bars>."
18950 #: ../fish/guestfish.pod:886
18951 msgid "GUESTFISH COMMANDS"
18955 #: ../fish/guestfish.pod:888
18957 "The commands in this section are guestfish convenience commands, in other "
18958 "words, they are not part of the L<guestfs(3)> API."
18962 #: ../fish/guestfish.pod:891
18967 #: ../fish/guestfish.pod:893
18976 #: ../fish/guestfish.pod:896
18977 msgid "Without any parameter, this provides general help."
18981 #: ../fish/guestfish.pod:898
18982 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18986 #: ../fish/guestfish.pod:900
18987 msgid "quit | exit"
18991 #: ../fish/guestfish.pod:902
18992 msgid "This exits guestfish. You can also use C<^D> key."
18996 #: ../fish/guestfish.pod:904
18997 msgid "@FISH_COMMANDS@"
19001 #: ../fish/guestfish.pod:906
19006 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
19011 #: ../fish/guestfish.pod:912
19013 "guestfish returns 0 if the commands completed without error, or 1 if there "
19018 #: ../fish/guestfish.pod:919
19023 #: ../fish/guestfish.pod:921
19025 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
19030 #: ../fish/guestfish.pod:924
19031 msgid "GUESTFISH_PID"
19035 #: ../fish/guestfish.pod:926
19037 "Used with the I<--remote> option to specify the remote guestfish process to "
19038 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
19042 #: ../fish/guestfish.pod:930
19047 #: ../fish/guestfish.pod:932
19049 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
19050 "not specified, the external L<hexedit(1)> program is used."
19054 #: ../fish/guestfish.pod:936
19059 #: ../fish/guestfish.pod:938
19061 "If compiled with GNU readline support, various files in the home directory "
19062 "can be used. See L</FILES>."
19066 #: ../fish/guestfish.pod:947
19068 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
19069 "effect as using the B<-v> option."
19073 #: ../fish/guestfish.pod:959
19075 "Set the path that guestfish uses to search for kernel and initrd.img. See "
19076 "the discussion of paths in L<guestfs(3)>."
19080 #: ../fish/guestfish.pod:970
19081 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
19085 #: ../fish/guestfish.pod:972
19090 #: ../fish/guestfish.pod:974
19092 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
19097 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
19102 #: ../fish/guestfish.pod:993
19103 msgid "$HOME/.guestfish"
19107 #: ../fish/guestfish.pod:995
19109 "If compiled with GNU readline support, then the command history is saved in "
19114 #: ../fish/guestfish.pod:998
19115 msgid "$HOME/.inputrc"
19119 #: ../fish/guestfish.pod:1000
19120 msgid "/etc/inputrc"
19124 #: ../fish/guestfish.pod:1002
19126 "If compiled with GNU readline support, then these files can be used to "
19127 "configure readline. For further information, please see L<readline(3)/"
19128 "INITIALIZATION FILE>."
19132 #: ../fish/guestfish.pod:1006
19133 msgid "To write rules which only apply to guestfish, use:"
19137 #: ../fish/guestfish.pod:1008
19147 #: ../fish/guestfish.pod:1012
19149 "Variables that you can set in inputrc that change the behaviour of guestfish "
19150 "in useful ways include:"
19154 #: ../fish/guestfish.pod:1017
19155 msgid "completion-ignore-case (default: on)"
19159 #: ../fish/guestfish.pod:1019
19161 "By default, guestfish will ignore case when tab-completing paths on the "
19166 #: ../fish/guestfish.pod:1022
19169 " set completion-ignore-case off\n"
19174 #: ../fish/guestfish.pod:1024
19175 msgid "to make guestfish case sensitive."
19179 #: ../fish/guestfish.pod:1028
19184 #: ../fish/guestfish.pod:1030
19185 msgid "test2.img (etc)"
19189 #: ../fish/guestfish.pod:1032
19191 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
19192 "will be created in the file C<test1.img> in the current directory. The "
19193 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
19194 "the same name will be overwritten."
19198 #: ../fish/guestfish.pod:1041
19200 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
19201 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-"
19202 "filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)"
19203 ">, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, "
19208 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124
19209 #: ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370
19210 #: ../tools/virt-win-reg.pl:518 ../tools/virt-resize.pl:1512
19211 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300
19212 #: ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
19214 "This program is free software; you can redistribute it and/or modify it "
19215 "under the terms of the GNU General Public License as published by the Free "
19216 "Software Foundation; either version 2 of the License, or (at your option) "
19217 "any later version."
19221 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129
19222 #: ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375
19223 #: ../tools/virt-win-reg.pl:523 ../tools/virt-resize.pl:1517
19224 #: ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305
19225 #: ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
19227 "This program is distributed in the hope that it will be useful, but WITHOUT "
19228 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
19229 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
19234 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134
19235 #: ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380
19236 #: ../tools/virt-win-reg.pl:528 ../tools/virt-resize.pl:1522
19237 #: ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310
19238 #: ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
19240 "You should have received a copy of the GNU General Public License along with "
19241 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
19242 "Ave, Cambridge, MA 02139, USA."
19246 #: ../fish/guestfish-actions.pod:1
19251 #: ../fish/guestfish-actions.pod:3
19254 " add-cdrom filename\n"
19259 #: ../fish/guestfish-actions.pod:15
19261 "This call checks for the existence of C<filename>. This stops you from "
19262 "specifying other types of drive which are supported by qemu such as C<nbd:> "
19263 "and C<http:> URLs. To specify those, use the general L</config> call "
19268 #: ../fish/guestfish-actions.pod:22
19270 "If you just want to add an ISO file (often you use this as an efficient way "
19271 "to transfer large files into the guest), then you should probably use L</add-"
19272 "drive-ro> instead."
19276 #: ../fish/guestfish-actions.pod:35
19281 #: ../fish/guestfish-actions.pod:37
19286 #: ../fish/guestfish-actions.pod:39
19289 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
19294 #: ../fish/guestfish-actions.pod:41
19296 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
19297 "It works by connecting to libvirt, requesting the domain and domain XML from "
19298 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19302 #: ../fish/guestfish-actions.pod:58
19304 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
19305 "libvirt.org/uri.html>). If this is not set then we connect to the default "
19306 "libvirt URI (or one set through an environment variable, see the libvirt "
19307 "documentation for full details). If you are using the C API directly then "
19308 "it is more flexible to create the libvirt connection object yourself, get "
19309 "the domain object, and call L</add-libvirt-dom>."
19313 #: ../fish/guestfish-actions.pod:66
19315 "The other optional parameters are passed directly through to L</add-drive-"
19320 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
19322 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
19326 #: ../fish/guestfish-actions.pod:71
19331 #: ../fish/guestfish-actions.pod:73
19334 " add-drive filename\n"
19339 #: ../fish/guestfish-actions.pod:75
19341 "This function is the equivalent of calling L</add-drive-opts> with no "
19342 "optional parameters, so the disk is added writable, with the format being "
19343 "detected automatically."
19347 #: ../fish/guestfish-actions.pod:79
19349 "Automatic detection of the format opens you up to a potential security hole "
19350 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19351 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19352 "you should think about replacing calls to this function with calls to L</add-"
19353 "drive-opts>, and specifying the format."
19357 #: ../fish/guestfish-actions.pod:86
19358 msgid "add-drive-opts"
19362 #: ../fish/guestfish-actions.pod:88
19367 #: ../fish/guestfish-actions.pod:90
19370 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19375 #: ../fish/guestfish-actions.pod:117
19377 "This forces the image format. If you omit this (or use L</add-drive> or L</"
19378 "add-drive-ro>) then the format is automatically detected. Possible formats "
19379 "include C<raw> and C<qcow2>."
19383 #: ../fish/guestfish-actions.pod:128
19385 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
19386 "add-drive-with-if> call (q.v.)"
19390 #: ../fish/guestfish-actions.pod:135
19391 msgid "add-drive-ro"
19395 #: ../fish/guestfish-actions.pod:137
19400 #: ../fish/guestfish-actions.pod:139
19403 " add-drive-ro filename\n"
19408 #: ../fish/guestfish-actions.pod:141
19410 "This function is the equivalent of calling L</add-drive-opts> with the "
19411 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19412 "is added read-only, with the format being detected automatically."
19416 #: ../fish/guestfish-actions.pod:146
19417 msgid "add-drive-ro-with-if"
19421 #: ../fish/guestfish-actions.pod:148
19424 " add-drive-ro-with-if filename iface\n"
19429 #: ../fish/guestfish-actions.pod:150
19431 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19432 "interface emulation to use at run time."
19436 #: ../fish/guestfish-actions.pod:160
19437 msgid "add-drive-with-if"
19441 #: ../fish/guestfish-actions.pod:162
19444 " add-drive-with-if filename iface\n"
19449 #: ../fish/guestfish-actions.pod:164
19451 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19452 "interface emulation to use at run time."
19456 #: ../fish/guestfish-actions.pod:174
19461 #: ../fish/guestfish-actions.pod:176
19464 " aug-clear augpath\n"
19469 #: ../fish/guestfish-actions.pod:181
19474 #: ../fish/guestfish-actions.pod:183
19482 #: ../fish/guestfish-actions.pod:185
19484 "Close the current Augeas handle and free up any resources used by it. After "
19485 "calling this, you have to call L</aug-init> again before you can use any "
19486 "other Augeas functions."
19490 #: ../fish/guestfish-actions.pod:190
19491 msgid "aug-defnode"
19495 #: ../fish/guestfish-actions.pod:192
19498 " aug-defnode name expr val\n"
19503 #: ../fish/guestfish-actions.pod:197
19505 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19506 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19507 "containing that single node."
19511 #: ../fish/guestfish-actions.pod:205
19516 #: ../fish/guestfish-actions.pod:207
19519 " aug-defvar name expr\n"
19524 #: ../fish/guestfish-actions.pod:216
19529 #: ../fish/guestfish-actions.pod:218
19532 " aug-get augpath\n"
19537 #: ../fish/guestfish-actions.pod:223
19542 #: ../fish/guestfish-actions.pod:225
19545 " aug-init root flags\n"
19550 #: ../fish/guestfish-actions.pod:231
19551 msgid "You must call this before using any other L</aug-*> commands."
19555 #: ../fish/guestfish-actions.pod:266
19556 msgid "Do not load the tree in L</aug-init>."
19560 #: ../fish/guestfish-actions.pod:270
19561 msgid "To close the handle, you can call L</aug-close>."
19565 #: ../fish/guestfish-actions.pod:274
19570 #: ../fish/guestfish-actions.pod:276
19573 " aug-insert augpath label true|false\n"
19578 #: ../fish/guestfish-actions.pod:286
19583 #: ../fish/guestfish-actions.pod:288
19591 #: ../fish/guestfish-actions.pod:295
19596 #: ../fish/guestfish-actions.pod:297
19599 " aug-ls augpath\n"
19604 #: ../fish/guestfish-actions.pod:299
19606 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19607 "resulting nodes into alphabetical order."
19611 #: ../fish/guestfish-actions.pod:302
19616 #: ../fish/guestfish-actions.pod:304
19619 " aug-match augpath\n"
19624 #: ../fish/guestfish-actions.pod:310
19629 #: ../fish/guestfish-actions.pod:312
19632 " aug-mv src dest\n"
19637 #: ../fish/guestfish-actions.pod:317
19642 #: ../fish/guestfish-actions.pod:319
19645 " aug-rm augpath\n"
19650 #: ../fish/guestfish-actions.pod:325
19655 #: ../fish/guestfish-actions.pod:327
19663 #: ../fish/guestfish-actions.pod:331
19665 "The flags which were passed to L</aug-init> affect exactly how files are "
19670 #: ../fish/guestfish-actions.pod:334
19675 #: ../fish/guestfish-actions.pod:336
19678 " aug-set augpath val\n"
19683 #: ../fish/guestfish-actions.pod:340
19685 "In the Augeas API, it is possible to clear a node by setting the value to "
19686 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19687 "this call. Instead you must use the L</aug-clear> call."
19691 #: ../fish/guestfish-actions.pod:345
19696 #: ../fish/guestfish-actions.pod:347
19699 " available 'groups ...'\n"
19704 #: ../fish/guestfish-actions.pod:353
19706 "The libguestfs groups, and the functions that those groups correspond to, "
19707 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19708 "runtime by calling L</available-all-groups>."
19712 #: ../fish/guestfish-actions.pod:377
19713 msgid "You must call L</launch> before calling this function."
19717 #: ../fish/guestfish-actions.pod:399
19719 "This call was added in version C<1.0.80>. In previous versions of "
19720 "libguestfs all you could do would be to speculatively execute a command to "
19721 "find out if the daemon implemented it. See also L</version>."
19725 #: ../fish/guestfish-actions.pod:406
19726 msgid "available-all-groups"
19730 #: ../fish/guestfish-actions.pod:408
19733 " available-all-groups\n"
19738 #: ../fish/guestfish-actions.pod:410
19740 "This command returns a list of all optional groups that this daemon knows "
19741 "about. Note this returns both supported and unsupported groups. To find "
19742 "out which ones the daemon can actually support you have to call L</"
19743 "available> on each member of the returned list."
19747 #: ../fish/guestfish-actions.pod:416
19748 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19752 #: ../fish/guestfish-actions.pod:418
19757 #: ../fish/guestfish-actions.pod:420
19760 " base64-in (base64file|-) filename\n"
19765 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434
19766 #: ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827
19767 #: ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223
19768 #: ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140
19769 #: ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162
19770 #: ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223
19771 #: ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19772 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19776 #: ../fish/guestfish-actions.pod:427
19781 #: ../fish/guestfish-actions.pod:429
19784 " base64-out filename (base64file|-)\n"
19789 #: ../fish/guestfish-actions.pod:436
19790 msgid "blockdev-flushbufs"
19794 #: ../fish/guestfish-actions.pod:438
19797 " blockdev-flushbufs device\n"
19802 #: ../fish/guestfish-actions.pod:445
19803 msgid "blockdev-getbsz"
19807 #: ../fish/guestfish-actions.pod:447
19810 " blockdev-getbsz device\n"
19815 #: ../fish/guestfish-actions.pod:456
19816 msgid "blockdev-getro"
19820 #: ../fish/guestfish-actions.pod:458
19823 " blockdev-getro device\n"
19828 #: ../fish/guestfish-actions.pod:465
19829 msgid "blockdev-getsize64"
19833 #: ../fish/guestfish-actions.pod:467
19836 " blockdev-getsize64 device\n"
19841 #: ../fish/guestfish-actions.pod:471
19842 msgid "See also L</blockdev-getsz>."
19846 #: ../fish/guestfish-actions.pod:475
19847 msgid "blockdev-getss"
19851 #: ../fish/guestfish-actions.pod:477
19854 " blockdev-getss device\n"
19859 #: ../fish/guestfish-actions.pod:482
19861 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19865 #: ../fish/guestfish-actions.pod:487
19866 msgid "blockdev-getsz"
19870 #: ../fish/guestfish-actions.pod:489
19873 " blockdev-getsz device\n"
19878 #: ../fish/guestfish-actions.pod:494
19880 "See also L</blockdev-getss> for the real sector size of the device, and L</"
19881 "blockdev-getsize64> for the more useful I<size in bytes>."
19885 #: ../fish/guestfish-actions.pod:500
19886 msgid "blockdev-rereadpt"
19890 #: ../fish/guestfish-actions.pod:502
19893 " blockdev-rereadpt device\n"
19898 #: ../fish/guestfish-actions.pod:508
19899 msgid "blockdev-setbsz"
19903 #: ../fish/guestfish-actions.pod:510
19906 " blockdev-setbsz device blocksize\n"
19911 #: ../fish/guestfish-actions.pod:519
19912 msgid "blockdev-setro"
19916 #: ../fish/guestfish-actions.pod:521
19919 " blockdev-setro device\n"
19924 #: ../fish/guestfish-actions.pod:527
19925 msgid "blockdev-setrw"
19929 #: ../fish/guestfish-actions.pod:529
19932 " blockdev-setrw device\n"
19937 #: ../fish/guestfish-actions.pod:535
19938 msgid "case-sensitive-path"
19942 #: ../fish/guestfish-actions.pod:537
19945 " case-sensitive-path path\n"
19950 #: ../fish/guestfish-actions.pod:561
19952 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
19953 "WINDOWS/system32\"> (the exact return value would depend on details of how "
19954 "the directories were originally created under Windows)."
19958 #: ../fish/guestfish-actions.pod:569
19959 msgid "See also L</realpath>."
19963 #: ../fish/guestfish-actions.pod:571
19968 #: ../fish/guestfish-actions.pod:573
19976 #: ../fish/guestfish-actions.pod:577
19978 "Note that this function cannot correctly handle binary files (specifically, "
19979 "files containing C<\\0> character which is treated as end of string). For "
19980 "those you need to use the L</read-file> or L</download> functions which have "
19981 "a more complex interface."
19985 #: ../fish/guestfish-actions.pod:585
19990 #: ../fish/guestfish-actions.pod:587
19993 " checksum csumtype path\n"
19998 #: ../fish/guestfish-actions.pod:630
19999 msgid "To get the checksum for a device, use L</checksum-device>."
20003 #: ../fish/guestfish-actions.pod:632
20004 msgid "To get the checksums for many files, use L</checksums-out>."
20008 #: ../fish/guestfish-actions.pod:634
20009 msgid "checksum-device"
20013 #: ../fish/guestfish-actions.pod:636
20016 " checksum-device csumtype device\n"
20021 #: ../fish/guestfish-actions.pod:638
20023 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
20024 "device named C<device>. For the types of checksums supported see the L</"
20025 "checksum> command."
20029 #: ../fish/guestfish-actions.pod:642
20030 msgid "checksums-out"
20034 #: ../fish/guestfish-actions.pod:644
20037 " checksums-out csumtype directory (sumsfile|-)\n"
20042 #: ../fish/guestfish-actions.pod:660
20047 #: ../fish/guestfish-actions.pod:662
20050 " chmod mode path\n"
20055 #: ../fish/guestfish-actions.pod:673
20060 #: ../fish/guestfish-actions.pod:675
20063 " chown owner group path\n"
20068 #: ../fish/guestfish-actions.pod:683
20073 #: ../fish/guestfish-actions.pod:685
20076 " command 'arguments ...'\n"
20081 #: ../fish/guestfish-actions.pod:692
20083 "The single parameter is an argv-style list of arguments. The first element "
20084 "is the name of the program to run. Subsequent elements are parameters. The "
20085 "list must be non-empty (ie. must contain a program name). Note that the "
20086 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
20090 #: ../fish/guestfish-actions.pod:720
20091 msgid "command-lines"
20095 #: ../fish/guestfish-actions.pod:722
20098 " command-lines 'arguments ...'\n"
20103 #: ../fish/guestfish-actions.pod:724
20105 "This is the same as L</command>, but splits the result into a list of lines."
20109 #: ../fish/guestfish-actions.pod:727
20110 msgid "See also: L</sh-lines>"
20114 #: ../fish/guestfish-actions.pod:732
20119 #: ../fish/guestfish-actions.pod:734
20122 " config qemuparam qemuvalue\n"
20127 #: ../fish/guestfish-actions.pod:745
20132 #: ../fish/guestfish-actions.pod:747
20135 " copy-size src dest size\n"
20140 #: ../fish/guestfish-actions.pod:755
20145 #: ../fish/guestfish-actions.pod:757
20153 #: ../fish/guestfish-actions.pod:762
20158 #: ../fish/guestfish-actions.pod:764
20166 #: ../fish/guestfish-actions.pod:769
20171 #: ../fish/guestfish-actions.pod:771
20179 #: ../fish/guestfish-actions.pod:778
20181 "If the destination is a device, it must be as large or larger than the "
20182 "source file or device, otherwise the copy will fail. This command cannot do "
20183 "partial copies (see L</copy-size>)."
20187 #: ../fish/guestfish-actions.pod:782
20192 #: ../fish/guestfish-actions.pod:784
20200 #: ../fish/guestfish-actions.pod:792
20205 #: ../fish/guestfish-actions.pod:794
20213 #: ../fish/guestfish-actions.pod:803
20218 #: ../fish/guestfish-actions.pod:805
20226 #: ../fish/guestfish-actions.pod:811
20228 "Another way to get the same information is to enable verbose messages with "
20229 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
20230 "before running the program."
20234 #: ../fish/guestfish-actions.pod:816
20239 #: ../fish/guestfish-actions.pod:818
20242 " download remotefilename (filename|-)\n"
20247 #: ../fish/guestfish-actions.pod:825
20248 msgid "See also L</upload>, L</cat>."
20252 #: ../fish/guestfish-actions.pod:829
20253 msgid "download-offset"
20257 #: ../fish/guestfish-actions.pod:831
20260 " download-offset remotefilename (filename|-) offset size\n"
20265 #: ../fish/guestfish-actions.pod:839
20267 "Note that there is no limit on the amount of data that can be downloaded "
20268 "with this call, unlike with L</pread>, and this call always reads the full "
20269 "amount unless an error occurs."
20273 #: ../fish/guestfish-actions.pod:844
20274 msgid "See also L</download>, L</pread>."
20278 #: ../fish/guestfish-actions.pod:848
20279 msgid "drop-caches"
20283 #: ../fish/guestfish-actions.pod:850
20286 " drop-caches whattodrop\n"
20291 #: ../fish/guestfish-actions.pod:862
20296 #: ../fish/guestfish-actions.pod:864
20304 #: ../fish/guestfish-actions.pod:876
20309 #: ../fish/guestfish-actions.pod:878
20312 " e2fsck-f device\n"
20317 #: ../fish/guestfish-actions.pod:884
20319 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20320 "should use L</fsck>."
20324 #: ../fish/guestfish-actions.pod:887
20325 msgid "echo-daemon"
20329 #: ../fish/guestfish-actions.pod:889
20332 " echo-daemon 'words ...'\n"
20337 #: ../fish/guestfish-actions.pod:896
20338 msgid "See also L</ping-daemon>."
20342 #: ../fish/guestfish-actions.pod:898
20347 #: ../fish/guestfish-actions.pod:900
20350 " egrep regex path\n"
20355 #: ../fish/guestfish-actions.pod:908
20360 #: ../fish/guestfish-actions.pod:910
20363 " egrepi regex path\n"
20368 #: ../fish/guestfish-actions.pod:918
20373 #: ../fish/guestfish-actions.pod:920
20376 " equal file1 file2\n"
20381 #: ../fish/guestfish-actions.pod:927
20386 #: ../fish/guestfish-actions.pod:929
20394 #: ../fish/guestfish-actions.pod:934
20395 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20399 #: ../fish/guestfish-actions.pod:936
20404 #: ../fish/guestfish-actions.pod:938
20407 " fallocate path len\n"
20412 #: ../fish/guestfish-actions.pod:955
20413 msgid "fallocate64"
20417 #: ../fish/guestfish-actions.pod:957
20420 " fallocate64 path len\n"
20425 #: ../fish/guestfish-actions.pod:963
20427 "Note that this call allocates disk blocks for the file. To create a sparse "
20428 "file use L</truncate-size> instead."
20432 #: ../fish/guestfish-actions.pod:966
20434 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20435 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20436 "maximum size of files created through that call to 1GB."
20440 #: ../fish/guestfish-actions.pod:975
20445 #: ../fish/guestfish-actions.pod:977
20448 " fgrep pattern path\n"
20453 #: ../fish/guestfish-actions.pod:985
20458 #: ../fish/guestfish-actions.pod:987
20461 " fgrepi pattern path\n"
20466 #: ../fish/guestfish-actions.pod:995
20471 #: ../fish/guestfish-actions.pod:997
20479 #: ../fish/guestfish-actions.pod:1009
20481 "This command can also be used on C</dev/> devices (and partitions, LV "
20482 "names). You can for example use this to determine if a device contains a "
20483 "filesystem, although it's usually better to use L</vfs-type>."
20487 #: ../fish/guestfish-actions.pod:1019
20488 msgid "file-architecture"
20492 #: ../fish/guestfish-actions.pod:1021
20495 " file-architecture filename\n"
20500 #: ../fish/guestfish-actions.pod:1124
20505 #: ../fish/guestfish-actions.pod:1126
20513 #: ../fish/guestfish-actions.pod:1130
20515 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
20516 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
20520 #: ../fish/guestfish-actions.pod:1134
20525 #: ../fish/guestfish-actions.pod:1136
20528 " fill c len path\n"
20533 #: ../fish/guestfish-actions.pod:1142
20535 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20536 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20537 "L</fill-pattern>."
20541 #: ../fish/guestfish-actions.pod:1147
20542 msgid "fill-pattern"
20546 #: ../fish/guestfish-actions.pod:1149
20549 " fill-pattern pattern len path\n"
20554 #: ../fish/guestfish-actions.pod:1151
20556 "This function is like L</fill> except that it creates a new file of length "
20557 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20558 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20563 #: ../fish/guestfish-actions.pod:1156
20568 #: ../fish/guestfish-actions.pod:1158
20571 " find directory\n"
20576 #: ../fish/guestfish-actions.pod:1172
20577 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20581 #: ../fish/guestfish-actions.pod:1185
20582 msgid "See also L</find0>."
20586 #: ../fish/guestfish-actions.pod:1190
20591 #: ../fish/guestfish-actions.pod:1192
20594 " find0 directory (files|-)\n"
20599 #: ../fish/guestfish-actions.pod:1198
20601 "This command works the same way as L</find> with the following exceptions:"
20605 #: ../fish/guestfish-actions.pod:1225
20606 msgid "findfs-label"
20610 #: ../fish/guestfish-actions.pod:1227
20613 " findfs-label label\n"
20618 #: ../fish/guestfish-actions.pod:1233
20619 msgid "To find the label of a filesystem, use L</vfs-label>."
20623 #: ../fish/guestfish-actions.pod:1235
20624 msgid "findfs-uuid"
20628 #: ../fish/guestfish-actions.pod:1237
20631 " findfs-uuid uuid\n"
20636 #: ../fish/guestfish-actions.pod:1243
20637 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20641 #: ../fish/guestfish-actions.pod:1245
20646 #: ../fish/guestfish-actions.pod:1247
20649 " fsck fstype device\n"
20654 #: ../fish/guestfish-actions.pod:1277
20659 #: ../fish/guestfish-actions.pod:1279
20667 #: ../fish/guestfish-actions.pod:1286
20668 msgid "get-autosync"
20672 #: ../fish/guestfish-actions.pod:1288
20680 #: ../fish/guestfish-actions.pod:1292
20685 #: ../fish/guestfish-actions.pod:1294
20693 #: ../fish/guestfish-actions.pod:1298
20694 msgid "get-e2label"
20698 #: ../fish/guestfish-actions.pod:1300
20701 " get-e2label device\n"
20706 #: ../fish/guestfish-actions.pod:1312
20711 #: ../fish/guestfish-actions.pod:1314
20714 " get-e2uuid device\n"
20719 #: ../fish/guestfish-actions.pod:1326
20720 msgid "get-memsize"
20724 #: ../fish/guestfish-actions.pod:1328
20732 #: ../fish/guestfish-actions.pod:1333
20734 "If L</set-memsize> was not called on this handle, and if "
20735 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20736 "value for memsize."
20740 #: ../fish/guestfish-actions.pod:1340
20741 msgid "get-network"
20745 #: ../fish/guestfish-actions.pod:1342
20753 #: ../fish/guestfish-actions.pod:1346
20758 #: ../fish/guestfish-actions.pod:1348
20766 #: ../fish/guestfish-actions.pod:1355
20771 #: ../fish/guestfish-actions.pod:1357
20776 #: ../fish/guestfish-actions.pod:1359
20784 #: ../fish/guestfish-actions.pod:1366
20789 #: ../fish/guestfish-actions.pod:1368
20797 #: ../fish/guestfish-actions.pod:1375
20798 msgid "get-recovery-proc"
20802 #: ../fish/guestfish-actions.pod:1377
20805 " get-recovery-proc\n"
20810 #: ../fish/guestfish-actions.pod:1381
20811 msgid "get-selinux"
20815 #: ../fish/guestfish-actions.pod:1383
20823 #: ../fish/guestfish-actions.pod:1385
20825 "This returns the current setting of the selinux flag which is passed to the "
20826 "appliance at boot time. See L</set-selinux>."
20830 #: ../fish/guestfish-actions.pod:1391
20835 #: ../fish/guestfish-actions.pod:1393
20843 #: ../fish/guestfish-actions.pod:1400
20848 #: ../fish/guestfish-actions.pod:1402
20856 #: ../fish/guestfish-actions.pod:1406
20861 #: ../fish/guestfish-actions.pod:1408
20869 #: ../fish/guestfish-actions.pod:1410
20871 "Return the current umask. By default the umask is C<022> unless it has been "
20872 "set by calling L</umask>."
20876 #: ../fish/guestfish-actions.pod:1413
20877 msgid "get-verbose"
20881 #: ../fish/guestfish-actions.pod:1415
20889 #: ../fish/guestfish-actions.pod:1419
20894 #: ../fish/guestfish-actions.pod:1421
20902 #: ../fish/guestfish-actions.pod:1425
20903 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20907 #: ../fish/guestfish-actions.pod:1428
20912 #: ../fish/guestfish-actions.pod:1430
20915 " getxattrs path\n"
20920 #: ../fish/guestfish-actions.pod:1438
20921 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20925 #: ../fish/guestfish-actions.pod:1440
20926 msgid "glob-expand"
20930 #: ../fish/guestfish-actions.pod:1442
20933 " glob-expand pattern\n"
20938 #: ../fish/guestfish-actions.pod:1455
20943 #: ../fish/guestfish-actions.pod:1457
20946 " grep regex path\n"
20951 #: ../fish/guestfish-actions.pod:1465
20956 #: ../fish/guestfish-actions.pod:1467
20959 " grepi regex path\n"
20964 #: ../fish/guestfish-actions.pod:1475
20965 msgid "grub-install"
20969 #: ../fish/guestfish-actions.pod:1477
20972 " grub-install root device\n"
20977 #: ../fish/guestfish-actions.pod:1493
20982 #: ../fish/guestfish-actions.pod:1495
20990 #: ../fish/guestfish-actions.pod:1503
20995 #: ../fish/guestfish-actions.pod:1505
20998 " head-n nrlines path\n"
21003 #: ../fish/guestfish-actions.pod:1518
21008 #: ../fish/guestfish-actions.pod:1520
21016 #: ../fish/guestfish-actions.pod:1528
21021 #: ../fish/guestfish-actions.pod:1530
21024 " initrd-cat initrdpath filename\n"
21029 #: ../fish/guestfish-actions.pod:1542
21030 msgid "See also L</initrd-list>."
21034 #: ../fish/guestfish-actions.pod:1547
21035 msgid "initrd-list"
21039 #: ../fish/guestfish-actions.pod:1549
21042 " initrd-list path\n"
21047 #: ../fish/guestfish-actions.pod:1561
21048 msgid "inotify-add-watch"
21052 #: ../fish/guestfish-actions.pod:1563
21055 " inotify-add-watch path mask\n"
21060 #: ../fish/guestfish-actions.pod:1575
21061 msgid "inotify-close"
21065 #: ../fish/guestfish-actions.pod:1577
21073 #: ../fish/guestfish-actions.pod:1583
21074 msgid "inotify-files"
21078 #: ../fish/guestfish-actions.pod:1585
21086 #: ../fish/guestfish-actions.pod:1587
21088 "This function is a helpful wrapper around L</inotify-read> which just "
21089 "returns a list of pathnames of objects that were touched. The returned "
21090 "pathnames are sorted and deduplicated."
21094 #: ../fish/guestfish-actions.pod:1591
21095 msgid "inotify-init"
21099 #: ../fish/guestfish-actions.pod:1593
21102 " inotify-init maxevents\n"
21107 #: ../fish/guestfish-actions.pod:1599
21109 "C<maxevents> is the maximum number of events which will be queued up between "
21110 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
21111 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
21112 "default was 16384 events. Beyond this limit, the kernel throws away events, "
21113 "but records the fact that it threw them away by setting a flag "
21114 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
21118 #: ../fish/guestfish-actions.pod:1609
21120 "Before any events are generated, you have to add some watches to the "
21121 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
21122 "L</inotify-watch-all>."
21126 #: ../fish/guestfish-actions.pod:1615
21128 "Queued up events should be read periodically by calling L</inotify-read> (or "
21129 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
21130 "If you don't read the events out often enough then you risk the internal "
21131 "queue overflowing."
21135 #: ../fish/guestfish-actions.pod:1622
21137 "The handle should be closed after use by calling L</inotify-close>. This "
21138 "also removes any watches automatically."
21142 #: ../fish/guestfish-actions.pod:1631
21143 msgid "inotify-read"
21147 #: ../fish/guestfish-actions.pod:1633
21155 #: ../fish/guestfish-actions.pod:1646
21156 msgid "inotify-rm-watch"
21160 #: ../fish/guestfish-actions.pod:1648
21163 " inotify-rm-watch wd\n"
21168 #: ../fish/guestfish-actions.pod:1650
21169 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
21173 #: ../fish/guestfish-actions.pod:1653
21174 msgid "inspect-get-arch"
21178 #: ../fish/guestfish-actions.pod:1655
21181 " inspect-get-arch root\n"
21186 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673
21187 #: ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765
21188 #: ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801
21189 #: ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839
21190 #: ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885
21191 #: ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950
21192 #: ../fish/guestfish-actions.pod:1966
21194 "This function should only be called with a root device string as returned by "
21199 #: ../fish/guestfish-actions.pod:1660
21201 "This returns the architecture of the inspected operating system. The "
21202 "possible return values are listed under L</file-architecture>."
21206 #: ../fish/guestfish-actions.pod:1669
21207 msgid "inspect-get-distro"
21211 #: ../fish/guestfish-actions.pod:1671
21214 " inspect-get-distro root\n"
21219 #: ../fish/guestfish-actions.pod:1743
21220 msgid "inspect-get-filesystems"
21224 #: ../fish/guestfish-actions.pod:1745
21227 " inspect-get-filesystems root\n"
21232 #: ../fish/guestfish-actions.pod:1758
21234 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21235 "get-mountpoints>."
21239 #: ../fish/guestfish-actions.pod:1761
21240 msgid "inspect-get-hostname"
21244 #: ../fish/guestfish-actions.pod:1763
21247 " inspect-get-hostname root\n"
21252 #: ../fish/guestfish-actions.pod:1776
21253 msgid "inspect-get-major-version"
21257 #: ../fish/guestfish-actions.pod:1778
21260 " inspect-get-major-version root\n"
21265 #: ../fish/guestfish-actions.pod:1797
21266 msgid "inspect-get-minor-version"
21270 #: ../fish/guestfish-actions.pod:1799
21273 " inspect-get-minor-version root\n"
21278 #: ../fish/guestfish-actions.pod:1809
21280 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21281 "get-major-version>."
21285 #: ../fish/guestfish-actions.pod:1812
21286 msgid "inspect-get-mountpoints"
21290 #: ../fish/guestfish-actions.pod:1814
21293 " inspect-get-mountpoints root\n"
21298 #: ../fish/guestfish-actions.pod:1832
21300 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
21301 "get-filesystems>."
21305 #: ../fish/guestfish-actions.pod:1835
21306 msgid "inspect-get-package-format"
21310 #: ../fish/guestfish-actions.pod:1837
21313 " inspect-get-package-format root\n"
21318 #: ../fish/guestfish-actions.pod:1842
21320 "This function and L</inspect-get-package-management> return the package "
21321 "format and package management tool used by the inspected operating system. "
21322 "For example for Fedora these functions would return C<rpm> (package format) "
21323 "and C<yum> (package management)."
21327 #: ../fish/guestfish-actions.pod:1857
21328 msgid "inspect-get-package-management"
21332 #: ../fish/guestfish-actions.pod:1859
21335 " inspect-get-package-management root\n"
21340 #: ../fish/guestfish-actions.pod:1864
21342 "L</inspect-get-package-format> and this function return the package format "
21343 "and package management tool used by the inspected operating system. For "
21344 "example for Fedora these functions would return C<rpm> (package format) and "
21345 "C<yum> (package management)."
21349 #: ../fish/guestfish-actions.pod:1881
21350 msgid "inspect-get-product-name"
21354 #: ../fish/guestfish-actions.pod:1883
21357 " inspect-get-product-name root\n"
21362 #: ../fish/guestfish-actions.pod:1898
21363 msgid "inspect-get-roots"
21367 #: ../fish/guestfish-actions.pod:1900
21370 " inspect-get-roots\n"
21375 #: ../fish/guestfish-actions.pod:1902
21377 "This function is a convenient way to get the list of root devices, as "
21378 "returned from a previous call to L</inspect-os>, but without redoing the "
21379 "whole inspection process."
21383 #: ../fish/guestfish-actions.pod:1906
21385 "This returns an empty list if either no root devices were found or the "
21386 "caller has not called L</inspect-os>."
21390 #: ../fish/guestfish-actions.pod:1911
21391 msgid "inspect-get-type"
21395 #: ../fish/guestfish-actions.pod:1913
21398 " inspect-get-type root\n"
21403 #: ../fish/guestfish-actions.pod:1946
21404 msgid "inspect-get-windows-systemroot"
21408 #: ../fish/guestfish-actions.pod:1948
21411 " inspect-get-windows-systemroot root\n"
21416 #: ../fish/guestfish-actions.pod:1962
21417 msgid "inspect-list-applications"
21421 #: ../fish/guestfish-actions.pod:1964
21424 " inspect-list-applications root\n"
21429 #: ../fish/guestfish-actions.pod:1971
21431 "I<Note:> This call works differently from other parts of the inspection "
21432 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21433 "then mount up the disks, before calling this. Listing applications is a "
21434 "significantly more difficult operation which requires access to the full "
21435 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21436 "are just returning data cached in the libguestfs handle, this call actually "
21437 "reads parts of the mounted filesystems during the call."
21441 #: ../fish/guestfish-actions.pod:2061
21446 #: ../fish/guestfish-actions.pod:2063
21454 #: ../fish/guestfish-actions.pod:2078
21456 "You can pass the root string(s) returned to other L</inspect-get-*> "
21457 "functions in order to query further information about each operating system, "
21458 "such as the name and version."
21462 #: ../fish/guestfish-actions.pod:2083
21464 "This function uses other libguestfs features such as L</mount-ro> and L</"
21465 "umount-all> in order to mount and unmount filesystems and look at the "
21466 "contents. This should be called with no disks currently mounted. The "
21467 "function may also use Augeas, so any existing Augeas handle will be closed."
21471 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251
21472 #: ../fish/guestfish-actions.pod:2297
21473 msgid "See also L</list-filesystems>."
21477 #: ../fish/guestfish-actions.pod:2097
21478 msgid "is-blockdev"
21482 #: ../fish/guestfish-actions.pod:2099
21485 " is-blockdev path\n"
21490 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122
21491 #: ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150
21492 #: ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194
21493 #: ../fish/guestfish-actions.pod:2203
21494 msgid "See also L</stat>."
21498 #: ../fish/guestfish-actions.pod:2106
21503 #: ../fish/guestfish-actions.pod:2108
21511 #: ../fish/guestfish-actions.pod:2115
21516 #: ../fish/guestfish-actions.pod:2117
21519 " is-chardev path\n"
21524 #: ../fish/guestfish-actions.pod:2124
21529 #: ../fish/guestfish-actions.pod:2126
21537 #: ../fish/guestfish-actions.pod:2133
21542 #: ../fish/guestfish-actions.pod:2135
21550 #: ../fish/guestfish-actions.pod:2143
21555 #: ../fish/guestfish-actions.pod:2145
21563 #: ../fish/guestfish-actions.pod:2152
21568 #: ../fish/guestfish-actions.pod:2154
21576 #: ../fish/guestfish-actions.pod:2162
21577 msgid "is-launching"
21581 #: ../fish/guestfish-actions.pod:2164
21589 #: ../fish/guestfish-actions.pod:2171
21594 #: ../fish/guestfish-actions.pod:2173
21602 #: ../fish/guestfish-actions.pod:2178
21607 #: ../fish/guestfish-actions.pod:2180
21615 #: ../fish/guestfish-actions.pod:2187
21620 #: ../fish/guestfish-actions.pod:2189
21623 " is-socket path\n"
21628 #: ../fish/guestfish-actions.pod:2196
21633 #: ../fish/guestfish-actions.pod:2198
21636 " is-symlink path\n"
21641 #: ../fish/guestfish-actions.pod:2205
21642 msgid "kill-subprocess"
21646 #: ../fish/guestfish-actions.pod:2207
21649 " kill-subprocess\n"
21654 #: ../fish/guestfish-actions.pod:2211
21659 #: ../fish/guestfish-actions.pod:2213
21664 #: ../fish/guestfish-actions.pod:2215
21672 #: ../fish/guestfish-actions.pod:2223
21677 #: ../fish/guestfish-actions.pod:2225
21680 " lchown owner group path\n"
21685 #: ../fish/guestfish-actions.pod:2227
21687 "Change the file owner to C<owner> and group to C<group>. This is like L</"
21688 "chown> but if C<path> is a symlink then the link itself is changed, not the "
21693 #: ../fish/guestfish-actions.pod:2235
21698 #: ../fish/guestfish-actions.pod:2237
21701 " lgetxattrs path\n"
21706 #: ../fish/guestfish-actions.pod:2239
21708 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21709 "it returns the extended attributes of the link itself."
21713 #: ../fish/guestfish-actions.pod:2243
21714 msgid "list-devices"
21718 #: ../fish/guestfish-actions.pod:2245
21726 #: ../fish/guestfish-actions.pod:2253
21727 msgid "list-filesystems"
21731 #: ../fish/guestfish-actions.pod:2255
21734 " list-filesystems\n"
21739 #: ../fish/guestfish-actions.pod:2274
21741 "This command runs other libguestfs commands, which might include L</mount> "
21742 "and L</umount>, and therefore you should use this soon after launch and only "
21743 "when nothing is mounted."
21747 #: ../fish/guestfish-actions.pod:2278
21749 "Not all of the filesystems returned will be mountable. In particular, swap "
21750 "partitions are returned in the list. Also this command does not check that "
21751 "each filesystem found is valid and mountable, and some filesystems might be "
21752 "mountable but require special options. Filesystems may not all belong to a "
21753 "single logical operating system (use L</inspect-os> to look for OSes)."
21757 #: ../fish/guestfish-actions.pod:2286
21758 msgid "list-partitions"
21762 #: ../fish/guestfish-actions.pod:2288
21765 " list-partitions\n"
21770 #: ../fish/guestfish-actions.pod:2294
21772 "This does not return logical volumes. For that you will need to call L</"
21777 #: ../fish/guestfish-actions.pod:2299
21782 #: ../fish/guestfish-actions.pod:2301
21790 #: ../fish/guestfish-actions.pod:2309
21795 #: ../fish/guestfish-actions.pod:2311
21798 " ln target linkname\n"
21803 #: ../fish/guestfish-actions.pod:2315
21808 #: ../fish/guestfish-actions.pod:2317
21811 " ln-f target linkname\n"
21816 #: ../fish/guestfish-actions.pod:2322
21821 #: ../fish/guestfish-actions.pod:2324
21824 " ln-s target linkname\n"
21829 #: ../fish/guestfish-actions.pod:2328
21834 #: ../fish/guestfish-actions.pod:2330
21837 " ln-sf target linkname\n"
21842 #: ../fish/guestfish-actions.pod:2335
21843 msgid "lremovexattr"
21847 #: ../fish/guestfish-actions.pod:2337
21850 " lremovexattr xattr path\n"
21855 #: ../fish/guestfish-actions.pod:2339
21857 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21858 "it removes an extended attribute of the link itself."
21862 #: ../fish/guestfish-actions.pod:2343
21867 #: ../fish/guestfish-actions.pod:2345
21875 #: ../fish/guestfish-actions.pod:2351
21877 "This command is mostly useful for interactive sessions. Programs should "
21878 "probably use L</readdir> instead."
21882 #: ../fish/guestfish-actions.pod:2354
21887 #: ../fish/guestfish-actions.pod:2356
21890 " lsetxattr xattr val vallen path\n"
21895 #: ../fish/guestfish-actions.pod:2358
21897 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21898 "sets an extended attribute of the link itself."
21902 #: ../fish/guestfish-actions.pod:2362
21907 #: ../fish/guestfish-actions.pod:2364
21915 #: ../fish/guestfish-actions.pod:2368
21917 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21918 "the link is stat-ed, not the file it refers to."
21922 #: ../fish/guestfish-actions.pod:2374
21927 #: ../fish/guestfish-actions.pod:2376
21930 " lstatlist path 'names ...'\n"
21935 #: ../fish/guestfish-actions.pod:2378
21937 "This call allows you to perform the L</lstat> operation on multiple files, "
21938 "where all files are in the directory C<path>. C<names> is the list of files "
21939 "from this directory."
21943 #: ../fish/guestfish-actions.pod:2387
21945 "This call is intended for programs that want to efficiently list a directory "
21946 "contents without making many round-trips. See also L</lxattrlist> for a "
21947 "similarly efficient call for getting extended attributes. Very long "
21948 "directory listings might cause the protocol message size to be exceeded, "
21949 "causing this call to fail. The caller must split up such requests into "
21950 "smaller groups of names."
21954 #: ../fish/guestfish-actions.pod:2395
21955 msgid "luks-add-key"
21959 #: ../fish/guestfish-actions.pod:2397
21962 " luks-add-key device keyslot\n"
21967 #: ../fish/guestfish-actions.pod:2404
21969 "Note that if C<keyslot> already contains a key, then this command will "
21970 "fail. You have to use L</luks-kill-slot> first to remove that key."
21974 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430
21975 #: ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457
21976 #: ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21978 "This command has one or more key or passphrase parameters. Guestfish will "
21979 "prompt for these separately."
21983 #: ../fish/guestfish-actions.pod:2411
21988 #: ../fish/guestfish-actions.pod:2413
21991 " luks-close device\n"
21996 #: ../fish/guestfish-actions.pod:2415
21998 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
21999 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
22000 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
22005 #: ../fish/guestfish-actions.pod:2421
22006 msgid "luks-format"
22010 #: ../fish/guestfish-actions.pod:2423
22013 " luks-format device keyslot\n"
22018 #: ../fish/guestfish-actions.pod:2436
22019 msgid "luks-format-cipher"
22023 #: ../fish/guestfish-actions.pod:2438
22026 " luks-format-cipher device keyslot cipher\n"
22031 #: ../fish/guestfish-actions.pod:2440
22033 "This command is the same as L</luks-format> but it also allows you to set "
22034 "the C<cipher> used."
22038 #: ../fish/guestfish-actions.pod:2449
22039 msgid "luks-kill-slot"
22043 #: ../fish/guestfish-actions.pod:2451
22046 " luks-kill-slot device keyslot\n"
22051 #: ../fish/guestfish-actions.pod:2460
22056 #: ../fish/guestfish-actions.pod:2462
22059 " luks-open device mapname\n"
22064 #: ../fish/guestfish-actions.pod:2476
22066 "If this block device contains LVM volume groups, then calling L</vgscan> "
22067 "followed by L</vg-activate-all> will make them visible."
22071 #: ../fish/guestfish-actions.pod:2483
22072 msgid "luks-open-ro"
22076 #: ../fish/guestfish-actions.pod:2485
22079 " luks-open-ro device mapname\n"
22084 #: ../fish/guestfish-actions.pod:2487
22086 "This is the same as L</luks-open> except that a read-only mapping is created."
22090 #: ../fish/guestfish-actions.pod:2493
22095 #: ../fish/guestfish-actions.pod:2495
22098 " lvcreate logvol volgroup mbytes\n"
22103 #: ../fish/guestfish-actions.pod:2500
22104 msgid "lvm-canonical-lv-name"
22108 #: ../fish/guestfish-actions.pod:2502
22111 " lvm-canonical-lv-name lvname\n"
22116 #: ../fish/guestfish-actions.pod:2511
22117 msgid "See also L</is-lv>."
22121 #: ../fish/guestfish-actions.pod:2513
22122 msgid "lvm-clear-filter"
22126 #: ../fish/guestfish-actions.pod:2515
22129 " lvm-clear-filter\n"
22134 #: ../fish/guestfish-actions.pod:2517
22136 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
22141 #: ../fish/guestfish-actions.pod:2523
22142 msgid "lvm-remove-all"
22146 #: ../fish/guestfish-actions.pod:2525
22149 " lvm-remove-all\n"
22154 #: ../fish/guestfish-actions.pod:2533
22155 msgid "lvm-set-filter"
22159 #: ../fish/guestfish-actions.pod:2535
22162 " lvm-set-filter 'devices ...'\n"
22167 #: ../fish/guestfish-actions.pod:2560
22172 #: ../fish/guestfish-actions.pod:2562
22175 " lvremove device\n"
22180 #: ../fish/guestfish-actions.pod:2570
22185 #: ../fish/guestfish-actions.pod:2572
22188 " lvrename logvol newlogvol\n"
22193 #: ../fish/guestfish-actions.pod:2576
22198 #: ../fish/guestfish-actions.pod:2578
22201 " lvresize device mbytes\n"
22206 #: ../fish/guestfish-actions.pod:2584
22207 msgid "lvresize-free"
22211 #: ../fish/guestfish-actions.pod:2586
22214 " lvresize-free lv percent\n"
22219 #: ../fish/guestfish-actions.pod:2594
22224 #: ../fish/guestfish-actions.pod:2596
22232 #: ../fish/guestfish-actions.pod:2604
22233 msgid "See also L</lvs-full>, L</list-filesystems>."
22237 #: ../fish/guestfish-actions.pod:2606
22242 #: ../fish/guestfish-actions.pod:2608
22250 #: ../fish/guestfish-actions.pod:2613
22255 #: ../fish/guestfish-actions.pod:2615
22263 #: ../fish/guestfish-actions.pod:2619
22268 #: ../fish/guestfish-actions.pod:2621
22271 " lxattrlist path 'names ...'\n"
22276 #: ../fish/guestfish-actions.pod:2637
22278 "This call is intended for programs that want to efficiently list a directory "
22279 "contents without making many round-trips. See also L</lstatlist> for a "
22280 "similarly efficient call for getting standard stats. Very long directory "
22281 "listings might cause the protocol message size to be exceeded, causing this "
22282 "call to fail. The caller must split up such requests into smaller groups of "
22287 #: ../fish/guestfish-actions.pod:2645
22292 #: ../fish/guestfish-actions.pod:2647
22300 #: ../fish/guestfish-actions.pod:2651
22305 #: ../fish/guestfish-actions.pod:2653
22308 " mkdir-mode path mode\n"
22313 #: ../fish/guestfish-actions.pod:2662
22314 msgid "See also L</mkdir>, L</umask>"
22318 #: ../fish/guestfish-actions.pod:2664
22323 #: ../fish/guestfish-actions.pod:2666
22331 #: ../fish/guestfish-actions.pod:2671
22336 #: ../fish/guestfish-actions.pod:2673
22339 " mkdtemp template\n"
22344 #: ../fish/guestfish-actions.pod:2694
22349 #: ../fish/guestfish-actions.pod:2696
22352 " mke2fs-J fstype blocksize device journal\n"
22357 #: ../fish/guestfish-actions.pod:2704
22358 msgid "See also L</mke2journal>."
22362 #: ../fish/guestfish-actions.pod:2706
22367 #: ../fish/guestfish-actions.pod:2708
22370 " mke2fs-JL fstype blocksize device label\n"
22375 #: ../fish/guestfish-actions.pod:2713
22376 msgid "See also L</mke2journal-L>."
22380 #: ../fish/guestfish-actions.pod:2715
22385 #: ../fish/guestfish-actions.pod:2717
22388 " mke2fs-JU fstype blocksize device uuid\n"
22393 #: ../fish/guestfish-actions.pod:2722
22394 msgid "See also L</mke2journal-U>."
22398 #: ../fish/guestfish-actions.pod:2724
22399 msgid "mke2journal"
22403 #: ../fish/guestfish-actions.pod:2726
22406 " mke2journal blocksize device\n"
22411 #: ../fish/guestfish-actions.pod:2733
22412 msgid "mke2journal-L"
22416 #: ../fish/guestfish-actions.pod:2735
22419 " mke2journal-L blocksize label device\n"
22424 #: ../fish/guestfish-actions.pod:2739
22425 msgid "mke2journal-U"
22429 #: ../fish/guestfish-actions.pod:2741
22432 " mke2journal-U blocksize uuid device\n"
22437 #: ../fish/guestfish-actions.pod:2745
22442 #: ../fish/guestfish-actions.pod:2747
22445 " mkfifo mode path\n"
22450 #: ../fish/guestfish-actions.pod:2749
22452 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22453 "is just a convenient wrapper around L</mknod>."
22457 #: ../fish/guestfish-actions.pod:2755
22462 #: ../fish/guestfish-actions.pod:2757
22465 " mkfs fstype device\n"
22470 #: ../fish/guestfish-actions.pod:2763
22475 #: ../fish/guestfish-actions.pod:2765
22478 " mkfs-b fstype blocksize device\n"
22483 #: ../fish/guestfish-actions.pod:2767
22485 "This call is similar to L</mkfs>, but it allows you to control the block "
22486 "size of the resulting filesystem. Supported block sizes depend on the "
22487 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22491 #: ../fish/guestfish-actions.pod:2775
22492 msgid "mkmountpoint"
22496 #: ../fish/guestfish-actions.pod:2777
22499 " mkmountpoint exemptpath\n"
22504 #: ../fish/guestfish-actions.pod:2779
22506 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22507 "to create extra mountpoints before mounting the first filesystem."
22511 #: ../fish/guestfish-actions.pod:2803
22513 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22514 "unexpected errors if you try to mix these calls. It is safest to manually "
22515 "unmount filesystems and remove mountpoints after use."
22519 #: ../fish/guestfish-actions.pod:2807
22521 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22522 "for this to work for manual mountpoints, you must ensure that the innermost "
22523 "mountpoints have the longest pathnames, as in the example code above."
22527 #: ../fish/guestfish-actions.pod:2814
22529 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22530 "that L</umount-all> is called when the handle is closed which can also "
22531 "trigger these issues."
22535 #: ../fish/guestfish-actions.pod:2818
22540 #: ../fish/guestfish-actions.pod:2820
22543 " mknod mode devmajor devminor path\n"
22548 #: ../fish/guestfish-actions.pod:2830
22550 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22551 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22552 "regular file). These constants are available in the standard Linux header "
22553 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22554 "wrappers around this command which bitwise OR in the appropriate constant "
22559 #: ../fish/guestfish-actions.pod:2840
22564 #: ../fish/guestfish-actions.pod:2842
22567 " mknod-b mode devmajor devminor path\n"
22572 #: ../fish/guestfish-actions.pod:2844
22574 "This call creates a block device node called C<path> with mode C<mode> and "
22575 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22576 "wrapper around L</mknod>."
22580 #: ../fish/guestfish-actions.pod:2850
22585 #: ../fish/guestfish-actions.pod:2852
22588 " mknod-c mode devmajor devminor path\n"
22593 #: ../fish/guestfish-actions.pod:2854
22595 "This call creates a char device node called C<path> with mode C<mode> and "
22596 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22597 "wrapper around L</mknod>."
22601 #: ../fish/guestfish-actions.pod:2860
22606 #: ../fish/guestfish-actions.pod:2862
22614 #: ../fish/guestfish-actions.pod:2866
22619 #: ../fish/guestfish-actions.pod:2868
22622 " mkswap-L label device\n"
22627 #: ../fish/guestfish-actions.pod:2876
22632 #: ../fish/guestfish-actions.pod:2878
22635 " mkswap-U uuid device\n"
22640 #: ../fish/guestfish-actions.pod:2882
22641 msgid "mkswap-file"
22645 #: ../fish/guestfish-actions.pod:2884
22648 " mkswap-file path\n"
22653 #: ../fish/guestfish-actions.pod:2888
22655 "This command just writes a swap file signature to an existing file. To "
22656 "create the file itself, use something like L</fallocate>."
22660 #: ../fish/guestfish-actions.pod:2891
22665 #: ../fish/guestfish-actions.pod:2893
22668 " modprobe modulename\n"
22673 #: ../fish/guestfish-actions.pod:2900
22678 #: ../fish/guestfish-actions.pod:2902
22681 " mount device mountpoint\n"
22686 #: ../fish/guestfish-actions.pod:2918
22688 "B<Important note:> When you use this call, the filesystem options C<sync> "
22689 "and C<noatime> are set implicitly. This was originally done because we "
22690 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22691 "very large negative performance impact and negligible effect on "
22692 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22693 "code that needs performance, and instead use L</mount-options> (use an empty "
22694 "string for the first parameter if you don't want any options)."
22698 #: ../fish/guestfish-actions.pod:2928
22703 #: ../fish/guestfish-actions.pod:2930
22706 " mount-loop file mountpoint\n"
22711 #: ../fish/guestfish-actions.pod:2936
22712 msgid "mount-options"
22716 #: ../fish/guestfish-actions.pod:2938
22719 " mount-options options device mountpoint\n"
22724 #: ../fish/guestfish-actions.pod:2940
22726 "This is the same as the L</mount> command, but it allows you to set the "
22727 "mount options as for the L<mount(8)> I<-o> flag."
22731 #: ../fish/guestfish-actions.pod:2948
22736 #: ../fish/guestfish-actions.pod:2950
22739 " mount-ro device mountpoint\n"
22744 #: ../fish/guestfish-actions.pod:2952
22746 "This is the same as the L</mount> command, but it mounts the filesystem with "
22747 "the read-only (I<-o ro>) flag."
22751 #: ../fish/guestfish-actions.pod:2955
22756 #: ../fish/guestfish-actions.pod:2957
22759 " mount-vfs options vfstype device mountpoint\n"
22764 #: ../fish/guestfish-actions.pod:2959
22766 "This is the same as the L</mount> command, but it allows you to set both the "
22767 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22771 #: ../fish/guestfish-actions.pod:2963
22772 msgid "mountpoints"
22776 #: ../fish/guestfish-actions.pod:2965
22784 #: ../fish/guestfish-actions.pod:2967
22786 "This call is similar to L</mounts>. That call returns a list of devices. "
22787 "This one returns a hash table (map) of device name to directory where the "
22788 "device is mounted."
22792 #: ../fish/guestfish-actions.pod:2971
22797 #: ../fish/guestfish-actions.pod:2973
22805 #: ../fish/guestfish-actions.pod:2980
22806 msgid "See also: L</mountpoints>"
22810 #: ../fish/guestfish-actions.pod:2982
22815 #: ../fish/guestfish-actions.pod:2984
22823 #: ../fish/guestfish-actions.pod:2989
22824 msgid "ntfs-3g-probe"
22828 #: ../fish/guestfish-actions.pod:2991
22831 " ntfs-3g-probe true|false device\n"
22836 #: ../fish/guestfish-actions.pod:3005
22841 #: ../fish/guestfish-actions.pod:3007
22844 " ntfsresize device\n"
22849 #: ../fish/guestfish-actions.pod:3013
22850 msgid "ntfsresize-size"
22854 #: ../fish/guestfish-actions.pod:3015
22857 " ntfsresize-size device size\n"
22862 #: ../fish/guestfish-actions.pod:3017
22864 "This command is the same as L</ntfsresize> except that it allows you to "
22865 "specify the new size (in bytes) explicitly."
22869 #: ../fish/guestfish-actions.pod:3020
22874 #: ../fish/guestfish-actions.pod:3022
22877 " part-add device prlogex startsect endsect\n"
22882 #: ../fish/guestfish-actions.pod:3024
22884 "This command adds a partition to C<device>. If there is no partition table "
22885 "on the device, call L</part-init> first."
22889 #: ../fish/guestfish-actions.pod:3036
22891 "Creating a partition which covers the whole disk is not so easy. Use L</"
22892 "part-disk> to do that."
22896 #: ../fish/guestfish-actions.pod:3039
22901 #: ../fish/guestfish-actions.pod:3041
22904 " part-del device partnum\n"
22909 #: ../fish/guestfish-actions.pod:3049
22914 #: ../fish/guestfish-actions.pod:3051
22917 " part-disk device parttype\n"
22922 #: ../fish/guestfish-actions.pod:3053
22924 "This command is simply a combination of L</part-init> followed by L</part-"
22925 "add> to create a single primary partition covering the whole disk."
22929 #: ../fish/guestfish-actions.pod:3057
22931 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22932 "possible values are described in L</part-init>."
22936 #: ../fish/guestfish-actions.pod:3063
22937 msgid "part-get-bootable"
22941 #: ../fish/guestfish-actions.pod:3065
22944 " part-get-bootable device partnum\n"
22949 #: ../fish/guestfish-actions.pod:3070
22950 msgid "See also L</part-set-bootable>."
22954 #: ../fish/guestfish-actions.pod:3072
22955 msgid "part-get-mbr-id"
22959 #: ../fish/guestfish-actions.pod:3074
22962 " part-get-mbr-id device partnum\n"
22967 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22969 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22970 "undefined results for other partition table types (see L</part-get-"
22975 #: ../fish/guestfish-actions.pod:3083
22976 msgid "part-get-parttype"
22980 #: ../fish/guestfish-actions.pod:3085
22983 " part-get-parttype device\n"
22988 #: ../fish/guestfish-actions.pod:3090
22990 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22991 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22992 "possible, although unusual. See L</part-init> for a full list."
22996 #: ../fish/guestfish-actions.pod:3095
23001 #: ../fish/guestfish-actions.pod:3097
23004 " part-init device parttype\n"
23009 #: ../fish/guestfish-actions.pod:3103
23011 "Initially there are no partitions. Following this, you should call L</part-"
23012 "add> for each partition required."
23016 #: ../fish/guestfish-actions.pod:3166
23021 #: ../fish/guestfish-actions.pod:3168
23024 " part-list device\n"
23029 #: ../fish/guestfish-actions.pod:3183
23031 "Start of the partition I<in bytes>. To get sectors you have to divide by "
23032 "the device's sector size, see L</blockdev-getss>."
23036 #: ../fish/guestfish-actions.pod:3196
23037 msgid "part-set-bootable"
23041 #: ../fish/guestfish-actions.pod:3198
23044 " part-set-bootable device partnum true|false\n"
23049 #: ../fish/guestfish-actions.pod:3207
23050 msgid "part-set-mbr-id"
23054 #: ../fish/guestfish-actions.pod:3209
23057 " part-set-mbr-id device partnum idbyte\n"
23062 #: ../fish/guestfish-actions.pod:3221
23063 msgid "part-set-name"
23067 #: ../fish/guestfish-actions.pod:3223
23070 " part-set-name device partnum name\n"
23075 #: ../fish/guestfish-actions.pod:3231
23076 msgid "part-to-dev"
23080 #: ../fish/guestfish-actions.pod:3233
23083 " part-to-dev partition\n"
23088 #: ../fish/guestfish-actions.pod:3239
23090 "The named partition must exist, for example as a string returned from L</"
23091 "list-partitions>."
23095 #: ../fish/guestfish-actions.pod:3242
23096 msgid "ping-daemon"
23100 #: ../fish/guestfish-actions.pod:3244
23108 #: ../fish/guestfish-actions.pod:3251
23113 #: ../fish/guestfish-actions.pod:3253
23116 " pread path count offset\n"
23121 #: ../fish/guestfish-actions.pod:3261
23122 msgid "See also L</pwrite>, L</pread-device>."
23126 #: ../fish/guestfish-actions.pod:3266
23127 msgid "pread-device"
23131 #: ../fish/guestfish-actions.pod:3268
23134 " pread-device device count offset\n"
23139 #: ../fish/guestfish-actions.pod:3276
23140 msgid "See also L</pread>."
23144 #: ../fish/guestfish-actions.pod:3281
23149 #: ../fish/guestfish-actions.pod:3283
23152 " pvcreate device\n"
23157 #: ../fish/guestfish-actions.pod:3289
23162 #: ../fish/guestfish-actions.pod:3291
23165 " pvremove device\n"
23170 #: ../fish/guestfish-actions.pod:3300
23175 #: ../fish/guestfish-actions.pod:3302
23178 " pvresize device\n"
23183 #: ../fish/guestfish-actions.pod:3307
23184 msgid "pvresize-size"
23188 #: ../fish/guestfish-actions.pod:3309
23191 " pvresize-size device size\n"
23196 #: ../fish/guestfish-actions.pod:3311
23198 "This command is the same as L</pvresize> except that it allows you to "
23199 "specify the new size (in bytes) explicitly."
23203 #: ../fish/guestfish-actions.pod:3314
23208 #: ../fish/guestfish-actions.pod:3316
23216 #: ../fish/guestfish-actions.pod:3324
23217 msgid "See also L</pvs-full>."
23221 #: ../fish/guestfish-actions.pod:3326
23226 #: ../fish/guestfish-actions.pod:3328
23234 #: ../fish/guestfish-actions.pod:3333
23239 #: ../fish/guestfish-actions.pod:3335
23247 #: ../fish/guestfish-actions.pod:3339
23252 #: ../fish/guestfish-actions.pod:3341
23255 " pwrite path content offset\n"
23260 #: ../fish/guestfish-actions.pod:3352
23261 msgid "See also L</pread>, L</pwrite-device>."
23265 #: ../fish/guestfish-actions.pod:3357
23266 msgid "pwrite-device"
23270 #: ../fish/guestfish-actions.pod:3359
23273 " pwrite-device device content offset\n"
23278 #: ../fish/guestfish-actions.pod:3369
23279 msgid "See also L</pwrite>."
23283 #: ../fish/guestfish-actions.pod:3374
23288 #: ../fish/guestfish-actions.pod:3376
23291 " read-file path\n"
23296 #: ../fish/guestfish-actions.pod:3381
23298 "Unlike L</cat>, this function can correctly handle files that contain "
23299 "embedded ASCII NUL characters. However unlike L</download>, this function "
23300 "is limited in the total size of file that can be handled."
23304 #: ../fish/guestfish-actions.pod:3389
23309 #: ../fish/guestfish-actions.pod:3391
23312 " read-lines path\n"
23317 #: ../fish/guestfish-actions.pod:3398
23319 "Note that this function cannot correctly handle binary files (specifically, "
23320 "files containing C<\\0> character which is treated as end of line). For "
23321 "those you need to use the L</read-file> function which has a more complex "
23326 #: ../fish/guestfish-actions.pod:3403
23331 #: ../fish/guestfish-actions.pod:3405
23339 #: ../fish/guestfish-actions.pod:3457
23341 "This function is primarily intended for use by programs. To get a simple "
23342 "list of names, use L</ls>. To get a printable directory for human "
23343 "consumption, use L</ll>."
23347 #: ../fish/guestfish-actions.pod:3461
23352 #: ../fish/guestfish-actions.pod:3463
23360 #: ../fish/guestfish-actions.pod:3467
23361 msgid "readlinklist"
23365 #: ../fish/guestfish-actions.pod:3469
23368 " readlinklist path 'names ...'\n"
23373 #: ../fish/guestfish-actions.pod:3493
23378 #: ../fish/guestfish-actions.pod:3495
23386 #: ../fish/guestfish-actions.pod:3500
23387 msgid "removexattr"
23391 #: ../fish/guestfish-actions.pod:3502
23394 " removexattr xattr path\n"
23399 #: ../fish/guestfish-actions.pod:3507
23400 msgid "See also: L</lremovexattr>, L<attr(5)>."
23404 #: ../fish/guestfish-actions.pod:3509
23409 #: ../fish/guestfish-actions.pod:3511
23412 " resize2fs device\n"
23417 #: ../fish/guestfish-actions.pod:3516
23419 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23420 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23421 "gives an error about this and sometimes not. In any case, it is always safe "
23422 "to call L</e2fsck-f> before calling this function."
23426 #: ../fish/guestfish-actions.pod:3522
23427 msgid "resize2fs-size"
23431 #: ../fish/guestfish-actions.pod:3524
23434 " resize2fs-size device size\n"
23439 #: ../fish/guestfish-actions.pod:3526
23441 "This command is the same as L</resize2fs> except that it allows you to "
23442 "specify the new size (in bytes) explicitly."
23446 #: ../fish/guestfish-actions.pod:3529
23451 #: ../fish/guestfish-actions.pod:3531
23459 #: ../fish/guestfish-actions.pod:3535
23464 #: ../fish/guestfish-actions.pod:3537
23472 #: ../fish/guestfish-actions.pod:3543
23477 #: ../fish/guestfish-actions.pod:3545
23485 #: ../fish/guestfish-actions.pod:3549
23486 msgid "rmmountpoint"
23490 #: ../fish/guestfish-actions.pod:3551
23493 " rmmountpoint exemptpath\n"
23498 #: ../fish/guestfish-actions.pod:3553
23500 "This calls removes a mountpoint that was previously created with L</"
23501 "mkmountpoint>. See L</mkmountpoint> for full details."
23505 #: ../fish/guestfish-actions.pod:3557
23506 msgid "scrub-device"
23510 #: ../fish/guestfish-actions.pod:3559
23513 " scrub-device device\n"
23518 #: ../fish/guestfish-actions.pod:3570
23523 #: ../fish/guestfish-actions.pod:3572
23526 " scrub-file file\n"
23531 #: ../fish/guestfish-actions.pod:3582
23532 msgid "scrub-freespace"
23536 #: ../fish/guestfish-actions.pod:3584
23539 " scrub-freespace dir\n"
23544 #: ../fish/guestfish-actions.pod:3586
23546 "This command creates the directory C<dir> and then fills it with files until "
23547 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23548 "deletes them. The intention is to scrub any free space on the partition "
23549 "containing C<dir>."
23553 #: ../fish/guestfish-actions.pod:3595
23558 #: ../fish/guestfish-actions.pod:3597
23563 #: ../fish/guestfish-actions.pod:3599
23566 " set-append append\n"
23571 #: ../fish/guestfish-actions.pod:3610
23572 msgid "set-autosync"
23576 #: ../fish/guestfish-actions.pod:3612
23581 #: ../fish/guestfish-actions.pod:3614
23584 " set-autosync true|false\n"
23589 #: ../fish/guestfish-actions.pod:3616
23591 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23592 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23593 "closed (also if the program exits without closing handles)."
23597 #: ../fish/guestfish-actions.pod:3624
23602 #: ../fish/guestfish-actions.pod:3626
23607 #: ../fish/guestfish-actions.pod:3628
23610 " set-direct true|false\n"
23615 #: ../fish/guestfish-actions.pod:3634
23617 "One consequence of this is that log messages aren't caught by the library "
23618 "and handled by L</set-log-message-callback>, but go straight to stdout."
23622 #: ../fish/guestfish-actions.pod:3643
23623 msgid "set-e2label"
23627 #: ../fish/guestfish-actions.pod:3645
23630 " set-e2label device label\n"
23635 #: ../fish/guestfish-actions.pod:3651
23637 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23638 "label on a filesystem."
23642 #: ../fish/guestfish-actions.pod:3654
23647 #: ../fish/guestfish-actions.pod:3656
23650 " set-e2uuid device uuid\n"
23655 #: ../fish/guestfish-actions.pod:3663
23657 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23658 "UUID of a filesystem."
23662 #: ../fish/guestfish-actions.pod:3666
23663 msgid "set-memsize"
23667 #: ../fish/guestfish-actions.pod:3668
23672 #: ../fish/guestfish-actions.pod:3670
23675 " set-memsize memsize\n"
23680 #: ../fish/guestfish-actions.pod:3672
23682 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23683 "This only has any effect if called before L</launch>."
23687 #: ../fish/guestfish-actions.pod:3683
23688 msgid "set-network"
23692 #: ../fish/guestfish-actions.pod:3685
23697 #: ../fish/guestfish-actions.pod:3687
23700 " set-network true|false\n"
23705 #: ../fish/guestfish-actions.pod:3695
23707 "You must call this before calling L</launch>, otherwise it has no effect."
23711 #: ../fish/guestfish-actions.pod:3698
23716 #: ../fish/guestfish-actions.pod:3700
23721 #: ../fish/guestfish-actions.pod:3702
23724 " set-path searchpath\n"
23729 #: ../fish/guestfish-actions.pod:3711
23734 #: ../fish/guestfish-actions.pod:3713
23739 #: ../fish/guestfish-actions.pod:3715
23747 #: ../fish/guestfish-actions.pod:3735
23748 msgid "set-recovery-proc"
23752 #: ../fish/guestfish-actions.pod:3737
23753 msgid "recovery-proc"
23757 #: ../fish/guestfish-actions.pod:3739
23760 " set-recovery-proc true|false\n"
23765 #: ../fish/guestfish-actions.pod:3741
23767 "If this is called with the parameter C<false> then L</launch> does not "
23768 "create a recovery process. The purpose of the recovery process is to stop "
23769 "runaway qemu processes in the case where the main program aborts abruptly."
23773 #: ../fish/guestfish-actions.pod:3746
23775 "This only has any effect if called before L</launch>, and the default is "
23780 #: ../fish/guestfish-actions.pod:3755
23781 msgid "set-selinux"
23785 #: ../fish/guestfish-actions.pod:3757
23790 #: ../fish/guestfish-actions.pod:3759
23793 " set-selinux true|false\n"
23798 #: ../fish/guestfish-actions.pod:3770
23803 #: ../fish/guestfish-actions.pod:3772
23808 #: ../fish/guestfish-actions.pod:3774
23811 " set-trace true|false\n"
23816 #: ../fish/guestfish-actions.pod:3790
23817 msgid "set-verbose"
23821 #: ../fish/guestfish-actions.pod:3792
23826 #: ../fish/guestfish-actions.pod:3794
23829 " set-verbose true|false\n"
23834 #: ../fish/guestfish-actions.pod:3801
23839 #: ../fish/guestfish-actions.pod:3803
23842 " setcon context\n"
23847 #: ../fish/guestfish-actions.pod:3810
23852 #: ../fish/guestfish-actions.pod:3812
23855 " setxattr xattr val vallen path\n"
23860 #: ../fish/guestfish-actions.pod:3818
23861 msgid "See also: L</lsetxattr>, L<attr(5)>."
23865 #: ../fish/guestfish-actions.pod:3820
23870 #: ../fish/guestfish-actions.pod:3822
23873 " sfdisk device cyls heads sectors 'lines ...'\n"
23878 #: ../fish/guestfish-actions.pod:3844
23879 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23883 #: ../fish/guestfish-actions.pod:3850
23888 #: ../fish/guestfish-actions.pod:3852
23891 " sfdiskM device 'lines ...'\n"
23896 #: ../fish/guestfish-actions.pod:3854
23898 "This is a simplified interface to the L</sfdisk> command, where partition "
23899 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23900 "you don't need to specify the cyls, heads and sectors parameters which were "
23901 "rarely if ever used anyway."
23905 #: ../fish/guestfish-actions.pod:3860
23906 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23910 #: ../fish/guestfish-actions.pod:3866
23915 #: ../fish/guestfish-actions.pod:3868
23918 " sfdisk-N device partnum cyls heads sectors line\n"
23923 #: ../fish/guestfish-actions.pod:3873
23925 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23926 "cyls/heads/sectors parameters."
23930 #: ../fish/guestfish-actions.pod:3876
23931 msgid "See also: L</part-add>"
23935 #: ../fish/guestfish-actions.pod:3881
23936 msgid "sfdisk-disk-geometry"
23940 #: ../fish/guestfish-actions.pod:3883
23943 " sfdisk-disk-geometry device\n"
23948 #: ../fish/guestfish-actions.pod:3885
23950 "This displays the disk geometry of C<device> read from the partition table. "
23951 "Especially in the case where the underlying block device has been resized, "
23952 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
23953 "kernel-geometry>)."
23957 #: ../fish/guestfish-actions.pod:3893
23958 msgid "sfdisk-kernel-geometry"
23962 #: ../fish/guestfish-actions.pod:3895
23965 " sfdisk-kernel-geometry device\n"
23970 #: ../fish/guestfish-actions.pod:3902
23975 #: ../fish/guestfish-actions.pod:3904
23978 " sfdisk-l device\n"
23983 #: ../fish/guestfish-actions.pod:3910
23984 msgid "See also: L</part-list>"
23988 #: ../fish/guestfish-actions.pod:3912
23993 #: ../fish/guestfish-actions.pod:3914
24001 #: ../fish/guestfish-actions.pod:3919
24002 msgid "This is like L</command>, but passes the command to:"
24006 #: ../fish/guestfish-actions.pod:3927
24007 msgid "All the provisos about L</command> apply to this call."
24011 #: ../fish/guestfish-actions.pod:3929
24016 #: ../fish/guestfish-actions.pod:3931
24019 " sh-lines command\n"
24024 #: ../fish/guestfish-actions.pod:3933
24025 msgid "This is the same as L</sh>, but splits the result into a list of lines."
24029 #: ../fish/guestfish-actions.pod:3936
24030 msgid "See also: L</command-lines>"
24034 #: ../fish/guestfish-actions.pod:3938
24039 #: ../fish/guestfish-actions.pod:3940
24047 #: ../fish/guestfish-actions.pod:3944
24052 #: ../fish/guestfish-actions.pod:3946
24060 #: ../fish/guestfish-actions.pod:3952
24065 #: ../fish/guestfish-actions.pod:3954
24073 #: ../fish/guestfish-actions.pod:3962
24078 #: ../fish/guestfish-actions.pod:3964
24086 #: ../fish/guestfish-actions.pod:3972
24091 #: ../fish/guestfish-actions.pod:3974
24094 " strings-e encoding path\n"
24099 #: ../fish/guestfish-actions.pod:3976
24101 "This is like the L</strings> command, but allows you to specify the encoding "
24102 "of strings that are looked for in the source file C<path>."
24106 #: ../fish/guestfish-actions.pod:3986
24108 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
24109 "ISO-8859-X (this is what L</strings> uses)."
24113 #: ../fish/guestfish-actions.pod:4018
24114 msgid "swapoff-device"
24118 #: ../fish/guestfish-actions.pod:4020
24121 " swapoff-device device\n"
24126 #: ../fish/guestfish-actions.pod:4022
24128 "This command disables the libguestfs appliance swap device or partition "
24129 "named C<device>. See L</swapon-device>."
24133 #: ../fish/guestfish-actions.pod:4026
24134 msgid "swapoff-file"
24138 #: ../fish/guestfish-actions.pod:4028
24141 " swapoff-file file\n"
24146 #: ../fish/guestfish-actions.pod:4032
24147 msgid "swapoff-label"
24151 #: ../fish/guestfish-actions.pod:4034
24154 " swapoff-label label\n"
24159 #: ../fish/guestfish-actions.pod:4039
24160 msgid "swapoff-uuid"
24164 #: ../fish/guestfish-actions.pod:4041
24167 " swapoff-uuid uuid\n"
24172 #: ../fish/guestfish-actions.pod:4046
24173 msgid "swapon-device"
24177 #: ../fish/guestfish-actions.pod:4048
24180 " swapon-device device\n"
24185 #: ../fish/guestfish-actions.pod:4050
24187 "This command enables the libguestfs appliance to use the swap device or "
24188 "partition named C<device>. The increased memory is made available for all "
24189 "commands, for example those run using L</command> or L</sh>."
24193 #: ../fish/guestfish-actions.pod:4062
24194 msgid "swapon-file"
24198 #: ../fish/guestfish-actions.pod:4064
24201 " swapon-file file\n"
24206 #: ../fish/guestfish-actions.pod:4066
24208 "This command enables swap to a file. See L</swapon-device> for other notes."
24212 #: ../fish/guestfish-actions.pod:4069
24213 msgid "swapon-label"
24217 #: ../fish/guestfish-actions.pod:4071
24220 " swapon-label label\n"
24225 #: ../fish/guestfish-actions.pod:4073
24227 "This command enables swap to a labeled swap partition. See L</swapon-"
24228 "device> for other notes."
24232 #: ../fish/guestfish-actions.pod:4076
24233 msgid "swapon-uuid"
24237 #: ../fish/guestfish-actions.pod:4078
24240 " swapon-uuid uuid\n"
24245 #: ../fish/guestfish-actions.pod:4080
24247 "This command enables swap to a swap partition with the given UUID. See L</"
24248 "swapon-device> for other notes."
24252 #: ../fish/guestfish-actions.pod:4083
24257 #: ../fish/guestfish-actions.pod:4085
24265 #: ../fish/guestfish-actions.pod:4093
24270 #: ../fish/guestfish-actions.pod:4095
24278 #: ../fish/guestfish-actions.pod:4103
24283 #: ../fish/guestfish-actions.pod:4105
24286 " tail-n nrlines path\n"
24291 #: ../fish/guestfish-actions.pod:4118
24296 #: ../fish/guestfish-actions.pod:4120
24299 " tar-in (tarfile|-) directory\n"
24304 #: ../fish/guestfish-actions.pod:4125
24305 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24309 #: ../fish/guestfish-actions.pod:4130
24314 #: ../fish/guestfish-actions.pod:4132
24317 " tar-out directory (tarfile|-)\n"
24322 #: ../fish/guestfish-actions.pod:4137
24323 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24327 #: ../fish/guestfish-actions.pod:4142
24332 #: ../fish/guestfish-actions.pod:4144
24335 " tgz-in (tarball|-) directory\n"
24340 #: ../fish/guestfish-actions.pod:4149
24341 msgid "To upload an uncompressed tarball, use L</tar-in>."
24345 #: ../fish/guestfish-actions.pod:4153
24350 #: ../fish/guestfish-actions.pod:4155
24353 " tgz-out directory (tarball|-)\n"
24358 #: ../fish/guestfish-actions.pod:4160
24359 msgid "To download an uncompressed tarball, use L</tar-out>."
24363 #: ../fish/guestfish-actions.pod:4164
24368 #: ../fish/guestfish-actions.pod:4166
24376 #: ../fish/guestfish-actions.pod:4175
24381 #: ../fish/guestfish-actions.pod:4177
24389 #: ../fish/guestfish-actions.pod:4182
24390 msgid "truncate-size"
24394 #: ../fish/guestfish-actions.pod:4184
24397 " truncate-size path size\n"
24402 #: ../fish/guestfish-actions.pod:4189
24404 "If the current file size is less than C<size> then the file is extended to "
24405 "the required size with zero bytes. This creates a sparse file (ie. disk "
24406 "blocks are not allocated for the file until you write to it). To create a "
24407 "non-sparse file of zeroes, use L</fallocate64> instead."
24411 #: ../fish/guestfish-actions.pod:4195
24416 #: ../fish/guestfish-actions.pod:4197
24419 " tune2fs-l device\n"
24424 #: ../fish/guestfish-actions.pod:4207
24429 #: ../fish/guestfish-actions.pod:4209
24432 " txz-in (tarball|-) directory\n"
24437 #: ../fish/guestfish-actions.pod:4216
24442 #: ../fish/guestfish-actions.pod:4218
24445 " txz-out directory (tarball|-)\n"
24450 #: ../fish/guestfish-actions.pod:4225
24455 #: ../fish/guestfish-actions.pod:4227
24463 #: ../fish/guestfish-actions.pod:4241
24464 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24468 #: ../fish/guestfish-actions.pod:4246
24473 #: ../fish/guestfish-actions.pod:4248
24478 #: ../fish/guestfish-actions.pod:4250
24481 " umount pathordevice\n"
24486 #: ../fish/guestfish-actions.pod:4256
24491 #: ../fish/guestfish-actions.pod:4258
24492 msgid "unmount-all"
24496 #: ../fish/guestfish-actions.pod:4260
24504 #: ../fish/guestfish-actions.pod:4266
24509 #: ../fish/guestfish-actions.pod:4268
24512 " upload (filename|-) remotefilename\n"
24517 #: ../fish/guestfish-actions.pod:4275
24518 msgid "See also L</download>."
24522 #: ../fish/guestfish-actions.pod:4279
24523 msgid "upload-offset"
24527 #: ../fish/guestfish-actions.pod:4281
24530 " upload-offset (filename|-) remotefilename offset\n"
24535 #: ../fish/guestfish-actions.pod:4293
24537 "Note that there is no limit on the amount of data that can be uploaded with "
24538 "this call, unlike with L</pwrite>, and this call always writes the full "
24539 "amount unless an error occurs."
24543 #: ../fish/guestfish-actions.pod:4298
24544 msgid "See also L</upload>, L</pwrite>."
24548 #: ../fish/guestfish-actions.pod:4302
24553 #: ../fish/guestfish-actions.pod:4304
24556 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24561 #: ../fish/guestfish-actions.pod:4323
24566 #: ../fish/guestfish-actions.pod:4325
24574 #: ../fish/guestfish-actions.pod:4352
24576 "I<Note:> Don't use this call to test for availability of features. In "
24577 "enterprise distributions we backport features from later versions into "
24578 "earlier versions, making this an unreliable way to test for features. Use "
24579 "L</available> instead."
24583 #: ../fish/guestfish-actions.pod:4358
24588 #: ../fish/guestfish-actions.pod:4360
24591 " vfs-label device\n"
24596 #: ../fish/guestfish-actions.pod:4367
24597 msgid "To find a filesystem from the label, use L</findfs-label>."
24601 #: ../fish/guestfish-actions.pod:4369
24606 #: ../fish/guestfish-actions.pod:4371
24609 " vfs-type device\n"
24614 #: ../fish/guestfish-actions.pod:4381
24619 #: ../fish/guestfish-actions.pod:4383
24622 " vfs-uuid device\n"
24627 #: ../fish/guestfish-actions.pod:4390
24628 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24632 #: ../fish/guestfish-actions.pod:4392
24633 msgid "vg-activate"
24637 #: ../fish/guestfish-actions.pod:4394
24640 " vg-activate true|false 'volgroups ...'\n"
24645 #: ../fish/guestfish-actions.pod:4407
24646 msgid "vg-activate-all"
24650 #: ../fish/guestfish-actions.pod:4409
24653 " vg-activate-all true|false\n"
24658 #: ../fish/guestfish-actions.pod:4419
24663 #: ../fish/guestfish-actions.pod:4421
24666 " vgcreate volgroup 'physvols ...'\n"
24671 #: ../fish/guestfish-actions.pod:4426
24676 #: ../fish/guestfish-actions.pod:4428
24679 " vglvuuids vgname\n"
24684 #: ../fish/guestfish-actions.pod:4433
24686 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24687 "logical volumes and volume groups."
24691 #: ../fish/guestfish-actions.pod:4436
24692 msgid "See also L</vgpvuuids>."
24696 #: ../fish/guestfish-actions.pod:4438
24701 #: ../fish/guestfish-actions.pod:4440
24704 " vgpvuuids vgname\n"
24709 #: ../fish/guestfish-actions.pod:4445
24711 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24712 "physical volumes and volume groups."
24716 #: ../fish/guestfish-actions.pod:4448
24717 msgid "See also L</vglvuuids>."
24721 #: ../fish/guestfish-actions.pod:4450
24726 #: ../fish/guestfish-actions.pod:4452
24729 " vgremove vgname\n"
24734 #: ../fish/guestfish-actions.pod:4459
24739 #: ../fish/guestfish-actions.pod:4461
24742 " vgrename volgroup newvolgroup\n"
24747 #: ../fish/guestfish-actions.pod:4465
24752 #: ../fish/guestfish-actions.pod:4467
24760 #: ../fish/guestfish-actions.pod:4475
24761 msgid "See also L</vgs-full>."
24765 #: ../fish/guestfish-actions.pod:4477
24770 #: ../fish/guestfish-actions.pod:4479
24778 #: ../fish/guestfish-actions.pod:4484
24783 #: ../fish/guestfish-actions.pod:4486
24791 #: ../fish/guestfish-actions.pod:4491
24796 #: ../fish/guestfish-actions.pod:4493
24804 #: ../fish/guestfish-actions.pod:4497
24809 #: ../fish/guestfish-actions.pod:4499
24817 #: ../fish/guestfish-actions.pod:4504
24822 #: ../fish/guestfish-actions.pod:4506
24830 #: ../fish/guestfish-actions.pod:4511
24835 #: ../fish/guestfish-actions.pod:4513
24843 #: ../fish/guestfish-actions.pod:4518
24848 #: ../fish/guestfish-actions.pod:4520
24851 " write path content\n"
24856 #: ../fish/guestfish-actions.pod:4528
24861 #: ../fish/guestfish-actions.pod:4530
24864 " write-file path content size\n"
24869 #: ../fish/guestfish-actions.pod:4553
24874 #: ../fish/guestfish-actions.pod:4555
24877 " zegrep regex path\n"
24882 #: ../fish/guestfish-actions.pod:4563
24887 #: ../fish/guestfish-actions.pod:4565
24890 " zegrepi regex path\n"
24895 #: ../fish/guestfish-actions.pod:4573
24900 #: ../fish/guestfish-actions.pod:4575
24908 #: ../fish/guestfish-actions.pod:4583
24909 msgid "See also: L</zero-device>, L</scrub-device>."
24913 #: ../fish/guestfish-actions.pod:4585
24914 msgid "zero-device"
24918 #: ../fish/guestfish-actions.pod:4587
24921 " zero-device device\n"
24926 #: ../fish/guestfish-actions.pod:4589
24928 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24929 "which just zeroes the first few blocks of a device."
24933 #: ../fish/guestfish-actions.pod:4596
24938 #: ../fish/guestfish-actions.pod:4598
24941 " zerofree device\n"
24946 #: ../fish/guestfish-actions.pod:4611
24951 #: ../fish/guestfish-actions.pod:4613
24954 " zfgrep pattern path\n"
24959 #: ../fish/guestfish-actions.pod:4621
24964 #: ../fish/guestfish-actions.pod:4623
24967 " zfgrepi pattern path\n"
24972 #: ../fish/guestfish-actions.pod:4631
24977 #: ../fish/guestfish-actions.pod:4633
24980 " zfile meth path\n"
24985 #: ../fish/guestfish-actions.pod:4640
24987 "Since 1.0.63, use L</file> instead which can now process compressed files."
24991 #: ../fish/guestfish-actions.pod:4650
24996 #: ../fish/guestfish-actions.pod:4652
24999 " zgrep regex path\n"
25004 #: ../fish/guestfish-actions.pod:4660
25009 #: ../fish/guestfish-actions.pod:4662
25012 " zgrepi regex path\n"
25017 #: ../fish/guestfish-commands.pod:1
25022 #: ../fish/guestfish-commands.pod:3
25027 #: ../fish/guestfish-commands.pod:5
25030 " alloc filename size\n"
25035 #: ../fish/guestfish-commands.pod:7
25037 "This creates an empty (zeroed) file of the given size, and then adds so it "
25038 "can be further examined."
25042 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
25043 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
25047 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
25048 msgid "Size can be specified using standard suffixes, eg. C<1M>."
25052 #: ../fish/guestfish-commands.pod:14
25054 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
25055 "image, see L</PREPARED DISK IMAGES>."
25059 #: ../fish/guestfish-commands.pod:17
25064 #: ../fish/guestfish-commands.pod:19
25067 " copy-in local [local ...] /remotedir\n"
25072 #: ../fish/guestfish-commands.pod:21
25074 "C<copy-in> copies local files or directories recursively into the disk "
25075 "image, placing them in the directory called C</remotedir> (which must "
25076 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
25077 "other commands as necessary."
25081 #: ../fish/guestfish-commands.pod:26
25083 "Multiple local files and directories can be specified, but the last "
25084 "parameter must always be a remote directory. Wildcards cannot be used."
25088 #: ../fish/guestfish-commands.pod:30
25093 #: ../fish/guestfish-commands.pod:32
25096 " copy-out remote [remote ...] localdir\n"
25101 #: ../fish/guestfish-commands.pod:34
25103 "C<copy-out> copies remote files or directories recursively out of the disk "
25104 "image, placing them on the host disk in a local directory called C<localdir> "
25105 "(which must exist). This guestfish meta-command turns into a sequence of L</"
25106 "download>, L</tar-out> and other commands as necessary."
25110 #: ../fish/guestfish-commands.pod:40
25112 "Multiple remote files and directories can be specified, but the last "
25113 "parameter must always be a local directory. To download to the current "
25114 "directory, use C<.> as in:"
25118 #: ../fish/guestfish-commands.pod:44
25121 " copy-out /home .\n"
25126 #: ../fish/guestfish-commands.pod:46
25128 "Wildcards cannot be used in the ordinary command, but you can use them with "
25129 "the help of L</glob> like this:"
25133 #: ../fish/guestfish-commands.pod:49
25136 " glob copy-out /home/* .\n"
25141 #: ../fish/guestfish-commands.pod:51
25146 #: ../fish/guestfish-commands.pod:53
25149 " echo [params ...]\n"
25154 #: ../fish/guestfish-commands.pod:55
25155 msgid "This echos the parameters to the terminal."
25159 #: ../fish/guestfish-commands.pod:57
25164 #: ../fish/guestfish-commands.pod:59
25169 #: ../fish/guestfish-commands.pod:61
25174 #: ../fish/guestfish-commands.pod:63
25182 #: ../fish/guestfish-commands.pod:65
25184 "This is used to edit a file. It downloads the file, edits it locally using "
25185 "your editor, then uploads the result."
25189 #: ../fish/guestfish-commands.pod:68
25191 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
25192 "or C<emacs> you will get those corresponding editors."
25196 #: ../fish/guestfish-commands.pod:72
25201 #: ../fish/guestfish-commands.pod:74
25204 " glob command args...\n"
25209 #: ../fish/guestfish-commands.pod:76
25211 "Expand wildcards in any paths in the args list, and run C<command> "
25212 "repeatedly on each matching path."
25216 #: ../fish/guestfish-commands.pod:79
25217 msgid "See L</WILDCARDS AND GLOBBING>."
25221 #: ../fish/guestfish-commands.pod:81
25226 #: ../fish/guestfish-commands.pod:83
25229 " hexedit <filename|device>\n"
25230 " hexedit <filename|device> <max>\n"
25231 " hexedit <filename|device> <start> <max>\n"
25236 #: ../fish/guestfish-commands.pod:87
25238 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
25243 #: ../fish/guestfish-commands.pod:90
25245 "This command works by downloading potentially the whole file or device, "
25246 "editing it locally, then uploading it. If the file or device is large, you "
25247 "have to specify which part you wish to edit by using C<max> and/or C<start> "
25248 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
25249 "usual modifiers allowed such as C<1M> (1 megabyte)."
25253 #: ../fish/guestfish-commands.pod:97
25254 msgid "For example to edit the first few sectors of a disk you might do:"
25258 #: ../fish/guestfish-commands.pod:100
25261 " hexedit /dev/sda 1M\n"
25266 #: ../fish/guestfish-commands.pod:102
25268 "which would allow you to edit anywhere within the first megabyte of the disk."
25272 #: ../fish/guestfish-commands.pod:105
25273 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
25277 #: ../fish/guestfish-commands.pod:107
25280 " hexedit /dev/sda1 0x400 0x400\n"
25285 #: ../fish/guestfish-commands.pod:109
25286 msgid "(assuming the superblock is in the standard location)."
25290 #: ../fish/guestfish-commands.pod:111
25292 "This command requires the external L<hexedit(1)> program. You can specify "
25293 "another program to use by setting the C<HEXEDITOR> environment variable."
25297 #: ../fish/guestfish-commands.pod:115
25298 msgid "See also L</hexdump>."
25302 #: ../fish/guestfish-commands.pod:117
25307 #: ../fish/guestfish-commands.pod:119
25315 #: ../fish/guestfish-commands.pod:121
25317 "Change the local directory, ie. the current directory of guestfish itself."
25321 #: ../fish/guestfish-commands.pod:124
25322 msgid "Note that C<!cd> won't do what you might expect."
25326 #: ../fish/guestfish-commands.pod:126
25331 #: ../fish/guestfish-commands.pod:128
25336 #: ../fish/guestfish-commands.pod:130
25344 #: ../fish/guestfish-commands.pod:132
25345 msgid "Opens the manual page for guestfish."
25349 #: ../fish/guestfish-commands.pod:134
25354 #: ../fish/guestfish-commands.pod:136
25359 #: ../fish/guestfish-commands.pod:138
25367 #: ../fish/guestfish-commands.pod:140
25375 #: ../fish/guestfish-commands.pod:142
25376 msgid "This is used to view a file."
25380 #: ../fish/guestfish-commands.pod:144
25382 "The default viewer is C<$PAGER>. However if you use the alternate command "
25383 "C<less> you will get the C<less> command specifically."
25387 #: ../fish/guestfish-commands.pod:147
25392 #: ../fish/guestfish-commands.pod:149
25400 #: ../fish/guestfish-commands.pod:151
25402 "Close and reopen the libguestfs handle. It is not necessary to use this "
25403 "normally, because the handle is closed properly when guestfish exits. "
25404 "However this is occasionally useful for testing."
25408 #: ../fish/guestfish-commands.pod:155
25413 #: ../fish/guestfish-commands.pod:157
25416 " sparse filename size\n"
25421 #: ../fish/guestfish-commands.pod:159
25423 "This creates an empty sparse file of the given size, and then adds so it can "
25424 "be further examined."
25428 #: ../fish/guestfish-commands.pod:162
25430 "In all respects it works the same as the L</alloc> command, except that the "
25431 "image file is allocated sparsely, which means that disk blocks are not "
25432 "assigned to the file until they are needed. Sparse disk files only use "
25433 "space when written to, but they are slower and there is a danger you could "
25434 "run out of real disk space during a write operation."
25438 #: ../fish/guestfish-commands.pod:172
25443 #: ../fish/guestfish-commands.pod:174
25451 #: ../fish/guestfish-commands.pod:176
25453 "This command returns a list of the optional groups known to the daemon, and "
25454 "indicates which ones are supported by this build of the libguestfs appliance."
25458 #: ../fish/guestfish-commands.pod:180
25459 msgid "See also L<guestfs(3)/AVAILABILITY>."
25463 #: ../fish/guestfish-commands.pod:182
25468 #: ../fish/guestfish-commands.pod:184
25471 " time command args...\n"
25476 #: ../fish/guestfish-commands.pod:186
25478 "Run the command as usual, but print the elapsed time afterwards. This can "
25479 "be useful for benchmarking operations."
25483 #: ../test-tool/libguestfs-test-tool.pod:5
25484 msgid "libguestfs-test-tool - End user tests for libguestfs"
25488 #: ../test-tool/libguestfs-test-tool.pod:9
25491 " libguestfs-test-tool [--options]\n"
25496 #: ../test-tool/libguestfs-test-tool.pod:13
25498 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25499 "and developers, to allow them to check basic libguestfs functionality is "
25500 "working. This is needed because libguestfs occasionally breaks for reasons "
25501 "beyond our control: usually because of changes in the underlying qemu or "
25502 "kernel packages, or the host environment."
25506 #: ../test-tool/libguestfs-test-tool.pod:20
25507 msgid "If you suspect a problem in libguestfs, then just run:"
25511 #: ../test-tool/libguestfs-test-tool.pod:22
25514 " libguestfs-test-tool\n"
25519 #: ../test-tool/libguestfs-test-tool.pod:24
25520 msgid "It will print lots of diagnostic messages."
25524 #: ../test-tool/libguestfs-test-tool.pod:26
25525 msgid "If it runs to completion successfully, you will see this near the end:"
25529 #: ../test-tool/libguestfs-test-tool.pod:28
25532 " ===== TEST FINISHED OK =====\n"
25537 #: ../test-tool/libguestfs-test-tool.pod:30
25538 msgid "and the test tool will exit with code 0."
25542 #: ../test-tool/libguestfs-test-tool.pod:32
25544 "If it fails (and/or exits with non-zero error code), please paste the "
25545 "B<complete, unedited> output of the test tool into a bug report. More "
25546 "information about reporting bugs can be found on the L<http://libguestfs.org/"
25551 #: ../test-tool/libguestfs-test-tool.pod:41
25556 #: ../test-tool/libguestfs-test-tool.pod:43
25557 msgid "Display short usage information and exit."
25561 #: ../test-tool/libguestfs-test-tool.pod:45
25562 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25566 #: ../test-tool/libguestfs-test-tool.pod:47
25568 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25569 "normally look in the C<$libexec> directory that was configured when the tool "
25574 #: ../test-tool/libguestfs-test-tool.pod:51
25575 msgid "I<--qemu qemu_binary>"
25579 #: ../test-tool/libguestfs-test-tool.pod:53
25581 "If you have downloaded another qemu binary, point this option at the full "
25582 "path of the binary to try it."
25586 #: ../test-tool/libguestfs-test-tool.pod:56
25587 msgid "I<--qemudir qemu_source_dir>"
25591 #: ../test-tool/libguestfs-test-tool.pod:58
25593 "If you have compiled qemu from source, point this option at the source "
25594 "directory to try it."
25598 #: ../test-tool/libguestfs-test-tool.pod:61
25599 msgid "I<--timeout N>"
25603 #: ../test-tool/libguestfs-test-tool.pod:63
25605 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25606 "does not usually need to be adjusted unless your machine is very slow."
25610 #: ../test-tool/libguestfs-test-tool.pod:69
25611 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25615 #: ../test-tool/libguestfs-test-tool.pod:71
25617 "If you have compiled another version of qemu from source and would like to "
25618 "try that, then you can use the I<--qemudir> option to point to the qemu "
25619 "source directory."
25623 #: ../test-tool/libguestfs-test-tool.pod:75
25625 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25626 "option to point to the binary."
25630 #: ../test-tool/libguestfs-test-tool.pod:78
25632 "When using an alternate qemu with libguestfs, usually you would need to "
25633 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
25634 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
25635 "use either of the I<--qemudir> or I<--qemu> options."
25639 #: ../test-tool/libguestfs-test-tool.pod:85
25641 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25642 "I<1> if there was an error."
25646 #: ../test-tool/libguestfs-test-tool.pod:92
25647 msgid "/usr/libexec/libguestfs-test-tool-helper"
25651 #: ../test-tool/libguestfs-test-tool.pod:94
25653 "This helper program is run inside the appliance and provides additional "
25658 #: ../test-tool/libguestfs-test-tool.pod:97
25659 msgid "/usr/bin/mkisofs"
25663 #: ../test-tool/libguestfs-test-tool.pod:99
25665 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25666 "which is used as part of the tests."
25670 #: ../test-tool/libguestfs-test-tool.pod:106
25672 "For the full list of environment variables which may affect libguestfs, "
25673 "please see the L<guestfs(3)> manual page."
25677 #: ../test-tool/libguestfs-test-tool.pod:111
25678 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25682 #: ../test-tool/libguestfs-test-tool.pod:121
25683 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25687 #: ../fuse/guestmount.pod:5
25689 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25693 #: ../fuse/guestmount.pod:9
25696 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25701 #: ../fuse/guestmount.pod:11
25704 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25709 #: ../fuse/guestmount.pod:13
25712 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25717 #: ../fuse/guestmount.pod:17
25719 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25720 "machines. If you do this, you risk disk corruption in the VM."
25724 #: ../fuse/guestmount.pod:22
25726 "The guestmount program can be used to mount virtual machine filesystems and "
25727 "other disk images on the host. It uses libguestfs for access to the guest "
25728 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25729 "a mountable device."
25733 #: ../fuse/guestmount.pod:27
25735 "Along with other options, you have to give at least one device (I<-a> "
25736 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25737 "option) or use the I<-i> inspection option. How this works is better "
25738 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25743 #: ../fuse/guestmount.pod:33
25745 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25746 "by you, and the filesystem will not be visible to any other users unless you "
25747 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25748 "the filesystem, use the C<fusermount -u> command."
25752 #: ../fuse/guestmount.pod:41
25754 "For a typical Windows guest which has its main filesystem on the first "
25759 #: ../fuse/guestmount.pod:44
25762 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25767 #: ../fuse/guestmount.pod:46
25769 "For a typical Linux guest which has a /boot filesystem on the first "
25770 "partition, and the root filesystem on a logical volume:"
25774 #: ../fuse/guestmount.pod:49
25777 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25782 #: ../fuse/guestmount.pod:51
25783 msgid "To get libguestfs to detect guest mountpoints for you:"
25787 #: ../fuse/guestmount.pod:53
25790 " guestmount -a guest.img -i --ro /mnt\n"
25795 #: ../fuse/guestmount.pod:55
25796 msgid "For a libvirt guest called \"Guest\" you could do:"
25800 #: ../fuse/guestmount.pod:57
25803 " guestmount -d Guest -i --ro /mnt\n"
25808 #: ../fuse/guestmount.pod:59
25810 "If you don't know what filesystems are contained in a guest or disk image, "
25811 "use L<virt-filesystems(1)> first:"
25815 #: ../fuse/guestmount.pod:62
25818 " virt-filesystems MyGuest\n"
25823 #: ../fuse/guestmount.pod:64
25825 "If you want to trace the libguestfs calls but without excessive debugging "
25826 "information, we recommend:"
25830 #: ../fuse/guestmount.pod:67
25833 " guestmount [...] --trace /mnt\n"
25838 #: ../fuse/guestmount.pod:69
25839 msgid "If you want to debug the program, we recommend:"
25843 #: ../fuse/guestmount.pod:71
25846 " guestmount [...] --trace --verbose /mnt\n"
25851 #: ../fuse/guestmount.pod:79
25852 msgid "Add a block device or virtual machine image."
25856 #: ../fuse/guestmount.pod:96
25857 msgid "B<--dir-cache-timeout N>"
25861 #: ../fuse/guestmount.pod:98
25863 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25864 "seconds. The readdir cache [actually, there are several semi-independent "
25865 "caches] is populated after a readdir(2) call with the stat and extended "
25866 "attributes of the files in the directory, in anticipation that they will be "
25867 "requested soon after."
25871 #: ../fuse/guestmount.pod:104
25873 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25874 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25875 "requests, only cache existing ones."
25879 #: ../fuse/guestmount.pod:122
25881 "If you have untrusted raw-format guest disk images, you should use this "
25882 "option to specify the disk format. This avoids a possible security problem "
25883 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
25884 "guestfs_add_drive_opts>."
25888 #: ../fuse/guestmount.pod:127
25889 msgid "B<--fuse-help>"
25893 #: ../fuse/guestmount.pod:129
25894 msgid "Display help on special FUSE options (see I<-o> below)."
25898 #: ../fuse/guestmount.pod:133
25899 msgid "Display brief help and exit."
25903 #: ../fuse/guestmount.pod:146
25904 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25908 #: ../fuse/guestmount.pod:148
25910 "Mount the named partition or logical volume on the given mountpoint B<in the "
25911 "guest> (this has nothing to do with mountpoints in the host)."
25915 #: ../fuse/guestmount.pod:151
25917 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25918 "something on C</>."
25922 #: ../fuse/guestmount.pod:156
25924 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25925 "unmounted. If you specify this option, then we don't attempt to sync the "
25926 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25930 #: ../fuse/guestmount.pod:161
25931 msgid "B<-o option> | B<--option option>"
25935 #: ../fuse/guestmount.pod:163
25936 msgid "Pass extra options to FUSE."
25940 #: ../fuse/guestmount.pod:165
25942 "To get a list of all the extra options supported by FUSE, use the command "
25943 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25944 "of them are a good idea."
25948 #: ../fuse/guestmount.pod:169
25951 " guestmount --fuse-help\n"
25956 #: ../fuse/guestmount.pod:171
25957 msgid "Some potentially useful FUSE options:"
25961 #: ../fuse/guestmount.pod:175
25962 msgid "B<-o allow_other>"
25966 #: ../fuse/guestmount.pod:177
25967 msgid "Allow other users to see the filesystem."
25971 #: ../fuse/guestmount.pod:179
25972 msgid "B<-o attr_timeout=N>"
25976 #: ../fuse/guestmount.pod:181
25977 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25981 #: ../fuse/guestmount.pod:183
25982 msgid "B<-o kernel_cache>"
25986 #: ../fuse/guestmount.pod:185
25988 "Allow the kernel to cache files (reduces the number of reads that have to go "
25989 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25990 "afford the extra memory usage."
25994 #: ../fuse/guestmount.pod:189
25995 msgid "B<-o uid=N> B<-o gid=N>"
25999 #: ../fuse/guestmount.pod:191
26001 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
26002 "the chosen values."
26006 #: ../fuse/guestmount.pod:198
26008 "Add devices and mount everything read-only. Also disallow writes and make "
26009 "the disk appear read-only to FUSE."
26013 #: ../fuse/guestmount.pod:201
26015 "This is highly recommended if you are not going to edit the guest disk. If "
26016 "the guest is running and this option is I<not> supplied, then there is a "
26017 "strong risk of disk corruption in the guest. We try to prevent this from "
26018 "happening, but it is not always possible."
26022 #: ../fuse/guestmount.pod:206
26023 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
26027 #: ../fuse/guestmount.pod:210
26028 msgid "Enable SELinux support for the guest."
26032 #: ../fuse/guestmount.pod:214
26033 msgid "Enable verbose messages from underlying libguestfs."
26037 #: ../fuse/guestmount.pod:218
26038 msgid "Display the program version and exit."
26042 #: ../fuse/guestmount.pod:222
26044 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
26045 "FOR READ AND WRITE>."
26049 #: ../fuse/guestmount.pod:225
26050 msgid "B<-x> | B<--trace>"
26054 #: ../fuse/guestmount.pod:227
26055 msgid "Trace libguestfs calls."
26059 #: ../fuse/guestmount.pod:229
26060 msgid "This also stops the daemon from forking into the background."
26064 #: ../fuse/guestmount.pod:235
26066 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
26067 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
26072 #: ../tools/virt-edit.pl:34
26073 msgid "virt-edit - Edit a file in a virtual machine"
26077 #: ../tools/virt-edit.pl:38
26080 " virt-edit [--options] domname file\n"
26085 #: ../tools/virt-edit.pl:40
26088 " virt-edit [--options] disk.img [disk.img ...] file\n"
26093 #: ../tools/virt-edit.pl:42
26096 " virt-edit [domname|disk.img] file -e 'expr'\n"
26101 #: ../tools/virt-edit.pl:46
26103 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
26104 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
26105 "doing this, but doesn't catch all cases."
26109 #: ../tools/virt-edit.pl:52
26111 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
26112 "the named virtual machine (or disk image)."
26116 #: ../tools/virt-edit.pl:55
26118 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
26119 "you should look at the L<guestfish(1)> tool."
26123 #: ../tools/virt-edit.pl:60
26124 msgid "Edit the named files interactively:"
26128 #: ../tools/virt-edit.pl:62
26131 " virt-edit mydomain /boot/grub/grub.conf\n"
26136 #: ../tools/virt-edit.pl:64
26139 " virt-edit mydomain /etc/passwd\n"
26144 #: ../tools/virt-edit.pl:66
26146 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
26147 "below). To change the init default level to 5:"
26151 #: ../tools/virt-edit.pl:70
26154 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
26159 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181
26160 #: ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108
26161 #: ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
26162 msgid "Display brief help."
26166 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187
26167 #: ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69
26168 #: ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169
26169 #: ../tools/virt-list-partitions.pl:70
26170 msgid "B<--version>"
26174 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189
26175 #: ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71
26176 #: ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171
26177 #: ../tools/virt-list-partitions.pl:72
26178 msgid "Display version number and exit."
26182 #: ../tools/virt-edit.pl:96
26183 msgid "B<--backup extension> | B<-b extension>"
26187 #: ../tools/virt-edit.pl:98
26189 "Create a backup of the original file I<in the guest disk image>. The backup "
26190 "has the original filename with C<extension> added."
26194 #: ../tools/virt-edit.pl:101
26196 "Usually the first character of C<extension> would be a dot C<.> so you would "
26201 #: ../tools/virt-edit.pl:104
26204 " virt-edit -b .orig [etc]\n"
26209 #: ../tools/virt-edit.pl:106
26210 msgid "By default, no backup file is made."
26214 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203
26215 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122
26216 #: ../tools/virt-list-partitions.pl:78
26217 msgid "B<--connect URI> | B<-c URI>"
26221 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205
26222 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124
26223 #: ../tools/virt-list-partitions.pl:80
26225 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
26226 "to the default libvirt hypervisor."
26230 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208
26231 #: ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127
26232 #: ../tools/virt-list-partitions.pl:83
26234 "If you specify guest block devices directly, then libvirt is not used at all."
26238 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215
26239 #: ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89
26240 #: ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
26241 msgid "B<--format> raw"
26245 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217
26246 #: ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136
26247 #: ../tools/virt-list-partitions.pl:92
26249 "Specify the format of disk images given on the command line. If this is "
26250 "omitted then the format is autodetected from the content of the disk image."
26254 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221
26255 #: ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140
26256 #: ../tools/virt-list-partitions.pl:96
26258 "If disk images are requested from libvirt, then this program asks libvirt "
26259 "for this information. In this case, the value of the format parameter is "
26264 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225
26265 #: ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540
26266 #: ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144
26267 #: ../tools/virt-list-partitions.pl:100
26269 "If working with untrusted raw-format guest disk images, you should ensure "
26270 "the format is always specified."
26274 #: ../tools/virt-edit.pl:141
26275 msgid "B<--expr EXPR> | B<-e EXPR>"
26279 #: ../tools/virt-edit.pl:143
26281 "Instead of launching the external editor, non-interactively apply the Perl "
26282 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26287 #: ../tools/virt-edit.pl:147
26289 "Be careful to properly quote the expression to prevent it from being altered "
26294 #: ../tools/virt-edit.pl:268
26295 msgid "NON-INTERACTIVE EDITING"
26299 #: ../tools/virt-edit.pl:270
26301 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26302 "administrator can interactively edit the file."
26306 #: ../tools/virt-edit.pl:273
26308 "There are two ways also to use C<virt-edit> from scripts in order to make "
26309 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26310 "like this, it's less error-prone to write scripts directly using the "
26311 "libguestfs API and Augeas for configuration file editing.)"
26315 #: ../tools/virt-edit.pl:279
26317 "The first method is to temporarily set C<$EDITOR> to any script or program "
26318 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26319 "update C<tmpfile> in place however it likes."
26323 #: ../tools/virt-edit.pl:283
26325 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26326 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26327 "instances of C<foo> with C<bar> in a file:"
26331 #: ../tools/virt-edit.pl:287
26334 " virt-edit domname filename -e 's/foo/bar/'\n"
26339 #: ../tools/virt-edit.pl:289
26341 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26342 "For example to delete root's password you could do:"
26346 #: ../tools/virt-edit.pl:292
26349 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26354 #: ../tools/virt-edit.pl:294
26356 "What really happens is that the snippet is evaluated as a Perl expression "
26357 "for each line of the file. The line, including the final C<\\n>, is passed "
26358 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26362 #: ../tools/virt-edit.pl:299
26364 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26365 "C<apache> user account from the password file you can do:"
26369 #: ../tools/virt-edit.pl:302
26372 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26377 #: ../tools/virt-edit.pl:304
26379 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26380 "the end of the file is rather difficult this way since there is no concept "
26381 "of \"last line of the file\" - your expression just doesn't get called "
26382 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26387 #: ../tools/virt-edit.pl:310
26389 "The variable C<$lineno> contains the current line number. As is "
26390 "traditional, the first line in the file is number C<1>."
26394 #: ../tools/virt-edit.pl:313
26396 "The return value from the expression is ignored, but the expression may call "
26397 "C<die> in order to abort the whole program, leaving the original file "
26402 #: ../tools/virt-edit.pl:317
26404 "Remember when matching the end of a line that C<$_> may contain the final C<"
26405 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26406 "newline then neither of these. Thus to match or substitute some text at the "
26407 "end of a line, use this regular expression:"
26411 #: ../tools/virt-edit.pl:322
26414 " /some text(\\r?\\n)?$/\n"
26419 #: ../tools/virt-edit.pl:324
26421 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
26422 "$_> itself (since that would remove all newlines from the file):"
26426 #: ../tools/virt-edit.pl:328
26429 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26434 #: ../tools/virt-edit.pl:334
26439 #: ../tools/virt-edit.pl:336
26441 "If set, this string is used as the editor. It may contain arguments, eg. C<"
26446 #: ../tools/virt-edit.pl:339
26447 msgid "If not set, C<vi> is used."
26451 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141
26452 #: ../tools/virt-win-reg.pl:477 ../tools/virt-resize.pl:1476
26453 #: ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274
26454 #: ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26455 msgid "SHELL QUOTING"
26459 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479
26460 #: ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184
26461 #: ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:529
26462 #: ../tools/virt-list-partitions.pl:252
26464 "Libvirt guest names can contain arbitrary characters, some of which have "
26465 "meaning to the shell such as C<#> and space. You may need to quote or "
26466 "escape these characters on the command line. See the shell manual page L<sh"
26467 "(1)> for details."
26471 #: ../tools/virt-edit.pl:352
26473 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::"
26474 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, "
26479 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510
26480 #: ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202
26481 #: ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:559
26482 #: ../tools/virt-list-partitions.pl:269
26487 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512
26488 #: ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204
26489 #: ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:561
26490 #: ../tools/virt-list-partitions.pl:271
26491 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26495 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
26496 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26500 #: ../tools/virt-win-reg.pl:37
26502 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
26506 #: ../tools/virt-win-reg.pl:41
26509 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26514 #: ../tools/virt-win-reg.pl:43
26517 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26522 #: ../tools/virt-win-reg.pl:45
26525 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26530 #: ../tools/virt-win-reg.pl:47
26533 " virt-win-reg --merge domname [input.reg ...]\n"
26538 #: ../tools/virt-win-reg.pl:49
26541 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26546 #: ../tools/virt-win-reg.pl:53
26548 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26549 "virtual machines. If you do this, you I<will> get irreversible disk "
26550 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26551 "but doesn't catch all cases."
26555 #: ../tools/virt-win-reg.pl:58
26557 "Modifying the Windows Registry is an inherently risky operation. The format "
26558 "is deliberately obscure and undocumented, and Registry changes can leave the "
26559 "system unbootable. Therefore when using the C<--merge> option, make sure "
26560 "you have a reliable backup first."
26564 #: ../tools/virt-win-reg.pl:65
26566 "This program can export and merge Windows Registry entries from a Windows "
26571 #: ../tools/virt-win-reg.pl:68
26573 "The first parameter is the libvirt guest name or the raw disk image of a "
26578 #: ../tools/virt-win-reg.pl:71
26580 "If C<--merge> is I<not> specified, then the chosen registry key is displayed/"
26581 "exported (recursively). For example:"
26585 #: ../tools/virt-win-reg.pl:74
26588 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26593 #: ../tools/virt-win-reg.pl:76
26595 "You can also display single values from within registry keys, for example:"
26599 #: ../tools/virt-win-reg.pl:79
26602 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26603 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26604 " Windows 7 Enterprise\n"
26609 #: ../tools/virt-win-reg.pl:83
26611 "With C<--merge>, you can merge a textual regedit file into the Windows "
26616 #: ../tools/virt-win-reg.pl:86
26619 " $ virt-win-reg --merge Windows7 changes.reg\n"
26624 #: ../tools/virt-win-reg.pl:88
26625 msgid "SUPPORTED SYSTEMS"
26629 #: ../tools/virt-win-reg.pl:90
26631 "The program currently supports Windows NT-derived guests starting with "
26632 "Windows XP through to at least Windows 7."
26636 #: ../tools/virt-win-reg.pl:93
26638 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, C<HKEY_LOCAL_MACHINE"
26639 "\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, C<HKEY_LOCAL_MACHINE\\SYSTEM> "
26640 "and C<HKEY_USERS\\.DEFAULT>."
26644 #: ../tools/virt-win-reg.pl:97
26646 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26651 #: ../tools/virt-win-reg.pl:100
26653 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26658 #: ../tools/virt-win-reg.pl:103
26663 #: ../tools/virt-win-reg.pl:105
26665 "This program is only meant for simple access to the registry. If you want "
26666 "to do complicated things with the registry, we suggest you download the "
26667 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26668 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26669 "L<hivexregedit(1)>."
26673 #: ../tools/virt-win-reg.pl:111
26678 #: ../tools/virt-win-reg.pl:113
26680 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26681 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
26682 "style line endings. Since Windows regedit files are often in UTF-16LE with "
26683 "Windows-style line endings, you may need to reencode the whole file before "
26684 "or after processing."
26688 #: ../tools/virt-win-reg.pl:119
26690 "To reencode a file from Windows format to Linux (before processing it with "
26691 "the C<--merge> option), you would do something like this:"
26695 #: ../tools/virt-win-reg.pl:122
26698 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26703 #: ../tools/virt-win-reg.pl:124
26705 "To go in the opposite direction, after exporting and before sending the file "
26706 "to a Windows user, do something like this:"
26710 #: ../tools/virt-win-reg.pl:127
26713 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26718 #: ../tools/virt-win-reg.pl:129
26719 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26723 #: ../tools/virt-win-reg.pl:131
26725 "If you are unsure about the current encoding, use the L<file(1)> command. "
26726 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
26727 "style (CRLF) line endings, like this:"
26731 #: ../tools/virt-win-reg.pl:135
26734 " $ file software.reg\n"
26735 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26736 " with CRLF line terminators\n"
26741 #: ../tools/virt-win-reg.pl:139
26742 msgid "This file would need conversion before you could C<--merge> it."
26746 #: ../tools/virt-win-reg.pl:143
26748 "Be careful when passing parameters containing C<\\> (backslash) in the "
26749 "shell. Usually you will have to use 'single quotes' or double backslashes "
26750 "(but not both) to protect them from the shell."
26754 #: ../tools/virt-win-reg.pl:147
26755 msgid "Paths and value names are case-insensitive."
26759 #: ../tools/virt-win-reg.pl:149
26760 msgid "CurrentControlSet etc."
26764 #: ../tools/virt-win-reg.pl:151
26766 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26767 "Registry at the level of the hive file, and therefore you cannot modify "
26772 #: ../tools/virt-win-reg.pl:155
26774 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26775 "circumstances it might refer to another control set. The way to find out is "
26776 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26780 #: ../tools/virt-win-reg.pl:159
26783 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26784 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26785 " \"Current\"=dword:00000001\n"
26786 " \"Default\"=dword:00000001\n"
26787 " \"Failed\"=dword:00000000\n"
26788 " \"LastKnownGood\"=dword:00000002\n"
26793 #: ../tools/virt-win-reg.pl:166
26794 msgid "\"Current\" is the one which Windows will choose when it boots."
26798 #: ../tools/virt-win-reg.pl:168
26800 "Similarly, other C<Current...> keys in the path may need to be replaced."
26804 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26809 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:498
26810 msgid "Enable debugging messages."
26814 #: ../tools/virt-win-reg.pl:232
26819 #: ../tools/virt-win-reg.pl:234
26821 "In merge mode, this merges a textual regedit file into the Windows Registry "
26822 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26823 "displays or exports Registry entries instead."
26827 #: ../tools/virt-win-reg.pl:238
26829 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26830 "result in disk corruption. However exporting (without this flag) is always "
26835 #: ../tools/virt-win-reg.pl:246
26836 msgid "B<--encoding> UTF-16LE|ASCII"
26840 #: ../tools/virt-win-reg.pl:248
26842 "When merging (only), you may need to specify the encoding for strings to be "
26843 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
26844 "(3)/ENCODING STRINGS>."
26848 #: ../tools/virt-win-reg.pl:252
26850 "The default is to use UTF-16LE, which should work with recent versions of "
26855 #: ../tools/virt-win-reg.pl:486
26857 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
26858 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
26859 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26863 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26865 "When reporting bugs, please enable debugging and capture the I<complete> "
26870 #: ../tools/virt-win-reg.pl:504
26873 " export LIBGUESTFS_DEBUG=1\n"
26874 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26879 #: ../tools/virt-win-reg.pl:507
26881 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."
26886 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1510
26887 #: ../tools/virt-make-fs.pl:565
26888 msgid "Copyright (C) 2010 Red Hat Inc."
26892 #: ../tools/virt-resize.pl:42
26893 msgid "virt-resize - Resize a virtual machine disk"
26897 #: ../tools/virt-resize.pl:46
26900 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26901 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26902 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26907 #: ../tools/virt-resize.pl:52
26909 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26910 "larger or smaller overall, and resizing or deleting any partitions contained "
26915 #: ../tools/virt-resize.pl:56
26917 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26918 "not> be used on live virtual machines - for consistent results, shut the "
26919 "virtual machine down before resizing it."
26923 #: ../tools/virt-resize.pl:60
26925 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26926 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26930 #: ../tools/virt-resize.pl:66
26932 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26933 "fill the extra 5GB of space."
26937 #: ../tools/virt-resize.pl:69
26940 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26941 " virt-filesystems --long --h --all -a olddisk\n"
26942 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26943 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26948 #: ../tools/virt-resize.pl:74
26950 "As above, but make the /boot partition 200MB bigger, while giving the "
26951 "remaining space to /dev/sda2:"
26955 #: ../tools/virt-resize.pl:77
26958 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26963 #: ../tools/virt-resize.pl:79
26964 msgid "As above, but the output format will be uncompressed qcow2:"
26968 #: ../tools/virt-resize.pl:81
26971 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26972 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26977 #: ../tools/virt-resize.pl:84
26978 msgid "DETAILED USAGE"
26982 #: ../tools/virt-resize.pl:86
26983 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26987 #: ../tools/virt-resize.pl:90
26988 msgid "1. Shut down the virtual machine"
26992 #: ../tools/virt-resize.pl:92
26993 msgid "2. Locate input disk image"
26997 #: ../tools/virt-resize.pl:94
26999 "Locate the input disk image (ie. the file or device on the host containing "
27000 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27001 "dumpxml> like this to find the disk image name:"
27005 #: ../tools/virt-resize.pl:98
27008 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27009 " Found 1 nodes:\n"
27011 " <source dev=\"/dev/vg/lv_guest\" />\n"
27016 #: ../tools/virt-resize.pl:103
27017 msgid "3. Look at current sizing"
27021 #: ../tools/virt-resize.pl:105
27022 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
27026 #: ../tools/virt-resize.pl:108
27029 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
27030 " Name Type Size Parent\n"
27031 " /dev/sda1 partition 101M /dev/sda\n"
27032 " /dev/sda2 partition 7.9G /dev/sda\n"
27033 " /dev/sda device 8.0G -\n"
27038 #: ../tools/virt-resize.pl:114
27040 "(This example is a virtual machine with an 8 GB disk which we would like to "
27041 "expand up to 10 GB)."
27045 #: ../tools/virt-resize.pl:117
27046 msgid "4. Create output disk"
27050 #: ../tools/virt-resize.pl:119
27052 "Virt-resize cannot do in-place disk modifications. You have to have space "
27053 "to store the resized output disk."
27057 #: ../tools/virt-resize.pl:122
27059 "To store the resized disk image in a file, create a file of a suitable size:"
27063 #: ../tools/virt-resize.pl:125
27066 " # rm -f outdisk\n"
27067 " # truncate -s 10G outdisk\n"
27072 #: ../tools/virt-resize.pl:128
27073 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27077 #: ../tools/virt-resize.pl:130
27080 " # lvcreate -L 10G -n lv_name vg_name\n"
27085 #: ../tools/virt-resize.pl:132
27086 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27090 #: ../tools/virt-resize.pl:134
27093 " # virsh pool-list\n"
27094 " # virsh vol-create-as poolname newvol 10G\n"
27099 #: ../tools/virt-resize.pl:137
27104 #: ../tools/virt-resize.pl:139
27106 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27107 "file) and the output disk. The output disk is the one created in the "
27112 #: ../tools/virt-resize.pl:143
27115 " # virt-resize indisk outdisk\n"
27120 #: ../tools/virt-resize.pl:145
27122 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27123 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27124 "larger, then an extra, empty partition is created at the end of the disk "
27125 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27130 #: ../tools/virt-resize.pl:151
27132 "More realistically you'd want to expand existing partitions in the disk "
27133 "image by passing extra options (for the full list see the L</OPTIONS> "
27138 #: ../tools/virt-resize.pl:155
27140 "L</--expand> is the most useful option. It expands the named partition "
27141 "within the disk to fill any extra space:"
27145 #: ../tools/virt-resize.pl:158
27148 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27153 #: ../tools/virt-resize.pl:160
27155 "(In this case, an extra partition is I<not> created at the end of the disk, "
27156 "because there will be no unused space)."
27160 #: ../tools/virt-resize.pl:163
27162 "L</--resize> is the other commonly used option. The following would "
27163 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27164 "rest of the available space:"
27168 #: ../tools/virt-resize.pl:167
27171 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27172 " indisk outdisk\n"
27177 #: ../tools/virt-resize.pl:170
27179 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27180 "if virt-resize knows how, it will resize the contents, the equivalent of "
27181 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or L<ntfsresize(8)"
27182 ">. However virt-resize does not know how to resize some filesystems, so you "
27183 "would have to online resize them after booting the guest."
27187 #: ../tools/virt-resize.pl:177
27188 msgid "Other options are covered below."
27192 #: ../tools/virt-resize.pl:179
27197 #: ../tools/virt-resize.pl:181
27198 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27202 #: ../tools/virt-resize.pl:183
27203 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27207 #: ../tools/virt-resize.pl:185
27210 " # virsh edit guestname\n"
27215 #: ../tools/virt-resize.pl:187
27217 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
27218 "html#elementsDisks>"
27222 #: ../tools/virt-resize.pl:190
27223 msgid "Then start up the domain with the new, resized disk:"
27227 #: ../tools/virt-resize.pl:192
27230 " # virsh start guestname\n"
27235 #: ../tools/virt-resize.pl:194
27237 "and check that it still works. See also the L</NOTES> section below for "
27238 "additional information."
27242 #: ../tools/virt-resize.pl:197
27243 msgid "7. Resize LVs etc inside the guest"
27247 #: ../tools/virt-resize.pl:199
27248 msgid "(This can also be done offline using L<guestfish(1)>)"
27252 #: ../tools/virt-resize.pl:201
27254 "Once the guest has booted you should see the new space available, at least "
27255 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27256 "may need to resize LVs inside PVs, and also resize filesystem types that "
27257 "virt-resize does not know how to expand."
27261 #: ../tools/virt-resize.pl:208
27262 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27266 #: ../tools/virt-resize.pl:210
27268 "Shrinking is somewhat more complex than expanding, and only an overview is "
27273 #: ../tools/virt-resize.pl:213
27275 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27276 "filesystems). The user has to shrink content before passing the disk image "
27277 "to virt-resize, and virt-resize will check that the content has been shrunk "
27282 #: ../tools/virt-resize.pl:218
27283 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27287 #: ../tools/virt-resize.pl:220
27289 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27290 "steps 3 and 4 above to allocate a new disk image."
27294 #: ../tools/virt-resize.pl:223
27296 "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27300 #: ../tools/virt-resize.pl:226
27301 msgid "IGNORING OR DELETING PARTITIONS"
27305 #: ../tools/virt-resize.pl:228
27307 "virt-resize also gives a convenient way to ignore or delete partitions when "
27308 "copying from the input disk to the output disk. Ignoring a partition speeds "
27309 "up the copy where you don't care about the existing contents of a "
27310 "partition. Deleting a partition removes it completely, but note that it "
27311 "also renumbers any partitions after the one which is deleted, which can "
27312 "leave some guests unbootable."
27316 #: ../tools/virt-resize.pl:235
27317 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27321 #: ../tools/virt-resize.pl:237
27323 "If the input disk is in qcow2 format, then you may prefer that the output is "
27324 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27325 "the fly. The output format is simply determined by the format of the empty "
27326 "output container that you provide. Thus to create qcow2 output, use:"
27330 #: ../tools/virt-resize.pl:243
27333 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27338 #: ../tools/virt-resize.pl:245
27339 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27343 #: ../tools/virt-resize.pl:247
27344 msgid "Similarly, to get non-sparse raw output use:"
27348 #: ../tools/virt-resize.pl:249
27351 " fallocate -l size outdisk\n"
27356 #: ../tools/virt-resize.pl:251
27358 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
27359 "dev/zero of=outdisk bs=1M count=..>)"
27363 #: ../tools/virt-resize.pl:264
27364 msgid "Display help."
27368 #: ../tools/virt-resize.pl:278
27369 msgid "B<--resize part=size>"
27373 #: ../tools/virt-resize.pl:280
27375 "Resize the named partition (expanding or shrinking it) so that it has the "
27380 #: ../tools/virt-resize.pl:283
27382 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27383 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27384 "Exabytes; or as a percentage of the current size; or as a relative number or "
27385 "percentage. For example:"
27389 #: ../tools/virt-resize.pl:288
27392 " --resize /dev/sda2=10G\n"
27397 #: ../tools/virt-resize.pl:290
27400 " --resize /dev/sda4=90%\n"
27405 #: ../tools/virt-resize.pl:292
27408 " --resize /dev/sda2=+1G\n"
27413 #: ../tools/virt-resize.pl:294
27416 " --resize /dev/sda2=-200M\n"
27421 #: ../tools/virt-resize.pl:296
27424 " --resize /dev/sda1=+128K\n"
27429 #: ../tools/virt-resize.pl:298
27432 " --resize /dev/sda1=+10%\n"
27437 #: ../tools/virt-resize.pl:300
27440 " --resize /dev/sda1=-10%\n"
27445 #: ../tools/virt-resize.pl:302
27447 "You can increase the size of any partition. Virt-resize will expand the "
27448 "direct content of the partition if it knows how (see C<--expand> below)."
27452 #: ../tools/virt-resize.pl:306
27454 "You can only I<decrease> the size of partitions that contain filesystems or "
27455 "PVs which have already been shrunk. Virt-resize will check this has been "
27456 "done before proceeding, or else will print an error (see also C<--resize-"
27461 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403
27462 #: ../tools/virt-resize.pl:420
27463 msgid "You can give this option multiple times."
27467 #: ../tools/virt-resize.pl:317
27468 msgid "B<--resize-force part=size>"
27472 #: ../tools/virt-resize.pl:319
27474 "This is the same as C<--resize> except that it will let you decrease the "
27475 "size of any partition. Generally this means you will lose any data which "
27476 "was at the end of the partition you shrink, but you may not care about that "
27477 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27478 "as a swap partition)."
27482 #: ../tools/virt-resize.pl:325
27483 msgid "See also the C<--ignore> option."
27487 #: ../tools/virt-resize.pl:331
27488 msgid "B<--expand part>"
27492 #: ../tools/virt-resize.pl:333
27494 "Expand the named partition so it uses up all extra space (space left over "
27495 "after any other resize changes that you request have been done)."
27499 #: ../tools/virt-resize.pl:336
27501 "If virt-resize knows how, it will expand the direct content of the "
27502 "partition. For example, if the partition is an LVM PV, it will expand the "
27503 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27504 "content it doesn't know about alone."
27508 #: ../tools/virt-resize.pl:341
27509 msgid "Currently virt-resize can resize:"
27513 #: ../tools/virt-resize.pl:347
27515 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27520 #: ../tools/virt-resize.pl:352
27522 "NTFS filesystems contained directly in a partition, if libguestfs was "
27523 "compiled with support for NTFS."
27527 #: ../tools/virt-resize.pl:355
27529 "The filesystem must have been shut down consistently last time it was used. "
27530 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27531 "consistency check, so at the first boot after resizing Windows will check "
27536 #: ../tools/virt-resize.pl:362
27538 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
27539 "inside the PV, but see the C<--LV-expand> option. The user could also "
27540 "resize LVs as desired after boot."
27544 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
27545 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27549 #: ../tools/virt-resize.pl:374
27550 msgid "B<--shrink part>"
27554 #: ../tools/virt-resize.pl:376
27556 "Shrink the named partition until the overall disk image fits in the "
27557 "destination. The named partition B<must> contain a filesystem or PV which "
27558 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27559 "online tools). Virt-resize will check this and give an error if it has not "
27564 #: ../tools/virt-resize.pl:382
27566 "The amount by which the overall disk must be shrunk (after carrying out all "
27567 "other operations requested by the user) is called the \"deficit\". For "
27568 "example, a straight copy (assume no other operations) from a 5GB disk image "
27569 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27570 "would give an error unless the user specified a partition to shrink and that "
27571 "partition had more than a gigabyte of free space."
27575 #: ../tools/virt-resize.pl:396
27576 msgid "B<--ignore part>"
27580 #: ../tools/virt-resize.pl:398
27582 "Ignore the named partition. Effectively this means the partition is "
27583 "allocated on the destination disk, but the content is not copied across from "
27584 "the source disk. The content of the partition will be blank (all zero "
27589 #: ../tools/virt-resize.pl:409
27590 msgid "B<--delete part>"
27594 #: ../tools/virt-resize.pl:411
27596 "Delete the named partition. It would be more accurate to describe this as "
27597 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27598 "the original disk image is left intact."
27602 #: ../tools/virt-resize.pl:415
27604 "Note that when you delete a partition, then anything contained in the "
27605 "partition is also deleted. Furthermore, this causes any partitions that "
27606 "come after to be I<renumbered>, which can easily make your guest unbootable."
27610 #: ../tools/virt-resize.pl:426
27611 msgid "B<--LV-expand logvol>"
27615 #: ../tools/virt-resize.pl:428
27617 "This takes the logical volume and, as a final step, expands it to fill all "
27618 "the space available in its volume group. A typical usage, assuming a Linux "
27619 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
27620 "lv_root> would be:"
27624 #: ../tools/virt-resize.pl:433
27627 " virt-resize indisk outdisk \\\n"
27628 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27633 #: ../tools/virt-resize.pl:436
27635 "This would first expand the partition (and PV), and then expand the root "
27636 "device to fill the extra space in the PV."
27640 #: ../tools/virt-resize.pl:439
27642 "The contents of the LV are also resized if virt-resize knows how to do "
27643 "that. You can stop virt-resize from trying to expand the content by using "
27644 "the option C<--no-expand-content>."
27648 #: ../tools/virt-resize.pl:443
27649 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27653 #: ../tools/virt-resize.pl:446
27655 "You can give this option multiple times, I<but> it doesn't make sense to do "
27656 "this unless the logical volumes you specify are all in different volume "
27661 #: ../tools/virt-resize.pl:454
27662 msgid "B<--no-copy-boot-loader>"
27666 #: ../tools/virt-resize.pl:456
27668 "By default, virt-resize copies over some sectors at the start of the disk "
27669 "(up to the beginning of the first partition). Commonly these sectors "
27670 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27671 "in order for the guest to boot correctly."
27675 #: ../tools/virt-resize.pl:461
27677 "If you specify this flag, then this initial copy is not done. You may need "
27678 "to reinstall the boot loader in this case."
27682 #: ../tools/virt-resize.pl:469
27683 msgid "B<--no-extra-partition>"
27687 #: ../tools/virt-resize.pl:471
27689 "By default, virt-resize creates an extra partition if there is any extra, "
27690 "unused space after all resizing has happened. Use this option to prevent "
27691 "the extra partition from being created. If you do this then the extra space "
27692 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27693 "tool in the guest."
27697 #: ../tools/virt-resize.pl:477
27699 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27704 #: ../tools/virt-resize.pl:484
27705 msgid "B<--no-expand-content>"
27709 #: ../tools/virt-resize.pl:486
27711 "By default, virt-resize will try to expand the direct contents of "
27712 "partitions, if it knows how (see C<--expand> option above)."
27716 #: ../tools/virt-resize.pl:489
27718 "If you give the C<--no-expand-content> option then virt-resize will not "
27723 #: ../tools/virt-resize.pl:496
27724 msgid "B<-d> | B<--debug>"
27728 #: ../tools/virt-resize.pl:504
27729 msgid "B<-n> | B<--dryrun>"
27733 #: ../tools/virt-resize.pl:506
27734 msgid "Print a summary of what would be done, but don't do anything."
27738 #: ../tools/virt-resize.pl:512
27739 msgid "B<-q> | B<--quiet>"
27743 #: ../tools/virt-resize.pl:514
27744 msgid "Don't print the summary."
27748 #: ../tools/virt-resize.pl:522
27750 "Specify the format of the input disk image. If this flag is not given then "
27751 "it is auto-detected from the image itself."
27755 #: ../tools/virt-resize.pl:528
27757 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27758 "AND NON-SPARSE RAW FORMATS>."
27762 #: ../tools/virt-resize.pl:535
27763 msgid "B<--output-format> raw"
27767 #: ../tools/virt-resize.pl:537
27769 "Specify the format of the output disk image. If this flag is not given then "
27770 "it is auto-detected from the image itself."
27774 #: ../tools/virt-resize.pl:543
27776 "Note that you still need to create the output disk with the right format. "
27777 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27781 #: ../tools/virt-resize.pl:1419
27786 #: ../tools/virt-resize.pl:1421
27787 msgid "\"Partition 1 does not end on cylinder boundary.\""
27791 #: ../tools/virt-resize.pl:1423
27793 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27794 "means the partitions will not be aligned to the ancient CHS geometry. "
27795 "However CHS geometry is meaningless for disks manufactured since the early "
27796 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27797 "cylinders is not required by any modern operating system."
27801 #: ../tools/virt-resize.pl:1430
27802 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27806 #: ../tools/virt-resize.pl:1432
27808 "In Windows Vista and later versions, Microsoft switched to using a separate "
27809 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27810 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27811 "the boot partition. Doing so seems to break the guest completely. However "
27812 "expanding the second partition (ie. C: drive) should work."
27816 #: ../tools/virt-resize.pl:1439
27818 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27819 "NTFS partitions have been expanded. This is just a safety check and (unless "
27820 "it find errors) is nothing to worry about."
27824 #: ../tools/virt-resize.pl:1443
27825 msgid "GUEST BOOT STUCK AT \"GRUB\""
27829 #: ../tools/virt-resize.pl:1445
27831 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27832 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27833 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27834 "although we think is to do with partition alignment."
27838 #: ../tools/virt-resize.pl:1450
27841 " guestfish -i -a newdisk\n"
27842 " ><fs> cat /boot/grub/device.map\n"
27843 " # check the contents of this file are sensible or\n"
27844 " # edit the file if necessary\n"
27845 " ><fs> grub-install / /dev/vda\n"
27851 #: ../tools/virt-resize.pl:1457
27853 "For more flexible guest reconfiguration, including if you need to specify "
27854 "other parameters to grub-install, use L<virt-rescue(1)>."
27858 #: ../tools/virt-resize.pl:1460
27859 msgid "ALTERNATIVE TOOLS"
27863 #: ../tools/virt-resize.pl:1462
27865 "There are several proprietary tools for resizing partitions. We won't "
27866 "mention any here."
27870 #: ../tools/virt-resize.pl:1465
27872 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27873 "operations on disk images. They can resize and move partitions, but I don't "
27874 "think they can do anything with the contents, and they certainly don't "
27879 #: ../tools/virt-resize.pl:1470
27881 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27882 "but at a much lower level. You will probably end up hand-calculating sector "
27883 "offsets, which is something that virt-resize was designed to avoid. If you "
27884 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27889 #: ../tools/virt-resize.pl:1485
27891 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
27892 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
27893 "L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, "
27894 "L<grub-install(8)>, L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://"
27895 "libguestfs.org/>."
27899 #: ../tools/virt-list-filesystems.pl:32
27901 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27905 #: ../tools/virt-list-filesystems.pl:36
27908 " virt-list-filesystems [--options] domname\n"
27913 #: ../tools/virt-list-filesystems.pl:38
27916 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27921 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27923 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27928 #: ../tools/virt-list-filesystems.pl:45
27930 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27931 "are contained in a virtual machine or disk image."
27935 #: ../tools/virt-list-filesystems.pl:49
27937 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27938 "functionality. For more complex cases you should look at the L<guestfish(1)"
27943 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27944 msgid "B<-l> | B<--long>"
27948 #: ../tools/virt-list-filesystems.pl:108
27950 "With this option, C<virt-list-filesystems> displays the type of each "
27951 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27955 #: ../tools/virt-list-filesystems.pl:115
27956 msgid "B<-a> | B<--all>"
27960 #: ../tools/virt-list-filesystems.pl:117
27962 "Normally we only show mountable filesystems. If this option is given then "
27963 "swap devices are shown too."
27967 #: ../tools/virt-list-filesystems.pl:191
27969 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
27970 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
27971 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27975 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27976 msgid "Copyright (C) 2009 Red Hat Inc."
27980 #: ../tools/virt-tar.pl:33
27981 msgid "virt-tar - Extract or upload files to a virtual machine"
27985 #: ../tools/virt-tar.pl:37
27988 " virt-tar [--options] -x domname directory tarball\n"
27993 #: ../tools/virt-tar.pl:39
27996 " virt-tar [--options] -u domname tarball directory\n"
28001 #: ../tools/virt-tar.pl:41
28004 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28009 #: ../tools/virt-tar.pl:43
28012 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28017 #: ../tools/virt-tar.pl:47
28018 msgid "Download C</home> from the VM into a local tarball:"
28022 #: ../tools/virt-tar.pl:49
28025 " virt-tar -x domname /home home.tar\n"
28030 #: ../tools/virt-tar.pl:51
28033 " virt-tar -zx domname /home home.tar.gz\n"
28038 #: ../tools/virt-tar.pl:53
28039 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28043 #: ../tools/virt-tar.pl:55
28046 " virt-tar -u domname uploadstuff.tar /tmp\n"
28051 #: ../tools/virt-tar.pl:57
28054 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28059 #: ../tools/virt-tar.pl:61
28061 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28062 "virtual machines. If you do this, you risk disk corruption in the VM. "
28063 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28067 #: ../tools/virt-tar.pl:66
28069 "You can use C<-x> (extract) on live virtual machines, but you might get "
28070 "inconsistent results or errors if there is filesystem activity inside the "
28071 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28072 "work, but the only way to guarantee consistent results is if the virtual "
28073 "machine is shut down."
28077 #: ../tools/virt-tar.pl:74
28079 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28080 "parts of a guest filesystem. There are many possibilities: making backups, "
28081 "uploading data files, snooping on guest activity, fixing or customizing "
28086 #: ../tools/virt-tar.pl:79
28088 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28089 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28090 "should look at the L<guestfish(1)> tool."
28094 #: ../tools/virt-tar.pl:83
28096 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28097 "its contents (recursively) from the virtual machine into a local tarball. "
28098 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28099 "virtual machine. You cannot use these two options together."
28103 #: ../tools/virt-tar.pl:89
28105 "In addition, you may need to use the C<-z> (gZip) option to enable "
28106 "compression. When uploading, you have to specify C<-z> if the upload file "
28107 "is compressed because virt-tar won't detect this on its own."
28111 #: ../tools/virt-tar.pl:93
28113 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28114 "example it cannot do PKZip files or bzip2 compression. If you want that "
28115 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28116 "the L<libguestfs(3)> API)."
28120 #: ../tools/virt-tar.pl:151
28121 msgid "B<-x> | B<--extract> | B<--download>"
28125 #: ../tools/virt-tar.pl:153
28126 msgid "B<-u> | B<--upload>"
28130 #: ../tools/virt-tar.pl:155
28132 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28137 #: ../tools/virt-tar.pl:158
28139 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28140 "Please read the L</WARNING> section above before using this option."
28144 #: ../tools/virt-tar.pl:162
28145 msgid "You must specify exactly one of these options."
28149 #: ../tools/virt-tar.pl:168
28150 msgid "B<-z> | B<--gzip>"
28154 #: ../tools/virt-tar.pl:170
28155 msgid "Specify that the input or output tarball is gzip-compressed."
28159 #: ../tools/virt-tar.pl:283
28161 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<Sys::"
28162 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
28167 #: ../tools/virt-make-fs.pl:37
28168 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28172 #: ../tools/virt-make-fs.pl:41
28175 " virt-make-fs [--options] input.tar output.img\n"
28180 #: ../tools/virt-make-fs.pl:43
28183 " virt-make-fs [--options] input.tar.gz output.img\n"
28188 #: ../tools/virt-make-fs.pl:45
28191 " virt-make-fs [--options] directory output.img\n"
28196 #: ../tools/virt-make-fs.pl:49
28198 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28199 "archive or some files in a directory. It is similar to tools like L<mkisofs"
28200 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
28201 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
28202 "you want to attach these filesystems to existing virtual machines (eg. to "
28203 "import large amounts of read-only data to a VM)."
28207 #: ../tools/virt-make-fs.pl:57
28208 msgid "Basic usage is:"
28212 #: ../tools/virt-make-fs.pl:59
28215 " virt-make-fs input output\n"
28220 #: ../tools/virt-make-fs.pl:61
28222 "where C<input> is either a directory containing files that you want to add, "
28223 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28224 "C<output> is a disk image. The input type is detected automatically. The "
28225 "output disk image defaults to a raw ext2 image unless you specify extra "
28226 "flags (see L</OPTIONS> below)."
28230 #: ../tools/virt-make-fs.pl:67
28231 msgid "EXTRA SPACE"
28235 #: ../tools/virt-make-fs.pl:69
28237 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28238 "the files that it contains, but might have extra space. Depending on how "
28239 "you are going to use the output, you might think this extra space is wasted "
28240 "and want to minimize it, or you might want to leave space so that more files "
28241 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28242 "but you can use the C<--size> flag to leave space in the filesystem if you "
28247 #: ../tools/virt-make-fs.pl:77
28249 "An alternative way to leave extra space but not make the output image any "
28250 "bigger is to use an alternative disk image format (instead of the default "
28251 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28252 "image format (check your hypervisor supports this before using it). This "
28253 "allows you to choose a large C<--size> but the extra space won't actually be "
28254 "allocated in the image until you try to store something in it."
28258 #: ../tools/virt-make-fs.pl:85
28260 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28261 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-"
28262 "resize to build another image from scratch."
28266 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
28267 #: ../tools/virt-make-fs.pl:142
28272 #: ../tools/virt-make-fs.pl:91
28275 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28280 #: ../tools/virt-make-fs.pl:93
28281 msgid "FILESYSTEM TYPE"
28285 #: ../tools/virt-make-fs.pl:95
28287 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28288 "libguestfs supports can be used (but I<not> read-only formats like "
28289 "ISO9660). Here are some of the more common choices:"
28293 #: ../tools/virt-make-fs.pl:101
28298 #: ../tools/virt-make-fs.pl:103
28300 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28301 "you are not going to use the filesystem in a way that requires the journal, "
28302 "then this is just wasted overhead."
28306 #: ../tools/virt-make-fs.pl:107
28307 msgid "I<ntfs> or I<vfat>"
28311 #: ../tools/virt-make-fs.pl:109
28312 msgid "Useful if exporting data to a Windows guest."
28316 #: ../tools/virt-make-fs.pl:111
28318 "I<Note for vfat>: The tar archive or local directory must only contain files "
28319 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28320 "program running within libguestfs is unable to change the ownership of non-"
28321 "root files, since vfat itself does not support this."
28325 #: ../tools/virt-make-fs.pl:116
28330 #: ../tools/virt-make-fs.pl:118
28332 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28333 "total filesystem size."
28337 #: ../tools/virt-make-fs.pl:125
28340 " virt-make-fs --type=minix input minixfs.img\n"
28345 #: ../tools/virt-make-fs.pl:127
28346 msgid "TO PARTITION OR NOT TO PARTITION"
28350 #: ../tools/virt-make-fs.pl:129
28351 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28355 #: ../tools/virt-make-fs.pl:131
28357 "Adding a partition can make the disk image more compatible with certain "
28358 "virtualized operating systems which don't expect to see a filesystem "
28359 "directly located on a block device (Linux doesn't care and will happily "
28360 "handle both types)."
28364 #: ../tools/virt-make-fs.pl:136
28366 "On the other hand, if you have a partition table then the output image is no "
28367 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28368 "directly on a partitioned disk image. (However libguestfs tools such as "
28369 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28373 #: ../tools/virt-make-fs.pl:144
28374 msgid "Add an MBR partition:"
28378 #: ../tools/virt-make-fs.pl:146
28381 " virt-make-fs --partition -- input disk.img\n"
28386 #: ../tools/virt-make-fs.pl:148
28388 "If the output disk image could be terabyte-sized or larger, it's better to "
28389 "use an EFI/GPT-compatible partition table:"
28393 #: ../tools/virt-make-fs.pl:151
28396 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28401 #: ../tools/virt-make-fs.pl:179
28402 msgid "Enable debugging information."
28406 #: ../tools/virt-make-fs.pl:185
28407 msgid "B<--size=E<lt>NE<gt>>"
28411 #: ../tools/virt-make-fs.pl:187
28412 msgid "B<--size=+E<lt>NE<gt>>"
28416 #: ../tools/virt-make-fs.pl:189
28417 msgid "B<-s E<lt>NE<gt>>"
28421 #: ../tools/virt-make-fs.pl:191
28422 msgid "B<-s +E<lt>NE<gt>>"
28426 #: ../tools/virt-make-fs.pl:193
28428 "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28432 #: ../tools/virt-make-fs.pl:196
28434 "If this option is I<not> given, then the output image will be just large "
28435 "enough to contain all the files, with not much wasted space."
28439 #: ../tools/virt-make-fs.pl:199
28441 "To choose a fixed size output disk, specify an absolute number followed by b/"
28442 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28443 "Petabytes or Exabytes. This must be large enough to contain all the input "
28444 "files, else you will get an error."
28448 #: ../tools/virt-make-fs.pl:204
28450 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
28451 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28452 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28453 "the input files, and (approximately) an extra 200 MB free space."
28457 #: ../tools/virt-make-fs.pl:210
28459 "Note that virt-make-fs estimates free space, and therefore will not produce "
28460 "filesystems containing precisely the free space requested. (It is much more "
28461 "expensive and time-consuming to produce a filesystem which has precisely the "
28462 "desired free space)."
28466 #: ../tools/virt-make-fs.pl:219
28467 msgid "B<--format=E<lt>fmtE<gt>>"
28471 #: ../tools/virt-make-fs.pl:221
28472 msgid "B<-F E<lt>fmtE<gt>>"
28476 #: ../tools/virt-make-fs.pl:223
28477 msgid "Choose the output disk image format."
28481 #: ../tools/virt-make-fs.pl:225
28482 msgid "The default is C<raw> (raw disk image)."
28486 #: ../tools/virt-make-fs.pl:227
28488 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28489 "that would really make sense here is C<qcow2>."
28493 #: ../tools/virt-make-fs.pl:234
28494 msgid "B<--type=E<lt>fsE<gt>>"
28498 #: ../tools/virt-make-fs.pl:236
28499 msgid "B<-t E<lt>fsE<gt>>"
28503 #: ../tools/virt-make-fs.pl:238
28504 msgid "Choose the output filesystem type."
28508 #: ../tools/virt-make-fs.pl:240
28509 msgid "The default is C<ext2>."
28513 #: ../tools/virt-make-fs.pl:242
28515 "Any filesystem which is supported read-write by libguestfs can be used here."
28519 #: ../tools/virt-make-fs.pl:249
28520 msgid "B<--partition>"
28524 #: ../tools/virt-make-fs.pl:251
28525 msgid "B<--partition=E<lt>parttypeE<gt>>"
28529 #: ../tools/virt-make-fs.pl:253
28531 "If specified, this flag adds an MBR partition table to the output disk image."
28535 #: ../tools/virt-make-fs.pl:256
28537 "You can change the partition table type, eg. C<--partition=gpt> for large "
28542 #: ../tools/virt-make-fs.pl:259
28544 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28545 "might consider the next parameter to be the partition type. For example:"
28549 #: ../tools/virt-make-fs.pl:263
28552 " virt-make-fs --partition input.tar ...\n"
28557 #: ../tools/virt-make-fs.pl:265
28559 "would cause virt-make-fs to think you wanted to use a partition type of "
28560 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28561 "dash) between options and the input file argument:"
28565 #: ../tools/virt-make-fs.pl:269
28568 " virt-make-fs --partition -- input.tar ...\n"
28573 #: ../tools/virt-make-fs.pl:536
28575 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28576 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
28577 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28581 #: ../tools/virt-make-fs.pl:553
28584 " export LIBGUESTFS_DEBUG=1\n"
28585 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28590 #: ../tools/virt-make-fs.pl:556
28592 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
28597 #: ../tools/virt-list-partitions.pl:32
28599 "virt-list-partitions - List partitions in a virtual machine or disk image"
28603 #: ../tools/virt-list-partitions.pl:36
28606 " virt-list-partitions [--options] domname\n"
28611 #: ../tools/virt-list-partitions.pl:38
28614 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28619 #: ../tools/virt-list-partitions.pl:45
28621 "C<virt-list-partitions> is a command line tool to list the partitions that "
28622 "are contained in a virtual machine or disk image. It is mainly useful as a "
28623 "first step to using L<virt-resize(1)>."
28627 #: ../tools/virt-list-partitions.pl:50
28629 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28630 "functionality. For more complex cases you should look at the L<guestfish(1)"
28635 #: ../tools/virt-list-partitions.pl:107
28636 msgid "B<-h> | B<--human-readable>"
28640 #: ../tools/virt-list-partitions.pl:109
28641 msgid "Show sizes in human-readable form (eg. \"1G\")."
28645 #: ../tools/virt-list-partitions.pl:117
28647 "With this option, C<virt-list-partitions> displays the type and size of each "
28648 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28652 #: ../tools/virt-list-partitions.pl:124
28653 msgid "B<-t> | B<--total>"
28657 #: ../tools/virt-list-partitions.pl:126
28659 "Display the total size of each block device (as a separate row or rows)."
28663 #: ../tools/virt-list-partitions.pl:259
28665 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
28666 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
28667 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."