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.13\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-24 20:19+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-df.pl:32 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-rescue.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-df.pl:34 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-rescue.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-df.pl:38 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-rescue.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-df.pl:46 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../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:1999 ../src/guestfs.pod:2005 ../src/guestfs.pod:2010 ../src/guestfs.pod:2016 ../src/guestfs.pod:2128 ../src/guestfs.pod:2132 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../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-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:347 ../tools/virt-resize.pl:352 ../tools/virt-resize.pl:362
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:1842 ../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
3586 msgid "The reply message for ordinary functions is:"
3590 #: ../src/guestfs.pod:1860
3593 " total length (header + ret,\n"
3594 " but not including the length word itself)\n"
3595 " struct guestfs_message_header (encoded as XDR)\n"
3596 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3601 #: ../src/guestfs.pod:1865
3603 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3604 "functions that return no formal return values."
3608 #: ../src/guestfs.pod:1868
3609 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3613 #: ../src/guestfs.pod:1871
3615 "In the case of an error, a flag is set in the header, and the reply message "
3616 "is slightly changed:"
3620 #: ../src/guestfs.pod:1874
3623 " total length (header + error,\n"
3624 " but not including the length word itself)\n"
3625 " struct guestfs_message_header (encoded as XDR)\n"
3626 " struct guestfs_message_error (encoded as XDR)\n"
3631 #: ../src/guestfs.pod:1879
3633 "The C<guestfs_message_error> structure contains the error message as a "
3638 #: ../src/guestfs.pod:1882
3639 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3643 #: ../src/guestfs.pod:1884
3645 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3646 "The normal request message is sent (see above). However this is followed by "
3647 "a sequence of file chunks."
3651 #: ../src/guestfs.pod:1888
3654 " total length (header + arguments,\n"
3655 " but not including the length word itself,\n"
3656 " and not including the chunks)\n"
3657 " struct guestfs_message_header (encoded as XDR)\n"
3658 " struct guestfs_<foo>_args (encoded as XDR)\n"
3659 " sequence of chunks for FileIn param #0\n"
3660 " sequence of chunks for FileIn param #1 etc.\n"
3665 #: ../src/guestfs.pod:1896
3666 msgid "The \"sequence of chunks\" is:"
3670 #: ../src/guestfs.pod:1898
3673 " length of chunk (not including length word itself)\n"
3674 " struct guestfs_chunk (encoded as XDR)\n"
3675 " length of chunk\n"
3676 " struct guestfs_chunk (encoded as XDR)\n"
3678 " length of chunk\n"
3679 " struct guestfs_chunk (with data.data_len == 0)\n"
3684 #: ../src/guestfs.pod:1906
3686 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3687 "is set in the final chunk to indicate either successful completion or early "
3692 #: ../src/guestfs.pod:1910
3694 "At time of writing there are no functions that have more than one FileIn "
3695 "parameter. However this is (theoretically) supported, by sending the "
3696 "sequence of chunks for each FileIn parameter one after another (from left to "
3701 #: ../src/guestfs.pod:1915
3703 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3704 "transfer. The library does this by sending a chunk with a special flag set "
3705 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3706 "RPC, does I<not> send any reply, and goes back to reading the next request."
3710 #: ../src/guestfs.pod:1921
3712 "The daemon may also cancel. It does this by writing a special word "
3713 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3714 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3715 "cancel chunk). The special word is chosen so that even if cancellation "
3716 "happens right at the end of the transfer (after the library has finished "
3717 "writing and has started listening for the reply), the \"spurious\" cancel "
3718 "flag will not be confused with the reply message."
3722 #: ../src/guestfs.pod:1930
3724 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3725 "limit), and also files where the size is not known in advance (eg. from "
3726 "pipes or sockets). However the chunks are rather small "
3727 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3728 "to keep much in memory."
3732 #: ../src/guestfs.pod:1936
3733 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3737 #: ../src/guestfs.pod:1938
3739 "The protocol for FileOut parameters is exactly the same as for FileIn "
3740 "parameters, but with the roles of daemon and library reversed."
3744 #: ../src/guestfs.pod:1941
3747 " total length (header + ret,\n"
3748 " but not including the length word itself,\n"
3749 " and not including the chunks)\n"
3750 " struct guestfs_message_header (encoded as XDR)\n"
3751 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3752 " sequence of chunks for FileOut param #0\n"
3753 " sequence of chunks for FileOut param #1 etc.\n"
3758 #: ../src/guestfs.pod:1949
3759 msgid "INITIAL MESSAGE"
3763 #: ../src/guestfs.pod:1951
3765 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3766 "which indicates that the guest and daemon is alive. This is what "
3767 "L</guestfs_launch> waits for."
3771 #: ../src/guestfs.pod:1955
3772 msgid "PROGRESS NOTIFICATION MESSAGES"
3776 #: ../src/guestfs.pod:1957
3778 "The daemon may send progress notification messages at any time. These are "
3779 "distinguished by the normal length word being replaced by "
3780 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3784 #: ../src/guestfs.pod:1961
3786 "The library turns them into progress callbacks (see "
3787 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3788 "discards them if not."
3792 #: ../src/guestfs.pod:1965
3794 "The daemon self-limits the frequency of progress messages it sends (see "
3795 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3800 #: ../src/guestfs.pod:1969
3801 msgid "LIBGUESTFS VERSION NUMBERS"
3805 #: ../src/guestfs.pod:1971
3807 "Since April 2010, libguestfs has started to make separate development and "
3808 "stable releases, along with corresponding branches in our git repository. "
3809 "These separate releases can be identified by version number:"
3813 #: ../src/guestfs.pod:1976
3816 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3817 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3823 " | `-------- sub-version\n"
3825 " `------ always '1' because we don't change the ABI\n"
3830 #: ../src/guestfs.pod:1987
3831 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3835 #: ../src/guestfs.pod:1989
3837 "As time passes we cherry pick fixes from the development branch and backport "
3838 "those into the stable branch, the effect being that the stable branch should "
3839 "get more stable and less buggy over time. So the stable releases are ideal "
3840 "for people who don't need new features but would just like the software to "
3845 #: ../src/guestfs.pod:1995
3846 msgid "Our criteria for backporting changes are:"
3850 #: ../src/guestfs.pod:2001
3852 "Documentation changes which don't affect any code are backported unless the "
3853 "documentation refers to a future feature which is not in stable."
3857 #: ../src/guestfs.pod:2007
3859 "Bug fixes which are not controversial, fix obvious problems, and have been "
3860 "well tested are backported."
3864 #: ../src/guestfs.pod:2012
3866 "Simple rearrangements of code which shouldn't affect how it works get "
3867 "backported. This is so that the code in the two branches doesn't get too "
3868 "far out of step, allowing us to backport future fixes more easily."
3872 #: ../src/guestfs.pod:2018
3874 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3875 "exceptional case: the new feature is required in order to implement an "
3876 "important bug fix."
3880 #: ../src/guestfs.pod:2024
3882 "A new stable branch starts when we think the new features in development are "
3883 "substantial and compelling enough over the current stable branch to warrant "
3884 "it. When that happens we create new stable and development versions 1.N.0 "
3885 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3886 "stable at this point, but by backporting fixes from development, that branch "
3887 "will stabilize over time."
3891 #: ../src/guestfs.pod:2032 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3892 msgid "ENVIRONMENT VARIABLES"
3896 #: ../src/guestfs.pod:2036 ../fish/guestfish.pod:941
3897 msgid "LIBGUESTFS_APPEND"
3901 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:943
3902 msgid "Pass additional options to the guest kernel."
3906 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:945
3907 msgid "LIBGUESTFS_DEBUG"
3911 #: ../src/guestfs.pod:2042
3913 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3914 "effect as calling C<guestfs_set_verbose (g, 1)>."
3918 #: ../src/guestfs.pod:2045 ../fish/guestfish.pod:950
3919 msgid "LIBGUESTFS_MEMSIZE"
3923 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:952
3924 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3928 #: ../src/guestfs.pod:2050 ../fish/guestfish.pod:955
3931 " LIBGUESTFS_MEMSIZE=700\n"
3936 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:957
3937 msgid "LIBGUESTFS_PATH"
3941 #: ../src/guestfs.pod:2054
3943 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3944 "the discussion of paths in section PATH above."
3948 #: ../src/guestfs.pod:2057 ../fish/guestfish.pod:962
3949 msgid "LIBGUESTFS_QEMU"
3953 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:964
3955 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3956 "which was found at compile time by the configure script is used."
3960 #: ../src/guestfs.pod:2063
3961 msgid "See also L</QEMU WRAPPERS> above."
3965 #: ../src/guestfs.pod:2065 ../fish/guestfish.pod:968
3966 msgid "LIBGUESTFS_TRACE"
3970 #: ../src/guestfs.pod:2067
3972 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3973 "effect as calling C<guestfs_set_trace (g, 1)>."
3977 #: ../src/guestfs.pod:2070 ../fish/guestfish.pod:977
3982 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:979
3983 msgid "Location of temporary directory, defaults to C</tmp>."
3987 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:981
3989 "If libguestfs was compiled to use the supermin appliance then the real "
3990 "appliance is cached in this directory, shared between all handles belonging "
3991 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3992 "use in case C</tmp> is not large enough."
3996 #: ../src/guestfs.pod:2082 ../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-df.pl:640 ../tools/virt-resize.pl:1485 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
4001 #: ../src/guestfs.pod:2084
4003 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4004 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4005 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4006 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4007 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4008 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4009 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4013 #: ../src/guestfs.pod:2107
4015 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4016 "L<lvm(8)>, L<disktype(1)>."
4020 #: ../src/guestfs.pod:2114 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
4025 #: ../src/guestfs.pod:2116
4026 msgid "To get a list of bugs against libguestfs use this link:"
4030 #: ../src/guestfs.pod:2118
4031 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4035 #: ../src/guestfs.pod:2120
4036 msgid "To report a new bug against libguestfs use this link:"
4040 #: ../src/guestfs.pod:2122
4041 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4045 #: ../src/guestfs.pod:2124
4046 msgid "When reporting a bug, please check:"
4050 #: ../src/guestfs.pod:2130
4051 msgid "That the bug hasn't been reported already."
4055 #: ../src/guestfs.pod:2134
4056 msgid "That you are testing a recent version."
4060 #: ../src/guestfs.pod:2138
4061 msgid "Describe the bug accurately, and give a way to reproduce it."
4065 #: ../src/guestfs.pod:2142
4067 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4072 #: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4077 #: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1060 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4078 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4082 #: ../src/guestfs.pod:2151 ../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-df.pl:653 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
4087 #: ../src/guestfs.pod:2153 ../fish/guestfish.pod:1064 ../fuse/guestmount.pod:250
4088 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4092 #: ../src/guestfs.pod:2156
4094 "This library is free software; you can redistribute it and/or modify it "
4095 "under the terms of the GNU Lesser General Public License as published by the "
4096 "Free Software Foundation; either version 2 of the License, or (at your "
4097 "option) any later version."
4101 #: ../src/guestfs.pod:2161
4103 "This library is distributed in the hope that it will be useful, but WITHOUT "
4104 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4105 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4110 #: ../src/guestfs.pod:2166
4112 "You should have received a copy of the GNU Lesser General Public License "
4113 "along with this library; if not, write to the Free Software Foundation, "
4114 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4118 #: ../src/guestfs-actions.pod:1
4119 msgid "guestfs_add_cdrom"
4123 #: ../src/guestfs-actions.pod:3
4127 " guestfs_add_cdrom (guestfs_h *g,\n"
4128 " const char *filename);\n"
4133 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4134 msgid "This function adds a virtual CD-ROM disk image to the guest."
4138 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4139 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4143 #: ../src/guestfs-actions.pod:17
4145 "This call checks for the existence of C<filename>. This stops you from "
4146 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4147 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4152 #: ../src/guestfs-actions.pod:24
4154 "If you just want to add an ISO file (often you use this as an efficient way "
4155 "to transfer large files into the guest), then you should probably use "
4156 "C<guestfs_add_drive_ro> instead."
4160 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786 ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452 ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247 ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299 ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406 ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487 ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523 ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648 ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096 ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204 ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4161 msgid "This function returns 0 on success or -1 on error."
4165 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4167 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4172 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990 ../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:4549 ../fish/guestfish-actions.pod:4646
4174 "Deprecated functions will not be removed from the API, but the fact that "
4175 "they are deprecated indicates that there are problems with correct use of "
4180 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635 ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6735
4181 msgid "(Added in 0.3)"
4185 #: ../src/guestfs-actions.pod:41
4186 msgid "guestfs_add_domain"
4190 #: ../src/guestfs-actions.pod:43
4194 " guestfs_add_domain (guestfs_h *g,\n"
4195 " const char *dom,\n"
4201 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4203 "You may supply a list of optional arguments to this call. Use zero or more "
4204 "of the following pairs of parameters, and terminate the list with C<-1> on "
4205 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4209 #: ../src/guestfs-actions.pod:53
4212 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4213 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4214 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4219 #: ../src/guestfs-actions.pod:57
4221 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4222 "It works by connecting to libvirt, requesting the domain and domain XML from "
4223 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4228 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4230 "The number of disks added is returned. This operation is atomic: if an "
4231 "error is returned, then no disks are added."
4235 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4237 "This function does some minimal checks to make sure the libvirt domain is "
4238 "not running (unless C<readonly> is true). In a future version we will try "
4239 "to acquire the libvirt lock on each disk."
4243 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4245 "Disks must be accessible locally. This often means that adding disks from a "
4246 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4247 "unless those disks are accessible via the same device path locally too."
4251 #: ../src/guestfs-actions.pod:74
4253 "The optional C<libvirturi> parameter sets the libvirt URI (see "
4254 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
4255 "default libvirt URI (or one set through an environment variable, see the "
4256 "libvirt documentation for full details). If you are using the C API "
4257 "directly then it is more flexible to create the libvirt connection object "
4258 "yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
4262 #: ../src/guestfs-actions.pod:82
4264 "The other optional parameters are passed directly through to "
4265 "C<guestfs_add_drive_opts>."
4269 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009 ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759 ../src/guestfs-actions.pod:6772
4270 msgid "On error this function returns -1."
4274 #: ../src/guestfs-actions.pod:87
4275 msgid "guestfs_add_domain_va"
4279 #: ../src/guestfs-actions.pod:89
4283 " guestfs_add_domain_va (guestfs_h *g,\n"
4284 " const char *dom,\n"
4290 #: ../src/guestfs-actions.pod:94
4291 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4295 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4296 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4300 #: ../src/guestfs-actions.pod:98
4301 msgid "guestfs_add_domain_argv"
4305 #: ../src/guestfs-actions.pod:100
4309 " guestfs_add_domain_argv (guestfs_h *g,\n"
4310 " const char *dom,\n"
4311 " const struct guestfs_add_domain_argv *optargs);\n"
4316 #: ../src/guestfs-actions.pod:105
4317 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4321 #: ../src/guestfs-actions.pod:109
4322 msgid "guestfs_add_drive"
4326 #: ../src/guestfs-actions.pod:111
4330 " guestfs_add_drive (guestfs_h *g,\n"
4331 " const char *filename);\n"
4336 #: ../src/guestfs-actions.pod:115
4338 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4339 "optional parameters, so the disk is added writable, with the format being "
4340 "detected automatically."
4344 #: ../src/guestfs-actions.pod:119
4346 "Automatic detection of the format opens you up to a potential security hole "
4347 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4348 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4349 "you should think about replacing calls to this function with calls to "
4350 "C<guestfs_add_drive_opts>, and specifying the format."
4354 #: ../src/guestfs-actions.pod:130
4355 msgid "guestfs_add_drive_opts"
4359 #: ../src/guestfs-actions.pod:132
4363 " guestfs_add_drive_opts (guestfs_h *g,\n"
4364 " const char *filename,\n"
4370 #: ../src/guestfs-actions.pod:142
4373 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4374 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4375 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4380 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4382 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4383 "The first time you call this function, the disk appears as C</dev/sda>, the "
4384 "second time as C</dev/sdb>, and so on."
4388 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4390 "You don't necessarily need to be root when using libguestfs. However you "
4391 "obviously do need sufficient permissions to access the filename for whatever "
4392 "operations you want to perform (ie. read access if you just want to read the "
4393 "image or write access if you want to modify the image)."
4397 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4398 msgid "This call checks that C<filename> exists."
4402 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4403 msgid "The optional arguments are:"
4407 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4412 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4414 "If true then the image is treated as read-only. Writes are still allowed, "
4415 "but they are stored in a temporary snapshot overlay which is discarded at "
4416 "the end. The disk that you add is not modified."
4420 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4425 #: ../src/guestfs-actions.pod:171
4427 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4428 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4429 "Possible formats include C<raw> and C<qcow2>."
4433 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4435 "Automatic detection of the format opens you up to a potential security hole "
4436 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4437 "RHBZ#642934. Specifying the format closes this security hole."
4441 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4446 #: ../src/guestfs-actions.pod:182
4448 "This rarely-used option lets you emulate the behaviour of the deprecated "
4449 "C<guestfs_add_drive_with_if> call (q.v.)"
4453 #: ../src/guestfs-actions.pod:189
4454 msgid "(Added in 1.5.23)"
4458 #: ../src/guestfs-actions.pod:191
4459 msgid "guestfs_add_drive_opts_va"
4463 #: ../src/guestfs-actions.pod:193
4467 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4468 " const char *filename,\n"
4474 #: ../src/guestfs-actions.pod:198
4475 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4479 #: ../src/guestfs-actions.pod:202
4480 msgid "guestfs_add_drive_opts_argv"
4484 #: ../src/guestfs-actions.pod:204
4488 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4489 " const char *filename,\n"
4490 " const struct guestfs_add_drive_opts_argv "
4496 #: ../src/guestfs-actions.pod:209
4497 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4501 #: ../src/guestfs-actions.pod:213
4502 msgid "guestfs_add_drive_ro"
4506 #: ../src/guestfs-actions.pod:215
4510 " guestfs_add_drive_ro (guestfs_h *g,\n"
4511 " const char *filename);\n"
4516 #: ../src/guestfs-actions.pod:219
4518 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4519 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4520 "disk is added read-only, with the format being detected automatically."
4524 #: ../src/guestfs-actions.pod:226
4525 msgid "(Added in 1.0.38)"
4529 #: ../src/guestfs-actions.pod:228
4530 msgid "guestfs_add_drive_ro_with_if"
4534 #: ../src/guestfs-actions.pod:230
4538 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4539 " const char *filename,\n"
4540 " const char *iface);\n"
4545 #: ../src/guestfs-actions.pod:235
4547 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4548 "QEMU interface emulation to use at run time."
4552 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2303
4553 msgid "(Added in 1.0.84)"
4557 #: ../src/guestfs-actions.pod:249
4558 msgid "guestfs_add_drive_with_if"
4562 #: ../src/guestfs-actions.pod:251
4566 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4567 " const char *filename,\n"
4568 " const char *iface);\n"
4573 #: ../src/guestfs-actions.pod:256
4575 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4576 "QEMU interface emulation to use at run time."
4580 #: ../src/guestfs-actions.pod:270
4581 msgid "guestfs_aug_clear"
4585 #: ../src/guestfs-actions.pod:272
4589 " guestfs_aug_clear (guestfs_h *g,\n"
4590 " const char *augpath);\n"
4595 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4597 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4598 "L<augtool(1)> C<clear> command."
4602 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4603 msgid "(Added in 1.3.4)"
4607 #: ../src/guestfs-actions.pod:283
4608 msgid "guestfs_aug_close"
4612 #: ../src/guestfs-actions.pod:285
4616 " guestfs_aug_close (guestfs_h *g);\n"
4621 #: ../src/guestfs-actions.pod:288
4623 "Close the current Augeas handle and free up any resources used by it. After "
4624 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4625 "any other Augeas functions."
4629 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:5086
4630 msgid "(Added in 0.7)"
4634 #: ../src/guestfs-actions.pod:297
4635 msgid "guestfs_aug_defnode"
4639 #: ../src/guestfs-actions.pod:299
4642 " struct guestfs_int_bool *\n"
4643 " guestfs_aug_defnode (guestfs_h *g,\n"
4644 " const char *name,\n"
4645 " const char *expr,\n"
4646 " const char *val);\n"
4651 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4652 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4656 #: ../src/guestfs-actions.pod:308
4658 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4659 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4660 "containing that single node."
4664 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4666 "On success this returns a pair containing the number of nodes in the "
4667 "nodeset, and a boolean flag if a node was created."
4671 #: ../src/guestfs-actions.pod:316
4673 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4674 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4678 #: ../src/guestfs-actions.pod:322
4679 msgid "guestfs_aug_defvar"
4683 #: ../src/guestfs-actions.pod:324
4687 " guestfs_aug_defvar (guestfs_h *g,\n"
4688 " const char *name,\n"
4689 " const char *expr);\n"
4694 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4696 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4697 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4701 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4703 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4704 "evaluates to something which is not a nodeset."
4708 #: ../src/guestfs-actions.pod:340
4709 msgid "guestfs_aug_get"
4713 #: ../src/guestfs-actions.pod:342
4717 " guestfs_aug_get (guestfs_h *g,\n"
4718 " const char *augpath);\n"
4723 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4725 "Look up the value associated with C<path>. If C<path> matches exactly one "
4726 "node, the C<value> is returned."
4730 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495 ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532 ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4732 "This function returns a string, or NULL on error. I<The caller must free "
4733 "the returned string after use>."
4737 #: ../src/guestfs-actions.pod:354
4738 msgid "guestfs_aug_init"
4742 #: ../src/guestfs-actions.pod:356
4746 " guestfs_aug_init (guestfs_h *g,\n"
4747 " const char *root,\n"
4753 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4755 "Create a new Augeas handle for editing configuration files. If there was "
4756 "any previous Augeas handle associated with this guestfs session, then it is "
4761 #: ../src/guestfs-actions.pod:365
4762 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4766 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4767 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4771 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4773 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4774 "logical I<or> of the following integers:"
4778 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
4779 msgid "C<AUG_SAVE_BACKUP> = 1"
4783 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
4784 msgid "Keep the original file with a C<.augsave> extension."
4788 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
4789 msgid "C<AUG_SAVE_NEWFILE> = 2"
4793 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
4795 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4796 "original. Overrides C<AUG_SAVE_BACKUP>."
4800 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
4801 msgid "C<AUG_TYPE_CHECK> = 4"
4805 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
4806 msgid "Typecheck lenses (can be expensive)."
4810 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
4811 msgid "C<AUG_NO_STDINC> = 8"
4815 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
4816 msgid "Do not use standard load path for modules."
4820 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
4821 msgid "C<AUG_SAVE_NOOP> = 16"
4825 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
4826 msgid "Make save a no-op, just record what would have been changed."
4830 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
4831 msgid "C<AUG_NO_LOAD> = 32"
4835 #: ../src/guestfs-actions.pod:400
4836 msgid "Do not load the tree in C<guestfs_aug_init>."
4840 #: ../src/guestfs-actions.pod:404
4841 msgid "To close the handle, you can call C<guestfs_aug_close>."
4845 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
4846 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4850 #: ../src/guestfs-actions.pod:412
4851 msgid "guestfs_aug_insert"
4855 #: ../src/guestfs-actions.pod:414
4859 " guestfs_aug_insert (guestfs_h *g,\n"
4860 " const char *augpath,\n"
4861 " const char *label,\n"
4867 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
4869 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4870 "or after C<path> (depending on the boolean flag C<before>)."
4874 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
4876 "C<path> must match exactly one existing node in the tree, and C<label> must "
4877 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4881 #: ../src/guestfs-actions.pod:432
4882 msgid "guestfs_aug_load"
4886 #: ../src/guestfs-actions.pod:434
4890 " guestfs_aug_load (guestfs_h *g);\n"
4895 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
4896 msgid "Load files into the tree."
4900 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
4901 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4905 #: ../src/guestfs-actions.pod:446
4906 msgid "guestfs_aug_ls"
4910 #: ../src/guestfs-actions.pod:448
4914 " guestfs_aug_ls (guestfs_h *g,\n"
4915 " const char *augpath);\n"
4920 #: ../src/guestfs-actions.pod:452
4922 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4923 "sorting the resulting nodes into alphabetical order."
4927 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248 ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133 ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837 ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006 ../src/guestfs-actions.pod:7025
4929 "This function returns a NULL-terminated array of strings (like "
4930 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4931 "strings and the array after use>."
4935 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931 ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347 ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
4936 msgid "(Added in 0.8)"
4940 #: ../src/guestfs-actions.pod:461
4941 msgid "guestfs_aug_match"
4945 #: ../src/guestfs-actions.pod:463
4949 " guestfs_aug_match (guestfs_h *g,\n"
4950 " const char *augpath);\n"
4955 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
4957 "Returns a list of paths which match the path expression C<path>. The "
4958 "returned paths are sufficiently qualified so that they match exactly one "
4959 "node in the current tree."
4963 #: ../src/guestfs-actions.pod:477
4964 msgid "guestfs_aug_mv"
4968 #: ../src/guestfs-actions.pod:479
4972 " guestfs_aug_mv (guestfs_h *g,\n"
4973 " const char *src,\n"
4974 " const char *dest);\n"
4979 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
4981 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4982 "C<dest> is overwritten if it exists."
4986 #: ../src/guestfs-actions.pod:491
4987 msgid "guestfs_aug_rm"
4991 #: ../src/guestfs-actions.pod:493
4995 " guestfs_aug_rm (guestfs_h *g,\n"
4996 " const char *augpath);\n"
5001 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5002 msgid "Remove C<path> and all of its children."
5006 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5007 msgid "On success this returns the number of entries which were removed."
5011 #: ../src/guestfs-actions.pod:505
5012 msgid "guestfs_aug_save"
5016 #: ../src/guestfs-actions.pod:507
5020 " guestfs_aug_save (guestfs_h *g);\n"
5025 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5026 msgid "This writes all pending changes to disk."
5030 #: ../src/guestfs-actions.pod:512
5032 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5037 #: ../src/guestfs-actions.pod:519
5038 msgid "guestfs_aug_set"
5042 #: ../src/guestfs-actions.pod:521
5046 " guestfs_aug_set (guestfs_h *g,\n"
5047 " const char *augpath,\n"
5048 " const char *val);\n"
5053 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5054 msgid "Set the value associated with C<path> to C<val>."
5058 #: ../src/guestfs-actions.pod:528
5060 "In the Augeas API, it is possible to clear a node by setting the value to "
5061 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5062 "this call. Instead you must use the C<guestfs_aug_clear> call."
5066 #: ../src/guestfs-actions.pod:537
5067 msgid "guestfs_available"
5071 #: ../src/guestfs-actions.pod:539
5075 " guestfs_available (guestfs_h *g,\n"
5076 " char *const *groups);\n"
5081 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5083 "This command is used to check the availability of some groups of "
5084 "functionality in the appliance, which not all builds of the libguestfs "
5085 "appliance will be able to provide."
5089 #: ../src/guestfs-actions.pod:547
5091 "The libguestfs groups, and the functions that those groups correspond to, "
5092 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5093 "runtime by calling C<guestfs_available_all_groups>."
5097 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5099 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5100 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5101 "and Augeas (configuration file editing) functions."
5105 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5106 msgid "The command returns no error if I<all> requested groups are available."
5110 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5112 "It fails with an error if one or more of the requested groups is unavailable "
5117 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5119 "If an unknown group name is included in the list of groups then an error is "
5124 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5129 #: ../src/guestfs-actions.pod:571
5130 msgid "You must call C<guestfs_launch> before calling this function."
5134 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5136 "The reason is because we don't know what groups are supported by the "
5137 "appliance/daemon until it is running and can be queried."
5141 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5143 "If a group of functions is available, this does not necessarily mean that "
5144 "they will work. You still have to check for errors when calling individual "
5145 "API functions even if they are available."
5149 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5151 "It is usually the job of distro packagers to build complete functionality "
5152 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5153 "with all requirements satisfied, will support everything."
5157 #: ../src/guestfs-actions.pod:593
5159 "This call was added in version C<1.0.80>. In previous versions of "
5160 "libguestfs all you could do would be to speculatively execute a command to "
5161 "find out if the daemon implemented it. See also C<guestfs_version>."
5165 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5166 msgid "(Added in 1.0.80)"
5170 #: ../src/guestfs-actions.pod:604
5171 msgid "guestfs_available_all_groups"
5175 #: ../src/guestfs-actions.pod:606
5179 " guestfs_available_all_groups (guestfs_h *g);\n"
5184 #: ../src/guestfs-actions.pod:609
5186 "This command returns a list of all optional groups that this daemon knows "
5187 "about. Note this returns both supported and unsupported groups. To find "
5188 "out which ones the daemon can actually support you have to call "
5189 "C<guestfs_available> on each member of the returned list."
5193 #: ../src/guestfs-actions.pod:615
5194 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5198 #: ../src/guestfs-actions.pod:621
5199 msgid "(Added in 1.3.15)"
5203 #: ../src/guestfs-actions.pod:623
5204 msgid "guestfs_base64_in"
5208 #: ../src/guestfs-actions.pod:625
5212 " guestfs_base64_in (guestfs_h *g,\n"
5213 " const char *base64file,\n"
5214 " const char *filename);\n"
5219 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5220 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
5224 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5225 msgid "(Added in 1.3.5)"
5229 #: ../src/guestfs-actions.pod:637
5230 msgid "guestfs_base64_out"
5234 #: ../src/guestfs-actions.pod:639
5238 " guestfs_base64_out (guestfs_h *g,\n"
5239 " const char *filename,\n"
5240 " const char *base64file);\n"
5245 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5247 "This command downloads the contents of C<filename>, writing it out to local "
5248 "file C<base64file> encoded as base64."
5252 #: ../src/guestfs-actions.pod:651
5253 msgid "guestfs_blockdev_flushbufs"
5257 #: ../src/guestfs-actions.pod:653
5261 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5262 " const char *device);\n"
5267 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5268 msgid "This tells the kernel to flush internal buffers associated with C<device>."
5272 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../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
5273 msgid "This uses the L<blockdev(8)> command."
5277 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5278 msgid "(Added in 0.9.3)"
5282 #: ../src/guestfs-actions.pod:666
5283 msgid "guestfs_blockdev_getbsz"
5287 #: ../src/guestfs-actions.pod:668
5291 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5292 " const char *device);\n"
5297 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5298 msgid "This returns the block size of a device."
5302 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5304 "(Note this is different from both I<size in blocks> and I<filesystem block "
5309 #: ../src/guestfs-actions.pod:683
5310 msgid "guestfs_blockdev_getro"
5314 #: ../src/guestfs-actions.pod:685
5318 " guestfs_blockdev_getro (guestfs_h *g,\n"
5319 " const char *device);\n"
5324 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5326 "Returns a boolean indicating if the block device is read-only (true if "
5327 "read-only, false if not)."
5331 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171 ../src/guestfs-actions.pod:4585
5332 msgid "This function returns a C truth value on success or -1 on error."
5336 #: ../src/guestfs-actions.pod:698
5337 msgid "guestfs_blockdev_getsize64"
5341 #: ../src/guestfs-actions.pod:700
5345 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5346 " const char *device);\n"
5351 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5352 msgid "This returns the size of the device in bytes."
5356 #: ../src/guestfs-actions.pod:706
5357 msgid "See also C<guestfs_blockdev_getsz>."
5361 #: ../src/guestfs-actions.pod:714
5362 msgid "guestfs_blockdev_getss"
5366 #: ../src/guestfs-actions.pod:716
5370 " guestfs_blockdev_getss (guestfs_h *g,\n"
5371 " const char *device);\n"
5376 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5378 "This returns the size of sectors on a block device. Usually 512, but can be "
5379 "larger for modern devices."
5383 #: ../src/guestfs-actions.pod:723
5385 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5390 #: ../src/guestfs-actions.pod:732
5391 msgid "guestfs_blockdev_getsz"
5395 #: ../src/guestfs-actions.pod:734
5399 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5400 " const char *device);\n"
5405 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5407 "This returns the size of the device in units of 512-byte sectors (even if "
5408 "the sectorsize isn't 512 bytes ... weird)."
5412 #: ../src/guestfs-actions.pod:741
5414 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5415 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5419 #: ../src/guestfs-actions.pod:751
5420 msgid "guestfs_blockdev_rereadpt"
5424 #: ../src/guestfs-actions.pod:753
5428 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5429 " const char *device);\n"
5434 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5435 msgid "Reread the partition table on C<device>."
5439 #: ../src/guestfs-actions.pod:765
5440 msgid "guestfs_blockdev_setbsz"
5444 #: ../src/guestfs-actions.pod:767
5448 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5449 " const char *device,\n"
5450 " int blocksize);\n"
5455 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5456 msgid "This sets the block size of a device."
5460 #: ../src/guestfs-actions.pod:783
5461 msgid "guestfs_blockdev_setro"
5465 #: ../src/guestfs-actions.pod:785
5469 " guestfs_blockdev_setro (guestfs_h *g,\n"
5470 " const char *device);\n"
5475 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5476 msgid "Sets the block device named C<device> to read-only."
5480 #: ../src/guestfs-actions.pod:797
5481 msgid "guestfs_blockdev_setrw"
5485 #: ../src/guestfs-actions.pod:799
5489 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5490 " const char *device);\n"
5495 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5496 msgid "Sets the block device named C<device> to read-write."
5500 #: ../src/guestfs-actions.pod:811
5501 msgid "guestfs_case_sensitive_path"
5505 #: ../src/guestfs-actions.pod:813
5509 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5510 " const char *path);\n"
5515 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5517 "This can be used to resolve case insensitive paths on a filesystem which is "
5518 "case sensitive. The use case is to resolve paths which you have read from "
5519 "Windows configuration files or the Windows Registry, to the true path."
5523 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5525 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5526 "(and probably others), which is that although the underlying filesystem is "
5527 "case-insensitive, the driver exports the filesystem to Linux as "
5532 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5534 "One consequence of this is that special directories such as C<c:\\windows> "
5535 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5536 "precise details of how they were created. In Windows itself this would not "
5541 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5543 "Bug or feature? You decide: "
5544 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5548 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5550 "This function resolves the true case of each element in the path and returns "
5551 "the case-sensitive path."
5555 #: ../src/guestfs-actions.pod:839
5557 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5558 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5559 "how the directories were originally created under Windows)."
5563 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5564 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5568 #: ../src/guestfs-actions.pod:847
5569 msgid "See also C<guestfs_realpath>."
5573 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5574 msgid "(Added in 1.0.75)"
5578 #: ../src/guestfs-actions.pod:854
5583 #: ../src/guestfs-actions.pod:856
5587 " guestfs_cat (guestfs_h *g,\n"
5588 " const char *path);\n"
5593 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5594 msgid "Return the contents of the file named C<path>."
5598 #: ../src/guestfs-actions.pod:862
5600 "Note that this function cannot correctly handle binary files (specifically, "
5601 "files containing C<\\0> character which is treated as end of string). For "
5602 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5603 "functions which have a more complex interface."
5607 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254 ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880 ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841 ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945 ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7029 ../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:3263 ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354 ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386 ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115 ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543 ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628 ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5609 "Because of the message protocol, there is a transfer limit of somewhere "
5610 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5614 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331 ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6690
5615 msgid "(Added in 0.4)"
5619 #: ../src/guestfs-actions.pod:875
5620 msgid "guestfs_checksum"
5624 #: ../src/guestfs-actions.pod:877
5628 " guestfs_checksum (guestfs_h *g,\n"
5629 " const char *csumtype,\n"
5630 " const char *path);\n"
5635 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5636 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5640 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5642 "The type of checksum to compute is given by the C<csumtype> parameter which "
5643 "must have one of the following values:"
5647 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5652 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5654 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5659 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5664 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5665 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5669 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5674 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5675 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5679 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
5684 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
5685 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5689 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
5694 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
5695 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5699 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
5704 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
5705 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5709 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
5714 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
5715 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5719 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
5720 msgid "The checksum is returned as a printable string."
5724 #: ../src/guestfs-actions.pod:923
5725 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5729 #: ../src/guestfs-actions.pod:925
5730 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5734 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
5735 msgid "(Added in 1.0.2)"
5739 #: ../src/guestfs-actions.pod:932
5740 msgid "guestfs_checksum_device"
5744 #: ../src/guestfs-actions.pod:934
5748 " guestfs_checksum_device (guestfs_h *g,\n"
5749 " const char *csumtype,\n"
5750 " const char *device);\n"
5755 #: ../src/guestfs-actions.pod:939
5757 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5758 "device named C<device>. For the types of checksums supported see the "
5759 "C<guestfs_checksum> command."
5763 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6702
5764 msgid "(Added in 1.3.2)"
5768 #: ../src/guestfs-actions.pod:948
5769 msgid "guestfs_checksums_out"
5773 #: ../src/guestfs-actions.pod:950
5777 " guestfs_checksums_out (guestfs_h *g,\n"
5778 " const char *csumtype,\n"
5779 " const char *directory,\n"
5780 " const char *sumsfile);\n"
5785 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
5787 "This command computes the checksums of all regular files in C<directory> and "
5788 "then emits a list of those checksums to the local output file C<sumsfile>."
5792 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
5794 "This can be used for verifying the integrity of a virtual machine. However "
5795 "to be properly secure you should pay attention to the output of the checksum "
5796 "command (it uses the ones from GNU coreutils). In particular when the "
5797 "filename is not printable, coreutils uses a special backslash syntax. For "
5798 "more information, see the GNU coreutils info file."
5802 #: ../src/guestfs-actions.pod:970
5803 msgid "(Added in 1.3.7)"
5807 #: ../src/guestfs-actions.pod:972
5808 msgid "guestfs_chmod"
5812 #: ../src/guestfs-actions.pod:974
5816 " guestfs_chmod (guestfs_h *g,\n"
5818 " const char *path);\n"
5823 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
5825 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5830 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
5832 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5833 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5838 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209 ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838 ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
5839 msgid "The mode actually set is affected by the umask."
5843 #: ../src/guestfs-actions.pod:992
5844 msgid "guestfs_chown"
5848 #: ../src/guestfs-actions.pod:994
5852 " guestfs_chown (guestfs_h *g,\n"
5855 " const char *path);\n"
5860 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
5861 msgid "Change the file owner to C<owner> and group to C<group>."
5865 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
5867 "Only numeric uid and gid are supported. If you want to use names, you will "
5868 "need to locate and parse the password file yourself (Augeas support makes "
5869 "this relatively easy)."
5873 #: ../src/guestfs-actions.pod:1010
5874 msgid "guestfs_command"
5878 #: ../src/guestfs-actions.pod:1012
5882 " guestfs_command (guestfs_h *g,\n"
5883 " char *const *arguments);\n"
5888 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
5890 "This call runs a command from the guest filesystem. The filesystem must be "
5891 "mounted, and must contain a compatible operating system (ie. something "
5892 "Linux, with the same or compatible processor architecture)."
5896 #: ../src/guestfs-actions.pod:1021
5898 "The single parameter is an argv-style list of arguments. The first element "
5899 "is the name of the program to run. Subsequent elements are parameters. The "
5900 "list must be non-empty (ie. must contain a program name). Note that the "
5901 "command runs directly, and is I<not> invoked via the shell (see "
5906 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
5907 msgid "The return value is anything printed to I<stdout> by the command."
5911 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
5913 "If the command returns a non-zero exit status, then this function returns an "
5914 "error message. The error message string is the content of I<stderr> from "
5919 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
5921 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5922 "C</bin>. If you require a program from another location, you should provide "
5923 "the full path in the first parameter."
5927 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
5929 "Shared libraries and data files required by the program must be available on "
5930 "filesystems which are mounted in the correct places. It is the caller's "
5931 "responsibility to ensure all filesystems that are needed are mounted at the "
5936 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
5937 msgid "(Added in 0.9.1)"
5941 #: ../src/guestfs-actions.pod:1054
5942 msgid "guestfs_command_lines"
5946 #: ../src/guestfs-actions.pod:1056
5950 " guestfs_command_lines (guestfs_h *g,\n"
5951 " char *const *arguments);\n"
5956 #: ../src/guestfs-actions.pod:1060
5958 "This is the same as C<guestfs_command>, but splits the result into a list of "
5963 #: ../src/guestfs-actions.pod:1063
5964 msgid "See also: C<guestfs_sh_lines>"
5968 #: ../src/guestfs-actions.pod:1074
5969 msgid "guestfs_config"
5973 #: ../src/guestfs-actions.pod:1076
5977 " guestfs_config (guestfs_h *g,\n"
5978 " const char *qemuparam,\n"
5979 " const char *qemuvalue);\n"
5984 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
5986 "This can be used to add arbitrary qemu command line parameters of the form "
5987 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5988 "setting some parameters which would interfere with parameters that we use."
5992 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
5993 msgid "The first character of C<param> string must be a C<-> (dash)."
5997 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
5998 msgid "C<value> can be NULL."
6002 #: ../src/guestfs-actions.pod:1094
6003 msgid "guestfs_copy_size"
6007 #: ../src/guestfs-actions.pod:1096
6011 " guestfs_copy_size (guestfs_h *g,\n"
6012 " const char *src,\n"
6013 " const char *dest,\n"
6019 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6021 "This command copies exactly C<size> bytes from one source device or file "
6022 "C<src> to another destination device or file C<dest>."
6026 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6028 "Note this will fail if the source is too short or if the destination is not "
6033 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:6900
6035 "This long-running command can generate progress notification messages so "
6036 "that the caller can display a progress bar or indicator. To receive these "
6037 "messages, the caller must register a progress callback. See "
6038 "L<guestfs(3)/guestfs_set_progress_callback>."
6042 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6043 msgid "(Added in 1.0.87)"
6047 #: ../src/guestfs-actions.pod:1117
6052 #: ../src/guestfs-actions.pod:1119
6056 " guestfs_cp (guestfs_h *g,\n"
6057 " const char *src,\n"
6058 " const char *dest);\n"
6063 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6065 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6066 "destination filename or destination directory."
6070 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454 ../src/guestfs-actions.pod:4831
6071 msgid "(Added in 1.0.18)"
6075 #: ../src/guestfs-actions.pod:1131
6076 msgid "guestfs_cp_a"
6080 #: ../src/guestfs-actions.pod:1133
6084 " guestfs_cp_a (guestfs_h *g,\n"
6085 " const char *src,\n"
6086 " const char *dest);\n"
6091 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6093 "This copies a file or directory from C<src> to C<dest> recursively using the "
6098 #: ../src/guestfs-actions.pod:1145
6103 #: ../src/guestfs-actions.pod:1147
6107 " guestfs_dd (guestfs_h *g,\n"
6108 " const char *src,\n"
6109 " const char *dest);\n"
6114 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6116 "This command copies from one source device or file C<src> to another "
6117 "destination device or file C<dest>. Normally you would use this to copy to "
6118 "or from a device or partition, for example to duplicate a filesystem."
6122 #: ../src/guestfs-actions.pod:1157
6124 "If the destination is a device, it must be as large or larger than the "
6125 "source file or device, otherwise the copy will fail. This command cannot do "
6126 "partial copies (see C<guestfs_copy_size>)."
6130 #: ../src/guestfs-actions.pod:1165
6135 #: ../src/guestfs-actions.pod:1167
6139 " guestfs_df (guestfs_h *g);\n"
6144 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6145 msgid "This command runs the C<df> command to report disk space used."
6149 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6151 "This command is mostly useful for interactive sessions. It is I<not> "
6152 "intended that you try to parse the output string. Use C<statvfs> from "
6157 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6774
6158 msgid "(Added in 1.0.54)"
6162 #: ../src/guestfs-actions.pod:1181
6163 msgid "guestfs_df_h"
6167 #: ../src/guestfs-actions.pod:1183
6171 " guestfs_df_h (guestfs_h *g);\n"
6176 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6178 "This command runs the C<df -h> command to report disk space used in "
6179 "human-readable format."
6183 #: ../src/guestfs-actions.pod:1198
6184 msgid "guestfs_dmesg"
6188 #: ../src/guestfs-actions.pod:1200
6192 " guestfs_dmesg (guestfs_h *g);\n"
6197 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6199 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6200 "This is sometimes useful for extended debugging of problems."
6204 #: ../src/guestfs-actions.pod:1207
6206 "Another way to get the same information is to enable verbose messages with "
6207 "C<guestfs_set_verbose> or by setting the environment variable "
6208 "C<LIBGUESTFS_DEBUG=1> before running the program."
6212 #: ../src/guestfs-actions.pod:1217
6213 msgid "guestfs_download"
6217 #: ../src/guestfs-actions.pod:1219
6221 " guestfs_download (guestfs_h *g,\n"
6222 " const char *remotefilename,\n"
6223 " const char *filename);\n"
6228 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6230 "Download file C<remotefilename> and save it as C<filename> on the local "
6235 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6236 msgid "C<filename> can also be a named pipe."
6240 #: ../src/guestfs-actions.pod:1229
6241 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6245 #: ../src/guestfs-actions.pod:1240
6246 msgid "guestfs_download_offset"
6250 #: ../src/guestfs-actions.pod:1242
6254 " guestfs_download_offset (guestfs_h *g,\n"
6255 " const char *remotefilename,\n"
6256 " const char *filename,\n"
6257 " int64_t offset,\n"
6263 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6265 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6266 "region must be within the file or device)."
6270 #: ../src/guestfs-actions.pod:1255
6272 "Note that there is no limit on the amount of data that can be downloaded "
6273 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6274 "full amount unless an error occurs."
6278 #: ../src/guestfs-actions.pod:1260
6279 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6283 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6284 msgid "(Added in 1.5.17)"
6288 #: ../src/guestfs-actions.pod:1271
6289 msgid "guestfs_drop_caches"
6293 #: ../src/guestfs-actions.pod:1273
6297 " guestfs_drop_caches (guestfs_h *g,\n"
6298 " int whattodrop);\n"
6303 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6305 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6306 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6307 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6311 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6312 msgid "Setting C<whattodrop> to 3 should drop everything."
6316 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6318 "This automatically calls L<sync(2)> before the operation, so that the "
6319 "maximum guest memory is freed."
6323 #: ../src/guestfs-actions.pod:1291
6328 #: ../src/guestfs-actions.pod:1293
6332 " guestfs_du (guestfs_h *g,\n"
6333 " const char *path);\n"
6338 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6340 "This command runs the C<du -s> command to estimate file space usage for "
6345 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6347 "C<path> can be a file or a directory. If C<path> is a directory then the "
6348 "estimate includes the contents of the directory and all subdirectories "
6353 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6354 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6358 #: ../src/guestfs-actions.pod:1311
6359 msgid "guestfs_e2fsck_f"
6363 #: ../src/guestfs-actions.pod:1313
6367 " guestfs_e2fsck_f (guestfs_h *g,\n"
6368 " const char *device);\n"
6373 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6375 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6376 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6381 #: ../src/guestfs-actions.pod:1321
6383 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6384 "Normally you should use C<guestfs_fsck>."
6388 #: ../src/guestfs-actions.pod:1326
6389 msgid "(Added in 1.0.29)"
6393 #: ../src/guestfs-actions.pod:1328
6394 msgid "guestfs_echo_daemon"
6398 #: ../src/guestfs-actions.pod:1330
6402 " guestfs_echo_daemon (guestfs_h *g,\n"
6403 " char *const *words);\n"
6408 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6410 "This command concatenates the list of C<words> passed with single spaces "
6411 "between them and returns the resulting string."
6415 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6416 msgid "You can use this command to test the connection through to the daemon."
6420 #: ../src/guestfs-actions.pod:1339
6421 msgid "See also C<guestfs_ping_daemon>."
6425 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5620
6426 msgid "(Added in 1.0.69)"
6430 #: ../src/guestfs-actions.pod:1346
6431 msgid "guestfs_egrep"
6435 #: ../src/guestfs-actions.pod:1348
6439 " guestfs_egrep (guestfs_h *g,\n"
6440 " const char *regex,\n"
6441 " const char *path);\n"
6446 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6447 msgid "This calls the external C<egrep> program and returns the matching lines."
6451 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996 ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022 ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6452 msgid "(Added in 1.0.66)"
6456 #: ../src/guestfs-actions.pod:1365
6457 msgid "guestfs_egrepi"
6461 #: ../src/guestfs-actions.pod:1367
6465 " guestfs_egrepi (guestfs_h *g,\n"
6466 " const char *regex,\n"
6467 " const char *path);\n"
6472 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6473 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6477 #: ../src/guestfs-actions.pod:1384
6478 msgid "guestfs_equal"
6482 #: ../src/guestfs-actions.pod:1386
6486 " guestfs_equal (guestfs_h *g,\n"
6487 " const char *file1,\n"
6488 " const char *file2);\n"
6493 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6495 "This compares the two files C<file1> and C<file2> and returns true if their "
6496 "content is exactly equal, or false otherwise."
6500 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6501 msgid "The external L<cmp(1)> program is used for the comparison."
6505 #: ../src/guestfs-actions.pod:1400
6506 msgid "guestfs_exists"
6510 #: ../src/guestfs-actions.pod:1402
6514 " guestfs_exists (guestfs_h *g,\n"
6515 " const char *path);\n"
6520 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6522 "This returns C<true> if and only if there is a file, directory (or anything) "
6523 "with the given C<path> name."
6527 #: ../src/guestfs-actions.pod:1409
6528 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6532 #: ../src/guestfs-actions.pod:1415
6533 msgid "guestfs_fallocate"
6537 #: ../src/guestfs-actions.pod:1417
6541 " guestfs_fallocate (guestfs_h *g,\n"
6542 " const char *path,\n"
6548 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6550 "This command preallocates a file (containing zero bytes) named C<path> of "
6551 "size C<len> bytes. If the file exists already, it is overwritten."
6555 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6557 "Do not confuse this with the guestfish-specific C<alloc> command which "
6558 "allocates a file in the host and attaches it as a device."
6562 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6564 "This function is deprecated. In new code, use the C<fallocate64> call "
6569 #: ../src/guestfs-actions.pod:1441
6570 msgid "guestfs_fallocate64"
6574 #: ../src/guestfs-actions.pod:1443
6578 " guestfs_fallocate64 (guestfs_h *g,\n"
6579 " const char *path,\n"
6585 #: ../src/guestfs-actions.pod:1452
6587 "Note that this call allocates disk blocks for the file. To create a sparse "
6588 "file use C<guestfs_truncate_size> instead."
6592 #: ../src/guestfs-actions.pod:1455
6594 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6595 "oversight it only allowed 30 bit lengths to be specified, effectively "
6596 "limiting the maximum size of files created through that call to 1GB."
6600 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6602 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6603 "commands which create a file in the host and attach it as a device."
6607 #: ../src/guestfs-actions.pod:1466
6608 msgid "(Added in 1.3.17)"
6612 #: ../src/guestfs-actions.pod:1468
6613 msgid "guestfs_fgrep"
6617 #: ../src/guestfs-actions.pod:1470
6621 " guestfs_fgrep (guestfs_h *g,\n"
6622 " const char *pattern,\n"
6623 " const char *path);\n"
6628 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6629 msgid "This calls the external C<fgrep> program and returns the matching lines."
6633 #: ../src/guestfs-actions.pod:1487
6634 msgid "guestfs_fgrepi"
6638 #: ../src/guestfs-actions.pod:1489
6642 " guestfs_fgrepi (guestfs_h *g,\n"
6643 " const char *pattern,\n"
6644 " const char *path);\n"
6649 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
6650 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6654 #: ../src/guestfs-actions.pod:1506
6655 msgid "guestfs_file"
6659 #: ../src/guestfs-actions.pod:1508
6663 " guestfs_file (guestfs_h *g,\n"
6664 " const char *path);\n"
6669 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
6671 "This call uses the standard L<file(1)> command to determine the type or "
6672 "contents of the file."
6676 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
6678 "This call will also transparently look inside various types of compressed "
6683 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
6685 "The exact command which runs is C<file -zb path>. Note in particular that "
6686 "the filename is not prepended to the output (the C<-b> option)."
6690 #: ../src/guestfs-actions.pod:1522
6692 "This command can also be used on C</dev/> devices (and partitions, LV "
6693 "names). You can for example use this to determine if a device contains a "
6694 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6698 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
6700 "If the C<path> does not begin with C</dev/> then this command only works for "
6701 "the content of regular files. For other file types (directory, symbolic "
6702 "link etc) it will just return the string C<directory> etc."
6706 #: ../src/guestfs-actions.pod:1537
6707 msgid "guestfs_file_architecture"
6711 #: ../src/guestfs-actions.pod:1539
6715 " guestfs_file_architecture (guestfs_h *g,\n"
6716 " const char *filename);\n"
6721 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
6723 "This detects the architecture of the binary C<filename>, and returns it if "
6728 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
6729 msgid "Currently defined architectures are:"
6733 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
6738 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
6740 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6741 "irrespective of the precise processor requirements of the binary."
6745 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
6750 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
6751 msgid "64 bit x86-64."
6755 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
6760 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
6761 msgid "32 bit SPARC."
6765 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
6770 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
6771 msgid "64 bit SPARC V9 and above."
6775 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
6780 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
6781 msgid "Intel Itanium."
6785 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
6790 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
6791 msgid "32 bit Power PC."
6795 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
6800 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
6801 msgid "64 bit Power PC."
6805 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
6806 msgid "Libguestfs may return other architecture strings in future."
6810 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
6811 msgid "The function works on at least the following types of files:"
6815 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
6816 msgid "many types of Un*x and Linux binary"
6820 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
6821 msgid "many types of Un*x and Linux shared library"
6825 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
6826 msgid "Windows Win32 and Win64 binaries"
6830 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
6831 msgid "Windows Win32 and Win64 DLLs"
6835 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
6836 msgid "Win32 binaries and DLLs return C<i386>."
6840 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
6841 msgid "Win64 binaries and DLLs return C<x86_64>."
6845 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
6846 msgid "Linux kernel modules"
6850 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
6851 msgid "Linux new-style initrd images"
6855 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
6856 msgid "some non-x86 Linux vmlinuz kernels"
6860 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
6861 msgid "What it can't do currently:"
6865 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
6866 msgid "static libraries (libfoo.a)"
6870 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
6871 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6875 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
6876 msgid "x86 Linux vmlinuz kernels"
6880 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
6882 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6883 "compressed code, and are horribly hard to unpack. If you want to find the "
6884 "architecture of a kernel, use the architecture of the associated initrd or "
6885 "kernel module(s) instead."
6889 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766 ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997 ../src/guestfs-actions.pod:3129
6890 msgid "(Added in 1.5.3)"
6894 #: ../src/guestfs-actions.pod:1649
6895 msgid "guestfs_filesize"
6899 #: ../src/guestfs-actions.pod:1651
6903 " guestfs_filesize (guestfs_h *g,\n"
6904 " const char *file);\n"
6909 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
6910 msgid "This command returns the size of C<file> in bytes."
6914 #: ../src/guestfs-actions.pod:1657
6916 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6917 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6918 "devices, use C<guestfs_blockdev_getsize64>."
6922 #: ../src/guestfs-actions.pod:1663
6923 msgid "(Added in 1.0.82)"
6927 #: ../src/guestfs-actions.pod:1665
6928 msgid "guestfs_fill"
6932 #: ../src/guestfs-actions.pod:1667
6936 " guestfs_fill (guestfs_h *g,\n"
6939 " const char *path);\n"
6944 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
6946 "This command creates a new file called C<path>. The initial content of the "
6947 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6952 #: ../src/guestfs-actions.pod:1677
6954 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6955 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6956 "bytes use C<guestfs_fill_pattern>."
6960 #: ../src/guestfs-actions.pod:1689
6961 msgid "(Added in 1.0.79)"
6965 #: ../src/guestfs-actions.pod:1691
6966 msgid "guestfs_fill_pattern"
6970 #: ../src/guestfs-actions.pod:1693
6974 " guestfs_fill_pattern (guestfs_h *g,\n"
6975 " const char *pattern,\n"
6977 " const char *path);\n"
6982 #: ../src/guestfs-actions.pod:1699
6984 "This function is like C<guestfs_fill> except that it creates a new file of "
6985 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6986 "pattern is truncated if necessary to ensure the length of the file is "
6987 "exactly C<len> bytes."
6991 #: ../src/guestfs-actions.pod:1711
6992 msgid "(Added in 1.3.12)"
6996 #: ../src/guestfs-actions.pod:1713
6997 msgid "guestfs_find"
7001 #: ../src/guestfs-actions.pod:1715
7005 " guestfs_find (guestfs_h *g,\n"
7006 " const char *directory);\n"
7011 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7013 "This command lists out all files and directories, recursively, starting at "
7014 "C<directory>. It is essentially equivalent to running the shell command "
7015 "C<find directory -print> but some post-processing happens on the output, "
7020 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7022 "This returns a list of strings I<without any prefix>. Thus if the directory "
7027 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7037 #: ../src/guestfs-actions.pod:1731
7038 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7042 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7053 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7054 msgid "If C<directory> is not a directory, then this command returns an error."
7058 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7059 msgid "The returned list is sorted."
7063 #: ../src/guestfs-actions.pod:1744
7064 msgid "See also C<guestfs_find0>."
7068 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788 ../src/guestfs-actions.pod:5249
7069 msgid "(Added in 1.0.27)"
7073 #: ../src/guestfs-actions.pod:1755
7074 msgid "guestfs_find0"
7078 #: ../src/guestfs-actions.pod:1757
7082 " guestfs_find0 (guestfs_h *g,\n"
7083 " const char *directory,\n"
7084 " const char *files);\n"
7089 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7091 "This command lists out all files and directories, recursively, starting at "
7092 "C<directory>, placing the resulting list in the external file called "
7097 #: ../src/guestfs-actions.pod:1766
7099 "This command works the same way as C<guestfs_find> with the following "
7104 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7105 msgid "The resulting list is written to an external file."
7109 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7111 "Items (filenames) in the result are separated by C<\\0> characters. See "
7112 "L<find(1)> option I<-print0>."
7116 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7117 msgid "This command is not limited in the number of names that it can return."
7121 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7122 msgid "The result list is not sorted."
7126 #: ../src/guestfs-actions.pod:1793
7127 msgid "(Added in 1.0.74)"
7131 #: ../src/guestfs-actions.pod:1795
7132 msgid "guestfs_findfs_label"
7136 #: ../src/guestfs-actions.pod:1797
7140 " guestfs_findfs_label (guestfs_h *g,\n"
7141 " const char *label);\n"
7146 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7148 "This command searches the filesystems and returns the one which has the "
7149 "given label. An error is returned if no such filesystem can be found."
7153 #: ../src/guestfs-actions.pod:1805
7154 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7158 #: ../src/guestfs-actions.pod:1812
7159 msgid "guestfs_findfs_uuid"
7163 #: ../src/guestfs-actions.pod:1814
7167 " guestfs_findfs_uuid (guestfs_h *g,\n"
7168 " const char *uuid);\n"
7173 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7175 "This command searches the filesystems and returns the one which has the "
7176 "given UUID. An error is returned if no such filesystem can be found."
7180 #: ../src/guestfs-actions.pod:1822
7181 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7185 #: ../src/guestfs-actions.pod:1829
7186 msgid "guestfs_fsck"
7190 #: ../src/guestfs-actions.pod:1831
7194 " guestfs_fsck (guestfs_h *g,\n"
7195 " const char *fstype,\n"
7196 " const char *device);\n"
7201 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7203 "This runs the filesystem checker (fsck) on C<device> which should have "
7204 "filesystem type C<fstype>."
7208 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7210 "The returned integer is the status. See L<fsck(8)> for the list of status "
7211 "codes from C<fsck>."
7215 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7216 msgid "Multiple status codes can be summed together."
7220 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7222 "A non-zero return code can mean \"success\", for example if errors have been "
7223 "corrected on the filesystem."
7227 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7228 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7232 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7233 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7237 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7238 msgid "(Added in 1.0.16)"
7242 #: ../src/guestfs-actions.pod:1868
7243 msgid "guestfs_get_append"
7247 #: ../src/guestfs-actions.pod:1870
7251 " guestfs_get_append (guestfs_h *g);\n"
7256 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7258 "Return the additional kernel options which are added to the guest kernel "
7263 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7264 msgid "If C<NULL> then no options are added."
7268 #: ../src/guestfs-actions.pod:1878
7270 "This function returns a string which may be NULL. There is no way to return "
7271 "an error from this function. The string is owned by the guest handle and "
7272 "must I<not> be freed."
7276 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7277 msgid "(Added in 1.0.26)"
7281 #: ../src/guestfs-actions.pod:1884
7282 msgid "guestfs_get_autosync"
7286 #: ../src/guestfs-actions.pod:1886
7290 " guestfs_get_autosync (guestfs_h *g);\n"
7295 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7296 msgid "Get the autosync flag."
7300 #: ../src/guestfs-actions.pod:1895
7301 msgid "guestfs_get_direct"
7305 #: ../src/guestfs-actions.pod:1897
7309 " guestfs_get_direct (guestfs_h *g);\n"
7314 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7315 msgid "Return the direct appliance mode flag."
7319 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7320 msgid "(Added in 1.0.72)"
7324 #: ../src/guestfs-actions.pod:1906
7325 msgid "guestfs_get_e2label"
7329 #: ../src/guestfs-actions.pod:1908
7333 " guestfs_get_e2label (guestfs_h *g,\n"
7334 " const char *device);\n"
7339 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7340 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7344 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7346 "This function is deprecated. In new code, use the C<vfs_label> call "
7351 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7352 msgid "(Added in 1.0.15)"
7356 #: ../src/guestfs-actions.pod:1927
7357 msgid "guestfs_get_e2uuid"
7361 #: ../src/guestfs-actions.pod:1929
7365 " guestfs_get_e2uuid (guestfs_h *g,\n"
7366 " const char *device);\n"
7371 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7372 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7376 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7377 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7381 #: ../src/guestfs-actions.pod:1948
7382 msgid "guestfs_get_memsize"
7386 #: ../src/guestfs-actions.pod:1950
7390 " guestfs_get_memsize (guestfs_h *g);\n"
7395 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7396 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7400 #: ../src/guestfs-actions.pod:1956
7402 "If C<guestfs_set_memsize> was not called on this handle, and if "
7403 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7404 "value for memsize."
7408 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7409 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7413 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7414 msgid "(Added in 1.0.55)"
7418 #: ../src/guestfs-actions.pod:1967
7419 msgid "guestfs_get_network"
7423 #: ../src/guestfs-actions.pod:1969
7427 " guestfs_get_network (guestfs_h *g);\n"
7432 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7433 msgid "This returns the enable network flag."
7437 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7438 msgid "(Added in 1.5.4)"
7442 #: ../src/guestfs-actions.pod:1978
7443 msgid "guestfs_get_path"
7447 #: ../src/guestfs-actions.pod:1980
7451 " guestfs_get_path (guestfs_h *g);\n"
7456 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7457 msgid "Return the current search path."
7461 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7463 "This is always non-NULL. If it wasn't set already, then this will return "
7468 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7470 "This function returns a string, or NULL on error. The string is owned by "
7471 "the guest handle and must I<not> be freed."
7475 #: ../src/guestfs-actions.pod:1993
7476 msgid "guestfs_get_pid"
7480 #: ../src/guestfs-actions.pod:1995
7484 " guestfs_get_pid (guestfs_h *g);\n"
7489 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7491 "Return the process ID of the qemu subprocess. If there is no qemu "
7492 "subprocess, then this will return an error."
7496 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7497 msgid "This is an internal call used for debugging and testing."
7501 #: ../src/guestfs-actions.pod:2005
7502 msgid "(Added in 1.0.56)"
7506 #: ../src/guestfs-actions.pod:2007
7507 msgid "guestfs_get_qemu"
7511 #: ../src/guestfs-actions.pod:2009
7515 " guestfs_get_qemu (guestfs_h *g);\n"
7520 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7521 msgid "Return the current qemu binary."
7525 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7527 "This is always non-NULL. If it wasn't set already, then this will return "
7528 "the default qemu binary name."
7532 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7533 msgid "(Added in 1.0.6)"
7537 #: ../src/guestfs-actions.pod:2022
7538 msgid "guestfs_get_recovery_proc"
7542 #: ../src/guestfs-actions.pod:2024
7546 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7551 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7552 msgid "Return the recovery process enabled flag."
7556 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219 ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6438
7557 msgid "(Added in 1.0.77)"
7561 #: ../src/guestfs-actions.pod:2033
7562 msgid "guestfs_get_selinux"
7566 #: ../src/guestfs-actions.pod:2035
7570 " guestfs_get_selinux (guestfs_h *g);\n"
7575 #: ../src/guestfs-actions.pod:2038
7577 "This returns the current setting of the selinux flag which is passed to the "
7578 "appliance at boot time. See C<guestfs_set_selinux>."
7582 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7583 msgid "(Added in 1.0.67)"
7587 #: ../src/guestfs-actions.pod:2048
7588 msgid "guestfs_get_state"
7592 #: ../src/guestfs-actions.pod:2050
7596 " guestfs_get_state (guestfs_h *g);\n"
7601 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
7603 "This returns the current state as an opaque integer. This is only useful "
7604 "for printing debug and internal error messages."
7608 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3139 ../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
7609 msgid "For more information on states, see L<guestfs(3)>."
7613 #: ../src/guestfs-actions.pod:2062
7614 msgid "guestfs_get_trace"
7618 #: ../src/guestfs-actions.pod:2064
7622 " guestfs_get_trace (guestfs_h *g);\n"
7627 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
7628 msgid "Return the command trace flag."
7632 #: ../src/guestfs-actions.pod:2073
7633 msgid "guestfs_get_umask"
7637 #: ../src/guestfs-actions.pod:2075
7641 " guestfs_get_umask (guestfs_h *g);\n"
7646 #: ../src/guestfs-actions.pod:2078
7648 "Return the current umask. By default the umask is C<022> unless it has been "
7649 "set by calling C<guestfs_umask>."
7653 #: ../src/guestfs-actions.pod:2085
7654 msgid "guestfs_get_verbose"
7658 #: ../src/guestfs-actions.pod:2087
7662 " guestfs_get_verbose (guestfs_h *g);\n"
7667 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
7668 msgid "This returns the verbose messages flag."
7672 #: ../src/guestfs-actions.pod:2096
7673 msgid "guestfs_getcon"
7677 #: ../src/guestfs-actions.pod:2098
7681 " guestfs_getcon (guestfs_h *g);\n"
7686 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
7687 msgid "This gets the SELinux security context of the daemon."
7691 #: ../src/guestfs-actions.pod:2103
7692 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7696 #: ../src/guestfs-actions.pod:2111
7697 msgid "guestfs_getxattrs"
7701 #: ../src/guestfs-actions.pod:2113
7704 " struct guestfs_xattr_list *\n"
7705 " guestfs_getxattrs (guestfs_h *g,\n"
7706 " const char *path);\n"
7711 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
7712 msgid "This call lists the extended attributes of the file or directory C<path>."
7716 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
7718 "At the system call level, this is a combination of the L<listxattr(2)> and "
7719 "L<getxattr(2)> calls."
7723 #: ../src/guestfs-actions.pod:2123
7724 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7728 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3882
7730 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7731 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7735 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235 ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669 ../src/guestfs-actions.pod:6994
7736 msgid "(Added in 1.0.59)"
7740 #: ../src/guestfs-actions.pod:2131
7741 msgid "guestfs_glob_expand"
7745 #: ../src/guestfs-actions.pod:2133
7749 " guestfs_glob_expand (guestfs_h *g,\n"
7750 " const char *pattern);\n"
7755 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
7757 "This command searches for all the pathnames matching C<pattern> according to "
7758 "the wildcard expansion rules used by the shell."
7762 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
7763 msgid "If no paths match, then this returns an empty list (note: not an error)."
7767 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
7769 "It is just a wrapper around the C L<glob(3)> function with flags "
7770 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7774 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5851
7775 msgid "(Added in 1.0.50)"
7779 #: ../src/guestfs-actions.pod:2154
7780 msgid "guestfs_grep"
7784 #: ../src/guestfs-actions.pod:2156
7788 " guestfs_grep (guestfs_h *g,\n"
7789 " const char *regex,\n"
7790 " const char *path);\n"
7795 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
7796 msgid "This calls the external C<grep> program and returns the matching lines."
7800 #: ../src/guestfs-actions.pod:2173
7801 msgid "guestfs_grepi"
7805 #: ../src/guestfs-actions.pod:2175
7809 " guestfs_grepi (guestfs_h *g,\n"
7810 " const char *regex,\n"
7811 " const char *path);\n"
7816 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
7817 msgid "This calls the external C<grep -i> program and returns the matching lines."
7821 #: ../src/guestfs-actions.pod:2192
7822 msgid "guestfs_grub_install"
7826 #: ../src/guestfs-actions.pod:2194
7830 " guestfs_grub_install (guestfs_h *g,\n"
7831 " const char *root,\n"
7832 " const char *device);\n"
7837 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
7839 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7840 "the root directory being C<root>."
7844 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
7846 "Note: If grub-install reports the error \"No suitable drive was found in the "
7847 "generated device map.\" it may be that you need to create a "
7848 "C</boot/grub/device.map> file first that contains the mapping between grub "
7849 "device names and Linux device names. It is usually sufficient to create a "
7854 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
7862 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
7863 msgid "replacing C</dev/vda> with the name of the installation device."
7867 #: ../src/guestfs-actions.pod:2215
7868 msgid "(Added in 1.0.17)"
7872 #: ../src/guestfs-actions.pod:2217
7873 msgid "guestfs_head"
7877 #: ../src/guestfs-actions.pod:2219
7881 " guestfs_head (guestfs_h *g,\n"
7882 " const char *path);\n"
7887 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
7889 "This command returns up to the first 10 lines of a file as a list of "
7894 #: ../src/guestfs-actions.pod:2235
7895 msgid "guestfs_head_n"
7899 #: ../src/guestfs-actions.pod:2237
7903 " guestfs_head_n (guestfs_h *g,\n"
7905 " const char *path);\n"
7910 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
7912 "If the parameter C<nrlines> is a positive number, this returns the first "
7913 "C<nrlines> lines of the file C<path>."
7917 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
7919 "If the parameter C<nrlines> is a negative number, this returns lines from "
7920 "the file C<path>, excluding the last C<nrlines> lines."
7924 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
7925 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7929 #: ../src/guestfs-actions.pod:2259
7930 msgid "guestfs_hexdump"
7934 #: ../src/guestfs-actions.pod:2261
7938 " guestfs_hexdump (guestfs_h *g,\n"
7939 " const char *path);\n"
7944 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
7946 "This runs C<hexdump -C> on the given C<path>. The result is the "
7947 "human-readable, canonical hex dump of the file."
7951 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5970
7952 msgid "(Added in 1.0.22)"
7956 #: ../src/guestfs-actions.pod:2276
7957 msgid "guestfs_initrd_cat"
7961 #: ../src/guestfs-actions.pod:2278
7965 " guestfs_initrd_cat (guestfs_h *g,\n"
7966 " const char *initrdpath,\n"
7967 " const char *filename,\n"
7968 " size_t *size_r);\n"
7973 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
7975 "This command unpacks the file C<filename> from the initrd file called "
7976 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7981 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
7983 "For example, in guestfish you could use the following command to examine the "
7984 "boot script (usually called C</init>) contained in a Linux initrd or "
7989 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
7992 " initrd-cat /boot/initrd-<version>.img init\n"
7997 #: ../src/guestfs-actions.pod:2294
7998 msgid "See also C<guestfs_initrd_list>."
8002 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8004 "This function returns a buffer, or NULL on error. The size of the returned "
8005 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8010 #: ../src/guestfs-actions.pod:2305
8011 msgid "guestfs_initrd_list"
8015 #: ../src/guestfs-actions.pod:2307
8019 " guestfs_initrd_list (guestfs_h *g,\n"
8020 " const char *path);\n"
8025 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8026 msgid "This command lists out files contained in an initrd."
8030 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8032 "The files are listed without any initial C</> character. The files are "
8033 "listed in the order they appear (not necessarily alphabetical). Directory "
8034 "names are listed as separate items."
8038 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8040 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8041 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8046 #: ../src/guestfs-actions.pod:2327
8047 msgid "guestfs_inotify_add_watch"
8051 #: ../src/guestfs-actions.pod:2329
8055 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8056 " const char *path,\n"
8062 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8063 msgid "Watch C<path> for the events listed in C<mask>."
8067 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8069 "Note that if C<path> is a directory then events within that directory are "
8070 "watched, but this does I<not> happen recursively (in subdirectories)."
8074 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8076 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8077 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8081 #: ../src/guestfs-actions.pod:2348
8082 msgid "guestfs_inotify_close"
8086 #: ../src/guestfs-actions.pod:2350
8090 " guestfs_inotify_close (guestfs_h *g);\n"
8095 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8097 "This closes the inotify handle which was previously opened by inotify_init. "
8098 "It removes all watches, throws away any pending events, and deallocates all "
8103 #: ../src/guestfs-actions.pod:2361
8104 msgid "guestfs_inotify_files"
8108 #: ../src/guestfs-actions.pod:2363
8112 " guestfs_inotify_files (guestfs_h *g);\n"
8117 #: ../src/guestfs-actions.pod:2366
8119 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8120 "returns a list of pathnames of objects that were touched. The returned "
8121 "pathnames are sorted and deduplicated."
8125 #: ../src/guestfs-actions.pod:2376
8126 msgid "guestfs_inotify_init"
8130 #: ../src/guestfs-actions.pod:2378
8134 " guestfs_inotify_init (guestfs_h *g,\n"
8135 " int maxevents);\n"
8140 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8142 "This command creates a new inotify handle. The inotify subsystem can be "
8143 "used to notify events which happen to objects in the guest filesystem."
8147 #: ../src/guestfs-actions.pod:2386
8149 "C<maxevents> is the maximum number of events which will be queued up between "
8150 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8151 "passed as C<0>, then the kernel (or previously set) default is used. For "
8152 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8153 "throws away events, but records the fact that it threw them away by setting "
8154 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8155 "C<guestfs_inotify_read>)."
8159 #: ../src/guestfs-actions.pod:2396
8161 "Before any events are generated, you have to add some watches to the "
8162 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8163 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8167 #: ../src/guestfs-actions.pod:2402
8169 "Queued up events should be read periodically by calling "
8170 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8171 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8172 "often enough then you risk the internal queue overflowing."
8176 #: ../src/guestfs-actions.pod:2409
8178 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8179 "This also removes any watches automatically."
8183 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8185 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8186 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8187 "that there is one global inotify handle per libguestfs instance."
8191 #: ../src/guestfs-actions.pod:2422
8192 msgid "guestfs_inotify_read"
8196 #: ../src/guestfs-actions.pod:2424
8199 " struct guestfs_inotify_event_list *\n"
8200 " guestfs_inotify_read (guestfs_h *g);\n"
8205 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8207 "Return the complete queue of events that have happened since the previous "
8212 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8213 msgid "If no events have happened, this returns an empty list."
8217 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8219 "I<Note>: In order to make sure that all events have been read, you must call "
8220 "this function repeatedly until it returns an empty list. The reason is that "
8221 "the call will read events up to the maximum appliance-to-host message size "
8222 "and leave remaining events in the queue."
8226 #: ../src/guestfs-actions.pod:2438
8228 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8229 "there was an error. I<The caller must call "
8230 "C<guestfs_free_inotify_event_list> after use>."
8234 #: ../src/guestfs-actions.pod:2444
8235 msgid "guestfs_inotify_rm_watch"
8239 #: ../src/guestfs-actions.pod:2446
8243 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8249 #: ../src/guestfs-actions.pod:2450
8251 "Remove a previously defined inotify watch. See "
8252 "C<guestfs_inotify_add_watch>."
8256 #: ../src/guestfs-actions.pod:2457
8257 msgid "guestfs_inspect_get_arch"
8261 #: ../src/guestfs-actions.pod:2459
8265 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8266 " const char *root);\n"
8271 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486 ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593 ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640 ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2857
8273 "This function should only be called with a root device string as returned by "
8274 "C<guestfs_inspect_os>."
8278 #: ../src/guestfs-actions.pod:2466
8280 "This returns the architecture of the inspected operating system. The "
8281 "possible return values are listed under C<guestfs_file_architecture>."
8285 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8287 "If the architecture could not be determined, then the string C<unknown> is "
8292 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554 ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628 ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989 ../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
8293 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8297 #: ../src/guestfs-actions.pod:2480
8298 msgid "guestfs_inspect_get_distro"
8302 #: ../src/guestfs-actions.pod:2482
8306 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8307 " const char *root);\n"
8312 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8313 msgid "This returns the distro (distribution) of the inspected operating system."
8317 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8318 msgid "Currently defined distros are:"
8322 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8323 msgid "\"archlinux\""
8327 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8332 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8337 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8342 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8347 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8352 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8357 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8362 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8363 msgid "\"linuxmint\""
8367 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8372 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8373 msgid "\"mandriva\""
8377 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8382 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8387 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8392 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8397 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8402 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8403 msgid "\"redhat-based\""
8407 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8408 msgid "Some Red Hat-derived distro."
8412 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8417 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8418 msgid "Red Hat Enterprise Linux and some derivatives."
8422 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8427 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8432 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8437 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8438 msgid "The distro could not be determined."
8442 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804 ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8447 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8449 "Windows does not have distributions. This string is returned if the OS type "
8454 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8456 "Future versions of libguestfs may return other strings here. The caller "
8457 "should be prepared to handle any string."
8461 #: ../src/guestfs-actions.pod:2561
8462 msgid "guestfs_inspect_get_filesystems"
8466 #: ../src/guestfs-actions.pod:2563
8470 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8471 " const char *root);\n"
8476 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8478 "This returns a list of all the filesystems that we think are associated with "
8479 "this operating system. This includes the root filesystem, other ordinary "
8480 "filesystems, and non-mounted devices like swap partitions."
8484 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8486 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8487 "to be shared between operating systems."
8491 #: ../src/guestfs-actions.pod:2578
8493 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8494 "C<guestfs_inspect_get_mountpoints>."
8498 #: ../src/guestfs-actions.pod:2587
8499 msgid "guestfs_inspect_get_hostname"
8503 #: ../src/guestfs-actions.pod:2589
8507 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8508 " const char *root);\n"
8513 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8515 "This function returns the hostname of the operating system as found by "
8516 "inspection of the guest's configuration files."
8520 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8522 "If the hostname could not be determined, then the string C<unknown> is "
8527 #: ../src/guestfs-actions.pod:2607
8528 msgid "guestfs_inspect_get_major_version"
8532 #: ../src/guestfs-actions.pod:2609
8536 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8537 " const char *root);\n"
8542 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8543 msgid "This returns the major version number of the inspected operating system."
8547 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
8549 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8550 "popular public names used by the operating system. Notably the operating "
8551 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8552 "1). You can find out the real versions corresponding to releases of Windows "
8553 "by consulting Wikipedia or MSDN."
8557 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8558 msgid "If the version could not be determined, then C<0> is returned."
8562 #: ../src/guestfs-actions.pod:2634
8563 msgid "guestfs_inspect_get_minor_version"
8567 #: ../src/guestfs-actions.pod:2636
8571 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8572 " const char *root);\n"
8577 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
8578 msgid "This returns the minor version number of the inspected operating system."
8582 #: ../src/guestfs-actions.pod:2648
8584 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8585 "C<guestfs_inspect_get_major_version>."
8589 #: ../src/guestfs-actions.pod:2655
8590 msgid "guestfs_inspect_get_mountpoints"
8594 #: ../src/guestfs-actions.pod:2657
8598 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8599 " const char *root);\n"
8604 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
8606 "This returns a hash of where we think the filesystems associated with this "
8607 "operating system should be mounted. Callers should note that this is at "
8608 "best an educated guess made by reading configuration files such as "
8613 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
8615 "Each element in the returned hashtable has a key which is the path of the "
8616 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8617 "mounted there (eg. C</dev/sda1>)."
8621 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
8622 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8626 #: ../src/guestfs-actions.pod:2677
8628 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8629 "C<guestfs_inspect_get_filesystems>."
8633 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
8635 "This function returns a NULL-terminated array of strings, or NULL if there "
8636 "was an error. The array of strings will always have length C<2n+1>, where "
8637 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8638 "caller must free the strings and the array after use>."
8642 #: ../src/guestfs-actions.pod:2688
8643 msgid "guestfs_inspect_get_package_format"
8647 #: ../src/guestfs-actions.pod:2690
8651 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8652 " const char *root);\n"
8657 #: ../src/guestfs-actions.pod:2697
8659 "This function and C<guestfs_inspect_get_package_management> return the "
8660 "package format and package management tool used by the inspected operating "
8661 "system. For example for Fedora these functions would return C<rpm> (package "
8662 "format) and C<yum> (package management)."
8666 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
8668 "This returns the string C<unknown> if we could not determine the package "
8669 "format I<or> if the operating system does not have a real packaging system "
8674 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
8676 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8677 "Future versions of libguestfs may return other strings."
8681 #: ../src/guestfs-actions.pod:2715
8682 msgid "guestfs_inspect_get_package_management"
8686 #: ../src/guestfs-actions.pod:2717
8690 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8691 " const char *root);\n"
8696 #: ../src/guestfs-actions.pod:2724
8698 "C<guestfs_inspect_get_package_format> and this function return the package "
8699 "format and package management tool used by the inspected operating system. "
8700 "For example for Fedora these functions would return C<rpm> (package format) "
8701 "and C<yum> (package management)."
8705 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
8707 "This returns the string C<unknown> if we could not determine the package "
8708 "management tool I<or> if the operating system does not have a real packaging "
8709 "system (eg. Windows)."
8713 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
8715 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8716 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8717 "libguestfs may return other strings."
8721 #: ../src/guestfs-actions.pod:2744
8722 msgid "guestfs_inspect_get_product_name"
8726 #: ../src/guestfs-actions.pod:2746
8730 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8731 " const char *root);\n"
8736 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
8738 "This returns the product name of the inspected operating system. The "
8739 "product name is generally some freeform string which can be displayed to the "
8740 "user, but should not be parsed by programs."
8744 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
8746 "If the product name could not be determined, then the string C<unknown> is "
8751 #: ../src/guestfs-actions.pod:2768
8752 msgid "guestfs_inspect_get_roots"
8756 #: ../src/guestfs-actions.pod:2770
8760 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8765 #: ../src/guestfs-actions.pod:2773
8767 "This function is a convenient way to get the list of root devices, as "
8768 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8769 "the whole inspection process."
8773 #: ../src/guestfs-actions.pod:2777
8775 "This returns an empty list if either no root devices were found or the "
8776 "caller has not called C<guestfs_inspect_os>."
8780 #: ../src/guestfs-actions.pod:2786
8781 msgid "guestfs_inspect_get_type"
8785 #: ../src/guestfs-actions.pod:2788
8789 " guestfs_inspect_get_type (guestfs_h *g,\n"
8790 " const char *root);\n"
8795 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
8797 "This returns the type of the inspected operating system. Currently defined "
8802 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
8807 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
8808 msgid "Any Linux-based operating system."
8812 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
8813 msgid "Any Microsoft Windows operating system."
8817 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
8822 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
8827 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
8828 msgid "The operating system type could not be determined."
8832 #: ../src/guestfs-actions.pod:2828
8833 msgid "guestfs_inspect_get_windows_systemroot"
8837 #: ../src/guestfs-actions.pod:2830
8841 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8842 " const char *root);\n"
8847 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
8849 "This returns the Windows systemroot of the inspected guest. The systemroot "
8850 "is a directory path such as C</WINDOWS>."
8854 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
8856 "This call assumes that the guest is Windows and that the systemroot could be "
8857 "determined by inspection. If this is not the case then an error is "
8862 #: ../src/guestfs-actions.pod:2849
8863 msgid "(Added in 1.5.25)"
8867 #: ../src/guestfs-actions.pod:2851
8868 msgid "guestfs_inspect_list_applications"
8872 #: ../src/guestfs-actions.pod:2853
8875 " struct guestfs_application_list *\n"
8876 " guestfs_inspect_list_applications (guestfs_h *g,\n"
8877 " const char *root);\n"
8882 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
8883 msgid "Return the list of applications installed in the operating system."
8887 #: ../src/guestfs-actions.pod:2862
8889 "I<Note:> This call works differently from other parts of the inspection "
8890 "API. You have to call C<guestfs_inspect_os>, then "
8891 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
8892 "this. Listing applications is a significantly more difficult operation "
8893 "which requires access to the full filesystem. Also note that unlike the "
8894 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
8895 "the libguestfs handle, this call actually reads parts of the mounted "
8896 "filesystems during the call."
8900 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
8902 "This returns an empty list if the inspection code was not able to determine "
8903 "the list of applications."
8907 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
8908 msgid "The application structure contains the following fields:"
8912 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
8917 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
8919 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8920 "guests, this is the package name."
8924 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
8925 msgid "C<app_display_name>"
8929 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
8931 "The display name of the application, sometimes localized to the install "
8932 "language of the guest operating system."
8936 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
8938 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8939 "to display something can use C<app_name> instead."
8943 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
8944 msgid "C<app_epoch>"
8948 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
8950 "For package managers which use epochs, this contains the epoch of the "
8951 "package (an integer). If unavailable, this is returned as C<0>."
8955 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
8956 msgid "C<app_version>"
8960 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
8962 "The version string of the application or package. If unavailable this is "
8963 "returned as an empty string C<\"\">."
8967 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
8968 msgid "C<app_release>"
8972 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
8974 "The release string of the application or package, for package managers that "
8975 "use this. If unavailable this is returned as an empty string C<\"\">."
8979 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
8980 msgid "C<app_install_path>"
8984 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
8986 "The installation path of the application (on operating systems such as "
8987 "Windows which use installation paths). This path is in the format used by "
8988 "the guest operating system, it is not a libguestfs path."
8992 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
8993 msgid "If unavailable this is returned as an empty string C<\"\">."
8997 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
8998 msgid "C<app_trans_path>"
9002 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9004 "The install path translated into a libguestfs path. If unavailable this is "
9005 "returned as an empty string C<\"\">."
9009 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9010 msgid "C<app_publisher>"
9014 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9016 "The name of the publisher of the application, for package managers that use "
9017 "this. If unavailable this is returned as an empty string C<\"\">."
9021 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9026 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9028 "The URL (eg. upstream URL) of the application. If unavailable this is "
9029 "returned as an empty string C<\"\">."
9033 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9034 msgid "C<app_source_package>"
9038 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9040 "For packaging systems which support this, the name of the source package. "
9041 "If unavailable this is returned as an empty string C<\"\">."
9045 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9046 msgid "C<app_summary>"
9050 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9052 "A short (usually one line) description of the application or package. If "
9053 "unavailable this is returned as an empty string C<\"\">."
9057 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9058 msgid "C<app_description>"
9062 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9064 "A longer description of the application or package. If unavailable this is "
9065 "returned as an empty string C<\"\">."
9069 #: ../src/guestfs-actions.pod:2952
9071 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9072 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9077 #: ../src/guestfs-actions.pod:2956
9078 msgid "guestfs_inspect_os"
9082 #: ../src/guestfs-actions.pod:2958
9086 " guestfs_inspect_os (guestfs_h *g);\n"
9091 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9093 "This function uses other libguestfs functions and certain heuristics to "
9094 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9095 "for operating systems."
9099 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9100 msgid "The list returned is empty if no operating systems were found."
9104 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9106 "If one operating system was found, then this returns a list with a single "
9107 "element, which is the name of the root filesystem of this operating system. "
9108 "It is also possible for this function to return a list containing more than "
9109 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9110 "element being the root filesystem of one of the operating systems."
9114 #: ../src/guestfs-actions.pod:2974
9116 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9117 "functions in order to query further information about each operating system, "
9118 "such as the name and version."
9122 #: ../src/guestfs-actions.pod:2979
9124 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9125 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9126 "the contents. This should be called with no disks currently mounted. The "
9127 "function may also use Augeas, so any existing Augeas handle will be closed."
9131 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9133 "This function cannot decrypt encrypted disks. The caller must do that first "
9134 "(supplying the necessary keys) if the disk is encrypted."
9138 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246 ../src/guestfs-actions.pod:3308
9139 msgid "See also C<guestfs_list_filesystems>."
9143 #: ../src/guestfs-actions.pod:2999
9144 msgid "guestfs_is_blockdev"
9148 #: ../src/guestfs-actions.pod:3001
9152 " guestfs_is_blockdev (guestfs_h *g,\n"
9153 " const char *path);\n"
9158 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9160 "This returns C<true> if and only if there is a block device with the given "
9165 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3169
9166 msgid "See also C<guestfs_stat>."
9170 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3173
9171 msgid "(Added in 1.5.10)"
9175 #: ../src/guestfs-actions.pod:3014
9176 msgid "guestfs_is_busy"
9180 #: ../src/guestfs-actions.pod:3016
9184 " guestfs_is_busy (guestfs_h *g);\n"
9189 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9191 "This returns true iff this handle is busy processing a command (in the "
9196 #: ../src/guestfs-actions.pod:3028
9197 msgid "guestfs_is_chardev"
9201 #: ../src/guestfs-actions.pod:3030
9205 " guestfs_is_chardev (guestfs_h *g,\n"
9206 " const char *path);\n"
9211 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9213 "This returns C<true> if and only if there is a character device with the "
9214 "given C<path> name."
9218 #: ../src/guestfs-actions.pod:3043
9219 msgid "guestfs_is_config"
9223 #: ../src/guestfs-actions.pod:3045
9227 " guestfs_is_config (guestfs_h *g);\n"
9232 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9234 "This returns true iff this handle is being configured (in the C<CONFIG> "
9239 #: ../src/guestfs-actions.pod:3057
9240 msgid "guestfs_is_dir"
9244 #: ../src/guestfs-actions.pod:3059
9248 " guestfs_is_dir (guestfs_h *g,\n"
9249 " const char *path);\n"
9254 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9256 "This returns C<true> if and only if there is a directory with the given "
9257 "C<path> name. Note that it returns false for other objects like files."
9261 #: ../src/guestfs-actions.pod:3073
9262 msgid "guestfs_is_fifo"
9266 #: ../src/guestfs-actions.pod:3075
9270 " guestfs_is_fifo (guestfs_h *g,\n"
9271 " const char *path);\n"
9276 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9278 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9279 "given C<path> name."
9283 #: ../src/guestfs-actions.pod:3088
9284 msgid "guestfs_is_file"
9288 #: ../src/guestfs-actions.pod:3090
9292 " guestfs_is_file (guestfs_h *g,\n"
9293 " const char *path);\n"
9298 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9300 "This returns C<true> if and only if there is a regular file with the given "
9301 "C<path> name. Note that it returns false for other objects like "
9306 #: ../src/guestfs-actions.pod:3104
9307 msgid "guestfs_is_launching"
9311 #: ../src/guestfs-actions.pod:3106
9315 " guestfs_is_launching (guestfs_h *g);\n"
9320 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9322 "This returns true iff this handle is launching the subprocess (in the "
9323 "C<LAUNCHING> state)."
9327 #: ../src/guestfs-actions.pod:3118
9328 msgid "guestfs_is_lv"
9332 #: ../src/guestfs-actions.pod:3120
9336 " guestfs_is_lv (guestfs_h *g,\n"
9337 " const char *device);\n"
9342 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9344 "This command tests whether C<device> is a logical volume, and returns true "
9345 "iff this is the case."
9349 #: ../src/guestfs-actions.pod:3131
9350 msgid "guestfs_is_ready"
9354 #: ../src/guestfs-actions.pod:3133
9358 " guestfs_is_ready (guestfs_h *g);\n"
9363 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9365 "This returns true iff this handle is ready to accept commands (in the "
9370 #: ../src/guestfs-actions.pod:3145
9371 msgid "guestfs_is_socket"
9375 #: ../src/guestfs-actions.pod:3147
9379 " guestfs_is_socket (guestfs_h *g,\n"
9380 " const char *path);\n"
9385 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9387 "This returns C<true> if and only if there is a Unix domain socket with the "
9388 "given C<path> name."
9392 #: ../src/guestfs-actions.pod:3160
9393 msgid "guestfs_is_symlink"
9397 #: ../src/guestfs-actions.pod:3162
9401 " guestfs_is_symlink (guestfs_h *g,\n"
9402 " const char *path);\n"
9407 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9409 "This returns C<true> if and only if there is a symbolic link with the given "
9414 #: ../src/guestfs-actions.pod:3175
9415 msgid "guestfs_kill_subprocess"
9419 #: ../src/guestfs-actions.pod:3177
9423 " guestfs_kill_subprocess (guestfs_h *g);\n"
9428 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9429 msgid "This kills the qemu subprocess. You should never need to call this."
9433 #: ../src/guestfs-actions.pod:3186
9434 msgid "guestfs_launch"
9438 #: ../src/guestfs-actions.pod:3188
9442 " guestfs_launch (guestfs_h *g);\n"
9447 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9449 "Internally libguestfs is implemented by running a virtual machine using "
9454 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9456 "You should call this after configuring the handle (eg. adding drives) but "
9457 "before performing any actions."
9461 #: ../src/guestfs-actions.pod:3201
9462 msgid "guestfs_lchown"
9466 #: ../src/guestfs-actions.pod:3203
9470 " guestfs_lchown (guestfs_h *g,\n"
9473 " const char *path);\n"
9478 #: ../src/guestfs-actions.pod:3209
9480 "Change the file owner to C<owner> and group to C<group>. This is like "
9481 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9482 "changed, not the target."
9486 #: ../src/guestfs-actions.pod:3221
9487 msgid "guestfs_lgetxattrs"
9491 #: ../src/guestfs-actions.pod:3223
9494 " struct guestfs_xattr_list *\n"
9495 " guestfs_lgetxattrs (guestfs_h *g,\n"
9496 " const char *path);\n"
9501 #: ../src/guestfs-actions.pod:3227
9503 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9504 "then it returns the extended attributes of the link itself."
9508 #: ../src/guestfs-actions.pod:3237
9509 msgid "guestfs_list_devices"
9513 #: ../src/guestfs-actions.pod:3239
9517 " guestfs_list_devices (guestfs_h *g);\n"
9522 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9523 msgid "List all the block devices."
9527 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9528 msgid "The full block device names are returned, eg. C</dev/sda>."
9532 #: ../src/guestfs-actions.pod:3254
9533 msgid "guestfs_list_filesystems"
9537 #: ../src/guestfs-actions.pod:3256
9541 " guestfs_list_filesystems (guestfs_h *g);\n"
9546 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
9548 "This inspection command looks for filesystems on partitions, block devices "
9549 "and logical volumes, returning a list of devices containing filesystems and "
9554 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
9556 "The return value is a hash, where the keys are the devices containing "
9557 "filesystems, and the values are the filesystem types. For example:"
9561 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
9564 " \"/dev/sda1\" => \"ntfs\"\n"
9565 " \"/dev/sda2\" => \"ext2\"\n"
9566 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9567 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9572 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
9574 "The value can have the special value \"unknown\", meaning the content of the "
9575 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9579 #: ../src/guestfs-actions.pod:3276
9581 "This command runs other libguestfs commands, which might include "
9582 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9583 "soon after launch and only when nothing is mounted."
9587 #: ../src/guestfs-actions.pod:3280
9589 "Not all of the filesystems returned will be mountable. In particular, swap "
9590 "partitions are returned in the list. Also this command does not check that "
9591 "each filesystem found is valid and mountable, and some filesystems might be "
9592 "mountable but require special options. Filesystems may not all belong to a "
9593 "single logical operating system (use C<guestfs_inspect_os> to look for "
9598 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
9599 msgid "(Added in 1.5.15)"
9603 #: ../src/guestfs-actions.pod:3296
9604 msgid "guestfs_list_partitions"
9608 #: ../src/guestfs-actions.pod:3298
9612 " guestfs_list_partitions (guestfs_h *g);\n"
9617 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
9618 msgid "List all the partitions detected on all block devices."
9622 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
9623 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9627 #: ../src/guestfs-actions.pod:3305
9629 "This does not return logical volumes. For that you will need to call "
9634 #: ../src/guestfs-actions.pod:3316
9639 #: ../src/guestfs-actions.pod:3318
9643 " guestfs_ll (guestfs_h *g,\n"
9644 " const char *directory);\n"
9649 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
9651 "List the files in C<directory> (relative to the root directory, there is no "
9652 "cwd) in the format of 'ls -la'."
9656 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
9658 "This command is mostly useful for interactive sessions. It is I<not> "
9659 "intended that you try to parse the output string."
9663 #: ../src/guestfs-actions.pod:3333
9668 #: ../src/guestfs-actions.pod:3335
9672 " guestfs_ln (guestfs_h *g,\n"
9673 " const char *target,\n"
9674 " const char *linkname);\n"
9679 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
9680 msgid "This command creates a hard link using the C<ln> command."
9684 #: ../src/guestfs-actions.pod:3346
9685 msgid "guestfs_ln_f"
9689 #: ../src/guestfs-actions.pod:3348
9693 " guestfs_ln_f (guestfs_h *g,\n"
9694 " const char *target,\n"
9695 " const char *linkname);\n"
9700 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
9702 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9703 "option removes the link (C<linkname>) if it exists already."
9707 #: ../src/guestfs-actions.pod:3360
9708 msgid "guestfs_ln_s"
9712 #: ../src/guestfs-actions.pod:3362
9716 " guestfs_ln_s (guestfs_h *g,\n"
9717 " const char *target,\n"
9718 " const char *linkname);\n"
9723 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
9724 msgid "This command creates a symbolic link using the C<ln -s> command."
9728 #: ../src/guestfs-actions.pod:3373
9729 msgid "guestfs_ln_sf"
9733 #: ../src/guestfs-actions.pod:3375
9737 " guestfs_ln_sf (guestfs_h *g,\n"
9738 " const char *target,\n"
9739 " const char *linkname);\n"
9744 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
9746 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9747 "option removes the link (C<linkname>) if it exists already."
9751 #: ../src/guestfs-actions.pod:3387
9752 msgid "guestfs_lremovexattr"
9756 #: ../src/guestfs-actions.pod:3389
9760 " guestfs_lremovexattr (guestfs_h *g,\n"
9761 " const char *xattr,\n"
9762 " const char *path);\n"
9767 #: ../src/guestfs-actions.pod:3394
9769 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9770 "link, then it removes an extended attribute of the link itself."
9774 #: ../src/guestfs-actions.pod:3402
9779 #: ../src/guestfs-actions.pod:3404
9783 " guestfs_ls (guestfs_h *g,\n"
9784 " const char *directory);\n"
9789 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
9791 "List the files in C<directory> (relative to the root directory, there is no "
9792 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9797 #: ../src/guestfs-actions.pod:3412
9799 "This command is mostly useful for interactive sessions. Programs should "
9800 "probably use C<guestfs_readdir> instead."
9804 #: ../src/guestfs-actions.pod:3421
9805 msgid "guestfs_lsetxattr"
9809 #: ../src/guestfs-actions.pod:3423
9813 " guestfs_lsetxattr (guestfs_h *g,\n"
9814 " const char *xattr,\n"
9815 " const char *val,\n"
9817 " const char *path);\n"
9822 #: ../src/guestfs-actions.pod:3430
9824 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9825 "then it sets an extended attribute of the link itself."
9829 #: ../src/guestfs-actions.pod:3438
9830 msgid "guestfs_lstat"
9834 #: ../src/guestfs-actions.pod:3440
9837 " struct guestfs_stat *\n"
9838 " guestfs_lstat (guestfs_h *g,\n"
9839 " const char *path);\n"
9844 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
9845 msgid "Returns file information for the given C<path>."
9849 #: ../src/guestfs-actions.pod:3446
9851 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9852 "link, then the link is stat-ed, not the file it refers to."
9856 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
9857 msgid "This is the same as the C<lstat(2)> system call."
9861 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
9863 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9864 "error. I<The caller must call C<guestfs_free_stat> after use>."
9868 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
9869 msgid "(Added in 0.9.2)"
9873 #: ../src/guestfs-actions.pod:3458
9874 msgid "guestfs_lstatlist"
9878 #: ../src/guestfs-actions.pod:3460
9881 " struct guestfs_stat_list *\n"
9882 " guestfs_lstatlist (guestfs_h *g,\n"
9883 " const char *path,\n"
9884 " char *const *names);\n"
9889 #: ../src/guestfs-actions.pod:3465
9891 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9892 "files, where all files are in the directory C<path>. C<names> is the list "
9893 "of files from this directory."
9897 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
9899 "On return you get a list of stat structs, with a one-to-one correspondence "
9900 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9901 "then the C<ino> field of that structure is set to C<-1>."
9905 #: ../src/guestfs-actions.pod:3474
9907 "This call is intended for programs that want to efficiently list a directory "
9908 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9909 "for a similarly efficient call for getting extended attributes. Very long "
9910 "directory listings might cause the protocol message size to be exceeded, "
9911 "causing this call to fail. The caller must split up such requests into "
9912 "smaller groups of names."
9916 #: ../src/guestfs-actions.pod:3482
9918 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9919 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9923 #: ../src/guestfs-actions.pod:3488
9924 msgid "guestfs_luks_add_key"
9928 #: ../src/guestfs-actions.pod:3490
9932 " guestfs_luks_add_key (guestfs_h *g,\n"
9933 " const char *device,\n"
9934 " const char *key,\n"
9935 " const char *newkey,\n"
9941 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
9943 "This command adds a new key on LUKS device C<device>. C<key> is any "
9944 "existing key, and is used to access the device. C<newkey> is the new key to "
9945 "add. C<keyslot> is the key slot that will be replaced."
9949 #: ../src/guestfs-actions.pod:3502
9951 "Note that if C<keyslot> already contains a key, then this command will "
9952 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9956 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548 ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
9958 "This function takes a key or passphrase parameter which could contain "
9959 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9964 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
9965 msgid "(Added in 1.5.2)"
9969 #: ../src/guestfs-actions.pod:3514
9970 msgid "guestfs_luks_close"
9974 #: ../src/guestfs-actions.pod:3516
9978 " guestfs_luks_close (guestfs_h *g,\n"
9979 " const char *device);\n"
9984 #: ../src/guestfs-actions.pod:3520
9986 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9987 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9988 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9989 "underlying block device."
9993 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696 ../src/guestfs-actions.pod:3744
9994 msgid "(Added in 1.5.1)"
9998 #: ../src/guestfs-actions.pod:3530
9999 msgid "guestfs_luks_format"
10003 #: ../src/guestfs-actions.pod:3532
10007 " guestfs_luks_format (guestfs_h *g,\n"
10008 " const char *device,\n"
10009 " const char *key,\n"
10015 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10017 "This command erases existing data on C<device> and formats the device as a "
10018 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10019 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10023 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568 ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433 ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567 ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10025 "B<This command is dangerous. Without careful use you can easily destroy all "
10030 #: ../src/guestfs-actions.pod:3554
10031 msgid "guestfs_luks_format_cipher"
10035 #: ../src/guestfs-actions.pod:3556
10039 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10040 " const char *device,\n"
10041 " const char *key,\n"
10043 " const char *cipher);\n"
10048 #: ../src/guestfs-actions.pod:3563
10050 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10051 "set the C<cipher> used."
10055 #: ../src/guestfs-actions.pod:3577
10056 msgid "guestfs_luks_kill_slot"
10060 #: ../src/guestfs-actions.pod:3579
10064 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10065 " const char *device,\n"
10066 " const char *key,\n"
10072 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10074 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10075 "device C<device>. C<key> must be one of the I<other> keys."
10079 #: ../src/guestfs-actions.pod:3597
10080 msgid "guestfs_luks_open"
10084 #: ../src/guestfs-actions.pod:3599
10088 " guestfs_luks_open (guestfs_h *g,\n"
10089 " const char *device,\n"
10090 " const char *key,\n"
10091 " const char *mapname);\n"
10096 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10098 "This command opens a block device which has been encrypted according to the "
10099 "Linux Unified Key Setup (LUKS) standard."
10103 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10104 msgid "C<device> is the encrypted block device or partition."
10108 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10110 "The caller must supply one of the keys associated with the LUKS block "
10111 "device, in the C<key> parameter."
10115 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10117 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10118 "writes to this block device are decrypted from and encrypted to the "
10119 "underlying C<device> respectively."
10123 #: ../src/guestfs-actions.pod:3617
10125 "If this block device contains LVM volume groups, then calling "
10126 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10131 #: ../src/guestfs-actions.pod:3629
10132 msgid "guestfs_luks_open_ro"
10136 #: ../src/guestfs-actions.pod:3631
10140 " guestfs_luks_open_ro (guestfs_h *g,\n"
10141 " const char *device,\n"
10142 " const char *key,\n"
10143 " const char *mapname);\n"
10148 #: ../src/guestfs-actions.pod:3637
10150 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10155 #: ../src/guestfs-actions.pod:3648
10156 msgid "guestfs_lvcreate"
10160 #: ../src/guestfs-actions.pod:3650
10164 " guestfs_lvcreate (guestfs_h *g,\n"
10165 " const char *logvol,\n"
10166 " const char *volgroup,\n"
10172 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10174 "This creates an LVM logical volume called C<logvol> on the volume group "
10175 "C<volgroup>, with C<size> megabytes."
10179 #: ../src/guestfs-actions.pod:3663
10180 msgid "guestfs_lvm_canonical_lv_name"
10184 #: ../src/guestfs-actions.pod:3665
10188 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10189 " const char *lvname);\n"
10194 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10196 "This converts alternative naming schemes for LVs that you might find to the "
10197 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
10202 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10204 "This command returns an error if the C<lvname> parameter does not refer to a "
10209 #: ../src/guestfs-actions.pod:3676
10210 msgid "See also C<guestfs_is_lv>."
10214 #: ../src/guestfs-actions.pod:3681
10215 msgid "(Added in 1.5.24)"
10219 #: ../src/guestfs-actions.pod:3683
10220 msgid "guestfs_lvm_clear_filter"
10224 #: ../src/guestfs-actions.pod:3685
10228 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10233 #: ../src/guestfs-actions.pod:3688
10235 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10236 "see every block device."
10240 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733 ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10241 msgid "This command also clears the LVM cache and performs a volume group scan."
10245 #: ../src/guestfs-actions.pod:3698
10246 msgid "guestfs_lvm_remove_all"
10250 #: ../src/guestfs-actions.pod:3700
10254 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10259 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10261 "This command removes all LVM logical volumes, volume groups and physical "
10266 #: ../src/guestfs-actions.pod:3713
10267 msgid "guestfs_lvm_set_filter"
10271 #: ../src/guestfs-actions.pod:3715
10275 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10276 " char *const *devices);\n"
10281 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10283 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10284 "block devices in the list C<devices>, and will ignore all other attached "
10289 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10291 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10292 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10293 "there are two types of duplication possible: either cloned PVs/VGs which "
10294 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10295 "same name. In normal operation you cannot create this situation, but you "
10296 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10297 "inside the LVM metadata."
10301 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10302 msgid "You can filter whole block devices or individual partitions."
10306 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10308 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10309 "filesystem), even if you are not filtering out that VG."
10313 #: ../src/guestfs-actions.pod:3746
10314 msgid "guestfs_lvremove"
10318 #: ../src/guestfs-actions.pod:3748
10322 " guestfs_lvremove (guestfs_h *g,\n"
10323 " const char *device);\n"
10328 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10330 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10331 "LV, such as C</dev/VG/LV>."
10335 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10337 "You can also remove all LVs in a volume group by specifying the VG name, "
10342 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914 ../src/guestfs-actions.pod:6644
10343 msgid "(Added in 1.0.13)"
10347 #: ../src/guestfs-actions.pod:3762
10348 msgid "guestfs_lvrename"
10352 #: ../src/guestfs-actions.pod:3764
10356 " guestfs_lvrename (guestfs_h *g,\n"
10357 " const char *logvol,\n"
10358 " const char *newlogvol);\n"
10363 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10364 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10368 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10369 msgid "(Added in 1.0.83)"
10373 #: ../src/guestfs-actions.pod:3775
10374 msgid "guestfs_lvresize"
10378 #: ../src/guestfs-actions.pod:3777
10382 " guestfs_lvresize (guestfs_h *g,\n"
10383 " const char *device,\n"
10389 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10391 "This resizes (expands or shrinks) an existing LVM logical volume to "
10392 "C<mbytes>. When reducing, data in the reduced part is lost."
10396 #: ../src/guestfs-actions.pod:3790
10397 msgid "guestfs_lvresize_free"
10401 #: ../src/guestfs-actions.pod:3792
10405 " guestfs_lvresize_free (guestfs_h *g,\n"
10406 " const char *lv,\n"
10412 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10414 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10415 "remaining free space in the volume group. Commonly you would call this with "
10416 "pc = 100 which expands the logical volume as much as possible, using all "
10417 "remaining free space in the volume group."
10421 #: ../src/guestfs-actions.pod:3805
10422 msgid "(Added in 1.3.3)"
10426 #: ../src/guestfs-actions.pod:3807
10427 msgid "guestfs_lvs"
10431 #: ../src/guestfs-actions.pod:3809
10435 " guestfs_lvs (guestfs_h *g);\n"
10440 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10442 "List all the logical volumes detected. This is the equivalent of the "
10443 "L<lvs(8)> command."
10447 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10449 "This returns a list of the logical volume device names "
10450 "(eg. C</dev/VolGroup00/LogVol00>)."
10454 #: ../src/guestfs-actions.pod:3818
10455 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10459 #: ../src/guestfs-actions.pod:3826
10460 msgid "guestfs_lvs_full"
10464 #: ../src/guestfs-actions.pod:3828
10467 " struct guestfs_lvm_lv_list *\n"
10468 " guestfs_lvs_full (guestfs_h *g);\n"
10473 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10475 "List all the logical volumes detected. This is the equivalent of the "
10476 "L<lvs(8)> command. The \"full\" version includes all fields."
10480 #: ../src/guestfs-actions.pod:3834
10482 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10483 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
10488 #: ../src/guestfs-actions.pod:3840
10489 msgid "guestfs_lvuuid"
10493 #: ../src/guestfs-actions.pod:3842
10497 " guestfs_lvuuid (guestfs_h *g,\n"
10498 " const char *device);\n"
10503 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10504 msgid "This command returns the UUID of the LVM LV C<device>."
10508 #: ../src/guestfs-actions.pod:3853
10509 msgid "guestfs_lxattrlist"
10513 #: ../src/guestfs-actions.pod:3855
10516 " struct guestfs_xattr_list *\n"
10517 " guestfs_lxattrlist (guestfs_h *g,\n"
10518 " const char *path,\n"
10519 " char *const *names);\n"
10524 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
10526 "This call allows you to get the extended attributes of multiple files, where "
10527 "all files are in the directory C<path>. C<names> is the list of files from "
10532 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
10534 "On return you get a flat list of xattr structs which must be interpreted "
10535 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10536 "C<attrval> in this struct is zero-length to indicate there was an error "
10537 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10538 "number (the number of following attributes for this file, which could be "
10539 "C<\"0\">). Then after the first xattr struct are the zero or more "
10540 "attributes for the first named file. This repeats for the second and "
10541 "subsequent files."
10545 #: ../src/guestfs-actions.pod:3874
10547 "This call is intended for programs that want to efficiently list a directory "
10548 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10549 "a similarly efficient call for getting standard stats. Very long directory "
10550 "listings might cause the protocol message size to be exceeded, causing this "
10551 "call to fail. The caller must split up such requests into smaller groups of "
10556 #: ../src/guestfs-actions.pod:3888
10557 msgid "guestfs_mkdir"
10561 #: ../src/guestfs-actions.pod:3890
10565 " guestfs_mkdir (guestfs_h *g,\n"
10566 " const char *path);\n"
10571 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
10572 msgid "Create a directory named C<path>."
10576 #: ../src/guestfs-actions.pod:3900
10577 msgid "guestfs_mkdir_mode"
10581 #: ../src/guestfs-actions.pod:3902
10585 " guestfs_mkdir_mode (guestfs_h *g,\n"
10586 " const char *path,\n"
10592 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
10594 "This command creates a directory, setting the initial permissions of the "
10595 "directory to C<mode>."
10599 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
10601 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10602 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10607 #: ../src/guestfs-actions.pod:3914
10608 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10612 #: ../src/guestfs-actions.pod:3920
10613 msgid "guestfs_mkdir_p"
10617 #: ../src/guestfs-actions.pod:3922
10621 " guestfs_mkdir_p (guestfs_h *g,\n"
10622 " const char *path);\n"
10627 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
10629 "Create a directory named C<path>, creating any parent directories as "
10630 "necessary. This is like the C<mkdir -p> shell command."
10634 #: ../src/guestfs-actions.pod:3933
10635 msgid "guestfs_mkdtemp"
10639 #: ../src/guestfs-actions.pod:3935
10643 " guestfs_mkdtemp (guestfs_h *g,\n"
10644 " const char *template);\n"
10649 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
10651 "This command creates a temporary directory. The C<template> parameter "
10652 "should be a full pathname for the temporary directory name with the final "
10653 "six characters being \"XXXXXX\"."
10657 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
10659 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10660 "being suitable for Windows filesystems."
10664 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
10665 msgid "The name of the temporary directory that was created is returned."
10669 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
10670 msgid "The temporary directory is created with mode 0700 and is owned by root."
10674 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
10676 "The caller is responsible for deleting the temporary directory and its "
10677 "contents after use."
10681 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
10682 msgid "See also: L<mkdtemp(3)>"
10686 #: ../src/guestfs-actions.pod:3963
10687 msgid "guestfs_mke2fs_J"
10691 #: ../src/guestfs-actions.pod:3965
10695 " guestfs_mke2fs_J (guestfs_h *g,\n"
10696 " const char *fstype,\n"
10697 " int blocksize,\n"
10698 " const char *device,\n"
10699 " const char *journal);\n"
10704 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
10706 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10707 "C<journal>. It is equivalent to the command:"
10711 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
10714 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10719 #: ../src/guestfs-actions.pod:3978
10720 msgid "See also C<guestfs_mke2journal>."
10724 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
10725 msgid "(Added in 1.0.68)"
10729 #: ../src/guestfs-actions.pod:3984
10730 msgid "guestfs_mke2fs_JL"
10734 #: ../src/guestfs-actions.pod:3986
10738 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10739 " const char *fstype,\n"
10740 " int blocksize,\n"
10741 " const char *device,\n"
10742 " const char *label);\n"
10747 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
10749 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10750 "the journal labeled C<label>."
10754 #: ../src/guestfs-actions.pod:3996
10755 msgid "See also C<guestfs_mke2journal_L>."
10759 #: ../src/guestfs-actions.pod:4002
10760 msgid "guestfs_mke2fs_JU"
10764 #: ../src/guestfs-actions.pod:4004
10768 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10769 " const char *fstype,\n"
10770 " int blocksize,\n"
10771 " const char *device,\n"
10772 " const char *uuid);\n"
10777 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
10779 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10780 "the journal with UUID C<uuid>."
10784 #: ../src/guestfs-actions.pod:4014
10785 msgid "See also C<guestfs_mke2journal_U>."
10789 #: ../src/guestfs-actions.pod:4020
10790 msgid "guestfs_mke2journal"
10794 #: ../src/guestfs-actions.pod:4022
10798 " guestfs_mke2journal (guestfs_h *g,\n"
10799 " int blocksize,\n"
10800 " const char *device);\n"
10805 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
10807 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10812 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
10815 " mke2fs -O journal_dev -b blocksize device\n"
10820 #: ../src/guestfs-actions.pod:4036
10821 msgid "guestfs_mke2journal_L"
10825 #: ../src/guestfs-actions.pod:4038
10829 " guestfs_mke2journal_L (guestfs_h *g,\n"
10830 " int blocksize,\n"
10831 " const char *label,\n"
10832 " const char *device);\n"
10837 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
10838 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10842 #: ../src/guestfs-actions.pod:4050
10843 msgid "guestfs_mke2journal_U"
10847 #: ../src/guestfs-actions.pod:4052
10851 " guestfs_mke2journal_U (guestfs_h *g,\n"
10852 " int blocksize,\n"
10853 " const char *uuid,\n"
10854 " const char *device);\n"
10859 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
10860 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10864 #: ../src/guestfs-actions.pod:4064
10865 msgid "guestfs_mkfifo"
10869 #: ../src/guestfs-actions.pod:4066
10873 " guestfs_mkfifo (guestfs_h *g,\n"
10875 " const char *path);\n"
10880 #: ../src/guestfs-actions.pod:4071
10882 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10883 "is just a convenient wrapper around C<guestfs_mknod>."
10887 #: ../src/guestfs-actions.pod:4081
10888 msgid "guestfs_mkfs"
10892 #: ../src/guestfs-actions.pod:4083
10896 " guestfs_mkfs (guestfs_h *g,\n"
10897 " const char *fstype,\n"
10898 " const char *device);\n"
10903 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
10905 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10906 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10910 #: ../src/guestfs-actions.pod:4096
10911 msgid "guestfs_mkfs_b"
10915 #: ../src/guestfs-actions.pod:4098
10919 " guestfs_mkfs_b (guestfs_h *g,\n"
10920 " const char *fstype,\n"
10921 " int blocksize,\n"
10922 " const char *device);\n"
10927 #: ../src/guestfs-actions.pod:4104
10929 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10930 "block size of the resulting filesystem. Supported block sizes depend on the "
10931 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10935 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
10937 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10942 #: ../src/guestfs-actions.pod:4116
10943 msgid "guestfs_mkmountpoint"
10947 #: ../src/guestfs-actions.pod:4118
10951 " guestfs_mkmountpoint (guestfs_h *g,\n"
10952 " const char *exemptpath);\n"
10957 #: ../src/guestfs-actions.pod:4122
10959 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10960 "that can be used to create extra mountpoints before mounting the first "
10965 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
10967 "These calls are I<only> necessary in some very limited circumstances, mainly "
10968 "the case where you want to mount a mix of unrelated and/or read-only "
10969 "filesystems together."
10973 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
10975 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10976 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10977 "inside that. You can unpack this as follows in guestfish:"
10981 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
10984 " add-ro Fedora-11-i686-Live.iso\n"
10986 " mkmountpoint /cd\n"
10987 " mkmountpoint /sqsh\n"
10988 " mkmountpoint /ext3fs\n"
10989 " mount /dev/sda /cd\n"
10990 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10991 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10996 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
10997 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11001 #: ../src/guestfs-actions.pod:4146
11003 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11004 "may get unexpected errors if you try to mix these calls. It is safest to "
11005 "manually unmount filesystems and remove mountpoints after use."
11009 #: ../src/guestfs-actions.pod:4150
11011 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11012 "first, so for this to work for manual mountpoints, you must ensure that the "
11013 "innermost mountpoints have the longest pathnames, as in the example code "
11018 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11019 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11023 #: ../src/guestfs-actions.pod:4157
11025 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11026 "means that C<guestfs_umount_all> is called when the handle is closed which "
11027 "can also trigger these issues."
11031 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422 ../src/guestfs-actions.pod:5315
11032 msgid "(Added in 1.0.62)"
11036 #: ../src/guestfs-actions.pod:4165
11037 msgid "guestfs_mknod"
11041 #: ../src/guestfs-actions.pod:4167
11045 " guestfs_mknod (guestfs_h *g,\n"
11049 " const char *path);\n"
11054 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11056 "This call creates block or character special devices, or named pipes "
11061 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11063 "The C<mode> parameter should be the mode, using the standard constants. "
11064 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11065 "used when creating block and character special devices."
11069 #: ../src/guestfs-actions.pod:4182
11071 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11072 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11073 "regular file). These constants are available in the standard Linux header "
11074 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11075 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11076 "the appropriate constant for you."
11080 #: ../src/guestfs-actions.pod:4196
11081 msgid "guestfs_mknod_b"
11085 #: ../src/guestfs-actions.pod:4198
11089 " guestfs_mknod_b (guestfs_h *g,\n"
11093 " const char *path);\n"
11098 #: ../src/guestfs-actions.pod:4205
11100 "This call creates a block device node called C<path> with mode C<mode> and "
11101 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11102 "wrapper around C<guestfs_mknod>."
11106 #: ../src/guestfs-actions.pod:4215
11107 msgid "guestfs_mknod_c"
11111 #: ../src/guestfs-actions.pod:4217
11115 " guestfs_mknod_c (guestfs_h *g,\n"
11119 " const char *path);\n"
11124 #: ../src/guestfs-actions.pod:4224
11126 "This call creates a char device node called C<path> with mode C<mode> and "
11127 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11128 "wrapper around C<guestfs_mknod>."
11132 #: ../src/guestfs-actions.pod:4234
11133 msgid "guestfs_mkswap"
11137 #: ../src/guestfs-actions.pod:4236
11141 " guestfs_mkswap (guestfs_h *g,\n"
11142 " const char *device);\n"
11147 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11148 msgid "Create a swap partition on C<device>."
11152 #: ../src/guestfs-actions.pod:4246
11153 msgid "guestfs_mkswap_L"
11157 #: ../src/guestfs-actions.pod:4248
11161 " guestfs_mkswap_L (guestfs_h *g,\n"
11162 " const char *label,\n"
11163 " const char *device);\n"
11168 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11169 msgid "Create a swap partition on C<device> with label C<label>."
11173 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11175 "Note that you cannot attach a swap label to a block device "
11176 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
11177 "the kernel or swap tools."
11181 #: ../src/guestfs-actions.pod:4263
11182 msgid "guestfs_mkswap_U"
11186 #: ../src/guestfs-actions.pod:4265
11190 " guestfs_mkswap_U (guestfs_h *g,\n"
11191 " const char *uuid,\n"
11192 " const char *device);\n"
11197 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11198 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11202 #: ../src/guestfs-actions.pod:4276
11203 msgid "guestfs_mkswap_file"
11207 #: ../src/guestfs-actions.pod:4278
11211 " guestfs_mkswap_file (guestfs_h *g,\n"
11212 " const char *path);\n"
11217 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11218 msgid "Create a swap file."
11222 #: ../src/guestfs-actions.pod:4284
11224 "This command just writes a swap file signature to an existing file. To "
11225 "create the file itself, use something like C<guestfs_fallocate>."
11229 #: ../src/guestfs-actions.pod:4291
11230 msgid "guestfs_modprobe"
11234 #: ../src/guestfs-actions.pod:4293
11238 " guestfs_modprobe (guestfs_h *g,\n"
11239 " const char *modulename);\n"
11244 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11245 msgid "This loads a kernel module in the appliance."
11249 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11251 "The kernel module must have been whitelisted when libguestfs was built (see "
11252 "C<appliance/kmod.whitelist.in> in the source)."
11256 #: ../src/guestfs-actions.pod:4306
11257 msgid "guestfs_mount"
11261 #: ../src/guestfs-actions.pod:4308
11265 " guestfs_mount (guestfs_h *g,\n"
11266 " const char *device,\n"
11267 " const char *mountpoint);\n"
11272 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11274 "Mount a guest disk at a position in the filesystem. Block devices are named "
11275 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11276 "those block devices contain partitions, they will have the usual names "
11277 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11281 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11283 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11284 "mounted on C</> before others can be mounted. Other filesystems can only be "
11285 "mounted on directories which already exist."
11289 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11291 "The mounted filesystem is writable, if we have sufficient permissions on the "
11292 "underlying device."
11296 #: ../src/guestfs-actions.pod:4327
11298 "B<Important note:> When you use this call, the filesystem options C<sync> "
11299 "and C<noatime> are set implicitly. This was originally done because we "
11300 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11301 "very large negative performance impact and negligible effect on "
11302 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11303 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11304 "(use an empty string for the first parameter if you don't want any options)."
11308 #: ../src/guestfs-actions.pod:4341
11309 msgid "guestfs_mount_loop"
11313 #: ../src/guestfs-actions.pod:4343
11317 " guestfs_mount_loop (guestfs_h *g,\n"
11318 " const char *file,\n"
11319 " const char *mountpoint);\n"
11324 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11326 "This command lets you mount C<file> (a filesystem image in a file) on a "
11327 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11332 #: ../src/guestfs-actions.pod:4356
11333 msgid "guestfs_mount_options"
11337 #: ../src/guestfs-actions.pod:4358
11341 " guestfs_mount_options (guestfs_h *g,\n"
11342 " const char *options,\n"
11343 " const char *device,\n"
11344 " const char *mountpoint);\n"
11349 #: ../src/guestfs-actions.pod:4364
11351 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11352 "the mount options as for the L<mount(8)> I<-o> flag."
11356 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11358 "If the C<options> parameter is an empty string, then no options are passed "
11359 "(all options default to whatever the filesystem uses)."
11363 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388 ../src/guestfs-actions.pod:4405
11364 msgid "(Added in 1.0.10)"
11368 #: ../src/guestfs-actions.pod:4376
11369 msgid "guestfs_mount_ro"
11373 #: ../src/guestfs-actions.pod:4378
11377 " guestfs_mount_ro (guestfs_h *g,\n"
11378 " const char *device,\n"
11379 " const char *mountpoint);\n"
11384 #: ../src/guestfs-actions.pod:4383
11386 "This is the same as the C<guestfs_mount> command, but it mounts the "
11387 "filesystem with the read-only (I<-o ro>) flag."
11391 #: ../src/guestfs-actions.pod:4390
11392 msgid "guestfs_mount_vfs"
11396 #: ../src/guestfs-actions.pod:4392
11400 " guestfs_mount_vfs (guestfs_h *g,\n"
11401 " const char *options,\n"
11402 " const char *vfstype,\n"
11403 " const char *device,\n"
11404 " const char *mountpoint);\n"
11409 #: ../src/guestfs-actions.pod:4399
11411 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11412 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
11417 #: ../src/guestfs-actions.pod:4407
11418 msgid "guestfs_mountpoints"
11422 #: ../src/guestfs-actions.pod:4409
11426 " guestfs_mountpoints (guestfs_h *g);\n"
11431 #: ../src/guestfs-actions.pod:4412
11433 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11434 "devices. This one returns a hash table (map) of device name to directory "
11435 "where the device is mounted."
11439 #: ../src/guestfs-actions.pod:4424
11440 msgid "guestfs_mounts"
11444 #: ../src/guestfs-actions.pod:4426
11448 " guestfs_mounts (guestfs_h *g);\n"
11453 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11455 "This returns the list of currently mounted filesystems. It returns the list "
11456 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11460 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11461 msgid "Some internal mounts are not shown."
11465 #: ../src/guestfs-actions.pod:4434
11466 msgid "See also: C<guestfs_mountpoints>"
11470 #: ../src/guestfs-actions.pod:4442
11475 #: ../src/guestfs-actions.pod:4444
11479 " guestfs_mv (guestfs_h *g,\n"
11480 " const char *src,\n"
11481 " const char *dest);\n"
11486 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11488 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11489 "destination filename or destination directory."
11493 #: ../src/guestfs-actions.pod:4456
11494 msgid "guestfs_ntfs_3g_probe"
11498 #: ../src/guestfs-actions.pod:4458
11502 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11504 " const char *device);\n"
11509 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11511 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11512 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11513 "read-write, and some cannot be mounted at all)."
11517 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11519 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11520 "can be mounted read-write. Set it to false if you want to test if the "
11521 "volume can be mounted read-only."
11525 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
11527 "The return value is an integer which C<0> if the operation would succeed, or "
11528 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11532 #: ../src/guestfs-actions.pod:4477
11533 msgid "(Added in 1.0.43)"
11537 #: ../src/guestfs-actions.pod:4479
11538 msgid "guestfs_ntfsresize"
11542 #: ../src/guestfs-actions.pod:4481
11546 " guestfs_ntfsresize (guestfs_h *g,\n"
11547 " const char *device);\n"
11552 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
11554 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11555 "size of the underlying device. See also L<ntfsresize(8)>."
11559 #: ../src/guestfs-actions.pod:4493
11560 msgid "guestfs_ntfsresize_size"
11564 #: ../src/guestfs-actions.pod:4495
11568 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11569 " const char *device,\n"
11570 " int64_t size);\n"
11575 #: ../src/guestfs-actions.pod:4500
11577 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11578 "to specify the new size (in bytes) explicitly."
11582 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941 ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
11583 msgid "(Added in 1.3.14)"
11587 #: ../src/guestfs-actions.pod:4507
11588 msgid "guestfs_part_add"
11592 #: ../src/guestfs-actions.pod:4509
11596 " guestfs_part_add (guestfs_h *g,\n"
11597 " const char *device,\n"
11598 " const char *prlogex,\n"
11599 " int64_t startsect,\n"
11600 " int64_t endsect);\n"
11605 #: ../src/guestfs-actions.pod:4516
11607 "This command adds a partition to C<device>. If there is no partition table "
11608 "on the device, call C<guestfs_part_init> first."
11612 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
11614 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11615 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11616 "C<logical>) and C<e> (or C<extended>) partition types."
11620 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
11622 "C<startsect> and C<endsect> are the start and end of the partition in "
11623 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11624 "from the end of the disk (C<-1> is the last sector)."
11628 #: ../src/guestfs-actions.pod:4528
11630 "Creating a partition which covers the whole disk is not so easy. Use "
11631 "C<guestfs_part_disk> to do that."
11635 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4799
11636 msgid "(Added in 1.0.78)"
11640 #: ../src/guestfs-actions.pod:4535
11641 msgid "guestfs_part_del"
11645 #: ../src/guestfs-actions.pod:4537
11649 " guestfs_part_del (guestfs_h *g,\n"
11650 " const char *device,\n"
11656 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
11657 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11661 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
11663 "Note that in the case of MBR partitioning, deleting an extended partition "
11664 "also deletes any logical partitions it contains."
11668 #: ../src/guestfs-actions.pod:4552
11669 msgid "guestfs_part_disk"
11673 #: ../src/guestfs-actions.pod:4554
11677 " guestfs_part_disk (guestfs_h *g,\n"
11678 " const char *device,\n"
11679 " const char *parttype);\n"
11684 #: ../src/guestfs-actions.pod:4559
11686 "This command is simply a combination of C<guestfs_part_init> followed by "
11687 "C<guestfs_part_add> to create a single primary partition covering the whole "
11692 #: ../src/guestfs-actions.pod:4563
11694 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11695 "possible values are described in C<guestfs_part_init>."
11699 #: ../src/guestfs-actions.pod:4573
11700 msgid "guestfs_part_get_bootable"
11704 #: ../src/guestfs-actions.pod:4575
11708 " guestfs_part_get_bootable (guestfs_h *g,\n"
11709 " const char *device,\n"
11715 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
11717 "This command returns true if the partition C<partnum> on C<device> has the "
11718 "bootable flag set."
11722 #: ../src/guestfs-actions.pod:4583
11723 msgid "See also C<guestfs_part_set_bootable>."
11727 #: ../src/guestfs-actions.pod:4589
11728 msgid "guestfs_part_get_mbr_id"
11732 #: ../src/guestfs-actions.pod:4591
11736 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11737 " const char *device,\n"
11743 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
11745 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11746 "partition C<partnum>."
11750 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
11752 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11753 "undefined results for other partition table types (see "
11754 "C<guestfs_part_get_parttype>)."
11758 #: ../src/guestfs-actions.pod:4607
11759 msgid "guestfs_part_get_parttype"
11763 #: ../src/guestfs-actions.pod:4609
11767 " guestfs_part_get_parttype (guestfs_h *g,\n"
11768 " const char *device);\n"
11773 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
11775 "This command examines the partition table on C<device> and returns the "
11776 "partition table type (format) being used."
11780 #: ../src/guestfs-actions.pod:4616
11782 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11783 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11784 "possible, although unusual. See C<guestfs_part_init> for a full list."
11788 #: ../src/guestfs-actions.pod:4626
11789 msgid "guestfs_part_init"
11793 #: ../src/guestfs-actions.pod:4628
11797 " guestfs_part_init (guestfs_h *g,\n"
11798 " const char *device,\n"
11799 " const char *parttype);\n"
11804 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
11806 "This creates an empty partition table on C<device> of one of the partition "
11807 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11808 "(for large disks)."
11812 #: ../src/guestfs-actions.pod:4637
11814 "Initially there are no partitions. Following this, you should call "
11815 "C<guestfs_part_add> for each partition required."
11819 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
11820 msgid "Possible values for C<parttype> are:"
11824 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
11825 msgid "B<efi> | B<gpt>"
11829 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
11830 msgid "Intel EFI / GPT partition table."
11834 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
11836 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11837 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11838 "the C<mbr> format."
11842 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
11843 msgid "B<mbr> | B<msdos>"
11847 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
11849 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11850 "Windows. This partition type will B<only> work for device sizes up to 2 "
11851 "TB. For large disks we recommend using C<gpt>."
11855 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
11856 msgid "Other partition table types that may work but are not supported include:"
11860 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
11865 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
11866 msgid "AIX disk labels."
11870 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
11871 msgid "B<amiga> | B<rdb>"
11875 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
11876 msgid "Amiga \"Rigid Disk Block\" format."
11880 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
11885 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
11886 msgid "BSD disk labels."
11890 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
11895 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
11896 msgid "DASD, used on IBM mainframes."
11900 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
11905 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
11906 msgid "MIPS/SGI volumes."
11910 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
11915 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
11916 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11920 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
11925 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
11926 msgid "NEC PC-98 format, common in Japan apparently."
11930 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
11935 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
11936 msgid "Sun disk labels."
11940 #: ../src/guestfs-actions.pod:4704
11941 msgid "guestfs_part_list"
11945 #: ../src/guestfs-actions.pod:4706
11948 " struct guestfs_partition_list *\n"
11949 " guestfs_part_list (guestfs_h *g,\n"
11950 " const char *device);\n"
11955 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
11957 "This command parses the partition table on C<device> and returns the list of "
11958 "partitions found."
11962 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
11963 msgid "The fields in the returned structure are:"
11967 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
11968 msgid "B<part_num>"
11972 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
11973 msgid "Partition number, counting from 1."
11977 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
11978 msgid "B<part_start>"
11982 #: ../src/guestfs-actions.pod:4723
11984 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11985 "the device's sector size, see C<guestfs_blockdev_getss>."
11989 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
11990 msgid "B<part_end>"
11994 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
11995 msgid "End of the partition in bytes."
11999 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12000 msgid "B<part_size>"
12004 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12005 msgid "Size of the partition in bytes."
12009 #: ../src/guestfs-actions.pod:4736
12011 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12012 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12017 #: ../src/guestfs-actions.pod:4742
12018 msgid "guestfs_part_set_bootable"
12022 #: ../src/guestfs-actions.pod:4744
12026 " guestfs_part_set_bootable (guestfs_h *g,\n"
12027 " const char *device,\n"
12029 " int bootable);\n"
12034 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12036 "This sets the bootable flag on partition numbered C<partnum> on device "
12037 "C<device>. Note that partitions are numbered from 1."
12041 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12043 "The bootable flag is used by some operating systems (notably Windows) to "
12044 "determine which partition to boot from. It is by no means universally "
12049 #: ../src/guestfs-actions.pod:4761
12050 msgid "guestfs_part_set_mbr_id"
12054 #: ../src/guestfs-actions.pod:4763
12058 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12059 " const char *device,\n"
12066 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12068 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12069 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12070 "documentation are in fact hexadecimal numbers, but usually documented "
12071 "without any leading \"0x\" which might be confusing."
12075 #: ../src/guestfs-actions.pod:4783
12076 msgid "guestfs_part_set_name"
12080 #: ../src/guestfs-actions.pod:4785
12084 " guestfs_part_set_name (guestfs_h *g,\n"
12085 " const char *device,\n"
12087 " const char *name);\n"
12092 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12094 "This sets the partition name on partition numbered C<partnum> on device "
12095 "C<device>. Note that partitions are numbered from 1."
12099 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12101 "The partition name can only be set on certain types of partition table. "
12102 "This works on C<gpt> but not on C<mbr> partitions."
12106 #: ../src/guestfs-actions.pod:4801
12107 msgid "guestfs_part_to_dev"
12111 #: ../src/guestfs-actions.pod:4803
12115 " guestfs_part_to_dev (guestfs_h *g,\n"
12116 " const char *partition);\n"
12121 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12123 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12124 "partition number, returning the device name (eg. \"/dev/sdb\")."
12128 #: ../src/guestfs-actions.pod:4811
12130 "The named partition must exist, for example as a string returned from "
12131 "C<guestfs_list_partitions>."
12135 #: ../src/guestfs-actions.pod:4819
12136 msgid "guestfs_ping_daemon"
12140 #: ../src/guestfs-actions.pod:4821
12144 " guestfs_ping_daemon (guestfs_h *g);\n"
12149 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12151 "This is a test probe into the guestfs daemon running inside the qemu "
12152 "subprocess. Calling this function checks that the daemon responds to the "
12153 "ping message, without affecting the daemon or attached block device(s) in "
12158 #: ../src/guestfs-actions.pod:4833
12159 msgid "guestfs_pread"
12163 #: ../src/guestfs-actions.pod:4835
12167 " guestfs_pread (guestfs_h *g,\n"
12168 " const char *path,\n"
12170 " int64_t offset,\n"
12171 " size_t *size_r);\n"
12176 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12178 "This command lets you read part of a file. It reads C<count> bytes of the "
12179 "file, starting at C<offset>, from file C<path>."
12183 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12185 "This may read fewer bytes than requested. For further details see the "
12186 "L<pread(2)> system call."
12190 #: ../src/guestfs-actions.pod:4848
12191 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12195 #: ../src/guestfs-actions.pod:4859
12196 msgid "guestfs_pread_device"
12200 #: ../src/guestfs-actions.pod:4861
12204 " guestfs_pread_device (guestfs_h *g,\n"
12205 " const char *device,\n"
12207 " int64_t offset,\n"
12208 " size_t *size_r);\n"
12213 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12215 "This command lets you read part of a file. It reads C<count> bytes of "
12216 "C<device>, starting at C<offset>."
12220 #: ../src/guestfs-actions.pod:4874
12221 msgid "See also C<guestfs_pread>."
12225 #: ../src/guestfs-actions.pod:4883
12226 msgid "(Added in 1.5.21)"
12230 #: ../src/guestfs-actions.pod:4885
12231 msgid "guestfs_pvcreate"
12235 #: ../src/guestfs-actions.pod:4887
12239 " guestfs_pvcreate (guestfs_h *g,\n"
12240 " const char *device);\n"
12245 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12247 "This creates an LVM physical volume on the named C<device>, where C<device> "
12248 "should usually be a partition name such as C</dev/sda1>."
12252 #: ../src/guestfs-actions.pod:4899
12253 msgid "guestfs_pvremove"
12257 #: ../src/guestfs-actions.pod:4901
12261 " guestfs_pvremove (guestfs_h *g,\n"
12262 " const char *device);\n"
12267 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12269 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12274 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12276 "The implementation uses the C<pvremove> command which refuses to wipe "
12277 "physical volumes that contain any volume groups, so you have to remove those "
12282 #: ../src/guestfs-actions.pod:4916
12283 msgid "guestfs_pvresize"
12287 #: ../src/guestfs-actions.pod:4918
12291 " guestfs_pvresize (guestfs_h *g,\n"
12292 " const char *device);\n"
12297 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12299 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12300 "the new size of the underlying device."
12304 #: ../src/guestfs-actions.pod:4929
12305 msgid "guestfs_pvresize_size"
12309 #: ../src/guestfs-actions.pod:4931
12313 " guestfs_pvresize_size (guestfs_h *g,\n"
12314 " const char *device,\n"
12315 " int64_t size);\n"
12320 #: ../src/guestfs-actions.pod:4936
12322 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12323 "specify the new size (in bytes) explicitly."
12327 #: ../src/guestfs-actions.pod:4943
12328 msgid "guestfs_pvs"
12332 #: ../src/guestfs-actions.pod:4945
12336 " guestfs_pvs (guestfs_h *g);\n"
12341 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12343 "List all the physical volumes detected. This is the equivalent of the "
12344 "L<pvs(8)> command."
12348 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12350 "This returns a list of just the device names that contain PVs "
12351 "(eg. C</dev/sda2>)."
12355 #: ../src/guestfs-actions.pod:4954
12356 msgid "See also C<guestfs_pvs_full>."
12360 #: ../src/guestfs-actions.pod:4962
12361 msgid "guestfs_pvs_full"
12365 #: ../src/guestfs-actions.pod:4964
12368 " struct guestfs_lvm_pv_list *\n"
12369 " guestfs_pvs_full (guestfs_h *g);\n"
12374 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12376 "List all the physical volumes detected. This is the equivalent of the "
12377 "L<pvs(8)> command. The \"full\" version includes all fields."
12381 #: ../src/guestfs-actions.pod:4970
12383 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12384 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
12389 #: ../src/guestfs-actions.pod:4976
12390 msgid "guestfs_pvuuid"
12394 #: ../src/guestfs-actions.pod:4978
12398 " guestfs_pvuuid (guestfs_h *g,\n"
12399 " const char *device);\n"
12404 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12405 msgid "This command returns the UUID of the LVM PV C<device>."
12409 #: ../src/guestfs-actions.pod:4989
12410 msgid "guestfs_pwrite"
12414 #: ../src/guestfs-actions.pod:4991
12418 " guestfs_pwrite (guestfs_h *g,\n"
12419 " const char *path,\n"
12420 " const char *content,\n"
12421 " size_t content_size,\n"
12422 " int64_t offset);\n"
12427 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12429 "This command writes to part of a file. It writes the data buffer C<content> "
12430 "to the file C<path> starting at offset C<offset>."
12434 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12436 "This command implements the L<pwrite(2)> system call, and like that system "
12437 "call it may not write the full data requested. The return value is the "
12438 "number of bytes that were actually written to the file. This could even be "
12439 "0, although short writes are unlikely for regular files in ordinary "
12444 #: ../src/guestfs-actions.pod:5007
12445 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12449 #: ../src/guestfs-actions.pod:5016
12450 msgid "guestfs_pwrite_device"
12454 #: ../src/guestfs-actions.pod:5018
12458 " guestfs_pwrite_device (guestfs_h *g,\n"
12459 " const char *device,\n"
12460 " const char *content,\n"
12461 " size_t content_size,\n"
12462 " int64_t offset);\n"
12467 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12469 "This command writes to part of a device. It writes the data buffer "
12470 "C<content> to C<device> starting at offset C<offset>."
12474 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12476 "This command implements the L<pwrite(2)> system call, and like that system "
12477 "call it may not write the full data requested (although short writes to disk "
12478 "devices and partitions are probably impossible with standard Linux kernels)."
12482 #: ../src/guestfs-actions.pod:5033
12483 msgid "See also C<guestfs_pwrite>."
12487 #: ../src/guestfs-actions.pod:5040
12488 msgid "(Added in 1.5.20)"
12492 #: ../src/guestfs-actions.pod:5042
12493 msgid "guestfs_read_file"
12497 #: ../src/guestfs-actions.pod:5044
12501 " guestfs_read_file (guestfs_h *g,\n"
12502 " const char *path,\n"
12503 " size_t *size_r);\n"
12508 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12509 msgid "This calls returns the contents of the file C<path> as a buffer."
12513 #: ../src/guestfs-actions.pod:5052
12515 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12516 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12517 "function is limited in the total size of file that can be handled."
12521 #: ../src/guestfs-actions.pod:5064
12522 msgid "(Added in 1.0.63)"
12526 #: ../src/guestfs-actions.pod:5066
12527 msgid "guestfs_read_lines"
12531 #: ../src/guestfs-actions.pod:5068
12535 " guestfs_read_lines (guestfs_h *g,\n"
12536 " const char *path);\n"
12541 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
12543 "The file contents are returned as a list of lines. Trailing C<LF> and "
12544 "C<CRLF> character sequences are I<not> returned."
12548 #: ../src/guestfs-actions.pod:5077
12550 "Note that this function cannot correctly handle binary files (specifically, "
12551 "files containing C<\\0> character which is treated as end of line). For "
12552 "those you need to use the C<guestfs_read_file> function which has a more "
12553 "complex interface."
12557 #: ../src/guestfs-actions.pod:5088
12558 msgid "guestfs_readdir"
12562 #: ../src/guestfs-actions.pod:5090
12565 " struct guestfs_dirent_list *\n"
12566 " guestfs_readdir (guestfs_h *g,\n"
12567 " const char *dir);\n"
12572 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
12573 msgid "This returns the list of directory entries in directory C<dir>."
12577 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
12579 "All entries in the directory are returned, including C<.> and C<..>. The "
12580 "entries are I<not> sorted, but returned in the same order as the underlying "
12585 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
12587 "Also this call returns basic file type information about each file. The "
12588 "C<ftyp> field will contain one of the following characters:"
12592 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
12597 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
12598 msgid "Block special"
12602 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
12607 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
12608 msgid "Char special"
12612 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
12617 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
12622 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
12627 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
12628 msgid "FIFO (named pipe)"
12632 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
12637 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
12638 msgid "Symbolic link"
12642 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
12647 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
12648 msgid "Regular file"
12652 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
12657 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
12662 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
12667 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
12668 msgid "Unknown file type"
12672 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
12677 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
12678 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12682 #: ../src/guestfs-actions.pod:5144
12684 "This function is primarily intended for use by programs. To get a simple "
12685 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12686 "consumption, use C<guestfs_ll>."
12690 #: ../src/guestfs-actions.pod:5148
12692 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12693 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
12698 #: ../src/guestfs-actions.pod:5154
12699 msgid "guestfs_readlink"
12703 #: ../src/guestfs-actions.pod:5156
12707 " guestfs_readlink (guestfs_h *g,\n"
12708 " const char *path);\n"
12713 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
12714 msgid "This command reads the target of a symbolic link."
12718 #: ../src/guestfs-actions.pod:5167
12719 msgid "guestfs_readlinklist"
12723 #: ../src/guestfs-actions.pod:5169
12727 " guestfs_readlinklist (guestfs_h *g,\n"
12728 " const char *path,\n"
12729 " char *const *names);\n"
12734 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
12736 "This call allows you to do a C<readlink> operation on multiple files, where "
12737 "all files are in the directory C<path>. C<names> is the list of files from "
12742 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
12744 "On return you get a list of strings, with a one-to-one correspondence to the "
12745 "C<names> list. Each string is the value of the symbolic link."
12749 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
12751 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12752 "result string is the empty string C<\"\">. However the whole operation is "
12753 "completed even if there were C<readlink(2)> errors, and so you can call this "
12754 "function with names where you don't know if they are symbolic links already "
12755 "(albeit slightly less efficient)."
12759 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
12761 "This call is intended for programs that want to efficiently list a directory "
12762 "contents without making many round-trips. Very long directory listings "
12763 "might cause the protocol message size to be exceeded, causing this call to "
12764 "fail. The caller must split up such requests into smaller groups of names."
12768 #: ../src/guestfs-actions.pod:5202
12769 msgid "guestfs_realpath"
12773 #: ../src/guestfs-actions.pod:5204
12777 " guestfs_realpath (guestfs_h *g,\n"
12778 " const char *path);\n"
12783 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
12785 "Return the canonicalized absolute pathname of C<path>. The returned path "
12786 "has no C<.>, C<..> or symbolic link path elements."
12790 #: ../src/guestfs-actions.pod:5216
12791 msgid "guestfs_removexattr"
12795 #: ../src/guestfs-actions.pod:5218
12799 " guestfs_removexattr (guestfs_h *g,\n"
12800 " const char *xattr,\n"
12801 " const char *path);\n"
12806 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
12807 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12811 #: ../src/guestfs-actions.pod:5226
12812 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12816 #: ../src/guestfs-actions.pod:5232
12817 msgid "guestfs_resize2fs"
12821 #: ../src/guestfs-actions.pod:5234
12825 " guestfs_resize2fs (guestfs_h *g,\n"
12826 " const char *device);\n"
12831 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
12833 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12834 "underlying device."
12838 #: ../src/guestfs-actions.pod:5241
12840 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12841 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12842 "sometimes gives an error about this and sometimes not. In any case, it is "
12843 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12847 #: ../src/guestfs-actions.pod:5251
12848 msgid "guestfs_resize2fs_size"
12852 #: ../src/guestfs-actions.pod:5253
12856 " guestfs_resize2fs_size (guestfs_h *g,\n"
12857 " const char *device,\n"
12858 " int64_t size);\n"
12863 #: ../src/guestfs-actions.pod:5258
12865 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12866 "to specify the new size (in bytes) explicitly."
12870 #: ../src/guestfs-actions.pod:5265
12875 #: ../src/guestfs-actions.pod:5267
12879 " guestfs_rm (guestfs_h *g,\n"
12880 " const char *path);\n"
12885 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
12886 msgid "Remove the single file C<path>."
12890 #: ../src/guestfs-actions.pod:5277
12891 msgid "guestfs_rm_rf"
12895 #: ../src/guestfs-actions.pod:5279
12899 " guestfs_rm_rf (guestfs_h *g,\n"
12900 " const char *path);\n"
12905 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
12907 "Remove the file or directory C<path>, recursively removing the contents if "
12908 "its a directory. This is like the C<rm -rf> shell command."
12912 #: ../src/guestfs-actions.pod:5291
12913 msgid "guestfs_rmdir"
12917 #: ../src/guestfs-actions.pod:5293
12921 " guestfs_rmdir (guestfs_h *g,\n"
12922 " const char *path);\n"
12927 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
12928 msgid "Remove the single directory C<path>."
12932 #: ../src/guestfs-actions.pod:5303
12933 msgid "guestfs_rmmountpoint"
12937 #: ../src/guestfs-actions.pod:5305
12941 " guestfs_rmmountpoint (guestfs_h *g,\n"
12942 " const char *exemptpath);\n"
12947 #: ../src/guestfs-actions.pod:5309
12949 "This calls removes a mountpoint that was previously created with "
12950 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12954 #: ../src/guestfs-actions.pod:5317
12955 msgid "guestfs_scrub_device"
12959 #: ../src/guestfs-actions.pod:5319
12963 " guestfs_scrub_device (guestfs_h *g,\n"
12964 " const char *device);\n"
12969 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
12971 "This command writes patterns over C<device> to make data retrieval more "
12976 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347 ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564 ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
12978 "It is an interface to the L<scrub(1)> program. See that manual page for "
12983 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5371
12984 msgid "(Added in 1.0.52)"
12988 #: ../src/guestfs-actions.pod:5336
12989 msgid "guestfs_scrub_file"
12993 #: ../src/guestfs-actions.pod:5338
12997 " guestfs_scrub_file (guestfs_h *g,\n"
12998 " const char *file);\n"
13003 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13005 "This command writes patterns over a file to make data retrieval more "
13010 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13011 msgid "The file is I<removed> after scrubbing."
13015 #: ../src/guestfs-actions.pod:5354
13016 msgid "guestfs_scrub_freespace"
13020 #: ../src/guestfs-actions.pod:5356
13024 " guestfs_scrub_freespace (guestfs_h *g,\n"
13025 " const char *dir);\n"
13030 #: ../src/guestfs-actions.pod:5360
13032 "This command creates the directory C<dir> and then fills it with files until "
13033 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13034 "and deletes them. The intention is to scrub any free space on the partition "
13035 "containing C<dir>."
13039 #: ../src/guestfs-actions.pod:5373
13040 msgid "guestfs_set_append"
13044 #: ../src/guestfs-actions.pod:5375
13048 " guestfs_set_append (guestfs_h *g,\n"
13049 " const char *append);\n"
13054 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13056 "This function is used to add additional options to the guest kernel command "
13061 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13063 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13064 "environment variable."
13068 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13070 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13071 "(libguestfs always adds a few of its own)."
13075 #: ../src/guestfs-actions.pod:5392
13076 msgid "guestfs_set_autosync"
13080 #: ../src/guestfs-actions.pod:5394
13084 " guestfs_set_autosync (guestfs_h *g,\n"
13085 " int autosync);\n"
13090 #: ../src/guestfs-actions.pod:5398
13092 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13093 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13094 "the handle is closed (also if the program exits without closing handles)."
13098 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13100 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13101 "disabled by default)."
13105 #: ../src/guestfs-actions.pod:5410
13106 msgid "guestfs_set_direct"
13110 #: ../src/guestfs-actions.pod:5412
13114 " guestfs_set_direct (guestfs_h *g,\n"
13120 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13122 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13123 "passed directly through to the appliance once it is launched."
13127 #: ../src/guestfs-actions.pod:5420
13129 "One consequence of this is that log messages aren't caught by the library "
13130 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13135 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13136 msgid "You probably don't want to use this unless you know what you are doing."
13140 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13141 msgid "The default is disabled."
13145 #: ../src/guestfs-actions.pod:5433
13146 msgid "guestfs_set_e2label"
13150 #: ../src/guestfs-actions.pod:5435
13154 " guestfs_set_e2label (guestfs_h *g,\n"
13155 " const char *device,\n"
13156 " const char *label);\n"
13161 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13163 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13164 "C<label>. Filesystem labels are limited to 16 characters."
13168 #: ../src/guestfs-actions.pod:5444
13170 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13171 "the existing label on a filesystem."
13175 #: ../src/guestfs-actions.pod:5451
13176 msgid "guestfs_set_e2uuid"
13180 #: ../src/guestfs-actions.pod:5453
13184 " guestfs_set_e2uuid (guestfs_h *g,\n"
13185 " const char *device,\n"
13186 " const char *uuid);\n"
13191 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13193 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13194 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13195 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13199 #: ../src/guestfs-actions.pod:5463
13201 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13202 "the existing UUID of a filesystem."
13206 #: ../src/guestfs-actions.pod:5470
13207 msgid "guestfs_set_memsize"
13211 #: ../src/guestfs-actions.pod:5472
13215 " guestfs_set_memsize (guestfs_h *g,\n"
13221 #: ../src/guestfs-actions.pod:5476
13223 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13224 "This only has any effect if called before C<guestfs_launch>."
13228 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13230 "You can also change this by setting the environment variable "
13231 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13235 #: ../src/guestfs-actions.pod:5491
13236 msgid "guestfs_set_network"
13240 #: ../src/guestfs-actions.pod:5493
13244 " guestfs_set_network (guestfs_h *g,\n"
13250 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13252 "If C<network> is true, then the network is enabled in the libguestfs "
13253 "appliance. The default is false."
13257 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13259 "This affects whether commands are able to access the network (see "
13260 "L<guestfs(3)/RUNNING COMMANDS>)."
13264 #: ../src/guestfs-actions.pod:5503
13266 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13271 #: ../src/guestfs-actions.pod:5510
13272 msgid "guestfs_set_path"
13276 #: ../src/guestfs-actions.pod:5512
13280 " guestfs_set_path (guestfs_h *g,\n"
13281 " const char *searchpath);\n"
13286 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13287 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13291 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13293 "The default is C<$libdir/guestfs> unless overridden by setting "
13294 "C<LIBGUESTFS_PATH> environment variable."
13298 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13299 msgid "Setting C<path> to C<NULL> restores the default path."
13303 #: ../src/guestfs-actions.pod:5527
13304 msgid "guestfs_set_qemu"
13308 #: ../src/guestfs-actions.pod:5529
13312 " guestfs_set_qemu (guestfs_h *g,\n"
13313 " const char *qemu);\n"
13318 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13319 msgid "Set the qemu binary that we will use."
13323 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13324 msgid "The default is chosen when the library was compiled by the configure script."
13328 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13330 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13335 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13336 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13340 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13342 "Note that you should call this function as early as possible after creating "
13343 "the handle. This is because some pre-launch operations depend on testing "
13344 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13345 "don't retest features, and so you might see inconsistent results. Using the "
13346 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13347 "the qemu binary at the same time as the handle is created."
13351 #: ../src/guestfs-actions.pod:5555
13352 msgid "guestfs_set_recovery_proc"
13356 #: ../src/guestfs-actions.pod:5557
13360 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13361 " int recoveryproc);\n"
13366 #: ../src/guestfs-actions.pod:5561
13368 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13369 "not create a recovery process. The purpose of the recovery process is to "
13370 "stop runaway qemu processes in the case where the main program aborts "
13375 #: ../src/guestfs-actions.pod:5566
13377 "This only has any effect if called before C<guestfs_launch>, and the default "
13382 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13384 "About the only time when you would want to disable this is if the main "
13385 "process will fork itself into the background (\"daemonize\" itself). In "
13386 "this case the recovery process thinks that the main program has disappeared "
13387 "and so kills qemu, which is not very helpful."
13391 #: ../src/guestfs-actions.pod:5579
13392 msgid "guestfs_set_selinux"
13396 #: ../src/guestfs-actions.pod:5581
13400 " guestfs_set_selinux (guestfs_h *g,\n"
13406 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13408 "This sets the selinux flag that is passed to the appliance at boot time. "
13409 "The default is C<selinux=0> (disabled)."
13413 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13415 "Note that if SELinux is enabled, it is always in Permissive mode "
13416 "(C<enforcing=0>)."
13420 #: ../src/guestfs-actions.pod:5598
13421 msgid "guestfs_set_trace"
13425 #: ../src/guestfs-actions.pod:5600
13429 " guestfs_set_trace (guestfs_h *g,\n"
13435 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13437 "If the command trace flag is set to 1, then commands are printed on stderr "
13438 "before they are executed in a format which is very similar to the one used "
13439 "by guestfish. In other words, you can run a program with this enabled, and "
13440 "you will get out a script which you can feed to guestfish to perform the "
13441 "same set of actions."
13445 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13447 "If you want to trace C API calls into libguestfs (and other libraries) then "
13448 "possibly a better way is to use the external ltrace(1) command."
13452 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13454 "Command traces are disabled unless the environment variable "
13455 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13459 #: ../src/guestfs-actions.pod:5622
13460 msgid "guestfs_set_verbose"
13464 #: ../src/guestfs-actions.pod:5624
13468 " guestfs_set_verbose (guestfs_h *g,\n"
13474 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13475 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13479 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13481 "Verbose messages are disabled unless the environment variable "
13482 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13486 #: ../src/guestfs-actions.pod:5637
13487 msgid "guestfs_setcon"
13491 #: ../src/guestfs-actions.pod:5639
13495 " guestfs_setcon (guestfs_h *g,\n"
13496 " const char *context);\n"
13501 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13503 "This sets the SELinux security context of the daemon to the string "
13508 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13509 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13513 #: ../src/guestfs-actions.pod:5652
13514 msgid "guestfs_setxattr"
13518 #: ../src/guestfs-actions.pod:5654
13522 " guestfs_setxattr (guestfs_h *g,\n"
13523 " const char *xattr,\n"
13524 " const char *val,\n"
13526 " const char *path);\n"
13531 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
13533 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13534 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13538 #: ../src/guestfs-actions.pod:5665
13539 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13543 #: ../src/guestfs-actions.pod:5671
13544 msgid "guestfs_sfdisk"
13548 #: ../src/guestfs-actions.pod:5673
13552 " guestfs_sfdisk (guestfs_h *g,\n"
13553 " const char *device,\n"
13557 " char *const *lines);\n"
13562 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
13564 "This is a direct interface to the L<sfdisk(8)> program for creating "
13565 "partitions on block devices."
13569 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
13570 msgid "C<device> should be a block device, for example C</dev/sda>."
13574 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
13576 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13577 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13578 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13579 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13580 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13581 "the kernel) cannot work out the right geometry and you will need to tell it."
13585 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
13587 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13588 "refer to the L<sfdisk(8)> manpage."
13592 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
13594 "To create a single partition occupying the whole disk, you would pass "
13595 "C<lines> as a single element list, when the single element being the string "
13600 #: ../src/guestfs-actions.pod:5701
13601 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13605 #: ../src/guestfs-actions.pod:5711
13606 msgid "guestfs_sfdiskM"
13610 #: ../src/guestfs-actions.pod:5713
13614 " guestfs_sfdiskM (guestfs_h *g,\n"
13615 " const char *device,\n"
13616 " char *const *lines);\n"
13621 #: ../src/guestfs-actions.pod:5718
13623 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13624 "partition sizes are specified in megabytes only (rounded to the nearest "
13625 "cylinder) and you don't need to specify the cyls, heads and sectors "
13626 "parameters which were rarely if ever used anyway."
13630 #: ../src/guestfs-actions.pod:5724
13632 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13633 "C<guestfs_part_disk>"
13637 #: ../src/guestfs-actions.pod:5734
13638 msgid "guestfs_sfdisk_N"
13642 #: ../src/guestfs-actions.pod:5736
13646 " guestfs_sfdisk_N (guestfs_h *g,\n"
13647 " const char *device,\n"
13652 " const char *line);\n"
13657 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
13659 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13660 "(note: C<n> counts from 1)."
13664 #: ../src/guestfs-actions.pod:5748
13666 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13667 "for the cyls/heads/sectors parameters."
13671 #: ../src/guestfs-actions.pod:5751
13672 msgid "See also: C<guestfs_part_add>"
13676 #: ../src/guestfs-actions.pod:5760
13677 msgid "guestfs_sfdisk_disk_geometry"
13681 #: ../src/guestfs-actions.pod:5762
13685 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13686 " const char *device);\n"
13691 #: ../src/guestfs-actions.pod:5766
13693 "This displays the disk geometry of C<device> read from the partition table. "
13694 "Especially in the case where the underlying block device has been resized, "
13695 "this can be different from the kernel's idea of the geometry (see "
13696 "C<guestfs_sfdisk_kernel_geometry>)."
13700 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
13701 msgid "The result is in human-readable format, and not designed to be parsed."
13705 #: ../src/guestfs-actions.pod:5779
13706 msgid "guestfs_sfdisk_kernel_geometry"
13710 #: ../src/guestfs-actions.pod:5781
13714 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13715 " const char *device);\n"
13720 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
13721 msgid "This displays the kernel's idea of the geometry of C<device>."
13725 #: ../src/guestfs-actions.pod:5795
13726 msgid "guestfs_sfdisk_l"
13730 #: ../src/guestfs-actions.pod:5797
13734 " guestfs_sfdisk_l (guestfs_h *g,\n"
13735 " const char *device);\n"
13740 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
13742 "This displays the partition table on C<device>, in the human-readable output "
13743 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13747 #: ../src/guestfs-actions.pod:5805
13748 msgid "See also: C<guestfs_part_list>"
13752 #: ../src/guestfs-actions.pod:5812
13757 #: ../src/guestfs-actions.pod:5814
13761 " guestfs_sh (guestfs_h *g,\n"
13762 " const char *command);\n"
13767 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
13769 "This call runs a command from the guest filesystem via the guest's "
13774 #: ../src/guestfs-actions.pod:5821
13775 msgid "This is like C<guestfs_command>, but passes the command to:"
13779 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
13782 " /bin/sh -c \"command\"\n"
13787 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
13789 "Depending on the guest's shell, this usually results in wildcards being "
13790 "expanded, shell expressions being interpolated and so on."
13794 #: ../src/guestfs-actions.pod:5829
13795 msgid "All the provisos about C<guestfs_command> apply to this call."
13799 #: ../src/guestfs-actions.pod:5836
13800 msgid "guestfs_sh_lines"
13804 #: ../src/guestfs-actions.pod:5838
13808 " guestfs_sh_lines (guestfs_h *g,\n"
13809 " const char *command);\n"
13814 #: ../src/guestfs-actions.pod:5842
13816 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13821 #: ../src/guestfs-actions.pod:5845
13822 msgid "See also: C<guestfs_command_lines>"
13826 #: ../src/guestfs-actions.pod:5853
13827 msgid "guestfs_sleep"
13831 #: ../src/guestfs-actions.pod:5855
13835 " guestfs_sleep (guestfs_h *g,\n"
13841 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
13842 msgid "Sleep for C<secs> seconds."
13846 #: ../src/guestfs-actions.pod:5863
13847 msgid "(Added in 1.0.41)"
13851 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
13852 msgid "guestfs_stat"
13856 #: ../src/guestfs-actions.pod:5867
13859 " struct guestfs_stat *\n"
13860 " guestfs_stat (guestfs_h *g,\n"
13861 " const char *path);\n"
13866 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
13867 msgid "This is the same as the C<stat(2)> system call."
13871 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
13872 msgid "guestfs_statvfs"
13876 #: ../src/guestfs-actions.pod:5883
13879 " struct guestfs_statvfs *\n"
13880 " guestfs_statvfs (guestfs_h *g,\n"
13881 " const char *path);\n"
13886 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
13888 "Returns file system statistics for any mounted file system. C<path> should "
13889 "be a file or directory in the mounted file system (typically it is the mount "
13890 "point itself, but it doesn't need to be)."
13894 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
13895 msgid "This is the same as the C<statvfs(2)> system call."
13899 #: ../src/guestfs-actions.pod:5893
13901 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13902 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13906 #: ../src/guestfs-actions.pod:5899
13907 msgid "guestfs_strings"
13911 #: ../src/guestfs-actions.pod:5901
13915 " guestfs_strings (guestfs_h *g,\n"
13916 " const char *path);\n"
13921 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
13923 "This runs the L<strings(1)> command on a file and returns the list of "
13924 "printable strings found."
13928 #: ../src/guestfs-actions.pod:5917
13929 msgid "guestfs_strings_e"
13933 #: ../src/guestfs-actions.pod:5919
13937 " guestfs_strings_e (guestfs_h *g,\n"
13938 " const char *encoding,\n"
13939 " const char *path);\n"
13944 #: ../src/guestfs-actions.pod:5924
13946 "This is like the C<guestfs_strings> command, but allows you to specify the "
13947 "encoding of strings that are looked for in the source file C<path>."
13951 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
13952 msgid "Allowed encodings are:"
13956 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
13961 #: ../src/guestfs-actions.pod:5934
13963 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13964 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13968 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
13973 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
13974 msgid "Single 8-bit-byte characters."
13978 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
13983 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
13984 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13988 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
13989 msgid "l (lower case letter L)"
13993 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
13995 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13996 "examining binaries in Windows guests."
14000 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14005 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14006 msgid "32-bit big endian such as UCS-4BE."
14010 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14015 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14016 msgid "32-bit little endian such as UCS-4LE."
14020 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14021 msgid "The returned strings are transcoded to UTF-8."
14025 #: ../src/guestfs-actions.pod:5972
14026 msgid "guestfs_swapoff_device"
14030 #: ../src/guestfs-actions.pod:5974
14034 " guestfs_swapoff_device (guestfs_h *g,\n"
14035 " const char *device);\n"
14040 #: ../src/guestfs-actions.pod:5978
14042 "This command disables the libguestfs appliance swap device or partition "
14043 "named C<device>. See C<guestfs_swapon_device>."
14047 #: ../src/guestfs-actions.pod:5986
14048 msgid "guestfs_swapoff_file"
14052 #: ../src/guestfs-actions.pod:5988
14056 " guestfs_swapoff_file (guestfs_h *g,\n"
14057 " const char *file);\n"
14062 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14063 msgid "This command disables the libguestfs appliance swap on file."
14067 #: ../src/guestfs-actions.pod:5998
14068 msgid "guestfs_swapoff_label"
14072 #: ../src/guestfs-actions.pod:6000
14076 " guestfs_swapoff_label (guestfs_h *g,\n"
14077 " const char *label);\n"
14082 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14084 "This command disables the libguestfs appliance swap on labeled swap "
14089 #: ../src/guestfs-actions.pod:6011
14090 msgid "guestfs_swapoff_uuid"
14094 #: ../src/guestfs-actions.pod:6013
14098 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14099 " const char *uuid);\n"
14104 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14106 "This command disables the libguestfs appliance swap partition with the given "
14111 #: ../src/guestfs-actions.pod:6024
14112 msgid "guestfs_swapon_device"
14116 #: ../src/guestfs-actions.pod:6026
14120 " guestfs_swapon_device (guestfs_h *g,\n"
14121 " const char *device);\n"
14126 #: ../src/guestfs-actions.pod:6030
14128 "This command enables the libguestfs appliance to use the swap device or "
14129 "partition named C<device>. The increased memory is made available for all "
14130 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14134 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14136 "Note that you should not swap to existing guest swap partitions unless you "
14137 "know what you are doing. They may contain hibernation information, or other "
14138 "information that the guest doesn't want you to trash. You also risk leaking "
14139 "information about the host to the guest this way. Instead, attach a new "
14140 "host device to the guest and swap on that."
14144 #: ../src/guestfs-actions.pod:6046
14145 msgid "guestfs_swapon_file"
14149 #: ../src/guestfs-actions.pod:6048
14153 " guestfs_swapon_file (guestfs_h *g,\n"
14154 " const char *file);\n"
14159 #: ../src/guestfs-actions.pod:6052
14161 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14166 #: ../src/guestfs-actions.pod:6059
14167 msgid "guestfs_swapon_label"
14171 #: ../src/guestfs-actions.pod:6061
14175 " guestfs_swapon_label (guestfs_h *g,\n"
14176 " const char *label);\n"
14181 #: ../src/guestfs-actions.pod:6065
14183 "This command enables swap to a labeled swap partition. See "
14184 "C<guestfs_swapon_device> for other notes."
14188 #: ../src/guestfs-actions.pod:6072
14189 msgid "guestfs_swapon_uuid"
14193 #: ../src/guestfs-actions.pod:6074
14197 " guestfs_swapon_uuid (guestfs_h *g,\n"
14198 " const char *uuid);\n"
14203 #: ../src/guestfs-actions.pod:6078
14205 "This command enables swap to a swap partition with the given UUID. See "
14206 "C<guestfs_swapon_device> for other notes."
14210 #: ../src/guestfs-actions.pod:6085
14211 msgid "guestfs_sync"
14215 #: ../src/guestfs-actions.pod:6087
14219 " guestfs_sync (guestfs_h *g);\n"
14224 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14226 "This syncs the disk, so that any writes are flushed through to the "
14227 "underlying disk image."
14231 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14233 "You should always call this if you have modified a disk image, before "
14234 "closing the handle."
14238 #: ../src/guestfs-actions.pod:6100
14239 msgid "guestfs_tail"
14243 #: ../src/guestfs-actions.pod:6102
14247 " guestfs_tail (guestfs_h *g,\n"
14248 " const char *path);\n"
14253 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14254 msgid "This command returns up to the last 10 lines of a file as a list of strings."
14258 #: ../src/guestfs-actions.pod:6118
14259 msgid "guestfs_tail_n"
14263 #: ../src/guestfs-actions.pod:6120
14267 " guestfs_tail_n (guestfs_h *g,\n"
14269 " const char *path);\n"
14274 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14276 "If the parameter C<nrlines> is a positive number, this returns the last "
14277 "C<nrlines> lines of the file C<path>."
14281 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14283 "If the parameter C<nrlines> is a negative number, this returns lines from "
14284 "the file C<path>, starting with the C<-nrlines>th line."
14288 #: ../src/guestfs-actions.pod:6142
14289 msgid "guestfs_tar_in"
14293 #: ../src/guestfs-actions.pod:6144
14297 " guestfs_tar_in (guestfs_h *g,\n"
14298 " const char *tarfile,\n"
14299 " const char *directory);\n"
14304 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14306 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14307 "tar file) into C<directory>."
14311 #: ../src/guestfs-actions.pod:6152
14312 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14316 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14317 msgid "(Added in 1.0.3)"
14321 #: ../src/guestfs-actions.pod:6159
14322 msgid "guestfs_tar_out"
14326 #: ../src/guestfs-actions.pod:6161
14330 " guestfs_tar_out (guestfs_h *g,\n"
14331 " const char *directory,\n"
14332 " const char *tarfile);\n"
14337 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14339 "This command packs the contents of C<directory> and downloads it to local "
14344 #: ../src/guestfs-actions.pod:6169
14346 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14347 "C<guestfs_txz_out>."
14351 #: ../src/guestfs-actions.pod:6176
14352 msgid "guestfs_tgz_in"
14356 #: ../src/guestfs-actions.pod:6178
14360 " guestfs_tgz_in (guestfs_h *g,\n"
14361 " const char *tarball,\n"
14362 " const char *directory);\n"
14367 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14369 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14370 "tar file) into C<directory>."
14374 #: ../src/guestfs-actions.pod:6186
14375 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14379 #: ../src/guestfs-actions.pod:6192
14380 msgid "guestfs_tgz_out"
14384 #: ../src/guestfs-actions.pod:6194
14388 " guestfs_tgz_out (guestfs_h *g,\n"
14389 " const char *directory,\n"
14390 " const char *tarball);\n"
14395 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14397 "This command packs the contents of C<directory> and downloads it to local "
14402 #: ../src/guestfs-actions.pod:6202
14403 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14407 #: ../src/guestfs-actions.pod:6208
14408 msgid "guestfs_touch"
14412 #: ../src/guestfs-actions.pod:6210
14416 " guestfs_touch (guestfs_h *g,\n"
14417 " const char *path);\n"
14422 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14424 "Touch acts like the L<touch(1)> command. It can be used to update the "
14425 "timestamps on a file, or, if the file does not exist, to create a new "
14426 "zero-length file."
14430 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14432 "This command only works on regular files, and will fail on other file types "
14433 "such as directories, symbolic links, block special etc."
14437 #: ../src/guestfs-actions.pod:6225
14438 msgid "guestfs_truncate"
14442 #: ../src/guestfs-actions.pod:6227
14446 " guestfs_truncate (guestfs_h *g,\n"
14447 " const char *path);\n"
14452 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14454 "This command truncates C<path> to a zero-length file. The file must exist "
14459 #: ../src/guestfs-actions.pod:6238
14460 msgid "guestfs_truncate_size"
14464 #: ../src/guestfs-actions.pod:6240
14468 " guestfs_truncate_size (guestfs_h *g,\n"
14469 " const char *path,\n"
14470 " int64_t size);\n"
14475 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14477 "This command truncates C<path> to size C<size> bytes. The file must exist "
14482 #: ../src/guestfs-actions.pod:6248
14484 "If the current file size is less than C<size> then the file is extended to "
14485 "the required size with zero bytes. This creates a sparse file (ie. disk "
14486 "blocks are not allocated for the file until you write to it). To create a "
14487 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14491 #: ../src/guestfs-actions.pod:6258
14492 msgid "guestfs_tune2fs_l"
14496 #: ../src/guestfs-actions.pod:6260
14500 " guestfs_tune2fs_l (guestfs_h *g,\n"
14501 " const char *device);\n"
14506 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
14508 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14513 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
14515 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14516 "for more details. The list of fields returned isn't clearly defined, and "
14517 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14518 "and the filesystem itself."
14522 #: ../src/guestfs-actions.pod:6280
14523 msgid "guestfs_txz_in"
14527 #: ../src/guestfs-actions.pod:6282
14531 " guestfs_txz_in (guestfs_h *g,\n"
14532 " const char *tarball,\n"
14533 " const char *directory);\n"
14538 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
14540 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14541 "tar file) into C<directory>."
14545 #: ../src/guestfs-actions.pod:6294
14546 msgid "guestfs_txz_out"
14550 #: ../src/guestfs-actions.pod:6296
14554 " guestfs_txz_out (guestfs_h *g,\n"
14555 " const char *directory,\n"
14556 " const char *tarball);\n"
14561 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
14563 "This command packs the contents of C<directory> and downloads it to local "
14564 "file C<tarball> (as an xz compressed tar archive)."
14568 #: ../src/guestfs-actions.pod:6308
14569 msgid "guestfs_umask"
14573 #: ../src/guestfs-actions.pod:6310
14577 " guestfs_umask (guestfs_h *g,\n"
14583 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
14585 "This function sets the mask used for creating new files and device nodes to "
14590 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
14592 "Typical umask values would be C<022> which creates new files with "
14593 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14594 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14598 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
14600 "The default umask is C<022>. This is important because it means that "
14601 "directories and device nodes will be created with C<0644> or C<0755> mode "
14602 "even if you specify C<0777>."
14606 #: ../src/guestfs-actions.pod:6326
14608 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14609 "C<guestfs_mkdir>."
14613 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
14614 msgid "This call returns the previous umask."
14618 #: ../src/guestfs-actions.pod:6335
14619 msgid "guestfs_umount"
14623 #: ../src/guestfs-actions.pod:6337
14627 " guestfs_umount (guestfs_h *g,\n"
14628 " const char *pathordevice);\n"
14633 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
14635 "This unmounts the given filesystem. The filesystem may be specified either "
14636 "by its mountpoint (path) or the device which contains the filesystem."
14640 #: ../src/guestfs-actions.pod:6349
14641 msgid "guestfs_umount_all"
14645 #: ../src/guestfs-actions.pod:6351
14649 " guestfs_umount_all (guestfs_h *g);\n"
14654 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
14655 msgid "This unmounts all mounted filesystems."
14659 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
14660 msgid "Some internal mounts are not unmounted by this call."
14664 #: ../src/guestfs-actions.pod:6362
14665 msgid "guestfs_upload"
14669 #: ../src/guestfs-actions.pod:6364
14673 " guestfs_upload (guestfs_h *g,\n"
14674 " const char *filename,\n"
14675 " const char *remotefilename);\n"
14680 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
14681 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14685 #: ../src/guestfs-actions.pod:6374
14686 msgid "See also C<guestfs_download>."
14690 #: ../src/guestfs-actions.pod:6380
14691 msgid "guestfs_upload_offset"
14695 #: ../src/guestfs-actions.pod:6382
14699 " guestfs_upload_offset (guestfs_h *g,\n"
14700 " const char *filename,\n"
14701 " const char *remotefilename,\n"
14702 " int64_t offset);\n"
14707 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
14709 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14710 "The intention is to overwrite parts of existing files or devices, although "
14711 "if a non-existant file is specified then it is created with a \"hole\" "
14712 "before C<offset>. The size of the data written is implicit in the size of "
14713 "the source C<filename>."
14717 #: ../src/guestfs-actions.pod:6398
14719 "Note that there is no limit on the amount of data that can be uploaded with "
14720 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14721 "full amount unless an error occurs."
14725 #: ../src/guestfs-actions.pod:6403
14726 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14730 #: ../src/guestfs-actions.pod:6409
14731 msgid "guestfs_utimens"
14735 #: ../src/guestfs-actions.pod:6411
14739 " guestfs_utimens (guestfs_h *g,\n"
14740 " const char *path,\n"
14741 " int64_t atsecs,\n"
14742 " int64_t atnsecs,\n"
14743 " int64_t mtsecs,\n"
14744 " int64_t mtnsecs);\n"
14749 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
14750 msgid "This command sets the timestamps of a file with nanosecond precision."
14754 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
14756 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14761 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
14763 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14764 "nanoseconds from the epoch."
14768 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
14770 "If the C<*nsecs> field contains the special value C<-1> then the "
14771 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14772 "ignored in this case)."
14776 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
14778 "If the C<*nsecs> field contains the special value C<-2> then the "
14779 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14784 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
14785 msgid "guestfs_version"
14789 #: ../src/guestfs-actions.pod:6442
14792 " struct guestfs_version *\n"
14793 " guestfs_version (guestfs_h *g);\n"
14798 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
14799 msgid "Return the libguestfs version number that the program is linked against."
14803 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
14805 "Note that because of dynamic linking this is not necessarily the version of "
14806 "libguestfs that you compiled against. You can compile the program, and then "
14807 "at runtime dynamically link against a completely different C<libguestfs.so> "
14812 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
14814 "This call was added in version C<1.0.58>. In previous versions of "
14815 "libguestfs there was no way to get the version number. From C code you can "
14816 "use dynamic linker functions to find out if this symbol exists (if it "
14817 "doesn't, then it's an earlier version)."
14821 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
14823 "The call returns a structure with four elements. The first three (C<major>, "
14824 "C<minor> and C<release>) are numbers and correspond to the usual version "
14825 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14826 "but may be used for distro-specific information."
14830 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
14831 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14835 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
14836 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14840 #: ../src/guestfs-actions.pod:6470
14842 "I<Note:> Don't use this call to test for availability of features. In "
14843 "enterprise distributions we backport features from later versions into "
14844 "earlier versions, making this an unreliable way to test for features. Use "
14845 "C<guestfs_available> instead."
14849 #: ../src/guestfs-actions.pod:6476
14851 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14852 "error. I<The caller must call C<guestfs_free_version> after use>."
14856 #: ../src/guestfs-actions.pod:6480
14857 msgid "(Added in 1.0.58)"
14861 #: ../src/guestfs-actions.pod:6482
14862 msgid "guestfs_vfs_label"
14866 #: ../src/guestfs-actions.pod:6484
14870 " guestfs_vfs_label (guestfs_h *g,\n"
14871 " const char *device);\n"
14876 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
14877 msgid "This returns the filesystem label of the filesystem on C<device>."
14881 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
14882 msgid "If the filesystem is unlabeled, this returns the empty string."
14886 #: ../src/guestfs-actions.pod:6493
14887 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14891 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
14892 msgid "(Added in 1.3.18)"
14896 #: ../src/guestfs-actions.pod:6500
14897 msgid "guestfs_vfs_type"
14901 #: ../src/guestfs-actions.pod:6502
14905 " guestfs_vfs_type (guestfs_h *g,\n"
14906 " const char *device);\n"
14911 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
14913 "This command gets the filesystem type corresponding to the filesystem on "
14918 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
14920 "For most filesystems, the result is the name of the Linux VFS module which "
14921 "would be used to mount this filesystem if you mounted it without specifying "
14922 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14926 #: ../src/guestfs-actions.pod:6519
14927 msgid "guestfs_vfs_uuid"
14931 #: ../src/guestfs-actions.pod:6521
14935 " guestfs_vfs_uuid (guestfs_h *g,\n"
14936 " const char *device);\n"
14941 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
14942 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14946 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
14947 msgid "If the filesystem does not have a UUID, this returns the empty string."
14951 #: ../src/guestfs-actions.pod:6530
14952 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14956 #: ../src/guestfs-actions.pod:6537
14957 msgid "guestfs_vg_activate"
14961 #: ../src/guestfs-actions.pod:6539
14965 " guestfs_vg_activate (guestfs_h *g,\n"
14967 " char *const *volgroups);\n"
14972 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
14974 "This command activates or (if C<activate> is false) deactivates all logical "
14975 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14976 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14977 "deactivated, then those devices disappear."
14981 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
14982 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14986 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
14988 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14989 "activated or deactivated."
14993 #: ../src/guestfs-actions.pod:6559
14994 msgid "guestfs_vg_activate_all"
14998 #: ../src/guestfs-actions.pod:6561
15002 " guestfs_vg_activate_all (guestfs_h *g,\n"
15003 " int activate);\n"
15008 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15010 "This command activates or (if C<activate> is false) deactivates all logical "
15011 "volumes in all volume groups. If activated, then they are made known to the "
15012 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15013 "those devices disappear."
15017 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15018 msgid "This command is the same as running C<vgchange -a y|n>"
15022 #: ../src/guestfs-actions.pod:6577
15023 msgid "guestfs_vgcreate"
15027 #: ../src/guestfs-actions.pod:6579
15031 " guestfs_vgcreate (guestfs_h *g,\n"
15032 " const char *volgroup,\n"
15033 " char *const *physvols);\n"
15038 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15040 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15041 "of physical volumes C<physvols>."
15045 #: ../src/guestfs-actions.pod:6591
15046 msgid "guestfs_vglvuuids"
15050 #: ../src/guestfs-actions.pod:6593
15054 " guestfs_vglvuuids (guestfs_h *g,\n"
15055 " const char *vgname);\n"
15060 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15062 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15063 "volumes created in this volume group."
15067 #: ../src/guestfs-actions.pod:6600
15069 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15070 "associate logical volumes and volume groups."
15074 #: ../src/guestfs-actions.pod:6603
15075 msgid "See also C<guestfs_vgpvuuids>."
15079 #: ../src/guestfs-actions.pod:6611
15080 msgid "guestfs_vgpvuuids"
15084 #: ../src/guestfs-actions.pod:6613
15088 " guestfs_vgpvuuids (guestfs_h *g,\n"
15089 " const char *vgname);\n"
15094 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15096 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15097 "volumes that this volume group resides on."
15101 #: ../src/guestfs-actions.pod:6620
15103 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15104 "associate physical volumes and volume groups."
15108 #: ../src/guestfs-actions.pod:6623
15109 msgid "See also C<guestfs_vglvuuids>."
15113 #: ../src/guestfs-actions.pod:6631
15114 msgid "guestfs_vgremove"
15118 #: ../src/guestfs-actions.pod:6633
15122 " guestfs_vgremove (guestfs_h *g,\n"
15123 " const char *vgname);\n"
15128 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15129 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15133 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15134 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
15138 #: ../src/guestfs-actions.pod:6646
15139 msgid "guestfs_vgrename"
15143 #: ../src/guestfs-actions.pod:6648
15147 " guestfs_vgrename (guestfs_h *g,\n"
15148 " const char *volgroup,\n"
15149 " const char *newvolgroup);\n"
15154 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15155 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15159 #: ../src/guestfs-actions.pod:6659
15160 msgid "guestfs_vgs"
15164 #: ../src/guestfs-actions.pod:6661
15168 " guestfs_vgs (guestfs_h *g);\n"
15173 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15175 "List all the volumes groups detected. This is the equivalent of the "
15176 "L<vgs(8)> command."
15180 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15182 "This returns a list of just the volume group names that were detected "
15183 "(eg. C<VolGroup00>)."
15187 #: ../src/guestfs-actions.pod:6670
15188 msgid "See also C<guestfs_vgs_full>."
15192 #: ../src/guestfs-actions.pod:6678
15193 msgid "guestfs_vgs_full"
15197 #: ../src/guestfs-actions.pod:6680
15200 " struct guestfs_lvm_vg_list *\n"
15201 " guestfs_vgs_full (guestfs_h *g);\n"
15206 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15208 "List all the volumes groups detected. This is the equivalent of the "
15209 "L<vgs(8)> command. The \"full\" version includes all fields."
15213 #: ../src/guestfs-actions.pod:6686
15215 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15216 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
15221 #: ../src/guestfs-actions.pod:6692
15222 msgid "guestfs_vgscan"
15226 #: ../src/guestfs-actions.pod:6694
15230 " guestfs_vgscan (guestfs_h *g);\n"
15235 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15237 "This rescans all block devices and rebuilds the list of LVM physical "
15238 "volumes, volume groups and logical volumes."
15242 #: ../src/guestfs-actions.pod:6704
15243 msgid "guestfs_vguuid"
15247 #: ../src/guestfs-actions.pod:6706
15251 " guestfs_vguuid (guestfs_h *g,\n"
15252 " const char *vgname);\n"
15257 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15258 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15262 #: ../src/guestfs-actions.pod:6717
15263 msgid "guestfs_wait_ready"
15267 #: ../src/guestfs-actions.pod:6719
15271 " guestfs_wait_ready (guestfs_h *g);\n"
15276 #: ../src/guestfs-actions.pod:6722
15277 msgid "This function is a no op."
15281 #: ../src/guestfs-actions.pod:6724
15283 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15284 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15285 "is no longer necessary because C<guestfs_launch> now does the waiting."
15289 #: ../src/guestfs-actions.pod:6729
15291 "If you see any calls to this function in code then you can just remove them, "
15292 "unless you want to retain compatibility with older versions of the API."
15296 #: ../src/guestfs-actions.pod:6737
15297 msgid "guestfs_wc_c"
15301 #: ../src/guestfs-actions.pod:6739
15305 " guestfs_wc_c (guestfs_h *g,\n"
15306 " const char *path);\n"
15311 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15313 "This command counts the characters in a file, using the C<wc -c> external "
15318 #: ../src/guestfs-actions.pod:6750
15319 msgid "guestfs_wc_l"
15323 #: ../src/guestfs-actions.pod:6752
15327 " guestfs_wc_l (guestfs_h *g,\n"
15328 " const char *path);\n"
15333 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15335 "This command counts the lines in a file, using the C<wc -l> external "
15340 #: ../src/guestfs-actions.pod:6763
15341 msgid "guestfs_wc_w"
15345 #: ../src/guestfs-actions.pod:6765
15349 " guestfs_wc_w (guestfs_h *g,\n"
15350 " const char *path);\n"
15355 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15357 "This command counts the words in a file, using the C<wc -w> external "
15362 #: ../src/guestfs-actions.pod:6776
15363 msgid "guestfs_write"
15367 #: ../src/guestfs-actions.pod:6778
15371 " guestfs_write (guestfs_h *g,\n"
15372 " const char *path,\n"
15373 " const char *content,\n"
15374 " size_t content_size);\n"
15379 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15381 "This call creates a file called C<path>. The content of the file is the "
15382 "string C<content> (which can contain any 8 bit data)."
15386 #: ../src/guestfs-actions.pod:6794
15387 msgid "guestfs_write_file"
15391 #: ../src/guestfs-actions.pod:6796
15395 " guestfs_write_file (guestfs_h *g,\n"
15396 " const char *path,\n"
15397 " const char *content,\n"
15403 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15405 "This call creates a file called C<path>. The contents of the file is the "
15406 "string C<content> (which can contain any 8 bit data), with length C<size>."
15410 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15412 "As a special case, if C<size> is C<0> then the length is calculated using "
15413 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15417 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15419 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15420 "I<not> work, even if the length is specified."
15424 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15425 msgid "This function is deprecated. In new code, use the C<write> call instead."
15429 #: ../src/guestfs-actions.pod:6827
15430 msgid "guestfs_zegrep"
15434 #: ../src/guestfs-actions.pod:6829
15438 " guestfs_zegrep (guestfs_h *g,\n"
15439 " const char *regex,\n"
15440 " const char *path);\n"
15445 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15446 msgid "This calls the external C<zegrep> program and returns the matching lines."
15450 #: ../src/guestfs-actions.pod:6846
15451 msgid "guestfs_zegrepi"
15455 #: ../src/guestfs-actions.pod:6848
15459 " guestfs_zegrepi (guestfs_h *g,\n"
15460 " const char *regex,\n"
15461 " const char *path);\n"
15466 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15467 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15471 #: ../src/guestfs-actions.pod:6865
15472 msgid "guestfs_zero"
15476 #: ../src/guestfs-actions.pod:6867
15480 " guestfs_zero (guestfs_h *g,\n"
15481 " const char *device);\n"
15486 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15487 msgid "This command writes zeroes over the first few blocks of C<device>."
15491 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15493 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15494 "securely wipe the device). It should be sufficient to remove any partition "
15495 "tables, filesystem superblocks and so on."
15499 #: ../src/guestfs-actions.pod:6877
15500 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15504 #: ../src/guestfs-actions.pod:6888
15505 msgid "guestfs_zero_device"
15509 #: ../src/guestfs-actions.pod:6890
15513 " guestfs_zero_device (guestfs_h *g,\n"
15514 " const char *device);\n"
15519 #: ../src/guestfs-actions.pod:6894
15521 "This command writes zeroes over the entire C<device>. Compare with "
15522 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15526 #: ../src/guestfs-actions.pod:6908
15527 msgid "(Added in 1.3.1)"
15531 #: ../src/guestfs-actions.pod:6910
15532 msgid "guestfs_zerofree"
15536 #: ../src/guestfs-actions.pod:6912
15540 " guestfs_zerofree (guestfs_h *g,\n"
15541 " const char *device);\n"
15546 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
15548 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15549 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15550 "possible to compress the filesystem more effectively."
15554 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
15555 msgid "You should B<not> run this program if the filesystem is mounted."
15559 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
15561 "It is possible that using this program can damage the filesystem or data on "
15566 #: ../src/guestfs-actions.pod:6931
15567 msgid "guestfs_zfgrep"
15571 #: ../src/guestfs-actions.pod:6933
15575 " guestfs_zfgrep (guestfs_h *g,\n"
15576 " const char *pattern,\n"
15577 " const char *path);\n"
15582 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
15583 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15587 #: ../src/guestfs-actions.pod:6950
15588 msgid "guestfs_zfgrepi"
15592 #: ../src/guestfs-actions.pod:6952
15596 " guestfs_zfgrepi (guestfs_h *g,\n"
15597 " const char *pattern,\n"
15598 " const char *path);\n"
15603 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
15604 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15608 #: ../src/guestfs-actions.pod:6969
15609 msgid "guestfs_zfile"
15613 #: ../src/guestfs-actions.pod:6971
15617 " guestfs_zfile (guestfs_h *g,\n"
15618 " const char *meth,\n"
15619 " const char *path);\n"
15624 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
15625 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15629 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
15630 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15634 #: ../src/guestfs-actions.pod:6981
15636 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15641 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
15642 msgid "This function is deprecated. In new code, use the C<file> call instead."
15646 #: ../src/guestfs-actions.pod:6996
15647 msgid "guestfs_zgrep"
15651 #: ../src/guestfs-actions.pod:6998
15655 " guestfs_zgrep (guestfs_h *g,\n"
15656 " const char *regex,\n"
15657 " const char *path);\n"
15662 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
15663 msgid "This calls the external C<zgrep> program and returns the matching lines."
15667 #: ../src/guestfs-actions.pod:7015
15668 msgid "guestfs_zgrepi"
15672 #: ../src/guestfs-actions.pod:7017
15676 " guestfs_zgrepi (guestfs_h *g,\n"
15677 " const char *regex,\n"
15678 " const char *path);\n"
15683 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
15684 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15688 #: ../src/guestfs-availability.pod:3
15693 #: ../src/guestfs-availability.pod:5
15695 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15696 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15697 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15698 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15699 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15703 #: ../src/guestfs-availability.pod:21
15708 #: ../src/guestfs-availability.pod:23
15710 "The following functions: L</guestfs_inotify_add_watch> "
15711 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15712 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15716 #: ../src/guestfs-availability.pod:31
15717 msgid "B<linuxfsuuid>"
15721 #: ../src/guestfs-availability.pod:33
15723 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15724 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15728 #: ../src/guestfs-availability.pod:40
15729 msgid "B<linuxmodules>"
15733 #: ../src/guestfs-availability.pod:42
15734 msgid "The following functions: L</guestfs_modprobe>"
15738 #: ../src/guestfs-availability.pod:45
15739 msgid "B<linuxxattrs>"
15743 #: ../src/guestfs-availability.pod:47
15745 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15746 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15747 "L</guestfs_removexattr> L</guestfs_setxattr>"
15751 #: ../src/guestfs-availability.pod:56
15756 #: ../src/guestfs-availability.pod:58
15758 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15759 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15760 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15764 #: ../src/guestfs-availability.pod:67
15769 #: ../src/guestfs-availability.pod:69
15771 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15772 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15773 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15774 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15775 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15776 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15777 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15778 "L</guestfs_vgs_full>"
15782 #: ../src/guestfs-availability.pod:92
15787 #: ../src/guestfs-availability.pod:94
15789 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15790 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15794 #: ../src/guestfs-availability.pod:100
15799 #: ../src/guestfs-availability.pod:102
15800 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15804 #: ../src/guestfs-availability.pod:105
15805 msgid "B<ntfsprogs>"
15809 #: ../src/guestfs-availability.pod:107
15810 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15814 #: ../src/guestfs-availability.pod:111
15815 msgid "B<realpath>"
15819 #: ../src/guestfs-availability.pod:113
15820 msgid "The following functions: L</guestfs_realpath>"
15824 #: ../src/guestfs-availability.pod:116
15829 #: ../src/guestfs-availability.pod:118
15831 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15832 "L</guestfs_scrub_freespace>"
15836 #: ../src/guestfs-availability.pod:123
15841 #: ../src/guestfs-availability.pod:125
15842 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15846 #: ../src/guestfs-availability.pod:129
15851 #: ../src/guestfs-availability.pod:131
15852 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15856 #: ../src/guestfs-availability.pod:135
15857 msgid "B<zerofree>"
15861 #: ../src/guestfs-availability.pod:137
15862 msgid "The following functions: L</guestfs_zerofree>"
15866 #: ../src/guestfs-structs.pod:1
15867 msgid "guestfs_int_bool"
15871 #: ../src/guestfs-structs.pod:3
15874 " struct guestfs_int_bool {\n"
15882 #: ../src/guestfs-structs.pod:8
15885 " struct guestfs_int_bool_list {\n"
15886 " uint32_t len; /* Number of elements in list. */\n"
15887 " struct guestfs_int_bool *val; /* Elements. */\n"
15893 #: ../src/guestfs-structs.pod:13
15896 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15897 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15902 #: ../src/guestfs-structs.pod:16
15903 msgid "guestfs_lvm_pv"
15907 #: ../src/guestfs-structs.pod:18
15910 " struct guestfs_lvm_pv {\n"
15911 " char *pv_name;\n"
15912 " /* The next field is NOT nul-terminated, be careful when printing it: "
15914 " char pv_uuid[32];\n"
15916 " uint64_t pv_size;\n"
15917 " uint64_t dev_size;\n"
15918 " uint64_t pv_free;\n"
15919 " uint64_t pv_used;\n"
15920 " char *pv_attr;\n"
15921 " int64_t pv_pe_count;\n"
15922 " int64_t pv_pe_alloc_count;\n"
15923 " char *pv_tags;\n"
15924 " uint64_t pe_start;\n"
15925 " int64_t pv_mda_count;\n"
15926 " uint64_t pv_mda_free;\n"
15932 #: ../src/guestfs-structs.pod:36
15935 " struct guestfs_lvm_pv_list {\n"
15936 " uint32_t len; /* Number of elements in list. */\n"
15937 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15943 #: ../src/guestfs-structs.pod:41
15946 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15947 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15952 #: ../src/guestfs-structs.pod:44
15953 msgid "guestfs_lvm_vg"
15957 #: ../src/guestfs-structs.pod:46
15960 " struct guestfs_lvm_vg {\n"
15961 " char *vg_name;\n"
15962 " /* The next field is NOT nul-terminated, be careful when printing it: "
15964 " char vg_uuid[32];\n"
15966 " char *vg_attr;\n"
15967 " uint64_t vg_size;\n"
15968 " uint64_t vg_free;\n"
15969 " char *vg_sysid;\n"
15970 " uint64_t vg_extent_size;\n"
15971 " int64_t vg_extent_count;\n"
15972 " int64_t vg_free_count;\n"
15973 " int64_t max_lv;\n"
15974 " int64_t max_pv;\n"
15975 " int64_t pv_count;\n"
15976 " int64_t lv_count;\n"
15977 " int64_t snap_count;\n"
15978 " int64_t vg_seqno;\n"
15979 " char *vg_tags;\n"
15980 " int64_t vg_mda_count;\n"
15981 " uint64_t vg_mda_free;\n"
15987 #: ../src/guestfs-structs.pod:69
15990 " struct guestfs_lvm_vg_list {\n"
15991 " uint32_t len; /* Number of elements in list. */\n"
15992 " struct guestfs_lvm_vg *val; /* Elements. */\n"
15998 #: ../src/guestfs-structs.pod:74
16001 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16002 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16007 #: ../src/guestfs-structs.pod:77
16008 msgid "guestfs_lvm_lv"
16012 #: ../src/guestfs-structs.pod:79
16015 " struct guestfs_lvm_lv {\n"
16016 " char *lv_name;\n"
16017 " /* The next field is NOT nul-terminated, be careful when printing it: "
16019 " char lv_uuid[32];\n"
16020 " char *lv_attr;\n"
16021 " int64_t lv_major;\n"
16022 " int64_t lv_minor;\n"
16023 " int64_t lv_kernel_major;\n"
16024 " int64_t lv_kernel_minor;\n"
16025 " uint64_t lv_size;\n"
16026 " int64_t seg_count;\n"
16028 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16029 " float snap_percent;\n"
16030 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16031 " float copy_percent;\n"
16032 " char *move_pv;\n"
16033 " char *lv_tags;\n"
16034 " char *mirror_log;\n"
16035 " char *modules;\n"
16041 #: ../src/guestfs-structs.pod:101
16044 " struct guestfs_lvm_lv_list {\n"
16045 " uint32_t len; /* Number of elements in list. */\n"
16046 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16052 #: ../src/guestfs-structs.pod:106
16055 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16056 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16061 #: ../src/guestfs-structs.pod:111
16064 " struct guestfs_stat {\n"
16068 " int64_t nlink;\n"
16073 " int64_t blksize;\n"
16074 " int64_t blocks;\n"
16075 " int64_t atime;\n"
16076 " int64_t mtime;\n"
16077 " int64_t ctime;\n"
16083 #: ../src/guestfs-structs.pod:127
16086 " struct guestfs_stat_list {\n"
16087 " uint32_t len; /* Number of elements in list. */\n"
16088 " struct guestfs_stat *val; /* Elements. */\n"
16094 #: ../src/guestfs-structs.pod:132
16097 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16098 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16103 #: ../src/guestfs-structs.pod:137
16106 " struct guestfs_statvfs {\n"
16107 " int64_t bsize;\n"
16108 " int64_t frsize;\n"
16109 " int64_t blocks;\n"
16110 " int64_t bfree;\n"
16111 " int64_t bavail;\n"
16112 " int64_t files;\n"
16113 " int64_t ffree;\n"
16114 " int64_t favail;\n"
16117 " int64_t namemax;\n"
16123 #: ../src/guestfs-structs.pod:151
16126 " struct guestfs_statvfs_list {\n"
16127 " uint32_t len; /* Number of elements in list. */\n"
16128 " struct guestfs_statvfs *val; /* Elements. */\n"
16134 #: ../src/guestfs-structs.pod:156
16137 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16138 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16143 #: ../src/guestfs-structs.pod:159
16144 msgid "guestfs_dirent"
16148 #: ../src/guestfs-structs.pod:161
16151 " struct guestfs_dirent {\n"
16160 #: ../src/guestfs-structs.pod:167
16163 " struct guestfs_dirent_list {\n"
16164 " uint32_t len; /* Number of elements in list. */\n"
16165 " struct guestfs_dirent *val; /* Elements. */\n"
16171 #: ../src/guestfs-structs.pod:172
16174 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16175 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16180 #: ../src/guestfs-structs.pod:177
16183 " struct guestfs_version {\n"
16184 " int64_t major;\n"
16185 " int64_t minor;\n"
16186 " int64_t release;\n"
16193 #: ../src/guestfs-structs.pod:184
16196 " struct guestfs_version_list {\n"
16197 " uint32_t len; /* Number of elements in list. */\n"
16198 " struct guestfs_version *val; /* Elements. */\n"
16204 #: ../src/guestfs-structs.pod:189
16207 " void guestfs_free_version (struct guestfs_free_version *);\n"
16208 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16213 #: ../src/guestfs-structs.pod:192
16214 msgid "guestfs_xattr"
16218 #: ../src/guestfs-structs.pod:194
16221 " struct guestfs_xattr {\n"
16222 " char *attrname;\n"
16223 " /* The next two fields describe a byte array. */\n"
16224 " uint32_t attrval_len;\n"
16225 " char *attrval;\n"
16231 #: ../src/guestfs-structs.pod:201
16234 " struct guestfs_xattr_list {\n"
16235 " uint32_t len; /* Number of elements in list. */\n"
16236 " struct guestfs_xattr *val; /* Elements. */\n"
16242 #: ../src/guestfs-structs.pod:206
16245 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16246 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16251 #: ../src/guestfs-structs.pod:209
16252 msgid "guestfs_inotify_event"
16256 #: ../src/guestfs-structs.pod:211
16259 " struct guestfs_inotify_event {\n"
16260 " int64_t in_wd;\n"
16261 " uint32_t in_mask;\n"
16262 " uint32_t in_cookie;\n"
16263 " char *in_name;\n"
16269 #: ../src/guestfs-structs.pod:218
16272 " struct guestfs_inotify_event_list {\n"
16273 " uint32_t len; /* Number of elements in list. */\n"
16274 " struct guestfs_inotify_event *val; /* Elements. */\n"
16280 #: ../src/guestfs-structs.pod:223
16283 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16284 " void guestfs_free_inotify_event_list (struct "
16285 "guestfs_free_inotify_event_list *);\n"
16290 #: ../src/guestfs-structs.pod:226
16291 msgid "guestfs_partition"
16295 #: ../src/guestfs-structs.pod:228
16298 " struct guestfs_partition {\n"
16299 " int32_t part_num;\n"
16300 " uint64_t part_start;\n"
16301 " uint64_t part_end;\n"
16302 " uint64_t part_size;\n"
16308 #: ../src/guestfs-structs.pod:235
16311 " struct guestfs_partition_list {\n"
16312 " uint32_t len; /* Number of elements in list. */\n"
16313 " struct guestfs_partition *val; /* Elements. */\n"
16319 #: ../src/guestfs-structs.pod:240
16322 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16323 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16328 #: ../src/guestfs-structs.pod:243
16329 msgid "guestfs_application"
16333 #: ../src/guestfs-structs.pod:245
16336 " struct guestfs_application {\n"
16337 " char *app_name;\n"
16338 " char *app_display_name;\n"
16339 " int32_t app_epoch;\n"
16340 " char *app_version;\n"
16341 " char *app_release;\n"
16342 " char *app_install_path;\n"
16343 " char *app_trans_path;\n"
16344 " char *app_publisher;\n"
16345 " char *app_url;\n"
16346 " char *app_source_package;\n"
16347 " char *app_summary;\n"
16348 " char *app_description;\n"
16354 #: ../src/guestfs-structs.pod:260
16357 " struct guestfs_application_list {\n"
16358 " uint32_t len; /* Number of elements in list. */\n"
16359 " struct guestfs_application *val; /* Elements. */\n"
16365 #: ../src/guestfs-structs.pod:265
16368 " void guestfs_free_application (struct guestfs_free_application *);\n"
16369 " void guestfs_free_application_list (struct guestfs_free_application_list "
16375 #: ../fish/guestfish.pod:5
16376 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16380 #: ../fish/guestfish.pod:9
16383 " guestfish [--options] [commands]\n"
16388 #: ../fish/guestfish.pod:11
16396 #: ../fish/guestfish.pod:13
16399 " guestfish [--ro|--rw] -a disk.img\n"
16404 #: ../fish/guestfish.pod:15
16407 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16412 #: ../fish/guestfish.pod:17
16415 " guestfish -d libvirt-domain\n"
16420 #: ../fish/guestfish.pod:19
16423 " guestfish [--ro|--rw] -a disk.img -i\n"
16428 #: ../fish/guestfish.pod:21
16431 " guestfish -d libvirt-domain -i\n"
16436 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59 ../tools/virt-rescue.pl:41
16441 #: ../fish/guestfish.pod:25
16443 "Using guestfish in read/write mode on live virtual machines can be "
16444 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16445 "option to use guestfish safely if the disk image or virtual machine might be "
16450 #: ../fish/guestfish.pod:32
16452 "Guestfish is a shell and command-line tool for examining and modifying "
16453 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16454 "functionality of the guestfs API, see L<guestfs(3)>."
16458 #: ../fish/guestfish.pod:36
16460 "Guestfish gives you structured access to the libguestfs API, from shell "
16461 "scripts or the command line or interactively. If you want to rescue a "
16462 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16467 #: ../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
16472 #: ../fish/guestfish.pod:43
16473 msgid "As an interactive shell"
16477 #: ../fish/guestfish.pod:45
16485 #: ../fish/guestfish.pod:47
16488 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16489 " editing virtual machine filesystems.\n"
16494 #: ../fish/guestfish.pod:50
16497 " Type: 'help' for a list of commands\n"
16498 " 'man' to read the manual\n"
16499 " 'quit' to quit the shell\n"
16504 #: ../fish/guestfish.pod:54
16507 " ><fs> add-ro disk.img\n"
16509 " ><fs> list-filesystems\n"
16510 " /dev/sda1: ext4\n"
16511 " /dev/vg_guest/lv_root: ext4\n"
16512 " /dev/vg_guest/lv_swap: swap\n"
16513 " ><fs> mount /dev/vg_guest/lv_root /\n"
16514 " ><fs> cat /etc/fstab\n"
16516 " # Created by anaconda\n"
16523 #: ../fish/guestfish.pod:67
16524 msgid "From shell scripts"
16528 #: ../fish/guestfish.pod:69
16529 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16533 #: ../fish/guestfish.pod:71
16536 " guestfish <<_EOF_\n"
16539 " mount /dev/vg_guest/lv_root /\n"
16540 " write /etc/motd \"Welcome, new users\"\n"
16546 #: ../fish/guestfish.pod:78
16547 msgid "List the LVM logical volumes in a disk image:"
16551 #: ../fish/guestfish.pod:80
16554 " guestfish -a disk.img --ro <<_EOF_\n"
16562 #: ../fish/guestfish.pod:85
16563 msgid "List all the filesystems in a disk image:"
16567 #: ../fish/guestfish.pod:87
16570 " guestfish -a disk.img --ro <<_EOF_\n"
16572 " list-filesystems\n"
16578 #: ../fish/guestfish.pod:92
16579 msgid "On one command line"
16583 #: ../fish/guestfish.pod:94
16584 msgid "Update C</etc/resolv.conf> in a guest:"
16588 #: ../fish/guestfish.pod:96
16592 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16593 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16598 #: ../fish/guestfish.pod:100
16599 msgid "Edit C</boot/grub/grub.conf> interactively:"
16603 #: ../fish/guestfish.pod:102
16606 " guestfish --rw --add disk.img \\\n"
16607 " --mount /dev/vg_guest/lv_root \\\n"
16608 " --mount /dev/sda1:/boot \\\n"
16609 " edit /boot/grub/grub.conf\n"
16614 #: ../fish/guestfish.pod:107
16615 msgid "Mount disks automatically"
16619 #: ../fish/guestfish.pod:109
16621 "Use the I<-i> option to automatically mount the disks from a virtual "
16626 #: ../fish/guestfish.pod:112
16629 " guestfish --ro -a disk.img -i cat /etc/group\n"
16634 #: ../fish/guestfish.pod:114
16637 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16642 #: ../fish/guestfish.pod:116
16643 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16647 #: ../fish/guestfish.pod:118
16650 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16655 #: ../fish/guestfish.pod:120
16656 msgid "As a script interpreter"
16660 #: ../fish/guestfish.pod:122
16661 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16665 #: ../fish/guestfish.pod:124
16668 " #!/usr/bin/guestfish -f\n"
16669 " sparse test1.img 100M\n"
16671 " part-disk /dev/sda mbr\n"
16672 " mkfs ext2 /dev/sda1\n"
16677 #: ../fish/guestfish.pod:130
16678 msgid "Start with a prepared disk"
16682 #: ../fish/guestfish.pod:132
16684 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16685 "single ext2-formatted partition:"
16689 #: ../fish/guestfish.pod:135
16692 " guestfish -N fs\n"
16697 #: ../fish/guestfish.pod:137
16698 msgid "To list what is available do:"
16702 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
16705 " guestfish -N help | less\n"
16710 #: ../fish/guestfish.pod:141
16711 msgid "Remote control"
16715 #: ../fish/guestfish.pod:143
16718 " eval \"`guestfish --listen`\"\n"
16719 " guestfish --remote add-ro disk.img\n"
16720 " guestfish --remote run\n"
16721 " guestfish --remote lvs\n"
16726 #: ../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-df.pl:71 ../tools/virt-resize.pl:256 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
16731 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-resize.pl:264 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
16736 #: ../fish/guestfish.pod:154
16737 msgid "Displays general help on options."
16741 #: ../fish/guestfish.pod:156
16742 msgid "B<-h> | B<--cmd-help>"
16746 #: ../fish/guestfish.pod:158
16747 msgid "Lists all available guestfish commands."
16751 #: ../fish/guestfish.pod:160
16752 msgid "B<-h cmd> | B<--cmd-help cmd>"
16756 #: ../fish/guestfish.pod:162
16757 msgid "Displays detailed help on a single command C<cmd>."
16761 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16762 msgid "B<-a image> | B<--add image>"
16766 #: ../fish/guestfish.pod:166
16767 msgid "Add a block device or virtual machine image to the shell."
16771 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16773 "The format of the disk image is auto-detected. To override this and force a "
16774 "particular format use the I<--format=..> option."
16778 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16779 msgid "B<-c URI> | B<--connect URI>"
16783 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16785 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16786 "URI to use. The default is to use the default libvirt connection."
16790 #: ../fish/guestfish.pod:177
16795 #: ../fish/guestfish.pod:179
16797 "If using the I<--listen> option and a csh-like shell, use this option. See "
16798 "section L</REMOTE CONTROL AND CSH> below."
16802 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16803 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16807 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16809 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16810 "used, then any libvirt domain can be used. However in write mode, only "
16811 "libvirt domains which are shut down can be named here."
16815 #: ../fish/guestfish.pod:188
16816 msgid "B<-D> | B<--no-dest-paths>"
16820 #: ../fish/guestfish.pod:190
16822 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16823 "to hit the tab key to complete paths on the guest filesystem, but this "
16824 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16825 "allow this feature to be disabled."
16829 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16830 msgid "B<--echo-keys>"
16834 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16836 "When prompting for keys and passphrases, guestfish normally turns echoing "
16837 "off so you cannot see what you are typing. If you are not worried about "
16838 "Tempest attacks and there is no one else in the room you can specify this "
16839 "flag to see what you are typing."
16843 #: ../fish/guestfish.pod:202
16844 msgid "B<-f file> | B<--file file>"
16848 #: ../fish/guestfish.pod:204
16849 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16853 #: ../fish/guestfish.pod:207
16856 " #!/usr/bin/guestfish -f\n"
16861 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16862 msgid "B<--format=raw|qcow2|..> | B<--format>"
16866 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16868 "The default for the I<-a> option is to auto-detect the format of the disk "
16869 "image. Using this forces the disk format for I<-a> options which follow on "
16870 "the command line. Using I<--format> with no argument switches back to "
16871 "auto-detection for subsequent I<-a> options."
16875 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
16876 msgid "For example:"
16880 #: ../fish/guestfish.pod:218
16883 " guestfish --format=raw -a disk.img\n"
16888 #: ../fish/guestfish.pod:220
16889 msgid "forces raw format (no auto-detection) for C<disk.img>."
16893 #: ../fish/guestfish.pod:222
16896 " guestfish --format=raw -a disk.img --format -a another.img\n"
16901 #: ../fish/guestfish.pod:224
16903 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
16904 "auto-detection for C<another.img>."
16908 #: ../fish/guestfish.pod:227
16910 "If you have untrusted raw-format guest disk images, you should use this "
16911 "option to specify the disk format. This avoids a possible security problem "
16912 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16916 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16917 msgid "B<-i> | B<--inspector>"
16921 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16923 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16924 "system and mount filesystems as they would be mounted on the real virtual "
16929 #: ../fish/guestfish.pod:238
16930 msgid "Typical usage is either:"
16934 #: ../fish/guestfish.pod:240
16937 " guestfish -d myguest -i\n"
16942 #: ../fish/guestfish.pod:242
16943 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16947 #: ../fish/guestfish.pod:244
16950 " guestfish --ro -d myguest -i\n"
16955 #: ../fish/guestfish.pod:246
16956 msgid "(for active domains, readonly), or specify the block device directly:"
16960 #: ../fish/guestfish.pod:248
16963 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16968 #: ../fish/guestfish.pod:250
16970 "Note that the command line syntax changed slightly over older versions of "
16971 "guestfish. You can still use the old syntax:"
16975 #: ../fish/guestfish.pod:253
16978 " guestfish [--ro] -i disk.img\n"
16983 #: ../fish/guestfish.pod:255
16986 " guestfish [--ro] -i libvirt-domain\n"
16991 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16992 msgid "B<--keys-from-stdin>"
16996 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
16998 "Read key or passphrase parameters from stdin. The default is to try to read "
16999 "passphrases from the user by opening C</dev/tty>."
17003 #: ../fish/guestfish.pod:262
17004 msgid "B<--listen>"
17008 #: ../fish/guestfish.pod:264
17010 "Fork into the background and listen for remote commands. See section "
17011 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17015 #: ../fish/guestfish.pod:267
17016 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17020 #: ../fish/guestfish.pod:269
17021 msgid "Mount the named partition or logical volume on the given mountpoint."
17025 #: ../fish/guestfish.pod:271
17026 msgid "If the mountpoint is omitted, it defaults to C</>."
17030 #: ../fish/guestfish.pod:273
17031 msgid "You have to mount something on C</> before most commands will work."
17035 #: ../fish/guestfish.pod:275
17037 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17042 #: ../fish/guestfish.pod:278
17044 "If you don't know what filesystems a disk image contains, you can either run "
17045 "guestfish without this option, then list the partitions, filesystems and LVs "
17046 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17047 "commands), or you can use the L<virt-filesystems(1)> program."
17051 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17052 msgid "B<-n> | B<--no-sync>"
17056 #: ../fish/guestfish.pod:286
17058 "Disable autosync. This is enabled by default. See the discussion of "
17059 "autosync in the L<guestfs(3)> manpage."
17063 #: ../fish/guestfish.pod:289
17064 msgid "B<-N type> | B<--new type> | B<-N help>"
17068 #: ../fish/guestfish.pod:291
17070 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17071 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17072 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17077 #: ../fish/guestfish.pod:296
17078 msgid "B<--progress-bars>"
17082 #: ../fish/guestfish.pod:298
17083 msgid "Enable progress bars, even when guestfish is used non-interactively."
17087 #: ../fish/guestfish.pod:300
17089 "Progress bars are enabled by default when guestfish is used as an "
17090 "interactive shell."
17094 #: ../fish/guestfish.pod:303
17095 msgid "B<--no-progress-bars>"
17099 #: ../fish/guestfish.pod:305
17100 msgid "Disable progress bars."
17104 #: ../fish/guestfish.pod:307
17105 msgid "B<--remote[=pid]>"
17109 #: ../fish/guestfish.pod:309
17111 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17112 "CONTROL GUESTFISH OVER A SOCKET> below."
17116 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17117 msgid "B<-r> | B<--ro>"
17121 #: ../fish/guestfish.pod:314
17123 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17124 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17128 #: ../fish/guestfish.pod:317 ../tools/virt-rescue.pl:187
17130 "The option must always be used if the disk image or virtual machine might be "
17131 "running, and is generally recommended in cases where you don't need write "
17132 "access to the disk."
17136 #: ../fish/guestfish.pod:321
17138 "Note that prepared disk images created with I<-N> are not affected by the "
17143 #: ../fish/guestfish.pod:324
17144 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17148 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208 ../tools/virt-rescue.pl:195
17149 msgid "B<--selinux>"
17153 #: ../fish/guestfish.pod:328
17154 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17158 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17159 msgid "B<-v> | B<--verbose>"
17163 #: ../fish/guestfish.pod:332
17165 "Enable very verbose messages. This is particularly useful if you find a "
17170 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17171 msgid "B<-V> | B<--version>"
17175 #: ../fish/guestfish.pod:337
17176 msgid "Display the guestfish / libguestfs version number and exit."
17180 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17181 msgid "B<-w> | B<--rw>"
17185 #: ../fish/guestfish.pod:341
17187 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17192 #: ../fish/guestfish.pod:344
17197 #: ../fish/guestfish.pod:346
17198 msgid "Echo each command before executing it."
17202 #: ../fish/guestfish.pod:350
17203 msgid "COMMANDS ON COMMAND LINE"
17207 #: ../fish/guestfish.pod:352
17208 msgid "Any additional (non-option) arguments are treated as commands to execute."
17212 #: ../fish/guestfish.pod:355
17214 "Commands to execute should be separated by a colon (C<:>), where the colon "
17215 "is a separate parameter. Thus:"
17219 #: ../fish/guestfish.pod:358
17222 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17227 #: ../fish/guestfish.pod:360
17229 "If there are no additional arguments, then we enter a shell, either an "
17230 "interactive shell with a prompt (if the input is a terminal) or a "
17231 "non-interactive shell."
17235 #: ../fish/guestfish.pod:364
17237 "In either command line mode or non-interactive shell, the first command that "
17238 "gives an error causes the whole shell to exit. In interactive mode (with a "
17239 "prompt) if a command fails, you can continue to enter commands."
17243 #: ../fish/guestfish.pod:369
17244 msgid "USING launch (OR run)"
17248 #: ../fish/guestfish.pod:371
17250 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17251 "then launch it, then mount any disks you need, and finally issue "
17252 "actions/commands. So the general order of the day is:"
17256 #: ../fish/guestfish.pod:379
17257 msgid "add or -a/--add"
17261 #: ../fish/guestfish.pod:383
17262 msgid "launch (aka run)"
17266 #: ../fish/guestfish.pod:387
17267 msgid "mount or -m/--mount"
17271 #: ../fish/guestfish.pod:391
17272 msgid "any other commands"
17276 #: ../fish/guestfish.pod:395
17278 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17279 "guest before mounting or performing any other commands."
17283 #: ../fish/guestfish.pod:398
17285 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17286 "I<--new> options were given then C<run> is done automatically, simply "
17287 "because guestfish can't perform the action you asked for without doing this."
17291 #: ../fish/guestfish.pod:403
17292 msgid "OPENING DISKS FOR READ AND WRITE"
17296 #: ../fish/guestfish.pod:405
17298 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17299 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17300 "open disk images read-only or for writing."
17304 #: ../fish/guestfish.pod:409
17306 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17307 "disk images supplied on the command line for write. To open a disk image "
17308 "read-only you have to do I<-a image --ro>."
17312 #: ../fish/guestfish.pod:413
17314 "This matters: If you accidentally open a live VM disk image writable then "
17315 "you will cause irreversible disk corruption."
17319 #: ../fish/guestfish.pod:416
17321 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17322 "images will be opened read-only. You will have to either specify "
17323 "I<guestfish --rw> or change a configuration file in order to get write "
17324 "access for disk images specified by those other command line options."
17328 #: ../fish/guestfish.pod:421
17330 "This version of guestfish has a I<--rw> option which does nothing (it is "
17331 "already the default). However it is highly recommended that you use this "
17332 "option to indicate that guestfish needs write access, and to prepare your "
17333 "scripts for the day when this option will be required for write access."
17337 #: ../fish/guestfish.pod:427
17339 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17340 "other libguestfs program apart from guestfish and guestmount."
17344 #: ../fish/guestfish.pod:430
17349 #: ../fish/guestfish.pod:432
17351 "You can quote ordinary parameters using either single or double quotes. For "
17356 #: ../fish/guestfish.pod:435
17359 " add \"file with a space.img\"\n"
17364 #: ../fish/guestfish.pod:437
17367 " rm '/file name'\n"
17372 #: ../fish/guestfish.pod:439
17380 #: ../fish/guestfish.pod:441
17382 "A few commands require a list of strings to be passed. For these, use a "
17383 "whitespace-separated list, enclosed in quotes. Strings containing "
17384 "whitespace to be passed through must be enclosed in single quotes. A "
17385 "literal single quote must be escaped with a backslash."
17389 #: ../fish/guestfish.pod:446
17392 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17393 " command \"/bin/echo 'foo bar'\"\n"
17394 " command \"/bin/echo \\'foo\\'\"\n"
17399 #: ../fish/guestfish.pod:450
17400 msgid "OPTIONAL ARGUMENTS"
17404 #: ../fish/guestfish.pod:452
17406 "Some commands take optional arguments. These arguments appear in this "
17407 "documentation as C<[argname:..]>. You can use them as in these examples:"
17411 #: ../fish/guestfish.pod:456
17414 " add-drive-opts filename\n"
17419 #: ../fish/guestfish.pod:458
17422 " add-drive-opts filename readonly:true\n"
17427 #: ../fish/guestfish.pod:460
17430 " add-drive-opts filename format:qcow2 readonly:false\n"
17435 #: ../fish/guestfish.pod:462
17437 "Each optional argument can appear at most once. All optional arguments must "
17438 "appear after the required ones."
17442 #: ../fish/guestfish.pod:465
17447 #: ../fish/guestfish.pod:467
17448 msgid "This section applies to all commands which can take integers as parameters."
17452 #: ../fish/guestfish.pod:470
17453 msgid "SIZE SUFFIX"
17457 #: ../fish/guestfish.pod:472
17459 "When the command takes a parameter measured in bytes, you can use one of the "
17460 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17464 #: ../fish/guestfish.pod:478
17465 msgid "B<k> or B<K> or B<KiB>"
17469 #: ../fish/guestfish.pod:480
17470 msgid "The size in kilobytes (multiplied by 1024)."
17474 #: ../fish/guestfish.pod:482
17479 #: ../fish/guestfish.pod:484
17480 msgid "The size in SI 1000 byte units."
17484 #: ../fish/guestfish.pod:486
17485 msgid "B<M> or B<MiB>"
17489 #: ../fish/guestfish.pod:488
17490 msgid "The size in megabytes (multiplied by 1048576)."
17494 #: ../fish/guestfish.pod:490
17499 #: ../fish/guestfish.pod:492
17500 msgid "The size in SI 1000000 byte units."
17504 #: ../fish/guestfish.pod:494
17505 msgid "B<G> or B<GiB>"
17509 #: ../fish/guestfish.pod:496
17510 msgid "The size in gigabytes (multiplied by 2**30)."
17514 #: ../fish/guestfish.pod:498
17519 #: ../fish/guestfish.pod:500
17520 msgid "The size in SI 10**9 byte units."
17524 #: ../fish/guestfish.pod:502
17525 msgid "B<T> or B<TiB>"
17529 #: ../fish/guestfish.pod:504
17530 msgid "The size in terabytes (multiplied by 2**40)."
17534 #: ../fish/guestfish.pod:506
17539 #: ../fish/guestfish.pod:508
17540 msgid "The size in SI 10**12 byte units."
17544 #: ../fish/guestfish.pod:510
17545 msgid "B<P> or B<PiB>"
17549 #: ../fish/guestfish.pod:512
17550 msgid "The size in petabytes (multiplied by 2**50)."
17554 #: ../fish/guestfish.pod:514
17559 #: ../fish/guestfish.pod:516
17560 msgid "The size in SI 10**15 byte units."
17564 #: ../fish/guestfish.pod:518
17565 msgid "B<E> or B<EiB>"
17569 #: ../fish/guestfish.pod:520
17570 msgid "The size in exabytes (multiplied by 2**60)."
17574 #: ../fish/guestfish.pod:522
17579 #: ../fish/guestfish.pod:524
17580 msgid "The size in SI 10**18 byte units."
17584 #: ../fish/guestfish.pod:526
17585 msgid "B<Z> or B<ZiB>"
17589 #: ../fish/guestfish.pod:528
17590 msgid "The size in zettabytes (multiplied by 2**70)."
17594 #: ../fish/guestfish.pod:530
17599 #: ../fish/guestfish.pod:532
17600 msgid "The size in SI 10**21 byte units."
17604 #: ../fish/guestfish.pod:534
17605 msgid "B<Y> or B<YiB>"
17609 #: ../fish/guestfish.pod:536
17610 msgid "The size in yottabytes (multiplied by 2**80)."
17614 #: ../fish/guestfish.pod:538
17619 #: ../fish/guestfish.pod:540
17620 msgid "The size in SI 10**24 byte units."
17624 #: ../fish/guestfish.pod:546
17627 " truncate-size /file 1G\n"
17632 #: ../fish/guestfish.pod:548
17633 msgid "would truncate the file to 1 gigabyte."
17637 #: ../fish/guestfish.pod:550
17639 "Be careful because a few commands take sizes in kilobytes or megabytes "
17640 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17641 "Adding a suffix will probably not do what you expect."
17645 #: ../fish/guestfish.pod:554
17646 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17650 #: ../fish/guestfish.pod:556
17652 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17653 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17657 #: ../fish/guestfish.pod:559
17660 " 1234 decimal number 1234\n"
17661 " 02322 octal number, equivalent to decimal 1234\n"
17662 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17667 #: ../fish/guestfish.pod:563
17669 "When using the C<chmod> command, you almost always want to specify an octal "
17670 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17671 "L<chmod(1)> program):"
17675 #: ../fish/guestfish.pod:567
17678 " chmod 0777 /public # OK\n"
17679 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17684 #: ../fish/guestfish.pod:570
17686 "Commands that return numbers usually print them in decimal, but some "
17687 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17688 "octal, preceeded by C<0>)."
17692 #: ../fish/guestfish.pod:574
17693 msgid "WILDCARDS AND GLOBBING"
17697 #: ../fish/guestfish.pod:576
17699 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17700 "(globbing) by default. So for example the following will not do what you "
17705 #: ../fish/guestfish.pod:580
17713 #: ../fish/guestfish.pod:582
17715 "Assuming you don't have a directory called literally C</home/*> then the "
17716 "above command will return an error."
17720 #: ../fish/guestfish.pod:585
17721 msgid "To perform wildcard expansion, use the C<glob> command."
17725 #: ../fish/guestfish.pod:587
17728 " glob rm-rf /home/*\n"
17733 #: ../fish/guestfish.pod:589
17735 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17736 "many times), equivalent to:"
17740 #: ../fish/guestfish.pod:592
17743 " rm-rf /home/jim\n"
17744 " rm-rf /home/joe\n"
17745 " rm-rf /home/mary\n"
17750 #: ../fish/guestfish.pod:596
17751 msgid "C<glob> only works on simple guest paths and not on device names."
17755 #: ../fish/guestfish.pod:598
17757 "If you have several parameters, each containing a wildcard, then glob will "
17758 "perform a Cartesian product."
17762 #: ../fish/guestfish.pod:601
17767 #: ../fish/guestfish.pod:603
17769 "Any line which starts with a I<#> character is treated as a comment and "
17770 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17771 "a command. For example:"
17775 #: ../fish/guestfish.pod:607
17778 " # this is a comment\n"
17779 " # this is a comment\n"
17780 " foo # NOT a comment\n"
17785 #: ../fish/guestfish.pod:611
17786 msgid "Blank lines are also ignored."
17790 #: ../fish/guestfish.pod:613
17791 msgid "RUNNING COMMANDS LOCALLY"
17795 #: ../fish/guestfish.pod:615
17797 "Any line which starts with a I<!> character is treated as a command sent to "
17798 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17802 #: ../fish/guestfish.pod:619
17806 " tgz-out /remote local/remote-data.tar.gz\n"
17811 #: ../fish/guestfish.pod:622
17813 "will create a directory C<local> on the host, and then export the contents "
17814 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17815 "(See C<tgz-out>)."
17819 #: ../fish/guestfish.pod:626
17821 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17822 "effect, due to the way that subprocesses work in Unix."
17826 #: ../fish/guestfish.pod:629
17831 #: ../fish/guestfish.pod:631
17833 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17834 "command (a guestfish command) to the second command (any host command). For "
17839 #: ../fish/guestfish.pod:635
17842 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17847 #: ../fish/guestfish.pod:637
17849 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17850 "program). The above command would list all accounts in the guest filesystem "
17851 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17855 #: ../fish/guestfish.pod:642
17858 " hexdump /bin/ls | head\n"
17859 " list-devices | tail -1\n"
17860 " tgz-out / - | tar ztf -\n"
17865 #: ../fish/guestfish.pod:646
17867 "The space before the pipe symbol is required, any space after the pipe "
17868 "symbol is optional. Everything after the pipe symbol is just passed "
17869 "straight to the host shell, so it can contain redirections, globs and "
17870 "anything else that makes sense on the host side."
17874 #: ../fish/guestfish.pod:651
17876 "To use a literal argument which begins with a pipe symbol, you have to quote "
17881 #: ../fish/guestfish.pod:654
17889 #: ../fish/guestfish.pod:656
17890 msgid "HOME DIRECTORIES"
17894 #: ../fish/guestfish.pod:658
17896 "If a parameter starts with the character C<~> then the tilde may be expanded "
17897 "as a home directory path (either C<~> for the current user's home directory, "
17898 "or C<~user> for another user)."
17902 #: ../fish/guestfish.pod:662
17904 "Note that home directory expansion happens for users known I<on the host>, "
17905 "not in the guest filesystem."
17909 #: ../fish/guestfish.pod:665
17911 "To use a literal argument which begins with a tilde, you have to quote it, "
17916 #: ../fish/guestfish.pod:668
17924 #: ../fish/guestfish.pod:672
17926 "Libguestfs has some support for Linux guests encrypted according to the "
17927 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17928 "disk encryption systems used by modern Linux guests. Currently only "
17929 "LVM-on-LUKS is supported."
17933 #: ../fish/guestfish.pod:677
17934 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17938 #: ../fish/guestfish.pod:679
17941 " ><fs> vfs-type /dev/sda2\n"
17947 #: ../fish/guestfish.pod:682
17949 "Then open those devices using L</luks-open>. This creates a device-mapper "
17950 "device called C</dev/mapper/luksdev>."
17954 #: ../fish/guestfish.pod:685
17957 " ><fs> luks-open /dev/sda2 luksdev\n"
17958 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17963 #: ../fish/guestfish.pod:688
17965 "Finally you have to tell LVM to scan for volume groups on the newly created "
17970 #: ../fish/guestfish.pod:691
17974 " vg-activate-all true\n"
17979 #: ../fish/guestfish.pod:694
17980 msgid "The logical volume(s) can now be mounted in the usual way."
17984 #: ../fish/guestfish.pod:696
17986 "Before closing a LUKS device you must unmount any logical volumes on it and "
17987 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17988 "one. Then you can close the mapper device:"
17992 #: ../fish/guestfish.pod:700
17995 " vg-activate false /dev/VG\n"
17996 " luks-close /dev/mapper/luksdev\n"
18001 #: ../fish/guestfish.pod:703
18002 msgid "WINDOWS PATHS"
18006 #: ../fish/guestfish.pod:705
18008 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18009 "(with some limitations). The following commands are equivalent:"
18013 #: ../fish/guestfish.pod:708
18016 " file /WINDOWS/system32/config/system.LOG\n"
18021 #: ../fish/guestfish.pod:710
18024 " file win:/windows/system32/config/system.log\n"
18029 #: ../fish/guestfish.pod:712
18032 " file win:\\windows\\system32\\config\\system.log\n"
18037 #: ../fish/guestfish.pod:714
18040 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18045 #: ../fish/guestfish.pod:716
18047 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18048 "handles case insensitivity like Windows would. This only works in argument "
18049 "positions that expect a path."
18053 #: ../fish/guestfish.pod:720
18054 msgid "UPLOADING AND DOWNLOADING FILES"
18058 #: ../fish/guestfish.pod:722
18060 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18061 "others which upload from or download to a local file, you can use the "
18062 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18066 #: ../fish/guestfish.pod:726
18074 #: ../fish/guestfish.pod:728
18075 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
18079 #: ../fish/guestfish.pod:731
18082 " tar-out /etc - | tar tf -\n"
18087 #: ../fish/guestfish.pod:733
18089 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18090 "command (see L</PIPES>)."
18094 #: ../fish/guestfish.pod:736
18096 "When using C<-> to read from stdin, the input is read up to the end of "
18097 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18098 "some arbitrary end marker:"
18102 #: ../fish/guestfish.pod:740
18105 " upload -<<END /foo\n"
18114 #: ../fish/guestfish.pod:746
18116 "Any string of characters can be used instead of C<END>. The end marker must "
18117 "appear on a line of its own, without any preceeding or following characters "
18118 "(not even spaces)."
18122 #: ../fish/guestfish.pod:750
18124 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18125 "upload local files (so-called \"FileIn\" parameters in the generator)."
18129 #: ../fish/guestfish.pod:753
18130 msgid "EXIT ON ERROR BEHAVIOUR"
18134 #: ../fish/guestfish.pod:755
18136 "By default, guestfish will ignore any errors when in interactive mode "
18137 "(ie. taking commands from a human over a tty), and will exit on the first "
18138 "error in non-interactive mode (scripts, commands given on the command line)."
18142 #: ../fish/guestfish.pod:760
18144 "If you prefix a command with a I<-> character, then that command will not "
18145 "cause guestfish to exit, even if that (one) command returns an error."
18149 #: ../fish/guestfish.pod:764
18150 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18154 #: ../fish/guestfish.pod:766
18156 "Guestfish can be remote-controlled over a socket. This is useful "
18157 "particularly in shell scripts where you want to make several different "
18158 "changes to a filesystem, but you don't want the overhead of starting up a "
18159 "guestfish process each time."
18163 #: ../fish/guestfish.pod:771
18164 msgid "Start a guestfish server process using:"
18168 #: ../fish/guestfish.pod:773
18171 " eval \"`guestfish --listen`\"\n"
18176 #: ../fish/guestfish.pod:775
18177 msgid "and then send it commands by doing:"
18181 #: ../fish/guestfish.pod:777
18184 " guestfish --remote cmd [...]\n"
18189 #: ../fish/guestfish.pod:779
18190 msgid "To cause the server to exit, send it the exit command:"
18194 #: ../fish/guestfish.pod:781
18197 " guestfish --remote exit\n"
18202 #: ../fish/guestfish.pod:783
18204 "Note that the server will normally exit if there is an error in a command. "
18205 "You can change this in the usual way. See section L</EXIT ON ERROR "
18210 #: ../fish/guestfish.pod:787
18211 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18215 #: ../fish/guestfish.pod:789
18217 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18218 "is how the I<--remote> option knows where to send the commands. You can "
18219 "have several guestfish listener processes running using:"
18223 #: ../fish/guestfish.pod:793
18226 " eval \"`guestfish --listen`\"\n"
18227 " pid1=$GUESTFISH_PID\n"
18228 " eval \"`guestfish --listen`\"\n"
18229 " pid2=$GUESTFISH_PID\n"
18231 " guestfish --remote=$pid1 cmd\n"
18232 " guestfish --remote=$pid2 cmd\n"
18237 #: ../fish/guestfish.pod:801
18238 msgid "REMOTE CONTROL AND CSH"
18242 #: ../fish/guestfish.pod:803
18244 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18249 #: ../fish/guestfish.pod:806
18252 " eval \"`guestfish --listen --csh`\"\n"
18257 #: ../fish/guestfish.pod:808
18258 msgid "REMOTE CONTROL DETAILS"
18262 #: ../fish/guestfish.pod:810
18264 "Remote control happens over a Unix domain socket called "
18265 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
18266 "of the process, and C<$PID> is the process ID of the server."
18270 #: ../fish/guestfish.pod:814
18271 msgid "Guestfish client and server versions must match exactly."
18275 #: ../fish/guestfish.pod:816
18276 msgid "PREPARED DISK IMAGES"
18280 #: ../fish/guestfish.pod:818
18282 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18283 "preformatted disk images that guestfish can make for you to save typing. "
18284 "This is particularly useful for testing purposes. This option is used "
18285 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18286 "can be mixed with I<-a>)."
18290 #: ../fish/guestfish.pod:824
18292 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18293 "the second and so on. Existing files in the current directory are "
18298 #: ../fish/guestfish.pod:828
18300 "The type briefly describes how the disk should be sized, partitioned, how "
18301 "filesystem(s) should be created, and how content should be added. "
18302 "Optionally the type can be followed by extra parameters, separated by C<:> "
18303 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
18304 "sparsely-allocated disk, containing a single partition, with the partition "
18305 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
18306 "on a 1GB disk instead."
18310 #: ../fish/guestfish.pod:836
18311 msgid "To list the available types and any extra parameters they take, run:"
18315 #: ../fish/guestfish.pod:840
18317 "Note that the prepared filesystem is not mounted. You would usually have to "
18318 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18322 #: ../fish/guestfish.pod:844
18324 "If any I<-N> or I<--new> options are given, the guest is automatically "
18329 #: ../fish/guestfish.pod:849
18330 msgid "Create a 100MB disk with an ext4-formatted partition:"
18334 #: ../fish/guestfish.pod:851
18337 " guestfish -N fs:ext4\n"
18342 #: ../fish/guestfish.pod:853
18343 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18347 #: ../fish/guestfish.pod:855
18350 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18355 #: ../fish/guestfish.pod:857
18356 msgid "Create a blank 200MB disk:"
18360 #: ../fish/guestfish.pod:859
18363 " guestfish -N disk:200M\n"
18368 #: ../fish/guestfish.pod:861
18369 msgid "PROGRESS BARS"
18373 #: ../fish/guestfish.pod:863
18375 "Some (not all) long-running commands send progress notification messages as "
18376 "they are running. Guestfish turns these messages into progress bars."
18380 #: ../fish/guestfish.pod:867
18382 "When a command that supports progress bars takes longer than two seconds to "
18383 "run, and if progress bars are enabled, then you will see one appearing below "
18388 #: ../fish/guestfish.pod:871
18391 " ><fs> copy-size /large-file /another-file 2048M\n"
18392 " / 10% [#####-----------------------------------------] 00:30\n"
18397 #: ../fish/guestfish.pod:874
18399 "The spinner on the left hand side moves round once for every progress "
18400 "notification received from the backend. This is a (reasonably) golden "
18401 "assurance that the command is \"doing something\" even if the progress bar "
18402 "is not moving, because the command is able to send the progress "
18403 "notifications. When the bar reaches 100% and the command finishes, the "
18404 "spinner disappears."
18408 #: ../fish/guestfish.pod:881
18410 "Progress bars are enabled by default when guestfish is used interactively. "
18411 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18412 "and you can disable them completely using I<--no-progress-bars>."
18416 #: ../fish/guestfish.pod:886
18417 msgid "GUESTFISH COMMANDS"
18421 #: ../fish/guestfish.pod:888
18423 "The commands in this section are guestfish convenience commands, in other "
18424 "words, they are not part of the L<guestfs(3)> API."
18428 #: ../fish/guestfish.pod:891
18433 #: ../fish/guestfish.pod:893
18442 #: ../fish/guestfish.pod:896
18443 msgid "Without any parameter, this provides general help."
18447 #: ../fish/guestfish.pod:898
18448 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18452 #: ../fish/guestfish.pod:900
18453 msgid "quit | exit"
18457 #: ../fish/guestfish.pod:902
18458 msgid "This exits guestfish. You can also use C<^D> key."
18462 #: ../fish/guestfish.pod:904
18463 msgid "@FISH_COMMANDS@"
18467 #: ../fish/guestfish.pod:906
18472 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18477 #: ../fish/guestfish.pod:912
18479 "guestfish returns 0 if the commands completed without error, or 1 if there "
18484 #: ../fish/guestfish.pod:919
18489 #: ../fish/guestfish.pod:921
18491 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18496 #: ../fish/guestfish.pod:924
18497 msgid "GUESTFISH_PID"
18501 #: ../fish/guestfish.pod:926
18503 "Used with the I<--remote> option to specify the remote guestfish process to "
18504 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18508 #: ../fish/guestfish.pod:930
18513 #: ../fish/guestfish.pod:932
18515 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18516 "not specified, the external L<hexedit(1)> program is used."
18520 #: ../fish/guestfish.pod:936
18525 #: ../fish/guestfish.pod:938
18527 "If compiled with GNU readline support, various files in the home directory "
18528 "can be used. See L</FILES>."
18532 #: ../fish/guestfish.pod:947
18534 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18535 "effect as using the B<-v> option."
18539 #: ../fish/guestfish.pod:959
18541 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18542 "the discussion of paths in L<guestfs(3)>."
18546 #: ../fish/guestfish.pod:970
18547 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18551 #: ../fish/guestfish.pod:972
18556 #: ../fish/guestfish.pod:974
18558 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18563 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
18568 #: ../fish/guestfish.pod:993
18569 msgid "$HOME/.guestfish"
18573 #: ../fish/guestfish.pod:995
18575 "If compiled with GNU readline support, then the command history is saved in "
18580 #: ../fish/guestfish.pod:998
18581 msgid "$HOME/.inputrc"
18585 #: ../fish/guestfish.pod:1000
18586 msgid "/etc/inputrc"
18590 #: ../fish/guestfish.pod:1002
18592 "If compiled with GNU readline support, then these files can be used to "
18593 "configure readline. For further information, please see "
18594 "L<readline(3)/INITIALIZATION FILE>."
18598 #: ../fish/guestfish.pod:1006
18599 msgid "To write rules which only apply to guestfish, use:"
18603 #: ../fish/guestfish.pod:1008
18613 #: ../fish/guestfish.pod:1012
18615 "Variables that you can set in inputrc that change the behaviour of guestfish "
18616 "in useful ways include:"
18620 #: ../fish/guestfish.pod:1017
18621 msgid "completion-ignore-case (default: on)"
18625 #: ../fish/guestfish.pod:1019
18627 "By default, guestfish will ignore case when tab-completing paths on the "
18632 #: ../fish/guestfish.pod:1022
18635 " set completion-ignore-case off\n"
18640 #: ../fish/guestfish.pod:1024
18641 msgid "to make guestfish case sensitive."
18645 #: ../fish/guestfish.pod:1028
18650 #: ../fish/guestfish.pod:1030
18651 msgid "test2.img (etc)"
18655 #: ../fish/guestfish.pod:1032
18657 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18658 "will be created in the file C<test1.img> in the current directory. The "
18659 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18660 "the same name will be overwritten."
18664 #: ../fish/guestfish.pod:1041
18666 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18667 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
18668 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
18669 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
18670 "L<virt-win-reg(1)>, L<hexedit(1)>."
18674 #: ../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-df.pl:657 ../tools/virt-resize.pl:1514 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
18676 "This program is free software; you can redistribute it and/or modify it "
18677 "under the terms of the GNU General Public License as published by the Free "
18678 "Software Foundation; either version 2 of the License, or (at your option) "
18679 "any later version."
18683 #: ../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-df.pl:662 ../tools/virt-resize.pl:1519 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
18685 "This program is distributed in the hope that it will be useful, but WITHOUT "
18686 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18687 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18692 #: ../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-df.pl:667 ../tools/virt-resize.pl:1524 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
18694 "You should have received a copy of the GNU General Public License along with "
18695 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18696 "Ave, Cambridge, MA 02139, USA."
18700 #: ../fish/guestfish-actions.pod:1
18705 #: ../fish/guestfish-actions.pod:3
18708 " add-cdrom filename\n"
18713 #: ../fish/guestfish-actions.pod:15
18715 "This call checks for the existence of C<filename>. This stops you from "
18716 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18717 "and C<http:> URLs. To specify those, use the general L</config> call "
18722 #: ../fish/guestfish-actions.pod:22
18724 "If you just want to add an ISO file (often you use this as an efficient way "
18725 "to transfer large files into the guest), then you should probably use "
18726 "L</add-drive-ro> instead."
18730 #: ../fish/guestfish-actions.pod:35
18735 #: ../fish/guestfish-actions.pod:37
18740 #: ../fish/guestfish-actions.pod:39
18743 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18748 #: ../fish/guestfish-actions.pod:41
18750 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18751 "It works by connecting to libvirt, requesting the domain and domain XML from "
18752 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18756 #: ../fish/guestfish-actions.pod:58
18758 "The optional C<libvirturi> parameter sets the libvirt URI (see "
18759 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
18760 "default libvirt URI (or one set through an environment variable, see the "
18761 "libvirt documentation for full details). If you are using the C API "
18762 "directly then it is more flexible to create the libvirt connection object "
18763 "yourself, get the domain object, and call L</add-libvirt-dom>."
18767 #: ../fish/guestfish-actions.pod:66
18769 "The other optional parameters are passed directly through to "
18770 "L</add-drive-opts>."
18774 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
18776 "This command has one or more optional arguments. See L</OPTIONAL "
18781 #: ../fish/guestfish-actions.pod:71
18786 #: ../fish/guestfish-actions.pod:73
18789 " add-drive filename\n"
18794 #: ../fish/guestfish-actions.pod:75
18796 "This function is the equivalent of calling L</add-drive-opts> with no "
18797 "optional parameters, so the disk is added writable, with the format being "
18798 "detected automatically."
18802 #: ../fish/guestfish-actions.pod:79
18804 "Automatic detection of the format opens you up to a potential security hole "
18805 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18806 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18807 "you should think about replacing calls to this function with calls to "
18808 "L</add-drive-opts>, and specifying the format."
18812 #: ../fish/guestfish-actions.pod:86
18813 msgid "add-drive-opts"
18817 #: ../fish/guestfish-actions.pod:88
18822 #: ../fish/guestfish-actions.pod:90
18825 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18830 #: ../fish/guestfish-actions.pod:117
18832 "This forces the image format. If you omit this (or use L</add-drive> or "
18833 "L</add-drive-ro>) then the format is automatically detected. Possible "
18834 "formats include C<raw> and C<qcow2>."
18838 #: ../fish/guestfish-actions.pod:128
18840 "This rarely-used option lets you emulate the behaviour of the deprecated "
18841 "L</add-drive-with-if> call (q.v.)"
18845 #: ../fish/guestfish-actions.pod:135
18846 msgid "add-drive-ro"
18850 #: ../fish/guestfish-actions.pod:137
18855 #: ../fish/guestfish-actions.pod:139
18858 " add-drive-ro filename\n"
18863 #: ../fish/guestfish-actions.pod:141
18865 "This function is the equivalent of calling L</add-drive-opts> with the "
18866 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18867 "is added read-only, with the format being detected automatically."
18871 #: ../fish/guestfish-actions.pod:146
18872 msgid "add-drive-ro-with-if"
18876 #: ../fish/guestfish-actions.pod:148
18879 " add-drive-ro-with-if filename iface\n"
18884 #: ../fish/guestfish-actions.pod:150
18886 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18887 "interface emulation to use at run time."
18891 #: ../fish/guestfish-actions.pod:160
18892 msgid "add-drive-with-if"
18896 #: ../fish/guestfish-actions.pod:162
18899 " add-drive-with-if filename iface\n"
18904 #: ../fish/guestfish-actions.pod:164
18906 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18907 "interface emulation to use at run time."
18911 #: ../fish/guestfish-actions.pod:174
18916 #: ../fish/guestfish-actions.pod:176
18919 " aug-clear augpath\n"
18924 #: ../fish/guestfish-actions.pod:181
18929 #: ../fish/guestfish-actions.pod:183
18937 #: ../fish/guestfish-actions.pod:185
18939 "Close the current Augeas handle and free up any resources used by it. After "
18940 "calling this, you have to call L</aug-init> again before you can use any "
18941 "other Augeas functions."
18945 #: ../fish/guestfish-actions.pod:190
18946 msgid "aug-defnode"
18950 #: ../fish/guestfish-actions.pod:192
18953 " aug-defnode name expr val\n"
18958 #: ../fish/guestfish-actions.pod:197
18960 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18961 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18962 "containing that single node."
18966 #: ../fish/guestfish-actions.pod:205
18971 #: ../fish/guestfish-actions.pod:207
18974 " aug-defvar name expr\n"
18979 #: ../fish/guestfish-actions.pod:216
18984 #: ../fish/guestfish-actions.pod:218
18987 " aug-get augpath\n"
18992 #: ../fish/guestfish-actions.pod:223
18997 #: ../fish/guestfish-actions.pod:225
19000 " aug-init root flags\n"
19005 #: ../fish/guestfish-actions.pod:231
19006 msgid "You must call this before using any other L</aug-*> commands."
19010 #: ../fish/guestfish-actions.pod:266
19011 msgid "Do not load the tree in L</aug-init>."
19015 #: ../fish/guestfish-actions.pod:270
19016 msgid "To close the handle, you can call L</aug-close>."
19020 #: ../fish/guestfish-actions.pod:274
19025 #: ../fish/guestfish-actions.pod:276
19028 " aug-insert augpath label true|false\n"
19033 #: ../fish/guestfish-actions.pod:286
19038 #: ../fish/guestfish-actions.pod:288
19046 #: ../fish/guestfish-actions.pod:295
19051 #: ../fish/guestfish-actions.pod:297
19054 " aug-ls augpath\n"
19059 #: ../fish/guestfish-actions.pod:299
19061 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19062 "resulting nodes into alphabetical order."
19066 #: ../fish/guestfish-actions.pod:302
19071 #: ../fish/guestfish-actions.pod:304
19074 " aug-match augpath\n"
19079 #: ../fish/guestfish-actions.pod:310
19084 #: ../fish/guestfish-actions.pod:312
19087 " aug-mv src dest\n"
19092 #: ../fish/guestfish-actions.pod:317
19097 #: ../fish/guestfish-actions.pod:319
19100 " aug-rm augpath\n"
19105 #: ../fish/guestfish-actions.pod:325
19110 #: ../fish/guestfish-actions.pod:327
19118 #: ../fish/guestfish-actions.pod:331
19120 "The flags which were passed to L</aug-init> affect exactly how files are "
19125 #: ../fish/guestfish-actions.pod:334
19130 #: ../fish/guestfish-actions.pod:336
19133 " aug-set augpath val\n"
19138 #: ../fish/guestfish-actions.pod:340
19140 "In the Augeas API, it is possible to clear a node by setting the value to "
19141 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19142 "this call. Instead you must use the L</aug-clear> call."
19146 #: ../fish/guestfish-actions.pod:345
19151 #: ../fish/guestfish-actions.pod:347
19154 " available 'groups ...'\n"
19159 #: ../fish/guestfish-actions.pod:353
19161 "The libguestfs groups, and the functions that those groups correspond to, "
19162 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19163 "runtime by calling L</available-all-groups>."
19167 #: ../fish/guestfish-actions.pod:377
19168 msgid "You must call L</launch> before calling this function."
19172 #: ../fish/guestfish-actions.pod:399
19174 "This call was added in version C<1.0.80>. In previous versions of "
19175 "libguestfs all you could do would be to speculatively execute a command to "
19176 "find out if the daemon implemented it. See also L</version>."
19180 #: ../fish/guestfish-actions.pod:406
19181 msgid "available-all-groups"
19185 #: ../fish/guestfish-actions.pod:408
19188 " available-all-groups\n"
19193 #: ../fish/guestfish-actions.pod:410
19195 "This command returns a list of all optional groups that this daemon knows "
19196 "about. Note this returns both supported and unsupported groups. To find "
19197 "out which ones the daemon can actually support you have to call "
19198 "L</available> on each member of the returned list."
19202 #: ../fish/guestfish-actions.pod:416
19203 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19207 #: ../fish/guestfish-actions.pod:418
19212 #: ../fish/guestfish-actions.pod:420
19215 " base64-in (base64file|-) filename\n"
19220 #: ../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:4128 ../fish/guestfish-actions.pod:4140 ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162 ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223 ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19221 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19225 #: ../fish/guestfish-actions.pod:427
19230 #: ../fish/guestfish-actions.pod:429
19233 " base64-out filename (base64file|-)\n"
19238 #: ../fish/guestfish-actions.pod:436
19239 msgid "blockdev-flushbufs"
19243 #: ../fish/guestfish-actions.pod:438
19246 " blockdev-flushbufs device\n"
19251 #: ../fish/guestfish-actions.pod:445
19252 msgid "blockdev-getbsz"
19256 #: ../fish/guestfish-actions.pod:447
19259 " blockdev-getbsz device\n"
19264 #: ../fish/guestfish-actions.pod:456
19265 msgid "blockdev-getro"
19269 #: ../fish/guestfish-actions.pod:458
19272 " blockdev-getro device\n"
19277 #: ../fish/guestfish-actions.pod:465
19278 msgid "blockdev-getsize64"
19282 #: ../fish/guestfish-actions.pod:467
19285 " blockdev-getsize64 device\n"
19290 #: ../fish/guestfish-actions.pod:471
19291 msgid "See also L</blockdev-getsz>."
19295 #: ../fish/guestfish-actions.pod:475
19296 msgid "blockdev-getss"
19300 #: ../fish/guestfish-actions.pod:477
19303 " blockdev-getss device\n"
19308 #: ../fish/guestfish-actions.pod:482
19309 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19313 #: ../fish/guestfish-actions.pod:487
19314 msgid "blockdev-getsz"
19318 #: ../fish/guestfish-actions.pod:489
19321 " blockdev-getsz device\n"
19326 #: ../fish/guestfish-actions.pod:494
19328 "See also L</blockdev-getss> for the real sector size of the device, and "
19329 "L</blockdev-getsize64> for the more useful I<size in bytes>."
19333 #: ../fish/guestfish-actions.pod:500
19334 msgid "blockdev-rereadpt"
19338 #: ../fish/guestfish-actions.pod:502
19341 " blockdev-rereadpt device\n"
19346 #: ../fish/guestfish-actions.pod:508
19347 msgid "blockdev-setbsz"
19351 #: ../fish/guestfish-actions.pod:510
19354 " blockdev-setbsz device blocksize\n"
19359 #: ../fish/guestfish-actions.pod:519
19360 msgid "blockdev-setro"
19364 #: ../fish/guestfish-actions.pod:521
19367 " blockdev-setro device\n"
19372 #: ../fish/guestfish-actions.pod:527
19373 msgid "blockdev-setrw"
19377 #: ../fish/guestfish-actions.pod:529
19380 " blockdev-setrw device\n"
19385 #: ../fish/guestfish-actions.pod:535
19386 msgid "case-sensitive-path"
19390 #: ../fish/guestfish-actions.pod:537
19393 " case-sensitive-path path\n"
19398 #: ../fish/guestfish-actions.pod:561
19400 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
19401 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
19402 "how the directories were originally created under Windows)."
19406 #: ../fish/guestfish-actions.pod:569
19407 msgid "See also L</realpath>."
19411 #: ../fish/guestfish-actions.pod:571
19416 #: ../fish/guestfish-actions.pod:573
19424 #: ../fish/guestfish-actions.pod:577
19426 "Note that this function cannot correctly handle binary files (specifically, "
19427 "files containing C<\\0> character which is treated as end of string). For "
19428 "those you need to use the L</read-file> or L</download> functions which have "
19429 "a more complex interface."
19433 #: ../fish/guestfish-actions.pod:585
19438 #: ../fish/guestfish-actions.pod:587
19441 " checksum csumtype path\n"
19446 #: ../fish/guestfish-actions.pod:630
19447 msgid "To get the checksum for a device, use L</checksum-device>."
19451 #: ../fish/guestfish-actions.pod:632
19452 msgid "To get the checksums for many files, use L</checksums-out>."
19456 #: ../fish/guestfish-actions.pod:634
19457 msgid "checksum-device"
19461 #: ../fish/guestfish-actions.pod:636
19464 " checksum-device csumtype device\n"
19469 #: ../fish/guestfish-actions.pod:638
19471 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19472 "device named C<device>. For the types of checksums supported see the "
19473 "L</checksum> command."
19477 #: ../fish/guestfish-actions.pod:642
19478 msgid "checksums-out"
19482 #: ../fish/guestfish-actions.pod:644
19485 " checksums-out csumtype directory (sumsfile|-)\n"
19490 #: ../fish/guestfish-actions.pod:660
19495 #: ../fish/guestfish-actions.pod:662
19498 " chmod mode path\n"
19503 #: ../fish/guestfish-actions.pod:673
19508 #: ../fish/guestfish-actions.pod:675
19511 " chown owner group path\n"
19516 #: ../fish/guestfish-actions.pod:683
19521 #: ../fish/guestfish-actions.pod:685
19524 " command 'arguments ...'\n"
19529 #: ../fish/guestfish-actions.pod:692
19531 "The single parameter is an argv-style list of arguments. The first element "
19532 "is the name of the program to run. Subsequent elements are parameters. The "
19533 "list must be non-empty (ie. must contain a program name). Note that the "
19534 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19538 #: ../fish/guestfish-actions.pod:720
19539 msgid "command-lines"
19543 #: ../fish/guestfish-actions.pod:722
19546 " command-lines 'arguments ...'\n"
19551 #: ../fish/guestfish-actions.pod:724
19552 msgid "This is the same as L</command>, but splits the result into a list of lines."
19556 #: ../fish/guestfish-actions.pod:727
19557 msgid "See also: L</sh-lines>"
19561 #: ../fish/guestfish-actions.pod:732
19566 #: ../fish/guestfish-actions.pod:734
19569 " config qemuparam qemuvalue\n"
19574 #: ../fish/guestfish-actions.pod:745
19579 #: ../fish/guestfish-actions.pod:747
19582 " copy-size src dest size\n"
19587 #: ../fish/guestfish-actions.pod:755
19592 #: ../fish/guestfish-actions.pod:757
19600 #: ../fish/guestfish-actions.pod:762
19605 #: ../fish/guestfish-actions.pod:764
19613 #: ../fish/guestfish-actions.pod:769
19618 #: ../fish/guestfish-actions.pod:771
19626 #: ../fish/guestfish-actions.pod:778
19628 "If the destination is a device, it must be as large or larger than the "
19629 "source file or device, otherwise the copy will fail. This command cannot do "
19630 "partial copies (see L</copy-size>)."
19634 #: ../fish/guestfish-actions.pod:782
19639 #: ../fish/guestfish-actions.pod:784
19647 #: ../fish/guestfish-actions.pod:792
19652 #: ../fish/guestfish-actions.pod:794
19660 #: ../fish/guestfish-actions.pod:803
19665 #: ../fish/guestfish-actions.pod:805
19673 #: ../fish/guestfish-actions.pod:811
19675 "Another way to get the same information is to enable verbose messages with "
19676 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19677 "before running the program."
19681 #: ../fish/guestfish-actions.pod:816
19686 #: ../fish/guestfish-actions.pod:818
19689 " download remotefilename (filename|-)\n"
19694 #: ../fish/guestfish-actions.pod:825
19695 msgid "See also L</upload>, L</cat>."
19699 #: ../fish/guestfish-actions.pod:829
19700 msgid "download-offset"
19704 #: ../fish/guestfish-actions.pod:831
19707 " download-offset remotefilename (filename|-) offset size\n"
19712 #: ../fish/guestfish-actions.pod:839
19714 "Note that there is no limit on the amount of data that can be downloaded "
19715 "with this call, unlike with L</pread>, and this call always reads the full "
19716 "amount unless an error occurs."
19720 #: ../fish/guestfish-actions.pod:844
19721 msgid "See also L</download>, L</pread>."
19725 #: ../fish/guestfish-actions.pod:848
19726 msgid "drop-caches"
19730 #: ../fish/guestfish-actions.pod:850
19733 " drop-caches whattodrop\n"
19738 #: ../fish/guestfish-actions.pod:862
19743 #: ../fish/guestfish-actions.pod:864
19751 #: ../fish/guestfish-actions.pod:876
19756 #: ../fish/guestfish-actions.pod:878
19759 " e2fsck-f device\n"
19764 #: ../fish/guestfish-actions.pod:884
19766 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19767 "should use L</fsck>."
19771 #: ../fish/guestfish-actions.pod:887
19772 msgid "echo-daemon"
19776 #: ../fish/guestfish-actions.pod:889
19779 " echo-daemon 'words ...'\n"
19784 #: ../fish/guestfish-actions.pod:896
19785 msgid "See also L</ping-daemon>."
19789 #: ../fish/guestfish-actions.pod:898
19794 #: ../fish/guestfish-actions.pod:900
19797 " egrep regex path\n"
19802 #: ../fish/guestfish-actions.pod:908
19807 #: ../fish/guestfish-actions.pod:910
19810 " egrepi regex path\n"
19815 #: ../fish/guestfish-actions.pod:918
19820 #: ../fish/guestfish-actions.pod:920
19823 " equal file1 file2\n"
19828 #: ../fish/guestfish-actions.pod:927
19833 #: ../fish/guestfish-actions.pod:929
19841 #: ../fish/guestfish-actions.pod:934
19842 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19846 #: ../fish/guestfish-actions.pod:936
19851 #: ../fish/guestfish-actions.pod:938
19854 " fallocate path len\n"
19859 #: ../fish/guestfish-actions.pod:955
19860 msgid "fallocate64"
19864 #: ../fish/guestfish-actions.pod:957
19867 " fallocate64 path len\n"
19872 #: ../fish/guestfish-actions.pod:963
19874 "Note that this call allocates disk blocks for the file. To create a sparse "
19875 "file use L</truncate-size> instead."
19879 #: ../fish/guestfish-actions.pod:966
19881 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19882 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19883 "maximum size of files created through that call to 1GB."
19887 #: ../fish/guestfish-actions.pod:975
19892 #: ../fish/guestfish-actions.pod:977
19895 " fgrep pattern path\n"
19900 #: ../fish/guestfish-actions.pod:985
19905 #: ../fish/guestfish-actions.pod:987
19908 " fgrepi pattern path\n"
19913 #: ../fish/guestfish-actions.pod:995
19918 #: ../fish/guestfish-actions.pod:997
19926 #: ../fish/guestfish-actions.pod:1009
19928 "This command can also be used on C</dev/> devices (and partitions, LV "
19929 "names). You can for example use this to determine if a device contains a "
19930 "filesystem, although it's usually better to use L</vfs-type>."
19934 #: ../fish/guestfish-actions.pod:1019
19935 msgid "file-architecture"
19939 #: ../fish/guestfish-actions.pod:1021
19942 " file-architecture filename\n"
19947 #: ../fish/guestfish-actions.pod:1124
19952 #: ../fish/guestfish-actions.pod:1126
19960 #: ../fish/guestfish-actions.pod:1130
19962 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
19963 "L</is-file> etc. To get the size of block devices, use "
19964 "L</blockdev-getsize64>."
19968 #: ../fish/guestfish-actions.pod:1134
19973 #: ../fish/guestfish-actions.pod:1136
19976 " fill c len path\n"
19981 #: ../fish/guestfish-actions.pod:1142
19983 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19984 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19985 "L</fill-pattern>."
19989 #: ../fish/guestfish-actions.pod:1147
19990 msgid "fill-pattern"
19994 #: ../fish/guestfish-actions.pod:1149
19997 " fill-pattern pattern len path\n"
20002 #: ../fish/guestfish-actions.pod:1151
20004 "This function is like L</fill> except that it creates a new file of length "
20005 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20006 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20011 #: ../fish/guestfish-actions.pod:1156
20016 #: ../fish/guestfish-actions.pod:1158
20019 " find directory\n"
20024 #: ../fish/guestfish-actions.pod:1172
20025 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20029 #: ../fish/guestfish-actions.pod:1185
20030 msgid "See also L</find0>."
20034 #: ../fish/guestfish-actions.pod:1190
20039 #: ../fish/guestfish-actions.pod:1192
20042 " find0 directory (files|-)\n"
20047 #: ../fish/guestfish-actions.pod:1198
20048 msgid "This command works the same way as L</find> with the following exceptions:"
20052 #: ../fish/guestfish-actions.pod:1225
20053 msgid "findfs-label"
20057 #: ../fish/guestfish-actions.pod:1227
20060 " findfs-label label\n"
20065 #: ../fish/guestfish-actions.pod:1233
20066 msgid "To find the label of a filesystem, use L</vfs-label>."
20070 #: ../fish/guestfish-actions.pod:1235
20071 msgid "findfs-uuid"
20075 #: ../fish/guestfish-actions.pod:1237
20078 " findfs-uuid uuid\n"
20083 #: ../fish/guestfish-actions.pod:1243
20084 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20088 #: ../fish/guestfish-actions.pod:1245
20093 #: ../fish/guestfish-actions.pod:1247
20096 " fsck fstype device\n"
20101 #: ../fish/guestfish-actions.pod:1277
20106 #: ../fish/guestfish-actions.pod:1279
20114 #: ../fish/guestfish-actions.pod:1286
20115 msgid "get-autosync"
20119 #: ../fish/guestfish-actions.pod:1288
20127 #: ../fish/guestfish-actions.pod:1292
20132 #: ../fish/guestfish-actions.pod:1294
20140 #: ../fish/guestfish-actions.pod:1298
20141 msgid "get-e2label"
20145 #: ../fish/guestfish-actions.pod:1300
20148 " get-e2label device\n"
20153 #: ../fish/guestfish-actions.pod:1312
20158 #: ../fish/guestfish-actions.pod:1314
20161 " get-e2uuid device\n"
20166 #: ../fish/guestfish-actions.pod:1326
20167 msgid "get-memsize"
20171 #: ../fish/guestfish-actions.pod:1328
20179 #: ../fish/guestfish-actions.pod:1333
20181 "If L</set-memsize> was not called on this handle, and if "
20182 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20183 "value for memsize."
20187 #: ../fish/guestfish-actions.pod:1340
20188 msgid "get-network"
20192 #: ../fish/guestfish-actions.pod:1342
20200 #: ../fish/guestfish-actions.pod:1346
20205 #: ../fish/guestfish-actions.pod:1348
20213 #: ../fish/guestfish-actions.pod:1355
20218 #: ../fish/guestfish-actions.pod:1357
20223 #: ../fish/guestfish-actions.pod:1359
20231 #: ../fish/guestfish-actions.pod:1366
20236 #: ../fish/guestfish-actions.pod:1368
20244 #: ../fish/guestfish-actions.pod:1375
20245 msgid "get-recovery-proc"
20249 #: ../fish/guestfish-actions.pod:1377
20252 " get-recovery-proc\n"
20257 #: ../fish/guestfish-actions.pod:1381
20258 msgid "get-selinux"
20262 #: ../fish/guestfish-actions.pod:1383
20270 #: ../fish/guestfish-actions.pod:1385
20272 "This returns the current setting of the selinux flag which is passed to the "
20273 "appliance at boot time. See L</set-selinux>."
20277 #: ../fish/guestfish-actions.pod:1391
20282 #: ../fish/guestfish-actions.pod:1393
20290 #: ../fish/guestfish-actions.pod:1400
20295 #: ../fish/guestfish-actions.pod:1402
20303 #: ../fish/guestfish-actions.pod:1406
20308 #: ../fish/guestfish-actions.pod:1408
20316 #: ../fish/guestfish-actions.pod:1410
20318 "Return the current umask. By default the umask is C<022> unless it has been "
20319 "set by calling L</umask>."
20323 #: ../fish/guestfish-actions.pod:1413
20324 msgid "get-verbose"
20328 #: ../fish/guestfish-actions.pod:1415
20336 #: ../fish/guestfish-actions.pod:1419
20341 #: ../fish/guestfish-actions.pod:1421
20349 #: ../fish/guestfish-actions.pod:1425
20350 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20354 #: ../fish/guestfish-actions.pod:1428
20359 #: ../fish/guestfish-actions.pod:1430
20362 " getxattrs path\n"
20367 #: ../fish/guestfish-actions.pod:1438
20368 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20372 #: ../fish/guestfish-actions.pod:1440
20373 msgid "glob-expand"
20377 #: ../fish/guestfish-actions.pod:1442
20380 " glob-expand pattern\n"
20385 #: ../fish/guestfish-actions.pod:1455
20390 #: ../fish/guestfish-actions.pod:1457
20393 " grep regex path\n"
20398 #: ../fish/guestfish-actions.pod:1465
20403 #: ../fish/guestfish-actions.pod:1467
20406 " grepi regex path\n"
20411 #: ../fish/guestfish-actions.pod:1475
20412 msgid "grub-install"
20416 #: ../fish/guestfish-actions.pod:1477
20419 " grub-install root device\n"
20424 #: ../fish/guestfish-actions.pod:1493
20429 #: ../fish/guestfish-actions.pod:1495
20437 #: ../fish/guestfish-actions.pod:1503
20442 #: ../fish/guestfish-actions.pod:1505
20445 " head-n nrlines path\n"
20450 #: ../fish/guestfish-actions.pod:1518
20455 #: ../fish/guestfish-actions.pod:1520
20463 #: ../fish/guestfish-actions.pod:1528
20468 #: ../fish/guestfish-actions.pod:1530
20471 " initrd-cat initrdpath filename\n"
20476 #: ../fish/guestfish-actions.pod:1542
20477 msgid "See also L</initrd-list>."
20481 #: ../fish/guestfish-actions.pod:1547
20482 msgid "initrd-list"
20486 #: ../fish/guestfish-actions.pod:1549
20489 " initrd-list path\n"
20494 #: ../fish/guestfish-actions.pod:1561
20495 msgid "inotify-add-watch"
20499 #: ../fish/guestfish-actions.pod:1563
20502 " inotify-add-watch path mask\n"
20507 #: ../fish/guestfish-actions.pod:1575
20508 msgid "inotify-close"
20512 #: ../fish/guestfish-actions.pod:1577
20520 #: ../fish/guestfish-actions.pod:1583
20521 msgid "inotify-files"
20525 #: ../fish/guestfish-actions.pod:1585
20533 #: ../fish/guestfish-actions.pod:1587
20535 "This function is a helpful wrapper around L</inotify-read> which just "
20536 "returns a list of pathnames of objects that were touched. The returned "
20537 "pathnames are sorted and deduplicated."
20541 #: ../fish/guestfish-actions.pod:1591
20542 msgid "inotify-init"
20546 #: ../fish/guestfish-actions.pod:1593
20549 " inotify-init maxevents\n"
20554 #: ../fish/guestfish-actions.pod:1599
20556 "C<maxevents> is the maximum number of events which will be queued up between "
20557 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20558 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20559 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20560 "but records the fact that it threw them away by setting a flag "
20561 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20565 #: ../fish/guestfish-actions.pod:1609
20567 "Before any events are generated, you have to add some watches to the "
20568 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20569 "L</inotify-watch-all>."
20573 #: ../fish/guestfish-actions.pod:1615
20575 "Queued up events should be read periodically by calling L</inotify-read> (or "
20576 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20577 "If you don't read the events out often enough then you risk the internal "
20578 "queue overflowing."
20582 #: ../fish/guestfish-actions.pod:1622
20584 "The handle should be closed after use by calling L</inotify-close>. This "
20585 "also removes any watches automatically."
20589 #: ../fish/guestfish-actions.pod:1631
20590 msgid "inotify-read"
20594 #: ../fish/guestfish-actions.pod:1633
20602 #: ../fish/guestfish-actions.pod:1646
20603 msgid "inotify-rm-watch"
20607 #: ../fish/guestfish-actions.pod:1648
20610 " inotify-rm-watch wd\n"
20615 #: ../fish/guestfish-actions.pod:1650
20616 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20620 #: ../fish/guestfish-actions.pod:1653
20621 msgid "inspect-get-arch"
20625 #: ../fish/guestfish-actions.pod:1655
20628 " inspect-get-arch root\n"
20633 #: ../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
20635 "This function should only be called with a root device string as returned by "
20640 #: ../fish/guestfish-actions.pod:1660
20642 "This returns the architecture of the inspected operating system. The "
20643 "possible return values are listed under L</file-architecture>."
20647 #: ../fish/guestfish-actions.pod:1669
20648 msgid "inspect-get-distro"
20652 #: ../fish/guestfish-actions.pod:1671
20655 " inspect-get-distro root\n"
20660 #: ../fish/guestfish-actions.pod:1743
20661 msgid "inspect-get-filesystems"
20665 #: ../fish/guestfish-actions.pod:1745
20668 " inspect-get-filesystems root\n"
20673 #: ../fish/guestfish-actions.pod:1758
20675 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20676 "L</inspect-get-mountpoints>."
20680 #: ../fish/guestfish-actions.pod:1761
20681 msgid "inspect-get-hostname"
20685 #: ../fish/guestfish-actions.pod:1763
20688 " inspect-get-hostname root\n"
20693 #: ../fish/guestfish-actions.pod:1776
20694 msgid "inspect-get-major-version"
20698 #: ../fish/guestfish-actions.pod:1778
20701 " inspect-get-major-version root\n"
20706 #: ../fish/guestfish-actions.pod:1797
20707 msgid "inspect-get-minor-version"
20711 #: ../fish/guestfish-actions.pod:1799
20714 " inspect-get-minor-version root\n"
20719 #: ../fish/guestfish-actions.pod:1809
20721 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20722 "L</inspect-get-major-version>."
20726 #: ../fish/guestfish-actions.pod:1812
20727 msgid "inspect-get-mountpoints"
20731 #: ../fish/guestfish-actions.pod:1814
20734 " inspect-get-mountpoints root\n"
20739 #: ../fish/guestfish-actions.pod:1832
20741 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20742 "L</inspect-get-filesystems>."
20746 #: ../fish/guestfish-actions.pod:1835
20747 msgid "inspect-get-package-format"
20751 #: ../fish/guestfish-actions.pod:1837
20754 " inspect-get-package-format root\n"
20759 #: ../fish/guestfish-actions.pod:1842
20761 "This function and L</inspect-get-package-management> return the package "
20762 "format and package management tool used by the inspected operating system. "
20763 "For example for Fedora these functions would return C<rpm> (package format) "
20764 "and C<yum> (package management)."
20768 #: ../fish/guestfish-actions.pod:1857
20769 msgid "inspect-get-package-management"
20773 #: ../fish/guestfish-actions.pod:1859
20776 " inspect-get-package-management root\n"
20781 #: ../fish/guestfish-actions.pod:1864
20783 "L</inspect-get-package-format> and this function return the package format "
20784 "and package management tool used by the inspected operating system. For "
20785 "example for Fedora these functions would return C<rpm> (package format) and "
20786 "C<yum> (package management)."
20790 #: ../fish/guestfish-actions.pod:1881
20791 msgid "inspect-get-product-name"
20795 #: ../fish/guestfish-actions.pod:1883
20798 " inspect-get-product-name root\n"
20803 #: ../fish/guestfish-actions.pod:1898
20804 msgid "inspect-get-roots"
20808 #: ../fish/guestfish-actions.pod:1900
20811 " inspect-get-roots\n"
20816 #: ../fish/guestfish-actions.pod:1902
20818 "This function is a convenient way to get the list of root devices, as "
20819 "returned from a previous call to L</inspect-os>, but without redoing the "
20820 "whole inspection process."
20824 #: ../fish/guestfish-actions.pod:1906
20826 "This returns an empty list if either no root devices were found or the "
20827 "caller has not called L</inspect-os>."
20831 #: ../fish/guestfish-actions.pod:1911
20832 msgid "inspect-get-type"
20836 #: ../fish/guestfish-actions.pod:1913
20839 " inspect-get-type root\n"
20844 #: ../fish/guestfish-actions.pod:1946
20845 msgid "inspect-get-windows-systemroot"
20849 #: ../fish/guestfish-actions.pod:1948
20852 " inspect-get-windows-systemroot root\n"
20857 #: ../fish/guestfish-actions.pod:1962
20858 msgid "inspect-list-applications"
20862 #: ../fish/guestfish-actions.pod:1964
20865 " inspect-list-applications root\n"
20870 #: ../fish/guestfish-actions.pod:1971
20872 "I<Note:> This call works differently from other parts of the inspection "
20873 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
20874 "then mount up the disks, before calling this. Listing applications is a "
20875 "significantly more difficult operation which requires access to the full "
20876 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
20877 "are just returning data cached in the libguestfs handle, this call actually "
20878 "reads parts of the mounted filesystems during the call."
20882 #: ../fish/guestfish-actions.pod:2061
20887 #: ../fish/guestfish-actions.pod:2063
20895 #: ../fish/guestfish-actions.pod:2078
20897 "You can pass the root string(s) returned to other L</inspect-get-*> "
20898 "functions in order to query further information about each operating system, "
20899 "such as the name and version."
20903 #: ../fish/guestfish-actions.pod:2083
20905 "This function uses other libguestfs features such as L</mount-ro> and "
20906 "L</umount-all> in order to mount and unmount filesystems and look at the "
20907 "contents. This should be called with no disks currently mounted. The "
20908 "function may also use Augeas, so any existing Augeas handle will be closed."
20912 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2297
20913 msgid "See also L</list-filesystems>."
20917 #: ../fish/guestfish-actions.pod:2097
20918 msgid "is-blockdev"
20922 #: ../fish/guestfish-actions.pod:2099
20925 " is-blockdev path\n"
20930 #: ../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
20931 msgid "See also L</stat>."
20935 #: ../fish/guestfish-actions.pod:2106
20940 #: ../fish/guestfish-actions.pod:2108
20948 #: ../fish/guestfish-actions.pod:2115
20953 #: ../fish/guestfish-actions.pod:2117
20956 " is-chardev path\n"
20961 #: ../fish/guestfish-actions.pod:2124
20966 #: ../fish/guestfish-actions.pod:2126
20974 #: ../fish/guestfish-actions.pod:2133
20979 #: ../fish/guestfish-actions.pod:2135
20987 #: ../fish/guestfish-actions.pod:2143
20992 #: ../fish/guestfish-actions.pod:2145
21000 #: ../fish/guestfish-actions.pod:2152
21005 #: ../fish/guestfish-actions.pod:2154
21013 #: ../fish/guestfish-actions.pod:2162
21014 msgid "is-launching"
21018 #: ../fish/guestfish-actions.pod:2164
21026 #: ../fish/guestfish-actions.pod:2171
21031 #: ../fish/guestfish-actions.pod:2173
21039 #: ../fish/guestfish-actions.pod:2178
21044 #: ../fish/guestfish-actions.pod:2180
21052 #: ../fish/guestfish-actions.pod:2187
21057 #: ../fish/guestfish-actions.pod:2189
21060 " is-socket path\n"
21065 #: ../fish/guestfish-actions.pod:2196
21070 #: ../fish/guestfish-actions.pod:2198
21073 " is-symlink path\n"
21078 #: ../fish/guestfish-actions.pod:2205
21079 msgid "kill-subprocess"
21083 #: ../fish/guestfish-actions.pod:2207
21086 " kill-subprocess\n"
21091 #: ../fish/guestfish-actions.pod:2211
21096 #: ../fish/guestfish-actions.pod:2213
21101 #: ../fish/guestfish-actions.pod:2215
21109 #: ../fish/guestfish-actions.pod:2223
21114 #: ../fish/guestfish-actions.pod:2225
21117 " lchown owner group path\n"
21122 #: ../fish/guestfish-actions.pod:2227
21124 "Change the file owner to C<owner> and group to C<group>. This is like "
21125 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
21130 #: ../fish/guestfish-actions.pod:2235
21135 #: ../fish/guestfish-actions.pod:2237
21138 " lgetxattrs path\n"
21143 #: ../fish/guestfish-actions.pod:2239
21145 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21146 "it returns the extended attributes of the link itself."
21150 #: ../fish/guestfish-actions.pod:2243
21151 msgid "list-devices"
21155 #: ../fish/guestfish-actions.pod:2245
21163 #: ../fish/guestfish-actions.pod:2253
21164 msgid "list-filesystems"
21168 #: ../fish/guestfish-actions.pod:2255
21171 " list-filesystems\n"
21176 #: ../fish/guestfish-actions.pod:2274
21178 "This command runs other libguestfs commands, which might include L</mount> "
21179 "and L</umount>, and therefore you should use this soon after launch and only "
21180 "when nothing is mounted."
21184 #: ../fish/guestfish-actions.pod:2278
21186 "Not all of the filesystems returned will be mountable. In particular, swap "
21187 "partitions are returned in the list. Also this command does not check that "
21188 "each filesystem found is valid and mountable, and some filesystems might be "
21189 "mountable but require special options. Filesystems may not all belong to a "
21190 "single logical operating system (use L</inspect-os> to look for OSes)."
21194 #: ../fish/guestfish-actions.pod:2286
21195 msgid "list-partitions"
21199 #: ../fish/guestfish-actions.pod:2288
21202 " list-partitions\n"
21207 #: ../fish/guestfish-actions.pod:2294
21209 "This does not return logical volumes. For that you will need to call "
21214 #: ../fish/guestfish-actions.pod:2299
21219 #: ../fish/guestfish-actions.pod:2301
21227 #: ../fish/guestfish-actions.pod:2309
21232 #: ../fish/guestfish-actions.pod:2311
21235 " ln target linkname\n"
21240 #: ../fish/guestfish-actions.pod:2315
21245 #: ../fish/guestfish-actions.pod:2317
21248 " ln-f target linkname\n"
21253 #: ../fish/guestfish-actions.pod:2322
21258 #: ../fish/guestfish-actions.pod:2324
21261 " ln-s target linkname\n"
21266 #: ../fish/guestfish-actions.pod:2328
21271 #: ../fish/guestfish-actions.pod:2330
21274 " ln-sf target linkname\n"
21279 #: ../fish/guestfish-actions.pod:2335
21280 msgid "lremovexattr"
21284 #: ../fish/guestfish-actions.pod:2337
21287 " lremovexattr xattr path\n"
21292 #: ../fish/guestfish-actions.pod:2339
21294 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21295 "it removes an extended attribute of the link itself."
21299 #: ../fish/guestfish-actions.pod:2343
21304 #: ../fish/guestfish-actions.pod:2345
21312 #: ../fish/guestfish-actions.pod:2351
21314 "This command is mostly useful for interactive sessions. Programs should "
21315 "probably use L</readdir> instead."
21319 #: ../fish/guestfish-actions.pod:2354
21324 #: ../fish/guestfish-actions.pod:2356
21327 " lsetxattr xattr val vallen path\n"
21332 #: ../fish/guestfish-actions.pod:2358
21334 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21335 "sets an extended attribute of the link itself."
21339 #: ../fish/guestfish-actions.pod:2362
21344 #: ../fish/guestfish-actions.pod:2364
21352 #: ../fish/guestfish-actions.pod:2368
21354 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21355 "the link is stat-ed, not the file it refers to."
21359 #: ../fish/guestfish-actions.pod:2374
21364 #: ../fish/guestfish-actions.pod:2376
21367 " lstatlist path 'names ...'\n"
21372 #: ../fish/guestfish-actions.pod:2378
21374 "This call allows you to perform the L</lstat> operation on multiple files, "
21375 "where all files are in the directory C<path>. C<names> is the list of files "
21376 "from this directory."
21380 #: ../fish/guestfish-actions.pod:2387
21382 "This call is intended for programs that want to efficiently list a directory "
21383 "contents without making many round-trips. See also L</lxattrlist> for a "
21384 "similarly efficient call for getting extended attributes. Very long "
21385 "directory listings might cause the protocol message size to be exceeded, "
21386 "causing this call to fail. The caller must split up such requests into "
21387 "smaller groups of names."
21391 #: ../fish/guestfish-actions.pod:2395
21392 msgid "luks-add-key"
21396 #: ../fish/guestfish-actions.pod:2397
21399 " luks-add-key device keyslot\n"
21404 #: ../fish/guestfish-actions.pod:2404
21406 "Note that if C<keyslot> already contains a key, then this command will "
21407 "fail. You have to use L</luks-kill-slot> first to remove that key."
21411 #: ../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
21413 "This command has one or more key or passphrase parameters. Guestfish will "
21414 "prompt for these separately."
21418 #: ../fish/guestfish-actions.pod:2411
21423 #: ../fish/guestfish-actions.pod:2413
21426 " luks-close device\n"
21431 #: ../fish/guestfish-actions.pod:2415
21433 "This closes a LUKS device that was created earlier by L</luks-open> or "
21434 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
21435 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
21436 "underlying block device."
21440 #: ../fish/guestfish-actions.pod:2421
21441 msgid "luks-format"
21445 #: ../fish/guestfish-actions.pod:2423
21448 " luks-format device keyslot\n"
21453 #: ../fish/guestfish-actions.pod:2436
21454 msgid "luks-format-cipher"
21458 #: ../fish/guestfish-actions.pod:2438
21461 " luks-format-cipher device keyslot cipher\n"
21466 #: ../fish/guestfish-actions.pod:2440
21468 "This command is the same as L</luks-format> but it also allows you to set "
21469 "the C<cipher> used."
21473 #: ../fish/guestfish-actions.pod:2449
21474 msgid "luks-kill-slot"
21478 #: ../fish/guestfish-actions.pod:2451
21481 " luks-kill-slot device keyslot\n"
21486 #: ../fish/guestfish-actions.pod:2460
21491 #: ../fish/guestfish-actions.pod:2462
21494 " luks-open device mapname\n"
21499 #: ../fish/guestfish-actions.pod:2476
21501 "If this block device contains LVM volume groups, then calling L</vgscan> "
21502 "followed by L</vg-activate-all> will make them visible."
21506 #: ../fish/guestfish-actions.pod:2483
21507 msgid "luks-open-ro"
21511 #: ../fish/guestfish-actions.pod:2485
21514 " luks-open-ro device mapname\n"
21519 #: ../fish/guestfish-actions.pod:2487
21521 "This is the same as L</luks-open> except that a read-only mapping is "
21526 #: ../fish/guestfish-actions.pod:2493
21531 #: ../fish/guestfish-actions.pod:2495
21534 " lvcreate logvol volgroup mbytes\n"
21539 #: ../fish/guestfish-actions.pod:2500
21540 msgid "lvm-canonical-lv-name"
21544 #: ../fish/guestfish-actions.pod:2502
21547 " lvm-canonical-lv-name lvname\n"
21552 #: ../fish/guestfish-actions.pod:2511
21553 msgid "See also L</is-lv>."
21557 #: ../fish/guestfish-actions.pod:2513
21558 msgid "lvm-clear-filter"
21562 #: ../fish/guestfish-actions.pod:2515
21565 " lvm-clear-filter\n"
21570 #: ../fish/guestfish-actions.pod:2517
21572 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21577 #: ../fish/guestfish-actions.pod:2523
21578 msgid "lvm-remove-all"
21582 #: ../fish/guestfish-actions.pod:2525
21585 " lvm-remove-all\n"
21590 #: ../fish/guestfish-actions.pod:2533
21591 msgid "lvm-set-filter"
21595 #: ../fish/guestfish-actions.pod:2535
21598 " lvm-set-filter 'devices ...'\n"
21603 #: ../fish/guestfish-actions.pod:2560
21608 #: ../fish/guestfish-actions.pod:2562
21611 " lvremove device\n"
21616 #: ../fish/guestfish-actions.pod:2570
21621 #: ../fish/guestfish-actions.pod:2572
21624 " lvrename logvol newlogvol\n"
21629 #: ../fish/guestfish-actions.pod:2576
21634 #: ../fish/guestfish-actions.pod:2578
21637 " lvresize device mbytes\n"
21642 #: ../fish/guestfish-actions.pod:2584
21643 msgid "lvresize-free"
21647 #: ../fish/guestfish-actions.pod:2586
21650 " lvresize-free lv percent\n"
21655 #: ../fish/guestfish-actions.pod:2594
21660 #: ../fish/guestfish-actions.pod:2596
21668 #: ../fish/guestfish-actions.pod:2604
21669 msgid "See also L</lvs-full>, L</list-filesystems>."
21673 #: ../fish/guestfish-actions.pod:2606
21678 #: ../fish/guestfish-actions.pod:2608
21686 #: ../fish/guestfish-actions.pod:2613
21691 #: ../fish/guestfish-actions.pod:2615
21699 #: ../fish/guestfish-actions.pod:2619
21704 #: ../fish/guestfish-actions.pod:2621
21707 " lxattrlist path 'names ...'\n"
21712 #: ../fish/guestfish-actions.pod:2637
21714 "This call is intended for programs that want to efficiently list a directory "
21715 "contents without making many round-trips. See also L</lstatlist> for a "
21716 "similarly efficient call for getting standard stats. Very long directory "
21717 "listings might cause the protocol message size to be exceeded, causing this "
21718 "call to fail. The caller must split up such requests into smaller groups of "
21723 #: ../fish/guestfish-actions.pod:2645
21728 #: ../fish/guestfish-actions.pod:2647
21736 #: ../fish/guestfish-actions.pod:2651
21741 #: ../fish/guestfish-actions.pod:2653
21744 " mkdir-mode path mode\n"
21749 #: ../fish/guestfish-actions.pod:2662
21750 msgid "See also L</mkdir>, L</umask>"
21754 #: ../fish/guestfish-actions.pod:2664
21759 #: ../fish/guestfish-actions.pod:2666
21767 #: ../fish/guestfish-actions.pod:2671
21772 #: ../fish/guestfish-actions.pod:2673
21775 " mkdtemp template\n"
21780 #: ../fish/guestfish-actions.pod:2694
21785 #: ../fish/guestfish-actions.pod:2696
21788 " mke2fs-J fstype blocksize device journal\n"
21793 #: ../fish/guestfish-actions.pod:2704
21794 msgid "See also L</mke2journal>."
21798 #: ../fish/guestfish-actions.pod:2706
21803 #: ../fish/guestfish-actions.pod:2708
21806 " mke2fs-JL fstype blocksize device label\n"
21811 #: ../fish/guestfish-actions.pod:2713
21812 msgid "See also L</mke2journal-L>."
21816 #: ../fish/guestfish-actions.pod:2715
21821 #: ../fish/guestfish-actions.pod:2717
21824 " mke2fs-JU fstype blocksize device uuid\n"
21829 #: ../fish/guestfish-actions.pod:2722
21830 msgid "See also L</mke2journal-U>."
21834 #: ../fish/guestfish-actions.pod:2724
21835 msgid "mke2journal"
21839 #: ../fish/guestfish-actions.pod:2726
21842 " mke2journal blocksize device\n"
21847 #: ../fish/guestfish-actions.pod:2733
21848 msgid "mke2journal-L"
21852 #: ../fish/guestfish-actions.pod:2735
21855 " mke2journal-L blocksize label device\n"
21860 #: ../fish/guestfish-actions.pod:2739
21861 msgid "mke2journal-U"
21865 #: ../fish/guestfish-actions.pod:2741
21868 " mke2journal-U blocksize uuid device\n"
21873 #: ../fish/guestfish-actions.pod:2745
21878 #: ../fish/guestfish-actions.pod:2747
21881 " mkfifo mode path\n"
21886 #: ../fish/guestfish-actions.pod:2749
21888 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21889 "is just a convenient wrapper around L</mknod>."
21893 #: ../fish/guestfish-actions.pod:2755
21898 #: ../fish/guestfish-actions.pod:2757
21901 " mkfs fstype device\n"
21906 #: ../fish/guestfish-actions.pod:2763
21911 #: ../fish/guestfish-actions.pod:2765
21914 " mkfs-b fstype blocksize device\n"
21919 #: ../fish/guestfish-actions.pod:2767
21921 "This call is similar to L</mkfs>, but it allows you to control the block "
21922 "size of the resulting filesystem. Supported block sizes depend on the "
21923 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21927 #: ../fish/guestfish-actions.pod:2775
21928 msgid "mkmountpoint"
21932 #: ../fish/guestfish-actions.pod:2777
21935 " mkmountpoint exemptpath\n"
21940 #: ../fish/guestfish-actions.pod:2779
21942 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21943 "to create extra mountpoints before mounting the first filesystem."
21947 #: ../fish/guestfish-actions.pod:2803
21949 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21950 "unexpected errors if you try to mix these calls. It is safest to manually "
21951 "unmount filesystems and remove mountpoints after use."
21955 #: ../fish/guestfish-actions.pod:2807
21957 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21958 "for this to work for manual mountpoints, you must ensure that the innermost "
21959 "mountpoints have the longest pathnames, as in the example code above."
21963 #: ../fish/guestfish-actions.pod:2814
21965 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21966 "that L</umount-all> is called when the handle is closed which can also "
21967 "trigger these issues."
21971 #: ../fish/guestfish-actions.pod:2818
21976 #: ../fish/guestfish-actions.pod:2820
21979 " mknod mode devmajor devminor path\n"
21984 #: ../fish/guestfish-actions.pod:2830
21986 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21987 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21988 "regular file). These constants are available in the standard Linux header "
21989 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21990 "wrappers around this command which bitwise OR in the appropriate constant "
21995 #: ../fish/guestfish-actions.pod:2840
22000 #: ../fish/guestfish-actions.pod:2842
22003 " mknod-b mode devmajor devminor path\n"
22008 #: ../fish/guestfish-actions.pod:2844
22010 "This call creates a block device node called C<path> with mode C<mode> and "
22011 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22012 "wrapper around L</mknod>."
22016 #: ../fish/guestfish-actions.pod:2850
22021 #: ../fish/guestfish-actions.pod:2852
22024 " mknod-c mode devmajor devminor path\n"
22029 #: ../fish/guestfish-actions.pod:2854
22031 "This call creates a char device node called C<path> with mode C<mode> and "
22032 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22033 "wrapper around L</mknod>."
22037 #: ../fish/guestfish-actions.pod:2860
22042 #: ../fish/guestfish-actions.pod:2862
22050 #: ../fish/guestfish-actions.pod:2866
22055 #: ../fish/guestfish-actions.pod:2868
22058 " mkswap-L label device\n"
22063 #: ../fish/guestfish-actions.pod:2876
22068 #: ../fish/guestfish-actions.pod:2878
22071 " mkswap-U uuid device\n"
22076 #: ../fish/guestfish-actions.pod:2882
22077 msgid "mkswap-file"
22081 #: ../fish/guestfish-actions.pod:2884
22084 " mkswap-file path\n"
22089 #: ../fish/guestfish-actions.pod:2888
22091 "This command just writes a swap file signature to an existing file. To "
22092 "create the file itself, use something like L</fallocate>."
22096 #: ../fish/guestfish-actions.pod:2891
22101 #: ../fish/guestfish-actions.pod:2893
22104 " modprobe modulename\n"
22109 #: ../fish/guestfish-actions.pod:2900
22114 #: ../fish/guestfish-actions.pod:2902
22117 " mount device mountpoint\n"
22122 #: ../fish/guestfish-actions.pod:2918
22124 "B<Important note:> When you use this call, the filesystem options C<sync> "
22125 "and C<noatime> are set implicitly. This was originally done because we "
22126 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22127 "very large negative performance impact and negligible effect on "
22128 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22129 "code that needs performance, and instead use L</mount-options> (use an empty "
22130 "string for the first parameter if you don't want any options)."
22134 #: ../fish/guestfish-actions.pod:2928
22139 #: ../fish/guestfish-actions.pod:2930
22142 " mount-loop file mountpoint\n"
22147 #: ../fish/guestfish-actions.pod:2936
22148 msgid "mount-options"
22152 #: ../fish/guestfish-actions.pod:2938
22155 " mount-options options device mountpoint\n"
22160 #: ../fish/guestfish-actions.pod:2940
22162 "This is the same as the L</mount> command, but it allows you to set the "
22163 "mount options as for the L<mount(8)> I<-o> flag."
22167 #: ../fish/guestfish-actions.pod:2948
22172 #: ../fish/guestfish-actions.pod:2950
22175 " mount-ro device mountpoint\n"
22180 #: ../fish/guestfish-actions.pod:2952
22182 "This is the same as the L</mount> command, but it mounts the filesystem with "
22183 "the read-only (I<-o ro>) flag."
22187 #: ../fish/guestfish-actions.pod:2955
22192 #: ../fish/guestfish-actions.pod:2957
22195 " mount-vfs options vfstype device mountpoint\n"
22200 #: ../fish/guestfish-actions.pod:2959
22202 "This is the same as the L</mount> command, but it allows you to set both the "
22203 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22207 #: ../fish/guestfish-actions.pod:2963
22208 msgid "mountpoints"
22212 #: ../fish/guestfish-actions.pod:2965
22220 #: ../fish/guestfish-actions.pod:2967
22222 "This call is similar to L</mounts>. That call returns a list of devices. "
22223 "This one returns a hash table (map) of device name to directory where the "
22224 "device is mounted."
22228 #: ../fish/guestfish-actions.pod:2971
22233 #: ../fish/guestfish-actions.pod:2973
22241 #: ../fish/guestfish-actions.pod:2980
22242 msgid "See also: L</mountpoints>"
22246 #: ../fish/guestfish-actions.pod:2982
22251 #: ../fish/guestfish-actions.pod:2984
22259 #: ../fish/guestfish-actions.pod:2989
22260 msgid "ntfs-3g-probe"
22264 #: ../fish/guestfish-actions.pod:2991
22267 " ntfs-3g-probe true|false device\n"
22272 #: ../fish/guestfish-actions.pod:3005
22277 #: ../fish/guestfish-actions.pod:3007
22280 " ntfsresize device\n"
22285 #: ../fish/guestfish-actions.pod:3013
22286 msgid "ntfsresize-size"
22290 #: ../fish/guestfish-actions.pod:3015
22293 " ntfsresize-size device size\n"
22298 #: ../fish/guestfish-actions.pod:3017
22300 "This command is the same as L</ntfsresize> except that it allows you to "
22301 "specify the new size (in bytes) explicitly."
22305 #: ../fish/guestfish-actions.pod:3020
22310 #: ../fish/guestfish-actions.pod:3022
22313 " part-add device prlogex startsect endsect\n"
22318 #: ../fish/guestfish-actions.pod:3024
22320 "This command adds a partition to C<device>. If there is no partition table "
22321 "on the device, call L</part-init> first."
22325 #: ../fish/guestfish-actions.pod:3036
22327 "Creating a partition which covers the whole disk is not so easy. Use "
22328 "L</part-disk> to do that."
22332 #: ../fish/guestfish-actions.pod:3039
22337 #: ../fish/guestfish-actions.pod:3041
22340 " part-del device partnum\n"
22345 #: ../fish/guestfish-actions.pod:3049
22350 #: ../fish/guestfish-actions.pod:3051
22353 " part-disk device parttype\n"
22358 #: ../fish/guestfish-actions.pod:3053
22360 "This command is simply a combination of L</part-init> followed by "
22361 "L</part-add> to create a single primary partition covering the whole disk."
22365 #: ../fish/guestfish-actions.pod:3057
22367 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22368 "possible values are described in L</part-init>."
22372 #: ../fish/guestfish-actions.pod:3063
22373 msgid "part-get-bootable"
22377 #: ../fish/guestfish-actions.pod:3065
22380 " part-get-bootable device partnum\n"
22385 #: ../fish/guestfish-actions.pod:3070
22386 msgid "See also L</part-set-bootable>."
22390 #: ../fish/guestfish-actions.pod:3072
22391 msgid "part-get-mbr-id"
22395 #: ../fish/guestfish-actions.pod:3074
22398 " part-get-mbr-id device partnum\n"
22403 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22405 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22406 "undefined results for other partition table types (see "
22407 "L</part-get-parttype>)."
22411 #: ../fish/guestfish-actions.pod:3083
22412 msgid "part-get-parttype"
22416 #: ../fish/guestfish-actions.pod:3085
22419 " part-get-parttype device\n"
22424 #: ../fish/guestfish-actions.pod:3090
22426 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22427 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22428 "possible, although unusual. See L</part-init> for a full list."
22432 #: ../fish/guestfish-actions.pod:3095
22437 #: ../fish/guestfish-actions.pod:3097
22440 " part-init device parttype\n"
22445 #: ../fish/guestfish-actions.pod:3103
22447 "Initially there are no partitions. Following this, you should call "
22448 "L</part-add> for each partition required."
22452 #: ../fish/guestfish-actions.pod:3166
22457 #: ../fish/guestfish-actions.pod:3168
22460 " part-list device\n"
22465 #: ../fish/guestfish-actions.pod:3183
22467 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22468 "the device's sector size, see L</blockdev-getss>."
22472 #: ../fish/guestfish-actions.pod:3196
22473 msgid "part-set-bootable"
22477 #: ../fish/guestfish-actions.pod:3198
22480 " part-set-bootable device partnum true|false\n"
22485 #: ../fish/guestfish-actions.pod:3207
22486 msgid "part-set-mbr-id"
22490 #: ../fish/guestfish-actions.pod:3209
22493 " part-set-mbr-id device partnum idbyte\n"
22498 #: ../fish/guestfish-actions.pod:3221
22499 msgid "part-set-name"
22503 #: ../fish/guestfish-actions.pod:3223
22506 " part-set-name device partnum name\n"
22511 #: ../fish/guestfish-actions.pod:3231
22512 msgid "part-to-dev"
22516 #: ../fish/guestfish-actions.pod:3233
22519 " part-to-dev partition\n"
22524 #: ../fish/guestfish-actions.pod:3239
22526 "The named partition must exist, for example as a string returned from "
22527 "L</list-partitions>."
22531 #: ../fish/guestfish-actions.pod:3242
22532 msgid "ping-daemon"
22536 #: ../fish/guestfish-actions.pod:3244
22544 #: ../fish/guestfish-actions.pod:3251
22549 #: ../fish/guestfish-actions.pod:3253
22552 " pread path count offset\n"
22557 #: ../fish/guestfish-actions.pod:3261
22558 msgid "See also L</pwrite>, L</pread-device>."
22562 #: ../fish/guestfish-actions.pod:3266
22563 msgid "pread-device"
22567 #: ../fish/guestfish-actions.pod:3268
22570 " pread-device device count offset\n"
22575 #: ../fish/guestfish-actions.pod:3276
22576 msgid "See also L</pread>."
22580 #: ../fish/guestfish-actions.pod:3281
22585 #: ../fish/guestfish-actions.pod:3283
22588 " pvcreate device\n"
22593 #: ../fish/guestfish-actions.pod:3289
22598 #: ../fish/guestfish-actions.pod:3291
22601 " pvremove device\n"
22606 #: ../fish/guestfish-actions.pod:3300
22611 #: ../fish/guestfish-actions.pod:3302
22614 " pvresize device\n"
22619 #: ../fish/guestfish-actions.pod:3307
22620 msgid "pvresize-size"
22624 #: ../fish/guestfish-actions.pod:3309
22627 " pvresize-size device size\n"
22632 #: ../fish/guestfish-actions.pod:3311
22634 "This command is the same as L</pvresize> except that it allows you to "
22635 "specify the new size (in bytes) explicitly."
22639 #: ../fish/guestfish-actions.pod:3314
22644 #: ../fish/guestfish-actions.pod:3316
22652 #: ../fish/guestfish-actions.pod:3324
22653 msgid "See also L</pvs-full>."
22657 #: ../fish/guestfish-actions.pod:3326
22662 #: ../fish/guestfish-actions.pod:3328
22670 #: ../fish/guestfish-actions.pod:3333
22675 #: ../fish/guestfish-actions.pod:3335
22683 #: ../fish/guestfish-actions.pod:3339
22688 #: ../fish/guestfish-actions.pod:3341
22691 " pwrite path content offset\n"
22696 #: ../fish/guestfish-actions.pod:3352
22697 msgid "See also L</pread>, L</pwrite-device>."
22701 #: ../fish/guestfish-actions.pod:3357
22702 msgid "pwrite-device"
22706 #: ../fish/guestfish-actions.pod:3359
22709 " pwrite-device device content offset\n"
22714 #: ../fish/guestfish-actions.pod:3369
22715 msgid "See also L</pwrite>."
22719 #: ../fish/guestfish-actions.pod:3374
22724 #: ../fish/guestfish-actions.pod:3376
22727 " read-file path\n"
22732 #: ../fish/guestfish-actions.pod:3381
22734 "Unlike L</cat>, this function can correctly handle files that contain "
22735 "embedded ASCII NUL characters. However unlike L</download>, this function "
22736 "is limited in the total size of file that can be handled."
22740 #: ../fish/guestfish-actions.pod:3389
22745 #: ../fish/guestfish-actions.pod:3391
22748 " read-lines path\n"
22753 #: ../fish/guestfish-actions.pod:3398
22755 "Note that this function cannot correctly handle binary files (specifically, "
22756 "files containing C<\\0> character which is treated as end of line). For "
22757 "those you need to use the L</read-file> function which has a more complex "
22762 #: ../fish/guestfish-actions.pod:3403
22767 #: ../fish/guestfish-actions.pod:3405
22775 #: ../fish/guestfish-actions.pod:3457
22777 "This function is primarily intended for use by programs. To get a simple "
22778 "list of names, use L</ls>. To get a printable directory for human "
22779 "consumption, use L</ll>."
22783 #: ../fish/guestfish-actions.pod:3461
22788 #: ../fish/guestfish-actions.pod:3463
22796 #: ../fish/guestfish-actions.pod:3467
22797 msgid "readlinklist"
22801 #: ../fish/guestfish-actions.pod:3469
22804 " readlinklist path 'names ...'\n"
22809 #: ../fish/guestfish-actions.pod:3493
22814 #: ../fish/guestfish-actions.pod:3495
22822 #: ../fish/guestfish-actions.pod:3500
22823 msgid "removexattr"
22827 #: ../fish/guestfish-actions.pod:3502
22830 " removexattr xattr path\n"
22835 #: ../fish/guestfish-actions.pod:3507
22836 msgid "See also: L</lremovexattr>, L<attr(5)>."
22840 #: ../fish/guestfish-actions.pod:3509
22845 #: ../fish/guestfish-actions.pod:3511
22848 " resize2fs device\n"
22853 #: ../fish/guestfish-actions.pod:3516
22855 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22856 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22857 "gives an error about this and sometimes not. In any case, it is always safe "
22858 "to call L</e2fsck-f> before calling this function."
22862 #: ../fish/guestfish-actions.pod:3522
22863 msgid "resize2fs-size"
22867 #: ../fish/guestfish-actions.pod:3524
22870 " resize2fs-size device size\n"
22875 #: ../fish/guestfish-actions.pod:3526
22877 "This command is the same as L</resize2fs> except that it allows you to "
22878 "specify the new size (in bytes) explicitly."
22882 #: ../fish/guestfish-actions.pod:3529
22887 #: ../fish/guestfish-actions.pod:3531
22895 #: ../fish/guestfish-actions.pod:3535
22900 #: ../fish/guestfish-actions.pod:3537
22908 #: ../fish/guestfish-actions.pod:3543
22913 #: ../fish/guestfish-actions.pod:3545
22921 #: ../fish/guestfish-actions.pod:3549
22922 msgid "rmmountpoint"
22926 #: ../fish/guestfish-actions.pod:3551
22929 " rmmountpoint exemptpath\n"
22934 #: ../fish/guestfish-actions.pod:3553
22936 "This calls removes a mountpoint that was previously created with "
22937 "L</mkmountpoint>. See L</mkmountpoint> for full details."
22941 #: ../fish/guestfish-actions.pod:3557
22942 msgid "scrub-device"
22946 #: ../fish/guestfish-actions.pod:3559
22949 " scrub-device device\n"
22954 #: ../fish/guestfish-actions.pod:3570
22959 #: ../fish/guestfish-actions.pod:3572
22962 " scrub-file file\n"
22967 #: ../fish/guestfish-actions.pod:3582
22968 msgid "scrub-freespace"
22972 #: ../fish/guestfish-actions.pod:3584
22975 " scrub-freespace dir\n"
22980 #: ../fish/guestfish-actions.pod:3586
22982 "This command creates the directory C<dir> and then fills it with files until "
22983 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22984 "deletes them. The intention is to scrub any free space on the partition "
22985 "containing C<dir>."
22989 #: ../fish/guestfish-actions.pod:3595
22994 #: ../fish/guestfish-actions.pod:3597
22999 #: ../fish/guestfish-actions.pod:3599
23002 " set-append append\n"
23007 #: ../fish/guestfish-actions.pod:3610
23008 msgid "set-autosync"
23012 #: ../fish/guestfish-actions.pod:3612
23017 #: ../fish/guestfish-actions.pod:3614
23020 " set-autosync true|false\n"
23025 #: ../fish/guestfish-actions.pod:3616
23027 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23028 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23029 "closed (also if the program exits without closing handles)."
23033 #: ../fish/guestfish-actions.pod:3624
23038 #: ../fish/guestfish-actions.pod:3626
23043 #: ../fish/guestfish-actions.pod:3628
23046 " set-direct true|false\n"
23051 #: ../fish/guestfish-actions.pod:3634
23053 "One consequence of this is that log messages aren't caught by the library "
23054 "and handled by L</set-log-message-callback>, but go straight to stdout."
23058 #: ../fish/guestfish-actions.pod:3643
23059 msgid "set-e2label"
23063 #: ../fish/guestfish-actions.pod:3645
23066 " set-e2label device label\n"
23071 #: ../fish/guestfish-actions.pod:3651
23073 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23074 "label on a filesystem."
23078 #: ../fish/guestfish-actions.pod:3654
23083 #: ../fish/guestfish-actions.pod:3656
23086 " set-e2uuid device uuid\n"
23091 #: ../fish/guestfish-actions.pod:3663
23093 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23094 "UUID of a filesystem."
23098 #: ../fish/guestfish-actions.pod:3666
23099 msgid "set-memsize"
23103 #: ../fish/guestfish-actions.pod:3668
23108 #: ../fish/guestfish-actions.pod:3670
23111 " set-memsize memsize\n"
23116 #: ../fish/guestfish-actions.pod:3672
23118 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23119 "This only has any effect if called before L</launch>."
23123 #: ../fish/guestfish-actions.pod:3683
23124 msgid "set-network"
23128 #: ../fish/guestfish-actions.pod:3685
23133 #: ../fish/guestfish-actions.pod:3687
23136 " set-network true|false\n"
23141 #: ../fish/guestfish-actions.pod:3695
23142 msgid "You must call this before calling L</launch>, otherwise it has no effect."
23146 #: ../fish/guestfish-actions.pod:3698
23151 #: ../fish/guestfish-actions.pod:3700
23156 #: ../fish/guestfish-actions.pod:3702
23159 " set-path searchpath\n"
23164 #: ../fish/guestfish-actions.pod:3711
23169 #: ../fish/guestfish-actions.pod:3713
23174 #: ../fish/guestfish-actions.pod:3715
23182 #: ../fish/guestfish-actions.pod:3735
23183 msgid "set-recovery-proc"
23187 #: ../fish/guestfish-actions.pod:3737
23188 msgid "recovery-proc"
23192 #: ../fish/guestfish-actions.pod:3739
23195 " set-recovery-proc true|false\n"
23200 #: ../fish/guestfish-actions.pod:3741
23202 "If this is called with the parameter C<false> then L</launch> does not "
23203 "create a recovery process. The purpose of the recovery process is to stop "
23204 "runaway qemu processes in the case where the main program aborts abruptly."
23208 #: ../fish/guestfish-actions.pod:3746
23210 "This only has any effect if called before L</launch>, and the default is "
23215 #: ../fish/guestfish-actions.pod:3755
23216 msgid "set-selinux"
23220 #: ../fish/guestfish-actions.pod:3757
23225 #: ../fish/guestfish-actions.pod:3759
23228 " set-selinux true|false\n"
23233 #: ../fish/guestfish-actions.pod:3770
23238 #: ../fish/guestfish-actions.pod:3772
23243 #: ../fish/guestfish-actions.pod:3774
23246 " set-trace true|false\n"
23251 #: ../fish/guestfish-actions.pod:3790
23252 msgid "set-verbose"
23256 #: ../fish/guestfish-actions.pod:3792
23261 #: ../fish/guestfish-actions.pod:3794
23264 " set-verbose true|false\n"
23269 #: ../fish/guestfish-actions.pod:3801
23274 #: ../fish/guestfish-actions.pod:3803
23277 " setcon context\n"
23282 #: ../fish/guestfish-actions.pod:3810
23287 #: ../fish/guestfish-actions.pod:3812
23290 " setxattr xattr val vallen path\n"
23295 #: ../fish/guestfish-actions.pod:3818
23296 msgid "See also: L</lsetxattr>, L<attr(5)>."
23300 #: ../fish/guestfish-actions.pod:3820
23305 #: ../fish/guestfish-actions.pod:3822
23308 " sfdisk device cyls heads sectors 'lines ...'\n"
23313 #: ../fish/guestfish-actions.pod:3844
23314 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23318 #: ../fish/guestfish-actions.pod:3850
23323 #: ../fish/guestfish-actions.pod:3852
23326 " sfdiskM device 'lines ...'\n"
23331 #: ../fish/guestfish-actions.pod:3854
23333 "This is a simplified interface to the L</sfdisk> command, where partition "
23334 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23335 "you don't need to specify the cyls, heads and sectors parameters which were "
23336 "rarely if ever used anyway."
23340 #: ../fish/guestfish-actions.pod:3860
23341 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23345 #: ../fish/guestfish-actions.pod:3866
23350 #: ../fish/guestfish-actions.pod:3868
23353 " sfdisk-N device partnum cyls heads sectors line\n"
23358 #: ../fish/guestfish-actions.pod:3873
23360 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23361 "cyls/heads/sectors parameters."
23365 #: ../fish/guestfish-actions.pod:3876
23366 msgid "See also: L</part-add>"
23370 #: ../fish/guestfish-actions.pod:3881
23371 msgid "sfdisk-disk-geometry"
23375 #: ../fish/guestfish-actions.pod:3883
23378 " sfdisk-disk-geometry device\n"
23383 #: ../fish/guestfish-actions.pod:3885
23385 "This displays the disk geometry of C<device> read from the partition table. "
23386 "Especially in the case where the underlying block device has been resized, "
23387 "this can be different from the kernel's idea of the geometry (see "
23388 "L</sfdisk-kernel-geometry>)."
23392 #: ../fish/guestfish-actions.pod:3893
23393 msgid "sfdisk-kernel-geometry"
23397 #: ../fish/guestfish-actions.pod:3895
23400 " sfdisk-kernel-geometry device\n"
23405 #: ../fish/guestfish-actions.pod:3902
23410 #: ../fish/guestfish-actions.pod:3904
23413 " sfdisk-l device\n"
23418 #: ../fish/guestfish-actions.pod:3910
23419 msgid "See also: L</part-list>"
23423 #: ../fish/guestfish-actions.pod:3912
23428 #: ../fish/guestfish-actions.pod:3914
23436 #: ../fish/guestfish-actions.pod:3919
23437 msgid "This is like L</command>, but passes the command to:"
23441 #: ../fish/guestfish-actions.pod:3927
23442 msgid "All the provisos about L</command> apply to this call."
23446 #: ../fish/guestfish-actions.pod:3929
23451 #: ../fish/guestfish-actions.pod:3931
23454 " sh-lines command\n"
23459 #: ../fish/guestfish-actions.pod:3933
23460 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23464 #: ../fish/guestfish-actions.pod:3936
23465 msgid "See also: L</command-lines>"
23469 #: ../fish/guestfish-actions.pod:3938
23474 #: ../fish/guestfish-actions.pod:3940
23482 #: ../fish/guestfish-actions.pod:3944
23487 #: ../fish/guestfish-actions.pod:3946
23495 #: ../fish/guestfish-actions.pod:3952
23500 #: ../fish/guestfish-actions.pod:3954
23508 #: ../fish/guestfish-actions.pod:3962
23513 #: ../fish/guestfish-actions.pod:3964
23521 #: ../fish/guestfish-actions.pod:3972
23526 #: ../fish/guestfish-actions.pod:3974
23529 " strings-e encoding path\n"
23534 #: ../fish/guestfish-actions.pod:3976
23536 "This is like the L</strings> command, but allows you to specify the encoding "
23537 "of strings that are looked for in the source file C<path>."
23541 #: ../fish/guestfish-actions.pod:3986
23543 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23544 "ISO-8859-X (this is what L</strings> uses)."
23548 #: ../fish/guestfish-actions.pod:4018
23549 msgid "swapoff-device"
23553 #: ../fish/guestfish-actions.pod:4020
23556 " swapoff-device device\n"
23561 #: ../fish/guestfish-actions.pod:4022
23563 "This command disables the libguestfs appliance swap device or partition "
23564 "named C<device>. See L</swapon-device>."
23568 #: ../fish/guestfish-actions.pod:4026
23569 msgid "swapoff-file"
23573 #: ../fish/guestfish-actions.pod:4028
23576 " swapoff-file file\n"
23581 #: ../fish/guestfish-actions.pod:4032
23582 msgid "swapoff-label"
23586 #: ../fish/guestfish-actions.pod:4034
23589 " swapoff-label label\n"
23594 #: ../fish/guestfish-actions.pod:4039
23595 msgid "swapoff-uuid"
23599 #: ../fish/guestfish-actions.pod:4041
23602 " swapoff-uuid uuid\n"
23607 #: ../fish/guestfish-actions.pod:4046
23608 msgid "swapon-device"
23612 #: ../fish/guestfish-actions.pod:4048
23615 " swapon-device device\n"
23620 #: ../fish/guestfish-actions.pod:4050
23622 "This command enables the libguestfs appliance to use the swap device or "
23623 "partition named C<device>. The increased memory is made available for all "
23624 "commands, for example those run using L</command> or L</sh>."
23628 #: ../fish/guestfish-actions.pod:4062
23629 msgid "swapon-file"
23633 #: ../fish/guestfish-actions.pod:4064
23636 " swapon-file file\n"
23641 #: ../fish/guestfish-actions.pod:4066
23642 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
23646 #: ../fish/guestfish-actions.pod:4069
23647 msgid "swapon-label"
23651 #: ../fish/guestfish-actions.pod:4071
23654 " swapon-label label\n"
23659 #: ../fish/guestfish-actions.pod:4073
23661 "This command enables swap to a labeled swap partition. See "
23662 "L</swapon-device> for other notes."
23666 #: ../fish/guestfish-actions.pod:4076
23667 msgid "swapon-uuid"
23671 #: ../fish/guestfish-actions.pod:4078
23674 " swapon-uuid uuid\n"
23679 #: ../fish/guestfish-actions.pod:4080
23681 "This command enables swap to a swap partition with the given UUID. See "
23682 "L</swapon-device> for other notes."
23686 #: ../fish/guestfish-actions.pod:4083
23691 #: ../fish/guestfish-actions.pod:4085
23699 #: ../fish/guestfish-actions.pod:4093
23704 #: ../fish/guestfish-actions.pod:4095
23712 #: ../fish/guestfish-actions.pod:4103
23717 #: ../fish/guestfish-actions.pod:4105
23720 " tail-n nrlines path\n"
23725 #: ../fish/guestfish-actions.pod:4118
23730 #: ../fish/guestfish-actions.pod:4120
23733 " tar-in (tarfile|-) directory\n"
23738 #: ../fish/guestfish-actions.pod:4125
23739 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23743 #: ../fish/guestfish-actions.pod:4130
23748 #: ../fish/guestfish-actions.pod:4132
23751 " tar-out directory (tarfile|-)\n"
23756 #: ../fish/guestfish-actions.pod:4137
23757 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23761 #: ../fish/guestfish-actions.pod:4142
23766 #: ../fish/guestfish-actions.pod:4144
23769 " tgz-in (tarball|-) directory\n"
23774 #: ../fish/guestfish-actions.pod:4149
23775 msgid "To upload an uncompressed tarball, use L</tar-in>."
23779 #: ../fish/guestfish-actions.pod:4153
23784 #: ../fish/guestfish-actions.pod:4155
23787 " tgz-out directory (tarball|-)\n"
23792 #: ../fish/guestfish-actions.pod:4160
23793 msgid "To download an uncompressed tarball, use L</tar-out>."
23797 #: ../fish/guestfish-actions.pod:4164
23802 #: ../fish/guestfish-actions.pod:4166
23810 #: ../fish/guestfish-actions.pod:4175
23815 #: ../fish/guestfish-actions.pod:4177
23823 #: ../fish/guestfish-actions.pod:4182
23824 msgid "truncate-size"
23828 #: ../fish/guestfish-actions.pod:4184
23831 " truncate-size path size\n"
23836 #: ../fish/guestfish-actions.pod:4189
23838 "If the current file size is less than C<size> then the file is extended to "
23839 "the required size with zero bytes. This creates a sparse file (ie. disk "
23840 "blocks are not allocated for the file until you write to it). To create a "
23841 "non-sparse file of zeroes, use L</fallocate64> instead."
23845 #: ../fish/guestfish-actions.pod:4195
23850 #: ../fish/guestfish-actions.pod:4197
23853 " tune2fs-l device\n"
23858 #: ../fish/guestfish-actions.pod:4207
23863 #: ../fish/guestfish-actions.pod:4209
23866 " txz-in (tarball|-) directory\n"
23871 #: ../fish/guestfish-actions.pod:4216
23876 #: ../fish/guestfish-actions.pod:4218
23879 " txz-out directory (tarball|-)\n"
23884 #: ../fish/guestfish-actions.pod:4225
23889 #: ../fish/guestfish-actions.pod:4227
23897 #: ../fish/guestfish-actions.pod:4241
23898 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23902 #: ../fish/guestfish-actions.pod:4246
23907 #: ../fish/guestfish-actions.pod:4248
23912 #: ../fish/guestfish-actions.pod:4250
23915 " umount pathordevice\n"
23920 #: ../fish/guestfish-actions.pod:4256
23925 #: ../fish/guestfish-actions.pod:4258
23926 msgid "unmount-all"
23930 #: ../fish/guestfish-actions.pod:4260
23938 #: ../fish/guestfish-actions.pod:4266
23943 #: ../fish/guestfish-actions.pod:4268
23946 " upload (filename|-) remotefilename\n"
23951 #: ../fish/guestfish-actions.pod:4275
23952 msgid "See also L</download>."
23956 #: ../fish/guestfish-actions.pod:4279
23957 msgid "upload-offset"
23961 #: ../fish/guestfish-actions.pod:4281
23964 " upload-offset (filename|-) remotefilename offset\n"
23969 #: ../fish/guestfish-actions.pod:4293
23971 "Note that there is no limit on the amount of data that can be uploaded with "
23972 "this call, unlike with L</pwrite>, and this call always writes the full "
23973 "amount unless an error occurs."
23977 #: ../fish/guestfish-actions.pod:4298
23978 msgid "See also L</upload>, L</pwrite>."
23982 #: ../fish/guestfish-actions.pod:4302
23987 #: ../fish/guestfish-actions.pod:4304
23990 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23995 #: ../fish/guestfish-actions.pod:4323
24000 #: ../fish/guestfish-actions.pod:4325
24008 #: ../fish/guestfish-actions.pod:4352
24010 "I<Note:> Don't use this call to test for availability of features. In "
24011 "enterprise distributions we backport features from later versions into "
24012 "earlier versions, making this an unreliable way to test for features. Use "
24013 "L</available> instead."
24017 #: ../fish/guestfish-actions.pod:4358
24022 #: ../fish/guestfish-actions.pod:4360
24025 " vfs-label device\n"
24030 #: ../fish/guestfish-actions.pod:4367
24031 msgid "To find a filesystem from the label, use L</findfs-label>."
24035 #: ../fish/guestfish-actions.pod:4369
24040 #: ../fish/guestfish-actions.pod:4371
24043 " vfs-type device\n"
24048 #: ../fish/guestfish-actions.pod:4381
24053 #: ../fish/guestfish-actions.pod:4383
24056 " vfs-uuid device\n"
24061 #: ../fish/guestfish-actions.pod:4390
24062 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24066 #: ../fish/guestfish-actions.pod:4392
24067 msgid "vg-activate"
24071 #: ../fish/guestfish-actions.pod:4394
24074 " vg-activate true|false 'volgroups ...'\n"
24079 #: ../fish/guestfish-actions.pod:4407
24080 msgid "vg-activate-all"
24084 #: ../fish/guestfish-actions.pod:4409
24087 " vg-activate-all true|false\n"
24092 #: ../fish/guestfish-actions.pod:4419
24097 #: ../fish/guestfish-actions.pod:4421
24100 " vgcreate volgroup 'physvols ...'\n"
24105 #: ../fish/guestfish-actions.pod:4426
24110 #: ../fish/guestfish-actions.pod:4428
24113 " vglvuuids vgname\n"
24118 #: ../fish/guestfish-actions.pod:4433
24120 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24121 "logical volumes and volume groups."
24125 #: ../fish/guestfish-actions.pod:4436
24126 msgid "See also L</vgpvuuids>."
24130 #: ../fish/guestfish-actions.pod:4438
24135 #: ../fish/guestfish-actions.pod:4440
24138 " vgpvuuids vgname\n"
24143 #: ../fish/guestfish-actions.pod:4445
24145 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24146 "physical volumes and volume groups."
24150 #: ../fish/guestfish-actions.pod:4448
24151 msgid "See also L</vglvuuids>."
24155 #: ../fish/guestfish-actions.pod:4450
24160 #: ../fish/guestfish-actions.pod:4452
24163 " vgremove vgname\n"
24168 #: ../fish/guestfish-actions.pod:4459
24173 #: ../fish/guestfish-actions.pod:4461
24176 " vgrename volgroup newvolgroup\n"
24181 #: ../fish/guestfish-actions.pod:4465
24186 #: ../fish/guestfish-actions.pod:4467
24194 #: ../fish/guestfish-actions.pod:4475
24195 msgid "See also L</vgs-full>."
24199 #: ../fish/guestfish-actions.pod:4477
24204 #: ../fish/guestfish-actions.pod:4479
24212 #: ../fish/guestfish-actions.pod:4484
24217 #: ../fish/guestfish-actions.pod:4486
24225 #: ../fish/guestfish-actions.pod:4491
24230 #: ../fish/guestfish-actions.pod:4493
24238 #: ../fish/guestfish-actions.pod:4497
24243 #: ../fish/guestfish-actions.pod:4499
24251 #: ../fish/guestfish-actions.pod:4504
24256 #: ../fish/guestfish-actions.pod:4506
24264 #: ../fish/guestfish-actions.pod:4511
24269 #: ../fish/guestfish-actions.pod:4513
24277 #: ../fish/guestfish-actions.pod:4518
24282 #: ../fish/guestfish-actions.pod:4520
24285 " write path content\n"
24290 #: ../fish/guestfish-actions.pod:4528
24295 #: ../fish/guestfish-actions.pod:4530
24298 " write-file path content size\n"
24303 #: ../fish/guestfish-actions.pod:4553
24308 #: ../fish/guestfish-actions.pod:4555
24311 " zegrep regex path\n"
24316 #: ../fish/guestfish-actions.pod:4563
24321 #: ../fish/guestfish-actions.pod:4565
24324 " zegrepi regex path\n"
24329 #: ../fish/guestfish-actions.pod:4573
24334 #: ../fish/guestfish-actions.pod:4575
24342 #: ../fish/guestfish-actions.pod:4583
24343 msgid "See also: L</zero-device>, L</scrub-device>."
24347 #: ../fish/guestfish-actions.pod:4585
24348 msgid "zero-device"
24352 #: ../fish/guestfish-actions.pod:4587
24355 " zero-device device\n"
24360 #: ../fish/guestfish-actions.pod:4589
24362 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24363 "which just zeroes the first few blocks of a device."
24367 #: ../fish/guestfish-actions.pod:4596
24372 #: ../fish/guestfish-actions.pod:4598
24375 " zerofree device\n"
24380 #: ../fish/guestfish-actions.pod:4611
24385 #: ../fish/guestfish-actions.pod:4613
24388 " zfgrep pattern path\n"
24393 #: ../fish/guestfish-actions.pod:4621
24398 #: ../fish/guestfish-actions.pod:4623
24401 " zfgrepi pattern path\n"
24406 #: ../fish/guestfish-actions.pod:4631
24411 #: ../fish/guestfish-actions.pod:4633
24414 " zfile meth path\n"
24419 #: ../fish/guestfish-actions.pod:4640
24420 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
24424 #: ../fish/guestfish-actions.pod:4650
24429 #: ../fish/guestfish-actions.pod:4652
24432 " zgrep regex path\n"
24437 #: ../fish/guestfish-actions.pod:4660
24442 #: ../fish/guestfish-actions.pod:4662
24445 " zgrepi regex path\n"
24450 #: ../fish/guestfish-commands.pod:1
24455 #: ../fish/guestfish-commands.pod:3
24460 #: ../fish/guestfish-commands.pod:5
24463 " alloc filename size\n"
24468 #: ../fish/guestfish-commands.pod:7
24470 "This creates an empty (zeroed) file of the given size, and then adds so it "
24471 "can be further examined."
24475 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24476 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24480 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24481 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24485 #: ../fish/guestfish-commands.pod:14
24487 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24488 "image, see L</PREPARED DISK IMAGES>."
24492 #: ../fish/guestfish-commands.pod:17
24497 #: ../fish/guestfish-commands.pod:19
24500 " copy-in local [local ...] /remotedir\n"
24505 #: ../fish/guestfish-commands.pod:21
24507 "C<copy-in> copies local files or directories recursively into the disk "
24508 "image, placing them in the directory called C</remotedir> (which must "
24509 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24510 "other commands as necessary."
24514 #: ../fish/guestfish-commands.pod:26
24516 "Multiple local files and directories can be specified, but the last "
24517 "parameter must always be a remote directory. Wildcards cannot be used."
24521 #: ../fish/guestfish-commands.pod:30
24526 #: ../fish/guestfish-commands.pod:32
24529 " copy-out remote [remote ...] localdir\n"
24534 #: ../fish/guestfish-commands.pod:34
24536 "C<copy-out> copies remote files or directories recursively out of the disk "
24537 "image, placing them on the host disk in a local directory called C<localdir> "
24538 "(which must exist). This guestfish meta-command turns into a sequence of "
24539 "L</download>, L</tar-out> and other commands as necessary."
24543 #: ../fish/guestfish-commands.pod:40
24545 "Multiple remote files and directories can be specified, but the last "
24546 "parameter must always be a local directory. To download to the current "
24547 "directory, use C<.> as in:"
24551 #: ../fish/guestfish-commands.pod:44
24554 " copy-out /home .\n"
24559 #: ../fish/guestfish-commands.pod:46
24561 "Wildcards cannot be used in the ordinary command, but you can use them with "
24562 "the help of L</glob> like this:"
24566 #: ../fish/guestfish-commands.pod:49
24569 " glob copy-out /home/* .\n"
24574 #: ../fish/guestfish-commands.pod:51
24579 #: ../fish/guestfish-commands.pod:53
24582 " echo [params ...]\n"
24587 #: ../fish/guestfish-commands.pod:55
24588 msgid "This echos the parameters to the terminal."
24592 #: ../fish/guestfish-commands.pod:57
24597 #: ../fish/guestfish-commands.pod:59
24602 #: ../fish/guestfish-commands.pod:61
24607 #: ../fish/guestfish-commands.pod:63
24615 #: ../fish/guestfish-commands.pod:65
24617 "This is used to edit a file. It downloads the file, edits it locally using "
24618 "your editor, then uploads the result."
24622 #: ../fish/guestfish-commands.pod:68
24624 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24625 "or C<emacs> you will get those corresponding editors."
24629 #: ../fish/guestfish-commands.pod:72
24634 #: ../fish/guestfish-commands.pod:74
24637 " glob command args...\n"
24642 #: ../fish/guestfish-commands.pod:76
24644 "Expand wildcards in any paths in the args list, and run C<command> "
24645 "repeatedly on each matching path."
24649 #: ../fish/guestfish-commands.pod:79
24650 msgid "See L</WILDCARDS AND GLOBBING>."
24654 #: ../fish/guestfish-commands.pod:81
24659 #: ../fish/guestfish-commands.pod:83
24662 " hexedit <filename|device>\n"
24663 " hexedit <filename|device> <max>\n"
24664 " hexedit <filename|device> <start> <max>\n"
24669 #: ../fish/guestfish-commands.pod:87
24671 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24676 #: ../fish/guestfish-commands.pod:90
24678 "This command works by downloading potentially the whole file or device, "
24679 "editing it locally, then uploading it. If the file or device is large, you "
24680 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24681 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24682 "usual modifiers allowed such as C<1M> (1 megabyte)."
24686 #: ../fish/guestfish-commands.pod:97
24687 msgid "For example to edit the first few sectors of a disk you might do:"
24691 #: ../fish/guestfish-commands.pod:100
24694 " hexedit /dev/sda 1M\n"
24699 #: ../fish/guestfish-commands.pod:102
24701 "which would allow you to edit anywhere within the first megabyte of the "
24706 #: ../fish/guestfish-commands.pod:105
24707 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24711 #: ../fish/guestfish-commands.pod:107
24714 " hexedit /dev/sda1 0x400 0x400\n"
24719 #: ../fish/guestfish-commands.pod:109
24720 msgid "(assuming the superblock is in the standard location)."
24724 #: ../fish/guestfish-commands.pod:111
24726 "This command requires the external L<hexedit(1)> program. You can specify "
24727 "another program to use by setting the C<HEXEDITOR> environment variable."
24731 #: ../fish/guestfish-commands.pod:115
24732 msgid "See also L</hexdump>."
24736 #: ../fish/guestfish-commands.pod:117
24741 #: ../fish/guestfish-commands.pod:119
24749 #: ../fish/guestfish-commands.pod:121
24750 msgid "Change the local directory, ie. the current directory of guestfish itself."
24754 #: ../fish/guestfish-commands.pod:124
24755 msgid "Note that C<!cd> won't do what you might expect."
24759 #: ../fish/guestfish-commands.pod:126
24764 #: ../fish/guestfish-commands.pod:128
24769 #: ../fish/guestfish-commands.pod:130
24777 #: ../fish/guestfish-commands.pod:132
24778 msgid "Opens the manual page for guestfish."
24782 #: ../fish/guestfish-commands.pod:134
24787 #: ../fish/guestfish-commands.pod:136
24792 #: ../fish/guestfish-commands.pod:138
24800 #: ../fish/guestfish-commands.pod:140
24808 #: ../fish/guestfish-commands.pod:142
24809 msgid "This is used to view a file."
24813 #: ../fish/guestfish-commands.pod:144
24815 "The default viewer is C<$PAGER>. However if you use the alternate command "
24816 "C<less> you will get the C<less> command specifically."
24820 #: ../fish/guestfish-commands.pod:147
24825 #: ../fish/guestfish-commands.pod:149
24833 #: ../fish/guestfish-commands.pod:151
24835 "Close and reopen the libguestfs handle. It is not necessary to use this "
24836 "normally, because the handle is closed properly when guestfish exits. "
24837 "However this is occasionally useful for testing."
24841 #: ../fish/guestfish-commands.pod:155
24846 #: ../fish/guestfish-commands.pod:157
24849 " sparse filename size\n"
24854 #: ../fish/guestfish-commands.pod:159
24856 "This creates an empty sparse file of the given size, and then adds so it can "
24857 "be further examined."
24861 #: ../fish/guestfish-commands.pod:162
24863 "In all respects it works the same as the L</alloc> command, except that the "
24864 "image file is allocated sparsely, which means that disk blocks are not "
24865 "assigned to the file until they are needed. Sparse disk files only use "
24866 "space when written to, but they are slower and there is a danger you could "
24867 "run out of real disk space during a write operation."
24871 #: ../fish/guestfish-commands.pod:172
24876 #: ../fish/guestfish-commands.pod:174
24884 #: ../fish/guestfish-commands.pod:176
24886 "This command returns a list of the optional groups known to the daemon, and "
24887 "indicates which ones are supported by this build of the libguestfs "
24892 #: ../fish/guestfish-commands.pod:180
24893 msgid "See also L<guestfs(3)/AVAILABILITY>."
24897 #: ../fish/guestfish-commands.pod:182
24902 #: ../fish/guestfish-commands.pod:184
24905 " time command args...\n"
24910 #: ../fish/guestfish-commands.pod:186
24912 "Run the command as usual, but print the elapsed time afterwards. This can "
24913 "be useful for benchmarking operations."
24917 #: ../test-tool/libguestfs-test-tool.pod:5
24918 msgid "libguestfs-test-tool - End user tests for libguestfs"
24922 #: ../test-tool/libguestfs-test-tool.pod:9
24925 " libguestfs-test-tool [--options]\n"
24930 #: ../test-tool/libguestfs-test-tool.pod:13
24932 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24933 "and developers, to allow them to check basic libguestfs functionality is "
24934 "working. This is needed because libguestfs occasionally breaks for reasons "
24935 "beyond our control: usually because of changes in the underlying qemu or "
24936 "kernel packages, or the host environment."
24940 #: ../test-tool/libguestfs-test-tool.pod:20
24941 msgid "If you suspect a problem in libguestfs, then just run:"
24945 #: ../test-tool/libguestfs-test-tool.pod:22
24948 " libguestfs-test-tool\n"
24953 #: ../test-tool/libguestfs-test-tool.pod:24
24954 msgid "It will print lots of diagnostic messages."
24958 #: ../test-tool/libguestfs-test-tool.pod:26
24959 msgid "If it runs to completion successfully, you will see this near the end:"
24963 #: ../test-tool/libguestfs-test-tool.pod:28
24966 " ===== TEST FINISHED OK =====\n"
24971 #: ../test-tool/libguestfs-test-tool.pod:30
24972 msgid "and the test tool will exit with code 0."
24976 #: ../test-tool/libguestfs-test-tool.pod:32
24978 "If it fails (and/or exits with non-zero error code), please paste the "
24979 "B<complete, unedited> output of the test tool into a bug report. More "
24980 "information about reporting bugs can be found on the "
24981 "L<http://libguestfs.org/> website."
24985 #: ../test-tool/libguestfs-test-tool.pod:41
24990 #: ../test-tool/libguestfs-test-tool.pod:43
24991 msgid "Display short usage information and exit."
24995 #: ../test-tool/libguestfs-test-tool.pod:45
24996 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25000 #: ../test-tool/libguestfs-test-tool.pod:47
25002 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25003 "normally look in the C<$libexec> directory that was configured when the tool "
25008 #: ../test-tool/libguestfs-test-tool.pod:51
25009 msgid "I<--qemu qemu_binary>"
25013 #: ../test-tool/libguestfs-test-tool.pod:53
25015 "If you have downloaded another qemu binary, point this option at the full "
25016 "path of the binary to try it."
25020 #: ../test-tool/libguestfs-test-tool.pod:56
25021 msgid "I<--qemudir qemu_source_dir>"
25025 #: ../test-tool/libguestfs-test-tool.pod:58
25027 "If you have compiled qemu from source, point this option at the source "
25028 "directory to try it."
25032 #: ../test-tool/libguestfs-test-tool.pod:61
25033 msgid "I<--timeout N>"
25037 #: ../test-tool/libguestfs-test-tool.pod:63
25039 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25040 "does not usually need to be adjusted unless your machine is very slow."
25044 #: ../test-tool/libguestfs-test-tool.pod:69
25045 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25049 #: ../test-tool/libguestfs-test-tool.pod:71
25051 "If you have compiled another version of qemu from source and would like to "
25052 "try that, then you can use the I<--qemudir> option to point to the qemu "
25053 "source directory."
25057 #: ../test-tool/libguestfs-test-tool.pod:75
25059 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25060 "option to point to the binary."
25064 #: ../test-tool/libguestfs-test-tool.pod:78
25066 "When using an alternate qemu with libguestfs, usually you would need to "
25067 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
25068 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
25069 "when you use either of the I<--qemudir> or I<--qemu> options."
25073 #: ../test-tool/libguestfs-test-tool.pod:85
25075 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25076 "I<1> if there was an error."
25080 #: ../test-tool/libguestfs-test-tool.pod:92
25081 msgid "/usr/libexec/libguestfs-test-tool-helper"
25085 #: ../test-tool/libguestfs-test-tool.pod:94
25087 "This helper program is run inside the appliance and provides additional "
25092 #: ../test-tool/libguestfs-test-tool.pod:97
25093 msgid "/usr/bin/mkisofs"
25097 #: ../test-tool/libguestfs-test-tool.pod:99
25099 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25100 "which is used as part of the tests."
25104 #: ../test-tool/libguestfs-test-tool.pod:106
25106 "For the full list of environment variables which may affect libguestfs, "
25107 "please see the L<guestfs(3)> manual page."
25111 #: ../test-tool/libguestfs-test-tool.pod:111
25112 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25116 #: ../test-tool/libguestfs-test-tool.pod:121
25117 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25121 #: ../fuse/guestmount.pod:5
25122 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25126 #: ../fuse/guestmount.pod:9
25129 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25134 #: ../fuse/guestmount.pod:11
25137 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25142 #: ../fuse/guestmount.pod:13
25145 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25150 #: ../fuse/guestmount.pod:17
25152 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25153 "machines. If you do this, you risk disk corruption in the VM."
25157 #: ../fuse/guestmount.pod:22
25159 "The guestmount program can be used to mount virtual machine filesystems and "
25160 "other disk images on the host. It uses libguestfs for access to the guest "
25161 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25162 "a mountable device."
25166 #: ../fuse/guestmount.pod:27
25168 "Along with other options, you have to give at least one device (I<-a> "
25169 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25170 "option) or use the I<-i> inspection option. How this works is better "
25171 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25176 #: ../fuse/guestmount.pod:33
25178 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25179 "by you, and the filesystem will not be visible to any other users unless you "
25180 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25181 "the filesystem, use the C<fusermount -u> command."
25185 #: ../fuse/guestmount.pod:41
25187 "For a typical Windows guest which has its main filesystem on the first "
25192 #: ../fuse/guestmount.pod:44
25195 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25200 #: ../fuse/guestmount.pod:46
25202 "For a typical Linux guest which has a /boot filesystem on the first "
25203 "partition, and the root filesystem on a logical volume:"
25207 #: ../fuse/guestmount.pod:49
25210 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25215 #: ../fuse/guestmount.pod:51
25216 msgid "To get libguestfs to detect guest mountpoints for you:"
25220 #: ../fuse/guestmount.pod:53
25223 " guestmount -a guest.img -i --ro /mnt\n"
25228 #: ../fuse/guestmount.pod:55
25229 msgid "For a libvirt guest called \"Guest\" you could do:"
25233 #: ../fuse/guestmount.pod:57
25236 " guestmount -d Guest -i --ro /mnt\n"
25241 #: ../fuse/guestmount.pod:59
25243 "If you don't know what filesystems are contained in a guest or disk image, "
25244 "use L<virt-filesystems(1)> first:"
25248 #: ../fuse/guestmount.pod:62
25251 " virt-filesystems MyGuest\n"
25256 #: ../fuse/guestmount.pod:64
25258 "If you want to trace the libguestfs calls but without excessive debugging "
25259 "information, we recommend:"
25263 #: ../fuse/guestmount.pod:67
25266 " guestmount [...] --trace /mnt\n"
25271 #: ../fuse/guestmount.pod:69
25272 msgid "If you want to debug the program, we recommend:"
25276 #: ../fuse/guestmount.pod:71
25279 " guestmount [...] --trace --verbose /mnt\n"
25284 #: ../fuse/guestmount.pod:79
25285 msgid "Add a block device or virtual machine image."
25289 #: ../fuse/guestmount.pod:96
25290 msgid "B<--dir-cache-timeout N>"
25294 #: ../fuse/guestmount.pod:98
25296 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25297 "seconds. The readdir cache [actually, there are several semi-independent "
25298 "caches] is populated after a readdir(2) call with the stat and extended "
25299 "attributes of the files in the directory, in anticipation that they will be "
25300 "requested soon after."
25304 #: ../fuse/guestmount.pod:104
25306 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25307 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25308 "requests, only cache existing ones."
25312 #: ../fuse/guestmount.pod:122
25314 "If you have untrusted raw-format guest disk images, you should use this "
25315 "option to specify the disk format. This avoids a possible security problem "
25316 "with malicious guests (CVE-2010-3851). See also "
25317 "L<guestfs(3)/guestfs_add_drive_opts>."
25321 #: ../fuse/guestmount.pod:127
25322 msgid "B<--fuse-help>"
25326 #: ../fuse/guestmount.pod:129
25327 msgid "Display help on special FUSE options (see I<-o> below)."
25331 #: ../fuse/guestmount.pod:133
25332 msgid "Display brief help and exit."
25336 #: ../fuse/guestmount.pod:146
25337 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25341 #: ../fuse/guestmount.pod:148
25343 "Mount the named partition or logical volume on the given mountpoint B<in the "
25344 "guest> (this has nothing to do with mountpoints in the host)."
25348 #: ../fuse/guestmount.pod:151
25350 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25351 "something on C</>."
25355 #: ../fuse/guestmount.pod:156
25357 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25358 "unmounted. If you specify this option, then we don't attempt to sync the "
25359 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25363 #: ../fuse/guestmount.pod:161
25364 msgid "B<-o option> | B<--option option>"
25368 #: ../fuse/guestmount.pod:163
25369 msgid "Pass extra options to FUSE."
25373 #: ../fuse/guestmount.pod:165
25375 "To get a list of all the extra options supported by FUSE, use the command "
25376 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25377 "of them are a good idea."
25381 #: ../fuse/guestmount.pod:169
25384 " guestmount --fuse-help\n"
25389 #: ../fuse/guestmount.pod:171
25390 msgid "Some potentially useful FUSE options:"
25394 #: ../fuse/guestmount.pod:175
25395 msgid "B<-o allow_other>"
25399 #: ../fuse/guestmount.pod:177
25400 msgid "Allow other users to see the filesystem."
25404 #: ../fuse/guestmount.pod:179
25405 msgid "B<-o attr_timeout=N>"
25409 #: ../fuse/guestmount.pod:181
25410 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25414 #: ../fuse/guestmount.pod:183
25415 msgid "B<-o kernel_cache>"
25419 #: ../fuse/guestmount.pod:185
25421 "Allow the kernel to cache files (reduces the number of reads that have to go "
25422 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25423 "afford the extra memory usage."
25427 #: ../fuse/guestmount.pod:189
25428 msgid "B<-o uid=N> B<-o gid=N>"
25432 #: ../fuse/guestmount.pod:191
25434 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25435 "the chosen values."
25439 #: ../fuse/guestmount.pod:198
25441 "Add devices and mount everything read-only. Also disallow writes and make "
25442 "the disk appear read-only to FUSE."
25446 #: ../fuse/guestmount.pod:201
25448 "This is highly recommended if you are not going to edit the guest disk. If "
25449 "the guest is running and this option is I<not> supplied, then there is a "
25450 "strong risk of disk corruption in the guest. We try to prevent this from "
25451 "happening, but it is not always possible."
25455 #: ../fuse/guestmount.pod:206
25456 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25460 #: ../fuse/guestmount.pod:210
25461 msgid "Enable SELinux support for the guest."
25465 #: ../fuse/guestmount.pod:214
25466 msgid "Enable verbose messages from underlying libguestfs."
25470 #: ../fuse/guestmount.pod:218
25471 msgid "Display the program version and exit."
25475 #: ../fuse/guestmount.pod:222
25477 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25478 "FOR READ AND WRITE>."
25482 #: ../fuse/guestmount.pod:225
25483 msgid "B<-x> | B<--trace>"
25487 #: ../fuse/guestmount.pod:227
25488 msgid "Trace libguestfs calls."
25492 #: ../fuse/guestmount.pod:229
25493 msgid "This also stops the daemon from forking into the background."
25497 #: ../fuse/guestmount.pod:235
25499 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25500 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
25501 "L<http://fuse.sf.net/>."
25505 #: ../tools/virt-edit.pl:34
25506 msgid "virt-edit - Edit a file in a virtual machine"
25510 #: ../tools/virt-edit.pl:38
25513 " virt-edit [--options] domname file\n"
25518 #: ../tools/virt-edit.pl:40
25521 " virt-edit [--options] disk.img [disk.img ...] file\n"
25526 #: ../tools/virt-edit.pl:42
25529 " virt-edit [domname|disk.img] file -e 'expr'\n"
25534 #: ../tools/virt-edit.pl:46
25536 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25537 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25538 "doing this, but doesn't catch all cases."
25542 #: ../tools/virt-edit.pl:52
25544 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25545 "the named virtual machine (or disk image)."
25549 #: ../tools/virt-edit.pl:55
25551 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25552 "you should look at the L<guestfish(1)> tool."
25556 #: ../tools/virt-edit.pl:60
25557 msgid "Edit the named files interactively:"
25561 #: ../tools/virt-edit.pl:62
25564 " virt-edit mydomain /boot/grub/grub.conf\n"
25569 #: ../tools/virt-edit.pl:64
25572 " virt-edit mydomain /etc/passwd\n"
25577 #: ../tools/virt-edit.pl:66
25579 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25580 "below). To change the init default level to 5:"
25584 #: ../tools/virt-edit.pl:70
25587 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25592 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
25593 msgid "Display brief help."
25597 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
25598 msgid "B<--version>"
25602 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-resize.pl:274 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
25603 msgid "Display version number and exit."
25607 #: ../tools/virt-edit.pl:96
25608 msgid "B<--backup extension> | B<-b extension>"
25612 #: ../tools/virt-edit.pl:98
25614 "Create a backup of the original file I<in the guest disk image>. The backup "
25615 "has the original filename with C<extension> added."
25619 #: ../tools/virt-edit.pl:101
25621 "Usually the first character of C<extension> would be a dot C<.> so you would "
25626 #: ../tools/virt-edit.pl:104
25629 " virt-edit -b .orig [etc]\n"
25634 #: ../tools/virt-edit.pl:106
25635 msgid "By default, no backup file is made."
25639 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:78
25640 msgid "B<--connect URI> | B<-c URI>"
25644 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:80
25646 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25647 "to the default libvirt hypervisor."
25651 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208 ../tools/virt-df.pl:100 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:83
25653 "If you specify guest block devices directly, then libvirt is not used at "
25658 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117 ../tools/virt-resize.pl:522 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:90
25659 msgid "B<--format> raw"
25663 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:92
25665 "Specify the format of disk images given on the command line. If this is "
25666 "omitted then the format is autodetected from the content of the disk image."
25670 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:96
25672 "If disk images are requested from libvirt, then this program asks libvirt "
25673 "for this information. In this case, the value of the format parameter is "
25678 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127 ../tools/virt-resize.pl:527 ../tools/virt-resize.pl:542 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:100
25680 "If working with untrusted raw-format guest disk images, you should ensure "
25681 "the format is always specified."
25685 #: ../tools/virt-edit.pl:141
25686 msgid "B<--expr EXPR> | B<-e EXPR>"
25690 #: ../tools/virt-edit.pl:143
25692 "Instead of launching the external editor, non-interactively apply the Perl "
25693 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25698 #: ../tools/virt-edit.pl:147
25700 "Be careful to properly quote the expression to prevent it from being altered "
25705 #: ../tools/virt-edit.pl:268
25706 msgid "NON-INTERACTIVE EDITING"
25710 #: ../tools/virt-edit.pl:270
25712 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25713 "administrator can interactively edit the file."
25717 #: ../tools/virt-edit.pl:273
25719 "There are two ways also to use C<virt-edit> from scripts in order to make "
25720 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25721 "like this, it's less error-prone to write scripts directly using the "
25722 "libguestfs API and Augeas for configuration file editing.)"
25726 #: ../tools/virt-edit.pl:279
25728 "The first method is to temporarily set C<$EDITOR> to any script or program "
25729 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25730 "update C<tmpfile> in place however it likes."
25734 #: ../tools/virt-edit.pl:283
25736 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25737 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25738 "instances of C<foo> with C<bar> in a file:"
25742 #: ../tools/virt-edit.pl:287
25745 " virt-edit domname filename -e 's/foo/bar/'\n"
25750 #: ../tools/virt-edit.pl:289
25752 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25753 "For example to delete root's password you could do:"
25757 #: ../tools/virt-edit.pl:292
25760 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25765 #: ../tools/virt-edit.pl:294
25767 "What really happens is that the snippet is evaluated as a Perl expression "
25768 "for each line of the file. The line, including the final C<\\n>, is passed "
25769 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25773 #: ../tools/virt-edit.pl:299
25775 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25776 "C<apache> user account from the password file you can do:"
25780 #: ../tools/virt-edit.pl:302
25783 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25788 #: ../tools/virt-edit.pl:304
25790 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25791 "the end of the file is rather difficult this way since there is no concept "
25792 "of \"last line of the file\" - your expression just doesn't get called "
25793 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25798 #: ../tools/virt-edit.pl:310
25800 "The variable C<$lineno> contains the current line number. As is "
25801 "traditional, the first line in the file is number C<1>."
25805 #: ../tools/virt-edit.pl:313
25807 "The return value from the expression is ignored, but the expression may call "
25808 "C<die> in order to abort the whole program, leaving the original file "
25813 #: ../tools/virt-edit.pl:317
25815 "Remember when matching the end of a line that C<$_> may contain the final "
25816 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25817 "newline then neither of these. Thus to match or substitute some text at the "
25818 "end of a line, use this regular expression:"
25822 #: ../tools/virt-edit.pl:322
25825 " /some text(\\r?\\n)?$/\n"
25830 #: ../tools/virt-edit.pl:324
25832 "Alternately, use the perl C<chomp> function, being careful not to chomp "
25833 "C<$_> itself (since that would remove all newlines from the file):"
25837 #: ../tools/virt-edit.pl:328
25840 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25845 #: ../tools/virt-edit.pl:334
25850 #: ../tools/virt-edit.pl:336
25852 "If set, this string is used as the editor. It may contain arguments, "
25853 "eg. C<\"emacs -nw\">"
25857 #: ../tools/virt-edit.pl:339
25858 msgid "If not set, C<vi> is used."
25862 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477 ../tools/virt-df.pl:633 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
25863 msgid "SHELL QUOTING"
25867 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635 ../tools/virt-resize.pl:1480 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
25869 "Libvirt guest names can contain arbitrary characters, some of which have "
25870 "meaning to the shell such as C<#> and space. You may need to quote or "
25871 "escape these characters on the command line. See the shell manual page "
25872 "L<sh(1)> for details."
25876 #: ../tools/virt-edit.pl:352
25878 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25879 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
25880 "L<perl(1)>, L<perlre(1)>."
25884 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510 ../tools/virt-df.pl:649 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
25889 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
25890 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25894 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:275
25895 msgid "Copyright (C) 2009-2010 Red Hat Inc."
25899 #: ../tools/virt-win-reg.pl:37
25901 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
25906 #: ../tools/virt-win-reg.pl:41
25909 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
25914 #: ../tools/virt-win-reg.pl:43
25917 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
25922 #: ../tools/virt-win-reg.pl:45
25925 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
25930 #: ../tools/virt-win-reg.pl:47
25933 " virt-win-reg --merge domname [input.reg ...]\n"
25938 #: ../tools/virt-win-reg.pl:49
25941 " virt-win-reg [--options] disk.img ... # instead of domname\n"
25946 #: ../tools/virt-win-reg.pl:53
25948 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
25949 "virtual machines. If you do this, you I<will> get irreversible disk "
25950 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
25951 "but doesn't catch all cases."
25955 #: ../tools/virt-win-reg.pl:58
25957 "Modifying the Windows Registry is an inherently risky operation. The format "
25958 "is deliberately obscure and undocumented, and Registry changes can leave the "
25959 "system unbootable. Therefore when using the C<--merge> option, make sure "
25960 "you have a reliable backup first."
25964 #: ../tools/virt-win-reg.pl:65
25966 "This program can export and merge Windows Registry entries from a Windows "
25971 #: ../tools/virt-win-reg.pl:68
25973 "The first parameter is the libvirt guest name or the raw disk image of a "
25978 #: ../tools/virt-win-reg.pl:71
25980 "If C<--merge> is I<not> specified, then the chosen registry key is "
25981 "displayed/exported (recursively). For example:"
25985 #: ../tools/virt-win-reg.pl:74
25988 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
25993 #: ../tools/virt-win-reg.pl:76
25994 msgid "You can also display single values from within registry keys, for example:"
25998 #: ../tools/virt-win-reg.pl:79
26001 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26002 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26003 " Windows 7 Enterprise\n"
26008 #: ../tools/virt-win-reg.pl:83
26010 "With C<--merge>, you can merge a textual regedit file into the Windows "
26015 #: ../tools/virt-win-reg.pl:86
26018 " $ virt-win-reg --merge Windows7 changes.reg\n"
26023 #: ../tools/virt-win-reg.pl:88
26024 msgid "SUPPORTED SYSTEMS"
26028 #: ../tools/virt-win-reg.pl:90
26030 "The program currently supports Windows NT-derived guests starting with "
26031 "Windows XP through to at least Windows 7."
26035 #: ../tools/virt-win-reg.pl:93
26037 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
26038 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
26039 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
26043 #: ../tools/virt-win-reg.pl:97
26045 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26050 #: ../tools/virt-win-reg.pl:100
26052 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26057 #: ../tools/virt-win-reg.pl:103
26062 #: ../tools/virt-win-reg.pl:105
26064 "This program is only meant for simple access to the registry. If you want "
26065 "to do complicated things with the registry, we suggest you download the "
26066 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26067 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26068 "L<hivexregedit(1)>."
26072 #: ../tools/virt-win-reg.pl:111
26077 #: ../tools/virt-win-reg.pl:113
26079 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26080 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
26081 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
26082 "with Windows-style line endings, you may need to reencode the whole file "
26083 "before or after processing."
26087 #: ../tools/virt-win-reg.pl:119
26089 "To reencode a file from Windows format to Linux (before processing it with "
26090 "the C<--merge> option), you would do something like this:"
26094 #: ../tools/virt-win-reg.pl:122
26097 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26102 #: ../tools/virt-win-reg.pl:124
26104 "To go in the opposite direction, after exporting and before sending the file "
26105 "to a Windows user, do something like this:"
26109 #: ../tools/virt-win-reg.pl:127
26112 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26117 #: ../tools/virt-win-reg.pl:129
26118 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26122 #: ../tools/virt-win-reg.pl:131
26124 "If you are unsure about the current encoding, use the L<file(1)> command. "
26125 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
26126 "Windows-style (CRLF) line endings, like this:"
26130 #: ../tools/virt-win-reg.pl:135
26133 " $ file software.reg\n"
26134 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26135 " with CRLF line terminators\n"
26140 #: ../tools/virt-win-reg.pl:139
26141 msgid "This file would need conversion before you could C<--merge> it."
26145 #: ../tools/virt-win-reg.pl:143
26147 "Be careful when passing parameters containing C<\\> (backslash) in the "
26148 "shell. Usually you will have to use 'single quotes' or double backslashes "
26149 "(but not both) to protect them from the shell."
26153 #: ../tools/virt-win-reg.pl:147
26154 msgid "Paths and value names are case-insensitive."
26158 #: ../tools/virt-win-reg.pl:149
26159 msgid "CurrentControlSet etc."
26163 #: ../tools/virt-win-reg.pl:151
26165 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26166 "Registry at the level of the hive file, and therefore you cannot modify "
26171 #: ../tools/virt-win-reg.pl:155
26173 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26174 "circumstances it might refer to another control set. The way to find out is "
26175 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26179 #: ../tools/virt-win-reg.pl:159
26182 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26183 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26184 " \"Current\"=dword:00000001\n"
26185 " \"Default\"=dword:00000001\n"
26186 " \"Failed\"=dword:00000000\n"
26187 " \"LastKnownGood\"=dword:00000002\n"
26192 #: ../tools/virt-win-reg.pl:166
26193 msgid "\"Current\" is the one which Windows will choose when it boots."
26197 #: ../tools/virt-win-reg.pl:168
26198 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
26202 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26207 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:500
26208 msgid "Enable debugging messages."
26212 #: ../tools/virt-win-reg.pl:232
26217 #: ../tools/virt-win-reg.pl:234
26219 "In merge mode, this merges a textual regedit file into the Windows Registry "
26220 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26221 "displays or exports Registry entries instead."
26225 #: ../tools/virt-win-reg.pl:238
26227 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26228 "result in disk corruption. However exporting (without this flag) is always "
26233 #: ../tools/virt-win-reg.pl:246
26234 msgid "B<--encoding> UTF-16LE|ASCII"
26238 #: ../tools/virt-win-reg.pl:248
26240 "When merging (only), you may need to specify the encoding for strings to be "
26241 "used in the hive file. This is explained in detail in "
26242 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
26246 #: ../tools/virt-win-reg.pl:252
26248 "The default is to use UTF-16LE, which should work with recent versions of "
26253 #: ../tools/virt-win-reg.pl:486
26255 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
26256 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26257 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
26258 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26262 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26264 "When reporting bugs, please enable debugging and capture the I<complete> "
26269 #: ../tools/virt-win-reg.pl:504
26272 " export LIBGUESTFS_DEBUG=1\n"
26273 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26278 #: ../tools/virt-win-reg.pl:507
26280 "Attach /tmp/virt-win-reg.log to a new bug report at "
26281 "L<https://bugzilla.redhat.com/>"
26285 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1512 ../tools/virt-make-fs.pl:565
26286 msgid "Copyright (C) 2010 Red Hat Inc."
26290 #: ../tools/virt-df.pl:36
26291 msgid "virt-df - Display free space on virtual filesystems"
26295 #: ../tools/virt-df.pl:40
26298 " virt-df [--options]\n"
26303 #: ../tools/virt-df.pl:42
26306 " virt-df [--options] domname\n"
26311 #: ../tools/virt-df.pl:44
26314 " virt-df [--options] disk.img [disk.img ...]\n"
26319 #: ../tools/virt-df.pl:48
26321 "C<virt-df> is a command line tool to display free space on virtual machine "
26322 "filesystems. Unlike other tools, it doesn't just display the amount of "
26323 "space allocated to a virtual machine, but can look inside the virtual "
26324 "machine to see how much space is really being used."
26328 #: ../tools/virt-df.pl:53
26330 "It is like the L<df(1)> command, but for virtual machines, except that it "
26331 "also works for Windows virtual machines."
26335 #: ../tools/virt-df.pl:56
26337 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26338 "of all active and inactive guests, and performs a C<df>-type operation on "
26339 "each one in turn, printing out the results."
26343 #: ../tools/virt-df.pl:60
26345 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26346 "either the single named libvirt domain, or on the disk image(s) listed on "
26347 "the command line (which must all belong to a single VM). In this mode (with "
26348 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26349 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26353 #: ../tools/virt-df.pl:67
26355 "Use the C<--csv> option to get a format which can be easily parsed by other "
26356 "programs. Other options are mostly similar to standard C<df> options. See "
26357 "below for the complete list."
26361 #: ../tools/virt-df.pl:107
26366 #: ../tools/virt-df.pl:109
26368 "Write out the results in CSV format (comma-separated values). This format "
26369 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26370 "ABOUT CSV FORMAT> below."
26374 #: ../tools/virt-df.pl:134
26375 msgid "B<--human-readable> | B<-h>"
26379 #: ../tools/virt-df.pl:136
26380 msgid "Print sizes in human-readable format."
26384 #: ../tools/virt-df.pl:138
26385 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26389 #: ../tools/virt-df.pl:144
26390 msgid "B<--inodes> | B<-i>"
26394 #: ../tools/virt-df.pl:146
26395 msgid "Print inodes instead of blocks."
26399 #: ../tools/virt-df.pl:152
26400 msgid "B<--one-per-guest>"
26404 #: ../tools/virt-df.pl:154
26406 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26407 "disks from several guests to a single libguestfs appliance."
26411 #: ../tools/virt-df.pl:157
26412 msgid "You might use this option in the following circumstances:"
26416 #: ../tools/virt-df.pl:163
26418 "If you think an untrusted guest might actively try to exploit the libguestfs "
26419 "appliance kernel, then this prevents one guest from interfering with the "
26420 "stats printed for another guest."
26424 #: ../tools/virt-df.pl:169
26426 "If the kernel has a bug which stops it from accessing a filesystem in one "
26427 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26428 "and report stats for further guests."
26432 #: ../tools/virt-df.pl:180
26437 #: ../tools/virt-df.pl:182
26439 "Print UUIDs instead of names. This is useful for following a guest even "
26440 "when the guest is migrated or renamed, or when two guests happen to have the "
26445 #: ../tools/virt-df.pl:186
26447 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26448 "images, we still print the disk image name even when this option is "
26453 #: ../tools/virt-df.pl:609
26454 msgid "NOTE ABOUT CSV FORMAT"
26458 #: ../tools/virt-df.pl:611
26460 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26461 "should be easy to parse, but it is definitely not easy to parse."
26465 #: ../tools/virt-df.pl:614
26467 "Myth: Just split fields at commas. Reality: This does I<not> work "
26468 "reliably. This example has two columns:"
26472 #: ../tools/virt-df.pl:617
26475 " \"foo,bar\",baz\n"
26480 #: ../tools/virt-df.pl:619
26482 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26483 "reliably. This example has one row:"
26487 #: ../tools/virt-df.pl:622
26496 #: ../tools/virt-df.pl:625
26498 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26499 "packaged in major Linux distributions)."
26503 #: ../tools/virt-df.pl:628
26505 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26506 "or Python's built-in csv library)."
26510 #: ../tools/virt-df.pl:631
26511 msgid "Most spreadsheets and databases can import CSV directly."
26515 #: ../tools/virt-df.pl:642
26517 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26518 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26522 #: ../tools/virt-resize.pl:42
26523 msgid "virt-resize - Resize a virtual machine disk"
26527 #: ../tools/virt-resize.pl:46
26530 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26531 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26532 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26537 #: ../tools/virt-resize.pl:52
26539 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26540 "larger or smaller overall, and resizing or deleting any partitions contained "
26545 #: ../tools/virt-resize.pl:56
26547 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26548 "not> be used on live virtual machines - for consistent results, shut the "
26549 "virtual machine down before resizing it."
26553 #: ../tools/virt-resize.pl:60
26555 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26556 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26560 #: ../tools/virt-resize.pl:66
26562 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26563 "fill the extra 5GB of space."
26567 #: ../tools/virt-resize.pl:69
26570 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26571 " virt-filesystems --long --h --all -a olddisk\n"
26572 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26573 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26578 #: ../tools/virt-resize.pl:74
26580 "As above, but make the /boot partition 200MB bigger, while giving the "
26581 "remaining space to /dev/sda2:"
26585 #: ../tools/virt-resize.pl:77
26588 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26593 #: ../tools/virt-resize.pl:79
26594 msgid "As above, but the output format will be uncompressed qcow2:"
26598 #: ../tools/virt-resize.pl:81
26601 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26602 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26607 #: ../tools/virt-resize.pl:84
26608 msgid "DETAILED USAGE"
26612 #: ../tools/virt-resize.pl:86
26613 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26617 #: ../tools/virt-resize.pl:90
26618 msgid "1. Shut down the virtual machine"
26622 #: ../tools/virt-resize.pl:92
26623 msgid "2. Locate input disk image"
26627 #: ../tools/virt-resize.pl:94
26629 "Locate the input disk image (ie. the file or device on the host containing "
26630 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26631 "dumpxml> like this to find the disk image name:"
26635 #: ../tools/virt-resize.pl:98
26638 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26639 " Found 1 nodes:\n"
26641 " <source dev=\"/dev/vg/lv_guest\" />\n"
26646 #: ../tools/virt-resize.pl:103
26647 msgid "3. Look at current sizing"
26651 #: ../tools/virt-resize.pl:105
26652 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
26656 #: ../tools/virt-resize.pl:108
26659 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
26660 " Name Type Size Parent\n"
26661 " /dev/sda1 partition 101M /dev/sda\n"
26662 " /dev/sda2 partition 7.9G /dev/sda\n"
26663 " /dev/sda device 8.0G -\n"
26668 #: ../tools/virt-resize.pl:114
26670 "(This example is a virtual machine with an 8 GB disk which we would like to "
26671 "expand up to 10 GB)."
26675 #: ../tools/virt-resize.pl:117
26676 msgid "4. Create output disk"
26680 #: ../tools/virt-resize.pl:119
26682 "Virt-resize cannot do in-place disk modifications. You have to have space "
26683 "to store the resized output disk."
26687 #: ../tools/virt-resize.pl:122
26688 msgid "To store the resized disk image in a file, create a file of a suitable size:"
26692 #: ../tools/virt-resize.pl:125
26695 " # rm -f outdisk\n"
26696 " # truncate -s 10G outdisk\n"
26701 #: ../tools/virt-resize.pl:128
26702 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26706 #: ../tools/virt-resize.pl:130
26709 " # lvcreate -L 10G -n lv_name vg_name\n"
26714 #: ../tools/virt-resize.pl:132
26715 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26719 #: ../tools/virt-resize.pl:134
26722 " # virsh pool-list\n"
26723 " # virsh vol-create-as poolname newvol 10G\n"
26728 #: ../tools/virt-resize.pl:137
26733 #: ../tools/virt-resize.pl:139
26735 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26736 "file) and the output disk. The output disk is the one created in the "
26741 #: ../tools/virt-resize.pl:143
26744 " # virt-resize indisk outdisk\n"
26749 #: ../tools/virt-resize.pl:145
26751 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26752 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26753 "larger, then an extra, empty partition is created at the end of the disk "
26754 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26759 #: ../tools/virt-resize.pl:151
26761 "More realistically you'd want to expand existing partitions in the disk "
26762 "image by passing extra options (for the full list see the L</OPTIONS> "
26767 #: ../tools/virt-resize.pl:155
26769 "L</--expand> is the most useful option. It expands the named partition "
26770 "within the disk to fill any extra space:"
26774 #: ../tools/virt-resize.pl:158
26777 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26782 #: ../tools/virt-resize.pl:160
26784 "(In this case, an extra partition is I<not> created at the end of the disk, "
26785 "because there will be no unused space)."
26789 #: ../tools/virt-resize.pl:163
26791 "L</--resize> is the other commonly used option. The following would "
26792 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26793 "rest of the available space:"
26797 #: ../tools/virt-resize.pl:167
26800 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26801 " indisk outdisk\n"
26806 #: ../tools/virt-resize.pl:170
26808 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26809 "if virt-resize knows how, it will resize the contents, the equivalent of "
26810 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
26811 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
26812 "filesystems, so you would have to online resize them after booting the "
26813 "guest. And virt-resize also does not resize anything inside an LVM PV, it "
26814 "just resizes the PV itself and leaves the user to resize any LVs inside that "
26819 #: ../tools/virt-resize.pl:179
26820 msgid "Other options are covered below."
26824 #: ../tools/virt-resize.pl:181
26829 #: ../tools/virt-resize.pl:183
26830 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26834 #: ../tools/virt-resize.pl:185
26835 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26839 #: ../tools/virt-resize.pl:187
26842 " # virsh edit guestname\n"
26847 #: ../tools/virt-resize.pl:189
26849 "Change E<lt>source ...E<gt>, see "
26850 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
26854 #: ../tools/virt-resize.pl:192
26855 msgid "Then start up the domain with the new, resized disk:"
26859 #: ../tools/virt-resize.pl:194
26862 " # virsh start guestname\n"
26867 #: ../tools/virt-resize.pl:196
26869 "and check that it still works. See also the L</NOTES> section below for "
26870 "additional information."
26874 #: ../tools/virt-resize.pl:199
26875 msgid "7. Resize LVs etc inside the guest"
26879 #: ../tools/virt-resize.pl:201
26880 msgid "(This can also be done offline using L<guestfish(1)>)"
26884 #: ../tools/virt-resize.pl:203
26886 "Once the guest has booted you should see the new space available, at least "
26887 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26888 "may need to resize LVs inside PVs, and also resize filesystem types that "
26889 "virt-resize does not know how to expand."
26893 #: ../tools/virt-resize.pl:210
26894 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26898 #: ../tools/virt-resize.pl:212
26900 "Shrinking is somewhat more complex than expanding, and only an overview is "
26905 #: ../tools/virt-resize.pl:215
26907 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26908 "filesystems). The user has to shrink content before passing the disk image "
26909 "to virt-resize, and virt-resize will check that the content has been shrunk "
26914 #: ../tools/virt-resize.pl:220
26915 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26919 #: ../tools/virt-resize.pl:222
26921 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26922 "steps 3 and 4 above to allocate a new disk image."
26926 #: ../tools/virt-resize.pl:225
26927 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26931 #: ../tools/virt-resize.pl:228
26932 msgid "IGNORING OR DELETING PARTITIONS"
26936 #: ../tools/virt-resize.pl:230
26938 "virt-resize also gives a convenient way to ignore or delete partitions when "
26939 "copying from the input disk to the output disk. Ignoring a partition speeds "
26940 "up the copy where you don't care about the existing contents of a "
26941 "partition. Deleting a partition removes it completely, but note that it "
26942 "also renumbers any partitions after the one which is deleted, which can "
26943 "leave some guests unbootable."
26947 #: ../tools/virt-resize.pl:237
26948 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26952 #: ../tools/virt-resize.pl:239
26954 "If the input disk is in qcow2 format, then you may prefer that the output is "
26955 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26956 "the fly. The output format is simply determined by the format of the empty "
26957 "output container that you provide. Thus to create qcow2 output, use:"
26961 #: ../tools/virt-resize.pl:245
26964 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26969 #: ../tools/virt-resize.pl:247
26970 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26974 #: ../tools/virt-resize.pl:249
26975 msgid "Similarly, to get non-sparse raw output use:"
26979 #: ../tools/virt-resize.pl:251
26982 " fallocate -l size outdisk\n"
26987 #: ../tools/virt-resize.pl:253
26989 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26990 "if=/dev/zero of=outdisk bs=1M count=..>)"
26994 #: ../tools/virt-resize.pl:266
26995 msgid "Display help."
26999 #: ../tools/virt-resize.pl:280
27000 msgid "B<--resize part=size>"
27004 #: ../tools/virt-resize.pl:282
27006 "Resize the named partition (expanding or shrinking it) so that it has the "
27011 #: ../tools/virt-resize.pl:285
27013 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27014 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27015 "Exabytes; or as a percentage of the current size; or as a relative number or "
27016 "percentage. For example:"
27020 #: ../tools/virt-resize.pl:290
27023 " --resize /dev/sda2=10G\n"
27028 #: ../tools/virt-resize.pl:292
27031 " --resize /dev/sda4=90%\n"
27036 #: ../tools/virt-resize.pl:294
27039 " --resize /dev/sda2=+1G\n"
27044 #: ../tools/virt-resize.pl:296
27047 " --resize /dev/sda2=-200M\n"
27052 #: ../tools/virt-resize.pl:298
27055 " --resize /dev/sda1=+128K\n"
27060 #: ../tools/virt-resize.pl:300
27063 " --resize /dev/sda1=+10%\n"
27068 #: ../tools/virt-resize.pl:302
27071 " --resize /dev/sda1=-10%\n"
27076 #: ../tools/virt-resize.pl:304
27078 "You can increase the size of any partition. Virt-resize will expand the "
27079 "direct content of the partition if it knows how (see C<--expand> below)."
27083 #: ../tools/virt-resize.pl:308
27085 "You can only I<decrease> the size of partitions that contain filesystems or "
27086 "PVs which have already been shrunk. Virt-resize will check this has been "
27087 "done before proceeding, or else will print an error (see also "
27088 "C<--resize-force>)."
27092 #: ../tools/virt-resize.pl:313 ../tools/virt-resize.pl:405 ../tools/virt-resize.pl:422
27093 msgid "You can give this option multiple times."
27097 #: ../tools/virt-resize.pl:319
27098 msgid "B<--resize-force part=size>"
27102 #: ../tools/virt-resize.pl:321
27104 "This is the same as C<--resize> except that it will let you decrease the "
27105 "size of any partition. Generally this means you will lose any data which "
27106 "was at the end of the partition you shrink, but you may not care about that "
27107 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27108 "as a swap partition)."
27112 #: ../tools/virt-resize.pl:327
27113 msgid "See also the C<--ignore> option."
27117 #: ../tools/virt-resize.pl:333
27118 msgid "B<--expand part>"
27122 #: ../tools/virt-resize.pl:335
27124 "Expand the named partition so it uses up all extra space (space left over "
27125 "after any other resize changes that you request have been done)."
27129 #: ../tools/virt-resize.pl:338
27131 "If virt-resize knows how, it will expand the direct content of the "
27132 "partition. For example, if the partition is an LVM PV, it will expand the "
27133 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27134 "content it doesn't know about alone."
27138 #: ../tools/virt-resize.pl:343
27139 msgid "Currently virt-resize can resize:"
27143 #: ../tools/virt-resize.pl:349
27145 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27150 #: ../tools/virt-resize.pl:354
27152 "NTFS filesystems contained directly in a partition, if libguestfs was "
27153 "compiled with support for NTFS."
27157 #: ../tools/virt-resize.pl:357
27159 "The filesystem must have been shut down consistently last time it was used. "
27160 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27161 "consistency check, so at the first boot after resizing Windows will check "
27166 #: ../tools/virt-resize.pl:364
27168 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27169 "inside the PV. The user will have to resize LVs as desired."
27173 #: ../tools/virt-resize.pl:370 ../tools/virt-resize.pl:392
27174 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27178 #: ../tools/virt-resize.pl:376
27179 msgid "B<--shrink part>"
27183 #: ../tools/virt-resize.pl:378
27185 "Shrink the named partition until the overall disk image fits in the "
27186 "destination. The named partition B<must> contain a filesystem or PV which "
27187 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27188 "online tools). Virt-resize will check this and give an error if it has not "
27193 #: ../tools/virt-resize.pl:384
27195 "The amount by which the overall disk must be shrunk (after carrying out all "
27196 "other operations requested by the user) is called the \"deficit\". For "
27197 "example, a straight copy (assume no other operations) from a 5GB disk image "
27198 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27199 "would give an error unless the user specified a partition to shrink and that "
27200 "partition had more than a gigabyte of free space."
27204 #: ../tools/virt-resize.pl:398
27205 msgid "B<--ignore part>"
27209 #: ../tools/virt-resize.pl:400
27211 "Ignore the named partition. Effectively this means the partition is "
27212 "allocated on the destination disk, but the content is not copied across from "
27213 "the source disk. The content of the partition will be blank (all zero "
27218 #: ../tools/virt-resize.pl:411
27219 msgid "B<--delete part>"
27223 #: ../tools/virt-resize.pl:413
27225 "Delete the named partition. It would be more accurate to describe this as "
27226 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27227 "the original disk image is left intact."
27231 #: ../tools/virt-resize.pl:417
27233 "Note that when you delete a partition, then anything contained in the "
27234 "partition is also deleted. Furthermore, this causes any partitions that "
27235 "come after to be I<renumbered>, which can easily make your guest unbootable."
27239 #: ../tools/virt-resize.pl:428
27240 msgid "B<--LV-expand logvol>"
27244 #: ../tools/virt-resize.pl:430
27246 "This takes the logical volume and, as a final step, expands it to fill all "
27247 "the space available in its volume group. A typical usage, assuming a Linux "
27248 "guest with a single PV C</dev/sda2> and a root device called "
27249 "C</dev/vg_guest/lv_root> would be:"
27253 #: ../tools/virt-resize.pl:435
27256 " virt-resize indisk outdisk \\\n"
27257 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27262 #: ../tools/virt-resize.pl:438
27264 "This would first expand the partition (and PV), and then expand the root "
27265 "device to fill the extra space in the PV."
27269 #: ../tools/virt-resize.pl:441
27271 "The contents of the LV are also resized if virt-resize knows how to do "
27272 "that. You can stop virt-resize from trying to expand the content by using "
27273 "the option C<--no-expand-content>."
27277 #: ../tools/virt-resize.pl:445
27278 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27282 #: ../tools/virt-resize.pl:448
27284 "You can give this option multiple times, I<but> it doesn't make sense to do "
27285 "this unless the logical volumes you specify are all in different volume "
27290 #: ../tools/virt-resize.pl:456
27291 msgid "B<--no-copy-boot-loader>"
27295 #: ../tools/virt-resize.pl:458
27297 "By default, virt-resize copies over some sectors at the start of the disk "
27298 "(up to the beginning of the first partition). Commonly these sectors "
27299 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27300 "in order for the guest to boot correctly."
27304 #: ../tools/virt-resize.pl:463
27306 "If you specify this flag, then this initial copy is not done. You may need "
27307 "to reinstall the boot loader in this case."
27311 #: ../tools/virt-resize.pl:471
27312 msgid "B<--no-extra-partition>"
27316 #: ../tools/virt-resize.pl:473
27318 "By default, virt-resize creates an extra partition if there is any extra, "
27319 "unused space after all resizing has happened. Use this option to prevent "
27320 "the extra partition from being created. If you do this then the extra space "
27321 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27322 "tool in the guest."
27326 #: ../tools/virt-resize.pl:479
27328 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27333 #: ../tools/virt-resize.pl:486
27334 msgid "B<--no-expand-content>"
27338 #: ../tools/virt-resize.pl:488
27340 "By default, virt-resize will try to expand the direct contents of "
27341 "partitions, if it knows how (see C<--expand> option above)."
27345 #: ../tools/virt-resize.pl:491
27347 "If you give the C<--no-expand-content> option then virt-resize will not "
27352 #: ../tools/virt-resize.pl:498
27353 msgid "B<-d> | B<--debug>"
27357 #: ../tools/virt-resize.pl:506
27358 msgid "B<-n> | B<--dryrun>"
27362 #: ../tools/virt-resize.pl:508
27363 msgid "Print a summary of what would be done, but don't do anything."
27367 #: ../tools/virt-resize.pl:514
27368 msgid "B<-q> | B<--quiet>"
27372 #: ../tools/virt-resize.pl:516
27373 msgid "Don't print the summary."
27377 #: ../tools/virt-resize.pl:524
27379 "Specify the format of the input disk image. If this flag is not given then "
27380 "it is auto-detected from the image itself."
27384 #: ../tools/virt-resize.pl:530
27386 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27387 "AND NON-SPARSE RAW FORMATS>."
27391 #: ../tools/virt-resize.pl:537
27392 msgid "B<--output-format> raw"
27396 #: ../tools/virt-resize.pl:539
27398 "Specify the format of the output disk image. If this flag is not given then "
27399 "it is auto-detected from the image itself."
27403 #: ../tools/virt-resize.pl:545
27405 "Note that you still need to create the output disk with the right format. "
27406 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27410 #: ../tools/virt-resize.pl:1421 ../tools/virt-rescue.pl:90
27415 #: ../tools/virt-resize.pl:1423
27416 msgid "\"Partition 1 does not end on cylinder boundary.\""
27420 #: ../tools/virt-resize.pl:1425
27422 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27423 "means the partitions will not be aligned to the ancient CHS geometry. "
27424 "However CHS geometry is meaningless for disks manufactured since the early "
27425 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27426 "cylinders is not required by any modern operating system."
27430 #: ../tools/virt-resize.pl:1432
27431 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27435 #: ../tools/virt-resize.pl:1434
27437 "In Windows Vista and later versions, Microsoft switched to using a separate "
27438 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27439 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27440 "the boot partition. Doing so seems to break the guest completely. However "
27441 "expanding the second partition (ie. C: drive) should work."
27445 #: ../tools/virt-resize.pl:1441
27447 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27448 "NTFS partitions have been expanded. This is just a safety check and (unless "
27449 "it find errors) is nothing to worry about."
27453 #: ../tools/virt-resize.pl:1445
27454 msgid "GUEST BOOT STUCK AT \"GRUB\""
27458 #: ../tools/virt-resize.pl:1447
27460 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27461 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27462 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27463 "although we think is to do with partition alignment."
27467 #: ../tools/virt-resize.pl:1452
27470 " guestfish -i -a newdisk\n"
27471 " ><fs> cat /boot/grub/device.map\n"
27472 " # check the contents of this file are sensible or\n"
27473 " # edit the file if necessary\n"
27474 " ><fs> grub-install / /dev/vda\n"
27480 #: ../tools/virt-resize.pl:1459
27482 "For more flexible guest reconfiguration, including if you need to specify "
27483 "other parameters to grub-install, use L<virt-rescue(1)>."
27487 #: ../tools/virt-resize.pl:1462
27488 msgid "ALTERNATIVE TOOLS"
27492 #: ../tools/virt-resize.pl:1464
27494 "There are several proprietary tools for resizing partitions. We won't "
27495 "mention any here."
27499 #: ../tools/virt-resize.pl:1467
27501 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27502 "operations on disk images. They can resize and move partitions, but I don't "
27503 "think they can do anything with the contents, and they certainly don't "
27508 #: ../tools/virt-resize.pl:1472
27510 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27511 "but at a much lower level. You will probably end up hand-calculating sector "
27512 "offsets, which is something that virt-resize was designed to avoid. If you "
27513 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27518 #: ../tools/virt-resize.pl:1487
27520 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
27521 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
27522 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
27523 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27524 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27528 #: ../tools/virt-list-filesystems.pl:32
27529 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27533 #: ../tools/virt-list-filesystems.pl:36
27536 " virt-list-filesystems [--options] domname\n"
27541 #: ../tools/virt-list-filesystems.pl:38
27544 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27549 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27551 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27556 #: ../tools/virt-list-filesystems.pl:45
27558 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27559 "are contained in a virtual machine or disk image."
27563 #: ../tools/virt-list-filesystems.pl:49
27565 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27566 "functionality. For more complex cases you should look at the "
27567 "L<guestfish(1)> tool."
27571 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27572 msgid "B<-l> | B<--long>"
27576 #: ../tools/virt-list-filesystems.pl:108
27578 "With this option, C<virt-list-filesystems> displays the type of each "
27579 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27583 #: ../tools/virt-list-filesystems.pl:115
27584 msgid "B<-a> | B<--all>"
27588 #: ../tools/virt-list-filesystems.pl:117
27590 "Normally we only show mountable filesystems. If this option is given then "
27591 "swap devices are shown too."
27595 #: ../tools/virt-list-filesystems.pl:191
27597 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
27598 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
27599 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27603 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27604 msgid "Copyright (C) 2009 Red Hat Inc."
27608 #: ../tools/virt-tar.pl:33
27609 msgid "virt-tar - Extract or upload files to a virtual machine"
27613 #: ../tools/virt-tar.pl:37
27616 " virt-tar [--options] -x domname directory tarball\n"
27621 #: ../tools/virt-tar.pl:39
27624 " virt-tar [--options] -u domname tarball directory\n"
27629 #: ../tools/virt-tar.pl:41
27632 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27637 #: ../tools/virt-tar.pl:43
27640 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27645 #: ../tools/virt-tar.pl:47
27646 msgid "Download C</home> from the VM into a local tarball:"
27650 #: ../tools/virt-tar.pl:49
27653 " virt-tar -x domname /home home.tar\n"
27658 #: ../tools/virt-tar.pl:51
27661 " virt-tar -zx domname /home home.tar.gz\n"
27666 #: ../tools/virt-tar.pl:53
27667 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27671 #: ../tools/virt-tar.pl:55
27674 " virt-tar -u domname uploadstuff.tar /tmp\n"
27679 #: ../tools/virt-tar.pl:57
27682 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27687 #: ../tools/virt-tar.pl:61
27689 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27690 "virtual machines. If you do this, you risk disk corruption in the VM. "
27691 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27695 #: ../tools/virt-tar.pl:66
27697 "You can use C<-x> (extract) on live virtual machines, but you might get "
27698 "inconsistent results or errors if there is filesystem activity inside the "
27699 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27700 "work, but the only way to guarantee consistent results is if the virtual "
27701 "machine is shut down."
27705 #: ../tools/virt-tar.pl:74
27707 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27708 "parts of a guest filesystem. There are many possibilities: making backups, "
27709 "uploading data files, snooping on guest activity, fixing or customizing "
27714 #: ../tools/virt-tar.pl:79
27716 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27717 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27718 "should look at the L<guestfish(1)> tool."
27722 #: ../tools/virt-tar.pl:83
27724 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27725 "its contents (recursively) from the virtual machine into a local tarball. "
27726 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27727 "virtual machine. You cannot use these two options together."
27731 #: ../tools/virt-tar.pl:89
27733 "In addition, you may need to use the C<-z> (gZip) option to enable "
27734 "compression. When uploading, you have to specify C<-z> if the upload file "
27735 "is compressed because virt-tar won't detect this on its own."
27739 #: ../tools/virt-tar.pl:93
27741 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27742 "example it cannot do PKZip files or bzip2 compression. If you want that "
27743 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27744 "the L<libguestfs(3)> API)."
27748 #: ../tools/virt-tar.pl:151
27749 msgid "B<-x> | B<--extract> | B<--download>"
27753 #: ../tools/virt-tar.pl:153
27754 msgid "B<-u> | B<--upload>"
27758 #: ../tools/virt-tar.pl:155
27760 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27765 #: ../tools/virt-tar.pl:158
27767 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27768 "Please read the L</WARNING> section above before using this option."
27772 #: ../tools/virt-tar.pl:162
27773 msgid "You must specify exactly one of these options."
27777 #: ../tools/virt-tar.pl:168
27778 msgid "B<-z> | B<--gzip>"
27782 #: ../tools/virt-tar.pl:170
27783 msgid "Specify that the input or output tarball is gzip-compressed."
27787 #: ../tools/virt-tar.pl:283
27789 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27790 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
27791 "L<http://libguestfs.org/>."
27795 #: ../tools/virt-rescue.pl:33
27796 msgid "virt-rescue - Run a rescue shell on a virtual machine"
27800 #: ../tools/virt-rescue.pl:37
27803 " virt-rescue [--options] domname\n"
27808 #: ../tools/virt-rescue.pl:39
27811 " virt-rescue [--options] disk.img [disk.img ...]\n"
27816 #: ../tools/virt-rescue.pl:43
27818 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
27819 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
27820 "you from doing this, but doesn't catch all cases."
27824 #: ../tools/virt-rescue.pl:47
27826 "However if you use the I<--ro> (read only) option, then you can attach a "
27827 "shell to a live virtual machine. The results might be strange or "
27828 "inconsistent at times but you won't get disk corruption."
27832 #: ../tools/virt-rescue.pl:53
27834 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
27835 "need for a CD. virt-rescue gives you a rescue shell and some simple "
27836 "recovery tools which you can use to examine or rescue a virtual machine or "
27841 #: ../tools/virt-rescue.pl:58
27843 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
27844 "on disk image(s):"
27848 #: ../tools/virt-rescue.pl:61
27851 " virt-rescue GuestName\n"
27856 #: ../tools/virt-rescue.pl:63
27859 " virt-rescue --ro /path/to/disk.img\n"
27864 #: ../tools/virt-rescue.pl:65
27867 " virt-rescue /dev/sdc\n"
27872 #: ../tools/virt-rescue.pl:67
27873 msgid "For live VMs you I<must> use the --ro option."
27877 #: ../tools/virt-rescue.pl:69
27879 "When you run virt-rescue on a virtual machine or disk image, you are placed "
27880 "in an interactive bash shell where you can use many ordinary Linux "
27881 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
27882 "appliance. You must mount the virtual machine's filesystems by hand. There "
27883 "is an empty directory called C</sysroot> where you can mount filesystems."
27887 #: ../tools/virt-rescue.pl:76
27889 "In the example below, we list logical volumes, then choose one to mount "
27890 "under C</sysroot>:"
27894 #: ../tools/virt-rescue.pl:79
27898 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
27899 " lv_root vg_f11x64 -wi-a- 8.83G\n"
27900 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
27901 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
27902 " ><rescue> ls /sysroot\n"
27907 #: ../tools/virt-rescue.pl:86
27909 "If you don't know what filesystems are available on the virtual machine then "
27910 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
27914 #: ../tools/virt-rescue.pl:92
27916 "Virt-rescue can be used on I<any> disk image file or device, not just a "
27917 "virtual machine. For example you can use it on a blank file if you want to "
27918 "partition that file (although we would recommend using L<guestfish(1)> "
27919 "instead as it is more suitable for this purpose). You can even use "
27920 "virt-rescue on things like SD cards."
27924 #: ../tools/virt-rescue.pl:98
27926 "This tool is just designed for quick interactive hacking on a virtual "
27927 "machine. For more structured access to a virtual machine disk image, you "
27928 "should use L<guestfs(3)>. To get a structured shell that you can use to "
27929 "make scripted changes to guests, use L<guestfish(1)>."
27933 #: ../tools/virt-rescue.pl:127
27934 msgid "B<--append kernelopts>"
27938 #: ../tools/virt-rescue.pl:129
27939 msgid "Pass additional options to the rescue kernel."
27943 #: ../tools/virt-rescue.pl:164
27944 msgid "B<--memsize MB> | B<-m MB>"
27948 #: ../tools/virt-rescue.pl:166
27950 "Change the amount of memory allocated to the rescue system. The default is "
27951 "set by libguestfs and is small but adequate for running system tools. The "
27952 "occasional program might need more memory. The parameter is specified in "
27957 #: ../tools/virt-rescue.pl:175
27958 msgid "B<--network>"
27962 #: ../tools/virt-rescue.pl:177
27963 msgid "Enable QEMU user networking in the guest."
27967 #: ../tools/virt-rescue.pl:183
27968 msgid "B<--ro> | B<-r>"
27972 #: ../tools/virt-rescue.pl:185
27973 msgid "Open the image read-only."
27977 #: ../tools/virt-rescue.pl:197
27979 "Enable SELinux in the rescue appliance. You should read "
27980 "L<guestfs(3)/SELINUX> before using this option."
27984 #: ../tools/virt-rescue.pl:257
27986 "Several environment variables affect virt-rescue. See "
27987 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
27991 #: ../tools/virt-rescue.pl:269
27993 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
27994 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27998 #: ../tools/virt-make-fs.pl:37
27999 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28003 #: ../tools/virt-make-fs.pl:41
28006 " virt-make-fs [--options] input.tar output.img\n"
28011 #: ../tools/virt-make-fs.pl:43
28014 " virt-make-fs [--options] input.tar.gz output.img\n"
28019 #: ../tools/virt-make-fs.pl:45
28022 " virt-make-fs [--options] directory output.img\n"
28027 #: ../tools/virt-make-fs.pl:49
28029 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28030 "archive or some files in a directory. It is similar to tools like "
28031 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
28032 "it can create common filesystem types like ext2/3 or NTFS, which can be "
28033 "useful if you want to attach these filesystems to existing virtual machines "
28034 "(eg. to import large amounts of read-only data to a VM)."
28038 #: ../tools/virt-make-fs.pl:57
28039 msgid "Basic usage is:"
28043 #: ../tools/virt-make-fs.pl:59
28046 " virt-make-fs input output\n"
28051 #: ../tools/virt-make-fs.pl:61
28053 "where C<input> is either a directory containing files that you want to add, "
28054 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28055 "C<output> is a disk image. The input type is detected automatically. The "
28056 "output disk image defaults to a raw ext2 image unless you specify extra "
28057 "flags (see L</OPTIONS> below)."
28061 #: ../tools/virt-make-fs.pl:67
28062 msgid "EXTRA SPACE"
28066 #: ../tools/virt-make-fs.pl:69
28068 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28069 "the files that it contains, but might have extra space. Depending on how "
28070 "you are going to use the output, you might think this extra space is wasted "
28071 "and want to minimize it, or you might want to leave space so that more files "
28072 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28073 "but you can use the C<--size> flag to leave space in the filesystem if you "
28078 #: ../tools/virt-make-fs.pl:77
28080 "An alternative way to leave extra space but not make the output image any "
28081 "bigger is to use an alternative disk image format (instead of the default "
28082 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28083 "image format (check your hypervisor supports this before using it). This "
28084 "allows you to choose a large C<--size> but the extra space won't actually be "
28085 "allocated in the image until you try to store something in it."
28089 #: ../tools/virt-make-fs.pl:85
28091 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28092 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
28093 "virt-make-resize to build another image from scratch."
28097 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
28102 #: ../tools/virt-make-fs.pl:91
28105 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28110 #: ../tools/virt-make-fs.pl:93
28111 msgid "FILESYSTEM TYPE"
28115 #: ../tools/virt-make-fs.pl:95
28117 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28118 "libguestfs supports can be used (but I<not> read-only formats like "
28119 "ISO9660). Here are some of the more common choices:"
28123 #: ../tools/virt-make-fs.pl:101
28128 #: ../tools/virt-make-fs.pl:103
28130 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28131 "you are not going to use the filesystem in a way that requires the journal, "
28132 "then this is just wasted overhead."
28136 #: ../tools/virt-make-fs.pl:107
28137 msgid "I<ntfs> or I<vfat>"
28141 #: ../tools/virt-make-fs.pl:109
28142 msgid "Useful if exporting data to a Windows guest."
28146 #: ../tools/virt-make-fs.pl:111
28148 "I<Note for vfat>: The tar archive or local directory must only contain files "
28149 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28150 "program running within libguestfs is unable to change the ownership of "
28151 "non-root files, since vfat itself does not support this."
28155 #: ../tools/virt-make-fs.pl:116
28160 #: ../tools/virt-make-fs.pl:118
28162 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28163 "total filesystem size."
28167 #: ../tools/virt-make-fs.pl:125
28170 " virt-make-fs --type=minix input minixfs.img\n"
28175 #: ../tools/virt-make-fs.pl:127
28176 msgid "TO PARTITION OR NOT TO PARTITION"
28180 #: ../tools/virt-make-fs.pl:129
28181 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28185 #: ../tools/virt-make-fs.pl:131
28187 "Adding a partition can make the disk image more compatible with certain "
28188 "virtualized operating systems which don't expect to see a filesystem "
28189 "directly located on a block device (Linux doesn't care and will happily "
28190 "handle both types)."
28194 #: ../tools/virt-make-fs.pl:136
28196 "On the other hand, if you have a partition table then the output image is no "
28197 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28198 "directly on a partitioned disk image. (However libguestfs tools such as "
28199 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28203 #: ../tools/virt-make-fs.pl:144
28204 msgid "Add an MBR partition:"
28208 #: ../tools/virt-make-fs.pl:146
28211 " virt-make-fs --partition -- input disk.img\n"
28216 #: ../tools/virt-make-fs.pl:148
28218 "If the output disk image could be terabyte-sized or larger, it's better to "
28219 "use an EFI/GPT-compatible partition table:"
28223 #: ../tools/virt-make-fs.pl:151
28226 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28231 #: ../tools/virt-make-fs.pl:179
28232 msgid "Enable debugging information."
28236 #: ../tools/virt-make-fs.pl:185
28237 msgid "B<--size=E<lt>NE<gt>>"
28241 #: ../tools/virt-make-fs.pl:187
28242 msgid "B<--size=+E<lt>NE<gt>>"
28246 #: ../tools/virt-make-fs.pl:189
28247 msgid "B<-s E<lt>NE<gt>>"
28251 #: ../tools/virt-make-fs.pl:191
28252 msgid "B<-s +E<lt>NE<gt>>"
28256 #: ../tools/virt-make-fs.pl:193
28257 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28261 #: ../tools/virt-make-fs.pl:196
28263 "If this option is I<not> given, then the output image will be just large "
28264 "enough to contain all the files, with not much wasted space."
28268 #: ../tools/virt-make-fs.pl:199
28270 "To choose a fixed size output disk, specify an absolute number followed by "
28271 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28272 "Petabytes or Exabytes. This must be large enough to contain all the input "
28273 "files, else you will get an error."
28277 #: ../tools/virt-make-fs.pl:204
28279 "To leave extra space, specify C<+> (plus sign) and a number followed by "
28280 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28281 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28282 "the input files, and (approximately) an extra 200 MB free space."
28286 #: ../tools/virt-make-fs.pl:210
28288 "Note that virt-make-fs estimates free space, and therefore will not produce "
28289 "filesystems containing precisely the free space requested. (It is much more "
28290 "expensive and time-consuming to produce a filesystem which has precisely the "
28291 "desired free space)."
28295 #: ../tools/virt-make-fs.pl:219
28296 msgid "B<--format=E<lt>fmtE<gt>>"
28300 #: ../tools/virt-make-fs.pl:221
28301 msgid "B<-F E<lt>fmtE<gt>>"
28305 #: ../tools/virt-make-fs.pl:223
28306 msgid "Choose the output disk image format."
28310 #: ../tools/virt-make-fs.pl:225
28311 msgid "The default is C<raw> (raw disk image)."
28315 #: ../tools/virt-make-fs.pl:227
28317 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28318 "that would really make sense here is C<qcow2>."
28322 #: ../tools/virt-make-fs.pl:234
28323 msgid "B<--type=E<lt>fsE<gt>>"
28327 #: ../tools/virt-make-fs.pl:236
28328 msgid "B<-t E<lt>fsE<gt>>"
28332 #: ../tools/virt-make-fs.pl:238
28333 msgid "Choose the output filesystem type."
28337 #: ../tools/virt-make-fs.pl:240
28338 msgid "The default is C<ext2>."
28342 #: ../tools/virt-make-fs.pl:242
28343 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
28347 #: ../tools/virt-make-fs.pl:249
28348 msgid "B<--partition>"
28352 #: ../tools/virt-make-fs.pl:251
28353 msgid "B<--partition=E<lt>parttypeE<gt>>"
28357 #: ../tools/virt-make-fs.pl:253
28359 "If specified, this flag adds an MBR partition table to the output disk "
28364 #: ../tools/virt-make-fs.pl:256
28366 "You can change the partition table type, eg. C<--partition=gpt> for large "
28371 #: ../tools/virt-make-fs.pl:259
28373 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28374 "might consider the next parameter to be the partition type. For example:"
28378 #: ../tools/virt-make-fs.pl:263
28381 " virt-make-fs --partition input.tar ...\n"
28386 #: ../tools/virt-make-fs.pl:265
28388 "would cause virt-make-fs to think you wanted to use a partition type of "
28389 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28390 "dash) between options and the input file argument:"
28394 #: ../tools/virt-make-fs.pl:269
28397 " virt-make-fs --partition -- input.tar ...\n"
28402 #: ../tools/virt-make-fs.pl:536
28404 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28405 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
28406 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28410 #: ../tools/virt-make-fs.pl:553
28413 " export LIBGUESTFS_DEBUG=1\n"
28414 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28419 #: ../tools/virt-make-fs.pl:556
28421 "Attach /tmp/virt-make-fs.log to a new bug report at "
28422 "L<https://bugzilla.redhat.com/>"
28426 #: ../tools/virt-list-partitions.pl:32
28427 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28431 #: ../tools/virt-list-partitions.pl:36
28434 " virt-list-partitions [--options] domname\n"
28439 #: ../tools/virt-list-partitions.pl:38
28442 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28447 #: ../tools/virt-list-partitions.pl:45
28449 "C<virt-list-partitions> is a command line tool to list the partitions that "
28450 "are contained in a virtual machine or disk image. It is mainly useful as a "
28451 "first step to using L<virt-resize(1)>."
28455 #: ../tools/virt-list-partitions.pl:50
28457 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28458 "functionality. For more complex cases you should look at the "
28459 "L<guestfish(1)> tool."
28463 #: ../tools/virt-list-partitions.pl:107
28464 msgid "B<-h> | B<--human-readable>"
28468 #: ../tools/virt-list-partitions.pl:109
28469 msgid "Show sizes in human-readable form (eg. \"1G\")."
28473 #: ../tools/virt-list-partitions.pl:117
28475 "With this option, C<virt-list-partitions> displays the type and size of each "
28476 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28480 #: ../tools/virt-list-partitions.pl:124
28481 msgid "B<-t> | B<--total>"
28485 #: ../tools/virt-list-partitions.pl:126
28486 msgid "Display the total size of each block device (as a separate row or rows)."
28490 #: ../tools/virt-list-partitions.pl:259
28492 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
28493 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
28494 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."