1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.7.19\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-12-05 10:35+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=utf-8\n"
17 "Content-Transfer-Encoding: ENCODING"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
40 #: ../src/guestfs.pod:9
43 " #include <guestfs.h>\n"
48 #: ../src/guestfs.pod:11
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_sync (g);\n"
58 " guestfs_close (g);\n"
63 #: ../src/guestfs.pod:20
66 " cc prog.c -o prog -lguestfs\n"
68 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
73 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
78 #: ../src/guestfs.pod:26
80 "Libguestfs is a library for accessing and modifying guest disk images. "
81 "Amongst the things this is good for: making batch configuration changes to "
82 "guests, getting disk used/free statistics (see also: virt-df), migrating "
83 "between virtualization systems (see also: virt-p2v), performing partial "
84 "backups, performing partial guest clones, cloning guests and changing "
85 "registry/UUID/hostname info, and much else besides."
89 #: ../src/guestfs.pod:34
91 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
92 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
93 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
98 #: ../src/guestfs.pod:39
100 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
101 "what filesystem is in each LV, etc.). It can also run commands in the "
102 "context of the guest. Also you can access filesystems over FUSE."
106 #: ../src/guestfs.pod:44
108 "Libguestfs is a library that can be linked with C and C++ management "
109 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
110 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
115 #: ../src/guestfs.pod:49
117 "You don't need to be root to use libguestfs, although obviously you do need "
118 "enough permissions to access the disk images."
122 #: ../src/guestfs.pod:52
124 "Libguestfs is a large API because it can do many things. For a gentle "
125 "introduction, please read the L</API OVERVIEW> section next."
129 #: ../src/guestfs.pod:55
131 "There are also some example programs in the L<guestfs-examples(3)> manual "
136 #: ../src/guestfs.pod:58
141 #: ../src/guestfs.pod:60
143 "This section provides a gentler overview of the libguestfs API. We also try "
144 "to group API calls together, where that may not be obvious from reading "
145 "about the individual calls in the main section of this manual."
149 #: ../src/guestfs.pod:65
154 #: ../src/guestfs.pod:67
156 "Before you can use libguestfs calls, you have to create a handle. Then you "
157 "must add at least one disk image to the handle, followed by launching the "
158 "handle, then performing whatever operations you want, and finally closing "
159 "the handle. By convention we use the single letter C<g> for the name of the "
160 "handle variable, although of course you can use any name you want."
164 #: ../src/guestfs.pod:74
165 msgid "The general structure of all libguestfs-using programs looks like this:"
169 #: ../src/guestfs.pod:77
172 " guestfs_h *g = guestfs_create ();\n"
177 #: ../src/guestfs.pod:79
180 " /* Call guestfs_add_drive additional times if there are\n"
181 " * multiple disk images.\n"
183 " guestfs_add_drive (g, \"guest.img\");\n"
188 #: ../src/guestfs.pod:84
191 " /* Most manipulation calls won't work until you've launched\n"
192 " * the handle 'g'. You have to do this _after_ adding drives\n"
193 " * and _before_ other commands.\n"
195 " guestfs_launch (g);\n"
200 #: ../src/guestfs.pod:90
203 " /* Now you can examine what partitions, LVs etc are available.\n"
205 " char **partitions = guestfs_list_partitions (g);\n"
206 " char **logvols = guestfs_lvs (g);\n"
211 #: ../src/guestfs.pod:95
214 " /* To access a filesystem in the image, you must mount it.\n"
216 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
221 #: ../src/guestfs.pod:99
224 " /* Now you can perform filesystem actions on the guest\n"
227 " guestfs_touch (g, \"/hello\");\n"
232 #: ../src/guestfs.pod:104
235 " /* You only need to call guestfs_sync if you have made\n"
236 " * changes to the guest image. (But if you've made changes\n"
237 " * then you *must* sync). See also: guestfs_umount and\n"
238 " * guestfs_umount_all calls.\n"
240 " guestfs_sync (g);\n"
245 #: ../src/guestfs.pod:111
248 " /* Close the handle 'g'. */\n"
249 " guestfs_close (g);\n"
254 #: ../src/guestfs.pod:114
256 "The code above doesn't include any error checking. In real code you should "
257 "check return values carefully for errors. In general all functions that "
258 "return integers return C<-1> on error, and all functions that return "
259 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
260 "how to handle errors, and consult the documentation for each function call "
261 "below to see precisely how they return error indications."
265 #: ../src/guestfs.pod:122
270 #: ../src/guestfs.pod:124
272 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
273 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
274 "actual block device, or simply an empty file of zeroes that you have created "
275 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
280 #: ../src/guestfs.pod:130
282 "The call you should use in modern code for adding drives is "
283 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
284 "specifying that the format is raw, do:"
288 #: ../src/guestfs.pod:134
291 " guestfs_add_drive_opts (g, filename,\n"
292 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
298 #: ../src/guestfs.pod:138
299 msgid "You can add a disk read-only using:"
303 #: ../src/guestfs.pod:140
306 " guestfs_add_drive_opts (g, filename,\n"
307 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
308 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
314 #: ../src/guestfs.pod:145
316 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
317 "libguestfs won't modify the file."
321 #: ../src/guestfs.pod:148
323 "Be extremely cautious if the disk image is in use, eg. if it is being used "
324 "by a virtual machine. Adding it read-write will almost certainly cause disk "
325 "corruption, but adding it read-only is safe."
329 #: ../src/guestfs.pod:152
331 "You must add at least one disk image, and you may add multiple disk images. "
332 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
333 "first one you added), C</dev/sdb> (for the second one you added), etc."
337 #: ../src/guestfs.pod:157
339 "Once L</guestfs_launch> has been called you cannot add any more images. You "
340 "can call L</guestfs_list_devices> to get a list of the device names, in the "
341 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
345 #: ../src/guestfs.pod:162
350 #: ../src/guestfs.pod:164
352 "Before you can read or write files, create directories and so on in a disk "
353 "image that contains filesystems, you have to mount those filesystems using "
354 "L</guestfs_mount>. If you already know that a disk image contains (for "
355 "example) one partition with a filesystem on that partition, then you can "
360 #: ../src/guestfs.pod:170
363 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
368 #: ../src/guestfs.pod:172
370 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
371 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
372 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
376 #: ../src/guestfs.pod:176
378 "If you are given a disk image and you don't know what it contains then you "
379 "have to find out. Libguestfs can do that too: use "
380 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
381 "and LVs, and either try mounting each to see what is mountable, or else "
382 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also "
383 "has a set of APIs for inspection of disk images (see L</INSPECTION> below). "
384 "But you might find it easier to look at higher level programs built on top "
385 "of libguestfs, in particular L<virt-inspector(1)>."
389 #: ../src/guestfs.pod:186
391 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
392 "several other variations of the C<guestfs_mount_*> call."
396 #: ../src/guestfs.pod:189
397 msgid "FILESYSTEM ACCESS AND MODIFICATION"
401 #: ../src/guestfs.pod:191
403 "The majority of the libguestfs API consists of fairly low-level calls for "
404 "accessing and modifying the files, directories, symlinks etc on mounted "
405 "filesystems. There are over a hundred such calls which you can find listed "
406 "in detail below in this man page, and we don't even pretend to cover them "
407 "all in this overview."
411 #: ../src/guestfs.pod:197
413 "Specify filenames as full paths, starting with C<\"/\"> and including the "
418 #: ../src/guestfs.pod:200
420 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
421 "the file called C<\"etc/passwd\"> then you could do:"
425 #: ../src/guestfs.pod:203
428 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
433 #: ../src/guestfs.pod:205
435 "This would return C<data> as a newly allocated buffer containing the full "
436 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
437 "or C<NULL> if there was an error."
441 #: ../src/guestfs.pod:209
443 "As another example, to create a top-level directory on that filesystem "
444 "called C<\"var\"> you would do:"
448 #: ../src/guestfs.pod:212
451 " guestfs_mkdir (g, \"/var\");\n"
456 #: ../src/guestfs.pod:214
457 msgid "To create a symlink you could do:"
461 #: ../src/guestfs.pod:216
464 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
465 " \"/etc/rc3.d/S30portmap\");\n"
470 #: ../src/guestfs.pod:219
472 "Libguestfs will reject attempts to use relative paths and there is no "
473 "concept of a current working directory."
477 #: ../src/guestfs.pod:222
479 "Libguestfs can return errors in many situations: for example if the "
480 "filesystem isn't writable, or if a file or directory that you requested "
481 "doesn't exist. If you are using the C API (documented here) you have to "
482 "check for those error conditions after each call. (Other language bindings "
483 "turn these errors into exceptions)."
487 #: ../src/guestfs.pod:228
489 "File writes are affected by the per-handle umask, set by calling "
490 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
494 #: ../src/guestfs.pod:231
499 #: ../src/guestfs.pod:233
501 "Libguestfs contains API calls to read, create and modify partition tables on "
506 #: ../src/guestfs.pod:236
508 "In the common case where you want to create a single partition covering the "
509 "whole disk, you should use the L</guestfs_part_disk> call:"
513 #: ../src/guestfs.pod:240
516 " const char *parttype = \"mbr\";\n"
517 " if (disk_is_larger_than_2TB)\n"
518 " parttype = \"gpt\";\n"
519 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
524 #: ../src/guestfs.pod:245
526 "Obviously this effectively wipes anything that was on that disk image "
531 #: ../src/guestfs.pod:248
536 #: ../src/guestfs.pod:250
538 "Libguestfs provides access to a large part of the LVM2 API, such as "
539 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
540 "unless you familiarize yourself with the concepts of physical volumes, "
541 "volume groups and logical volumes."
545 #: ../src/guestfs.pod:255
547 "This author strongly recommends reading the LVM HOWTO, online at "
548 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
552 #: ../src/guestfs.pod:258
557 #: ../src/guestfs.pod:260
559 "Use L</guestfs_cat> to download small, text only files. This call is "
560 "limited to files which are less than 2 MB and which cannot contain any ASCII "
561 "NUL (C<\\0>) characters. However it has a very simple to use API."
565 #: ../src/guestfs.pod:265
567 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
568 "bit data, since it returns a (pointer, size) pair. However it is still "
569 "limited to \"small\" files, less than 2 MB."
573 #: ../src/guestfs.pod:269
575 "L</guestfs_download> can be used to download any file, with no limits on "
576 "content or size (even files larger than 4 GB)."
580 #: ../src/guestfs.pod:272
581 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
585 #: ../src/guestfs.pod:275
590 #: ../src/guestfs.pod:277
592 "It's often the case that you want to write a file or files to the disk "
597 #: ../src/guestfs.pod:280
599 "To write a small file with fixed content, use L</guestfs_write>. To create "
600 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
601 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
602 "variety of other functions for creating test files, for example "
603 "L</guestfs_fill> and L</guestfs_fill_pattern>."
607 #: ../src/guestfs.pod:286
609 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
610 "file content or size (even files larger than 4 GB)."
614 #: ../src/guestfs.pod:289
615 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
619 #: ../src/guestfs.pod:291
621 "However the fastest way to upload I<large numbers of arbitrary files> is to "
622 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
623 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
624 "the drive in a predictable way (eg. adding it last after all other drives) "
625 "then you can get the device name from L</guestfs_list_devices> and mount it "
626 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
627 "sometimes non-portable between kernel versions, and they don't support "
628 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
629 "using a label or UUID, use an ISO image instead."
633 #: ../src/guestfs.pod:302
638 #: ../src/guestfs.pod:304
640 "There are various different commands for copying between files and devices "
641 "and in and out of the guest filesystem. These are summarised in the table "
646 #: ../src/guestfs.pod:310
647 msgid "B<file> to B<file>"
651 #: ../src/guestfs.pod:312
653 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
654 "directories recursively."
658 #: ../src/guestfs.pod:315
659 msgid "B<file or device> to B<file or device>"
663 #: ../src/guestfs.pod:317
665 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
666 "devices in the guest."
670 #: ../src/guestfs.pod:320
671 msgid "Example: duplicate the contents of an LV:"
675 #: ../src/guestfs.pod:322
678 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
683 #: ../src/guestfs.pod:324
685 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
686 "(C</dev/VG/Original>). To copy less than the whole source device, use "
687 "L</guestfs_copy_size>."
691 #: ../src/guestfs.pod:328
692 msgid "B<file on the host> to B<file or device>"
696 #: ../src/guestfs.pod:330
697 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
701 #: ../src/guestfs.pod:332
702 msgid "B<file or device> to B<file on the host>"
706 #: ../src/guestfs.pod:334
707 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
711 #: ../src/guestfs.pod:338
712 msgid "LISTING FILES"
716 #: ../src/guestfs.pod:340
718 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
719 "L<guestfish(1)>-equivalent command C<ll>)."
723 #: ../src/guestfs.pod:343
725 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
726 "programs, as a flat list of strings."
730 #: ../src/guestfs.pod:346
732 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
733 "directory, plus additional information about each one. It is more "
734 "equivalent to using the L<readdir(3)> call on a local filesystem."
738 #: ../src/guestfs.pod:350
740 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
745 #: ../src/guestfs.pod:353
746 msgid "RUNNING COMMANDS"
750 #: ../src/guestfs.pod:355
752 "Although libguestfs is primarily an API for manipulating files inside guest "
753 "images, we also provide some limited facilities for running commands inside "
758 #: ../src/guestfs.pod:359
759 msgid "There are many limitations to this:"
763 #: ../src/guestfs.pod:363 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:377 ../src/guestfs.pod:382 ../src/guestfs.pod:386 ../src/guestfs.pod:391 ../src/guestfs.pod:396 ../src/guestfs.pod:955 ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968 ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003 ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033 ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045 ../src/guestfs.pod:1527 ../src/guestfs.pod:1532 ../src/guestfs.pod:1536 ../src/guestfs.pod:1646 ../src/guestfs.pod:1651 ../src/guestfs.pod:1655 ../src/guestfs.pod:2007 ../src/guestfs.pod:2013 ../src/guestfs.pod:2018 ../src/guestfs.pod:2024 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140 ../src/guestfs.pod:2144 ../src/guestfs.pod:2148 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:377 ../fish/guestfish.pod:381 ../fish/guestfish.pod:385 ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
768 #: ../src/guestfs.pod:365
770 "The kernel version that the command runs under will be different from what "
775 #: ../src/guestfs.pod:370
777 "If the command needs to communicate with daemons, then most likely they "
782 #: ../src/guestfs.pod:375
783 msgid "The command will be running in limited memory."
787 #: ../src/guestfs.pod:379
789 "The network may not be available unless you enable it (see "
790 "L</guestfs_set_network>)."
794 #: ../src/guestfs.pod:384
795 msgid "Only supports Linux guests (not Windows, BSD, etc)."
799 #: ../src/guestfs.pod:388
800 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
804 #: ../src/guestfs.pod:393
806 "For SELinux guests, you may need to enable SELinux and load policy first. "
807 "See L</SELINUX> in this manpage."
811 #: ../src/guestfs.pod:398
813 "I<Security:> It is not safe to run commands from untrusted, possibly "
814 "malicious guests. These commands may attempt to exploit your program by "
815 "sending unexpected output. They could also try to exploit the Linux kernel "
816 "or qemu provided by the libguestfs appliance. They could use the network "
817 "provided by the libguestfs appliance to bypass ordinary network partitions "
818 "and firewalls. They could use the elevated privileges or different SELinux "
819 "context of your program to their advantage."
823 #: ../src/guestfs.pod:407
825 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
826 "(a script which runs when the guest next boots normally), and to have this "
827 "script run the commands you want in the normal context of the running guest, "
828 "network security and so on. For information about other security issues, "
833 #: ../src/guestfs.pod:415
835 "The two main API calls to run commands are L</guestfs_command> and "
836 "L</guestfs_sh> (there are also variations)."
840 #: ../src/guestfs.pod:418
842 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
843 "shell globs, redirections, etc will work."
847 #: ../src/guestfs.pod:421
848 msgid "CONFIGURATION FILES"
852 #: ../src/guestfs.pod:423
854 "To read and write configuration files in Linux guest filesystems, we "
855 "strongly recommend using Augeas. For example, Augeas understands how to "
856 "read and write, say, a Linux shadow password file or X.org configuration "
857 "file, and so avoids you having to write that code."
861 #: ../src/guestfs.pod:428
863 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
864 "document Augeas itself here because there is excellent documentation on the "
865 "L<http://augeas.net/> website."
869 #: ../src/guestfs.pod:432
871 "If you don't want to use Augeas (you fool!) then try calling "
872 "L</guestfs_read_lines> to get the file as a list of lines which you can "
877 #: ../src/guestfs.pod:436
882 #: ../src/guestfs.pod:438
884 "We support SELinux guests. To ensure that labeling happens correctly in "
885 "SELinux guests, you need to enable SELinux and load the guest's policy:"
889 #: ../src/guestfs.pod:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279
894 #: ../src/guestfs.pod:446
895 msgid "Before launching, do:"
899 #: ../src/guestfs.pod:448
902 " guestfs_set_selinux (g, 1);\n"
907 #: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283
912 #: ../src/guestfs.pod:452
914 "After mounting the guest's filesystem(s), load the policy. This is best "
915 "done by running the L<load_policy(8)> command in the guest itself:"
919 #: ../src/guestfs.pod:456
922 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
927 #: ../src/guestfs.pod:458
929 "(Older versions of C<load_policy> require you to specify the name of the "
934 #: ../src/guestfs.pod:461 ../src/guestfs.pod:1289
939 #: ../src/guestfs.pod:463
941 "Optionally, set the security context for the API. The correct security "
942 "context to use can only be known by inspecting the guest. As an example:"
946 #: ../src/guestfs.pod:467
949 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
954 #: ../src/guestfs.pod:471
955 msgid "This will work for running commands and editing existing files."
959 #: ../src/guestfs.pod:473
961 "When new files are created, you may need to label them explicitly, for "
962 "example by running the external command C<restorecon pathname>."
966 #: ../src/guestfs.pod:477
971 #: ../src/guestfs.pod:479
973 "Certain calls are affected by the current file mode creation mask (the "
974 "\"umask\"). In particular ones which create files or directories, such as "
975 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
976 "either the default mode that the file is created with or modifies the mode "
981 #: ../src/guestfs.pod:485
983 "The default umask is C<022>, so files are created with modes such as C<0644> "
984 "and directories with C<0755>."
988 #: ../src/guestfs.pod:488
990 "There are two ways to avoid being affected by umask. Either set umask to 0 "
991 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
992 "L</guestfs_chmod> after creating each file or directory."
996 #: ../src/guestfs.pod:492
997 msgid "For more information about umask, see L<umask(2)>."
1001 #: ../src/guestfs.pod:494 ../fish/guestfish.pod:670
1002 msgid "ENCRYPTED DISKS"
1006 #: ../src/guestfs.pod:496
1008 "Libguestfs allows you to access Linux guests which have been encrypted using "
1009 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1010 "standard. This includes nearly all whole disk encryption systems used by "
1011 "modern Linux guests."
1015 #: ../src/guestfs.pod:502
1017 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1018 "returns the string C<crypto_LUKS>)."
1022 #: ../src/guestfs.pod:505
1024 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1025 "will require the passphrase!"
1029 #: ../src/guestfs.pod:508
1031 "Opening a LUKS device creates a new device mapper device called "
1032 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1033 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1034 "decrypted from and encrypted to the underlying block device respectively."
1038 #: ../src/guestfs.pod:514
1040 "LVM volume groups on the device can be made visible by calling "
1041 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1042 "volume(s) can now be mounted in the usual way."
1046 #: ../src/guestfs.pod:518
1048 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1049 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1050 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1051 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1052 "underlying encrypted block device)."
1056 #: ../src/guestfs.pod:525
1061 #: ../src/guestfs.pod:527
1063 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1064 "contains operating systems. (These APIs used to be in a separate Perl-only "
1065 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1066 "frequently used part of this library has been rewritten in C and moved into "
1071 #: ../src/guestfs.pod:533
1073 "Add all disks belonging to the unknown virtual machine and call "
1074 "L</guestfs_launch> in the usual way."
1078 #: ../src/guestfs.pod:536
1080 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1081 "and certain heuristics, and returns a list of operating systems that were "
1082 "found. An empty list means none were found. A single element is the root "
1083 "filesystem of the operating system. For dual- or multi-boot guests, "
1084 "multiple roots can be returned, each one corresponding to a separate "
1085 "operating system. (Multi-boot virtual machines are extremely rare in the "
1086 "world of virtualization, but since this scenario can happen, we have built "
1087 "libguestfs to deal with it.)"
1091 #: ../src/guestfs.pod:545
1093 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1094 "to get additional details about that operating system. For example, call "
1095 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1096 "Windows and Linux-based operating systems respectively."
1100 #: ../src/guestfs.pod:551
1102 "Un*x-like and Linux-based operating systems usually consist of several "
1103 "filesystems which are mounted at boot time (for example, a separate boot "
1104 "partition mounted on C</boot>). The inspection rules are able to detect how "
1105 "filesystems correspond to mount points. Call "
1106 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1107 "hash table like this example:"
1111 #: ../src/guestfs.pod:558
1114 " /boot => /dev/sda1\n"
1115 " / => /dev/vg_guest/lv_root\n"
1116 " /usr => /dev/vg_guest/lv_usr\n"
1121 #: ../src/guestfs.pod:562
1123 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1124 "filesystems as suggested."
1128 #: ../src/guestfs.pod:565
1130 "Be careful to mount filesystems in the right order (eg. C</> before "
1131 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1136 #: ../src/guestfs.pod:569
1138 "Inspection currently only works for some common operating systems. "
1139 "Contributors are welcome to send patches for other operating systems that we "
1140 "currently cannot detect."
1144 #: ../src/guestfs.pod:573
1146 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1147 "for more details. The L</guestfs_inspect_os> function just ignores any "
1148 "encrypted devices."
1152 #: ../src/guestfs.pod:577
1154 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1155 "inspection and caches the results in the guest handle. Subsequent calls to "
1156 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1157 "re-read the disks. If you change the content of the guest disks, you can "
1158 "redo inspection by calling L</guestfs_inspect_os> again. "
1159 "(L</guestfs_inspect_list_applications> works a little differently from the "
1160 "other calls and does read the disks. See documentation for that function "
1165 #: ../src/guestfs.pod:586
1166 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1170 #: ../src/guestfs.pod:588
1172 "Libguestfs can mount NTFS partitions. It does this using the "
1173 "L<http://www.ntfs-3g.org/> driver."
1177 #: ../src/guestfs.pod:591
1179 "DOS and Windows still use drive letters, and the filesystems are always "
1180 "treated as case insensitive by Windows itself, and therefore you might find "
1181 "a Windows configuration file referring to a path like "
1182 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1183 "that directory might be referred to as C</WINDOWS/System32>."
1187 #: ../src/guestfs.pod:597
1189 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1190 "libguestfs to read the appropriate Windows Registry and configuration files, "
1191 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1192 "L<virt-inspector(1)>)."
1196 #: ../src/guestfs.pod:602
1198 "Replacing backslash characters with forward slash characters is also outside "
1199 "the scope of libguestfs, but something that you can easily do."
1203 #: ../src/guestfs.pod:605
1205 "Where we can help is in resolving the case insensitivity of paths. For "
1206 "this, call L</guestfs_case_sensitive_path>."
1210 #: ../src/guestfs.pod:608
1212 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1213 "files, through the library C<hivex> which is part of the libguestfs project "
1214 "although ships as a separate tarball. You have to locate and download the "
1215 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1216 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1217 "L<virt-win-reg(1)> for more help on this issue."
1221 #: ../src/guestfs.pod:616
1222 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1226 #: ../src/guestfs.pod:618
1228 "Although we don't want to discourage you from using the C API, we will "
1229 "mention here that the same API is also available in other languages."
1233 #: ../src/guestfs.pod:621
1235 "The API is broadly identical in all supported languages. This means that "
1236 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1237 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1238 "words, a straightforward, predictable isomorphism between each language."
1242 #: ../src/guestfs.pod:627
1244 "Error messages are automatically transformed into exceptions if the language "
1249 #: ../src/guestfs.pod:630
1251 "We don't try to \"object orientify\" parts of the API in OO languages, "
1252 "although contributors are welcome to write higher level APIs above what we "
1253 "provide in their favourite languages if they wish."
1257 #: ../src/guestfs.pod:636
1262 #: ../src/guestfs.pod:638
1264 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1265 "identical to the C API. C++ classes and exceptions are not used."
1269 #: ../src/guestfs.pod:642
1274 #: ../src/guestfs.pod:644
1276 "The C# bindings are highly experimental. Please read the warnings at the "
1277 "top of C<csharp/Libguestfs.cs>."
1281 #: ../src/guestfs.pod:647
1286 #: ../src/guestfs.pod:649
1288 "This is the only language binding that is working but incomplete. Only "
1289 "calls which return simple integers have been bound in Haskell, and we are "
1290 "looking for help to complete this binding."
1294 #: ../src/guestfs.pod:653
1299 #: ../src/guestfs.pod:655
1301 "Full documentation is contained in the Javadoc which is distributed with "
1306 #: ../src/guestfs.pod:658
1311 #: ../src/guestfs.pod:660
1312 msgid "For documentation see L<guestfs-ocaml(3)>."
1316 #: ../src/guestfs.pod:662
1321 #: ../src/guestfs.pod:664
1322 msgid "For documentation see L<Sys::Guestfs(3)>."
1326 #: ../src/guestfs.pod:666
1331 #: ../src/guestfs.pod:668
1333 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1334 "the php-libguestfs package for your distribution."
1338 #: ../src/guestfs.pod:671
1339 msgid "The PHP binding only works correctly on 64 bit machines."
1343 #: ../src/guestfs.pod:673
1348 #: ../src/guestfs.pod:675
1349 msgid "For documentation see L<guestfs-python(3)>."
1353 #: ../src/guestfs.pod:677
1358 #: ../src/guestfs.pod:679
1359 msgid "For documentation see L<guestfs-ruby(3)>."
1363 #: ../src/guestfs.pod:681
1364 msgid "B<shell scripts>"
1368 #: ../src/guestfs.pod:683
1369 msgid "For documentation see L<guestfish(1)>."
1373 #: ../src/guestfs.pod:687
1374 msgid "LIBGUESTFS GOTCHAS"
1378 #: ../src/guestfs.pod:689
1380 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1381 "system [...] that works in the way it is documented but is counterintuitive "
1382 "and almost invites mistakes.\""
1386 #: ../src/guestfs.pod:693
1388 "Since we developed libguestfs and the associated tools, there are several "
1389 "things we would have designed differently, but are now stuck with for "
1390 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1391 "release, you can expect these to change. Beware of them."
1395 #: ../src/guestfs.pod:701
1396 msgid "Autosync / forgetting to sync."
1400 #: ../src/guestfs.pod:703
1402 "When modifying a filesystem from C or another language, you B<must> unmount "
1403 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1404 "libguestfs handle. You can also call:"
1408 #: ../src/guestfs.pod:707
1411 " guestfs_set_autosync (g, 1);\n"
1416 #: ../src/guestfs.pod:709
1418 "to have the unmount/sync done automatically for you when the handle 'g' is "
1419 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1424 #: ../src/guestfs.pod:713
1426 "If you forget to do this, then it is entirely possible that your changes "
1427 "won't be written out, or will be partially written, or (very rarely) that "
1428 "you'll get disk corruption."
1432 #: ../src/guestfs.pod:717
1434 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1435 "guestfish scripts that forget to sync will work just fine, which can make "
1436 "this very puzzling if you are trying to debug a problem."
1440 #: ../src/guestfs.pod:721
1442 "Update: Autosync is enabled by default for all API users starting from "
1443 "libguestfs 1.5.24."
1447 #: ../src/guestfs.pod:724
1448 msgid "Mount option C<-o sync> should not be the default."
1452 #: ../src/guestfs.pod:726
1454 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1455 "However C<-o sync> does not add any reliability benefit, but does have a "
1456 "very large performance impact."
1460 #: ../src/guestfs.pod:730
1462 "The work around is to use L</guestfs_mount_options> and set the mount "
1463 "options that you actually want to use."
1467 #: ../src/guestfs.pod:733
1468 msgid "Read-only should be the default."
1472 #: ../src/guestfs.pod:735
1474 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1475 "specify I<--rw> if you want to make changes to the image."
1479 #: ../src/guestfs.pod:738
1480 msgid "This would reduce the potential to corrupt live VM images."
1484 #: ../src/guestfs.pod:740
1486 "Note that many filesystems change the disk when you just mount and unmount, "
1487 "even if you didn't perform any writes. You need to use "
1488 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1492 #: ../src/guestfs.pod:744
1493 msgid "guestfish command line is hard to use."
1497 #: ../src/guestfs.pod:746
1499 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1500 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1501 "exist, so it fails. In earlier versions of guestfish the error message was "
1502 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1503 "we should have used C<guestfish -c command> to run commands."
1507 #: ../src/guestfs.pod:753
1508 msgid "guestfish megabyte modifiers don't work right on all commands"
1512 #: ../src/guestfs.pod:755
1514 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1515 "other modifiers). What guestfish actually does is to multiply the number "
1516 "part by the modifier part and pass the result to the C API. However this "
1517 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1518 "expecting some other unit (eg. megabytes)."
1522 #: ../src/guestfs.pod:762
1523 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1527 #: ../src/guestfs.pod:764
1530 " lvcreate LV VG 100M\n"
1535 #: ../src/guestfs.pod:766
1537 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1538 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1539 "megabytes * megabytes) logical volume. The error message you get from this "
1540 "is also a little obscure."
1544 #: ../src/guestfs.pod:771
1546 "This could be fixed in the generator by specially marking parameters and "
1547 "return values which take bytes or other units."
1551 #: ../src/guestfs.pod:774
1552 msgid "Ambiguity between devices and paths"
1556 #: ../src/guestfs.pod:776
1558 "There is a subtle ambiguity in the API between a device name "
1559 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1560 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1564 #: ../src/guestfs.pod:781
1566 "In the current API we usually resolve this ambiguity by having two separate "
1567 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1568 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1569 "detecting if the path supplied begins with C</dev/>."
1573 #: ../src/guestfs.pod:787
1575 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1576 "make paths/devices into structured names. One way to do this would be to "
1577 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1578 "aspect of grub. Another way would be to use a structured type, equivalent "
1579 "to this OCaml type:"
1583 #: ../src/guestfs.pod:793
1586 " type path = Path of string | Device of int | Partition of int * int\n"
1591 #: ../src/guestfs.pod:795
1592 msgid "which would allow you to pass arguments like:"
1596 #: ../src/guestfs.pod:797
1599 " Path \"/foo/bar\"\n"
1600 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1601 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1602 " Path \"/dev/sdb2\" (* not a device *)\n"
1607 #: ../src/guestfs.pod:802
1609 "As you can see there are still problems to resolve even with this "
1610 "representation. Also consider how it might work in guestfish."
1614 #: ../src/guestfs.pod:807
1615 msgid "PROTOCOL LIMITS"
1619 #: ../src/guestfs.pod:809
1621 "Internally libguestfs uses a message-based protocol to pass API calls and "
1622 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1623 "plenty more detail about this). The maximum message size used by the "
1624 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1625 "aware of this limit. The API calls which may be affected are individually "
1626 "documented, with a link back to this section of the documentation."
1630 #: ../src/guestfs.pod:817
1632 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1633 "a simple string. Because this string is at some point internally encoded as "
1634 "a message, the maximum size that it can return is slightly under 4 MB. If "
1635 "the requested file is larger than this then you will get an error."
1639 #: ../src/guestfs.pod:823
1641 "In order to transfer large files into and out of the guest filesystem, you "
1642 "need to use particular calls that support this. The sections L</UPLOADING> "
1643 "and L</DOWNLOADING> document how to do this."
1647 #: ../src/guestfs.pod:827
1649 "You might also consider mounting the disk image using our FUSE filesystem "
1650 "support (L<guestmount(1)>)."
1654 #: ../src/guestfs.pod:830
1655 msgid "KEYS AND PASSPHRASES"
1659 #: ../src/guestfs.pod:832
1661 "Certain libguestfs calls take a parameter that contains sensitive key "
1662 "material, passed in as a C string."
1666 #: ../src/guestfs.pod:835
1668 "In the future we would hope to change the libguestfs implementation so that "
1669 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1670 "swap. However this is I<not> done at the moment, because of the complexity "
1671 "of such an implementation."
1675 #: ../src/guestfs.pod:840
1677 "Therefore you should be aware that any key parameter you pass to libguestfs "
1678 "might end up being written out to the swap partition. If this is a concern, "
1679 "scrub the swap partition or don't use libguestfs on encrypted devices."
1683 #: ../src/guestfs.pod:845
1684 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1688 #: ../src/guestfs.pod:847
1690 "All high-level libguestfs actions are synchronous. If you want to use "
1691 "libguestfs asynchronously then you must create a thread."
1695 #: ../src/guestfs.pod:850
1697 "Only use the handle from a single thread. Either use the handle exclusively "
1698 "from one thread, or provide your own mutex so that two threads cannot issue "
1699 "calls on the same handle at the same time."
1703 #: ../src/guestfs.pod:854
1705 "See the graphical program guestfs-browser for one possible architecture for "
1706 "multithreaded programs using libvirt and libguestfs."
1710 #: ../src/guestfs.pod:857
1715 #: ../src/guestfs.pod:859
1717 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1722 #: ../src/guestfs.pod:862
1724 "By default it looks for these in the directory C<$libdir/guestfs> "
1725 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1729 #: ../src/guestfs.pod:865
1731 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1732 "to change the directories that libguestfs will search in. The value is a "
1733 "colon-separated list of paths. The current directory is I<not> searched "
1734 "unless the path contains an empty element or C<.>. For example "
1735 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1736 "then C</usr/lib/guestfs>."
1740 #: ../src/guestfs.pod:872
1741 msgid "QEMU WRAPPERS"
1745 #: ../src/guestfs.pod:874
1747 "If you want to compile your own qemu, run qemu from a non-standard location, "
1748 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1753 #: ../src/guestfs.pod:878
1755 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1756 "last command in the shell script (so that qemu replaces the shell and "
1757 "becomes the direct child of the libguestfs-using program). If you don't do "
1758 "this, then the qemu process won't be cleaned up correctly."
1762 #: ../src/guestfs.pod:883
1764 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1769 #: ../src/guestfs.pod:886
1773 " qemudir=/home/rjones/d/qemu\n"
1774 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1780 #: ../src/guestfs.pod:890
1782 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1783 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1788 #: ../src/guestfs.pod:894
1791 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1796 #: ../src/guestfs.pod:896
1798 "Note that libguestfs also calls qemu with the -help and -version options in "
1799 "order to determine features."
1803 #: ../src/guestfs.pod:899
1804 msgid "ABI GUARANTEE"
1808 #: ../src/guestfs.pod:901
1810 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1811 "actions as outlined in this section. Although we will deprecate some "
1812 "actions, for example if they get replaced by newer calls, we will keep the "
1813 "old actions forever. This allows you the developer to program in confidence "
1814 "against the libguestfs API."
1818 #: ../src/guestfs.pod:907
1819 msgid "BLOCK DEVICE NAMING"
1823 #: ../src/guestfs.pod:909
1825 "In the kernel there is now quite a profusion of schemata for naming block "
1826 "devices (in this context, by I<block device> I mean a physical or virtual "
1827 "hard drive). The original Linux IDE driver used names starting with "
1828 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1829 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1830 "replacement for the old IDE driver (particularly for SATA devices) those "
1831 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1832 "machines with paravirtualized drivers. This has created several different "
1833 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1838 #: ../src/guestfs.pod:921
1840 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1841 "Linux kernel to access block devices. We can run a variety of appliances "
1842 "based on a variety of Linux kernels."
1846 #: ../src/guestfs.pod:925
1848 "This causes a problem for libguestfs because many API calls use device or "
1849 "partition names. Working scripts and the recipe (example) scripts that we "
1850 "make available over the internet could fail if the naming scheme changes."
1854 #: ../src/guestfs.pod:930
1856 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1857 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1858 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1859 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1863 #: ../src/guestfs.pod:936
1865 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1866 "L</guestfs_list_partitions> and similar calls return the true names of the "
1867 "devices and partitions as known to the appliance."
1871 #: ../src/guestfs.pod:941
1872 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1876 #: ../src/guestfs.pod:943
1878 "Usually this translation is transparent. However in some (very rare) cases "
1879 "you may need to know the exact algorithm. Such cases include where you use "
1880 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1881 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1886 #: ../src/guestfs.pod:949
1888 "The algorithm is applied only to I<parameters> which are known to be either "
1889 "device or partition names. Return values from functions such as "
1890 "L</guestfs_list_devices> are never changed."
1894 #: ../src/guestfs.pod:957
1895 msgid "Is the string a parameter which is a device or partition name?"
1899 #: ../src/guestfs.pod:961
1900 msgid "Does the string begin with C</dev/sd>?"
1904 #: ../src/guestfs.pod:965
1906 "Does the named device exist? If so, we use that device. However if I<not> "
1907 "then we continue with this algorithm."
1911 #: ../src/guestfs.pod:970
1912 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1916 #: ../src/guestfs.pod:972
1917 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1921 #: ../src/guestfs.pod:974
1922 msgid "If that named device exists, use it. If not, continue."
1926 #: ../src/guestfs.pod:978
1927 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1931 #: ../src/guestfs.pod:980
1932 msgid "If that named device exists, use it. If not, return an error."
1936 #: ../src/guestfs.pod:984
1937 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1941 #: ../src/guestfs.pod:986
1943 "Although the standard naming scheme and automatic translation is useful for "
1944 "simple programs and guestfish scripts, for larger programs it is best not to "
1945 "rely on this mechanism."
1949 #: ../src/guestfs.pod:990
1951 "Where possible for maximum future portability programs using libguestfs "
1952 "should use these future-proof techniques:"
1956 #: ../src/guestfs.pod:997
1958 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
1959 "device names, and then use those names directly."
1963 #: ../src/guestfs.pod:1000
1964 msgid "Since those device names exist by definition, they will never be translated."
1968 #: ../src/guestfs.pod:1005
1970 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
1971 "filesystem labels."
1975 #: ../src/guestfs.pod:1010
1980 #: ../src/guestfs.pod:1012
1982 "This section discusses security implications of using libguestfs, "
1983 "particularly with untrusted or malicious guests or disk images."
1987 #: ../src/guestfs.pod:1015
1988 msgid "GENERAL SECURITY CONSIDERATIONS"
1992 #: ../src/guestfs.pod:1017
1994 "Be careful with any files or data that you download from a guest (by "
1995 "\"download\" we mean not just the L</guestfs_download> command but any "
1996 "command that reads files, filenames, directories or anything else from a "
1997 "disk image). An attacker could manipulate the data to fool your program "
1998 "into doing the wrong thing. Consider cases such as:"
2002 #: ../src/guestfs.pod:1027
2003 msgid "the data (file etc) not being present"
2007 #: ../src/guestfs.pod:1031
2008 msgid "being present but empty"
2012 #: ../src/guestfs.pod:1035
2013 msgid "being much larger than normal"
2017 #: ../src/guestfs.pod:1039
2018 msgid "containing arbitrary 8 bit data"
2022 #: ../src/guestfs.pod:1043
2023 msgid "being in an unexpected character encoding"
2027 #: ../src/guestfs.pod:1047
2028 msgid "containing homoglyphs."
2032 #: ../src/guestfs.pod:1051
2033 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2037 #: ../src/guestfs.pod:1053
2039 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2040 "(VFS) module can sometimes be escalated into exploits by deliberately "
2041 "creating a malicious, malformed filesystem. These exploits are very severe "
2042 "for two reasons. Firstly there are very many filesystem drivers in the "
2043 "kernel, and many of them are infrequently used and not much developer "
2044 "attention has been paid to the code. Linux userspace helps potential "
2045 "crackers by detecting the filesystem type and automatically choosing the "
2046 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2047 "the administrator. Secondly, a kernel-level exploit is like a local root "
2048 "exploit (worse in some ways), giving immediate and total access to the "
2049 "system right down to the hardware level."
2053 #: ../src/guestfs.pod:1066
2055 "That explains why you should never mount a filesystem from an untrusted "
2056 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2057 "inside a qemu virtual machine, usually running as a non-root user. The "
2058 "attacker would need to write a filesystem which first exploited the kernel, "
2059 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2060 "the libguestfs protocol, and finally to be as serious as the host kernel "
2061 "exploit it would need to escalate its privileges to root. This multi-step "
2062 "escalation, performed by a static piece of data, is thought to be extremely "
2063 "hard to do, although we never say 'never' about security issues."
2067 #: ../src/guestfs.pod:1077
2069 "In any case callers can reduce the attack surface by forcing the filesystem "
2070 "type when mounting (use L</guestfs_mount_vfs>)."
2074 #: ../src/guestfs.pod:1080
2075 msgid "PROTOCOL SECURITY"
2079 #: ../src/guestfs.pod:1082
2081 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2082 "defined upper message size. However a program that uses libguestfs must "
2083 "also take care - for example you can write a program that downloads a binary "
2084 "from a disk image and executes it locally, and no amount of protocol "
2085 "security will save you from the consequences."
2089 #: ../src/guestfs.pod:1088
2090 msgid "INSPECTION SECURITY"
2094 #: ../src/guestfs.pod:1090
2096 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2097 "directly from the guest, and these could contain any 8 bit data. Callers "
2098 "should be careful to escape these before printing them to a structured file "
2099 "(for example, use HTML escaping if creating a web page)."
2103 #: ../src/guestfs.pod:1096
2105 "Guest configuration may be altered in unusual ways by the administrator of "
2106 "the virtual machine, and may not reflect reality (particularly for untrusted "
2107 "or actively malicious guests). For example we parse the hostname from "
2108 "configuration files like C</etc/sysconfig/network> that we find in the "
2109 "guest, but the guest administrator can easily manipulate these files to "
2110 "provide the wrong hostname."
2114 #: ../src/guestfs.pod:1104
2116 "The inspection API parses guest configuration using two external libraries: "
2117 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2118 "designed to be robust in the face of malicious data, although denial of "
2119 "service attacks are still possible, for example with oversized configuration "
2124 #: ../src/guestfs.pod:1110
2125 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2129 #: ../src/guestfs.pod:1112
2131 "Be very cautious about running commands from the guest. By running a "
2132 "command in the guest, you are giving CPU time to a binary that you do not "
2133 "control, under the same user account as the library, albeit wrapped in qemu "
2134 "virtualization. More information and alternatives can be found in the "
2135 "section L</RUNNING COMMANDS>."
2139 #: ../src/guestfs.pod:1118
2140 msgid "CVE-2010-3851"
2144 #: ../src/guestfs.pod:1120
2145 msgid "https://bugzilla.redhat.com/642934"
2149 #: ../src/guestfs.pod:1122
2151 "This security bug concerns the automatic disk format detection that qemu "
2152 "does on disk images."
2156 #: ../src/guestfs.pod:1125
2158 "A raw disk image is just the raw bytes, there is no header. Other disk "
2159 "images like qcow2 contain a special header. Qemu deals with this by looking "
2160 "for one of the known headers, and if none is found then assuming the disk "
2161 "image must be raw."
2165 #: ../src/guestfs.pod:1130
2167 "This allows a guest which has been given a raw disk image to write some "
2168 "other header. At next boot (or when the disk image is accessed by "
2169 "libguestfs) qemu would do autodetection and think the disk image format was, "
2170 "say, qcow2 based on the header written by the guest."
2174 #: ../src/guestfs.pod:1135
2176 "This in itself would not be a problem, but qcow2 offers many features, one "
2177 "of which is to allow a disk image to refer to another image (called the "
2178 "\"backing disk\"). It does this by placing the path to the backing disk "
2179 "into the qcow2 header. This path is not validated and could point to any "
2180 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2181 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2182 "control of the attacker."
2186 #: ../src/guestfs.pod:1143
2187 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2191 #: ../src/guestfs.pod:1150
2192 msgid "You have enabled the network or have opened the disk in write mode."
2196 #: ../src/guestfs.pod:1154
2198 "You are also running untrusted code from the guest (see L</RUNNING "
2203 #: ../src/guestfs.pod:1159
2205 "The way to avoid this is to specify the expected disk format when adding "
2206 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2207 "should always do this if the disk is raw format, and it's a good idea for "
2212 #: ../src/guestfs.pod:1164
2214 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2215 "format is fetched from libvirt and passed through."
2219 #: ../src/guestfs.pod:1167
2221 "For libguestfs tools, use the I<--format> command line parameter as "
2226 #: ../src/guestfs.pod:1170
2227 msgid "CONNECTION MANAGEMENT"
2231 #: ../src/guestfs.pod:1172
2236 #: ../src/guestfs.pod:1174
2238 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2239 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2240 "handle and release all resources used."
2244 #: ../src/guestfs.pod:1178
2246 "For information on using multiple handles and threads, see the section "
2247 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2251 #: ../src/guestfs.pod:1181
2252 msgid "guestfs_create"
2256 #: ../src/guestfs.pod:1183
2259 " guestfs_h *guestfs_create (void);\n"
2264 #: ../src/guestfs.pod:1185
2265 msgid "Create a connection handle."
2269 #: ../src/guestfs.pod:1187
2271 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2272 "on the handle at least once."
2276 #: ../src/guestfs.pod:1190
2278 "This function returns a non-NULL pointer to a handle on success or NULL on "
2283 #: ../src/guestfs.pod:1193
2284 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2288 #: ../src/guestfs.pod:1195
2290 "You may also want to configure error handling for the handle. See L</ERROR "
2291 "HANDLING> section below."
2295 #: ../src/guestfs.pod:1198
2296 msgid "guestfs_close"
2300 #: ../src/guestfs.pod:1200
2303 " void guestfs_close (guestfs_h *g);\n"
2308 #: ../src/guestfs.pod:1202
2309 msgid "This closes the connection handle and frees up all resources used."
2313 #: ../src/guestfs.pod:1204
2314 msgid "ERROR HANDLING"
2318 #: ../src/guestfs.pod:1206
2320 "API functions can return errors. For example, almost all functions that "
2321 "return C<int> will return C<-1> to indicate an error."
2325 #: ../src/guestfs.pod:1209
2327 "Additional information is available for errors: an error message string and "
2328 "optionally an error number (errno) if the thing that failed was a system "
2333 #: ../src/guestfs.pod:1213
2335 "You can get at the additional information about the last error on the handle "
2336 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2337 "up an error handler with L</guestfs_set_error_handler>."
2341 #: ../src/guestfs.pod:1218
2343 "When the handle is created, a default error handler is installed which "
2344 "prints the error message string to C<stderr>. For small short-running "
2345 "command line programs it is sufficient to do:"
2349 #: ../src/guestfs.pod:1222
2352 " if (guestfs_launch (g) == -1)\n"
2353 " exit (EXIT_FAILURE);\n"
2358 #: ../src/guestfs.pod:1225
2360 "since the default error handler will ensure that an error message has been "
2361 "printed to C<stderr> before the program exits."
2365 #: ../src/guestfs.pod:1228
2367 "For other programs the caller will almost certainly want to install an "
2368 "alternate error handler or do error handling in-line like this:"
2372 #: ../src/guestfs.pod:1231
2375 " g = guestfs_create ();\n"
2380 #: ../src/guestfs.pod:1233
2383 " /* This disables the default behaviour of printing errors\n"
2385 " guestfs_set_error_handler (g, NULL, NULL);\n"
2390 #: ../src/guestfs.pod:1237
2393 " if (guestfs_launch (g) == -1) {\n"
2394 " /* Examine the error message and print it etc. */\n"
2395 " char *msg = guestfs_last_error (g);\n"
2396 " int errnum = guestfs_last_errno (g);\n"
2397 " fprintf (stderr, \"%s\\n\", msg);\n"
2404 #: ../src/guestfs.pod:1245
2406 "Out of memory errors are handled differently. The default action is to call "
2407 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2408 "L</guestfs_set_out_of_memory_handler>."
2412 #: ../src/guestfs.pod:1249
2414 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2415 "because there is no handle if this happens there is no way to get additional "
2416 "error information. However L</guestfs_create> is supposed to be a "
2417 "lightweight operation which can only fail because of insufficient memory (it "
2418 "returns NULL in this case)."
2422 #: ../src/guestfs.pod:1255
2423 msgid "guestfs_last_error"
2427 #: ../src/guestfs.pod:1257
2430 " const char *guestfs_last_error (guestfs_h *g);\n"
2435 #: ../src/guestfs.pod:1259
2437 "This returns the last error message that happened on C<g>. If there has not "
2438 "been an error since the handle was created, then this returns C<NULL>."
2442 #: ../src/guestfs.pod:1263
2444 "The lifetime of the returned string is until the next error occurs, or "
2445 "L</guestfs_close> is called."
2449 #: ../src/guestfs.pod:1266
2450 msgid "guestfs_last_errno"
2454 #: ../src/guestfs.pod:1268
2457 " int guestfs_last_errno (guestfs_h *g);\n"
2462 #: ../src/guestfs.pod:1270
2463 msgid "This returns the last error number (errno) that happened on C<g>."
2467 #: ../src/guestfs.pod:1272
2468 msgid "If successful, an errno integer not equal to zero is returned."
2472 #: ../src/guestfs.pod:1274
2473 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2477 #: ../src/guestfs.pod:1281
2478 msgid "There has not been any error on the handle."
2482 #: ../src/guestfs.pod:1285
2484 "There has been an error but the errno was meaningless. This corresponds to "
2485 "the case where the error did not come from a failed system call, but for "
2486 "some other reason."
2490 #: ../src/guestfs.pod:1291
2492 "There was an error from a failed system call, but for some reason the errno "
2493 "was not captured and returned. This usually indicates a bug in libguestfs."
2497 #: ../src/guestfs.pod:1297
2499 "Libguestfs tries to convert the errno from inside the applicance into a "
2500 "corresponding errno for the caller (not entirely trivial: the appliance "
2501 "might be running a completely different operating system from the library "
2502 "and error numbers are not standardized across Un*xen). If this could not be "
2503 "done, then the error is translated to C<EINVAL>. In practice this should "
2504 "only happen in very rare circumstances."
2508 #: ../src/guestfs.pod:1305
2509 msgid "guestfs_set_error_handler"
2513 #: ../src/guestfs.pod:1307
2516 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2518 " const char *msg);\n"
2519 " void guestfs_set_error_handler (guestfs_h *g,\n"
2520 " guestfs_error_handler_cb cb,\n"
2526 #: ../src/guestfs.pod:1314
2528 "The callback C<cb> will be called if there is an error. The parameters "
2529 "passed to the callback are an opaque data pointer and the error message "
2534 #: ../src/guestfs.pod:1318
2536 "C<errno> is not passed to the callback. To get that the callback must call "
2537 "L</guestfs_last_errno>."
2541 #: ../src/guestfs.pod:1321
2543 "Note that the message string C<msg> is freed as soon as the callback "
2544 "function returns, so if you want to stash it somewhere you must make your "
2549 #: ../src/guestfs.pod:1325
2550 msgid "The default handler prints messages on C<stderr>."
2554 #: ../src/guestfs.pod:1327
2555 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2559 #: ../src/guestfs.pod:1329
2560 msgid "guestfs_get_error_handler"
2564 #: ../src/guestfs.pod:1331
2567 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2568 " void **opaque_rtn);\n"
2573 #: ../src/guestfs.pod:1334
2574 msgid "Returns the current error handler callback."
2578 #: ../src/guestfs.pod:1336
2579 msgid "guestfs_set_out_of_memory_handler"
2583 #: ../src/guestfs.pod:1338
2586 " typedef void (*guestfs_abort_cb) (void);\n"
2587 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2588 " guestfs_abort_cb);\n"
2593 #: ../src/guestfs.pod:1342
2595 "The callback C<cb> will be called if there is an out of memory situation. "
2596 "I<Note this callback must not return>."
2600 #: ../src/guestfs.pod:1345
2601 msgid "The default is to call L<abort(3)>."
2605 #: ../src/guestfs.pod:1347
2606 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2610 #: ../src/guestfs.pod:1350
2611 msgid "guestfs_get_out_of_memory_handler"
2615 #: ../src/guestfs.pod:1352
2618 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2623 #: ../src/guestfs.pod:1354
2624 msgid "This returns the current out of memory handler."
2628 #: ../src/guestfs.pod:1356
2633 #: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908
2638 #: ../src/guestfs.pod:1360
2643 #: ../src/guestfs.pod:1362
2648 #: ../src/guestfs.pod:1364
2649 msgid "AVAILABILITY"
2653 #: ../src/guestfs.pod:1366
2654 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2658 #: ../src/guestfs.pod:1368
2660 "Using L</guestfs_available> you can test availability of the following "
2661 "groups of functions. This test queries the appliance to see if the "
2662 "appliance you are currently using supports the functionality."
2666 #: ../src/guestfs.pod:1373
2667 msgid "@AVAILABILITY@"
2671 #: ../src/guestfs.pod:1375
2672 msgid "GUESTFISH supported COMMAND"
2676 #: ../src/guestfs.pod:1377
2678 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2679 "prints out the available groups and whether they are supported by this build "
2680 "of libguestfs. Note however that you have to do C<run> first."
2684 #: ../src/guestfs.pod:1382
2685 msgid "SINGLE CALLS AT COMPILE TIME"
2689 #: ../src/guestfs.pod:1384
2691 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2692 "function, such as:"
2696 #: ../src/guestfs.pod:1387
2699 " #define LIBGUESTFS_HAVE_DD 1\n"
2704 #: ../src/guestfs.pod:1389
2705 msgid "if L</guestfs_dd> is available."
2709 #: ../src/guestfs.pod:1391
2711 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2712 "function is available at compile time, we recommended using build tools such "
2713 "as autoconf or cmake. For example in autotools you could use:"
2717 #: ../src/guestfs.pod:1396
2720 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2721 " AC_CHECK_FUNCS([guestfs_dd])\n"
2726 #: ../src/guestfs.pod:1399
2728 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2733 #: ../src/guestfs.pod:1402
2734 msgid "SINGLE CALLS AT RUN TIME"
2738 #: ../src/guestfs.pod:1404
2740 "Testing at compile time doesn't guarantee that a function really exists in "
2741 "the library. The reason is that you might be dynamically linked against a "
2742 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2743 "This situation unfortunately results in a segmentation fault, which is a "
2744 "shortcoming of the C dynamic linking system itself."
2748 #: ../src/guestfs.pod:1411
2750 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2751 "in this example program (note that you still need the compile time check as "
2756 #: ../src/guestfs.pod:1415
2759 " #include <stdio.h>\n"
2760 " #include <stdlib.h>\n"
2761 " #include <unistd.h>\n"
2762 " #include <dlfcn.h>\n"
2763 " #include <guestfs.h>\n"
2768 #: ../src/guestfs.pod:1421
2773 " #ifdef LIBGUESTFS_HAVE_DD\n"
2775 " int has_function;\n"
2780 #: ../src/guestfs.pod:1427
2783 " /* Test if the function guestfs_dd is really available. */\n"
2784 " dl = dlopen (NULL, RTLD_LAZY);\n"
2786 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2787 " exit (EXIT_FAILURE);\n"
2789 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2795 #: ../src/guestfs.pod:1436
2798 " if (!has_function)\n"
2799 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2801 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2802 " /* Now it's safe to call\n"
2803 " guestfs_dd (g, \"foo\", \"bar\");\n"
2807 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2814 #: ../src/guestfs.pod:1449
2816 "You may think the above is an awful lot of hassle, and it is. There are "
2817 "other ways outside of the C linking system to ensure that this kind of "
2818 "incompatibility never arises, such as using package versioning:"
2822 #: ../src/guestfs.pod:1454
2825 " Requires: libguestfs >= 1.0.80\n"
2830 #: ../src/guestfs.pod:1456
2831 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2835 #: ../src/guestfs.pod:1458
2837 "A recent feature of the API is the introduction of calls which take optional "
2838 "arguments. In C these are declared 3 ways. The main way is as a call which "
2839 "takes variable arguments (ie. C<...>), as in this example:"
2843 #: ../src/guestfs.pod:1463
2846 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2851 #: ../src/guestfs.pod:1465
2853 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2854 "call with no optional arguments specified:"
2858 #: ../src/guestfs.pod:1468
2861 " guestfs_add_drive_opts (g, filename, -1);\n"
2866 #: ../src/guestfs.pod:1470
2867 msgid "With a single optional argument:"
2871 #: ../src/guestfs.pod:1472
2874 " guestfs_add_drive_opts (g, filename,\n"
2875 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2881 #: ../src/guestfs.pod:1476
2886 #: ../src/guestfs.pod:1478
2889 " guestfs_add_drive_opts (g, filename,\n"
2890 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2891 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2897 #: ../src/guestfs.pod:1483
2899 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2904 #: ../src/guestfs.pod:1486
2905 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2909 #: ../src/guestfs.pod:1488
2911 "The second variant has the same name with the suffix C<_va>, which works the "
2912 "same way but takes a C<va_list>. See the C manual for details. For the "
2913 "example function, this is declared:"
2917 #: ../src/guestfs.pod:1492
2920 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2926 #: ../src/guestfs.pod:1495
2927 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2931 #: ../src/guestfs.pod:1497
2933 "The third variant is useful where you need to construct these calls. You "
2934 "pass in a structure where you fill in the optional fields. The structure "
2935 "has a bitmask as the first element which you must set to indicate which "
2936 "fields you have filled in. For our example function the structure and call "
2941 #: ../src/guestfs.pod:1503
2944 " struct guestfs_add_drive_opts_argv {\n"
2945 " uint64_t bitmask;\n"
2947 " const char *format;\n"
2950 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2951 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2956 #: ../src/guestfs.pod:1512
2957 msgid "You could call it like this:"
2961 #: ../src/guestfs.pod:1514
2964 " struct guestfs_add_drive_opts_argv optargs = {\n"
2965 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2966 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2968 " .format = \"qcow2\"\n"
2974 #: ../src/guestfs.pod:1521
2977 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2982 #: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
2987 #: ../src/guestfs.pod:1529
2988 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2992 #: ../src/guestfs.pod:1534
2993 msgid "You do not need to fill in all fields of the structure."
2997 #: ../src/guestfs.pod:1538
2999 "There must be a one-to-one correspondence between fields of the structure "
3000 "that are filled in, and bits set in the bitmask."
3004 #: ../src/guestfs.pod:1543
3005 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3009 #: ../src/guestfs.pod:1545
3011 "In other languages, optional arguments are expressed in the way that is "
3012 "natural for that language. We refer you to the language-specific "
3013 "documentation for more details on that."
3017 #: ../src/guestfs.pod:1549
3018 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3022 #: ../src/guestfs.pod:1551
3023 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3027 #: ../src/guestfs.pod:1553
3029 "The child process generates events in some situations. Current events "
3030 "include: receiving a log message, the child process exits."
3034 #: ../src/guestfs.pod:1556
3036 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3041 #: ../src/guestfs.pod:1559
3043 "Only I<one callback of each type> can be registered for each handle. "
3044 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3045 "that type. Cancel all callbacks of this type by calling this function with "
3046 "C<cb> set to C<NULL>."
3050 #: ../src/guestfs.pod:1564
3051 msgid "guestfs_set_log_message_callback"
3055 #: ../src/guestfs.pod:1566
3058 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3059 " char *buf, int len);\n"
3060 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3061 " guestfs_log_message_cb cb,\n"
3067 #: ../src/guestfs.pod:1572
3069 "The callback function C<cb> will be called whenever qemu or the guest writes "
3070 "anything to the console."
3074 #: ../src/guestfs.pod:1575
3075 msgid "Use this function to capture kernel messages and similar."
3079 #: ../src/guestfs.pod:1577
3081 "Normally there is no log message handler, and log messages are just "
3086 #: ../src/guestfs.pod:1580
3087 msgid "guestfs_set_subprocess_quit_callback"
3091 #: ../src/guestfs.pod:1582
3094 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3095 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3096 " guestfs_subprocess_quit_cb cb,\n"
3102 #: ../src/guestfs.pod:1587
3104 "The callback function C<cb> will be called when the child process quits, "
3105 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3106 "corresponds to a transition from any state to the CONFIG state)."
3110 #: ../src/guestfs.pod:1592
3111 msgid "guestfs_set_launch_done_callback"
3115 #: ../src/guestfs.pod:1594
3118 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3119 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3120 " guestfs_launch_done_cb cb,\n"
3126 #: ../src/guestfs.pod:1599
3128 "The callback function C<cb> will be called when the child process becomes "
3129 "ready first time after it has been launched. (This corresponds to a "
3130 "transition from LAUNCHING to the READY state)."
3134 #: ../src/guestfs.pod:1603
3135 msgid "guestfs_set_close_callback"
3139 #: ../src/guestfs.pod:1605
3142 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3143 " void guestfs_set_close_callback (guestfs_h *g,\n"
3144 " guestfs_close_cb cb,\n"
3150 #: ../src/guestfs.pod:1610
3152 "The callback function C<cb> will be called while the handle is being closed "
3153 "(synchronously from L</guestfs_close>)."
3157 #: ../src/guestfs.pod:1613
3159 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3160 "handles that are open when the program exits. This means that this callback "
3161 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3162 "problems in higher-level languages (eg. if your HLL interpreter has already "
3163 "been cleaned up by the time this is called, and if your callback then jumps "
3164 "into some HLL function)."
3168 #: ../src/guestfs.pod:1621
3169 msgid "guestfs_set_progress_callback"
3173 #: ../src/guestfs.pod:1623
3176 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3177 " int proc_nr, int serial,\n"
3178 " uint64_t position, uint64_t total);\n"
3179 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3180 " guestfs_progress_cb cb,\n"
3186 #: ../src/guestfs.pod:1630
3188 "Some long-running operations can generate progress messages. If this "
3189 "callback is registered, then it will be called each time a progress message "
3190 "is generated (usually two seconds after the operation started, and three "
3191 "times per second thereafter until it completes, although the frequency may "
3192 "change in future versions)."
3196 #: ../src/guestfs.pod:1636
3198 "The callback receives two numbers: C<position> and C<total>. The units of "
3199 "C<total> are not defined, although for some operations C<total> may relate "
3200 "in some way to the amount of data to be transferred (eg. in bytes or "
3201 "megabytes), and C<position> may be the portion which has been transferred."
3205 #: ../src/guestfs.pod:1642
3206 msgid "The only defined and stable parts of the API are:"
3210 #: ../src/guestfs.pod:1648
3212 "The callback can display to the user some type of progress bar or indicator "
3213 "which shows the ratio of C<position>:C<total>."
3217 #: ../src/guestfs.pod:1653
3218 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3222 #: ../src/guestfs.pod:1657
3224 "If any progress notification is sent during a call, then a final progress "
3225 "notification is always sent when C<position> = C<total>."
3229 #: ../src/guestfs.pod:1660
3231 "This is to simplify caller code, so callers can easily set the progress "
3232 "indicator to \"100%\" at the end of the operation, without requiring special "
3233 "code to detect this case."
3237 #: ../src/guestfs.pod:1666
3239 "The callback also receives the procedure number and serial number of the "
3240 "call. These are only useful for debugging protocol issues, and the callback "
3241 "can normally ignore them. The callback may want to print these numbers in "
3242 "error messages or debugging messages."
3246 #: ../src/guestfs.pod:1671
3247 msgid "PRIVATE DATA AREA"
3251 #: ../src/guestfs.pod:1673
3253 "You can attach named pieces of private data to the libguestfs handle, and "
3254 "fetch them by name for the lifetime of the handle. This is called the "
3255 "private data area and is only available from the C API."
3259 #: ../src/guestfs.pod:1677
3260 msgid "To attach a named piece of data, use the following call:"
3264 #: ../src/guestfs.pod:1679
3267 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3272 #: ../src/guestfs.pod:1681
3274 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3275 "pointer (which can be C<NULL>). Any previous item with the same name is "
3280 #: ../src/guestfs.pod:1685
3282 "You can use any C<key> you want, but names beginning with an underscore "
3283 "character are reserved for internal libguestfs purposes (for implementing "
3284 "language bindings). It is recommended to prefix the name with some unique "
3285 "string to avoid collisions with other users."
3289 #: ../src/guestfs.pod:1690
3290 msgid "To retrieve the pointer, use:"
3294 #: ../src/guestfs.pod:1692
3297 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3302 #: ../src/guestfs.pod:1694
3304 "This function returns C<NULL> if either no data is found associated with "
3305 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3310 #: ../src/guestfs.pod:1698
3312 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3313 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3314 "all. In particular, libguestfs does I<not> try to free the data when the "
3315 "handle is closed. If the data must be freed, then the caller must either "
3316 "free it before calling L</guestfs_close> or must set up a close callback to "
3317 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3318 "can be registered for a handle)."
3322 #: ../src/guestfs.pod:1706
3324 "The private data area is implemented using a hash table, and should be "
3325 "reasonably efficient for moderate numbers of keys."
3329 #: ../src/guestfs.pod:1709 ../src/guestfs.pod:1714
3334 #: ../src/guestfs.pod:1711
3336 "<!-- old anchor for the next section --> <a "
3337 "name=\"state_machine_and_low_level_event_api\"/>"
3341 #: ../src/guestfs.pod:1716
3342 msgid "ARCHITECTURE"
3346 #: ../src/guestfs.pod:1718
3348 "Internally, libguestfs is implemented by running an appliance (a special "
3349 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3350 "process of the main program."
3354 #: ../src/guestfs.pod:1722
3357 " ___________________\n"
3359 " | main program |\n"
3361 " | | child process / appliance\n"
3362 " | | __________________________\n"
3364 " +-------------------+ RPC | +-----------------+ |\n"
3365 " | libguestfs <--------------------> guestfsd | |\n"
3366 " | | | +-----------------+ |\n"
3367 " \\___________________/ | | Linux kernel | |\n"
3368 " | +--^--------------+ |\n"
3369 " \\_________|________________/\n"
3375 " \\______________/\n"
3380 #: ../src/guestfs.pod:1742
3382 "The library, linked to the main program, creates the child process and hence "
3383 "the appliance in the L</guestfs_launch> function."
3387 #: ../src/guestfs.pod:1745
3389 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3390 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3391 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3392 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3393 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3394 "attached to the qemu process which translates device access by the "
3395 "appliance's Linux kernel into accesses to the image."
3399 #: ../src/guestfs.pod:1754
3401 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3402 "Although the disk image you are attached to might also be used by some "
3403 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3404 "care if both libguestfs's qemu process and your virtual machine are trying "
3405 "to update the disk image at the same time, since these usually results in "
3406 "massive disk corruption)."
3410 #: ../src/guestfs.pod:1761
3411 msgid "STATE MACHINE"
3415 #: ../src/guestfs.pod:1763
3416 msgid "libguestfs uses a state machine to model the child process:"
3420 #: ../src/guestfs.pod:1765
3432 " / | \\ \\ guestfs_launch\n"
3433 " / | _\\__V______\n"
3435 " / | | LAUNCHING |\n"
3436 " / | \\___________/\n"
3438 " / | guestfs_launch\n"
3440 " ______ / __|____V\n"
3441 " / \\ ------> / \\\n"
3442 " | BUSY | | READY |\n"
3443 " \\______/ <------ \\________/\n"
3448 #: ../src/guestfs.pod:1787
3450 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3451 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3452 "(3) alternating between READY and BUSY as commands are issued to, and "
3453 "carried out by, the child process."
3457 #: ../src/guestfs.pod:1792
3459 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3460 "asynchronously at any time (eg. due to some internal error), and that causes "
3461 "the state to transition back to CONFIG."
3465 #: ../src/guestfs.pod:1796
3467 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3468 "issued when in the CONFIG state."
3472 #: ../src/guestfs.pod:1799
3474 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3475 "L</guestfs_launch> blocks until the child process is READY to accept "
3476 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3477 "moves the state from CONFIG to LAUNCHING while it is running."
3481 #: ../src/guestfs.pod:1805
3483 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3484 "state. These API calls block waiting for the command to be carried out "
3485 "(ie. the state to transition to BUSY and then back to READY). There are no "
3486 "non-blocking versions, and no way to issue more than one command per handle "
3491 #: ../src/guestfs.pod:1811
3493 "Finally, the child process sends asynchronous messages back to the main "
3494 "program, such as kernel log messages. You can register a callback to "
3495 "receive these messages."
3499 #: ../src/guestfs.pod:1815
3504 #: ../src/guestfs.pod:1817
3505 msgid "COMMUNICATION PROTOCOL"
3509 #: ../src/guestfs.pod:1819
3511 "Don't rely on using this protocol directly. This section documents how it "
3512 "currently works, but it may change at any time."
3516 #: ../src/guestfs.pod:1822
3518 "The protocol used to talk between the library and the daemon running inside "
3519 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3520 "1014, RFC 1832, RFC 4506)."
3524 #: ../src/guestfs.pod:1826
3526 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3527 "this file is automatically generated)."
3531 #: ../src/guestfs.pod:1829
3533 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3534 "and C<FileOut> parameters, which are handled with very simple request/reply "
3535 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3536 "parameters, which use the same request and reply messages, but they may also "
3537 "be followed by files sent using a chunked encoding."
3541 #: ../src/guestfs.pod:1836
3542 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3546 #: ../src/guestfs.pod:1838
3547 msgid "For ordinary functions, the request message is:"
3551 #: ../src/guestfs.pod:1840
3554 " total length (header + arguments,\n"
3555 " but not including the length word itself)\n"
3556 " struct guestfs_message_header (encoded as XDR)\n"
3557 " struct guestfs_<foo>_args (encoded as XDR)\n"
3562 #: ../src/guestfs.pod:1845
3564 "The total length field allows the daemon to allocate a fixed size buffer "
3565 "into which it slurps the rest of the message. As a result, the total length "
3566 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3567 "effective size of any request is limited to somewhere under this size."
3571 #: ../src/guestfs.pod:1851
3573 "Note also that many functions don't take any arguments, in which case the "
3574 "C<guestfs_I<foo>_args> is completely omitted."
3578 #: ../src/guestfs.pod:1854
3580 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3581 "receiver knows what type of args structure to expect, or none at all."
3585 #: ../src/guestfs.pod:1858
3587 "For functions that take optional arguments, the optional arguments are "
3588 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3589 "arguments. A bitmask in the header indicates which optional arguments are "
3590 "meaningful. The bitmask is also checked to see if it contains bits set "
3591 "which the daemon does not know about (eg. if more optional arguments were "
3592 "added in a later version of the library), and this causes the call to be "
3597 #: ../src/guestfs.pod:1866
3598 msgid "The reply message for ordinary functions is:"
3602 #: ../src/guestfs.pod:1868
3605 " total length (header + ret,\n"
3606 " but not including the length word itself)\n"
3607 " struct guestfs_message_header (encoded as XDR)\n"
3608 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3613 #: ../src/guestfs.pod:1873
3615 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3616 "functions that return no formal return values."
3620 #: ../src/guestfs.pod:1876
3621 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3625 #: ../src/guestfs.pod:1879
3627 "In the case of an error, a flag is set in the header, and the reply message "
3628 "is slightly changed:"
3632 #: ../src/guestfs.pod:1882
3635 " total length (header + error,\n"
3636 " but not including the length word itself)\n"
3637 " struct guestfs_message_header (encoded as XDR)\n"
3638 " struct guestfs_message_error (encoded as XDR)\n"
3643 #: ../src/guestfs.pod:1887
3645 "The C<guestfs_message_error> structure contains the error message as a "
3650 #: ../src/guestfs.pod:1890
3651 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3655 #: ../src/guestfs.pod:1892
3657 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3658 "The normal request message is sent (see above). However this is followed by "
3659 "a sequence of file chunks."
3663 #: ../src/guestfs.pod:1896
3666 " total length (header + arguments,\n"
3667 " but not including the length word itself,\n"
3668 " and not including the chunks)\n"
3669 " struct guestfs_message_header (encoded as XDR)\n"
3670 " struct guestfs_<foo>_args (encoded as XDR)\n"
3671 " sequence of chunks for FileIn param #0\n"
3672 " sequence of chunks for FileIn param #1 etc.\n"
3677 #: ../src/guestfs.pod:1904
3678 msgid "The \"sequence of chunks\" is:"
3682 #: ../src/guestfs.pod:1906
3685 " length of chunk (not including length word itself)\n"
3686 " struct guestfs_chunk (encoded as XDR)\n"
3687 " length of chunk\n"
3688 " struct guestfs_chunk (encoded as XDR)\n"
3690 " length of chunk\n"
3691 " struct guestfs_chunk (with data.data_len == 0)\n"
3696 #: ../src/guestfs.pod:1914
3698 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3699 "is set in the final chunk to indicate either successful completion or early "
3704 #: ../src/guestfs.pod:1918
3706 "At time of writing there are no functions that have more than one FileIn "
3707 "parameter. However this is (theoretically) supported, by sending the "
3708 "sequence of chunks for each FileIn parameter one after another (from left to "
3713 #: ../src/guestfs.pod:1923
3715 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3716 "transfer. The library does this by sending a chunk with a special flag set "
3717 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3718 "RPC, does I<not> send any reply, and goes back to reading the next request."
3722 #: ../src/guestfs.pod:1929
3724 "The daemon may also cancel. It does this by writing a special word "
3725 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3726 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3727 "cancel chunk). The special word is chosen so that even if cancellation "
3728 "happens right at the end of the transfer (after the library has finished "
3729 "writing and has started listening for the reply), the \"spurious\" cancel "
3730 "flag will not be confused with the reply message."
3734 #: ../src/guestfs.pod:1938
3736 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3737 "limit), and also files where the size is not known in advance (eg. from "
3738 "pipes or sockets). However the chunks are rather small "
3739 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3740 "to keep much in memory."
3744 #: ../src/guestfs.pod:1944
3745 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3749 #: ../src/guestfs.pod:1946
3751 "The protocol for FileOut parameters is exactly the same as for FileIn "
3752 "parameters, but with the roles of daemon and library reversed."
3756 #: ../src/guestfs.pod:1949
3759 " total length (header + ret,\n"
3760 " but not including the length word itself,\n"
3761 " and not including the chunks)\n"
3762 " struct guestfs_message_header (encoded as XDR)\n"
3763 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3764 " sequence of chunks for FileOut param #0\n"
3765 " sequence of chunks for FileOut param #1 etc.\n"
3770 #: ../src/guestfs.pod:1957
3771 msgid "INITIAL MESSAGE"
3775 #: ../src/guestfs.pod:1959
3777 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3778 "which indicates that the guest and daemon is alive. This is what "
3779 "L</guestfs_launch> waits for."
3783 #: ../src/guestfs.pod:1963
3784 msgid "PROGRESS NOTIFICATION MESSAGES"
3788 #: ../src/guestfs.pod:1965
3790 "The daemon may send progress notification messages at any time. These are "
3791 "distinguished by the normal length word being replaced by "
3792 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3796 #: ../src/guestfs.pod:1969
3798 "The library turns them into progress callbacks (see "
3799 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3800 "discards them if not."
3804 #: ../src/guestfs.pod:1973
3806 "The daemon self-limits the frequency of progress messages it sends (see "
3807 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3812 #: ../src/guestfs.pod:1977
3813 msgid "LIBGUESTFS VERSION NUMBERS"
3817 #: ../src/guestfs.pod:1979
3819 "Since April 2010, libguestfs has started to make separate development and "
3820 "stable releases, along with corresponding branches in our git repository. "
3821 "These separate releases can be identified by version number:"
3825 #: ../src/guestfs.pod:1984
3828 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3829 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3835 " | `-------- sub-version\n"
3837 " `------ always '1' because we don't change the ABI\n"
3842 #: ../src/guestfs.pod:1995
3843 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3847 #: ../src/guestfs.pod:1997
3849 "As time passes we cherry pick fixes from the development branch and backport "
3850 "those into the stable branch, the effect being that the stable branch should "
3851 "get more stable and less buggy over time. So the stable releases are ideal "
3852 "for people who don't need new features but would just like the software to "
3857 #: ../src/guestfs.pod:2003
3858 msgid "Our criteria for backporting changes are:"
3862 #: ../src/guestfs.pod:2009
3864 "Documentation changes which don't affect any code are backported unless the "
3865 "documentation refers to a future feature which is not in stable."
3869 #: ../src/guestfs.pod:2015
3871 "Bug fixes which are not controversial, fix obvious problems, and have been "
3872 "well tested are backported."
3876 #: ../src/guestfs.pod:2020
3878 "Simple rearrangements of code which shouldn't affect how it works get "
3879 "backported. This is so that the code in the two branches doesn't get too "
3880 "far out of step, allowing us to backport future fixes more easily."
3884 #: ../src/guestfs.pod:2026
3886 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3887 "exceptional case: the new feature is required in order to implement an "
3888 "important bug fix."
3892 #: ../src/guestfs.pod:2032
3894 "A new stable branch starts when we think the new features in development are "
3895 "substantial and compelling enough over the current stable branch to warrant "
3896 "it. When that happens we create new stable and development versions 1.N.0 "
3897 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3898 "stable at this point, but by backporting fixes from development, that branch "
3899 "will stabilize over time."
3903 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3904 msgid "ENVIRONMENT VARIABLES"
3908 #: ../src/guestfs.pod:2044 ../fish/guestfish.pod:941
3909 msgid "LIBGUESTFS_APPEND"
3913 #: ../src/guestfs.pod:2046 ../fish/guestfish.pod:943
3914 msgid "Pass additional options to the guest kernel."
3918 #: ../src/guestfs.pod:2048 ../fish/guestfish.pod:945
3919 msgid "LIBGUESTFS_DEBUG"
3923 #: ../src/guestfs.pod:2050
3925 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3926 "effect as calling C<guestfs_set_verbose (g, 1)>."
3930 #: ../src/guestfs.pod:2053 ../fish/guestfish.pod:950
3931 msgid "LIBGUESTFS_MEMSIZE"
3935 #: ../src/guestfs.pod:2055 ../fish/guestfish.pod:952
3936 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3940 #: ../src/guestfs.pod:2058 ../fish/guestfish.pod:955
3943 " LIBGUESTFS_MEMSIZE=700\n"
3948 #: ../src/guestfs.pod:2060 ../fish/guestfish.pod:957
3949 msgid "LIBGUESTFS_PATH"
3953 #: ../src/guestfs.pod:2062
3955 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3956 "the discussion of paths in section PATH above."
3960 #: ../src/guestfs.pod:2065 ../fish/guestfish.pod:962
3961 msgid "LIBGUESTFS_QEMU"
3965 #: ../src/guestfs.pod:2067 ../fish/guestfish.pod:964
3967 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3968 "which was found at compile time by the configure script is used."
3972 #: ../src/guestfs.pod:2071
3973 msgid "See also L</QEMU WRAPPERS> above."
3977 #: ../src/guestfs.pod:2073 ../fish/guestfish.pod:968
3978 msgid "LIBGUESTFS_TRACE"
3982 #: ../src/guestfs.pod:2075
3984 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3985 "effect as calling C<guestfs_set_trace (g, 1)>."
3989 #: ../src/guestfs.pod:2078 ../fish/guestfish.pod:977
3994 #: ../src/guestfs.pod:2080 ../fish/guestfish.pod:979
3995 msgid "Location of temporary directory, defaults to C</tmp>."
3999 #: ../src/guestfs.pod:2082 ../fish/guestfish.pod:981
4001 "If libguestfs was compiled to use the supermin appliance then the real "
4002 "appliance is cached in this directory, shared between all handles belonging "
4003 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4004 "use in case C</tmp> is not large enough."
4008 #: ../src/guestfs.pod:2090 ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
4013 #: ../src/guestfs.pod:2092
4015 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4016 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4017 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4018 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4019 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4020 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4021 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4025 #: ../src/guestfs.pod:2115
4027 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4028 "L<lvm(8)>, L<disktype(1)>."
4032 #: ../src/guestfs.pod:2122 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
4037 #: ../src/guestfs.pod:2124
4038 msgid "To get a list of bugs against libguestfs use this link:"
4042 #: ../src/guestfs.pod:2126
4043 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4047 #: ../src/guestfs.pod:2128
4048 msgid "To report a new bug against libguestfs use this link:"
4052 #: ../src/guestfs.pod:2130
4053 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4057 #: ../src/guestfs.pod:2132
4058 msgid "When reporting a bug, please check:"
4062 #: ../src/guestfs.pod:2138
4063 msgid "That the bug hasn't been reported already."
4067 #: ../src/guestfs.pod:2142
4068 msgid "That you are testing a recent version."
4072 #: ../src/guestfs.pod:2146
4073 msgid "Describe the bug accurately, and give a way to reproduce it."
4077 #: ../src/guestfs.pod:2150
4079 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4084 #: ../src/guestfs.pod:2155 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4089 #: ../src/guestfs.pod:2157 ../fish/guestfish.pod:1060 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4090 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4094 #: ../src/guestfs.pod:2159 ../fish/guestfish.pod:1062 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
4099 #: ../src/guestfs.pod:2161 ../fish/guestfish.pod:1064 ../fuse/guestmount.pod:250
4100 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4104 #: ../src/guestfs.pod:2164
4106 "This library is free software; you can redistribute it and/or modify it "
4107 "under the terms of the GNU Lesser General Public License as published by the "
4108 "Free Software Foundation; either version 2 of the License, or (at your "
4109 "option) any later version."
4113 #: ../src/guestfs.pod:2169
4115 "This library is distributed in the hope that it will be useful, but WITHOUT "
4116 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4117 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4122 #: ../src/guestfs.pod:2174
4124 "You should have received a copy of the GNU Lesser General Public License "
4125 "along with this library; if not, write to the Free Software Foundation, "
4126 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4130 #: ../src/guestfs-actions.pod:1
4131 msgid "guestfs_add_cdrom"
4135 #: ../src/guestfs-actions.pod:3
4139 " guestfs_add_cdrom (guestfs_h *g,\n"
4140 " const char *filename);\n"
4145 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4146 msgid "This function adds a virtual CD-ROM disk image to the guest."
4150 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4151 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4155 #: ../src/guestfs-actions.pod:17
4157 "This call checks for the existence of C<filename>. This stops you from "
4158 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4159 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4164 #: ../src/guestfs-actions.pod:24
4166 "If you just want to add an ISO file (often you use this as an efficient way "
4167 "to transfer large files into the guest), then you should probably use "
4168 "C<guestfs_add_drive_ro> instead."
4172 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3229 ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3446 ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3538 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3578 ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3633 ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3671 ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3928 ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4010 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4044 ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4239 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4308 ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4365 ../src/guestfs-actions.pod:4380 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4567 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:4778 ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4875 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:4990 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5377 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5507 ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5565 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5601 ../src/guestfs-actions.pod:5629 ../src/guestfs-actions.pod:5653 ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5696 ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6133 ../src/guestfs-actions.pod:6146 ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:6312 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6382 ../src/guestfs-actions.pod:6423 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6454 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6743 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6875 ../src/guestfs-actions.pod:6901 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6986 ../src/guestfs-actions.pod:7015
4173 msgid "This function returns 0 on success or -1 on error."
4177 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242 ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4179 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4184 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:245 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2778 ../fish/guestfish-actions.pod:4580 ../fish/guestfish-actions.pod:4677
4186 "Deprecated functions will not be removed from the API, but the fact that "
4187 "they are deprecated indicates that there are problems with correct use of "
4192 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:130 ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:4417 ../src/guestfs-actions.pod:5486 ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:6176 ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6823
4193 msgid "(Added in 0.3)"
4197 #: ../src/guestfs-actions.pod:41
4198 msgid "guestfs_add_domain"
4202 #: ../src/guestfs-actions.pod:43
4206 " guestfs_add_domain (guestfs_h *g,\n"
4207 " const char *dom,\n"
4213 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:139 ../src/guestfs-actions.pod:4143
4215 "You may supply a list of optional arguments to this call. Use zero or more "
4216 "of the following pairs of parameters, and terminate the list with C<-1> on "
4217 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4221 #: ../src/guestfs-actions.pod:53
4224 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4225 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4226 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4231 #: ../src/guestfs-actions.pod:57
4233 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4234 "It works by connecting to libvirt, requesting the domain and domain XML from "
4235 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4240 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4242 "The number of disks added is returned. This operation is atomic: if an "
4243 "error is returned, then no disks are added."
4247 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4249 "This function does some minimal checks to make sure the libvirt domain is "
4250 "not running (unless C<readonly> is true). In a future version we will try "
4251 "to acquire the libvirt lock on each disk."
4255 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4257 "Disks must be accessible locally. This often means that adding disks from a "
4258 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4259 "unless those disks are accessible via the same device path locally too."
4263 #: ../src/guestfs-actions.pod:74
4265 "The optional C<libvirturi> parameter sets the libvirt URI (see "
4266 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
4267 "default libvirt URI (or one set through an environment variable, see the "
4268 "libvirt documentation for full details). If you are using the C API "
4269 "directly then it is more flexible to create the libvirt connection object "
4270 "yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
4274 #: ../src/guestfs-actions.pod:82
4276 "The other optional parameters are passed directly through to "
4277 "C<guestfs_add_drive_opts>."
4281 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:4553 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:5087 ../src/guestfs-actions.pod:5113 ../src/guestfs-actions.pod:6409 ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6860
4282 msgid "On error this function returns -1."
4286 #: ../src/guestfs-actions.pod:87
4287 msgid "(Added in 1.7.4)"
4291 #: ../src/guestfs-actions.pod:89
4292 msgid "guestfs_add_domain_va"
4296 #: ../src/guestfs-actions.pod:91
4300 " guestfs_add_domain_va (guestfs_h *g,\n"
4301 " const char *dom,\n"
4307 #: ../src/guestfs-actions.pod:96
4308 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4312 #: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109 ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4192
4313 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4317 #: ../src/guestfs-actions.pod:100
4318 msgid "guestfs_add_domain_argv"
4322 #: ../src/guestfs-actions.pod:102
4326 " guestfs_add_domain_argv (guestfs_h *g,\n"
4327 " const char *dom,\n"
4328 " const struct guestfs_add_domain_argv *optargs);\n"
4333 #: ../src/guestfs-actions.pod:107
4334 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4338 #: ../src/guestfs-actions.pod:111
4339 msgid "guestfs_add_drive"
4343 #: ../src/guestfs-actions.pod:113
4347 " guestfs_add_drive (guestfs_h *g,\n"
4348 " const char *filename);\n"
4353 #: ../src/guestfs-actions.pod:117
4355 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4356 "optional parameters, so the disk is added writable, with the format being "
4357 "detected automatically."
4361 #: ../src/guestfs-actions.pod:121
4363 "Automatic detection of the format opens you up to a potential security hole "
4364 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4365 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4366 "you should think about replacing calls to this function with calls to "
4367 "C<guestfs_add_drive_opts>, and specifying the format."
4371 #: ../src/guestfs-actions.pod:132
4372 msgid "guestfs_add_drive_opts"
4376 #: ../src/guestfs-actions.pod:134
4380 " guestfs_add_drive_opts (guestfs_h *g,\n"
4381 " const char *filename,\n"
4387 #: ../src/guestfs-actions.pod:144
4390 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4391 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4392 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4397 #: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92
4399 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4400 "The first time you call this function, the disk appears as C</dev/sda>, the "
4401 "second time as C</dev/sdb>, and so on."
4405 #: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97
4407 "You don't necessarily need to be root when using libguestfs. However you "
4408 "obviously do need sufficient permissions to access the filename for whatever "
4409 "operations you want to perform (ie. read access if you just want to read the "
4410 "image or write access if you want to modify the image)."
4414 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103
4415 msgid "This call checks that C<filename> exists."
4419 #: ../src/guestfs-actions.pod:161 ../src/guestfs-actions.pod:4153 ../fish/guestfish-actions.pod:105 ../fish/guestfish-actions.pod:2789
4420 msgid "The optional arguments are:"
4424 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
4429 #: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111
4431 "If true then the image is treated as read-only. Writes are still allowed, "
4432 "but they are stored in a temporary snapshot overlay which is discarded at "
4433 "the end. The disk that you add is not modified."
4437 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115
4442 #: ../src/guestfs-actions.pod:173
4444 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4445 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4446 "Possible formats include C<raw> and C<qcow2>."
4450 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:121
4452 "Automatic detection of the format opens you up to a potential security hole "
4453 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4454 "RHBZ#642934. Specifying the format closes this security hole."
4458 #: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126
4463 #: ../src/guestfs-actions.pod:184
4465 "This rarely-used option lets you emulate the behaviour of the deprecated "
4466 "C<guestfs_add_drive_with_if> call (q.v.)"
4470 #: ../src/guestfs-actions.pod:191
4471 msgid "(Added in 1.5.23)"
4475 #: ../src/guestfs-actions.pod:193
4476 msgid "guestfs_add_drive_opts_va"
4480 #: ../src/guestfs-actions.pod:195
4484 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4485 " const char *filename,\n"
4491 #: ../src/guestfs-actions.pod:200
4492 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4496 #: ../src/guestfs-actions.pod:204
4497 msgid "guestfs_add_drive_opts_argv"
4501 #: ../src/guestfs-actions.pod:206
4505 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4506 " const char *filename,\n"
4507 " const struct guestfs_add_drive_opts_argv "
4513 #: ../src/guestfs-actions.pod:211
4514 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4518 #: ../src/guestfs-actions.pod:215
4519 msgid "guestfs_add_drive_ro"
4523 #: ../src/guestfs-actions.pod:217
4527 " guestfs_add_drive_ro (guestfs_h *g,\n"
4528 " const char *filename);\n"
4533 #: ../src/guestfs-actions.pod:221
4535 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4536 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4537 "disk is added read-only, with the format being detected automatically."
4541 #: ../src/guestfs-actions.pod:228
4542 msgid "(Added in 1.0.38)"
4546 #: ../src/guestfs-actions.pod:230
4547 msgid "guestfs_add_drive_ro_with_if"
4551 #: ../src/guestfs-actions.pod:232
4555 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4556 " const char *filename,\n"
4557 " const char *iface);\n"
4562 #: ../src/guestfs-actions.pod:237
4564 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4565 "QEMU interface emulation to use at run time."
4569 #: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:2305
4570 msgid "(Added in 1.0.84)"
4574 #: ../src/guestfs-actions.pod:251
4575 msgid "guestfs_add_drive_with_if"
4579 #: ../src/guestfs-actions.pod:253
4583 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4584 " const char *filename,\n"
4585 " const char *iface);\n"
4590 #: ../src/guestfs-actions.pod:258
4592 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4593 "QEMU interface emulation to use at run time."
4597 #: ../src/guestfs-actions.pod:272
4598 msgid "guestfs_aug_clear"
4602 #: ../src/guestfs-actions.pod:274
4606 " guestfs_aug_clear (guestfs_h *g,\n"
4607 " const char *augpath);\n"
4612 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178
4614 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4615 "L<augtool(1)> C<clear> command."
4619 #: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085
4620 msgid "(Added in 1.3.4)"
4624 #: ../src/guestfs-actions.pod:285
4625 msgid "guestfs_aug_close"
4629 #: ../src/guestfs-actions.pod:287
4633 " guestfs_aug_close (guestfs_h *g);\n"
4638 #: ../src/guestfs-actions.pod:290
4640 "Close the current Augeas handle and free up any resources used by it. After "
4641 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4642 "any other Augeas functions."
4646 #: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354 ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432 ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537 ../src/guestfs-actions.pod:5164
4647 msgid "(Added in 0.7)"
4651 #: ../src/guestfs-actions.pod:299
4652 msgid "guestfs_aug_defnode"
4656 #: ../src/guestfs-actions.pod:301
4659 " struct guestfs_int_bool *\n"
4660 " guestfs_aug_defnode (guestfs_h *g,\n"
4661 " const char *name,\n"
4662 " const char *expr,\n"
4663 " const char *val);\n"
4668 #: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194
4669 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4673 #: ../src/guestfs-actions.pod:310
4675 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4676 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4677 "containing that single node."
4681 #: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201
4683 "On success this returns a pair containing the number of nodes in the "
4684 "nodeset, and a boolean flag if a node was created."
4688 #: ../src/guestfs-actions.pod:318
4690 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4691 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4695 #: ../src/guestfs-actions.pod:324
4696 msgid "guestfs_aug_defvar"
4700 #: ../src/guestfs-actions.pod:326
4704 " guestfs_aug_defvar (guestfs_h *g,\n"
4705 " const char *name,\n"
4706 " const char *expr);\n"
4711 #: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209
4713 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4714 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4718 #: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213
4720 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4721 "evaluates to something which is not a nodeset."
4725 #: ../src/guestfs-actions.pod:342
4726 msgid "guestfs_aug_get"
4730 #: ../src/guestfs-actions.pod:344
4734 " guestfs_aug_get (guestfs_h *g,\n"
4735 " const char *augpath);\n"
4740 #: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220
4742 "Look up the value associated with C<path>. If C<path> matches exactly one "
4743 "node, the C<value> is returned."
4747 #: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048 ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2270 ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2558 ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2771 ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4699 ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5852 ../src/guestfs-actions.pod:5868 ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6800 ../src/guestfs-actions.pod:7072
4749 "This function returns a string, or NULL on error. I<The caller must free "
4750 "the returned string after use>."
4754 #: ../src/guestfs-actions.pod:356
4755 msgid "guestfs_aug_init"
4759 #: ../src/guestfs-actions.pod:358
4763 " guestfs_aug_init (guestfs_h *g,\n"
4764 " const char *root,\n"
4770 #: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227
4772 "Create a new Augeas handle for editing configuration files. If there was "
4773 "any previous Augeas handle associated with this guestfs session, then it is "
4778 #: ../src/guestfs-actions.pod:367
4779 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4783 #: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234
4784 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4788 #: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237
4790 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4791 "logical I<or> of the following integers:"
4795 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
4796 msgid "C<AUG_SAVE_BACKUP> = 1"
4800 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
4801 msgid "Keep the original file with a C<.augsave> extension."
4805 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
4806 msgid "C<AUG_SAVE_NEWFILE> = 2"
4810 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249
4812 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4813 "original. Overrides C<AUG_SAVE_BACKUP>."
4817 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
4818 msgid "C<AUG_TYPE_CHECK> = 4"
4822 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
4823 msgid "Typecheck lenses (can be expensive)."
4827 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
4828 msgid "C<AUG_NO_STDINC> = 8"
4832 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
4833 msgid "Do not use standard load path for modules."
4837 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
4838 msgid "C<AUG_SAVE_NOOP> = 16"
4842 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
4843 msgid "Make save a no-op, just record what would have been changed."
4847 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264
4848 msgid "C<AUG_NO_LOAD> = 32"
4852 #: ../src/guestfs-actions.pod:402
4853 msgid "Do not load the tree in C<guestfs_aug_init>."
4857 #: ../src/guestfs-actions.pod:406
4858 msgid "To close the handle, you can call C<guestfs_aug_close>."
4862 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272
4863 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4867 #: ../src/guestfs-actions.pod:414
4868 msgid "guestfs_aug_insert"
4872 #: ../src/guestfs-actions.pod:416
4876 " guestfs_aug_insert (guestfs_h *g,\n"
4877 " const char *augpath,\n"
4878 " const char *label,\n"
4884 #: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278
4886 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4887 "or after C<path> (depending on the boolean flag C<before>)."
4891 #: ../src/guestfs-actions.pod:426 ../fish/guestfish-actions.pod:282
4893 "C<path> must match exactly one existing node in the tree, and C<label> must "
4894 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4898 #: ../src/guestfs-actions.pod:434
4899 msgid "guestfs_aug_load"
4903 #: ../src/guestfs-actions.pod:436
4907 " guestfs_aug_load (guestfs_h *g);\n"
4912 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
4913 msgid "Load files into the tree."
4917 #: ../src/guestfs-actions.pod:441 ../fish/guestfish-actions.pod:292
4918 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4922 #: ../src/guestfs-actions.pod:448
4923 msgid "guestfs_aug_ls"
4927 #: ../src/guestfs-actions.pod:450
4931 " guestfs_aug_ls (guestfs_h *g,\n"
4932 " const char *augpath);\n"
4937 #: ../src/guestfs-actions.pod:454
4939 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4940 "sorting the resulting nodes into alphabetical order."
4944 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:1067 ../src/guestfs-actions.pod:1358 ../src/guestfs-actions.pod:1377 ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1499 ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:2166 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:2252 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2372 ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:3005 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6187 ../src/guestfs-actions.pod:6211 ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6713 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6925 ../src/guestfs-actions.pod:6944 ../src/guestfs-actions.pod:7029 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7113
4946 "This function returns a NULL-terminated array of strings (like "
4947 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4948 "strings and the array after use>."
4952 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:992 ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:1415 ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3943 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5367 ../src/guestfs-actions.pod:5379 ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6913
4953 msgid "(Added in 0.8)"
4957 #: ../src/guestfs-actions.pod:463
4958 msgid "guestfs_aug_match"
4962 #: ../src/guestfs-actions.pod:465
4966 " guestfs_aug_match (guestfs_h *g,\n"
4967 " const char *augpath);\n"
4972 #: ../src/guestfs-actions.pod:469 ../fish/guestfish-actions.pod:306
4974 "Returns a list of paths which match the path expression C<path>. The "
4975 "returned paths are sufficiently qualified so that they match exactly one "
4976 "node in the current tree."
4980 #: ../src/guestfs-actions.pod:479
4981 msgid "guestfs_aug_mv"
4985 #: ../src/guestfs-actions.pod:481
4989 " guestfs_aug_mv (guestfs_h *g,\n"
4990 " const char *src,\n"
4991 " const char *dest);\n"
4996 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:314
4998 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4999 "C<dest> is overwritten if it exists."
5003 #: ../src/guestfs-actions.pod:493
5004 msgid "guestfs_aug_rm"
5008 #: ../src/guestfs-actions.pod:495
5012 " guestfs_aug_rm (guestfs_h *g,\n"
5013 " const char *augpath);\n"
5018 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5019 msgid "Remove C<path> and all of its children."
5023 #: ../src/guestfs-actions.pod:501 ../fish/guestfish-actions.pod:323
5024 msgid "On success this returns the number of entries which were removed."
5028 #: ../src/guestfs-actions.pod:507
5029 msgid "guestfs_aug_save"
5033 #: ../src/guestfs-actions.pod:509
5037 " guestfs_aug_save (guestfs_h *g);\n"
5042 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:329
5043 msgid "This writes all pending changes to disk."
5047 #: ../src/guestfs-actions.pod:514
5049 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5054 #: ../src/guestfs-actions.pod:521
5055 msgid "guestfs_aug_set"
5059 #: ../src/guestfs-actions.pod:523
5063 " guestfs_aug_set (guestfs_h *g,\n"
5064 " const char *augpath,\n"
5065 " const char *val);\n"
5070 #: ../src/guestfs-actions.pod:528 ../fish/guestfish-actions.pod:338
5071 msgid "Set the value associated with C<path> to C<val>."
5075 #: ../src/guestfs-actions.pod:530
5077 "In the Augeas API, it is possible to clear a node by setting the value to "
5078 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5079 "this call. Instead you must use the C<guestfs_aug_clear> call."
5083 #: ../src/guestfs-actions.pod:539
5084 msgid "guestfs_available"
5088 #: ../src/guestfs-actions.pod:541
5092 " guestfs_available (guestfs_h *g,\n"
5093 " char *const *groups);\n"
5098 #: ../src/guestfs-actions.pod:545 ../fish/guestfish-actions.pod:349
5100 "This command is used to check the availability of some groups of "
5101 "functionality in the appliance, which not all builds of the libguestfs "
5102 "appliance will be able to provide."
5106 #: ../src/guestfs-actions.pod:549
5108 "The libguestfs groups, and the functions that those groups correspond to, "
5109 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5110 "runtime by calling C<guestfs_available_all_groups>."
5114 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:358
5116 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5117 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5118 "and Augeas (configuration file editing) functions."
5122 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5123 msgid "The command returns no error if I<all> requested groups are available."
5127 #: ../src/guestfs-actions.pod:561 ../fish/guestfish-actions.pod:365
5129 "It fails with an error if one or more of the requested groups is unavailable "
5134 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5136 "If an unknown group name is included in the list of groups then an error is "
5141 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5146 #: ../src/guestfs-actions.pod:573
5147 msgid "You must call C<guestfs_launch> before calling this function."
5151 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:379
5153 "The reason is because we don't know what groups are supported by the "
5154 "appliance/daemon until it is running and can be queried."
5158 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:385
5160 "If a group of functions is available, this does not necessarily mean that "
5161 "they will work. You still have to check for errors when calling individual "
5162 "API functions even if they are available."
5166 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:392
5168 "It is usually the job of distro packagers to build complete functionality "
5169 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5170 "with all requirements satisfied, will support everything."
5174 #: ../src/guestfs-actions.pod:595
5176 "This call was added in version C<1.0.80>. In previous versions of "
5177 "libguestfs all you could do would be to speculatively execute a command to "
5178 "find out if the daemon implemented it. See also C<guestfs_version>."
5182 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1165
5183 msgid "(Added in 1.0.80)"
5187 #: ../src/guestfs-actions.pod:606
5188 msgid "guestfs_available_all_groups"
5192 #: ../src/guestfs-actions.pod:608
5196 " guestfs_available_all_groups (guestfs_h *g);\n"
5201 #: ../src/guestfs-actions.pod:611
5203 "This command returns a list of all optional groups that this daemon knows "
5204 "about. Note this returns both supported and unsupported groups. To find "
5205 "out which ones the daemon can actually support you have to call "
5206 "C<guestfs_available> on each member of the returned list."
5210 #: ../src/guestfs-actions.pod:617
5211 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5215 #: ../src/guestfs-actions.pod:623
5216 msgid "(Added in 1.3.15)"
5220 #: ../src/guestfs-actions.pod:625
5221 msgid "guestfs_base64_in"
5225 #: ../src/guestfs-actions.pod:627
5229 " guestfs_base64_in (guestfs_h *g,\n"
5230 " const char *base64file,\n"
5231 " const char *filename);\n"
5236 #: ../src/guestfs-actions.pod:632 ../fish/guestfish-actions.pod:422
5237 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
5241 #: ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:651
5242 msgid "(Added in 1.3.5)"
5246 #: ../src/guestfs-actions.pod:639
5247 msgid "guestfs_base64_out"
5251 #: ../src/guestfs-actions.pod:641
5255 " guestfs_base64_out (guestfs_h *g,\n"
5256 " const char *filename,\n"
5257 " const char *base64file);\n"
5262 #: ../src/guestfs-actions.pod:646 ../fish/guestfish-actions.pod:431
5264 "This command downloads the contents of C<filename>, writing it out to local "
5265 "file C<base64file> encoded as base64."
5269 #: ../src/guestfs-actions.pod:653
5270 msgid "guestfs_blockdev_flushbufs"
5274 #: ../src/guestfs-actions.pod:655
5278 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5279 " const char *device);\n"
5284 #: ../src/guestfs-actions.pod:659 ../fish/guestfish-actions.pod:440
5285 msgid "This tells the kernel to flush internal buffers associated with C<device>."
5289 #: ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498 ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5290 msgid "This uses the L<blockdev(8)> command."
5294 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:714 ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:751 ../src/guestfs-actions.pod:765 ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:797 ../src/guestfs-actions.pod:811
5295 msgid "(Added in 0.9.3)"
5299 #: ../src/guestfs-actions.pod:668
5300 msgid "guestfs_blockdev_getbsz"
5304 #: ../src/guestfs-actions.pod:670
5308 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5309 " const char *device);\n"
5314 #: ../src/guestfs-actions.pod:674 ../fish/guestfish-actions.pod:449
5315 msgid "This returns the block size of a device."
5319 #: ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:776 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5321 "(Note this is different from both I<size in blocks> and I<filesystem block "
5326 #: ../src/guestfs-actions.pod:685
5327 msgid "guestfs_blockdev_getro"
5331 #: ../src/guestfs-actions.pod:687
5335 " guestfs_blockdev_getro (guestfs_h *g,\n"
5336 " const char *device);\n"
5341 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:460
5343 "Returns a boolean indicating if the block device is read-only (true if "
5344 "read-only, false if not)."
5348 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3036 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3096 ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3153 ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3183 ../src/guestfs-actions.pod:4663
5349 msgid "This function returns a C truth value on success or -1 on error."
5353 #: ../src/guestfs-actions.pod:700
5354 msgid "guestfs_blockdev_getsize64"
5358 #: ../src/guestfs-actions.pod:702
5362 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5363 " const char *device);\n"
5368 #: ../src/guestfs-actions.pod:706 ../fish/guestfish-actions.pod:469
5369 msgid "This returns the size of the device in bytes."
5373 #: ../src/guestfs-actions.pod:708
5374 msgid "See also C<guestfs_blockdev_getsz>."
5378 #: ../src/guestfs-actions.pod:716
5379 msgid "guestfs_blockdev_getss"
5383 #: ../src/guestfs-actions.pod:718
5387 " guestfs_blockdev_getss (guestfs_h *g,\n"
5388 " const char *device);\n"
5393 #: ../src/guestfs-actions.pod:722 ../fish/guestfish-actions.pod:479
5395 "This returns the size of sectors on a block device. Usually 512, but can be "
5396 "larger for modern devices."
5400 #: ../src/guestfs-actions.pod:725
5402 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5407 #: ../src/guestfs-actions.pod:734
5408 msgid "guestfs_blockdev_getsz"
5412 #: ../src/guestfs-actions.pod:736
5416 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5417 " const char *device);\n"
5422 #: ../src/guestfs-actions.pod:740 ../fish/guestfish-actions.pod:491
5424 "This returns the size of the device in units of 512-byte sectors (even if "
5425 "the sectorsize isn't 512 bytes ... weird)."
5429 #: ../src/guestfs-actions.pod:743
5431 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5432 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5436 #: ../src/guestfs-actions.pod:753
5437 msgid "guestfs_blockdev_rereadpt"
5441 #: ../src/guestfs-actions.pod:755
5445 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5446 " const char *device);\n"
5451 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:504
5452 msgid "Reread the partition table on C<device>."
5456 #: ../src/guestfs-actions.pod:767
5457 msgid "guestfs_blockdev_setbsz"
5461 #: ../src/guestfs-actions.pod:769
5465 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5466 " const char *device,\n"
5467 " int blocksize);\n"
5472 #: ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:512
5473 msgid "This sets the block size of a device."
5477 #: ../src/guestfs-actions.pod:785
5478 msgid "guestfs_blockdev_setro"
5482 #: ../src/guestfs-actions.pod:787
5486 " guestfs_blockdev_setro (guestfs_h *g,\n"
5487 " const char *device);\n"
5492 #: ../src/guestfs-actions.pod:791 ../fish/guestfish-actions.pod:523
5493 msgid "Sets the block device named C<device> to read-only."
5497 #: ../src/guestfs-actions.pod:799
5498 msgid "guestfs_blockdev_setrw"
5502 #: ../src/guestfs-actions.pod:801
5506 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5507 " const char *device);\n"
5512 #: ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:531
5513 msgid "Sets the block device named C<device> to read-write."
5517 #: ../src/guestfs-actions.pod:813
5518 msgid "guestfs_case_sensitive_path"
5522 #: ../src/guestfs-actions.pod:815
5526 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5527 " const char *path);\n"
5532 #: ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:539
5534 "This can be used to resolve case insensitive paths on a filesystem which is "
5535 "case sensitive. The use case is to resolve paths which you have read from "
5536 "Windows configuration files or the Windows Registry, to the true path."
5540 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:544
5542 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5543 "(and probably others), which is that although the underlying filesystem is "
5544 "case-insensitive, the driver exports the filesystem to Linux as "
5549 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:549
5551 "One consequence of this is that special directories such as C<c:\\windows> "
5552 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5553 "precise details of how they were created. In Windows itself this would not "
5558 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:555
5560 "Bug or feature? You decide: "
5561 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5565 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
5567 "This function resolves the true case of each element in the path and returns "
5568 "the case-sensitive path."
5572 #: ../src/guestfs-actions.pod:841
5574 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5575 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5576 "how the directories were originally created under Windows)."
5580 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:566
5581 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5585 #: ../src/guestfs-actions.pod:849
5586 msgid "See also C<guestfs_realpath>."
5590 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:6605
5591 msgid "(Added in 1.0.75)"
5595 #: ../src/guestfs-actions.pod:856
5600 #: ../src/guestfs-actions.pod:858
5604 " guestfs_cat (guestfs_h *g,\n"
5605 " const char *path);\n"
5610 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3424
5611 msgid "Return the contents of the file named C<path>."
5615 #: ../src/guestfs-actions.pod:864
5617 "Note that this function cannot correctly handle binary files (specifically, "
5618 "files containing C<\\0> character which is treated as end of string). For "
5619 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5620 "functions which have a more complex interface."
5624 #: ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:1051 ../src/guestfs-actions.pod:1071 ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1484 ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:2170 ../src/guestfs-actions.pod:2189 ../src/guestfs-actions.pod:2232 ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2273 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:4932 ../src/guestfs-actions.pod:4958 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:5139 ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6045 ../src/guestfs-actions.pod:6191 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6929 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7052 ../src/guestfs-actions.pod:7098 ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:582 ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729 ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3294 ../fish/guestfish-actions.pod:3309 ../fish/guestfish-actions.pod:3385 ../fish/guestfish-actions.pod:3402 ../fish/guestfish-actions.pod:3417 ../fish/guestfish-actions.pod:4000 ../fish/guestfish-actions.pod:4046 ../fish/guestfish-actions.pod:4131 ../fish/guestfish-actions.pod:4146 ../fish/guestfish-actions.pod:4556 ../fish/guestfish-actions.pod:4574 ../fish/guestfish-actions.pod:4591 ../fish/guestfish-actions.pod:4601 ../fish/guestfish-actions.pod:4649 ../fish/guestfish-actions.pod:4659 ../fish/guestfish-actions.pod:4688 ../fish/guestfish-actions.pod:4698
5626 "Because of the message protocol, there is a transfer limit of somewhere "
5627 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5631 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:3264 ../src/guestfs-actions.pod:3326 ../src/guestfs-actions.pod:3343 ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:5038 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:6764 ../src/guestfs-actions.pod:6778
5632 msgid "(Added in 0.4)"
5636 #: ../src/guestfs-actions.pod:877
5637 msgid "guestfs_checksum"
5641 #: ../src/guestfs-actions.pod:879
5645 " guestfs_checksum (guestfs_h *g,\n"
5646 " const char *csumtype,\n"
5647 " const char *path);\n"
5652 #: ../src/guestfs-actions.pod:884 ../fish/guestfish-actions.pod:589
5653 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5657 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
5659 "The type of checksum to compute is given by the C<csumtype> parameter which "
5660 "must have one of the following values:"
5664 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
5669 #: ../src/guestfs-actions.pod:894 ../fish/guestfish-actions.pod:599
5671 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5676 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
5681 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
5682 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5686 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
5691 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
5692 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5696 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
5701 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
5702 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5706 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
5711 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
5712 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5716 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
5721 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
5722 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5726 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
5731 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:624
5732 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5736 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:628
5737 msgid "The checksum is returned as a printable string."
5741 #: ../src/guestfs-actions.pod:925
5742 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5746 #: ../src/guestfs-actions.pod:927
5747 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5751 #: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3038 ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:6461
5752 msgid "(Added in 1.0.2)"
5756 #: ../src/guestfs-actions.pod:934
5757 msgid "guestfs_checksum_device"
5761 #: ../src/guestfs-actions.pod:936
5765 " guestfs_checksum_device (guestfs_h *g,\n"
5766 " const char *csumtype,\n"
5767 " const char *device);\n"
5772 #: ../src/guestfs-actions.pod:941
5774 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5775 "device named C<device>. For the types of checksums supported see the "
5776 "C<guestfs_checksum> command."
5780 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4859 ../src/guestfs-actions.pod:6370 ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6790
5781 msgid "(Added in 1.3.2)"
5785 #: ../src/guestfs-actions.pod:950
5786 msgid "guestfs_checksums_out"
5790 #: ../src/guestfs-actions.pod:952
5794 " guestfs_checksums_out (guestfs_h *g,\n"
5795 " const char *csumtype,\n"
5796 " const char *directory,\n"
5797 " const char *sumsfile);\n"
5802 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:646
5804 "This command computes the checksums of all regular files in C<directory> and "
5805 "then emits a list of those checksums to the local output file C<sumsfile>."
5809 #: ../src/guestfs-actions.pod:962 ../fish/guestfish-actions.pod:650
5811 "This can be used for verifying the integrity of a virtual machine. However "
5812 "to be properly secure you should pay attention to the output of the checksum "
5813 "command (it uses the ones from GNU coreutils). In particular when the "
5814 "filename is not printable, coreutils uses a special backslash syntax. For "
5815 "more information, see the GNU coreutils info file."
5819 #: ../src/guestfs-actions.pod:972
5820 msgid "(Added in 1.3.7)"
5824 #: ../src/guestfs-actions.pod:974
5825 msgid "guestfs_chmod"
5829 #: ../src/guestfs-actions.pod:976
5833 " guestfs_chmod (guestfs_h *g,\n"
5835 " const char *path);\n"
5840 #: ../src/guestfs-actions.pod:981 ../fish/guestfish-actions.pod:664
5842 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5847 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
5849 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5850 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5855 #: ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4268 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4306 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2869 ../fish/guestfish-actions.pod:2879 ../fish/guestfish-actions.pod:2889
5856 msgid "The mode actually set is affected by the umask."
5860 #: ../src/guestfs-actions.pod:994
5861 msgid "guestfs_chown"
5865 #: ../src/guestfs-actions.pod:996
5869 " guestfs_chown (guestfs_h *g,\n"
5872 " const char *path);\n"
5877 #: ../src/guestfs-actions.pod:1002 ../fish/guestfish-actions.pod:677
5878 msgid "Change the file owner to C<owner> and group to C<group>."
5882 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:3225 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
5884 "Only numeric uid and gid are supported. If you want to use names, you will "
5885 "need to locate and parse the password file yourself (Augeas support makes "
5886 "this relatively easy)."
5890 #: ../src/guestfs-actions.pod:1012
5891 msgid "guestfs_command"
5895 #: ../src/guestfs-actions.pod:1014
5899 " guestfs_command (guestfs_h *g,\n"
5900 " char *const *arguments);\n"
5905 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:687
5907 "This call runs a command from the guest filesystem. The filesystem must be "
5908 "mounted, and must contain a compatible operating system (ie. something "
5909 "Linux, with the same or compatible processor architecture)."
5913 #: ../src/guestfs-actions.pod:1023
5915 "The single parameter is an argv-style list of arguments. The first element "
5916 "is the name of the program to run. Subsequent elements are parameters. The "
5917 "list must be non-empty (ie. must contain a program name). Note that the "
5918 "command runs directly, and is I<not> invoked via the shell (see "
5923 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:699
5924 msgid "The return value is anything printed to I<stdout> by the command."
5928 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
5930 "If the command returns a non-zero exit status, then this function returns an "
5931 "error message. The error message string is the content of I<stderr> from "
5936 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:706
5938 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5939 "C</bin>. If you require a program from another location, you should provide "
5940 "the full path in the first parameter."
5944 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:711
5946 "Shared libraries and data files required by the program must be available on "
5947 "filesystems which are mounted in the correct places. It is the caller's "
5948 "responsibility to ensure all filesystems that are needed are mounted at the "
5953 #: ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1537
5954 msgid "(Added in 0.9.1)"
5958 #: ../src/guestfs-actions.pod:1056
5959 msgid "guestfs_command_lines"
5963 #: ../src/guestfs-actions.pod:1058
5967 " guestfs_command_lines (guestfs_h *g,\n"
5968 " char *const *arguments);\n"
5973 #: ../src/guestfs-actions.pod:1062
5975 "This is the same as C<guestfs_command>, but splits the result into a list of "
5980 #: ../src/guestfs-actions.pod:1065
5981 msgid "See also: C<guestfs_sh_lines>"
5985 #: ../src/guestfs-actions.pod:1076
5986 msgid "guestfs_config"
5990 #: ../src/guestfs-actions.pod:1078
5994 " guestfs_config (guestfs_h *g,\n"
5995 " const char *qemuparam,\n"
5996 " const char *qemuvalue);\n"
6001 #: ../src/guestfs-actions.pod:1083 ../fish/guestfish-actions.pod:736
6003 "This can be used to add arbitrary qemu command line parameters of the form "
6004 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6005 "setting some parameters which would interfere with parameters that we use."
6009 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6010 msgid "The first character of C<param> string must be a C<-> (dash)."
6014 #: ../src/guestfs-actions.pod:1090 ../fish/guestfish-actions.pod:743
6015 msgid "C<value> can be NULL."
6019 #: ../src/guestfs-actions.pod:1096
6020 msgid "guestfs_copy_size"
6024 #: ../src/guestfs-actions.pod:1098
6028 " guestfs_copy_size (guestfs_h *g,\n"
6029 " const char *src,\n"
6030 " const char *dest,\n"
6036 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:749
6038 "This command copies exactly C<size> bytes from one source device or file "
6039 "C<src> to another destination device or file C<dest>."
6043 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6045 "Note this will fail if the source is too short or if the destination is not "
6050 #: ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6490 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6988
6052 "This long-running command can generate progress notification messages so "
6053 "that the caller can display a progress bar or indicator. To receive these "
6054 "messages, the caller must register a progress callback. See "
6055 "L<guestfs(3)/guestfs_set_progress_callback>."
6059 #: ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:5065 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6803
6060 msgid "(Added in 1.0.87)"
6064 #: ../src/guestfs-actions.pod:1119
6069 #: ../src/guestfs-actions.pod:1121
6073 " guestfs_cp (guestfs_h *g,\n"
6074 " const char *src,\n"
6075 " const char *dest);\n"
6080 #: ../src/guestfs-actions.pod:1126 ../fish/guestfish-actions.pod:759
6082 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6083 "destination filename or destination directory."
6087 #: ../src/guestfs-actions.pod:1131 ../src/guestfs-actions.pod:1145 ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1291 ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4909
6088 msgid "(Added in 1.0.18)"
6092 #: ../src/guestfs-actions.pod:1133
6093 msgid "guestfs_cp_a"
6097 #: ../src/guestfs-actions.pod:1135
6101 " guestfs_cp_a (guestfs_h *g,\n"
6102 " const char *src,\n"
6103 " const char *dest);\n"
6108 #: ../src/guestfs-actions.pod:1140 ../fish/guestfish-actions.pod:766
6110 "This copies a file or directory from C<src> to C<dest> recursively using the "
6115 #: ../src/guestfs-actions.pod:1147
6120 #: ../src/guestfs-actions.pod:1149
6124 " guestfs_dd (guestfs_h *g,\n"
6125 " const char *src,\n"
6126 " const char *dest);\n"
6131 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:773
6133 "This command copies from one source device or file C<src> to another "
6134 "destination device or file C<dest>. Normally you would use this to copy to "
6135 "or from a device or partition, for example to duplicate a filesystem."
6139 #: ../src/guestfs-actions.pod:1159
6141 "If the destination is a device, it must be as large or larger than the "
6142 "source file or device, otherwise the copy will fail. This command cannot do "
6143 "partial copies (see C<guestfs_copy_size>)."
6147 #: ../src/guestfs-actions.pod:1167
6152 #: ../src/guestfs-actions.pod:1169
6156 " guestfs_df (guestfs_h *g);\n"
6161 #: ../src/guestfs-actions.pod:1172 ../fish/guestfish-actions.pod:786
6162 msgid "This command runs the C<df> command to report disk space used."
6166 #: ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6168 "This command is mostly useful for interactive sessions. It is I<not> "
6169 "intended that you try to parse the output string. Use C<statvfs> from "
6174 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:2259 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4432 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6218 ../src/guestfs-actions.pod:6836 ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6862
6175 msgid "(Added in 1.0.54)"
6179 #: ../src/guestfs-actions.pod:1183
6180 msgid "guestfs_df_h"
6184 #: ../src/guestfs-actions.pod:1185
6188 " guestfs_df_h (guestfs_h *g);\n"
6193 #: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:796
6195 "This command runs the C<df -h> command to report disk space used in "
6196 "human-readable format."
6200 #: ../src/guestfs-actions.pod:1200
6201 msgid "guestfs_dmesg"
6205 #: ../src/guestfs-actions.pod:1202
6209 " guestfs_dmesg (guestfs_h *g);\n"
6214 #: ../src/guestfs-actions.pod:1205 ../fish/guestfish-actions.pod:807
6216 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6217 "This is sometimes useful for extended debugging of problems."
6221 #: ../src/guestfs-actions.pod:1209
6223 "Another way to get the same information is to enable verbose messages with "
6224 "C<guestfs_set_verbose> or by setting the environment variable "
6225 "C<LIBGUESTFS_DEBUG=1> before running the program."
6229 #: ../src/guestfs-actions.pod:1219
6230 msgid "guestfs_download"
6234 #: ../src/guestfs-actions.pod:1221
6238 " guestfs_download (guestfs_h *g,\n"
6239 " const char *remotefilename,\n"
6240 " const char *filename);\n"
6245 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1251 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6247 "Download file C<remotefilename> and save it as C<filename> on the local "
6252 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4304
6253 msgid "C<filename> can also be a named pipe."
6257 #: ../src/guestfs-actions.pod:1231
6258 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6262 #: ../src/guestfs-actions.pod:1242
6263 msgid "guestfs_download_offset"
6267 #: ../src/guestfs-actions.pod:1244
6271 " guestfs_download_offset (guestfs_h *g,\n"
6272 " const char *remotefilename,\n"
6273 " const char *filename,\n"
6274 " int64_t offset,\n"
6280 #: ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:836
6282 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6283 "region must be within the file or device)."
6287 #: ../src/guestfs-actions.pod:1257
6289 "Note that there is no limit on the amount of data that can be downloaded "
6290 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6291 "full amount unless an error occurs."
6295 #: ../src/guestfs-actions.pod:1262
6296 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6300 #: ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:6495
6301 msgid "(Added in 1.5.17)"
6305 #: ../src/guestfs-actions.pod:1273
6306 msgid "guestfs_drop_caches"
6310 #: ../src/guestfs-actions.pod:1275
6314 " guestfs_drop_caches (guestfs_h *g,\n"
6315 " int whattodrop);\n"
6320 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:852
6322 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6323 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6324 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6328 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
6329 msgid "Setting C<whattodrop> to 3 should drop everything."
6333 #: ../src/guestfs-actions.pod:1286 ../fish/guestfish-actions.pod:859
6335 "This automatically calls L<sync(2)> before the operation, so that the "
6336 "maximum guest memory is freed."
6340 #: ../src/guestfs-actions.pod:1293
6345 #: ../src/guestfs-actions.pod:1295
6349 " guestfs_du (guestfs_h *g,\n"
6350 " const char *path);\n"
6355 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:866
6357 "This command runs the C<du -s> command to estimate file space usage for "
6362 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
6364 "C<path> can be a file or a directory. If C<path> is a directory then the "
6365 "estimate includes the contents of the directory and all subdirectories "
6370 #: ../src/guestfs-actions.pod:1306 ../fish/guestfish-actions.pod:873
6371 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6375 #: ../src/guestfs-actions.pod:1313
6376 msgid "guestfs_e2fsck_f"
6380 #: ../src/guestfs-actions.pod:1315
6384 " guestfs_e2fsck_f (guestfs_h *g,\n"
6385 " const char *device);\n"
6390 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:880
6392 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6393 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6398 #: ../src/guestfs-actions.pod:1323
6400 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6401 "Normally you should use C<guestfs_fsck>."
6405 #: ../src/guestfs-actions.pod:1328
6406 msgid "(Added in 1.0.29)"
6410 #: ../src/guestfs-actions.pod:1330
6411 msgid "guestfs_echo_daemon"
6415 #: ../src/guestfs-actions.pod:1332
6419 " guestfs_echo_daemon (guestfs_h *g,\n"
6420 " char *const *words);\n"
6425 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:891
6427 "This command concatenates the list of C<words> passed with single spaces "
6428 "between them and returns the resulting string."
6432 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
6433 msgid "You can use this command to test the connection through to the daemon."
6437 #: ../src/guestfs-actions.pod:1341
6438 msgid "See also C<guestfs_ping_daemon>."
6442 #: ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:5698
6443 msgid "(Added in 1.0.69)"
6447 #: ../src/guestfs-actions.pod:1348
6448 msgid "guestfs_egrep"
6452 #: ../src/guestfs-actions.pod:1350
6456 " guestfs_egrep (guestfs_h *g,\n"
6457 " const char *regex,\n"
6458 " const char *path);\n"
6463 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:902
6464 msgid "This calls the external C<egrep> program and returns the matching lines."
6468 #: ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1384 ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:2192 ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2361 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2444 ../src/guestfs-actions.pod:2457 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:4367 ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:6062 ../src/guestfs-actions.pod:6074 ../src/guestfs-actions.pod:6087 ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6932 ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:7036 ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7120
6469 msgid "(Added in 1.0.66)"
6473 #: ../src/guestfs-actions.pod:1367
6474 msgid "guestfs_egrepi"
6478 #: ../src/guestfs-actions.pod:1369
6482 " guestfs_egrepi (guestfs_h *g,\n"
6483 " const char *regex,\n"
6484 " const char *path);\n"
6489 #: ../src/guestfs-actions.pod:1374 ../fish/guestfish-actions.pod:912
6490 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6494 #: ../src/guestfs-actions.pod:1386
6495 msgid "guestfs_equal"
6499 #: ../src/guestfs-actions.pod:1388
6503 " guestfs_equal (guestfs_h *g,\n"
6504 " const char *file1,\n"
6505 " const char *file2);\n"
6510 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:922
6512 "This compares the two files C<file1> and C<file2> and returns true if their "
6513 "content is exactly equal, or false otherwise."
6517 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
6518 msgid "The external L<cmp(1)> program is used for the comparison."
6522 #: ../src/guestfs-actions.pod:1402
6523 msgid "guestfs_exists"
6527 #: ../src/guestfs-actions.pod:1404
6531 " guestfs_exists (guestfs_h *g,\n"
6532 " const char *path);\n"
6537 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:931
6539 "This returns C<true> if and only if there is a file, directory (or anything) "
6540 "with the given C<path> name."
6544 #: ../src/guestfs-actions.pod:1411
6545 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6549 #: ../src/guestfs-actions.pod:1417
6550 msgid "guestfs_fallocate"
6554 #: ../src/guestfs-actions.pod:1419
6558 " guestfs_fallocate (guestfs_h *g,\n"
6559 " const char *path,\n"
6565 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6567 "This command preallocates a file (containing zero bytes) named C<path> of "
6568 "size C<len> bytes. If the file exists already, it is overwritten."
6572 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:944
6574 "Do not confuse this with the guestfish-specific C<alloc> command which "
6575 "allocates a file in the host and attaches it as a device."
6579 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:948
6581 "This function is deprecated. In new code, use the C<fallocate64> call "
6586 #: ../src/guestfs-actions.pod:1443
6587 msgid "guestfs_fallocate64"
6591 #: ../src/guestfs-actions.pod:1445
6595 " guestfs_fallocate64 (guestfs_h *g,\n"
6596 " const char *path,\n"
6602 #: ../src/guestfs-actions.pod:1454
6604 "Note that this call allocates disk blocks for the file. To create a sparse "
6605 "file use C<guestfs_truncate_size> instead."
6609 #: ../src/guestfs-actions.pod:1457
6611 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6612 "oversight it only allowed 30 bit lengths to be specified, effectively "
6613 "limiting the maximum size of files created through that call to 1GB."
6617 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:971
6619 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6620 "commands which create a file in the host and attach it as a device."
6624 #: ../src/guestfs-actions.pod:1468
6625 msgid "(Added in 1.3.17)"
6629 #: ../src/guestfs-actions.pod:1470
6630 msgid "guestfs_fgrep"
6634 #: ../src/guestfs-actions.pod:1472
6638 " guestfs_fgrep (guestfs_h *g,\n"
6639 " const char *pattern,\n"
6640 " const char *path);\n"
6645 #: ../src/guestfs-actions.pod:1477 ../fish/guestfish-actions.pod:979
6646 msgid "This calls the external C<fgrep> program and returns the matching lines."
6650 #: ../src/guestfs-actions.pod:1489
6651 msgid "guestfs_fgrepi"
6655 #: ../src/guestfs-actions.pod:1491
6659 " guestfs_fgrepi (guestfs_h *g,\n"
6660 " const char *pattern,\n"
6661 " const char *path);\n"
6666 #: ../src/guestfs-actions.pod:1496 ../fish/guestfish-actions.pod:989
6667 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6671 #: ../src/guestfs-actions.pod:1508
6672 msgid "guestfs_file"
6676 #: ../src/guestfs-actions.pod:1510
6680 " guestfs_file (guestfs_h *g,\n"
6681 " const char *path);\n"
6686 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:999
6688 "This call uses the standard L<file(1)> command to determine the type or "
6689 "contents of the file."
6693 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
6695 "This call will also transparently look inside various types of compressed "
6700 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
6702 "The exact command which runs is C<file -zb path>. Note in particular that "
6703 "the filename is not prepended to the output (the C<-b> option)."
6707 #: ../src/guestfs-actions.pod:1524
6709 "This command can also be used on C</dev/> devices (and partitions, LV "
6710 "names). You can for example use this to determine if a device contains a "
6711 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6715 #: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1014
6717 "If the C<path> does not begin with C</dev/> then this command only works for "
6718 "the content of regular files. For other file types (directory, symbolic "
6719 "link etc) it will just return the string C<directory> etc."
6723 #: ../src/guestfs-actions.pod:1539
6724 msgid "guestfs_file_architecture"
6728 #: ../src/guestfs-actions.pod:1541
6732 " guestfs_file_architecture (guestfs_h *g,\n"
6733 " const char *filename);\n"
6738 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
6740 "This detects the architecture of the binary C<filename>, and returns it if "
6745 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
6746 msgid "Currently defined architectures are:"
6750 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
6755 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
6757 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6758 "irrespective of the precise processor requirements of the binary."
6762 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
6767 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
6768 msgid "64 bit x86-64."
6772 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
6777 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
6778 msgid "32 bit SPARC."
6782 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
6787 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
6788 msgid "64 bit SPARC V9 and above."
6792 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
6797 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
6798 msgid "Intel Itanium."
6802 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
6807 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
6808 msgid "32 bit Power PC."
6812 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
6817 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
6818 msgid "64 bit Power PC."
6822 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
6823 msgid "Libguestfs may return other architecture strings in future."
6827 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
6828 msgid "The function works on at least the following types of files:"
6832 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
6833 msgid "many types of Un*x and Linux binary"
6837 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
6838 msgid "many types of Un*x and Linux shared library"
6842 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
6843 msgid "Windows Win32 and Win64 binaries"
6847 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
6848 msgid "Windows Win32 and Win64 DLLs"
6852 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
6853 msgid "Win32 binaries and DLLs return C<i386>."
6857 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
6858 msgid "Win64 binaries and DLLs return C<x86_64>."
6862 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
6863 msgid "Linux kernel modules"
6867 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
6868 msgid "Linux new-style initrd images"
6872 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
6873 msgid "some non-x86 Linux vmlinuz kernels"
6877 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
6878 msgid "What it can't do currently:"
6882 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
6883 msgid "static libraries (libfoo.a)"
6887 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
6888 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6892 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
6893 msgid "x86 Linux vmlinuz kernels"
6897 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
6899 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6900 "compressed code, and are horribly hard to unpack. If you want to find the "
6901 "architecture of a kernel, use the architecture of the associated initrd or "
6902 "kernel module(s) instead."
6906 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812 ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2587 ../src/guestfs-actions.pod:2636 ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3141
6907 msgid "(Added in 1.5.3)"
6911 #: ../src/guestfs-actions.pod:1651
6912 msgid "guestfs_filesize"
6916 #: ../src/guestfs-actions.pod:1653
6920 " guestfs_filesize (guestfs_h *g,\n"
6921 " const char *file);\n"
6926 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
6927 msgid "This command returns the size of C<file> in bytes."
6931 #: ../src/guestfs-actions.pod:1659
6933 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6934 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6935 "devices, use C<guestfs_blockdev_getsize64>."
6939 #: ../src/guestfs-actions.pod:1665
6940 msgid "(Added in 1.0.82)"
6944 #: ../src/guestfs-actions.pod:1667
6945 msgid "guestfs_fill"
6949 #: ../src/guestfs-actions.pod:1669
6953 " guestfs_fill (guestfs_h *g,\n"
6956 " const char *path);\n"
6961 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
6963 "This command creates a new file called C<path>. The initial content of the "
6964 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6969 #: ../src/guestfs-actions.pod:1679
6971 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6972 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6973 "bytes use C<guestfs_fill_pattern>."
6977 #: ../src/guestfs-actions.pod:1691
6978 msgid "(Added in 1.0.79)"
6982 #: ../src/guestfs-actions.pod:1693
6983 msgid "guestfs_fill_pattern"
6987 #: ../src/guestfs-actions.pod:1695
6991 " guestfs_fill_pattern (guestfs_h *g,\n"
6992 " const char *pattern,\n"
6994 " const char *path);\n"
6999 #: ../src/guestfs-actions.pod:1701
7001 "This function is like C<guestfs_fill> except that it creates a new file of "
7002 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7003 "pattern is truncated if necessary to ensure the length of the file is "
7004 "exactly C<len> bytes."
7008 #: ../src/guestfs-actions.pod:1713
7009 msgid "(Added in 1.3.12)"
7013 #: ../src/guestfs-actions.pod:1715
7014 msgid "guestfs_find"
7018 #: ../src/guestfs-actions.pod:1717
7022 " guestfs_find (guestfs_h *g,\n"
7023 " const char *directory);\n"
7028 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7030 "This command lists out all files and directories, recursively, starting at "
7031 "C<directory>. It is essentially equivalent to running the shell command "
7032 "C<find directory -print> but some post-processing happens on the output, "
7037 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7039 "This returns a list of strings I<without any prefix>. Thus if the directory "
7044 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7054 #: ../src/guestfs-actions.pod:1733
7055 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7059 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7070 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7071 msgid "If C<directory> is not a directory, then this command returns an error."
7075 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7076 msgid "The returned list is sorted."
7080 #: ../src/guestfs-actions.pod:1746
7081 msgid "See also C<guestfs_find0>."
7085 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5327
7086 msgid "(Added in 1.0.27)"
7090 #: ../src/guestfs-actions.pod:1757
7091 msgid "guestfs_find0"
7095 #: ../src/guestfs-actions.pod:1759
7099 " guestfs_find0 (guestfs_h *g,\n"
7100 " const char *directory,\n"
7101 " const char *files);\n"
7106 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7108 "This command lists out all files and directories, recursively, starting at "
7109 "C<directory>, placing the resulting list in the external file called "
7114 #: ../src/guestfs-actions.pod:1768
7116 "This command works the same way as C<guestfs_find> with the following "
7121 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7122 msgid "The resulting list is written to an external file."
7126 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7128 "Items (filenames) in the result are separated by C<\\0> characters. See "
7129 "L<find(1)> option I<-print0>."
7133 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7134 msgid "This command is not limited in the number of names that it can return."
7138 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7139 msgid "The result list is not sorted."
7143 #: ../src/guestfs-actions.pod:1795
7144 msgid "(Added in 1.0.74)"
7148 #: ../src/guestfs-actions.pod:1797
7149 msgid "guestfs_findfs_label"
7153 #: ../src/guestfs-actions.pod:1799
7157 " guestfs_findfs_label (guestfs_h *g,\n"
7158 " const char *label);\n"
7163 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
7165 "This command searches the filesystems and returns the one which has the "
7166 "given label. An error is returned if no such filesystem can be found."
7170 #: ../src/guestfs-actions.pod:1807
7171 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7175 #: ../src/guestfs-actions.pod:1814
7176 msgid "guestfs_findfs_uuid"
7180 #: ../src/guestfs-actions.pod:1816
7184 " guestfs_findfs_uuid (guestfs_h *g,\n"
7185 " const char *uuid);\n"
7190 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
7192 "This command searches the filesystems and returns the one which has the "
7193 "given UUID. An error is returned if no such filesystem can be found."
7197 #: ../src/guestfs-actions.pod:1824
7198 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7202 #: ../src/guestfs-actions.pod:1831
7203 msgid "guestfs_fsck"
7207 #: ../src/guestfs-actions.pod:1833
7211 " guestfs_fsck (guestfs_h *g,\n"
7212 " const char *fstype,\n"
7213 " const char *device);\n"
7218 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
7220 "This runs the filesystem checker (fsck) on C<device> which should have "
7221 "filesystem type C<fstype>."
7225 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
7227 "The returned integer is the status. See L<fsck(8)> for the list of status "
7228 "codes from C<fsck>."
7232 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
7233 msgid "Multiple status codes can be summed together."
7237 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
7239 "A non-zero return code can mean \"success\", for example if errors have been "
7240 "corrected on the filesystem."
7244 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
7245 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7249 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
7250 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7254 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:6974
7255 msgid "(Added in 1.0.16)"
7259 #: ../src/guestfs-actions.pod:1870
7260 msgid "guestfs_get_append"
7264 #: ../src/guestfs-actions.pod:1872
7268 " guestfs_get_append (guestfs_h *g);\n"
7273 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
7275 "Return the additional kernel options which are added to the guest kernel "
7280 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
7281 msgid "If C<NULL> then no options are added."
7285 #: ../src/guestfs-actions.pod:1880
7287 "This function returns a string which may be NULL. There is no way to return "
7288 "an error from this function. The string is owned by the guest handle and "
7289 "must I<not> be freed."
7293 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:5855 ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:6645 ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:7017
7294 msgid "(Added in 1.0.26)"
7298 #: ../src/guestfs-actions.pod:1886
7299 msgid "guestfs_get_autosync"
7303 #: ../src/guestfs-actions.pod:1888
7307 " guestfs_get_autosync (guestfs_h *g);\n"
7312 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
7313 msgid "Get the autosync flag."
7317 #: ../src/guestfs-actions.pod:1897
7318 msgid "guestfs_get_direct"
7322 #: ../src/guestfs-actions.pod:1899
7326 " guestfs_get_direct (guestfs_h *g);\n"
7331 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
7332 msgid "Return the direct appliance mode flag."
7336 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5509
7337 msgid "(Added in 1.0.72)"
7341 #: ../src/guestfs-actions.pod:1908
7342 msgid "guestfs_get_e2label"
7346 #: ../src/guestfs-actions.pod:1910
7350 " guestfs_get_e2label (guestfs_h *g,\n"
7351 " const char *device);\n"
7356 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
7357 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7361 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1305
7363 "This function is deprecated. In new code, use the C<vfs_label> call "
7368 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:5527 ../src/guestfs-actions.pod:5546
7369 msgid "(Added in 1.0.15)"
7373 #: ../src/guestfs-actions.pod:1929
7374 msgid "guestfs_get_e2uuid"
7378 #: ../src/guestfs-actions.pod:1931
7382 " guestfs_get_e2uuid (guestfs_h *g,\n"
7383 " const char *device);\n"
7388 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
7389 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7393 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1319
7394 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7398 #: ../src/guestfs-actions.pod:1950
7399 msgid "guestfs_get_memsize"
7403 #: ../src/guestfs-actions.pod:1952
7407 " guestfs_get_memsize (guestfs_h *g);\n"
7412 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
7413 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7417 #: ../src/guestfs-actions.pod:1958
7419 "If C<guestfs_set_memsize> was not called on this handle, and if "
7420 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7421 "value for memsize."
7425 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5669 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3711 ../fish/guestfish-actions.pod:3798
7426 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7430 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:4272 ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5567 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6411
7431 msgid "(Added in 1.0.55)"
7435 #: ../src/guestfs-actions.pod:1969
7436 msgid "guestfs_get_network"
7440 #: ../src/guestfs-actions.pod:1971
7444 " guestfs_get_network (guestfs_h *g);\n"
7449 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
7450 msgid "This returns the enable network flag."
7454 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5586
7455 msgid "(Added in 1.5.4)"
7459 #: ../src/guestfs-actions.pod:1980
7460 msgid "guestfs_get_path"
7464 #: ../src/guestfs-actions.pod:1982
7468 " guestfs_get_path (guestfs_h *g);\n"
7473 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
7474 msgid "Return the current search path."
7478 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
7480 "This is always non-NULL. If it wasn't set already, then this will return "
7485 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
7487 "This function returns a string, or NULL on error. The string is owned by "
7488 "the guest handle and must I<not> be freed."
7492 #: ../src/guestfs-actions.pod:1995
7493 msgid "guestfs_get_pid"
7497 #: ../src/guestfs-actions.pod:1997
7501 " guestfs_get_pid (guestfs_h *g);\n"
7506 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
7508 "Return the process ID of the qemu subprocess. If there is no qemu "
7509 "subprocess, then this will return an error."
7513 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
7514 msgid "This is an internal call used for debugging and testing."
7518 #: ../src/guestfs-actions.pod:2007
7519 msgid "(Added in 1.0.56)"
7523 #: ../src/guestfs-actions.pod:2009
7524 msgid "guestfs_get_qemu"
7528 #: ../src/guestfs-actions.pod:2011
7532 " guestfs_get_qemu (guestfs_h *g);\n"
7537 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
7538 msgid "Return the current qemu binary."
7542 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
7544 "This is always non-NULL. If it wasn't set already, then this will return "
7545 "the default qemu binary name."
7549 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5631
7550 msgid "(Added in 1.0.6)"
7554 #: ../src/guestfs-actions.pod:2024
7555 msgid "guestfs_get_recovery_proc"
7559 #: ../src/guestfs-actions.pod:2026
7563 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7568 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
7569 msgid "Return the recovery process enabled flag."
7573 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:4935 ../src/guestfs-actions.pod:5278 ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6526
7574 msgid "(Added in 1.0.77)"
7578 #: ../src/guestfs-actions.pod:2035
7579 msgid "guestfs_get_selinux"
7583 #: ../src/guestfs-actions.pod:2037
7587 " guestfs_get_selinux (guestfs_h *g);\n"
7592 #: ../src/guestfs-actions.pod:2040
7594 "This returns the current setting of the selinux flag which is passed to the "
7595 "appliance at boot time. See C<guestfs_set_selinux>."
7599 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:5728
7600 msgid "(Added in 1.0.67)"
7604 #: ../src/guestfs-actions.pod:2050
7605 msgid "guestfs_get_state"
7609 #: ../src/guestfs-actions.pod:2052
7613 " guestfs_get_state (guestfs_h *g);\n"
7618 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
7620 "This returns the current state as an opaque integer. This is only useful "
7621 "for printing debug and internal error messages."
7625 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
7626 msgid "For more information on states, see L<guestfs(3)>."
7630 #: ../src/guestfs-actions.pod:2064
7631 msgid "guestfs_get_trace"
7635 #: ../src/guestfs-actions.pod:2066
7639 " guestfs_get_trace (guestfs_h *g);\n"
7644 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
7645 msgid "Return the command trace flag."
7649 #: ../src/guestfs-actions.pod:2075
7650 msgid "guestfs_get_umask"
7654 #: ../src/guestfs-actions.pod:2077
7658 " guestfs_get_umask (guestfs_h *g);\n"
7663 #: ../src/guestfs-actions.pod:2080
7665 "Return the current umask. By default the umask is C<022> unless it has been "
7666 "set by calling C<guestfs_umask>."
7670 #: ../src/guestfs-actions.pod:2087
7671 msgid "guestfs_get_verbose"
7675 #: ../src/guestfs-actions.pod:2089
7679 " guestfs_get_verbose (guestfs_h *g);\n"
7684 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
7685 msgid "This returns the verbose messages flag."
7689 #: ../src/guestfs-actions.pod:2098
7690 msgid "guestfs_getcon"
7694 #: ../src/guestfs-actions.pod:2100
7698 " guestfs_getcon (guestfs_h *g);\n"
7703 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
7704 msgid "This gets the SELinux security context of the daemon."
7708 #: ../src/guestfs-actions.pod:2105
7709 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7713 #: ../src/guestfs-actions.pod:2113
7714 msgid "guestfs_getxattrs"
7718 #: ../src/guestfs-actions.pod:2115
7721 " struct guestfs_xattr_list *\n"
7722 " guestfs_getxattrs (guestfs_h *g,\n"
7723 " const char *path);\n"
7728 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1432
7729 msgid "This call lists the extended attributes of the file or directory C<path>."
7733 #: ../src/guestfs-actions.pod:2122 ../fish/guestfish-actions.pod:1435
7735 "At the system call level, this is a combination of the L<listxattr(2)> and "
7736 "L<getxattr(2)> calls."
7740 #: ../src/guestfs-actions.pod:2125
7741 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7745 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:3894
7747 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7748 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7752 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:7082
7753 msgid "(Added in 1.0.59)"
7757 #: ../src/guestfs-actions.pod:2133
7758 msgid "guestfs_glob_expand"
7762 #: ../src/guestfs-actions.pod:2135
7766 " guestfs_glob_expand (guestfs_h *g,\n"
7767 " const char *pattern);\n"
7772 #: ../src/guestfs-actions.pod:2139 ../fish/guestfish-actions.pod:1444
7774 "This command searches for all the pathnames matching C<pattern> according to "
7775 "the wildcard expansion rules used by the shell."
7779 #: ../src/guestfs-actions.pod:2143 ../fish/guestfish-actions.pod:1448
7780 msgid "If no paths match, then this returns an empty list (note: not an error)."
7784 #: ../src/guestfs-actions.pod:2146 ../fish/guestfish-actions.pod:1451
7786 "It is just a wrapper around the C L<glob(3)> function with flags "
7787 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7791 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:5929
7792 msgid "(Added in 1.0.50)"
7796 #: ../src/guestfs-actions.pod:2156
7797 msgid "guestfs_grep"
7801 #: ../src/guestfs-actions.pod:2158
7805 " guestfs_grep (guestfs_h *g,\n"
7806 " const char *regex,\n"
7807 " const char *path);\n"
7812 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1459
7813 msgid "This calls the external C<grep> program and returns the matching lines."
7817 #: ../src/guestfs-actions.pod:2175
7818 msgid "guestfs_grepi"
7822 #: ../src/guestfs-actions.pod:2177
7826 " guestfs_grepi (guestfs_h *g,\n"
7827 " const char *regex,\n"
7828 " const char *path);\n"
7833 #: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1469
7834 msgid "This calls the external C<grep -i> program and returns the matching lines."
7838 #: ../src/guestfs-actions.pod:2194
7839 msgid "guestfs_grub_install"
7843 #: ../src/guestfs-actions.pod:2196
7847 " guestfs_grub_install (guestfs_h *g,\n"
7848 " const char *root,\n"
7849 " const char *device);\n"
7854 #: ../src/guestfs-actions.pod:2201 ../fish/guestfish-actions.pod:1479
7856 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7857 "the root directory being C<root>."
7861 #: ../src/guestfs-actions.pod:2204 ../fish/guestfish-actions.pod:1482
7863 "Note: If grub-install reports the error \"No suitable drive was found in the "
7864 "generated device map.\" it may be that you need to create a "
7865 "C</boot/grub/device.map> file first that contains the mapping between grub "
7866 "device names and Linux device names. It is usually sufficient to create a "
7871 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1489
7879 #: ../src/guestfs-actions.pod:2213 ../fish/guestfish-actions.pod:1491
7880 msgid "replacing C</dev/vda> with the name of the installation device."
7884 #: ../src/guestfs-actions.pod:2217
7885 msgid "(Added in 1.0.17)"
7889 #: ../src/guestfs-actions.pod:2219
7890 msgid "guestfs_head"
7894 #: ../src/guestfs-actions.pod:2221
7898 " guestfs_head (guestfs_h *g,\n"
7899 " const char *path);\n"
7904 #: ../src/guestfs-actions.pod:2225 ../fish/guestfish-actions.pod:1497
7906 "This command returns up to the first 10 lines of a file as a list of "
7911 #: ../src/guestfs-actions.pod:2237
7912 msgid "guestfs_head_n"
7916 #: ../src/guestfs-actions.pod:2239
7920 " guestfs_head_n (guestfs_h *g,\n"
7922 " const char *path);\n"
7927 #: ../src/guestfs-actions.pod:2244 ../fish/guestfish-actions.pod:1507
7929 "If the parameter C<nrlines> is a positive number, this returns the first "
7930 "C<nrlines> lines of the file C<path>."
7934 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
7936 "If the parameter C<nrlines> is a negative number, this returns lines from "
7937 "the file C<path>, excluding the last C<nrlines> lines."
7941 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:6209 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4144
7942 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7946 #: ../src/guestfs-actions.pod:2261
7947 msgid "guestfs_hexdump"
7951 #: ../src/guestfs-actions.pod:2263
7955 " guestfs_hexdump (guestfs_h *g,\n"
7956 " const char *path);\n"
7961 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
7963 "This runs C<hexdump -C> on the given C<path>. The result is the "
7964 "human-readable, canonical hex dump of the file."
7968 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:5993 ../src/guestfs-actions.pod:6048
7969 msgid "(Added in 1.0.22)"
7973 #: ../src/guestfs-actions.pod:2278
7974 msgid "guestfs_initrd_cat"
7978 #: ../src/guestfs-actions.pod:2280
7982 " guestfs_initrd_cat (guestfs_h *g,\n"
7983 " const char *initrdpath,\n"
7984 " const char *filename,\n"
7985 " size_t *size_r);\n"
7990 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1532
7992 "This command unpacks the file C<filename> from the initrd file called "
7993 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7998 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1536
8000 "For example, in guestfish you could use the following command to examine the "
8001 "boot script (usually called C</init>) contained in a Linux initrd or "
8006 #: ../src/guestfs-actions.pod:2294 ../fish/guestfish-actions.pod:1540
8009 " initrd-cat /boot/initrd-<version>.img init\n"
8014 #: ../src/guestfs-actions.pod:2296
8015 msgid "See also C<guestfs_initrd_list>."
8019 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:4928 ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:5135
8021 "This function returns a buffer, or NULL on error. The size of the returned "
8022 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8027 #: ../src/guestfs-actions.pod:2307
8028 msgid "guestfs_initrd_list"
8032 #: ../src/guestfs-actions.pod:2309
8036 " guestfs_initrd_list (guestfs_h *g,\n"
8037 " const char *path);\n"
8042 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1551
8043 msgid "This command lists out files contained in an initrd."
8047 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1553
8049 "The files are listed without any initial C</> character. The files are "
8050 "listed in the order they appear (not necessarily alphabetical). Directory "
8051 "names are listed as separate items."
8055 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1557
8057 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8058 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8063 #: ../src/guestfs-actions.pod:2329
8064 msgid "guestfs_inotify_add_watch"
8068 #: ../src/guestfs-actions.pod:2331
8072 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8073 " const char *path,\n"
8079 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1565
8080 msgid "Watch C<path> for the events listed in C<mask>."
8084 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1567
8086 "Note that if C<path> is a directory then events within that directory are "
8087 "watched, but this does I<not> happen recursively (in subdirectories)."
8091 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1571
8093 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8094 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8098 #: ../src/guestfs-actions.pod:2350
8099 msgid "guestfs_inotify_close"
8103 #: ../src/guestfs-actions.pod:2352
8107 " guestfs_inotify_close (guestfs_h *g);\n"
8112 #: ../src/guestfs-actions.pod:2355 ../fish/guestfish-actions.pod:1579
8114 "This closes the inotify handle which was previously opened by inotify_init. "
8115 "It removes all watches, throws away any pending events, and deallocates all "
8120 #: ../src/guestfs-actions.pod:2363
8121 msgid "guestfs_inotify_files"
8125 #: ../src/guestfs-actions.pod:2365
8129 " guestfs_inotify_files (guestfs_h *g);\n"
8134 #: ../src/guestfs-actions.pod:2368
8136 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8137 "returns a list of pathnames of objects that were touched. The returned "
8138 "pathnames are sorted and deduplicated."
8142 #: ../src/guestfs-actions.pod:2378
8143 msgid "guestfs_inotify_init"
8147 #: ../src/guestfs-actions.pod:2380
8151 " guestfs_inotify_init (guestfs_h *g,\n"
8152 " int maxevents);\n"
8157 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1595
8159 "This command creates a new inotify handle. The inotify subsystem can be "
8160 "used to notify events which happen to objects in the guest filesystem."
8164 #: ../src/guestfs-actions.pod:2388
8166 "C<maxevents> is the maximum number of events which will be queued up between "
8167 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8168 "passed as C<0>, then the kernel (or previously set) default is used. For "
8169 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8170 "throws away events, but records the fact that it threw them away by setting "
8171 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8172 "C<guestfs_inotify_read>)."
8176 #: ../src/guestfs-actions.pod:2398
8178 "Before any events are generated, you have to add some watches to the "
8179 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8180 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8184 #: ../src/guestfs-actions.pod:2404
8186 "Queued up events should be read periodically by calling "
8187 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8188 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8189 "often enough then you risk the internal queue overflowing."
8193 #: ../src/guestfs-actions.pod:2411
8195 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8196 "This also removes any watches automatically."
8200 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1626
8202 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8203 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8204 "that there is one global inotify handle per libguestfs instance."
8208 #: ../src/guestfs-actions.pod:2424
8209 msgid "guestfs_inotify_read"
8213 #: ../src/guestfs-actions.pod:2426
8216 " struct guestfs_inotify_event_list *\n"
8217 " guestfs_inotify_read (guestfs_h *g);\n"
8222 #: ../src/guestfs-actions.pod:2429 ../fish/guestfish-actions.pod:1635
8224 "Return the complete queue of events that have happened since the previous "
8229 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1638
8230 msgid "If no events have happened, this returns an empty list."
8234 #: ../src/guestfs-actions.pod:2434 ../fish/guestfish-actions.pod:1640
8236 "I<Note>: In order to make sure that all events have been read, you must call "
8237 "this function repeatedly until it returns an empty list. The reason is that "
8238 "the call will read events up to the maximum appliance-to-host message size "
8239 "and leave remaining events in the queue."
8243 #: ../src/guestfs-actions.pod:2440
8245 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8246 "there was an error. I<The caller must call "
8247 "C<guestfs_free_inotify_event_list> after use>."
8251 #: ../src/guestfs-actions.pod:2446
8252 msgid "guestfs_inotify_rm_watch"
8256 #: ../src/guestfs-actions.pod:2448
8260 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8266 #: ../src/guestfs-actions.pod:2452
8268 "Remove a previously defined inotify watch. See "
8269 "C<guestfs_inotify_add_watch>."
8273 #: ../src/guestfs-actions.pod:2459
8274 msgid "guestfs_inspect_get_arch"
8278 #: ../src/guestfs-actions.pod:2461
8282 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8283 " const char *root);\n"
8288 #: ../src/guestfs-actions.pod:2465 ../src/guestfs-actions.pod:2488 ../src/guestfs-actions.pod:2569 ../src/guestfs-actions.pod:2595 ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2644 ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:2698 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:2867
8290 "This function should only be called with a root device string as returned by "
8291 "C<guestfs_inspect_os>."
8295 #: ../src/guestfs-actions.pod:2468
8297 "This returns the architecture of the inspected operating system. The "
8298 "possible return values are listed under C<guestfs_file_architecture>."
8302 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1664
8304 "If the architecture could not be determined, then the string C<unknown> is "
8309 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2854 ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741 ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909 ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960 ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8310 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8314 #: ../src/guestfs-actions.pod:2482
8315 msgid "guestfs_inspect_get_distro"
8319 #: ../src/guestfs-actions.pod:2484
8323 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8324 " const char *root);\n"
8329 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
8330 msgid "This returns the distro (distribution) of the inspected operating system."
8334 #: ../src/guestfs-actions.pod:2494 ../fish/guestfish-actions.pod:1679
8335 msgid "Currently defined distros are:"
8339 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1683
8340 msgid "\"archlinux\""
8344 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1685
8349 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1687
8354 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1689
8359 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1691
8364 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1693
8369 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1695
8374 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1697
8379 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1699
8380 msgid "\"linuxmint\""
8384 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1701
8389 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1703
8390 msgid "\"mandriva\""
8394 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1705
8399 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1707
8404 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1709
8409 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1711
8414 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1713
8419 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1715
8420 msgid "\"redhat-based\""
8424 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1717
8425 msgid "Some Red Hat-derived distro."
8429 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1719
8434 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1721
8435 msgid "Red Hat Enterprise Linux and some derivatives."
8439 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1723
8444 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1725
8449 #: ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2822 ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8454 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1729
8455 msgid "The distro could not be determined."
8459 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8464 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1733
8466 "Windows does not have distributions. This string is returned if the OS type "
8471 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8473 "Future versions of libguestfs may return other strings here. The caller "
8474 "should be prepared to handle any string."
8478 #: ../src/guestfs-actions.pod:2563
8479 msgid "guestfs_inspect_get_filesystems"
8483 #: ../src/guestfs-actions.pod:2565
8487 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8488 " const char *root);\n"
8493 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1750
8495 "This returns a list of all the filesystems that we think are associated with "
8496 "this operating system. This includes the root filesystem, other ordinary "
8497 "filesystems, and non-mounted devices like swap partitions."
8501 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1755
8503 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8504 "to be shared between operating systems."
8508 #: ../src/guestfs-actions.pod:2580
8510 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8511 "C<guestfs_inspect_get_mountpoints>."
8515 #: ../src/guestfs-actions.pod:2589
8516 msgid "guestfs_inspect_get_hostname"
8520 #: ../src/guestfs-actions.pod:2591
8524 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8525 " const char *root);\n"
8530 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1768
8532 "This function returns the hostname of the operating system as found by "
8533 "inspection of the guest's configuration files."
8537 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1771
8539 "If the hostname could not be determined, then the string C<unknown> is "
8544 #: ../src/guestfs-actions.pod:2609
8545 msgid "(Added in 1.7.9)"
8549 #: ../src/guestfs-actions.pod:2611
8550 msgid "guestfs_inspect_get_major_version"
8554 #: ../src/guestfs-actions.pod:2613
8558 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8559 " const char *root);\n"
8564 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1783
8565 msgid "This returns the major version number of the inspected operating system."
8569 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
8571 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8572 "popular public names used by the operating system. Notably the operating "
8573 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8574 "1). You can find out the real versions corresponding to releases of Windows "
8575 "by consulting Wikipedia or MSDN."
8579 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8580 msgid "If the version could not be determined, then C<0> is returned."
8584 #: ../src/guestfs-actions.pod:2638
8585 msgid "guestfs_inspect_get_minor_version"
8589 #: ../src/guestfs-actions.pod:2640
8593 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8594 " const char *root);\n"
8599 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
8600 msgid "This returns the minor version number of the inspected operating system."
8604 #: ../src/guestfs-actions.pod:2652
8606 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8607 "C<guestfs_inspect_get_major_version>."
8611 #: ../src/guestfs-actions.pod:2659
8612 msgid "guestfs_inspect_get_mountpoints"
8616 #: ../src/guestfs-actions.pod:2661
8620 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8621 " const char *root);\n"
8626 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1819
8628 "This returns a hash of where we think the filesystems associated with this "
8629 "operating system should be mounted. Callers should note that this is at "
8630 "best an educated guess made by reading configuration files such as "
8635 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1824
8637 "Each element in the returned hashtable has a key which is the path of the "
8638 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8639 "mounted there (eg. C</dev/sda1>)."
8643 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1829
8644 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8648 #: ../src/guestfs-actions.pod:2681
8650 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8651 "C<guestfs_inspect_get_filesystems>."
8655 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:4494 ../src/guestfs-actions.pod:6350
8657 "This function returns a NULL-terminated array of strings, or NULL if there "
8658 "was an error. The array of strings will always have length C<2n+1>, where "
8659 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8660 "caller must free the strings and the array after use>."
8664 #: ../src/guestfs-actions.pod:2692
8665 msgid "guestfs_inspect_get_package_format"
8669 #: ../src/guestfs-actions.pod:2694
8673 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8674 " const char *root);\n"
8679 #: ../src/guestfs-actions.pod:2701
8681 "This function and C<guestfs_inspect_get_package_management> return the "
8682 "package format and package management tool used by the inspected operating "
8683 "system. For example for Fedora these functions would return C<rpm> (package "
8684 "format) and C<yum> (package management)."
8688 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
8690 "This returns the string C<unknown> if we could not determine the package "
8691 "format I<or> if the operating system does not have a real packaging system "
8696 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
8698 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8699 "Future versions of libguestfs may return other strings."
8703 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2750
8704 msgid "(Added in 1.7.5)"
8708 #: ../src/guestfs-actions.pod:2721
8709 msgid "guestfs_inspect_get_package_management"
8713 #: ../src/guestfs-actions.pod:2723
8717 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8718 " const char *root);\n"
8723 #: ../src/guestfs-actions.pod:2730
8725 "C<guestfs_inspect_get_package_format> and this function return the package "
8726 "format and package management tool used by the inspected operating system. "
8727 "For example for Fedora these functions would return C<rpm> (package format) "
8728 "and C<yum> (package management)."
8732 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1870
8734 "This returns the string C<unknown> if we could not determine the package "
8735 "management tool I<or> if the operating system does not have a real packaging "
8736 "system (eg. Windows)."
8740 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1874
8742 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8743 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8744 "libguestfs may return other strings."
8748 #: ../src/guestfs-actions.pod:2752
8749 msgid "guestfs_inspect_get_product_name"
8753 #: ../src/guestfs-actions.pod:2754
8757 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8758 " const char *root);\n"
8763 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1888
8765 "This returns the product name of the inspected operating system. The "
8766 "product name is generally some freeform string which can be displayed to the "
8767 "user, but should not be parsed by programs."
8771 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1893
8773 "If the product name could not be determined, then the string C<unknown> is "
8778 #: ../src/guestfs-actions.pod:2776
8779 msgid "guestfs_inspect_get_roots"
8783 #: ../src/guestfs-actions.pod:2778
8787 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8792 #: ../src/guestfs-actions.pod:2781
8794 "This function is a convenient way to get the list of root devices, as "
8795 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8796 "the whole inspection process."
8800 #: ../src/guestfs-actions.pod:2785
8802 "This returns an empty list if either no root devices were found or the "
8803 "caller has not called C<guestfs_inspect_os>."
8807 #: ../src/guestfs-actions.pod:2794
8808 msgid "(Added in 1.7.3)"
8812 #: ../src/guestfs-actions.pod:2796
8813 msgid "guestfs_inspect_get_type"
8817 #: ../src/guestfs-actions.pod:2798
8821 " guestfs_inspect_get_type (guestfs_h *g,\n"
8822 " const char *root);\n"
8827 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
8829 "This returns the type of the inspected operating system. Currently defined "
8834 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1923
8839 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
8840 msgid "Any Linux-based operating system."
8844 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1929
8845 msgid "Any Microsoft Windows operating system."
8849 #: ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1931
8854 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1933
8859 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1937
8860 msgid "The operating system type could not be determined."
8864 #: ../src/guestfs-actions.pod:2838
8865 msgid "guestfs_inspect_get_windows_systemroot"
8869 #: ../src/guestfs-actions.pod:2840
8873 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8874 " const char *root);\n"
8879 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1953
8881 "This returns the Windows systemroot of the inspected guest. The systemroot "
8882 "is a directory path such as C</WINDOWS>."
8886 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1956
8888 "This call assumes that the guest is Windows and that the systemroot could be "
8889 "determined by inspection. If this is not the case then an error is "
8894 #: ../src/guestfs-actions.pod:2859
8895 msgid "(Added in 1.5.25)"
8899 #: ../src/guestfs-actions.pod:2861
8900 msgid "guestfs_inspect_list_applications"
8904 #: ../src/guestfs-actions.pod:2863
8907 " struct guestfs_application_list *\n"
8908 " guestfs_inspect_list_applications (guestfs_h *g,\n"
8909 " const char *root);\n"
8914 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1969
8915 msgid "Return the list of applications installed in the operating system."
8919 #: ../src/guestfs-actions.pod:2872
8921 "I<Note:> This call works differently from other parts of the inspection "
8922 "API. You have to call C<guestfs_inspect_os>, then "
8923 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
8924 "this. Listing applications is a significantly more difficult operation "
8925 "which requires access to the full filesystem. Also note that unlike the "
8926 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
8927 "the libguestfs handle, this call actually reads parts of the mounted "
8928 "filesystems during the call."
8932 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1981
8934 "This returns an empty list if the inspection code was not able to determine "
8935 "the list of applications."
8939 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:1984
8940 msgid "The application structure contains the following fields:"
8944 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1988
8949 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1990
8951 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8952 "guests, this is the package name."
8956 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1993
8957 msgid "C<app_display_name>"
8961 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1995
8963 "The display name of the application, sometimes localized to the install "
8964 "language of the guest operating system."
8968 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1998
8970 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8971 "to display something can use C<app_name> instead."
8975 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2001
8976 msgid "C<app_epoch>"
8980 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2003
8982 "For package managers which use epochs, this contains the epoch of the "
8983 "package (an integer). If unavailable, this is returned as C<0>."
8987 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2006
8988 msgid "C<app_version>"
8992 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2008
8994 "The version string of the application or package. If unavailable this is "
8995 "returned as an empty string C<\"\">."
8999 #: ../src/guestfs-actions.pod:2912 ../fish/guestfish-actions.pod:2011
9000 msgid "C<app_release>"
9004 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2013
9006 "The release string of the application or package, for package managers that "
9007 "use this. If unavailable this is returned as an empty string C<\"\">."
9011 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2017
9012 msgid "C<app_install_path>"
9016 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2019
9018 "The installation path of the application (on operating systems such as "
9019 "Windows which use installation paths). This path is in the format used by "
9020 "the guest operating system, it is not a libguestfs path."
9024 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2024
9025 msgid "If unavailable this is returned as an empty string C<\"\">."
9029 #: ../src/guestfs-actions.pod:2927 ../fish/guestfish-actions.pod:2026
9030 msgid "C<app_trans_path>"
9034 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2028
9036 "The install path translated into a libguestfs path. If unavailable this is "
9037 "returned as an empty string C<\"\">."
9041 #: ../src/guestfs-actions.pod:2932 ../fish/guestfish-actions.pod:2031
9042 msgid "C<app_publisher>"
9046 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2033
9048 "The name of the publisher of the application, for package managers that use "
9049 "this. If unavailable this is returned as an empty string C<\"\">."
9053 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2037
9058 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2039
9060 "The URL (eg. upstream URL) of the application. If unavailable this is "
9061 "returned as an empty string C<\"\">."
9065 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2042
9066 msgid "C<app_source_package>"
9070 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2044
9072 "For packaging systems which support this, the name of the source package. "
9073 "If unavailable this is returned as an empty string C<\"\">."
9077 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2047
9078 msgid "C<app_summary>"
9082 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2049
9084 "A short (usually one line) description of the application or package. If "
9085 "unavailable this is returned as an empty string C<\"\">."
9089 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2052
9090 msgid "C<app_description>"
9094 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2054
9096 "A longer description of the application or package. If unavailable this is "
9097 "returned as an empty string C<\"\">."
9101 #: ../src/guestfs-actions.pod:2962
9103 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9104 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9109 #: ../src/guestfs-actions.pod:2966
9110 msgid "(Added in 1.7.8)"
9114 #: ../src/guestfs-actions.pod:2968
9115 msgid "guestfs_inspect_os"
9119 #: ../src/guestfs-actions.pod:2970
9123 " guestfs_inspect_os (guestfs_h *g);\n"
9128 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2065
9130 "This function uses other libguestfs functions and certain heuristics to "
9131 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9132 "for operating systems."
9136 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2069
9137 msgid "The list returned is empty if no operating systems were found."
9141 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2071
9143 "If one operating system was found, then this returns a list with a single "
9144 "element, which is the name of the root filesystem of this operating system. "
9145 "It is also possible for this function to return a list containing more than "
9146 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9147 "element being the root filesystem of one of the operating systems."
9151 #: ../src/guestfs-actions.pod:2986
9153 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9154 "functions in order to query further information about each operating system, "
9155 "such as the name and version."
9159 #: ../src/guestfs-actions.pod:2991
9161 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9162 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9163 "the contents. This should be called with no disks currently mounted. The "
9164 "function may also use Augeas, so any existing Augeas handle will be closed."
9168 #: ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:2089
9170 "This function cannot decrypt encrypted disks. The caller must do that first "
9171 "(supplying the necessary keys) if the disk is encrypted."
9175 #: ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3320
9176 msgid "See also C<guestfs_list_filesystems>."
9180 #: ../src/guestfs-actions.pod:3011
9181 msgid "guestfs_is_blockdev"
9185 #: ../src/guestfs-actions.pod:3013
9189 " guestfs_is_blockdev (guestfs_h *g,\n"
9190 " const char *path);\n"
9195 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2101
9197 "This returns C<true> if and only if there is a block device with the given "
9202 #: ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3181
9203 msgid "See also C<guestfs_stat>."
9207 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3185
9208 msgid "(Added in 1.5.10)"
9212 #: ../src/guestfs-actions.pod:3026
9213 msgid "guestfs_is_busy"
9217 #: ../src/guestfs-actions.pod:3028
9221 " guestfs_is_busy (guestfs_h *g);\n"
9226 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2110
9228 "This returns true iff this handle is busy processing a command (in the "
9233 #: ../src/guestfs-actions.pod:3040
9234 msgid "guestfs_is_chardev"
9238 #: ../src/guestfs-actions.pod:3042
9242 " guestfs_is_chardev (guestfs_h *g,\n"
9243 " const char *path);\n"
9248 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2119
9250 "This returns C<true> if and only if there is a character device with the "
9251 "given C<path> name."
9255 #: ../src/guestfs-actions.pod:3055
9256 msgid "guestfs_is_config"
9260 #: ../src/guestfs-actions.pod:3057
9264 " guestfs_is_config (guestfs_h *g);\n"
9269 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2128
9271 "This returns true iff this handle is being configured (in the C<CONFIG> "
9276 #: ../src/guestfs-actions.pod:3069
9277 msgid "guestfs_is_dir"
9281 #: ../src/guestfs-actions.pod:3071
9285 " guestfs_is_dir (guestfs_h *g,\n"
9286 " const char *path);\n"
9291 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2137
9293 "This returns C<true> if and only if there is a directory with the given "
9294 "C<path> name. Note that it returns false for other objects like files."
9298 #: ../src/guestfs-actions.pod:3085
9299 msgid "guestfs_is_fifo"
9303 #: ../src/guestfs-actions.pod:3087
9307 " guestfs_is_fifo (guestfs_h *g,\n"
9308 " const char *path);\n"
9313 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2147
9315 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9316 "given C<path> name."
9320 #: ../src/guestfs-actions.pod:3100
9321 msgid "guestfs_is_file"
9325 #: ../src/guestfs-actions.pod:3102
9329 " guestfs_is_file (guestfs_h *g,\n"
9330 " const char *path);\n"
9335 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2156
9337 "This returns C<true> if and only if there is a regular file with the given "
9338 "C<path> name. Note that it returns false for other objects like "
9343 #: ../src/guestfs-actions.pod:3116
9344 msgid "guestfs_is_launching"
9348 #: ../src/guestfs-actions.pod:3118
9352 " guestfs_is_launching (guestfs_h *g);\n"
9357 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2166
9359 "This returns true iff this handle is launching the subprocess (in the "
9360 "C<LAUNCHING> state)."
9364 #: ../src/guestfs-actions.pod:3130
9365 msgid "guestfs_is_lv"
9369 #: ../src/guestfs-actions.pod:3132
9373 " guestfs_is_lv (guestfs_h *g,\n"
9374 " const char *device);\n"
9379 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2175
9381 "This command tests whether C<device> is a logical volume, and returns true "
9382 "iff this is the case."
9386 #: ../src/guestfs-actions.pod:3143
9387 msgid "guestfs_is_ready"
9391 #: ../src/guestfs-actions.pod:3145
9395 " guestfs_is_ready (guestfs_h *g);\n"
9400 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2182
9402 "This returns true iff this handle is ready to accept commands (in the "
9407 #: ../src/guestfs-actions.pod:3157
9408 msgid "guestfs_is_socket"
9412 #: ../src/guestfs-actions.pod:3159
9416 " guestfs_is_socket (guestfs_h *g,\n"
9417 " const char *path);\n"
9422 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2191
9424 "This returns C<true> if and only if there is a Unix domain socket with the "
9425 "given C<path> name."
9429 #: ../src/guestfs-actions.pod:3172
9430 msgid "guestfs_is_symlink"
9434 #: ../src/guestfs-actions.pod:3174
9438 " guestfs_is_symlink (guestfs_h *g,\n"
9439 " const char *path);\n"
9444 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2200
9446 "This returns C<true> if and only if there is a symbolic link with the given "
9451 #: ../src/guestfs-actions.pod:3187
9452 msgid "guestfs_kill_subprocess"
9456 #: ../src/guestfs-actions.pod:3189
9460 " guestfs_kill_subprocess (guestfs_h *g);\n"
9465 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2209
9466 msgid "This kills the qemu subprocess. You should never need to call this."
9470 #: ../src/guestfs-actions.pod:3198
9471 msgid "guestfs_launch"
9475 #: ../src/guestfs-actions.pod:3200
9479 " guestfs_launch (guestfs_h *g);\n"
9484 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2217
9486 "Internally libguestfs is implemented by running a virtual machine using "
9491 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2220
9493 "You should call this after configuring the handle (eg. adding drives) but "
9494 "before performing any actions."
9498 #: ../src/guestfs-actions.pod:3213
9499 msgid "guestfs_lchown"
9503 #: ../src/guestfs-actions.pod:3215
9507 " guestfs_lchown (guestfs_h *g,\n"
9510 " const char *path);\n"
9515 #: ../src/guestfs-actions.pod:3221
9517 "Change the file owner to C<owner> and group to C<group>. This is like "
9518 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9519 "changed, not the target."
9523 #: ../src/guestfs-actions.pod:3233
9524 msgid "guestfs_lgetxattrs"
9528 #: ../src/guestfs-actions.pod:3235
9531 " struct guestfs_xattr_list *\n"
9532 " guestfs_lgetxattrs (guestfs_h *g,\n"
9533 " const char *path);\n"
9538 #: ../src/guestfs-actions.pod:3239
9540 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9541 "then it returns the extended attributes of the link itself."
9545 #: ../src/guestfs-actions.pod:3249
9546 msgid "guestfs_list_devices"
9550 #: ../src/guestfs-actions.pod:3251
9554 " guestfs_list_devices (guestfs_h *g);\n"
9559 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2247
9560 msgid "List all the block devices."
9564 #: ../src/guestfs-actions.pod:3256 ../fish/guestfish-actions.pod:2249
9565 msgid "The full block device names are returned, eg. C</dev/sda>."
9569 #: ../src/guestfs-actions.pod:3266
9570 msgid "guestfs_list_filesystems"
9574 #: ../src/guestfs-actions.pod:3268
9578 " guestfs_list_filesystems (guestfs_h *g);\n"
9583 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2257
9585 "This inspection command looks for filesystems on partitions, block devices "
9586 "and logical volumes, returning a list of devices containing filesystems and "
9591 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2261
9593 "The return value is a hash, where the keys are the devices containing "
9594 "filesystems, and the values are the filesystem types. For example:"
9598 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2265
9601 " \"/dev/sda1\" => \"ntfs\"\n"
9602 " \"/dev/sda2\" => \"ext2\"\n"
9603 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9604 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9609 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2270
9611 "The value can have the special value \"unknown\", meaning the content of the "
9612 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9616 #: ../src/guestfs-actions.pod:3288
9618 "This command runs other libguestfs commands, which might include "
9619 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9620 "soon after launch and only when nothing is mounted."
9624 #: ../src/guestfs-actions.pod:3292
9626 "Not all of the filesystems returned will be mountable. In particular, swap "
9627 "partitions are returned in the list. Also this command does not check that "
9628 "each filesystem found is valid and mountable, and some filesystems might be "
9629 "mountable but require special options. Filesystems may not all belong to a "
9630 "single logical operating system (use C<guestfs_inspect_os> to look for "
9635 #: ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:4895
9636 msgid "(Added in 1.5.15)"
9640 #: ../src/guestfs-actions.pod:3308
9641 msgid "guestfs_list_partitions"
9645 #: ../src/guestfs-actions.pod:3310
9649 " guestfs_list_partitions (guestfs_h *g);\n"
9654 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2290
9655 msgid "List all the partitions detected on all block devices."
9659 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2292
9660 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9664 #: ../src/guestfs-actions.pod:3317
9666 "This does not return logical volumes. For that you will need to call "
9671 #: ../src/guestfs-actions.pod:3328
9676 #: ../src/guestfs-actions.pod:3330
9680 " guestfs_ll (guestfs_h *g,\n"
9681 " const char *directory);\n"
9686 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2303
9688 "List the files in C<directory> (relative to the root directory, there is no "
9689 "cwd) in the format of 'ls -la'."
9693 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2306
9695 "This command is mostly useful for interactive sessions. It is I<not> "
9696 "intended that you try to parse the output string."
9700 #: ../src/guestfs-actions.pod:3345
9705 #: ../src/guestfs-actions.pod:3347
9709 " guestfs_ln (guestfs_h *g,\n"
9710 " const char *target,\n"
9711 " const char *linkname);\n"
9716 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2313
9717 msgid "This command creates a hard link using the C<ln> command."
9721 #: ../src/guestfs-actions.pod:3358
9722 msgid "guestfs_ln_f"
9726 #: ../src/guestfs-actions.pod:3360
9730 " guestfs_ln_f (guestfs_h *g,\n"
9731 " const char *target,\n"
9732 " const char *linkname);\n"
9737 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2319
9739 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9740 "option removes the link (C<linkname>) if it exists already."
9744 #: ../src/guestfs-actions.pod:3372
9745 msgid "guestfs_ln_s"
9749 #: ../src/guestfs-actions.pod:3374
9753 " guestfs_ln_s (guestfs_h *g,\n"
9754 " const char *target,\n"
9755 " const char *linkname);\n"
9760 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2326
9761 msgid "This command creates a symbolic link using the C<ln -s> command."
9765 #: ../src/guestfs-actions.pod:3385
9766 msgid "guestfs_ln_sf"
9770 #: ../src/guestfs-actions.pod:3387
9774 " guestfs_ln_sf (guestfs_h *g,\n"
9775 " const char *target,\n"
9776 " const char *linkname);\n"
9781 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2332
9783 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9784 "option removes the link (C<linkname>) if it exists already."
9788 #: ../src/guestfs-actions.pod:3399
9789 msgid "guestfs_lremovexattr"
9793 #: ../src/guestfs-actions.pod:3401
9797 " guestfs_lremovexattr (guestfs_h *g,\n"
9798 " const char *xattr,\n"
9799 " const char *path);\n"
9804 #: ../src/guestfs-actions.pod:3406
9806 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9807 "link, then it removes an extended attribute of the link itself."
9811 #: ../src/guestfs-actions.pod:3414
9816 #: ../src/guestfs-actions.pod:3416
9820 " guestfs_ls (guestfs_h *g,\n"
9821 " const char *directory);\n"
9826 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2347
9828 "List the files in C<directory> (relative to the root directory, there is no "
9829 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9834 #: ../src/guestfs-actions.pod:3424
9836 "This command is mostly useful for interactive sessions. Programs should "
9837 "probably use C<guestfs_readdir> instead."
9841 #: ../src/guestfs-actions.pod:3433
9842 msgid "guestfs_lsetxattr"
9846 #: ../src/guestfs-actions.pod:3435
9850 " guestfs_lsetxattr (guestfs_h *g,\n"
9851 " const char *xattr,\n"
9852 " const char *val,\n"
9854 " const char *path);\n"
9859 #: ../src/guestfs-actions.pod:3442
9861 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9862 "then it sets an extended attribute of the link itself."
9866 #: ../src/guestfs-actions.pod:3450
9867 msgid "guestfs_lstat"
9871 #: ../src/guestfs-actions.pod:3452
9874 " struct guestfs_stat *\n"
9875 " guestfs_lstat (guestfs_h *g,\n"
9876 " const char *path);\n"
9881 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3979
9882 msgid "Returns file information for the given C<path>."
9886 #: ../src/guestfs-actions.pod:3458
9888 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9889 "link, then the link is stat-ed, not the file it refers to."
9893 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2372
9894 msgid "This is the same as the C<lstat(2)> system call."
9898 #: ../src/guestfs-actions.pod:3464 ../src/guestfs-actions.pod:5953
9900 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9901 "error. I<The caller must call C<guestfs_free_stat> after use>."
9905 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6356
9906 msgid "(Added in 0.9.2)"
9910 #: ../src/guestfs-actions.pod:3470
9911 msgid "guestfs_lstatlist"
9915 #: ../src/guestfs-actions.pod:3472
9918 " struct guestfs_stat_list *\n"
9919 " guestfs_lstatlist (guestfs_h *g,\n"
9920 " const char *path,\n"
9921 " char *const *names);\n"
9926 #: ../src/guestfs-actions.pod:3477
9928 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9929 "files, where all files are in the directory C<path>. C<names> is the list "
9930 "of files from this directory."
9934 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:2382
9936 "On return you get a list of stat structs, with a one-to-one correspondence "
9937 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9938 "then the C<ino> field of that structure is set to C<-1>."
9942 #: ../src/guestfs-actions.pod:3486
9944 "This call is intended for programs that want to efficiently list a directory "
9945 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9946 "for a similarly efficient call for getting extended attributes. Very long "
9947 "directory listings might cause the protocol message size to be exceeded, "
9948 "causing this call to fail. The caller must split up such requests into "
9949 "smaller groups of names."
9953 #: ../src/guestfs-actions.pod:3494
9955 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9956 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9960 #: ../src/guestfs-actions.pod:3500
9961 msgid "guestfs_luks_add_key"
9965 #: ../src/guestfs-actions.pod:3502
9969 " guestfs_luks_add_key (guestfs_h *g,\n"
9970 " const char *device,\n"
9971 " const char *key,\n"
9972 " const char *newkey,\n"
9978 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2399
9980 "This command adds a new key on LUKS device C<device>. C<key> is any "
9981 "existing key, and is used to access the device. C<newkey> is the new key to "
9982 "add. C<keyslot> is the key slot that will be replaced."
9986 #: ../src/guestfs-actions.pod:3514
9988 "Note that if C<keyslot> already contains a key, then this command will "
9989 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9993 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:3654
9995 "This function takes a key or passphrase parameter which could contain "
9996 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10001 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3587 ../src/guestfs-actions.pod:3607
10002 msgid "(Added in 1.5.2)"
10006 #: ../src/guestfs-actions.pod:3526
10007 msgid "guestfs_luks_close"
10011 #: ../src/guestfs-actions.pod:3528
10015 " guestfs_luks_close (guestfs_h *g,\n"
10016 " const char *device);\n"
10021 #: ../src/guestfs-actions.pod:3532
10023 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10024 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10025 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10026 "underlying block device."
10030 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3658 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3756
10031 msgid "(Added in 1.5.1)"
10035 #: ../src/guestfs-actions.pod:3542
10036 msgid "guestfs_luks_format"
10040 #: ../src/guestfs-actions.pod:3544
10044 " guestfs_luks_format (guestfs_h *g,\n"
10045 " const char *device,\n"
10046 " const char *key,\n"
10052 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2425
10054 "This command erases existing data on C<device> and formats the device as a "
10055 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10056 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10060 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:4646 ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5784 ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5833 ../src/guestfs-actions.pod:6993 ../fish/guestfish-actions.pod:2433 ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:3091 ../fish/guestfish-actions.pod:3598 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:3894 ../fish/guestfish-actions.pod:3909 ../fish/guestfish-actions.pod:4624
10062 "B<This command is dangerous. Without careful use you can easily destroy all "
10067 #: ../src/guestfs-actions.pod:3566
10068 msgid "guestfs_luks_format_cipher"
10072 #: ../src/guestfs-actions.pod:3568
10076 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10077 " const char *device,\n"
10078 " const char *key,\n"
10080 " const char *cipher);\n"
10085 #: ../src/guestfs-actions.pod:3575
10087 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10088 "set the C<cipher> used."
10092 #: ../src/guestfs-actions.pod:3589
10093 msgid "guestfs_luks_kill_slot"
10097 #: ../src/guestfs-actions.pod:3591
10101 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10102 " const char *device,\n"
10103 " const char *key,\n"
10109 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2453
10111 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10112 "device C<device>. C<key> must be one of the I<other> keys."
10116 #: ../src/guestfs-actions.pod:3609
10117 msgid "guestfs_luks_open"
10121 #: ../src/guestfs-actions.pod:3611
10125 " guestfs_luks_open (guestfs_h *g,\n"
10126 " const char *device,\n"
10127 " const char *key,\n"
10128 " const char *mapname);\n"
10133 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2464
10135 "This command opens a block device which has been encrypted according to the "
10136 "Linux Unified Key Setup (LUKS) standard."
10140 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2467
10141 msgid "C<device> is the encrypted block device or partition."
10145 #: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2469
10147 "The caller must supply one of the keys associated with the LUKS block "
10148 "device, in the C<key> parameter."
10152 #: ../src/guestfs-actions.pod:3625 ../fish/guestfish-actions.pod:2472
10154 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10155 "writes to this block device are decrypted from and encrypted to the "
10156 "underlying C<device> respectively."
10160 #: ../src/guestfs-actions.pod:3629
10162 "If this block device contains LVM volume groups, then calling "
10163 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10168 #: ../src/guestfs-actions.pod:3641
10169 msgid "guestfs_luks_open_ro"
10173 #: ../src/guestfs-actions.pod:3643
10177 " guestfs_luks_open_ro (guestfs_h *g,\n"
10178 " const char *device,\n"
10179 " const char *key,\n"
10180 " const char *mapname);\n"
10185 #: ../src/guestfs-actions.pod:3649
10187 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10192 #: ../src/guestfs-actions.pod:3660
10193 msgid "guestfs_lvcreate"
10197 #: ../src/guestfs-actions.pod:3662
10201 " guestfs_lvcreate (guestfs_h *g,\n"
10202 " const char *logvol,\n"
10203 " const char *volgroup,\n"
10209 #: ../src/guestfs-actions.pod:3668 ../fish/guestfish-actions.pod:2497
10211 "This creates an LVM logical volume called C<logvol> on the volume group "
10212 "C<volgroup>, with C<size> megabytes."
10216 #: ../src/guestfs-actions.pod:3675
10217 msgid "guestfs_lvm_canonical_lv_name"
10221 #: ../src/guestfs-actions.pod:3677
10225 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10226 " const char *lvname);\n"
10231 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2504
10233 "This converts alternative naming schemes for LVs that you might find to the "
10234 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
10239 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2508
10241 "This command returns an error if the C<lvname> parameter does not refer to a "
10246 #: ../src/guestfs-actions.pod:3688
10247 msgid "See also C<guestfs_is_lv>."
10251 #: ../src/guestfs-actions.pod:3693
10252 msgid "(Added in 1.5.24)"
10256 #: ../src/guestfs-actions.pod:3695
10257 msgid "guestfs_lvm_clear_filter"
10261 #: ../src/guestfs-actions.pod:3697
10265 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10270 #: ../src/guestfs-actions.pod:3700
10272 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10273 "see every block device."
10277 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10278 msgid "This command also clears the LVM cache and performs a volume group scan."
10282 #: ../src/guestfs-actions.pod:3710
10283 msgid "guestfs_lvm_remove_all"
10287 #: ../src/guestfs-actions.pod:3712
10291 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10296 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2527
10298 "This command removes all LVM logical volumes, volume groups and physical "
10303 #: ../src/guestfs-actions.pod:3725
10304 msgid "guestfs_lvm_set_filter"
10308 #: ../src/guestfs-actions.pod:3727
10312 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10313 " char *const *devices);\n"
10318 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2537
10320 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10321 "block devices in the list C<devices>, and will ignore all other attached "
10326 #: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2541
10328 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10329 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10330 "there are two types of duplication possible: either cloned PVs/VGs which "
10331 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10332 "same name. In normal operation you cannot create this situation, but you "
10333 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10334 "inside the LVM metadata."
10338 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2554
10339 msgid "You can filter whole block devices or individual partitions."
10343 #: ../src/guestfs-actions.pod:3750 ../fish/guestfish-actions.pod:2556
10345 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10346 "filesystem), even if you are not filtering out that VG."
10350 #: ../src/guestfs-actions.pod:3758
10351 msgid "guestfs_lvremove"
10355 #: ../src/guestfs-actions.pod:3760
10359 " guestfs_lvremove (guestfs_h *g,\n"
10360 " const char *device);\n"
10365 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2564
10367 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10368 "LV, such as C</dev/VG/LV>."
10372 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2567
10374 "You can also remove all LVs in a volume group by specifying the VG name, "
10379 #: ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:4992 ../src/guestfs-actions.pod:6732
10380 msgid "(Added in 1.0.13)"
10384 #: ../src/guestfs-actions.pod:3774
10385 msgid "guestfs_lvrename"
10389 #: ../src/guestfs-actions.pod:3776
10393 " guestfs_lvrename (guestfs_h *g,\n"
10394 " const char *logvol,\n"
10395 " const char *newlogvol);\n"
10400 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2574
10401 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10405 #: ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:6745
10406 msgid "(Added in 1.0.83)"
10410 #: ../src/guestfs-actions.pod:3787
10411 msgid "guestfs_lvresize"
10415 #: ../src/guestfs-actions.pod:3789
10419 " guestfs_lvresize (guestfs_h *g,\n"
10420 " const char *device,\n"
10426 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
10428 "This resizes (expands or shrinks) an existing LVM logical volume to "
10429 "C<mbytes>. When reducing, data in the reduced part is lost."
10433 #: ../src/guestfs-actions.pod:3802
10434 msgid "guestfs_lvresize_free"
10438 #: ../src/guestfs-actions.pod:3804
10442 " guestfs_lvresize_free (guestfs_h *g,\n"
10443 " const char *lv,\n"
10449 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2588
10451 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10452 "remaining free space in the volume group. Commonly you would call this with "
10453 "pc = 100 which expands the logical volume as much as possible, using all "
10454 "remaining free space in the volume group."
10458 #: ../src/guestfs-actions.pod:3817
10459 msgid "(Added in 1.3.3)"
10463 #: ../src/guestfs-actions.pod:3819
10464 msgid "guestfs_lvs"
10468 #: ../src/guestfs-actions.pod:3821
10472 " guestfs_lvs (guestfs_h *g);\n"
10477 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2598
10479 "List all the logical volumes detected. This is the equivalent of the "
10480 "L<lvs(8)> command."
10484 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2601
10486 "This returns a list of the logical volume device names "
10487 "(eg. C</dev/VolGroup00/LogVol00>)."
10491 #: ../src/guestfs-actions.pod:3830
10492 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10496 #: ../src/guestfs-actions.pod:3838
10497 msgid "guestfs_lvs_full"
10501 #: ../src/guestfs-actions.pod:3840
10504 " struct guestfs_lvm_lv_list *\n"
10505 " guestfs_lvs_full (guestfs_h *g);\n"
10510 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2610
10512 "List all the logical volumes detected. This is the equivalent of the "
10513 "L<lvs(8)> command. The \"full\" version includes all fields."
10517 #: ../src/guestfs-actions.pod:3846
10519 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10520 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
10525 #: ../src/guestfs-actions.pod:3852
10526 msgid "guestfs_lvuuid"
10530 #: ../src/guestfs-actions.pod:3854
10534 " guestfs_lvuuid (guestfs_h *g,\n"
10535 " const char *device);\n"
10540 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2617
10541 msgid "This command returns the UUID of the LVM LV C<device>."
10545 #: ../src/guestfs-actions.pod:3865
10546 msgid "guestfs_lxattrlist"
10550 #: ../src/guestfs-actions.pod:3867
10553 " struct guestfs_xattr_list *\n"
10554 " guestfs_lxattrlist (guestfs_h *g,\n"
10555 " const char *path,\n"
10556 " char *const *names);\n"
10561 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2623
10563 "This call allows you to get the extended attributes of multiple files, where "
10564 "all files are in the directory C<path>. C<names> is the list of files from "
10569 #: ../src/guestfs-actions.pod:3876 ../fish/guestfish-actions.pod:2627
10571 "On return you get a flat list of xattr structs which must be interpreted "
10572 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10573 "C<attrval> in this struct is zero-length to indicate there was an error "
10574 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10575 "number (the number of following attributes for this file, which could be "
10576 "C<\"0\">). Then after the first xattr struct are the zero or more "
10577 "attributes for the first named file. This repeats for the second and "
10578 "subsequent files."
10582 #: ../src/guestfs-actions.pod:3886
10584 "This call is intended for programs that want to efficiently list a directory "
10585 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10586 "a similarly efficient call for getting standard stats. Very long directory "
10587 "listings might cause the protocol message size to be exceeded, causing this "
10588 "call to fail. The caller must split up such requests into smaller groups of "
10593 #: ../src/guestfs-actions.pod:3900
10594 msgid "guestfs_mkdir"
10598 #: ../src/guestfs-actions.pod:3902
10602 " guestfs_mkdir (guestfs_h *g,\n"
10603 " const char *path);\n"
10608 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2649
10609 msgid "Create a directory named C<path>."
10613 #: ../src/guestfs-actions.pod:3912
10614 msgid "guestfs_mkdir_mode"
10618 #: ../src/guestfs-actions.pod:3914
10622 " guestfs_mkdir_mode (guestfs_h *g,\n"
10623 " const char *path,\n"
10629 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2655
10631 "This command creates a directory, setting the initial permissions of the "
10632 "directory to C<mode>."
10636 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2658
10638 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10639 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10644 #: ../src/guestfs-actions.pod:3926
10645 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10649 #: ../src/guestfs-actions.pod:3932
10650 msgid "guestfs_mkdir_p"
10654 #: ../src/guestfs-actions.pod:3934
10658 " guestfs_mkdir_p (guestfs_h *g,\n"
10659 " const char *path);\n"
10664 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2668
10666 "Create a directory named C<path>, creating any parent directories as "
10667 "necessary. This is like the C<mkdir -p> shell command."
10671 #: ../src/guestfs-actions.pod:3945
10672 msgid "guestfs_mkdtemp"
10676 #: ../src/guestfs-actions.pod:3947
10680 " guestfs_mkdtemp (guestfs_h *g,\n"
10681 " const char *template);\n"
10686 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2675
10688 "This command creates a temporary directory. The C<template> parameter "
10689 "should be a full pathname for the temporary directory name with the final "
10690 "six characters being \"XXXXXX\"."
10694 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2680
10696 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10697 "being suitable for Windows filesystems."
10701 #: ../src/guestfs-actions.pod:3959 ../fish/guestfish-actions.pod:2683
10702 msgid "The name of the temporary directory that was created is returned."
10706 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2686
10707 msgid "The temporary directory is created with mode 0700 and is owned by root."
10711 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2689
10713 "The caller is responsible for deleting the temporary directory and its "
10714 "contents after use."
10718 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2692
10719 msgid "See also: L<mkdtemp(3)>"
10723 #: ../src/guestfs-actions.pod:3975
10724 msgid "guestfs_mke2fs_J"
10728 #: ../src/guestfs-actions.pod:3977
10732 " guestfs_mke2fs_J (guestfs_h *g,\n"
10733 " const char *fstype,\n"
10734 " int blocksize,\n"
10735 " const char *device,\n"
10736 " const char *journal);\n"
10741 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2698
10743 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10744 "C<journal>. It is equivalent to the command:"
10748 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2702
10751 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10756 #: ../src/guestfs-actions.pod:3990
10757 msgid "See also C<guestfs_mke2journal>."
10761 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4030 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4133 ../src/guestfs-actions.pod:4382
10762 msgid "(Added in 1.0.68)"
10766 #: ../src/guestfs-actions.pod:3996
10767 msgid "guestfs_mke2fs_JL"
10771 #: ../src/guestfs-actions.pod:3998
10775 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10776 " const char *fstype,\n"
10777 " int blocksize,\n"
10778 " const char *device,\n"
10779 " const char *label);\n"
10784 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2710
10786 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10787 "the journal labeled C<label>."
10791 #: ../src/guestfs-actions.pod:4008
10792 msgid "See also C<guestfs_mke2journal_L>."
10796 #: ../src/guestfs-actions.pod:4014
10797 msgid "guestfs_mke2fs_JU"
10801 #: ../src/guestfs-actions.pod:4016
10805 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10806 " const char *fstype,\n"
10807 " int blocksize,\n"
10808 " const char *device,\n"
10809 " const char *uuid);\n"
10814 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2719
10816 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10817 "the journal with UUID C<uuid>."
10821 #: ../src/guestfs-actions.pod:4026
10822 msgid "See also C<guestfs_mke2journal_U>."
10826 #: ../src/guestfs-actions.pod:4032
10827 msgid "guestfs_mke2journal"
10831 #: ../src/guestfs-actions.pod:4034
10835 " guestfs_mke2journal (guestfs_h *g,\n"
10836 " int blocksize,\n"
10837 " const char *device);\n"
10842 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2728
10844 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10849 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2731
10852 " mke2fs -O journal_dev -b blocksize device\n"
10857 #: ../src/guestfs-actions.pod:4048
10858 msgid "guestfs_mke2journal_L"
10862 #: ../src/guestfs-actions.pod:4050
10866 " guestfs_mke2journal_L (guestfs_h *g,\n"
10867 " int blocksize,\n"
10868 " const char *label,\n"
10869 " const char *device);\n"
10874 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2737
10875 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10879 #: ../src/guestfs-actions.pod:4062
10880 msgid "guestfs_mke2journal_U"
10884 #: ../src/guestfs-actions.pod:4064
10888 " guestfs_mke2journal_U (guestfs_h *g,\n"
10889 " int blocksize,\n"
10890 " const char *uuid,\n"
10891 " const char *device);\n"
10896 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2743
10897 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10901 #: ../src/guestfs-actions.pod:4076
10902 msgid "guestfs_mkfifo"
10906 #: ../src/guestfs-actions.pod:4078
10910 " guestfs_mkfifo (guestfs_h *g,\n"
10912 " const char *path);\n"
10917 #: ../src/guestfs-actions.pod:4083
10919 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10920 "is just a convenient wrapper around C<guestfs_mknod>."
10924 #: ../src/guestfs-actions.pod:4093
10925 msgid "guestfs_mkfs"
10929 #: ../src/guestfs-actions.pod:4095
10933 " guestfs_mkfs (guestfs_h *g,\n"
10934 " const char *fstype,\n"
10935 " const char *device);\n"
10940 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2759
10942 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10943 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10947 #: ../src/guestfs-actions.pod:4108
10948 msgid "guestfs_mkfs_b"
10952 #: ../src/guestfs-actions.pod:4110
10956 " guestfs_mkfs_b (guestfs_h *g,\n"
10957 " const char *fstype,\n"
10958 " int blocksize,\n"
10959 " const char *device);\n"
10964 #: ../src/guestfs-actions.pod:4116
10966 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10967 "block size of the resulting filesystem. Supported block sizes depend on the "
10968 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10972 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2772 ../fish/guestfish-actions.pod:2799
10974 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10979 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2775
10981 "This function is deprecated. In new code, use the C<mkfs_opts> call "
10986 #: ../src/guestfs-actions.pod:4135
10987 msgid "guestfs_mkfs_opts"
10991 #: ../src/guestfs-actions.pod:4137
10995 " guestfs_mkfs_opts (guestfs_h *g,\n"
10996 " const char *fstype,\n"
10997 " const char *device,\n"
11003 #: ../src/guestfs-actions.pod:4148
11006 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11011 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2786
11013 "This function creates a filesystem on C<device>. The filesystem type is "
11014 "C<fstype>, for example C<ext3>."
11018 #: ../src/guestfs-actions.pod:4157 ../fish/guestfish-actions.pod:2793
11019 msgid "C<blocksize>"
11023 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2795
11025 "The filesystem block size. Supported block sizes depend on the filesystem "
11026 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11031 #: ../src/guestfs-actions.pod:4170
11032 msgid "guestfs_mkfs_opts_va"
11036 #: ../src/guestfs-actions.pod:4172
11040 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11041 " const char *fstype,\n"
11042 " const char *device,\n"
11043 " va_list args);\n"
11048 #: ../src/guestfs-actions.pod:4178
11049 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11053 #: ../src/guestfs-actions.pod:4182
11054 msgid "guestfs_mkfs_opts_argv"
11058 #: ../src/guestfs-actions.pod:4184
11062 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
11063 " const char *fstype,\n"
11064 " const char *device,\n"
11065 " const struct guestfs_mkfs_opts_argv *optargs);\n"
11070 #: ../src/guestfs-actions.pod:4190
11071 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
11075 #: ../src/guestfs-actions.pod:4194
11076 msgid "guestfs_mkmountpoint"
11080 #: ../src/guestfs-actions.pod:4196
11084 " guestfs_mkmountpoint (guestfs_h *g,\n"
11085 " const char *exemptpath);\n"
11090 #: ../src/guestfs-actions.pod:4200
11092 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11093 "that can be used to create extra mountpoints before mounting the first "
11098 #: ../src/guestfs-actions.pod:4204 ../fish/guestfish-actions.pod:2814
11100 "These calls are I<only> necessary in some very limited circumstances, mainly "
11101 "the case where you want to mount a mix of unrelated and/or read-only "
11102 "filesystems together."
11106 #: ../src/guestfs-actions.pod:4208 ../fish/guestfish-actions.pod:2818
11108 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11109 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11110 "inside that. You can unpack this as follows in guestfish:"
11114 #: ../src/guestfs-actions.pod:4213 ../fish/guestfish-actions.pod:2823
11117 " add-ro Fedora-11-i686-Live.iso\n"
11119 " mkmountpoint /cd\n"
11120 " mkmountpoint /sqsh\n"
11121 " mkmountpoint /ext3fs\n"
11122 " mount /dev/sda /cd\n"
11123 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11124 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11129 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2832
11130 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11134 #: ../src/guestfs-actions.pod:4224
11136 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11137 "may get unexpected errors if you try to mix these calls. It is safest to "
11138 "manually unmount filesystems and remove mountpoints after use."
11142 #: ../src/guestfs-actions.pod:4228
11144 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11145 "first, so for this to work for manual mountpoints, you must ensure that the "
11146 "innermost mountpoints have the longest pathnames, as in the example code "
11151 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2843
11152 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11156 #: ../src/guestfs-actions.pod:4235
11158 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11159 "means that C<guestfs_umount_all> is called when the handle is closed which "
11160 "can also trigger these issues."
11164 #: ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4500 ../src/guestfs-actions.pod:5393
11165 msgid "(Added in 1.0.62)"
11169 #: ../src/guestfs-actions.pod:4243
11170 msgid "guestfs_mknod"
11174 #: ../src/guestfs-actions.pod:4245
11178 " guestfs_mknod (guestfs_h *g,\n"
11182 " const char *path);\n"
11187 #: ../src/guestfs-actions.pod:4252 ../fish/guestfish-actions.pod:2853
11189 "This call creates block or character special devices, or named pipes "
11194 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2856
11196 "The C<mode> parameter should be the mode, using the standard constants. "
11197 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11198 "used when creating block and character special devices."
11202 #: ../src/guestfs-actions.pod:4260
11204 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11205 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11206 "regular file). These constants are available in the standard Linux header "
11207 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11208 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11209 "the appropriate constant for you."
11213 #: ../src/guestfs-actions.pod:4274
11214 msgid "guestfs_mknod_b"
11218 #: ../src/guestfs-actions.pod:4276
11222 " guestfs_mknod_b (guestfs_h *g,\n"
11226 " const char *path);\n"
11231 #: ../src/guestfs-actions.pod:4283
11233 "This call creates a block device node called C<path> with mode C<mode> and "
11234 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11235 "wrapper around C<guestfs_mknod>."
11239 #: ../src/guestfs-actions.pod:4293
11240 msgid "guestfs_mknod_c"
11244 #: ../src/guestfs-actions.pod:4295
11248 " guestfs_mknod_c (guestfs_h *g,\n"
11252 " const char *path);\n"
11257 #: ../src/guestfs-actions.pod:4302
11259 "This call creates a char device node called C<path> with mode C<mode> and "
11260 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11261 "wrapper around C<guestfs_mknod>."
11265 #: ../src/guestfs-actions.pod:4312
11266 msgid "guestfs_mkswap"
11270 #: ../src/guestfs-actions.pod:4314
11274 " guestfs_mkswap (guestfs_h *g,\n"
11275 " const char *device);\n"
11280 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2895
11281 msgid "Create a swap partition on C<device>."
11285 #: ../src/guestfs-actions.pod:4324
11286 msgid "guestfs_mkswap_L"
11290 #: ../src/guestfs-actions.pod:4326
11294 " guestfs_mkswap_L (guestfs_h *g,\n"
11295 " const char *label,\n"
11296 " const char *device);\n"
11301 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2901
11302 msgid "Create a swap partition on C<device> with label C<label>."
11306 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2903
11308 "Note that you cannot attach a swap label to a block device "
11309 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
11310 "the kernel or swap tools."
11314 #: ../src/guestfs-actions.pod:4341
11315 msgid "guestfs_mkswap_U"
11319 #: ../src/guestfs-actions.pod:4343
11323 " guestfs_mkswap_U (guestfs_h *g,\n"
11324 " const char *uuid,\n"
11325 " const char *device);\n"
11330 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2911
11331 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11335 #: ../src/guestfs-actions.pod:4354
11336 msgid "guestfs_mkswap_file"
11340 #: ../src/guestfs-actions.pod:4356
11344 " guestfs_mkswap_file (guestfs_h *g,\n"
11345 " const char *path);\n"
11350 #: ../src/guestfs-actions.pod:4360 ../fish/guestfish-actions.pod:2917
11351 msgid "Create a swap file."
11355 #: ../src/guestfs-actions.pod:4362
11357 "This command just writes a swap file signature to an existing file. To "
11358 "create the file itself, use something like C<guestfs_fallocate>."
11362 #: ../src/guestfs-actions.pod:4369
11363 msgid "guestfs_modprobe"
11367 #: ../src/guestfs-actions.pod:4371
11371 " guestfs_modprobe (guestfs_h *g,\n"
11372 " const char *modulename);\n"
11377 #: ../src/guestfs-actions.pod:4375 ../fish/guestfish-actions.pod:2926
11378 msgid "This loads a kernel module in the appliance."
11382 #: ../src/guestfs-actions.pod:4377 ../fish/guestfish-actions.pod:2928
11384 "The kernel module must have been whitelisted when libguestfs was built (see "
11385 "C<appliance/kmod.whitelist.in> in the source)."
11389 #: ../src/guestfs-actions.pod:4384
11390 msgid "guestfs_mount"
11394 #: ../src/guestfs-actions.pod:4386
11398 " guestfs_mount (guestfs_h *g,\n"
11399 " const char *device,\n"
11400 " const char *mountpoint);\n"
11405 #: ../src/guestfs-actions.pod:4391 ../fish/guestfish-actions.pod:2935
11407 "Mount a guest disk at a position in the filesystem. Block devices are named "
11408 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11409 "those block devices contain partitions, they will have the usual names "
11410 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11414 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2941
11416 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11417 "mounted on C</> before others can be mounted. Other filesystems can only be "
11418 "mounted on directories which already exist."
11422 #: ../src/guestfs-actions.pod:4402 ../fish/guestfish-actions.pod:2946
11424 "The mounted filesystem is writable, if we have sufficient permissions on the "
11425 "underlying device."
11429 #: ../src/guestfs-actions.pod:4405
11431 "B<Important note:> When you use this call, the filesystem options C<sync> "
11432 "and C<noatime> are set implicitly. This was originally done because we "
11433 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11434 "very large negative performance impact and negligible effect on "
11435 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11436 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11437 "(use an empty string for the first parameter if you don't want any options)."
11441 #: ../src/guestfs-actions.pod:4419
11442 msgid "guestfs_mount_loop"
11446 #: ../src/guestfs-actions.pod:4421
11450 " guestfs_mount_loop (guestfs_h *g,\n"
11451 " const char *file,\n"
11452 " const char *mountpoint);\n"
11457 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:2963
11459 "This command lets you mount C<file> (a filesystem image in a file) on a "
11460 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11465 #: ../src/guestfs-actions.pod:4434
11466 msgid "guestfs_mount_options"
11470 #: ../src/guestfs-actions.pod:4436
11474 " guestfs_mount_options (guestfs_h *g,\n"
11475 " const char *options,\n"
11476 " const char *device,\n"
11477 " const char *mountpoint);\n"
11482 #: ../src/guestfs-actions.pod:4442
11484 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11485 "the mount options as for the L<mount(8)> I<-o> flag."
11489 #: ../src/guestfs-actions.pod:4446 ../fish/guestfish-actions.pod:2975
11491 "If the C<options> parameter is an empty string, then no options are passed "
11492 "(all options default to whatever the filesystem uses)."
11496 #: ../src/guestfs-actions.pod:4452 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4483
11497 msgid "(Added in 1.0.10)"
11501 #: ../src/guestfs-actions.pod:4454
11502 msgid "guestfs_mount_ro"
11506 #: ../src/guestfs-actions.pod:4456
11510 " guestfs_mount_ro (guestfs_h *g,\n"
11511 " const char *device,\n"
11512 " const char *mountpoint);\n"
11517 #: ../src/guestfs-actions.pod:4461
11519 "This is the same as the C<guestfs_mount> command, but it mounts the "
11520 "filesystem with the read-only (I<-o ro>) flag."
11524 #: ../src/guestfs-actions.pod:4468
11525 msgid "guestfs_mount_vfs"
11529 #: ../src/guestfs-actions.pod:4470
11533 " guestfs_mount_vfs (guestfs_h *g,\n"
11534 " const char *options,\n"
11535 " const char *vfstype,\n"
11536 " const char *device,\n"
11537 " const char *mountpoint);\n"
11542 #: ../src/guestfs-actions.pod:4477
11544 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11545 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
11550 #: ../src/guestfs-actions.pod:4485
11551 msgid "guestfs_mountpoints"
11555 #: ../src/guestfs-actions.pod:4487
11559 " guestfs_mountpoints (guestfs_h *g);\n"
11564 #: ../src/guestfs-actions.pod:4490
11566 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11567 "devices. This one returns a hash table (map) of device name to directory "
11568 "where the device is mounted."
11572 #: ../src/guestfs-actions.pod:4502
11573 msgid "guestfs_mounts"
11577 #: ../src/guestfs-actions.pod:4504
11581 " guestfs_mounts (guestfs_h *g);\n"
11586 #: ../src/guestfs-actions.pod:4507 ../fish/guestfish-actions.pod:3006
11588 "This returns the list of currently mounted filesystems. It returns the list "
11589 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11593 #: ../src/guestfs-actions.pod:4510 ../fish/guestfish-actions.pod:3009
11594 msgid "Some internal mounts are not shown."
11598 #: ../src/guestfs-actions.pod:4512
11599 msgid "See also: C<guestfs_mountpoints>"
11603 #: ../src/guestfs-actions.pod:4520
11608 #: ../src/guestfs-actions.pod:4522
11612 " guestfs_mv (guestfs_h *g,\n"
11613 " const char *src,\n"
11614 " const char *dest);\n"
11619 #: ../src/guestfs-actions.pod:4527 ../fish/guestfish-actions.pod:3017
11621 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11622 "destination filename or destination directory."
11626 #: ../src/guestfs-actions.pod:4534
11627 msgid "guestfs_ntfs_3g_probe"
11631 #: ../src/guestfs-actions.pod:4536
11635 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11637 " const char *device);\n"
11642 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3024
11644 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11645 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11646 "read-write, and some cannot be mounted at all)."
11650 #: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3028
11652 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11653 "can be mounted read-write. Set it to false if you want to test if the "
11654 "volume can be mounted read-only."
11658 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3032
11660 "The return value is an integer which C<0> if the operation would succeed, or "
11661 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11665 #: ../src/guestfs-actions.pod:4555
11666 msgid "(Added in 1.0.43)"
11670 #: ../src/guestfs-actions.pod:4557
11671 msgid "guestfs_ntfsresize"
11675 #: ../src/guestfs-actions.pod:4559
11679 " guestfs_ntfsresize (guestfs_h *g,\n"
11680 " const char *device);\n"
11685 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3040
11687 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11688 "size of the underlying device. See also L<ntfsresize(8)>."
11692 #: ../src/guestfs-actions.pod:4571
11693 msgid "guestfs_ntfsresize_size"
11697 #: ../src/guestfs-actions.pod:4573
11701 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11702 " const char *device,\n"
11703 " int64_t size);\n"
11708 #: ../src/guestfs-actions.pod:4578
11710 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11711 "to specify the new size (in bytes) explicitly."
11715 #: ../src/guestfs-actions.pod:4583 ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:5341
11716 msgid "(Added in 1.3.14)"
11720 #: ../src/guestfs-actions.pod:4585
11721 msgid "guestfs_part_add"
11725 #: ../src/guestfs-actions.pod:4587
11729 " guestfs_part_add (guestfs_h *g,\n"
11730 " const char *device,\n"
11731 " const char *prlogex,\n"
11732 " int64_t startsect,\n"
11733 " int64_t endsect);\n"
11738 #: ../src/guestfs-actions.pod:4594
11740 "This command adds a partition to C<device>. If there is no partition table "
11741 "on the device, call C<guestfs_part_init> first."
11745 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3058
11747 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11748 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11749 "C<logical>) and C<e> (or C<extended>) partition types."
11753 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3063
11755 "C<startsect> and C<endsect> are the start and end of the partition in "
11756 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11757 "from the end of the disk (C<-1> is the last sector)."
11761 #: ../src/guestfs-actions.pod:4606
11763 "Creating a partition which covers the whole disk is not so easy. Use "
11764 "C<guestfs_part_disk> to do that."
11768 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4877
11769 msgid "(Added in 1.0.78)"
11773 #: ../src/guestfs-actions.pod:4613
11774 msgid "guestfs_part_del"
11778 #: ../src/guestfs-actions.pod:4615
11782 " guestfs_part_del (guestfs_h *g,\n"
11783 " const char *device,\n"
11789 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3074
11790 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11794 #: ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:3076
11796 "Note that in the case of MBR partitioning, deleting an extended partition "
11797 "also deletes any logical partitions it contains."
11801 #: ../src/guestfs-actions.pod:4630
11802 msgid "guestfs_part_disk"
11806 #: ../src/guestfs-actions.pod:4632
11810 " guestfs_part_disk (guestfs_h *g,\n"
11811 " const char *device,\n"
11812 " const char *parttype);\n"
11817 #: ../src/guestfs-actions.pod:4637
11819 "This command is simply a combination of C<guestfs_part_init> followed by "
11820 "C<guestfs_part_add> to create a single primary partition covering the whole "
11825 #: ../src/guestfs-actions.pod:4641
11827 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11828 "possible values are described in C<guestfs_part_init>."
11832 #: ../src/guestfs-actions.pod:4651
11833 msgid "guestfs_part_get_bootable"
11837 #: ../src/guestfs-actions.pod:4653
11841 " guestfs_part_get_bootable (guestfs_h *g,\n"
11842 " const char *device,\n"
11848 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3098
11850 "This command returns true if the partition C<partnum> on C<device> has the "
11851 "bootable flag set."
11855 #: ../src/guestfs-actions.pod:4661
11856 msgid "See also C<guestfs_part_set_bootable>."
11860 #: ../src/guestfs-actions.pod:4667
11861 msgid "guestfs_part_get_mbr_id"
11865 #: ../src/guestfs-actions.pod:4669
11869 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11870 " const char *device,\n"
11876 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3107
11878 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11879 "partition C<partnum>."
11883 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4853
11885 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11886 "undefined results for other partition table types (see "
11887 "C<guestfs_part_get_parttype>)."
11891 #: ../src/guestfs-actions.pod:4685
11892 msgid "guestfs_part_get_parttype"
11896 #: ../src/guestfs-actions.pod:4687
11900 " guestfs_part_get_parttype (guestfs_h *g,\n"
11901 " const char *device);\n"
11906 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3118
11908 "This command examines the partition table on C<device> and returns the "
11909 "partition table type (format) being used."
11913 #: ../src/guestfs-actions.pod:4694
11915 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11916 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11917 "possible, although unusual. See C<guestfs_part_init> for a full list."
11921 #: ../src/guestfs-actions.pod:4704
11922 msgid "guestfs_part_init"
11926 #: ../src/guestfs-actions.pod:4706
11930 " guestfs_part_init (guestfs_h *g,\n"
11931 " const char *device,\n"
11932 " const char *parttype);\n"
11937 #: ../src/guestfs-actions.pod:4711 ../fish/guestfish-actions.pod:3130
11939 "This creates an empty partition table on C<device> of one of the partition "
11940 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11941 "(for large disks)."
11945 #: ../src/guestfs-actions.pod:4715
11947 "Initially there are no partitions. Following this, you should call "
11948 "C<guestfs_part_add> for each partition required."
11952 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3137
11953 msgid "Possible values for C<parttype> are:"
11957 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3141
11958 msgid "B<efi> | B<gpt>"
11962 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3143
11963 msgid "Intel EFI / GPT partition table."
11967 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3145
11969 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11970 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11971 "the C<mbr> format."
11975 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3149
11976 msgid "B<mbr> | B<msdos>"
11980 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3151
11982 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11983 "Windows. This partition type will B<only> work for device sizes up to 2 "
11984 "TB. For large disks we recommend using C<gpt>."
11988 #: ../src/guestfs-actions.pod:4739 ../fish/guestfish-actions.pod:3158
11989 msgid "Other partition table types that may work but are not supported include:"
11993 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3163
11998 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3165
11999 msgid "AIX disk labels."
12003 #: ../src/guestfs-actions.pod:4748 ../fish/guestfish-actions.pod:3167
12004 msgid "B<amiga> | B<rdb>"
12008 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3169
12009 msgid "Amiga \"Rigid Disk Block\" format."
12013 #: ../src/guestfs-actions.pod:4752 ../fish/guestfish-actions.pod:3171
12018 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3173
12019 msgid "BSD disk labels."
12023 #: ../src/guestfs-actions.pod:4756 ../fish/guestfish-actions.pod:3175
12028 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3177
12029 msgid "DASD, used on IBM mainframes."
12033 #: ../src/guestfs-actions.pod:4760 ../fish/guestfish-actions.pod:3179
12038 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3181
12039 msgid "MIPS/SGI volumes."
12043 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3183
12048 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3185
12049 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12053 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3187
12058 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3189
12059 msgid "NEC PC-98 format, common in Japan apparently."
12063 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3191
12068 #: ../src/guestfs-actions.pod:4774 ../fish/guestfish-actions.pod:3193
12069 msgid "Sun disk labels."
12073 #: ../src/guestfs-actions.pod:4782
12074 msgid "guestfs_part_list"
12078 #: ../src/guestfs-actions.pod:4784
12081 " struct guestfs_partition_list *\n"
12082 " guestfs_part_list (guestfs_h *g,\n"
12083 " const char *device);\n"
12088 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3201
12090 "This command parses the partition table on C<device> and returns the list of "
12091 "partitions found."
12095 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3204
12096 msgid "The fields in the returned structure are:"
12100 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3208
12101 msgid "B<part_num>"
12105 #: ../src/guestfs-actions.pod:4797 ../fish/guestfish-actions.pod:3210
12106 msgid "Partition number, counting from 1."
12110 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3212
12111 msgid "B<part_start>"
12115 #: ../src/guestfs-actions.pod:4801
12117 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12118 "the device's sector size, see C<guestfs_blockdev_getss>."
12122 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3217
12123 msgid "B<part_end>"
12127 #: ../src/guestfs-actions.pod:4806 ../fish/guestfish-actions.pod:3219
12128 msgid "End of the partition in bytes."
12132 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3221
12133 msgid "B<part_size>"
12137 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3223
12138 msgid "Size of the partition in bytes."
12142 #: ../src/guestfs-actions.pod:4814
12144 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12145 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12150 #: ../src/guestfs-actions.pod:4820
12151 msgid "guestfs_part_set_bootable"
12155 #: ../src/guestfs-actions.pod:4822
12159 " guestfs_part_set_bootable (guestfs_h *g,\n"
12160 " const char *device,\n"
12162 " int bootable);\n"
12167 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3231
12169 "This sets the bootable flag on partition numbered C<partnum> on device "
12170 "C<device>. Note that partitions are numbered from 1."
12174 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3234
12176 "The bootable flag is used by some operating systems (notably Windows) to "
12177 "determine which partition to boot from. It is by no means universally "
12182 #: ../src/guestfs-actions.pod:4839
12183 msgid "guestfs_part_set_mbr_id"
12187 #: ../src/guestfs-actions.pod:4841
12191 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12192 " const char *device,\n"
12199 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3242
12201 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12202 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12203 "documentation are in fact hexadecimal numbers, but usually documented "
12204 "without any leading \"0x\" which might be confusing."
12208 #: ../src/guestfs-actions.pod:4861
12209 msgid "guestfs_part_set_name"
12213 #: ../src/guestfs-actions.pod:4863
12217 " guestfs_part_set_name (guestfs_h *g,\n"
12218 " const char *device,\n"
12220 " const char *name);\n"
12225 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3256
12227 "This sets the partition name on partition numbered C<partnum> on device "
12228 "C<device>. Note that partitions are numbered from 1."
12232 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3259
12234 "The partition name can only be set on certain types of partition table. "
12235 "This works on C<gpt> but not on C<mbr> partitions."
12239 #: ../src/guestfs-actions.pod:4879
12240 msgid "guestfs_part_to_dev"
12244 #: ../src/guestfs-actions.pod:4881
12248 " guestfs_part_to_dev (guestfs_h *g,\n"
12249 " const char *partition);\n"
12254 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3266
12256 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12257 "partition number, returning the device name (eg. \"/dev/sdb\")."
12261 #: ../src/guestfs-actions.pod:4889
12263 "The named partition must exist, for example as a string returned from "
12264 "C<guestfs_list_partitions>."
12268 #: ../src/guestfs-actions.pod:4897
12269 msgid "guestfs_ping_daemon"
12273 #: ../src/guestfs-actions.pod:4899
12277 " guestfs_ping_daemon (guestfs_h *g);\n"
12282 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3277
12284 "This is a test probe into the guestfs daemon running inside the qemu "
12285 "subprocess. Calling this function checks that the daemon responds to the "
12286 "ping message, without affecting the daemon or attached block device(s) in "
12291 #: ../src/guestfs-actions.pod:4911
12292 msgid "guestfs_pread"
12296 #: ../src/guestfs-actions.pod:4913
12300 " guestfs_pread (guestfs_h *g,\n"
12301 " const char *path,\n"
12303 " int64_t offset,\n"
12304 " size_t *size_r);\n"
12309 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3286
12311 "This command lets you read part of a file. It reads C<count> bytes of the "
12312 "file, starting at C<offset>, from file C<path>."
12316 #: ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3289 ../fish/guestfish-actions.pod:3304
12318 "This may read fewer bytes than requested. For further details see the "
12319 "L<pread(2)> system call."
12323 #: ../src/guestfs-actions.pod:4926
12324 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12328 #: ../src/guestfs-actions.pod:4937
12329 msgid "guestfs_pread_device"
12333 #: ../src/guestfs-actions.pod:4939
12337 " guestfs_pread_device (guestfs_h *g,\n"
12338 " const char *device,\n"
12340 " int64_t offset,\n"
12341 " size_t *size_r);\n"
12346 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3301
12348 "This command lets you read part of a file. It reads C<count> bytes of "
12349 "C<device>, starting at C<offset>."
12353 #: ../src/guestfs-actions.pod:4952
12354 msgid "See also C<guestfs_pread>."
12358 #: ../src/guestfs-actions.pod:4961
12359 msgid "(Added in 1.5.21)"
12363 #: ../src/guestfs-actions.pod:4963
12364 msgid "guestfs_pvcreate"
12368 #: ../src/guestfs-actions.pod:4965
12372 " guestfs_pvcreate (guestfs_h *g,\n"
12373 " const char *device);\n"
12378 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3316
12380 "This creates an LVM physical volume on the named C<device>, where C<device> "
12381 "should usually be a partition name such as C</dev/sda1>."
12385 #: ../src/guestfs-actions.pod:4977
12386 msgid "guestfs_pvremove"
12390 #: ../src/guestfs-actions.pod:4979
12394 " guestfs_pvremove (guestfs_h *g,\n"
12395 " const char *device);\n"
12400 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3324
12402 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12407 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3327
12409 "The implementation uses the C<pvremove> command which refuses to wipe "
12410 "physical volumes that contain any volume groups, so you have to remove those "
12415 #: ../src/guestfs-actions.pod:4994
12416 msgid "guestfs_pvresize"
12420 #: ../src/guestfs-actions.pod:4996
12424 " guestfs_pvresize (guestfs_h *g,\n"
12425 " const char *device);\n"
12430 #: ../src/guestfs-actions.pod:5000 ../fish/guestfish-actions.pod:3335
12432 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12433 "the new size of the underlying device."
12437 #: ../src/guestfs-actions.pod:5007
12438 msgid "guestfs_pvresize_size"
12442 #: ../src/guestfs-actions.pod:5009
12446 " guestfs_pvresize_size (guestfs_h *g,\n"
12447 " const char *device,\n"
12448 " int64_t size);\n"
12453 #: ../src/guestfs-actions.pod:5014
12455 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12456 "specify the new size (in bytes) explicitly."
12460 #: ../src/guestfs-actions.pod:5021
12461 msgid "guestfs_pvs"
12465 #: ../src/guestfs-actions.pod:5023
12469 " guestfs_pvs (guestfs_h *g);\n"
12474 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3349
12476 "List all the physical volumes detected. This is the equivalent of the "
12477 "L<pvs(8)> command."
12481 #: ../src/guestfs-actions.pod:5029 ../fish/guestfish-actions.pod:3352
12483 "This returns a list of just the device names that contain PVs "
12484 "(eg. C</dev/sda2>)."
12488 #: ../src/guestfs-actions.pod:5032
12489 msgid "See also C<guestfs_pvs_full>."
12493 #: ../src/guestfs-actions.pod:5040
12494 msgid "guestfs_pvs_full"
12498 #: ../src/guestfs-actions.pod:5042
12501 " struct guestfs_lvm_pv_list *\n"
12502 " guestfs_pvs_full (guestfs_h *g);\n"
12507 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3361
12509 "List all the physical volumes detected. This is the equivalent of the "
12510 "L<pvs(8)> command. The \"full\" version includes all fields."
12514 #: ../src/guestfs-actions.pod:5048
12516 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12517 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
12522 #: ../src/guestfs-actions.pod:5054
12523 msgid "guestfs_pvuuid"
12527 #: ../src/guestfs-actions.pod:5056
12531 " guestfs_pvuuid (guestfs_h *g,\n"
12532 " const char *device);\n"
12537 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3368
12538 msgid "This command returns the UUID of the LVM PV C<device>."
12542 #: ../src/guestfs-actions.pod:5067
12543 msgid "guestfs_pwrite"
12547 #: ../src/guestfs-actions.pod:5069
12551 " guestfs_pwrite (guestfs_h *g,\n"
12552 " const char *path,\n"
12553 " const char *content,\n"
12554 " size_t content_size,\n"
12555 " int64_t offset);\n"
12560 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3374
12562 "This command writes to part of a file. It writes the data buffer C<content> "
12563 "to the file C<path> starting at offset C<offset>."
12567 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3377
12569 "This command implements the L<pwrite(2)> system call, and like that system "
12570 "call it may not write the full data requested. The return value is the "
12571 "number of bytes that were actually written to the file. This could even be "
12572 "0, although short writes are unlikely for regular files in ordinary "
12577 #: ../src/guestfs-actions.pod:5085
12578 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12582 #: ../src/guestfs-actions.pod:5094
12583 msgid "guestfs_pwrite_device"
12587 #: ../src/guestfs-actions.pod:5096
12591 " guestfs_pwrite_device (guestfs_h *g,\n"
12592 " const char *device,\n"
12593 " const char *content,\n"
12594 " size_t content_size,\n"
12595 " int64_t offset);\n"
12600 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3392
12602 "This command writes to part of a device. It writes the data buffer "
12603 "C<content> to C<device> starting at offset C<offset>."
12607 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3395
12609 "This command implements the L<pwrite(2)> system call, and like that system "
12610 "call it may not write the full data requested (although short writes to disk "
12611 "devices and partitions are probably impossible with standard Linux kernels)."
12615 #: ../src/guestfs-actions.pod:5111
12616 msgid "See also C<guestfs_pwrite>."
12620 #: ../src/guestfs-actions.pod:5118
12621 msgid "(Added in 1.5.20)"
12625 #: ../src/guestfs-actions.pod:5120
12626 msgid "guestfs_read_file"
12630 #: ../src/guestfs-actions.pod:5122
12634 " guestfs_read_file (guestfs_h *g,\n"
12635 " const char *path,\n"
12636 " size_t *size_r);\n"
12641 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3409
12642 msgid "This calls returns the contents of the file C<path> as a buffer."
12646 #: ../src/guestfs-actions.pod:5130
12648 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12649 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12650 "function is limited in the total size of file that can be handled."
12654 #: ../src/guestfs-actions.pod:5142
12655 msgid "(Added in 1.0.63)"
12659 #: ../src/guestfs-actions.pod:5144
12660 msgid "guestfs_read_lines"
12664 #: ../src/guestfs-actions.pod:5146
12668 " guestfs_read_lines (guestfs_h *g,\n"
12669 " const char *path);\n"
12674 #: ../src/guestfs-actions.pod:5152 ../fish/guestfish-actions.pod:3426
12676 "The file contents are returned as a list of lines. Trailing C<LF> and "
12677 "C<CRLF> character sequences are I<not> returned."
12681 #: ../src/guestfs-actions.pod:5155
12683 "Note that this function cannot correctly handle binary files (specifically, "
12684 "files containing C<\\0> character which is treated as end of line). For "
12685 "those you need to use the C<guestfs_read_file> function which has a more "
12686 "complex interface."
12690 #: ../src/guestfs-actions.pod:5166
12691 msgid "guestfs_readdir"
12695 #: ../src/guestfs-actions.pod:5168
12698 " struct guestfs_dirent_list *\n"
12699 " guestfs_readdir (guestfs_h *g,\n"
12700 " const char *dir);\n"
12705 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3438
12706 msgid "This returns the list of directory entries in directory C<dir>."
12710 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3440
12712 "All entries in the directory are returned, including C<.> and C<..>. The "
12713 "entries are I<not> sorted, but returned in the same order as the underlying "
12718 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3444
12720 "Also this call returns basic file type information about each file. The "
12721 "C<ftyp> field will contain one of the following characters:"
12725 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3449
12730 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3451
12731 msgid "Block special"
12735 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3453
12740 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3455
12741 msgid "Char special"
12745 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:3457
12750 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3459
12755 #: ../src/guestfs-actions.pod:5195 ../fish/guestfish-actions.pod:3461
12760 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3463
12761 msgid "FIFO (named pipe)"
12765 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3465
12770 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3467
12771 msgid "Symbolic link"
12775 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3469
12780 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3471
12781 msgid "Regular file"
12785 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3473
12790 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3475
12795 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3477
12800 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3479
12801 msgid "Unknown file type"
12805 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3481
12810 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3483
12811 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12815 #: ../src/guestfs-actions.pod:5222
12817 "This function is primarily intended for use by programs. To get a simple "
12818 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12819 "consumption, use C<guestfs_ll>."
12823 #: ../src/guestfs-actions.pod:5226
12825 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12826 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
12831 #: ../src/guestfs-actions.pod:5232
12832 msgid "guestfs_readlink"
12836 #: ../src/guestfs-actions.pod:5234
12840 " guestfs_readlink (guestfs_h *g,\n"
12841 " const char *path);\n"
12846 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3496
12847 msgid "This command reads the target of a symbolic link."
12851 #: ../src/guestfs-actions.pod:5245
12852 msgid "guestfs_readlinklist"
12856 #: ../src/guestfs-actions.pod:5247
12860 " guestfs_readlinklist (guestfs_h *g,\n"
12861 " const char *path,\n"
12862 " char *const *names);\n"
12867 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3502
12869 "This call allows you to do a C<readlink> operation on multiple files, where "
12870 "all files are in the directory C<path>. C<names> is the list of files from "
12875 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3506
12877 "On return you get a list of strings, with a one-to-one correspondence to the "
12878 "C<names> list. Each string is the value of the symbolic link."
12882 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3510
12884 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12885 "result string is the empty string C<\"\">. However the whole operation is "
12886 "completed even if there were C<readlink(2)> errors, and so you can call this "
12887 "function with names where you don't know if they are symbolic links already "
12888 "(albeit slightly less efficient)."
12892 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3517
12894 "This call is intended for programs that want to efficiently list a directory "
12895 "contents without making many round-trips. Very long directory listings "
12896 "might cause the protocol message size to be exceeded, causing this call to "
12897 "fail. The caller must split up such requests into smaller groups of names."
12901 #: ../src/guestfs-actions.pod:5280
12902 msgid "guestfs_realpath"
12906 #: ../src/guestfs-actions.pod:5282
12910 " guestfs_realpath (guestfs_h *g,\n"
12911 " const char *path);\n"
12916 #: ../src/guestfs-actions.pod:5286 ../fish/guestfish-actions.pod:3528
12918 "Return the canonicalized absolute pathname of C<path>. The returned path "
12919 "has no C<.>, C<..> or symbolic link path elements."
12923 #: ../src/guestfs-actions.pod:5294
12924 msgid "guestfs_removexattr"
12928 #: ../src/guestfs-actions.pod:5296
12932 " guestfs_removexattr (guestfs_h *g,\n"
12933 " const char *xattr,\n"
12934 " const char *path);\n"
12939 #: ../src/guestfs-actions.pod:5301 ../fish/guestfish-actions.pod:3535
12940 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12944 #: ../src/guestfs-actions.pod:5304
12945 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12949 #: ../src/guestfs-actions.pod:5310
12950 msgid "guestfs_resize2fs"
12954 #: ../src/guestfs-actions.pod:5312
12958 " guestfs_resize2fs (guestfs_h *g,\n"
12959 " const char *device);\n"
12964 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3544
12966 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12967 "underlying device."
12971 #: ../src/guestfs-actions.pod:5319
12973 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12974 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12975 "sometimes gives an error about this and sometimes not. In any case, it is "
12976 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12980 #: ../src/guestfs-actions.pod:5329
12981 msgid "guestfs_resize2fs_size"
12985 #: ../src/guestfs-actions.pod:5331
12989 " guestfs_resize2fs_size (guestfs_h *g,\n"
12990 " const char *device,\n"
12991 " int64_t size);\n"
12996 #: ../src/guestfs-actions.pod:5336
12998 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12999 "to specify the new size (in bytes) explicitly."
13003 #: ../src/guestfs-actions.pod:5343
13008 #: ../src/guestfs-actions.pod:5345
13012 " guestfs_rm (guestfs_h *g,\n"
13013 " const char *path);\n"
13018 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:3564
13019 msgid "Remove the single file C<path>."
13023 #: ../src/guestfs-actions.pod:5355
13024 msgid "guestfs_rm_rf"
13028 #: ../src/guestfs-actions.pod:5357
13032 " guestfs_rm_rf (guestfs_h *g,\n"
13033 " const char *path);\n"
13038 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3570
13040 "Remove the file or directory C<path>, recursively removing the contents if "
13041 "its a directory. This is like the C<rm -rf> shell command."
13045 #: ../src/guestfs-actions.pod:5369
13046 msgid "guestfs_rmdir"
13050 #: ../src/guestfs-actions.pod:5371
13054 " guestfs_rmdir (guestfs_h *g,\n"
13055 " const char *path);\n"
13060 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3578
13061 msgid "Remove the single directory C<path>."
13065 #: ../src/guestfs-actions.pod:5381
13066 msgid "guestfs_rmmountpoint"
13070 #: ../src/guestfs-actions.pod:5383
13074 " guestfs_rmmountpoint (guestfs_h *g,\n"
13075 " const char *exemptpath);\n"
13080 #: ../src/guestfs-actions.pod:5387
13082 "This calls removes a mountpoint that was previously created with "
13083 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13087 #: ../src/guestfs-actions.pod:5395
13088 msgid "guestfs_scrub_device"
13092 #: ../src/guestfs-actions.pod:5397
13096 " guestfs_scrub_device (guestfs_h *g,\n"
13097 " const char *device);\n"
13102 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3592
13104 "This command writes patterns over C<device> to make data retrieval more "
13109 #: ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:5425 ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3595 ../fish/guestfish-actions.pod:3610 ../fish/guestfish-actions.pod:3623
13111 "It is an interface to the L<scrub(1)> program. See that manual page for "
13116 #: ../src/guestfs-actions.pod:5412 ../src/guestfs-actions.pod:5430 ../src/guestfs-actions.pod:5449
13117 msgid "(Added in 1.0.52)"
13121 #: ../src/guestfs-actions.pod:5414
13122 msgid "guestfs_scrub_file"
13126 #: ../src/guestfs-actions.pod:5416
13130 " guestfs_scrub_file (guestfs_h *g,\n"
13131 " const char *file);\n"
13136 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3605
13138 "This command writes patterns over a file to make data retrieval more "
13143 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3608
13144 msgid "The file is I<removed> after scrubbing."
13148 #: ../src/guestfs-actions.pod:5432
13149 msgid "guestfs_scrub_freespace"
13153 #: ../src/guestfs-actions.pod:5434
13157 " guestfs_scrub_freespace (guestfs_h *g,\n"
13158 " const char *dir);\n"
13163 #: ../src/guestfs-actions.pod:5438
13165 "This command creates the directory C<dir> and then fills it with files until "
13166 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13167 "and deletes them. The intention is to scrub any free space on the partition "
13168 "containing C<dir>."
13172 #: ../src/guestfs-actions.pod:5451
13173 msgid "guestfs_set_append"
13177 #: ../src/guestfs-actions.pod:5453
13181 " guestfs_set_append (guestfs_h *g,\n"
13182 " const char *append);\n"
13187 #: ../src/guestfs-actions.pod:5457 ../fish/guestfish-actions.pod:3632
13189 "This function is used to add additional options to the guest kernel command "
13194 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3635
13196 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13197 "environment variable."
13201 #: ../src/guestfs-actions.pod:5463 ../fish/guestfish-actions.pod:3638
13203 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13204 "(libguestfs always adds a few of its own)."
13208 #: ../src/guestfs-actions.pod:5470
13209 msgid "guestfs_set_autosync"
13213 #: ../src/guestfs-actions.pod:5472
13217 " guestfs_set_autosync (guestfs_h *g,\n"
13218 " int autosync);\n"
13223 #: ../src/guestfs-actions.pod:5476
13225 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13226 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13227 "the handle is closed (also if the program exits without closing handles)."
13231 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3652
13233 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13234 "disabled by default)."
13238 #: ../src/guestfs-actions.pod:5488
13239 msgid "guestfs_set_direct"
13243 #: ../src/guestfs-actions.pod:5490
13247 " guestfs_set_direct (guestfs_h *g,\n"
13253 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3661
13255 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13256 "passed directly through to the appliance once it is launched."
13260 #: ../src/guestfs-actions.pod:5498
13262 "One consequence of this is that log messages aren't caught by the library "
13263 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13268 #: ../src/guestfs-actions.pod:5502 ../fish/guestfish-actions.pod:3669
13269 msgid "You probably don't want to use this unless you know what you are doing."
13273 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3672
13274 msgid "The default is disabled."
13278 #: ../src/guestfs-actions.pod:5511
13279 msgid "guestfs_set_e2label"
13283 #: ../src/guestfs-actions.pod:5513
13287 " guestfs_set_e2label (guestfs_h *g,\n"
13288 " const char *device,\n"
13289 " const char *label);\n"
13294 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3678
13296 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13297 "C<label>. Filesystem labels are limited to 16 characters."
13301 #: ../src/guestfs-actions.pod:5522
13303 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13304 "the existing label on a filesystem."
13308 #: ../src/guestfs-actions.pod:5529
13309 msgid "guestfs_set_e2uuid"
13313 #: ../src/guestfs-actions.pod:5531
13317 " guestfs_set_e2uuid (guestfs_h *g,\n"
13318 " const char *device,\n"
13319 " const char *uuid);\n"
13324 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3689
13326 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13327 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13328 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13332 #: ../src/guestfs-actions.pod:5541
13334 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13335 "the existing UUID of a filesystem."
13339 #: ../src/guestfs-actions.pod:5548
13340 msgid "guestfs_set_memsize"
13344 #: ../src/guestfs-actions.pod:5550
13348 " guestfs_set_memsize (guestfs_h *g,\n"
13354 #: ../src/guestfs-actions.pod:5554
13356 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13357 "This only has any effect if called before C<guestfs_launch>."
13361 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3707
13363 "You can also change this by setting the environment variable "
13364 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13368 #: ../src/guestfs-actions.pod:5569
13369 msgid "guestfs_set_network"
13373 #: ../src/guestfs-actions.pod:5571
13377 " guestfs_set_network (guestfs_h *g,\n"
13383 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3720
13385 "If C<network> is true, then the network is enabled in the libguestfs "
13386 "appliance. The default is false."
13390 #: ../src/guestfs-actions.pod:5578 ../fish/guestfish-actions.pod:3723
13392 "This affects whether commands are able to access the network (see "
13393 "L<guestfs(3)/RUNNING COMMANDS>)."
13397 #: ../src/guestfs-actions.pod:5581
13399 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13404 #: ../src/guestfs-actions.pod:5588
13405 msgid "guestfs_set_path"
13409 #: ../src/guestfs-actions.pod:5590
13413 " guestfs_set_path (guestfs_h *g,\n"
13414 " const char *searchpath);\n"
13419 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3735
13420 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13424 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3737
13426 "The default is C<$libdir/guestfs> unless overridden by setting "
13427 "C<LIBGUESTFS_PATH> environment variable."
13431 #: ../src/guestfs-actions.pod:5599 ../fish/guestfish-actions.pod:3740
13432 msgid "Setting C<path> to C<NULL> restores the default path."
13436 #: ../src/guestfs-actions.pod:5605
13437 msgid "guestfs_set_qemu"
13441 #: ../src/guestfs-actions.pod:5607
13445 " guestfs_set_qemu (guestfs_h *g,\n"
13446 " const char *qemu);\n"
13451 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3748
13452 msgid "Set the qemu binary that we will use."
13456 #: ../src/guestfs-actions.pod:5613 ../fish/guestfish-actions.pod:3750
13457 msgid "The default is chosen when the library was compiled by the configure script."
13461 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3753
13463 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13468 #: ../src/guestfs-actions.pod:5619 ../fish/guestfish-actions.pod:3756
13469 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13473 #: ../src/guestfs-actions.pod:5621 ../fish/guestfish-actions.pod:3758
13475 "Note that you should call this function as early as possible after creating "
13476 "the handle. This is because some pre-launch operations depend on testing "
13477 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13478 "don't retest features, and so you might see inconsistent results. Using the "
13479 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13480 "the qemu binary at the same time as the handle is created."
13484 #: ../src/guestfs-actions.pod:5633
13485 msgid "guestfs_set_recovery_proc"
13489 #: ../src/guestfs-actions.pod:5635
13493 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13494 " int recoveryproc);\n"
13499 #: ../src/guestfs-actions.pod:5639
13501 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13502 "not create a recovery process. The purpose of the recovery process is to "
13503 "stop runaway qemu processes in the case where the main program aborts "
13508 #: ../src/guestfs-actions.pod:5644
13510 "This only has any effect if called before C<guestfs_launch>, and the default "
13515 #: ../src/guestfs-actions.pod:5647 ../fish/guestfish-actions.pod:3780
13517 "About the only time when you would want to disable this is if the main "
13518 "process will fork itself into the background (\"daemonize\" itself). In "
13519 "this case the recovery process thinks that the main program has disappeared "
13520 "and so kills qemu, which is not very helpful."
13524 #: ../src/guestfs-actions.pod:5657
13525 msgid "guestfs_set_selinux"
13529 #: ../src/guestfs-actions.pod:5659
13533 " guestfs_set_selinux (guestfs_h *g,\n"
13539 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3792
13541 "This sets the selinux flag that is passed to the appliance at boot time. "
13542 "The default is C<selinux=0> (disabled)."
13546 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3795
13548 "Note that if SELinux is enabled, it is always in Permissive mode "
13549 "(C<enforcing=0>)."
13553 #: ../src/guestfs-actions.pod:5676
13554 msgid "guestfs_set_trace"
13558 #: ../src/guestfs-actions.pod:5678
13562 " guestfs_set_trace (guestfs_h *g,\n"
13568 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3807
13570 "If the command trace flag is set to 1, then commands are printed on stderr "
13571 "before they are executed in a format which is very similar to the one used "
13572 "by guestfish. In other words, you can run a program with this enabled, and "
13573 "you will get out a script which you can feed to guestfish to perform the "
13574 "same set of actions."
13578 #: ../src/guestfs-actions.pod:5689 ../fish/guestfish-actions.pod:3814
13580 "If you want to trace C API calls into libguestfs (and other libraries) then "
13581 "possibly a better way is to use the external ltrace(1) command."
13585 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3818
13587 "Command traces are disabled unless the environment variable "
13588 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13592 #: ../src/guestfs-actions.pod:5700
13593 msgid "guestfs_set_verbose"
13597 #: ../src/guestfs-actions.pod:5702
13601 " guestfs_set_verbose (guestfs_h *g,\n"
13607 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3827
13608 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13612 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3829
13614 "Verbose messages are disabled unless the environment variable "
13615 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13619 #: ../src/guestfs-actions.pod:5715
13620 msgid "guestfs_setcon"
13624 #: ../src/guestfs-actions.pod:5717
13628 " guestfs_setcon (guestfs_h *g,\n"
13629 " const char *context);\n"
13634 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3836
13636 "This sets the SELinux security context of the daemon to the string "
13641 #: ../src/guestfs-actions.pod:5724 ../fish/guestfish-actions.pod:3839
13642 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13646 #: ../src/guestfs-actions.pod:5730
13647 msgid "guestfs_setxattr"
13651 #: ../src/guestfs-actions.pod:5732
13655 " guestfs_setxattr (guestfs_h *g,\n"
13656 " const char *xattr,\n"
13657 " const char *val,\n"
13659 " const char *path);\n"
13664 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3845
13666 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13667 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13671 #: ../src/guestfs-actions.pod:5743
13672 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13676 #: ../src/guestfs-actions.pod:5749
13677 msgid "guestfs_sfdisk"
13681 #: ../src/guestfs-actions.pod:5751
13685 " guestfs_sfdisk (guestfs_h *g,\n"
13686 " const char *device,\n"
13690 " char *const *lines);\n"
13695 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3855
13697 "This is a direct interface to the L<sfdisk(8)> program for creating "
13698 "partitions on block devices."
13702 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3858
13703 msgid "C<device> should be a block device, for example C</dev/sda>."
13707 #: ../src/guestfs-actions.pod:5764 ../fish/guestfish-actions.pod:3860
13709 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13710 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13711 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13712 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13713 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13714 "the kernel) cannot work out the right geometry and you will need to tell it."
13718 #: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3868
13720 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13721 "refer to the L<sfdisk(8)> manpage."
13725 #: ../src/guestfs-actions.pod:5775 ../fish/guestfish-actions.pod:3871
13727 "To create a single partition occupying the whole disk, you would pass "
13728 "C<lines> as a single element list, when the single element being the string "
13733 #: ../src/guestfs-actions.pod:5779
13734 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13738 #: ../src/guestfs-actions.pod:5789
13739 msgid "guestfs_sfdiskM"
13743 #: ../src/guestfs-actions.pod:5791
13747 " guestfs_sfdiskM (guestfs_h *g,\n"
13748 " const char *device,\n"
13749 " char *const *lines);\n"
13754 #: ../src/guestfs-actions.pod:5796
13756 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13757 "partition sizes are specified in megabytes only (rounded to the nearest "
13758 "cylinder) and you don't need to specify the cyls, heads and sectors "
13759 "parameters which were rarely if ever used anyway."
13763 #: ../src/guestfs-actions.pod:5802
13765 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13766 "C<guestfs_part_disk>"
13770 #: ../src/guestfs-actions.pod:5812
13771 msgid "guestfs_sfdisk_N"
13775 #: ../src/guestfs-actions.pod:5814
13779 " guestfs_sfdisk_N (guestfs_h *g,\n"
13780 " const char *device,\n"
13785 " const char *line);\n"
13790 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3901
13792 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13793 "(note: C<n> counts from 1)."
13797 #: ../src/guestfs-actions.pod:5826
13799 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13800 "for the cyls/heads/sectors parameters."
13804 #: ../src/guestfs-actions.pod:5829
13805 msgid "See also: C<guestfs_part_add>"
13809 #: ../src/guestfs-actions.pod:5838
13810 msgid "guestfs_sfdisk_disk_geometry"
13814 #: ../src/guestfs-actions.pod:5840
13818 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13819 " const char *device);\n"
13824 #: ../src/guestfs-actions.pod:5844
13826 "This displays the disk geometry of C<device> read from the partition table. "
13827 "Especially in the case where the underlying block device has been resized, "
13828 "this can be different from the kernel's idea of the geometry (see "
13829 "C<guestfs_sfdisk_kernel_geometry>)."
13833 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5865 ../fish/guestfish-actions.pod:3921 ../fish/guestfish-actions.pod:3930
13834 msgid "The result is in human-readable format, and not designed to be parsed."
13838 #: ../src/guestfs-actions.pod:5857
13839 msgid "guestfs_sfdisk_kernel_geometry"
13843 #: ../src/guestfs-actions.pod:5859
13847 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13848 " const char *device);\n"
13853 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3928
13854 msgid "This displays the kernel's idea of the geometry of C<device>."
13858 #: ../src/guestfs-actions.pod:5873
13859 msgid "guestfs_sfdisk_l"
13863 #: ../src/guestfs-actions.pod:5875
13867 " guestfs_sfdisk_l (guestfs_h *g,\n"
13868 " const char *device);\n"
13873 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3937
13875 "This displays the partition table on C<device>, in the human-readable output "
13876 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13880 #: ../src/guestfs-actions.pod:5883
13881 msgid "See also: C<guestfs_part_list>"
13885 #: ../src/guestfs-actions.pod:5890
13890 #: ../src/guestfs-actions.pod:5892
13894 " guestfs_sh (guestfs_h *g,\n"
13895 " const char *command);\n"
13900 #: ../src/guestfs-actions.pod:5896 ../fish/guestfish-actions.pod:3947
13902 "This call runs a command from the guest filesystem via the guest's "
13907 #: ../src/guestfs-actions.pod:5899
13908 msgid "This is like C<guestfs_command>, but passes the command to:"
13912 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3952
13915 " /bin/sh -c \"command\"\n"
13920 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3954
13922 "Depending on the guest's shell, this usually results in wildcards being "
13923 "expanded, shell expressions being interpolated and so on."
13927 #: ../src/guestfs-actions.pod:5907
13928 msgid "All the provisos about C<guestfs_command> apply to this call."
13932 #: ../src/guestfs-actions.pod:5914
13933 msgid "guestfs_sh_lines"
13937 #: ../src/guestfs-actions.pod:5916
13941 " guestfs_sh_lines (guestfs_h *g,\n"
13942 " const char *command);\n"
13947 #: ../src/guestfs-actions.pod:5920
13949 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13954 #: ../src/guestfs-actions.pod:5923
13955 msgid "See also: C<guestfs_command_lines>"
13959 #: ../src/guestfs-actions.pod:5931
13960 msgid "guestfs_sleep"
13964 #: ../src/guestfs-actions.pod:5933
13968 " guestfs_sleep (guestfs_h *g,\n"
13974 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3973
13975 msgid "Sleep for C<secs> seconds."
13979 #: ../src/guestfs-actions.pod:5941
13980 msgid "(Added in 1.0.41)"
13984 #: ../src/guestfs-actions.pod:5943 ../src/guestfs-structs.pod:109
13985 msgid "guestfs_stat"
13989 #: ../src/guestfs-actions.pod:5945
13992 " struct guestfs_stat *\n"
13993 " guestfs_stat (guestfs_h *g,\n"
13994 " const char *path);\n"
13999 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3981
14000 msgid "This is the same as the C<stat(2)> system call."
14004 #: ../src/guestfs-actions.pod:5959 ../src/guestfs-structs.pod:135
14005 msgid "guestfs_statvfs"
14009 #: ../src/guestfs-actions.pod:5961
14012 " struct guestfs_statvfs *\n"
14013 " guestfs_statvfs (guestfs_h *g,\n"
14014 " const char *path);\n"
14019 #: ../src/guestfs-actions.pod:5965 ../fish/guestfish-actions.pod:3987
14021 "Returns file system statistics for any mounted file system. C<path> should "
14022 "be a file or directory in the mounted file system (typically it is the mount "
14023 "point itself, but it doesn't need to be)."
14027 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3991
14028 msgid "This is the same as the C<statvfs(2)> system call."
14032 #: ../src/guestfs-actions.pod:5971
14034 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14035 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14039 #: ../src/guestfs-actions.pod:5977
14040 msgid "guestfs_strings"
14044 #: ../src/guestfs-actions.pod:5979
14048 " guestfs_strings (guestfs_h *g,\n"
14049 " const char *path);\n"
14054 #: ../src/guestfs-actions.pod:5983 ../fish/guestfish-actions.pod:3997
14056 "This runs the L<strings(1)> command on a file and returns the list of "
14057 "printable strings found."
14061 #: ../src/guestfs-actions.pod:5995
14062 msgid "guestfs_strings_e"
14066 #: ../src/guestfs-actions.pod:5997
14070 " guestfs_strings_e (guestfs_h *g,\n"
14071 " const char *encoding,\n"
14072 " const char *path);\n"
14077 #: ../src/guestfs-actions.pod:6002
14079 "This is like the C<guestfs_strings> command, but allows you to specify the "
14080 "encoding of strings that are looked for in the source file C<path>."
14084 #: ../src/guestfs-actions.pod:6006 ../fish/guestfish-actions.pod:4011
14085 msgid "Allowed encodings are:"
14089 #: ../src/guestfs-actions.pod:6010 ../fish/guestfish-actions.pod:4015
14094 #: ../src/guestfs-actions.pod:6012
14096 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14097 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14101 #: ../src/guestfs-actions.pod:6015 ../fish/guestfish-actions.pod:4020
14106 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4022
14107 msgid "Single 8-bit-byte characters."
14111 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4024
14116 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4026
14117 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14121 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4029
14122 msgid "l (lower case letter L)"
14126 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:4031
14128 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14129 "examining binaries in Windows guests."
14133 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4034
14138 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4036
14139 msgid "32-bit big endian such as UCS-4BE."
14143 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4038
14148 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4040
14149 msgid "32-bit little endian such as UCS-4LE."
14153 #: ../src/guestfs-actions.pod:6039 ../fish/guestfish-actions.pod:4044
14154 msgid "The returned strings are transcoded to UTF-8."
14158 #: ../src/guestfs-actions.pod:6050
14159 msgid "guestfs_swapoff_device"
14163 #: ../src/guestfs-actions.pod:6052
14167 " guestfs_swapoff_device (guestfs_h *g,\n"
14168 " const char *device);\n"
14173 #: ../src/guestfs-actions.pod:6056
14175 "This command disables the libguestfs appliance swap device or partition "
14176 "named C<device>. See C<guestfs_swapon_device>."
14180 #: ../src/guestfs-actions.pod:6064
14181 msgid "guestfs_swapoff_file"
14185 #: ../src/guestfs-actions.pod:6066
14189 " guestfs_swapoff_file (guestfs_h *g,\n"
14190 " const char *file);\n"
14195 #: ../src/guestfs-actions.pod:6070 ../fish/guestfish-actions.pod:4061
14196 msgid "This command disables the libguestfs appliance swap on file."
14200 #: ../src/guestfs-actions.pod:6076
14201 msgid "guestfs_swapoff_label"
14205 #: ../src/guestfs-actions.pod:6078
14209 " guestfs_swapoff_label (guestfs_h *g,\n"
14210 " const char *label);\n"
14215 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4067
14217 "This command disables the libguestfs appliance swap on labeled swap "
14222 #: ../src/guestfs-actions.pod:6089
14223 msgid "guestfs_swapoff_uuid"
14227 #: ../src/guestfs-actions.pod:6091
14231 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14232 " const char *uuid);\n"
14237 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4074
14239 "This command disables the libguestfs appliance swap partition with the given "
14244 #: ../src/guestfs-actions.pod:6102
14245 msgid "guestfs_swapon_device"
14249 #: ../src/guestfs-actions.pod:6104
14253 " guestfs_swapon_device (guestfs_h *g,\n"
14254 " const char *device);\n"
14259 #: ../src/guestfs-actions.pod:6108
14261 "This command enables the libguestfs appliance to use the swap device or "
14262 "partition named C<device>. The increased memory is made available for all "
14263 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14267 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4086
14269 "Note that you should not swap to existing guest swap partitions unless you "
14270 "know what you are doing. They may contain hibernation information, or other "
14271 "information that the guest doesn't want you to trash. You also risk leaking "
14272 "information about the host to the guest this way. Instead, attach a new "
14273 "host device to the guest and swap on that."
14277 #: ../src/guestfs-actions.pod:6124
14278 msgid "guestfs_swapon_file"
14282 #: ../src/guestfs-actions.pod:6126
14286 " guestfs_swapon_file (guestfs_h *g,\n"
14287 " const char *file);\n"
14292 #: ../src/guestfs-actions.pod:6130
14294 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14299 #: ../src/guestfs-actions.pod:6137
14300 msgid "guestfs_swapon_label"
14304 #: ../src/guestfs-actions.pod:6139
14308 " guestfs_swapon_label (guestfs_h *g,\n"
14309 " const char *label);\n"
14314 #: ../src/guestfs-actions.pod:6143
14316 "This command enables swap to a labeled swap partition. See "
14317 "C<guestfs_swapon_device> for other notes."
14321 #: ../src/guestfs-actions.pod:6150
14322 msgid "guestfs_swapon_uuid"
14326 #: ../src/guestfs-actions.pod:6152
14330 " guestfs_swapon_uuid (guestfs_h *g,\n"
14331 " const char *uuid);\n"
14336 #: ../src/guestfs-actions.pod:6156
14338 "This command enables swap to a swap partition with the given UUID. See "
14339 "C<guestfs_swapon_device> for other notes."
14343 #: ../src/guestfs-actions.pod:6163
14344 msgid "guestfs_sync"
14348 #: ../src/guestfs-actions.pod:6165
14352 " guestfs_sync (guestfs_h *g);\n"
14357 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4118
14359 "This syncs the disk, so that any writes are flushed through to the "
14360 "underlying disk image."
14364 #: ../src/guestfs-actions.pod:6171 ../fish/guestfish-actions.pod:4121
14366 "You should always call this if you have modified a disk image, before "
14367 "closing the handle."
14371 #: ../src/guestfs-actions.pod:6178
14372 msgid "guestfs_tail"
14376 #: ../src/guestfs-actions.pod:6180
14380 " guestfs_tail (guestfs_h *g,\n"
14381 " const char *path);\n"
14386 #: ../src/guestfs-actions.pod:6184 ../fish/guestfish-actions.pod:4128
14387 msgid "This command returns up to the last 10 lines of a file as a list of strings."
14391 #: ../src/guestfs-actions.pod:6196
14392 msgid "guestfs_tail_n"
14396 #: ../src/guestfs-actions.pod:6198
14400 " guestfs_tail_n (guestfs_h *g,\n"
14402 " const char *path);\n"
14407 #: ../src/guestfs-actions.pod:6203 ../fish/guestfish-actions.pod:4138
14409 "If the parameter C<nrlines> is a positive number, this returns the last "
14410 "C<nrlines> lines of the file C<path>."
14414 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4141
14416 "If the parameter C<nrlines> is a negative number, this returns lines from "
14417 "the file C<path>, starting with the C<-nrlines>th line."
14421 #: ../src/guestfs-actions.pod:6220
14422 msgid "guestfs_tar_in"
14426 #: ../src/guestfs-actions.pod:6222
14430 " guestfs_tar_in (guestfs_h *g,\n"
14431 " const char *tarfile,\n"
14432 " const char *directory);\n"
14437 #: ../src/guestfs-actions.pod:6227 ../fish/guestfish-actions.pod:4153
14439 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14440 "tar file) into C<directory>."
14444 #: ../src/guestfs-actions.pod:6230
14445 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14449 #: ../src/guestfs-actions.pod:6235 ../src/guestfs-actions.pod:6252 ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6284
14450 msgid "(Added in 1.0.3)"
14454 #: ../src/guestfs-actions.pod:6237
14455 msgid "guestfs_tar_out"
14459 #: ../src/guestfs-actions.pod:6239
14463 " guestfs_tar_out (guestfs_h *g,\n"
14464 " const char *directory,\n"
14465 " const char *tarfile);\n"
14470 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4165
14472 "This command packs the contents of C<directory> and downloads it to local "
14477 #: ../src/guestfs-actions.pod:6247
14479 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14480 "C<guestfs_txz_out>."
14484 #: ../src/guestfs-actions.pod:6254
14485 msgid "guestfs_tgz_in"
14489 #: ../src/guestfs-actions.pod:6256
14493 " guestfs_tgz_in (guestfs_h *g,\n"
14494 " const char *tarball,\n"
14495 " const char *directory);\n"
14500 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4177
14502 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14503 "tar file) into C<directory>."
14507 #: ../src/guestfs-actions.pod:6264
14508 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14512 #: ../src/guestfs-actions.pod:6270
14513 msgid "guestfs_tgz_out"
14517 #: ../src/guestfs-actions.pod:6272
14521 " guestfs_tgz_out (guestfs_h *g,\n"
14522 " const char *directory,\n"
14523 " const char *tarball);\n"
14528 #: ../src/guestfs-actions.pod:6277 ../fish/guestfish-actions.pod:4188
14530 "This command packs the contents of C<directory> and downloads it to local "
14535 #: ../src/guestfs-actions.pod:6280
14536 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14540 #: ../src/guestfs-actions.pod:6286
14541 msgid "guestfs_touch"
14545 #: ../src/guestfs-actions.pod:6288
14549 " guestfs_touch (guestfs_h *g,\n"
14550 " const char *path);\n"
14555 #: ../src/guestfs-actions.pod:6292 ../fish/guestfish-actions.pod:4199
14557 "Touch acts like the L<touch(1)> command. It can be used to update the "
14558 "timestamps on a file, or, if the file does not exist, to create a new "
14559 "zero-length file."
14563 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4203
14565 "This command only works on regular files, and will fail on other file types "
14566 "such as directories, symbolic links, block special etc."
14570 #: ../src/guestfs-actions.pod:6303
14571 msgid "guestfs_truncate"
14575 #: ../src/guestfs-actions.pod:6305
14579 " guestfs_truncate (guestfs_h *g,\n"
14580 " const char *path);\n"
14585 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4210
14587 "This command truncates C<path> to a zero-length file. The file must exist "
14592 #: ../src/guestfs-actions.pod:6316
14593 msgid "guestfs_truncate_size"
14597 #: ../src/guestfs-actions.pod:6318
14601 " guestfs_truncate_size (guestfs_h *g,\n"
14602 " const char *path,\n"
14603 " int64_t size);\n"
14608 #: ../src/guestfs-actions.pod:6323 ../fish/guestfish-actions.pod:4217
14610 "This command truncates C<path> to size C<size> bytes. The file must exist "
14615 #: ../src/guestfs-actions.pod:6326
14617 "If the current file size is less than C<size> then the file is extended to "
14618 "the required size with zero bytes. This creates a sparse file (ie. disk "
14619 "blocks are not allocated for the file until you write to it). To create a "
14620 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14624 #: ../src/guestfs-actions.pod:6336
14625 msgid "guestfs_tune2fs_l"
14629 #: ../src/guestfs-actions.pod:6338
14633 " guestfs_tune2fs_l (guestfs_h *g,\n"
14634 " const char *device);\n"
14639 #: ../src/guestfs-actions.pod:6342 ../fish/guestfish-actions.pod:4230
14641 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14646 #: ../src/guestfs-actions.pod:6345 ../fish/guestfish-actions.pod:4233
14648 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14649 "for more details. The list of fields returned isn't clearly defined, and "
14650 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14651 "and the filesystem itself."
14655 #: ../src/guestfs-actions.pod:6358
14656 msgid "guestfs_txz_in"
14660 #: ../src/guestfs-actions.pod:6360
14664 " guestfs_txz_in (guestfs_h *g,\n"
14665 " const char *tarball,\n"
14666 " const char *directory);\n"
14671 #: ../src/guestfs-actions.pod:6365 ../fish/guestfish-actions.pod:4242
14673 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14674 "tar file) into C<directory>."
14678 #: ../src/guestfs-actions.pod:6372
14679 msgid "guestfs_txz_out"
14683 #: ../src/guestfs-actions.pod:6374
14687 " guestfs_txz_out (guestfs_h *g,\n"
14688 " const char *directory,\n"
14689 " const char *tarball);\n"
14694 #: ../src/guestfs-actions.pod:6379 ../fish/guestfish-actions.pod:4251
14696 "This command packs the contents of C<directory> and downloads it to local "
14697 "file C<tarball> (as an xz compressed tar archive)."
14701 #: ../src/guestfs-actions.pod:6386
14702 msgid "guestfs_umask"
14706 #: ../src/guestfs-actions.pod:6388
14710 " guestfs_umask (guestfs_h *g,\n"
14716 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4260
14718 "This function sets the mask used for creating new files and device nodes to "
14723 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4263
14725 "Typical umask values would be C<022> which creates new files with "
14726 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14727 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14731 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4268
14733 "The default umask is C<022>. This is important because it means that "
14734 "directories and device nodes will be created with C<0644> or C<0755> mode "
14735 "even if you specify C<0777>."
14739 #: ../src/guestfs-actions.pod:6404
14741 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14742 "C<guestfs_mkdir>."
14746 #: ../src/guestfs-actions.pod:6407 ../fish/guestfish-actions.pod:4275
14747 msgid "This call returns the previous umask."
14751 #: ../src/guestfs-actions.pod:6413
14752 msgid "guestfs_umount"
14756 #: ../src/guestfs-actions.pod:6415
14760 " guestfs_umount (guestfs_h *g,\n"
14761 " const char *pathordevice);\n"
14766 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4283
14768 "This unmounts the given filesystem. The filesystem may be specified either "
14769 "by its mountpoint (path) or the device which contains the filesystem."
14773 #: ../src/guestfs-actions.pod:6427
14774 msgid "guestfs_umount_all"
14778 #: ../src/guestfs-actions.pod:6429
14782 " guestfs_umount_all (guestfs_h *g);\n"
14787 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4293
14788 msgid "This unmounts all mounted filesystems."
14792 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4295
14793 msgid "Some internal mounts are not unmounted by this call."
14797 #: ../src/guestfs-actions.pod:6440
14798 msgid "guestfs_upload"
14802 #: ../src/guestfs-actions.pod:6442
14806 " guestfs_upload (guestfs_h *g,\n"
14807 " const char *filename,\n"
14808 " const char *remotefilename);\n"
14813 #: ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6471 ../fish/guestfish-actions.pod:4301 ../fish/guestfish-actions.pod:4314
14814 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14818 #: ../src/guestfs-actions.pod:6452
14819 msgid "See also C<guestfs_download>."
14823 #: ../src/guestfs-actions.pod:6463
14824 msgid "guestfs_upload_offset"
14828 #: ../src/guestfs-actions.pod:6465
14832 " guestfs_upload_offset (guestfs_h *g,\n"
14833 " const char *filename,\n"
14834 " const char *remotefilename,\n"
14835 " int64_t offset);\n"
14840 #: ../src/guestfs-actions.pod:6474 ../fish/guestfish-actions.pod:4317
14842 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14843 "The intention is to overwrite parts of existing files or devices, although "
14844 "if a non-existant file is specified then it is created with a \"hole\" "
14845 "before C<offset>. The size of the data written is implicit in the size of "
14846 "the source C<filename>."
14850 #: ../src/guestfs-actions.pod:6481
14852 "Note that there is no limit on the amount of data that can be uploaded with "
14853 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14854 "full amount unless an error occurs."
14858 #: ../src/guestfs-actions.pod:6486
14859 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14863 #: ../src/guestfs-actions.pod:6497
14864 msgid "guestfs_utimens"
14868 #: ../src/guestfs-actions.pod:6499
14872 " guestfs_utimens (guestfs_h *g,\n"
14873 " const char *path,\n"
14874 " int64_t atsecs,\n"
14875 " int64_t atnsecs,\n"
14876 " int64_t mtsecs,\n"
14877 " int64_t mtnsecs);\n"
14882 #: ../src/guestfs-actions.pod:6507 ../fish/guestfish-actions.pod:4337
14883 msgid "This command sets the timestamps of a file with nanosecond precision."
14887 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4340
14889 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14894 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4343
14896 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14897 "nanoseconds from the epoch."
14901 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4346
14903 "If the C<*nsecs> field contains the special value C<-1> then the "
14904 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14905 "ignored in this case)."
14909 #: ../src/guestfs-actions.pod:6520 ../fish/guestfish-actions.pod:4350
14911 "If the C<*nsecs> field contains the special value C<-2> then the "
14912 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14917 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-structs.pod:175
14918 msgid "guestfs_version"
14922 #: ../src/guestfs-actions.pod:6530
14925 " struct guestfs_version *\n"
14926 " guestfs_version (guestfs_h *g);\n"
14931 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4358
14932 msgid "Return the libguestfs version number that the program is linked against."
14936 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4361
14938 "Note that because of dynamic linking this is not necessarily the version of "
14939 "libguestfs that you compiled against. You can compile the program, and then "
14940 "at runtime dynamically link against a completely different C<libguestfs.so> "
14945 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4366
14947 "This call was added in version C<1.0.58>. In previous versions of "
14948 "libguestfs there was no way to get the version number. From C code you can "
14949 "use dynamic linker functions to find out if this symbol exists (if it "
14950 "doesn't, then it's an earlier version)."
14954 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4372
14956 "The call returns a structure with four elements. The first three (C<major>, "
14957 "C<minor> and C<release>) are numbers and correspond to the usual version "
14958 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14959 "but may be used for distro-specific information."
14963 #: ../src/guestfs-actions.pod:6553 ../fish/guestfish-actions.pod:4378
14964 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14968 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4381
14969 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14973 #: ../src/guestfs-actions.pod:6558
14975 "I<Note:> Don't use this call to test for availability of features. In "
14976 "enterprise distributions we backport features from later versions into "
14977 "earlier versions, making this an unreliable way to test for features. Use "
14978 "C<guestfs_available> instead."
14982 #: ../src/guestfs-actions.pod:6564
14984 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14985 "error. I<The caller must call C<guestfs_free_version> after use>."
14989 #: ../src/guestfs-actions.pod:6568
14990 msgid "(Added in 1.0.58)"
14994 #: ../src/guestfs-actions.pod:6570
14995 msgid "guestfs_vfs_label"
14999 #: ../src/guestfs-actions.pod:6572
15003 " guestfs_vfs_label (guestfs_h *g,\n"
15004 " const char *device);\n"
15009 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4393
15010 msgid "This returns the filesystem label of the filesystem on C<device>."
15014 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4396
15015 msgid "If the filesystem is unlabeled, this returns the empty string."
15019 #: ../src/guestfs-actions.pod:6581
15020 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15024 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6623
15025 msgid "(Added in 1.3.18)"
15029 #: ../src/guestfs-actions.pod:6588
15030 msgid "guestfs_vfs_type"
15034 #: ../src/guestfs-actions.pod:6590
15038 " guestfs_vfs_type (guestfs_h *g,\n"
15039 " const char *device);\n"
15044 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4404
15046 "This command gets the filesystem type corresponding to the filesystem on "
15051 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4407
15053 "For most filesystems, the result is the name of the Linux VFS module which "
15054 "would be used to mount this filesystem if you mounted it without specifying "
15055 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15059 #: ../src/guestfs-actions.pod:6607
15060 msgid "guestfs_vfs_uuid"
15064 #: ../src/guestfs-actions.pod:6609
15068 " guestfs_vfs_uuid (guestfs_h *g,\n"
15069 " const char *device);\n"
15074 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
15075 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15079 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4419
15080 msgid "If the filesystem does not have a UUID, this returns the empty string."
15084 #: ../src/guestfs-actions.pod:6618
15085 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15089 #: ../src/guestfs-actions.pod:6625
15090 msgid "guestfs_vg_activate"
15094 #: ../src/guestfs-actions.pod:6627
15098 " guestfs_vg_activate (guestfs_h *g,\n"
15100 " char *const *volgroups);\n"
15105 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4427
15107 "This command activates or (if C<activate> is false) deactivates all logical "
15108 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15109 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15110 "deactivated, then those devices disappear."
15114 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4433
15115 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15119 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4435
15121 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15122 "activated or deactivated."
15126 #: ../src/guestfs-actions.pod:6647
15127 msgid "guestfs_vg_activate_all"
15131 #: ../src/guestfs-actions.pod:6649
15135 " guestfs_vg_activate_all (guestfs_h *g,\n"
15136 " int activate);\n"
15141 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4442
15143 "This command activates or (if C<activate> is false) deactivates all logical "
15144 "volumes in all volume groups. If activated, then they are made known to the "
15145 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15146 "those devices disappear."
15150 #: ../src/guestfs-actions.pod:6659 ../fish/guestfish-actions.pod:4448
15151 msgid "This command is the same as running C<vgchange -a y|n>"
15155 #: ../src/guestfs-actions.pod:6665
15156 msgid "guestfs_vgcreate"
15160 #: ../src/guestfs-actions.pod:6667
15164 " guestfs_vgcreate (guestfs_h *g,\n"
15165 " const char *volgroup,\n"
15166 " char *const *physvols);\n"
15171 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4454
15173 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15174 "of physical volumes C<physvols>."
15178 #: ../src/guestfs-actions.pod:6679
15179 msgid "guestfs_vglvuuids"
15183 #: ../src/guestfs-actions.pod:6681
15187 " guestfs_vglvuuids (guestfs_h *g,\n"
15188 " const char *vgname);\n"
15193 #: ../src/guestfs-actions.pod:6685 ../fish/guestfish-actions.pod:4461
15195 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15196 "volumes created in this volume group."
15200 #: ../src/guestfs-actions.pod:6688
15202 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15203 "associate logical volumes and volume groups."
15207 #: ../src/guestfs-actions.pod:6691
15208 msgid "See also C<guestfs_vgpvuuids>."
15212 #: ../src/guestfs-actions.pod:6699
15213 msgid "guestfs_vgpvuuids"
15217 #: ../src/guestfs-actions.pod:6701
15221 " guestfs_vgpvuuids (guestfs_h *g,\n"
15222 " const char *vgname);\n"
15227 #: ../src/guestfs-actions.pod:6705 ../fish/guestfish-actions.pod:4473
15229 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15230 "volumes that this volume group resides on."
15234 #: ../src/guestfs-actions.pod:6708
15236 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15237 "associate physical volumes and volume groups."
15241 #: ../src/guestfs-actions.pod:6711
15242 msgid "See also C<guestfs_vglvuuids>."
15246 #: ../src/guestfs-actions.pod:6719
15247 msgid "guestfs_vgremove"
15251 #: ../src/guestfs-actions.pod:6721
15255 " guestfs_vgremove (guestfs_h *g,\n"
15256 " const char *vgname);\n"
15261 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4485
15262 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15266 #: ../src/guestfs-actions.pod:6727 ../fish/guestfish-actions.pod:4487
15267 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
15271 #: ../src/guestfs-actions.pod:6734
15272 msgid "guestfs_vgrename"
15276 #: ../src/guestfs-actions.pod:6736
15280 " guestfs_vgrename (guestfs_h *g,\n"
15281 " const char *volgroup,\n"
15282 " const char *newvolgroup);\n"
15287 #: ../src/guestfs-actions.pod:6741 ../fish/guestfish-actions.pod:4494
15288 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15292 #: ../src/guestfs-actions.pod:6747
15293 msgid "guestfs_vgs"
15297 #: ../src/guestfs-actions.pod:6749
15301 " guestfs_vgs (guestfs_h *g);\n"
15306 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4500
15308 "List all the volumes groups detected. This is the equivalent of the "
15309 "L<vgs(8)> command."
15313 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4503
15315 "This returns a list of just the volume group names that were detected "
15316 "(eg. C<VolGroup00>)."
15320 #: ../src/guestfs-actions.pod:6758
15321 msgid "See also C<guestfs_vgs_full>."
15325 #: ../src/guestfs-actions.pod:6766
15326 msgid "guestfs_vgs_full"
15330 #: ../src/guestfs-actions.pod:6768
15333 " struct guestfs_lvm_vg_list *\n"
15334 " guestfs_vgs_full (guestfs_h *g);\n"
15339 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4512
15341 "List all the volumes groups detected. This is the equivalent of the "
15342 "L<vgs(8)> command. The \"full\" version includes all fields."
15346 #: ../src/guestfs-actions.pod:6774
15348 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15349 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
15354 #: ../src/guestfs-actions.pod:6780
15355 msgid "guestfs_vgscan"
15359 #: ../src/guestfs-actions.pod:6782
15363 " guestfs_vgscan (guestfs_h *g);\n"
15368 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4519
15370 "This rescans all block devices and rebuilds the list of LVM physical "
15371 "volumes, volume groups and logical volumes."
15375 #: ../src/guestfs-actions.pod:6792
15376 msgid "guestfs_vguuid"
15380 #: ../src/guestfs-actions.pod:6794
15384 " guestfs_vguuid (guestfs_h *g,\n"
15385 " const char *vgname);\n"
15390 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4526
15391 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15395 #: ../src/guestfs-actions.pod:6805
15396 msgid "guestfs_wait_ready"
15400 #: ../src/guestfs-actions.pod:6807
15404 " guestfs_wait_ready (guestfs_h *g);\n"
15409 #: ../src/guestfs-actions.pod:6810
15410 msgid "This function is a no op."
15414 #: ../src/guestfs-actions.pod:6812
15416 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15417 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15418 "is no longer necessary because C<guestfs_launch> now does the waiting."
15422 #: ../src/guestfs-actions.pod:6817
15424 "If you see any calls to this function in code then you can just remove them, "
15425 "unless you want to retain compatibility with older versions of the API."
15429 #: ../src/guestfs-actions.pod:6825
15430 msgid "guestfs_wc_c"
15434 #: ../src/guestfs-actions.pod:6827
15438 " guestfs_wc_c (guestfs_h *g,\n"
15439 " const char *path);\n"
15444 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4532
15446 "This command counts the characters in a file, using the C<wc -c> external "
15451 #: ../src/guestfs-actions.pod:6838
15452 msgid "guestfs_wc_l"
15456 #: ../src/guestfs-actions.pod:6840
15460 " guestfs_wc_l (guestfs_h *g,\n"
15461 " const char *path);\n"
15466 #: ../src/guestfs-actions.pod:6844 ../fish/guestfish-actions.pod:4539
15468 "This command counts the lines in a file, using the C<wc -l> external "
15473 #: ../src/guestfs-actions.pod:6851
15474 msgid "guestfs_wc_w"
15478 #: ../src/guestfs-actions.pod:6853
15482 " guestfs_wc_w (guestfs_h *g,\n"
15483 " const char *path);\n"
15488 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4546
15490 "This command counts the words in a file, using the C<wc -w> external "
15495 #: ../src/guestfs-actions.pod:6864
15496 msgid "guestfs_write"
15500 #: ../src/guestfs-actions.pod:6866
15504 " guestfs_write (guestfs_h *g,\n"
15505 " const char *path,\n"
15506 " const char *content,\n"
15507 " size_t content_size);\n"
15512 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4553
15514 "This call creates a file called C<path>. The content of the file is the "
15515 "string C<content> (which can contain any 8 bit data)."
15519 #: ../src/guestfs-actions.pod:6882
15520 msgid "guestfs_write_file"
15524 #: ../src/guestfs-actions.pod:6884
15528 " guestfs_write_file (guestfs_h *g,\n"
15529 " const char *path,\n"
15530 " const char *content,\n"
15536 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4563
15538 "This call creates a file called C<path>. The contents of the file is the "
15539 "string C<content> (which can contain any 8 bit data), with length C<size>."
15543 #: ../src/guestfs-actions.pod:6894 ../fish/guestfish-actions.pod:4567
15545 "As a special case, if C<size> is C<0> then the length is calculated using "
15546 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15550 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4571
15552 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15553 "I<not> work, even if the length is specified."
15557 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4577
15558 msgid "This function is deprecated. In new code, use the C<write> call instead."
15562 #: ../src/guestfs-actions.pod:6915
15563 msgid "guestfs_zegrep"
15567 #: ../src/guestfs-actions.pod:6917
15571 " guestfs_zegrep (guestfs_h *g,\n"
15572 " const char *regex,\n"
15573 " const char *path);\n"
15578 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4588
15579 msgid "This calls the external C<zegrep> program and returns the matching lines."
15583 #: ../src/guestfs-actions.pod:6934
15584 msgid "guestfs_zegrepi"
15588 #: ../src/guestfs-actions.pod:6936
15592 " guestfs_zegrepi (guestfs_h *g,\n"
15593 " const char *regex,\n"
15594 " const char *path);\n"
15599 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4598
15600 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15604 #: ../src/guestfs-actions.pod:6953
15605 msgid "guestfs_zero"
15609 #: ../src/guestfs-actions.pod:6955
15613 " guestfs_zero (guestfs_h *g,\n"
15614 " const char *device);\n"
15619 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4608
15620 msgid "This command writes zeroes over the first few blocks of C<device>."
15624 #: ../src/guestfs-actions.pod:6961 ../fish/guestfish-actions.pod:4610
15626 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15627 "securely wipe the device). It should be sufficient to remove any partition "
15628 "tables, filesystem superblocks and so on."
15632 #: ../src/guestfs-actions.pod:6965
15633 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15637 #: ../src/guestfs-actions.pod:6976
15638 msgid "guestfs_zero_device"
15642 #: ../src/guestfs-actions.pod:6978
15646 " guestfs_zero_device (guestfs_h *g,\n"
15647 " const char *device);\n"
15652 #: ../src/guestfs-actions.pod:6982
15654 "This command writes zeroes over the entire C<device>. Compare with "
15655 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15659 #: ../src/guestfs-actions.pod:6996
15660 msgid "(Added in 1.3.1)"
15664 #: ../src/guestfs-actions.pod:6998
15665 msgid "guestfs_zerofree"
15669 #: ../src/guestfs-actions.pod:7000
15673 " guestfs_zerofree (guestfs_h *g,\n"
15674 " const char *device);\n"
15679 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4631
15681 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15682 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15683 "possible to compress the filesystem more effectively."
15687 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4636
15688 msgid "You should B<not> run this program if the filesystem is mounted."
15692 #: ../src/guestfs-actions.pod:7012 ../fish/guestfish-actions.pod:4639
15694 "It is possible that using this program can damage the filesystem or data on "
15699 #: ../src/guestfs-actions.pod:7019
15700 msgid "guestfs_zfgrep"
15704 #: ../src/guestfs-actions.pod:7021
15708 " guestfs_zfgrep (guestfs_h *g,\n"
15709 " const char *pattern,\n"
15710 " const char *path);\n"
15715 #: ../src/guestfs-actions.pod:7026 ../fish/guestfish-actions.pod:4646
15716 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15720 #: ../src/guestfs-actions.pod:7038
15721 msgid "guestfs_zfgrepi"
15725 #: ../src/guestfs-actions.pod:7040
15729 " guestfs_zfgrepi (guestfs_h *g,\n"
15730 " const char *pattern,\n"
15731 " const char *path);\n"
15736 #: ../src/guestfs-actions.pod:7045 ../fish/guestfish-actions.pod:4656
15737 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15741 #: ../src/guestfs-actions.pod:7057
15742 msgid "guestfs_zfile"
15746 #: ../src/guestfs-actions.pod:7059
15750 " guestfs_zfile (guestfs_h *g,\n"
15751 " const char *meth,\n"
15752 " const char *path);\n"
15757 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4666
15758 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15762 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4669
15763 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15767 #: ../src/guestfs-actions.pod:7069
15769 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15774 #: ../src/guestfs-actions.pod:7075 ../fish/guestfish-actions.pod:4674
15775 msgid "This function is deprecated. In new code, use the C<file> call instead."
15779 #: ../src/guestfs-actions.pod:7084
15780 msgid "guestfs_zgrep"
15784 #: ../src/guestfs-actions.pod:7086
15788 " guestfs_zgrep (guestfs_h *g,\n"
15789 " const char *regex,\n"
15790 " const char *path);\n"
15795 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4685
15796 msgid "This calls the external C<zgrep> program and returns the matching lines."
15800 #: ../src/guestfs-actions.pod:7103
15801 msgid "guestfs_zgrepi"
15805 #: ../src/guestfs-actions.pod:7105
15809 " guestfs_zgrepi (guestfs_h *g,\n"
15810 " const char *regex,\n"
15811 " const char *path);\n"
15816 #: ../src/guestfs-actions.pod:7110 ../fish/guestfish-actions.pod:4695
15817 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15821 #: ../src/guestfs-availability.pod:3
15826 #: ../src/guestfs-availability.pod:5
15828 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15829 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15830 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15831 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15832 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15836 #: ../src/guestfs-availability.pod:21
15841 #: ../src/guestfs-availability.pod:23
15843 "The following functions: L</guestfs_inotify_add_watch> "
15844 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15845 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15849 #: ../src/guestfs-availability.pod:31
15850 msgid "B<linuxfsuuid>"
15854 #: ../src/guestfs-availability.pod:33
15856 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15857 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15861 #: ../src/guestfs-availability.pod:40
15862 msgid "B<linuxmodules>"
15866 #: ../src/guestfs-availability.pod:42
15867 msgid "The following functions: L</guestfs_modprobe>"
15871 #: ../src/guestfs-availability.pod:45
15872 msgid "B<linuxxattrs>"
15876 #: ../src/guestfs-availability.pod:47
15878 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15879 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15880 "L</guestfs_removexattr> L</guestfs_setxattr>"
15884 #: ../src/guestfs-availability.pod:56
15889 #: ../src/guestfs-availability.pod:58
15891 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15892 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15893 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15897 #: ../src/guestfs-availability.pod:67
15902 #: ../src/guestfs-availability.pod:69
15904 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15905 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15906 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15907 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15908 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15909 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15910 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15911 "L</guestfs_vgs_full>"
15915 #: ../src/guestfs-availability.pod:92
15920 #: ../src/guestfs-availability.pod:94
15922 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15923 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15927 #: ../src/guestfs-availability.pod:100
15932 #: ../src/guestfs-availability.pod:102
15933 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15937 #: ../src/guestfs-availability.pod:105
15938 msgid "B<ntfsprogs>"
15942 #: ../src/guestfs-availability.pod:107
15943 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15947 #: ../src/guestfs-availability.pod:111
15948 msgid "B<realpath>"
15952 #: ../src/guestfs-availability.pod:113
15953 msgid "The following functions: L</guestfs_realpath>"
15957 #: ../src/guestfs-availability.pod:116
15962 #: ../src/guestfs-availability.pod:118
15964 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15965 "L</guestfs_scrub_freespace>"
15969 #: ../src/guestfs-availability.pod:123
15974 #: ../src/guestfs-availability.pod:125
15975 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15979 #: ../src/guestfs-availability.pod:129
15984 #: ../src/guestfs-availability.pod:131
15985 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15989 #: ../src/guestfs-availability.pod:135
15990 msgid "B<zerofree>"
15994 #: ../src/guestfs-availability.pod:137
15995 msgid "The following functions: L</guestfs_zerofree>"
15999 #: ../src/guestfs-structs.pod:1
16000 msgid "guestfs_int_bool"
16004 #: ../src/guestfs-structs.pod:3
16007 " struct guestfs_int_bool {\n"
16015 #: ../src/guestfs-structs.pod:8
16018 " struct guestfs_int_bool_list {\n"
16019 " uint32_t len; /* Number of elements in list. */\n"
16020 " struct guestfs_int_bool *val; /* Elements. */\n"
16026 #: ../src/guestfs-structs.pod:13
16029 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16030 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16035 #: ../src/guestfs-structs.pod:16
16036 msgid "guestfs_lvm_pv"
16040 #: ../src/guestfs-structs.pod:18
16043 " struct guestfs_lvm_pv {\n"
16044 " char *pv_name;\n"
16045 " /* The next field is NOT nul-terminated, be careful when printing it: "
16047 " char pv_uuid[32];\n"
16049 " uint64_t pv_size;\n"
16050 " uint64_t dev_size;\n"
16051 " uint64_t pv_free;\n"
16052 " uint64_t pv_used;\n"
16053 " char *pv_attr;\n"
16054 " int64_t pv_pe_count;\n"
16055 " int64_t pv_pe_alloc_count;\n"
16056 " char *pv_tags;\n"
16057 " uint64_t pe_start;\n"
16058 " int64_t pv_mda_count;\n"
16059 " uint64_t pv_mda_free;\n"
16065 #: ../src/guestfs-structs.pod:36
16068 " struct guestfs_lvm_pv_list {\n"
16069 " uint32_t len; /* Number of elements in list. */\n"
16070 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16076 #: ../src/guestfs-structs.pod:41
16079 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16080 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16085 #: ../src/guestfs-structs.pod:44
16086 msgid "guestfs_lvm_vg"
16090 #: ../src/guestfs-structs.pod:46
16093 " struct guestfs_lvm_vg {\n"
16094 " char *vg_name;\n"
16095 " /* The next field is NOT nul-terminated, be careful when printing it: "
16097 " char vg_uuid[32];\n"
16099 " char *vg_attr;\n"
16100 " uint64_t vg_size;\n"
16101 " uint64_t vg_free;\n"
16102 " char *vg_sysid;\n"
16103 " uint64_t vg_extent_size;\n"
16104 " int64_t vg_extent_count;\n"
16105 " int64_t vg_free_count;\n"
16106 " int64_t max_lv;\n"
16107 " int64_t max_pv;\n"
16108 " int64_t pv_count;\n"
16109 " int64_t lv_count;\n"
16110 " int64_t snap_count;\n"
16111 " int64_t vg_seqno;\n"
16112 " char *vg_tags;\n"
16113 " int64_t vg_mda_count;\n"
16114 " uint64_t vg_mda_free;\n"
16120 #: ../src/guestfs-structs.pod:69
16123 " struct guestfs_lvm_vg_list {\n"
16124 " uint32_t len; /* Number of elements in list. */\n"
16125 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16131 #: ../src/guestfs-structs.pod:74
16134 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16135 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16140 #: ../src/guestfs-structs.pod:77
16141 msgid "guestfs_lvm_lv"
16145 #: ../src/guestfs-structs.pod:79
16148 " struct guestfs_lvm_lv {\n"
16149 " char *lv_name;\n"
16150 " /* The next field is NOT nul-terminated, be careful when printing it: "
16152 " char lv_uuid[32];\n"
16153 " char *lv_attr;\n"
16154 " int64_t lv_major;\n"
16155 " int64_t lv_minor;\n"
16156 " int64_t lv_kernel_major;\n"
16157 " int64_t lv_kernel_minor;\n"
16158 " uint64_t lv_size;\n"
16159 " int64_t seg_count;\n"
16161 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16162 " float snap_percent;\n"
16163 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16164 " float copy_percent;\n"
16165 " char *move_pv;\n"
16166 " char *lv_tags;\n"
16167 " char *mirror_log;\n"
16168 " char *modules;\n"
16174 #: ../src/guestfs-structs.pod:101
16177 " struct guestfs_lvm_lv_list {\n"
16178 " uint32_t len; /* Number of elements in list. */\n"
16179 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16185 #: ../src/guestfs-structs.pod:106
16188 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16189 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16194 #: ../src/guestfs-structs.pod:111
16197 " struct guestfs_stat {\n"
16201 " int64_t nlink;\n"
16206 " int64_t blksize;\n"
16207 " int64_t blocks;\n"
16208 " int64_t atime;\n"
16209 " int64_t mtime;\n"
16210 " int64_t ctime;\n"
16216 #: ../src/guestfs-structs.pod:127
16219 " struct guestfs_stat_list {\n"
16220 " uint32_t len; /* Number of elements in list. */\n"
16221 " struct guestfs_stat *val; /* Elements. */\n"
16227 #: ../src/guestfs-structs.pod:132
16230 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16231 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16236 #: ../src/guestfs-structs.pod:137
16239 " struct guestfs_statvfs {\n"
16240 " int64_t bsize;\n"
16241 " int64_t frsize;\n"
16242 " int64_t blocks;\n"
16243 " int64_t bfree;\n"
16244 " int64_t bavail;\n"
16245 " int64_t files;\n"
16246 " int64_t ffree;\n"
16247 " int64_t favail;\n"
16250 " int64_t namemax;\n"
16256 #: ../src/guestfs-structs.pod:151
16259 " struct guestfs_statvfs_list {\n"
16260 " uint32_t len; /* Number of elements in list. */\n"
16261 " struct guestfs_statvfs *val; /* Elements. */\n"
16267 #: ../src/guestfs-structs.pod:156
16270 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16271 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16276 #: ../src/guestfs-structs.pod:159
16277 msgid "guestfs_dirent"
16281 #: ../src/guestfs-structs.pod:161
16284 " struct guestfs_dirent {\n"
16293 #: ../src/guestfs-structs.pod:167
16296 " struct guestfs_dirent_list {\n"
16297 " uint32_t len; /* Number of elements in list. */\n"
16298 " struct guestfs_dirent *val; /* Elements. */\n"
16304 #: ../src/guestfs-structs.pod:172
16307 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16308 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16313 #: ../src/guestfs-structs.pod:177
16316 " struct guestfs_version {\n"
16317 " int64_t major;\n"
16318 " int64_t minor;\n"
16319 " int64_t release;\n"
16326 #: ../src/guestfs-structs.pod:184
16329 " struct guestfs_version_list {\n"
16330 " uint32_t len; /* Number of elements in list. */\n"
16331 " struct guestfs_version *val; /* Elements. */\n"
16337 #: ../src/guestfs-structs.pod:189
16340 " void guestfs_free_version (struct guestfs_free_version *);\n"
16341 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16346 #: ../src/guestfs-structs.pod:192
16347 msgid "guestfs_xattr"
16351 #: ../src/guestfs-structs.pod:194
16354 " struct guestfs_xattr {\n"
16355 " char *attrname;\n"
16356 " /* The next two fields describe a byte array. */\n"
16357 " uint32_t attrval_len;\n"
16358 " char *attrval;\n"
16364 #: ../src/guestfs-structs.pod:201
16367 " struct guestfs_xattr_list {\n"
16368 " uint32_t len; /* Number of elements in list. */\n"
16369 " struct guestfs_xattr *val; /* Elements. */\n"
16375 #: ../src/guestfs-structs.pod:206
16378 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16379 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16384 #: ../src/guestfs-structs.pod:209
16385 msgid "guestfs_inotify_event"
16389 #: ../src/guestfs-structs.pod:211
16392 " struct guestfs_inotify_event {\n"
16393 " int64_t in_wd;\n"
16394 " uint32_t in_mask;\n"
16395 " uint32_t in_cookie;\n"
16396 " char *in_name;\n"
16402 #: ../src/guestfs-structs.pod:218
16405 " struct guestfs_inotify_event_list {\n"
16406 " uint32_t len; /* Number of elements in list. */\n"
16407 " struct guestfs_inotify_event *val; /* Elements. */\n"
16413 #: ../src/guestfs-structs.pod:223
16416 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16417 " void guestfs_free_inotify_event_list (struct "
16418 "guestfs_free_inotify_event_list *);\n"
16423 #: ../src/guestfs-structs.pod:226
16424 msgid "guestfs_partition"
16428 #: ../src/guestfs-structs.pod:228
16431 " struct guestfs_partition {\n"
16432 " int32_t part_num;\n"
16433 " uint64_t part_start;\n"
16434 " uint64_t part_end;\n"
16435 " uint64_t part_size;\n"
16441 #: ../src/guestfs-structs.pod:235
16444 " struct guestfs_partition_list {\n"
16445 " uint32_t len; /* Number of elements in list. */\n"
16446 " struct guestfs_partition *val; /* Elements. */\n"
16452 #: ../src/guestfs-structs.pod:240
16455 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16456 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16461 #: ../src/guestfs-structs.pod:243
16462 msgid "guestfs_application"
16466 #: ../src/guestfs-structs.pod:245
16469 " struct guestfs_application {\n"
16470 " char *app_name;\n"
16471 " char *app_display_name;\n"
16472 " int32_t app_epoch;\n"
16473 " char *app_version;\n"
16474 " char *app_release;\n"
16475 " char *app_install_path;\n"
16476 " char *app_trans_path;\n"
16477 " char *app_publisher;\n"
16478 " char *app_url;\n"
16479 " char *app_source_package;\n"
16480 " char *app_summary;\n"
16481 " char *app_description;\n"
16487 #: ../src/guestfs-structs.pod:260
16490 " struct guestfs_application_list {\n"
16491 " uint32_t len; /* Number of elements in list. */\n"
16492 " struct guestfs_application *val; /* Elements. */\n"
16498 #: ../src/guestfs-structs.pod:265
16501 " void guestfs_free_application (struct guestfs_free_application *);\n"
16502 " void guestfs_free_application_list (struct guestfs_free_application_list "
16508 #: ../fish/guestfish.pod:5
16509 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16513 #: ../fish/guestfish.pod:9
16516 " guestfish [--options] [commands]\n"
16521 #: ../fish/guestfish.pod:11
16529 #: ../fish/guestfish.pod:13
16532 " guestfish [--ro|--rw] -a disk.img\n"
16537 #: ../fish/guestfish.pod:15
16540 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16545 #: ../fish/guestfish.pod:17
16548 " guestfish -d libvirt-domain\n"
16553 #: ../fish/guestfish.pod:19
16556 " guestfish [--ro|--rw] -a disk.img -i\n"
16561 #: ../fish/guestfish.pod:21
16564 " guestfish -d libvirt-domain -i\n"
16569 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16574 #: ../fish/guestfish.pod:25
16576 "Using guestfish in read/write mode on live virtual machines can be "
16577 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16578 "option to use guestfish safely if the disk image or virtual machine might be "
16583 #: ../fish/guestfish.pod:32
16585 "Guestfish is a shell and command-line tool for examining and modifying "
16586 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16587 "functionality of the guestfs API, see L<guestfs(3)>."
16591 #: ../fish/guestfish.pod:36
16593 "Guestfish gives you structured access to the libguestfs API, from shell "
16594 "scripts or the command line or interactively. If you want to rescue a "
16595 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16600 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16605 #: ../fish/guestfish.pod:43
16606 msgid "As an interactive shell"
16610 #: ../fish/guestfish.pod:45
16618 #: ../fish/guestfish.pod:47
16621 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16622 " editing virtual machine filesystems.\n"
16627 #: ../fish/guestfish.pod:50
16630 " Type: 'help' for a list of commands\n"
16631 " 'man' to read the manual\n"
16632 " 'quit' to quit the shell\n"
16637 #: ../fish/guestfish.pod:54
16640 " ><fs> add-ro disk.img\n"
16642 " ><fs> list-filesystems\n"
16643 " /dev/sda1: ext4\n"
16644 " /dev/vg_guest/lv_root: ext4\n"
16645 " /dev/vg_guest/lv_swap: swap\n"
16646 " ><fs> mount /dev/vg_guest/lv_root /\n"
16647 " ><fs> cat /etc/fstab\n"
16649 " # Created by anaconda\n"
16656 #: ../fish/guestfish.pod:67
16657 msgid "From shell scripts"
16661 #: ../fish/guestfish.pod:69
16662 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16666 #: ../fish/guestfish.pod:71
16669 " guestfish <<_EOF_\n"
16672 " mount /dev/vg_guest/lv_root /\n"
16673 " write /etc/motd \"Welcome, new users\"\n"
16679 #: ../fish/guestfish.pod:78
16680 msgid "List the LVM logical volumes in a disk image:"
16684 #: ../fish/guestfish.pod:80
16687 " guestfish -a disk.img --ro <<_EOF_\n"
16695 #: ../fish/guestfish.pod:85
16696 msgid "List all the filesystems in a disk image:"
16700 #: ../fish/guestfish.pod:87
16703 " guestfish -a disk.img --ro <<_EOF_\n"
16705 " list-filesystems\n"
16711 #: ../fish/guestfish.pod:92
16712 msgid "On one command line"
16716 #: ../fish/guestfish.pod:94
16717 msgid "Update C</etc/resolv.conf> in a guest:"
16721 #: ../fish/guestfish.pod:96
16725 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16726 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16731 #: ../fish/guestfish.pod:100
16732 msgid "Edit C</boot/grub/grub.conf> interactively:"
16736 #: ../fish/guestfish.pod:102
16739 " guestfish --rw --add disk.img \\\n"
16740 " --mount /dev/vg_guest/lv_root \\\n"
16741 " --mount /dev/sda1:/boot \\\n"
16742 " edit /boot/grub/grub.conf\n"
16747 #: ../fish/guestfish.pod:107
16748 msgid "Mount disks automatically"
16752 #: ../fish/guestfish.pod:109
16754 "Use the I<-i> option to automatically mount the disks from a virtual "
16759 #: ../fish/guestfish.pod:112
16762 " guestfish --ro -a disk.img -i cat /etc/group\n"
16767 #: ../fish/guestfish.pod:114
16770 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16775 #: ../fish/guestfish.pod:116
16776 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16780 #: ../fish/guestfish.pod:118
16783 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16788 #: ../fish/guestfish.pod:120
16789 msgid "As a script interpreter"
16793 #: ../fish/guestfish.pod:122
16794 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16798 #: ../fish/guestfish.pod:124
16801 " #!/usr/bin/guestfish -f\n"
16802 " sparse test1.img 100M\n"
16804 " part-disk /dev/sda mbr\n"
16805 " mkfs ext2 /dev/sda1\n"
16810 #: ../fish/guestfish.pod:130
16811 msgid "Start with a prepared disk"
16815 #: ../fish/guestfish.pod:132
16817 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16818 "single ext2-formatted partition:"
16822 #: ../fish/guestfish.pod:135
16825 " guestfish -N fs\n"
16830 #: ../fish/guestfish.pod:137
16831 msgid "To list what is available do:"
16835 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
16838 " guestfish -N help | less\n"
16843 #: ../fish/guestfish.pod:141
16844 msgid "Remote control"
16848 #: ../fish/guestfish.pod:143
16851 " eval \"`guestfish --listen`\"\n"
16852 " guestfish --remote add-ro disk.img\n"
16853 " guestfish --remote run\n"
16854 " guestfish --remote lvs\n"
16859 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
16864 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
16869 #: ../fish/guestfish.pod:154
16870 msgid "Displays general help on options."
16874 #: ../fish/guestfish.pod:156
16875 msgid "B<-h> | B<--cmd-help>"
16879 #: ../fish/guestfish.pod:158
16880 msgid "Lists all available guestfish commands."
16884 #: ../fish/guestfish.pod:160
16885 msgid "B<-h cmd> | B<--cmd-help cmd>"
16889 #: ../fish/guestfish.pod:162
16890 msgid "Displays detailed help on a single command C<cmd>."
16894 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16895 msgid "B<-a image> | B<--add image>"
16899 #: ../fish/guestfish.pod:166
16900 msgid "Add a block device or virtual machine image to the shell."
16904 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16906 "The format of the disk image is auto-detected. To override this and force a "
16907 "particular format use the I<--format=..> option."
16911 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16912 msgid "B<-c URI> | B<--connect URI>"
16916 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16918 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16919 "URI to use. The default is to use the default libvirt connection."
16923 #: ../fish/guestfish.pod:177
16928 #: ../fish/guestfish.pod:179
16930 "If using the I<--listen> option and a csh-like shell, use this option. See "
16931 "section L</REMOTE CONTROL AND CSH> below."
16935 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16936 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16940 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16942 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16943 "used, then any libvirt domain can be used. However in write mode, only "
16944 "libvirt domains which are shut down can be named here."
16948 #: ../fish/guestfish.pod:188
16949 msgid "B<-D> | B<--no-dest-paths>"
16953 #: ../fish/guestfish.pod:190
16955 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16956 "to hit the tab key to complete paths on the guest filesystem, but this "
16957 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16958 "allow this feature to be disabled."
16962 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16963 msgid "B<--echo-keys>"
16967 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16969 "When prompting for keys and passphrases, guestfish normally turns echoing "
16970 "off so you cannot see what you are typing. If you are not worried about "
16971 "Tempest attacks and there is no one else in the room you can specify this "
16972 "flag to see what you are typing."
16976 #: ../fish/guestfish.pod:202
16977 msgid "B<-f file> | B<--file file>"
16981 #: ../fish/guestfish.pod:204
16982 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16986 #: ../fish/guestfish.pod:207
16989 " #!/usr/bin/guestfish -f\n"
16994 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16995 msgid "B<--format=raw|qcow2|..> | B<--format>"
16999 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
17001 "The default for the I<-a> option is to auto-detect the format of the disk "
17002 "image. Using this forces the disk format for I<-a> options which follow on "
17003 "the command line. Using I<--format> with no argument switches back to "
17004 "auto-detection for subsequent I<-a> options."
17008 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
17009 msgid "For example:"
17013 #: ../fish/guestfish.pod:218
17016 " guestfish --format=raw -a disk.img\n"
17021 #: ../fish/guestfish.pod:220
17022 msgid "forces raw format (no auto-detection) for C<disk.img>."
17026 #: ../fish/guestfish.pod:222
17029 " guestfish --format=raw -a disk.img --format -a another.img\n"
17034 #: ../fish/guestfish.pod:224
17036 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
17037 "auto-detection for C<another.img>."
17041 #: ../fish/guestfish.pod:227
17043 "If you have untrusted raw-format guest disk images, you should use this "
17044 "option to specify the disk format. This avoids a possible security problem "
17045 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17049 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
17050 msgid "B<-i> | B<--inspector>"
17054 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
17056 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17057 "system and mount filesystems as they would be mounted on the real virtual "
17062 #: ../fish/guestfish.pod:238
17063 msgid "Typical usage is either:"
17067 #: ../fish/guestfish.pod:240
17070 " guestfish -d myguest -i\n"
17075 #: ../fish/guestfish.pod:242
17076 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17080 #: ../fish/guestfish.pod:244
17083 " guestfish --ro -d myguest -i\n"
17088 #: ../fish/guestfish.pod:246
17089 msgid "(for active domains, readonly), or specify the block device directly:"
17093 #: ../fish/guestfish.pod:248
17096 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17101 #: ../fish/guestfish.pod:250
17103 "Note that the command line syntax changed slightly over older versions of "
17104 "guestfish. You can still use the old syntax:"
17108 #: ../fish/guestfish.pod:253
17111 " guestfish [--ro] -i disk.img\n"
17116 #: ../fish/guestfish.pod:255
17119 " guestfish [--ro] -i libvirt-domain\n"
17124 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17125 msgid "B<--keys-from-stdin>"
17129 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17131 "Read key or passphrase parameters from stdin. The default is to try to read "
17132 "passphrases from the user by opening C</dev/tty>."
17136 #: ../fish/guestfish.pod:262
17137 msgid "B<--listen>"
17141 #: ../fish/guestfish.pod:264
17143 "Fork into the background and listen for remote commands. See section "
17144 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17148 #: ../fish/guestfish.pod:267
17149 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17153 #: ../fish/guestfish.pod:269
17154 msgid "Mount the named partition or logical volume on the given mountpoint."
17158 #: ../fish/guestfish.pod:271
17159 msgid "If the mountpoint is omitted, it defaults to C</>."
17163 #: ../fish/guestfish.pod:273
17164 msgid "You have to mount something on C</> before most commands will work."
17168 #: ../fish/guestfish.pod:275
17170 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17175 #: ../fish/guestfish.pod:278
17177 "If you don't know what filesystems a disk image contains, you can either run "
17178 "guestfish without this option, then list the partitions, filesystems and LVs "
17179 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17180 "commands), or you can use the L<virt-filesystems(1)> program."
17184 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17185 msgid "B<-n> | B<--no-sync>"
17189 #: ../fish/guestfish.pod:286
17191 "Disable autosync. This is enabled by default. See the discussion of "
17192 "autosync in the L<guestfs(3)> manpage."
17196 #: ../fish/guestfish.pod:289
17197 msgid "B<-N type> | B<--new type> | B<-N help>"
17201 #: ../fish/guestfish.pod:291
17203 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17204 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17205 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17210 #: ../fish/guestfish.pod:296
17211 msgid "B<--progress-bars>"
17215 #: ../fish/guestfish.pod:298
17216 msgid "Enable progress bars, even when guestfish is used non-interactively."
17220 #: ../fish/guestfish.pod:300
17222 "Progress bars are enabled by default when guestfish is used as an "
17223 "interactive shell."
17227 #: ../fish/guestfish.pod:303
17228 msgid "B<--no-progress-bars>"
17232 #: ../fish/guestfish.pod:305
17233 msgid "Disable progress bars."
17237 #: ../fish/guestfish.pod:307
17238 msgid "B<--remote[=pid]>"
17242 #: ../fish/guestfish.pod:309
17244 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17245 "CONTROL GUESTFISH OVER A SOCKET> below."
17249 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17250 msgid "B<-r> | B<--ro>"
17254 #: ../fish/guestfish.pod:314
17256 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17257 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17261 #: ../fish/guestfish.pod:317
17263 "The option must always be used if the disk image or virtual machine might be "
17264 "running, and is generally recommended in cases where you don't need write "
17265 "access to the disk."
17269 #: ../fish/guestfish.pod:321
17271 "Note that prepared disk images created with I<-N> are not affected by the "
17276 #: ../fish/guestfish.pod:324
17277 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17281 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17282 msgid "B<--selinux>"
17286 #: ../fish/guestfish.pod:328
17287 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17291 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17292 msgid "B<-v> | B<--verbose>"
17296 #: ../fish/guestfish.pod:332
17298 "Enable very verbose messages. This is particularly useful if you find a "
17303 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17304 msgid "B<-V> | B<--version>"
17308 #: ../fish/guestfish.pod:337
17309 msgid "Display the guestfish / libguestfs version number and exit."
17313 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17314 msgid "B<-w> | B<--rw>"
17318 #: ../fish/guestfish.pod:341
17320 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17325 #: ../fish/guestfish.pod:344
17330 #: ../fish/guestfish.pod:346
17331 msgid "Echo each command before executing it."
17335 #: ../fish/guestfish.pod:350
17336 msgid "COMMANDS ON COMMAND LINE"
17340 #: ../fish/guestfish.pod:352
17341 msgid "Any additional (non-option) arguments are treated as commands to execute."
17345 #: ../fish/guestfish.pod:355
17347 "Commands to execute should be separated by a colon (C<:>), where the colon "
17348 "is a separate parameter. Thus:"
17352 #: ../fish/guestfish.pod:358
17355 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17360 #: ../fish/guestfish.pod:360
17362 "If there are no additional arguments, then we enter a shell, either an "
17363 "interactive shell with a prompt (if the input is a terminal) or a "
17364 "non-interactive shell."
17368 #: ../fish/guestfish.pod:364
17370 "In either command line mode or non-interactive shell, the first command that "
17371 "gives an error causes the whole shell to exit. In interactive mode (with a "
17372 "prompt) if a command fails, you can continue to enter commands."
17376 #: ../fish/guestfish.pod:369
17377 msgid "USING launch (OR run)"
17381 #: ../fish/guestfish.pod:371
17383 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17384 "then launch it, then mount any disks you need, and finally issue "
17385 "actions/commands. So the general order of the day is:"
17389 #: ../fish/guestfish.pod:379
17390 msgid "add or -a/--add"
17394 #: ../fish/guestfish.pod:383
17395 msgid "launch (aka run)"
17399 #: ../fish/guestfish.pod:387
17400 msgid "mount or -m/--mount"
17404 #: ../fish/guestfish.pod:391
17405 msgid "any other commands"
17409 #: ../fish/guestfish.pod:395
17411 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17412 "guest before mounting or performing any other commands."
17416 #: ../fish/guestfish.pod:398
17418 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17419 "I<--new> options were given then C<run> is done automatically, simply "
17420 "because guestfish can't perform the action you asked for without doing this."
17424 #: ../fish/guestfish.pod:403
17425 msgid "OPENING DISKS FOR READ AND WRITE"
17429 #: ../fish/guestfish.pod:405
17431 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17432 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17433 "open disk images read-only or for writing."
17437 #: ../fish/guestfish.pod:409
17439 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17440 "disk images supplied on the command line for write. To open a disk image "
17441 "read-only you have to do I<-a image --ro>."
17445 #: ../fish/guestfish.pod:413
17447 "This matters: If you accidentally open a live VM disk image writable then "
17448 "you will cause irreversible disk corruption."
17452 #: ../fish/guestfish.pod:416
17454 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17455 "images will be opened read-only. You will have to either specify "
17456 "I<guestfish --rw> or change a configuration file in order to get write "
17457 "access for disk images specified by those other command line options."
17461 #: ../fish/guestfish.pod:421
17463 "This version of guestfish has a I<--rw> option which does nothing (it is "
17464 "already the default). However it is highly recommended that you use this "
17465 "option to indicate that guestfish needs write access, and to prepare your "
17466 "scripts for the day when this option will be required for write access."
17470 #: ../fish/guestfish.pod:427
17472 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17473 "other libguestfs program apart from guestfish and guestmount."
17477 #: ../fish/guestfish.pod:430
17482 #: ../fish/guestfish.pod:432
17484 "You can quote ordinary parameters using either single or double quotes. For "
17489 #: ../fish/guestfish.pod:435
17492 " add \"file with a space.img\"\n"
17497 #: ../fish/guestfish.pod:437
17500 " rm '/file name'\n"
17505 #: ../fish/guestfish.pod:439
17513 #: ../fish/guestfish.pod:441
17515 "A few commands require a list of strings to be passed. For these, use a "
17516 "whitespace-separated list, enclosed in quotes. Strings containing "
17517 "whitespace to be passed through must be enclosed in single quotes. A "
17518 "literal single quote must be escaped with a backslash."
17522 #: ../fish/guestfish.pod:446
17525 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17526 " command \"/bin/echo 'foo bar'\"\n"
17527 " command \"/bin/echo \\'foo\\'\"\n"
17532 #: ../fish/guestfish.pod:450
17533 msgid "OPTIONAL ARGUMENTS"
17537 #: ../fish/guestfish.pod:452
17539 "Some commands take optional arguments. These arguments appear in this "
17540 "documentation as C<[argname:..]>. You can use them as in these examples:"
17544 #: ../fish/guestfish.pod:456
17547 " add-drive-opts filename\n"
17552 #: ../fish/guestfish.pod:458
17555 " add-drive-opts filename readonly:true\n"
17560 #: ../fish/guestfish.pod:460
17563 " add-drive-opts filename format:qcow2 readonly:false\n"
17568 #: ../fish/guestfish.pod:462
17570 "Each optional argument can appear at most once. All optional arguments must "
17571 "appear after the required ones."
17575 #: ../fish/guestfish.pod:465
17580 #: ../fish/guestfish.pod:467
17581 msgid "This section applies to all commands which can take integers as parameters."
17585 #: ../fish/guestfish.pod:470
17586 msgid "SIZE SUFFIX"
17590 #: ../fish/guestfish.pod:472
17592 "When the command takes a parameter measured in bytes, you can use one of the "
17593 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17597 #: ../fish/guestfish.pod:478
17598 msgid "B<k> or B<K> or B<KiB>"
17602 #: ../fish/guestfish.pod:480
17603 msgid "The size in kilobytes (multiplied by 1024)."
17607 #: ../fish/guestfish.pod:482
17612 #: ../fish/guestfish.pod:484
17613 msgid "The size in SI 1000 byte units."
17617 #: ../fish/guestfish.pod:486
17618 msgid "B<M> or B<MiB>"
17622 #: ../fish/guestfish.pod:488
17623 msgid "The size in megabytes (multiplied by 1048576)."
17627 #: ../fish/guestfish.pod:490
17632 #: ../fish/guestfish.pod:492
17633 msgid "The size in SI 1000000 byte units."
17637 #: ../fish/guestfish.pod:494
17638 msgid "B<G> or B<GiB>"
17642 #: ../fish/guestfish.pod:496
17643 msgid "The size in gigabytes (multiplied by 2**30)."
17647 #: ../fish/guestfish.pod:498
17652 #: ../fish/guestfish.pod:500
17653 msgid "The size in SI 10**9 byte units."
17657 #: ../fish/guestfish.pod:502
17658 msgid "B<T> or B<TiB>"
17662 #: ../fish/guestfish.pod:504
17663 msgid "The size in terabytes (multiplied by 2**40)."
17667 #: ../fish/guestfish.pod:506
17672 #: ../fish/guestfish.pod:508
17673 msgid "The size in SI 10**12 byte units."
17677 #: ../fish/guestfish.pod:510
17678 msgid "B<P> or B<PiB>"
17682 #: ../fish/guestfish.pod:512
17683 msgid "The size in petabytes (multiplied by 2**50)."
17687 #: ../fish/guestfish.pod:514
17692 #: ../fish/guestfish.pod:516
17693 msgid "The size in SI 10**15 byte units."
17697 #: ../fish/guestfish.pod:518
17698 msgid "B<E> or B<EiB>"
17702 #: ../fish/guestfish.pod:520
17703 msgid "The size in exabytes (multiplied by 2**60)."
17707 #: ../fish/guestfish.pod:522
17712 #: ../fish/guestfish.pod:524
17713 msgid "The size in SI 10**18 byte units."
17717 #: ../fish/guestfish.pod:526
17718 msgid "B<Z> or B<ZiB>"
17722 #: ../fish/guestfish.pod:528
17723 msgid "The size in zettabytes (multiplied by 2**70)."
17727 #: ../fish/guestfish.pod:530
17732 #: ../fish/guestfish.pod:532
17733 msgid "The size in SI 10**21 byte units."
17737 #: ../fish/guestfish.pod:534
17738 msgid "B<Y> or B<YiB>"
17742 #: ../fish/guestfish.pod:536
17743 msgid "The size in yottabytes (multiplied by 2**80)."
17747 #: ../fish/guestfish.pod:538
17752 #: ../fish/guestfish.pod:540
17753 msgid "The size in SI 10**24 byte units."
17757 #: ../fish/guestfish.pod:546
17760 " truncate-size /file 1G\n"
17765 #: ../fish/guestfish.pod:548
17766 msgid "would truncate the file to 1 gigabyte."
17770 #: ../fish/guestfish.pod:550
17772 "Be careful because a few commands take sizes in kilobytes or megabytes "
17773 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17774 "Adding a suffix will probably not do what you expect."
17778 #: ../fish/guestfish.pod:554
17779 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17783 #: ../fish/guestfish.pod:556
17785 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17786 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17790 #: ../fish/guestfish.pod:559
17793 " 1234 decimal number 1234\n"
17794 " 02322 octal number, equivalent to decimal 1234\n"
17795 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17800 #: ../fish/guestfish.pod:563
17802 "When using the C<chmod> command, you almost always want to specify an octal "
17803 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17804 "L<chmod(1)> program):"
17808 #: ../fish/guestfish.pod:567
17811 " chmod 0777 /public # OK\n"
17812 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17817 #: ../fish/guestfish.pod:570
17819 "Commands that return numbers usually print them in decimal, but some "
17820 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17821 "octal, preceeded by C<0>)."
17825 #: ../fish/guestfish.pod:574
17826 msgid "WILDCARDS AND GLOBBING"
17830 #: ../fish/guestfish.pod:576
17832 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17833 "(globbing) by default. So for example the following will not do what you "
17838 #: ../fish/guestfish.pod:580
17846 #: ../fish/guestfish.pod:582
17848 "Assuming you don't have a directory called literally C</home/*> then the "
17849 "above command will return an error."
17853 #: ../fish/guestfish.pod:585
17854 msgid "To perform wildcard expansion, use the C<glob> command."
17858 #: ../fish/guestfish.pod:587
17861 " glob rm-rf /home/*\n"
17866 #: ../fish/guestfish.pod:589
17868 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17869 "many times), equivalent to:"
17873 #: ../fish/guestfish.pod:592
17876 " rm-rf /home/jim\n"
17877 " rm-rf /home/joe\n"
17878 " rm-rf /home/mary\n"
17883 #: ../fish/guestfish.pod:596
17884 msgid "C<glob> only works on simple guest paths and not on device names."
17888 #: ../fish/guestfish.pod:598
17890 "If you have several parameters, each containing a wildcard, then glob will "
17891 "perform a Cartesian product."
17895 #: ../fish/guestfish.pod:601
17900 #: ../fish/guestfish.pod:603
17902 "Any line which starts with a I<#> character is treated as a comment and "
17903 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17904 "a command. For example:"
17908 #: ../fish/guestfish.pod:607
17911 " # this is a comment\n"
17912 " # this is a comment\n"
17913 " foo # NOT a comment\n"
17918 #: ../fish/guestfish.pod:611
17919 msgid "Blank lines are also ignored."
17923 #: ../fish/guestfish.pod:613
17924 msgid "RUNNING COMMANDS LOCALLY"
17928 #: ../fish/guestfish.pod:615
17930 "Any line which starts with a I<!> character is treated as a command sent to "
17931 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17935 #: ../fish/guestfish.pod:619
17939 " tgz-out /remote local/remote-data.tar.gz\n"
17944 #: ../fish/guestfish.pod:622
17946 "will create a directory C<local> on the host, and then export the contents "
17947 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17948 "(See C<tgz-out>)."
17952 #: ../fish/guestfish.pod:626
17954 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17955 "effect, due to the way that subprocesses work in Unix."
17959 #: ../fish/guestfish.pod:629
17964 #: ../fish/guestfish.pod:631
17966 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17967 "command (a guestfish command) to the second command (any host command). For "
17972 #: ../fish/guestfish.pod:635
17975 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17980 #: ../fish/guestfish.pod:637
17982 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17983 "program). The above command would list all accounts in the guest filesystem "
17984 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17988 #: ../fish/guestfish.pod:642
17991 " hexdump /bin/ls | head\n"
17992 " list-devices | tail -1\n"
17993 " tgz-out / - | tar ztf -\n"
17998 #: ../fish/guestfish.pod:646
18000 "The space before the pipe symbol is required, any space after the pipe "
18001 "symbol is optional. Everything after the pipe symbol is just passed "
18002 "straight to the host shell, so it can contain redirections, globs and "
18003 "anything else that makes sense on the host side."
18007 #: ../fish/guestfish.pod:651
18009 "To use a literal argument which begins with a pipe symbol, you have to quote "
18014 #: ../fish/guestfish.pod:654
18022 #: ../fish/guestfish.pod:656
18023 msgid "HOME DIRECTORIES"
18027 #: ../fish/guestfish.pod:658
18029 "If a parameter starts with the character C<~> then the tilde may be expanded "
18030 "as a home directory path (either C<~> for the current user's home directory, "
18031 "or C<~user> for another user)."
18035 #: ../fish/guestfish.pod:662
18037 "Note that home directory expansion happens for users known I<on the host>, "
18038 "not in the guest filesystem."
18042 #: ../fish/guestfish.pod:665
18044 "To use a literal argument which begins with a tilde, you have to quote it, "
18049 #: ../fish/guestfish.pod:668
18057 #: ../fish/guestfish.pod:672
18059 "Libguestfs has some support for Linux guests encrypted according to the "
18060 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18061 "disk encryption systems used by modern Linux guests. Currently only "
18062 "LVM-on-LUKS is supported."
18066 #: ../fish/guestfish.pod:677
18067 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18071 #: ../fish/guestfish.pod:679
18074 " ><fs> vfs-type /dev/sda2\n"
18080 #: ../fish/guestfish.pod:682
18082 "Then open those devices using L</luks-open>. This creates a device-mapper "
18083 "device called C</dev/mapper/luksdev>."
18087 #: ../fish/guestfish.pod:685
18090 " ><fs> luks-open /dev/sda2 luksdev\n"
18091 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18096 #: ../fish/guestfish.pod:688
18098 "Finally you have to tell LVM to scan for volume groups on the newly created "
18103 #: ../fish/guestfish.pod:691
18107 " vg-activate-all true\n"
18112 #: ../fish/guestfish.pod:694
18113 msgid "The logical volume(s) can now be mounted in the usual way."
18117 #: ../fish/guestfish.pod:696
18119 "Before closing a LUKS device you must unmount any logical volumes on it and "
18120 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18121 "one. Then you can close the mapper device:"
18125 #: ../fish/guestfish.pod:700
18128 " vg-activate false /dev/VG\n"
18129 " luks-close /dev/mapper/luksdev\n"
18134 #: ../fish/guestfish.pod:703
18135 msgid "WINDOWS PATHS"
18139 #: ../fish/guestfish.pod:705
18141 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18142 "(with some limitations). The following commands are equivalent:"
18146 #: ../fish/guestfish.pod:708
18149 " file /WINDOWS/system32/config/system.LOG\n"
18154 #: ../fish/guestfish.pod:710
18157 " file win:/windows/system32/config/system.log\n"
18162 #: ../fish/guestfish.pod:712
18165 " file win:\\windows\\system32\\config\\system.log\n"
18170 #: ../fish/guestfish.pod:714
18173 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18178 #: ../fish/guestfish.pod:716
18180 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18181 "handles case insensitivity like Windows would. This only works in argument "
18182 "positions that expect a path."
18186 #: ../fish/guestfish.pod:720
18187 msgid "UPLOADING AND DOWNLOADING FILES"
18191 #: ../fish/guestfish.pod:722
18193 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18194 "others which upload from or download to a local file, you can use the "
18195 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18199 #: ../fish/guestfish.pod:726
18207 #: ../fish/guestfish.pod:728
18208 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
18212 #: ../fish/guestfish.pod:731
18215 " tar-out /etc - | tar tf -\n"
18220 #: ../fish/guestfish.pod:733
18222 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18223 "command (see L</PIPES>)."
18227 #: ../fish/guestfish.pod:736
18229 "When using C<-> to read from stdin, the input is read up to the end of "
18230 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18231 "some arbitrary end marker:"
18235 #: ../fish/guestfish.pod:740
18238 " upload -<<END /foo\n"
18247 #: ../fish/guestfish.pod:746
18249 "Any string of characters can be used instead of C<END>. The end marker must "
18250 "appear on a line of its own, without any preceeding or following characters "
18251 "(not even spaces)."
18255 #: ../fish/guestfish.pod:750
18257 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18258 "upload local files (so-called \"FileIn\" parameters in the generator)."
18262 #: ../fish/guestfish.pod:753
18263 msgid "EXIT ON ERROR BEHAVIOUR"
18267 #: ../fish/guestfish.pod:755
18269 "By default, guestfish will ignore any errors when in interactive mode "
18270 "(ie. taking commands from a human over a tty), and will exit on the first "
18271 "error in non-interactive mode (scripts, commands given on the command line)."
18275 #: ../fish/guestfish.pod:760
18277 "If you prefix a command with a I<-> character, then that command will not "
18278 "cause guestfish to exit, even if that (one) command returns an error."
18282 #: ../fish/guestfish.pod:764
18283 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18287 #: ../fish/guestfish.pod:766
18289 "Guestfish can be remote-controlled over a socket. This is useful "
18290 "particularly in shell scripts where you want to make several different "
18291 "changes to a filesystem, but you don't want the overhead of starting up a "
18292 "guestfish process each time."
18296 #: ../fish/guestfish.pod:771
18297 msgid "Start a guestfish server process using:"
18301 #: ../fish/guestfish.pod:773
18304 " eval \"`guestfish --listen`\"\n"
18309 #: ../fish/guestfish.pod:775
18310 msgid "and then send it commands by doing:"
18314 #: ../fish/guestfish.pod:777
18317 " guestfish --remote cmd [...]\n"
18322 #: ../fish/guestfish.pod:779
18323 msgid "To cause the server to exit, send it the exit command:"
18327 #: ../fish/guestfish.pod:781
18330 " guestfish --remote exit\n"
18335 #: ../fish/guestfish.pod:783
18337 "Note that the server will normally exit if there is an error in a command. "
18338 "You can change this in the usual way. See section L</EXIT ON ERROR "
18343 #: ../fish/guestfish.pod:787
18344 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18348 #: ../fish/guestfish.pod:789
18350 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18351 "is how the I<--remote> option knows where to send the commands. You can "
18352 "have several guestfish listener processes running using:"
18356 #: ../fish/guestfish.pod:793
18359 " eval \"`guestfish --listen`\"\n"
18360 " pid1=$GUESTFISH_PID\n"
18361 " eval \"`guestfish --listen`\"\n"
18362 " pid2=$GUESTFISH_PID\n"
18364 " guestfish --remote=$pid1 cmd\n"
18365 " guestfish --remote=$pid2 cmd\n"
18370 #: ../fish/guestfish.pod:801
18371 msgid "REMOTE CONTROL AND CSH"
18375 #: ../fish/guestfish.pod:803
18377 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18382 #: ../fish/guestfish.pod:806
18385 " eval \"`guestfish --listen --csh`\"\n"
18390 #: ../fish/guestfish.pod:808
18391 msgid "REMOTE CONTROL DETAILS"
18395 #: ../fish/guestfish.pod:810
18397 "Remote control happens over a Unix domain socket called "
18398 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
18399 "of the process, and C<$PID> is the process ID of the server."
18403 #: ../fish/guestfish.pod:814
18404 msgid "Guestfish client and server versions must match exactly."
18408 #: ../fish/guestfish.pod:816
18409 msgid "PREPARED DISK IMAGES"
18413 #: ../fish/guestfish.pod:818
18415 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18416 "preformatted disk images that guestfish can make for you to save typing. "
18417 "This is particularly useful for testing purposes. This option is used "
18418 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18419 "can be mixed with I<-a>)."
18423 #: ../fish/guestfish.pod:824
18425 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18426 "the second and so on. Existing files in the current directory are "
18431 #: ../fish/guestfish.pod:828
18433 "The type briefly describes how the disk should be sized, partitioned, how "
18434 "filesystem(s) should be created, and how content should be added. "
18435 "Optionally the type can be followed by extra parameters, separated by C<:> "
18436 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
18437 "sparsely-allocated disk, containing a single partition, with the partition "
18438 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
18439 "on a 1GB disk instead."
18443 #: ../fish/guestfish.pod:836
18444 msgid "To list the available types and any extra parameters they take, run:"
18448 #: ../fish/guestfish.pod:840
18450 "Note that the prepared filesystem is not mounted. You would usually have to "
18451 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18455 #: ../fish/guestfish.pod:844
18457 "If any I<-N> or I<--new> options are given, the guest is automatically "
18462 #: ../fish/guestfish.pod:849
18463 msgid "Create a 100MB disk with an ext4-formatted partition:"
18467 #: ../fish/guestfish.pod:851
18470 " guestfish -N fs:ext4\n"
18475 #: ../fish/guestfish.pod:853
18476 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18480 #: ../fish/guestfish.pod:855
18483 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18488 #: ../fish/guestfish.pod:857
18489 msgid "Create a blank 200MB disk:"
18493 #: ../fish/guestfish.pod:859
18496 " guestfish -N disk:200M\n"
18501 #: ../fish/guestfish.pod:861
18502 msgid "PROGRESS BARS"
18506 #: ../fish/guestfish.pod:863
18508 "Some (not all) long-running commands send progress notification messages as "
18509 "they are running. Guestfish turns these messages into progress bars."
18513 #: ../fish/guestfish.pod:867
18515 "When a command that supports progress bars takes longer than two seconds to "
18516 "run, and if progress bars are enabled, then you will see one appearing below "
18521 #: ../fish/guestfish.pod:871
18524 " ><fs> copy-size /large-file /another-file 2048M\n"
18525 " / 10% [#####-----------------------------------------] 00:30\n"
18530 #: ../fish/guestfish.pod:874
18532 "The spinner on the left hand side moves round once for every progress "
18533 "notification received from the backend. This is a (reasonably) golden "
18534 "assurance that the command is \"doing something\" even if the progress bar "
18535 "is not moving, because the command is able to send the progress "
18536 "notifications. When the bar reaches 100% and the command finishes, the "
18537 "spinner disappears."
18541 #: ../fish/guestfish.pod:881
18543 "Progress bars are enabled by default when guestfish is used interactively. "
18544 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18545 "and you can disable them completely using I<--no-progress-bars>."
18549 #: ../fish/guestfish.pod:886
18550 msgid "GUESTFISH COMMANDS"
18554 #: ../fish/guestfish.pod:888
18556 "The commands in this section are guestfish convenience commands, in other "
18557 "words, they are not part of the L<guestfs(3)> API."
18561 #: ../fish/guestfish.pod:891
18566 #: ../fish/guestfish.pod:893
18575 #: ../fish/guestfish.pod:896
18576 msgid "Without any parameter, this provides general help."
18580 #: ../fish/guestfish.pod:898
18581 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18585 #: ../fish/guestfish.pod:900
18586 msgid "quit | exit"
18590 #: ../fish/guestfish.pod:902
18591 msgid "This exits guestfish. You can also use C<^D> key."
18595 #: ../fish/guestfish.pod:904
18596 msgid "@FISH_COMMANDS@"
18600 #: ../fish/guestfish.pod:906
18605 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18610 #: ../fish/guestfish.pod:912
18612 "guestfish returns 0 if the commands completed without error, or 1 if there "
18617 #: ../fish/guestfish.pod:919
18622 #: ../fish/guestfish.pod:921
18624 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18629 #: ../fish/guestfish.pod:924
18630 msgid "GUESTFISH_PID"
18634 #: ../fish/guestfish.pod:926
18636 "Used with the I<--remote> option to specify the remote guestfish process to "
18637 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18641 #: ../fish/guestfish.pod:930
18646 #: ../fish/guestfish.pod:932
18648 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18649 "not specified, the external L<hexedit(1)> program is used."
18653 #: ../fish/guestfish.pod:936
18658 #: ../fish/guestfish.pod:938
18660 "If compiled with GNU readline support, various files in the home directory "
18661 "can be used. See L</FILES>."
18665 #: ../fish/guestfish.pod:947
18667 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18668 "effect as using the B<-v> option."
18672 #: ../fish/guestfish.pod:959
18674 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18675 "the discussion of paths in L<guestfs(3)>."
18679 #: ../fish/guestfish.pod:970
18680 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18684 #: ../fish/guestfish.pod:972
18689 #: ../fish/guestfish.pod:974
18691 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18696 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
18701 #: ../fish/guestfish.pod:993
18702 msgid "$HOME/.guestfish"
18706 #: ../fish/guestfish.pod:995
18708 "If compiled with GNU readline support, then the command history is saved in "
18713 #: ../fish/guestfish.pod:998
18714 msgid "$HOME/.inputrc"
18718 #: ../fish/guestfish.pod:1000
18719 msgid "/etc/inputrc"
18723 #: ../fish/guestfish.pod:1002
18725 "If compiled with GNU readline support, then these files can be used to "
18726 "configure readline. For further information, please see "
18727 "L<readline(3)/INITIALIZATION FILE>."
18731 #: ../fish/guestfish.pod:1006
18732 msgid "To write rules which only apply to guestfish, use:"
18736 #: ../fish/guestfish.pod:1008
18746 #: ../fish/guestfish.pod:1012
18748 "Variables that you can set in inputrc that change the behaviour of guestfish "
18749 "in useful ways include:"
18753 #: ../fish/guestfish.pod:1017
18754 msgid "completion-ignore-case (default: on)"
18758 #: ../fish/guestfish.pod:1019
18760 "By default, guestfish will ignore case when tab-completing paths on the "
18765 #: ../fish/guestfish.pod:1022
18768 " set completion-ignore-case off\n"
18773 #: ../fish/guestfish.pod:1024
18774 msgid "to make guestfish case sensitive."
18778 #: ../fish/guestfish.pod:1028
18783 #: ../fish/guestfish.pod:1030
18784 msgid "test2.img (etc)"
18788 #: ../fish/guestfish.pod:1032
18790 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18791 "will be created in the file C<test1.img> in the current directory. The "
18792 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18793 "the same name will be overwritten."
18797 #: ../fish/guestfish.pod:1041
18799 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18800 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
18801 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
18802 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
18803 "L<virt-win-reg(1)>, L<hexedit(1)>."
18807 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
18809 "This program is free software; you can redistribute it and/or modify it "
18810 "under the terms of the GNU General Public License as published by the Free "
18811 "Software Foundation; either version 2 of the License, or (at your option) "
18812 "any later version."
18816 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
18818 "This program is distributed in the hope that it will be useful, but WITHOUT "
18819 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18820 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18825 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
18827 "You should have received a copy of the GNU General Public License along with "
18828 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18829 "Ave, Cambridge, MA 02139, USA."
18833 #: ../fish/guestfish-actions.pod:1
18838 #: ../fish/guestfish-actions.pod:3
18841 " add-cdrom filename\n"
18846 #: ../fish/guestfish-actions.pod:15
18848 "This call checks for the existence of C<filename>. This stops you from "
18849 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18850 "and C<http:> URLs. To specify those, use the general L</config> call "
18855 #: ../fish/guestfish-actions.pod:22
18857 "If you just want to add an ISO file (often you use this as an efficient way "
18858 "to transfer large files into the guest), then you should probably use "
18859 "L</add-drive-ro> instead."
18863 #: ../fish/guestfish-actions.pod:35
18868 #: ../fish/guestfish-actions.pod:37
18873 #: ../fish/guestfish-actions.pod:39
18876 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18881 #: ../fish/guestfish-actions.pod:41
18883 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18884 "It works by connecting to libvirt, requesting the domain and domain XML from "
18885 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18889 #: ../fish/guestfish-actions.pod:58
18891 "The optional C<libvirturi> parameter sets the libvirt URI (see "
18892 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
18893 "default libvirt URI (or one set through an environment variable, see the "
18894 "libvirt documentation for full details). If you are using the C API "
18895 "directly then it is more flexible to create the libvirt connection object "
18896 "yourself, get the domain object, and call L</add-libvirt-dom>."
18900 #: ../fish/guestfish-actions.pod:66
18902 "The other optional parameters are passed directly through to "
18903 "L</add-drive-opts>."
18907 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133 ../fish/guestfish-actions.pod:2804
18909 "This command has one or more optional arguments. See L</OPTIONAL "
18914 #: ../fish/guestfish-actions.pod:71
18919 #: ../fish/guestfish-actions.pod:73
18922 " add-drive filename\n"
18927 #: ../fish/guestfish-actions.pod:75
18929 "This function is the equivalent of calling L</add-drive-opts> with no "
18930 "optional parameters, so the disk is added writable, with the format being "
18931 "detected automatically."
18935 #: ../fish/guestfish-actions.pod:79
18937 "Automatic detection of the format opens you up to a potential security hole "
18938 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18939 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18940 "you should think about replacing calls to this function with calls to "
18941 "L</add-drive-opts>, and specifying the format."
18945 #: ../fish/guestfish-actions.pod:86
18946 msgid "add-drive-opts"
18950 #: ../fish/guestfish-actions.pod:88
18955 #: ../fish/guestfish-actions.pod:90
18958 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18963 #: ../fish/guestfish-actions.pod:117
18965 "This forces the image format. If you omit this (or use L</add-drive> or "
18966 "L</add-drive-ro>) then the format is automatically detected. Possible "
18967 "formats include C<raw> and C<qcow2>."
18971 #: ../fish/guestfish-actions.pod:128
18973 "This rarely-used option lets you emulate the behaviour of the deprecated "
18974 "L</add-drive-with-if> call (q.v.)"
18978 #: ../fish/guestfish-actions.pod:135
18979 msgid "add-drive-ro"
18983 #: ../fish/guestfish-actions.pod:137
18988 #: ../fish/guestfish-actions.pod:139
18991 " add-drive-ro filename\n"
18996 #: ../fish/guestfish-actions.pod:141
18998 "This function is the equivalent of calling L</add-drive-opts> with the "
18999 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19000 "is added read-only, with the format being detected automatically."
19004 #: ../fish/guestfish-actions.pod:146
19005 msgid "add-drive-ro-with-if"
19009 #: ../fish/guestfish-actions.pod:148
19012 " add-drive-ro-with-if filename iface\n"
19017 #: ../fish/guestfish-actions.pod:150
19019 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19020 "interface emulation to use at run time."
19024 #: ../fish/guestfish-actions.pod:160
19025 msgid "add-drive-with-if"
19029 #: ../fish/guestfish-actions.pod:162
19032 " add-drive-with-if filename iface\n"
19037 #: ../fish/guestfish-actions.pod:164
19039 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19040 "interface emulation to use at run time."
19044 #: ../fish/guestfish-actions.pod:174
19049 #: ../fish/guestfish-actions.pod:176
19052 " aug-clear augpath\n"
19057 #: ../fish/guestfish-actions.pod:181
19062 #: ../fish/guestfish-actions.pod:183
19070 #: ../fish/guestfish-actions.pod:185
19072 "Close the current Augeas handle and free up any resources used by it. After "
19073 "calling this, you have to call L</aug-init> again before you can use any "
19074 "other Augeas functions."
19078 #: ../fish/guestfish-actions.pod:190
19079 msgid "aug-defnode"
19083 #: ../fish/guestfish-actions.pod:192
19086 " aug-defnode name expr val\n"
19091 #: ../fish/guestfish-actions.pod:197
19093 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19094 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19095 "containing that single node."
19099 #: ../fish/guestfish-actions.pod:205
19104 #: ../fish/guestfish-actions.pod:207
19107 " aug-defvar name expr\n"
19112 #: ../fish/guestfish-actions.pod:216
19117 #: ../fish/guestfish-actions.pod:218
19120 " aug-get augpath\n"
19125 #: ../fish/guestfish-actions.pod:223
19130 #: ../fish/guestfish-actions.pod:225
19133 " aug-init root flags\n"
19138 #: ../fish/guestfish-actions.pod:231
19139 msgid "You must call this before using any other L</aug-*> commands."
19143 #: ../fish/guestfish-actions.pod:266
19144 msgid "Do not load the tree in L</aug-init>."
19148 #: ../fish/guestfish-actions.pod:270
19149 msgid "To close the handle, you can call L</aug-close>."
19153 #: ../fish/guestfish-actions.pod:274
19158 #: ../fish/guestfish-actions.pod:276
19161 " aug-insert augpath label true|false\n"
19166 #: ../fish/guestfish-actions.pod:286
19171 #: ../fish/guestfish-actions.pod:288
19179 #: ../fish/guestfish-actions.pod:295
19184 #: ../fish/guestfish-actions.pod:297
19187 " aug-ls augpath\n"
19192 #: ../fish/guestfish-actions.pod:299
19194 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19195 "resulting nodes into alphabetical order."
19199 #: ../fish/guestfish-actions.pod:302
19204 #: ../fish/guestfish-actions.pod:304
19207 " aug-match augpath\n"
19212 #: ../fish/guestfish-actions.pod:310
19217 #: ../fish/guestfish-actions.pod:312
19220 " aug-mv src dest\n"
19225 #: ../fish/guestfish-actions.pod:317
19230 #: ../fish/guestfish-actions.pod:319
19233 " aug-rm augpath\n"
19238 #: ../fish/guestfish-actions.pod:325
19243 #: ../fish/guestfish-actions.pod:327
19251 #: ../fish/guestfish-actions.pod:331
19253 "The flags which were passed to L</aug-init> affect exactly how files are "
19258 #: ../fish/guestfish-actions.pod:334
19263 #: ../fish/guestfish-actions.pod:336
19266 " aug-set augpath val\n"
19271 #: ../fish/guestfish-actions.pod:340
19273 "In the Augeas API, it is possible to clear a node by setting the value to "
19274 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19275 "this call. Instead you must use the L</aug-clear> call."
19279 #: ../fish/guestfish-actions.pod:345
19284 #: ../fish/guestfish-actions.pod:347
19287 " available 'groups ...'\n"
19292 #: ../fish/guestfish-actions.pod:353
19294 "The libguestfs groups, and the functions that those groups correspond to, "
19295 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19296 "runtime by calling L</available-all-groups>."
19300 #: ../fish/guestfish-actions.pod:377
19301 msgid "You must call L</launch> before calling this function."
19305 #: ../fish/guestfish-actions.pod:399
19307 "This call was added in version C<1.0.80>. In previous versions of "
19308 "libguestfs all you could do would be to speculatively execute a command to "
19309 "find out if the daemon implemented it. See also L</version>."
19313 #: ../fish/guestfish-actions.pod:406
19314 msgid "available-all-groups"
19318 #: ../fish/guestfish-actions.pod:408
19321 " available-all-groups\n"
19326 #: ../fish/guestfish-actions.pod:410
19328 "This command returns a list of all optional groups that this daemon knows "
19329 "about. Note this returns both supported and unsupported groups. To find "
19330 "out which ones the daemon can actually support you have to call "
19331 "L</available> on each member of the returned list."
19335 #: ../fish/guestfish-actions.pod:416
19336 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19340 #: ../fish/guestfish-actions.pod:418
19345 #: ../fish/guestfish-actions.pod:420
19348 " base64-in (base64file|-) filename\n"
19353 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434 ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827 ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223 ../fish/guestfish-actions.pod:4159 ../fish/guestfish-actions.pod:4171 ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4193 ../fish/guestfish-actions.pod:4245 ../fish/guestfish-actions.pod:4254 ../fish/guestfish-actions.pod:4308 ../fish/guestfish-actions.pod:4331
19354 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19358 #: ../fish/guestfish-actions.pod:427
19363 #: ../fish/guestfish-actions.pod:429
19366 " base64-out filename (base64file|-)\n"
19371 #: ../fish/guestfish-actions.pod:436
19372 msgid "blockdev-flushbufs"
19376 #: ../fish/guestfish-actions.pod:438
19379 " blockdev-flushbufs device\n"
19384 #: ../fish/guestfish-actions.pod:445
19385 msgid "blockdev-getbsz"
19389 #: ../fish/guestfish-actions.pod:447
19392 " blockdev-getbsz device\n"
19397 #: ../fish/guestfish-actions.pod:456
19398 msgid "blockdev-getro"
19402 #: ../fish/guestfish-actions.pod:458
19405 " blockdev-getro device\n"
19410 #: ../fish/guestfish-actions.pod:465
19411 msgid "blockdev-getsize64"
19415 #: ../fish/guestfish-actions.pod:467
19418 " blockdev-getsize64 device\n"
19423 #: ../fish/guestfish-actions.pod:471
19424 msgid "See also L</blockdev-getsz>."
19428 #: ../fish/guestfish-actions.pod:475
19429 msgid "blockdev-getss"
19433 #: ../fish/guestfish-actions.pod:477
19436 " blockdev-getss device\n"
19441 #: ../fish/guestfish-actions.pod:482
19442 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19446 #: ../fish/guestfish-actions.pod:487
19447 msgid "blockdev-getsz"
19451 #: ../fish/guestfish-actions.pod:489
19454 " blockdev-getsz device\n"
19459 #: ../fish/guestfish-actions.pod:494
19461 "See also L</blockdev-getss> for the real sector size of the device, and "
19462 "L</blockdev-getsize64> for the more useful I<size in bytes>."
19466 #: ../fish/guestfish-actions.pod:500
19467 msgid "blockdev-rereadpt"
19471 #: ../fish/guestfish-actions.pod:502
19474 " blockdev-rereadpt device\n"
19479 #: ../fish/guestfish-actions.pod:508
19480 msgid "blockdev-setbsz"
19484 #: ../fish/guestfish-actions.pod:510
19487 " blockdev-setbsz device blocksize\n"
19492 #: ../fish/guestfish-actions.pod:519
19493 msgid "blockdev-setro"
19497 #: ../fish/guestfish-actions.pod:521
19500 " blockdev-setro device\n"
19505 #: ../fish/guestfish-actions.pod:527
19506 msgid "blockdev-setrw"
19510 #: ../fish/guestfish-actions.pod:529
19513 " blockdev-setrw device\n"
19518 #: ../fish/guestfish-actions.pod:535
19519 msgid "case-sensitive-path"
19523 #: ../fish/guestfish-actions.pod:537
19526 " case-sensitive-path path\n"
19531 #: ../fish/guestfish-actions.pod:561
19533 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
19534 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
19535 "how the directories were originally created under Windows)."
19539 #: ../fish/guestfish-actions.pod:569
19540 msgid "See also L</realpath>."
19544 #: ../fish/guestfish-actions.pod:571
19549 #: ../fish/guestfish-actions.pod:573
19557 #: ../fish/guestfish-actions.pod:577
19559 "Note that this function cannot correctly handle binary files (specifically, "
19560 "files containing C<\\0> character which is treated as end of string). For "
19561 "those you need to use the L</read-file> or L</download> functions which have "
19562 "a more complex interface."
19566 #: ../fish/guestfish-actions.pod:585
19571 #: ../fish/guestfish-actions.pod:587
19574 " checksum csumtype path\n"
19579 #: ../fish/guestfish-actions.pod:630
19580 msgid "To get the checksum for a device, use L</checksum-device>."
19584 #: ../fish/guestfish-actions.pod:632
19585 msgid "To get the checksums for many files, use L</checksums-out>."
19589 #: ../fish/guestfish-actions.pod:634
19590 msgid "checksum-device"
19594 #: ../fish/guestfish-actions.pod:636
19597 " checksum-device csumtype device\n"
19602 #: ../fish/guestfish-actions.pod:638
19604 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19605 "device named C<device>. For the types of checksums supported see the "
19606 "L</checksum> command."
19610 #: ../fish/guestfish-actions.pod:642
19611 msgid "checksums-out"
19615 #: ../fish/guestfish-actions.pod:644
19618 " checksums-out csumtype directory (sumsfile|-)\n"
19623 #: ../fish/guestfish-actions.pod:660
19628 #: ../fish/guestfish-actions.pod:662
19631 " chmod mode path\n"
19636 #: ../fish/guestfish-actions.pod:673
19641 #: ../fish/guestfish-actions.pod:675
19644 " chown owner group path\n"
19649 #: ../fish/guestfish-actions.pod:683
19654 #: ../fish/guestfish-actions.pod:685
19657 " command 'arguments ...'\n"
19662 #: ../fish/guestfish-actions.pod:692
19664 "The single parameter is an argv-style list of arguments. The first element "
19665 "is the name of the program to run. Subsequent elements are parameters. The "
19666 "list must be non-empty (ie. must contain a program name). Note that the "
19667 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19671 #: ../fish/guestfish-actions.pod:720
19672 msgid "command-lines"
19676 #: ../fish/guestfish-actions.pod:722
19679 " command-lines 'arguments ...'\n"
19684 #: ../fish/guestfish-actions.pod:724
19685 msgid "This is the same as L</command>, but splits the result into a list of lines."
19689 #: ../fish/guestfish-actions.pod:727
19690 msgid "See also: L</sh-lines>"
19694 #: ../fish/guestfish-actions.pod:732
19699 #: ../fish/guestfish-actions.pod:734
19702 " config qemuparam qemuvalue\n"
19707 #: ../fish/guestfish-actions.pod:745
19712 #: ../fish/guestfish-actions.pod:747
19715 " copy-size src dest size\n"
19720 #: ../fish/guestfish-actions.pod:755
19725 #: ../fish/guestfish-actions.pod:757
19733 #: ../fish/guestfish-actions.pod:762
19738 #: ../fish/guestfish-actions.pod:764
19746 #: ../fish/guestfish-actions.pod:769
19751 #: ../fish/guestfish-actions.pod:771
19759 #: ../fish/guestfish-actions.pod:778
19761 "If the destination is a device, it must be as large or larger than the "
19762 "source file or device, otherwise the copy will fail. This command cannot do "
19763 "partial copies (see L</copy-size>)."
19767 #: ../fish/guestfish-actions.pod:782
19772 #: ../fish/guestfish-actions.pod:784
19780 #: ../fish/guestfish-actions.pod:792
19785 #: ../fish/guestfish-actions.pod:794
19793 #: ../fish/guestfish-actions.pod:803
19798 #: ../fish/guestfish-actions.pod:805
19806 #: ../fish/guestfish-actions.pod:811
19808 "Another way to get the same information is to enable verbose messages with "
19809 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19810 "before running the program."
19814 #: ../fish/guestfish-actions.pod:816
19819 #: ../fish/guestfish-actions.pod:818
19822 " download remotefilename (filename|-)\n"
19827 #: ../fish/guestfish-actions.pod:825
19828 msgid "See also L</upload>, L</cat>."
19832 #: ../fish/guestfish-actions.pod:829
19833 msgid "download-offset"
19837 #: ../fish/guestfish-actions.pod:831
19840 " download-offset remotefilename (filename|-) offset size\n"
19845 #: ../fish/guestfish-actions.pod:839
19847 "Note that there is no limit on the amount of data that can be downloaded "
19848 "with this call, unlike with L</pread>, and this call always reads the full "
19849 "amount unless an error occurs."
19853 #: ../fish/guestfish-actions.pod:844
19854 msgid "See also L</download>, L</pread>."
19858 #: ../fish/guestfish-actions.pod:848
19859 msgid "drop-caches"
19863 #: ../fish/guestfish-actions.pod:850
19866 " drop-caches whattodrop\n"
19871 #: ../fish/guestfish-actions.pod:862
19876 #: ../fish/guestfish-actions.pod:864
19884 #: ../fish/guestfish-actions.pod:876
19889 #: ../fish/guestfish-actions.pod:878
19892 " e2fsck-f device\n"
19897 #: ../fish/guestfish-actions.pod:884
19899 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19900 "should use L</fsck>."
19904 #: ../fish/guestfish-actions.pod:887
19905 msgid "echo-daemon"
19909 #: ../fish/guestfish-actions.pod:889
19912 " echo-daemon 'words ...'\n"
19917 #: ../fish/guestfish-actions.pod:896
19918 msgid "See also L</ping-daemon>."
19922 #: ../fish/guestfish-actions.pod:898
19927 #: ../fish/guestfish-actions.pod:900
19930 " egrep regex path\n"
19935 #: ../fish/guestfish-actions.pod:908
19940 #: ../fish/guestfish-actions.pod:910
19943 " egrepi regex path\n"
19948 #: ../fish/guestfish-actions.pod:918
19953 #: ../fish/guestfish-actions.pod:920
19956 " equal file1 file2\n"
19961 #: ../fish/guestfish-actions.pod:927
19966 #: ../fish/guestfish-actions.pod:929
19974 #: ../fish/guestfish-actions.pod:934
19975 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19979 #: ../fish/guestfish-actions.pod:936
19984 #: ../fish/guestfish-actions.pod:938
19987 " fallocate path len\n"
19992 #: ../fish/guestfish-actions.pod:955
19993 msgid "fallocate64"
19997 #: ../fish/guestfish-actions.pod:957
20000 " fallocate64 path len\n"
20005 #: ../fish/guestfish-actions.pod:963
20007 "Note that this call allocates disk blocks for the file. To create a sparse "
20008 "file use L</truncate-size> instead."
20012 #: ../fish/guestfish-actions.pod:966
20014 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20015 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20016 "maximum size of files created through that call to 1GB."
20020 #: ../fish/guestfish-actions.pod:975
20025 #: ../fish/guestfish-actions.pod:977
20028 " fgrep pattern path\n"
20033 #: ../fish/guestfish-actions.pod:985
20038 #: ../fish/guestfish-actions.pod:987
20041 " fgrepi pattern path\n"
20046 #: ../fish/guestfish-actions.pod:995
20051 #: ../fish/guestfish-actions.pod:997
20059 #: ../fish/guestfish-actions.pod:1009
20061 "This command can also be used on C</dev/> devices (and partitions, LV "
20062 "names). You can for example use this to determine if a device contains a "
20063 "filesystem, although it's usually better to use L</vfs-type>."
20067 #: ../fish/guestfish-actions.pod:1019
20068 msgid "file-architecture"
20072 #: ../fish/guestfish-actions.pod:1021
20075 " file-architecture filename\n"
20080 #: ../fish/guestfish-actions.pod:1124
20085 #: ../fish/guestfish-actions.pod:1126
20093 #: ../fish/guestfish-actions.pod:1130
20095 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
20096 "L</is-file> etc. To get the size of block devices, use "
20097 "L</blockdev-getsize64>."
20101 #: ../fish/guestfish-actions.pod:1134
20106 #: ../fish/guestfish-actions.pod:1136
20109 " fill c len path\n"
20114 #: ../fish/guestfish-actions.pod:1142
20116 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20117 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20118 "L</fill-pattern>."
20122 #: ../fish/guestfish-actions.pod:1147
20123 msgid "fill-pattern"
20127 #: ../fish/guestfish-actions.pod:1149
20130 " fill-pattern pattern len path\n"
20135 #: ../fish/guestfish-actions.pod:1151
20137 "This function is like L</fill> except that it creates a new file of length "
20138 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20139 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20144 #: ../fish/guestfish-actions.pod:1156
20149 #: ../fish/guestfish-actions.pod:1158
20152 " find directory\n"
20157 #: ../fish/guestfish-actions.pod:1172
20158 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20162 #: ../fish/guestfish-actions.pod:1185
20163 msgid "See also L</find0>."
20167 #: ../fish/guestfish-actions.pod:1190
20172 #: ../fish/guestfish-actions.pod:1192
20175 " find0 directory (files|-)\n"
20180 #: ../fish/guestfish-actions.pod:1198
20181 msgid "This command works the same way as L</find> with the following exceptions:"
20185 #: ../fish/guestfish-actions.pod:1225
20186 msgid "findfs-label"
20190 #: ../fish/guestfish-actions.pod:1227
20193 " findfs-label label\n"
20198 #: ../fish/guestfish-actions.pod:1233
20199 msgid "To find the label of a filesystem, use L</vfs-label>."
20203 #: ../fish/guestfish-actions.pod:1235
20204 msgid "findfs-uuid"
20208 #: ../fish/guestfish-actions.pod:1237
20211 " findfs-uuid uuid\n"
20216 #: ../fish/guestfish-actions.pod:1243
20217 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20221 #: ../fish/guestfish-actions.pod:1245
20226 #: ../fish/guestfish-actions.pod:1247
20229 " fsck fstype device\n"
20234 #: ../fish/guestfish-actions.pod:1277
20239 #: ../fish/guestfish-actions.pod:1279
20247 #: ../fish/guestfish-actions.pod:1286
20248 msgid "get-autosync"
20252 #: ../fish/guestfish-actions.pod:1288
20260 #: ../fish/guestfish-actions.pod:1292
20265 #: ../fish/guestfish-actions.pod:1294
20273 #: ../fish/guestfish-actions.pod:1298
20274 msgid "get-e2label"
20278 #: ../fish/guestfish-actions.pod:1300
20281 " get-e2label device\n"
20286 #: ../fish/guestfish-actions.pod:1312
20291 #: ../fish/guestfish-actions.pod:1314
20294 " get-e2uuid device\n"
20299 #: ../fish/guestfish-actions.pod:1326
20300 msgid "get-memsize"
20304 #: ../fish/guestfish-actions.pod:1328
20312 #: ../fish/guestfish-actions.pod:1333
20314 "If L</set-memsize> was not called on this handle, and if "
20315 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20316 "value for memsize."
20320 #: ../fish/guestfish-actions.pod:1340
20321 msgid "get-network"
20325 #: ../fish/guestfish-actions.pod:1342
20333 #: ../fish/guestfish-actions.pod:1346
20338 #: ../fish/guestfish-actions.pod:1348
20346 #: ../fish/guestfish-actions.pod:1355
20351 #: ../fish/guestfish-actions.pod:1357
20356 #: ../fish/guestfish-actions.pod:1359
20364 #: ../fish/guestfish-actions.pod:1366
20369 #: ../fish/guestfish-actions.pod:1368
20377 #: ../fish/guestfish-actions.pod:1375
20378 msgid "get-recovery-proc"
20382 #: ../fish/guestfish-actions.pod:1377
20385 " get-recovery-proc\n"
20390 #: ../fish/guestfish-actions.pod:1381
20391 msgid "get-selinux"
20395 #: ../fish/guestfish-actions.pod:1383
20403 #: ../fish/guestfish-actions.pod:1385
20405 "This returns the current setting of the selinux flag which is passed to the "
20406 "appliance at boot time. See L</set-selinux>."
20410 #: ../fish/guestfish-actions.pod:1391
20415 #: ../fish/guestfish-actions.pod:1393
20423 #: ../fish/guestfish-actions.pod:1400
20428 #: ../fish/guestfish-actions.pod:1402
20436 #: ../fish/guestfish-actions.pod:1406
20441 #: ../fish/guestfish-actions.pod:1408
20449 #: ../fish/guestfish-actions.pod:1410
20451 "Return the current umask. By default the umask is C<022> unless it has been "
20452 "set by calling L</umask>."
20456 #: ../fish/guestfish-actions.pod:1413
20457 msgid "get-verbose"
20461 #: ../fish/guestfish-actions.pod:1415
20469 #: ../fish/guestfish-actions.pod:1419
20474 #: ../fish/guestfish-actions.pod:1421
20482 #: ../fish/guestfish-actions.pod:1425
20483 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20487 #: ../fish/guestfish-actions.pod:1428
20492 #: ../fish/guestfish-actions.pod:1430
20495 " getxattrs path\n"
20500 #: ../fish/guestfish-actions.pod:1438
20501 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20505 #: ../fish/guestfish-actions.pod:1440
20506 msgid "glob-expand"
20510 #: ../fish/guestfish-actions.pod:1442
20513 " glob-expand pattern\n"
20518 #: ../fish/guestfish-actions.pod:1455
20523 #: ../fish/guestfish-actions.pod:1457
20526 " grep regex path\n"
20531 #: ../fish/guestfish-actions.pod:1465
20536 #: ../fish/guestfish-actions.pod:1467
20539 " grepi regex path\n"
20544 #: ../fish/guestfish-actions.pod:1475
20545 msgid "grub-install"
20549 #: ../fish/guestfish-actions.pod:1477
20552 " grub-install root device\n"
20557 #: ../fish/guestfish-actions.pod:1493
20562 #: ../fish/guestfish-actions.pod:1495
20570 #: ../fish/guestfish-actions.pod:1503
20575 #: ../fish/guestfish-actions.pod:1505
20578 " head-n nrlines path\n"
20583 #: ../fish/guestfish-actions.pod:1518
20588 #: ../fish/guestfish-actions.pod:1520
20596 #: ../fish/guestfish-actions.pod:1528
20601 #: ../fish/guestfish-actions.pod:1530
20604 " initrd-cat initrdpath filename\n"
20609 #: ../fish/guestfish-actions.pod:1542
20610 msgid "See also L</initrd-list>."
20614 #: ../fish/guestfish-actions.pod:1547
20615 msgid "initrd-list"
20619 #: ../fish/guestfish-actions.pod:1549
20622 " initrd-list path\n"
20627 #: ../fish/guestfish-actions.pod:1561
20628 msgid "inotify-add-watch"
20632 #: ../fish/guestfish-actions.pod:1563
20635 " inotify-add-watch path mask\n"
20640 #: ../fish/guestfish-actions.pod:1575
20641 msgid "inotify-close"
20645 #: ../fish/guestfish-actions.pod:1577
20653 #: ../fish/guestfish-actions.pod:1583
20654 msgid "inotify-files"
20658 #: ../fish/guestfish-actions.pod:1585
20666 #: ../fish/guestfish-actions.pod:1587
20668 "This function is a helpful wrapper around L</inotify-read> which just "
20669 "returns a list of pathnames of objects that were touched. The returned "
20670 "pathnames are sorted and deduplicated."
20674 #: ../fish/guestfish-actions.pod:1591
20675 msgid "inotify-init"
20679 #: ../fish/guestfish-actions.pod:1593
20682 " inotify-init maxevents\n"
20687 #: ../fish/guestfish-actions.pod:1599
20689 "C<maxevents> is the maximum number of events which will be queued up between "
20690 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20691 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20692 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20693 "but records the fact that it threw them away by setting a flag "
20694 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20698 #: ../fish/guestfish-actions.pod:1609
20700 "Before any events are generated, you have to add some watches to the "
20701 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20702 "L</inotify-watch-all>."
20706 #: ../fish/guestfish-actions.pod:1615
20708 "Queued up events should be read periodically by calling L</inotify-read> (or "
20709 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20710 "If you don't read the events out often enough then you risk the internal "
20711 "queue overflowing."
20715 #: ../fish/guestfish-actions.pod:1622
20717 "The handle should be closed after use by calling L</inotify-close>. This "
20718 "also removes any watches automatically."
20722 #: ../fish/guestfish-actions.pod:1631
20723 msgid "inotify-read"
20727 #: ../fish/guestfish-actions.pod:1633
20735 #: ../fish/guestfish-actions.pod:1646
20736 msgid "inotify-rm-watch"
20740 #: ../fish/guestfish-actions.pod:1648
20743 " inotify-rm-watch wd\n"
20748 #: ../fish/guestfish-actions.pod:1650
20749 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20753 #: ../fish/guestfish-actions.pod:1653
20754 msgid "inspect-get-arch"
20758 #: ../fish/guestfish-actions.pod:1655
20761 " inspect-get-arch root\n"
20766 #: ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1673 ../fish/guestfish-actions.pod:1747 ../fish/guestfish-actions.pod:1765 ../fish/guestfish-actions.pod:1780 ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1839 ../fish/guestfish-actions.pod:1861 ../fish/guestfish-actions.pod:1885 ../fish/guestfish-actions.pod:1915 ../fish/guestfish-actions.pod:1950 ../fish/guestfish-actions.pod:1966
20768 "This function should only be called with a root device string as returned by "
20773 #: ../fish/guestfish-actions.pod:1660
20775 "This returns the architecture of the inspected operating system. The "
20776 "possible return values are listed under L</file-architecture>."
20780 #: ../fish/guestfish-actions.pod:1669
20781 msgid "inspect-get-distro"
20785 #: ../fish/guestfish-actions.pod:1671
20788 " inspect-get-distro root\n"
20793 #: ../fish/guestfish-actions.pod:1743
20794 msgid "inspect-get-filesystems"
20798 #: ../fish/guestfish-actions.pod:1745
20801 " inspect-get-filesystems root\n"
20806 #: ../fish/guestfish-actions.pod:1758
20808 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20809 "L</inspect-get-mountpoints>."
20813 #: ../fish/guestfish-actions.pod:1761
20814 msgid "inspect-get-hostname"
20818 #: ../fish/guestfish-actions.pod:1763
20821 " inspect-get-hostname root\n"
20826 #: ../fish/guestfish-actions.pod:1776
20827 msgid "inspect-get-major-version"
20831 #: ../fish/guestfish-actions.pod:1778
20834 " inspect-get-major-version root\n"
20839 #: ../fish/guestfish-actions.pod:1797
20840 msgid "inspect-get-minor-version"
20844 #: ../fish/guestfish-actions.pod:1799
20847 " inspect-get-minor-version root\n"
20852 #: ../fish/guestfish-actions.pod:1809
20854 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20855 "L</inspect-get-major-version>."
20859 #: ../fish/guestfish-actions.pod:1812
20860 msgid "inspect-get-mountpoints"
20864 #: ../fish/guestfish-actions.pod:1814
20867 " inspect-get-mountpoints root\n"
20872 #: ../fish/guestfish-actions.pod:1832
20874 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20875 "L</inspect-get-filesystems>."
20879 #: ../fish/guestfish-actions.pod:1835
20880 msgid "inspect-get-package-format"
20884 #: ../fish/guestfish-actions.pod:1837
20887 " inspect-get-package-format root\n"
20892 #: ../fish/guestfish-actions.pod:1842
20894 "This function and L</inspect-get-package-management> return the package "
20895 "format and package management tool used by the inspected operating system. "
20896 "For example for Fedora these functions would return C<rpm> (package format) "
20897 "and C<yum> (package management)."
20901 #: ../fish/guestfish-actions.pod:1857
20902 msgid "inspect-get-package-management"
20906 #: ../fish/guestfish-actions.pod:1859
20909 " inspect-get-package-management root\n"
20914 #: ../fish/guestfish-actions.pod:1864
20916 "L</inspect-get-package-format> and this function return the package format "
20917 "and package management tool used by the inspected operating system. For "
20918 "example for Fedora these functions would return C<rpm> (package format) and "
20919 "C<yum> (package management)."
20923 #: ../fish/guestfish-actions.pod:1881
20924 msgid "inspect-get-product-name"
20928 #: ../fish/guestfish-actions.pod:1883
20931 " inspect-get-product-name root\n"
20936 #: ../fish/guestfish-actions.pod:1898
20937 msgid "inspect-get-roots"
20941 #: ../fish/guestfish-actions.pod:1900
20944 " inspect-get-roots\n"
20949 #: ../fish/guestfish-actions.pod:1902
20951 "This function is a convenient way to get the list of root devices, as "
20952 "returned from a previous call to L</inspect-os>, but without redoing the "
20953 "whole inspection process."
20957 #: ../fish/guestfish-actions.pod:1906
20959 "This returns an empty list if either no root devices were found or the "
20960 "caller has not called L</inspect-os>."
20964 #: ../fish/guestfish-actions.pod:1911
20965 msgid "inspect-get-type"
20969 #: ../fish/guestfish-actions.pod:1913
20972 " inspect-get-type root\n"
20977 #: ../fish/guestfish-actions.pod:1946
20978 msgid "inspect-get-windows-systemroot"
20982 #: ../fish/guestfish-actions.pod:1948
20985 " inspect-get-windows-systemroot root\n"
20990 #: ../fish/guestfish-actions.pod:1962
20991 msgid "inspect-list-applications"
20995 #: ../fish/guestfish-actions.pod:1964
20998 " inspect-list-applications root\n"
21003 #: ../fish/guestfish-actions.pod:1971
21005 "I<Note:> This call works differently from other parts of the inspection "
21006 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21007 "then mount up the disks, before calling this. Listing applications is a "
21008 "significantly more difficult operation which requires access to the full "
21009 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21010 "are just returning data cached in the libguestfs handle, this call actually "
21011 "reads parts of the mounted filesystems during the call."
21015 #: ../fish/guestfish-actions.pod:2061
21020 #: ../fish/guestfish-actions.pod:2063
21028 #: ../fish/guestfish-actions.pod:2078
21030 "You can pass the root string(s) returned to other L</inspect-get-*> "
21031 "functions in order to query further information about each operating system, "
21032 "such as the name and version."
21036 #: ../fish/guestfish-actions.pod:2083
21038 "This function uses other libguestfs features such as L</mount-ro> and "
21039 "L</umount-all> in order to mount and unmount filesystems and look at the "
21040 "contents. This should be called with no disks currently mounted. The "
21041 "function may also use Augeas, so any existing Augeas handle will be closed."
21045 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2297
21046 msgid "See also L</list-filesystems>."
21050 #: ../fish/guestfish-actions.pod:2097
21051 msgid "is-blockdev"
21055 #: ../fish/guestfish-actions.pod:2099
21058 " is-blockdev path\n"
21063 #: ../fish/guestfish-actions.pod:2104 ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2141 ../fish/guestfish-actions.pod:2150 ../fish/guestfish-actions.pod:2160 ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2203
21064 msgid "See also L</stat>."
21068 #: ../fish/guestfish-actions.pod:2106
21073 #: ../fish/guestfish-actions.pod:2108
21081 #: ../fish/guestfish-actions.pod:2115
21086 #: ../fish/guestfish-actions.pod:2117
21089 " is-chardev path\n"
21094 #: ../fish/guestfish-actions.pod:2124
21099 #: ../fish/guestfish-actions.pod:2126
21107 #: ../fish/guestfish-actions.pod:2133
21112 #: ../fish/guestfish-actions.pod:2135
21120 #: ../fish/guestfish-actions.pod:2143
21125 #: ../fish/guestfish-actions.pod:2145
21133 #: ../fish/guestfish-actions.pod:2152
21138 #: ../fish/guestfish-actions.pod:2154
21146 #: ../fish/guestfish-actions.pod:2162
21147 msgid "is-launching"
21151 #: ../fish/guestfish-actions.pod:2164
21159 #: ../fish/guestfish-actions.pod:2171
21164 #: ../fish/guestfish-actions.pod:2173
21172 #: ../fish/guestfish-actions.pod:2178
21177 #: ../fish/guestfish-actions.pod:2180
21185 #: ../fish/guestfish-actions.pod:2187
21190 #: ../fish/guestfish-actions.pod:2189
21193 " is-socket path\n"
21198 #: ../fish/guestfish-actions.pod:2196
21203 #: ../fish/guestfish-actions.pod:2198
21206 " is-symlink path\n"
21211 #: ../fish/guestfish-actions.pod:2205
21212 msgid "kill-subprocess"
21216 #: ../fish/guestfish-actions.pod:2207
21219 " kill-subprocess\n"
21224 #: ../fish/guestfish-actions.pod:2211
21229 #: ../fish/guestfish-actions.pod:2213
21234 #: ../fish/guestfish-actions.pod:2215
21242 #: ../fish/guestfish-actions.pod:2223
21247 #: ../fish/guestfish-actions.pod:2225
21250 " lchown owner group path\n"
21255 #: ../fish/guestfish-actions.pod:2227
21257 "Change the file owner to C<owner> and group to C<group>. This is like "
21258 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
21263 #: ../fish/guestfish-actions.pod:2235
21268 #: ../fish/guestfish-actions.pod:2237
21271 " lgetxattrs path\n"
21276 #: ../fish/guestfish-actions.pod:2239
21278 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21279 "it returns the extended attributes of the link itself."
21283 #: ../fish/guestfish-actions.pod:2243
21284 msgid "list-devices"
21288 #: ../fish/guestfish-actions.pod:2245
21296 #: ../fish/guestfish-actions.pod:2253
21297 msgid "list-filesystems"
21301 #: ../fish/guestfish-actions.pod:2255
21304 " list-filesystems\n"
21309 #: ../fish/guestfish-actions.pod:2274
21311 "This command runs other libguestfs commands, which might include L</mount> "
21312 "and L</umount>, and therefore you should use this soon after launch and only "
21313 "when nothing is mounted."
21317 #: ../fish/guestfish-actions.pod:2278
21319 "Not all of the filesystems returned will be mountable. In particular, swap "
21320 "partitions are returned in the list. Also this command does not check that "
21321 "each filesystem found is valid and mountable, and some filesystems might be "
21322 "mountable but require special options. Filesystems may not all belong to a "
21323 "single logical operating system (use L</inspect-os> to look for OSes)."
21327 #: ../fish/guestfish-actions.pod:2286
21328 msgid "list-partitions"
21332 #: ../fish/guestfish-actions.pod:2288
21335 " list-partitions\n"
21340 #: ../fish/guestfish-actions.pod:2294
21342 "This does not return logical volumes. For that you will need to call "
21347 #: ../fish/guestfish-actions.pod:2299
21352 #: ../fish/guestfish-actions.pod:2301
21360 #: ../fish/guestfish-actions.pod:2309
21365 #: ../fish/guestfish-actions.pod:2311
21368 " ln target linkname\n"
21373 #: ../fish/guestfish-actions.pod:2315
21378 #: ../fish/guestfish-actions.pod:2317
21381 " ln-f target linkname\n"
21386 #: ../fish/guestfish-actions.pod:2322
21391 #: ../fish/guestfish-actions.pod:2324
21394 " ln-s target linkname\n"
21399 #: ../fish/guestfish-actions.pod:2328
21404 #: ../fish/guestfish-actions.pod:2330
21407 " ln-sf target linkname\n"
21412 #: ../fish/guestfish-actions.pod:2335
21413 msgid "lremovexattr"
21417 #: ../fish/guestfish-actions.pod:2337
21420 " lremovexattr xattr path\n"
21425 #: ../fish/guestfish-actions.pod:2339
21427 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21428 "it removes an extended attribute of the link itself."
21432 #: ../fish/guestfish-actions.pod:2343
21437 #: ../fish/guestfish-actions.pod:2345
21445 #: ../fish/guestfish-actions.pod:2351
21447 "This command is mostly useful for interactive sessions. Programs should "
21448 "probably use L</readdir> instead."
21452 #: ../fish/guestfish-actions.pod:2354
21457 #: ../fish/guestfish-actions.pod:2356
21460 " lsetxattr xattr val vallen path\n"
21465 #: ../fish/guestfish-actions.pod:2358
21467 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21468 "sets an extended attribute of the link itself."
21472 #: ../fish/guestfish-actions.pod:2362
21477 #: ../fish/guestfish-actions.pod:2364
21485 #: ../fish/guestfish-actions.pod:2368
21487 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21488 "the link is stat-ed, not the file it refers to."
21492 #: ../fish/guestfish-actions.pod:2374
21497 #: ../fish/guestfish-actions.pod:2376
21500 " lstatlist path 'names ...'\n"
21505 #: ../fish/guestfish-actions.pod:2378
21507 "This call allows you to perform the L</lstat> operation on multiple files, "
21508 "where all files are in the directory C<path>. C<names> is the list of files "
21509 "from this directory."
21513 #: ../fish/guestfish-actions.pod:2387
21515 "This call is intended for programs that want to efficiently list a directory "
21516 "contents without making many round-trips. See also L</lxattrlist> for a "
21517 "similarly efficient call for getting extended attributes. Very long "
21518 "directory listings might cause the protocol message size to be exceeded, "
21519 "causing this call to fail. The caller must split up such requests into "
21520 "smaller groups of names."
21524 #: ../fish/guestfish-actions.pod:2395
21525 msgid "luks-add-key"
21529 #: ../fish/guestfish-actions.pod:2397
21532 " luks-add-key device keyslot\n"
21537 #: ../fish/guestfish-actions.pod:2404
21539 "Note that if C<keyslot> already contains a key, then this command will "
21540 "fail. You have to use L</luks-kill-slot> first to remove that key."
21544 #: ../fish/guestfish-actions.pod:2408 ../fish/guestfish-actions.pod:2430 ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2457 ../fish/guestfish-actions.pod:2480 ../fish/guestfish-actions.pod:2490
21546 "This command has one or more key or passphrase parameters. Guestfish will "
21547 "prompt for these separately."
21551 #: ../fish/guestfish-actions.pod:2411
21556 #: ../fish/guestfish-actions.pod:2413
21559 " luks-close device\n"
21564 #: ../fish/guestfish-actions.pod:2415
21566 "This closes a LUKS device that was created earlier by L</luks-open> or "
21567 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
21568 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
21569 "underlying block device."
21573 #: ../fish/guestfish-actions.pod:2421
21574 msgid "luks-format"
21578 #: ../fish/guestfish-actions.pod:2423
21581 " luks-format device keyslot\n"
21586 #: ../fish/guestfish-actions.pod:2436
21587 msgid "luks-format-cipher"
21591 #: ../fish/guestfish-actions.pod:2438
21594 " luks-format-cipher device keyslot cipher\n"
21599 #: ../fish/guestfish-actions.pod:2440
21601 "This command is the same as L</luks-format> but it also allows you to set "
21602 "the C<cipher> used."
21606 #: ../fish/guestfish-actions.pod:2449
21607 msgid "luks-kill-slot"
21611 #: ../fish/guestfish-actions.pod:2451
21614 " luks-kill-slot device keyslot\n"
21619 #: ../fish/guestfish-actions.pod:2460
21624 #: ../fish/guestfish-actions.pod:2462
21627 " luks-open device mapname\n"
21632 #: ../fish/guestfish-actions.pod:2476
21634 "If this block device contains LVM volume groups, then calling L</vgscan> "
21635 "followed by L</vg-activate-all> will make them visible."
21639 #: ../fish/guestfish-actions.pod:2483
21640 msgid "luks-open-ro"
21644 #: ../fish/guestfish-actions.pod:2485
21647 " luks-open-ro device mapname\n"
21652 #: ../fish/guestfish-actions.pod:2487
21654 "This is the same as L</luks-open> except that a read-only mapping is "
21659 #: ../fish/guestfish-actions.pod:2493
21664 #: ../fish/guestfish-actions.pod:2495
21667 " lvcreate logvol volgroup mbytes\n"
21672 #: ../fish/guestfish-actions.pod:2500
21673 msgid "lvm-canonical-lv-name"
21677 #: ../fish/guestfish-actions.pod:2502
21680 " lvm-canonical-lv-name lvname\n"
21685 #: ../fish/guestfish-actions.pod:2511
21686 msgid "See also L</is-lv>."
21690 #: ../fish/guestfish-actions.pod:2513
21691 msgid "lvm-clear-filter"
21695 #: ../fish/guestfish-actions.pod:2515
21698 " lvm-clear-filter\n"
21703 #: ../fish/guestfish-actions.pod:2517
21705 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21710 #: ../fish/guestfish-actions.pod:2523
21711 msgid "lvm-remove-all"
21715 #: ../fish/guestfish-actions.pod:2525
21718 " lvm-remove-all\n"
21723 #: ../fish/guestfish-actions.pod:2533
21724 msgid "lvm-set-filter"
21728 #: ../fish/guestfish-actions.pod:2535
21731 " lvm-set-filter 'devices ...'\n"
21736 #: ../fish/guestfish-actions.pod:2560
21741 #: ../fish/guestfish-actions.pod:2562
21744 " lvremove device\n"
21749 #: ../fish/guestfish-actions.pod:2570
21754 #: ../fish/guestfish-actions.pod:2572
21757 " lvrename logvol newlogvol\n"
21762 #: ../fish/guestfish-actions.pod:2576
21767 #: ../fish/guestfish-actions.pod:2578
21770 " lvresize device mbytes\n"
21775 #: ../fish/guestfish-actions.pod:2584
21776 msgid "lvresize-free"
21780 #: ../fish/guestfish-actions.pod:2586
21783 " lvresize-free lv percent\n"
21788 #: ../fish/guestfish-actions.pod:2594
21793 #: ../fish/guestfish-actions.pod:2596
21801 #: ../fish/guestfish-actions.pod:2604
21802 msgid "See also L</lvs-full>, L</list-filesystems>."
21806 #: ../fish/guestfish-actions.pod:2606
21811 #: ../fish/guestfish-actions.pod:2608
21819 #: ../fish/guestfish-actions.pod:2613
21824 #: ../fish/guestfish-actions.pod:2615
21832 #: ../fish/guestfish-actions.pod:2619
21837 #: ../fish/guestfish-actions.pod:2621
21840 " lxattrlist path 'names ...'\n"
21845 #: ../fish/guestfish-actions.pod:2637
21847 "This call is intended for programs that want to efficiently list a directory "
21848 "contents without making many round-trips. See also L</lstatlist> for a "
21849 "similarly efficient call for getting standard stats. Very long directory "
21850 "listings might cause the protocol message size to be exceeded, causing this "
21851 "call to fail. The caller must split up such requests into smaller groups of "
21856 #: ../fish/guestfish-actions.pod:2645
21861 #: ../fish/guestfish-actions.pod:2647
21869 #: ../fish/guestfish-actions.pod:2651
21874 #: ../fish/guestfish-actions.pod:2653
21877 " mkdir-mode path mode\n"
21882 #: ../fish/guestfish-actions.pod:2662
21883 msgid "See also L</mkdir>, L</umask>"
21887 #: ../fish/guestfish-actions.pod:2664
21892 #: ../fish/guestfish-actions.pod:2666
21900 #: ../fish/guestfish-actions.pod:2671
21905 #: ../fish/guestfish-actions.pod:2673
21908 " mkdtemp template\n"
21913 #: ../fish/guestfish-actions.pod:2694
21918 #: ../fish/guestfish-actions.pod:2696
21921 " mke2fs-J fstype blocksize device journal\n"
21926 #: ../fish/guestfish-actions.pod:2704
21927 msgid "See also L</mke2journal>."
21931 #: ../fish/guestfish-actions.pod:2706
21936 #: ../fish/guestfish-actions.pod:2708
21939 " mke2fs-JL fstype blocksize device label\n"
21944 #: ../fish/guestfish-actions.pod:2713
21945 msgid "See also L</mke2journal-L>."
21949 #: ../fish/guestfish-actions.pod:2715
21954 #: ../fish/guestfish-actions.pod:2717
21957 " mke2fs-JU fstype blocksize device uuid\n"
21962 #: ../fish/guestfish-actions.pod:2722
21963 msgid "See also L</mke2journal-U>."
21967 #: ../fish/guestfish-actions.pod:2724
21968 msgid "mke2journal"
21972 #: ../fish/guestfish-actions.pod:2726
21975 " mke2journal blocksize device\n"
21980 #: ../fish/guestfish-actions.pod:2733
21981 msgid "mke2journal-L"
21985 #: ../fish/guestfish-actions.pod:2735
21988 " mke2journal-L blocksize label device\n"
21993 #: ../fish/guestfish-actions.pod:2739
21994 msgid "mke2journal-U"
21998 #: ../fish/guestfish-actions.pod:2741
22001 " mke2journal-U blocksize uuid device\n"
22006 #: ../fish/guestfish-actions.pod:2745
22011 #: ../fish/guestfish-actions.pod:2747
22014 " mkfifo mode path\n"
22019 #: ../fish/guestfish-actions.pod:2749
22021 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22022 "is just a convenient wrapper around L</mknod>."
22026 #: ../fish/guestfish-actions.pod:2755
22031 #: ../fish/guestfish-actions.pod:2757
22034 " mkfs fstype device\n"
22039 #: ../fish/guestfish-actions.pod:2763
22044 #: ../fish/guestfish-actions.pod:2765
22047 " mkfs-b fstype blocksize device\n"
22052 #: ../fish/guestfish-actions.pod:2767
22054 "This call is similar to L</mkfs>, but it allows you to control the block "
22055 "size of the resulting filesystem. Supported block sizes depend on the "
22056 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22060 #: ../fish/guestfish-actions.pod:2782
22065 #: ../fish/guestfish-actions.pod:2784
22068 " mkfs-opts fstype device [blocksize:..]\n"
22073 #: ../fish/guestfish-actions.pod:2806
22074 msgid "mkmountpoint"
22078 #: ../fish/guestfish-actions.pod:2808
22081 " mkmountpoint exemptpath\n"
22086 #: ../fish/guestfish-actions.pod:2810
22088 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22089 "to create extra mountpoints before mounting the first filesystem."
22093 #: ../fish/guestfish-actions.pod:2834
22095 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22096 "unexpected errors if you try to mix these calls. It is safest to manually "
22097 "unmount filesystems and remove mountpoints after use."
22101 #: ../fish/guestfish-actions.pod:2838
22103 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22104 "for this to work for manual mountpoints, you must ensure that the innermost "
22105 "mountpoints have the longest pathnames, as in the example code above."
22109 #: ../fish/guestfish-actions.pod:2845
22111 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22112 "that L</umount-all> is called when the handle is closed which can also "
22113 "trigger these issues."
22117 #: ../fish/guestfish-actions.pod:2849
22122 #: ../fish/guestfish-actions.pod:2851
22125 " mknod mode devmajor devminor path\n"
22130 #: ../fish/guestfish-actions.pod:2861
22132 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22133 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22134 "regular file). These constants are available in the standard Linux header "
22135 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22136 "wrappers around this command which bitwise OR in the appropriate constant "
22141 #: ../fish/guestfish-actions.pod:2871
22146 #: ../fish/guestfish-actions.pod:2873
22149 " mknod-b mode devmajor devminor path\n"
22154 #: ../fish/guestfish-actions.pod:2875
22156 "This call creates a block device node called C<path> with mode C<mode> and "
22157 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22158 "wrapper around L</mknod>."
22162 #: ../fish/guestfish-actions.pod:2881
22167 #: ../fish/guestfish-actions.pod:2883
22170 " mknod-c mode devmajor devminor path\n"
22175 #: ../fish/guestfish-actions.pod:2885
22177 "This call creates a char device node called C<path> with mode C<mode> and "
22178 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22179 "wrapper around L</mknod>."
22183 #: ../fish/guestfish-actions.pod:2891
22188 #: ../fish/guestfish-actions.pod:2893
22196 #: ../fish/guestfish-actions.pod:2897
22201 #: ../fish/guestfish-actions.pod:2899
22204 " mkswap-L label device\n"
22209 #: ../fish/guestfish-actions.pod:2907
22214 #: ../fish/guestfish-actions.pod:2909
22217 " mkswap-U uuid device\n"
22222 #: ../fish/guestfish-actions.pod:2913
22223 msgid "mkswap-file"
22227 #: ../fish/guestfish-actions.pod:2915
22230 " mkswap-file path\n"
22235 #: ../fish/guestfish-actions.pod:2919
22237 "This command just writes a swap file signature to an existing file. To "
22238 "create the file itself, use something like L</fallocate>."
22242 #: ../fish/guestfish-actions.pod:2922
22247 #: ../fish/guestfish-actions.pod:2924
22250 " modprobe modulename\n"
22255 #: ../fish/guestfish-actions.pod:2931
22260 #: ../fish/guestfish-actions.pod:2933
22263 " mount device mountpoint\n"
22268 #: ../fish/guestfish-actions.pod:2949
22270 "B<Important note:> When you use this call, the filesystem options C<sync> "
22271 "and C<noatime> are set implicitly. This was originally done because we "
22272 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22273 "very large negative performance impact and negligible effect on "
22274 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22275 "code that needs performance, and instead use L</mount-options> (use an empty "
22276 "string for the first parameter if you don't want any options)."
22280 #: ../fish/guestfish-actions.pod:2959
22285 #: ../fish/guestfish-actions.pod:2961
22288 " mount-loop file mountpoint\n"
22293 #: ../fish/guestfish-actions.pod:2967
22294 msgid "mount-options"
22298 #: ../fish/guestfish-actions.pod:2969
22301 " mount-options options device mountpoint\n"
22306 #: ../fish/guestfish-actions.pod:2971
22308 "This is the same as the L</mount> command, but it allows you to set the "
22309 "mount options as for the L<mount(8)> I<-o> flag."
22313 #: ../fish/guestfish-actions.pod:2979
22318 #: ../fish/guestfish-actions.pod:2981
22321 " mount-ro device mountpoint\n"
22326 #: ../fish/guestfish-actions.pod:2983
22328 "This is the same as the L</mount> command, but it mounts the filesystem with "
22329 "the read-only (I<-o ro>) flag."
22333 #: ../fish/guestfish-actions.pod:2986
22338 #: ../fish/guestfish-actions.pod:2988
22341 " mount-vfs options vfstype device mountpoint\n"
22346 #: ../fish/guestfish-actions.pod:2990
22348 "This is the same as the L</mount> command, but it allows you to set both the "
22349 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22353 #: ../fish/guestfish-actions.pod:2994
22354 msgid "mountpoints"
22358 #: ../fish/guestfish-actions.pod:2996
22366 #: ../fish/guestfish-actions.pod:2998
22368 "This call is similar to L</mounts>. That call returns a list of devices. "
22369 "This one returns a hash table (map) of device name to directory where the "
22370 "device is mounted."
22374 #: ../fish/guestfish-actions.pod:3002
22379 #: ../fish/guestfish-actions.pod:3004
22387 #: ../fish/guestfish-actions.pod:3011
22388 msgid "See also: L</mountpoints>"
22392 #: ../fish/guestfish-actions.pod:3013
22397 #: ../fish/guestfish-actions.pod:3015
22405 #: ../fish/guestfish-actions.pod:3020
22406 msgid "ntfs-3g-probe"
22410 #: ../fish/guestfish-actions.pod:3022
22413 " ntfs-3g-probe true|false device\n"
22418 #: ../fish/guestfish-actions.pod:3036
22423 #: ../fish/guestfish-actions.pod:3038
22426 " ntfsresize device\n"
22431 #: ../fish/guestfish-actions.pod:3044
22432 msgid "ntfsresize-size"
22436 #: ../fish/guestfish-actions.pod:3046
22439 " ntfsresize-size device size\n"
22444 #: ../fish/guestfish-actions.pod:3048
22446 "This command is the same as L</ntfsresize> except that it allows you to "
22447 "specify the new size (in bytes) explicitly."
22451 #: ../fish/guestfish-actions.pod:3051
22456 #: ../fish/guestfish-actions.pod:3053
22459 " part-add device prlogex startsect endsect\n"
22464 #: ../fish/guestfish-actions.pod:3055
22466 "This command adds a partition to C<device>. If there is no partition table "
22467 "on the device, call L</part-init> first."
22471 #: ../fish/guestfish-actions.pod:3067
22473 "Creating a partition which covers the whole disk is not so easy. Use "
22474 "L</part-disk> to do that."
22478 #: ../fish/guestfish-actions.pod:3070
22483 #: ../fish/guestfish-actions.pod:3072
22486 " part-del device partnum\n"
22491 #: ../fish/guestfish-actions.pod:3080
22496 #: ../fish/guestfish-actions.pod:3082
22499 " part-disk device parttype\n"
22504 #: ../fish/guestfish-actions.pod:3084
22506 "This command is simply a combination of L</part-init> followed by "
22507 "L</part-add> to create a single primary partition covering the whole disk."
22511 #: ../fish/guestfish-actions.pod:3088
22513 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22514 "possible values are described in L</part-init>."
22518 #: ../fish/guestfish-actions.pod:3094
22519 msgid "part-get-bootable"
22523 #: ../fish/guestfish-actions.pod:3096
22526 " part-get-bootable device partnum\n"
22531 #: ../fish/guestfish-actions.pod:3101
22532 msgid "See also L</part-set-bootable>."
22536 #: ../fish/guestfish-actions.pod:3103
22537 msgid "part-get-mbr-id"
22541 #: ../fish/guestfish-actions.pod:3105
22544 " part-get-mbr-id device partnum\n"
22549 #: ../fish/guestfish-actions.pod:3110 ../fish/guestfish-actions.pod:3248
22551 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22552 "undefined results for other partition table types (see "
22553 "L</part-get-parttype>)."
22557 #: ../fish/guestfish-actions.pod:3114
22558 msgid "part-get-parttype"
22562 #: ../fish/guestfish-actions.pod:3116
22565 " part-get-parttype device\n"
22570 #: ../fish/guestfish-actions.pod:3121
22572 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22573 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22574 "possible, although unusual. See L</part-init> for a full list."
22578 #: ../fish/guestfish-actions.pod:3126
22583 #: ../fish/guestfish-actions.pod:3128
22586 " part-init device parttype\n"
22591 #: ../fish/guestfish-actions.pod:3134
22593 "Initially there are no partitions. Following this, you should call "
22594 "L</part-add> for each partition required."
22598 #: ../fish/guestfish-actions.pod:3197
22603 #: ../fish/guestfish-actions.pod:3199
22606 " part-list device\n"
22611 #: ../fish/guestfish-actions.pod:3214
22613 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22614 "the device's sector size, see L</blockdev-getss>."
22618 #: ../fish/guestfish-actions.pod:3227
22619 msgid "part-set-bootable"
22623 #: ../fish/guestfish-actions.pod:3229
22626 " part-set-bootable device partnum true|false\n"
22631 #: ../fish/guestfish-actions.pod:3238
22632 msgid "part-set-mbr-id"
22636 #: ../fish/guestfish-actions.pod:3240
22639 " part-set-mbr-id device partnum idbyte\n"
22644 #: ../fish/guestfish-actions.pod:3252
22645 msgid "part-set-name"
22649 #: ../fish/guestfish-actions.pod:3254
22652 " part-set-name device partnum name\n"
22657 #: ../fish/guestfish-actions.pod:3262
22658 msgid "part-to-dev"
22662 #: ../fish/guestfish-actions.pod:3264
22665 " part-to-dev partition\n"
22670 #: ../fish/guestfish-actions.pod:3270
22672 "The named partition must exist, for example as a string returned from "
22673 "L</list-partitions>."
22677 #: ../fish/guestfish-actions.pod:3273
22678 msgid "ping-daemon"
22682 #: ../fish/guestfish-actions.pod:3275
22690 #: ../fish/guestfish-actions.pod:3282
22695 #: ../fish/guestfish-actions.pod:3284
22698 " pread path count offset\n"
22703 #: ../fish/guestfish-actions.pod:3292
22704 msgid "See also L</pwrite>, L</pread-device>."
22708 #: ../fish/guestfish-actions.pod:3297
22709 msgid "pread-device"
22713 #: ../fish/guestfish-actions.pod:3299
22716 " pread-device device count offset\n"
22721 #: ../fish/guestfish-actions.pod:3307
22722 msgid "See also L</pread>."
22726 #: ../fish/guestfish-actions.pod:3312
22731 #: ../fish/guestfish-actions.pod:3314
22734 " pvcreate device\n"
22739 #: ../fish/guestfish-actions.pod:3320
22744 #: ../fish/guestfish-actions.pod:3322
22747 " pvremove device\n"
22752 #: ../fish/guestfish-actions.pod:3331
22757 #: ../fish/guestfish-actions.pod:3333
22760 " pvresize device\n"
22765 #: ../fish/guestfish-actions.pod:3338
22766 msgid "pvresize-size"
22770 #: ../fish/guestfish-actions.pod:3340
22773 " pvresize-size device size\n"
22778 #: ../fish/guestfish-actions.pod:3342
22780 "This command is the same as L</pvresize> except that it allows you to "
22781 "specify the new size (in bytes) explicitly."
22785 #: ../fish/guestfish-actions.pod:3345
22790 #: ../fish/guestfish-actions.pod:3347
22798 #: ../fish/guestfish-actions.pod:3355
22799 msgid "See also L</pvs-full>."
22803 #: ../fish/guestfish-actions.pod:3357
22808 #: ../fish/guestfish-actions.pod:3359
22816 #: ../fish/guestfish-actions.pod:3364
22821 #: ../fish/guestfish-actions.pod:3366
22829 #: ../fish/guestfish-actions.pod:3370
22834 #: ../fish/guestfish-actions.pod:3372
22837 " pwrite path content offset\n"
22842 #: ../fish/guestfish-actions.pod:3383
22843 msgid "See also L</pread>, L</pwrite-device>."
22847 #: ../fish/guestfish-actions.pod:3388
22848 msgid "pwrite-device"
22852 #: ../fish/guestfish-actions.pod:3390
22855 " pwrite-device device content offset\n"
22860 #: ../fish/guestfish-actions.pod:3400
22861 msgid "See also L</pwrite>."
22865 #: ../fish/guestfish-actions.pod:3405
22870 #: ../fish/guestfish-actions.pod:3407
22873 " read-file path\n"
22878 #: ../fish/guestfish-actions.pod:3412
22880 "Unlike L</cat>, this function can correctly handle files that contain "
22881 "embedded ASCII NUL characters. However unlike L</download>, this function "
22882 "is limited in the total size of file that can be handled."
22886 #: ../fish/guestfish-actions.pod:3420
22891 #: ../fish/guestfish-actions.pod:3422
22894 " read-lines path\n"
22899 #: ../fish/guestfish-actions.pod:3429
22901 "Note that this function cannot correctly handle binary files (specifically, "
22902 "files containing C<\\0> character which is treated as end of line). For "
22903 "those you need to use the L</read-file> function which has a more complex "
22908 #: ../fish/guestfish-actions.pod:3434
22913 #: ../fish/guestfish-actions.pod:3436
22921 #: ../fish/guestfish-actions.pod:3488
22923 "This function is primarily intended for use by programs. To get a simple "
22924 "list of names, use L</ls>. To get a printable directory for human "
22925 "consumption, use L</ll>."
22929 #: ../fish/guestfish-actions.pod:3492
22934 #: ../fish/guestfish-actions.pod:3494
22942 #: ../fish/guestfish-actions.pod:3498
22943 msgid "readlinklist"
22947 #: ../fish/guestfish-actions.pod:3500
22950 " readlinklist path 'names ...'\n"
22955 #: ../fish/guestfish-actions.pod:3524
22960 #: ../fish/guestfish-actions.pod:3526
22968 #: ../fish/guestfish-actions.pod:3531
22969 msgid "removexattr"
22973 #: ../fish/guestfish-actions.pod:3533
22976 " removexattr xattr path\n"
22981 #: ../fish/guestfish-actions.pod:3538
22982 msgid "See also: L</lremovexattr>, L<attr(5)>."
22986 #: ../fish/guestfish-actions.pod:3540
22991 #: ../fish/guestfish-actions.pod:3542
22994 " resize2fs device\n"
22999 #: ../fish/guestfish-actions.pod:3547
23001 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23002 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23003 "gives an error about this and sometimes not. In any case, it is always safe "
23004 "to call L</e2fsck-f> before calling this function."
23008 #: ../fish/guestfish-actions.pod:3553
23009 msgid "resize2fs-size"
23013 #: ../fish/guestfish-actions.pod:3555
23016 " resize2fs-size device size\n"
23021 #: ../fish/guestfish-actions.pod:3557
23023 "This command is the same as L</resize2fs> except that it allows you to "
23024 "specify the new size (in bytes) explicitly."
23028 #: ../fish/guestfish-actions.pod:3560
23033 #: ../fish/guestfish-actions.pod:3562
23041 #: ../fish/guestfish-actions.pod:3566
23046 #: ../fish/guestfish-actions.pod:3568
23054 #: ../fish/guestfish-actions.pod:3574
23059 #: ../fish/guestfish-actions.pod:3576
23067 #: ../fish/guestfish-actions.pod:3580
23068 msgid "rmmountpoint"
23072 #: ../fish/guestfish-actions.pod:3582
23075 " rmmountpoint exemptpath\n"
23080 #: ../fish/guestfish-actions.pod:3584
23082 "This calls removes a mountpoint that was previously created with "
23083 "L</mkmountpoint>. See L</mkmountpoint> for full details."
23087 #: ../fish/guestfish-actions.pod:3588
23088 msgid "scrub-device"
23092 #: ../fish/guestfish-actions.pod:3590
23095 " scrub-device device\n"
23100 #: ../fish/guestfish-actions.pod:3601
23105 #: ../fish/guestfish-actions.pod:3603
23108 " scrub-file file\n"
23113 #: ../fish/guestfish-actions.pod:3613
23114 msgid "scrub-freespace"
23118 #: ../fish/guestfish-actions.pod:3615
23121 " scrub-freespace dir\n"
23126 #: ../fish/guestfish-actions.pod:3617
23128 "This command creates the directory C<dir> and then fills it with files until "
23129 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23130 "deletes them. The intention is to scrub any free space on the partition "
23131 "containing C<dir>."
23135 #: ../fish/guestfish-actions.pod:3626
23140 #: ../fish/guestfish-actions.pod:3628
23145 #: ../fish/guestfish-actions.pod:3630
23148 " set-append append\n"
23153 #: ../fish/guestfish-actions.pod:3641
23154 msgid "set-autosync"
23158 #: ../fish/guestfish-actions.pod:3643
23163 #: ../fish/guestfish-actions.pod:3645
23166 " set-autosync true|false\n"
23171 #: ../fish/guestfish-actions.pod:3647
23173 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23174 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23175 "closed (also if the program exits without closing handles)."
23179 #: ../fish/guestfish-actions.pod:3655
23184 #: ../fish/guestfish-actions.pod:3657
23189 #: ../fish/guestfish-actions.pod:3659
23192 " set-direct true|false\n"
23197 #: ../fish/guestfish-actions.pod:3665
23199 "One consequence of this is that log messages aren't caught by the library "
23200 "and handled by L</set-log-message-callback>, but go straight to stdout."
23204 #: ../fish/guestfish-actions.pod:3674
23205 msgid "set-e2label"
23209 #: ../fish/guestfish-actions.pod:3676
23212 " set-e2label device label\n"
23217 #: ../fish/guestfish-actions.pod:3682
23219 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23220 "label on a filesystem."
23224 #: ../fish/guestfish-actions.pod:3685
23229 #: ../fish/guestfish-actions.pod:3687
23232 " set-e2uuid device uuid\n"
23237 #: ../fish/guestfish-actions.pod:3694
23239 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23240 "UUID of a filesystem."
23244 #: ../fish/guestfish-actions.pod:3697
23245 msgid "set-memsize"
23249 #: ../fish/guestfish-actions.pod:3699
23254 #: ../fish/guestfish-actions.pod:3701
23257 " set-memsize memsize\n"
23262 #: ../fish/guestfish-actions.pod:3703
23264 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23265 "This only has any effect if called before L</launch>."
23269 #: ../fish/guestfish-actions.pod:3714
23270 msgid "set-network"
23274 #: ../fish/guestfish-actions.pod:3716
23279 #: ../fish/guestfish-actions.pod:3718
23282 " set-network true|false\n"
23287 #: ../fish/guestfish-actions.pod:3726
23288 msgid "You must call this before calling L</launch>, otherwise it has no effect."
23292 #: ../fish/guestfish-actions.pod:3729
23297 #: ../fish/guestfish-actions.pod:3731
23302 #: ../fish/guestfish-actions.pod:3733
23305 " set-path searchpath\n"
23310 #: ../fish/guestfish-actions.pod:3742
23315 #: ../fish/guestfish-actions.pod:3744
23320 #: ../fish/guestfish-actions.pod:3746
23328 #: ../fish/guestfish-actions.pod:3766
23329 msgid "set-recovery-proc"
23333 #: ../fish/guestfish-actions.pod:3768
23334 msgid "recovery-proc"
23338 #: ../fish/guestfish-actions.pod:3770
23341 " set-recovery-proc true|false\n"
23346 #: ../fish/guestfish-actions.pod:3772
23348 "If this is called with the parameter C<false> then L</launch> does not "
23349 "create a recovery process. The purpose of the recovery process is to stop "
23350 "runaway qemu processes in the case where the main program aborts abruptly."
23354 #: ../fish/guestfish-actions.pod:3777
23356 "This only has any effect if called before L</launch>, and the default is "
23361 #: ../fish/guestfish-actions.pod:3786
23362 msgid "set-selinux"
23366 #: ../fish/guestfish-actions.pod:3788
23371 #: ../fish/guestfish-actions.pod:3790
23374 " set-selinux true|false\n"
23379 #: ../fish/guestfish-actions.pod:3801
23384 #: ../fish/guestfish-actions.pod:3803
23389 #: ../fish/guestfish-actions.pod:3805
23392 " set-trace true|false\n"
23397 #: ../fish/guestfish-actions.pod:3821
23398 msgid "set-verbose"
23402 #: ../fish/guestfish-actions.pod:3823
23407 #: ../fish/guestfish-actions.pod:3825
23410 " set-verbose true|false\n"
23415 #: ../fish/guestfish-actions.pod:3832
23420 #: ../fish/guestfish-actions.pod:3834
23423 " setcon context\n"
23428 #: ../fish/guestfish-actions.pod:3841
23433 #: ../fish/guestfish-actions.pod:3843
23436 " setxattr xattr val vallen path\n"
23441 #: ../fish/guestfish-actions.pod:3849
23442 msgid "See also: L</lsetxattr>, L<attr(5)>."
23446 #: ../fish/guestfish-actions.pod:3851
23451 #: ../fish/guestfish-actions.pod:3853
23454 " sfdisk device cyls heads sectors 'lines ...'\n"
23459 #: ../fish/guestfish-actions.pod:3875
23460 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23464 #: ../fish/guestfish-actions.pod:3881
23469 #: ../fish/guestfish-actions.pod:3883
23472 " sfdiskM device 'lines ...'\n"
23477 #: ../fish/guestfish-actions.pod:3885
23479 "This is a simplified interface to the L</sfdisk> command, where partition "
23480 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23481 "you don't need to specify the cyls, heads and sectors parameters which were "
23482 "rarely if ever used anyway."
23486 #: ../fish/guestfish-actions.pod:3891
23487 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23491 #: ../fish/guestfish-actions.pod:3897
23496 #: ../fish/guestfish-actions.pod:3899
23499 " sfdisk-N device partnum cyls heads sectors line\n"
23504 #: ../fish/guestfish-actions.pod:3904
23506 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23507 "cyls/heads/sectors parameters."
23511 #: ../fish/guestfish-actions.pod:3907
23512 msgid "See also: L</part-add>"
23516 #: ../fish/guestfish-actions.pod:3912
23517 msgid "sfdisk-disk-geometry"
23521 #: ../fish/guestfish-actions.pod:3914
23524 " sfdisk-disk-geometry device\n"
23529 #: ../fish/guestfish-actions.pod:3916
23531 "This displays the disk geometry of C<device> read from the partition table. "
23532 "Especially in the case where the underlying block device has been resized, "
23533 "this can be different from the kernel's idea of the geometry (see "
23534 "L</sfdisk-kernel-geometry>)."
23538 #: ../fish/guestfish-actions.pod:3924
23539 msgid "sfdisk-kernel-geometry"
23543 #: ../fish/guestfish-actions.pod:3926
23546 " sfdisk-kernel-geometry device\n"
23551 #: ../fish/guestfish-actions.pod:3933
23556 #: ../fish/guestfish-actions.pod:3935
23559 " sfdisk-l device\n"
23564 #: ../fish/guestfish-actions.pod:3941
23565 msgid "See also: L</part-list>"
23569 #: ../fish/guestfish-actions.pod:3943
23574 #: ../fish/guestfish-actions.pod:3945
23582 #: ../fish/guestfish-actions.pod:3950
23583 msgid "This is like L</command>, but passes the command to:"
23587 #: ../fish/guestfish-actions.pod:3958
23588 msgid "All the provisos about L</command> apply to this call."
23592 #: ../fish/guestfish-actions.pod:3960
23597 #: ../fish/guestfish-actions.pod:3962
23600 " sh-lines command\n"
23605 #: ../fish/guestfish-actions.pod:3964
23606 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23610 #: ../fish/guestfish-actions.pod:3967
23611 msgid "See also: L</command-lines>"
23615 #: ../fish/guestfish-actions.pod:3969
23620 #: ../fish/guestfish-actions.pod:3971
23628 #: ../fish/guestfish-actions.pod:3975
23633 #: ../fish/guestfish-actions.pod:3977
23641 #: ../fish/guestfish-actions.pod:3983
23646 #: ../fish/guestfish-actions.pod:3985
23654 #: ../fish/guestfish-actions.pod:3993
23659 #: ../fish/guestfish-actions.pod:3995
23667 #: ../fish/guestfish-actions.pod:4003
23672 #: ../fish/guestfish-actions.pod:4005
23675 " strings-e encoding path\n"
23680 #: ../fish/guestfish-actions.pod:4007
23682 "This is like the L</strings> command, but allows you to specify the encoding "
23683 "of strings that are looked for in the source file C<path>."
23687 #: ../fish/guestfish-actions.pod:4017
23689 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23690 "ISO-8859-X (this is what L</strings> uses)."
23694 #: ../fish/guestfish-actions.pod:4049
23695 msgid "swapoff-device"
23699 #: ../fish/guestfish-actions.pod:4051
23702 " swapoff-device device\n"
23707 #: ../fish/guestfish-actions.pod:4053
23709 "This command disables the libguestfs appliance swap device or partition "
23710 "named C<device>. See L</swapon-device>."
23714 #: ../fish/guestfish-actions.pod:4057
23715 msgid "swapoff-file"
23719 #: ../fish/guestfish-actions.pod:4059
23722 " swapoff-file file\n"
23727 #: ../fish/guestfish-actions.pod:4063
23728 msgid "swapoff-label"
23732 #: ../fish/guestfish-actions.pod:4065
23735 " swapoff-label label\n"
23740 #: ../fish/guestfish-actions.pod:4070
23741 msgid "swapoff-uuid"
23745 #: ../fish/guestfish-actions.pod:4072
23748 " swapoff-uuid uuid\n"
23753 #: ../fish/guestfish-actions.pod:4077
23754 msgid "swapon-device"
23758 #: ../fish/guestfish-actions.pod:4079
23761 " swapon-device device\n"
23766 #: ../fish/guestfish-actions.pod:4081
23768 "This command enables the libguestfs appliance to use the swap device or "
23769 "partition named C<device>. The increased memory is made available for all "
23770 "commands, for example those run using L</command> or L</sh>."
23774 #: ../fish/guestfish-actions.pod:4093
23775 msgid "swapon-file"
23779 #: ../fish/guestfish-actions.pod:4095
23782 " swapon-file file\n"
23787 #: ../fish/guestfish-actions.pod:4097
23788 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
23792 #: ../fish/guestfish-actions.pod:4100
23793 msgid "swapon-label"
23797 #: ../fish/guestfish-actions.pod:4102
23800 " swapon-label label\n"
23805 #: ../fish/guestfish-actions.pod:4104
23807 "This command enables swap to a labeled swap partition. See "
23808 "L</swapon-device> for other notes."
23812 #: ../fish/guestfish-actions.pod:4107
23813 msgid "swapon-uuid"
23817 #: ../fish/guestfish-actions.pod:4109
23820 " swapon-uuid uuid\n"
23825 #: ../fish/guestfish-actions.pod:4111
23827 "This command enables swap to a swap partition with the given UUID. See "
23828 "L</swapon-device> for other notes."
23832 #: ../fish/guestfish-actions.pod:4114
23837 #: ../fish/guestfish-actions.pod:4116
23845 #: ../fish/guestfish-actions.pod:4124
23850 #: ../fish/guestfish-actions.pod:4126
23858 #: ../fish/guestfish-actions.pod:4134
23863 #: ../fish/guestfish-actions.pod:4136
23866 " tail-n nrlines path\n"
23871 #: ../fish/guestfish-actions.pod:4149
23876 #: ../fish/guestfish-actions.pod:4151
23879 " tar-in (tarfile|-) directory\n"
23884 #: ../fish/guestfish-actions.pod:4156
23885 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23889 #: ../fish/guestfish-actions.pod:4161
23894 #: ../fish/guestfish-actions.pod:4163
23897 " tar-out directory (tarfile|-)\n"
23902 #: ../fish/guestfish-actions.pod:4168
23903 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23907 #: ../fish/guestfish-actions.pod:4173
23912 #: ../fish/guestfish-actions.pod:4175
23915 " tgz-in (tarball|-) directory\n"
23920 #: ../fish/guestfish-actions.pod:4180
23921 msgid "To upload an uncompressed tarball, use L</tar-in>."
23925 #: ../fish/guestfish-actions.pod:4184
23930 #: ../fish/guestfish-actions.pod:4186
23933 " tgz-out directory (tarball|-)\n"
23938 #: ../fish/guestfish-actions.pod:4191
23939 msgid "To download an uncompressed tarball, use L</tar-out>."
23943 #: ../fish/guestfish-actions.pod:4195
23948 #: ../fish/guestfish-actions.pod:4197
23956 #: ../fish/guestfish-actions.pod:4206
23961 #: ../fish/guestfish-actions.pod:4208
23969 #: ../fish/guestfish-actions.pod:4213
23970 msgid "truncate-size"
23974 #: ../fish/guestfish-actions.pod:4215
23977 " truncate-size path size\n"
23982 #: ../fish/guestfish-actions.pod:4220
23984 "If the current file size is less than C<size> then the file is extended to "
23985 "the required size with zero bytes. This creates a sparse file (ie. disk "
23986 "blocks are not allocated for the file until you write to it). To create a "
23987 "non-sparse file of zeroes, use L</fallocate64> instead."
23991 #: ../fish/guestfish-actions.pod:4226
23996 #: ../fish/guestfish-actions.pod:4228
23999 " tune2fs-l device\n"
24004 #: ../fish/guestfish-actions.pod:4238
24009 #: ../fish/guestfish-actions.pod:4240
24012 " txz-in (tarball|-) directory\n"
24017 #: ../fish/guestfish-actions.pod:4247
24022 #: ../fish/guestfish-actions.pod:4249
24025 " txz-out directory (tarball|-)\n"
24030 #: ../fish/guestfish-actions.pod:4256
24035 #: ../fish/guestfish-actions.pod:4258
24043 #: ../fish/guestfish-actions.pod:4272
24044 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24048 #: ../fish/guestfish-actions.pod:4277
24053 #: ../fish/guestfish-actions.pod:4279
24058 #: ../fish/guestfish-actions.pod:4281
24061 " umount pathordevice\n"
24066 #: ../fish/guestfish-actions.pod:4287
24071 #: ../fish/guestfish-actions.pod:4289
24072 msgid "unmount-all"
24076 #: ../fish/guestfish-actions.pod:4291
24084 #: ../fish/guestfish-actions.pod:4297
24089 #: ../fish/guestfish-actions.pod:4299
24092 " upload (filename|-) remotefilename\n"
24097 #: ../fish/guestfish-actions.pod:4306
24098 msgid "See also L</download>."
24102 #: ../fish/guestfish-actions.pod:4310
24103 msgid "upload-offset"
24107 #: ../fish/guestfish-actions.pod:4312
24110 " upload-offset (filename|-) remotefilename offset\n"
24115 #: ../fish/guestfish-actions.pod:4324
24117 "Note that there is no limit on the amount of data that can be uploaded with "
24118 "this call, unlike with L</pwrite>, and this call always writes the full "
24119 "amount unless an error occurs."
24123 #: ../fish/guestfish-actions.pod:4329
24124 msgid "See also L</upload>, L</pwrite>."
24128 #: ../fish/guestfish-actions.pod:4333
24133 #: ../fish/guestfish-actions.pod:4335
24136 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24141 #: ../fish/guestfish-actions.pod:4354
24146 #: ../fish/guestfish-actions.pod:4356
24154 #: ../fish/guestfish-actions.pod:4383
24156 "I<Note:> Don't use this call to test for availability of features. In "
24157 "enterprise distributions we backport features from later versions into "
24158 "earlier versions, making this an unreliable way to test for features. Use "
24159 "L</available> instead."
24163 #: ../fish/guestfish-actions.pod:4389
24168 #: ../fish/guestfish-actions.pod:4391
24171 " vfs-label device\n"
24176 #: ../fish/guestfish-actions.pod:4398
24177 msgid "To find a filesystem from the label, use L</findfs-label>."
24181 #: ../fish/guestfish-actions.pod:4400
24186 #: ../fish/guestfish-actions.pod:4402
24189 " vfs-type device\n"
24194 #: ../fish/guestfish-actions.pod:4412
24199 #: ../fish/guestfish-actions.pod:4414
24202 " vfs-uuid device\n"
24207 #: ../fish/guestfish-actions.pod:4421
24208 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24212 #: ../fish/guestfish-actions.pod:4423
24213 msgid "vg-activate"
24217 #: ../fish/guestfish-actions.pod:4425
24220 " vg-activate true|false 'volgroups ...'\n"
24225 #: ../fish/guestfish-actions.pod:4438
24226 msgid "vg-activate-all"
24230 #: ../fish/guestfish-actions.pod:4440
24233 " vg-activate-all true|false\n"
24238 #: ../fish/guestfish-actions.pod:4450
24243 #: ../fish/guestfish-actions.pod:4452
24246 " vgcreate volgroup 'physvols ...'\n"
24251 #: ../fish/guestfish-actions.pod:4457
24256 #: ../fish/guestfish-actions.pod:4459
24259 " vglvuuids vgname\n"
24264 #: ../fish/guestfish-actions.pod:4464
24266 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24267 "logical volumes and volume groups."
24271 #: ../fish/guestfish-actions.pod:4467
24272 msgid "See also L</vgpvuuids>."
24276 #: ../fish/guestfish-actions.pod:4469
24281 #: ../fish/guestfish-actions.pod:4471
24284 " vgpvuuids vgname\n"
24289 #: ../fish/guestfish-actions.pod:4476
24291 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24292 "physical volumes and volume groups."
24296 #: ../fish/guestfish-actions.pod:4479
24297 msgid "See also L</vglvuuids>."
24301 #: ../fish/guestfish-actions.pod:4481
24306 #: ../fish/guestfish-actions.pod:4483
24309 " vgremove vgname\n"
24314 #: ../fish/guestfish-actions.pod:4490
24319 #: ../fish/guestfish-actions.pod:4492
24322 " vgrename volgroup newvolgroup\n"
24327 #: ../fish/guestfish-actions.pod:4496
24332 #: ../fish/guestfish-actions.pod:4498
24340 #: ../fish/guestfish-actions.pod:4506
24341 msgid "See also L</vgs-full>."
24345 #: ../fish/guestfish-actions.pod:4508
24350 #: ../fish/guestfish-actions.pod:4510
24358 #: ../fish/guestfish-actions.pod:4515
24363 #: ../fish/guestfish-actions.pod:4517
24371 #: ../fish/guestfish-actions.pod:4522
24376 #: ../fish/guestfish-actions.pod:4524
24384 #: ../fish/guestfish-actions.pod:4528
24389 #: ../fish/guestfish-actions.pod:4530
24397 #: ../fish/guestfish-actions.pod:4535
24402 #: ../fish/guestfish-actions.pod:4537
24410 #: ../fish/guestfish-actions.pod:4542
24415 #: ../fish/guestfish-actions.pod:4544
24423 #: ../fish/guestfish-actions.pod:4549
24428 #: ../fish/guestfish-actions.pod:4551
24431 " write path content\n"
24436 #: ../fish/guestfish-actions.pod:4559
24441 #: ../fish/guestfish-actions.pod:4561
24444 " write-file path content size\n"
24449 #: ../fish/guestfish-actions.pod:4584
24454 #: ../fish/guestfish-actions.pod:4586
24457 " zegrep regex path\n"
24462 #: ../fish/guestfish-actions.pod:4594
24467 #: ../fish/guestfish-actions.pod:4596
24470 " zegrepi regex path\n"
24475 #: ../fish/guestfish-actions.pod:4604
24480 #: ../fish/guestfish-actions.pod:4606
24488 #: ../fish/guestfish-actions.pod:4614
24489 msgid "See also: L</zero-device>, L</scrub-device>."
24493 #: ../fish/guestfish-actions.pod:4616
24494 msgid "zero-device"
24498 #: ../fish/guestfish-actions.pod:4618
24501 " zero-device device\n"
24506 #: ../fish/guestfish-actions.pod:4620
24508 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24509 "which just zeroes the first few blocks of a device."
24513 #: ../fish/guestfish-actions.pod:4627
24518 #: ../fish/guestfish-actions.pod:4629
24521 " zerofree device\n"
24526 #: ../fish/guestfish-actions.pod:4642
24531 #: ../fish/guestfish-actions.pod:4644
24534 " zfgrep pattern path\n"
24539 #: ../fish/guestfish-actions.pod:4652
24544 #: ../fish/guestfish-actions.pod:4654
24547 " zfgrepi pattern path\n"
24552 #: ../fish/guestfish-actions.pod:4662
24557 #: ../fish/guestfish-actions.pod:4664
24560 " zfile meth path\n"
24565 #: ../fish/guestfish-actions.pod:4671
24566 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
24570 #: ../fish/guestfish-actions.pod:4681
24575 #: ../fish/guestfish-actions.pod:4683
24578 " zgrep regex path\n"
24583 #: ../fish/guestfish-actions.pod:4691
24588 #: ../fish/guestfish-actions.pod:4693
24591 " zgrepi regex path\n"
24596 #: ../fish/guestfish-commands.pod:1
24601 #: ../fish/guestfish-commands.pod:3
24606 #: ../fish/guestfish-commands.pod:5
24609 " alloc filename size\n"
24614 #: ../fish/guestfish-commands.pod:7
24616 "This creates an empty (zeroed) file of the given size, and then adds so it "
24617 "can be further examined."
24621 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24622 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24626 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24627 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24631 #: ../fish/guestfish-commands.pod:14
24633 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24634 "image, see L</PREPARED DISK IMAGES>."
24638 #: ../fish/guestfish-commands.pod:17
24643 #: ../fish/guestfish-commands.pod:19
24646 " copy-in local [local ...] /remotedir\n"
24651 #: ../fish/guestfish-commands.pod:21
24653 "C<copy-in> copies local files or directories recursively into the disk "
24654 "image, placing them in the directory called C</remotedir> (which must "
24655 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24656 "other commands as necessary."
24660 #: ../fish/guestfish-commands.pod:26
24662 "Multiple local files and directories can be specified, but the last "
24663 "parameter must always be a remote directory. Wildcards cannot be used."
24667 #: ../fish/guestfish-commands.pod:30
24672 #: ../fish/guestfish-commands.pod:32
24675 " copy-out remote [remote ...] localdir\n"
24680 #: ../fish/guestfish-commands.pod:34
24682 "C<copy-out> copies remote files or directories recursively out of the disk "
24683 "image, placing them on the host disk in a local directory called C<localdir> "
24684 "(which must exist). This guestfish meta-command turns into a sequence of "
24685 "L</download>, L</tar-out> and other commands as necessary."
24689 #: ../fish/guestfish-commands.pod:40
24691 "Multiple remote files and directories can be specified, but the last "
24692 "parameter must always be a local directory. To download to the current "
24693 "directory, use C<.> as in:"
24697 #: ../fish/guestfish-commands.pod:44
24700 " copy-out /home .\n"
24705 #: ../fish/guestfish-commands.pod:46
24707 "Wildcards cannot be used in the ordinary command, but you can use them with "
24708 "the help of L</glob> like this:"
24712 #: ../fish/guestfish-commands.pod:49
24715 " glob copy-out /home/* .\n"
24720 #: ../fish/guestfish-commands.pod:51
24725 #: ../fish/guestfish-commands.pod:53
24728 " echo [params ...]\n"
24733 #: ../fish/guestfish-commands.pod:55
24734 msgid "This echos the parameters to the terminal."
24738 #: ../fish/guestfish-commands.pod:57
24743 #: ../fish/guestfish-commands.pod:59
24748 #: ../fish/guestfish-commands.pod:61
24753 #: ../fish/guestfish-commands.pod:63
24761 #: ../fish/guestfish-commands.pod:65
24763 "This is used to edit a file. It downloads the file, edits it locally using "
24764 "your editor, then uploads the result."
24768 #: ../fish/guestfish-commands.pod:68
24770 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24771 "or C<emacs> you will get those corresponding editors."
24775 #: ../fish/guestfish-commands.pod:72
24780 #: ../fish/guestfish-commands.pod:74
24783 " glob command args...\n"
24788 #: ../fish/guestfish-commands.pod:76
24790 "Expand wildcards in any paths in the args list, and run C<command> "
24791 "repeatedly on each matching path."
24795 #: ../fish/guestfish-commands.pod:79
24796 msgid "See L</WILDCARDS AND GLOBBING>."
24800 #: ../fish/guestfish-commands.pod:81
24805 #: ../fish/guestfish-commands.pod:83
24808 " hexedit <filename|device>\n"
24809 " hexedit <filename|device> <max>\n"
24810 " hexedit <filename|device> <start> <max>\n"
24815 #: ../fish/guestfish-commands.pod:87
24817 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24822 #: ../fish/guestfish-commands.pod:90
24824 "This command works by downloading potentially the whole file or device, "
24825 "editing it locally, then uploading it. If the file or device is large, you "
24826 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24827 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24828 "usual modifiers allowed such as C<1M> (1 megabyte)."
24832 #: ../fish/guestfish-commands.pod:97
24833 msgid "For example to edit the first few sectors of a disk you might do:"
24837 #: ../fish/guestfish-commands.pod:100
24840 " hexedit /dev/sda 1M\n"
24845 #: ../fish/guestfish-commands.pod:102
24847 "which would allow you to edit anywhere within the first megabyte of the "
24852 #: ../fish/guestfish-commands.pod:105
24853 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24857 #: ../fish/guestfish-commands.pod:107
24860 " hexedit /dev/sda1 0x400 0x400\n"
24865 #: ../fish/guestfish-commands.pod:109
24866 msgid "(assuming the superblock is in the standard location)."
24870 #: ../fish/guestfish-commands.pod:111
24872 "This command requires the external L<hexedit(1)> program. You can specify "
24873 "another program to use by setting the C<HEXEDITOR> environment variable."
24877 #: ../fish/guestfish-commands.pod:115
24878 msgid "See also L</hexdump>."
24882 #: ../fish/guestfish-commands.pod:117
24887 #: ../fish/guestfish-commands.pod:119
24895 #: ../fish/guestfish-commands.pod:121
24896 msgid "Change the local directory, ie. the current directory of guestfish itself."
24900 #: ../fish/guestfish-commands.pod:124
24901 msgid "Note that C<!cd> won't do what you might expect."
24905 #: ../fish/guestfish-commands.pod:126
24910 #: ../fish/guestfish-commands.pod:128
24915 #: ../fish/guestfish-commands.pod:130
24923 #: ../fish/guestfish-commands.pod:132
24924 msgid "Opens the manual page for guestfish."
24928 #: ../fish/guestfish-commands.pod:134
24933 #: ../fish/guestfish-commands.pod:136
24938 #: ../fish/guestfish-commands.pod:138
24946 #: ../fish/guestfish-commands.pod:140
24954 #: ../fish/guestfish-commands.pod:142
24955 msgid "This is used to view a file."
24959 #: ../fish/guestfish-commands.pod:144
24961 "The default viewer is C<$PAGER>. However if you use the alternate command "
24962 "C<less> you will get the C<less> command specifically."
24966 #: ../fish/guestfish-commands.pod:147
24971 #: ../fish/guestfish-commands.pod:149
24979 #: ../fish/guestfish-commands.pod:151
24981 "Close and reopen the libguestfs handle. It is not necessary to use this "
24982 "normally, because the handle is closed properly when guestfish exits. "
24983 "However this is occasionally useful for testing."
24987 #: ../fish/guestfish-commands.pod:155
24992 #: ../fish/guestfish-commands.pod:157
24995 " sparse filename size\n"
25000 #: ../fish/guestfish-commands.pod:159
25002 "This creates an empty sparse file of the given size, and then adds so it can "
25003 "be further examined."
25007 #: ../fish/guestfish-commands.pod:162
25009 "In all respects it works the same as the L</alloc> command, except that the "
25010 "image file is allocated sparsely, which means that disk blocks are not "
25011 "assigned to the file until they are needed. Sparse disk files only use "
25012 "space when written to, but they are slower and there is a danger you could "
25013 "run out of real disk space during a write operation."
25017 #: ../fish/guestfish-commands.pod:172
25022 #: ../fish/guestfish-commands.pod:174
25030 #: ../fish/guestfish-commands.pod:176
25032 "This command returns a list of the optional groups known to the daemon, and "
25033 "indicates which ones are supported by this build of the libguestfs "
25038 #: ../fish/guestfish-commands.pod:180
25039 msgid "See also L<guestfs(3)/AVAILABILITY>."
25043 #: ../fish/guestfish-commands.pod:182
25048 #: ../fish/guestfish-commands.pod:184
25051 " time command args...\n"
25056 #: ../fish/guestfish-commands.pod:186
25058 "Run the command as usual, but print the elapsed time afterwards. This can "
25059 "be useful for benchmarking operations."
25063 #: ../test-tool/libguestfs-test-tool.pod:5
25064 msgid "libguestfs-test-tool - End user tests for libguestfs"
25068 #: ../test-tool/libguestfs-test-tool.pod:9
25071 " libguestfs-test-tool [--options]\n"
25076 #: ../test-tool/libguestfs-test-tool.pod:13
25078 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25079 "and developers, to allow them to check basic libguestfs functionality is "
25080 "working. This is needed because libguestfs occasionally breaks for reasons "
25081 "beyond our control: usually because of changes in the underlying qemu or "
25082 "kernel packages, or the host environment."
25086 #: ../test-tool/libguestfs-test-tool.pod:20
25087 msgid "If you suspect a problem in libguestfs, then just run:"
25091 #: ../test-tool/libguestfs-test-tool.pod:22
25094 " libguestfs-test-tool\n"
25099 #: ../test-tool/libguestfs-test-tool.pod:24
25100 msgid "It will print lots of diagnostic messages."
25104 #: ../test-tool/libguestfs-test-tool.pod:26
25105 msgid "If it runs to completion successfully, you will see this near the end:"
25109 #: ../test-tool/libguestfs-test-tool.pod:28
25112 " ===== TEST FINISHED OK =====\n"
25117 #: ../test-tool/libguestfs-test-tool.pod:30
25118 msgid "and the test tool will exit with code 0."
25122 #: ../test-tool/libguestfs-test-tool.pod:32
25124 "If it fails (and/or exits with non-zero error code), please paste the "
25125 "B<complete, unedited> output of the test tool into a bug report. More "
25126 "information about reporting bugs can be found on the "
25127 "L<http://libguestfs.org/> website."
25131 #: ../test-tool/libguestfs-test-tool.pod:41
25136 #: ../test-tool/libguestfs-test-tool.pod:43
25137 msgid "Display short usage information and exit."
25141 #: ../test-tool/libguestfs-test-tool.pod:45
25142 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25146 #: ../test-tool/libguestfs-test-tool.pod:47
25148 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25149 "normally look in the C<$libexec> directory that was configured when the tool "
25154 #: ../test-tool/libguestfs-test-tool.pod:51
25155 msgid "I<--qemu qemu_binary>"
25159 #: ../test-tool/libguestfs-test-tool.pod:53
25161 "If you have downloaded another qemu binary, point this option at the full "
25162 "path of the binary to try it."
25166 #: ../test-tool/libguestfs-test-tool.pod:56
25167 msgid "I<--qemudir qemu_source_dir>"
25171 #: ../test-tool/libguestfs-test-tool.pod:58
25173 "If you have compiled qemu from source, point this option at the source "
25174 "directory to try it."
25178 #: ../test-tool/libguestfs-test-tool.pod:61
25179 msgid "I<--timeout N>"
25183 #: ../test-tool/libguestfs-test-tool.pod:63
25185 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25186 "does not usually need to be adjusted unless your machine is very slow."
25190 #: ../test-tool/libguestfs-test-tool.pod:69
25191 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25195 #: ../test-tool/libguestfs-test-tool.pod:71
25197 "If you have compiled another version of qemu from source and would like to "
25198 "try that, then you can use the I<--qemudir> option to point to the qemu "
25199 "source directory."
25203 #: ../test-tool/libguestfs-test-tool.pod:75
25205 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25206 "option to point to the binary."
25210 #: ../test-tool/libguestfs-test-tool.pod:78
25212 "When using an alternate qemu with libguestfs, usually you would need to "
25213 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
25214 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
25215 "when you use either of the I<--qemudir> or I<--qemu> options."
25219 #: ../test-tool/libguestfs-test-tool.pod:85
25221 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25222 "I<1> if there was an error."
25226 #: ../test-tool/libguestfs-test-tool.pod:92
25227 msgid "/usr/libexec/libguestfs-test-tool-helper"
25231 #: ../test-tool/libguestfs-test-tool.pod:94
25233 "This helper program is run inside the appliance and provides additional "
25238 #: ../test-tool/libguestfs-test-tool.pod:97
25239 msgid "/usr/bin/mkisofs"
25243 #: ../test-tool/libguestfs-test-tool.pod:99
25245 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25246 "which is used as part of the tests."
25250 #: ../test-tool/libguestfs-test-tool.pod:106
25252 "For the full list of environment variables which may affect libguestfs, "
25253 "please see the L<guestfs(3)> manual page."
25257 #: ../test-tool/libguestfs-test-tool.pod:111
25258 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25262 #: ../test-tool/libguestfs-test-tool.pod:121
25263 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25267 #: ../fuse/guestmount.pod:5
25268 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25272 #: ../fuse/guestmount.pod:9
25275 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25280 #: ../fuse/guestmount.pod:11
25283 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25288 #: ../fuse/guestmount.pod:13
25291 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25296 #: ../fuse/guestmount.pod:17
25298 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25299 "machines. If you do this, you risk disk corruption in the VM."
25303 #: ../fuse/guestmount.pod:22
25305 "The guestmount program can be used to mount virtual machine filesystems and "
25306 "other disk images on the host. It uses libguestfs for access to the guest "
25307 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25308 "a mountable device."
25312 #: ../fuse/guestmount.pod:27
25314 "Along with other options, you have to give at least one device (I<-a> "
25315 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25316 "option) or use the I<-i> inspection option. How this works is better "
25317 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25322 #: ../fuse/guestmount.pod:33
25324 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25325 "by you, and the filesystem will not be visible to any other users unless you "
25326 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25327 "the filesystem, use the C<fusermount -u> command."
25331 #: ../fuse/guestmount.pod:41
25333 "For a typical Windows guest which has its main filesystem on the first "
25338 #: ../fuse/guestmount.pod:44
25341 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25346 #: ../fuse/guestmount.pod:46
25348 "For a typical Linux guest which has a /boot filesystem on the first "
25349 "partition, and the root filesystem on a logical volume:"
25353 #: ../fuse/guestmount.pod:49
25356 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25361 #: ../fuse/guestmount.pod:51
25362 msgid "To get libguestfs to detect guest mountpoints for you:"
25366 #: ../fuse/guestmount.pod:53
25369 " guestmount -a guest.img -i --ro /mnt\n"
25374 #: ../fuse/guestmount.pod:55
25375 msgid "For a libvirt guest called \"Guest\" you could do:"
25379 #: ../fuse/guestmount.pod:57
25382 " guestmount -d Guest -i --ro /mnt\n"
25387 #: ../fuse/guestmount.pod:59
25389 "If you don't know what filesystems are contained in a guest or disk image, "
25390 "use L<virt-filesystems(1)> first:"
25394 #: ../fuse/guestmount.pod:62
25397 " virt-filesystems MyGuest\n"
25402 #: ../fuse/guestmount.pod:64
25404 "If you want to trace the libguestfs calls but without excessive debugging "
25405 "information, we recommend:"
25409 #: ../fuse/guestmount.pod:67
25412 " guestmount [...] --trace /mnt\n"
25417 #: ../fuse/guestmount.pod:69
25418 msgid "If you want to debug the program, we recommend:"
25422 #: ../fuse/guestmount.pod:71
25425 " guestmount [...] --trace --verbose /mnt\n"
25430 #: ../fuse/guestmount.pod:79
25431 msgid "Add a block device or virtual machine image."
25435 #: ../fuse/guestmount.pod:96
25436 msgid "B<--dir-cache-timeout N>"
25440 #: ../fuse/guestmount.pod:98
25442 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25443 "seconds. The readdir cache [actually, there are several semi-independent "
25444 "caches] is populated after a readdir(2) call with the stat and extended "
25445 "attributes of the files in the directory, in anticipation that they will be "
25446 "requested soon after."
25450 #: ../fuse/guestmount.pod:104
25452 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25453 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25454 "requests, only cache existing ones."
25458 #: ../fuse/guestmount.pod:122
25460 "If you have untrusted raw-format guest disk images, you should use this "
25461 "option to specify the disk format. This avoids a possible security problem "
25462 "with malicious guests (CVE-2010-3851). See also "
25463 "L<guestfs(3)/guestfs_add_drive_opts>."
25467 #: ../fuse/guestmount.pod:127
25468 msgid "B<--fuse-help>"
25472 #: ../fuse/guestmount.pod:129
25473 msgid "Display help on special FUSE options (see I<-o> below)."
25477 #: ../fuse/guestmount.pod:133
25478 msgid "Display brief help and exit."
25482 #: ../fuse/guestmount.pod:146
25483 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25487 #: ../fuse/guestmount.pod:148
25489 "Mount the named partition or logical volume on the given mountpoint B<in the "
25490 "guest> (this has nothing to do with mountpoints in the host)."
25494 #: ../fuse/guestmount.pod:151
25496 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25497 "something on C</>."
25501 #: ../fuse/guestmount.pod:156
25503 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25504 "unmounted. If you specify this option, then we don't attempt to sync the "
25505 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25509 #: ../fuse/guestmount.pod:161
25510 msgid "B<-o option> | B<--option option>"
25514 #: ../fuse/guestmount.pod:163
25515 msgid "Pass extra options to FUSE."
25519 #: ../fuse/guestmount.pod:165
25521 "To get a list of all the extra options supported by FUSE, use the command "
25522 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25523 "of them are a good idea."
25527 #: ../fuse/guestmount.pod:169
25530 " guestmount --fuse-help\n"
25535 #: ../fuse/guestmount.pod:171
25536 msgid "Some potentially useful FUSE options:"
25540 #: ../fuse/guestmount.pod:175
25541 msgid "B<-o allow_other>"
25545 #: ../fuse/guestmount.pod:177
25546 msgid "Allow other users to see the filesystem."
25550 #: ../fuse/guestmount.pod:179
25551 msgid "B<-o attr_timeout=N>"
25555 #: ../fuse/guestmount.pod:181
25556 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25560 #: ../fuse/guestmount.pod:183
25561 msgid "B<-o kernel_cache>"
25565 #: ../fuse/guestmount.pod:185
25567 "Allow the kernel to cache files (reduces the number of reads that have to go "
25568 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25569 "afford the extra memory usage."
25573 #: ../fuse/guestmount.pod:189
25574 msgid "B<-o uid=N> B<-o gid=N>"
25578 #: ../fuse/guestmount.pod:191
25580 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25581 "the chosen values."
25585 #: ../fuse/guestmount.pod:198
25587 "Add devices and mount everything read-only. Also disallow writes and make "
25588 "the disk appear read-only to FUSE."
25592 #: ../fuse/guestmount.pod:201
25594 "This is highly recommended if you are not going to edit the guest disk. If "
25595 "the guest is running and this option is I<not> supplied, then there is a "
25596 "strong risk of disk corruption in the guest. We try to prevent this from "
25597 "happening, but it is not always possible."
25601 #: ../fuse/guestmount.pod:206
25602 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25606 #: ../fuse/guestmount.pod:210
25607 msgid "Enable SELinux support for the guest."
25611 #: ../fuse/guestmount.pod:214
25612 msgid "Enable verbose messages from underlying libguestfs."
25616 #: ../fuse/guestmount.pod:218
25617 msgid "Display the program version and exit."
25621 #: ../fuse/guestmount.pod:222
25623 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25624 "FOR READ AND WRITE>."
25628 #: ../fuse/guestmount.pod:225
25629 msgid "B<-x> | B<--trace>"
25633 #: ../fuse/guestmount.pod:227
25634 msgid "Trace libguestfs calls."
25638 #: ../fuse/guestmount.pod:229
25639 msgid "This also stops the daemon from forking into the background."
25643 #: ../fuse/guestmount.pod:235
25645 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25646 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
25647 "L<http://fuse.sf.net/>."
25651 #: ../tools/virt-edit.pl:34
25652 msgid "virt-edit - Edit a file in a virtual machine"
25656 #: ../tools/virt-edit.pl:38
25659 " virt-edit [--options] domname file\n"
25664 #: ../tools/virt-edit.pl:40
25667 " virt-edit [--options] disk.img [disk.img ...] file\n"
25672 #: ../tools/virt-edit.pl:42
25675 " virt-edit [domname|disk.img] file -e 'expr'\n"
25680 #: ../tools/virt-edit.pl:46
25682 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25683 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25684 "doing this, but doesn't catch all cases."
25688 #: ../tools/virt-edit.pl:52
25690 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25691 "the named virtual machine (or disk image)."
25695 #: ../tools/virt-edit.pl:55
25697 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25698 "you should look at the L<guestfish(1)> tool."
25702 #: ../tools/virt-edit.pl:60
25703 msgid "Edit the named files interactively:"
25707 #: ../tools/virt-edit.pl:62
25710 " virt-edit mydomain /boot/grub/grub.conf\n"
25715 #: ../tools/virt-edit.pl:64
25718 " virt-edit mydomain /etc/passwd\n"
25723 #: ../tools/virt-edit.pl:66
25725 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25726 "below). To change the init default level to 5:"
25730 #: ../tools/virt-edit.pl:70
25733 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25738 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
25739 msgid "Display brief help."
25743 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
25744 msgid "B<--version>"
25748 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
25749 msgid "Display version number and exit."
25753 #: ../tools/virt-edit.pl:96
25754 msgid "B<--backup extension> | B<-b extension>"
25758 #: ../tools/virt-edit.pl:98
25760 "Create a backup of the original file I<in the guest disk image>. The backup "
25761 "has the original filename with C<extension> added."
25765 #: ../tools/virt-edit.pl:101
25767 "Usually the first character of C<extension> would be a dot C<.> so you would "
25772 #: ../tools/virt-edit.pl:104
25775 " virt-edit -b .orig [etc]\n"
25780 #: ../tools/virt-edit.pl:106
25781 msgid "By default, no backup file is made."
25785 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-list-partitions.pl:78
25786 msgid "B<--connect URI> | B<-c URI>"
25790 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-list-partitions.pl:80
25792 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25793 "to the default libvirt hypervisor."
25797 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:83
25799 "If you specify guest block devices directly, then libvirt is not used at "
25804 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
25805 msgid "B<--format> raw"
25809 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-list-partitions.pl:92
25811 "Specify the format of disk images given on the command line. If this is "
25812 "omitted then the format is autodetected from the content of the disk image."
25816 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-list-partitions.pl:96
25818 "If disk images are requested from libvirt, then this program asks libvirt "
25819 "for this information. In this case, the value of the format parameter is "
25824 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225 ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144 ../tools/virt-list-partitions.pl:100
25826 "If working with untrusted raw-format guest disk images, you should ensure "
25827 "the format is always specified."
25831 #: ../tools/virt-edit.pl:141
25832 msgid "B<--expr EXPR> | B<-e EXPR>"
25836 #: ../tools/virt-edit.pl:143
25838 "Instead of launching the external editor, non-interactively apply the Perl "
25839 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25844 #: ../tools/virt-edit.pl:147
25846 "Be careful to properly quote the expression to prevent it from being altered "
25851 #: ../tools/virt-edit.pl:268
25852 msgid "NON-INTERACTIVE EDITING"
25856 #: ../tools/virt-edit.pl:270
25858 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25859 "administrator can interactively edit the file."
25863 #: ../tools/virt-edit.pl:273
25865 "There are two ways also to use C<virt-edit> from scripts in order to make "
25866 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25867 "like this, it's less error-prone to write scripts directly using the "
25868 "libguestfs API and Augeas for configuration file editing.)"
25872 #: ../tools/virt-edit.pl:279
25874 "The first method is to temporarily set C<$EDITOR> to any script or program "
25875 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25876 "update C<tmpfile> in place however it likes."
25880 #: ../tools/virt-edit.pl:283
25882 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25883 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25884 "instances of C<foo> with C<bar> in a file:"
25888 #: ../tools/virt-edit.pl:287
25891 " virt-edit domname filename -e 's/foo/bar/'\n"
25896 #: ../tools/virt-edit.pl:289
25898 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25899 "For example to delete root's password you could do:"
25903 #: ../tools/virt-edit.pl:292
25906 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25911 #: ../tools/virt-edit.pl:294
25913 "What really happens is that the snippet is evaluated as a Perl expression "
25914 "for each line of the file. The line, including the final C<\\n>, is passed "
25915 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25919 #: ../tools/virt-edit.pl:299
25921 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25922 "C<apache> user account from the password file you can do:"
25926 #: ../tools/virt-edit.pl:302
25929 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25934 #: ../tools/virt-edit.pl:304
25936 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25937 "the end of the file is rather difficult this way since there is no concept "
25938 "of \"last line of the file\" - your expression just doesn't get called "
25939 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25944 #: ../tools/virt-edit.pl:310
25946 "The variable C<$lineno> contains the current line number. As is "
25947 "traditional, the first line in the file is number C<1>."
25951 #: ../tools/virt-edit.pl:313
25953 "The return value from the expression is ignored, but the expression may call "
25954 "C<die> in order to abort the whole program, leaving the original file "
25959 #: ../tools/virt-edit.pl:317
25961 "Remember when matching the end of a line that C<$_> may contain the final "
25962 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25963 "newline then neither of these. Thus to match or substitute some text at the "
25964 "end of a line, use this regular expression:"
25968 #: ../tools/virt-edit.pl:322
25971 " /some text(\\r?\\n)?$/\n"
25976 #: ../tools/virt-edit.pl:324
25978 "Alternately, use the perl C<chomp> function, being careful not to chomp "
25979 "C<$_> itself (since that would remove all newlines from the file):"
25983 #: ../tools/virt-edit.pl:328
25986 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25991 #: ../tools/virt-edit.pl:334
25996 #: ../tools/virt-edit.pl:336
25998 "If set, this string is used as the editor. It may contain arguments, "
25999 "eg. C<\"emacs -nw\">"
26003 #: ../tools/virt-edit.pl:339
26004 msgid "If not set, C<vi> is used."
26008 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26009 msgid "SHELL QUOTING"
26013 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
26015 "Libvirt guest names can contain arbitrary characters, some of which have "
26016 "meaning to the shell such as C<#> and space. You may need to quote or "
26017 "escape these characters on the command line. See the shell manual page "
26018 "L<sh(1)> for details."
26022 #: ../tools/virt-edit.pl:352
26024 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26025 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
26026 "L<perl(1)>, L<perlre(1)>."
26030 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
26035 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
26036 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26040 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
26041 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26045 #: ../tools/virt-win-reg.pl:37
26047 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
26052 #: ../tools/virt-win-reg.pl:41
26055 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26060 #: ../tools/virt-win-reg.pl:43
26063 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26068 #: ../tools/virt-win-reg.pl:45
26071 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26076 #: ../tools/virt-win-reg.pl:47
26079 " virt-win-reg --merge domname [input.reg ...]\n"
26084 #: ../tools/virt-win-reg.pl:49
26087 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26092 #: ../tools/virt-win-reg.pl:53
26094 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26095 "virtual machines. If you do this, you I<will> get irreversible disk "
26096 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26097 "but doesn't catch all cases."
26101 #: ../tools/virt-win-reg.pl:58
26103 "Modifying the Windows Registry is an inherently risky operation. The format "
26104 "is deliberately obscure and undocumented, and Registry changes can leave the "
26105 "system unbootable. Therefore when using the C<--merge> option, make sure "
26106 "you have a reliable backup first."
26110 #: ../tools/virt-win-reg.pl:65
26112 "This program can export and merge Windows Registry entries from a Windows "
26117 #: ../tools/virt-win-reg.pl:68
26119 "The first parameter is the libvirt guest name or the raw disk image of a "
26124 #: ../tools/virt-win-reg.pl:71
26126 "If C<--merge> is I<not> specified, then the chosen registry key is "
26127 "displayed/exported (recursively). For example:"
26131 #: ../tools/virt-win-reg.pl:74
26134 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26139 #: ../tools/virt-win-reg.pl:76
26140 msgid "You can also display single values from within registry keys, for example:"
26144 #: ../tools/virt-win-reg.pl:79
26147 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26148 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26149 " Windows 7 Enterprise\n"
26154 #: ../tools/virt-win-reg.pl:83
26156 "With C<--merge>, you can merge a textual regedit file into the Windows "
26161 #: ../tools/virt-win-reg.pl:86
26164 " $ virt-win-reg --merge Windows7 changes.reg\n"
26169 #: ../tools/virt-win-reg.pl:88
26170 msgid "SUPPORTED SYSTEMS"
26174 #: ../tools/virt-win-reg.pl:90
26176 "The program currently supports Windows NT-derived guests starting with "
26177 "Windows XP through to at least Windows 7."
26181 #: ../tools/virt-win-reg.pl:93
26183 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
26184 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
26185 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
26189 #: ../tools/virt-win-reg.pl:97
26191 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26196 #: ../tools/virt-win-reg.pl:100
26198 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26203 #: ../tools/virt-win-reg.pl:103
26208 #: ../tools/virt-win-reg.pl:105
26210 "This program is only meant for simple access to the registry. If you want "
26211 "to do complicated things with the registry, we suggest you download the "
26212 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26213 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26214 "L<hivexregedit(1)>."
26218 #: ../tools/virt-win-reg.pl:111
26223 #: ../tools/virt-win-reg.pl:113
26225 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26226 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
26227 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
26228 "with Windows-style line endings, you may need to reencode the whole file "
26229 "before or after processing."
26233 #: ../tools/virt-win-reg.pl:119
26235 "To reencode a file from Windows format to Linux (before processing it with "
26236 "the C<--merge> option), you would do something like this:"
26240 #: ../tools/virt-win-reg.pl:122
26243 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26248 #: ../tools/virt-win-reg.pl:124
26250 "To go in the opposite direction, after exporting and before sending the file "
26251 "to a Windows user, do something like this:"
26255 #: ../tools/virt-win-reg.pl:127
26258 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26263 #: ../tools/virt-win-reg.pl:129
26264 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26268 #: ../tools/virt-win-reg.pl:131
26270 "If you are unsure about the current encoding, use the L<file(1)> command. "
26271 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
26272 "Windows-style (CRLF) line endings, like this:"
26276 #: ../tools/virt-win-reg.pl:135
26279 " $ file software.reg\n"
26280 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26281 " with CRLF line terminators\n"
26286 #: ../tools/virt-win-reg.pl:139
26287 msgid "This file would need conversion before you could C<--merge> it."
26291 #: ../tools/virt-win-reg.pl:143
26293 "Be careful when passing parameters containing C<\\> (backslash) in the "
26294 "shell. Usually you will have to use 'single quotes' or double backslashes "
26295 "(but not both) to protect them from the shell."
26299 #: ../tools/virt-win-reg.pl:147
26300 msgid "Paths and value names are case-insensitive."
26304 #: ../tools/virt-win-reg.pl:149
26305 msgid "CurrentControlSet etc."
26309 #: ../tools/virt-win-reg.pl:151
26311 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26312 "Registry at the level of the hive file, and therefore you cannot modify "
26317 #: ../tools/virt-win-reg.pl:155
26319 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26320 "circumstances it might refer to another control set. The way to find out is "
26321 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26325 #: ../tools/virt-win-reg.pl:159
26328 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26329 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26330 " \"Current\"=dword:00000001\n"
26331 " \"Default\"=dword:00000001\n"
26332 " \"Failed\"=dword:00000000\n"
26333 " \"LastKnownGood\"=dword:00000002\n"
26338 #: ../tools/virt-win-reg.pl:166
26339 msgid "\"Current\" is the one which Windows will choose when it boots."
26343 #: ../tools/virt-win-reg.pl:168
26344 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
26348 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26353 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:498
26354 msgid "Enable debugging messages."
26358 #: ../tools/virt-win-reg.pl:232
26363 #: ../tools/virt-win-reg.pl:234
26365 "In merge mode, this merges a textual regedit file into the Windows Registry "
26366 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26367 "displays or exports Registry entries instead."
26371 #: ../tools/virt-win-reg.pl:238
26373 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26374 "result in disk corruption. However exporting (without this flag) is always "
26379 #: ../tools/virt-win-reg.pl:246
26380 msgid "B<--encoding> UTF-16LE|ASCII"
26384 #: ../tools/virt-win-reg.pl:248
26386 "When merging (only), you may need to specify the encoding for strings to be "
26387 "used in the hive file. This is explained in detail in "
26388 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
26392 #: ../tools/virt-win-reg.pl:252
26394 "The default is to use UTF-16LE, which should work with recent versions of "
26399 #: ../tools/virt-win-reg.pl:486
26401 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
26402 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26403 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
26404 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26408 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26410 "When reporting bugs, please enable debugging and capture the I<complete> "
26415 #: ../tools/virt-win-reg.pl:504
26418 " export LIBGUESTFS_DEBUG=1\n"
26419 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26424 #: ../tools/virt-win-reg.pl:507
26426 "Attach /tmp/virt-win-reg.log to a new bug report at "
26427 "L<https://bugzilla.redhat.com/>"
26431 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:565
26432 msgid "Copyright (C) 2010 Red Hat Inc."
26436 #: ../tools/virt-resize.pl:42
26437 msgid "virt-resize - Resize a virtual machine disk"
26441 #: ../tools/virt-resize.pl:46
26444 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26445 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26446 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26451 #: ../tools/virt-resize.pl:52
26453 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26454 "larger or smaller overall, and resizing or deleting any partitions contained "
26459 #: ../tools/virt-resize.pl:56
26461 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26462 "not> be used on live virtual machines - for consistent results, shut the "
26463 "virtual machine down before resizing it."
26467 #: ../tools/virt-resize.pl:60
26469 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26470 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26474 #: ../tools/virt-resize.pl:66
26476 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26477 "fill the extra 5GB of space."
26481 #: ../tools/virt-resize.pl:69
26484 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26485 " virt-filesystems --long --h --all -a olddisk\n"
26486 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26487 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26492 #: ../tools/virt-resize.pl:74
26494 "As above, but make the /boot partition 200MB bigger, while giving the "
26495 "remaining space to /dev/sda2:"
26499 #: ../tools/virt-resize.pl:77
26502 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26507 #: ../tools/virt-resize.pl:79
26508 msgid "As above, but the output format will be uncompressed qcow2:"
26512 #: ../tools/virt-resize.pl:81
26515 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26516 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26521 #: ../tools/virt-resize.pl:84
26522 msgid "DETAILED USAGE"
26526 #: ../tools/virt-resize.pl:86
26527 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26531 #: ../tools/virt-resize.pl:90
26532 msgid "1. Shut down the virtual machine"
26536 #: ../tools/virt-resize.pl:92
26537 msgid "2. Locate input disk image"
26541 #: ../tools/virt-resize.pl:94
26543 "Locate the input disk image (ie. the file or device on the host containing "
26544 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26545 "dumpxml> like this to find the disk image name:"
26549 #: ../tools/virt-resize.pl:98
26552 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26553 " Found 1 nodes:\n"
26555 " <source dev=\"/dev/vg/lv_guest\" />\n"
26560 #: ../tools/virt-resize.pl:103
26561 msgid "3. Look at current sizing"
26565 #: ../tools/virt-resize.pl:105
26566 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
26570 #: ../tools/virt-resize.pl:108
26573 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
26574 " Name Type Size Parent\n"
26575 " /dev/sda1 partition 101M /dev/sda\n"
26576 " /dev/sda2 partition 7.9G /dev/sda\n"
26577 " /dev/sda device 8.0G -\n"
26582 #: ../tools/virt-resize.pl:114
26584 "(This example is a virtual machine with an 8 GB disk which we would like to "
26585 "expand up to 10 GB)."
26589 #: ../tools/virt-resize.pl:117
26590 msgid "4. Create output disk"
26594 #: ../tools/virt-resize.pl:119
26596 "Virt-resize cannot do in-place disk modifications. You have to have space "
26597 "to store the resized output disk."
26601 #: ../tools/virt-resize.pl:122
26602 msgid "To store the resized disk image in a file, create a file of a suitable size:"
26606 #: ../tools/virt-resize.pl:125
26609 " # rm -f outdisk\n"
26610 " # truncate -s 10G outdisk\n"
26615 #: ../tools/virt-resize.pl:128
26616 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26620 #: ../tools/virt-resize.pl:130
26623 " # lvcreate -L 10G -n lv_name vg_name\n"
26628 #: ../tools/virt-resize.pl:132
26629 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26633 #: ../tools/virt-resize.pl:134
26636 " # virsh pool-list\n"
26637 " # virsh vol-create-as poolname newvol 10G\n"
26642 #: ../tools/virt-resize.pl:137
26647 #: ../tools/virt-resize.pl:139
26649 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26650 "file) and the output disk. The output disk is the one created in the "
26655 #: ../tools/virt-resize.pl:143
26658 " # virt-resize indisk outdisk\n"
26663 #: ../tools/virt-resize.pl:145
26665 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26666 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26667 "larger, then an extra, empty partition is created at the end of the disk "
26668 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26673 #: ../tools/virt-resize.pl:151
26675 "More realistically you'd want to expand existing partitions in the disk "
26676 "image by passing extra options (for the full list see the L</OPTIONS> "
26681 #: ../tools/virt-resize.pl:155
26683 "L</--expand> is the most useful option. It expands the named partition "
26684 "within the disk to fill any extra space:"
26688 #: ../tools/virt-resize.pl:158
26691 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26696 #: ../tools/virt-resize.pl:160
26698 "(In this case, an extra partition is I<not> created at the end of the disk, "
26699 "because there will be no unused space)."
26703 #: ../tools/virt-resize.pl:163
26705 "L</--resize> is the other commonly used option. The following would "
26706 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26707 "rest of the available space:"
26711 #: ../tools/virt-resize.pl:167
26714 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26715 " indisk outdisk\n"
26720 #: ../tools/virt-resize.pl:170
26722 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26723 "if virt-resize knows how, it will resize the contents, the equivalent of "
26724 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
26725 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
26726 "filesystems, so you would have to online resize them after booting the "
26731 #: ../tools/virt-resize.pl:177
26732 msgid "Other options are covered below."
26736 #: ../tools/virt-resize.pl:179
26741 #: ../tools/virt-resize.pl:181
26742 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26746 #: ../tools/virt-resize.pl:183
26747 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26751 #: ../tools/virt-resize.pl:185
26754 " # virsh edit guestname\n"
26759 #: ../tools/virt-resize.pl:187
26761 "Change E<lt>source ...E<gt>, see "
26762 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
26766 #: ../tools/virt-resize.pl:190
26767 msgid "Then start up the domain with the new, resized disk:"
26771 #: ../tools/virt-resize.pl:192
26774 " # virsh start guestname\n"
26779 #: ../tools/virt-resize.pl:194
26781 "and check that it still works. See also the L</NOTES> section below for "
26782 "additional information."
26786 #: ../tools/virt-resize.pl:197
26787 msgid "7. Resize LVs etc inside the guest"
26791 #: ../tools/virt-resize.pl:199
26792 msgid "(This can also be done offline using L<guestfish(1)>)"
26796 #: ../tools/virt-resize.pl:201
26798 "Once the guest has booted you should see the new space available, at least "
26799 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26800 "may need to resize LVs inside PVs, and also resize filesystem types that "
26801 "virt-resize does not know how to expand."
26805 #: ../tools/virt-resize.pl:208
26806 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26810 #: ../tools/virt-resize.pl:210
26812 "Shrinking is somewhat more complex than expanding, and only an overview is "
26817 #: ../tools/virt-resize.pl:213
26819 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26820 "filesystems). The user has to shrink content before passing the disk image "
26821 "to virt-resize, and virt-resize will check that the content has been shrunk "
26826 #: ../tools/virt-resize.pl:218
26827 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26831 #: ../tools/virt-resize.pl:220
26833 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26834 "steps 3 and 4 above to allocate a new disk image."
26838 #: ../tools/virt-resize.pl:223
26839 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26843 #: ../tools/virt-resize.pl:226
26844 msgid "IGNORING OR DELETING PARTITIONS"
26848 #: ../tools/virt-resize.pl:228
26850 "virt-resize also gives a convenient way to ignore or delete partitions when "
26851 "copying from the input disk to the output disk. Ignoring a partition speeds "
26852 "up the copy where you don't care about the existing contents of a "
26853 "partition. Deleting a partition removes it completely, but note that it "
26854 "also renumbers any partitions after the one which is deleted, which can "
26855 "leave some guests unbootable."
26859 #: ../tools/virt-resize.pl:235
26860 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26864 #: ../tools/virt-resize.pl:237
26866 "If the input disk is in qcow2 format, then you may prefer that the output is "
26867 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26868 "the fly. The output format is simply determined by the format of the empty "
26869 "output container that you provide. Thus to create qcow2 output, use:"
26873 #: ../tools/virt-resize.pl:243
26876 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26881 #: ../tools/virt-resize.pl:245
26882 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26886 #: ../tools/virt-resize.pl:247
26887 msgid "Similarly, to get non-sparse raw output use:"
26891 #: ../tools/virt-resize.pl:249
26894 " fallocate -l size outdisk\n"
26899 #: ../tools/virt-resize.pl:251
26901 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26902 "if=/dev/zero of=outdisk bs=1M count=..>)"
26906 #: ../tools/virt-resize.pl:264
26907 msgid "Display help."
26911 #: ../tools/virt-resize.pl:278
26912 msgid "B<--resize part=size>"
26916 #: ../tools/virt-resize.pl:280
26918 "Resize the named partition (expanding or shrinking it) so that it has the "
26923 #: ../tools/virt-resize.pl:283
26925 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26926 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26927 "Exabytes; or as a percentage of the current size; or as a relative number or "
26928 "percentage. For example:"
26932 #: ../tools/virt-resize.pl:288
26935 " --resize /dev/sda2=10G\n"
26940 #: ../tools/virt-resize.pl:290
26943 " --resize /dev/sda4=90%\n"
26948 #: ../tools/virt-resize.pl:292
26951 " --resize /dev/sda2=+1G\n"
26956 #: ../tools/virt-resize.pl:294
26959 " --resize /dev/sda2=-200M\n"
26964 #: ../tools/virt-resize.pl:296
26967 " --resize /dev/sda1=+128K\n"
26972 #: ../tools/virt-resize.pl:298
26975 " --resize /dev/sda1=+10%\n"
26980 #: ../tools/virt-resize.pl:300
26983 " --resize /dev/sda1=-10%\n"
26988 #: ../tools/virt-resize.pl:302
26990 "You can increase the size of any partition. Virt-resize will expand the "
26991 "direct content of the partition if it knows how (see C<--expand> below)."
26995 #: ../tools/virt-resize.pl:306
26997 "You can only I<decrease> the size of partitions that contain filesystems or "
26998 "PVs which have already been shrunk. Virt-resize will check this has been "
26999 "done before proceeding, or else will print an error (see also "
27000 "C<--resize-force>)."
27004 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
27005 msgid "You can give this option multiple times."
27009 #: ../tools/virt-resize.pl:317
27010 msgid "B<--resize-force part=size>"
27014 #: ../tools/virt-resize.pl:319
27016 "This is the same as C<--resize> except that it will let you decrease the "
27017 "size of any partition. Generally this means you will lose any data which "
27018 "was at the end of the partition you shrink, but you may not care about that "
27019 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27020 "as a swap partition)."
27024 #: ../tools/virt-resize.pl:325
27025 msgid "See also the C<--ignore> option."
27029 #: ../tools/virt-resize.pl:331
27030 msgid "B<--expand part>"
27034 #: ../tools/virt-resize.pl:333
27036 "Expand the named partition so it uses up all extra space (space left over "
27037 "after any other resize changes that you request have been done)."
27041 #: ../tools/virt-resize.pl:336
27043 "If virt-resize knows how, it will expand the direct content of the "
27044 "partition. For example, if the partition is an LVM PV, it will expand the "
27045 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27046 "content it doesn't know about alone."
27050 #: ../tools/virt-resize.pl:341
27051 msgid "Currently virt-resize can resize:"
27055 #: ../tools/virt-resize.pl:347
27057 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27062 #: ../tools/virt-resize.pl:352
27064 "NTFS filesystems contained directly in a partition, if libguestfs was "
27065 "compiled with support for NTFS."
27069 #: ../tools/virt-resize.pl:355
27071 "The filesystem must have been shut down consistently last time it was used. "
27072 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27073 "consistency check, so at the first boot after resizing Windows will check "
27078 #: ../tools/virt-resize.pl:362
27080 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
27081 "inside the PV, but see the C<--LV-expand> option. The user could also "
27082 "resize LVs as desired after boot."
27086 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
27087 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27091 #: ../tools/virt-resize.pl:374
27092 msgid "B<--shrink part>"
27096 #: ../tools/virt-resize.pl:376
27098 "Shrink the named partition until the overall disk image fits in the "
27099 "destination. The named partition B<must> contain a filesystem or PV which "
27100 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27101 "online tools). Virt-resize will check this and give an error if it has not "
27106 #: ../tools/virt-resize.pl:382
27108 "The amount by which the overall disk must be shrunk (after carrying out all "
27109 "other operations requested by the user) is called the \"deficit\". For "
27110 "example, a straight copy (assume no other operations) from a 5GB disk image "
27111 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27112 "would give an error unless the user specified a partition to shrink and that "
27113 "partition had more than a gigabyte of free space."
27117 #: ../tools/virt-resize.pl:396
27118 msgid "B<--ignore part>"
27122 #: ../tools/virt-resize.pl:398
27124 "Ignore the named partition. Effectively this means the partition is "
27125 "allocated on the destination disk, but the content is not copied across from "
27126 "the source disk. The content of the partition will be blank (all zero "
27131 #: ../tools/virt-resize.pl:409
27132 msgid "B<--delete part>"
27136 #: ../tools/virt-resize.pl:411
27138 "Delete the named partition. It would be more accurate to describe this as "
27139 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27140 "the original disk image is left intact."
27144 #: ../tools/virt-resize.pl:415
27146 "Note that when you delete a partition, then anything contained in the "
27147 "partition is also deleted. Furthermore, this causes any partitions that "
27148 "come after to be I<renumbered>, which can easily make your guest unbootable."
27152 #: ../tools/virt-resize.pl:426
27153 msgid "B<--LV-expand logvol>"
27157 #: ../tools/virt-resize.pl:428
27159 "This takes the logical volume and, as a final step, expands it to fill all "
27160 "the space available in its volume group. A typical usage, assuming a Linux "
27161 "guest with a single PV C</dev/sda2> and a root device called "
27162 "C</dev/vg_guest/lv_root> would be:"
27166 #: ../tools/virt-resize.pl:433
27169 " virt-resize indisk outdisk \\\n"
27170 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27175 #: ../tools/virt-resize.pl:436
27177 "This would first expand the partition (and PV), and then expand the root "
27178 "device to fill the extra space in the PV."
27182 #: ../tools/virt-resize.pl:439
27184 "The contents of the LV are also resized if virt-resize knows how to do "
27185 "that. You can stop virt-resize from trying to expand the content by using "
27186 "the option C<--no-expand-content>."
27190 #: ../tools/virt-resize.pl:443
27191 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27195 #: ../tools/virt-resize.pl:446
27197 "You can give this option multiple times, I<but> it doesn't make sense to do "
27198 "this unless the logical volumes you specify are all in different volume "
27203 #: ../tools/virt-resize.pl:454
27204 msgid "B<--no-copy-boot-loader>"
27208 #: ../tools/virt-resize.pl:456
27210 "By default, virt-resize copies over some sectors at the start of the disk "
27211 "(up to the beginning of the first partition). Commonly these sectors "
27212 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27213 "in order for the guest to boot correctly."
27217 #: ../tools/virt-resize.pl:461
27219 "If you specify this flag, then this initial copy is not done. You may need "
27220 "to reinstall the boot loader in this case."
27224 #: ../tools/virt-resize.pl:469
27225 msgid "B<--no-extra-partition>"
27229 #: ../tools/virt-resize.pl:471
27231 "By default, virt-resize creates an extra partition if there is any extra, "
27232 "unused space after all resizing has happened. Use this option to prevent "
27233 "the extra partition from being created. If you do this then the extra space "
27234 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27235 "tool in the guest."
27239 #: ../tools/virt-resize.pl:477
27241 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27246 #: ../tools/virt-resize.pl:484
27247 msgid "B<--no-expand-content>"
27251 #: ../tools/virt-resize.pl:486
27253 "By default, virt-resize will try to expand the direct contents of "
27254 "partitions, if it knows how (see C<--expand> option above)."
27258 #: ../tools/virt-resize.pl:489
27260 "If you give the C<--no-expand-content> option then virt-resize will not "
27265 #: ../tools/virt-resize.pl:496
27266 msgid "B<-d> | B<--debug>"
27270 #: ../tools/virt-resize.pl:504
27271 msgid "B<-n> | B<--dryrun>"
27275 #: ../tools/virt-resize.pl:506
27276 msgid "Print a summary of what would be done, but don't do anything."
27280 #: ../tools/virt-resize.pl:512
27281 msgid "B<-q> | B<--quiet>"
27285 #: ../tools/virt-resize.pl:514
27286 msgid "Don't print the summary."
27290 #: ../tools/virt-resize.pl:522
27292 "Specify the format of the input disk image. If this flag is not given then "
27293 "it is auto-detected from the image itself."
27297 #: ../tools/virt-resize.pl:528
27299 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27300 "AND NON-SPARSE RAW FORMATS>."
27304 #: ../tools/virt-resize.pl:535
27305 msgid "B<--output-format> raw"
27309 #: ../tools/virt-resize.pl:537
27311 "Specify the format of the output disk image. If this flag is not given then "
27312 "it is auto-detected from the image itself."
27316 #: ../tools/virt-resize.pl:543
27318 "Note that you still need to create the output disk with the right format. "
27319 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27323 #: ../tools/virt-resize.pl:1419
27328 #: ../tools/virt-resize.pl:1421
27329 msgid "\"Partition 1 does not end on cylinder boundary.\""
27333 #: ../tools/virt-resize.pl:1423
27335 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27336 "means the partitions will not be aligned to the ancient CHS geometry. "
27337 "However CHS geometry is meaningless for disks manufactured since the early "
27338 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27339 "cylinders is not required by any modern operating system."
27343 #: ../tools/virt-resize.pl:1430
27344 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27348 #: ../tools/virt-resize.pl:1432
27350 "In Windows Vista and later versions, Microsoft switched to using a separate "
27351 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27352 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27353 "the boot partition. Doing so seems to break the guest completely. However "
27354 "expanding the second partition (ie. C: drive) should work."
27358 #: ../tools/virt-resize.pl:1439
27360 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27361 "NTFS partitions have been expanded. This is just a safety check and (unless "
27362 "it find errors) is nothing to worry about."
27366 #: ../tools/virt-resize.pl:1443
27367 msgid "GUEST BOOT STUCK AT \"GRUB\""
27371 #: ../tools/virt-resize.pl:1445
27373 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27374 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27375 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27376 "although we think is to do with partition alignment."
27380 #: ../tools/virt-resize.pl:1450
27383 " guestfish -i -a newdisk\n"
27384 " ><fs> cat /boot/grub/device.map\n"
27385 " # check the contents of this file are sensible or\n"
27386 " # edit the file if necessary\n"
27387 " ><fs> grub-install / /dev/vda\n"
27393 #: ../tools/virt-resize.pl:1457
27395 "For more flexible guest reconfiguration, including if you need to specify "
27396 "other parameters to grub-install, use L<virt-rescue(1)>."
27400 #: ../tools/virt-resize.pl:1460
27401 msgid "ALTERNATIVE TOOLS"
27405 #: ../tools/virt-resize.pl:1462
27407 "There are several proprietary tools for resizing partitions. We won't "
27408 "mention any here."
27412 #: ../tools/virt-resize.pl:1465
27414 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27415 "operations on disk images. They can resize and move partitions, but I don't "
27416 "think they can do anything with the contents, and they certainly don't "
27421 #: ../tools/virt-resize.pl:1470
27423 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27424 "but at a much lower level. You will probably end up hand-calculating sector "
27425 "offsets, which is something that virt-resize was designed to avoid. If you "
27426 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27431 #: ../tools/virt-resize.pl:1485
27433 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
27434 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
27435 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
27436 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27437 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27441 #: ../tools/virt-list-filesystems.pl:32
27442 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27446 #: ../tools/virt-list-filesystems.pl:36
27449 " virt-list-filesystems [--options] domname\n"
27454 #: ../tools/virt-list-filesystems.pl:38
27457 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27462 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27464 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27469 #: ../tools/virt-list-filesystems.pl:45
27471 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27472 "are contained in a virtual machine or disk image."
27476 #: ../tools/virt-list-filesystems.pl:49
27478 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27479 "functionality. For more complex cases you should look at the "
27480 "L<guestfish(1)> tool."
27484 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27485 msgid "B<-l> | B<--long>"
27489 #: ../tools/virt-list-filesystems.pl:108
27491 "With this option, C<virt-list-filesystems> displays the type of each "
27492 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27496 #: ../tools/virt-list-filesystems.pl:115
27497 msgid "B<-a> | B<--all>"
27501 #: ../tools/virt-list-filesystems.pl:117
27503 "Normally we only show mountable filesystems. If this option is given then "
27504 "swap devices are shown too."
27508 #: ../tools/virt-list-filesystems.pl:191
27510 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
27511 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
27512 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27516 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27517 msgid "Copyright (C) 2009 Red Hat Inc."
27521 #: ../tools/virt-tar.pl:33
27522 msgid "virt-tar - Extract or upload files to a virtual machine"
27526 #: ../tools/virt-tar.pl:37
27529 " virt-tar [--options] -x domname directory tarball\n"
27534 #: ../tools/virt-tar.pl:39
27537 " virt-tar [--options] -u domname tarball directory\n"
27542 #: ../tools/virt-tar.pl:41
27545 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27550 #: ../tools/virt-tar.pl:43
27553 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27558 #: ../tools/virt-tar.pl:47
27559 msgid "Download C</home> from the VM into a local tarball:"
27563 #: ../tools/virt-tar.pl:49
27566 " virt-tar -x domname /home home.tar\n"
27571 #: ../tools/virt-tar.pl:51
27574 " virt-tar -zx domname /home home.tar.gz\n"
27579 #: ../tools/virt-tar.pl:53
27580 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27584 #: ../tools/virt-tar.pl:55
27587 " virt-tar -u domname uploadstuff.tar /tmp\n"
27592 #: ../tools/virt-tar.pl:57
27595 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27600 #: ../tools/virt-tar.pl:61
27602 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27603 "virtual machines. If you do this, you risk disk corruption in the VM. "
27604 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27608 #: ../tools/virt-tar.pl:66
27610 "You can use C<-x> (extract) on live virtual machines, but you might get "
27611 "inconsistent results or errors if there is filesystem activity inside the "
27612 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27613 "work, but the only way to guarantee consistent results is if the virtual "
27614 "machine is shut down."
27618 #: ../tools/virt-tar.pl:74
27620 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27621 "parts of a guest filesystem. There are many possibilities: making backups, "
27622 "uploading data files, snooping on guest activity, fixing or customizing "
27627 #: ../tools/virt-tar.pl:79
27629 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27630 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27631 "should look at the L<guestfish(1)> tool."
27635 #: ../tools/virt-tar.pl:83
27637 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27638 "its contents (recursively) from the virtual machine into a local tarball. "
27639 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27640 "virtual machine. You cannot use these two options together."
27644 #: ../tools/virt-tar.pl:89
27646 "In addition, you may need to use the C<-z> (gZip) option to enable "
27647 "compression. When uploading, you have to specify C<-z> if the upload file "
27648 "is compressed because virt-tar won't detect this on its own."
27652 #: ../tools/virt-tar.pl:93
27654 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27655 "example it cannot do PKZip files or bzip2 compression. If you want that "
27656 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27657 "the L<libguestfs(3)> API)."
27661 #: ../tools/virt-tar.pl:151
27662 msgid "B<-x> | B<--extract> | B<--download>"
27666 #: ../tools/virt-tar.pl:153
27667 msgid "B<-u> | B<--upload>"
27671 #: ../tools/virt-tar.pl:155
27673 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27678 #: ../tools/virt-tar.pl:158
27680 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27681 "Please read the L</WARNING> section above before using this option."
27685 #: ../tools/virt-tar.pl:162
27686 msgid "You must specify exactly one of these options."
27690 #: ../tools/virt-tar.pl:168
27691 msgid "B<-z> | B<--gzip>"
27695 #: ../tools/virt-tar.pl:170
27696 msgid "Specify that the input or output tarball is gzip-compressed."
27700 #: ../tools/virt-tar.pl:283
27702 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27703 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
27704 "L<http://libguestfs.org/>."
27708 #: ../tools/virt-make-fs.pl:37
27709 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27713 #: ../tools/virt-make-fs.pl:41
27716 " virt-make-fs [--options] input.tar output.img\n"
27721 #: ../tools/virt-make-fs.pl:43
27724 " virt-make-fs [--options] input.tar.gz output.img\n"
27729 #: ../tools/virt-make-fs.pl:45
27732 " virt-make-fs [--options] directory output.img\n"
27737 #: ../tools/virt-make-fs.pl:49
27739 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27740 "archive or some files in a directory. It is similar to tools like "
27741 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
27742 "it can create common filesystem types like ext2/3 or NTFS, which can be "
27743 "useful if you want to attach these filesystems to existing virtual machines "
27744 "(eg. to import large amounts of read-only data to a VM)."
27748 #: ../tools/virt-make-fs.pl:57
27749 msgid "Basic usage is:"
27753 #: ../tools/virt-make-fs.pl:59
27756 " virt-make-fs input output\n"
27761 #: ../tools/virt-make-fs.pl:61
27763 "where C<input> is either a directory containing files that you want to add, "
27764 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27765 "C<output> is a disk image. The input type is detected automatically. The "
27766 "output disk image defaults to a raw ext2 image unless you specify extra "
27767 "flags (see L</OPTIONS> below)."
27771 #: ../tools/virt-make-fs.pl:67
27772 msgid "EXTRA SPACE"
27776 #: ../tools/virt-make-fs.pl:69
27778 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27779 "the files that it contains, but might have extra space. Depending on how "
27780 "you are going to use the output, you might think this extra space is wasted "
27781 "and want to minimize it, or you might want to leave space so that more files "
27782 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27783 "but you can use the C<--size> flag to leave space in the filesystem if you "
27788 #: ../tools/virt-make-fs.pl:77
27790 "An alternative way to leave extra space but not make the output image any "
27791 "bigger is to use an alternative disk image format (instead of the default "
27792 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27793 "image format (check your hypervisor supports this before using it). This "
27794 "allows you to choose a large C<--size> but the extra space won't actually be "
27795 "allocated in the image until you try to store something in it."
27799 #: ../tools/virt-make-fs.pl:85
27801 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27802 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
27803 "virt-make-resize to build another image from scratch."
27807 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
27812 #: ../tools/virt-make-fs.pl:91
27815 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27820 #: ../tools/virt-make-fs.pl:93
27821 msgid "FILESYSTEM TYPE"
27825 #: ../tools/virt-make-fs.pl:95
27827 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27828 "libguestfs supports can be used (but I<not> read-only formats like "
27829 "ISO9660). Here are some of the more common choices:"
27833 #: ../tools/virt-make-fs.pl:101
27838 #: ../tools/virt-make-fs.pl:103
27840 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27841 "you are not going to use the filesystem in a way that requires the journal, "
27842 "then this is just wasted overhead."
27846 #: ../tools/virt-make-fs.pl:107
27847 msgid "I<ntfs> or I<vfat>"
27851 #: ../tools/virt-make-fs.pl:109
27852 msgid "Useful if exporting data to a Windows guest."
27856 #: ../tools/virt-make-fs.pl:111
27858 "I<Note for vfat>: The tar archive or local directory must only contain files "
27859 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27860 "program running within libguestfs is unable to change the ownership of "
27861 "non-root files, since vfat itself does not support this."
27865 #: ../tools/virt-make-fs.pl:116
27870 #: ../tools/virt-make-fs.pl:118
27872 "Lower overhead than C<ext2>, but certain limitations on filename length and "
27873 "total filesystem size."
27877 #: ../tools/virt-make-fs.pl:125
27880 " virt-make-fs --type=minix input minixfs.img\n"
27885 #: ../tools/virt-make-fs.pl:127
27886 msgid "TO PARTITION OR NOT TO PARTITION"
27890 #: ../tools/virt-make-fs.pl:129
27891 msgid "Optionally virt-make-fs can add a partition table to the output disk."
27895 #: ../tools/virt-make-fs.pl:131
27897 "Adding a partition can make the disk image more compatible with certain "
27898 "virtualized operating systems which don't expect to see a filesystem "
27899 "directly located on a block device (Linux doesn't care and will happily "
27900 "handle both types)."
27904 #: ../tools/virt-make-fs.pl:136
27906 "On the other hand, if you have a partition table then the output image is no "
27907 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
27908 "directly on a partitioned disk image. (However libguestfs tools such as "
27909 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
27913 #: ../tools/virt-make-fs.pl:144
27914 msgid "Add an MBR partition:"
27918 #: ../tools/virt-make-fs.pl:146
27921 " virt-make-fs --partition -- input disk.img\n"
27926 #: ../tools/virt-make-fs.pl:148
27928 "If the output disk image could be terabyte-sized or larger, it's better to "
27929 "use an EFI/GPT-compatible partition table:"
27933 #: ../tools/virt-make-fs.pl:151
27936 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
27941 #: ../tools/virt-make-fs.pl:179
27942 msgid "Enable debugging information."
27946 #: ../tools/virt-make-fs.pl:185
27947 msgid "B<--size=E<lt>NE<gt>>"
27951 #: ../tools/virt-make-fs.pl:187
27952 msgid "B<--size=+E<lt>NE<gt>>"
27956 #: ../tools/virt-make-fs.pl:189
27957 msgid "B<-s E<lt>NE<gt>>"
27961 #: ../tools/virt-make-fs.pl:191
27962 msgid "B<-s +E<lt>NE<gt>>"
27966 #: ../tools/virt-make-fs.pl:193
27967 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
27971 #: ../tools/virt-make-fs.pl:196
27973 "If this option is I<not> given, then the output image will be just large "
27974 "enough to contain all the files, with not much wasted space."
27978 #: ../tools/virt-make-fs.pl:199
27980 "To choose a fixed size output disk, specify an absolute number followed by "
27981 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27982 "Petabytes or Exabytes. This must be large enough to contain all the input "
27983 "files, else you will get an error."
27987 #: ../tools/virt-make-fs.pl:204
27989 "To leave extra space, specify C<+> (plus sign) and a number followed by "
27990 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27991 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
27992 "the input files, and (approximately) an extra 200 MB free space."
27996 #: ../tools/virt-make-fs.pl:210
27998 "Note that virt-make-fs estimates free space, and therefore will not produce "
27999 "filesystems containing precisely the free space requested. (It is much more "
28000 "expensive and time-consuming to produce a filesystem which has precisely the "
28001 "desired free space)."
28005 #: ../tools/virt-make-fs.pl:219
28006 msgid "B<--format=E<lt>fmtE<gt>>"
28010 #: ../tools/virt-make-fs.pl:221
28011 msgid "B<-F E<lt>fmtE<gt>>"
28015 #: ../tools/virt-make-fs.pl:223
28016 msgid "Choose the output disk image format."
28020 #: ../tools/virt-make-fs.pl:225
28021 msgid "The default is C<raw> (raw disk image)."
28025 #: ../tools/virt-make-fs.pl:227
28027 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28028 "that would really make sense here is C<qcow2>."
28032 #: ../tools/virt-make-fs.pl:234
28033 msgid "B<--type=E<lt>fsE<gt>>"
28037 #: ../tools/virt-make-fs.pl:236
28038 msgid "B<-t E<lt>fsE<gt>>"
28042 #: ../tools/virt-make-fs.pl:238
28043 msgid "Choose the output filesystem type."
28047 #: ../tools/virt-make-fs.pl:240
28048 msgid "The default is C<ext2>."
28052 #: ../tools/virt-make-fs.pl:242
28053 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
28057 #: ../tools/virt-make-fs.pl:249
28058 msgid "B<--partition>"
28062 #: ../tools/virt-make-fs.pl:251
28063 msgid "B<--partition=E<lt>parttypeE<gt>>"
28067 #: ../tools/virt-make-fs.pl:253
28069 "If specified, this flag adds an MBR partition table to the output disk "
28074 #: ../tools/virt-make-fs.pl:256
28076 "You can change the partition table type, eg. C<--partition=gpt> for large "
28081 #: ../tools/virt-make-fs.pl:259
28083 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28084 "might consider the next parameter to be the partition type. For example:"
28088 #: ../tools/virt-make-fs.pl:263
28091 " virt-make-fs --partition input.tar ...\n"
28096 #: ../tools/virt-make-fs.pl:265
28098 "would cause virt-make-fs to think you wanted to use a partition type of "
28099 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28100 "dash) between options and the input file argument:"
28104 #: ../tools/virt-make-fs.pl:269
28107 " virt-make-fs --partition -- input.tar ...\n"
28112 #: ../tools/virt-make-fs.pl:536
28114 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28115 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
28116 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28120 #: ../tools/virt-make-fs.pl:553
28123 " export LIBGUESTFS_DEBUG=1\n"
28124 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28129 #: ../tools/virt-make-fs.pl:556
28131 "Attach /tmp/virt-make-fs.log to a new bug report at "
28132 "L<https://bugzilla.redhat.com/>"
28136 #: ../tools/virt-list-partitions.pl:32
28137 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28141 #: ../tools/virt-list-partitions.pl:36
28144 " virt-list-partitions [--options] domname\n"
28149 #: ../tools/virt-list-partitions.pl:38
28152 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28157 #: ../tools/virt-list-partitions.pl:45
28159 "C<virt-list-partitions> is a command line tool to list the partitions that "
28160 "are contained in a virtual machine or disk image. It is mainly useful as a "
28161 "first step to using L<virt-resize(1)>."
28165 #: ../tools/virt-list-partitions.pl:50
28167 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28168 "functionality. For more complex cases you should look at the "
28169 "L<guestfish(1)> tool."
28173 #: ../tools/virt-list-partitions.pl:107
28174 msgid "B<-h> | B<--human-readable>"
28178 #: ../tools/virt-list-partitions.pl:109
28179 msgid "Show sizes in human-readable form (eg. \"1G\")."
28183 #: ../tools/virt-list-partitions.pl:117
28185 "With this option, C<virt-list-partitions> displays the type and size of each "
28186 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28190 #: ../tools/virt-list-partitions.pl:124
28191 msgid "B<-t> | B<--total>"
28195 #: ../tools/virt-list-partitions.pl:126
28196 msgid "Display the total size of each block device (as a separate row or rows)."
28200 #: ../tools/virt-list-partitions.pl:259
28202 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
28203 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
28204 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."