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.23\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-12-12 21:33+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=utf-8\n"
17 "Content-Transfer-Encoding: ENCODING"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
40 #: ../src/guestfs.pod:9
43 " #include <guestfs.h>\n"
48 #: ../src/guestfs.pod:11
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_close (g);\n"
62 #: ../src/guestfs.pod:19
65 " cc prog.c -o prog -lguestfs\n"
67 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
72 #: ../src/guestfs.pod:23 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
77 #: ../src/guestfs.pod:25
79 "Libguestfs is a library for accessing and modifying guest disk images. "
80 "Amongst the things this is good for: making batch configuration changes to "
81 "guests, getting disk used/free statistics (see also: virt-df), migrating "
82 "between virtualization systems (see also: virt-p2v), performing partial "
83 "backups, performing partial guest clones, cloning guests and changing "
84 "registry/UUID/hostname info, and much else besides."
88 #: ../src/guestfs.pod:33
90 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
91 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
92 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
97 #: ../src/guestfs.pod:38
99 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
100 "what filesystem is in each LV, etc.). It can also run commands in the "
101 "context of the guest. Also you can access filesystems over FUSE."
105 #: ../src/guestfs.pod:43
107 "Libguestfs is a library that can be linked with C and C++ management "
108 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
109 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
114 #: ../src/guestfs.pod:48
116 "You don't need to be root to use libguestfs, although obviously you do need "
117 "enough permissions to access the disk images."
121 #: ../src/guestfs.pod:51
123 "Libguestfs is a large API because it can do many things. For a gentle "
124 "introduction, please read the L</API OVERVIEW> section next."
128 #: ../src/guestfs.pod:54
130 "There are also some example programs in the L<guestfs-examples(3)> manual "
135 #: ../src/guestfs.pod:57
140 #: ../src/guestfs.pod:59
142 "This section provides a gentler overview of the libguestfs API. We also try "
143 "to group API calls together, where that may not be obvious from reading "
144 "about the individual calls in the main section of this manual."
148 #: ../src/guestfs.pod:64
153 #: ../src/guestfs.pod:66
155 "Before you can use libguestfs calls, you have to create a handle. Then you "
156 "must add at least one disk image to the handle, followed by launching the "
157 "handle, then performing whatever operations you want, and finally closing "
158 "the handle. By convention we use the single letter C<g> for the name of the "
159 "handle variable, although of course you can use any name you want."
163 #: ../src/guestfs.pod:73
164 msgid "The general structure of all libguestfs-using programs looks like this:"
168 #: ../src/guestfs.pod:76
171 " guestfs_h *g = guestfs_create ();\n"
176 #: ../src/guestfs.pod:78
179 " /* Call guestfs_add_drive additional times if there are\n"
180 " * multiple disk images.\n"
182 " guestfs_add_drive (g, \"guest.img\");\n"
187 #: ../src/guestfs.pod:83
190 " /* Most manipulation calls won't work until you've launched\n"
191 " * the handle 'g'. You have to do this _after_ adding drives\n"
192 " * and _before_ other commands.\n"
194 " guestfs_launch (g);\n"
199 #: ../src/guestfs.pod:89
202 " /* Now you can examine what partitions, LVs etc are available.\n"
204 " char **partitions = guestfs_list_partitions (g);\n"
205 " char **logvols = guestfs_lvs (g);\n"
210 #: ../src/guestfs.pod:94
213 " /* To access a filesystem in the image, you must mount it.\n"
215 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
220 #: ../src/guestfs.pod:98
223 " /* Now you can perform filesystem actions on the guest\n"
226 " guestfs_touch (g, \"/hello\");\n"
231 #: ../src/guestfs.pod:103
234 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
235 " * it is done automatically when you close the handle. See\n"
236 " * discussion of autosync in this page.\n"
238 " guestfs_sync (g);\n"
243 #: ../src/guestfs.pod:109
246 " /* Close the handle 'g'. */\n"
247 " guestfs_close (g);\n"
252 #: ../src/guestfs.pod:112
254 "The code above doesn't include any error checking. In real code you should "
255 "check return values carefully for errors. In general all functions that "
256 "return integers return C<-1> on error, and all functions that return "
257 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
258 "how to handle errors, and consult the documentation for each function call "
259 "below to see precisely how they return error indications. See "
260 "L<guestfs-examples(3)> for fully worked examples."
264 #: ../src/guestfs.pod:121
269 #: ../src/guestfs.pod:123
271 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
272 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
273 "actual block device, or simply an empty file of zeroes that you have created "
274 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
279 #: ../src/guestfs.pod:129
281 "The call you should use in modern code for adding drives is "
282 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
283 "specifying that the format is raw, do:"
287 #: ../src/guestfs.pod:133
290 " guestfs_add_drive_opts (g, filename,\n"
291 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
297 #: ../src/guestfs.pod:137
298 msgid "You can add a disk read-only using:"
302 #: ../src/guestfs.pod:139
305 " guestfs_add_drive_opts (g, filename,\n"
306 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
307 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
313 #: ../src/guestfs.pod:144
315 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
316 "libguestfs won't modify the file."
320 #: ../src/guestfs.pod:147
322 "Be extremely cautious if the disk image is in use, eg. if it is being used "
323 "by a virtual machine. Adding it read-write will almost certainly cause disk "
324 "corruption, but adding it read-only is safe."
328 #: ../src/guestfs.pod:151
330 "You must add at least one disk image, and you may add multiple disk images. "
331 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
332 "first one you added), C</dev/sdb> (for the second one you added), etc."
336 #: ../src/guestfs.pod:156
338 "Once L</guestfs_launch> has been called you cannot add any more images. You "
339 "can call L</guestfs_list_devices> to get a list of the device names, in the "
340 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
344 #: ../src/guestfs.pod:161
349 #: ../src/guestfs.pod:163
351 "Before you can read or write files, create directories and so on in a disk "
352 "image that contains filesystems, you have to mount those filesystems using "
353 "L</guestfs_mount>. If you already know that a disk image contains (for "
354 "example) one partition with a filesystem on that partition, then you can "
359 #: ../src/guestfs.pod:169
362 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
367 #: ../src/guestfs.pod:171
369 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
370 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
371 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
375 #: ../src/guestfs.pod:175
377 "If you are given a disk image and you don't know what it contains then you "
378 "have to find out. Libguestfs can do that too: use "
379 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
380 "and LVs, and either try mounting each to see what is mountable, or else "
381 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also "
382 "has a set of APIs for inspection of disk images (see L</INSPECTION> below). "
383 "But you might find it easier to look at higher level programs built on top "
384 "of libguestfs, in particular L<virt-inspector(1)>."
388 #: ../src/guestfs.pod:185
390 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
391 "several other variations of the C<guestfs_mount_*> call."
395 #: ../src/guestfs.pod:188
396 msgid "FILESYSTEM ACCESS AND MODIFICATION"
400 #: ../src/guestfs.pod:190
402 "The majority of the libguestfs API consists of fairly low-level calls for "
403 "accessing and modifying the files, directories, symlinks etc on mounted "
404 "filesystems. There are over a hundred such calls which you can find listed "
405 "in detail below in this man page, and we don't even pretend to cover them "
406 "all in this overview."
410 #: ../src/guestfs.pod:196
412 "Specify filenames as full paths, starting with C<\"/\"> and including the "
417 #: ../src/guestfs.pod:199
419 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
420 "the file called C<\"etc/passwd\"> then you could do:"
424 #: ../src/guestfs.pod:202
427 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
432 #: ../src/guestfs.pod:204
434 "This would return C<data> as a newly allocated buffer containing the full "
435 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
436 "or C<NULL> if there was an error."
440 #: ../src/guestfs.pod:208
442 "As another example, to create a top-level directory on that filesystem "
443 "called C<\"var\"> you would do:"
447 #: ../src/guestfs.pod:211
450 " guestfs_mkdir (g, \"/var\");\n"
455 #: ../src/guestfs.pod:213
456 msgid "To create a symlink you could do:"
460 #: ../src/guestfs.pod:215
463 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
464 " \"/etc/rc3.d/S30portmap\");\n"
469 #: ../src/guestfs.pod:218
471 "Libguestfs will reject attempts to use relative paths and there is no "
472 "concept of a current working directory."
476 #: ../src/guestfs.pod:221
478 "Libguestfs can return errors in many situations: for example if the "
479 "filesystem isn't writable, or if a file or directory that you requested "
480 "doesn't exist. If you are using the C API (documented here) you have to "
481 "check for those error conditions after each call. (Other language bindings "
482 "turn these errors into exceptions)."
486 #: ../src/guestfs.pod:227
488 "File writes are affected by the per-handle umask, set by calling "
489 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
493 #: ../src/guestfs.pod:230
498 #: ../src/guestfs.pod:232
500 "Libguestfs contains API calls to read, create and modify partition tables on "
505 #: ../src/guestfs.pod:235
507 "In the common case where you want to create a single partition covering the "
508 "whole disk, you should use the L</guestfs_part_disk> call:"
512 #: ../src/guestfs.pod:239
515 " const char *parttype = \"mbr\";\n"
516 " if (disk_is_larger_than_2TB)\n"
517 " parttype = \"gpt\";\n"
518 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
523 #: ../src/guestfs.pod:244
525 "Obviously this effectively wipes anything that was on that disk image "
530 #: ../src/guestfs.pod:247
535 #: ../src/guestfs.pod:249
537 "Libguestfs provides access to a large part of the LVM2 API, such as "
538 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
539 "unless you familiarize yourself with the concepts of physical volumes, "
540 "volume groups and logical volumes."
544 #: ../src/guestfs.pod:254
546 "This author strongly recommends reading the LVM HOWTO, online at "
547 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
551 #: ../src/guestfs.pod:257
556 #: ../src/guestfs.pod:259
558 "Use L</guestfs_cat> to download small, text only files. This call is "
559 "limited to files which are less than 2 MB and which cannot contain any ASCII "
560 "NUL (C<\\0>) characters. However it has a very simple to use API."
564 #: ../src/guestfs.pod:264
566 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
567 "bit data, since it returns a (pointer, size) pair. However it is still "
568 "limited to \"small\" files, less than 2 MB."
572 #: ../src/guestfs.pod:268
574 "L</guestfs_download> can be used to download any file, with no limits on "
575 "content or size (even files larger than 4 GB)."
579 #: ../src/guestfs.pod:271
580 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
584 #: ../src/guestfs.pod:274
589 #: ../src/guestfs.pod:276
591 "It's often the case that you want to write a file or files to the disk "
596 #: ../src/guestfs.pod:279
598 "To write a small file with fixed content, use L</guestfs_write>. To create "
599 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
600 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
601 "variety of other functions for creating test files, for example "
602 "L</guestfs_fill> and L</guestfs_fill_pattern>."
606 #: ../src/guestfs.pod:285
608 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
609 "file content or size (even files larger than 4 GB)."
613 #: ../src/guestfs.pod:288
614 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
618 #: ../src/guestfs.pod:290
620 "However the fastest way to upload I<large numbers of arbitrary files> is to "
621 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
622 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
623 "the drive in a predictable way (eg. adding it last after all other drives) "
624 "then you can get the device name from L</guestfs_list_devices> and mount it "
625 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
626 "sometimes non-portable between kernel versions, and they don't support "
627 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
628 "using a label or UUID, use an ISO image instead."
632 #: ../src/guestfs.pod:301
637 #: ../src/guestfs.pod:303
639 "There are various different commands for copying between files and devices "
640 "and in and out of the guest filesystem. These are summarised in the table "
645 #: ../src/guestfs.pod:309
646 msgid "B<file> to B<file>"
650 #: ../src/guestfs.pod:311
652 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
653 "directories recursively."
657 #: ../src/guestfs.pod:314
658 msgid "B<file or device> to B<file or device>"
662 #: ../src/guestfs.pod:316
664 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
665 "devices in the guest."
669 #: ../src/guestfs.pod:319
670 msgid "Example: duplicate the contents of an LV:"
674 #: ../src/guestfs.pod:321
677 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
682 #: ../src/guestfs.pod:323
684 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
685 "(C</dev/VG/Original>). To copy less than the whole source device, use "
686 "L</guestfs_copy_size>."
690 #: ../src/guestfs.pod:327
691 msgid "B<file on the host> to B<file or device>"
695 #: ../src/guestfs.pod:329
696 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
700 #: ../src/guestfs.pod:331
701 msgid "B<file or device> to B<file on the host>"
705 #: ../src/guestfs.pod:333
706 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
710 #: ../src/guestfs.pod:337
711 msgid "LISTING FILES"
715 #: ../src/guestfs.pod:339
717 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
718 "L<guestfish(1)>-equivalent command C<ll>)."
722 #: ../src/guestfs.pod:342
724 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
725 "programs, as a flat list of strings."
729 #: ../src/guestfs.pod:345
731 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
732 "directory, plus additional information about each one. It is more "
733 "equivalent to using the L<readdir(3)> call on a local filesystem."
737 #: ../src/guestfs.pod:349
739 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
744 #: ../src/guestfs.pod:352
745 msgid "RUNNING COMMANDS"
749 #: ../src/guestfs.pod:354
751 "Although libguestfs is primarily an API for manipulating files inside guest "
752 "images, we also provide some limited facilities for running commands inside "
757 #: ../src/guestfs.pod:358
758 msgid "There are many limitations to this:"
762 #: ../src/guestfs.pod:362 ../src/guestfs.pod:367 ../src/guestfs.pod:372 ../src/guestfs.pod:376 ../src/guestfs.pod:381 ../src/guestfs.pod:385 ../src/guestfs.pod:390 ../src/guestfs.pod:395 ../src/guestfs.pod:954 ../src/guestfs.pod:958 ../src/guestfs.pod:962 ../src/guestfs.pod:967 ../src/guestfs.pod:975 ../src/guestfs.pod:994 ../src/guestfs.pod:1002 ../src/guestfs.pod:1024 ../src/guestfs.pod:1028 ../src/guestfs.pod:1032 ../src/guestfs.pod:1036 ../src/guestfs.pod:1040 ../src/guestfs.pod:1044 ../src/guestfs.pod:1526 ../src/guestfs.pod:1531 ../src/guestfs.pod:1535 ../src/guestfs.pod:1645 ../src/guestfs.pod:1650 ../src/guestfs.pod:1654 ../src/guestfs.pod:2006 ../src/guestfs.pod:2012 ../src/guestfs.pod:2017 ../src/guestfs.pod:2023 ../src/guestfs.pod:2135 ../src/guestfs.pod:2139 ../src/guestfs.pod:2143 ../src/guestfs.pod:2147 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:427 ../fish/guestfish.pod:431 ../fish/guestfish.pod:435 ../fish/guestfish.pod:439 ../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-win-reg.pl:536 ../tools/virt-win-reg.pl:542 ../tools/virt-win-reg.pl:548 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
767 #: ../src/guestfs.pod:364
769 "The kernel version that the command runs under will be different from what "
774 #: ../src/guestfs.pod:369
776 "If the command needs to communicate with daemons, then most likely they "
781 #: ../src/guestfs.pod:374
782 msgid "The command will be running in limited memory."
786 #: ../src/guestfs.pod:378
788 "The network may not be available unless you enable it (see "
789 "L</guestfs_set_network>)."
793 #: ../src/guestfs.pod:383
794 msgid "Only supports Linux guests (not Windows, BSD, etc)."
798 #: ../src/guestfs.pod:387
799 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
803 #: ../src/guestfs.pod:392
805 "For SELinux guests, you may need to enable SELinux and load policy first. "
806 "See L</SELINUX> in this manpage."
810 #: ../src/guestfs.pod:397
812 "I<Security:> It is not safe to run commands from untrusted, possibly "
813 "malicious guests. These commands may attempt to exploit your program by "
814 "sending unexpected output. They could also try to exploit the Linux kernel "
815 "or qemu provided by the libguestfs appliance. They could use the network "
816 "provided by the libguestfs appliance to bypass ordinary network partitions "
817 "and firewalls. They could use the elevated privileges or different SELinux "
818 "context of your program to their advantage."
822 #: ../src/guestfs.pod:406
824 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
825 "(a script which runs when the guest next boots normally), and to have this "
826 "script run the commands you want in the normal context of the running guest, "
827 "network security and so on. For information about other security issues, "
832 #: ../src/guestfs.pod:414
834 "The two main API calls to run commands are L</guestfs_command> and "
835 "L</guestfs_sh> (there are also variations)."
839 #: ../src/guestfs.pod:417
841 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
842 "shell globs, redirections, etc will work."
846 #: ../src/guestfs.pod:420
847 msgid "CONFIGURATION FILES"
851 #: ../src/guestfs.pod:422
853 "To read and write configuration files in Linux guest filesystems, we "
854 "strongly recommend using Augeas. For example, Augeas understands how to "
855 "read and write, say, a Linux shadow password file or X.org configuration "
856 "file, and so avoids you having to write that code."
860 #: ../src/guestfs.pod:427
862 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
863 "document Augeas itself here because there is excellent documentation on the "
864 "L<http://augeas.net/> website."
868 #: ../src/guestfs.pod:431
870 "If you don't want to use Augeas (you fool!) then try calling "
871 "L</guestfs_read_lines> to get the file as a list of lines which you can "
876 #: ../src/guestfs.pod:435
881 #: ../src/guestfs.pod:437
883 "We support SELinux guests. To ensure that labeling happens correctly in "
884 "SELinux guests, you need to enable SELinux and load the guest's policy:"
888 #: ../src/guestfs.pod:443 ../src/guestfs.pod:1147 ../src/guestfs.pod:1278
893 #: ../src/guestfs.pod:445
894 msgid "Before launching, do:"
898 #: ../src/guestfs.pod:447
901 " guestfs_set_selinux (g, 1);\n"
906 #: ../src/guestfs.pod:449 ../src/guestfs.pod:1151 ../src/guestfs.pod:1282
911 #: ../src/guestfs.pod:451
913 "After mounting the guest's filesystem(s), load the policy. This is best "
914 "done by running the L<load_policy(8)> command in the guest itself:"
918 #: ../src/guestfs.pod:455
921 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
926 #: ../src/guestfs.pod:457
928 "(Older versions of C<load_policy> require you to specify the name of the "
933 #: ../src/guestfs.pod:460 ../src/guestfs.pod:1288
938 #: ../src/guestfs.pod:462
940 "Optionally, set the security context for the API. The correct security "
941 "context to use can only be known by inspecting the guest. As an example:"
945 #: ../src/guestfs.pod:466
948 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
953 #: ../src/guestfs.pod:470
954 msgid "This will work for running commands and editing existing files."
958 #: ../src/guestfs.pod:472
960 "When new files are created, you may need to label them explicitly, for "
961 "example by running the external command C<restorecon pathname>."
965 #: ../src/guestfs.pod:476
970 #: ../src/guestfs.pod:478
972 "Certain calls are affected by the current file mode creation mask (the "
973 "\"umask\"). In particular ones which create files or directories, such as "
974 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
975 "either the default mode that the file is created with or modifies the mode "
980 #: ../src/guestfs.pod:484
982 "The default umask is C<022>, so files are created with modes such as C<0644> "
983 "and directories with C<0755>."
987 #: ../src/guestfs.pod:487
989 "There are two ways to avoid being affected by umask. Either set umask to 0 "
990 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
991 "L</guestfs_chmod> after creating each file or directory."
995 #: ../src/guestfs.pod:491
996 msgid "For more information about umask, see L<umask(2)>."
1000 #: ../src/guestfs.pod:493 ../fish/guestfish.pod:720
1001 msgid "ENCRYPTED DISKS"
1005 #: ../src/guestfs.pod:495
1007 "Libguestfs allows you to access Linux guests which have been encrypted using "
1008 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1009 "standard. This includes nearly all whole disk encryption systems used by "
1010 "modern Linux guests."
1014 #: ../src/guestfs.pod:501
1016 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1017 "returns the string C<crypto_LUKS>)."
1021 #: ../src/guestfs.pod:504
1023 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1024 "will require the passphrase!"
1028 #: ../src/guestfs.pod:507
1030 "Opening a LUKS device creates a new device mapper device called "
1031 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1032 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1033 "decrypted from and encrypted to the underlying block device respectively."
1037 #: ../src/guestfs.pod:513
1039 "LVM volume groups on the device can be made visible by calling "
1040 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1041 "volume(s) can now be mounted in the usual way."
1045 #: ../src/guestfs.pod:517
1047 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1048 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1049 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1050 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1051 "underlying encrypted block device)."
1055 #: ../src/guestfs.pod:524
1060 #: ../src/guestfs.pod:526
1062 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1063 "contains operating systems. (These APIs used to be in a separate Perl-only "
1064 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1065 "frequently used part of this library has been rewritten in C and moved into "
1070 #: ../src/guestfs.pod:532
1072 "Add all disks belonging to the unknown virtual machine and call "
1073 "L</guestfs_launch> in the usual way."
1077 #: ../src/guestfs.pod:535
1079 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1080 "and certain heuristics, and returns a list of operating systems that were "
1081 "found. An empty list means none were found. A single element is the root "
1082 "filesystem of the operating system. For dual- or multi-boot guests, "
1083 "multiple roots can be returned, each one corresponding to a separate "
1084 "operating system. (Multi-boot virtual machines are extremely rare in the "
1085 "world of virtualization, but since this scenario can happen, we have built "
1086 "libguestfs to deal with it.)"
1090 #: ../src/guestfs.pod:544
1092 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1093 "to get additional details about that operating system. For example, call "
1094 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1095 "Windows and Linux-based operating systems respectively."
1099 #: ../src/guestfs.pod:550
1101 "Un*x-like and Linux-based operating systems usually consist of several "
1102 "filesystems which are mounted at boot time (for example, a separate boot "
1103 "partition mounted on C</boot>). The inspection rules are able to detect how "
1104 "filesystems correspond to mount points. Call "
1105 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1106 "hash table like this example:"
1110 #: ../src/guestfs.pod:557
1113 " /boot => /dev/sda1\n"
1114 " / => /dev/vg_guest/lv_root\n"
1115 " /usr => /dev/vg_guest/lv_usr\n"
1120 #: ../src/guestfs.pod:561
1122 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1123 "filesystems as suggested."
1127 #: ../src/guestfs.pod:564
1129 "Be careful to mount filesystems in the right order (eg. C</> before "
1130 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1135 #: ../src/guestfs.pod:568
1137 "Inspection currently only works for some common operating systems. "
1138 "Contributors are welcome to send patches for other operating systems that we "
1139 "currently cannot detect."
1143 #: ../src/guestfs.pod:572
1145 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1146 "for more details. The L</guestfs_inspect_os> function just ignores any "
1147 "encrypted devices."
1151 #: ../src/guestfs.pod:576
1153 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1154 "inspection and caches the results in the guest handle. Subsequent calls to "
1155 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1156 "re-read the disks. If you change the content of the guest disks, you can "
1157 "redo inspection by calling L</guestfs_inspect_os> again. "
1158 "(L</guestfs_inspect_list_applications> works a little differently from the "
1159 "other calls and does read the disks. See documentation for that function "
1164 #: ../src/guestfs.pod:585
1165 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1169 #: ../src/guestfs.pod:587
1171 "Libguestfs can mount NTFS partitions. It does this using the "
1172 "L<http://www.ntfs-3g.org/> driver."
1176 #: ../src/guestfs.pod:590
1178 "DOS and Windows still use drive letters, and the filesystems are always "
1179 "treated as case insensitive by Windows itself, and therefore you might find "
1180 "a Windows configuration file referring to a path like "
1181 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1182 "that directory might be referred to as C</WINDOWS/System32>."
1186 #: ../src/guestfs.pod:596
1188 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1189 "libguestfs to read the appropriate Windows Registry and configuration files, "
1190 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1191 "L<virt-inspector(1)>)."
1195 #: ../src/guestfs.pod:601
1197 "Replacing backslash characters with forward slash characters is also outside "
1198 "the scope of libguestfs, but something that you can easily do."
1202 #: ../src/guestfs.pod:604
1204 "Where we can help is in resolving the case insensitivity of paths. For "
1205 "this, call L</guestfs_case_sensitive_path>."
1209 #: ../src/guestfs.pod:607
1211 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1212 "files, through the library C<hivex> which is part of the libguestfs project "
1213 "although ships as a separate tarball. You have to locate and download the "
1214 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1215 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1216 "L<virt-win-reg(1)> for more help on this issue."
1220 #: ../src/guestfs.pod:615
1221 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1225 #: ../src/guestfs.pod:617
1227 "Although we don't want to discourage you from using the C API, we will "
1228 "mention here that the same API is also available in other languages."
1232 #: ../src/guestfs.pod:620
1234 "The API is broadly identical in all supported languages. This means that "
1235 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1236 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1237 "words, a straightforward, predictable isomorphism between each language."
1241 #: ../src/guestfs.pod:626
1243 "Error messages are automatically transformed into exceptions if the language "
1248 #: ../src/guestfs.pod:629
1250 "We don't try to \"object orientify\" parts of the API in OO languages, "
1251 "although contributors are welcome to write higher level APIs above what we "
1252 "provide in their favourite languages if they wish."
1256 #: ../src/guestfs.pod:635
1261 #: ../src/guestfs.pod:637
1263 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1264 "identical to the C API. C++ classes and exceptions are not used."
1268 #: ../src/guestfs.pod:641
1273 #: ../src/guestfs.pod:643
1275 "The C# bindings are highly experimental. Please read the warnings at the "
1276 "top of C<csharp/Libguestfs.cs>."
1280 #: ../src/guestfs.pod:646
1285 #: ../src/guestfs.pod:648
1287 "This is the only language binding that is working but incomplete. Only "
1288 "calls which return simple integers have been bound in Haskell, and we are "
1289 "looking for help to complete this binding."
1293 #: ../src/guestfs.pod:652
1298 #: ../src/guestfs.pod:654
1300 "Full documentation is contained in the Javadoc which is distributed with "
1305 #: ../src/guestfs.pod:657
1310 #: ../src/guestfs.pod:659
1311 msgid "For documentation see L<guestfs-ocaml(3)>."
1315 #: ../src/guestfs.pod:661
1320 #: ../src/guestfs.pod:663
1321 msgid "For documentation see L<Sys::Guestfs(3)>."
1325 #: ../src/guestfs.pod:665
1330 #: ../src/guestfs.pod:667
1332 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1333 "the php-libguestfs package for your distribution."
1337 #: ../src/guestfs.pod:670
1338 msgid "The PHP binding only works correctly on 64 bit machines."
1342 #: ../src/guestfs.pod:672
1347 #: ../src/guestfs.pod:674
1348 msgid "For documentation see L<guestfs-python(3)>."
1352 #: ../src/guestfs.pod:676
1357 #: ../src/guestfs.pod:678
1358 msgid "For documentation see L<guestfs-ruby(3)>."
1362 #: ../src/guestfs.pod:680
1363 msgid "B<shell scripts>"
1367 #: ../src/guestfs.pod:682
1368 msgid "For documentation see L<guestfish(1)>."
1372 #: ../src/guestfs.pod:686
1373 msgid "LIBGUESTFS GOTCHAS"
1377 #: ../src/guestfs.pod:688
1379 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1380 "system [...] that works in the way it is documented but is counterintuitive "
1381 "and almost invites mistakes.\""
1385 #: ../src/guestfs.pod:692
1387 "Since we developed libguestfs and the associated tools, there are several "
1388 "things we would have designed differently, but are now stuck with for "
1389 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1390 "release, you can expect these to change. Beware of them."
1394 #: ../src/guestfs.pod:700
1395 msgid "Autosync / forgetting to sync."
1399 #: ../src/guestfs.pod:702
1401 "When modifying a filesystem from C or another language, you B<must> unmount "
1402 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1403 "libguestfs handle. You can also call:"
1407 #: ../src/guestfs.pod:706
1410 " guestfs_set_autosync (g, 1);\n"
1415 #: ../src/guestfs.pod:708
1417 "to have the unmount/sync done automatically for you when the handle 'g' is "
1418 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1423 #: ../src/guestfs.pod:712
1425 "If you forget to do this, then it is entirely possible that your changes "
1426 "won't be written out, or will be partially written, or (very rarely) that "
1427 "you'll get disk corruption."
1431 #: ../src/guestfs.pod:716
1433 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1434 "guestfish scripts that forget to sync will work just fine, which can make "
1435 "this very puzzling if you are trying to debug a problem."
1439 #: ../src/guestfs.pod:720
1441 "Update: Autosync is enabled by default for all API users starting from "
1442 "libguestfs 1.5.24."
1446 #: ../src/guestfs.pod:723
1447 msgid "Mount option C<-o sync> should not be the default."
1451 #: ../src/guestfs.pod:725
1453 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1454 "However C<-o sync> does not add any reliability benefit, but does have a "
1455 "very large performance impact."
1459 #: ../src/guestfs.pod:729
1461 "The work around is to use L</guestfs_mount_options> and set the mount "
1462 "options that you actually want to use."
1466 #: ../src/guestfs.pod:732
1467 msgid "Read-only should be the default."
1471 #: ../src/guestfs.pod:734
1473 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1474 "specify I<--rw> if you want to make changes to the image."
1478 #: ../src/guestfs.pod:737
1479 msgid "This would reduce the potential to corrupt live VM images."
1483 #: ../src/guestfs.pod:739
1485 "Note that many filesystems change the disk when you just mount and unmount, "
1486 "even if you didn't perform any writes. You need to use "
1487 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1491 #: ../src/guestfs.pod:743
1492 msgid "guestfish command line is hard to use."
1496 #: ../src/guestfs.pod:745
1498 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1499 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1500 "exist, so it fails. In earlier versions of guestfish the error message was "
1501 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1502 "we should have used C<guestfish -c command> to run commands."
1506 #: ../src/guestfs.pod:752
1507 msgid "guestfish megabyte modifiers don't work right on all commands"
1511 #: ../src/guestfs.pod:754
1513 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1514 "other modifiers). What guestfish actually does is to multiply the number "
1515 "part by the modifier part and pass the result to the C API. However this "
1516 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1517 "expecting some other unit (eg. megabytes)."
1521 #: ../src/guestfs.pod:761
1522 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1526 #: ../src/guestfs.pod:763
1529 " lvcreate LV VG 100M\n"
1534 #: ../src/guestfs.pod:765
1536 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1537 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1538 "megabytes * megabytes) logical volume. The error message you get from this "
1539 "is also a little obscure."
1543 #: ../src/guestfs.pod:770
1545 "This could be fixed in the generator by specially marking parameters and "
1546 "return values which take bytes or other units."
1550 #: ../src/guestfs.pod:773
1551 msgid "Ambiguity between devices and paths"
1555 #: ../src/guestfs.pod:775
1557 "There is a subtle ambiguity in the API between a device name "
1558 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1559 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1563 #: ../src/guestfs.pod:780
1565 "In the current API we usually resolve this ambiguity by having two separate "
1566 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1567 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1568 "detecting if the path supplied begins with C</dev/>."
1572 #: ../src/guestfs.pod:786
1574 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1575 "make paths/devices into structured names. One way to do this would be to "
1576 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1577 "aspect of grub. Another way would be to use a structured type, equivalent "
1578 "to this OCaml type:"
1582 #: ../src/guestfs.pod:792
1585 " type path = Path of string | Device of int | Partition of int * int\n"
1590 #: ../src/guestfs.pod:794
1591 msgid "which would allow you to pass arguments like:"
1595 #: ../src/guestfs.pod:796
1598 " Path \"/foo/bar\"\n"
1599 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1600 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1601 " Path \"/dev/sdb2\" (* not a device *)\n"
1606 #: ../src/guestfs.pod:801
1608 "As you can see there are still problems to resolve even with this "
1609 "representation. Also consider how it might work in guestfish."
1613 #: ../src/guestfs.pod:806
1614 msgid "PROTOCOL LIMITS"
1618 #: ../src/guestfs.pod:808
1620 "Internally libguestfs uses a message-based protocol to pass API calls and "
1621 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1622 "plenty more detail about this). The maximum message size used by the "
1623 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1624 "aware of this limit. The API calls which may be affected are individually "
1625 "documented, with a link back to this section of the documentation."
1629 #: ../src/guestfs.pod:816
1631 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1632 "a simple string. Because this string is at some point internally encoded as "
1633 "a message, the maximum size that it can return is slightly under 4 MB. If "
1634 "the requested file is larger than this then you will get an error."
1638 #: ../src/guestfs.pod:822
1640 "In order to transfer large files into and out of the guest filesystem, you "
1641 "need to use particular calls that support this. The sections L</UPLOADING> "
1642 "and L</DOWNLOADING> document how to do this."
1646 #: ../src/guestfs.pod:826
1648 "You might also consider mounting the disk image using our FUSE filesystem "
1649 "support (L<guestmount(1)>)."
1653 #: ../src/guestfs.pod:829
1654 msgid "KEYS AND PASSPHRASES"
1658 #: ../src/guestfs.pod:831
1660 "Certain libguestfs calls take a parameter that contains sensitive key "
1661 "material, passed in as a C string."
1665 #: ../src/guestfs.pod:834
1667 "In the future we would hope to change the libguestfs implementation so that "
1668 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1669 "swap. However this is I<not> done at the moment, because of the complexity "
1670 "of such an implementation."
1674 #: ../src/guestfs.pod:839
1676 "Therefore you should be aware that any key parameter you pass to libguestfs "
1677 "might end up being written out to the swap partition. If this is a concern, "
1678 "scrub the swap partition or don't use libguestfs on encrypted devices."
1682 #: ../src/guestfs.pod:844
1683 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1687 #: ../src/guestfs.pod:846
1689 "All high-level libguestfs actions are synchronous. If you want to use "
1690 "libguestfs asynchronously then you must create a thread."
1694 #: ../src/guestfs.pod:849
1696 "Only use the handle from a single thread. Either use the handle exclusively "
1697 "from one thread, or provide your own mutex so that two threads cannot issue "
1698 "calls on the same handle at the same time."
1702 #: ../src/guestfs.pod:853
1704 "See the graphical program guestfs-browser for one possible architecture for "
1705 "multithreaded programs using libvirt and libguestfs."
1709 #: ../src/guestfs.pod:856
1714 #: ../src/guestfs.pod:858
1716 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1721 #: ../src/guestfs.pod:861
1723 "By default it looks for these in the directory C<$libdir/guestfs> "
1724 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1728 #: ../src/guestfs.pod:864
1730 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1731 "to change the directories that libguestfs will search in. The value is a "
1732 "colon-separated list of paths. The current directory is I<not> searched "
1733 "unless the path contains an empty element or C<.>. For example "
1734 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1735 "then C</usr/lib/guestfs>."
1739 #: ../src/guestfs.pod:871
1740 msgid "QEMU WRAPPERS"
1744 #: ../src/guestfs.pod:873
1746 "If you want to compile your own qemu, run qemu from a non-standard location, "
1747 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1752 #: ../src/guestfs.pod:877
1754 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1755 "last command in the shell script (so that qemu replaces the shell and "
1756 "becomes the direct child of the libguestfs-using program). If you don't do "
1757 "this, then the qemu process won't be cleaned up correctly."
1761 #: ../src/guestfs.pod:882
1763 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1768 #: ../src/guestfs.pod:885
1772 " qemudir=/home/rjones/d/qemu\n"
1773 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1779 #: ../src/guestfs.pod:889
1781 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1782 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1787 #: ../src/guestfs.pod:893
1790 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1795 #: ../src/guestfs.pod:895
1797 "Note that libguestfs also calls qemu with the -help and -version options in "
1798 "order to determine features."
1802 #: ../src/guestfs.pod:898
1803 msgid "ABI GUARANTEE"
1807 #: ../src/guestfs.pod:900
1809 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1810 "actions as outlined in this section. Although we will deprecate some "
1811 "actions, for example if they get replaced by newer calls, we will keep the "
1812 "old actions forever. This allows you the developer to program in confidence "
1813 "against the libguestfs API."
1817 #: ../src/guestfs.pod:906
1818 msgid "BLOCK DEVICE NAMING"
1822 #: ../src/guestfs.pod:908
1824 "In the kernel there is now quite a profusion of schemata for naming block "
1825 "devices (in this context, by I<block device> I mean a physical or virtual "
1826 "hard drive). The original Linux IDE driver used names starting with "
1827 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1828 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1829 "replacement for the old IDE driver (particularly for SATA devices) those "
1830 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1831 "machines with paravirtualized drivers. This has created several different "
1832 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1837 #: ../src/guestfs.pod:920
1839 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1840 "Linux kernel to access block devices. We can run a variety of appliances "
1841 "based on a variety of Linux kernels."
1845 #: ../src/guestfs.pod:924
1847 "This causes a problem for libguestfs because many API calls use device or "
1848 "partition names. Working scripts and the recipe (example) scripts that we "
1849 "make available over the internet could fail if the naming scheme changes."
1853 #: ../src/guestfs.pod:929
1855 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1856 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1857 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1858 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1862 #: ../src/guestfs.pod:935
1864 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1865 "L</guestfs_list_partitions> and similar calls return the true names of the "
1866 "devices and partitions as known to the appliance."
1870 #: ../src/guestfs.pod:940
1871 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1875 #: ../src/guestfs.pod:942
1877 "Usually this translation is transparent. However in some (very rare) cases "
1878 "you may need to know the exact algorithm. Such cases include where you use "
1879 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1880 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1885 #: ../src/guestfs.pod:948
1887 "The algorithm is applied only to I<parameters> which are known to be either "
1888 "device or partition names. Return values from functions such as "
1889 "L</guestfs_list_devices> are never changed."
1893 #: ../src/guestfs.pod:956
1894 msgid "Is the string a parameter which is a device or partition name?"
1898 #: ../src/guestfs.pod:960
1899 msgid "Does the string begin with C</dev/sd>?"
1903 #: ../src/guestfs.pod:964
1905 "Does the named device exist? If so, we use that device. However if I<not> "
1906 "then we continue with this algorithm."
1910 #: ../src/guestfs.pod:969
1911 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1915 #: ../src/guestfs.pod:971
1916 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1920 #: ../src/guestfs.pod:973
1921 msgid "If that named device exists, use it. If not, continue."
1925 #: ../src/guestfs.pod:977
1926 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1930 #: ../src/guestfs.pod:979
1931 msgid "If that named device exists, use it. If not, return an error."
1935 #: ../src/guestfs.pod:983
1936 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1940 #: ../src/guestfs.pod:985
1942 "Although the standard naming scheme and automatic translation is useful for "
1943 "simple programs and guestfish scripts, for larger programs it is best not to "
1944 "rely on this mechanism."
1948 #: ../src/guestfs.pod:989
1950 "Where possible for maximum future portability programs using libguestfs "
1951 "should use these future-proof techniques:"
1955 #: ../src/guestfs.pod:996
1957 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
1958 "device names, and then use those names directly."
1962 #: ../src/guestfs.pod:999
1963 msgid "Since those device names exist by definition, they will never be translated."
1967 #: ../src/guestfs.pod:1004
1969 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
1970 "filesystem labels."
1974 #: ../src/guestfs.pod:1009
1979 #: ../src/guestfs.pod:1011
1981 "This section discusses security implications of using libguestfs, "
1982 "particularly with untrusted or malicious guests or disk images."
1986 #: ../src/guestfs.pod:1014
1987 msgid "GENERAL SECURITY CONSIDERATIONS"
1991 #: ../src/guestfs.pod:1016
1993 "Be careful with any files or data that you download from a guest (by "
1994 "\"download\" we mean not just the L</guestfs_download> command but any "
1995 "command that reads files, filenames, directories or anything else from a "
1996 "disk image). An attacker could manipulate the data to fool your program "
1997 "into doing the wrong thing. Consider cases such as:"
2001 #: ../src/guestfs.pod:1026
2002 msgid "the data (file etc) not being present"
2006 #: ../src/guestfs.pod:1030
2007 msgid "being present but empty"
2011 #: ../src/guestfs.pod:1034
2012 msgid "being much larger than normal"
2016 #: ../src/guestfs.pod:1038
2017 msgid "containing arbitrary 8 bit data"
2021 #: ../src/guestfs.pod:1042
2022 msgid "being in an unexpected character encoding"
2026 #: ../src/guestfs.pod:1046
2027 msgid "containing homoglyphs."
2031 #: ../src/guestfs.pod:1050
2032 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2036 #: ../src/guestfs.pod:1052
2038 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2039 "(VFS) module can sometimes be escalated into exploits by deliberately "
2040 "creating a malicious, malformed filesystem. These exploits are very severe "
2041 "for two reasons. Firstly there are very many filesystem drivers in the "
2042 "kernel, and many of them are infrequently used and not much developer "
2043 "attention has been paid to the code. Linux userspace helps potential "
2044 "crackers by detecting the filesystem type and automatically choosing the "
2045 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2046 "the administrator. Secondly, a kernel-level exploit is like a local root "
2047 "exploit (worse in some ways), giving immediate and total access to the "
2048 "system right down to the hardware level."
2052 #: ../src/guestfs.pod:1065
2054 "That explains why you should never mount a filesystem from an untrusted "
2055 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2056 "inside a qemu virtual machine, usually running as a non-root user. The "
2057 "attacker would need to write a filesystem which first exploited the kernel, "
2058 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2059 "the libguestfs protocol, and finally to be as serious as the host kernel "
2060 "exploit it would need to escalate its privileges to root. This multi-step "
2061 "escalation, performed by a static piece of data, is thought to be extremely "
2062 "hard to do, although we never say 'never' about security issues."
2066 #: ../src/guestfs.pod:1076
2068 "In any case callers can reduce the attack surface by forcing the filesystem "
2069 "type when mounting (use L</guestfs_mount_vfs>)."
2073 #: ../src/guestfs.pod:1079
2074 msgid "PROTOCOL SECURITY"
2078 #: ../src/guestfs.pod:1081
2080 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2081 "defined upper message size. However a program that uses libguestfs must "
2082 "also take care - for example you can write a program that downloads a binary "
2083 "from a disk image and executes it locally, and no amount of protocol "
2084 "security will save you from the consequences."
2088 #: ../src/guestfs.pod:1087
2089 msgid "INSPECTION SECURITY"
2093 #: ../src/guestfs.pod:1089
2095 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2096 "directly from the guest, and these could contain any 8 bit data. Callers "
2097 "should be careful to escape these before printing them to a structured file "
2098 "(for example, use HTML escaping if creating a web page)."
2102 #: ../src/guestfs.pod:1095
2104 "Guest configuration may be altered in unusual ways by the administrator of "
2105 "the virtual machine, and may not reflect reality (particularly for untrusted "
2106 "or actively malicious guests). For example we parse the hostname from "
2107 "configuration files like C</etc/sysconfig/network> that we find in the "
2108 "guest, but the guest administrator can easily manipulate these files to "
2109 "provide the wrong hostname."
2113 #: ../src/guestfs.pod:1103
2115 "The inspection API parses guest configuration using two external libraries: "
2116 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2117 "designed to be robust in the face of malicious data, although denial of "
2118 "service attacks are still possible, for example with oversized configuration "
2123 #: ../src/guestfs.pod:1109
2124 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2128 #: ../src/guestfs.pod:1111
2130 "Be very cautious about running commands from the guest. By running a "
2131 "command in the guest, you are giving CPU time to a binary that you do not "
2132 "control, under the same user account as the library, albeit wrapped in qemu "
2133 "virtualization. More information and alternatives can be found in the "
2134 "section L</RUNNING COMMANDS>."
2138 #: ../src/guestfs.pod:1117
2139 msgid "CVE-2010-3851"
2143 #: ../src/guestfs.pod:1119
2144 msgid "https://bugzilla.redhat.com/642934"
2148 #: ../src/guestfs.pod:1121
2150 "This security bug concerns the automatic disk format detection that qemu "
2151 "does on disk images."
2155 #: ../src/guestfs.pod:1124
2157 "A raw disk image is just the raw bytes, there is no header. Other disk "
2158 "images like qcow2 contain a special header. Qemu deals with this by looking "
2159 "for one of the known headers, and if none is found then assuming the disk "
2160 "image must be raw."
2164 #: ../src/guestfs.pod:1129
2166 "This allows a guest which has been given a raw disk image to write some "
2167 "other header. At next boot (or when the disk image is accessed by "
2168 "libguestfs) qemu would do autodetection and think the disk image format was, "
2169 "say, qcow2 based on the header written by the guest."
2173 #: ../src/guestfs.pod:1134
2175 "This in itself would not be a problem, but qcow2 offers many features, one "
2176 "of which is to allow a disk image to refer to another image (called the "
2177 "\"backing disk\"). It does this by placing the path to the backing disk "
2178 "into the qcow2 header. This path is not validated and could point to any "
2179 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2180 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2181 "control of the attacker."
2185 #: ../src/guestfs.pod:1142
2186 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2190 #: ../src/guestfs.pod:1149
2191 msgid "You have enabled the network or have opened the disk in write mode."
2195 #: ../src/guestfs.pod:1153
2197 "You are also running untrusted code from the guest (see L</RUNNING "
2202 #: ../src/guestfs.pod:1158
2204 "The way to avoid this is to specify the expected disk format when adding "
2205 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2206 "should always do this if the disk is raw format, and it's a good idea for "
2211 #: ../src/guestfs.pod:1163
2213 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2214 "format is fetched from libvirt and passed through."
2218 #: ../src/guestfs.pod:1166
2220 "For libguestfs tools, use the I<--format> command line parameter as "
2225 #: ../src/guestfs.pod:1169
2226 msgid "CONNECTION MANAGEMENT"
2230 #: ../src/guestfs.pod:1171
2235 #: ../src/guestfs.pod:1173
2237 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2238 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2239 "handle and release all resources used."
2243 #: ../src/guestfs.pod:1177
2245 "For information on using multiple handles and threads, see the section "
2246 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2250 #: ../src/guestfs.pod:1180
2251 msgid "guestfs_create"
2255 #: ../src/guestfs.pod:1182
2258 " guestfs_h *guestfs_create (void);\n"
2263 #: ../src/guestfs.pod:1184
2264 msgid "Create a connection handle."
2268 #: ../src/guestfs.pod:1186
2270 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2271 "on the handle at least once."
2275 #: ../src/guestfs.pod:1189
2277 "This function returns a non-NULL pointer to a handle on success or NULL on "
2282 #: ../src/guestfs.pod:1192
2283 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2287 #: ../src/guestfs.pod:1194
2289 "You may also want to configure error handling for the handle. See L</ERROR "
2290 "HANDLING> section below."
2294 #: ../src/guestfs.pod:1197
2295 msgid "guestfs_close"
2299 #: ../src/guestfs.pod:1199
2302 " void guestfs_close (guestfs_h *g);\n"
2307 #: ../src/guestfs.pod:1201
2308 msgid "This closes the connection handle and frees up all resources used."
2312 #: ../src/guestfs.pod:1203
2313 msgid "ERROR HANDLING"
2317 #: ../src/guestfs.pod:1205
2319 "API functions can return errors. For example, almost all functions that "
2320 "return C<int> will return C<-1> to indicate an error."
2324 #: ../src/guestfs.pod:1208
2326 "Additional information is available for errors: an error message string and "
2327 "optionally an error number (errno) if the thing that failed was a system "
2332 #: ../src/guestfs.pod:1212
2334 "You can get at the additional information about the last error on the handle "
2335 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2336 "up an error handler with L</guestfs_set_error_handler>."
2340 #: ../src/guestfs.pod:1217
2342 "When the handle is created, a default error handler is installed which "
2343 "prints the error message string to C<stderr>. For small short-running "
2344 "command line programs it is sufficient to do:"
2348 #: ../src/guestfs.pod:1221
2351 " if (guestfs_launch (g) == -1)\n"
2352 " exit (EXIT_FAILURE);\n"
2357 #: ../src/guestfs.pod:1224
2359 "since the default error handler will ensure that an error message has been "
2360 "printed to C<stderr> before the program exits."
2364 #: ../src/guestfs.pod:1227
2366 "For other programs the caller will almost certainly want to install an "
2367 "alternate error handler or do error handling in-line like this:"
2371 #: ../src/guestfs.pod:1230
2374 " g = guestfs_create ();\n"
2379 #: ../src/guestfs.pod:1232
2382 " /* This disables the default behaviour of printing errors\n"
2384 " guestfs_set_error_handler (g, NULL, NULL);\n"
2389 #: ../src/guestfs.pod:1236
2392 " if (guestfs_launch (g) == -1) {\n"
2393 " /* Examine the error message and print it etc. */\n"
2394 " char *msg = guestfs_last_error (g);\n"
2395 " int errnum = guestfs_last_errno (g);\n"
2396 " fprintf (stderr, \"%s\\n\", msg);\n"
2403 #: ../src/guestfs.pod:1244
2405 "Out of memory errors are handled differently. The default action is to call "
2406 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2407 "L</guestfs_set_out_of_memory_handler>."
2411 #: ../src/guestfs.pod:1248
2413 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2414 "because there is no handle if this happens there is no way to get additional "
2415 "error information. However L</guestfs_create> is supposed to be a "
2416 "lightweight operation which can only fail because of insufficient memory (it "
2417 "returns NULL in this case)."
2421 #: ../src/guestfs.pod:1254
2422 msgid "guestfs_last_error"
2426 #: ../src/guestfs.pod:1256
2429 " const char *guestfs_last_error (guestfs_h *g);\n"
2434 #: ../src/guestfs.pod:1258
2436 "This returns the last error message that happened on C<g>. If there has not "
2437 "been an error since the handle was created, then this returns C<NULL>."
2441 #: ../src/guestfs.pod:1262
2443 "The lifetime of the returned string is until the next error occurs, or "
2444 "L</guestfs_close> is called."
2448 #: ../src/guestfs.pod:1265
2449 msgid "guestfs_last_errno"
2453 #: ../src/guestfs.pod:1267
2456 " int guestfs_last_errno (guestfs_h *g);\n"
2461 #: ../src/guestfs.pod:1269
2462 msgid "This returns the last error number (errno) that happened on C<g>."
2466 #: ../src/guestfs.pod:1271
2467 msgid "If successful, an errno integer not equal to zero is returned."
2471 #: ../src/guestfs.pod:1273
2472 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2476 #: ../src/guestfs.pod:1280
2477 msgid "There has not been any error on the handle."
2481 #: ../src/guestfs.pod:1284
2483 "There has been an error but the errno was meaningless. This corresponds to "
2484 "the case where the error did not come from a failed system call, but for "
2485 "some other reason."
2489 #: ../src/guestfs.pod:1290
2491 "There was an error from a failed system call, but for some reason the errno "
2492 "was not captured and returned. This usually indicates a bug in libguestfs."
2496 #: ../src/guestfs.pod:1296
2498 "Libguestfs tries to convert the errno from inside the applicance into a "
2499 "corresponding errno for the caller (not entirely trivial: the appliance "
2500 "might be running a completely different operating system from the library "
2501 "and error numbers are not standardized across Un*xen). If this could not be "
2502 "done, then the error is translated to C<EINVAL>. In practice this should "
2503 "only happen in very rare circumstances."
2507 #: ../src/guestfs.pod:1304
2508 msgid "guestfs_set_error_handler"
2512 #: ../src/guestfs.pod:1306
2515 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2517 " const char *msg);\n"
2518 " void guestfs_set_error_handler (guestfs_h *g,\n"
2519 " guestfs_error_handler_cb cb,\n"
2525 #: ../src/guestfs.pod:1313
2527 "The callback C<cb> will be called if there is an error. The parameters "
2528 "passed to the callback are an opaque data pointer and the error message "
2533 #: ../src/guestfs.pod:1317
2535 "C<errno> is not passed to the callback. To get that the callback must call "
2536 "L</guestfs_last_errno>."
2540 #: ../src/guestfs.pod:1320
2542 "Note that the message string C<msg> is freed as soon as the callback "
2543 "function returns, so if you want to stash it somewhere you must make your "
2548 #: ../src/guestfs.pod:1324
2549 msgid "The default handler prints messages on C<stderr>."
2553 #: ../src/guestfs.pod:1326
2554 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2558 #: ../src/guestfs.pod:1328
2559 msgid "guestfs_get_error_handler"
2563 #: ../src/guestfs.pod:1330
2566 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2567 " void **opaque_rtn);\n"
2572 #: ../src/guestfs.pod:1333
2573 msgid "Returns the current error handler callback."
2577 #: ../src/guestfs.pod:1335
2578 msgid "guestfs_set_out_of_memory_handler"
2582 #: ../src/guestfs.pod:1337
2585 " typedef void (*guestfs_abort_cb) (void);\n"
2586 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2587 " guestfs_abort_cb);\n"
2592 #: ../src/guestfs.pod:1341
2594 "The callback C<cb> will be called if there is an out of memory situation. "
2595 "I<Note this callback must not return>."
2599 #: ../src/guestfs.pod:1344
2600 msgid "The default is to call L<abort(3)>."
2604 #: ../src/guestfs.pod:1346
2605 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2609 #: ../src/guestfs.pod:1349
2610 msgid "guestfs_get_out_of_memory_handler"
2614 #: ../src/guestfs.pod:1351
2617 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2622 #: ../src/guestfs.pod:1353
2623 msgid "This returns the current out of memory handler."
2627 #: ../src/guestfs.pod:1355
2632 #: ../src/guestfs.pod:1357 ../fish/guestfish.pod:958
2637 #: ../src/guestfs.pod:1359
2642 #: ../src/guestfs.pod:1361
2647 #: ../src/guestfs.pod:1363
2648 msgid "AVAILABILITY"
2652 #: ../src/guestfs.pod:1365
2653 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2657 #: ../src/guestfs.pod:1367
2659 "Using L</guestfs_available> you can test availability of the following "
2660 "groups of functions. This test queries the appliance to see if the "
2661 "appliance you are currently using supports the functionality."
2665 #: ../src/guestfs.pod:1372
2666 msgid "@AVAILABILITY@"
2670 #: ../src/guestfs.pod:1374
2671 msgid "GUESTFISH supported COMMAND"
2675 #: ../src/guestfs.pod:1376
2677 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2678 "prints out the available groups and whether they are supported by this build "
2679 "of libguestfs. Note however that you have to do C<run> first."
2683 #: ../src/guestfs.pod:1381
2684 msgid "SINGLE CALLS AT COMPILE TIME"
2688 #: ../src/guestfs.pod:1383
2690 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2691 "function, such as:"
2695 #: ../src/guestfs.pod:1386
2698 " #define LIBGUESTFS_HAVE_DD 1\n"
2703 #: ../src/guestfs.pod:1388
2704 msgid "if L</guestfs_dd> is available."
2708 #: ../src/guestfs.pod:1390
2710 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2711 "function is available at compile time, we recommended using build tools such "
2712 "as autoconf or cmake. For example in autotools you could use:"
2716 #: ../src/guestfs.pod:1395
2719 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2720 " AC_CHECK_FUNCS([guestfs_dd])\n"
2725 #: ../src/guestfs.pod:1398
2727 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2732 #: ../src/guestfs.pod:1401
2733 msgid "SINGLE CALLS AT RUN TIME"
2737 #: ../src/guestfs.pod:1403
2739 "Testing at compile time doesn't guarantee that a function really exists in "
2740 "the library. The reason is that you might be dynamically linked against a "
2741 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2742 "This situation unfortunately results in a segmentation fault, which is a "
2743 "shortcoming of the C dynamic linking system itself."
2747 #: ../src/guestfs.pod:1410
2749 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2750 "in this example program (note that you still need the compile time check as "
2755 #: ../src/guestfs.pod:1414
2758 " #include <stdio.h>\n"
2759 " #include <stdlib.h>\n"
2760 " #include <unistd.h>\n"
2761 " #include <dlfcn.h>\n"
2762 " #include <guestfs.h>\n"
2767 #: ../src/guestfs.pod:1420
2772 " #ifdef LIBGUESTFS_HAVE_DD\n"
2774 " int has_function;\n"
2779 #: ../src/guestfs.pod:1426
2782 " /* Test if the function guestfs_dd is really available. */\n"
2783 " dl = dlopen (NULL, RTLD_LAZY);\n"
2785 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2786 " exit (EXIT_FAILURE);\n"
2788 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2794 #: ../src/guestfs.pod:1435
2797 " if (!has_function)\n"
2798 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2800 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2801 " /* Now it's safe to call\n"
2802 " guestfs_dd (g, \"foo\", \"bar\");\n"
2806 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2813 #: ../src/guestfs.pod:1448
2815 "You may think the above is an awful lot of hassle, and it is. There are "
2816 "other ways outside of the C linking system to ensure that this kind of "
2817 "incompatibility never arises, such as using package versioning:"
2821 #: ../src/guestfs.pod:1453
2824 " Requires: libguestfs >= 1.0.80\n"
2829 #: ../src/guestfs.pod:1455
2830 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2834 #: ../src/guestfs.pod:1457
2836 "A recent feature of the API is the introduction of calls which take optional "
2837 "arguments. In C these are declared 3 ways. The main way is as a call which "
2838 "takes variable arguments (ie. C<...>), as in this example:"
2842 #: ../src/guestfs.pod:1462
2845 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2850 #: ../src/guestfs.pod:1464
2852 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2853 "call with no optional arguments specified:"
2857 #: ../src/guestfs.pod:1467
2860 " guestfs_add_drive_opts (g, filename, -1);\n"
2865 #: ../src/guestfs.pod:1469
2866 msgid "With a single optional argument:"
2870 #: ../src/guestfs.pod:1471
2873 " guestfs_add_drive_opts (g, filename,\n"
2874 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2880 #: ../src/guestfs.pod:1475
2885 #: ../src/guestfs.pod:1477
2888 " guestfs_add_drive_opts (g, filename,\n"
2889 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2890 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2896 #: ../src/guestfs.pod:1482
2898 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2903 #: ../src/guestfs.pod:1485
2904 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2908 #: ../src/guestfs.pod:1487
2910 "The second variant has the same name with the suffix C<_va>, which works the "
2911 "same way but takes a C<va_list>. See the C manual for details. For the "
2912 "example function, this is declared:"
2916 #: ../src/guestfs.pod:1491
2919 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2925 #: ../src/guestfs.pod:1494
2926 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2930 #: ../src/guestfs.pod:1496
2932 "The third variant is useful where you need to construct these calls. You "
2933 "pass in a structure where you fill in the optional fields. The structure "
2934 "has a bitmask as the first element which you must set to indicate which "
2935 "fields you have filled in. For our example function the structure and call "
2940 #: ../src/guestfs.pod:1502
2943 " struct guestfs_add_drive_opts_argv {\n"
2944 " uint64_t bitmask;\n"
2946 " const char *format;\n"
2949 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2950 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2955 #: ../src/guestfs.pod:1511
2956 msgid "You could call it like this:"
2960 #: ../src/guestfs.pod:1513
2963 " struct guestfs_add_drive_opts_argv optargs = {\n"
2964 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2965 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2967 " .format = \"qcow2\"\n"
2973 #: ../src/guestfs.pod:1520
2976 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2981 #: ../src/guestfs.pod:1522 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255 ../tools/virt-win-reg.pl:532
2986 #: ../src/guestfs.pod:1528
2987 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2991 #: ../src/guestfs.pod:1533
2992 msgid "You do not need to fill in all fields of the structure."
2996 #: ../src/guestfs.pod:1537
2998 "There must be a one-to-one correspondence between fields of the structure "
2999 "that are filled in, and bits set in the bitmask."
3003 #: ../src/guestfs.pod:1542
3004 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3008 #: ../src/guestfs.pod:1544
3010 "In other languages, optional arguments are expressed in the way that is "
3011 "natural for that language. We refer you to the language-specific "
3012 "documentation for more details on that."
3016 #: ../src/guestfs.pod:1548
3017 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3021 #: ../src/guestfs.pod:1550
3022 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3026 #: ../src/guestfs.pod:1552
3028 "The child process generates events in some situations. Current events "
3029 "include: receiving a log message, the child process exits."
3033 #: ../src/guestfs.pod:1555
3035 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3040 #: ../src/guestfs.pod:1558
3042 "Only I<one callback of each type> can be registered for each handle. "
3043 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3044 "that type. Cancel all callbacks of this type by calling this function with "
3045 "C<cb> set to C<NULL>."
3049 #: ../src/guestfs.pod:1563
3050 msgid "guestfs_set_log_message_callback"
3054 #: ../src/guestfs.pod:1565
3057 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3058 " char *buf, int len);\n"
3059 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3060 " guestfs_log_message_cb cb,\n"
3066 #: ../src/guestfs.pod:1571
3068 "The callback function C<cb> will be called whenever qemu or the guest writes "
3069 "anything to the console."
3073 #: ../src/guestfs.pod:1574
3074 msgid "Use this function to capture kernel messages and similar."
3078 #: ../src/guestfs.pod:1576
3080 "Normally there is no log message handler, and log messages are just "
3085 #: ../src/guestfs.pod:1579
3086 msgid "guestfs_set_subprocess_quit_callback"
3090 #: ../src/guestfs.pod:1581
3093 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3094 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3095 " guestfs_subprocess_quit_cb cb,\n"
3101 #: ../src/guestfs.pod:1586
3103 "The callback function C<cb> will be called when the child process quits, "
3104 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3105 "corresponds to a transition from any state to the CONFIG state)."
3109 #: ../src/guestfs.pod:1591
3110 msgid "guestfs_set_launch_done_callback"
3114 #: ../src/guestfs.pod:1593
3117 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3118 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3119 " guestfs_launch_done_cb cb,\n"
3125 #: ../src/guestfs.pod:1598
3127 "The callback function C<cb> will be called when the child process becomes "
3128 "ready first time after it has been launched. (This corresponds to a "
3129 "transition from LAUNCHING to the READY state)."
3133 #: ../src/guestfs.pod:1602
3134 msgid "guestfs_set_close_callback"
3138 #: ../src/guestfs.pod:1604
3141 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3142 " void guestfs_set_close_callback (guestfs_h *g,\n"
3143 " guestfs_close_cb cb,\n"
3149 #: ../src/guestfs.pod:1609
3151 "The callback function C<cb> will be called while the handle is being closed "
3152 "(synchronously from L</guestfs_close>)."
3156 #: ../src/guestfs.pod:1612
3158 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3159 "handles that are open when the program exits. This means that this callback "
3160 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3161 "problems in higher-level languages (eg. if your HLL interpreter has already "
3162 "been cleaned up by the time this is called, and if your callback then jumps "
3163 "into some HLL function)."
3167 #: ../src/guestfs.pod:1620
3168 msgid "guestfs_set_progress_callback"
3172 #: ../src/guestfs.pod:1622
3175 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3176 " int proc_nr, int serial,\n"
3177 " uint64_t position, uint64_t total);\n"
3178 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3179 " guestfs_progress_cb cb,\n"
3185 #: ../src/guestfs.pod:1629
3187 "Some long-running operations can generate progress messages. If this "
3188 "callback is registered, then it will be called each time a progress message "
3189 "is generated (usually two seconds after the operation started, and three "
3190 "times per second thereafter until it completes, although the frequency may "
3191 "change in future versions)."
3195 #: ../src/guestfs.pod:1635
3197 "The callback receives two numbers: C<position> and C<total>. The units of "
3198 "C<total> are not defined, although for some operations C<total> may relate "
3199 "in some way to the amount of data to be transferred (eg. in bytes or "
3200 "megabytes), and C<position> may be the portion which has been transferred."
3204 #: ../src/guestfs.pod:1641
3205 msgid "The only defined and stable parts of the API are:"
3209 #: ../src/guestfs.pod:1647
3211 "The callback can display to the user some type of progress bar or indicator "
3212 "which shows the ratio of C<position>:C<total>."
3216 #: ../src/guestfs.pod:1652
3217 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3221 #: ../src/guestfs.pod:1656
3223 "If any progress notification is sent during a call, then a final progress "
3224 "notification is always sent when C<position> = C<total>."
3228 #: ../src/guestfs.pod:1659
3230 "This is to simplify caller code, so callers can easily set the progress "
3231 "indicator to \"100%\" at the end of the operation, without requiring special "
3232 "code to detect this case."
3236 #: ../src/guestfs.pod:1665
3238 "The callback also receives the procedure number and serial number of the "
3239 "call. These are only useful for debugging protocol issues, and the callback "
3240 "can normally ignore them. The callback may want to print these numbers in "
3241 "error messages or debugging messages."
3245 #: ../src/guestfs.pod:1670
3246 msgid "PRIVATE DATA AREA"
3250 #: ../src/guestfs.pod:1672
3252 "You can attach named pieces of private data to the libguestfs handle, and "
3253 "fetch them by name for the lifetime of the handle. This is called the "
3254 "private data area and is only available from the C API."
3258 #: ../src/guestfs.pod:1676
3259 msgid "To attach a named piece of data, use the following call:"
3263 #: ../src/guestfs.pod:1678
3266 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3271 #: ../src/guestfs.pod:1680
3273 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3274 "pointer (which can be C<NULL>). Any previous item with the same name is "
3279 #: ../src/guestfs.pod:1684
3281 "You can use any C<key> you want, but names beginning with an underscore "
3282 "character are reserved for internal libguestfs purposes (for implementing "
3283 "language bindings). It is recommended to prefix the name with some unique "
3284 "string to avoid collisions with other users."
3288 #: ../src/guestfs.pod:1689
3289 msgid "To retrieve the pointer, use:"
3293 #: ../src/guestfs.pod:1691
3296 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3301 #: ../src/guestfs.pod:1693
3303 "This function returns C<NULL> if either no data is found associated with "
3304 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3309 #: ../src/guestfs.pod:1697
3311 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3312 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3313 "all. In particular, libguestfs does I<not> try to free the data when the "
3314 "handle is closed. If the data must be freed, then the caller must either "
3315 "free it before calling L</guestfs_close> or must set up a close callback to "
3316 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3317 "can be registered for a handle)."
3321 #: ../src/guestfs.pod:1705
3323 "The private data area is implemented using a hash table, and should be "
3324 "reasonably efficient for moderate numbers of keys."
3328 #: ../src/guestfs.pod:1708 ../src/guestfs.pod:1713
3333 #: ../src/guestfs.pod:1710
3335 "<!-- old anchor for the next section --> <a "
3336 "name=\"state_machine_and_low_level_event_api\"/>"
3340 #: ../src/guestfs.pod:1715
3341 msgid "ARCHITECTURE"
3345 #: ../src/guestfs.pod:1717
3347 "Internally, libguestfs is implemented by running an appliance (a special "
3348 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3349 "process of the main program."
3353 #: ../src/guestfs.pod:1721
3356 " ___________________\n"
3358 " | main program |\n"
3360 " | | child process / appliance\n"
3361 " | | __________________________\n"
3363 " +-------------------+ RPC | +-----------------+ |\n"
3364 " | libguestfs <--------------------> guestfsd | |\n"
3365 " | | | +-----------------+ |\n"
3366 " \\___________________/ | | Linux kernel | |\n"
3367 " | +--^--------------+ |\n"
3368 " \\_________|________________/\n"
3374 " \\______________/\n"
3379 #: ../src/guestfs.pod:1741
3381 "The library, linked to the main program, creates the child process and hence "
3382 "the appliance in the L</guestfs_launch> function."
3386 #: ../src/guestfs.pod:1744
3388 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3389 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3390 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3391 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3392 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3393 "attached to the qemu process which translates device access by the "
3394 "appliance's Linux kernel into accesses to the image."
3398 #: ../src/guestfs.pod:1753
3400 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3401 "Although the disk image you are attached to might also be used by some "
3402 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3403 "care if both libguestfs's qemu process and your virtual machine are trying "
3404 "to update the disk image at the same time, since these usually results in "
3405 "massive disk corruption)."
3409 #: ../src/guestfs.pod:1760
3410 msgid "STATE MACHINE"
3414 #: ../src/guestfs.pod:1762
3415 msgid "libguestfs uses a state machine to model the child process:"
3419 #: ../src/guestfs.pod:1764
3431 " / | \\ \\ guestfs_launch\n"
3432 " / | _\\__V______\n"
3434 " / | | LAUNCHING |\n"
3435 " / | \\___________/\n"
3437 " / | guestfs_launch\n"
3439 " ______ / __|____V\n"
3440 " / \\ ------> / \\\n"
3441 " | BUSY | | READY |\n"
3442 " \\______/ <------ \\________/\n"
3447 #: ../src/guestfs.pod:1786
3449 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3450 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3451 "(3) alternating between READY and BUSY as commands are issued to, and "
3452 "carried out by, the child process."
3456 #: ../src/guestfs.pod:1791
3458 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3459 "asynchronously at any time (eg. due to some internal error), and that causes "
3460 "the state to transition back to CONFIG."
3464 #: ../src/guestfs.pod:1795
3466 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3467 "issued when in the CONFIG state."
3471 #: ../src/guestfs.pod:1798
3473 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3474 "L</guestfs_launch> blocks until the child process is READY to accept "
3475 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3476 "moves the state from CONFIG to LAUNCHING while it is running."
3480 #: ../src/guestfs.pod:1804
3482 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3483 "state. These API calls block waiting for the command to be carried out "
3484 "(ie. the state to transition to BUSY and then back to READY). There are no "
3485 "non-blocking versions, and no way to issue more than one command per handle "
3490 #: ../src/guestfs.pod:1810
3492 "Finally, the child process sends asynchronous messages back to the main "
3493 "program, such as kernel log messages. You can register a callback to "
3494 "receive these messages."
3498 #: ../src/guestfs.pod:1814
3503 #: ../src/guestfs.pod:1816
3504 msgid "COMMUNICATION PROTOCOL"
3508 #: ../src/guestfs.pod:1818
3510 "Don't rely on using this protocol directly. This section documents how it "
3511 "currently works, but it may change at any time."
3515 #: ../src/guestfs.pod:1821
3517 "The protocol used to talk between the library and the daemon running inside "
3518 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3519 "1014, RFC 1832, RFC 4506)."
3523 #: ../src/guestfs.pod:1825
3525 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3526 "this file is automatically generated)."
3530 #: ../src/guestfs.pod:1828
3532 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3533 "and C<FileOut> parameters, which are handled with very simple request/reply "
3534 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3535 "parameters, which use the same request and reply messages, but they may also "
3536 "be followed by files sent using a chunked encoding."
3540 #: ../src/guestfs.pod:1835
3541 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3545 #: ../src/guestfs.pod:1837
3546 msgid "For ordinary functions, the request message is:"
3550 #: ../src/guestfs.pod:1839
3553 " total length (header + arguments,\n"
3554 " but not including the length word itself)\n"
3555 " struct guestfs_message_header (encoded as XDR)\n"
3556 " struct guestfs_<foo>_args (encoded as XDR)\n"
3561 #: ../src/guestfs.pod:1844
3563 "The total length field allows the daemon to allocate a fixed size buffer "
3564 "into which it slurps the rest of the message. As a result, the total length "
3565 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3566 "effective size of any request is limited to somewhere under this size."
3570 #: ../src/guestfs.pod:1850
3572 "Note also that many functions don't take any arguments, in which case the "
3573 "C<guestfs_I<foo>_args> is completely omitted."
3577 #: ../src/guestfs.pod:1853
3579 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3580 "receiver knows what type of args structure to expect, or none at all."
3584 #: ../src/guestfs.pod:1857
3586 "For functions that take optional arguments, the optional arguments are "
3587 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
3588 "arguments. A bitmask in the header indicates which optional arguments are "
3589 "meaningful. The bitmask is also checked to see if it contains bits set "
3590 "which the daemon does not know about (eg. if more optional arguments were "
3591 "added in a later version of the library), and this causes the call to be "
3596 #: ../src/guestfs.pod:1865
3597 msgid "The reply message for ordinary functions is:"
3601 #: ../src/guestfs.pod:1867
3604 " total length (header + ret,\n"
3605 " but not including the length word itself)\n"
3606 " struct guestfs_message_header (encoded as XDR)\n"
3607 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3612 #: ../src/guestfs.pod:1872
3614 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3615 "functions that return no formal return values."
3619 #: ../src/guestfs.pod:1875
3620 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3624 #: ../src/guestfs.pod:1878
3626 "In the case of an error, a flag is set in the header, and the reply message "
3627 "is slightly changed:"
3631 #: ../src/guestfs.pod:1881
3634 " total length (header + error,\n"
3635 " but not including the length word itself)\n"
3636 " struct guestfs_message_header (encoded as XDR)\n"
3637 " struct guestfs_message_error (encoded as XDR)\n"
3642 #: ../src/guestfs.pod:1886
3644 "The C<guestfs_message_error> structure contains the error message as a "
3649 #: ../src/guestfs.pod:1889
3650 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3654 #: ../src/guestfs.pod:1891
3656 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3657 "The normal request message is sent (see above). However this is followed by "
3658 "a sequence of file chunks."
3662 #: ../src/guestfs.pod:1895
3665 " total length (header + arguments,\n"
3666 " but not including the length word itself,\n"
3667 " and not including the chunks)\n"
3668 " struct guestfs_message_header (encoded as XDR)\n"
3669 " struct guestfs_<foo>_args (encoded as XDR)\n"
3670 " sequence of chunks for FileIn param #0\n"
3671 " sequence of chunks for FileIn param #1 etc.\n"
3676 #: ../src/guestfs.pod:1903
3677 msgid "The \"sequence of chunks\" is:"
3681 #: ../src/guestfs.pod:1905
3684 " length of chunk (not including length word itself)\n"
3685 " struct guestfs_chunk (encoded as XDR)\n"
3686 " length of chunk\n"
3687 " struct guestfs_chunk (encoded as XDR)\n"
3689 " length of chunk\n"
3690 " struct guestfs_chunk (with data.data_len == 0)\n"
3695 #: ../src/guestfs.pod:1913
3697 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3698 "is set in the final chunk to indicate either successful completion or early "
3703 #: ../src/guestfs.pod:1917
3705 "At time of writing there are no functions that have more than one FileIn "
3706 "parameter. However this is (theoretically) supported, by sending the "
3707 "sequence of chunks for each FileIn parameter one after another (from left to "
3712 #: ../src/guestfs.pod:1922
3714 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3715 "transfer. The library does this by sending a chunk with a special flag set "
3716 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3717 "RPC, does I<not> send any reply, and goes back to reading the next request."
3721 #: ../src/guestfs.pod:1928
3723 "The daemon may also cancel. It does this by writing a special word "
3724 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3725 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3726 "cancel chunk). The special word is chosen so that even if cancellation "
3727 "happens right at the end of the transfer (after the library has finished "
3728 "writing and has started listening for the reply), the \"spurious\" cancel "
3729 "flag will not be confused with the reply message."
3733 #: ../src/guestfs.pod:1937
3735 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3736 "limit), and also files where the size is not known in advance (eg. from "
3737 "pipes or sockets). However the chunks are rather small "
3738 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3739 "to keep much in memory."
3743 #: ../src/guestfs.pod:1943
3744 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3748 #: ../src/guestfs.pod:1945
3750 "The protocol for FileOut parameters is exactly the same as for FileIn "
3751 "parameters, but with the roles of daemon and library reversed."
3755 #: ../src/guestfs.pod:1948
3758 " total length (header + ret,\n"
3759 " but not including the length word itself,\n"
3760 " and not including the chunks)\n"
3761 " struct guestfs_message_header (encoded as XDR)\n"
3762 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3763 " sequence of chunks for FileOut param #0\n"
3764 " sequence of chunks for FileOut param #1 etc.\n"
3769 #: ../src/guestfs.pod:1956
3770 msgid "INITIAL MESSAGE"
3774 #: ../src/guestfs.pod:1958
3776 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3777 "which indicates that the guest and daemon is alive. This is what "
3778 "L</guestfs_launch> waits for."
3782 #: ../src/guestfs.pod:1962
3783 msgid "PROGRESS NOTIFICATION MESSAGES"
3787 #: ../src/guestfs.pod:1964
3789 "The daemon may send progress notification messages at any time. These are "
3790 "distinguished by the normal length word being replaced by "
3791 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3795 #: ../src/guestfs.pod:1968
3797 "The library turns them into progress callbacks (see "
3798 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3799 "discards them if not."
3803 #: ../src/guestfs.pod:1972
3805 "The daemon self-limits the frequency of progress messages it sends (see "
3806 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3811 #: ../src/guestfs.pod:1976
3812 msgid "LIBGUESTFS VERSION NUMBERS"
3816 #: ../src/guestfs.pod:1978
3818 "Since April 2010, libguestfs has started to make separate development and "
3819 "stable releases, along with corresponding branches in our git repository. "
3820 "These separate releases can be identified by version number:"
3824 #: ../src/guestfs.pod:1983
3827 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3828 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3834 " | `-------- sub-version\n"
3836 " `------ always '1' because we don't change the ABI\n"
3841 #: ../src/guestfs.pod:1994
3842 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3846 #: ../src/guestfs.pod:1996
3848 "As time passes we cherry pick fixes from the development branch and backport "
3849 "those into the stable branch, the effect being that the stable branch should "
3850 "get more stable and less buggy over time. So the stable releases are ideal "
3851 "for people who don't need new features but would just like the software to "
3856 #: ../src/guestfs.pod:2002
3857 msgid "Our criteria for backporting changes are:"
3861 #: ../src/guestfs.pod:2008
3863 "Documentation changes which don't affect any code are backported unless the "
3864 "documentation refers to a future feature which is not in stable."
3868 #: ../src/guestfs.pod:2014
3870 "Bug fixes which are not controversial, fix obvious problems, and have been "
3871 "well tested are backported."
3875 #: ../src/guestfs.pod:2019
3877 "Simple rearrangements of code which shouldn't affect how it works get "
3878 "backported. This is so that the code in the two branches doesn't get too "
3879 "far out of step, allowing us to backport future fixes more easily."
3883 #: ../src/guestfs.pod:2025
3885 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3886 "exceptional case: the new feature is required in order to implement an "
3887 "important bug fix."
3891 #: ../src/guestfs.pod:2031
3893 "A new stable branch starts when we think the new features in development are "
3894 "substantial and compelling enough over the current stable branch to warrant "
3895 "it. When that happens we create new stable and development versions 1.N.0 "
3896 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3897 "stable at this point, but by backporting fixes from development, that branch "
3898 "will stabilize over time."
3902 #: ../src/guestfs.pod:2039 ../fish/guestfish.pod:965 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3903 msgid "ENVIRONMENT VARIABLES"
3907 #: ../src/guestfs.pod:2043 ../fish/guestfish.pod:991
3908 msgid "LIBGUESTFS_APPEND"
3912 #: ../src/guestfs.pod:2045 ../fish/guestfish.pod:993
3913 msgid "Pass additional options to the guest kernel."
3917 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:995
3918 msgid "LIBGUESTFS_DEBUG"
3922 #: ../src/guestfs.pod:2049
3924 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3925 "effect as calling C<guestfs_set_verbose (g, 1)>."
3929 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:1000
3930 msgid "LIBGUESTFS_MEMSIZE"
3934 #: ../src/guestfs.pod:2054 ../fish/guestfish.pod:1002
3935 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3939 #: ../src/guestfs.pod:2057 ../fish/guestfish.pod:1005
3942 " LIBGUESTFS_MEMSIZE=700\n"
3947 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:1007
3948 msgid "LIBGUESTFS_PATH"
3952 #: ../src/guestfs.pod:2061
3954 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3955 "the discussion of paths in section PATH above."
3959 #: ../src/guestfs.pod:2064 ../fish/guestfish.pod:1012
3960 msgid "LIBGUESTFS_QEMU"
3964 #: ../src/guestfs.pod:2066 ../fish/guestfish.pod:1014
3966 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3967 "which was found at compile time by the configure script is used."
3971 #: ../src/guestfs.pod:2070
3972 msgid "See also L</QEMU WRAPPERS> above."
3976 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:1018
3977 msgid "LIBGUESTFS_TRACE"
3981 #: ../src/guestfs.pod:2074
3983 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3984 "effect as calling C<guestfs_set_trace (g, 1)>."
3988 #: ../src/guestfs.pod:2077 ../fish/guestfish.pod:1027
3993 #: ../src/guestfs.pod:2079 ../fish/guestfish.pod:1029
3994 msgid "Location of temporary directory, defaults to C</tmp>."
3998 #: ../src/guestfs.pod:2081 ../fish/guestfish.pod:1031
4000 "If libguestfs was compiled to use the supermin appliance then the real "
4001 "appliance is cached in this directory, shared between all handles belonging "
4002 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
4003 "use in case C</tmp> is not large enough."
4007 #: ../src/guestfs.pod:2089 ../fish/guestfish.pod:1089 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:572 ../tools/virt-resize.pl:1483 ../tools/virt-list-filesystems.pl:189 ../tools/virt-tar.pl:281 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:257
4012 #: ../src/guestfs.pod:2091
4014 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4015 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4016 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4017 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4018 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4019 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4020 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4024 #: ../src/guestfs.pod:2114
4026 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4027 "L<lvm(8)>, L<disktype(1)>."
4031 #: ../src/guestfs.pod:2121 ../tools/virt-win-reg.pl:587 ../tools/virt-make-fs.pl:548
4036 #: ../src/guestfs.pod:2123
4037 msgid "To get a list of bugs against libguestfs use this link:"
4041 #: ../src/guestfs.pod:2125
4042 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4046 #: ../src/guestfs.pod:2127
4047 msgid "To report a new bug against libguestfs use this link:"
4051 #: ../src/guestfs.pod:2129
4052 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4056 #: ../src/guestfs.pod:2131
4057 msgid "When reporting a bug, please check:"
4061 #: ../src/guestfs.pod:2137
4062 msgid "That the bug hasn't been reported already."
4066 #: ../src/guestfs.pod:2141
4067 msgid "That you are testing a recent version."
4071 #: ../src/guestfs.pod:2145
4072 msgid "Describe the bug accurately, and give a way to reproduce it."
4076 #: ../src/guestfs.pod:2149
4078 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4083 #: ../src/guestfs.pod:2154 ../fish/guestfish.pod:1108 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4088 #: ../src/guestfs.pod:2156 ../fish/guestfish.pod:1110 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4089 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4093 #: ../src/guestfs.pod:2158 ../fish/guestfish.pod:1112 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:602 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:296 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:273
4098 #: ../src/guestfs.pod:2160 ../fish/guestfish.pod:1114 ../fuse/guestmount.pod:250
4099 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4103 #: ../src/guestfs.pod:2163
4105 "This library is free software; you can redistribute it and/or modify it "
4106 "under the terms of the GNU Lesser General Public License as published by the "
4107 "Free Software Foundation; either version 2 of the License, or (at your "
4108 "option) any later version."
4112 #: ../src/guestfs.pod:2168
4114 "This library is distributed in the hope that it will be useful, but WITHOUT "
4115 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4116 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4121 #: ../src/guestfs.pod:2173
4123 "You should have received a copy of the GNU Lesser General Public License "
4124 "along with this library; if not, write to the Free Software Foundation, "
4125 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4129 #: ../src/guestfs-actions.pod:1
4130 msgid "guestfs_add_cdrom"
4134 #: ../src/guestfs-actions.pod:3
4138 " guestfs_add_cdrom (guestfs_h *g,\n"
4139 " const char *filename);\n"
4144 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4145 msgid "This function adds a virtual CD-ROM disk image to the guest."
4149 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4150 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4154 #: ../src/guestfs-actions.pod:17
4156 "This call checks for the existence of C<filename>. This stops you from "
4157 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4158 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4163 #: ../src/guestfs-actions.pod:24
4165 "If you just want to add an ISO file (often you use this as an efficient way "
4166 "to transfer large files into the guest), then you should probably use "
4167 "C<guestfs_add_drive_ro> instead."
4171 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:189 ../src/guestfs-actions.pod:226 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:970 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1326 ../src/guestfs-actions.pod:1432 ../src/guestfs-actions.pod:1466 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:1793 ../src/guestfs-actions.pod:2215 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3209 ../src/guestfs-actions.pod:3229 ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3368 ../src/guestfs-actions.pod:3381 ../src/guestfs-actions.pod:3395 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3446 ../src/guestfs-actions.pod:3518 ../src/guestfs-actions.pod:3538 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3578 ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3633 ../src/guestfs-actions.pod:3652 ../src/guestfs-actions.pod:3671 ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3718 ../src/guestfs-actions.pod:3754 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3798 ../src/guestfs-actions.pod:3815 ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3928 ../src/guestfs-actions.pod:3941 ../src/guestfs-actions.pod:3992 ../src/guestfs-actions.pod:4010 ../src/guestfs-actions.pod:4028 ../src/guestfs-actions.pod:4044 ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4072 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4168 ../src/guestfs-actions.pod:4239 ../src/guestfs-actions.pod:4270 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:4308 ../src/guestfs-actions.pod:4320 ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4350 ../src/guestfs-actions.pod:4365 ../src/guestfs-actions.pod:4380 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4430 ../src/guestfs-actions.pod:4450 ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4481 ../src/guestfs-actions.pod:4530 ../src/guestfs-actions.pod:4567 ../src/guestfs-actions.pod:4581 ../src/guestfs-actions.pod:4609 ../src/guestfs-actions.pod:4626 ../src/guestfs-actions.pod:4644 ../src/guestfs-actions.pod:4778 ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4875 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4973 ../src/guestfs-actions.pod:4990 ../src/guestfs-actions.pod:5003 ../src/guestfs-actions.pod:5017 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5339 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5365 ../src/guestfs-actions.pod:5377 ../src/guestfs-actions.pod:5391 ../src/guestfs-actions.pod:5407 ../src/guestfs-actions.pod:5428 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5507 ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5565 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5601 ../src/guestfs-actions.pod:5629 ../src/guestfs-actions.pod:5653 ../src/guestfs-actions.pod:5672 ../src/guestfs-actions.pod:5696 ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:5745 ../src/guestfs-actions.pod:5782 ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:6060 ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6120 ../src/guestfs-actions.pod:6133 ../src/guestfs-actions.pod:6146 ../src/guestfs-actions.pod:6159 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6282 ../src/guestfs-actions.pod:6299 ../src/guestfs-actions.pod:6312 ../src/guestfs-actions.pod:6332 ../src/guestfs-actions.pod:6368 ../src/guestfs-actions.pod:6382 ../src/guestfs-actions.pod:6423 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6454 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6524 ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6661 ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:6730 ../src/guestfs-actions.pod:6743 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6875 ../src/guestfs-actions.pod:6901 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:6986 ../src/guestfs-actions.pod:7015
4172 msgid "This function returns 0 on success or -1 on error."
4176 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:242 ../src/guestfs-actions.pod:263 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4178 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4183 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:245 ../src/guestfs-actions.pod:266 ../src/guestfs-actions.pod:1437 ../src/guestfs-actions.pod:1923 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:4129 ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:7078 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:2778 ../fish/guestfish-actions.pod:4580 ../fish/guestfish-actions.pod:4677
4185 "Deprecated functions will not be removed from the API, but the fact that "
4186 "they are deprecated indicates that there are problems with correct use of "
4191 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:130 ../src/guestfs-actions.pod:1094 ../src/guestfs-actions.pod:1895 ../src/guestfs-actions.pod:1993 ../src/guestfs-actions.pod:2096 ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3211 ../src/guestfs-actions.pod:4417 ../src/guestfs-actions.pod:5486 ../src/guestfs-actions.pod:5603 ../src/guestfs-actions.pod:5713 ../src/guestfs-actions.pod:6176 ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6823
4192 msgid "(Added in 0.3)"
4196 #: ../src/guestfs-actions.pod:41
4197 msgid "guestfs_add_domain"
4201 #: ../src/guestfs-actions.pod:43
4205 " guestfs_add_domain (guestfs_h *g,\n"
4206 " const char *dom,\n"
4212 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:139 ../src/guestfs-actions.pod:4143
4214 "You may supply a list of optional arguments to this call. Use zero or more "
4215 "of the following pairs of parameters, and terminate the list with C<-1> on "
4216 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4220 #: ../src/guestfs-actions.pod:53
4223 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4224 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4225 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4230 #: ../src/guestfs-actions.pod:57
4232 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4233 "It works by connecting to libvirt, requesting the domain and domain XML from "
4234 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4239 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4241 "The number of disks added is returned. This operation is atomic: if an "
4242 "error is returned, then no disks are added."
4246 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4248 "This function does some minimal checks to make sure the libvirt domain is "
4249 "not running (unless C<readonly> is true). In a future version we will try "
4250 "to acquire the libvirt lock on each disk."
4254 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4256 "Disks must be accessible locally. This often means that adding disks from a "
4257 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4258 "unless those disks are accessible via the same device path locally too."
4262 #: ../src/guestfs-actions.pod:74
4264 "The optional C<libvirturi> parameter sets the libvirt URI (see "
4265 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
4266 "default libvirt URI (or one set through an environment variable, see the "
4267 "libvirt documentation for full details). If you are using the C API "
4268 "directly then it is more flexible to create the libvirt connection object "
4269 "yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
4273 #: ../src/guestfs-actions.pod:82
4275 "The other optional parameters are passed directly through to "
4276 "C<guestfs_add_drive_opts>."
4280 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1663 ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:2005 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2634 ../src/guestfs-actions.pod:2655 ../src/guestfs-actions.pod:4553 ../src/guestfs-actions.pod:4681 ../src/guestfs-actions.pod:5087 ../src/guestfs-actions.pod:5113 ../src/guestfs-actions.pod:6409 ../src/guestfs-actions.pod:6834 ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6860
4281 msgid "On error this function returns -1."
4285 #: ../src/guestfs-actions.pod:87
4286 msgid "(Added in 1.7.4)"
4290 #: ../src/guestfs-actions.pod:89
4291 msgid "guestfs_add_domain_va"
4295 #: ../src/guestfs-actions.pod:91
4299 " guestfs_add_domain_va (guestfs_h *g,\n"
4300 " const char *dom,\n"
4306 #: ../src/guestfs-actions.pod:96
4307 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4311 #: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109 ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213 ../src/guestfs-actions.pod:4180 ../src/guestfs-actions.pod:4192
4312 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4316 #: ../src/guestfs-actions.pod:100
4317 msgid "guestfs_add_domain_argv"
4321 #: ../src/guestfs-actions.pod:102
4325 " guestfs_add_domain_argv (guestfs_h *g,\n"
4326 " const char *dom,\n"
4327 " const struct guestfs_add_domain_argv *optargs);\n"
4332 #: ../src/guestfs-actions.pod:107
4333 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4337 #: ../src/guestfs-actions.pod:111
4338 msgid "guestfs_add_drive"
4342 #: ../src/guestfs-actions.pod:113
4346 " guestfs_add_drive (guestfs_h *g,\n"
4347 " const char *filename);\n"
4352 #: ../src/guestfs-actions.pod:117
4354 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4355 "optional parameters, so the disk is added writable, with the format being "
4356 "detected automatically."
4360 #: ../src/guestfs-actions.pod:121
4362 "Automatic detection of the format opens you up to a potential security hole "
4363 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4364 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4365 "you should think about replacing calls to this function with calls to "
4366 "C<guestfs_add_drive_opts>, and specifying the format."
4370 #: ../src/guestfs-actions.pod:132
4371 msgid "guestfs_add_drive_opts"
4375 #: ../src/guestfs-actions.pod:134
4379 " guestfs_add_drive_opts (guestfs_h *g,\n"
4380 " const char *filename,\n"
4386 #: ../src/guestfs-actions.pod:144
4389 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4390 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4391 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4396 #: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92
4398 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4399 "The first time you call this function, the disk appears as C</dev/sda>, the "
4400 "second time as C</dev/sdb>, and so on."
4404 #: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97
4406 "You don't necessarily need to be root when using libguestfs. However you "
4407 "obviously do need sufficient permissions to access the filename for whatever "
4408 "operations you want to perform (ie. read access if you just want to read the "
4409 "image or write access if you want to modify the image)."
4413 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103
4414 msgid "This call checks that C<filename> exists."
4418 #: ../src/guestfs-actions.pod:161 ../src/guestfs-actions.pod:4153 ../fish/guestfish-actions.pod:105 ../fish/guestfish-actions.pod:2789
4419 msgid "The optional arguments are:"
4423 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
4428 #: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111
4430 "If true then the image is treated as read-only. Writes are still allowed, "
4431 "but they are stored in a temporary snapshot overlay which is discarded at "
4432 "the end. The disk that you add is not modified."
4436 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115
4441 #: ../src/guestfs-actions.pod:173
4443 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4444 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4445 "Possible formats include C<raw> and C<qcow2>."
4449 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:121
4451 "Automatic detection of the format opens you up to a potential security hole "
4452 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4453 "RHBZ#642934. Specifying the format closes this security hole."
4457 #: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126
4462 #: ../src/guestfs-actions.pod:184
4464 "This rarely-used option lets you emulate the behaviour of the deprecated "
4465 "C<guestfs_add_drive_with_if> call (q.v.)"
4469 #: ../src/guestfs-actions.pod:191
4470 msgid "(Added in 1.5.23)"
4474 #: ../src/guestfs-actions.pod:193
4475 msgid "guestfs_add_drive_opts_va"
4479 #: ../src/guestfs-actions.pod:195
4483 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4484 " const char *filename,\n"
4490 #: ../src/guestfs-actions.pod:200
4491 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4495 #: ../src/guestfs-actions.pod:204
4496 msgid "guestfs_add_drive_opts_argv"
4500 #: ../src/guestfs-actions.pod:206
4504 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4505 " const char *filename,\n"
4506 " const struct guestfs_add_drive_opts_argv "
4512 #: ../src/guestfs-actions.pod:211
4513 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4517 #: ../src/guestfs-actions.pod:215
4518 msgid "guestfs_add_drive_ro"
4522 #: ../src/guestfs-actions.pod:217
4526 " guestfs_add_drive_ro (guestfs_h *g,\n"
4527 " const char *filename);\n"
4532 #: ../src/guestfs-actions.pod:221
4534 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4535 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4536 "disk is added read-only, with the format being detected automatically."
4540 #: ../src/guestfs-actions.pod:228
4541 msgid "(Added in 1.0.38)"
4545 #: ../src/guestfs-actions.pod:230
4546 msgid "guestfs_add_drive_ro_with_if"
4550 #: ../src/guestfs-actions.pod:232
4554 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4555 " const char *filename,\n"
4556 " const char *iface);\n"
4561 #: ../src/guestfs-actions.pod:237
4563 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4564 "QEMU interface emulation to use at run time."
4568 #: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:2305
4569 msgid "(Added in 1.0.84)"
4573 #: ../src/guestfs-actions.pod:251
4574 msgid "guestfs_add_drive_with_if"
4578 #: ../src/guestfs-actions.pod:253
4582 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4583 " const char *filename,\n"
4584 " const char *iface);\n"
4589 #: ../src/guestfs-actions.pod:258
4591 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4592 "QEMU interface emulation to use at run time."
4596 #: ../src/guestfs-actions.pod:272
4597 msgid "guestfs_aug_clear"
4601 #: ../src/guestfs-actions.pod:274
4605 " guestfs_aug_clear (guestfs_h *g,\n"
4606 " const char *augpath);\n"
4611 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178
4613 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4614 "L<augtool(1)> C<clear> command."
4618 #: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085
4619 msgid "(Added in 1.3.4)"
4623 #: ../src/guestfs-actions.pod:285
4624 msgid "guestfs_aug_close"
4628 #: ../src/guestfs-actions.pod:287
4632 " guestfs_aug_close (guestfs_h *g);\n"
4637 #: ../src/guestfs-actions.pod:290
4639 "Close the current Augeas handle and free up any resources used by it. After "
4640 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4641 "any other Augeas functions."
4645 #: ../src/guestfs-actions.pod:297 ../src/guestfs-actions.pod:322 ../src/guestfs-actions.pod:340 ../src/guestfs-actions.pod:354 ../src/guestfs-actions.pod:412 ../src/guestfs-actions.pod:432 ../src/guestfs-actions.pod:446 ../src/guestfs-actions.pod:477 ../src/guestfs-actions.pod:491 ../src/guestfs-actions.pod:505 ../src/guestfs-actions.pod:519 ../src/guestfs-actions.pod:537 ../src/guestfs-actions.pod:5164
4646 msgid "(Added in 0.7)"
4650 #: ../src/guestfs-actions.pod:299
4651 msgid "guestfs_aug_defnode"
4655 #: ../src/guestfs-actions.pod:301
4658 " struct guestfs_int_bool *\n"
4659 " guestfs_aug_defnode (guestfs_h *g,\n"
4660 " const char *name,\n"
4661 " const char *expr,\n"
4662 " const char *val);\n"
4667 #: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194
4668 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4672 #: ../src/guestfs-actions.pod:310
4674 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4675 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4676 "containing that single node."
4680 #: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201
4682 "On success this returns a pair containing the number of nodes in the "
4683 "nodeset, and a boolean flag if a node was created."
4687 #: ../src/guestfs-actions.pod:318
4689 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4690 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4694 #: ../src/guestfs-actions.pod:324
4695 msgid "guestfs_aug_defvar"
4699 #: ../src/guestfs-actions.pod:326
4703 " guestfs_aug_defvar (guestfs_h *g,\n"
4704 " const char *name,\n"
4705 " const char *expr);\n"
4710 #: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209
4712 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4713 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4717 #: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213
4719 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4720 "evaluates to something which is not a nodeset."
4724 #: ../src/guestfs-actions.pod:342
4725 msgid "guestfs_aug_get"
4729 #: ../src/guestfs-actions.pod:344
4733 " guestfs_aug_get (guestfs_h *g,\n"
4734 " const char *augpath);\n"
4739 #: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220
4741 "Look up the value associated with C<path>. If C<path> matches exactly one "
4742 "node, the C<value> is returned."
4746 #: ../src/guestfs-actions.pod:351 ../src/guestfs-actions.pod:851 ../src/guestfs-actions.pod:869 ../src/guestfs-actions.pod:929 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1048 ../src/guestfs-actions.pod:1178 ../src/guestfs-actions.pod:1195 ../src/guestfs-actions.pod:1214 ../src/guestfs-actions.pod:1343 ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:1646 ../src/guestfs-actions.pod:1809 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:1938 ../src/guestfs-actions.pod:2108 ../src/guestfs-actions.pod:2270 ../src/guestfs-actions.pod:2477 ../src/guestfs-actions.pod:2558 ../src/guestfs-actions.pod:2606 ../src/guestfs-actions.pod:2716 ../src/guestfs-actions.pod:2747 ../src/guestfs-actions.pod:2771 ../src/guestfs-actions.pod:2833 ../src/guestfs-actions.pod:2856 ../src/guestfs-actions.pod:3340 ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:3860 ../src/guestfs-actions.pod:3970 ../src/guestfs-actions.pod:4699 ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:5062 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5852 ../src/guestfs-actions.pod:5868 ../src/guestfs-actions.pod:5885 ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:6602 ../src/guestfs-actions.pod:6620 ../src/guestfs-actions.pod:6800 ../src/guestfs-actions.pod:7072
4748 "This function returns a string, or NULL on error. I<The caller must free "
4749 "the returned string after use>."
4753 #: ../src/guestfs-actions.pod:356
4754 msgid "guestfs_aug_init"
4758 #: ../src/guestfs-actions.pod:358
4762 " guestfs_aug_init (guestfs_h *g,\n"
4763 " const char *root,\n"
4769 #: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227
4771 "Create a new Augeas handle for editing configuration files. If there was "
4772 "any previous Augeas handle associated with this guestfs session, then it is "
4777 #: ../src/guestfs-actions.pod:367
4778 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4782 #: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234
4783 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4787 #: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237
4789 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4790 "logical I<or> of the following integers:"
4794 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
4795 msgid "C<AUG_SAVE_BACKUP> = 1"
4799 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
4800 msgid "Keep the original file with a C<.augsave> extension."
4804 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
4805 msgid "C<AUG_SAVE_NEWFILE> = 2"
4809 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249
4811 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4812 "original. Overrides C<AUG_SAVE_BACKUP>."
4816 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
4817 msgid "C<AUG_TYPE_CHECK> = 4"
4821 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
4822 msgid "Typecheck lenses (can be expensive)."
4826 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
4827 msgid "C<AUG_NO_STDINC> = 8"
4831 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
4832 msgid "Do not use standard load path for modules."
4836 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
4837 msgid "C<AUG_SAVE_NOOP> = 16"
4841 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
4842 msgid "Make save a no-op, just record what would have been changed."
4846 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264
4847 msgid "C<AUG_NO_LOAD> = 32"
4851 #: ../src/guestfs-actions.pod:402
4852 msgid "Do not load the tree in C<guestfs_aug_init>."
4856 #: ../src/guestfs-actions.pod:406
4857 msgid "To close the handle, you can call C<guestfs_aug_close>."
4861 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272
4862 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4866 #: ../src/guestfs-actions.pod:414
4867 msgid "guestfs_aug_insert"
4871 #: ../src/guestfs-actions.pod:416
4875 " guestfs_aug_insert (guestfs_h *g,\n"
4876 " const char *augpath,\n"
4877 " const char *label,\n"
4883 #: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278
4885 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4886 "or after C<path> (depending on the boolean flag C<before>)."
4890 #: ../src/guestfs-actions.pod:426 ../fish/guestfish-actions.pod:282
4892 "C<path> must match exactly one existing node in the tree, and C<label> must "
4893 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4897 #: ../src/guestfs-actions.pod:434
4898 msgid "guestfs_aug_load"
4902 #: ../src/guestfs-actions.pod:436
4906 " guestfs_aug_load (guestfs_h *g);\n"
4911 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
4912 msgid "Load files into the tree."
4916 #: ../src/guestfs-actions.pod:441 ../fish/guestfish-actions.pod:292
4917 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4921 #: ../src/guestfs-actions.pod:448
4922 msgid "guestfs_aug_ls"
4926 #: ../src/guestfs-actions.pod:450
4930 " guestfs_aug_ls (guestfs_h *g,\n"
4931 " const char *augpath);\n"
4936 #: ../src/guestfs-actions.pod:454
4938 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4939 "sorting the resulting nodes into alphabetical order."
4943 #: ../src/guestfs-actions.pod:457 ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:1067 ../src/guestfs-actions.pod:1358 ../src/guestfs-actions.pod:1377 ../src/guestfs-actions.pod:1480 ../src/guestfs-actions.pod:1499 ../src/guestfs-actions.pod:1748 ../src/guestfs-actions.pod:2150 ../src/guestfs-actions.pod:2166 ../src/guestfs-actions.pod:2185 ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:2252 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2372 ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:2790 ../src/guestfs-actions.pod:3005 ../src/guestfs-actions.pod:3260 ../src/guestfs-actions.pod:3322 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3832 ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:5034 ../src/guestfs-actions.pod:5160 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5986 ../src/guestfs-actions.pod:6041 ../src/guestfs-actions.pod:6187 ../src/guestfs-actions.pod:6211 ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:6713 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6925 ../src/guestfs-actions.pod:6944 ../src/guestfs-actions.pod:7029 ../src/guestfs-actions.pod:7048 ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7113
4945 "This function returns a NULL-terminated array of strings (like "
4946 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4947 "strings and the array after use>."
4951 #: ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:992 ../src/guestfs-actions.pod:1010 ../src/guestfs-actions.pod:1415 ../src/guestfs-actions.pod:3083 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3723 ../src/guestfs-actions.pod:3910 ../src/guestfs-actions.pod:3943 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4975 ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5367 ../src/guestfs-actions.pod:5379 ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:6425 ../src/guestfs-actions.pod:6438 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6880 ../src/guestfs-actions.pod:6913
4952 msgid "(Added in 0.8)"
4956 #: ../src/guestfs-actions.pod:463
4957 msgid "guestfs_aug_match"
4961 #: ../src/guestfs-actions.pod:465
4965 " guestfs_aug_match (guestfs_h *g,\n"
4966 " const char *augpath);\n"
4971 #: ../src/guestfs-actions.pod:469 ../fish/guestfish-actions.pod:306
4973 "Returns a list of paths which match the path expression C<path>. The "
4974 "returned paths are sufficiently qualified so that they match exactly one "
4975 "node in the current tree."
4979 #: ../src/guestfs-actions.pod:479
4980 msgid "guestfs_aug_mv"
4984 #: ../src/guestfs-actions.pod:481
4988 " guestfs_aug_mv (guestfs_h *g,\n"
4989 " const char *src,\n"
4990 " const char *dest);\n"
4995 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:314
4997 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4998 "C<dest> is overwritten if it exists."
5002 #: ../src/guestfs-actions.pod:493
5003 msgid "guestfs_aug_rm"
5007 #: ../src/guestfs-actions.pod:495
5011 " guestfs_aug_rm (guestfs_h *g,\n"
5012 " const char *augpath);\n"
5017 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5018 msgid "Remove C<path> and all of its children."
5022 #: ../src/guestfs-actions.pod:501 ../fish/guestfish-actions.pod:323
5023 msgid "On success this returns the number of entries which were removed."
5027 #: ../src/guestfs-actions.pod:507
5028 msgid "guestfs_aug_save"
5032 #: ../src/guestfs-actions.pod:509
5036 " guestfs_aug_save (guestfs_h *g);\n"
5041 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:329
5042 msgid "This writes all pending changes to disk."
5046 #: ../src/guestfs-actions.pod:514
5048 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5053 #: ../src/guestfs-actions.pod:521
5054 msgid "guestfs_aug_set"
5058 #: ../src/guestfs-actions.pod:523
5062 " guestfs_aug_set (guestfs_h *g,\n"
5063 " const char *augpath,\n"
5064 " const char *val);\n"
5069 #: ../src/guestfs-actions.pod:528 ../fish/guestfish-actions.pod:338
5070 msgid "Set the value associated with C<path> to C<val>."
5074 #: ../src/guestfs-actions.pod:530
5076 "In the Augeas API, it is possible to clear a node by setting the value to "
5077 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5078 "this call. Instead you must use the C<guestfs_aug_clear> call."
5082 #: ../src/guestfs-actions.pod:539
5083 msgid "guestfs_available"
5087 #: ../src/guestfs-actions.pod:541
5091 " guestfs_available (guestfs_h *g,\n"
5092 " char *const *groups);\n"
5097 #: ../src/guestfs-actions.pod:545 ../fish/guestfish-actions.pod:349
5099 "This command is used to check the availability of some groups of "
5100 "functionality in the appliance, which not all builds of the libguestfs "
5101 "appliance will be able to provide."
5105 #: ../src/guestfs-actions.pod:549
5107 "The libguestfs groups, and the functions that those groups correspond to, "
5108 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5109 "runtime by calling C<guestfs_available_all_groups>."
5113 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:358
5115 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5116 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5117 "and Augeas (configuration file editing) functions."
5121 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5122 msgid "The command returns no error if I<all> requested groups are available."
5126 #: ../src/guestfs-actions.pod:561 ../fish/guestfish-actions.pod:365
5128 "It fails with an error if one or more of the requested groups is unavailable "
5133 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5135 "If an unknown group name is included in the list of groups then an error is "
5140 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5145 #: ../src/guestfs-actions.pod:573
5146 msgid "You must call C<guestfs_launch> before calling this function."
5150 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:379
5152 "The reason is because we don't know what groups are supported by the "
5153 "appliance/daemon until it is running and can be queried."
5157 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:385
5159 "If a group of functions is available, this does not necessarily mean that "
5160 "they will work. You still have to check for errors when calling individual "
5161 "API functions even if they are available."
5165 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:392
5167 "It is usually the job of distro packagers to build complete functionality "
5168 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5169 "with all requirements satisfied, will support everything."
5173 #: ../src/guestfs-actions.pod:595
5175 "This call was added in version C<1.0.80>. In previous versions of "
5176 "libguestfs all you could do would be to speculatively execute a command to "
5177 "find out if the daemon implemented it. See also C<guestfs_version>."
5181 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1165
5182 msgid "(Added in 1.0.80)"
5186 #: ../src/guestfs-actions.pod:606
5187 msgid "guestfs_available_all_groups"
5191 #: ../src/guestfs-actions.pod:608
5195 " guestfs_available_all_groups (guestfs_h *g);\n"
5200 #: ../src/guestfs-actions.pod:611
5202 "This command returns a list of all optional groups that this daemon knows "
5203 "about. Note this returns both supported and unsupported groups. To find "
5204 "out which ones the daemon can actually support you have to call "
5205 "C<guestfs_available> on each member of the returned list."
5209 #: ../src/guestfs-actions.pod:617
5210 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5214 #: ../src/guestfs-actions.pod:623
5215 msgid "(Added in 1.3.15)"
5219 #: ../src/guestfs-actions.pod:625
5220 msgid "guestfs_base64_in"
5224 #: ../src/guestfs-actions.pod:627
5228 " guestfs_base64_in (guestfs_h *g,\n"
5229 " const char *base64file,\n"
5230 " const char *filename);\n"
5235 #: ../src/guestfs-actions.pod:632 ../fish/guestfish-actions.pod:422
5236 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
5240 #: ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:651
5241 msgid "(Added in 1.3.5)"
5245 #: ../src/guestfs-actions.pod:639
5246 msgid "guestfs_base64_out"
5250 #: ../src/guestfs-actions.pod:641
5254 " guestfs_base64_out (guestfs_h *g,\n"
5255 " const char *filename,\n"
5256 " const char *base64file);\n"
5261 #: ../src/guestfs-actions.pod:646 ../fish/guestfish-actions.pod:431
5263 "This command downloads the contents of C<filename>, writing it out to local "
5264 "file C<base64file> encoded as base64."
5268 #: ../src/guestfs-actions.pod:653
5269 msgid "guestfs_blockdev_flushbufs"
5273 #: ../src/guestfs-actions.pod:655
5277 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5278 " const char *device);\n"
5283 #: ../src/guestfs-actions.pod:659 ../fish/guestfish-actions.pod:440
5284 msgid "This tells the kernel to flush internal buffers associated with C<device>."
5288 #: ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498 ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5289 msgid "This uses the L<blockdev(8)> command."
5293 #: ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:714 ../src/guestfs-actions.pod:732 ../src/guestfs-actions.pod:751 ../src/guestfs-actions.pod:765 ../src/guestfs-actions.pod:783 ../src/guestfs-actions.pod:797 ../src/guestfs-actions.pod:811
5294 msgid "(Added in 0.9.3)"
5298 #: ../src/guestfs-actions.pod:668
5299 msgid "guestfs_blockdev_getbsz"
5303 #: ../src/guestfs-actions.pod:670
5307 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5308 " const char *device);\n"
5313 #: ../src/guestfs-actions.pod:674 ../fish/guestfish-actions.pod:449
5314 msgid "This returns the block size of a device."
5318 #: ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:776 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5320 "(Note this is different from both I<size in blocks> and I<filesystem block "
5325 #: ../src/guestfs-actions.pod:685
5326 msgid "guestfs_blockdev_getro"
5330 #: ../src/guestfs-actions.pod:687
5334 " guestfs_blockdev_getro (guestfs_h *g,\n"
5335 " const char *device);\n"
5340 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:460
5342 "Returns a boolean indicating if the block device is read-only (true if "
5343 "read-only, false if not)."
5347 #: ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3036 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3065 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3096 ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3126 ../src/guestfs-actions.pod:3139 ../src/guestfs-actions.pod:3153 ../src/guestfs-actions.pod:3168 ../src/guestfs-actions.pod:3183 ../src/guestfs-actions.pod:4663
5348 msgid "This function returns a C truth value on success or -1 on error."
5352 #: ../src/guestfs-actions.pod:700
5353 msgid "guestfs_blockdev_getsize64"
5357 #: ../src/guestfs-actions.pod:702
5361 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5362 " const char *device);\n"
5367 #: ../src/guestfs-actions.pod:706 ../fish/guestfish-actions.pod:469
5368 msgid "This returns the size of the device in bytes."
5372 #: ../src/guestfs-actions.pod:708
5373 msgid "See also C<guestfs_blockdev_getsz>."
5377 #: ../src/guestfs-actions.pod:716
5378 msgid "guestfs_blockdev_getss"
5382 #: ../src/guestfs-actions.pod:718
5386 " guestfs_blockdev_getss (guestfs_h *g,\n"
5387 " const char *device);\n"
5392 #: ../src/guestfs-actions.pod:722 ../fish/guestfish-actions.pod:479
5394 "This returns the size of sectors on a block device. Usually 512, but can be "
5395 "larger for modern devices."
5399 #: ../src/guestfs-actions.pod:725
5401 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5406 #: ../src/guestfs-actions.pod:734
5407 msgid "guestfs_blockdev_getsz"
5411 #: ../src/guestfs-actions.pod:736
5415 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5416 " const char *device);\n"
5421 #: ../src/guestfs-actions.pod:740 ../fish/guestfish-actions.pod:491
5423 "This returns the size of the device in units of 512-byte sectors (even if "
5424 "the sectorsize isn't 512 bytes ... weird)."
5428 #: ../src/guestfs-actions.pod:743
5430 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5431 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5435 #: ../src/guestfs-actions.pod:753
5436 msgid "guestfs_blockdev_rereadpt"
5440 #: ../src/guestfs-actions.pod:755
5444 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5445 " const char *device);\n"
5450 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:504
5451 msgid "Reread the partition table on C<device>."
5455 #: ../src/guestfs-actions.pod:767
5456 msgid "guestfs_blockdev_setbsz"
5460 #: ../src/guestfs-actions.pod:769
5464 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5465 " const char *device,\n"
5466 " int blocksize);\n"
5471 #: ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:512
5472 msgid "This sets the block size of a device."
5476 #: ../src/guestfs-actions.pod:785
5477 msgid "guestfs_blockdev_setro"
5481 #: ../src/guestfs-actions.pod:787
5485 " guestfs_blockdev_setro (guestfs_h *g,\n"
5486 " const char *device);\n"
5491 #: ../src/guestfs-actions.pod:791 ../fish/guestfish-actions.pod:523
5492 msgid "Sets the block device named C<device> to read-only."
5496 #: ../src/guestfs-actions.pod:799
5497 msgid "guestfs_blockdev_setrw"
5501 #: ../src/guestfs-actions.pod:801
5505 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5506 " const char *device);\n"
5511 #: ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:531
5512 msgid "Sets the block device named C<device> to read-write."
5516 #: ../src/guestfs-actions.pod:813
5517 msgid "guestfs_case_sensitive_path"
5521 #: ../src/guestfs-actions.pod:815
5525 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5526 " const char *path);\n"
5531 #: ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:539
5533 "This can be used to resolve case insensitive paths on a filesystem which is "
5534 "case sensitive. The use case is to resolve paths which you have read from "
5535 "Windows configuration files or the Windows Registry, to the true path."
5539 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:544
5541 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5542 "(and probably others), which is that although the underlying filesystem is "
5543 "case-insensitive, the driver exports the filesystem to Linux as "
5548 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:549
5550 "One consequence of this is that special directories such as C<c:\\windows> "
5551 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5552 "precise details of how they were created. In Windows itself this would not "
5557 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:555
5559 "Bug or feature? You decide: "
5560 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5564 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
5566 "This function resolves the true case of each element in the path and returns "
5567 "the case-sensitive path."
5571 #: ../src/guestfs-actions.pod:841
5573 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5574 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5575 "how the directories were originally created under Windows)."
5579 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:566
5580 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5584 #: ../src/guestfs-actions.pod:849
5585 msgid "See also C<guestfs_realpath>."
5589 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:6605
5590 msgid "(Added in 1.0.75)"
5594 #: ../src/guestfs-actions.pod:856
5599 #: ../src/guestfs-actions.pod:858
5603 " guestfs_cat (guestfs_h *g,\n"
5604 " const char *path);\n"
5609 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:5150 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3424
5610 msgid "Return the contents of the file named C<path>."
5614 #: ../src/guestfs-actions.pod:864
5616 "Note that this function cannot correctly handle binary files (specifically, "
5617 "files containing C<\\0> character which is treated as end of string). For "
5618 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5619 "functions which have a more complex interface."
5623 #: ../src/guestfs-actions.pod:872 ../src/guestfs-actions.pod:1051 ../src/guestfs-actions.pod:1071 ../src/guestfs-actions.pod:1362 ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1484 ../src/guestfs-actions.pod:1503 ../src/guestfs-actions.pod:1752 ../src/guestfs-actions.pod:2170 ../src/guestfs-actions.pod:2189 ../src/guestfs-actions.pod:2232 ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2273 ../src/guestfs-actions.pod:2302 ../src/guestfs-actions.pod:4932 ../src/guestfs-actions.pod:4958 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:5115 ../src/guestfs-actions.pod:5139 ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6045 ../src/guestfs-actions.pod:6191 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6877 ../src/guestfs-actions.pod:6903 ../src/guestfs-actions.pod:6929 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7052 ../src/guestfs-actions.pod:7098 ../src/guestfs-actions.pod:7117 ../fish/guestfish-actions.pod:582 ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729 ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3294 ../fish/guestfish-actions.pod:3309 ../fish/guestfish-actions.pod:3385 ../fish/guestfish-actions.pod:3402 ../fish/guestfish-actions.pod:3417 ../fish/guestfish-actions.pod:4000 ../fish/guestfish-actions.pod:4046 ../fish/guestfish-actions.pod:4131 ../fish/guestfish-actions.pod:4146 ../fish/guestfish-actions.pod:4556 ../fish/guestfish-actions.pod:4574 ../fish/guestfish-actions.pod:4591 ../fish/guestfish-actions.pod:4601 ../fish/guestfish-actions.pod:4649 ../fish/guestfish-actions.pod:4659 ../fish/guestfish-actions.pod:4688 ../fish/guestfish-actions.pod:4698
5625 "Because of the message protocol, there is a transfer limit of somewhere "
5626 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5630 #: ../src/guestfs-actions.pod:875 ../src/guestfs-actions.pod:3264 ../src/guestfs-actions.pod:3326 ../src/guestfs-actions.pod:3343 ../src/guestfs-actions.pod:3431 ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:3850 ../src/guestfs-actions.pod:5038 ../src/guestfs-actions.pod:5052 ../src/guestfs-actions.pod:6764 ../src/guestfs-actions.pod:6778
5631 msgid "(Added in 0.4)"
5635 #: ../src/guestfs-actions.pod:877
5636 msgid "guestfs_checksum"
5640 #: ../src/guestfs-actions.pod:879
5644 " guestfs_checksum (guestfs_h *g,\n"
5645 " const char *csumtype,\n"
5646 " const char *path);\n"
5651 #: ../src/guestfs-actions.pod:884 ../fish/guestfish-actions.pod:589
5652 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5656 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
5658 "The type of checksum to compute is given by the C<csumtype> parameter which "
5659 "must have one of the following values:"
5663 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
5668 #: ../src/guestfs-actions.pod:894 ../fish/guestfish-actions.pod:599
5670 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5675 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
5680 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
5681 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5685 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
5690 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
5691 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5695 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
5700 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
5701 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5705 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
5710 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
5711 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5715 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
5720 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
5721 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5725 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
5730 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:624
5731 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5735 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:628
5736 msgid "The checksum is returned as a printable string."
5740 #: ../src/guestfs-actions.pod:925
5741 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5745 #: ../src/guestfs-actions.pod:927
5746 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5750 #: ../src/guestfs-actions.pod:932 ../src/guestfs-actions.pod:1240 ../src/guestfs-actions.pod:2062 ../src/guestfs-actions.pod:3038 ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3128 ../src/guestfs-actions.pod:3155 ../src/guestfs-actions.pod:6461
5751 msgid "(Added in 1.0.2)"
5755 #: ../src/guestfs-actions.pod:934
5756 msgid "guestfs_checksum_device"
5760 #: ../src/guestfs-actions.pod:936
5764 " guestfs_checksum_device (guestfs_h *g,\n"
5765 " const char *csumtype,\n"
5766 " const char *device);\n"
5771 #: ../src/guestfs-actions.pod:941
5773 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5774 "device named C<device>. For the types of checksums supported see the "
5775 "C<guestfs_checksum> command."
5779 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:4569 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4665 ../src/guestfs-actions.pod:4683 ../src/guestfs-actions.pod:4859 ../src/guestfs-actions.pod:6370 ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6790
5780 msgid "(Added in 1.3.2)"
5784 #: ../src/guestfs-actions.pod:950
5785 msgid "guestfs_checksums_out"
5789 #: ../src/guestfs-actions.pod:952
5793 " guestfs_checksums_out (guestfs_h *g,\n"
5794 " const char *csumtype,\n"
5795 " const char *directory,\n"
5796 " const char *sumsfile);\n"
5801 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:646
5803 "This command computes the checksums of all regular files in C<directory> and "
5804 "then emits a list of those checksums to the local output file C<sumsfile>."
5808 #: ../src/guestfs-actions.pod:962 ../fish/guestfish-actions.pod:650
5810 "This can be used for verifying the integrity of a virtual machine. However "
5811 "to be properly secure you should pay attention to the output of the checksum "
5812 "command (it uses the ones from GNU coreutils). In particular when the "
5813 "filename is not printable, coreutils uses a special backslash syntax. For "
5814 "more information, see the GNU coreutils info file."
5818 #: ../src/guestfs-actions.pod:972
5819 msgid "(Added in 1.3.7)"
5823 #: ../src/guestfs-actions.pod:974
5824 msgid "guestfs_chmod"
5828 #: ../src/guestfs-actions.pod:976
5832 " guestfs_chmod (guestfs_h *g,\n"
5834 " const char *path);\n"
5839 #: ../src/guestfs-actions.pod:981 ../fish/guestfish-actions.pod:664
5841 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5846 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
5848 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5849 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5854 #: ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4268 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4306 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2869 ../fish/guestfish-actions.pod:2879 ../fish/guestfish-actions.pod:2889
5855 msgid "The mode actually set is affected by the umask."
5859 #: ../src/guestfs-actions.pod:994
5860 msgid "guestfs_chown"
5864 #: ../src/guestfs-actions.pod:996
5868 " guestfs_chown (guestfs_h *g,\n"
5871 " const char *path);\n"
5876 #: ../src/guestfs-actions.pod:1002 ../fish/guestfish-actions.pod:677
5877 msgid "Change the file owner to C<owner> and group to C<group>."
5881 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:3225 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
5883 "Only numeric uid and gid are supported. If you want to use names, you will "
5884 "need to locate and parse the password file yourself (Augeas support makes "
5885 "this relatively easy)."
5889 #: ../src/guestfs-actions.pod:1012
5890 msgid "guestfs_command"
5894 #: ../src/guestfs-actions.pod:1014
5898 " guestfs_command (guestfs_h *g,\n"
5899 " char *const *arguments);\n"
5904 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:687
5906 "This call runs a command from the guest filesystem. The filesystem must be "
5907 "mounted, and must contain a compatible operating system (ie. something "
5908 "Linux, with the same or compatible processor architecture)."
5912 #: ../src/guestfs-actions.pod:1023
5914 "The single parameter is an argv-style list of arguments. The first element "
5915 "is the name of the program to run. Subsequent elements are parameters. The "
5916 "list must be non-empty (ie. must contain a program name). Note that the "
5917 "command runs directly, and is I<not> invoked via the shell (see "
5922 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:699
5923 msgid "The return value is anything printed to I<stdout> by the command."
5927 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
5929 "If the command returns a non-zero exit status, then this function returns an "
5930 "error message. The error message string is the content of I<stderr> from "
5935 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:706
5937 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5938 "C</bin>. If you require a program from another location, you should provide "
5939 "the full path in the first parameter."
5943 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:711
5945 "Shared libraries and data files required by the program must be available on "
5946 "filesystems which are mounted in the correct places. It is the caller's "
5947 "responsibility to ensure all filesystems that are needed are mounted at the "
5952 #: ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1537
5953 msgid "(Added in 0.9.1)"
5957 #: ../src/guestfs-actions.pod:1056
5958 msgid "guestfs_command_lines"
5962 #: ../src/guestfs-actions.pod:1058
5966 " guestfs_command_lines (guestfs_h *g,\n"
5967 " char *const *arguments);\n"
5972 #: ../src/guestfs-actions.pod:1062
5974 "This is the same as C<guestfs_command>, but splits the result into a list of "
5979 #: ../src/guestfs-actions.pod:1065
5980 msgid "See also: C<guestfs_sh_lines>"
5984 #: ../src/guestfs-actions.pod:1076
5985 msgid "guestfs_config"
5989 #: ../src/guestfs-actions.pod:1078
5993 " guestfs_config (guestfs_h *g,\n"
5994 " const char *qemuparam,\n"
5995 " const char *qemuvalue);\n"
6000 #: ../src/guestfs-actions.pod:1083 ../fish/guestfish-actions.pod:736
6002 "This can be used to add arbitrary qemu command line parameters of the form "
6003 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
6004 "setting some parameters which would interfere with parameters that we use."
6008 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
6009 msgid "The first character of C<param> string must be a C<-> (dash)."
6013 #: ../src/guestfs-actions.pod:1090 ../fish/guestfish-actions.pod:743
6014 msgid "C<value> can be NULL."
6018 #: ../src/guestfs-actions.pod:1096
6019 msgid "guestfs_copy_size"
6023 #: ../src/guestfs-actions.pod:1098
6027 " guestfs_copy_size (guestfs_h *g,\n"
6028 " const char *src,\n"
6029 " const char *dest,\n"
6035 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:749
6037 "This command copies exactly C<size> bytes from one source device or file "
6038 "C<src> to another destination device or file C<dest>."
6042 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6044 "Note this will fail if the source is too short or if the destination is not "
6049 #: ../src/guestfs-actions.pod:1112 ../src/guestfs-actions.pod:1235 ../src/guestfs-actions.pod:1266 ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:6456 ../src/guestfs-actions.pod:6490 ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6988
6051 "This long-running command can generate progress notification messages so "
6052 "that the caller can display a progress bar or indicator. To receive these "
6053 "messages, the caller must register a progress callback. See "
6054 "L<guestfs(3)/guestfs_set_progress_callback>."
6058 #: ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:5065 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:6717 ../src/guestfs-actions.pod:6803
6059 msgid "(Added in 1.0.87)"
6063 #: ../src/guestfs-actions.pod:1119
6068 #: ../src/guestfs-actions.pod:1121
6072 " guestfs_cp (guestfs_h *g,\n"
6073 " const char *src,\n"
6074 " const char *dest);\n"
6079 #: ../src/guestfs-actions.pod:1126 ../fish/guestfish-actions.pod:759
6081 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6082 "destination filename or destination directory."
6086 #: ../src/guestfs-actions.pod:1131 ../src/guestfs-actions.pod:1145 ../src/guestfs-actions.pod:1217 ../src/guestfs-actions.pod:1291 ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4909
6087 msgid "(Added in 1.0.18)"
6091 #: ../src/guestfs-actions.pod:1133
6092 msgid "guestfs_cp_a"
6096 #: ../src/guestfs-actions.pod:1135
6100 " guestfs_cp_a (guestfs_h *g,\n"
6101 " const char *src,\n"
6102 " const char *dest);\n"
6107 #: ../src/guestfs-actions.pod:1140 ../fish/guestfish-actions.pod:766
6109 "This copies a file or directory from C<src> to C<dest> recursively using the "
6114 #: ../src/guestfs-actions.pod:1147
6119 #: ../src/guestfs-actions.pod:1149
6123 " guestfs_dd (guestfs_h *g,\n"
6124 " const char *src,\n"
6125 " const char *dest);\n"
6130 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:773
6132 "This command copies from one source device or file C<src> to another "
6133 "destination device or file C<dest>. Normally you would use this to copy to "
6134 "or from a device or partition, for example to duplicate a filesystem."
6138 #: ../src/guestfs-actions.pod:1159
6140 "If the destination is a device, it must be as large or larger than the "
6141 "source file or device, otherwise the copy will fail. This command cannot do "
6142 "partial copies (see C<guestfs_copy_size>)."
6146 #: ../src/guestfs-actions.pod:1167
6151 #: ../src/guestfs-actions.pod:1169
6155 " guestfs_df (guestfs_h *g);\n"
6160 #: ../src/guestfs-actions.pod:1172 ../fish/guestfish-actions.pod:786
6161 msgid "This command runs the C<df> command to report disk space used."
6165 #: ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6167 "This command is mostly useful for interactive sessions. It is I<not> "
6168 "intended that you try to parse the output string. Use C<statvfs> from "
6173 #: ../src/guestfs-actions.pod:1181 ../src/guestfs-actions.pod:1198 ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:2235 ../src/guestfs-actions.pod:2259 ../src/guestfs-actions.pod:2327 ../src/guestfs-actions.pod:3973 ../src/guestfs-actions.pod:4432 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6218 ../src/guestfs-actions.pod:6836 ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6862
6174 msgid "(Added in 1.0.54)"
6178 #: ../src/guestfs-actions.pod:1183
6179 msgid "guestfs_df_h"
6183 #: ../src/guestfs-actions.pod:1185
6187 " guestfs_df_h (guestfs_h *g);\n"
6192 #: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:796
6194 "This command runs the C<df -h> command to report disk space used in "
6195 "human-readable format."
6199 #: ../src/guestfs-actions.pod:1200
6200 msgid "guestfs_dmesg"
6204 #: ../src/guestfs-actions.pod:1202
6208 " guestfs_dmesg (guestfs_h *g);\n"
6213 #: ../src/guestfs-actions.pod:1205 ../fish/guestfish-actions.pod:807
6215 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6216 "This is sometimes useful for extended debugging of problems."
6220 #: ../src/guestfs-actions.pod:1209
6222 "Another way to get the same information is to enable verbose messages with "
6223 "C<guestfs_set_verbose> or by setting the environment variable "
6224 "C<LIBGUESTFS_DEBUG=1> before running the program."
6228 #: ../src/guestfs-actions.pod:1219
6229 msgid "guestfs_download"
6233 #: ../src/guestfs-actions.pod:1221
6237 " guestfs_download (guestfs_h *g,\n"
6238 " const char *remotefilename,\n"
6239 " const char *filename);\n"
6244 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1251 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6246 "Download file C<remotefilename> and save it as C<filename> on the local "
6251 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:6450 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4304
6252 msgid "C<filename> can also be a named pipe."
6256 #: ../src/guestfs-actions.pod:1231
6257 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6261 #: ../src/guestfs-actions.pod:1242
6262 msgid "guestfs_download_offset"
6266 #: ../src/guestfs-actions.pod:1244
6270 " guestfs_download_offset (guestfs_h *g,\n"
6271 " const char *remotefilename,\n"
6272 " const char *filename,\n"
6273 " int64_t offset,\n"
6279 #: ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:836
6281 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6282 "region must be within the file or device)."
6286 #: ../src/guestfs-actions.pod:1257
6288 "Note that there is no limit on the amount of data that can be downloaded "
6289 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6290 "full amount unless an error occurs."
6294 #: ../src/guestfs-actions.pod:1262
6295 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6299 #: ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:6495
6300 msgid "(Added in 1.5.17)"
6304 #: ../src/guestfs-actions.pod:1273
6305 msgid "guestfs_drop_caches"
6309 #: ../src/guestfs-actions.pod:1275
6313 " guestfs_drop_caches (guestfs_h *g,\n"
6314 " int whattodrop);\n"
6319 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:852
6321 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6322 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6323 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6327 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
6328 msgid "Setting C<whattodrop> to 3 should drop everything."
6332 #: ../src/guestfs-actions.pod:1286 ../fish/guestfish-actions.pod:859
6334 "This automatically calls L<sync(2)> before the operation, so that the "
6335 "maximum guest memory is freed."
6339 #: ../src/guestfs-actions.pod:1293
6344 #: ../src/guestfs-actions.pod:1295
6348 " guestfs_du (guestfs_h *g,\n"
6349 " const char *path);\n"
6354 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:866
6356 "This command runs the C<du -s> command to estimate file space usage for "
6361 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
6363 "C<path> can be a file or a directory. If C<path> is a directory then the "
6364 "estimate includes the contents of the directory and all subdirectories "
6369 #: ../src/guestfs-actions.pod:1306 ../fish/guestfish-actions.pod:873
6370 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6374 #: ../src/guestfs-actions.pod:1313
6375 msgid "guestfs_e2fsck_f"
6379 #: ../src/guestfs-actions.pod:1315
6383 " guestfs_e2fsck_f (guestfs_h *g,\n"
6384 " const char *device);\n"
6389 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:880
6391 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6392 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6397 #: ../src/guestfs-actions.pod:1323
6399 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6400 "Normally you should use C<guestfs_fsck>."
6404 #: ../src/guestfs-actions.pod:1328
6405 msgid "(Added in 1.0.29)"
6409 #: ../src/guestfs-actions.pod:1330
6410 msgid "guestfs_echo_daemon"
6414 #: ../src/guestfs-actions.pod:1332
6418 " guestfs_echo_daemon (guestfs_h *g,\n"
6419 " char *const *words);\n"
6424 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:891
6426 "This command concatenates the list of C<words> passed with single spaces "
6427 "between them and returns the resulting string."
6431 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
6432 msgid "You can use this command to test the connection through to the daemon."
6436 #: ../src/guestfs-actions.pod:1341
6437 msgid "See also C<guestfs_ping_daemon>."
6441 #: ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:5698
6442 msgid "(Added in 1.0.69)"
6446 #: ../src/guestfs-actions.pod:1348
6447 msgid "guestfs_egrep"
6451 #: ../src/guestfs-actions.pod:1350
6455 " guestfs_egrep (guestfs_h *g,\n"
6456 " const char *regex,\n"
6457 " const char *path);\n"
6462 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:902
6463 msgid "This calls the external C<egrep> program and returns the matching lines."
6467 #: ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1384 ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1487 ../src/guestfs-actions.pod:1506 ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:2192 ../src/guestfs-actions.pod:2348 ../src/guestfs-actions.pod:2361 ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:2422 ../src/guestfs-actions.pod:2444 ../src/guestfs-actions.pod:2457 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3370 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3397 ../src/guestfs-actions.pod:4367 ../src/guestfs-actions.pod:5243 ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:6062 ../src/guestfs-actions.pod:6074 ../src/guestfs-actions.pod:6087 ../src/guestfs-actions.pod:6100 ../src/guestfs-actions.pod:6122 ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6161 ../src/guestfs-actions.pod:6932 ../src/guestfs-actions.pod:6951 ../src/guestfs-actions.pod:7036 ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7120
6468 msgid "(Added in 1.0.66)"
6472 #: ../src/guestfs-actions.pod:1367
6473 msgid "guestfs_egrepi"
6477 #: ../src/guestfs-actions.pod:1369
6481 " guestfs_egrepi (guestfs_h *g,\n"
6482 " const char *regex,\n"
6483 " const char *path);\n"
6488 #: ../src/guestfs-actions.pod:1374 ../fish/guestfish-actions.pod:912
6489 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6493 #: ../src/guestfs-actions.pod:1386
6494 msgid "guestfs_equal"
6498 #: ../src/guestfs-actions.pod:1388
6502 " guestfs_equal (guestfs_h *g,\n"
6503 " const char *file1,\n"
6504 " const char *file2);\n"
6509 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:922
6511 "This compares the two files C<file1> and C<file2> and returns true if their "
6512 "content is exactly equal, or false otherwise."
6516 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
6517 msgid "The external L<cmp(1)> program is used for the comparison."
6521 #: ../src/guestfs-actions.pod:1402
6522 msgid "guestfs_exists"
6526 #: ../src/guestfs-actions.pod:1404
6530 " guestfs_exists (guestfs_h *g,\n"
6531 " const char *path);\n"
6536 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:931
6538 "This returns C<true> if and only if there is a file, directory (or anything) "
6539 "with the given C<path> name."
6543 #: ../src/guestfs-actions.pod:1411
6544 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6548 #: ../src/guestfs-actions.pod:1417
6549 msgid "guestfs_fallocate"
6553 #: ../src/guestfs-actions.pod:1419
6557 " guestfs_fallocate (guestfs_h *g,\n"
6558 " const char *path,\n"
6564 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6566 "This command preallocates a file (containing zero bytes) named C<path> of "
6567 "size C<len> bytes. If the file exists already, it is overwritten."
6571 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:944
6573 "Do not confuse this with the guestfish-specific C<alloc> command which "
6574 "allocates a file in the host and attaches it as a device."
6578 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:948
6580 "This function is deprecated. In new code, use the C<fallocate64> call "
6585 #: ../src/guestfs-actions.pod:1443
6586 msgid "guestfs_fallocate64"
6590 #: ../src/guestfs-actions.pod:1445
6594 " guestfs_fallocate64 (guestfs_h *g,\n"
6595 " const char *path,\n"
6601 #: ../src/guestfs-actions.pod:1454
6603 "Note that this call allocates disk blocks for the file. To create a sparse "
6604 "file use C<guestfs_truncate_size> instead."
6608 #: ../src/guestfs-actions.pod:1457
6610 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6611 "oversight it only allowed 30 bit lengths to be specified, effectively "
6612 "limiting the maximum size of files created through that call to 1GB."
6616 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:971
6618 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6619 "commands which create a file in the host and attach it as a device."
6623 #: ../src/guestfs-actions.pod:1468
6624 msgid "(Added in 1.3.17)"
6628 #: ../src/guestfs-actions.pod:1470
6629 msgid "guestfs_fgrep"
6633 #: ../src/guestfs-actions.pod:1472
6637 " guestfs_fgrep (guestfs_h *g,\n"
6638 " const char *pattern,\n"
6639 " const char *path);\n"
6644 #: ../src/guestfs-actions.pod:1477 ../fish/guestfish-actions.pod:979
6645 msgid "This calls the external C<fgrep> program and returns the matching lines."
6649 #: ../src/guestfs-actions.pod:1489
6650 msgid "guestfs_fgrepi"
6654 #: ../src/guestfs-actions.pod:1491
6658 " guestfs_fgrepi (guestfs_h *g,\n"
6659 " const char *pattern,\n"
6660 " const char *path);\n"
6665 #: ../src/guestfs-actions.pod:1496 ../fish/guestfish-actions.pod:989
6666 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6670 #: ../src/guestfs-actions.pod:1508
6671 msgid "guestfs_file"
6675 #: ../src/guestfs-actions.pod:1510
6679 " guestfs_file (guestfs_h *g,\n"
6680 " const char *path);\n"
6685 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:999
6687 "This call uses the standard L<file(1)> command to determine the type or "
6688 "contents of the file."
6692 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
6694 "This call will also transparently look inside various types of compressed "
6699 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
6701 "The exact command which runs is C<file -zb path>. Note in particular that "
6702 "the filename is not prepended to the output (the C<-b> option)."
6706 #: ../src/guestfs-actions.pod:1524
6708 "This command can also be used on C</dev/> devices (and partitions, LV "
6709 "names). You can for example use this to determine if a device contains a "
6710 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6714 #: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1014
6716 "If the C<path> does not begin with C</dev/> then this command only works for "
6717 "the content of regular files. For other file types (directory, symbolic "
6718 "link etc) it will just return the string C<directory> etc."
6722 #: ../src/guestfs-actions.pod:1539
6723 msgid "guestfs_file_architecture"
6727 #: ../src/guestfs-actions.pod:1541
6731 " guestfs_file_architecture (guestfs_h *g,\n"
6732 " const char *filename);\n"
6737 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
6739 "This detects the architecture of the binary C<filename>, and returns it if "
6744 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
6745 msgid "Currently defined architectures are:"
6749 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
6754 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
6756 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6757 "irrespective of the precise processor requirements of the binary."
6761 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
6766 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
6767 msgid "64 bit x86-64."
6771 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
6776 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
6777 msgid "32 bit SPARC."
6781 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
6786 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
6787 msgid "64 bit SPARC V9 and above."
6791 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
6796 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
6797 msgid "Intel Itanium."
6801 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
6806 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
6807 msgid "32 bit Power PC."
6811 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
6816 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
6817 msgid "64 bit Power PC."
6821 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
6822 msgid "Libguestfs may return other architecture strings in future."
6826 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
6827 msgid "The function works on at least the following types of files:"
6831 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
6832 msgid "many types of Un*x and Linux binary"
6836 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
6837 msgid "many types of Un*x and Linux shared library"
6841 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
6842 msgid "Windows Win32 and Win64 binaries"
6846 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
6847 msgid "Windows Win32 and Win64 DLLs"
6851 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
6852 msgid "Win32 binaries and DLLs return C<i386>."
6856 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
6857 msgid "Win64 binaries and DLLs return C<x86_64>."
6861 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
6862 msgid "Linux kernel modules"
6866 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
6867 msgid "Linux new-style initrd images"
6871 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
6872 msgid "some non-x86 Linux vmlinuz kernels"
6876 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
6877 msgid "What it can't do currently:"
6881 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
6882 msgid "static libraries (libfoo.a)"
6886 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
6887 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6891 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
6892 msgid "x86 Linux vmlinuz kernels"
6896 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
6898 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6899 "compressed code, and are horribly hard to unpack. If you want to find the "
6900 "architecture of a kernel, use the architecture of the associated initrd or "
6901 "kernel module(s) instead."
6905 #: ../src/guestfs-actions.pod:1649 ../src/guestfs-actions.pod:1812 ../src/guestfs-actions.pod:1829 ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:2561 ../src/guestfs-actions.pod:2587 ../src/guestfs-actions.pod:2636 ../src/guestfs-actions.pod:2657 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2774 ../src/guestfs-actions.pod:2836 ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3141
6906 msgid "(Added in 1.5.3)"
6910 #: ../src/guestfs-actions.pod:1651
6911 msgid "guestfs_filesize"
6915 #: ../src/guestfs-actions.pod:1653
6919 " guestfs_filesize (guestfs_h *g,\n"
6920 " const char *file);\n"
6925 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
6926 msgid "This command returns the size of C<file> in bytes."
6930 #: ../src/guestfs-actions.pod:1659
6932 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6933 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6934 "devices, use C<guestfs_blockdev_getsize64>."
6938 #: ../src/guestfs-actions.pod:1665
6939 msgid "(Added in 1.0.82)"
6943 #: ../src/guestfs-actions.pod:1667
6944 msgid "guestfs_fill"
6948 #: ../src/guestfs-actions.pod:1669
6952 " guestfs_fill (guestfs_h *g,\n"
6955 " const char *path);\n"
6960 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
6962 "This command creates a new file called C<path>. The initial content of the "
6963 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6968 #: ../src/guestfs-actions.pod:1679
6970 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6971 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6972 "bytes use C<guestfs_fill_pattern>."
6976 #: ../src/guestfs-actions.pod:1691
6977 msgid "(Added in 1.0.79)"
6981 #: ../src/guestfs-actions.pod:1693
6982 msgid "guestfs_fill_pattern"
6986 #: ../src/guestfs-actions.pod:1695
6990 " guestfs_fill_pattern (guestfs_h *g,\n"
6991 " const char *pattern,\n"
6993 " const char *path);\n"
6998 #: ../src/guestfs-actions.pod:1701
7000 "This function is like C<guestfs_fill> except that it creates a new file of "
7001 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
7002 "pattern is truncated if necessary to ensure the length of the file is "
7003 "exactly C<len> bytes."
7007 #: ../src/guestfs-actions.pod:1713
7008 msgid "(Added in 1.3.12)"
7012 #: ../src/guestfs-actions.pod:1715
7013 msgid "guestfs_find"
7017 #: ../src/guestfs-actions.pod:1717
7021 " guestfs_find (guestfs_h *g,\n"
7022 " const char *directory);\n"
7027 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7029 "This command lists out all files and directories, recursively, starting at "
7030 "C<directory>. It is essentially equivalent to running the shell command "
7031 "C<find directory -print> but some post-processing happens on the output, "
7036 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7038 "This returns a list of strings I<without any prefix>. Thus if the directory "
7043 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7053 #: ../src/guestfs-actions.pod:1733
7054 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7058 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7069 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7070 msgid "If C<directory> is not a directory, then this command returns an error."
7074 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7075 msgid "The returned list is sorted."
7079 #: ../src/guestfs-actions.pod:1746
7080 msgid "See also C<guestfs_find0>."
7084 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5327
7085 msgid "(Added in 1.0.27)"
7089 #: ../src/guestfs-actions.pod:1757
7090 msgid "guestfs_find0"
7094 #: ../src/guestfs-actions.pod:1759
7098 " guestfs_find0 (guestfs_h *g,\n"
7099 " const char *directory,\n"
7100 " const char *files);\n"
7105 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7107 "This command lists out all files and directories, recursively, starting at "
7108 "C<directory>, placing the resulting list in the external file called "
7113 #: ../src/guestfs-actions.pod:1768
7115 "This command works the same way as C<guestfs_find> with the following "
7120 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7121 msgid "The resulting list is written to an external file."
7125 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7127 "Items (filenames) in the result are separated by C<\\0> characters. See "
7128 "L<find(1)> option I<-print0>."
7132 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7133 msgid "This command is not limited in the number of names that it can return."
7137 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7138 msgid "The result list is not sorted."
7142 #: ../src/guestfs-actions.pod:1795
7143 msgid "(Added in 1.0.74)"
7147 #: ../src/guestfs-actions.pod:1797
7148 msgid "guestfs_findfs_label"
7152 #: ../src/guestfs-actions.pod:1799
7156 " guestfs_findfs_label (guestfs_h *g,\n"
7157 " const char *label);\n"
7162 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
7164 "This command searches the filesystems and returns the one which has the "
7165 "given label. An error is returned if no such filesystem can be found."
7169 #: ../src/guestfs-actions.pod:1807
7170 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7174 #: ../src/guestfs-actions.pod:1814
7175 msgid "guestfs_findfs_uuid"
7179 #: ../src/guestfs-actions.pod:1816
7183 " guestfs_findfs_uuid (guestfs_h *g,\n"
7184 " const char *uuid);\n"
7189 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
7191 "This command searches the filesystems and returns the one which has the "
7192 "given UUID. An error is returned if no such filesystem can be found."
7196 #: ../src/guestfs-actions.pod:1824
7197 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7201 #: ../src/guestfs-actions.pod:1831
7202 msgid "guestfs_fsck"
7206 #: ../src/guestfs-actions.pod:1833
7210 " guestfs_fsck (guestfs_h *g,\n"
7211 " const char *fstype,\n"
7212 " const char *device);\n"
7217 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
7219 "This runs the filesystem checker (fsck) on C<device> which should have "
7220 "filesystem type C<fstype>."
7224 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
7226 "The returned integer is the status. See L<fsck(8)> for the list of status "
7227 "codes from C<fsck>."
7231 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
7232 msgid "Multiple status codes can be summed together."
7236 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
7238 "A non-zero return code can mean \"success\", for example if errors have been "
7239 "corrected on the filesystem."
7243 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
7244 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7248 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
7249 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7253 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:6974
7254 msgid "(Added in 1.0.16)"
7258 #: ../src/guestfs-actions.pod:1870
7259 msgid "guestfs_get_append"
7263 #: ../src/guestfs-actions.pod:1872
7267 " guestfs_get_append (guestfs_h *g);\n"
7272 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
7274 "Return the additional kernel options which are added to the guest kernel "
7279 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
7280 msgid "If C<NULL> then no options are added."
7284 #: ../src/guestfs-actions.pod:1880
7286 "This function returns a string which may be NULL. There is no way to return "
7287 "an error from this function. The string is owned by the guest handle and "
7288 "must I<not> be freed."
7292 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:5005 ../src/guestfs-actions.pod:5468 ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:5855 ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:5888 ../src/guestfs-actions.pod:6645 ../src/guestfs-actions.pod:6663 ../src/guestfs-actions.pod:7017
7293 msgid "(Added in 1.0.26)"
7297 #: ../src/guestfs-actions.pod:1886
7298 msgid "guestfs_get_autosync"
7302 #: ../src/guestfs-actions.pod:1888
7306 " guestfs_get_autosync (guestfs_h *g);\n"
7311 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
7312 msgid "Get the autosync flag."
7316 #: ../src/guestfs-actions.pod:1897
7317 msgid "guestfs_get_direct"
7321 #: ../src/guestfs-actions.pod:1899
7325 " guestfs_get_direct (guestfs_h *g);\n"
7330 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
7331 msgid "Return the direct appliance mode flag."
7335 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5509
7336 msgid "(Added in 1.0.72)"
7340 #: ../src/guestfs-actions.pod:1908
7341 msgid "guestfs_get_e2label"
7345 #: ../src/guestfs-actions.pod:1910
7349 " guestfs_get_e2label (guestfs_h *g,\n"
7350 " const char *device);\n"
7355 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
7356 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7360 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1305
7362 "This function is deprecated. In new code, use the C<vfs_label> call "
7367 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:5527 ../src/guestfs-actions.pod:5546
7368 msgid "(Added in 1.0.15)"
7372 #: ../src/guestfs-actions.pod:1929
7373 msgid "guestfs_get_e2uuid"
7377 #: ../src/guestfs-actions.pod:1931
7381 " guestfs_get_e2uuid (guestfs_h *g,\n"
7382 " const char *device);\n"
7387 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
7388 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7392 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1319
7393 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7397 #: ../src/guestfs-actions.pod:1950
7398 msgid "guestfs_get_memsize"
7402 #: ../src/guestfs-actions.pod:1952
7406 " guestfs_get_memsize (guestfs_h *g);\n"
7411 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
7412 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7416 #: ../src/guestfs-actions.pod:1958
7418 "If C<guestfs_set_memsize> was not called on this handle, and if "
7419 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7420 "value for memsize."
7424 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5669 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3711 ../fish/guestfish-actions.pod:3798
7425 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7429 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:4272 ../src/guestfs-actions.pod:4291 ../src/guestfs-actions.pod:4310 ../src/guestfs-actions.pod:4322 ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5567 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6411
7430 msgid "(Added in 1.0.55)"
7434 #: ../src/guestfs-actions.pod:1969
7435 msgid "guestfs_get_network"
7439 #: ../src/guestfs-actions.pod:1971
7443 " guestfs_get_network (guestfs_h *g);\n"
7448 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
7449 msgid "This returns the enable network flag."
7453 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5586
7454 msgid "(Added in 1.5.4)"
7458 #: ../src/guestfs-actions.pod:1980
7459 msgid "guestfs_get_path"
7463 #: ../src/guestfs-actions.pod:1982
7467 " guestfs_get_path (guestfs_h *g);\n"
7472 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
7473 msgid "Return the current search path."
7477 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
7479 "This is always non-NULL. If it wasn't set already, then this will return "
7484 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
7486 "This function returns a string, or NULL on error. The string is owned by "
7487 "the guest handle and must I<not> be freed."
7491 #: ../src/guestfs-actions.pod:1995
7492 msgid "guestfs_get_pid"
7496 #: ../src/guestfs-actions.pod:1997
7500 " guestfs_get_pid (guestfs_h *g);\n"
7505 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
7507 "Return the process ID of the qemu subprocess. If there is no qemu "
7508 "subprocess, then this will return an error."
7512 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
7513 msgid "This is an internal call used for debugging and testing."
7517 #: ../src/guestfs-actions.pod:2007
7518 msgid "(Added in 1.0.56)"
7522 #: ../src/guestfs-actions.pod:2009
7523 msgid "guestfs_get_qemu"
7527 #: ../src/guestfs-actions.pod:2011
7531 " guestfs_get_qemu (guestfs_h *g);\n"
7536 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
7537 msgid "Return the current qemu binary."
7541 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
7543 "This is always non-NULL. If it wasn't set already, then this will return "
7544 "the default qemu binary name."
7548 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5631
7549 msgid "(Added in 1.0.6)"
7553 #: ../src/guestfs-actions.pod:2024
7554 msgid "guestfs_get_recovery_proc"
7558 #: ../src/guestfs-actions.pod:2026
7562 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7567 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
7568 msgid "Return the recovery process enabled flag."
7572 #: ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3930 ../src/guestfs-actions.pod:4935 ../src/guestfs-actions.pod:5278 ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6526
7573 msgid "(Added in 1.0.77)"
7577 #: ../src/guestfs-actions.pod:2035
7578 msgid "guestfs_get_selinux"
7582 #: ../src/guestfs-actions.pod:2037
7586 " guestfs_get_selinux (guestfs_h *g);\n"
7591 #: ../src/guestfs-actions.pod:2040
7593 "This returns the current setting of the selinux flag which is passed to the "
7594 "appliance at boot time. See C<guestfs_set_selinux>."
7598 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111 ../src/guestfs-actions.pod:5674 ../src/guestfs-actions.pod:5728
7599 msgid "(Added in 1.0.67)"
7603 #: ../src/guestfs-actions.pod:2050
7604 msgid "guestfs_get_state"
7608 #: ../src/guestfs-actions.pod:2052
7612 " guestfs_get_state (guestfs_h *g);\n"
7617 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
7619 "This returns the current state as an opaque integer. This is only useful "
7620 "for printing debug and internal error messages."
7624 #: ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:3034 ../src/guestfs-actions.pod:3063 ../src/guestfs-actions.pod:3124 ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
7625 msgid "For more information on states, see L<guestfs(3)>."
7629 #: ../src/guestfs-actions.pod:2064
7630 msgid "guestfs_get_trace"
7634 #: ../src/guestfs-actions.pod:2066
7638 " guestfs_get_trace (guestfs_h *g);\n"
7643 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
7644 msgid "Return the command trace flag."
7648 #: ../src/guestfs-actions.pod:2075
7649 msgid "guestfs_get_umask"
7653 #: ../src/guestfs-actions.pod:2077
7657 " guestfs_get_umask (guestfs_h *g);\n"
7662 #: ../src/guestfs-actions.pod:2080
7664 "Return the current umask. By default the umask is C<022> unless it has been "
7665 "set by calling C<guestfs_umask>."
7669 #: ../src/guestfs-actions.pod:2087
7670 msgid "guestfs_get_verbose"
7674 #: ../src/guestfs-actions.pod:2089
7678 " guestfs_get_verbose (guestfs_h *g);\n"
7683 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
7684 msgid "This returns the verbose messages flag."
7688 #: ../src/guestfs-actions.pod:2098
7689 msgid "guestfs_getcon"
7693 #: ../src/guestfs-actions.pod:2100
7697 " guestfs_getcon (guestfs_h *g);\n"
7702 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
7703 msgid "This gets the SELinux security context of the daemon."
7707 #: ../src/guestfs-actions.pod:2105
7708 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7712 #: ../src/guestfs-actions.pod:2113
7713 msgid "guestfs_getxattrs"
7717 #: ../src/guestfs-actions.pod:2115
7720 " struct guestfs_xattr_list *\n"
7721 " guestfs_getxattrs (guestfs_h *g,\n"
7722 " const char *path);\n"
7727 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1432
7728 msgid "This call lists the extended attributes of the file or directory C<path>."
7732 #: ../src/guestfs-actions.pod:2122 ../fish/guestfish-actions.pod:1435
7734 "At the system call level, this is a combination of the L<listxattr(2)> and "
7735 "L<getxattr(2)> calls."
7739 #: ../src/guestfs-actions.pod:2125
7740 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7744 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:3894
7746 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7747 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7751 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:5308 ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:7082
7752 msgid "(Added in 1.0.59)"
7756 #: ../src/guestfs-actions.pod:2133
7757 msgid "guestfs_glob_expand"
7761 #: ../src/guestfs-actions.pod:2135
7765 " guestfs_glob_expand (guestfs_h *g,\n"
7766 " const char *pattern);\n"
7771 #: ../src/guestfs-actions.pod:2139 ../fish/guestfish-actions.pod:1444
7773 "This command searches for all the pathnames matching C<pattern> according to "
7774 "the wildcard expansion rules used by the shell."
7778 #: ../src/guestfs-actions.pod:2143 ../fish/guestfish-actions.pod:1448
7779 msgid "If no paths match, then this returns an empty list (note: not an error)."
7783 #: ../src/guestfs-actions.pod:2146 ../fish/guestfish-actions.pod:1451
7785 "It is just a wrapper around the C L<glob(3)> function with flags "
7786 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7790 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:5929
7791 msgid "(Added in 1.0.50)"
7795 #: ../src/guestfs-actions.pod:2156
7796 msgid "guestfs_grep"
7800 #: ../src/guestfs-actions.pod:2158
7804 " guestfs_grep (guestfs_h *g,\n"
7805 " const char *regex,\n"
7806 " const char *path);\n"
7811 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1459
7812 msgid "This calls the external C<grep> program and returns the matching lines."
7816 #: ../src/guestfs-actions.pod:2175
7817 msgid "guestfs_grepi"
7821 #: ../src/guestfs-actions.pod:2177
7825 " guestfs_grepi (guestfs_h *g,\n"
7826 " const char *regex,\n"
7827 " const char *path);\n"
7832 #: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1469
7833 msgid "This calls the external C<grep -i> program and returns the matching lines."
7837 #: ../src/guestfs-actions.pod:2194
7838 msgid "guestfs_grub_install"
7842 #: ../src/guestfs-actions.pod:2196
7846 " guestfs_grub_install (guestfs_h *g,\n"
7847 " const char *root,\n"
7848 " const char *device);\n"
7853 #: ../src/guestfs-actions.pod:2201 ../fish/guestfish-actions.pod:1479
7855 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7856 "the root directory being C<root>."
7860 #: ../src/guestfs-actions.pod:2204 ../fish/guestfish-actions.pod:1482
7862 "Note: If grub-install reports the error \"No suitable drive was found in the "
7863 "generated device map.\" it may be that you need to create a "
7864 "C</boot/grub/device.map> file first that contains the mapping between grub "
7865 "device names and Linux device names. It is usually sufficient to create a "
7870 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1489
7878 #: ../src/guestfs-actions.pod:2213 ../fish/guestfish-actions.pod:1491
7879 msgid "replacing C</dev/vda> with the name of the installation device."
7883 #: ../src/guestfs-actions.pod:2217
7884 msgid "(Added in 1.0.17)"
7888 #: ../src/guestfs-actions.pod:2219
7889 msgid "guestfs_head"
7893 #: ../src/guestfs-actions.pod:2221
7897 " guestfs_head (guestfs_h *g,\n"
7898 " const char *path);\n"
7903 #: ../src/guestfs-actions.pod:2225 ../fish/guestfish-actions.pod:1497
7905 "This command returns up to the first 10 lines of a file as a list of "
7910 #: ../src/guestfs-actions.pod:2237
7911 msgid "guestfs_head_n"
7915 #: ../src/guestfs-actions.pod:2239
7919 " guestfs_head_n (guestfs_h *g,\n"
7921 " const char *path);\n"
7926 #: ../src/guestfs-actions.pod:2244 ../fish/guestfish-actions.pod:1507
7928 "If the parameter C<nrlines> is a positive number, this returns the first "
7929 "C<nrlines> lines of the file C<path>."
7933 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
7935 "If the parameter C<nrlines> is a negative number, this returns lines from "
7936 "the file C<path>, excluding the last C<nrlines> lines."
7940 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:6209 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4144
7941 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7945 #: ../src/guestfs-actions.pod:2261
7946 msgid "guestfs_hexdump"
7950 #: ../src/guestfs-actions.pod:2263
7954 " guestfs_hexdump (guestfs_h *g,\n"
7955 " const char *path);\n"
7960 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
7962 "This runs C<hexdump -C> on the given C<path>. The result is the "
7963 "human-readable, canonical hex dump of the file."
7967 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:5993 ../src/guestfs-actions.pod:6048
7968 msgid "(Added in 1.0.22)"
7972 #: ../src/guestfs-actions.pod:2278
7973 msgid "guestfs_initrd_cat"
7977 #: ../src/guestfs-actions.pod:2280
7981 " guestfs_initrd_cat (guestfs_h *g,\n"
7982 " const char *initrdpath,\n"
7983 " const char *filename,\n"
7984 " size_t *size_r);\n"
7989 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1532
7991 "This command unpacks the file C<filename> from the initrd file called "
7992 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7997 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1536
7999 "For example, in guestfish you could use the following command to examine the "
8000 "boot script (usually called C</init>) contained in a Linux initrd or "
8005 #: ../src/guestfs-actions.pod:2294 ../fish/guestfish-actions.pod:1540
8008 " initrd-cat /boot/initrd-<version>.img init\n"
8013 #: ../src/guestfs-actions.pod:2296
8014 msgid "See also C<guestfs_initrd_list>."
8018 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:4928 ../src/guestfs-actions.pod:4954 ../src/guestfs-actions.pod:5135
8020 "This function returns a buffer, or NULL on error. The size of the returned "
8021 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8026 #: ../src/guestfs-actions.pod:2307
8027 msgid "guestfs_initrd_list"
8031 #: ../src/guestfs-actions.pod:2309
8035 " guestfs_initrd_list (guestfs_h *g,\n"
8036 " const char *path);\n"
8041 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1551
8042 msgid "This command lists out files contained in an initrd."
8046 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1553
8048 "The files are listed without any initial C</> character. The files are "
8049 "listed in the order they appear (not necessarily alphabetical). Directory "
8050 "names are listed as separate items."
8054 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1557
8056 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8057 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8062 #: ../src/guestfs-actions.pod:2329
8063 msgid "guestfs_inotify_add_watch"
8067 #: ../src/guestfs-actions.pod:2331
8071 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8072 " const char *path,\n"
8078 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1565
8079 msgid "Watch C<path> for the events listed in C<mask>."
8083 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1567
8085 "Note that if C<path> is a directory then events within that directory are "
8086 "watched, but this does I<not> happen recursively (in subdirectories)."
8090 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1571
8092 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8093 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8097 #: ../src/guestfs-actions.pod:2350
8098 msgid "guestfs_inotify_close"
8102 #: ../src/guestfs-actions.pod:2352
8106 " guestfs_inotify_close (guestfs_h *g);\n"
8111 #: ../src/guestfs-actions.pod:2355 ../fish/guestfish-actions.pod:1579
8113 "This closes the inotify handle which was previously opened by inotify_init. "
8114 "It removes all watches, throws away any pending events, and deallocates all "
8119 #: ../src/guestfs-actions.pod:2363
8120 msgid "guestfs_inotify_files"
8124 #: ../src/guestfs-actions.pod:2365
8128 " guestfs_inotify_files (guestfs_h *g);\n"
8133 #: ../src/guestfs-actions.pod:2368
8135 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8136 "returns a list of pathnames of objects that were touched. The returned "
8137 "pathnames are sorted and deduplicated."
8141 #: ../src/guestfs-actions.pod:2378
8142 msgid "guestfs_inotify_init"
8146 #: ../src/guestfs-actions.pod:2380
8150 " guestfs_inotify_init (guestfs_h *g,\n"
8151 " int maxevents);\n"
8156 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1595
8158 "This command creates a new inotify handle. The inotify subsystem can be "
8159 "used to notify events which happen to objects in the guest filesystem."
8163 #: ../src/guestfs-actions.pod:2388
8165 "C<maxevents> is the maximum number of events which will be queued up between "
8166 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8167 "passed as C<0>, then the kernel (or previously set) default is used. For "
8168 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8169 "throws away events, but records the fact that it threw them away by setting "
8170 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8171 "C<guestfs_inotify_read>)."
8175 #: ../src/guestfs-actions.pod:2398
8177 "Before any events are generated, you have to add some watches to the "
8178 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8179 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8183 #: ../src/guestfs-actions.pod:2404
8185 "Queued up events should be read periodically by calling "
8186 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8187 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8188 "often enough then you risk the internal queue overflowing."
8192 #: ../src/guestfs-actions.pod:2411
8194 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8195 "This also removes any watches automatically."
8199 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1626
8201 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8202 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8203 "that there is one global inotify handle per libguestfs instance."
8207 #: ../src/guestfs-actions.pod:2424
8208 msgid "guestfs_inotify_read"
8212 #: ../src/guestfs-actions.pod:2426
8215 " struct guestfs_inotify_event_list *\n"
8216 " guestfs_inotify_read (guestfs_h *g);\n"
8221 #: ../src/guestfs-actions.pod:2429 ../fish/guestfish-actions.pod:1635
8223 "Return the complete queue of events that have happened since the previous "
8228 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1638
8229 msgid "If no events have happened, this returns an empty list."
8233 #: ../src/guestfs-actions.pod:2434 ../fish/guestfish-actions.pod:1640
8235 "I<Note>: In order to make sure that all events have been read, you must call "
8236 "this function repeatedly until it returns an empty list. The reason is that "
8237 "the call will read events up to the maximum appliance-to-host message size "
8238 "and leave remaining events in the queue."
8242 #: ../src/guestfs-actions.pod:2440
8244 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8245 "there was an error. I<The caller must call "
8246 "C<guestfs_free_inotify_event_list> after use>."
8250 #: ../src/guestfs-actions.pod:2446
8251 msgid "guestfs_inotify_rm_watch"
8255 #: ../src/guestfs-actions.pod:2448
8259 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8265 #: ../src/guestfs-actions.pod:2452
8267 "Remove a previously defined inotify watch. See "
8268 "C<guestfs_inotify_add_watch>."
8272 #: ../src/guestfs-actions.pod:2459
8273 msgid "guestfs_inspect_get_arch"
8277 #: ../src/guestfs-actions.pod:2461
8281 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8282 " const char *root);\n"
8287 #: ../src/guestfs-actions.pod:2465 ../src/guestfs-actions.pod:2488 ../src/guestfs-actions.pod:2569 ../src/guestfs-actions.pod:2595 ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2644 ../src/guestfs-actions.pod:2665 ../src/guestfs-actions.pod:2698 ../src/guestfs-actions.pod:2727 ../src/guestfs-actions.pod:2758 ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:2867
8289 "This function should only be called with a root device string as returned by "
8290 "C<guestfs_inspect_os>."
8294 #: ../src/guestfs-actions.pod:2468
8296 "This returns the architecture of the inspected operating system. The "
8297 "possible return values are listed under C<guestfs_file_architecture>."
8301 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1664
8303 "If the architecture could not be determined, then the string C<unknown> is "
8308 #: ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2714 ../src/guestfs-actions.pod:2745 ../src/guestfs-actions.pod:2769 ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:2854 ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3001 ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741 ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909 ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960 ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8309 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8313 #: ../src/guestfs-actions.pod:2482
8314 msgid "guestfs_inspect_get_distro"
8318 #: ../src/guestfs-actions.pod:2484
8322 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8323 " const char *root);\n"
8328 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
8329 msgid "This returns the distro (distribution) of the inspected operating system."
8333 #: ../src/guestfs-actions.pod:2494 ../fish/guestfish-actions.pod:1679
8334 msgid "Currently defined distros are:"
8338 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1683
8339 msgid "\"archlinux\""
8343 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1685
8348 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1687
8353 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1689
8358 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1691
8363 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1693
8368 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1695
8373 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1697
8378 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1699
8379 msgid "\"linuxmint\""
8383 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1701
8388 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1703
8389 msgid "\"mandriva\""
8393 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1705
8398 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1707
8403 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1709
8408 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1711
8413 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1713
8418 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1715
8419 msgid "\"redhat-based\""
8423 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1717
8424 msgid "Some Red Hat-derived distro."
8428 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1719
8433 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1721
8434 msgid "Red Hat Enterprise Linux and some derivatives."
8438 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1723
8443 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1725
8448 #: ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2822 ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8453 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1729
8454 msgid "The distro could not be determined."
8458 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8463 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1733
8465 "Windows does not have distributions. This string is returned if the OS type "
8470 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8472 "Future versions of libguestfs may return other strings here. The caller "
8473 "should be prepared to handle any string."
8477 #: ../src/guestfs-actions.pod:2563
8478 msgid "guestfs_inspect_get_filesystems"
8482 #: ../src/guestfs-actions.pod:2565
8486 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8487 " const char *root);\n"
8492 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1750
8494 "This returns a list of all the filesystems that we think are associated with "
8495 "this operating system. This includes the root filesystem, other ordinary "
8496 "filesystems, and non-mounted devices like swap partitions."
8500 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1755
8502 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8503 "to be shared between operating systems."
8507 #: ../src/guestfs-actions.pod:2580
8509 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8510 "C<guestfs_inspect_get_mountpoints>."
8514 #: ../src/guestfs-actions.pod:2589
8515 msgid "guestfs_inspect_get_hostname"
8519 #: ../src/guestfs-actions.pod:2591
8523 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8524 " const char *root);\n"
8529 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1768
8531 "This function returns the hostname of the operating system as found by "
8532 "inspection of the guest's configuration files."
8536 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1771
8538 "If the hostname could not be determined, then the string C<unknown> is "
8543 #: ../src/guestfs-actions.pod:2609
8544 msgid "(Added in 1.7.9)"
8548 #: ../src/guestfs-actions.pod:2611
8549 msgid "guestfs_inspect_get_major_version"
8553 #: ../src/guestfs-actions.pod:2613
8557 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8558 " const char *root);\n"
8563 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1783
8564 msgid "This returns the major version number of the inspected operating system."
8568 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
8570 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8571 "popular public names used by the operating system. Notably the operating "
8572 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8573 "1). You can find out the real versions corresponding to releases of Windows "
8574 "by consulting Wikipedia or MSDN."
8578 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8579 msgid "If the version could not be determined, then C<0> is returned."
8583 #: ../src/guestfs-actions.pod:2638
8584 msgid "guestfs_inspect_get_minor_version"
8588 #: ../src/guestfs-actions.pod:2640
8592 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8593 " const char *root);\n"
8598 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
8599 msgid "This returns the minor version number of the inspected operating system."
8603 #: ../src/guestfs-actions.pod:2652
8605 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8606 "C<guestfs_inspect_get_major_version>."
8610 #: ../src/guestfs-actions.pod:2659
8611 msgid "guestfs_inspect_get_mountpoints"
8615 #: ../src/guestfs-actions.pod:2661
8619 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8620 " const char *root);\n"
8625 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1819
8627 "This returns a hash of where we think the filesystems associated with this "
8628 "operating system should be mounted. Callers should note that this is at "
8629 "best an educated guess made by reading configuration files such as "
8634 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1824
8636 "Each element in the returned hashtable has a key which is the path of the "
8637 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8638 "mounted there (eg. C</dev/sda1>)."
8642 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1829
8643 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8647 #: ../src/guestfs-actions.pod:2681
8649 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8650 "C<guestfs_inspect_get_filesystems>."
8654 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:4494 ../src/guestfs-actions.pod:6350
8656 "This function returns a NULL-terminated array of strings, or NULL if there "
8657 "was an error. The array of strings will always have length C<2n+1>, where "
8658 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8659 "caller must free the strings and the array after use>."
8663 #: ../src/guestfs-actions.pod:2692
8664 msgid "guestfs_inspect_get_package_format"
8668 #: ../src/guestfs-actions.pod:2694
8672 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8673 " const char *root);\n"
8678 #: ../src/guestfs-actions.pod:2701
8680 "This function and C<guestfs_inspect_get_package_management> return the "
8681 "package format and package management tool used by the inspected operating "
8682 "system. For example for Fedora these functions would return C<rpm> (package "
8683 "format) and C<yum> (package management)."
8687 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
8689 "This returns the string C<unknown> if we could not determine the package "
8690 "format I<or> if the operating system does not have a real packaging system "
8695 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
8697 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8698 "Future versions of libguestfs may return other strings."
8702 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2750
8703 msgid "(Added in 1.7.5)"
8707 #: ../src/guestfs-actions.pod:2721
8708 msgid "guestfs_inspect_get_package_management"
8712 #: ../src/guestfs-actions.pod:2723
8716 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8717 " const char *root);\n"
8722 #: ../src/guestfs-actions.pod:2730
8724 "C<guestfs_inspect_get_package_format> and this function return the package "
8725 "format and package management tool used by the inspected operating system. "
8726 "For example for Fedora these functions would return C<rpm> (package format) "
8727 "and C<yum> (package management)."
8731 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1870
8733 "This returns the string C<unknown> if we could not determine the package "
8734 "management tool I<or> if the operating system does not have a real packaging "
8735 "system (eg. Windows)."
8739 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1874
8741 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8742 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8743 "libguestfs may return other strings."
8747 #: ../src/guestfs-actions.pod:2752
8748 msgid "guestfs_inspect_get_product_name"
8752 #: ../src/guestfs-actions.pod:2754
8756 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8757 " const char *root);\n"
8762 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1888
8764 "This returns the product name of the inspected operating system. The "
8765 "product name is generally some freeform string which can be displayed to the "
8766 "user, but should not be parsed by programs."
8770 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1893
8772 "If the product name could not be determined, then the string C<unknown> is "
8777 #: ../src/guestfs-actions.pod:2776
8778 msgid "guestfs_inspect_get_roots"
8782 #: ../src/guestfs-actions.pod:2778
8786 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8791 #: ../src/guestfs-actions.pod:2781
8793 "This function is a convenient way to get the list of root devices, as "
8794 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8795 "the whole inspection process."
8799 #: ../src/guestfs-actions.pod:2785
8801 "This returns an empty list if either no root devices were found or the "
8802 "caller has not called C<guestfs_inspect_os>."
8806 #: ../src/guestfs-actions.pod:2794
8807 msgid "(Added in 1.7.3)"
8811 #: ../src/guestfs-actions.pod:2796
8812 msgid "guestfs_inspect_get_type"
8816 #: ../src/guestfs-actions.pod:2798
8820 " guestfs_inspect_get_type (guestfs_h *g,\n"
8821 " const char *root);\n"
8826 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
8828 "This returns the type of the inspected operating system. Currently defined "
8833 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1923
8838 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
8839 msgid "Any Linux-based operating system."
8843 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1929
8844 msgid "Any Microsoft Windows operating system."
8848 #: ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1931
8853 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1933
8858 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1937
8859 msgid "The operating system type could not be determined."
8863 #: ../src/guestfs-actions.pod:2838
8864 msgid "guestfs_inspect_get_windows_systemroot"
8868 #: ../src/guestfs-actions.pod:2840
8872 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8873 " const char *root);\n"
8878 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1953
8880 "This returns the Windows systemroot of the inspected guest. The systemroot "
8881 "is a directory path such as C</WINDOWS>."
8885 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1956
8887 "This call assumes that the guest is Windows and that the systemroot could be "
8888 "determined by inspection. If this is not the case then an error is "
8893 #: ../src/guestfs-actions.pod:2859
8894 msgid "(Added in 1.5.25)"
8898 #: ../src/guestfs-actions.pod:2861
8899 msgid "guestfs_inspect_list_applications"
8903 #: ../src/guestfs-actions.pod:2863
8906 " struct guestfs_application_list *\n"
8907 " guestfs_inspect_list_applications (guestfs_h *g,\n"
8908 " const char *root);\n"
8913 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1969
8914 msgid "Return the list of applications installed in the operating system."
8918 #: ../src/guestfs-actions.pod:2872
8920 "I<Note:> This call works differently from other parts of the inspection "
8921 "API. You have to call C<guestfs_inspect_os>, then "
8922 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
8923 "this. Listing applications is a significantly more difficult operation "
8924 "which requires access to the full filesystem. Also note that unlike the "
8925 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
8926 "the libguestfs handle, this call actually reads parts of the mounted "
8927 "filesystems during the call."
8931 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1981
8933 "This returns an empty list if the inspection code was not able to determine "
8934 "the list of applications."
8938 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:1984
8939 msgid "The application structure contains the following fields:"
8943 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1988
8948 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1990
8950 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8951 "guests, this is the package name."
8955 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1993
8956 msgid "C<app_display_name>"
8960 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1995
8962 "The display name of the application, sometimes localized to the install "
8963 "language of the guest operating system."
8967 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1998
8969 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8970 "to display something can use C<app_name> instead."
8974 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2001
8975 msgid "C<app_epoch>"
8979 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2003
8981 "For package managers which use epochs, this contains the epoch of the "
8982 "package (an integer). If unavailable, this is returned as C<0>."
8986 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2006
8987 msgid "C<app_version>"
8991 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2008
8993 "The version string of the application or package. If unavailable this is "
8994 "returned as an empty string C<\"\">."
8998 #: ../src/guestfs-actions.pod:2912 ../fish/guestfish-actions.pod:2011
8999 msgid "C<app_release>"
9003 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2013
9005 "The release string of the application or package, for package managers that "
9006 "use this. If unavailable this is returned as an empty string C<\"\">."
9010 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2017
9011 msgid "C<app_install_path>"
9015 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2019
9017 "The installation path of the application (on operating systems such as "
9018 "Windows which use installation paths). This path is in the format used by "
9019 "the guest operating system, it is not a libguestfs path."
9023 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2024
9024 msgid "If unavailable this is returned as an empty string C<\"\">."
9028 #: ../src/guestfs-actions.pod:2927 ../fish/guestfish-actions.pod:2026
9029 msgid "C<app_trans_path>"
9033 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2028
9035 "The install path translated into a libguestfs path. If unavailable this is "
9036 "returned as an empty string C<\"\">."
9040 #: ../src/guestfs-actions.pod:2932 ../fish/guestfish-actions.pod:2031
9041 msgid "C<app_publisher>"
9045 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2033
9047 "The name of the publisher of the application, for package managers that use "
9048 "this. If unavailable this is returned as an empty string C<\"\">."
9052 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2037
9057 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2039
9059 "The URL (eg. upstream URL) of the application. If unavailable this is "
9060 "returned as an empty string C<\"\">."
9064 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2042
9065 msgid "C<app_source_package>"
9069 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2044
9071 "For packaging systems which support this, the name of the source package. "
9072 "If unavailable this is returned as an empty string C<\"\">."
9076 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2047
9077 msgid "C<app_summary>"
9081 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2049
9083 "A short (usually one line) description of the application or package. If "
9084 "unavailable this is returned as an empty string C<\"\">."
9088 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2052
9089 msgid "C<app_description>"
9093 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2054
9095 "A longer description of the application or package. If unavailable this is "
9096 "returned as an empty string C<\"\">."
9100 #: ../src/guestfs-actions.pod:2962
9102 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9103 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9108 #: ../src/guestfs-actions.pod:2966
9109 msgid "(Added in 1.7.8)"
9113 #: ../src/guestfs-actions.pod:2968
9114 msgid "guestfs_inspect_os"
9118 #: ../src/guestfs-actions.pod:2970
9122 " guestfs_inspect_os (guestfs_h *g);\n"
9127 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2065
9129 "This function uses other libguestfs functions and certain heuristics to "
9130 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9131 "for operating systems."
9135 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2069
9136 msgid "The list returned is empty if no operating systems were found."
9140 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2071
9142 "If one operating system was found, then this returns a list with a single "
9143 "element, which is the name of the root filesystem of this operating system. "
9144 "It is also possible for this function to return a list containing more than "
9145 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9146 "element being the root filesystem of one of the operating systems."
9150 #: ../src/guestfs-actions.pod:2986
9152 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9153 "functions in order to query further information about each operating system, "
9154 "such as the name and version."
9158 #: ../src/guestfs-actions.pod:2991
9160 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9161 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9162 "the contents. This should be called with no disks currently mounted. The "
9163 "function may also use Augeas, so any existing Augeas handle will be closed."
9167 #: ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:2089
9169 "This function cannot decrypt encrypted disks. The caller must do that first "
9170 "(supplying the necessary keys) if the disk is encrypted."
9174 #: ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3320
9175 msgid "See also C<guestfs_list_filesystems>."
9179 #: ../src/guestfs-actions.pod:3011
9180 msgid "guestfs_is_blockdev"
9184 #: ../src/guestfs-actions.pod:3013
9188 " guestfs_is_blockdev (guestfs_h *g,\n"
9189 " const char *path);\n"
9194 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2101
9196 "This returns C<true> if and only if there is a block device with the given "
9201 #: ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3049 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3094 ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3166 ../src/guestfs-actions.pod:3181
9202 msgid "See also C<guestfs_stat>."
9206 #: ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3170 ../src/guestfs-actions.pod:3185
9207 msgid "(Added in 1.5.10)"
9211 #: ../src/guestfs-actions.pod:3026
9212 msgid "guestfs_is_busy"
9216 #: ../src/guestfs-actions.pod:3028
9220 " guestfs_is_busy (guestfs_h *g);\n"
9225 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2110
9227 "This returns true iff this handle is busy processing a command (in the "
9232 #: ../src/guestfs-actions.pod:3040
9233 msgid "guestfs_is_chardev"
9237 #: ../src/guestfs-actions.pod:3042
9241 " guestfs_is_chardev (guestfs_h *g,\n"
9242 " const char *path);\n"
9247 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2119
9249 "This returns C<true> if and only if there is a character device with the "
9250 "given C<path> name."
9254 #: ../src/guestfs-actions.pod:3055
9255 msgid "guestfs_is_config"
9259 #: ../src/guestfs-actions.pod:3057
9263 " guestfs_is_config (guestfs_h *g);\n"
9268 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2128
9270 "This returns true iff this handle is being configured (in the C<CONFIG> "
9275 #: ../src/guestfs-actions.pod:3069
9276 msgid "guestfs_is_dir"
9280 #: ../src/guestfs-actions.pod:3071
9284 " guestfs_is_dir (guestfs_h *g,\n"
9285 " const char *path);\n"
9290 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2137
9292 "This returns C<true> if and only if there is a directory with the given "
9293 "C<path> name. Note that it returns false for other objects like files."
9297 #: ../src/guestfs-actions.pod:3085
9298 msgid "guestfs_is_fifo"
9302 #: ../src/guestfs-actions.pod:3087
9306 " guestfs_is_fifo (guestfs_h *g,\n"
9307 " const char *path);\n"
9312 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2147
9314 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9315 "given C<path> name."
9319 #: ../src/guestfs-actions.pod:3100
9320 msgid "guestfs_is_file"
9324 #: ../src/guestfs-actions.pod:3102
9328 " guestfs_is_file (guestfs_h *g,\n"
9329 " const char *path);\n"
9334 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2156
9336 "This returns C<true> if and only if there is a regular file with the given "
9337 "C<path> name. Note that it returns false for other objects like "
9342 #: ../src/guestfs-actions.pod:3116
9343 msgid "guestfs_is_launching"
9347 #: ../src/guestfs-actions.pod:3118
9351 " guestfs_is_launching (guestfs_h *g);\n"
9356 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2166
9358 "This returns true iff this handle is launching the subprocess (in the "
9359 "C<LAUNCHING> state)."
9363 #: ../src/guestfs-actions.pod:3130
9364 msgid "guestfs_is_lv"
9368 #: ../src/guestfs-actions.pod:3132
9372 " guestfs_is_lv (guestfs_h *g,\n"
9373 " const char *device);\n"
9378 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2175
9380 "This command tests whether C<device> is a logical volume, and returns true "
9381 "iff this is the case."
9385 #: ../src/guestfs-actions.pod:3143
9386 msgid "guestfs_is_ready"
9390 #: ../src/guestfs-actions.pod:3145
9394 " guestfs_is_ready (guestfs_h *g);\n"
9399 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2182
9401 "This returns true iff this handle is ready to accept commands (in the "
9406 #: ../src/guestfs-actions.pod:3157
9407 msgid "guestfs_is_socket"
9411 #: ../src/guestfs-actions.pod:3159
9415 " guestfs_is_socket (guestfs_h *g,\n"
9416 " const char *path);\n"
9421 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2191
9423 "This returns C<true> if and only if there is a Unix domain socket with the "
9424 "given C<path> name."
9428 #: ../src/guestfs-actions.pod:3172
9429 msgid "guestfs_is_symlink"
9433 #: ../src/guestfs-actions.pod:3174
9437 " guestfs_is_symlink (guestfs_h *g,\n"
9438 " const char *path);\n"
9443 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2200
9445 "This returns C<true> if and only if there is a symbolic link with the given "
9450 #: ../src/guestfs-actions.pod:3187
9451 msgid "guestfs_kill_subprocess"
9455 #: ../src/guestfs-actions.pod:3189
9459 " guestfs_kill_subprocess (guestfs_h *g);\n"
9464 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2209
9465 msgid "This kills the qemu subprocess. You should never need to call this."
9469 #: ../src/guestfs-actions.pod:3198
9470 msgid "guestfs_launch"
9474 #: ../src/guestfs-actions.pod:3200
9478 " guestfs_launch (guestfs_h *g);\n"
9483 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2217
9485 "Internally libguestfs is implemented by running a virtual machine using "
9490 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2220
9492 "You should call this after configuring the handle (eg. adding drives) but "
9493 "before performing any actions."
9497 #: ../src/guestfs-actions.pod:3213
9498 msgid "guestfs_lchown"
9502 #: ../src/guestfs-actions.pod:3215
9506 " guestfs_lchown (guestfs_h *g,\n"
9509 " const char *path);\n"
9514 #: ../src/guestfs-actions.pod:3221
9516 "Change the file owner to C<owner> and group to C<group>. This is like "
9517 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9518 "changed, not the target."
9522 #: ../src/guestfs-actions.pod:3233
9523 msgid "guestfs_lgetxattrs"
9527 #: ../src/guestfs-actions.pod:3235
9530 " struct guestfs_xattr_list *\n"
9531 " guestfs_lgetxattrs (guestfs_h *g,\n"
9532 " const char *path);\n"
9537 #: ../src/guestfs-actions.pod:3239
9539 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9540 "then it returns the extended attributes of the link itself."
9544 #: ../src/guestfs-actions.pod:3249
9545 msgid "guestfs_list_devices"
9549 #: ../src/guestfs-actions.pod:3251
9553 " guestfs_list_devices (guestfs_h *g);\n"
9558 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2247
9559 msgid "List all the block devices."
9563 #: ../src/guestfs-actions.pod:3256 ../fish/guestfish-actions.pod:2249
9564 msgid "The full block device names are returned, eg. C</dev/sda>."
9568 #: ../src/guestfs-actions.pod:3266
9569 msgid "guestfs_list_filesystems"
9573 #: ../src/guestfs-actions.pod:3268
9577 " guestfs_list_filesystems (guestfs_h *g);\n"
9582 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2257
9584 "This inspection command looks for filesystems on partitions, block devices "
9585 "and logical volumes, returning a list of devices containing filesystems and "
9590 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2261
9592 "The return value is a hash, where the keys are the devices containing "
9593 "filesystems, and the values are the filesystem types. For example:"
9597 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2265
9600 " \"/dev/sda1\" => \"ntfs\"\n"
9601 " \"/dev/sda2\" => \"ext2\"\n"
9602 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9603 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9608 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2270
9610 "The value can have the special value \"unknown\", meaning the content of the "
9611 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9615 #: ../src/guestfs-actions.pod:3288
9617 "This command runs other libguestfs commands, which might include "
9618 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9619 "soon after launch and only when nothing is mounted."
9623 #: ../src/guestfs-actions.pod:3292
9625 "Not all of the filesystems returned will be mountable. In particular, swap "
9626 "partitions are returned in the list. Also this command does not check that "
9627 "each filesystem found is valid and mountable, and some filesystems might be "
9628 "mountable but require special options. Filesystems may not all belong to a "
9629 "single logical operating system (use C<guestfs_inspect_os> to look for "
9634 #: ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:4895
9635 msgid "(Added in 1.5.15)"
9639 #: ../src/guestfs-actions.pod:3308
9640 msgid "guestfs_list_partitions"
9644 #: ../src/guestfs-actions.pod:3310
9648 " guestfs_list_partitions (guestfs_h *g);\n"
9653 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2290
9654 msgid "List all the partitions detected on all block devices."
9658 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2292
9659 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9663 #: ../src/guestfs-actions.pod:3317
9665 "This does not return logical volumes. For that you will need to call "
9670 #: ../src/guestfs-actions.pod:3328
9675 #: ../src/guestfs-actions.pod:3330
9679 " guestfs_ll (guestfs_h *g,\n"
9680 " const char *directory);\n"
9685 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2303
9687 "List the files in C<directory> (relative to the root directory, there is no "
9688 "cwd) in the format of 'ls -la'."
9692 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2306
9694 "This command is mostly useful for interactive sessions. It is I<not> "
9695 "intended that you try to parse the output string."
9699 #: ../src/guestfs-actions.pod:3345
9704 #: ../src/guestfs-actions.pod:3347
9708 " guestfs_ln (guestfs_h *g,\n"
9709 " const char *target,\n"
9710 " const char *linkname);\n"
9715 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2313
9716 msgid "This command creates a hard link using the C<ln> command."
9720 #: ../src/guestfs-actions.pod:3358
9721 msgid "guestfs_ln_f"
9725 #: ../src/guestfs-actions.pod:3360
9729 " guestfs_ln_f (guestfs_h *g,\n"
9730 " const char *target,\n"
9731 " const char *linkname);\n"
9736 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2319
9738 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9739 "option removes the link (C<linkname>) if it exists already."
9743 #: ../src/guestfs-actions.pod:3372
9744 msgid "guestfs_ln_s"
9748 #: ../src/guestfs-actions.pod:3374
9752 " guestfs_ln_s (guestfs_h *g,\n"
9753 " const char *target,\n"
9754 " const char *linkname);\n"
9759 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2326
9760 msgid "This command creates a symbolic link using the C<ln -s> command."
9764 #: ../src/guestfs-actions.pod:3385
9765 msgid "guestfs_ln_sf"
9769 #: ../src/guestfs-actions.pod:3387
9773 " guestfs_ln_sf (guestfs_h *g,\n"
9774 " const char *target,\n"
9775 " const char *linkname);\n"
9780 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2332
9782 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9783 "option removes the link (C<linkname>) if it exists already."
9787 #: ../src/guestfs-actions.pod:3399
9788 msgid "guestfs_lremovexattr"
9792 #: ../src/guestfs-actions.pod:3401
9796 " guestfs_lremovexattr (guestfs_h *g,\n"
9797 " const char *xattr,\n"
9798 " const char *path);\n"
9803 #: ../src/guestfs-actions.pod:3406
9805 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9806 "link, then it removes an extended attribute of the link itself."
9810 #: ../src/guestfs-actions.pod:3414
9815 #: ../src/guestfs-actions.pod:3416
9819 " guestfs_ls (guestfs_h *g,\n"
9820 " const char *directory);\n"
9825 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2347
9827 "List the files in C<directory> (relative to the root directory, there is no "
9828 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9833 #: ../src/guestfs-actions.pod:3424
9835 "This command is mostly useful for interactive sessions. Programs should "
9836 "probably use C<guestfs_readdir> instead."
9840 #: ../src/guestfs-actions.pod:3433
9841 msgid "guestfs_lsetxattr"
9845 #: ../src/guestfs-actions.pod:3435
9849 " guestfs_lsetxattr (guestfs_h *g,\n"
9850 " const char *xattr,\n"
9851 " const char *val,\n"
9853 " const char *path);\n"
9858 #: ../src/guestfs-actions.pod:3442
9860 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9861 "then it sets an extended attribute of the link itself."
9865 #: ../src/guestfs-actions.pod:3450
9866 msgid "guestfs_lstat"
9870 #: ../src/guestfs-actions.pod:3452
9873 " struct guestfs_stat *\n"
9874 " guestfs_lstat (guestfs_h *g,\n"
9875 " const char *path);\n"
9880 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3979
9881 msgid "Returns file information for the given C<path>."
9885 #: ../src/guestfs-actions.pod:3458
9887 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9888 "link, then the link is stat-ed, not the file it refers to."
9892 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2372
9893 msgid "This is the same as the C<lstat(2)> system call."
9897 #: ../src/guestfs-actions.pod:3464 ../src/guestfs-actions.pod:5953
9899 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9900 "error. I<The caller must call C<guestfs_free_stat> after use>."
9904 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:5957 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6356
9905 msgid "(Added in 0.9.2)"
9909 #: ../src/guestfs-actions.pod:3470
9910 msgid "guestfs_lstatlist"
9914 #: ../src/guestfs-actions.pod:3472
9917 " struct guestfs_stat_list *\n"
9918 " guestfs_lstatlist (guestfs_h *g,\n"
9919 " const char *path,\n"
9920 " char *const *names);\n"
9925 #: ../src/guestfs-actions.pod:3477
9927 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9928 "files, where all files are in the directory C<path>. C<names> is the list "
9929 "of files from this directory."
9933 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:2382
9935 "On return you get a list of stat structs, with a one-to-one correspondence "
9936 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9937 "then the C<ino> field of that structure is set to C<-1>."
9941 #: ../src/guestfs-actions.pod:3486
9943 "This call is intended for programs that want to efficiently list a directory "
9944 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9945 "for a similarly efficient call for getting extended attributes. Very long "
9946 "directory listings might cause the protocol message size to be exceeded, "
9947 "causing this call to fail. The caller must split up such requests into "
9948 "smaller groups of names."
9952 #: ../src/guestfs-actions.pod:3494
9954 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9955 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9959 #: ../src/guestfs-actions.pod:3500
9960 msgid "guestfs_luks_add_key"
9964 #: ../src/guestfs-actions.pod:3502
9968 " guestfs_luks_add_key (guestfs_h *g,\n"
9969 " const char *device,\n"
9970 " const char *key,\n"
9971 " const char *newkey,\n"
9977 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2399
9979 "This command adds a new key on LUKS device C<device>. C<key> is any "
9980 "existing key, and is used to access the device. C<newkey> is the new key to "
9981 "add. C<keyslot> is the key slot that will be replaced."
9985 #: ../src/guestfs-actions.pod:3514
9987 "Note that if C<keyslot> already contains a key, then this command will "
9988 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9992 #: ../src/guestfs-actions.pod:3520 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3635 ../src/guestfs-actions.pod:3654
9994 "This function takes a key or passphrase parameter which could contain "
9995 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
10000 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3587 ../src/guestfs-actions.pod:3607
10001 msgid "(Added in 1.5.2)"
10005 #: ../src/guestfs-actions.pod:3526
10006 msgid "guestfs_luks_close"
10010 #: ../src/guestfs-actions.pod:3528
10014 " guestfs_luks_close (guestfs_h *g,\n"
10015 " const char *device);\n"
10020 #: ../src/guestfs-actions.pod:3532
10022 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10023 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10024 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10025 "underlying block device."
10029 #: ../src/guestfs-actions.pod:3540 ../src/guestfs-actions.pod:3639 ../src/guestfs-actions.pod:3658 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:3756
10030 msgid "(Added in 1.5.1)"
10034 #: ../src/guestfs-actions.pod:3542
10035 msgid "guestfs_luks_format"
10039 #: ../src/guestfs-actions.pod:3544
10043 " guestfs_luks_format (guestfs_h *g,\n"
10044 " const char *device,\n"
10045 " const char *key,\n"
10051 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2425
10053 "This command erases existing data on C<device> and formats the device as a "
10054 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10055 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10059 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:4646 ../src/guestfs-actions.pod:5409 ../src/guestfs-actions.pod:5784 ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5833 ../src/guestfs-actions.pod:6993 ../fish/guestfish-actions.pod:2433 ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:3091 ../fish/guestfish-actions.pod:3598 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:3894 ../fish/guestfish-actions.pod:3909 ../fish/guestfish-actions.pod:4624
10061 "B<This command is dangerous. Without careful use you can easily destroy all "
10066 #: ../src/guestfs-actions.pod:3566
10067 msgid "guestfs_luks_format_cipher"
10071 #: ../src/guestfs-actions.pod:3568
10075 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10076 " const char *device,\n"
10077 " const char *key,\n"
10079 " const char *cipher);\n"
10084 #: ../src/guestfs-actions.pod:3575
10086 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10087 "set the C<cipher> used."
10091 #: ../src/guestfs-actions.pod:3589
10092 msgid "guestfs_luks_kill_slot"
10096 #: ../src/guestfs-actions.pod:3591
10100 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10101 " const char *device,\n"
10102 " const char *key,\n"
10108 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2453
10110 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10111 "device C<device>. C<key> must be one of the I<other> keys."
10115 #: ../src/guestfs-actions.pod:3609
10116 msgid "guestfs_luks_open"
10120 #: ../src/guestfs-actions.pod:3611
10124 " guestfs_luks_open (guestfs_h *g,\n"
10125 " const char *device,\n"
10126 " const char *key,\n"
10127 " const char *mapname);\n"
10132 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2464
10134 "This command opens a block device which has been encrypted according to the "
10135 "Linux Unified Key Setup (LUKS) standard."
10139 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2467
10140 msgid "C<device> is the encrypted block device or partition."
10144 #: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2469
10146 "The caller must supply one of the keys associated with the LUKS block "
10147 "device, in the C<key> parameter."
10151 #: ../src/guestfs-actions.pod:3625 ../fish/guestfish-actions.pod:2472
10153 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10154 "writes to this block device are decrypted from and encrypted to the "
10155 "underlying C<device> respectively."
10159 #: ../src/guestfs-actions.pod:3629
10161 "If this block device contains LVM volume groups, then calling "
10162 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10167 #: ../src/guestfs-actions.pod:3641
10168 msgid "guestfs_luks_open_ro"
10172 #: ../src/guestfs-actions.pod:3643
10176 " guestfs_luks_open_ro (guestfs_h *g,\n"
10177 " const char *device,\n"
10178 " const char *key,\n"
10179 " const char *mapname);\n"
10184 #: ../src/guestfs-actions.pod:3649
10186 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10191 #: ../src/guestfs-actions.pod:3660
10192 msgid "guestfs_lvcreate"
10196 #: ../src/guestfs-actions.pod:3662
10200 " guestfs_lvcreate (guestfs_h *g,\n"
10201 " const char *logvol,\n"
10202 " const char *volgroup,\n"
10208 #: ../src/guestfs-actions.pod:3668 ../fish/guestfish-actions.pod:2497
10210 "This creates an LVM logical volume called C<logvol> on the volume group "
10211 "C<volgroup>, with C<size> megabytes."
10215 #: ../src/guestfs-actions.pod:3675
10216 msgid "guestfs_lvm_canonical_lv_name"
10220 #: ../src/guestfs-actions.pod:3677
10224 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10225 " const char *lvname);\n"
10230 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2504
10232 "This converts alternative naming schemes for LVs that you might find to the "
10233 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
10238 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2508
10240 "This command returns an error if the C<lvname> parameter does not refer to a "
10245 #: ../src/guestfs-actions.pod:3688
10246 msgid "See also C<guestfs_is_lv>."
10250 #: ../src/guestfs-actions.pod:3693
10251 msgid "(Added in 1.5.24)"
10255 #: ../src/guestfs-actions.pod:3695
10256 msgid "guestfs_lvm_clear_filter"
10260 #: ../src/guestfs-actions.pod:3697
10264 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10269 #: ../src/guestfs-actions.pod:3700
10271 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10272 "see every block device."
10276 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10277 msgid "This command also clears the LVM cache and performs a volume group scan."
10281 #: ../src/guestfs-actions.pod:3710
10282 msgid "guestfs_lvm_remove_all"
10286 #: ../src/guestfs-actions.pod:3712
10290 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10295 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2527
10297 "This command removes all LVM logical volumes, volume groups and physical "
10302 #: ../src/guestfs-actions.pod:3725
10303 msgid "guestfs_lvm_set_filter"
10307 #: ../src/guestfs-actions.pod:3727
10311 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10312 " char *const *devices);\n"
10317 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2537
10319 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10320 "block devices in the list C<devices>, and will ignore all other attached "
10325 #: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2541
10327 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10328 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10329 "there are two types of duplication possible: either cloned PVs/VGs which "
10330 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10331 "same name. In normal operation you cannot create this situation, but you "
10332 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10333 "inside the LVM metadata."
10337 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2554
10338 msgid "You can filter whole block devices or individual partitions."
10342 #: ../src/guestfs-actions.pod:3750 ../fish/guestfish-actions.pod:2556
10344 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10345 "filesystem), even if you are not filtering out that VG."
10349 #: ../src/guestfs-actions.pod:3758
10350 msgid "guestfs_lvremove"
10354 #: ../src/guestfs-actions.pod:3760
10358 " guestfs_lvremove (guestfs_h *g,\n"
10359 " const char *device);\n"
10364 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2564
10366 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10367 "LV, such as C</dev/VG/LV>."
10371 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2567
10373 "You can also remove all LVs in a volume group by specifying the VG name, "
10378 #: ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:4992 ../src/guestfs-actions.pod:6732
10379 msgid "(Added in 1.0.13)"
10383 #: ../src/guestfs-actions.pod:3774
10384 msgid "guestfs_lvrename"
10388 #: ../src/guestfs-actions.pod:3776
10392 " guestfs_lvrename (guestfs_h *g,\n"
10393 " const char *logvol,\n"
10394 " const char *newlogvol);\n"
10399 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2574
10400 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10404 #: ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:6745
10405 msgid "(Added in 1.0.83)"
10409 #: ../src/guestfs-actions.pod:3787
10410 msgid "guestfs_lvresize"
10414 #: ../src/guestfs-actions.pod:3789
10418 " guestfs_lvresize (guestfs_h *g,\n"
10419 " const char *device,\n"
10425 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
10427 "This resizes (expands or shrinks) an existing LVM logical volume to "
10428 "C<mbytes>. When reducing, data in the reduced part is lost."
10432 #: ../src/guestfs-actions.pod:3802
10433 msgid "guestfs_lvresize_free"
10437 #: ../src/guestfs-actions.pod:3804
10441 " guestfs_lvresize_free (guestfs_h *g,\n"
10442 " const char *lv,\n"
10448 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2588
10450 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10451 "remaining free space in the volume group. Commonly you would call this with "
10452 "pc = 100 which expands the logical volume as much as possible, using all "
10453 "remaining free space in the volume group."
10457 #: ../src/guestfs-actions.pod:3817
10458 msgid "(Added in 1.3.3)"
10462 #: ../src/guestfs-actions.pod:3819
10463 msgid "guestfs_lvs"
10467 #: ../src/guestfs-actions.pod:3821
10471 " guestfs_lvs (guestfs_h *g);\n"
10476 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2598
10478 "List all the logical volumes detected. This is the equivalent of the "
10479 "L<lvs(8)> command."
10483 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2601
10485 "This returns a list of the logical volume device names "
10486 "(eg. C</dev/VolGroup00/LogVol00>)."
10490 #: ../src/guestfs-actions.pod:3830
10491 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10495 #: ../src/guestfs-actions.pod:3838
10496 msgid "guestfs_lvs_full"
10500 #: ../src/guestfs-actions.pod:3840
10503 " struct guestfs_lvm_lv_list *\n"
10504 " guestfs_lvs_full (guestfs_h *g);\n"
10509 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2610
10511 "List all the logical volumes detected. This is the equivalent of the "
10512 "L<lvs(8)> command. The \"full\" version includes all fields."
10516 #: ../src/guestfs-actions.pod:3846
10518 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10519 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
10524 #: ../src/guestfs-actions.pod:3852
10525 msgid "guestfs_lvuuid"
10529 #: ../src/guestfs-actions.pod:3854
10533 " guestfs_lvuuid (guestfs_h *g,\n"
10534 " const char *device);\n"
10539 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2617
10540 msgid "This command returns the UUID of the LVM LV C<device>."
10544 #: ../src/guestfs-actions.pod:3865
10545 msgid "guestfs_lxattrlist"
10549 #: ../src/guestfs-actions.pod:3867
10552 " struct guestfs_xattr_list *\n"
10553 " guestfs_lxattrlist (guestfs_h *g,\n"
10554 " const char *path,\n"
10555 " char *const *names);\n"
10560 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2623
10562 "This call allows you to get the extended attributes of multiple files, where "
10563 "all files are in the directory C<path>. C<names> is the list of files from "
10568 #: ../src/guestfs-actions.pod:3876 ../fish/guestfish-actions.pod:2627
10570 "On return you get a flat list of xattr structs which must be interpreted "
10571 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10572 "C<attrval> in this struct is zero-length to indicate there was an error "
10573 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10574 "number (the number of following attributes for this file, which could be "
10575 "C<\"0\">). Then after the first xattr struct are the zero or more "
10576 "attributes for the first named file. This repeats for the second and "
10577 "subsequent files."
10581 #: ../src/guestfs-actions.pod:3886
10583 "This call is intended for programs that want to efficiently list a directory "
10584 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10585 "a similarly efficient call for getting standard stats. Very long directory "
10586 "listings might cause the protocol message size to be exceeded, causing this "
10587 "call to fail. The caller must split up such requests into smaller groups of "
10592 #: ../src/guestfs-actions.pod:3900
10593 msgid "guestfs_mkdir"
10597 #: ../src/guestfs-actions.pod:3902
10601 " guestfs_mkdir (guestfs_h *g,\n"
10602 " const char *path);\n"
10607 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2649
10608 msgid "Create a directory named C<path>."
10612 #: ../src/guestfs-actions.pod:3912
10613 msgid "guestfs_mkdir_mode"
10617 #: ../src/guestfs-actions.pod:3914
10621 " guestfs_mkdir_mode (guestfs_h *g,\n"
10622 " const char *path,\n"
10628 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2655
10630 "This command creates a directory, setting the initial permissions of the "
10631 "directory to C<mode>."
10635 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2658
10637 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10638 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10643 #: ../src/guestfs-actions.pod:3926
10644 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10648 #: ../src/guestfs-actions.pod:3932
10649 msgid "guestfs_mkdir_p"
10653 #: ../src/guestfs-actions.pod:3934
10657 " guestfs_mkdir_p (guestfs_h *g,\n"
10658 " const char *path);\n"
10663 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2668
10665 "Create a directory named C<path>, creating any parent directories as "
10666 "necessary. This is like the C<mkdir -p> shell command."
10670 #: ../src/guestfs-actions.pod:3945
10671 msgid "guestfs_mkdtemp"
10675 #: ../src/guestfs-actions.pod:3947
10679 " guestfs_mkdtemp (guestfs_h *g,\n"
10680 " const char *template);\n"
10685 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2675
10687 "This command creates a temporary directory. The C<template> parameter "
10688 "should be a full pathname for the temporary directory name with the final "
10689 "six characters being \"XXXXXX\"."
10693 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2680
10695 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10696 "being suitable for Windows filesystems."
10700 #: ../src/guestfs-actions.pod:3959 ../fish/guestfish-actions.pod:2683
10701 msgid "The name of the temporary directory that was created is returned."
10705 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2686
10706 msgid "The temporary directory is created with mode 0700 and is owned by root."
10710 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2689
10712 "The caller is responsible for deleting the temporary directory and its "
10713 "contents after use."
10717 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2692
10718 msgid "See also: L<mkdtemp(3)>"
10722 #: ../src/guestfs-actions.pod:3975
10723 msgid "guestfs_mke2fs_J"
10727 #: ../src/guestfs-actions.pod:3977
10731 " guestfs_mke2fs_J (guestfs_h *g,\n"
10732 " const char *fstype,\n"
10733 " int blocksize,\n"
10734 " const char *device,\n"
10735 " const char *journal);\n"
10740 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2698
10742 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10743 "C<journal>. It is equivalent to the command:"
10747 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2702
10750 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10755 #: ../src/guestfs-actions.pod:3990
10756 msgid "See also C<guestfs_mke2journal>."
10760 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4012 ../src/guestfs-actions.pod:4030 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4133 ../src/guestfs-actions.pod:4382
10761 msgid "(Added in 1.0.68)"
10765 #: ../src/guestfs-actions.pod:3996
10766 msgid "guestfs_mke2fs_JL"
10770 #: ../src/guestfs-actions.pod:3998
10774 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10775 " const char *fstype,\n"
10776 " int blocksize,\n"
10777 " const char *device,\n"
10778 " const char *label);\n"
10783 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2710
10785 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10786 "the journal labeled C<label>."
10790 #: ../src/guestfs-actions.pod:4008
10791 msgid "See also C<guestfs_mke2journal_L>."
10795 #: ../src/guestfs-actions.pod:4014
10796 msgid "guestfs_mke2fs_JU"
10800 #: ../src/guestfs-actions.pod:4016
10804 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10805 " const char *fstype,\n"
10806 " int blocksize,\n"
10807 " const char *device,\n"
10808 " const char *uuid);\n"
10813 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2719
10815 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10816 "the journal with UUID C<uuid>."
10820 #: ../src/guestfs-actions.pod:4026
10821 msgid "See also C<guestfs_mke2journal_U>."
10825 #: ../src/guestfs-actions.pod:4032
10826 msgid "guestfs_mke2journal"
10830 #: ../src/guestfs-actions.pod:4034
10834 " guestfs_mke2journal (guestfs_h *g,\n"
10835 " int blocksize,\n"
10836 " const char *device);\n"
10841 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2728
10843 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10848 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2731
10851 " mke2fs -O journal_dev -b blocksize device\n"
10856 #: ../src/guestfs-actions.pod:4048
10857 msgid "guestfs_mke2journal_L"
10861 #: ../src/guestfs-actions.pod:4050
10865 " guestfs_mke2journal_L (guestfs_h *g,\n"
10866 " int blocksize,\n"
10867 " const char *label,\n"
10868 " const char *device);\n"
10873 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2737
10874 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10878 #: ../src/guestfs-actions.pod:4062
10879 msgid "guestfs_mke2journal_U"
10883 #: ../src/guestfs-actions.pod:4064
10887 " guestfs_mke2journal_U (guestfs_h *g,\n"
10888 " int blocksize,\n"
10889 " const char *uuid,\n"
10890 " const char *device);\n"
10895 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2743
10896 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10900 #: ../src/guestfs-actions.pod:4076
10901 msgid "guestfs_mkfifo"
10905 #: ../src/guestfs-actions.pod:4078
10909 " guestfs_mkfifo (guestfs_h *g,\n"
10911 " const char *path);\n"
10916 #: ../src/guestfs-actions.pod:4083
10918 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10919 "is just a convenient wrapper around C<guestfs_mknod>."
10923 #: ../src/guestfs-actions.pod:4093
10924 msgid "guestfs_mkfs"
10928 #: ../src/guestfs-actions.pod:4095
10932 " guestfs_mkfs (guestfs_h *g,\n"
10933 " const char *fstype,\n"
10934 " const char *device);\n"
10939 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2759
10941 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10942 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10946 #: ../src/guestfs-actions.pod:4108
10947 msgid "guestfs_mkfs_b"
10951 #: ../src/guestfs-actions.pod:4110
10955 " guestfs_mkfs_b (guestfs_h *g,\n"
10956 " const char *fstype,\n"
10957 " int blocksize,\n"
10958 " const char *device);\n"
10963 #: ../src/guestfs-actions.pod:4116
10965 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10966 "block size of the resulting filesystem. Supported block sizes depend on the "
10967 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10971 #: ../src/guestfs-actions.pod:4121 ../src/guestfs-actions.pod:4163 ../fish/guestfish-actions.pod:2772 ../fish/guestfish-actions.pod:2799
10973 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10978 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2775
10980 "This function is deprecated. In new code, use the C<mkfs_opts> call "
10985 #: ../src/guestfs-actions.pod:4135
10986 msgid "guestfs_mkfs_opts"
10990 #: ../src/guestfs-actions.pod:4137
10994 " guestfs_mkfs_opts (guestfs_h *g,\n"
10995 " const char *fstype,\n"
10996 " const char *device,\n"
11002 #: ../src/guestfs-actions.pod:4148
11005 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
11010 #: ../src/guestfs-actions.pod:4150 ../fish/guestfish-actions.pod:2786
11012 "This function creates a filesystem on C<device>. The filesystem type is "
11013 "C<fstype>, for example C<ext3>."
11017 #: ../src/guestfs-actions.pod:4157 ../fish/guestfish-actions.pod:2793
11018 msgid "C<blocksize>"
11022 #: ../src/guestfs-actions.pod:4159 ../fish/guestfish-actions.pod:2795
11024 "The filesystem block size. Supported block sizes depend on the filesystem "
11025 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
11030 #: ../src/guestfs-actions.pod:4170
11031 msgid "guestfs_mkfs_opts_va"
11035 #: ../src/guestfs-actions.pod:4172
11039 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
11040 " const char *fstype,\n"
11041 " const char *device,\n"
11042 " va_list args);\n"
11047 #: ../src/guestfs-actions.pod:4178
11048 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
11052 #: ../src/guestfs-actions.pod:4182
11053 msgid "guestfs_mkfs_opts_argv"
11057 #: ../src/guestfs-actions.pod:4184
11061 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
11062 " const char *fstype,\n"
11063 " const char *device,\n"
11064 " const struct guestfs_mkfs_opts_argv *optargs);\n"
11069 #: ../src/guestfs-actions.pod:4190
11070 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
11074 #: ../src/guestfs-actions.pod:4194
11075 msgid "guestfs_mkmountpoint"
11079 #: ../src/guestfs-actions.pod:4196
11083 " guestfs_mkmountpoint (guestfs_h *g,\n"
11084 " const char *exemptpath);\n"
11089 #: ../src/guestfs-actions.pod:4200
11091 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
11092 "that can be used to create extra mountpoints before mounting the first "
11097 #: ../src/guestfs-actions.pod:4204 ../fish/guestfish-actions.pod:2814
11099 "These calls are I<only> necessary in some very limited circumstances, mainly "
11100 "the case where you want to mount a mix of unrelated and/or read-only "
11101 "filesystems together."
11105 #: ../src/guestfs-actions.pod:4208 ../fish/guestfish-actions.pod:2818
11107 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11108 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11109 "inside that. You can unpack this as follows in guestfish:"
11113 #: ../src/guestfs-actions.pod:4213 ../fish/guestfish-actions.pod:2823
11116 " add-ro Fedora-11-i686-Live.iso\n"
11118 " mkmountpoint /cd\n"
11119 " mkmountpoint /sqsh\n"
11120 " mkmountpoint /ext3fs\n"
11121 " mount /dev/sda /cd\n"
11122 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11123 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11128 #: ../src/guestfs-actions.pod:4222 ../fish/guestfish-actions.pod:2832
11129 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11133 #: ../src/guestfs-actions.pod:4224
11135 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11136 "may get unexpected errors if you try to mix these calls. It is safest to "
11137 "manually unmount filesystems and remove mountpoints after use."
11141 #: ../src/guestfs-actions.pod:4228
11143 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11144 "first, so for this to work for manual mountpoints, you must ensure that the "
11145 "innermost mountpoints have the longest pathnames, as in the example code "
11150 #: ../src/guestfs-actions.pod:4233 ../fish/guestfish-actions.pod:2843
11151 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11155 #: ../src/guestfs-actions.pod:4235
11157 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11158 "means that C<guestfs_umount_all> is called when the handle is closed which "
11159 "can also trigger these issues."
11163 #: ../src/guestfs-actions.pod:4241 ../src/guestfs-actions.pod:4500 ../src/guestfs-actions.pod:5393
11164 msgid "(Added in 1.0.62)"
11168 #: ../src/guestfs-actions.pod:4243
11169 msgid "guestfs_mknod"
11173 #: ../src/guestfs-actions.pod:4245
11177 " guestfs_mknod (guestfs_h *g,\n"
11181 " const char *path);\n"
11186 #: ../src/guestfs-actions.pod:4252 ../fish/guestfish-actions.pod:2853
11188 "This call creates block or character special devices, or named pipes "
11193 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2856
11195 "The C<mode> parameter should be the mode, using the standard constants. "
11196 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11197 "used when creating block and character special devices."
11201 #: ../src/guestfs-actions.pod:4260
11203 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11204 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11205 "regular file). These constants are available in the standard Linux header "
11206 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11207 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11208 "the appropriate constant for you."
11212 #: ../src/guestfs-actions.pod:4274
11213 msgid "guestfs_mknod_b"
11217 #: ../src/guestfs-actions.pod:4276
11221 " guestfs_mknod_b (guestfs_h *g,\n"
11225 " const char *path);\n"
11230 #: ../src/guestfs-actions.pod:4283
11232 "This call creates a block device node called C<path> with mode C<mode> and "
11233 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11234 "wrapper around C<guestfs_mknod>."
11238 #: ../src/guestfs-actions.pod:4293
11239 msgid "guestfs_mknod_c"
11243 #: ../src/guestfs-actions.pod:4295
11247 " guestfs_mknod_c (guestfs_h *g,\n"
11251 " const char *path);\n"
11256 #: ../src/guestfs-actions.pod:4302
11258 "This call creates a char device node called C<path> with mode C<mode> and "
11259 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11260 "wrapper around C<guestfs_mknod>."
11264 #: ../src/guestfs-actions.pod:4312
11265 msgid "guestfs_mkswap"
11269 #: ../src/guestfs-actions.pod:4314
11273 " guestfs_mkswap (guestfs_h *g,\n"
11274 " const char *device);\n"
11279 #: ../src/guestfs-actions.pod:4318 ../fish/guestfish-actions.pod:2895
11280 msgid "Create a swap partition on C<device>."
11284 #: ../src/guestfs-actions.pod:4324
11285 msgid "guestfs_mkswap_L"
11289 #: ../src/guestfs-actions.pod:4326
11293 " guestfs_mkswap_L (guestfs_h *g,\n"
11294 " const char *label,\n"
11295 " const char *device);\n"
11300 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2901
11301 msgid "Create a swap partition on C<device> with label C<label>."
11305 #: ../src/guestfs-actions.pod:4333 ../fish/guestfish-actions.pod:2903
11307 "Note that you cannot attach a swap label to a block device "
11308 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
11309 "the kernel or swap tools."
11313 #: ../src/guestfs-actions.pod:4341
11314 msgid "guestfs_mkswap_U"
11318 #: ../src/guestfs-actions.pod:4343
11322 " guestfs_mkswap_U (guestfs_h *g,\n"
11323 " const char *uuid,\n"
11324 " const char *device);\n"
11329 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2911
11330 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11334 #: ../src/guestfs-actions.pod:4354
11335 msgid "guestfs_mkswap_file"
11339 #: ../src/guestfs-actions.pod:4356
11343 " guestfs_mkswap_file (guestfs_h *g,\n"
11344 " const char *path);\n"
11349 #: ../src/guestfs-actions.pod:4360 ../fish/guestfish-actions.pod:2917
11350 msgid "Create a swap file."
11354 #: ../src/guestfs-actions.pod:4362
11356 "This command just writes a swap file signature to an existing file. To "
11357 "create the file itself, use something like C<guestfs_fallocate>."
11361 #: ../src/guestfs-actions.pod:4369
11362 msgid "guestfs_modprobe"
11366 #: ../src/guestfs-actions.pod:4371
11370 " guestfs_modprobe (guestfs_h *g,\n"
11371 " const char *modulename);\n"
11376 #: ../src/guestfs-actions.pod:4375 ../fish/guestfish-actions.pod:2926
11377 msgid "This loads a kernel module in the appliance."
11381 #: ../src/guestfs-actions.pod:4377 ../fish/guestfish-actions.pod:2928
11383 "The kernel module must have been whitelisted when libguestfs was built (see "
11384 "C<appliance/kmod.whitelist.in> in the source)."
11388 #: ../src/guestfs-actions.pod:4384
11389 msgid "guestfs_mount"
11393 #: ../src/guestfs-actions.pod:4386
11397 " guestfs_mount (guestfs_h *g,\n"
11398 " const char *device,\n"
11399 " const char *mountpoint);\n"
11404 #: ../src/guestfs-actions.pod:4391 ../fish/guestfish-actions.pod:2935
11406 "Mount a guest disk at a position in the filesystem. Block devices are named "
11407 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11408 "those block devices contain partitions, they will have the usual names "
11409 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11413 #: ../src/guestfs-actions.pod:4397 ../fish/guestfish-actions.pod:2941
11415 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11416 "mounted on C</> before others can be mounted. Other filesystems can only be "
11417 "mounted on directories which already exist."
11421 #: ../src/guestfs-actions.pod:4402 ../fish/guestfish-actions.pod:2946
11423 "The mounted filesystem is writable, if we have sufficient permissions on the "
11424 "underlying device."
11428 #: ../src/guestfs-actions.pod:4405
11430 "B<Important note:> When you use this call, the filesystem options C<sync> "
11431 "and C<noatime> are set implicitly. This was originally done because we "
11432 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11433 "very large negative performance impact and negligible effect on "
11434 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11435 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11436 "(use an empty string for the first parameter if you don't want any options)."
11440 #: ../src/guestfs-actions.pod:4419
11441 msgid "guestfs_mount_loop"
11445 #: ../src/guestfs-actions.pod:4421
11449 " guestfs_mount_loop (guestfs_h *g,\n"
11450 " const char *file,\n"
11451 " const char *mountpoint);\n"
11456 #: ../src/guestfs-actions.pod:4426 ../fish/guestfish-actions.pod:2963
11458 "This command lets you mount C<file> (a filesystem image in a file) on a "
11459 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11464 #: ../src/guestfs-actions.pod:4434
11465 msgid "guestfs_mount_options"
11469 #: ../src/guestfs-actions.pod:4436
11473 " guestfs_mount_options (guestfs_h *g,\n"
11474 " const char *options,\n"
11475 " const char *device,\n"
11476 " const char *mountpoint);\n"
11481 #: ../src/guestfs-actions.pod:4442
11483 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11484 "the mount options as for the L<mount(8)> I<-o> flag."
11488 #: ../src/guestfs-actions.pod:4446 ../fish/guestfish-actions.pod:2975
11490 "If the C<options> parameter is an empty string, then no options are passed "
11491 "(all options default to whatever the filesystem uses)."
11495 #: ../src/guestfs-actions.pod:4452 ../src/guestfs-actions.pod:4466 ../src/guestfs-actions.pod:4483
11496 msgid "(Added in 1.0.10)"
11500 #: ../src/guestfs-actions.pod:4454
11501 msgid "guestfs_mount_ro"
11505 #: ../src/guestfs-actions.pod:4456
11509 " guestfs_mount_ro (guestfs_h *g,\n"
11510 " const char *device,\n"
11511 " const char *mountpoint);\n"
11516 #: ../src/guestfs-actions.pod:4461
11518 "This is the same as the C<guestfs_mount> command, but it mounts the "
11519 "filesystem with the read-only (I<-o ro>) flag."
11523 #: ../src/guestfs-actions.pod:4468
11524 msgid "guestfs_mount_vfs"
11528 #: ../src/guestfs-actions.pod:4470
11532 " guestfs_mount_vfs (guestfs_h *g,\n"
11533 " const char *options,\n"
11534 " const char *vfstype,\n"
11535 " const char *device,\n"
11536 " const char *mountpoint);\n"
11541 #: ../src/guestfs-actions.pod:4477
11543 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11544 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
11549 #: ../src/guestfs-actions.pod:4485
11550 msgid "guestfs_mountpoints"
11554 #: ../src/guestfs-actions.pod:4487
11558 " guestfs_mountpoints (guestfs_h *g);\n"
11563 #: ../src/guestfs-actions.pod:4490
11565 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11566 "devices. This one returns a hash table (map) of device name to directory "
11567 "where the device is mounted."
11571 #: ../src/guestfs-actions.pod:4502
11572 msgid "guestfs_mounts"
11576 #: ../src/guestfs-actions.pod:4504
11580 " guestfs_mounts (guestfs_h *g);\n"
11585 #: ../src/guestfs-actions.pod:4507 ../fish/guestfish-actions.pod:3006
11587 "This returns the list of currently mounted filesystems. It returns the list "
11588 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11592 #: ../src/guestfs-actions.pod:4510 ../fish/guestfish-actions.pod:3009
11593 msgid "Some internal mounts are not shown."
11597 #: ../src/guestfs-actions.pod:4512
11598 msgid "See also: C<guestfs_mountpoints>"
11602 #: ../src/guestfs-actions.pod:4520
11607 #: ../src/guestfs-actions.pod:4522
11611 " guestfs_mv (guestfs_h *g,\n"
11612 " const char *src,\n"
11613 " const char *dest);\n"
11618 #: ../src/guestfs-actions.pod:4527 ../fish/guestfish-actions.pod:3017
11620 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11621 "destination filename or destination directory."
11625 #: ../src/guestfs-actions.pod:4534
11626 msgid "guestfs_ntfs_3g_probe"
11630 #: ../src/guestfs-actions.pod:4536
11634 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11636 " const char *device);\n"
11641 #: ../src/guestfs-actions.pod:4541 ../fish/guestfish-actions.pod:3024
11643 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11644 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11645 "read-write, and some cannot be mounted at all)."
11649 #: ../src/guestfs-actions.pod:4545 ../fish/guestfish-actions.pod:3028
11651 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11652 "can be mounted read-write. Set it to false if you want to test if the "
11653 "volume can be mounted read-only."
11657 #: ../src/guestfs-actions.pod:4549 ../fish/guestfish-actions.pod:3032
11659 "The return value is an integer which C<0> if the operation would succeed, or "
11660 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11664 #: ../src/guestfs-actions.pod:4555
11665 msgid "(Added in 1.0.43)"
11669 #: ../src/guestfs-actions.pod:4557
11670 msgid "guestfs_ntfsresize"
11674 #: ../src/guestfs-actions.pod:4559
11678 " guestfs_ntfsresize (guestfs_h *g,\n"
11679 " const char *device);\n"
11684 #: ../src/guestfs-actions.pod:4563 ../fish/guestfish-actions.pod:3040
11686 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11687 "size of the underlying device. See also L<ntfsresize(8)>."
11691 #: ../src/guestfs-actions.pod:4571
11692 msgid "guestfs_ntfsresize_size"
11696 #: ../src/guestfs-actions.pod:4573
11700 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11701 " const char *device,\n"
11702 " int64_t size);\n"
11707 #: ../src/guestfs-actions.pod:4578
11709 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11710 "to specify the new size (in bytes) explicitly."
11714 #: ../src/guestfs-actions.pod:4583 ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:5341
11715 msgid "(Added in 1.3.14)"
11719 #: ../src/guestfs-actions.pod:4585
11720 msgid "guestfs_part_add"
11724 #: ../src/guestfs-actions.pod:4587
11728 " guestfs_part_add (guestfs_h *g,\n"
11729 " const char *device,\n"
11730 " const char *prlogex,\n"
11731 " int64_t startsect,\n"
11732 " int64_t endsect);\n"
11737 #: ../src/guestfs-actions.pod:4594
11739 "This command adds a partition to C<device>. If there is no partition table "
11740 "on the device, call C<guestfs_part_init> first."
11744 #: ../src/guestfs-actions.pod:4597 ../fish/guestfish-actions.pod:3058
11746 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11747 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11748 "C<logical>) and C<e> (or C<extended>) partition types."
11752 #: ../src/guestfs-actions.pod:4602 ../fish/guestfish-actions.pod:3063
11754 "C<startsect> and C<endsect> are the start and end of the partition in "
11755 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11756 "from the end of the disk (C<-1> is the last sector)."
11760 #: ../src/guestfs-actions.pod:4606
11762 "Creating a partition which covers the whole disk is not so easy. Use "
11763 "C<guestfs_part_disk> to do that."
11767 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4649 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4780 ../src/guestfs-actions.pod:4818 ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4877
11768 msgid "(Added in 1.0.78)"
11772 #: ../src/guestfs-actions.pod:4613
11773 msgid "guestfs_part_del"
11777 #: ../src/guestfs-actions.pod:4615
11781 " guestfs_part_del (guestfs_h *g,\n"
11782 " const char *device,\n"
11788 #: ../src/guestfs-actions.pod:4620 ../fish/guestfish-actions.pod:3074
11789 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11793 #: ../src/guestfs-actions.pod:4622 ../fish/guestfish-actions.pod:3076
11795 "Note that in the case of MBR partitioning, deleting an extended partition "
11796 "also deletes any logical partitions it contains."
11800 #: ../src/guestfs-actions.pod:4630
11801 msgid "guestfs_part_disk"
11805 #: ../src/guestfs-actions.pod:4632
11809 " guestfs_part_disk (guestfs_h *g,\n"
11810 " const char *device,\n"
11811 " const char *parttype);\n"
11816 #: ../src/guestfs-actions.pod:4637
11818 "This command is simply a combination of C<guestfs_part_init> followed by "
11819 "C<guestfs_part_add> to create a single primary partition covering the whole "
11824 #: ../src/guestfs-actions.pod:4641
11826 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11827 "possible values are described in C<guestfs_part_init>."
11831 #: ../src/guestfs-actions.pod:4651
11832 msgid "guestfs_part_get_bootable"
11836 #: ../src/guestfs-actions.pod:4653
11840 " guestfs_part_get_bootable (guestfs_h *g,\n"
11841 " const char *device,\n"
11847 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3098
11849 "This command returns true if the partition C<partnum> on C<device> has the "
11850 "bootable flag set."
11854 #: ../src/guestfs-actions.pod:4661
11855 msgid "See also C<guestfs_part_set_bootable>."
11859 #: ../src/guestfs-actions.pod:4667
11860 msgid "guestfs_part_get_mbr_id"
11864 #: ../src/guestfs-actions.pod:4669
11868 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11869 " const char *device,\n"
11875 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3107
11877 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11878 "partition C<partnum>."
11882 #: ../src/guestfs-actions.pod:4677 ../src/guestfs-actions.pod:4853
11884 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11885 "undefined results for other partition table types (see "
11886 "C<guestfs_part_get_parttype>)."
11890 #: ../src/guestfs-actions.pod:4685
11891 msgid "guestfs_part_get_parttype"
11895 #: ../src/guestfs-actions.pod:4687
11899 " guestfs_part_get_parttype (guestfs_h *g,\n"
11900 " const char *device);\n"
11905 #: ../src/guestfs-actions.pod:4691 ../fish/guestfish-actions.pod:3118
11907 "This command examines the partition table on C<device> and returns the "
11908 "partition table type (format) being used."
11912 #: ../src/guestfs-actions.pod:4694
11914 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11915 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11916 "possible, although unusual. See C<guestfs_part_init> for a full list."
11920 #: ../src/guestfs-actions.pod:4704
11921 msgid "guestfs_part_init"
11925 #: ../src/guestfs-actions.pod:4706
11929 " guestfs_part_init (guestfs_h *g,\n"
11930 " const char *device,\n"
11931 " const char *parttype);\n"
11936 #: ../src/guestfs-actions.pod:4711 ../fish/guestfish-actions.pod:3130
11938 "This creates an empty partition table on C<device> of one of the partition "
11939 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11940 "(for large disks)."
11944 #: ../src/guestfs-actions.pod:4715
11946 "Initially there are no partitions. Following this, you should call "
11947 "C<guestfs_part_add> for each partition required."
11951 #: ../src/guestfs-actions.pod:4718 ../fish/guestfish-actions.pod:3137
11952 msgid "Possible values for C<parttype> are:"
11956 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3141
11957 msgid "B<efi> | B<gpt>"
11961 #: ../src/guestfs-actions.pod:4724 ../fish/guestfish-actions.pod:3143
11962 msgid "Intel EFI / GPT partition table."
11966 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3145
11968 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11969 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11970 "the C<mbr> format."
11974 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3149
11975 msgid "B<mbr> | B<msdos>"
11979 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3151
11981 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11982 "Windows. This partition type will B<only> work for device sizes up to 2 "
11983 "TB. For large disks we recommend using C<gpt>."
11987 #: ../src/guestfs-actions.pod:4739 ../fish/guestfish-actions.pod:3158
11988 msgid "Other partition table types that may work but are not supported include:"
11992 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3163
11997 #: ../src/guestfs-actions.pod:4746 ../fish/guestfish-actions.pod:3165
11998 msgid "AIX disk labels."
12002 #: ../src/guestfs-actions.pod:4748 ../fish/guestfish-actions.pod:3167
12003 msgid "B<amiga> | B<rdb>"
12007 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3169
12008 msgid "Amiga \"Rigid Disk Block\" format."
12012 #: ../src/guestfs-actions.pod:4752 ../fish/guestfish-actions.pod:3171
12017 #: ../src/guestfs-actions.pod:4754 ../fish/guestfish-actions.pod:3173
12018 msgid "BSD disk labels."
12022 #: ../src/guestfs-actions.pod:4756 ../fish/guestfish-actions.pod:3175
12027 #: ../src/guestfs-actions.pod:4758 ../fish/guestfish-actions.pod:3177
12028 msgid "DASD, used on IBM mainframes."
12032 #: ../src/guestfs-actions.pod:4760 ../fish/guestfish-actions.pod:3179
12037 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3181
12038 msgid "MIPS/SGI volumes."
12042 #: ../src/guestfs-actions.pod:4764 ../fish/guestfish-actions.pod:3183
12047 #: ../src/guestfs-actions.pod:4766 ../fish/guestfish-actions.pod:3185
12048 msgid "Old Mac partition format. Modern Macs use C<gpt>."
12052 #: ../src/guestfs-actions.pod:4768 ../fish/guestfish-actions.pod:3187
12057 #: ../src/guestfs-actions.pod:4770 ../fish/guestfish-actions.pod:3189
12058 msgid "NEC PC-98 format, common in Japan apparently."
12062 #: ../src/guestfs-actions.pod:4772 ../fish/guestfish-actions.pod:3191
12067 #: ../src/guestfs-actions.pod:4774 ../fish/guestfish-actions.pod:3193
12068 msgid "Sun disk labels."
12072 #: ../src/guestfs-actions.pod:4782
12073 msgid "guestfs_part_list"
12077 #: ../src/guestfs-actions.pod:4784
12080 " struct guestfs_partition_list *\n"
12081 " guestfs_part_list (guestfs_h *g,\n"
12082 " const char *device);\n"
12087 #: ../src/guestfs-actions.pod:4788 ../fish/guestfish-actions.pod:3201
12089 "This command parses the partition table on C<device> and returns the list of "
12090 "partitions found."
12094 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3204
12095 msgid "The fields in the returned structure are:"
12099 #: ../src/guestfs-actions.pod:4795 ../fish/guestfish-actions.pod:3208
12100 msgid "B<part_num>"
12104 #: ../src/guestfs-actions.pod:4797 ../fish/guestfish-actions.pod:3210
12105 msgid "Partition number, counting from 1."
12109 #: ../src/guestfs-actions.pod:4799 ../fish/guestfish-actions.pod:3212
12110 msgid "B<part_start>"
12114 #: ../src/guestfs-actions.pod:4801
12116 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12117 "the device's sector size, see C<guestfs_blockdev_getss>."
12121 #: ../src/guestfs-actions.pod:4804 ../fish/guestfish-actions.pod:3217
12122 msgid "B<part_end>"
12126 #: ../src/guestfs-actions.pod:4806 ../fish/guestfish-actions.pod:3219
12127 msgid "End of the partition in bytes."
12131 #: ../src/guestfs-actions.pod:4808 ../fish/guestfish-actions.pod:3221
12132 msgid "B<part_size>"
12136 #: ../src/guestfs-actions.pod:4810 ../fish/guestfish-actions.pod:3223
12137 msgid "Size of the partition in bytes."
12141 #: ../src/guestfs-actions.pod:4814
12143 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12144 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12149 #: ../src/guestfs-actions.pod:4820
12150 msgid "guestfs_part_set_bootable"
12154 #: ../src/guestfs-actions.pod:4822
12158 " guestfs_part_set_bootable (guestfs_h *g,\n"
12159 " const char *device,\n"
12161 " int bootable);\n"
12166 #: ../src/guestfs-actions.pod:4828 ../fish/guestfish-actions.pod:3231
12168 "This sets the bootable flag on partition numbered C<partnum> on device "
12169 "C<device>. Note that partitions are numbered from 1."
12173 #: ../src/guestfs-actions.pod:4831 ../fish/guestfish-actions.pod:3234
12175 "The bootable flag is used by some operating systems (notably Windows) to "
12176 "determine which partition to boot from. It is by no means universally "
12181 #: ../src/guestfs-actions.pod:4839
12182 msgid "guestfs_part_set_mbr_id"
12186 #: ../src/guestfs-actions.pod:4841
12190 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12191 " const char *device,\n"
12198 #: ../src/guestfs-actions.pod:4847 ../fish/guestfish-actions.pod:3242
12200 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12201 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12202 "documentation are in fact hexadecimal numbers, but usually documented "
12203 "without any leading \"0x\" which might be confusing."
12207 #: ../src/guestfs-actions.pod:4861
12208 msgid "guestfs_part_set_name"
12212 #: ../src/guestfs-actions.pod:4863
12216 " guestfs_part_set_name (guestfs_h *g,\n"
12217 " const char *device,\n"
12219 " const char *name);\n"
12224 #: ../src/guestfs-actions.pod:4869 ../fish/guestfish-actions.pod:3256
12226 "This sets the partition name on partition numbered C<partnum> on device "
12227 "C<device>. Note that partitions are numbered from 1."
12231 #: ../src/guestfs-actions.pod:4872 ../fish/guestfish-actions.pod:3259
12233 "The partition name can only be set on certain types of partition table. "
12234 "This works on C<gpt> but not on C<mbr> partitions."
12238 #: ../src/guestfs-actions.pod:4879
12239 msgid "guestfs_part_to_dev"
12243 #: ../src/guestfs-actions.pod:4881
12247 " guestfs_part_to_dev (guestfs_h *g,\n"
12248 " const char *partition);\n"
12253 #: ../src/guestfs-actions.pod:4885 ../fish/guestfish-actions.pod:3266
12255 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12256 "partition number, returning the device name (eg. \"/dev/sdb\")."
12260 #: ../src/guestfs-actions.pod:4889
12262 "The named partition must exist, for example as a string returned from "
12263 "C<guestfs_list_partitions>."
12267 #: ../src/guestfs-actions.pod:4897
12268 msgid "guestfs_ping_daemon"
12272 #: ../src/guestfs-actions.pod:4899
12276 " guestfs_ping_daemon (guestfs_h *g);\n"
12281 #: ../src/guestfs-actions.pod:4902 ../fish/guestfish-actions.pod:3277
12283 "This is a test probe into the guestfs daemon running inside the qemu "
12284 "subprocess. Calling this function checks that the daemon responds to the "
12285 "ping message, without affecting the daemon or attached block device(s) in "
12290 #: ../src/guestfs-actions.pod:4911
12291 msgid "guestfs_pread"
12295 #: ../src/guestfs-actions.pod:4913
12299 " guestfs_pread (guestfs_h *g,\n"
12300 " const char *path,\n"
12302 " int64_t offset,\n"
12303 " size_t *size_r);\n"
12308 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3286
12310 "This command lets you read part of a file. It reads C<count> bytes of the "
12311 "file, starting at C<offset>, from file C<path>."
12315 #: ../src/guestfs-actions.pod:4923 ../src/guestfs-actions.pod:4949 ../fish/guestfish-actions.pod:3289 ../fish/guestfish-actions.pod:3304
12317 "This may read fewer bytes than requested. For further details see the "
12318 "L<pread(2)> system call."
12322 #: ../src/guestfs-actions.pod:4926
12323 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12327 #: ../src/guestfs-actions.pod:4937
12328 msgid "guestfs_pread_device"
12332 #: ../src/guestfs-actions.pod:4939
12336 " guestfs_pread_device (guestfs_h *g,\n"
12337 " const char *device,\n"
12339 " int64_t offset,\n"
12340 " size_t *size_r);\n"
12345 #: ../src/guestfs-actions.pod:4946 ../fish/guestfish-actions.pod:3301
12347 "This command lets you read part of a file. It reads C<count> bytes of "
12348 "C<device>, starting at C<offset>."
12352 #: ../src/guestfs-actions.pod:4952
12353 msgid "See also C<guestfs_pread>."
12357 #: ../src/guestfs-actions.pod:4961
12358 msgid "(Added in 1.5.21)"
12362 #: ../src/guestfs-actions.pod:4963
12363 msgid "guestfs_pvcreate"
12367 #: ../src/guestfs-actions.pod:4965
12371 " guestfs_pvcreate (guestfs_h *g,\n"
12372 " const char *device);\n"
12377 #: ../src/guestfs-actions.pod:4969 ../fish/guestfish-actions.pod:3316
12379 "This creates an LVM physical volume on the named C<device>, where C<device> "
12380 "should usually be a partition name such as C</dev/sda1>."
12384 #: ../src/guestfs-actions.pod:4977
12385 msgid "guestfs_pvremove"
12389 #: ../src/guestfs-actions.pod:4979
12393 " guestfs_pvremove (guestfs_h *g,\n"
12394 " const char *device);\n"
12399 #: ../src/guestfs-actions.pod:4983 ../fish/guestfish-actions.pod:3324
12401 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12406 #: ../src/guestfs-actions.pod:4986 ../fish/guestfish-actions.pod:3327
12408 "The implementation uses the C<pvremove> command which refuses to wipe "
12409 "physical volumes that contain any volume groups, so you have to remove those "
12414 #: ../src/guestfs-actions.pod:4994
12415 msgid "guestfs_pvresize"
12419 #: ../src/guestfs-actions.pod:4996
12423 " guestfs_pvresize (guestfs_h *g,\n"
12424 " const char *device);\n"
12429 #: ../src/guestfs-actions.pod:5000 ../fish/guestfish-actions.pod:3335
12431 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12432 "the new size of the underlying device."
12436 #: ../src/guestfs-actions.pod:5007
12437 msgid "guestfs_pvresize_size"
12441 #: ../src/guestfs-actions.pod:5009
12445 " guestfs_pvresize_size (guestfs_h *g,\n"
12446 " const char *device,\n"
12447 " int64_t size);\n"
12452 #: ../src/guestfs-actions.pod:5014
12454 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12455 "specify the new size (in bytes) explicitly."
12459 #: ../src/guestfs-actions.pod:5021
12460 msgid "guestfs_pvs"
12464 #: ../src/guestfs-actions.pod:5023
12468 " guestfs_pvs (guestfs_h *g);\n"
12473 #: ../src/guestfs-actions.pod:5026 ../fish/guestfish-actions.pod:3349
12475 "List all the physical volumes detected. This is the equivalent of the "
12476 "L<pvs(8)> command."
12480 #: ../src/guestfs-actions.pod:5029 ../fish/guestfish-actions.pod:3352
12482 "This returns a list of just the device names that contain PVs "
12483 "(eg. C</dev/sda2>)."
12487 #: ../src/guestfs-actions.pod:5032
12488 msgid "See also C<guestfs_pvs_full>."
12492 #: ../src/guestfs-actions.pod:5040
12493 msgid "guestfs_pvs_full"
12497 #: ../src/guestfs-actions.pod:5042
12500 " struct guestfs_lvm_pv_list *\n"
12501 " guestfs_pvs_full (guestfs_h *g);\n"
12506 #: ../src/guestfs-actions.pod:5045 ../fish/guestfish-actions.pod:3361
12508 "List all the physical volumes detected. This is the equivalent of the "
12509 "L<pvs(8)> command. The \"full\" version includes all fields."
12513 #: ../src/guestfs-actions.pod:5048
12515 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12516 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
12521 #: ../src/guestfs-actions.pod:5054
12522 msgid "guestfs_pvuuid"
12526 #: ../src/guestfs-actions.pod:5056
12530 " guestfs_pvuuid (guestfs_h *g,\n"
12531 " const char *device);\n"
12536 #: ../src/guestfs-actions.pod:5060 ../fish/guestfish-actions.pod:3368
12537 msgid "This command returns the UUID of the LVM PV C<device>."
12541 #: ../src/guestfs-actions.pod:5067
12542 msgid "guestfs_pwrite"
12546 #: ../src/guestfs-actions.pod:5069
12550 " guestfs_pwrite (guestfs_h *g,\n"
12551 " const char *path,\n"
12552 " const char *content,\n"
12553 " size_t content_size,\n"
12554 " int64_t offset);\n"
12559 #: ../src/guestfs-actions.pod:5076 ../fish/guestfish-actions.pod:3374
12561 "This command writes to part of a file. It writes the data buffer C<content> "
12562 "to the file C<path> starting at offset C<offset>."
12566 #: ../src/guestfs-actions.pod:5079 ../fish/guestfish-actions.pod:3377
12568 "This command implements the L<pwrite(2)> system call, and like that system "
12569 "call it may not write the full data requested. The return value is the "
12570 "number of bytes that were actually written to the file. This could even be "
12571 "0, although short writes are unlikely for regular files in ordinary "
12576 #: ../src/guestfs-actions.pod:5085
12577 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12581 #: ../src/guestfs-actions.pod:5094
12582 msgid "guestfs_pwrite_device"
12586 #: ../src/guestfs-actions.pod:5096
12590 " guestfs_pwrite_device (guestfs_h *g,\n"
12591 " const char *device,\n"
12592 " const char *content,\n"
12593 " size_t content_size,\n"
12594 " int64_t offset);\n"
12599 #: ../src/guestfs-actions.pod:5103 ../fish/guestfish-actions.pod:3392
12601 "This command writes to part of a device. It writes the data buffer "
12602 "C<content> to C<device> starting at offset C<offset>."
12606 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3395
12608 "This command implements the L<pwrite(2)> system call, and like that system "
12609 "call it may not write the full data requested (although short writes to disk "
12610 "devices and partitions are probably impossible with standard Linux kernels)."
12614 #: ../src/guestfs-actions.pod:5111
12615 msgid "See also C<guestfs_pwrite>."
12619 #: ../src/guestfs-actions.pod:5118
12620 msgid "(Added in 1.5.20)"
12624 #: ../src/guestfs-actions.pod:5120
12625 msgid "guestfs_read_file"
12629 #: ../src/guestfs-actions.pod:5122
12633 " guestfs_read_file (guestfs_h *g,\n"
12634 " const char *path,\n"
12635 " size_t *size_r);\n"
12640 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3409
12641 msgid "This calls returns the contents of the file C<path> as a buffer."
12645 #: ../src/guestfs-actions.pod:5130
12647 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12648 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12649 "function is limited in the total size of file that can be handled."
12653 #: ../src/guestfs-actions.pod:5142
12654 msgid "(Added in 1.0.63)"
12658 #: ../src/guestfs-actions.pod:5144
12659 msgid "guestfs_read_lines"
12663 #: ../src/guestfs-actions.pod:5146
12667 " guestfs_read_lines (guestfs_h *g,\n"
12668 " const char *path);\n"
12673 #: ../src/guestfs-actions.pod:5152 ../fish/guestfish-actions.pod:3426
12675 "The file contents are returned as a list of lines. Trailing C<LF> and "
12676 "C<CRLF> character sequences are I<not> returned."
12680 #: ../src/guestfs-actions.pod:5155
12682 "Note that this function cannot correctly handle binary files (specifically, "
12683 "files containing C<\\0> character which is treated as end of line). For "
12684 "those you need to use the C<guestfs_read_file> function which has a more "
12685 "complex interface."
12689 #: ../src/guestfs-actions.pod:5166
12690 msgid "guestfs_readdir"
12694 #: ../src/guestfs-actions.pod:5168
12697 " struct guestfs_dirent_list *\n"
12698 " guestfs_readdir (guestfs_h *g,\n"
12699 " const char *dir);\n"
12704 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3438
12705 msgid "This returns the list of directory entries in directory C<dir>."
12709 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3440
12711 "All entries in the directory are returned, including C<.> and C<..>. The "
12712 "entries are I<not> sorted, but returned in the same order as the underlying "
12717 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3444
12719 "Also this call returns basic file type information about each file. The "
12720 "C<ftyp> field will contain one of the following characters:"
12724 #: ../src/guestfs-actions.pod:5183 ../fish/guestfish-actions.pod:3449
12729 #: ../src/guestfs-actions.pod:5185 ../fish/guestfish-actions.pod:3451
12730 msgid "Block special"
12734 #: ../src/guestfs-actions.pod:5187 ../fish/guestfish-actions.pod:3453
12739 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3455
12740 msgid "Char special"
12744 #: ../src/guestfs-actions.pod:5191 ../fish/guestfish-actions.pod:3457
12749 #: ../src/guestfs-actions.pod:5193 ../fish/guestfish-actions.pod:3459
12754 #: ../src/guestfs-actions.pod:5195 ../fish/guestfish-actions.pod:3461
12759 #: ../src/guestfs-actions.pod:5197 ../fish/guestfish-actions.pod:3463
12760 msgid "FIFO (named pipe)"
12764 #: ../src/guestfs-actions.pod:5199 ../fish/guestfish-actions.pod:3465
12769 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3467
12770 msgid "Symbolic link"
12774 #: ../src/guestfs-actions.pod:5203 ../fish/guestfish-actions.pod:3469
12779 #: ../src/guestfs-actions.pod:5205 ../fish/guestfish-actions.pod:3471
12780 msgid "Regular file"
12784 #: ../src/guestfs-actions.pod:5207 ../fish/guestfish-actions.pod:3473
12789 #: ../src/guestfs-actions.pod:5209 ../fish/guestfish-actions.pod:3475
12794 #: ../src/guestfs-actions.pod:5211 ../fish/guestfish-actions.pod:3477
12799 #: ../src/guestfs-actions.pod:5213 ../fish/guestfish-actions.pod:3479
12800 msgid "Unknown file type"
12804 #: ../src/guestfs-actions.pod:5215 ../fish/guestfish-actions.pod:3481
12809 #: ../src/guestfs-actions.pod:5217 ../fish/guestfish-actions.pod:3483
12810 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12814 #: ../src/guestfs-actions.pod:5222
12816 "This function is primarily intended for use by programs. To get a simple "
12817 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12818 "consumption, use C<guestfs_ll>."
12822 #: ../src/guestfs-actions.pod:5226
12824 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12825 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
12830 #: ../src/guestfs-actions.pod:5232
12831 msgid "guestfs_readlink"
12835 #: ../src/guestfs-actions.pod:5234
12839 " guestfs_readlink (guestfs_h *g,\n"
12840 " const char *path);\n"
12845 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3496
12846 msgid "This command reads the target of a symbolic link."
12850 #: ../src/guestfs-actions.pod:5245
12851 msgid "guestfs_readlinklist"
12855 #: ../src/guestfs-actions.pod:5247
12859 " guestfs_readlinklist (guestfs_h *g,\n"
12860 " const char *path,\n"
12861 " char *const *names);\n"
12866 #: ../src/guestfs-actions.pod:5252 ../fish/guestfish-actions.pod:3502
12868 "This call allows you to do a C<readlink> operation on multiple files, where "
12869 "all files are in the directory C<path>. C<names> is the list of files from "
12874 #: ../src/guestfs-actions.pod:5256 ../fish/guestfish-actions.pod:3506
12876 "On return you get a list of strings, with a one-to-one correspondence to the "
12877 "C<names> list. Each string is the value of the symbolic link."
12881 #: ../src/guestfs-actions.pod:5260 ../fish/guestfish-actions.pod:3510
12883 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12884 "result string is the empty string C<\"\">. However the whole operation is "
12885 "completed even if there were C<readlink(2)> errors, and so you can call this "
12886 "function with names where you don't know if they are symbolic links already "
12887 "(albeit slightly less efficient)."
12891 #: ../src/guestfs-actions.pod:5267 ../fish/guestfish-actions.pod:3517
12893 "This call is intended for programs that want to efficiently list a directory "
12894 "contents without making many round-trips. Very long directory listings "
12895 "might cause the protocol message size to be exceeded, causing this call to "
12896 "fail. The caller must split up such requests into smaller groups of names."
12900 #: ../src/guestfs-actions.pod:5280
12901 msgid "guestfs_realpath"
12905 #: ../src/guestfs-actions.pod:5282
12909 " guestfs_realpath (guestfs_h *g,\n"
12910 " const char *path);\n"
12915 #: ../src/guestfs-actions.pod:5286 ../fish/guestfish-actions.pod:3528
12917 "Return the canonicalized absolute pathname of C<path>. The returned path "
12918 "has no C<.>, C<..> or symbolic link path elements."
12922 #: ../src/guestfs-actions.pod:5294
12923 msgid "guestfs_removexattr"
12927 #: ../src/guestfs-actions.pod:5296
12931 " guestfs_removexattr (guestfs_h *g,\n"
12932 " const char *xattr,\n"
12933 " const char *path);\n"
12938 #: ../src/guestfs-actions.pod:5301 ../fish/guestfish-actions.pod:3535
12939 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12943 #: ../src/guestfs-actions.pod:5304
12944 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12948 #: ../src/guestfs-actions.pod:5310
12949 msgid "guestfs_resize2fs"
12953 #: ../src/guestfs-actions.pod:5312
12957 " guestfs_resize2fs (guestfs_h *g,\n"
12958 " const char *device);\n"
12963 #: ../src/guestfs-actions.pod:5316 ../fish/guestfish-actions.pod:3544
12965 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12966 "underlying device."
12970 #: ../src/guestfs-actions.pod:5319
12972 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12973 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12974 "sometimes gives an error about this and sometimes not. In any case, it is "
12975 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12979 #: ../src/guestfs-actions.pod:5329
12980 msgid "guestfs_resize2fs_size"
12984 #: ../src/guestfs-actions.pod:5331
12988 " guestfs_resize2fs_size (guestfs_h *g,\n"
12989 " const char *device,\n"
12990 " int64_t size);\n"
12995 #: ../src/guestfs-actions.pod:5336
12997 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12998 "to specify the new size (in bytes) explicitly."
13002 #: ../src/guestfs-actions.pod:5343
13007 #: ../src/guestfs-actions.pod:5345
13011 " guestfs_rm (guestfs_h *g,\n"
13012 " const char *path);\n"
13017 #: ../src/guestfs-actions.pod:5349 ../fish/guestfish-actions.pod:3564
13018 msgid "Remove the single file C<path>."
13022 #: ../src/guestfs-actions.pod:5355
13023 msgid "guestfs_rm_rf"
13027 #: ../src/guestfs-actions.pod:5357
13031 " guestfs_rm_rf (guestfs_h *g,\n"
13032 " const char *path);\n"
13037 #: ../src/guestfs-actions.pod:5361 ../fish/guestfish-actions.pod:3570
13039 "Remove the file or directory C<path>, recursively removing the contents if "
13040 "its a directory. This is like the C<rm -rf> shell command."
13044 #: ../src/guestfs-actions.pod:5369
13045 msgid "guestfs_rmdir"
13049 #: ../src/guestfs-actions.pod:5371
13053 " guestfs_rmdir (guestfs_h *g,\n"
13054 " const char *path);\n"
13059 #: ../src/guestfs-actions.pod:5375 ../fish/guestfish-actions.pod:3578
13060 msgid "Remove the single directory C<path>."
13064 #: ../src/guestfs-actions.pod:5381
13065 msgid "guestfs_rmmountpoint"
13069 #: ../src/guestfs-actions.pod:5383
13073 " guestfs_rmmountpoint (guestfs_h *g,\n"
13074 " const char *exemptpath);\n"
13079 #: ../src/guestfs-actions.pod:5387
13081 "This calls removes a mountpoint that was previously created with "
13082 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
13086 #: ../src/guestfs-actions.pod:5395
13087 msgid "guestfs_scrub_device"
13091 #: ../src/guestfs-actions.pod:5397
13095 " guestfs_scrub_device (guestfs_h *g,\n"
13096 " const char *device);\n"
13101 #: ../src/guestfs-actions.pod:5401 ../fish/guestfish-actions.pod:3592
13103 "This command writes patterns over C<device> to make data retrieval more "
13108 #: ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:5425 ../src/guestfs-actions.pod:5444 ../fish/guestfish-actions.pod:3595 ../fish/guestfish-actions.pod:3610 ../fish/guestfish-actions.pod:3623
13110 "It is an interface to the L<scrub(1)> program. See that manual page for "
13115 #: ../src/guestfs-actions.pod:5412 ../src/guestfs-actions.pod:5430 ../src/guestfs-actions.pod:5449
13116 msgid "(Added in 1.0.52)"
13120 #: ../src/guestfs-actions.pod:5414
13121 msgid "guestfs_scrub_file"
13125 #: ../src/guestfs-actions.pod:5416
13129 " guestfs_scrub_file (guestfs_h *g,\n"
13130 " const char *file);\n"
13135 #: ../src/guestfs-actions.pod:5420 ../fish/guestfish-actions.pod:3605
13137 "This command writes patterns over a file to make data retrieval more "
13142 #: ../src/guestfs-actions.pod:5423 ../fish/guestfish-actions.pod:3608
13143 msgid "The file is I<removed> after scrubbing."
13147 #: ../src/guestfs-actions.pod:5432
13148 msgid "guestfs_scrub_freespace"
13152 #: ../src/guestfs-actions.pod:5434
13156 " guestfs_scrub_freespace (guestfs_h *g,\n"
13157 " const char *dir);\n"
13162 #: ../src/guestfs-actions.pod:5438
13164 "This command creates the directory C<dir> and then fills it with files until "
13165 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13166 "and deletes them. The intention is to scrub any free space on the partition "
13167 "containing C<dir>."
13171 #: ../src/guestfs-actions.pod:5451
13172 msgid "guestfs_set_append"
13176 #: ../src/guestfs-actions.pod:5453
13180 " guestfs_set_append (guestfs_h *g,\n"
13181 " const char *append);\n"
13186 #: ../src/guestfs-actions.pod:5457 ../fish/guestfish-actions.pod:3632
13188 "This function is used to add additional options to the guest kernel command "
13193 #: ../src/guestfs-actions.pod:5460 ../fish/guestfish-actions.pod:3635
13195 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13196 "environment variable."
13200 #: ../src/guestfs-actions.pod:5463 ../fish/guestfish-actions.pod:3638
13202 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13203 "(libguestfs always adds a few of its own)."
13207 #: ../src/guestfs-actions.pod:5470
13208 msgid "guestfs_set_autosync"
13212 #: ../src/guestfs-actions.pod:5472
13216 " guestfs_set_autosync (guestfs_h *g,\n"
13217 " int autosync);\n"
13222 #: ../src/guestfs-actions.pod:5476
13224 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13225 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13226 "the handle is closed (also if the program exits without closing handles)."
13230 #: ../src/guestfs-actions.pod:5481 ../fish/guestfish-actions.pod:3652
13232 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13233 "disabled by default)."
13237 #: ../src/guestfs-actions.pod:5488
13238 msgid "guestfs_set_direct"
13242 #: ../src/guestfs-actions.pod:5490
13246 " guestfs_set_direct (guestfs_h *g,\n"
13252 #: ../src/guestfs-actions.pod:5494 ../fish/guestfish-actions.pod:3661
13254 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13255 "passed directly through to the appliance once it is launched."
13259 #: ../src/guestfs-actions.pod:5498
13261 "One consequence of this is that log messages aren't caught by the library "
13262 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13267 #: ../src/guestfs-actions.pod:5502 ../fish/guestfish-actions.pod:3669
13268 msgid "You probably don't want to use this unless you know what you are doing."
13272 #: ../src/guestfs-actions.pod:5505 ../fish/guestfish-actions.pod:3672
13273 msgid "The default is disabled."
13277 #: ../src/guestfs-actions.pod:5511
13278 msgid "guestfs_set_e2label"
13282 #: ../src/guestfs-actions.pod:5513
13286 " guestfs_set_e2label (guestfs_h *g,\n"
13287 " const char *device,\n"
13288 " const char *label);\n"
13293 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3678
13295 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13296 "C<label>. Filesystem labels are limited to 16 characters."
13300 #: ../src/guestfs-actions.pod:5522
13302 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13303 "the existing label on a filesystem."
13307 #: ../src/guestfs-actions.pod:5529
13308 msgid "guestfs_set_e2uuid"
13312 #: ../src/guestfs-actions.pod:5531
13316 " guestfs_set_e2uuid (guestfs_h *g,\n"
13317 " const char *device,\n"
13318 " const char *uuid);\n"
13323 #: ../src/guestfs-actions.pod:5536 ../fish/guestfish-actions.pod:3689
13325 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13326 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13327 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13331 #: ../src/guestfs-actions.pod:5541
13333 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13334 "the existing UUID of a filesystem."
13338 #: ../src/guestfs-actions.pod:5548
13339 msgid "guestfs_set_memsize"
13343 #: ../src/guestfs-actions.pod:5550
13347 " guestfs_set_memsize (guestfs_h *g,\n"
13353 #: ../src/guestfs-actions.pod:5554
13355 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13356 "This only has any effect if called before C<guestfs_launch>."
13360 #: ../src/guestfs-actions.pod:5558 ../fish/guestfish-actions.pod:3707
13362 "You can also change this by setting the environment variable "
13363 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13367 #: ../src/guestfs-actions.pod:5569
13368 msgid "guestfs_set_network"
13372 #: ../src/guestfs-actions.pod:5571
13376 " guestfs_set_network (guestfs_h *g,\n"
13382 #: ../src/guestfs-actions.pod:5575 ../fish/guestfish-actions.pod:3720
13384 "If C<network> is true, then the network is enabled in the libguestfs "
13385 "appliance. The default is false."
13389 #: ../src/guestfs-actions.pod:5578 ../fish/guestfish-actions.pod:3723
13391 "This affects whether commands are able to access the network (see "
13392 "L<guestfs(3)/RUNNING COMMANDS>)."
13396 #: ../src/guestfs-actions.pod:5581
13398 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13403 #: ../src/guestfs-actions.pod:5588
13404 msgid "guestfs_set_path"
13408 #: ../src/guestfs-actions.pod:5590
13412 " guestfs_set_path (guestfs_h *g,\n"
13413 " const char *searchpath);\n"
13418 #: ../src/guestfs-actions.pod:5594 ../fish/guestfish-actions.pod:3735
13419 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13423 #: ../src/guestfs-actions.pod:5596 ../fish/guestfish-actions.pod:3737
13425 "The default is C<$libdir/guestfs> unless overridden by setting "
13426 "C<LIBGUESTFS_PATH> environment variable."
13430 #: ../src/guestfs-actions.pod:5599 ../fish/guestfish-actions.pod:3740
13431 msgid "Setting C<path> to C<NULL> restores the default path."
13435 #: ../src/guestfs-actions.pod:5605
13436 msgid "guestfs_set_qemu"
13440 #: ../src/guestfs-actions.pod:5607
13444 " guestfs_set_qemu (guestfs_h *g,\n"
13445 " const char *qemu);\n"
13450 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3748
13451 msgid "Set the qemu binary that we will use."
13455 #: ../src/guestfs-actions.pod:5613 ../fish/guestfish-actions.pod:3750
13456 msgid "The default is chosen when the library was compiled by the configure script."
13460 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3753
13462 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13467 #: ../src/guestfs-actions.pod:5619 ../fish/guestfish-actions.pod:3756
13468 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13472 #: ../src/guestfs-actions.pod:5621 ../fish/guestfish-actions.pod:3758
13474 "Note that you should call this function as early as possible after creating "
13475 "the handle. This is because some pre-launch operations depend on testing "
13476 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13477 "don't retest features, and so you might see inconsistent results. Using the "
13478 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13479 "the qemu binary at the same time as the handle is created."
13483 #: ../src/guestfs-actions.pod:5633
13484 msgid "guestfs_set_recovery_proc"
13488 #: ../src/guestfs-actions.pod:5635
13492 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13493 " int recoveryproc);\n"
13498 #: ../src/guestfs-actions.pod:5639
13500 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13501 "not create a recovery process. The purpose of the recovery process is to "
13502 "stop runaway qemu processes in the case where the main program aborts "
13507 #: ../src/guestfs-actions.pod:5644
13509 "This only has any effect if called before C<guestfs_launch>, and the default "
13514 #: ../src/guestfs-actions.pod:5647 ../fish/guestfish-actions.pod:3780
13516 "About the only time when you would want to disable this is if the main "
13517 "process will fork itself into the background (\"daemonize\" itself). In "
13518 "this case the recovery process thinks that the main program has disappeared "
13519 "and so kills qemu, which is not very helpful."
13523 #: ../src/guestfs-actions.pod:5657
13524 msgid "guestfs_set_selinux"
13528 #: ../src/guestfs-actions.pod:5659
13532 " guestfs_set_selinux (guestfs_h *g,\n"
13538 #: ../src/guestfs-actions.pod:5663 ../fish/guestfish-actions.pod:3792
13540 "This sets the selinux flag that is passed to the appliance at boot time. "
13541 "The default is C<selinux=0> (disabled)."
13545 #: ../src/guestfs-actions.pod:5666 ../fish/guestfish-actions.pod:3795
13547 "Note that if SELinux is enabled, it is always in Permissive mode "
13548 "(C<enforcing=0>)."
13552 #: ../src/guestfs-actions.pod:5676
13553 msgid "guestfs_set_trace"
13557 #: ../src/guestfs-actions.pod:5678
13561 " guestfs_set_trace (guestfs_h *g,\n"
13567 #: ../src/guestfs-actions.pod:5682 ../fish/guestfish-actions.pod:3807
13569 "If the command trace flag is set to 1, then commands are printed on stderr "
13570 "before they are executed in a format which is very similar to the one used "
13571 "by guestfish. In other words, you can run a program with this enabled, and "
13572 "you will get out a script which you can feed to guestfish to perform the "
13573 "same set of actions."
13577 #: ../src/guestfs-actions.pod:5689 ../fish/guestfish-actions.pod:3814
13579 "If you want to trace C API calls into libguestfs (and other libraries) then "
13580 "possibly a better way is to use the external ltrace(1) command."
13584 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3818
13586 "Command traces are disabled unless the environment variable "
13587 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13591 #: ../src/guestfs-actions.pod:5700
13592 msgid "guestfs_set_verbose"
13596 #: ../src/guestfs-actions.pod:5702
13600 " guestfs_set_verbose (guestfs_h *g,\n"
13606 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3827
13607 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13611 #: ../src/guestfs-actions.pod:5708 ../fish/guestfish-actions.pod:3829
13613 "Verbose messages are disabled unless the environment variable "
13614 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13618 #: ../src/guestfs-actions.pod:5715
13619 msgid "guestfs_setcon"
13623 #: ../src/guestfs-actions.pod:5717
13627 " guestfs_setcon (guestfs_h *g,\n"
13628 " const char *context);\n"
13633 #: ../src/guestfs-actions.pod:5721 ../fish/guestfish-actions.pod:3836
13635 "This sets the SELinux security context of the daemon to the string "
13640 #: ../src/guestfs-actions.pod:5724 ../fish/guestfish-actions.pod:3839
13641 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13645 #: ../src/guestfs-actions.pod:5730
13646 msgid "guestfs_setxattr"
13650 #: ../src/guestfs-actions.pod:5732
13654 " guestfs_setxattr (guestfs_h *g,\n"
13655 " const char *xattr,\n"
13656 " const char *val,\n"
13658 " const char *path);\n"
13663 #: ../src/guestfs-actions.pod:5739 ../fish/guestfish-actions.pod:3845
13665 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13666 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13670 #: ../src/guestfs-actions.pod:5743
13671 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13675 #: ../src/guestfs-actions.pod:5749
13676 msgid "guestfs_sfdisk"
13680 #: ../src/guestfs-actions.pod:5751
13684 " guestfs_sfdisk (guestfs_h *g,\n"
13685 " const char *device,\n"
13689 " char *const *lines);\n"
13694 #: ../src/guestfs-actions.pod:5759 ../fish/guestfish-actions.pod:3855
13696 "This is a direct interface to the L<sfdisk(8)> program for creating "
13697 "partitions on block devices."
13701 #: ../src/guestfs-actions.pod:5762 ../fish/guestfish-actions.pod:3858
13702 msgid "C<device> should be a block device, for example C</dev/sda>."
13706 #: ../src/guestfs-actions.pod:5764 ../fish/guestfish-actions.pod:3860
13708 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13709 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13710 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13711 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13712 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13713 "the kernel) cannot work out the right geometry and you will need to tell it."
13717 #: ../src/guestfs-actions.pod:5772 ../fish/guestfish-actions.pod:3868
13719 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13720 "refer to the L<sfdisk(8)> manpage."
13724 #: ../src/guestfs-actions.pod:5775 ../fish/guestfish-actions.pod:3871
13726 "To create a single partition occupying the whole disk, you would pass "
13727 "C<lines> as a single element list, when the single element being the string "
13732 #: ../src/guestfs-actions.pod:5779
13733 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13737 #: ../src/guestfs-actions.pod:5789
13738 msgid "guestfs_sfdiskM"
13742 #: ../src/guestfs-actions.pod:5791
13746 " guestfs_sfdiskM (guestfs_h *g,\n"
13747 " const char *device,\n"
13748 " char *const *lines);\n"
13753 #: ../src/guestfs-actions.pod:5796
13755 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13756 "partition sizes are specified in megabytes only (rounded to the nearest "
13757 "cylinder) and you don't need to specify the cyls, heads and sectors "
13758 "parameters which were rarely if ever used anyway."
13762 #: ../src/guestfs-actions.pod:5802
13764 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13765 "C<guestfs_part_disk>"
13769 #: ../src/guestfs-actions.pod:5812
13770 msgid "guestfs_sfdisk_N"
13774 #: ../src/guestfs-actions.pod:5814
13778 " guestfs_sfdisk_N (guestfs_h *g,\n"
13779 " const char *device,\n"
13784 " const char *line);\n"
13789 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3901
13791 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13792 "(note: C<n> counts from 1)."
13796 #: ../src/guestfs-actions.pod:5826
13798 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13799 "for the cyls/heads/sectors parameters."
13803 #: ../src/guestfs-actions.pod:5829
13804 msgid "See also: C<guestfs_part_add>"
13808 #: ../src/guestfs-actions.pod:5838
13809 msgid "guestfs_sfdisk_disk_geometry"
13813 #: ../src/guestfs-actions.pod:5840
13817 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13818 " const char *device);\n"
13823 #: ../src/guestfs-actions.pod:5844
13825 "This displays the disk geometry of C<device> read from the partition table. "
13826 "Especially in the case where the underlying block device has been resized, "
13827 "this can be different from the kernel's idea of the geometry (see "
13828 "C<guestfs_sfdisk_kernel_geometry>)."
13832 #: ../src/guestfs-actions.pod:5849 ../src/guestfs-actions.pod:5865 ../fish/guestfish-actions.pod:3921 ../fish/guestfish-actions.pod:3930
13833 msgid "The result is in human-readable format, and not designed to be parsed."
13837 #: ../src/guestfs-actions.pod:5857
13838 msgid "guestfs_sfdisk_kernel_geometry"
13842 #: ../src/guestfs-actions.pod:5859
13846 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13847 " const char *device);\n"
13852 #: ../src/guestfs-actions.pod:5863 ../fish/guestfish-actions.pod:3928
13853 msgid "This displays the kernel's idea of the geometry of C<device>."
13857 #: ../src/guestfs-actions.pod:5873
13858 msgid "guestfs_sfdisk_l"
13862 #: ../src/guestfs-actions.pod:5875
13866 " guestfs_sfdisk_l (guestfs_h *g,\n"
13867 " const char *device);\n"
13872 #: ../src/guestfs-actions.pod:5879 ../fish/guestfish-actions.pod:3937
13874 "This displays the partition table on C<device>, in the human-readable output "
13875 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13879 #: ../src/guestfs-actions.pod:5883
13880 msgid "See also: C<guestfs_part_list>"
13884 #: ../src/guestfs-actions.pod:5890
13889 #: ../src/guestfs-actions.pod:5892
13893 " guestfs_sh (guestfs_h *g,\n"
13894 " const char *command);\n"
13899 #: ../src/guestfs-actions.pod:5896 ../fish/guestfish-actions.pod:3947
13901 "This call runs a command from the guest filesystem via the guest's "
13906 #: ../src/guestfs-actions.pod:5899
13907 msgid "This is like C<guestfs_command>, but passes the command to:"
13911 #: ../src/guestfs-actions.pod:5901 ../fish/guestfish-actions.pod:3952
13914 " /bin/sh -c \"command\"\n"
13919 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3954
13921 "Depending on the guest's shell, this usually results in wildcards being "
13922 "expanded, shell expressions being interpolated and so on."
13926 #: ../src/guestfs-actions.pod:5907
13927 msgid "All the provisos about C<guestfs_command> apply to this call."
13931 #: ../src/guestfs-actions.pod:5914
13932 msgid "guestfs_sh_lines"
13936 #: ../src/guestfs-actions.pod:5916
13940 " guestfs_sh_lines (guestfs_h *g,\n"
13941 " const char *command);\n"
13946 #: ../src/guestfs-actions.pod:5920
13948 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13953 #: ../src/guestfs-actions.pod:5923
13954 msgid "See also: C<guestfs_command_lines>"
13958 #: ../src/guestfs-actions.pod:5931
13959 msgid "guestfs_sleep"
13963 #: ../src/guestfs-actions.pod:5933
13967 " guestfs_sleep (guestfs_h *g,\n"
13973 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3973
13974 msgid "Sleep for C<secs> seconds."
13978 #: ../src/guestfs-actions.pod:5941
13979 msgid "(Added in 1.0.41)"
13983 #: ../src/guestfs-actions.pod:5943 ../src/guestfs-structs.pod:109
13984 msgid "guestfs_stat"
13988 #: ../src/guestfs-actions.pod:5945
13991 " struct guestfs_stat *\n"
13992 " guestfs_stat (guestfs_h *g,\n"
13993 " const char *path);\n"
13998 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3981
13999 msgid "This is the same as the C<stat(2)> system call."
14003 #: ../src/guestfs-actions.pod:5959 ../src/guestfs-structs.pod:135
14004 msgid "guestfs_statvfs"
14008 #: ../src/guestfs-actions.pod:5961
14011 " struct guestfs_statvfs *\n"
14012 " guestfs_statvfs (guestfs_h *g,\n"
14013 " const char *path);\n"
14018 #: ../src/guestfs-actions.pod:5965 ../fish/guestfish-actions.pod:3987
14020 "Returns file system statistics for any mounted file system. C<path> should "
14021 "be a file or directory in the mounted file system (typically it is the mount "
14022 "point itself, but it doesn't need to be)."
14026 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:3991
14027 msgid "This is the same as the C<statvfs(2)> system call."
14031 #: ../src/guestfs-actions.pod:5971
14033 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
14034 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
14038 #: ../src/guestfs-actions.pod:5977
14039 msgid "guestfs_strings"
14043 #: ../src/guestfs-actions.pod:5979
14047 " guestfs_strings (guestfs_h *g,\n"
14048 " const char *path);\n"
14053 #: ../src/guestfs-actions.pod:5983 ../fish/guestfish-actions.pod:3997
14055 "This runs the L<strings(1)> command on a file and returns the list of "
14056 "printable strings found."
14060 #: ../src/guestfs-actions.pod:5995
14061 msgid "guestfs_strings_e"
14065 #: ../src/guestfs-actions.pod:5997
14069 " guestfs_strings_e (guestfs_h *g,\n"
14070 " const char *encoding,\n"
14071 " const char *path);\n"
14076 #: ../src/guestfs-actions.pod:6002
14078 "This is like the C<guestfs_strings> command, but allows you to specify the "
14079 "encoding of strings that are looked for in the source file C<path>."
14083 #: ../src/guestfs-actions.pod:6006 ../fish/guestfish-actions.pod:4011
14084 msgid "Allowed encodings are:"
14088 #: ../src/guestfs-actions.pod:6010 ../fish/guestfish-actions.pod:4015
14093 #: ../src/guestfs-actions.pod:6012
14095 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
14096 "ISO-8859-X (this is what C<guestfs_strings> uses)."
14100 #: ../src/guestfs-actions.pod:6015 ../fish/guestfish-actions.pod:4020
14105 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4022
14106 msgid "Single 8-bit-byte characters."
14110 #: ../src/guestfs-actions.pod:6019 ../fish/guestfish-actions.pod:4024
14115 #: ../src/guestfs-actions.pod:6021 ../fish/guestfish-actions.pod:4026
14116 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14120 #: ../src/guestfs-actions.pod:6024 ../fish/guestfish-actions.pod:4029
14121 msgid "l (lower case letter L)"
14125 #: ../src/guestfs-actions.pod:6026 ../fish/guestfish-actions.pod:4031
14127 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14128 "examining binaries in Windows guests."
14132 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4034
14137 #: ../src/guestfs-actions.pod:6031 ../fish/guestfish-actions.pod:4036
14138 msgid "32-bit big endian such as UCS-4BE."
14142 #: ../src/guestfs-actions.pod:6033 ../fish/guestfish-actions.pod:4038
14147 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4040
14148 msgid "32-bit little endian such as UCS-4LE."
14152 #: ../src/guestfs-actions.pod:6039 ../fish/guestfish-actions.pod:4044
14153 msgid "The returned strings are transcoded to UTF-8."
14157 #: ../src/guestfs-actions.pod:6050
14158 msgid "guestfs_swapoff_device"
14162 #: ../src/guestfs-actions.pod:6052
14166 " guestfs_swapoff_device (guestfs_h *g,\n"
14167 " const char *device);\n"
14172 #: ../src/guestfs-actions.pod:6056
14174 "This command disables the libguestfs appliance swap device or partition "
14175 "named C<device>. See C<guestfs_swapon_device>."
14179 #: ../src/guestfs-actions.pod:6064
14180 msgid "guestfs_swapoff_file"
14184 #: ../src/guestfs-actions.pod:6066
14188 " guestfs_swapoff_file (guestfs_h *g,\n"
14189 " const char *file);\n"
14194 #: ../src/guestfs-actions.pod:6070 ../fish/guestfish-actions.pod:4061
14195 msgid "This command disables the libguestfs appliance swap on file."
14199 #: ../src/guestfs-actions.pod:6076
14200 msgid "guestfs_swapoff_label"
14204 #: ../src/guestfs-actions.pod:6078
14208 " guestfs_swapoff_label (guestfs_h *g,\n"
14209 " const char *label);\n"
14214 #: ../src/guestfs-actions.pod:6082 ../fish/guestfish-actions.pod:4067
14216 "This command disables the libguestfs appliance swap on labeled swap "
14221 #: ../src/guestfs-actions.pod:6089
14222 msgid "guestfs_swapoff_uuid"
14226 #: ../src/guestfs-actions.pod:6091
14230 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14231 " const char *uuid);\n"
14236 #: ../src/guestfs-actions.pod:6095 ../fish/guestfish-actions.pod:4074
14238 "This command disables the libguestfs appliance swap partition with the given "
14243 #: ../src/guestfs-actions.pod:6102
14244 msgid "guestfs_swapon_device"
14248 #: ../src/guestfs-actions.pod:6104
14252 " guestfs_swapon_device (guestfs_h *g,\n"
14253 " const char *device);\n"
14258 #: ../src/guestfs-actions.pod:6108
14260 "This command enables the libguestfs appliance to use the swap device or "
14261 "partition named C<device>. The increased memory is made available for all "
14262 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14266 #: ../src/guestfs-actions.pod:6113 ../fish/guestfish-actions.pod:4086
14268 "Note that you should not swap to existing guest swap partitions unless you "
14269 "know what you are doing. They may contain hibernation information, or other "
14270 "information that the guest doesn't want you to trash. You also risk leaking "
14271 "information about the host to the guest this way. Instead, attach a new "
14272 "host device to the guest and swap on that."
14276 #: ../src/guestfs-actions.pod:6124
14277 msgid "guestfs_swapon_file"
14281 #: ../src/guestfs-actions.pod:6126
14285 " guestfs_swapon_file (guestfs_h *g,\n"
14286 " const char *file);\n"
14291 #: ../src/guestfs-actions.pod:6130
14293 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14298 #: ../src/guestfs-actions.pod:6137
14299 msgid "guestfs_swapon_label"
14303 #: ../src/guestfs-actions.pod:6139
14307 " guestfs_swapon_label (guestfs_h *g,\n"
14308 " const char *label);\n"
14313 #: ../src/guestfs-actions.pod:6143
14315 "This command enables swap to a labeled swap partition. See "
14316 "C<guestfs_swapon_device> for other notes."
14320 #: ../src/guestfs-actions.pod:6150
14321 msgid "guestfs_swapon_uuid"
14325 #: ../src/guestfs-actions.pod:6152
14329 " guestfs_swapon_uuid (guestfs_h *g,\n"
14330 " const char *uuid);\n"
14335 #: ../src/guestfs-actions.pod:6156
14337 "This command enables swap to a swap partition with the given UUID. See "
14338 "C<guestfs_swapon_device> for other notes."
14342 #: ../src/guestfs-actions.pod:6163
14343 msgid "guestfs_sync"
14347 #: ../src/guestfs-actions.pod:6165
14351 " guestfs_sync (guestfs_h *g);\n"
14356 #: ../src/guestfs-actions.pod:6168 ../fish/guestfish-actions.pod:4118
14358 "This syncs the disk, so that any writes are flushed through to the "
14359 "underlying disk image."
14363 #: ../src/guestfs-actions.pod:6171 ../fish/guestfish-actions.pod:4121
14365 "You should always call this if you have modified a disk image, before "
14366 "closing the handle."
14370 #: ../src/guestfs-actions.pod:6178
14371 msgid "guestfs_tail"
14375 #: ../src/guestfs-actions.pod:6180
14379 " guestfs_tail (guestfs_h *g,\n"
14380 " const char *path);\n"
14385 #: ../src/guestfs-actions.pod:6184 ../fish/guestfish-actions.pod:4128
14386 msgid "This command returns up to the last 10 lines of a file as a list of strings."
14390 #: ../src/guestfs-actions.pod:6196
14391 msgid "guestfs_tail_n"
14395 #: ../src/guestfs-actions.pod:6198
14399 " guestfs_tail_n (guestfs_h *g,\n"
14401 " const char *path);\n"
14406 #: ../src/guestfs-actions.pod:6203 ../fish/guestfish-actions.pod:4138
14408 "If the parameter C<nrlines> is a positive number, this returns the last "
14409 "C<nrlines> lines of the file C<path>."
14413 #: ../src/guestfs-actions.pod:6206 ../fish/guestfish-actions.pod:4141
14415 "If the parameter C<nrlines> is a negative number, this returns lines from "
14416 "the file C<path>, starting with the C<-nrlines>th line."
14420 #: ../src/guestfs-actions.pod:6220
14421 msgid "guestfs_tar_in"
14425 #: ../src/guestfs-actions.pod:6222
14429 " guestfs_tar_in (guestfs_h *g,\n"
14430 " const char *tarfile,\n"
14431 " const char *directory);\n"
14436 #: ../src/guestfs-actions.pod:6227 ../fish/guestfish-actions.pod:4153
14438 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14439 "tar file) into C<directory>."
14443 #: ../src/guestfs-actions.pod:6230
14444 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14448 #: ../src/guestfs-actions.pod:6235 ../src/guestfs-actions.pod:6252 ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6284
14449 msgid "(Added in 1.0.3)"
14453 #: ../src/guestfs-actions.pod:6237
14454 msgid "guestfs_tar_out"
14458 #: ../src/guestfs-actions.pod:6239
14462 " guestfs_tar_out (guestfs_h *g,\n"
14463 " const char *directory,\n"
14464 " const char *tarfile);\n"
14469 #: ../src/guestfs-actions.pod:6244 ../fish/guestfish-actions.pod:4165
14471 "This command packs the contents of C<directory> and downloads it to local "
14476 #: ../src/guestfs-actions.pod:6247
14478 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14479 "C<guestfs_txz_out>."
14483 #: ../src/guestfs-actions.pod:6254
14484 msgid "guestfs_tgz_in"
14488 #: ../src/guestfs-actions.pod:6256
14492 " guestfs_tgz_in (guestfs_h *g,\n"
14493 " const char *tarball,\n"
14494 " const char *directory);\n"
14499 #: ../src/guestfs-actions.pod:6261 ../fish/guestfish-actions.pod:4177
14501 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14502 "tar file) into C<directory>."
14506 #: ../src/guestfs-actions.pod:6264
14507 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14511 #: ../src/guestfs-actions.pod:6270
14512 msgid "guestfs_tgz_out"
14516 #: ../src/guestfs-actions.pod:6272
14520 " guestfs_tgz_out (guestfs_h *g,\n"
14521 " const char *directory,\n"
14522 " const char *tarball);\n"
14527 #: ../src/guestfs-actions.pod:6277 ../fish/guestfish-actions.pod:4188
14529 "This command packs the contents of C<directory> and downloads it to local "
14534 #: ../src/guestfs-actions.pod:6280
14535 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14539 #: ../src/guestfs-actions.pod:6286
14540 msgid "guestfs_touch"
14544 #: ../src/guestfs-actions.pod:6288
14548 " guestfs_touch (guestfs_h *g,\n"
14549 " const char *path);\n"
14554 #: ../src/guestfs-actions.pod:6292 ../fish/guestfish-actions.pod:4199
14556 "Touch acts like the L<touch(1)> command. It can be used to update the "
14557 "timestamps on a file, or, if the file does not exist, to create a new "
14558 "zero-length file."
14562 #: ../src/guestfs-actions.pod:6296 ../fish/guestfish-actions.pod:4203
14564 "This command only works on regular files, and will fail on other file types "
14565 "such as directories, symbolic links, block special etc."
14569 #: ../src/guestfs-actions.pod:6303
14570 msgid "guestfs_truncate"
14574 #: ../src/guestfs-actions.pod:6305
14578 " guestfs_truncate (guestfs_h *g,\n"
14579 " const char *path);\n"
14584 #: ../src/guestfs-actions.pod:6309 ../fish/guestfish-actions.pod:4210
14586 "This command truncates C<path> to a zero-length file. The file must exist "
14591 #: ../src/guestfs-actions.pod:6316
14592 msgid "guestfs_truncate_size"
14596 #: ../src/guestfs-actions.pod:6318
14600 " guestfs_truncate_size (guestfs_h *g,\n"
14601 " const char *path,\n"
14602 " int64_t size);\n"
14607 #: ../src/guestfs-actions.pod:6323 ../fish/guestfish-actions.pod:4217
14609 "This command truncates C<path> to size C<size> bytes. The file must exist "
14614 #: ../src/guestfs-actions.pod:6326
14616 "If the current file size is less than C<size> then the file is extended to "
14617 "the required size with zero bytes. This creates a sparse file (ie. disk "
14618 "blocks are not allocated for the file until you write to it). To create a "
14619 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14623 #: ../src/guestfs-actions.pod:6336
14624 msgid "guestfs_tune2fs_l"
14628 #: ../src/guestfs-actions.pod:6338
14632 " guestfs_tune2fs_l (guestfs_h *g,\n"
14633 " const char *device);\n"
14638 #: ../src/guestfs-actions.pod:6342 ../fish/guestfish-actions.pod:4230
14640 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14645 #: ../src/guestfs-actions.pod:6345 ../fish/guestfish-actions.pod:4233
14647 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14648 "for more details. The list of fields returned isn't clearly defined, and "
14649 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14650 "and the filesystem itself."
14654 #: ../src/guestfs-actions.pod:6358
14655 msgid "guestfs_txz_in"
14659 #: ../src/guestfs-actions.pod:6360
14663 " guestfs_txz_in (guestfs_h *g,\n"
14664 " const char *tarball,\n"
14665 " const char *directory);\n"
14670 #: ../src/guestfs-actions.pod:6365 ../fish/guestfish-actions.pod:4242
14672 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14673 "tar file) into C<directory>."
14677 #: ../src/guestfs-actions.pod:6372
14678 msgid "guestfs_txz_out"
14682 #: ../src/guestfs-actions.pod:6374
14686 " guestfs_txz_out (guestfs_h *g,\n"
14687 " const char *directory,\n"
14688 " const char *tarball);\n"
14693 #: ../src/guestfs-actions.pod:6379 ../fish/guestfish-actions.pod:4251
14695 "This command packs the contents of C<directory> and downloads it to local "
14696 "file C<tarball> (as an xz compressed tar archive)."
14700 #: ../src/guestfs-actions.pod:6386
14701 msgid "guestfs_umask"
14705 #: ../src/guestfs-actions.pod:6388
14709 " guestfs_umask (guestfs_h *g,\n"
14715 #: ../src/guestfs-actions.pod:6392 ../fish/guestfish-actions.pod:4260
14717 "This function sets the mask used for creating new files and device nodes to "
14722 #: ../src/guestfs-actions.pod:6395 ../fish/guestfish-actions.pod:4263
14724 "Typical umask values would be C<022> which creates new files with "
14725 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14726 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14730 #: ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4268
14732 "The default umask is C<022>. This is important because it means that "
14733 "directories and device nodes will be created with C<0644> or C<0755> mode "
14734 "even if you specify C<0777>."
14738 #: ../src/guestfs-actions.pod:6404
14740 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14741 "C<guestfs_mkdir>."
14745 #: ../src/guestfs-actions.pod:6407 ../fish/guestfish-actions.pod:4275
14746 msgid "This call returns the previous umask."
14750 #: ../src/guestfs-actions.pod:6413
14751 msgid "guestfs_umount"
14755 #: ../src/guestfs-actions.pod:6415
14759 " guestfs_umount (guestfs_h *g,\n"
14760 " const char *pathordevice);\n"
14765 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4283
14767 "This unmounts the given filesystem. The filesystem may be specified either "
14768 "by its mountpoint (path) or the device which contains the filesystem."
14772 #: ../src/guestfs-actions.pod:6427
14773 msgid "guestfs_umount_all"
14777 #: ../src/guestfs-actions.pod:6429
14781 " guestfs_umount_all (guestfs_h *g);\n"
14786 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4293
14787 msgid "This unmounts all mounted filesystems."
14791 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4295
14792 msgid "Some internal mounts are not unmounted by this call."
14796 #: ../src/guestfs-actions.pod:6440
14797 msgid "guestfs_upload"
14801 #: ../src/guestfs-actions.pod:6442
14805 " guestfs_upload (guestfs_h *g,\n"
14806 " const char *filename,\n"
14807 " const char *remotefilename);\n"
14812 #: ../src/guestfs-actions.pod:6447 ../src/guestfs-actions.pod:6471 ../fish/guestfish-actions.pod:4301 ../fish/guestfish-actions.pod:4314
14813 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14817 #: ../src/guestfs-actions.pod:6452
14818 msgid "See also C<guestfs_download>."
14822 #: ../src/guestfs-actions.pod:6463
14823 msgid "guestfs_upload_offset"
14827 #: ../src/guestfs-actions.pod:6465
14831 " guestfs_upload_offset (guestfs_h *g,\n"
14832 " const char *filename,\n"
14833 " const char *remotefilename,\n"
14834 " int64_t offset);\n"
14839 #: ../src/guestfs-actions.pod:6474 ../fish/guestfish-actions.pod:4317
14841 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14842 "The intention is to overwrite parts of existing files or devices, although "
14843 "if a non-existant file is specified then it is created with a \"hole\" "
14844 "before C<offset>. The size of the data written is implicit in the size of "
14845 "the source C<filename>."
14849 #: ../src/guestfs-actions.pod:6481
14851 "Note that there is no limit on the amount of data that can be uploaded with "
14852 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14853 "full amount unless an error occurs."
14857 #: ../src/guestfs-actions.pod:6486
14858 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14862 #: ../src/guestfs-actions.pod:6497
14863 msgid "guestfs_utimens"
14867 #: ../src/guestfs-actions.pod:6499
14871 " guestfs_utimens (guestfs_h *g,\n"
14872 " const char *path,\n"
14873 " int64_t atsecs,\n"
14874 " int64_t atnsecs,\n"
14875 " int64_t mtsecs,\n"
14876 " int64_t mtnsecs);\n"
14881 #: ../src/guestfs-actions.pod:6507 ../fish/guestfish-actions.pod:4337
14882 msgid "This command sets the timestamps of a file with nanosecond precision."
14886 #: ../src/guestfs-actions.pod:6510 ../fish/guestfish-actions.pod:4340
14888 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14893 #: ../src/guestfs-actions.pod:6513 ../fish/guestfish-actions.pod:4343
14895 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14896 "nanoseconds from the epoch."
14900 #: ../src/guestfs-actions.pod:6516 ../fish/guestfish-actions.pod:4346
14902 "If the C<*nsecs> field contains the special value C<-1> then the "
14903 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14904 "ignored in this case)."
14908 #: ../src/guestfs-actions.pod:6520 ../fish/guestfish-actions.pod:4350
14910 "If the C<*nsecs> field contains the special value C<-2> then the "
14911 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14916 #: ../src/guestfs-actions.pod:6528 ../src/guestfs-structs.pod:175
14917 msgid "guestfs_version"
14921 #: ../src/guestfs-actions.pod:6530
14924 " struct guestfs_version *\n"
14925 " guestfs_version (guestfs_h *g);\n"
14930 #: ../src/guestfs-actions.pod:6533 ../fish/guestfish-actions.pod:4358
14931 msgid "Return the libguestfs version number that the program is linked against."
14935 #: ../src/guestfs-actions.pod:6536 ../fish/guestfish-actions.pod:4361
14937 "Note that because of dynamic linking this is not necessarily the version of "
14938 "libguestfs that you compiled against. You can compile the program, and then "
14939 "at runtime dynamically link against a completely different C<libguestfs.so> "
14944 #: ../src/guestfs-actions.pod:6541 ../fish/guestfish-actions.pod:4366
14946 "This call was added in version C<1.0.58>. In previous versions of "
14947 "libguestfs there was no way to get the version number. From C code you can "
14948 "use dynamic linker functions to find out if this symbol exists (if it "
14949 "doesn't, then it's an earlier version)."
14953 #: ../src/guestfs-actions.pod:6547 ../fish/guestfish-actions.pod:4372
14955 "The call returns a structure with four elements. The first three (C<major>, "
14956 "C<minor> and C<release>) are numbers and correspond to the usual version "
14957 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14958 "but may be used for distro-specific information."
14962 #: ../src/guestfs-actions.pod:6553 ../fish/guestfish-actions.pod:4378
14963 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14967 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4381
14968 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14972 #: ../src/guestfs-actions.pod:6558
14974 "I<Note:> Don't use this call to test for availability of features. In "
14975 "enterprise distributions we backport features from later versions into "
14976 "earlier versions, making this an unreliable way to test for features. Use "
14977 "C<guestfs_available> instead."
14981 #: ../src/guestfs-actions.pod:6564
14983 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14984 "error. I<The caller must call C<guestfs_free_version> after use>."
14988 #: ../src/guestfs-actions.pod:6568
14989 msgid "(Added in 1.0.58)"
14993 #: ../src/guestfs-actions.pod:6570
14994 msgid "guestfs_vfs_label"
14998 #: ../src/guestfs-actions.pod:6572
15002 " guestfs_vfs_label (guestfs_h *g,\n"
15003 " const char *device);\n"
15008 #: ../src/guestfs-actions.pod:6576 ../fish/guestfish-actions.pod:4393
15009 msgid "This returns the filesystem label of the filesystem on C<device>."
15013 #: ../src/guestfs-actions.pod:6579 ../fish/guestfish-actions.pod:4396
15014 msgid "If the filesystem is unlabeled, this returns the empty string."
15018 #: ../src/guestfs-actions.pod:6581
15019 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
15023 #: ../src/guestfs-actions.pod:6586 ../src/guestfs-actions.pod:6623
15024 msgid "(Added in 1.3.18)"
15028 #: ../src/guestfs-actions.pod:6588
15029 msgid "guestfs_vfs_type"
15033 #: ../src/guestfs-actions.pod:6590
15037 " guestfs_vfs_type (guestfs_h *g,\n"
15038 " const char *device);\n"
15043 #: ../src/guestfs-actions.pod:6594 ../fish/guestfish-actions.pod:4404
15045 "This command gets the filesystem type corresponding to the filesystem on "
15050 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4407
15052 "For most filesystems, the result is the name of the Linux VFS module which "
15053 "would be used to mount this filesystem if you mounted it without specifying "
15054 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
15058 #: ../src/guestfs-actions.pod:6607
15059 msgid "guestfs_vfs_uuid"
15063 #: ../src/guestfs-actions.pod:6609
15067 " guestfs_vfs_uuid (guestfs_h *g,\n"
15068 " const char *device);\n"
15073 #: ../src/guestfs-actions.pod:6613 ../fish/guestfish-actions.pod:4416
15074 msgid "This returns the filesystem UUID of the filesystem on C<device>."
15078 #: ../src/guestfs-actions.pod:6616 ../fish/guestfish-actions.pod:4419
15079 msgid "If the filesystem does not have a UUID, this returns the empty string."
15083 #: ../src/guestfs-actions.pod:6618
15084 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
15088 #: ../src/guestfs-actions.pod:6625
15089 msgid "guestfs_vg_activate"
15093 #: ../src/guestfs-actions.pod:6627
15097 " guestfs_vg_activate (guestfs_h *g,\n"
15099 " char *const *volgroups);\n"
15104 #: ../src/guestfs-actions.pod:6632 ../fish/guestfish-actions.pod:4427
15106 "This command activates or (if C<activate> is false) deactivates all logical "
15107 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15108 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15109 "deactivated, then those devices disappear."
15113 #: ../src/guestfs-actions.pod:6638 ../fish/guestfish-actions.pod:4433
15114 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15118 #: ../src/guestfs-actions.pod:6640 ../fish/guestfish-actions.pod:4435
15120 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15121 "activated or deactivated."
15125 #: ../src/guestfs-actions.pod:6647
15126 msgid "guestfs_vg_activate_all"
15130 #: ../src/guestfs-actions.pod:6649
15134 " guestfs_vg_activate_all (guestfs_h *g,\n"
15135 " int activate);\n"
15140 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4442
15142 "This command activates or (if C<activate> is false) deactivates all logical "
15143 "volumes in all volume groups. If activated, then they are made known to the "
15144 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15145 "those devices disappear."
15149 #: ../src/guestfs-actions.pod:6659 ../fish/guestfish-actions.pod:4448
15150 msgid "This command is the same as running C<vgchange -a y|n>"
15154 #: ../src/guestfs-actions.pod:6665
15155 msgid "guestfs_vgcreate"
15159 #: ../src/guestfs-actions.pod:6667
15163 " guestfs_vgcreate (guestfs_h *g,\n"
15164 " const char *volgroup,\n"
15165 " char *const *physvols);\n"
15170 #: ../src/guestfs-actions.pod:6672 ../fish/guestfish-actions.pod:4454
15172 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15173 "of physical volumes C<physvols>."
15177 #: ../src/guestfs-actions.pod:6679
15178 msgid "guestfs_vglvuuids"
15182 #: ../src/guestfs-actions.pod:6681
15186 " guestfs_vglvuuids (guestfs_h *g,\n"
15187 " const char *vgname);\n"
15192 #: ../src/guestfs-actions.pod:6685 ../fish/guestfish-actions.pod:4461
15194 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15195 "volumes created in this volume group."
15199 #: ../src/guestfs-actions.pod:6688
15201 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15202 "associate logical volumes and volume groups."
15206 #: ../src/guestfs-actions.pod:6691
15207 msgid "See also C<guestfs_vgpvuuids>."
15211 #: ../src/guestfs-actions.pod:6699
15212 msgid "guestfs_vgpvuuids"
15216 #: ../src/guestfs-actions.pod:6701
15220 " guestfs_vgpvuuids (guestfs_h *g,\n"
15221 " const char *vgname);\n"
15226 #: ../src/guestfs-actions.pod:6705 ../fish/guestfish-actions.pod:4473
15228 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15229 "volumes that this volume group resides on."
15233 #: ../src/guestfs-actions.pod:6708
15235 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15236 "associate physical volumes and volume groups."
15240 #: ../src/guestfs-actions.pod:6711
15241 msgid "See also C<guestfs_vglvuuids>."
15245 #: ../src/guestfs-actions.pod:6719
15246 msgid "guestfs_vgremove"
15250 #: ../src/guestfs-actions.pod:6721
15254 " guestfs_vgremove (guestfs_h *g,\n"
15255 " const char *vgname);\n"
15260 #: ../src/guestfs-actions.pod:6725 ../fish/guestfish-actions.pod:4485
15261 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15265 #: ../src/guestfs-actions.pod:6727 ../fish/guestfish-actions.pod:4487
15266 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
15270 #: ../src/guestfs-actions.pod:6734
15271 msgid "guestfs_vgrename"
15275 #: ../src/guestfs-actions.pod:6736
15279 " guestfs_vgrename (guestfs_h *g,\n"
15280 " const char *volgroup,\n"
15281 " const char *newvolgroup);\n"
15286 #: ../src/guestfs-actions.pod:6741 ../fish/guestfish-actions.pod:4494
15287 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15291 #: ../src/guestfs-actions.pod:6747
15292 msgid "guestfs_vgs"
15296 #: ../src/guestfs-actions.pod:6749
15300 " guestfs_vgs (guestfs_h *g);\n"
15305 #: ../src/guestfs-actions.pod:6752 ../fish/guestfish-actions.pod:4500
15307 "List all the volumes groups detected. This is the equivalent of the "
15308 "L<vgs(8)> command."
15312 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4503
15314 "This returns a list of just the volume group names that were detected "
15315 "(eg. C<VolGroup00>)."
15319 #: ../src/guestfs-actions.pod:6758
15320 msgid "See also C<guestfs_vgs_full>."
15324 #: ../src/guestfs-actions.pod:6766
15325 msgid "guestfs_vgs_full"
15329 #: ../src/guestfs-actions.pod:6768
15332 " struct guestfs_lvm_vg_list *\n"
15333 " guestfs_vgs_full (guestfs_h *g);\n"
15338 #: ../src/guestfs-actions.pod:6771 ../fish/guestfish-actions.pod:4512
15340 "List all the volumes groups detected. This is the equivalent of the "
15341 "L<vgs(8)> command. The \"full\" version includes all fields."
15345 #: ../src/guestfs-actions.pod:6774
15347 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15348 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
15353 #: ../src/guestfs-actions.pod:6780
15354 msgid "guestfs_vgscan"
15358 #: ../src/guestfs-actions.pod:6782
15362 " guestfs_vgscan (guestfs_h *g);\n"
15367 #: ../src/guestfs-actions.pod:6785 ../fish/guestfish-actions.pod:4519
15369 "This rescans all block devices and rebuilds the list of LVM physical "
15370 "volumes, volume groups and logical volumes."
15374 #: ../src/guestfs-actions.pod:6792
15375 msgid "guestfs_vguuid"
15379 #: ../src/guestfs-actions.pod:6794
15383 " guestfs_vguuid (guestfs_h *g,\n"
15384 " const char *vgname);\n"
15389 #: ../src/guestfs-actions.pod:6798 ../fish/guestfish-actions.pod:4526
15390 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15394 #: ../src/guestfs-actions.pod:6805
15395 msgid "guestfs_wait_ready"
15399 #: ../src/guestfs-actions.pod:6807
15403 " guestfs_wait_ready (guestfs_h *g);\n"
15408 #: ../src/guestfs-actions.pod:6810
15409 msgid "This function is a no op."
15413 #: ../src/guestfs-actions.pod:6812
15415 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15416 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15417 "is no longer necessary because C<guestfs_launch> now does the waiting."
15421 #: ../src/guestfs-actions.pod:6817
15423 "If you see any calls to this function in code then you can just remove them, "
15424 "unless you want to retain compatibility with older versions of the API."
15428 #: ../src/guestfs-actions.pod:6825
15429 msgid "guestfs_wc_c"
15433 #: ../src/guestfs-actions.pod:6827
15437 " guestfs_wc_c (guestfs_h *g,\n"
15438 " const char *path);\n"
15443 #: ../src/guestfs-actions.pod:6831 ../fish/guestfish-actions.pod:4532
15445 "This command counts the characters in a file, using the C<wc -c> external "
15450 #: ../src/guestfs-actions.pod:6838
15451 msgid "guestfs_wc_l"
15455 #: ../src/guestfs-actions.pod:6840
15459 " guestfs_wc_l (guestfs_h *g,\n"
15460 " const char *path);\n"
15465 #: ../src/guestfs-actions.pod:6844 ../fish/guestfish-actions.pod:4539
15467 "This command counts the lines in a file, using the C<wc -l> external "
15472 #: ../src/guestfs-actions.pod:6851
15473 msgid "guestfs_wc_w"
15477 #: ../src/guestfs-actions.pod:6853
15481 " guestfs_wc_w (guestfs_h *g,\n"
15482 " const char *path);\n"
15487 #: ../src/guestfs-actions.pod:6857 ../fish/guestfish-actions.pod:4546
15489 "This command counts the words in a file, using the C<wc -w> external "
15494 #: ../src/guestfs-actions.pod:6864
15495 msgid "guestfs_write"
15499 #: ../src/guestfs-actions.pod:6866
15503 " guestfs_write (guestfs_h *g,\n"
15504 " const char *path,\n"
15505 " const char *content,\n"
15506 " size_t content_size);\n"
15511 #: ../src/guestfs-actions.pod:6872 ../fish/guestfish-actions.pod:4553
15513 "This call creates a file called C<path>. The content of the file is the "
15514 "string C<content> (which can contain any 8 bit data)."
15518 #: ../src/guestfs-actions.pod:6882
15519 msgid "guestfs_write_file"
15523 #: ../src/guestfs-actions.pod:6884
15527 " guestfs_write_file (guestfs_h *g,\n"
15528 " const char *path,\n"
15529 " const char *content,\n"
15535 #: ../src/guestfs-actions.pod:6890 ../fish/guestfish-actions.pod:4563
15537 "This call creates a file called C<path>. The contents of the file is the "
15538 "string C<content> (which can contain any 8 bit data), with length C<size>."
15542 #: ../src/guestfs-actions.pod:6894 ../fish/guestfish-actions.pod:4567
15544 "As a special case, if C<size> is C<0> then the length is calculated using "
15545 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15549 #: ../src/guestfs-actions.pod:6898 ../fish/guestfish-actions.pod:4571
15551 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15552 "I<not> work, even if the length is specified."
15556 #: ../src/guestfs-actions.pod:6906 ../fish/guestfish-actions.pod:4577
15557 msgid "This function is deprecated. In new code, use the C<write> call instead."
15561 #: ../src/guestfs-actions.pod:6915
15562 msgid "guestfs_zegrep"
15566 #: ../src/guestfs-actions.pod:6917
15570 " guestfs_zegrep (guestfs_h *g,\n"
15571 " const char *regex,\n"
15572 " const char *path);\n"
15577 #: ../src/guestfs-actions.pod:6922 ../fish/guestfish-actions.pod:4588
15578 msgid "This calls the external C<zegrep> program and returns the matching lines."
15582 #: ../src/guestfs-actions.pod:6934
15583 msgid "guestfs_zegrepi"
15587 #: ../src/guestfs-actions.pod:6936
15591 " guestfs_zegrepi (guestfs_h *g,\n"
15592 " const char *regex,\n"
15593 " const char *path);\n"
15598 #: ../src/guestfs-actions.pod:6941 ../fish/guestfish-actions.pod:4598
15599 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15603 #: ../src/guestfs-actions.pod:6953
15604 msgid "guestfs_zero"
15608 #: ../src/guestfs-actions.pod:6955
15612 " guestfs_zero (guestfs_h *g,\n"
15613 " const char *device);\n"
15618 #: ../src/guestfs-actions.pod:6959 ../fish/guestfish-actions.pod:4608
15619 msgid "This command writes zeroes over the first few blocks of C<device>."
15623 #: ../src/guestfs-actions.pod:6961 ../fish/guestfish-actions.pod:4610
15625 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15626 "securely wipe the device). It should be sufficient to remove any partition "
15627 "tables, filesystem superblocks and so on."
15631 #: ../src/guestfs-actions.pod:6965
15632 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15636 #: ../src/guestfs-actions.pod:6976
15637 msgid "guestfs_zero_device"
15641 #: ../src/guestfs-actions.pod:6978
15645 " guestfs_zero_device (guestfs_h *g,\n"
15646 " const char *device);\n"
15651 #: ../src/guestfs-actions.pod:6982
15653 "This command writes zeroes over the entire C<device>. Compare with "
15654 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15658 #: ../src/guestfs-actions.pod:6996
15659 msgid "(Added in 1.3.1)"
15663 #: ../src/guestfs-actions.pod:6998
15664 msgid "guestfs_zerofree"
15668 #: ../src/guestfs-actions.pod:7000
15672 " guestfs_zerofree (guestfs_h *g,\n"
15673 " const char *device);\n"
15678 #: ../src/guestfs-actions.pod:7004 ../fish/guestfish-actions.pod:4631
15680 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15681 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15682 "possible to compress the filesystem more effectively."
15686 #: ../src/guestfs-actions.pod:7009 ../fish/guestfish-actions.pod:4636
15687 msgid "You should B<not> run this program if the filesystem is mounted."
15691 #: ../src/guestfs-actions.pod:7012 ../fish/guestfish-actions.pod:4639
15693 "It is possible that using this program can damage the filesystem or data on "
15698 #: ../src/guestfs-actions.pod:7019
15699 msgid "guestfs_zfgrep"
15703 #: ../src/guestfs-actions.pod:7021
15707 " guestfs_zfgrep (guestfs_h *g,\n"
15708 " const char *pattern,\n"
15709 " const char *path);\n"
15714 #: ../src/guestfs-actions.pod:7026 ../fish/guestfish-actions.pod:4646
15715 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15719 #: ../src/guestfs-actions.pod:7038
15720 msgid "guestfs_zfgrepi"
15724 #: ../src/guestfs-actions.pod:7040
15728 " guestfs_zfgrepi (guestfs_h *g,\n"
15729 " const char *pattern,\n"
15730 " const char *path);\n"
15735 #: ../src/guestfs-actions.pod:7045 ../fish/guestfish-actions.pod:4656
15736 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15740 #: ../src/guestfs-actions.pod:7057
15741 msgid "guestfs_zfile"
15745 #: ../src/guestfs-actions.pod:7059
15749 " guestfs_zfile (guestfs_h *g,\n"
15750 " const char *meth,\n"
15751 " const char *path);\n"
15756 #: ../src/guestfs-actions.pod:7064 ../fish/guestfish-actions.pod:4666
15757 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15761 #: ../src/guestfs-actions.pod:7067 ../fish/guestfish-actions.pod:4669
15762 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15766 #: ../src/guestfs-actions.pod:7069
15768 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15773 #: ../src/guestfs-actions.pod:7075 ../fish/guestfish-actions.pod:4674
15774 msgid "This function is deprecated. In new code, use the C<file> call instead."
15778 #: ../src/guestfs-actions.pod:7084
15779 msgid "guestfs_zgrep"
15783 #: ../src/guestfs-actions.pod:7086
15787 " guestfs_zgrep (guestfs_h *g,\n"
15788 " const char *regex,\n"
15789 " const char *path);\n"
15794 #: ../src/guestfs-actions.pod:7091 ../fish/guestfish-actions.pod:4685
15795 msgid "This calls the external C<zgrep> program and returns the matching lines."
15799 #: ../src/guestfs-actions.pod:7103
15800 msgid "guestfs_zgrepi"
15804 #: ../src/guestfs-actions.pod:7105
15808 " guestfs_zgrepi (guestfs_h *g,\n"
15809 " const char *regex,\n"
15810 " const char *path);\n"
15815 #: ../src/guestfs-actions.pod:7110 ../fish/guestfish-actions.pod:4695
15816 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15820 #: ../src/guestfs-availability.pod:3
15825 #: ../src/guestfs-availability.pod:5
15827 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15828 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15829 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15830 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15831 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15835 #: ../src/guestfs-availability.pod:21
15840 #: ../src/guestfs-availability.pod:23
15842 "The following functions: L</guestfs_inotify_add_watch> "
15843 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15844 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15848 #: ../src/guestfs-availability.pod:31
15849 msgid "B<linuxfsuuid>"
15853 #: ../src/guestfs-availability.pod:33
15855 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15856 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15860 #: ../src/guestfs-availability.pod:40
15861 msgid "B<linuxmodules>"
15865 #: ../src/guestfs-availability.pod:42
15866 msgid "The following functions: L</guestfs_modprobe>"
15870 #: ../src/guestfs-availability.pod:45
15871 msgid "B<linuxxattrs>"
15875 #: ../src/guestfs-availability.pod:47
15877 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15878 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15879 "L</guestfs_removexattr> L</guestfs_setxattr>"
15883 #: ../src/guestfs-availability.pod:56
15888 #: ../src/guestfs-availability.pod:58
15890 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15891 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15892 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15896 #: ../src/guestfs-availability.pod:67
15901 #: ../src/guestfs-availability.pod:69
15903 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15904 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15905 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15906 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15907 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15908 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15909 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15910 "L</guestfs_vgs_full>"
15914 #: ../src/guestfs-availability.pod:92
15919 #: ../src/guestfs-availability.pod:94
15921 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15922 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15926 #: ../src/guestfs-availability.pod:100
15931 #: ../src/guestfs-availability.pod:102
15932 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15936 #: ../src/guestfs-availability.pod:105
15937 msgid "B<ntfsprogs>"
15941 #: ../src/guestfs-availability.pod:107
15942 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15946 #: ../src/guestfs-availability.pod:111
15947 msgid "B<realpath>"
15951 #: ../src/guestfs-availability.pod:113
15952 msgid "The following functions: L</guestfs_realpath>"
15956 #: ../src/guestfs-availability.pod:116
15961 #: ../src/guestfs-availability.pod:118
15963 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15964 "L</guestfs_scrub_freespace>"
15968 #: ../src/guestfs-availability.pod:123
15973 #: ../src/guestfs-availability.pod:125
15974 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15978 #: ../src/guestfs-availability.pod:129
15983 #: ../src/guestfs-availability.pod:131
15984 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15988 #: ../src/guestfs-availability.pod:135
15989 msgid "B<zerofree>"
15993 #: ../src/guestfs-availability.pod:137
15994 msgid "The following functions: L</guestfs_zerofree>"
15998 #: ../src/guestfs-structs.pod:1
15999 msgid "guestfs_int_bool"
16003 #: ../src/guestfs-structs.pod:3
16006 " struct guestfs_int_bool {\n"
16014 #: ../src/guestfs-structs.pod:8
16017 " struct guestfs_int_bool_list {\n"
16018 " uint32_t len; /* Number of elements in list. */\n"
16019 " struct guestfs_int_bool *val; /* Elements. */\n"
16025 #: ../src/guestfs-structs.pod:13
16028 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
16029 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
16034 #: ../src/guestfs-structs.pod:16
16035 msgid "guestfs_lvm_pv"
16039 #: ../src/guestfs-structs.pod:18
16042 " struct guestfs_lvm_pv {\n"
16043 " char *pv_name;\n"
16044 " /* The next field is NOT nul-terminated, be careful when printing it: "
16046 " char pv_uuid[32];\n"
16048 " uint64_t pv_size;\n"
16049 " uint64_t dev_size;\n"
16050 " uint64_t pv_free;\n"
16051 " uint64_t pv_used;\n"
16052 " char *pv_attr;\n"
16053 " int64_t pv_pe_count;\n"
16054 " int64_t pv_pe_alloc_count;\n"
16055 " char *pv_tags;\n"
16056 " uint64_t pe_start;\n"
16057 " int64_t pv_mda_count;\n"
16058 " uint64_t pv_mda_free;\n"
16064 #: ../src/guestfs-structs.pod:36
16067 " struct guestfs_lvm_pv_list {\n"
16068 " uint32_t len; /* Number of elements in list. */\n"
16069 " struct guestfs_lvm_pv *val; /* Elements. */\n"
16075 #: ../src/guestfs-structs.pod:41
16078 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
16079 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
16084 #: ../src/guestfs-structs.pod:44
16085 msgid "guestfs_lvm_vg"
16089 #: ../src/guestfs-structs.pod:46
16092 " struct guestfs_lvm_vg {\n"
16093 " char *vg_name;\n"
16094 " /* The next field is NOT nul-terminated, be careful when printing it: "
16096 " char vg_uuid[32];\n"
16098 " char *vg_attr;\n"
16099 " uint64_t vg_size;\n"
16100 " uint64_t vg_free;\n"
16101 " char *vg_sysid;\n"
16102 " uint64_t vg_extent_size;\n"
16103 " int64_t vg_extent_count;\n"
16104 " int64_t vg_free_count;\n"
16105 " int64_t max_lv;\n"
16106 " int64_t max_pv;\n"
16107 " int64_t pv_count;\n"
16108 " int64_t lv_count;\n"
16109 " int64_t snap_count;\n"
16110 " int64_t vg_seqno;\n"
16111 " char *vg_tags;\n"
16112 " int64_t vg_mda_count;\n"
16113 " uint64_t vg_mda_free;\n"
16119 #: ../src/guestfs-structs.pod:69
16122 " struct guestfs_lvm_vg_list {\n"
16123 " uint32_t len; /* Number of elements in list. */\n"
16124 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16130 #: ../src/guestfs-structs.pod:74
16133 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16134 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16139 #: ../src/guestfs-structs.pod:77
16140 msgid "guestfs_lvm_lv"
16144 #: ../src/guestfs-structs.pod:79
16147 " struct guestfs_lvm_lv {\n"
16148 " char *lv_name;\n"
16149 " /* The next field is NOT nul-terminated, be careful when printing it: "
16151 " char lv_uuid[32];\n"
16152 " char *lv_attr;\n"
16153 " int64_t lv_major;\n"
16154 " int64_t lv_minor;\n"
16155 " int64_t lv_kernel_major;\n"
16156 " int64_t lv_kernel_minor;\n"
16157 " uint64_t lv_size;\n"
16158 " int64_t seg_count;\n"
16160 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16161 " float snap_percent;\n"
16162 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16163 " float copy_percent;\n"
16164 " char *move_pv;\n"
16165 " char *lv_tags;\n"
16166 " char *mirror_log;\n"
16167 " char *modules;\n"
16173 #: ../src/guestfs-structs.pod:101
16176 " struct guestfs_lvm_lv_list {\n"
16177 " uint32_t len; /* Number of elements in list. */\n"
16178 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16184 #: ../src/guestfs-structs.pod:106
16187 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16188 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16193 #: ../src/guestfs-structs.pod:111
16196 " struct guestfs_stat {\n"
16200 " int64_t nlink;\n"
16205 " int64_t blksize;\n"
16206 " int64_t blocks;\n"
16207 " int64_t atime;\n"
16208 " int64_t mtime;\n"
16209 " int64_t ctime;\n"
16215 #: ../src/guestfs-structs.pod:127
16218 " struct guestfs_stat_list {\n"
16219 " uint32_t len; /* Number of elements in list. */\n"
16220 " struct guestfs_stat *val; /* Elements. */\n"
16226 #: ../src/guestfs-structs.pod:132
16229 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16230 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16235 #: ../src/guestfs-structs.pod:137
16238 " struct guestfs_statvfs {\n"
16239 " int64_t bsize;\n"
16240 " int64_t frsize;\n"
16241 " int64_t blocks;\n"
16242 " int64_t bfree;\n"
16243 " int64_t bavail;\n"
16244 " int64_t files;\n"
16245 " int64_t ffree;\n"
16246 " int64_t favail;\n"
16249 " int64_t namemax;\n"
16255 #: ../src/guestfs-structs.pod:151
16258 " struct guestfs_statvfs_list {\n"
16259 " uint32_t len; /* Number of elements in list. */\n"
16260 " struct guestfs_statvfs *val; /* Elements. */\n"
16266 #: ../src/guestfs-structs.pod:156
16269 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16270 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16275 #: ../src/guestfs-structs.pod:159
16276 msgid "guestfs_dirent"
16280 #: ../src/guestfs-structs.pod:161
16283 " struct guestfs_dirent {\n"
16292 #: ../src/guestfs-structs.pod:167
16295 " struct guestfs_dirent_list {\n"
16296 " uint32_t len; /* Number of elements in list. */\n"
16297 " struct guestfs_dirent *val; /* Elements. */\n"
16303 #: ../src/guestfs-structs.pod:172
16306 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16307 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16312 #: ../src/guestfs-structs.pod:177
16315 " struct guestfs_version {\n"
16316 " int64_t major;\n"
16317 " int64_t minor;\n"
16318 " int64_t release;\n"
16325 #: ../src/guestfs-structs.pod:184
16328 " struct guestfs_version_list {\n"
16329 " uint32_t len; /* Number of elements in list. */\n"
16330 " struct guestfs_version *val; /* Elements. */\n"
16336 #: ../src/guestfs-structs.pod:189
16339 " void guestfs_free_version (struct guestfs_free_version *);\n"
16340 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16345 #: ../src/guestfs-structs.pod:192
16346 msgid "guestfs_xattr"
16350 #: ../src/guestfs-structs.pod:194
16353 " struct guestfs_xattr {\n"
16354 " char *attrname;\n"
16355 " /* The next two fields describe a byte array. */\n"
16356 " uint32_t attrval_len;\n"
16357 " char *attrval;\n"
16363 #: ../src/guestfs-structs.pod:201
16366 " struct guestfs_xattr_list {\n"
16367 " uint32_t len; /* Number of elements in list. */\n"
16368 " struct guestfs_xattr *val; /* Elements. */\n"
16374 #: ../src/guestfs-structs.pod:206
16377 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16378 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16383 #: ../src/guestfs-structs.pod:209
16384 msgid "guestfs_inotify_event"
16388 #: ../src/guestfs-structs.pod:211
16391 " struct guestfs_inotify_event {\n"
16392 " int64_t in_wd;\n"
16393 " uint32_t in_mask;\n"
16394 " uint32_t in_cookie;\n"
16395 " char *in_name;\n"
16401 #: ../src/guestfs-structs.pod:218
16404 " struct guestfs_inotify_event_list {\n"
16405 " uint32_t len; /* Number of elements in list. */\n"
16406 " struct guestfs_inotify_event *val; /* Elements. */\n"
16412 #: ../src/guestfs-structs.pod:223
16415 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16416 " void guestfs_free_inotify_event_list (struct "
16417 "guestfs_free_inotify_event_list *);\n"
16422 #: ../src/guestfs-structs.pod:226
16423 msgid "guestfs_partition"
16427 #: ../src/guestfs-structs.pod:228
16430 " struct guestfs_partition {\n"
16431 " int32_t part_num;\n"
16432 " uint64_t part_start;\n"
16433 " uint64_t part_end;\n"
16434 " uint64_t part_size;\n"
16440 #: ../src/guestfs-structs.pod:235
16443 " struct guestfs_partition_list {\n"
16444 " uint32_t len; /* Number of elements in list. */\n"
16445 " struct guestfs_partition *val; /* Elements. */\n"
16451 #: ../src/guestfs-structs.pod:240
16454 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16455 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16460 #: ../src/guestfs-structs.pod:243
16461 msgid "guestfs_application"
16465 #: ../src/guestfs-structs.pod:245
16468 " struct guestfs_application {\n"
16469 " char *app_name;\n"
16470 " char *app_display_name;\n"
16471 " int32_t app_epoch;\n"
16472 " char *app_version;\n"
16473 " char *app_release;\n"
16474 " char *app_install_path;\n"
16475 " char *app_trans_path;\n"
16476 " char *app_publisher;\n"
16477 " char *app_url;\n"
16478 " char *app_source_package;\n"
16479 " char *app_summary;\n"
16480 " char *app_description;\n"
16486 #: ../src/guestfs-structs.pod:260
16489 " struct guestfs_application_list {\n"
16490 " uint32_t len; /* Number of elements in list. */\n"
16491 " struct guestfs_application *val; /* Elements. */\n"
16497 #: ../src/guestfs-structs.pod:265
16500 " void guestfs_free_application (struct guestfs_free_application *);\n"
16501 " void guestfs_free_application_list (struct guestfs_free_application_list "
16507 #: ../fish/guestfish.pod:5
16508 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16512 #: ../fish/guestfish.pod:9
16515 " guestfish [--options] [commands]\n"
16520 #: ../fish/guestfish.pod:11
16528 #: ../fish/guestfish.pod:13
16531 " guestfish [--ro|--rw] -a disk.img\n"
16536 #: ../fish/guestfish.pod:15
16539 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16544 #: ../fish/guestfish.pod:17
16547 " guestfish -d libvirt-domain\n"
16552 #: ../fish/guestfish.pod:19
16555 " guestfish [--ro|--rw] -a disk.img -i\n"
16560 #: ../fish/guestfish.pod:21
16563 " guestfish -d libvirt-domain -i\n"
16568 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16573 #: ../fish/guestfish.pod:25
16575 "Using guestfish in read/write mode on live virtual machines can be "
16576 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16577 "option to use guestfish safely if the disk image or virtual machine might be "
16582 #: ../fish/guestfish.pod:32
16584 "Guestfish is a shell and command-line tool for examining and modifying "
16585 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16586 "functionality of the guestfs API, see L<guestfs(3)>."
16590 #: ../fish/guestfish.pod:36
16592 "Guestfish gives you structured access to the libguestfs API, from shell "
16593 "scripts or the command line or interactively. If you want to rescue a "
16594 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16599 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:897 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16604 #: ../fish/guestfish.pod:43
16605 msgid "As an interactive shell"
16609 #: ../fish/guestfish.pod:45
16617 #: ../fish/guestfish.pod:47
16620 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16621 " editing virtual machine filesystems.\n"
16626 #: ../fish/guestfish.pod:50
16629 " Type: 'help' for a list of commands\n"
16630 " 'man' to read the manual\n"
16631 " 'quit' to quit the shell\n"
16636 #: ../fish/guestfish.pod:54
16639 " ><fs> add-ro disk.img\n"
16641 " ><fs> list-filesystems\n"
16642 " /dev/sda1: ext4\n"
16643 " /dev/vg_guest/lv_root: ext4\n"
16644 " /dev/vg_guest/lv_swap: swap\n"
16645 " ><fs> mount /dev/vg_guest/lv_root /\n"
16646 " ><fs> cat /etc/fstab\n"
16648 " # Created by anaconda\n"
16655 #: ../fish/guestfish.pod:67
16656 msgid "From shell scripts"
16660 #: ../fish/guestfish.pod:69
16661 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16665 #: ../fish/guestfish.pod:71
16668 " guestfish <<_EOF_\n"
16671 " mount /dev/vg_guest/lv_root /\n"
16672 " write /etc/motd \"Welcome, new users\"\n"
16678 #: ../fish/guestfish.pod:78
16679 msgid "List the LVM logical volumes in a disk image:"
16683 #: ../fish/guestfish.pod:80
16686 " guestfish -a disk.img --ro <<_EOF_\n"
16694 #: ../fish/guestfish.pod:85
16695 msgid "List all the filesystems in a disk image:"
16699 #: ../fish/guestfish.pod:87
16702 " guestfish -a disk.img --ro <<_EOF_\n"
16704 " list-filesystems\n"
16710 #: ../fish/guestfish.pod:92
16711 msgid "On one command line"
16715 #: ../fish/guestfish.pod:94
16716 msgid "Update C</etc/resolv.conf> in a guest:"
16720 #: ../fish/guestfish.pod:96
16724 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16725 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16730 #: ../fish/guestfish.pod:100
16731 msgid "Edit C</boot/grub/grub.conf> interactively:"
16735 #: ../fish/guestfish.pod:102
16738 " guestfish --rw --add disk.img \\\n"
16739 " --mount /dev/vg_guest/lv_root \\\n"
16740 " --mount /dev/sda1:/boot \\\n"
16741 " edit /boot/grub/grub.conf\n"
16746 #: ../fish/guestfish.pod:107
16747 msgid "Mount disks automatically"
16751 #: ../fish/guestfish.pod:109
16753 "Use the I<-i> option to automatically mount the disks from a virtual "
16758 #: ../fish/guestfish.pod:112
16761 " guestfish --ro -a disk.img -i cat /etc/group\n"
16766 #: ../fish/guestfish.pod:114
16769 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16774 #: ../fish/guestfish.pod:116
16775 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16779 #: ../fish/guestfish.pod:118
16782 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16787 #: ../fish/guestfish.pod:120
16788 msgid "As a script interpreter"
16792 #: ../fish/guestfish.pod:122
16793 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16797 #: ../fish/guestfish.pod:124
16800 " #!/usr/bin/guestfish -f\n"
16801 " sparse test1.img 100M\n"
16803 " part-disk /dev/sda mbr\n"
16804 " mkfs ext2 /dev/sda1\n"
16809 #: ../fish/guestfish.pod:130
16810 msgid "Start with a prepared disk"
16814 #: ../fish/guestfish.pod:132
16816 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16817 "single ext2-formatted partition:"
16821 #: ../fish/guestfish.pod:135
16824 " guestfish -N fs\n"
16829 #: ../fish/guestfish.pod:137
16830 msgid "To list what is available do:"
16834 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:888
16837 " guestfish -N help | less\n"
16842 #: ../fish/guestfish.pod:141
16843 msgid "Remote control"
16847 #: ../fish/guestfish.pod:143
16850 " eval \"`guestfish --listen`\"\n"
16851 " guestfish --remote add-ro disk.img\n"
16852 " guestfish --remote run\n"
16853 " guestfish --remote lvs\n"
16858 #: ../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:96 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
16863 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:104 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
16868 #: ../fish/guestfish.pod:154
16869 msgid "Displays general help on options."
16873 #: ../fish/guestfish.pod:156
16878 #: ../fish/guestfish.pod:158
16879 msgid "B<--cmd-help>"
16883 #: ../fish/guestfish.pod:160
16884 msgid "Lists all available guestfish commands."
16888 #: ../fish/guestfish.pod:162
16893 #: ../fish/guestfish.pod:164
16894 msgid "B<--cmd-help cmd>"
16898 #: ../fish/guestfish.pod:166
16899 msgid "Displays detailed help on a single command C<cmd>."
16903 #: ../fish/guestfish.pod:168
16904 msgid "B<-a image>"
16908 #: ../fish/guestfish.pod:170
16909 msgid "B<--add image>"
16913 #: ../fish/guestfish.pod:172
16914 msgid "Add a block device or virtual machine image to the shell."
16918 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:81
16920 "The format of the disk image is auto-detected. To override this and force a "
16921 "particular format use the I<--format=..> option."
16925 #: ../fish/guestfish.pod:177
16927 "Using this flag is mostly equivalent to using the C<add> command, with "
16928 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16929 "the I<--format:...> flag was given."
16933 #: ../fish/guestfish.pod:181
16938 #: ../fish/guestfish.pod:183
16939 msgid "B<--connect URI>"
16943 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:86
16945 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16946 "URI to use. The default is to use the default libvirt connection."
16950 #: ../fish/guestfish.pod:189
16955 #: ../fish/guestfish.pod:191
16957 "If using the I<--listen> option and a csh-like shell, use this option. See "
16958 "section L</REMOTE CONTROL AND CSH> below."
16962 #: ../fish/guestfish.pod:194
16963 msgid "B<-d libvirt-domain>"
16967 #: ../fish/guestfish.pod:196
16968 msgid "B<--domain libvirt-domain>"
16972 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:92
16974 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16975 "used, then any libvirt domain can be used. However in write mode, only "
16976 "libvirt domains which are shut down can be named here."
16980 #: ../fish/guestfish.pod:202
16982 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16983 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16984 "if the I<--format:...> flag was given."
16988 #: ../fish/guestfish.pod:206
16993 #: ../fish/guestfish.pod:208
16994 msgid "B<--no-dest-paths>"
16998 #: ../fish/guestfish.pod:210
17000 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
17001 "to hit the tab key to complete paths on the guest filesystem, but this "
17002 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
17003 "allow this feature to be disabled."
17007 #: ../fish/guestfish.pod:215 ../fuse/guestmount.pod:108
17008 msgid "B<--echo-keys>"
17012 #: ../fish/guestfish.pod:217 ../fuse/guestmount.pod:110
17014 "When prompting for keys and passphrases, guestfish normally turns echoing "
17015 "off so you cannot see what you are typing. If you are not worried about "
17016 "Tempest attacks and there is no one else in the room you can specify this "
17017 "flag to see what you are typing."
17021 #: ../fish/guestfish.pod:222
17026 #: ../fish/guestfish.pod:224
17027 msgid "B<--file file>"
17031 #: ../fish/guestfish.pod:226
17032 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
17036 #: ../fish/guestfish.pod:229
17039 " #!/usr/bin/guestfish -f\n"
17044 #: ../fish/guestfish.pod:231
17045 msgid "B<--format=raw|qcow2|..>"
17049 #: ../fish/guestfish.pod:233
17050 msgid "B<--format>"
17054 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:117
17056 "The default for the I<-a> option is to auto-detect the format of the disk "
17057 "image. Using this forces the disk format for I<-a> options which follow on "
17058 "the command line. Using I<--format> with no argument switches back to "
17059 "auto-detection for subsequent I<-a> options."
17063 #: ../fish/guestfish.pod:240 ../fish/guestfish.pod:594
17064 msgid "For example:"
17068 #: ../fish/guestfish.pod:242
17071 " guestfish --format=raw -a disk.img\n"
17076 #: ../fish/guestfish.pod:244
17077 msgid "forces raw format (no auto-detection) for C<disk.img>."
17081 #: ../fish/guestfish.pod:246
17084 " guestfish --format=raw -a disk.img --format -a another.img\n"
17089 #: ../fish/guestfish.pod:248
17091 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
17092 "auto-detection for C<another.img>."
17096 #: ../fish/guestfish.pod:251
17098 "If you have untrusted raw-format guest disk images, you should use this "
17099 "option to specify the disk format. This avoids a possible security problem "
17100 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
17104 #: ../fish/guestfish.pod:256
17109 #: ../fish/guestfish.pod:258
17110 msgid "B<--inspector>"
17114 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:137
17116 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
17117 "system and mount filesystems as they would be mounted on the real virtual "
17122 #: ../fish/guestfish.pod:264
17123 msgid "Typical usage is either:"
17127 #: ../fish/guestfish.pod:266
17130 " guestfish -d myguest -i\n"
17135 #: ../fish/guestfish.pod:268
17136 msgid "(for an inactive libvirt domain called I<myguest>), or:"
17140 #: ../fish/guestfish.pod:270
17143 " guestfish --ro -d myguest -i\n"
17148 #: ../fish/guestfish.pod:272
17149 msgid "(for active domains, readonly), or specify the block device directly:"
17153 #: ../fish/guestfish.pod:274
17156 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
17161 #: ../fish/guestfish.pod:276
17163 "Note that the command line syntax changed slightly over older versions of "
17164 "guestfish. You can still use the old syntax:"
17168 #: ../fish/guestfish.pod:279
17171 " guestfish [--ro] -i disk.img\n"
17176 #: ../fish/guestfish.pod:281
17179 " guestfish [--ro] -i libvirt-domain\n"
17184 #: ../fish/guestfish.pod:283
17186 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
17187 "then using other commands to mount the filesystems that were found."
17191 #: ../fish/guestfish.pod:287 ../fuse/guestmount.pod:141
17192 msgid "B<--keys-from-stdin>"
17196 #: ../fish/guestfish.pod:289 ../fuse/guestmount.pod:143
17198 "Read key or passphrase parameters from stdin. The default is to try to read "
17199 "passphrases from the user by opening C</dev/tty>."
17203 #: ../fish/guestfish.pod:292
17204 msgid "B<--listen>"
17208 #: ../fish/guestfish.pod:294
17210 "Fork into the background and listen for remote commands. See section "
17211 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17215 #: ../fish/guestfish.pod:297
17216 msgid "B<-m dev[:mountpoint]>"
17220 #: ../fish/guestfish.pod:299
17221 msgid "B<--mount dev[:mountpoint]>"
17225 #: ../fish/guestfish.pod:301
17226 msgid "Mount the named partition or logical volume on the given mountpoint."
17230 #: ../fish/guestfish.pod:303
17231 msgid "If the mountpoint is omitted, it defaults to C</>."
17235 #: ../fish/guestfish.pod:305
17236 msgid "You have to mount something on C</> before most commands will work."
17240 #: ../fish/guestfish.pod:307
17242 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17247 #: ../fish/guestfish.pod:310
17249 "If you don't know what filesystems a disk image contains, you can either run "
17250 "guestfish without this option, then list the partitions, filesystems and LVs "
17251 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17252 "commands), or you can use the L<virt-filesystems(1)> program."
17256 #: ../fish/guestfish.pod:316
17258 "Using this flag is mostly equivalent to using the C<mount-options> command "
17259 "or the C<mount-ro> command if the I<--ro> flag was given."
17263 #: ../fish/guestfish.pod:319
17268 #: ../fish/guestfish.pod:321
17269 msgid "B<--no-sync>"
17273 #: ../fish/guestfish.pod:323
17275 "Disable autosync. This is enabled by default. See the discussion of "
17276 "autosync in the L<guestfs(3)> manpage."
17280 #: ../fish/guestfish.pod:326
17285 #: ../fish/guestfish.pod:328
17286 msgid "B<--new type>"
17290 #: ../fish/guestfish.pod:330
17295 #: ../fish/guestfish.pod:332
17297 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17298 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17299 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17304 #: ../fish/guestfish.pod:337
17305 msgid "B<--progress-bars>"
17309 #: ../fish/guestfish.pod:339
17310 msgid "Enable progress bars, even when guestfish is used non-interactively."
17314 #: ../fish/guestfish.pod:341
17316 "Progress bars are enabled by default when guestfish is used as an "
17317 "interactive shell."
17321 #: ../fish/guestfish.pod:344
17322 msgid "B<--no-progress-bars>"
17326 #: ../fish/guestfish.pod:346
17327 msgid "Disable progress bars."
17331 #: ../fish/guestfish.pod:348
17332 msgid "B<--remote[=pid]>"
17336 #: ../fish/guestfish.pod:350
17338 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17339 "CONTROL GUESTFISH OVER A SOCKET> below."
17343 #: ../fish/guestfish.pod:353
17348 #: ../fish/guestfish.pod:355
17353 #: ../fish/guestfish.pod:357
17355 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
17356 "mounts are done read-only."
17360 #: ../fish/guestfish.pod:360
17362 "The option must always be used if the disk image or virtual machine might be "
17363 "running, and is generally recommended in cases where you don't need write "
17364 "access to the disk."
17368 #: ../fish/guestfish.pod:364
17370 "Note that prepared disk images created with I<-N> are not affected by this "
17371 "option. Also commands like C<add> are not affected - you have to specify "
17372 "the C<readonly:true> option explicitly if you need it."
17376 #: ../fish/guestfish.pod:368
17377 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17381 #: ../fish/guestfish.pod:370 ../fuse/guestmount.pod:208
17382 msgid "B<--selinux>"
17386 #: ../fish/guestfish.pod:372
17387 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17391 #: ../fish/guestfish.pod:374
17396 #: ../fish/guestfish.pod:376
17397 msgid "B<--verbose>"
17401 #: ../fish/guestfish.pod:378
17403 "Enable very verbose messages. This is particularly useful if you find a "
17408 #: ../fish/guestfish.pod:381
17413 #: ../fish/guestfish.pod:383 ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:112 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
17414 msgid "B<--version>"
17418 #: ../fish/guestfish.pod:385
17419 msgid "Display the guestfish / libguestfs version number and exit."
17423 #: ../fish/guestfish.pod:387
17428 #: ../fish/guestfish.pod:389
17433 #: ../fish/guestfish.pod:391
17435 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17440 #: ../fish/guestfish.pod:394
17445 #: ../fish/guestfish.pod:396
17446 msgid "Echo each command before executing it."
17450 #: ../fish/guestfish.pod:400
17451 msgid "COMMANDS ON COMMAND LINE"
17455 #: ../fish/guestfish.pod:402
17456 msgid "Any additional (non-option) arguments are treated as commands to execute."
17460 #: ../fish/guestfish.pod:405
17462 "Commands to execute should be separated by a colon (C<:>), where the colon "
17463 "is a separate parameter. Thus:"
17467 #: ../fish/guestfish.pod:408
17470 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17475 #: ../fish/guestfish.pod:410
17477 "If there are no additional arguments, then we enter a shell, either an "
17478 "interactive shell with a prompt (if the input is a terminal) or a "
17479 "non-interactive shell."
17483 #: ../fish/guestfish.pod:414
17485 "In either command line mode or non-interactive shell, the first command that "
17486 "gives an error causes the whole shell to exit. In interactive mode (with a "
17487 "prompt) if a command fails, you can continue to enter commands."
17491 #: ../fish/guestfish.pod:419
17492 msgid "USING launch (OR run)"
17496 #: ../fish/guestfish.pod:421
17498 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17499 "then launch it, then mount any disks you need, and finally issue "
17500 "actions/commands. So the general order of the day is:"
17504 #: ../fish/guestfish.pod:429
17505 msgid "add or -a/--add"
17509 #: ../fish/guestfish.pod:433
17510 msgid "launch (aka run)"
17514 #: ../fish/guestfish.pod:437
17515 msgid "mount or -m/--mount"
17519 #: ../fish/guestfish.pod:441
17520 msgid "any other commands"
17524 #: ../fish/guestfish.pod:445
17526 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17527 "guest before mounting or performing any other commands."
17531 #: ../fish/guestfish.pod:448
17533 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17534 "I<--new> options were given then C<run> is done automatically, simply "
17535 "because guestfish can't perform the action you asked for without doing this."
17539 #: ../fish/guestfish.pod:453
17540 msgid "OPENING DISKS FOR READ AND WRITE"
17544 #: ../fish/guestfish.pod:455
17546 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17547 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17548 "open disk images read-only or for writing."
17552 #: ../fish/guestfish.pod:459
17554 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17555 "disk images supplied on the command line for write. To open a disk image "
17556 "read-only you have to do I<-a image --ro>."
17560 #: ../fish/guestfish.pod:463
17562 "This matters: If you accidentally open a live VM disk image writable then "
17563 "you will cause irreversible disk corruption."
17567 #: ../fish/guestfish.pod:466
17569 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17570 "images will be opened read-only. You will have to either specify "
17571 "I<guestfish --rw> or change a configuration file in order to get write "
17572 "access for disk images specified by those other command line options."
17576 #: ../fish/guestfish.pod:471
17578 "This version of guestfish has a I<--rw> option which does nothing (it is "
17579 "already the default). However it is highly recommended that you use this "
17580 "option to indicate that guestfish needs write access, and to prepare your "
17581 "scripts for the day when this option will be required for write access."
17585 #: ../fish/guestfish.pod:477
17587 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17588 "other libguestfs program apart from guestfish and guestmount."
17592 #: ../fish/guestfish.pod:480
17597 #: ../fish/guestfish.pod:482
17599 "You can quote ordinary parameters using either single or double quotes. For "
17604 #: ../fish/guestfish.pod:485
17607 " add \"file with a space.img\"\n"
17612 #: ../fish/guestfish.pod:487
17615 " rm '/file name'\n"
17620 #: ../fish/guestfish.pod:489
17628 #: ../fish/guestfish.pod:491
17630 "A few commands require a list of strings to be passed. For these, use a "
17631 "whitespace-separated list, enclosed in quotes. Strings containing "
17632 "whitespace to be passed through must be enclosed in single quotes. A "
17633 "literal single quote must be escaped with a backslash."
17637 #: ../fish/guestfish.pod:496
17640 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17641 " command \"/bin/echo 'foo bar'\"\n"
17642 " command \"/bin/echo \\'foo\\'\"\n"
17647 #: ../fish/guestfish.pod:500
17648 msgid "OPTIONAL ARGUMENTS"
17652 #: ../fish/guestfish.pod:502
17654 "Some commands take optional arguments. These arguments appear in this "
17655 "documentation as C<[argname:..]>. You can use them as in these examples:"
17659 #: ../fish/guestfish.pod:506
17662 " add-drive-opts filename\n"
17667 #: ../fish/guestfish.pod:508
17670 " add-drive-opts filename readonly:true\n"
17675 #: ../fish/guestfish.pod:510
17678 " add-drive-opts filename format:qcow2 readonly:false\n"
17683 #: ../fish/guestfish.pod:512
17685 "Each optional argument can appear at most once. All optional arguments must "
17686 "appear after the required ones."
17690 #: ../fish/guestfish.pod:515
17695 #: ../fish/guestfish.pod:517
17696 msgid "This section applies to all commands which can take integers as parameters."
17700 #: ../fish/guestfish.pod:520
17701 msgid "SIZE SUFFIX"
17705 #: ../fish/guestfish.pod:522
17707 "When the command takes a parameter measured in bytes, you can use one of the "
17708 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17712 #: ../fish/guestfish.pod:528
17713 msgid "B<k> or B<K> or B<KiB>"
17717 #: ../fish/guestfish.pod:530
17718 msgid "The size in kilobytes (multiplied by 1024)."
17722 #: ../fish/guestfish.pod:532
17727 #: ../fish/guestfish.pod:534
17728 msgid "The size in SI 1000 byte units."
17732 #: ../fish/guestfish.pod:536
17733 msgid "B<M> or B<MiB>"
17737 #: ../fish/guestfish.pod:538
17738 msgid "The size in megabytes (multiplied by 1048576)."
17742 #: ../fish/guestfish.pod:540
17747 #: ../fish/guestfish.pod:542
17748 msgid "The size in SI 1000000 byte units."
17752 #: ../fish/guestfish.pod:544
17753 msgid "B<G> or B<GiB>"
17757 #: ../fish/guestfish.pod:546
17758 msgid "The size in gigabytes (multiplied by 2**30)."
17762 #: ../fish/guestfish.pod:548
17767 #: ../fish/guestfish.pod:550
17768 msgid "The size in SI 10**9 byte units."
17772 #: ../fish/guestfish.pod:552
17773 msgid "B<T> or B<TiB>"
17777 #: ../fish/guestfish.pod:554
17778 msgid "The size in terabytes (multiplied by 2**40)."
17782 #: ../fish/guestfish.pod:556
17787 #: ../fish/guestfish.pod:558
17788 msgid "The size in SI 10**12 byte units."
17792 #: ../fish/guestfish.pod:560
17793 msgid "B<P> or B<PiB>"
17797 #: ../fish/guestfish.pod:562
17798 msgid "The size in petabytes (multiplied by 2**50)."
17802 #: ../fish/guestfish.pod:564
17807 #: ../fish/guestfish.pod:566
17808 msgid "The size in SI 10**15 byte units."
17812 #: ../fish/guestfish.pod:568
17813 msgid "B<E> or B<EiB>"
17817 #: ../fish/guestfish.pod:570
17818 msgid "The size in exabytes (multiplied by 2**60)."
17822 #: ../fish/guestfish.pod:572
17827 #: ../fish/guestfish.pod:574
17828 msgid "The size in SI 10**18 byte units."
17832 #: ../fish/guestfish.pod:576
17833 msgid "B<Z> or B<ZiB>"
17837 #: ../fish/guestfish.pod:578
17838 msgid "The size in zettabytes (multiplied by 2**70)."
17842 #: ../fish/guestfish.pod:580
17847 #: ../fish/guestfish.pod:582
17848 msgid "The size in SI 10**21 byte units."
17852 #: ../fish/guestfish.pod:584
17853 msgid "B<Y> or B<YiB>"
17857 #: ../fish/guestfish.pod:586
17858 msgid "The size in yottabytes (multiplied by 2**80)."
17862 #: ../fish/guestfish.pod:588
17867 #: ../fish/guestfish.pod:590
17868 msgid "The size in SI 10**24 byte units."
17872 #: ../fish/guestfish.pod:596
17875 " truncate-size /file 1G\n"
17880 #: ../fish/guestfish.pod:598
17881 msgid "would truncate the file to 1 gigabyte."
17885 #: ../fish/guestfish.pod:600
17887 "Be careful because a few commands take sizes in kilobytes or megabytes "
17888 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17889 "Adding a suffix will probably not do what you expect."
17893 #: ../fish/guestfish.pod:604
17894 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17898 #: ../fish/guestfish.pod:606
17900 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17901 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17905 #: ../fish/guestfish.pod:609
17908 " 1234 decimal number 1234\n"
17909 " 02322 octal number, equivalent to decimal 1234\n"
17910 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17915 #: ../fish/guestfish.pod:613
17917 "When using the C<chmod> command, you almost always want to specify an octal "
17918 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17919 "L<chmod(1)> program):"
17923 #: ../fish/guestfish.pod:617
17926 " chmod 0777 /public # OK\n"
17927 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17932 #: ../fish/guestfish.pod:620
17934 "Commands that return numbers usually print them in decimal, but some "
17935 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17936 "octal, preceeded by C<0>)."
17940 #: ../fish/guestfish.pod:624
17941 msgid "WILDCARDS AND GLOBBING"
17945 #: ../fish/guestfish.pod:626
17947 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17948 "(globbing) by default. So for example the following will not do what you "
17953 #: ../fish/guestfish.pod:630
17961 #: ../fish/guestfish.pod:632
17963 "Assuming you don't have a directory called literally C</home/*> then the "
17964 "above command will return an error."
17968 #: ../fish/guestfish.pod:635
17969 msgid "To perform wildcard expansion, use the C<glob> command."
17973 #: ../fish/guestfish.pod:637
17976 " glob rm-rf /home/*\n"
17981 #: ../fish/guestfish.pod:639
17983 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17984 "many times), equivalent to:"
17988 #: ../fish/guestfish.pod:642
17991 " rm-rf /home/jim\n"
17992 " rm-rf /home/joe\n"
17993 " rm-rf /home/mary\n"
17998 #: ../fish/guestfish.pod:646
17999 msgid "C<glob> only works on simple guest paths and not on device names."
18003 #: ../fish/guestfish.pod:648
18005 "If you have several parameters, each containing a wildcard, then glob will "
18006 "perform a Cartesian product."
18010 #: ../fish/guestfish.pod:651
18015 #: ../fish/guestfish.pod:653
18017 "Any line which starts with a I<#> character is treated as a comment and "
18018 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
18019 "a command. For example:"
18023 #: ../fish/guestfish.pod:657
18026 " # this is a comment\n"
18027 " # this is a comment\n"
18028 " foo # NOT a comment\n"
18033 #: ../fish/guestfish.pod:661
18034 msgid "Blank lines are also ignored."
18038 #: ../fish/guestfish.pod:663
18039 msgid "RUNNING COMMANDS LOCALLY"
18043 #: ../fish/guestfish.pod:665
18045 "Any line which starts with a I<!> character is treated as a command sent to "
18046 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
18050 #: ../fish/guestfish.pod:669
18054 " tgz-out /remote local/remote-data.tar.gz\n"
18059 #: ../fish/guestfish.pod:672
18061 "will create a directory C<local> on the host, and then export the contents "
18062 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
18063 "(See C<tgz-out>)."
18067 #: ../fish/guestfish.pod:676
18069 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
18070 "effect, due to the way that subprocesses work in Unix."
18074 #: ../fish/guestfish.pod:679
18079 #: ../fish/guestfish.pod:681
18081 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
18082 "command (a guestfish command) to the second command (any host command). For "
18087 #: ../fish/guestfish.pod:685
18090 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
18095 #: ../fish/guestfish.pod:687
18097 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
18098 "program). The above command would list all accounts in the guest filesystem "
18099 "which have UID 0, ie. root accounts including backdoors. Other examples:"
18103 #: ../fish/guestfish.pod:692
18106 " hexdump /bin/ls | head\n"
18107 " list-devices | tail -1\n"
18108 " tgz-out / - | tar ztf -\n"
18113 #: ../fish/guestfish.pod:696
18115 "The space before the pipe symbol is required, any space after the pipe "
18116 "symbol is optional. Everything after the pipe symbol is just passed "
18117 "straight to the host shell, so it can contain redirections, globs and "
18118 "anything else that makes sense on the host side."
18122 #: ../fish/guestfish.pod:701
18124 "To use a literal argument which begins with a pipe symbol, you have to quote "
18129 #: ../fish/guestfish.pod:704
18137 #: ../fish/guestfish.pod:706
18138 msgid "HOME DIRECTORIES"
18142 #: ../fish/guestfish.pod:708
18144 "If a parameter starts with the character C<~> then the tilde may be expanded "
18145 "as a home directory path (either C<~> for the current user's home directory, "
18146 "or C<~user> for another user)."
18150 #: ../fish/guestfish.pod:712
18152 "Note that home directory expansion happens for users known I<on the host>, "
18153 "not in the guest filesystem."
18157 #: ../fish/guestfish.pod:715
18159 "To use a literal argument which begins with a tilde, you have to quote it, "
18164 #: ../fish/guestfish.pod:718
18172 #: ../fish/guestfish.pod:722
18174 "Libguestfs has some support for Linux guests encrypted according to the "
18175 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
18176 "disk encryption systems used by modern Linux guests. Currently only "
18177 "LVM-on-LUKS is supported."
18181 #: ../fish/guestfish.pod:727
18182 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
18186 #: ../fish/guestfish.pod:729
18189 " ><fs> vfs-type /dev/sda2\n"
18195 #: ../fish/guestfish.pod:732
18197 "Then open those devices using L</luks-open>. This creates a device-mapper "
18198 "device called C</dev/mapper/luksdev>."
18202 #: ../fish/guestfish.pod:735
18205 " ><fs> luks-open /dev/sda2 luksdev\n"
18206 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
18211 #: ../fish/guestfish.pod:738
18213 "Finally you have to tell LVM to scan for volume groups on the newly created "
18218 #: ../fish/guestfish.pod:741
18222 " vg-activate-all true\n"
18227 #: ../fish/guestfish.pod:744
18228 msgid "The logical volume(s) can now be mounted in the usual way."
18232 #: ../fish/guestfish.pod:746
18234 "Before closing a LUKS device you must unmount any logical volumes on it and "
18235 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18236 "one. Then you can close the mapper device:"
18240 #: ../fish/guestfish.pod:750
18243 " vg-activate false /dev/VG\n"
18244 " luks-close /dev/mapper/luksdev\n"
18249 #: ../fish/guestfish.pod:753
18250 msgid "WINDOWS PATHS"
18254 #: ../fish/guestfish.pod:755
18256 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18257 "(with some limitations). The following commands are equivalent:"
18261 #: ../fish/guestfish.pod:758
18264 " file /WINDOWS/system32/config/system.LOG\n"
18269 #: ../fish/guestfish.pod:760
18272 " file win:/windows/system32/config/system.log\n"
18277 #: ../fish/guestfish.pod:762
18280 " file win:\\windows\\system32\\config\\system.log\n"
18285 #: ../fish/guestfish.pod:764
18288 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18293 #: ../fish/guestfish.pod:766
18295 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18296 "handles case insensitivity like Windows would. This only works in argument "
18297 "positions that expect a path."
18301 #: ../fish/guestfish.pod:770
18302 msgid "UPLOADING AND DOWNLOADING FILES"
18306 #: ../fish/guestfish.pod:772
18308 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18309 "others which upload from or download to a local file, you can use the "
18310 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18314 #: ../fish/guestfish.pod:776
18322 #: ../fish/guestfish.pod:778
18323 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
18327 #: ../fish/guestfish.pod:781
18330 " tar-out /etc - | tar tf -\n"
18335 #: ../fish/guestfish.pod:783
18337 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18338 "command (see L</PIPES>)."
18342 #: ../fish/guestfish.pod:786
18344 "When using C<-> to read from stdin, the input is read up to the end of "
18345 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18346 "some arbitrary end marker:"
18350 #: ../fish/guestfish.pod:790
18353 " upload -<<END /foo\n"
18362 #: ../fish/guestfish.pod:796
18364 "Any string of characters can be used instead of C<END>. The end marker must "
18365 "appear on a line of its own, without any preceeding or following characters "
18366 "(not even spaces)."
18370 #: ../fish/guestfish.pod:800
18372 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18373 "upload local files (so-called \"FileIn\" parameters in the generator)."
18377 #: ../fish/guestfish.pod:803
18378 msgid "EXIT ON ERROR BEHAVIOUR"
18382 #: ../fish/guestfish.pod:805
18384 "By default, guestfish will ignore any errors when in interactive mode "
18385 "(ie. taking commands from a human over a tty), and will exit on the first "
18386 "error in non-interactive mode (scripts, commands given on the command line)."
18390 #: ../fish/guestfish.pod:810
18392 "If you prefix a command with a I<-> character, then that command will not "
18393 "cause guestfish to exit, even if that (one) command returns an error."
18397 #: ../fish/guestfish.pod:814
18398 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18402 #: ../fish/guestfish.pod:816
18404 "Guestfish can be remote-controlled over a socket. This is useful "
18405 "particularly in shell scripts where you want to make several different "
18406 "changes to a filesystem, but you don't want the overhead of starting up a "
18407 "guestfish process each time."
18411 #: ../fish/guestfish.pod:821
18412 msgid "Start a guestfish server process using:"
18416 #: ../fish/guestfish.pod:823
18419 " eval \"`guestfish --listen`\"\n"
18424 #: ../fish/guestfish.pod:825
18425 msgid "and then send it commands by doing:"
18429 #: ../fish/guestfish.pod:827
18432 " guestfish --remote cmd [...]\n"
18437 #: ../fish/guestfish.pod:829
18438 msgid "To cause the server to exit, send it the exit command:"
18442 #: ../fish/guestfish.pod:831
18445 " guestfish --remote exit\n"
18450 #: ../fish/guestfish.pod:833
18452 "Note that the server will normally exit if there is an error in a command. "
18453 "You can change this in the usual way. See section L</EXIT ON ERROR "
18458 #: ../fish/guestfish.pod:837
18459 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18463 #: ../fish/guestfish.pod:839
18465 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18466 "is how the I<--remote> option knows where to send the commands. You can "
18467 "have several guestfish listener processes running using:"
18471 #: ../fish/guestfish.pod:843
18474 " eval \"`guestfish --listen`\"\n"
18475 " pid1=$GUESTFISH_PID\n"
18476 " eval \"`guestfish --listen`\"\n"
18477 " pid2=$GUESTFISH_PID\n"
18479 " guestfish --remote=$pid1 cmd\n"
18480 " guestfish --remote=$pid2 cmd\n"
18485 #: ../fish/guestfish.pod:851
18486 msgid "REMOTE CONTROL AND CSH"
18490 #: ../fish/guestfish.pod:853
18492 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18497 #: ../fish/guestfish.pod:856
18500 " eval \"`guestfish --listen --csh`\"\n"
18505 #: ../fish/guestfish.pod:858
18506 msgid "REMOTE CONTROL DETAILS"
18510 #: ../fish/guestfish.pod:860
18512 "Remote control happens over a Unix domain socket called "
18513 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
18514 "of the process, and C<$PID> is the process ID of the server."
18518 #: ../fish/guestfish.pod:864
18519 msgid "Guestfish client and server versions must match exactly."
18523 #: ../fish/guestfish.pod:866
18524 msgid "PREPARED DISK IMAGES"
18528 #: ../fish/guestfish.pod:868
18530 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18531 "preformatted disk images that guestfish can make for you to save typing. "
18532 "This is particularly useful for testing purposes. This option is used "
18533 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18534 "can be mixed with I<-a>)."
18538 #: ../fish/guestfish.pod:874
18540 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18541 "the second and so on. Existing files in the current directory are "
18546 #: ../fish/guestfish.pod:878
18548 "The type briefly describes how the disk should be sized, partitioned, how "
18549 "filesystem(s) should be created, and how content should be added. "
18550 "Optionally the type can be followed by extra parameters, separated by C<:> "
18551 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
18552 "sparsely-allocated disk, containing a single partition, with the partition "
18553 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
18554 "on a 1GB disk instead."
18558 #: ../fish/guestfish.pod:886
18559 msgid "To list the available types and any extra parameters they take, run:"
18563 #: ../fish/guestfish.pod:890
18565 "Note that the prepared filesystem is not mounted. You would usually have to "
18566 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18570 #: ../fish/guestfish.pod:894
18572 "If any I<-N> or I<--new> options are given, the guest is automatically "
18577 #: ../fish/guestfish.pod:899
18578 msgid "Create a 100MB disk with an ext4-formatted partition:"
18582 #: ../fish/guestfish.pod:901
18585 " guestfish -N fs:ext4\n"
18590 #: ../fish/guestfish.pod:903
18591 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18595 #: ../fish/guestfish.pod:905
18598 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18603 #: ../fish/guestfish.pod:907
18604 msgid "Create a blank 200MB disk:"
18608 #: ../fish/guestfish.pod:909
18611 " guestfish -N disk:200M\n"
18616 #: ../fish/guestfish.pod:911
18617 msgid "PROGRESS BARS"
18621 #: ../fish/guestfish.pod:913
18623 "Some (not all) long-running commands send progress notification messages as "
18624 "they are running. Guestfish turns these messages into progress bars."
18628 #: ../fish/guestfish.pod:917
18630 "When a command that supports progress bars takes longer than two seconds to "
18631 "run, and if progress bars are enabled, then you will see one appearing below "
18636 #: ../fish/guestfish.pod:921
18639 " ><fs> copy-size /large-file /another-file 2048M\n"
18640 " / 10% [#####-----------------------------------------] 00:30\n"
18645 #: ../fish/guestfish.pod:924
18647 "The spinner on the left hand side moves round once for every progress "
18648 "notification received from the backend. This is a (reasonably) golden "
18649 "assurance that the command is \"doing something\" even if the progress bar "
18650 "is not moving, because the command is able to send the progress "
18651 "notifications. When the bar reaches 100% and the command finishes, the "
18652 "spinner disappears."
18656 #: ../fish/guestfish.pod:931
18658 "Progress bars are enabled by default when guestfish is used interactively. "
18659 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18660 "and you can disable them completely using I<--no-progress-bars>."
18664 #: ../fish/guestfish.pod:936
18665 msgid "GUESTFISH COMMANDS"
18669 #: ../fish/guestfish.pod:938
18671 "The commands in this section are guestfish convenience commands, in other "
18672 "words, they are not part of the L<guestfs(3)> API."
18676 #: ../fish/guestfish.pod:941
18681 #: ../fish/guestfish.pod:943
18690 #: ../fish/guestfish.pod:946
18691 msgid "Without any parameter, this provides general help."
18695 #: ../fish/guestfish.pod:948
18696 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18700 #: ../fish/guestfish.pod:950
18701 msgid "quit | exit"
18705 #: ../fish/guestfish.pod:952
18706 msgid "This exits guestfish. You can also use C<^D> key."
18710 #: ../fish/guestfish.pod:954
18711 msgid "@FISH_COMMANDS@"
18715 #: ../fish/guestfish.pod:956
18720 #: ../fish/guestfish.pod:960 ../test-tool/libguestfs-test-tool.pod:83
18725 #: ../fish/guestfish.pod:962
18727 "guestfish returns 0 if the commands completed without error, or 1 if there "
18732 #: ../fish/guestfish.pod:969
18737 #: ../fish/guestfish.pod:971
18739 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18744 #: ../fish/guestfish.pod:974
18745 msgid "GUESTFISH_PID"
18749 #: ../fish/guestfish.pod:976
18751 "Used with the I<--remote> option to specify the remote guestfish process to "
18752 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18756 #: ../fish/guestfish.pod:980
18761 #: ../fish/guestfish.pod:982
18763 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18764 "not specified, the external L<hexedit(1)> program is used."
18768 #: ../fish/guestfish.pod:986
18773 #: ../fish/guestfish.pod:988
18775 "If compiled with GNU readline support, various files in the home directory "
18776 "can be used. See L</FILES>."
18780 #: ../fish/guestfish.pod:997
18782 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18783 "effect as using the B<-v> option."
18787 #: ../fish/guestfish.pod:1009
18789 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18790 "the discussion of paths in L<guestfs(3)>."
18794 #: ../fish/guestfish.pod:1020
18795 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18799 #: ../fish/guestfish.pod:1022
18804 #: ../fish/guestfish.pod:1024
18806 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18811 #: ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:88
18816 #: ../fish/guestfish.pod:1043
18817 msgid "$HOME/.guestfish"
18821 #: ../fish/guestfish.pod:1045
18823 "If compiled with GNU readline support, then the command history is saved in "
18828 #: ../fish/guestfish.pod:1048
18829 msgid "$HOME/.inputrc"
18833 #: ../fish/guestfish.pod:1050
18834 msgid "/etc/inputrc"
18838 #: ../fish/guestfish.pod:1052
18840 "If compiled with GNU readline support, then these files can be used to "
18841 "configure readline. For further information, please see "
18842 "L<readline(3)/INITIALIZATION FILE>."
18846 #: ../fish/guestfish.pod:1056
18847 msgid "To write rules which only apply to guestfish, use:"
18851 #: ../fish/guestfish.pod:1058
18861 #: ../fish/guestfish.pod:1062
18863 "Variables that you can set in inputrc that change the behaviour of guestfish "
18864 "in useful ways include:"
18868 #: ../fish/guestfish.pod:1067
18869 msgid "completion-ignore-case (default: on)"
18873 #: ../fish/guestfish.pod:1069
18875 "By default, guestfish will ignore case when tab-completing paths on the "
18880 #: ../fish/guestfish.pod:1072
18883 " set completion-ignore-case off\n"
18888 #: ../fish/guestfish.pod:1074
18889 msgid "to make guestfish case sensitive."
18893 #: ../fish/guestfish.pod:1078
18898 #: ../fish/guestfish.pod:1080
18899 msgid "test2.img (etc)"
18903 #: ../fish/guestfish.pod:1082
18905 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18906 "will be created in the file C<test1.img> in the current directory. The "
18907 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18908 "the same name will be overwritten."
18912 #: ../fish/guestfish.pod:1091
18914 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18915 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
18916 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
18917 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
18918 "L<virt-win-reg(1)>, L<hexedit(1)>."
18922 #: ../fish/guestfish.pod:1117 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:606 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
18924 "This program is free software; you can redistribute it and/or modify it "
18925 "under the terms of the GNU General Public License as published by the Free "
18926 "Software Foundation; either version 2 of the License, or (at your option) "
18927 "any later version."
18931 #: ../fish/guestfish.pod:1122 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:611 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
18933 "This program is distributed in the hope that it will be useful, but WITHOUT "
18934 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18935 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18940 #: ../fish/guestfish.pod:1127 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:616 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
18942 "You should have received a copy of the GNU General Public License along with "
18943 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18944 "Ave, Cambridge, MA 02139, USA."
18948 #: ../fish/guestfish-actions.pod:1
18953 #: ../fish/guestfish-actions.pod:3
18956 " add-cdrom filename\n"
18961 #: ../fish/guestfish-actions.pod:15
18963 "This call checks for the existence of C<filename>. This stops you from "
18964 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18965 "and C<http:> URLs. To specify those, use the general L</config> call "
18970 #: ../fish/guestfish-actions.pod:22
18972 "If you just want to add an ISO file (often you use this as an efficient way "
18973 "to transfer large files into the guest), then you should probably use "
18974 "L</add-drive-ro> instead."
18978 #: ../fish/guestfish-actions.pod:35
18983 #: ../fish/guestfish-actions.pod:37
18988 #: ../fish/guestfish-actions.pod:39
18991 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18996 #: ../fish/guestfish-actions.pod:41
18998 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18999 "It works by connecting to libvirt, requesting the domain and domain XML from "
19000 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
19004 #: ../fish/guestfish-actions.pod:58
19006 "The optional C<libvirturi> parameter sets the libvirt URI (see "
19007 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
19008 "default libvirt URI (or one set through an environment variable, see the "
19009 "libvirt documentation for full details). If you are using the C API "
19010 "directly then it is more flexible to create the libvirt connection object "
19011 "yourself, get the domain object, and call L</add-libvirt-dom>."
19015 #: ../fish/guestfish-actions.pod:66
19017 "The other optional parameters are passed directly through to "
19018 "L</add-drive-opts>."
19022 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133 ../fish/guestfish-actions.pod:2804
19024 "This command has one or more optional arguments. See L</OPTIONAL "
19029 #: ../fish/guestfish-actions.pod:71
19034 #: ../fish/guestfish-actions.pod:73
19037 " add-drive filename\n"
19042 #: ../fish/guestfish-actions.pod:75
19044 "This function is the equivalent of calling L</add-drive-opts> with no "
19045 "optional parameters, so the disk is added writable, with the format being "
19046 "detected automatically."
19050 #: ../fish/guestfish-actions.pod:79
19052 "Automatic detection of the format opens you up to a potential security hole "
19053 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
19054 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
19055 "you should think about replacing calls to this function with calls to "
19056 "L</add-drive-opts>, and specifying the format."
19060 #: ../fish/guestfish-actions.pod:86
19061 msgid "add-drive-opts"
19065 #: ../fish/guestfish-actions.pod:88
19070 #: ../fish/guestfish-actions.pod:90
19073 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
19078 #: ../fish/guestfish-actions.pod:117
19080 "This forces the image format. If you omit this (or use L</add-drive> or "
19081 "L</add-drive-ro>) then the format is automatically detected. Possible "
19082 "formats include C<raw> and C<qcow2>."
19086 #: ../fish/guestfish-actions.pod:128
19088 "This rarely-used option lets you emulate the behaviour of the deprecated "
19089 "L</add-drive-with-if> call (q.v.)"
19093 #: ../fish/guestfish-actions.pod:135
19094 msgid "add-drive-ro"
19098 #: ../fish/guestfish-actions.pod:137
19103 #: ../fish/guestfish-actions.pod:139
19106 " add-drive-ro filename\n"
19111 #: ../fish/guestfish-actions.pod:141
19113 "This function is the equivalent of calling L</add-drive-opts> with the "
19114 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
19115 "is added read-only, with the format being detected automatically."
19119 #: ../fish/guestfish-actions.pod:146
19120 msgid "add-drive-ro-with-if"
19124 #: ../fish/guestfish-actions.pod:148
19127 " add-drive-ro-with-if filename iface\n"
19132 #: ../fish/guestfish-actions.pod:150
19134 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
19135 "interface emulation to use at run time."
19139 #: ../fish/guestfish-actions.pod:160
19140 msgid "add-drive-with-if"
19144 #: ../fish/guestfish-actions.pod:162
19147 " add-drive-with-if filename iface\n"
19152 #: ../fish/guestfish-actions.pod:164
19154 "This is the same as L</add-drive> but it allows you to specify the QEMU "
19155 "interface emulation to use at run time."
19159 #: ../fish/guestfish-actions.pod:174
19164 #: ../fish/guestfish-actions.pod:176
19167 " aug-clear augpath\n"
19172 #: ../fish/guestfish-actions.pod:181
19177 #: ../fish/guestfish-actions.pod:183
19185 #: ../fish/guestfish-actions.pod:185
19187 "Close the current Augeas handle and free up any resources used by it. After "
19188 "calling this, you have to call L</aug-init> again before you can use any "
19189 "other Augeas functions."
19193 #: ../fish/guestfish-actions.pod:190
19194 msgid "aug-defnode"
19198 #: ../fish/guestfish-actions.pod:192
19201 " aug-defnode name expr val\n"
19206 #: ../fish/guestfish-actions.pod:197
19208 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
19209 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
19210 "containing that single node."
19214 #: ../fish/guestfish-actions.pod:205
19219 #: ../fish/guestfish-actions.pod:207
19222 " aug-defvar name expr\n"
19227 #: ../fish/guestfish-actions.pod:216
19232 #: ../fish/guestfish-actions.pod:218
19235 " aug-get augpath\n"
19240 #: ../fish/guestfish-actions.pod:223
19245 #: ../fish/guestfish-actions.pod:225
19248 " aug-init root flags\n"
19253 #: ../fish/guestfish-actions.pod:231
19254 msgid "You must call this before using any other L</aug-*> commands."
19258 #: ../fish/guestfish-actions.pod:266
19259 msgid "Do not load the tree in L</aug-init>."
19263 #: ../fish/guestfish-actions.pod:270
19264 msgid "To close the handle, you can call L</aug-close>."
19268 #: ../fish/guestfish-actions.pod:274
19273 #: ../fish/guestfish-actions.pod:276
19276 " aug-insert augpath label true|false\n"
19281 #: ../fish/guestfish-actions.pod:286
19286 #: ../fish/guestfish-actions.pod:288
19294 #: ../fish/guestfish-actions.pod:295
19299 #: ../fish/guestfish-actions.pod:297
19302 " aug-ls augpath\n"
19307 #: ../fish/guestfish-actions.pod:299
19309 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19310 "resulting nodes into alphabetical order."
19314 #: ../fish/guestfish-actions.pod:302
19319 #: ../fish/guestfish-actions.pod:304
19322 " aug-match augpath\n"
19327 #: ../fish/guestfish-actions.pod:310
19332 #: ../fish/guestfish-actions.pod:312
19335 " aug-mv src dest\n"
19340 #: ../fish/guestfish-actions.pod:317
19345 #: ../fish/guestfish-actions.pod:319
19348 " aug-rm augpath\n"
19353 #: ../fish/guestfish-actions.pod:325
19358 #: ../fish/guestfish-actions.pod:327
19366 #: ../fish/guestfish-actions.pod:331
19368 "The flags which were passed to L</aug-init> affect exactly how files are "
19373 #: ../fish/guestfish-actions.pod:334
19378 #: ../fish/guestfish-actions.pod:336
19381 " aug-set augpath val\n"
19386 #: ../fish/guestfish-actions.pod:340
19388 "In the Augeas API, it is possible to clear a node by setting the value to "
19389 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19390 "this call. Instead you must use the L</aug-clear> call."
19394 #: ../fish/guestfish-actions.pod:345
19399 #: ../fish/guestfish-actions.pod:347
19402 " available 'groups ...'\n"
19407 #: ../fish/guestfish-actions.pod:353
19409 "The libguestfs groups, and the functions that those groups correspond to, "
19410 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19411 "runtime by calling L</available-all-groups>."
19415 #: ../fish/guestfish-actions.pod:377
19416 msgid "You must call L</launch> before calling this function."
19420 #: ../fish/guestfish-actions.pod:399
19422 "This call was added in version C<1.0.80>. In previous versions of "
19423 "libguestfs all you could do would be to speculatively execute a command to "
19424 "find out if the daemon implemented it. See also L</version>."
19428 #: ../fish/guestfish-actions.pod:406
19429 msgid "available-all-groups"
19433 #: ../fish/guestfish-actions.pod:408
19436 " available-all-groups\n"
19441 #: ../fish/guestfish-actions.pod:410
19443 "This command returns a list of all optional groups that this daemon knows "
19444 "about. Note this returns both supported and unsupported groups. To find "
19445 "out which ones the daemon can actually support you have to call "
19446 "L</available> on each member of the returned list."
19450 #: ../fish/guestfish-actions.pod:416
19451 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19455 #: ../fish/guestfish-actions.pod:418
19460 #: ../fish/guestfish-actions.pod:420
19463 " base64-in (base64file|-) filename\n"
19468 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434 ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827 ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223 ../fish/guestfish-actions.pod:4159 ../fish/guestfish-actions.pod:4171 ../fish/guestfish-actions.pod:4182 ../fish/guestfish-actions.pod:4193 ../fish/guestfish-actions.pod:4245 ../fish/guestfish-actions.pod:4254 ../fish/guestfish-actions.pod:4308 ../fish/guestfish-actions.pod:4331
19469 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19473 #: ../fish/guestfish-actions.pod:427
19478 #: ../fish/guestfish-actions.pod:429
19481 " base64-out filename (base64file|-)\n"
19486 #: ../fish/guestfish-actions.pod:436
19487 msgid "blockdev-flushbufs"
19491 #: ../fish/guestfish-actions.pod:438
19494 " blockdev-flushbufs device\n"
19499 #: ../fish/guestfish-actions.pod:445
19500 msgid "blockdev-getbsz"
19504 #: ../fish/guestfish-actions.pod:447
19507 " blockdev-getbsz device\n"
19512 #: ../fish/guestfish-actions.pod:456
19513 msgid "blockdev-getro"
19517 #: ../fish/guestfish-actions.pod:458
19520 " blockdev-getro device\n"
19525 #: ../fish/guestfish-actions.pod:465
19526 msgid "blockdev-getsize64"
19530 #: ../fish/guestfish-actions.pod:467
19533 " blockdev-getsize64 device\n"
19538 #: ../fish/guestfish-actions.pod:471
19539 msgid "See also L</blockdev-getsz>."
19543 #: ../fish/guestfish-actions.pod:475
19544 msgid "blockdev-getss"
19548 #: ../fish/guestfish-actions.pod:477
19551 " blockdev-getss device\n"
19556 #: ../fish/guestfish-actions.pod:482
19557 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19561 #: ../fish/guestfish-actions.pod:487
19562 msgid "blockdev-getsz"
19566 #: ../fish/guestfish-actions.pod:489
19569 " blockdev-getsz device\n"
19574 #: ../fish/guestfish-actions.pod:494
19576 "See also L</blockdev-getss> for the real sector size of the device, and "
19577 "L</blockdev-getsize64> for the more useful I<size in bytes>."
19581 #: ../fish/guestfish-actions.pod:500
19582 msgid "blockdev-rereadpt"
19586 #: ../fish/guestfish-actions.pod:502
19589 " blockdev-rereadpt device\n"
19594 #: ../fish/guestfish-actions.pod:508
19595 msgid "blockdev-setbsz"
19599 #: ../fish/guestfish-actions.pod:510
19602 " blockdev-setbsz device blocksize\n"
19607 #: ../fish/guestfish-actions.pod:519
19608 msgid "blockdev-setro"
19612 #: ../fish/guestfish-actions.pod:521
19615 " blockdev-setro device\n"
19620 #: ../fish/guestfish-actions.pod:527
19621 msgid "blockdev-setrw"
19625 #: ../fish/guestfish-actions.pod:529
19628 " blockdev-setrw device\n"
19633 #: ../fish/guestfish-actions.pod:535
19634 msgid "case-sensitive-path"
19638 #: ../fish/guestfish-actions.pod:537
19641 " case-sensitive-path path\n"
19646 #: ../fish/guestfish-actions.pod:561
19648 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
19649 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
19650 "how the directories were originally created under Windows)."
19654 #: ../fish/guestfish-actions.pod:569
19655 msgid "See also L</realpath>."
19659 #: ../fish/guestfish-actions.pod:571
19664 #: ../fish/guestfish-actions.pod:573
19672 #: ../fish/guestfish-actions.pod:577
19674 "Note that this function cannot correctly handle binary files (specifically, "
19675 "files containing C<\\0> character which is treated as end of string). For "
19676 "those you need to use the L</read-file> or L</download> functions which have "
19677 "a more complex interface."
19681 #: ../fish/guestfish-actions.pod:585
19686 #: ../fish/guestfish-actions.pod:587
19689 " checksum csumtype path\n"
19694 #: ../fish/guestfish-actions.pod:630
19695 msgid "To get the checksum for a device, use L</checksum-device>."
19699 #: ../fish/guestfish-actions.pod:632
19700 msgid "To get the checksums for many files, use L</checksums-out>."
19704 #: ../fish/guestfish-actions.pod:634
19705 msgid "checksum-device"
19709 #: ../fish/guestfish-actions.pod:636
19712 " checksum-device csumtype device\n"
19717 #: ../fish/guestfish-actions.pod:638
19719 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19720 "device named C<device>. For the types of checksums supported see the "
19721 "L</checksum> command."
19725 #: ../fish/guestfish-actions.pod:642
19726 msgid "checksums-out"
19730 #: ../fish/guestfish-actions.pod:644
19733 " checksums-out csumtype directory (sumsfile|-)\n"
19738 #: ../fish/guestfish-actions.pod:660
19743 #: ../fish/guestfish-actions.pod:662
19746 " chmod mode path\n"
19751 #: ../fish/guestfish-actions.pod:673
19756 #: ../fish/guestfish-actions.pod:675
19759 " chown owner group path\n"
19764 #: ../fish/guestfish-actions.pod:683
19769 #: ../fish/guestfish-actions.pod:685
19772 " command 'arguments ...'\n"
19777 #: ../fish/guestfish-actions.pod:692
19779 "The single parameter is an argv-style list of arguments. The first element "
19780 "is the name of the program to run. Subsequent elements are parameters. The "
19781 "list must be non-empty (ie. must contain a program name). Note that the "
19782 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19786 #: ../fish/guestfish-actions.pod:720
19787 msgid "command-lines"
19791 #: ../fish/guestfish-actions.pod:722
19794 " command-lines 'arguments ...'\n"
19799 #: ../fish/guestfish-actions.pod:724
19800 msgid "This is the same as L</command>, but splits the result into a list of lines."
19804 #: ../fish/guestfish-actions.pod:727
19805 msgid "See also: L</sh-lines>"
19809 #: ../fish/guestfish-actions.pod:732
19814 #: ../fish/guestfish-actions.pod:734
19817 " config qemuparam qemuvalue\n"
19822 #: ../fish/guestfish-actions.pod:745
19827 #: ../fish/guestfish-actions.pod:747
19830 " copy-size src dest size\n"
19835 #: ../fish/guestfish-actions.pod:755
19840 #: ../fish/guestfish-actions.pod:757
19848 #: ../fish/guestfish-actions.pod:762
19853 #: ../fish/guestfish-actions.pod:764
19861 #: ../fish/guestfish-actions.pod:769
19866 #: ../fish/guestfish-actions.pod:771
19874 #: ../fish/guestfish-actions.pod:778
19876 "If the destination is a device, it must be as large or larger than the "
19877 "source file or device, otherwise the copy will fail. This command cannot do "
19878 "partial copies (see L</copy-size>)."
19882 #: ../fish/guestfish-actions.pod:782
19887 #: ../fish/guestfish-actions.pod:784
19895 #: ../fish/guestfish-actions.pod:792
19900 #: ../fish/guestfish-actions.pod:794
19908 #: ../fish/guestfish-actions.pod:803
19913 #: ../fish/guestfish-actions.pod:805
19921 #: ../fish/guestfish-actions.pod:811
19923 "Another way to get the same information is to enable verbose messages with "
19924 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19925 "before running the program."
19929 #: ../fish/guestfish-actions.pod:816
19934 #: ../fish/guestfish-actions.pod:818
19937 " download remotefilename (filename|-)\n"
19942 #: ../fish/guestfish-actions.pod:825
19943 msgid "See also L</upload>, L</cat>."
19947 #: ../fish/guestfish-actions.pod:829
19948 msgid "download-offset"
19952 #: ../fish/guestfish-actions.pod:831
19955 " download-offset remotefilename (filename|-) offset size\n"
19960 #: ../fish/guestfish-actions.pod:839
19962 "Note that there is no limit on the amount of data that can be downloaded "
19963 "with this call, unlike with L</pread>, and this call always reads the full "
19964 "amount unless an error occurs."
19968 #: ../fish/guestfish-actions.pod:844
19969 msgid "See also L</download>, L</pread>."
19973 #: ../fish/guestfish-actions.pod:848
19974 msgid "drop-caches"
19978 #: ../fish/guestfish-actions.pod:850
19981 " drop-caches whattodrop\n"
19986 #: ../fish/guestfish-actions.pod:862
19991 #: ../fish/guestfish-actions.pod:864
19999 #: ../fish/guestfish-actions.pod:876
20004 #: ../fish/guestfish-actions.pod:878
20007 " e2fsck-f device\n"
20012 #: ../fish/guestfish-actions.pod:884
20014 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
20015 "should use L</fsck>."
20019 #: ../fish/guestfish-actions.pod:887
20020 msgid "echo-daemon"
20024 #: ../fish/guestfish-actions.pod:889
20027 " echo-daemon 'words ...'\n"
20032 #: ../fish/guestfish-actions.pod:896
20033 msgid "See also L</ping-daemon>."
20037 #: ../fish/guestfish-actions.pod:898
20042 #: ../fish/guestfish-actions.pod:900
20045 " egrep regex path\n"
20050 #: ../fish/guestfish-actions.pod:908
20055 #: ../fish/guestfish-actions.pod:910
20058 " egrepi regex path\n"
20063 #: ../fish/guestfish-actions.pod:918
20068 #: ../fish/guestfish-actions.pod:920
20071 " equal file1 file2\n"
20076 #: ../fish/guestfish-actions.pod:927
20081 #: ../fish/guestfish-actions.pod:929
20089 #: ../fish/guestfish-actions.pod:934
20090 msgid "See also L</is-file>, L</is-dir>, L</stat>."
20094 #: ../fish/guestfish-actions.pod:936
20099 #: ../fish/guestfish-actions.pod:938
20102 " fallocate path len\n"
20107 #: ../fish/guestfish-actions.pod:955
20108 msgid "fallocate64"
20112 #: ../fish/guestfish-actions.pod:957
20115 " fallocate64 path len\n"
20120 #: ../fish/guestfish-actions.pod:963
20122 "Note that this call allocates disk blocks for the file. To create a sparse "
20123 "file use L</truncate-size> instead."
20127 #: ../fish/guestfish-actions.pod:966
20129 "The deprecated call L</fallocate> does the same, but owing to an oversight "
20130 "it only allowed 30 bit lengths to be specified, effectively limiting the "
20131 "maximum size of files created through that call to 1GB."
20135 #: ../fish/guestfish-actions.pod:975
20140 #: ../fish/guestfish-actions.pod:977
20143 " fgrep pattern path\n"
20148 #: ../fish/guestfish-actions.pod:985
20153 #: ../fish/guestfish-actions.pod:987
20156 " fgrepi pattern path\n"
20161 #: ../fish/guestfish-actions.pod:995
20166 #: ../fish/guestfish-actions.pod:997
20174 #: ../fish/guestfish-actions.pod:1009
20176 "This command can also be used on C</dev/> devices (and partitions, LV "
20177 "names). You can for example use this to determine if a device contains a "
20178 "filesystem, although it's usually better to use L</vfs-type>."
20182 #: ../fish/guestfish-actions.pod:1019
20183 msgid "file-architecture"
20187 #: ../fish/guestfish-actions.pod:1021
20190 " file-architecture filename\n"
20195 #: ../fish/guestfish-actions.pod:1124
20200 #: ../fish/guestfish-actions.pod:1126
20208 #: ../fish/guestfish-actions.pod:1130
20210 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
20211 "L</is-file> etc. To get the size of block devices, use "
20212 "L</blockdev-getsize64>."
20216 #: ../fish/guestfish-actions.pod:1134
20221 #: ../fish/guestfish-actions.pod:1136
20224 " fill c len path\n"
20229 #: ../fish/guestfish-actions.pod:1142
20231 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20232 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20233 "L</fill-pattern>."
20237 #: ../fish/guestfish-actions.pod:1147
20238 msgid "fill-pattern"
20242 #: ../fish/guestfish-actions.pod:1149
20245 " fill-pattern pattern len path\n"
20250 #: ../fish/guestfish-actions.pod:1151
20252 "This function is like L</fill> except that it creates a new file of length "
20253 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20254 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20259 #: ../fish/guestfish-actions.pod:1156
20264 #: ../fish/guestfish-actions.pod:1158
20267 " find directory\n"
20272 #: ../fish/guestfish-actions.pod:1172
20273 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20277 #: ../fish/guestfish-actions.pod:1185
20278 msgid "See also L</find0>."
20282 #: ../fish/guestfish-actions.pod:1190
20287 #: ../fish/guestfish-actions.pod:1192
20290 " find0 directory (files|-)\n"
20295 #: ../fish/guestfish-actions.pod:1198
20296 msgid "This command works the same way as L</find> with the following exceptions:"
20300 #: ../fish/guestfish-actions.pod:1225
20301 msgid "findfs-label"
20305 #: ../fish/guestfish-actions.pod:1227
20308 " findfs-label label\n"
20313 #: ../fish/guestfish-actions.pod:1233
20314 msgid "To find the label of a filesystem, use L</vfs-label>."
20318 #: ../fish/guestfish-actions.pod:1235
20319 msgid "findfs-uuid"
20323 #: ../fish/guestfish-actions.pod:1237
20326 " findfs-uuid uuid\n"
20331 #: ../fish/guestfish-actions.pod:1243
20332 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20336 #: ../fish/guestfish-actions.pod:1245
20341 #: ../fish/guestfish-actions.pod:1247
20344 " fsck fstype device\n"
20349 #: ../fish/guestfish-actions.pod:1277
20354 #: ../fish/guestfish-actions.pod:1279
20362 #: ../fish/guestfish-actions.pod:1286
20363 msgid "get-autosync"
20367 #: ../fish/guestfish-actions.pod:1288
20375 #: ../fish/guestfish-actions.pod:1292
20380 #: ../fish/guestfish-actions.pod:1294
20388 #: ../fish/guestfish-actions.pod:1298
20389 msgid "get-e2label"
20393 #: ../fish/guestfish-actions.pod:1300
20396 " get-e2label device\n"
20401 #: ../fish/guestfish-actions.pod:1312
20406 #: ../fish/guestfish-actions.pod:1314
20409 " get-e2uuid device\n"
20414 #: ../fish/guestfish-actions.pod:1326
20415 msgid "get-memsize"
20419 #: ../fish/guestfish-actions.pod:1328
20427 #: ../fish/guestfish-actions.pod:1333
20429 "If L</set-memsize> was not called on this handle, and if "
20430 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20431 "value for memsize."
20435 #: ../fish/guestfish-actions.pod:1340
20436 msgid "get-network"
20440 #: ../fish/guestfish-actions.pod:1342
20448 #: ../fish/guestfish-actions.pod:1346
20453 #: ../fish/guestfish-actions.pod:1348
20461 #: ../fish/guestfish-actions.pod:1355
20466 #: ../fish/guestfish-actions.pod:1357
20471 #: ../fish/guestfish-actions.pod:1359
20479 #: ../fish/guestfish-actions.pod:1366
20484 #: ../fish/guestfish-actions.pod:1368
20492 #: ../fish/guestfish-actions.pod:1375
20493 msgid "get-recovery-proc"
20497 #: ../fish/guestfish-actions.pod:1377
20500 " get-recovery-proc\n"
20505 #: ../fish/guestfish-actions.pod:1381
20506 msgid "get-selinux"
20510 #: ../fish/guestfish-actions.pod:1383
20518 #: ../fish/guestfish-actions.pod:1385
20520 "This returns the current setting of the selinux flag which is passed to the "
20521 "appliance at boot time. See L</set-selinux>."
20525 #: ../fish/guestfish-actions.pod:1391
20530 #: ../fish/guestfish-actions.pod:1393
20538 #: ../fish/guestfish-actions.pod:1400
20543 #: ../fish/guestfish-actions.pod:1402
20551 #: ../fish/guestfish-actions.pod:1406
20556 #: ../fish/guestfish-actions.pod:1408
20564 #: ../fish/guestfish-actions.pod:1410
20566 "Return the current umask. By default the umask is C<022> unless it has been "
20567 "set by calling L</umask>."
20571 #: ../fish/guestfish-actions.pod:1413
20572 msgid "get-verbose"
20576 #: ../fish/guestfish-actions.pod:1415
20584 #: ../fish/guestfish-actions.pod:1419
20589 #: ../fish/guestfish-actions.pod:1421
20597 #: ../fish/guestfish-actions.pod:1425
20598 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20602 #: ../fish/guestfish-actions.pod:1428
20607 #: ../fish/guestfish-actions.pod:1430
20610 " getxattrs path\n"
20615 #: ../fish/guestfish-actions.pod:1438
20616 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20620 #: ../fish/guestfish-actions.pod:1440
20621 msgid "glob-expand"
20625 #: ../fish/guestfish-actions.pod:1442
20628 " glob-expand pattern\n"
20633 #: ../fish/guestfish-actions.pod:1455
20638 #: ../fish/guestfish-actions.pod:1457
20641 " grep regex path\n"
20646 #: ../fish/guestfish-actions.pod:1465
20651 #: ../fish/guestfish-actions.pod:1467
20654 " grepi regex path\n"
20659 #: ../fish/guestfish-actions.pod:1475
20660 msgid "grub-install"
20664 #: ../fish/guestfish-actions.pod:1477
20667 " grub-install root device\n"
20672 #: ../fish/guestfish-actions.pod:1493
20677 #: ../fish/guestfish-actions.pod:1495
20685 #: ../fish/guestfish-actions.pod:1503
20690 #: ../fish/guestfish-actions.pod:1505
20693 " head-n nrlines path\n"
20698 #: ../fish/guestfish-actions.pod:1518
20703 #: ../fish/guestfish-actions.pod:1520
20711 #: ../fish/guestfish-actions.pod:1528
20716 #: ../fish/guestfish-actions.pod:1530
20719 " initrd-cat initrdpath filename\n"
20724 #: ../fish/guestfish-actions.pod:1542
20725 msgid "See also L</initrd-list>."
20729 #: ../fish/guestfish-actions.pod:1547
20730 msgid "initrd-list"
20734 #: ../fish/guestfish-actions.pod:1549
20737 " initrd-list path\n"
20742 #: ../fish/guestfish-actions.pod:1561
20743 msgid "inotify-add-watch"
20747 #: ../fish/guestfish-actions.pod:1563
20750 " inotify-add-watch path mask\n"
20755 #: ../fish/guestfish-actions.pod:1575
20756 msgid "inotify-close"
20760 #: ../fish/guestfish-actions.pod:1577
20768 #: ../fish/guestfish-actions.pod:1583
20769 msgid "inotify-files"
20773 #: ../fish/guestfish-actions.pod:1585
20781 #: ../fish/guestfish-actions.pod:1587
20783 "This function is a helpful wrapper around L</inotify-read> which just "
20784 "returns a list of pathnames of objects that were touched. The returned "
20785 "pathnames are sorted and deduplicated."
20789 #: ../fish/guestfish-actions.pod:1591
20790 msgid "inotify-init"
20794 #: ../fish/guestfish-actions.pod:1593
20797 " inotify-init maxevents\n"
20802 #: ../fish/guestfish-actions.pod:1599
20804 "C<maxevents> is the maximum number of events which will be queued up between "
20805 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20806 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20807 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20808 "but records the fact that it threw them away by setting a flag "
20809 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20813 #: ../fish/guestfish-actions.pod:1609
20815 "Before any events are generated, you have to add some watches to the "
20816 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20817 "L</inotify-watch-all>."
20821 #: ../fish/guestfish-actions.pod:1615
20823 "Queued up events should be read periodically by calling L</inotify-read> (or "
20824 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20825 "If you don't read the events out often enough then you risk the internal "
20826 "queue overflowing."
20830 #: ../fish/guestfish-actions.pod:1622
20832 "The handle should be closed after use by calling L</inotify-close>. This "
20833 "also removes any watches automatically."
20837 #: ../fish/guestfish-actions.pod:1631
20838 msgid "inotify-read"
20842 #: ../fish/guestfish-actions.pod:1633
20850 #: ../fish/guestfish-actions.pod:1646
20851 msgid "inotify-rm-watch"
20855 #: ../fish/guestfish-actions.pod:1648
20858 " inotify-rm-watch wd\n"
20863 #: ../fish/guestfish-actions.pod:1650
20864 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20868 #: ../fish/guestfish-actions.pod:1653
20869 msgid "inspect-get-arch"
20873 #: ../fish/guestfish-actions.pod:1655
20876 " inspect-get-arch root\n"
20881 #: ../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
20883 "This function should only be called with a root device string as returned by "
20888 #: ../fish/guestfish-actions.pod:1660
20890 "This returns the architecture of the inspected operating system. The "
20891 "possible return values are listed under L</file-architecture>."
20895 #: ../fish/guestfish-actions.pod:1669
20896 msgid "inspect-get-distro"
20900 #: ../fish/guestfish-actions.pod:1671
20903 " inspect-get-distro root\n"
20908 #: ../fish/guestfish-actions.pod:1743
20909 msgid "inspect-get-filesystems"
20913 #: ../fish/guestfish-actions.pod:1745
20916 " inspect-get-filesystems root\n"
20921 #: ../fish/guestfish-actions.pod:1758
20923 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20924 "L</inspect-get-mountpoints>."
20928 #: ../fish/guestfish-actions.pod:1761
20929 msgid "inspect-get-hostname"
20933 #: ../fish/guestfish-actions.pod:1763
20936 " inspect-get-hostname root\n"
20941 #: ../fish/guestfish-actions.pod:1776
20942 msgid "inspect-get-major-version"
20946 #: ../fish/guestfish-actions.pod:1778
20949 " inspect-get-major-version root\n"
20954 #: ../fish/guestfish-actions.pod:1797
20955 msgid "inspect-get-minor-version"
20959 #: ../fish/guestfish-actions.pod:1799
20962 " inspect-get-minor-version root\n"
20967 #: ../fish/guestfish-actions.pod:1809
20969 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20970 "L</inspect-get-major-version>."
20974 #: ../fish/guestfish-actions.pod:1812
20975 msgid "inspect-get-mountpoints"
20979 #: ../fish/guestfish-actions.pod:1814
20982 " inspect-get-mountpoints root\n"
20987 #: ../fish/guestfish-actions.pod:1832
20989 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20990 "L</inspect-get-filesystems>."
20994 #: ../fish/guestfish-actions.pod:1835
20995 msgid "inspect-get-package-format"
20999 #: ../fish/guestfish-actions.pod:1837
21002 " inspect-get-package-format root\n"
21007 #: ../fish/guestfish-actions.pod:1842
21009 "This function and L</inspect-get-package-management> return the package "
21010 "format and package management tool used by the inspected operating system. "
21011 "For example for Fedora these functions would return C<rpm> (package format) "
21012 "and C<yum> (package management)."
21016 #: ../fish/guestfish-actions.pod:1857
21017 msgid "inspect-get-package-management"
21021 #: ../fish/guestfish-actions.pod:1859
21024 " inspect-get-package-management root\n"
21029 #: ../fish/guestfish-actions.pod:1864
21031 "L</inspect-get-package-format> and this function return the package format "
21032 "and package management tool used by the inspected operating system. For "
21033 "example for Fedora these functions would return C<rpm> (package format) and "
21034 "C<yum> (package management)."
21038 #: ../fish/guestfish-actions.pod:1881
21039 msgid "inspect-get-product-name"
21043 #: ../fish/guestfish-actions.pod:1883
21046 " inspect-get-product-name root\n"
21051 #: ../fish/guestfish-actions.pod:1898
21052 msgid "inspect-get-roots"
21056 #: ../fish/guestfish-actions.pod:1900
21059 " inspect-get-roots\n"
21064 #: ../fish/guestfish-actions.pod:1902
21066 "This function is a convenient way to get the list of root devices, as "
21067 "returned from a previous call to L</inspect-os>, but without redoing the "
21068 "whole inspection process."
21072 #: ../fish/guestfish-actions.pod:1906
21074 "This returns an empty list if either no root devices were found or the "
21075 "caller has not called L</inspect-os>."
21079 #: ../fish/guestfish-actions.pod:1911
21080 msgid "inspect-get-type"
21084 #: ../fish/guestfish-actions.pod:1913
21087 " inspect-get-type root\n"
21092 #: ../fish/guestfish-actions.pod:1946
21093 msgid "inspect-get-windows-systemroot"
21097 #: ../fish/guestfish-actions.pod:1948
21100 " inspect-get-windows-systemroot root\n"
21105 #: ../fish/guestfish-actions.pod:1962
21106 msgid "inspect-list-applications"
21110 #: ../fish/guestfish-actions.pod:1964
21113 " inspect-list-applications root\n"
21118 #: ../fish/guestfish-actions.pod:1971
21120 "I<Note:> This call works differently from other parts of the inspection "
21121 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
21122 "then mount up the disks, before calling this. Listing applications is a "
21123 "significantly more difficult operation which requires access to the full "
21124 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
21125 "are just returning data cached in the libguestfs handle, this call actually "
21126 "reads parts of the mounted filesystems during the call."
21130 #: ../fish/guestfish-actions.pod:2061
21135 #: ../fish/guestfish-actions.pod:2063
21143 #: ../fish/guestfish-actions.pod:2078
21145 "You can pass the root string(s) returned to other L</inspect-get-*> "
21146 "functions in order to query further information about each operating system, "
21147 "such as the name and version."
21151 #: ../fish/guestfish-actions.pod:2083
21153 "This function uses other libguestfs features such as L</mount-ro> and "
21154 "L</umount-all> in order to mount and unmount filesystems and look at the "
21155 "contents. This should be called with no disks currently mounted. The "
21156 "function may also use Augeas, so any existing Augeas handle will be closed."
21160 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2297
21161 msgid "See also L</list-filesystems>."
21165 #: ../fish/guestfish-actions.pod:2097
21166 msgid "is-blockdev"
21170 #: ../fish/guestfish-actions.pod:2099
21173 " is-blockdev path\n"
21178 #: ../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
21179 msgid "See also L</stat>."
21183 #: ../fish/guestfish-actions.pod:2106
21188 #: ../fish/guestfish-actions.pod:2108
21196 #: ../fish/guestfish-actions.pod:2115
21201 #: ../fish/guestfish-actions.pod:2117
21204 " is-chardev path\n"
21209 #: ../fish/guestfish-actions.pod:2124
21214 #: ../fish/guestfish-actions.pod:2126
21222 #: ../fish/guestfish-actions.pod:2133
21227 #: ../fish/guestfish-actions.pod:2135
21235 #: ../fish/guestfish-actions.pod:2143
21240 #: ../fish/guestfish-actions.pod:2145
21248 #: ../fish/guestfish-actions.pod:2152
21253 #: ../fish/guestfish-actions.pod:2154
21261 #: ../fish/guestfish-actions.pod:2162
21262 msgid "is-launching"
21266 #: ../fish/guestfish-actions.pod:2164
21274 #: ../fish/guestfish-actions.pod:2171
21279 #: ../fish/guestfish-actions.pod:2173
21287 #: ../fish/guestfish-actions.pod:2178
21292 #: ../fish/guestfish-actions.pod:2180
21300 #: ../fish/guestfish-actions.pod:2187
21305 #: ../fish/guestfish-actions.pod:2189
21308 " is-socket path\n"
21313 #: ../fish/guestfish-actions.pod:2196
21318 #: ../fish/guestfish-actions.pod:2198
21321 " is-symlink path\n"
21326 #: ../fish/guestfish-actions.pod:2205
21327 msgid "kill-subprocess"
21331 #: ../fish/guestfish-actions.pod:2207
21334 " kill-subprocess\n"
21339 #: ../fish/guestfish-actions.pod:2211
21344 #: ../fish/guestfish-actions.pod:2213
21349 #: ../fish/guestfish-actions.pod:2215
21357 #: ../fish/guestfish-actions.pod:2223
21362 #: ../fish/guestfish-actions.pod:2225
21365 " lchown owner group path\n"
21370 #: ../fish/guestfish-actions.pod:2227
21372 "Change the file owner to C<owner> and group to C<group>. This is like "
21373 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
21378 #: ../fish/guestfish-actions.pod:2235
21383 #: ../fish/guestfish-actions.pod:2237
21386 " lgetxattrs path\n"
21391 #: ../fish/guestfish-actions.pod:2239
21393 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21394 "it returns the extended attributes of the link itself."
21398 #: ../fish/guestfish-actions.pod:2243
21399 msgid "list-devices"
21403 #: ../fish/guestfish-actions.pod:2245
21411 #: ../fish/guestfish-actions.pod:2253
21412 msgid "list-filesystems"
21416 #: ../fish/guestfish-actions.pod:2255
21419 " list-filesystems\n"
21424 #: ../fish/guestfish-actions.pod:2274
21426 "This command runs other libguestfs commands, which might include L</mount> "
21427 "and L</umount>, and therefore you should use this soon after launch and only "
21428 "when nothing is mounted."
21432 #: ../fish/guestfish-actions.pod:2278
21434 "Not all of the filesystems returned will be mountable. In particular, swap "
21435 "partitions are returned in the list. Also this command does not check that "
21436 "each filesystem found is valid and mountable, and some filesystems might be "
21437 "mountable but require special options. Filesystems may not all belong to a "
21438 "single logical operating system (use L</inspect-os> to look for OSes)."
21442 #: ../fish/guestfish-actions.pod:2286
21443 msgid "list-partitions"
21447 #: ../fish/guestfish-actions.pod:2288
21450 " list-partitions\n"
21455 #: ../fish/guestfish-actions.pod:2294
21457 "This does not return logical volumes. For that you will need to call "
21462 #: ../fish/guestfish-actions.pod:2299
21467 #: ../fish/guestfish-actions.pod:2301
21475 #: ../fish/guestfish-actions.pod:2309
21480 #: ../fish/guestfish-actions.pod:2311
21483 " ln target linkname\n"
21488 #: ../fish/guestfish-actions.pod:2315
21493 #: ../fish/guestfish-actions.pod:2317
21496 " ln-f target linkname\n"
21501 #: ../fish/guestfish-actions.pod:2322
21506 #: ../fish/guestfish-actions.pod:2324
21509 " ln-s target linkname\n"
21514 #: ../fish/guestfish-actions.pod:2328
21519 #: ../fish/guestfish-actions.pod:2330
21522 " ln-sf target linkname\n"
21527 #: ../fish/guestfish-actions.pod:2335
21528 msgid "lremovexattr"
21532 #: ../fish/guestfish-actions.pod:2337
21535 " lremovexattr xattr path\n"
21540 #: ../fish/guestfish-actions.pod:2339
21542 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21543 "it removes an extended attribute of the link itself."
21547 #: ../fish/guestfish-actions.pod:2343
21552 #: ../fish/guestfish-actions.pod:2345
21560 #: ../fish/guestfish-actions.pod:2351
21562 "This command is mostly useful for interactive sessions. Programs should "
21563 "probably use L</readdir> instead."
21567 #: ../fish/guestfish-actions.pod:2354
21572 #: ../fish/guestfish-actions.pod:2356
21575 " lsetxattr xattr val vallen path\n"
21580 #: ../fish/guestfish-actions.pod:2358
21582 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21583 "sets an extended attribute of the link itself."
21587 #: ../fish/guestfish-actions.pod:2362
21592 #: ../fish/guestfish-actions.pod:2364
21600 #: ../fish/guestfish-actions.pod:2368
21602 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21603 "the link is stat-ed, not the file it refers to."
21607 #: ../fish/guestfish-actions.pod:2374
21612 #: ../fish/guestfish-actions.pod:2376
21615 " lstatlist path 'names ...'\n"
21620 #: ../fish/guestfish-actions.pod:2378
21622 "This call allows you to perform the L</lstat> operation on multiple files, "
21623 "where all files are in the directory C<path>. C<names> is the list of files "
21624 "from this directory."
21628 #: ../fish/guestfish-actions.pod:2387
21630 "This call is intended for programs that want to efficiently list a directory "
21631 "contents without making many round-trips. See also L</lxattrlist> for a "
21632 "similarly efficient call for getting extended attributes. Very long "
21633 "directory listings might cause the protocol message size to be exceeded, "
21634 "causing this call to fail. The caller must split up such requests into "
21635 "smaller groups of names."
21639 #: ../fish/guestfish-actions.pod:2395
21640 msgid "luks-add-key"
21644 #: ../fish/guestfish-actions.pod:2397
21647 " luks-add-key device keyslot\n"
21652 #: ../fish/guestfish-actions.pod:2404
21654 "Note that if C<keyslot> already contains a key, then this command will "
21655 "fail. You have to use L</luks-kill-slot> first to remove that key."
21659 #: ../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
21661 "This command has one or more key or passphrase parameters. Guestfish will "
21662 "prompt for these separately."
21666 #: ../fish/guestfish-actions.pod:2411
21671 #: ../fish/guestfish-actions.pod:2413
21674 " luks-close device\n"
21679 #: ../fish/guestfish-actions.pod:2415
21681 "This closes a LUKS device that was created earlier by L</luks-open> or "
21682 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
21683 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
21684 "underlying block device."
21688 #: ../fish/guestfish-actions.pod:2421
21689 msgid "luks-format"
21693 #: ../fish/guestfish-actions.pod:2423
21696 " luks-format device keyslot\n"
21701 #: ../fish/guestfish-actions.pod:2436
21702 msgid "luks-format-cipher"
21706 #: ../fish/guestfish-actions.pod:2438
21709 " luks-format-cipher device keyslot cipher\n"
21714 #: ../fish/guestfish-actions.pod:2440
21716 "This command is the same as L</luks-format> but it also allows you to set "
21717 "the C<cipher> used."
21721 #: ../fish/guestfish-actions.pod:2449
21722 msgid "luks-kill-slot"
21726 #: ../fish/guestfish-actions.pod:2451
21729 " luks-kill-slot device keyslot\n"
21734 #: ../fish/guestfish-actions.pod:2460
21739 #: ../fish/guestfish-actions.pod:2462
21742 " luks-open device mapname\n"
21747 #: ../fish/guestfish-actions.pod:2476
21749 "If this block device contains LVM volume groups, then calling L</vgscan> "
21750 "followed by L</vg-activate-all> will make them visible."
21754 #: ../fish/guestfish-actions.pod:2483
21755 msgid "luks-open-ro"
21759 #: ../fish/guestfish-actions.pod:2485
21762 " luks-open-ro device mapname\n"
21767 #: ../fish/guestfish-actions.pod:2487
21769 "This is the same as L</luks-open> except that a read-only mapping is "
21774 #: ../fish/guestfish-actions.pod:2493
21779 #: ../fish/guestfish-actions.pod:2495
21782 " lvcreate logvol volgroup mbytes\n"
21787 #: ../fish/guestfish-actions.pod:2500
21788 msgid "lvm-canonical-lv-name"
21792 #: ../fish/guestfish-actions.pod:2502
21795 " lvm-canonical-lv-name lvname\n"
21800 #: ../fish/guestfish-actions.pod:2511
21801 msgid "See also L</is-lv>."
21805 #: ../fish/guestfish-actions.pod:2513
21806 msgid "lvm-clear-filter"
21810 #: ../fish/guestfish-actions.pod:2515
21813 " lvm-clear-filter\n"
21818 #: ../fish/guestfish-actions.pod:2517
21820 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21825 #: ../fish/guestfish-actions.pod:2523
21826 msgid "lvm-remove-all"
21830 #: ../fish/guestfish-actions.pod:2525
21833 " lvm-remove-all\n"
21838 #: ../fish/guestfish-actions.pod:2533
21839 msgid "lvm-set-filter"
21843 #: ../fish/guestfish-actions.pod:2535
21846 " lvm-set-filter 'devices ...'\n"
21851 #: ../fish/guestfish-actions.pod:2560
21856 #: ../fish/guestfish-actions.pod:2562
21859 " lvremove device\n"
21864 #: ../fish/guestfish-actions.pod:2570
21869 #: ../fish/guestfish-actions.pod:2572
21872 " lvrename logvol newlogvol\n"
21877 #: ../fish/guestfish-actions.pod:2576
21882 #: ../fish/guestfish-actions.pod:2578
21885 " lvresize device mbytes\n"
21890 #: ../fish/guestfish-actions.pod:2584
21891 msgid "lvresize-free"
21895 #: ../fish/guestfish-actions.pod:2586
21898 " lvresize-free lv percent\n"
21903 #: ../fish/guestfish-actions.pod:2594
21908 #: ../fish/guestfish-actions.pod:2596
21916 #: ../fish/guestfish-actions.pod:2604
21917 msgid "See also L</lvs-full>, L</list-filesystems>."
21921 #: ../fish/guestfish-actions.pod:2606
21926 #: ../fish/guestfish-actions.pod:2608
21934 #: ../fish/guestfish-actions.pod:2613
21939 #: ../fish/guestfish-actions.pod:2615
21947 #: ../fish/guestfish-actions.pod:2619
21952 #: ../fish/guestfish-actions.pod:2621
21955 " lxattrlist path 'names ...'\n"
21960 #: ../fish/guestfish-actions.pod:2637
21962 "This call is intended for programs that want to efficiently list a directory "
21963 "contents without making many round-trips. See also L</lstatlist> for a "
21964 "similarly efficient call for getting standard stats. Very long directory "
21965 "listings might cause the protocol message size to be exceeded, causing this "
21966 "call to fail. The caller must split up such requests into smaller groups of "
21971 #: ../fish/guestfish-actions.pod:2645
21976 #: ../fish/guestfish-actions.pod:2647
21984 #: ../fish/guestfish-actions.pod:2651
21989 #: ../fish/guestfish-actions.pod:2653
21992 " mkdir-mode path mode\n"
21997 #: ../fish/guestfish-actions.pod:2662
21998 msgid "See also L</mkdir>, L</umask>"
22002 #: ../fish/guestfish-actions.pod:2664
22007 #: ../fish/guestfish-actions.pod:2666
22015 #: ../fish/guestfish-actions.pod:2671
22020 #: ../fish/guestfish-actions.pod:2673
22023 " mkdtemp template\n"
22028 #: ../fish/guestfish-actions.pod:2694
22033 #: ../fish/guestfish-actions.pod:2696
22036 " mke2fs-J fstype blocksize device journal\n"
22041 #: ../fish/guestfish-actions.pod:2704
22042 msgid "See also L</mke2journal>."
22046 #: ../fish/guestfish-actions.pod:2706
22051 #: ../fish/guestfish-actions.pod:2708
22054 " mke2fs-JL fstype blocksize device label\n"
22059 #: ../fish/guestfish-actions.pod:2713
22060 msgid "See also L</mke2journal-L>."
22064 #: ../fish/guestfish-actions.pod:2715
22069 #: ../fish/guestfish-actions.pod:2717
22072 " mke2fs-JU fstype blocksize device uuid\n"
22077 #: ../fish/guestfish-actions.pod:2722
22078 msgid "See also L</mke2journal-U>."
22082 #: ../fish/guestfish-actions.pod:2724
22083 msgid "mke2journal"
22087 #: ../fish/guestfish-actions.pod:2726
22090 " mke2journal blocksize device\n"
22095 #: ../fish/guestfish-actions.pod:2733
22096 msgid "mke2journal-L"
22100 #: ../fish/guestfish-actions.pod:2735
22103 " mke2journal-L blocksize label device\n"
22108 #: ../fish/guestfish-actions.pod:2739
22109 msgid "mke2journal-U"
22113 #: ../fish/guestfish-actions.pod:2741
22116 " mke2journal-U blocksize uuid device\n"
22121 #: ../fish/guestfish-actions.pod:2745
22126 #: ../fish/guestfish-actions.pod:2747
22129 " mkfifo mode path\n"
22134 #: ../fish/guestfish-actions.pod:2749
22136 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
22137 "is just a convenient wrapper around L</mknod>."
22141 #: ../fish/guestfish-actions.pod:2755
22146 #: ../fish/guestfish-actions.pod:2757
22149 " mkfs fstype device\n"
22154 #: ../fish/guestfish-actions.pod:2763
22159 #: ../fish/guestfish-actions.pod:2765
22162 " mkfs-b fstype blocksize device\n"
22167 #: ../fish/guestfish-actions.pod:2767
22169 "This call is similar to L</mkfs>, but it allows you to control the block "
22170 "size of the resulting filesystem. Supported block sizes depend on the "
22171 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
22175 #: ../fish/guestfish-actions.pod:2782
22180 #: ../fish/guestfish-actions.pod:2784
22183 " mkfs-opts fstype device [blocksize:..]\n"
22188 #: ../fish/guestfish-actions.pod:2806
22189 msgid "mkmountpoint"
22193 #: ../fish/guestfish-actions.pod:2808
22196 " mkmountpoint exemptpath\n"
22201 #: ../fish/guestfish-actions.pod:2810
22203 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
22204 "to create extra mountpoints before mounting the first filesystem."
22208 #: ../fish/guestfish-actions.pod:2834
22210 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
22211 "unexpected errors if you try to mix these calls. It is safest to manually "
22212 "unmount filesystems and remove mountpoints after use."
22216 #: ../fish/guestfish-actions.pod:2838
22218 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
22219 "for this to work for manual mountpoints, you must ensure that the innermost "
22220 "mountpoints have the longest pathnames, as in the example code above."
22224 #: ../fish/guestfish-actions.pod:2845
22226 "Autosync [see L</set-autosync>, this is set by default on handles] means "
22227 "that L</umount-all> is called when the handle is closed which can also "
22228 "trigger these issues."
22232 #: ../fish/guestfish-actions.pod:2849
22237 #: ../fish/guestfish-actions.pod:2851
22240 " mknod mode devmajor devminor path\n"
22245 #: ../fish/guestfish-actions.pod:2861
22247 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22248 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22249 "regular file). These constants are available in the standard Linux header "
22250 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22251 "wrappers around this command which bitwise OR in the appropriate constant "
22256 #: ../fish/guestfish-actions.pod:2871
22261 #: ../fish/guestfish-actions.pod:2873
22264 " mknod-b mode devmajor devminor path\n"
22269 #: ../fish/guestfish-actions.pod:2875
22271 "This call creates a block device node called C<path> with mode C<mode> and "
22272 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22273 "wrapper around L</mknod>."
22277 #: ../fish/guestfish-actions.pod:2881
22282 #: ../fish/guestfish-actions.pod:2883
22285 " mknod-c mode devmajor devminor path\n"
22290 #: ../fish/guestfish-actions.pod:2885
22292 "This call creates a char device node called C<path> with mode C<mode> and "
22293 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22294 "wrapper around L</mknod>."
22298 #: ../fish/guestfish-actions.pod:2891
22303 #: ../fish/guestfish-actions.pod:2893
22311 #: ../fish/guestfish-actions.pod:2897
22316 #: ../fish/guestfish-actions.pod:2899
22319 " mkswap-L label device\n"
22324 #: ../fish/guestfish-actions.pod:2907
22329 #: ../fish/guestfish-actions.pod:2909
22332 " mkswap-U uuid device\n"
22337 #: ../fish/guestfish-actions.pod:2913
22338 msgid "mkswap-file"
22342 #: ../fish/guestfish-actions.pod:2915
22345 " mkswap-file path\n"
22350 #: ../fish/guestfish-actions.pod:2919
22352 "This command just writes a swap file signature to an existing file. To "
22353 "create the file itself, use something like L</fallocate>."
22357 #: ../fish/guestfish-actions.pod:2922
22362 #: ../fish/guestfish-actions.pod:2924
22365 " modprobe modulename\n"
22370 #: ../fish/guestfish-actions.pod:2931
22375 #: ../fish/guestfish-actions.pod:2933
22378 " mount device mountpoint\n"
22383 #: ../fish/guestfish-actions.pod:2949
22385 "B<Important note:> When you use this call, the filesystem options C<sync> "
22386 "and C<noatime> are set implicitly. This was originally done because we "
22387 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22388 "very large negative performance impact and negligible effect on "
22389 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22390 "code that needs performance, and instead use L</mount-options> (use an empty "
22391 "string for the first parameter if you don't want any options)."
22395 #: ../fish/guestfish-actions.pod:2959
22400 #: ../fish/guestfish-actions.pod:2961
22403 " mount-loop file mountpoint\n"
22408 #: ../fish/guestfish-actions.pod:2967
22409 msgid "mount-options"
22413 #: ../fish/guestfish-actions.pod:2969
22416 " mount-options options device mountpoint\n"
22421 #: ../fish/guestfish-actions.pod:2971
22423 "This is the same as the L</mount> command, but it allows you to set the "
22424 "mount options as for the L<mount(8)> I<-o> flag."
22428 #: ../fish/guestfish-actions.pod:2979
22433 #: ../fish/guestfish-actions.pod:2981
22436 " mount-ro device mountpoint\n"
22441 #: ../fish/guestfish-actions.pod:2983
22443 "This is the same as the L</mount> command, but it mounts the filesystem with "
22444 "the read-only (I<-o ro>) flag."
22448 #: ../fish/guestfish-actions.pod:2986
22453 #: ../fish/guestfish-actions.pod:2988
22456 " mount-vfs options vfstype device mountpoint\n"
22461 #: ../fish/guestfish-actions.pod:2990
22463 "This is the same as the L</mount> command, but it allows you to set both the "
22464 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22468 #: ../fish/guestfish-actions.pod:2994
22469 msgid "mountpoints"
22473 #: ../fish/guestfish-actions.pod:2996
22481 #: ../fish/guestfish-actions.pod:2998
22483 "This call is similar to L</mounts>. That call returns a list of devices. "
22484 "This one returns a hash table (map) of device name to directory where the "
22485 "device is mounted."
22489 #: ../fish/guestfish-actions.pod:3002
22494 #: ../fish/guestfish-actions.pod:3004
22502 #: ../fish/guestfish-actions.pod:3011
22503 msgid "See also: L</mountpoints>"
22507 #: ../fish/guestfish-actions.pod:3013
22512 #: ../fish/guestfish-actions.pod:3015
22520 #: ../fish/guestfish-actions.pod:3020
22521 msgid "ntfs-3g-probe"
22525 #: ../fish/guestfish-actions.pod:3022
22528 " ntfs-3g-probe true|false device\n"
22533 #: ../fish/guestfish-actions.pod:3036
22538 #: ../fish/guestfish-actions.pod:3038
22541 " ntfsresize device\n"
22546 #: ../fish/guestfish-actions.pod:3044
22547 msgid "ntfsresize-size"
22551 #: ../fish/guestfish-actions.pod:3046
22554 " ntfsresize-size device size\n"
22559 #: ../fish/guestfish-actions.pod:3048
22561 "This command is the same as L</ntfsresize> except that it allows you to "
22562 "specify the new size (in bytes) explicitly."
22566 #: ../fish/guestfish-actions.pod:3051
22571 #: ../fish/guestfish-actions.pod:3053
22574 " part-add device prlogex startsect endsect\n"
22579 #: ../fish/guestfish-actions.pod:3055
22581 "This command adds a partition to C<device>. If there is no partition table "
22582 "on the device, call L</part-init> first."
22586 #: ../fish/guestfish-actions.pod:3067
22588 "Creating a partition which covers the whole disk is not so easy. Use "
22589 "L</part-disk> to do that."
22593 #: ../fish/guestfish-actions.pod:3070
22598 #: ../fish/guestfish-actions.pod:3072
22601 " part-del device partnum\n"
22606 #: ../fish/guestfish-actions.pod:3080
22611 #: ../fish/guestfish-actions.pod:3082
22614 " part-disk device parttype\n"
22619 #: ../fish/guestfish-actions.pod:3084
22621 "This command is simply a combination of L</part-init> followed by "
22622 "L</part-add> to create a single primary partition covering the whole disk."
22626 #: ../fish/guestfish-actions.pod:3088
22628 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22629 "possible values are described in L</part-init>."
22633 #: ../fish/guestfish-actions.pod:3094
22634 msgid "part-get-bootable"
22638 #: ../fish/guestfish-actions.pod:3096
22641 " part-get-bootable device partnum\n"
22646 #: ../fish/guestfish-actions.pod:3101
22647 msgid "See also L</part-set-bootable>."
22651 #: ../fish/guestfish-actions.pod:3103
22652 msgid "part-get-mbr-id"
22656 #: ../fish/guestfish-actions.pod:3105
22659 " part-get-mbr-id device partnum\n"
22664 #: ../fish/guestfish-actions.pod:3110 ../fish/guestfish-actions.pod:3248
22666 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22667 "undefined results for other partition table types (see "
22668 "L</part-get-parttype>)."
22672 #: ../fish/guestfish-actions.pod:3114
22673 msgid "part-get-parttype"
22677 #: ../fish/guestfish-actions.pod:3116
22680 " part-get-parttype device\n"
22685 #: ../fish/guestfish-actions.pod:3121
22687 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22688 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22689 "possible, although unusual. See L</part-init> for a full list."
22693 #: ../fish/guestfish-actions.pod:3126
22698 #: ../fish/guestfish-actions.pod:3128
22701 " part-init device parttype\n"
22706 #: ../fish/guestfish-actions.pod:3134
22708 "Initially there are no partitions. Following this, you should call "
22709 "L</part-add> for each partition required."
22713 #: ../fish/guestfish-actions.pod:3197
22718 #: ../fish/guestfish-actions.pod:3199
22721 " part-list device\n"
22726 #: ../fish/guestfish-actions.pod:3214
22728 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22729 "the device's sector size, see L</blockdev-getss>."
22733 #: ../fish/guestfish-actions.pod:3227
22734 msgid "part-set-bootable"
22738 #: ../fish/guestfish-actions.pod:3229
22741 " part-set-bootable device partnum true|false\n"
22746 #: ../fish/guestfish-actions.pod:3238
22747 msgid "part-set-mbr-id"
22751 #: ../fish/guestfish-actions.pod:3240
22754 " part-set-mbr-id device partnum idbyte\n"
22759 #: ../fish/guestfish-actions.pod:3252
22760 msgid "part-set-name"
22764 #: ../fish/guestfish-actions.pod:3254
22767 " part-set-name device partnum name\n"
22772 #: ../fish/guestfish-actions.pod:3262
22773 msgid "part-to-dev"
22777 #: ../fish/guestfish-actions.pod:3264
22780 " part-to-dev partition\n"
22785 #: ../fish/guestfish-actions.pod:3270
22787 "The named partition must exist, for example as a string returned from "
22788 "L</list-partitions>."
22792 #: ../fish/guestfish-actions.pod:3273
22793 msgid "ping-daemon"
22797 #: ../fish/guestfish-actions.pod:3275
22805 #: ../fish/guestfish-actions.pod:3282
22810 #: ../fish/guestfish-actions.pod:3284
22813 " pread path count offset\n"
22818 #: ../fish/guestfish-actions.pod:3292
22819 msgid "See also L</pwrite>, L</pread-device>."
22823 #: ../fish/guestfish-actions.pod:3297
22824 msgid "pread-device"
22828 #: ../fish/guestfish-actions.pod:3299
22831 " pread-device device count offset\n"
22836 #: ../fish/guestfish-actions.pod:3307
22837 msgid "See also L</pread>."
22841 #: ../fish/guestfish-actions.pod:3312
22846 #: ../fish/guestfish-actions.pod:3314
22849 " pvcreate device\n"
22854 #: ../fish/guestfish-actions.pod:3320
22859 #: ../fish/guestfish-actions.pod:3322
22862 " pvremove device\n"
22867 #: ../fish/guestfish-actions.pod:3331
22872 #: ../fish/guestfish-actions.pod:3333
22875 " pvresize device\n"
22880 #: ../fish/guestfish-actions.pod:3338
22881 msgid "pvresize-size"
22885 #: ../fish/guestfish-actions.pod:3340
22888 " pvresize-size device size\n"
22893 #: ../fish/guestfish-actions.pod:3342
22895 "This command is the same as L</pvresize> except that it allows you to "
22896 "specify the new size (in bytes) explicitly."
22900 #: ../fish/guestfish-actions.pod:3345
22905 #: ../fish/guestfish-actions.pod:3347
22913 #: ../fish/guestfish-actions.pod:3355
22914 msgid "See also L</pvs-full>."
22918 #: ../fish/guestfish-actions.pod:3357
22923 #: ../fish/guestfish-actions.pod:3359
22931 #: ../fish/guestfish-actions.pod:3364
22936 #: ../fish/guestfish-actions.pod:3366
22944 #: ../fish/guestfish-actions.pod:3370
22949 #: ../fish/guestfish-actions.pod:3372
22952 " pwrite path content offset\n"
22957 #: ../fish/guestfish-actions.pod:3383
22958 msgid "See also L</pread>, L</pwrite-device>."
22962 #: ../fish/guestfish-actions.pod:3388
22963 msgid "pwrite-device"
22967 #: ../fish/guestfish-actions.pod:3390
22970 " pwrite-device device content offset\n"
22975 #: ../fish/guestfish-actions.pod:3400
22976 msgid "See also L</pwrite>."
22980 #: ../fish/guestfish-actions.pod:3405
22985 #: ../fish/guestfish-actions.pod:3407
22988 " read-file path\n"
22993 #: ../fish/guestfish-actions.pod:3412
22995 "Unlike L</cat>, this function can correctly handle files that contain "
22996 "embedded ASCII NUL characters. However unlike L</download>, this function "
22997 "is limited in the total size of file that can be handled."
23001 #: ../fish/guestfish-actions.pod:3420
23006 #: ../fish/guestfish-actions.pod:3422
23009 " read-lines path\n"
23014 #: ../fish/guestfish-actions.pod:3429
23016 "Note that this function cannot correctly handle binary files (specifically, "
23017 "files containing C<\\0> character which is treated as end of line). For "
23018 "those you need to use the L</read-file> function which has a more complex "
23023 #: ../fish/guestfish-actions.pod:3434
23028 #: ../fish/guestfish-actions.pod:3436
23036 #: ../fish/guestfish-actions.pod:3488
23038 "This function is primarily intended for use by programs. To get a simple "
23039 "list of names, use L</ls>. To get a printable directory for human "
23040 "consumption, use L</ll>."
23044 #: ../fish/guestfish-actions.pod:3492
23049 #: ../fish/guestfish-actions.pod:3494
23057 #: ../fish/guestfish-actions.pod:3498
23058 msgid "readlinklist"
23062 #: ../fish/guestfish-actions.pod:3500
23065 " readlinklist path 'names ...'\n"
23070 #: ../fish/guestfish-actions.pod:3524
23075 #: ../fish/guestfish-actions.pod:3526
23083 #: ../fish/guestfish-actions.pod:3531
23084 msgid "removexattr"
23088 #: ../fish/guestfish-actions.pod:3533
23091 " removexattr xattr path\n"
23096 #: ../fish/guestfish-actions.pod:3538
23097 msgid "See also: L</lremovexattr>, L<attr(5)>."
23101 #: ../fish/guestfish-actions.pod:3540
23106 #: ../fish/guestfish-actions.pod:3542
23109 " resize2fs device\n"
23114 #: ../fish/guestfish-actions.pod:3547
23116 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
23117 "before calling this command. For unknown reasons C<resize2fs> sometimes "
23118 "gives an error about this and sometimes not. In any case, it is always safe "
23119 "to call L</e2fsck-f> before calling this function."
23123 #: ../fish/guestfish-actions.pod:3553
23124 msgid "resize2fs-size"
23128 #: ../fish/guestfish-actions.pod:3555
23131 " resize2fs-size device size\n"
23136 #: ../fish/guestfish-actions.pod:3557
23138 "This command is the same as L</resize2fs> except that it allows you to "
23139 "specify the new size (in bytes) explicitly."
23143 #: ../fish/guestfish-actions.pod:3560
23148 #: ../fish/guestfish-actions.pod:3562
23156 #: ../fish/guestfish-actions.pod:3566
23161 #: ../fish/guestfish-actions.pod:3568
23169 #: ../fish/guestfish-actions.pod:3574
23174 #: ../fish/guestfish-actions.pod:3576
23182 #: ../fish/guestfish-actions.pod:3580
23183 msgid "rmmountpoint"
23187 #: ../fish/guestfish-actions.pod:3582
23190 " rmmountpoint exemptpath\n"
23195 #: ../fish/guestfish-actions.pod:3584
23197 "This calls removes a mountpoint that was previously created with "
23198 "L</mkmountpoint>. See L</mkmountpoint> for full details."
23202 #: ../fish/guestfish-actions.pod:3588
23203 msgid "scrub-device"
23207 #: ../fish/guestfish-actions.pod:3590
23210 " scrub-device device\n"
23215 #: ../fish/guestfish-actions.pod:3601
23220 #: ../fish/guestfish-actions.pod:3603
23223 " scrub-file file\n"
23228 #: ../fish/guestfish-actions.pod:3613
23229 msgid "scrub-freespace"
23233 #: ../fish/guestfish-actions.pod:3615
23236 " scrub-freespace dir\n"
23241 #: ../fish/guestfish-actions.pod:3617
23243 "This command creates the directory C<dir> and then fills it with files until "
23244 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23245 "deletes them. The intention is to scrub any free space on the partition "
23246 "containing C<dir>."
23250 #: ../fish/guestfish-actions.pod:3626
23255 #: ../fish/guestfish-actions.pod:3628
23260 #: ../fish/guestfish-actions.pod:3630
23263 " set-append append\n"
23268 #: ../fish/guestfish-actions.pod:3641
23269 msgid "set-autosync"
23273 #: ../fish/guestfish-actions.pod:3643
23278 #: ../fish/guestfish-actions.pod:3645
23281 " set-autosync true|false\n"
23286 #: ../fish/guestfish-actions.pod:3647
23288 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23289 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23290 "closed (also if the program exits without closing handles)."
23294 #: ../fish/guestfish-actions.pod:3655
23299 #: ../fish/guestfish-actions.pod:3657
23304 #: ../fish/guestfish-actions.pod:3659
23307 " set-direct true|false\n"
23312 #: ../fish/guestfish-actions.pod:3665
23314 "One consequence of this is that log messages aren't caught by the library "
23315 "and handled by L</set-log-message-callback>, but go straight to stdout."
23319 #: ../fish/guestfish-actions.pod:3674
23320 msgid "set-e2label"
23324 #: ../fish/guestfish-actions.pod:3676
23327 " set-e2label device label\n"
23332 #: ../fish/guestfish-actions.pod:3682
23334 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23335 "label on a filesystem."
23339 #: ../fish/guestfish-actions.pod:3685
23344 #: ../fish/guestfish-actions.pod:3687
23347 " set-e2uuid device uuid\n"
23352 #: ../fish/guestfish-actions.pod:3694
23354 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23355 "UUID of a filesystem."
23359 #: ../fish/guestfish-actions.pod:3697
23360 msgid "set-memsize"
23364 #: ../fish/guestfish-actions.pod:3699
23369 #: ../fish/guestfish-actions.pod:3701
23372 " set-memsize memsize\n"
23377 #: ../fish/guestfish-actions.pod:3703
23379 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23380 "This only has any effect if called before L</launch>."
23384 #: ../fish/guestfish-actions.pod:3714
23385 msgid "set-network"
23389 #: ../fish/guestfish-actions.pod:3716
23394 #: ../fish/guestfish-actions.pod:3718
23397 " set-network true|false\n"
23402 #: ../fish/guestfish-actions.pod:3726
23403 msgid "You must call this before calling L</launch>, otherwise it has no effect."
23407 #: ../fish/guestfish-actions.pod:3729
23412 #: ../fish/guestfish-actions.pod:3731
23417 #: ../fish/guestfish-actions.pod:3733
23420 " set-path searchpath\n"
23425 #: ../fish/guestfish-actions.pod:3742
23430 #: ../fish/guestfish-actions.pod:3744
23435 #: ../fish/guestfish-actions.pod:3746
23443 #: ../fish/guestfish-actions.pod:3766
23444 msgid "set-recovery-proc"
23448 #: ../fish/guestfish-actions.pod:3768
23449 msgid "recovery-proc"
23453 #: ../fish/guestfish-actions.pod:3770
23456 " set-recovery-proc true|false\n"
23461 #: ../fish/guestfish-actions.pod:3772
23463 "If this is called with the parameter C<false> then L</launch> does not "
23464 "create a recovery process. The purpose of the recovery process is to stop "
23465 "runaway qemu processes in the case where the main program aborts abruptly."
23469 #: ../fish/guestfish-actions.pod:3777
23471 "This only has any effect if called before L</launch>, and the default is "
23476 #: ../fish/guestfish-actions.pod:3786
23477 msgid "set-selinux"
23481 #: ../fish/guestfish-actions.pod:3788
23486 #: ../fish/guestfish-actions.pod:3790
23489 " set-selinux true|false\n"
23494 #: ../fish/guestfish-actions.pod:3801
23499 #: ../fish/guestfish-actions.pod:3803
23504 #: ../fish/guestfish-actions.pod:3805
23507 " set-trace true|false\n"
23512 #: ../fish/guestfish-actions.pod:3821
23513 msgid "set-verbose"
23517 #: ../fish/guestfish-actions.pod:3823
23522 #: ../fish/guestfish-actions.pod:3825
23525 " set-verbose true|false\n"
23530 #: ../fish/guestfish-actions.pod:3832
23535 #: ../fish/guestfish-actions.pod:3834
23538 " setcon context\n"
23543 #: ../fish/guestfish-actions.pod:3841
23548 #: ../fish/guestfish-actions.pod:3843
23551 " setxattr xattr val vallen path\n"
23556 #: ../fish/guestfish-actions.pod:3849
23557 msgid "See also: L</lsetxattr>, L<attr(5)>."
23561 #: ../fish/guestfish-actions.pod:3851
23566 #: ../fish/guestfish-actions.pod:3853
23569 " sfdisk device cyls heads sectors 'lines ...'\n"
23574 #: ../fish/guestfish-actions.pod:3875
23575 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23579 #: ../fish/guestfish-actions.pod:3881
23584 #: ../fish/guestfish-actions.pod:3883
23587 " sfdiskM device 'lines ...'\n"
23592 #: ../fish/guestfish-actions.pod:3885
23594 "This is a simplified interface to the L</sfdisk> command, where partition "
23595 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23596 "you don't need to specify the cyls, heads and sectors parameters which were "
23597 "rarely if ever used anyway."
23601 #: ../fish/guestfish-actions.pod:3891
23602 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23606 #: ../fish/guestfish-actions.pod:3897
23611 #: ../fish/guestfish-actions.pod:3899
23614 " sfdisk-N device partnum cyls heads sectors line\n"
23619 #: ../fish/guestfish-actions.pod:3904
23621 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23622 "cyls/heads/sectors parameters."
23626 #: ../fish/guestfish-actions.pod:3907
23627 msgid "See also: L</part-add>"
23631 #: ../fish/guestfish-actions.pod:3912
23632 msgid "sfdisk-disk-geometry"
23636 #: ../fish/guestfish-actions.pod:3914
23639 " sfdisk-disk-geometry device\n"
23644 #: ../fish/guestfish-actions.pod:3916
23646 "This displays the disk geometry of C<device> read from the partition table. "
23647 "Especially in the case where the underlying block device has been resized, "
23648 "this can be different from the kernel's idea of the geometry (see "
23649 "L</sfdisk-kernel-geometry>)."
23653 #: ../fish/guestfish-actions.pod:3924
23654 msgid "sfdisk-kernel-geometry"
23658 #: ../fish/guestfish-actions.pod:3926
23661 " sfdisk-kernel-geometry device\n"
23666 #: ../fish/guestfish-actions.pod:3933
23671 #: ../fish/guestfish-actions.pod:3935
23674 " sfdisk-l device\n"
23679 #: ../fish/guestfish-actions.pod:3941
23680 msgid "See also: L</part-list>"
23684 #: ../fish/guestfish-actions.pod:3943
23689 #: ../fish/guestfish-actions.pod:3945
23697 #: ../fish/guestfish-actions.pod:3950
23698 msgid "This is like L</command>, but passes the command to:"
23702 #: ../fish/guestfish-actions.pod:3958
23703 msgid "All the provisos about L</command> apply to this call."
23707 #: ../fish/guestfish-actions.pod:3960
23712 #: ../fish/guestfish-actions.pod:3962
23715 " sh-lines command\n"
23720 #: ../fish/guestfish-actions.pod:3964
23721 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23725 #: ../fish/guestfish-actions.pod:3967
23726 msgid "See also: L</command-lines>"
23730 #: ../fish/guestfish-actions.pod:3969
23735 #: ../fish/guestfish-actions.pod:3971
23743 #: ../fish/guestfish-actions.pod:3975
23748 #: ../fish/guestfish-actions.pod:3977
23756 #: ../fish/guestfish-actions.pod:3983
23761 #: ../fish/guestfish-actions.pod:3985
23769 #: ../fish/guestfish-actions.pod:3993
23774 #: ../fish/guestfish-actions.pod:3995
23782 #: ../fish/guestfish-actions.pod:4003
23787 #: ../fish/guestfish-actions.pod:4005
23790 " strings-e encoding path\n"
23795 #: ../fish/guestfish-actions.pod:4007
23797 "This is like the L</strings> command, but allows you to specify the encoding "
23798 "of strings that are looked for in the source file C<path>."
23802 #: ../fish/guestfish-actions.pod:4017
23804 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23805 "ISO-8859-X (this is what L</strings> uses)."
23809 #: ../fish/guestfish-actions.pod:4049
23810 msgid "swapoff-device"
23814 #: ../fish/guestfish-actions.pod:4051
23817 " swapoff-device device\n"
23822 #: ../fish/guestfish-actions.pod:4053
23824 "This command disables the libguestfs appliance swap device or partition "
23825 "named C<device>. See L</swapon-device>."
23829 #: ../fish/guestfish-actions.pod:4057
23830 msgid "swapoff-file"
23834 #: ../fish/guestfish-actions.pod:4059
23837 " swapoff-file file\n"
23842 #: ../fish/guestfish-actions.pod:4063
23843 msgid "swapoff-label"
23847 #: ../fish/guestfish-actions.pod:4065
23850 " swapoff-label label\n"
23855 #: ../fish/guestfish-actions.pod:4070
23856 msgid "swapoff-uuid"
23860 #: ../fish/guestfish-actions.pod:4072
23863 " swapoff-uuid uuid\n"
23868 #: ../fish/guestfish-actions.pod:4077
23869 msgid "swapon-device"
23873 #: ../fish/guestfish-actions.pod:4079
23876 " swapon-device device\n"
23881 #: ../fish/guestfish-actions.pod:4081
23883 "This command enables the libguestfs appliance to use the swap device or "
23884 "partition named C<device>. The increased memory is made available for all "
23885 "commands, for example those run using L</command> or L</sh>."
23889 #: ../fish/guestfish-actions.pod:4093
23890 msgid "swapon-file"
23894 #: ../fish/guestfish-actions.pod:4095
23897 " swapon-file file\n"
23902 #: ../fish/guestfish-actions.pod:4097
23903 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
23907 #: ../fish/guestfish-actions.pod:4100
23908 msgid "swapon-label"
23912 #: ../fish/guestfish-actions.pod:4102
23915 " swapon-label label\n"
23920 #: ../fish/guestfish-actions.pod:4104
23922 "This command enables swap to a labeled swap partition. See "
23923 "L</swapon-device> for other notes."
23927 #: ../fish/guestfish-actions.pod:4107
23928 msgid "swapon-uuid"
23932 #: ../fish/guestfish-actions.pod:4109
23935 " swapon-uuid uuid\n"
23940 #: ../fish/guestfish-actions.pod:4111
23942 "This command enables swap to a swap partition with the given UUID. See "
23943 "L</swapon-device> for other notes."
23947 #: ../fish/guestfish-actions.pod:4114
23952 #: ../fish/guestfish-actions.pod:4116
23960 #: ../fish/guestfish-actions.pod:4124
23965 #: ../fish/guestfish-actions.pod:4126
23973 #: ../fish/guestfish-actions.pod:4134
23978 #: ../fish/guestfish-actions.pod:4136
23981 " tail-n nrlines path\n"
23986 #: ../fish/guestfish-actions.pod:4149
23991 #: ../fish/guestfish-actions.pod:4151
23994 " tar-in (tarfile|-) directory\n"
23999 #: ../fish/guestfish-actions.pod:4156
24000 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
24004 #: ../fish/guestfish-actions.pod:4161
24009 #: ../fish/guestfish-actions.pod:4163
24012 " tar-out directory (tarfile|-)\n"
24017 #: ../fish/guestfish-actions.pod:4168
24018 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
24022 #: ../fish/guestfish-actions.pod:4173
24027 #: ../fish/guestfish-actions.pod:4175
24030 " tgz-in (tarball|-) directory\n"
24035 #: ../fish/guestfish-actions.pod:4180
24036 msgid "To upload an uncompressed tarball, use L</tar-in>."
24040 #: ../fish/guestfish-actions.pod:4184
24045 #: ../fish/guestfish-actions.pod:4186
24048 " tgz-out directory (tarball|-)\n"
24053 #: ../fish/guestfish-actions.pod:4191
24054 msgid "To download an uncompressed tarball, use L</tar-out>."
24058 #: ../fish/guestfish-actions.pod:4195
24063 #: ../fish/guestfish-actions.pod:4197
24071 #: ../fish/guestfish-actions.pod:4206
24076 #: ../fish/guestfish-actions.pod:4208
24084 #: ../fish/guestfish-actions.pod:4213
24085 msgid "truncate-size"
24089 #: ../fish/guestfish-actions.pod:4215
24092 " truncate-size path size\n"
24097 #: ../fish/guestfish-actions.pod:4220
24099 "If the current file size is less than C<size> then the file is extended to "
24100 "the required size with zero bytes. This creates a sparse file (ie. disk "
24101 "blocks are not allocated for the file until you write to it). To create a "
24102 "non-sparse file of zeroes, use L</fallocate64> instead."
24106 #: ../fish/guestfish-actions.pod:4226
24111 #: ../fish/guestfish-actions.pod:4228
24114 " tune2fs-l device\n"
24119 #: ../fish/guestfish-actions.pod:4238
24124 #: ../fish/guestfish-actions.pod:4240
24127 " txz-in (tarball|-) directory\n"
24132 #: ../fish/guestfish-actions.pod:4247
24137 #: ../fish/guestfish-actions.pod:4249
24140 " txz-out directory (tarball|-)\n"
24145 #: ../fish/guestfish-actions.pod:4256
24150 #: ../fish/guestfish-actions.pod:4258
24158 #: ../fish/guestfish-actions.pod:4272
24159 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
24163 #: ../fish/guestfish-actions.pod:4277
24168 #: ../fish/guestfish-actions.pod:4279
24173 #: ../fish/guestfish-actions.pod:4281
24176 " umount pathordevice\n"
24181 #: ../fish/guestfish-actions.pod:4287
24186 #: ../fish/guestfish-actions.pod:4289
24187 msgid "unmount-all"
24191 #: ../fish/guestfish-actions.pod:4291
24199 #: ../fish/guestfish-actions.pod:4297
24204 #: ../fish/guestfish-actions.pod:4299
24207 " upload (filename|-) remotefilename\n"
24212 #: ../fish/guestfish-actions.pod:4306
24213 msgid "See also L</download>."
24217 #: ../fish/guestfish-actions.pod:4310
24218 msgid "upload-offset"
24222 #: ../fish/guestfish-actions.pod:4312
24225 " upload-offset (filename|-) remotefilename offset\n"
24230 #: ../fish/guestfish-actions.pod:4324
24232 "Note that there is no limit on the amount of data that can be uploaded with "
24233 "this call, unlike with L</pwrite>, and this call always writes the full "
24234 "amount unless an error occurs."
24238 #: ../fish/guestfish-actions.pod:4329
24239 msgid "See also L</upload>, L</pwrite>."
24243 #: ../fish/guestfish-actions.pod:4333
24248 #: ../fish/guestfish-actions.pod:4335
24251 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24256 #: ../fish/guestfish-actions.pod:4354
24261 #: ../fish/guestfish-actions.pod:4356
24269 #: ../fish/guestfish-actions.pod:4383
24271 "I<Note:> Don't use this call to test for availability of features. In "
24272 "enterprise distributions we backport features from later versions into "
24273 "earlier versions, making this an unreliable way to test for features. Use "
24274 "L</available> instead."
24278 #: ../fish/guestfish-actions.pod:4389
24283 #: ../fish/guestfish-actions.pod:4391
24286 " vfs-label device\n"
24291 #: ../fish/guestfish-actions.pod:4398
24292 msgid "To find a filesystem from the label, use L</findfs-label>."
24296 #: ../fish/guestfish-actions.pod:4400
24301 #: ../fish/guestfish-actions.pod:4402
24304 " vfs-type device\n"
24309 #: ../fish/guestfish-actions.pod:4412
24314 #: ../fish/guestfish-actions.pod:4414
24317 " vfs-uuid device\n"
24322 #: ../fish/guestfish-actions.pod:4421
24323 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24327 #: ../fish/guestfish-actions.pod:4423
24328 msgid "vg-activate"
24332 #: ../fish/guestfish-actions.pod:4425
24335 " vg-activate true|false 'volgroups ...'\n"
24340 #: ../fish/guestfish-actions.pod:4438
24341 msgid "vg-activate-all"
24345 #: ../fish/guestfish-actions.pod:4440
24348 " vg-activate-all true|false\n"
24353 #: ../fish/guestfish-actions.pod:4450
24358 #: ../fish/guestfish-actions.pod:4452
24361 " vgcreate volgroup 'physvols ...'\n"
24366 #: ../fish/guestfish-actions.pod:4457
24371 #: ../fish/guestfish-actions.pod:4459
24374 " vglvuuids vgname\n"
24379 #: ../fish/guestfish-actions.pod:4464
24381 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24382 "logical volumes and volume groups."
24386 #: ../fish/guestfish-actions.pod:4467
24387 msgid "See also L</vgpvuuids>."
24391 #: ../fish/guestfish-actions.pod:4469
24396 #: ../fish/guestfish-actions.pod:4471
24399 " vgpvuuids vgname\n"
24404 #: ../fish/guestfish-actions.pod:4476
24406 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24407 "physical volumes and volume groups."
24411 #: ../fish/guestfish-actions.pod:4479
24412 msgid "See also L</vglvuuids>."
24416 #: ../fish/guestfish-actions.pod:4481
24421 #: ../fish/guestfish-actions.pod:4483
24424 " vgremove vgname\n"
24429 #: ../fish/guestfish-actions.pod:4490
24434 #: ../fish/guestfish-actions.pod:4492
24437 " vgrename volgroup newvolgroup\n"
24442 #: ../fish/guestfish-actions.pod:4496
24447 #: ../fish/guestfish-actions.pod:4498
24455 #: ../fish/guestfish-actions.pod:4506
24456 msgid "See also L</vgs-full>."
24460 #: ../fish/guestfish-actions.pod:4508
24465 #: ../fish/guestfish-actions.pod:4510
24473 #: ../fish/guestfish-actions.pod:4515
24478 #: ../fish/guestfish-actions.pod:4517
24486 #: ../fish/guestfish-actions.pod:4522
24491 #: ../fish/guestfish-actions.pod:4524
24499 #: ../fish/guestfish-actions.pod:4528
24504 #: ../fish/guestfish-actions.pod:4530
24512 #: ../fish/guestfish-actions.pod:4535
24517 #: ../fish/guestfish-actions.pod:4537
24525 #: ../fish/guestfish-actions.pod:4542
24530 #: ../fish/guestfish-actions.pod:4544
24538 #: ../fish/guestfish-actions.pod:4549
24543 #: ../fish/guestfish-actions.pod:4551
24546 " write path content\n"
24551 #: ../fish/guestfish-actions.pod:4559
24556 #: ../fish/guestfish-actions.pod:4561
24559 " write-file path content size\n"
24564 #: ../fish/guestfish-actions.pod:4584
24569 #: ../fish/guestfish-actions.pod:4586
24572 " zegrep regex path\n"
24577 #: ../fish/guestfish-actions.pod:4594
24582 #: ../fish/guestfish-actions.pod:4596
24585 " zegrepi regex path\n"
24590 #: ../fish/guestfish-actions.pod:4604
24595 #: ../fish/guestfish-actions.pod:4606
24603 #: ../fish/guestfish-actions.pod:4614
24604 msgid "See also: L</zero-device>, L</scrub-device>."
24608 #: ../fish/guestfish-actions.pod:4616
24609 msgid "zero-device"
24613 #: ../fish/guestfish-actions.pod:4618
24616 " zero-device device\n"
24621 #: ../fish/guestfish-actions.pod:4620
24623 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24624 "which just zeroes the first few blocks of a device."
24628 #: ../fish/guestfish-actions.pod:4627
24633 #: ../fish/guestfish-actions.pod:4629
24636 " zerofree device\n"
24641 #: ../fish/guestfish-actions.pod:4642
24646 #: ../fish/guestfish-actions.pod:4644
24649 " zfgrep pattern path\n"
24654 #: ../fish/guestfish-actions.pod:4652
24659 #: ../fish/guestfish-actions.pod:4654
24662 " zfgrepi pattern path\n"
24667 #: ../fish/guestfish-actions.pod:4662
24672 #: ../fish/guestfish-actions.pod:4664
24675 " zfile meth path\n"
24680 #: ../fish/guestfish-actions.pod:4671
24681 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
24685 #: ../fish/guestfish-actions.pod:4681
24690 #: ../fish/guestfish-actions.pod:4683
24693 " zgrep regex path\n"
24698 #: ../fish/guestfish-actions.pod:4691
24703 #: ../fish/guestfish-actions.pod:4693
24706 " zgrepi regex path\n"
24711 #: ../fish/guestfish-commands.pod:1
24716 #: ../fish/guestfish-commands.pod:3
24721 #: ../fish/guestfish-commands.pod:5
24724 " alloc filename size\n"
24729 #: ../fish/guestfish-commands.pod:7
24731 "This creates an empty (zeroed) file of the given size, and then adds so it "
24732 "can be further examined."
24736 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24737 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24741 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24742 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24746 #: ../fish/guestfish-commands.pod:14
24748 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24749 "image, see L</PREPARED DISK IMAGES>."
24753 #: ../fish/guestfish-commands.pod:17
24758 #: ../fish/guestfish-commands.pod:19
24761 " copy-in local [local ...] /remotedir\n"
24766 #: ../fish/guestfish-commands.pod:21
24768 "C<copy-in> copies local files or directories recursively into the disk "
24769 "image, placing them in the directory called C</remotedir> (which must "
24770 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24771 "other commands as necessary."
24775 #: ../fish/guestfish-commands.pod:26
24777 "Multiple local files and directories can be specified, but the last "
24778 "parameter must always be a remote directory. Wildcards cannot be used."
24782 #: ../fish/guestfish-commands.pod:30
24787 #: ../fish/guestfish-commands.pod:32
24790 " copy-out remote [remote ...] localdir\n"
24795 #: ../fish/guestfish-commands.pod:34
24797 "C<copy-out> copies remote files or directories recursively out of the disk "
24798 "image, placing them on the host disk in a local directory called C<localdir> "
24799 "(which must exist). This guestfish meta-command turns into a sequence of "
24800 "L</download>, L</tar-out> and other commands as necessary."
24804 #: ../fish/guestfish-commands.pod:40
24806 "Multiple remote files and directories can be specified, but the last "
24807 "parameter must always be a local directory. To download to the current "
24808 "directory, use C<.> as in:"
24812 #: ../fish/guestfish-commands.pod:44
24815 " copy-out /home .\n"
24820 #: ../fish/guestfish-commands.pod:46
24822 "Wildcards cannot be used in the ordinary command, but you can use them with "
24823 "the help of L</glob> like this:"
24827 #: ../fish/guestfish-commands.pod:49
24830 " glob copy-out /home/* .\n"
24835 #: ../fish/guestfish-commands.pod:51
24840 #: ../fish/guestfish-commands.pod:53
24843 " echo [params ...]\n"
24848 #: ../fish/guestfish-commands.pod:55
24849 msgid "This echos the parameters to the terminal."
24853 #: ../fish/guestfish-commands.pod:57
24858 #: ../fish/guestfish-commands.pod:59
24863 #: ../fish/guestfish-commands.pod:61
24868 #: ../fish/guestfish-commands.pod:63
24876 #: ../fish/guestfish-commands.pod:65
24878 "This is used to edit a file. It downloads the file, edits it locally using "
24879 "your editor, then uploads the result."
24883 #: ../fish/guestfish-commands.pod:68
24885 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24886 "or C<emacs> you will get those corresponding editors."
24890 #: ../fish/guestfish-commands.pod:72
24895 #: ../fish/guestfish-commands.pod:74
24898 " glob command args...\n"
24903 #: ../fish/guestfish-commands.pod:76
24905 "Expand wildcards in any paths in the args list, and run C<command> "
24906 "repeatedly on each matching path."
24910 #: ../fish/guestfish-commands.pod:79
24911 msgid "See L</WILDCARDS AND GLOBBING>."
24915 #: ../fish/guestfish-commands.pod:81
24920 #: ../fish/guestfish-commands.pod:83
24923 " hexedit <filename|device>\n"
24924 " hexedit <filename|device> <max>\n"
24925 " hexedit <filename|device> <start> <max>\n"
24930 #: ../fish/guestfish-commands.pod:87
24932 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24937 #: ../fish/guestfish-commands.pod:90
24939 "This command works by downloading potentially the whole file or device, "
24940 "editing it locally, then uploading it. If the file or device is large, you "
24941 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24942 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24943 "usual modifiers allowed such as C<1M> (1 megabyte)."
24947 #: ../fish/guestfish-commands.pod:97
24948 msgid "For example to edit the first few sectors of a disk you might do:"
24952 #: ../fish/guestfish-commands.pod:100
24955 " hexedit /dev/sda 1M\n"
24960 #: ../fish/guestfish-commands.pod:102
24962 "which would allow you to edit anywhere within the first megabyte of the "
24967 #: ../fish/guestfish-commands.pod:105
24968 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24972 #: ../fish/guestfish-commands.pod:107
24975 " hexedit /dev/sda1 0x400 0x400\n"
24980 #: ../fish/guestfish-commands.pod:109
24981 msgid "(assuming the superblock is in the standard location)."
24985 #: ../fish/guestfish-commands.pod:111
24987 "This command requires the external L<hexedit(1)> program. You can specify "
24988 "another program to use by setting the C<HEXEDITOR> environment variable."
24992 #: ../fish/guestfish-commands.pod:115
24993 msgid "See also L</hexdump>."
24997 #: ../fish/guestfish-commands.pod:117
25002 #: ../fish/guestfish-commands.pod:119
25010 #: ../fish/guestfish-commands.pod:121
25011 msgid "Change the local directory, ie. the current directory of guestfish itself."
25015 #: ../fish/guestfish-commands.pod:124
25016 msgid "Note that C<!cd> won't do what you might expect."
25020 #: ../fish/guestfish-commands.pod:126
25025 #: ../fish/guestfish-commands.pod:128
25030 #: ../fish/guestfish-commands.pod:130
25038 #: ../fish/guestfish-commands.pod:132
25039 msgid "Opens the manual page for guestfish."
25043 #: ../fish/guestfish-commands.pod:134
25048 #: ../fish/guestfish-commands.pod:136
25053 #: ../fish/guestfish-commands.pod:138
25061 #: ../fish/guestfish-commands.pod:140
25069 #: ../fish/guestfish-commands.pod:142
25070 msgid "This is used to view a file."
25074 #: ../fish/guestfish-commands.pod:144
25076 "The default viewer is C<$PAGER>. However if you use the alternate command "
25077 "C<less> you will get the C<less> command specifically."
25081 #: ../fish/guestfish-commands.pod:147
25086 #: ../fish/guestfish-commands.pod:149
25094 #: ../fish/guestfish-commands.pod:151
25096 "Close and reopen the libguestfs handle. It is not necessary to use this "
25097 "normally, because the handle is closed properly when guestfish exits. "
25098 "However this is occasionally useful for testing."
25102 #: ../fish/guestfish-commands.pod:155
25107 #: ../fish/guestfish-commands.pod:157
25110 " sparse filename size\n"
25115 #: ../fish/guestfish-commands.pod:159
25117 "This creates an empty sparse file of the given size, and then adds so it can "
25118 "be further examined."
25122 #: ../fish/guestfish-commands.pod:162
25124 "In all respects it works the same as the L</alloc> command, except that the "
25125 "image file is allocated sparsely, which means that disk blocks are not "
25126 "assigned to the file until they are needed. Sparse disk files only use "
25127 "space when written to, but they are slower and there is a danger you could "
25128 "run out of real disk space during a write operation."
25132 #: ../fish/guestfish-commands.pod:172
25137 #: ../fish/guestfish-commands.pod:174
25145 #: ../fish/guestfish-commands.pod:176
25147 "This command returns a list of the optional groups known to the daemon, and "
25148 "indicates which ones are supported by this build of the libguestfs "
25153 #: ../fish/guestfish-commands.pod:180
25154 msgid "See also L<guestfs(3)/AVAILABILITY>."
25158 #: ../fish/guestfish-commands.pod:182
25163 #: ../fish/guestfish-commands.pod:184
25166 " time command args...\n"
25171 #: ../fish/guestfish-commands.pod:186
25173 "Run the command as usual, but print the elapsed time afterwards. This can "
25174 "be useful for benchmarking operations."
25178 #: ../test-tool/libguestfs-test-tool.pod:5
25179 msgid "libguestfs-test-tool - End user tests for libguestfs"
25183 #: ../test-tool/libguestfs-test-tool.pod:9
25186 " libguestfs-test-tool [--options]\n"
25191 #: ../test-tool/libguestfs-test-tool.pod:13
25193 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
25194 "and developers, to allow them to check basic libguestfs functionality is "
25195 "working. This is needed because libguestfs occasionally breaks for reasons "
25196 "beyond our control: usually because of changes in the underlying qemu or "
25197 "kernel packages, or the host environment."
25201 #: ../test-tool/libguestfs-test-tool.pod:20
25202 msgid "If you suspect a problem in libguestfs, then just run:"
25206 #: ../test-tool/libguestfs-test-tool.pod:22
25209 " libguestfs-test-tool\n"
25214 #: ../test-tool/libguestfs-test-tool.pod:24
25215 msgid "It will print lots of diagnostic messages."
25219 #: ../test-tool/libguestfs-test-tool.pod:26
25220 msgid "If it runs to completion successfully, you will see this near the end:"
25224 #: ../test-tool/libguestfs-test-tool.pod:28
25227 " ===== TEST FINISHED OK =====\n"
25232 #: ../test-tool/libguestfs-test-tool.pod:30
25233 msgid "and the test tool will exit with code 0."
25237 #: ../test-tool/libguestfs-test-tool.pod:32
25239 "If it fails (and/or exits with non-zero error code), please paste the "
25240 "B<complete, unedited> output of the test tool into a bug report. More "
25241 "information about reporting bugs can be found on the "
25242 "L<http://libguestfs.org/> website."
25246 #: ../test-tool/libguestfs-test-tool.pod:41
25251 #: ../test-tool/libguestfs-test-tool.pod:43
25252 msgid "Display short usage information and exit."
25256 #: ../test-tool/libguestfs-test-tool.pod:45
25257 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25261 #: ../test-tool/libguestfs-test-tool.pod:47
25263 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25264 "normally look in the C<$libexec> directory that was configured when the tool "
25269 #: ../test-tool/libguestfs-test-tool.pod:51
25270 msgid "I<--qemu qemu_binary>"
25274 #: ../test-tool/libguestfs-test-tool.pod:53
25276 "If you have downloaded another qemu binary, point this option at the full "
25277 "path of the binary to try it."
25281 #: ../test-tool/libguestfs-test-tool.pod:56
25282 msgid "I<--qemudir qemu_source_dir>"
25286 #: ../test-tool/libguestfs-test-tool.pod:58
25288 "If you have compiled qemu from source, point this option at the source "
25289 "directory to try it."
25293 #: ../test-tool/libguestfs-test-tool.pod:61
25294 msgid "I<--timeout N>"
25298 #: ../test-tool/libguestfs-test-tool.pod:63
25300 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25301 "does not usually need to be adjusted unless your machine is very slow."
25305 #: ../test-tool/libguestfs-test-tool.pod:69
25306 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25310 #: ../test-tool/libguestfs-test-tool.pod:71
25312 "If you have compiled another version of qemu from source and would like to "
25313 "try that, then you can use the I<--qemudir> option to point to the qemu "
25314 "source directory."
25318 #: ../test-tool/libguestfs-test-tool.pod:75
25320 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25321 "option to point to the binary."
25325 #: ../test-tool/libguestfs-test-tool.pod:78
25327 "When using an alternate qemu with libguestfs, usually you would need to "
25328 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
25329 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
25330 "when you use either of the I<--qemudir> or I<--qemu> options."
25334 #: ../test-tool/libguestfs-test-tool.pod:85
25336 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25337 "I<1> if there was an error."
25341 #: ../test-tool/libguestfs-test-tool.pod:92
25342 msgid "/usr/libexec/libguestfs-test-tool-helper"
25346 #: ../test-tool/libguestfs-test-tool.pod:94
25348 "This helper program is run inside the appliance and provides additional "
25353 #: ../test-tool/libguestfs-test-tool.pod:97
25354 msgid "/usr/bin/mkisofs"
25358 #: ../test-tool/libguestfs-test-tool.pod:99
25360 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25361 "which is used as part of the tests."
25365 #: ../test-tool/libguestfs-test-tool.pod:106
25367 "For the full list of environment variables which may affect libguestfs, "
25368 "please see the L<guestfs(3)> manual page."
25372 #: ../test-tool/libguestfs-test-tool.pod:111
25373 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25377 #: ../test-tool/libguestfs-test-tool.pod:121
25378 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25382 #: ../fuse/guestmount.pod:5
25383 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25387 #: ../fuse/guestmount.pod:9
25390 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25395 #: ../fuse/guestmount.pod:11
25398 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25403 #: ../fuse/guestmount.pod:13
25406 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25411 #: ../fuse/guestmount.pod:17
25413 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25414 "machines. If you do this, you risk disk corruption in the VM."
25418 #: ../fuse/guestmount.pod:22
25420 "The guestmount program can be used to mount virtual machine filesystems and "
25421 "other disk images on the host. It uses libguestfs for access to the guest "
25422 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25423 "a mountable device."
25427 #: ../fuse/guestmount.pod:27
25429 "Along with other options, you have to give at least one device (I<-a> "
25430 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25431 "option) or use the I<-i> inspection option. How this works is better "
25432 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25437 #: ../fuse/guestmount.pod:33
25439 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25440 "by you, and the filesystem will not be visible to any other users unless you "
25441 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25442 "the filesystem, use the C<fusermount -u> command."
25446 #: ../fuse/guestmount.pod:41
25448 "For a typical Windows guest which has its main filesystem on the first "
25453 #: ../fuse/guestmount.pod:44
25456 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25461 #: ../fuse/guestmount.pod:46
25463 "For a typical Linux guest which has a /boot filesystem on the first "
25464 "partition, and the root filesystem on a logical volume:"
25468 #: ../fuse/guestmount.pod:49
25471 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25476 #: ../fuse/guestmount.pod:51
25477 msgid "To get libguestfs to detect guest mountpoints for you:"
25481 #: ../fuse/guestmount.pod:53
25484 " guestmount -a guest.img -i --ro /mnt\n"
25489 #: ../fuse/guestmount.pod:55
25490 msgid "For a libvirt guest called \"Guest\" you could do:"
25494 #: ../fuse/guestmount.pod:57
25497 " guestmount -d Guest -i --ro /mnt\n"
25502 #: ../fuse/guestmount.pod:59
25504 "If you don't know what filesystems are contained in a guest or disk image, "
25505 "use L<virt-filesystems(1)> first:"
25509 #: ../fuse/guestmount.pod:62
25512 " virt-filesystems MyGuest\n"
25517 #: ../fuse/guestmount.pod:64
25519 "If you want to trace the libguestfs calls but without excessive debugging "
25520 "information, we recommend:"
25524 #: ../fuse/guestmount.pod:67
25527 " guestmount [...] --trace /mnt\n"
25532 #: ../fuse/guestmount.pod:69
25533 msgid "If you want to debug the program, we recommend:"
25537 #: ../fuse/guestmount.pod:71
25540 " guestmount [...] --trace --verbose /mnt\n"
25545 #: ../fuse/guestmount.pod:77
25546 msgid "B<-a image> | B<--add image>"
25550 #: ../fuse/guestmount.pod:79
25551 msgid "Add a block device or virtual machine image."
25555 #: ../fuse/guestmount.pod:84
25556 msgid "B<-c URI> | B<--connect URI>"
25560 #: ../fuse/guestmount.pod:90
25561 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
25565 #: ../fuse/guestmount.pod:96
25566 msgid "B<--dir-cache-timeout N>"
25570 #: ../fuse/guestmount.pod:98
25572 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25573 "seconds. The readdir cache [actually, there are several semi-independent "
25574 "caches] is populated after a readdir(2) call with the stat and extended "
25575 "attributes of the files in the directory, in anticipation that they will be "
25576 "requested soon after."
25580 #: ../fuse/guestmount.pod:104
25582 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25583 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25584 "requests, only cache existing ones."
25588 #: ../fuse/guestmount.pod:115
25589 msgid "B<--format=raw|qcow2|..> | B<--format>"
25593 #: ../fuse/guestmount.pod:122
25595 "If you have untrusted raw-format guest disk images, you should use this "
25596 "option to specify the disk format. This avoids a possible security problem "
25597 "with malicious guests (CVE-2010-3851). See also "
25598 "L<guestfs(3)/guestfs_add_drive_opts>."
25602 #: ../fuse/guestmount.pod:127
25603 msgid "B<--fuse-help>"
25607 #: ../fuse/guestmount.pod:129
25608 msgid "Display help on special FUSE options (see I<-o> below)."
25612 #: ../fuse/guestmount.pod:133
25613 msgid "Display brief help and exit."
25617 #: ../fuse/guestmount.pod:135
25618 msgid "B<-i> | B<--inspector>"
25622 #: ../fuse/guestmount.pod:146
25623 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25627 #: ../fuse/guestmount.pod:148
25629 "Mount the named partition or logical volume on the given mountpoint B<in the "
25630 "guest> (this has nothing to do with mountpoints in the host)."
25634 #: ../fuse/guestmount.pod:151
25636 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25637 "something on C</>."
25641 #: ../fuse/guestmount.pod:154
25642 msgid "B<-n> | B<--no-sync>"
25646 #: ../fuse/guestmount.pod:156
25648 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25649 "unmounted. If you specify this option, then we don't attempt to sync the "
25650 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25654 #: ../fuse/guestmount.pod:161
25655 msgid "B<-o option> | B<--option option>"
25659 #: ../fuse/guestmount.pod:163
25660 msgid "Pass extra options to FUSE."
25664 #: ../fuse/guestmount.pod:165
25666 "To get a list of all the extra options supported by FUSE, use the command "
25667 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25668 "of them are a good idea."
25672 #: ../fuse/guestmount.pod:169
25675 " guestmount --fuse-help\n"
25680 #: ../fuse/guestmount.pod:171
25681 msgid "Some potentially useful FUSE options:"
25685 #: ../fuse/guestmount.pod:175
25686 msgid "B<-o allow_other>"
25690 #: ../fuse/guestmount.pod:177
25691 msgid "Allow other users to see the filesystem."
25695 #: ../fuse/guestmount.pod:179
25696 msgid "B<-o attr_timeout=N>"
25700 #: ../fuse/guestmount.pod:181
25701 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25705 #: ../fuse/guestmount.pod:183
25706 msgid "B<-o kernel_cache>"
25710 #: ../fuse/guestmount.pod:185
25712 "Allow the kernel to cache files (reduces the number of reads that have to go "
25713 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25714 "afford the extra memory usage."
25718 #: ../fuse/guestmount.pod:189
25719 msgid "B<-o uid=N> B<-o gid=N>"
25723 #: ../fuse/guestmount.pod:191
25725 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25726 "the chosen values."
25730 #: ../fuse/guestmount.pod:196
25731 msgid "B<-r> | B<--ro>"
25735 #: ../fuse/guestmount.pod:198
25737 "Add devices and mount everything read-only. Also disallow writes and make "
25738 "the disk appear read-only to FUSE."
25742 #: ../fuse/guestmount.pod:201
25744 "This is highly recommended if you are not going to edit the guest disk. If "
25745 "the guest is running and this option is I<not> supplied, then there is a "
25746 "strong risk of disk corruption in the guest. We try to prevent this from "
25747 "happening, but it is not always possible."
25751 #: ../fuse/guestmount.pod:206
25752 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25756 #: ../fuse/guestmount.pod:210
25757 msgid "Enable SELinux support for the guest."
25761 #: ../fuse/guestmount.pod:212
25762 msgid "B<-v> | B<--verbose>"
25766 #: ../fuse/guestmount.pod:214
25767 msgid "Enable verbose messages from underlying libguestfs."
25771 #: ../fuse/guestmount.pod:216
25772 msgid "B<-V> | B<--version>"
25776 #: ../fuse/guestmount.pod:218
25777 msgid "Display the program version and exit."
25781 #: ../fuse/guestmount.pod:220
25782 msgid "B<-w> | B<--rw>"
25786 #: ../fuse/guestmount.pod:222
25788 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25789 "FOR READ AND WRITE>."
25793 #: ../fuse/guestmount.pod:225
25794 msgid "B<-x> | B<--trace>"
25798 #: ../fuse/guestmount.pod:227
25799 msgid "Trace libguestfs calls."
25803 #: ../fuse/guestmount.pod:229
25804 msgid "This also stops the daemon from forking into the background."
25808 #: ../fuse/guestmount.pod:235
25810 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25811 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
25812 "L<http://fuse.sf.net/>."
25816 #: ../tools/virt-edit.pl:34
25817 msgid "virt-edit - Edit a file in a virtual machine"
25821 #: ../tools/virt-edit.pl:38
25824 " virt-edit [--options] domname file\n"
25829 #: ../tools/virt-edit.pl:40
25832 " virt-edit [--options] disk.img [disk.img ...] file\n"
25837 #: ../tools/virt-edit.pl:42
25840 " virt-edit [domname|disk.img] file -e 'expr'\n"
25845 #: ../tools/virt-edit.pl:46
25847 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25848 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25849 "doing this, but doesn't catch all cases."
25853 #: ../tools/virt-edit.pl:52
25855 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25856 "the named virtual machine (or disk image)."
25860 #: ../tools/virt-edit.pl:55
25862 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25863 "you should look at the L<guestfish(1)> tool."
25867 #: ../tools/virt-edit.pl:60
25868 msgid "Edit the named files interactively:"
25872 #: ../tools/virt-edit.pl:62
25875 " virt-edit mydomain /boot/grub/grub.conf\n"
25880 #: ../tools/virt-edit.pl:64
25883 " virt-edit mydomain /etc/passwd\n"
25888 #: ../tools/virt-edit.pl:66
25890 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25891 "below). To change the init default level to 5:"
25895 #: ../tools/virt-edit.pl:70
25898 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25903 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:106 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
25904 msgid "Display brief help."
25908 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:114 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
25909 msgid "Display version number and exit."
25913 #: ../tools/virt-edit.pl:96
25914 msgid "B<--backup extension> | B<-b extension>"
25918 #: ../tools/virt-edit.pl:98
25920 "Create a backup of the original file I<in the guest disk image>. The backup "
25921 "has the original filename with C<extension> added."
25925 #: ../tools/virt-edit.pl:101
25927 "Usually the first character of C<extension> would be a dot C<.> so you would "
25932 #: ../tools/virt-edit.pl:104
25935 " virt-edit -b .orig [etc]\n"
25940 #: ../tools/virt-edit.pl:106
25941 msgid "By default, no backup file is made."
25945 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:128 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-list-partitions.pl:78
25946 msgid "B<--connect URI> | B<-c URI>"
25950 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:130 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-list-partitions.pl:80
25952 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25953 "to the default libvirt hypervisor."
25957 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:133 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:83
25959 "If you specify guest block devices directly, then libvirt is not used at "
25964 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:140 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
25965 msgid "B<--format> raw"
25969 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:142 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-list-partitions.pl:92
25971 "Specify the format of disk images given on the command line. If this is "
25972 "omitted then the format is autodetected from the content of the disk image."
25976 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:146 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-list-partitions.pl:96
25978 "If disk images are requested from libvirt, then this program asks libvirt "
25979 "for this information. In this case, the value of the format parameter is "
25984 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:150 ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144 ../tools/virt-list-partitions.pl:100
25986 "If working with untrusted raw-format guest disk images, you should ensure "
25987 "the format is always specified."
25991 #: ../tools/virt-edit.pl:141
25992 msgid "B<--expr EXPR> | B<-e EXPR>"
25996 #: ../tools/virt-edit.pl:143
25998 "Instead of launching the external editor, non-interactively apply the Perl "
25999 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26004 #: ../tools/virt-edit.pl:147
26006 "Be careful to properly quote the expression to prevent it from being altered "
26011 #: ../tools/virt-edit.pl:268
26012 msgid "NON-INTERACTIVE EDITING"
26016 #: ../tools/virt-edit.pl:270
26018 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26019 "administrator can interactively edit the file."
26023 #: ../tools/virt-edit.pl:273
26025 "There are two ways also to use C<virt-edit> from scripts in order to make "
26026 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26027 "like this, it's less error-prone to write scripts directly using the "
26028 "libguestfs API and Augeas for configuration file editing.)"
26032 #: ../tools/virt-edit.pl:279
26034 "The first method is to temporarily set C<$EDITOR> to any script or program "
26035 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26036 "update C<tmpfile> in place however it likes."
26040 #: ../tools/virt-edit.pl:283
26042 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26043 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26044 "instances of C<foo> with C<bar> in a file:"
26048 #: ../tools/virt-edit.pl:287
26051 " virt-edit domname filename -e 's/foo/bar/'\n"
26056 #: ../tools/virt-edit.pl:289
26058 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26059 "For example to delete root's password you could do:"
26063 #: ../tools/virt-edit.pl:292
26066 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26071 #: ../tools/virt-edit.pl:294
26073 "What really happens is that the snippet is evaluated as a Perl expression "
26074 "for each line of the file. The line, including the final C<\\n>, is passed "
26075 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26079 #: ../tools/virt-edit.pl:299
26081 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26082 "C<apache> user account from the password file you can do:"
26086 #: ../tools/virt-edit.pl:302
26089 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26094 #: ../tools/virt-edit.pl:304
26096 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26097 "the end of the file is rather difficult this way since there is no concept "
26098 "of \"last line of the file\" - your expression just doesn't get called "
26099 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26104 #: ../tools/virt-edit.pl:310
26106 "The variable C<$lineno> contains the current line number. As is "
26107 "traditional, the first line in the file is number C<1>."
26111 #: ../tools/virt-edit.pl:313
26113 "The return value from the expression is ignored, but the expression may call "
26114 "C<die> in order to abort the whole program, leaving the original file "
26119 #: ../tools/virt-edit.pl:317
26121 "Remember when matching the end of a line that C<$_> may contain the final "
26122 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26123 "newline then neither of these. Thus to match or substitute some text at the "
26124 "end of a line, use this regular expression:"
26128 #: ../tools/virt-edit.pl:322
26131 " /some text(\\r?\\n)?$/\n"
26136 #: ../tools/virt-edit.pl:324
26138 "Alternately, use the perl C<chomp> function, being careful not to chomp "
26139 "C<$_> itself (since that would remove all newlines from the file):"
26143 #: ../tools/virt-edit.pl:328
26146 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26151 #: ../tools/virt-edit.pl:334
26156 #: ../tools/virt-edit.pl:336
26158 "If set, this string is used as the editor. It may contain arguments, "
26159 "eg. C<\"emacs -nw\">"
26163 #: ../tools/virt-edit.pl:339
26164 msgid "If not set, C<vi> is used."
26168 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:559 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
26169 msgid "SHELL QUOTING"
26173 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:567 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
26175 "Libvirt guest names can contain arbitrary characters, some of which have "
26176 "meaning to the shell such as C<#> and space. You may need to quote or "
26177 "escape these characters on the command line. See the shell manual page "
26178 "L<sh(1)> for details."
26182 #: ../tools/virt-edit.pl:352
26184 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26185 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
26186 "L<perl(1)>, L<perlre(1)>."
26190 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:598 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
26195 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:600 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
26196 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
26200 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
26201 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26205 #: ../tools/virt-win-reg.pl:37
26207 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
26212 #: ../tools/virt-win-reg.pl:41
26215 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26220 #: ../tools/virt-win-reg.pl:43
26223 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26228 #: ../tools/virt-win-reg.pl:45
26231 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26236 #: ../tools/virt-win-reg.pl:47
26239 " virt-win-reg --merge domname [input.reg ...]\n"
26244 #: ../tools/virt-win-reg.pl:49
26247 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26252 #: ../tools/virt-win-reg.pl:53
26254 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26255 "virtual machines. If you do this, you I<will> get irreversible disk "
26256 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26257 "but doesn't catch all cases."
26261 #: ../tools/virt-win-reg.pl:58
26263 "Modifying the Windows Registry is an inherently risky operation. The format "
26264 "is deliberately obscure and undocumented, and Registry changes can leave the "
26265 "system unbootable. Therefore when using the C<--merge> option, make sure "
26266 "you have a reliable backup first."
26270 #: ../tools/virt-win-reg.pl:65
26272 "This program can export and merge Windows Registry entries from a Windows "
26277 #: ../tools/virt-win-reg.pl:68
26279 "The first parameter is the libvirt guest name or the raw disk image of a "
26284 #: ../tools/virt-win-reg.pl:71
26286 "If C<--merge> is I<not> specified, then the chosen registry key is "
26287 "displayed/exported (recursively). For example:"
26291 #: ../tools/virt-win-reg.pl:74
26294 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26299 #: ../tools/virt-win-reg.pl:76
26300 msgid "You can also display single values from within registry keys, for example:"
26304 #: ../tools/virt-win-reg.pl:79
26307 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26308 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26309 " Windows 7 Enterprise\n"
26314 #: ../tools/virt-win-reg.pl:83
26316 "With C<--merge>, you can merge a textual regedit file into the Windows "
26321 #: ../tools/virt-win-reg.pl:86
26324 " $ virt-win-reg --merge Windows7 changes.reg\n"
26329 #: ../tools/virt-win-reg.pl:88
26334 #: ../tools/virt-win-reg.pl:90
26336 "This program is only meant for simple access to the registry. If you want "
26337 "to do complicated things with the registry, we suggest you download the "
26338 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26339 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26340 "L<hivexregedit(1)>."
26344 #: ../tools/virt-win-reg.pl:120 ../tools/virt-make-fs.pl:177
26349 #: ../tools/virt-win-reg.pl:122 ../tools/virt-resize.pl:498
26350 msgid "Enable debugging messages."
26354 #: ../tools/virt-win-reg.pl:157
26359 #: ../tools/virt-win-reg.pl:159
26361 "In merge mode, this merges a textual regedit file into the Windows Registry "
26362 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26363 "displays or exports Registry entries instead."
26367 #: ../tools/virt-win-reg.pl:163
26369 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26370 "result in disk corruption. However exporting (without this flag) is always "
26375 #: ../tools/virt-win-reg.pl:171
26376 msgid "B<--encoding> UTF-16LE|ASCII"
26380 #: ../tools/virt-win-reg.pl:173
26382 "When merging (only), you may need to specify the encoding for strings to be "
26383 "used in the hive file. This is explained in detail in "
26384 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
26388 #: ../tools/virt-win-reg.pl:177
26390 "The default is to use UTF-16LE, which should work with recent versions of "
26395 #: ../tools/virt-win-reg.pl:402
26396 msgid "SUPPORTED SYSTEMS"
26400 #: ../tools/virt-win-reg.pl:404
26402 "The program currently supports Windows NT-derived guests starting with "
26403 "Windows XP through to at least Windows 7."
26407 #: ../tools/virt-win-reg.pl:407
26409 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
26410 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
26411 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
26415 #: ../tools/virt-win-reg.pl:411
26417 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26422 #: ../tools/virt-win-reg.pl:414
26424 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26429 #: ../tools/virt-win-reg.pl:417
26434 #: ../tools/virt-win-reg.pl:419
26436 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26437 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
26438 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
26439 "with Windows-style line endings, you may need to reencode the whole file "
26440 "before or after processing."
26444 #: ../tools/virt-win-reg.pl:425
26446 "To reencode a file from Windows format to Linux (before processing it with "
26447 "the C<--merge> option), you would do something like this:"
26451 #: ../tools/virt-win-reg.pl:428
26454 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26459 #: ../tools/virt-win-reg.pl:430
26461 "To go in the opposite direction, after exporting and before sending the file "
26462 "to a Windows user, do something like this:"
26466 #: ../tools/virt-win-reg.pl:433
26469 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26474 #: ../tools/virt-win-reg.pl:435
26475 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26479 #: ../tools/virt-win-reg.pl:437
26481 "If you are unsure about the current encoding, use the L<file(1)> command. "
26482 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
26483 "Windows-style (CRLF) line endings, like this:"
26487 #: ../tools/virt-win-reg.pl:441
26490 " $ file software.reg\n"
26491 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26492 " with CRLF line terminators\n"
26497 #: ../tools/virt-win-reg.pl:445
26498 msgid "This file would need conversion before you could C<--merge> it."
26502 #: ../tools/virt-win-reg.pl:447
26503 msgid "CurrentControlSet etc."
26507 #: ../tools/virt-win-reg.pl:449
26509 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26510 "Registry at the level of the hive file, and therefore you cannot modify "
26515 #: ../tools/virt-win-reg.pl:453
26517 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26518 "circumstances it might refer to another control set. The way to find out is "
26519 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26523 #: ../tools/virt-win-reg.pl:457
26526 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26527 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26528 " \"Current\"=dword:00000001\n"
26529 " \"Default\"=dword:00000001\n"
26530 " \"Failed\"=dword:00000000\n"
26531 " \"LastKnownGood\"=dword:00000002\n"
26536 #: ../tools/virt-win-reg.pl:464
26537 msgid "\"Current\" is the one which Windows will choose when it boots."
26541 #: ../tools/virt-win-reg.pl:466
26542 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
26546 #: ../tools/virt-win-reg.pl:469
26547 msgid "WINDOWS TIPS"
26551 #: ../tools/virt-win-reg.pl:471
26553 "Note that some of these tips modify the guest disk image. The guest I<must> "
26554 "be shut off, else you will get disk corruption."
26558 #: ../tools/virt-win-reg.pl:474
26559 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
26563 #: ../tools/virt-win-reg.pl:476
26565 "Prepare a DOS batch script, VBScript or executable. Upload this using "
26566 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
26567 "is uploaded into C<C:\\>:"
26571 #: ../tools/virt-win-reg.pl:480
26574 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
26579 #: ../tools/virt-win-reg.pl:482
26580 msgid "Prepare a regedit file containing the registry change:"
26584 #: ../tools/virt-win-reg.pl:484
26587 " cat > test.reg <<'EOF'\n"
26588 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
26589 " \"Test\"=\"c:\\\\test.bat\"\n"
26595 #: ../tools/virt-win-reg.pl:489
26597 "In this example we use the key C<RunOnce> which means that the script will "
26598 "run precisely once when the first user logs in. If you want it to run every "
26599 "time a user logs in, replace C<RunOnce> with C<Run>."
26603 #: ../tools/virt-win-reg.pl:493
26604 msgid "Now update the registry:"
26608 #: ../tools/virt-win-reg.pl:495
26611 " virt-win-reg --merge WindowsGuest test.reg\n"
26616 #: ../tools/virt-win-reg.pl:497
26617 msgid "INSTALLING A SERVICE"
26621 #: ../tools/virt-win-reg.pl:499
26623 "This section assumes you are familiar with Windows services, and you either "
26624 "have a program which handles the Windows Service Control Protocol directly "
26625 "or you want to run any program using a service wrapper like SrvAny or the "
26630 #: ../tools/virt-win-reg.pl:504
26632 "First upload the program and optionally the service wrapper. In this case "
26633 "the test program is called C<test.exe> and we are using the RHSrvAny "
26638 #: ../tools/virt-win-reg.pl:508
26641 " guestfish -i -d WindowsGuest <<EOF\n"
26642 " upload rhsrvany.exe /rhsrvany.exe\n"
26643 " upload test.exe /test.exe\n"
26649 #: ../tools/virt-win-reg.pl:513
26651 "Prepare a regedit file containing the registry changes. In this example, "
26652 "the first registry change is needed for the service itself or the service "
26653 "wrapper (if used). The second registry change is only needed because I am "
26654 "using the RHSrvAny service wrapper."
26658 #: ../tools/virt-win-reg.pl:518
26661 " cat > service.reg <<'EOF'\n"
26662 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
26663 " \"Type\"=dword:00000010\n"
26664 " \"Start\"=dword:00000002\n"
26665 " \"ErrorControl\"=dword:00000001\n"
26666 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
26667 " \"DisplayName\"=\"RHSrvAny\"\n"
26668 " \"ObjectName\"=\"NetworkService\"\n"
26673 #: ../tools/virt-win-reg.pl:527
26676 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
26677 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
26678 " \"PWD\"=\"c:\\\\Temp\"\n"
26684 #: ../tools/virt-win-reg.pl:538
26686 "For use of C<ControlSet001> see the section above in this manual page. You "
26687 "may need to adjust this according to the control set that is in use by the "
26692 #: ../tools/virt-win-reg.pl:544
26694 "C<\"ObjectName\"> controls the privileges that the service will have. An "
26695 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
26696 "privileged account."
26700 #: ../tools/virt-win-reg.pl:550
26702 "For the meaning of the magic numbers, see this Microsoft KB article: "
26703 "L<http://support.microsoft.com/kb/103000>."
26707 #: ../tools/virt-win-reg.pl:555
26708 msgid "Update the registry:"
26712 #: ../tools/virt-win-reg.pl:557
26715 " virt-win-reg --merge WindowsGuest service.reg\n"
26720 #: ../tools/virt-win-reg.pl:561
26722 "Be careful when passing parameters containing C<\\> (backslash) in the "
26723 "shell. Usually you will have to use 'single quotes' or double backslashes "
26724 "(but not both) to protect them from the shell."
26728 #: ../tools/virt-win-reg.pl:565
26729 msgid "Paths and value names are case-insensitive."
26733 #: ../tools/virt-win-reg.pl:574
26735 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
26736 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26737 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
26738 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26742 #: ../tools/virt-win-reg.pl:589 ../tools/virt-make-fs.pl:550
26744 "When reporting bugs, please enable debugging and capture the I<complete> "
26749 #: ../tools/virt-win-reg.pl:592
26752 " export LIBGUESTFS_DEBUG=1\n"
26753 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26758 #: ../tools/virt-win-reg.pl:595
26760 "Attach /tmp/virt-win-reg.log to a new bug report at "
26761 "L<https://bugzilla.redhat.com/>"
26765 #: ../tools/virt-win-reg.pl:604 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:565
26766 msgid "Copyright (C) 2010 Red Hat Inc."
26770 #: ../tools/virt-resize.pl:42
26771 msgid "virt-resize - Resize a virtual machine disk"
26775 #: ../tools/virt-resize.pl:46
26778 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26779 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26780 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26785 #: ../tools/virt-resize.pl:52
26787 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26788 "larger or smaller overall, and resizing or deleting any partitions contained "
26793 #: ../tools/virt-resize.pl:56
26795 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26796 "not> be used on live virtual machines - for consistent results, shut the "
26797 "virtual machine down before resizing it."
26801 #: ../tools/virt-resize.pl:60
26803 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26804 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26808 #: ../tools/virt-resize.pl:66
26810 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26811 "fill the extra 5GB of space."
26815 #: ../tools/virt-resize.pl:69
26818 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26819 " virt-filesystems --long --h --all -a olddisk\n"
26820 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26821 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26826 #: ../tools/virt-resize.pl:74
26828 "As above, but make the /boot partition 200MB bigger, while giving the "
26829 "remaining space to /dev/sda2:"
26833 #: ../tools/virt-resize.pl:77
26836 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26841 #: ../tools/virt-resize.pl:79
26842 msgid "As above, but the output format will be uncompressed qcow2:"
26846 #: ../tools/virt-resize.pl:81
26849 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26850 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26855 #: ../tools/virt-resize.pl:84
26856 msgid "DETAILED USAGE"
26860 #: ../tools/virt-resize.pl:86
26861 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26865 #: ../tools/virt-resize.pl:90
26866 msgid "1. Shut down the virtual machine"
26870 #: ../tools/virt-resize.pl:92
26871 msgid "2. Locate input disk image"
26875 #: ../tools/virt-resize.pl:94
26877 "Locate the input disk image (ie. the file or device on the host containing "
26878 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26879 "dumpxml> like this to find the disk image name:"
26883 #: ../tools/virt-resize.pl:98
26886 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26887 " Found 1 nodes:\n"
26889 " <source dev=\"/dev/vg/lv_guest\" />\n"
26894 #: ../tools/virt-resize.pl:103
26895 msgid "3. Look at current sizing"
26899 #: ../tools/virt-resize.pl:105
26900 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
26904 #: ../tools/virt-resize.pl:108
26907 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
26908 " Name Type Size Parent\n"
26909 " /dev/sda1 partition 101M /dev/sda\n"
26910 " /dev/sda2 partition 7.9G /dev/sda\n"
26911 " /dev/sda device 8.0G -\n"
26916 #: ../tools/virt-resize.pl:114
26918 "(This example is a virtual machine with an 8 GB disk which we would like to "
26919 "expand up to 10 GB)."
26923 #: ../tools/virt-resize.pl:117
26924 msgid "4. Create output disk"
26928 #: ../tools/virt-resize.pl:119
26930 "Virt-resize cannot do in-place disk modifications. You have to have space "
26931 "to store the resized output disk."
26935 #: ../tools/virt-resize.pl:122
26936 msgid "To store the resized disk image in a file, create a file of a suitable size:"
26940 #: ../tools/virt-resize.pl:125
26943 " # rm -f outdisk\n"
26944 " # truncate -s 10G outdisk\n"
26949 #: ../tools/virt-resize.pl:128
26950 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26954 #: ../tools/virt-resize.pl:130
26957 " # lvcreate -L 10G -n lv_name vg_name\n"
26962 #: ../tools/virt-resize.pl:132
26963 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26967 #: ../tools/virt-resize.pl:134
26970 " # virsh pool-list\n"
26971 " # virsh vol-create-as poolname newvol 10G\n"
26976 #: ../tools/virt-resize.pl:137
26981 #: ../tools/virt-resize.pl:139
26983 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26984 "file) and the output disk. The output disk is the one created in the "
26989 #: ../tools/virt-resize.pl:143
26992 " # virt-resize indisk outdisk\n"
26997 #: ../tools/virt-resize.pl:145
26999 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27000 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27001 "larger, then an extra, empty partition is created at the end of the disk "
27002 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27007 #: ../tools/virt-resize.pl:151
27009 "More realistically you'd want to expand existing partitions in the disk "
27010 "image by passing extra options (for the full list see the L</OPTIONS> "
27015 #: ../tools/virt-resize.pl:155
27017 "L</--expand> is the most useful option. It expands the named partition "
27018 "within the disk to fill any extra space:"
27022 #: ../tools/virt-resize.pl:158
27025 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27030 #: ../tools/virt-resize.pl:160
27032 "(In this case, an extra partition is I<not> created at the end of the disk, "
27033 "because there will be no unused space)."
27037 #: ../tools/virt-resize.pl:163
27039 "L</--resize> is the other commonly used option. The following would "
27040 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27041 "rest of the available space:"
27045 #: ../tools/virt-resize.pl:167
27048 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27049 " indisk outdisk\n"
27054 #: ../tools/virt-resize.pl:170
27056 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27057 "if virt-resize knows how, it will resize the contents, the equivalent of "
27058 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
27059 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
27060 "filesystems, so you would have to online resize them after booting the "
27065 #: ../tools/virt-resize.pl:177
27066 msgid "Other options are covered below."
27070 #: ../tools/virt-resize.pl:179
27075 #: ../tools/virt-resize.pl:181
27076 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27080 #: ../tools/virt-resize.pl:183
27081 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27085 #: ../tools/virt-resize.pl:185
27088 " # virsh edit guestname\n"
27093 #: ../tools/virt-resize.pl:187
27095 "Change E<lt>source ...E<gt>, see "
27096 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
27100 #: ../tools/virt-resize.pl:190
27101 msgid "Then start up the domain with the new, resized disk:"
27105 #: ../tools/virt-resize.pl:192
27108 " # virsh start guestname\n"
27113 #: ../tools/virt-resize.pl:194
27115 "and check that it still works. See also the L</NOTES> section below for "
27116 "additional information."
27120 #: ../tools/virt-resize.pl:197
27121 msgid "7. Resize LVs etc inside the guest"
27125 #: ../tools/virt-resize.pl:199
27126 msgid "(This can also be done offline using L<guestfish(1)>)"
27130 #: ../tools/virt-resize.pl:201
27132 "Once the guest has booted you should see the new space available, at least "
27133 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27134 "may need to resize LVs inside PVs, and also resize filesystem types that "
27135 "virt-resize does not know how to expand."
27139 #: ../tools/virt-resize.pl:208
27140 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27144 #: ../tools/virt-resize.pl:210
27146 "Shrinking is somewhat more complex than expanding, and only an overview is "
27151 #: ../tools/virt-resize.pl:213
27153 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27154 "filesystems). The user has to shrink content before passing the disk image "
27155 "to virt-resize, and virt-resize will check that the content has been shrunk "
27160 #: ../tools/virt-resize.pl:218
27161 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27165 #: ../tools/virt-resize.pl:220
27167 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27168 "steps 3 and 4 above to allocate a new disk image."
27172 #: ../tools/virt-resize.pl:223
27173 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27177 #: ../tools/virt-resize.pl:226
27178 msgid "IGNORING OR DELETING PARTITIONS"
27182 #: ../tools/virt-resize.pl:228
27184 "virt-resize also gives a convenient way to ignore or delete partitions when "
27185 "copying from the input disk to the output disk. Ignoring a partition speeds "
27186 "up the copy where you don't care about the existing contents of a "
27187 "partition. Deleting a partition removes it completely, but note that it "
27188 "also renumbers any partitions after the one which is deleted, which can "
27189 "leave some guests unbootable."
27193 #: ../tools/virt-resize.pl:235
27194 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27198 #: ../tools/virt-resize.pl:237
27200 "If the input disk is in qcow2 format, then you may prefer that the output is "
27201 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27202 "the fly. The output format is simply determined by the format of the empty "
27203 "output container that you provide. Thus to create qcow2 output, use:"
27207 #: ../tools/virt-resize.pl:243
27210 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27215 #: ../tools/virt-resize.pl:245
27216 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27220 #: ../tools/virt-resize.pl:247
27221 msgid "Similarly, to get non-sparse raw output use:"
27225 #: ../tools/virt-resize.pl:249
27228 " fallocate -l size outdisk\n"
27233 #: ../tools/virt-resize.pl:251
27235 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
27236 "if=/dev/zero of=outdisk bs=1M count=..>)"
27240 #: ../tools/virt-resize.pl:264
27241 msgid "Display help."
27245 #: ../tools/virt-resize.pl:278
27246 msgid "B<--resize part=size>"
27250 #: ../tools/virt-resize.pl:280
27252 "Resize the named partition (expanding or shrinking it) so that it has the "
27257 #: ../tools/virt-resize.pl:283
27259 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27260 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27261 "Exabytes; or as a percentage of the current size; or as a relative number or "
27262 "percentage. For example:"
27266 #: ../tools/virt-resize.pl:288
27269 " --resize /dev/sda2=10G\n"
27274 #: ../tools/virt-resize.pl:290
27277 " --resize /dev/sda4=90%\n"
27282 #: ../tools/virt-resize.pl:292
27285 " --resize /dev/sda2=+1G\n"
27290 #: ../tools/virt-resize.pl:294
27293 " --resize /dev/sda2=-200M\n"
27298 #: ../tools/virt-resize.pl:296
27301 " --resize /dev/sda1=+128K\n"
27306 #: ../tools/virt-resize.pl:298
27309 " --resize /dev/sda1=+10%\n"
27314 #: ../tools/virt-resize.pl:300
27317 " --resize /dev/sda1=-10%\n"
27322 #: ../tools/virt-resize.pl:302
27324 "You can increase the size of any partition. Virt-resize will expand the "
27325 "direct content of the partition if it knows how (see C<--expand> below)."
27329 #: ../tools/virt-resize.pl:306
27331 "You can only I<decrease> the size of partitions that contain filesystems or "
27332 "PVs which have already been shrunk. Virt-resize will check this has been "
27333 "done before proceeding, or else will print an error (see also "
27334 "C<--resize-force>)."
27338 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
27339 msgid "You can give this option multiple times."
27343 #: ../tools/virt-resize.pl:317
27344 msgid "B<--resize-force part=size>"
27348 #: ../tools/virt-resize.pl:319
27350 "This is the same as C<--resize> except that it will let you decrease the "
27351 "size of any partition. Generally this means you will lose any data which "
27352 "was at the end of the partition you shrink, but you may not care about that "
27353 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27354 "as a swap partition)."
27358 #: ../tools/virt-resize.pl:325
27359 msgid "See also the C<--ignore> option."
27363 #: ../tools/virt-resize.pl:331
27364 msgid "B<--expand part>"
27368 #: ../tools/virt-resize.pl:333
27370 "Expand the named partition so it uses up all extra space (space left over "
27371 "after any other resize changes that you request have been done)."
27375 #: ../tools/virt-resize.pl:336
27377 "If virt-resize knows how, it will expand the direct content of the "
27378 "partition. For example, if the partition is an LVM PV, it will expand the "
27379 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27380 "content it doesn't know about alone."
27384 #: ../tools/virt-resize.pl:341
27385 msgid "Currently virt-resize can resize:"
27389 #: ../tools/virt-resize.pl:347
27391 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27396 #: ../tools/virt-resize.pl:352
27398 "NTFS filesystems contained directly in a partition, if libguestfs was "
27399 "compiled with support for NTFS."
27403 #: ../tools/virt-resize.pl:355
27405 "The filesystem must have been shut down consistently last time it was used. "
27406 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27407 "consistency check, so at the first boot after resizing Windows will check "
27412 #: ../tools/virt-resize.pl:362
27414 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
27415 "inside the PV, but see the C<--LV-expand> option. The user could also "
27416 "resize LVs as desired after boot."
27420 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
27421 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27425 #: ../tools/virt-resize.pl:374
27426 msgid "B<--shrink part>"
27430 #: ../tools/virt-resize.pl:376
27432 "Shrink the named partition until the overall disk image fits in the "
27433 "destination. The named partition B<must> contain a filesystem or PV which "
27434 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27435 "online tools). Virt-resize will check this and give an error if it has not "
27440 #: ../tools/virt-resize.pl:382
27442 "The amount by which the overall disk must be shrunk (after carrying out all "
27443 "other operations requested by the user) is called the \"deficit\". For "
27444 "example, a straight copy (assume no other operations) from a 5GB disk image "
27445 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27446 "would give an error unless the user specified a partition to shrink and that "
27447 "partition had more than a gigabyte of free space."
27451 #: ../tools/virt-resize.pl:396
27452 msgid "B<--ignore part>"
27456 #: ../tools/virt-resize.pl:398
27458 "Ignore the named partition. Effectively this means the partition is "
27459 "allocated on the destination disk, but the content is not copied across from "
27460 "the source disk. The content of the partition will be blank (all zero "
27465 #: ../tools/virt-resize.pl:409
27466 msgid "B<--delete part>"
27470 #: ../tools/virt-resize.pl:411
27472 "Delete the named partition. It would be more accurate to describe this as "
27473 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27474 "the original disk image is left intact."
27478 #: ../tools/virt-resize.pl:415
27480 "Note that when you delete a partition, then anything contained in the "
27481 "partition is also deleted. Furthermore, this causes any partitions that "
27482 "come after to be I<renumbered>, which can easily make your guest unbootable."
27486 #: ../tools/virt-resize.pl:426
27487 msgid "B<--LV-expand logvol>"
27491 #: ../tools/virt-resize.pl:428
27493 "This takes the logical volume and, as a final step, expands it to fill all "
27494 "the space available in its volume group. A typical usage, assuming a Linux "
27495 "guest with a single PV C</dev/sda2> and a root device called "
27496 "C</dev/vg_guest/lv_root> would be:"
27500 #: ../tools/virt-resize.pl:433
27503 " virt-resize indisk outdisk \\\n"
27504 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27509 #: ../tools/virt-resize.pl:436
27511 "This would first expand the partition (and PV), and then expand the root "
27512 "device to fill the extra space in the PV."
27516 #: ../tools/virt-resize.pl:439
27518 "The contents of the LV are also resized if virt-resize knows how to do "
27519 "that. You can stop virt-resize from trying to expand the content by using "
27520 "the option C<--no-expand-content>."
27524 #: ../tools/virt-resize.pl:443
27525 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27529 #: ../tools/virt-resize.pl:446
27531 "You can give this option multiple times, I<but> it doesn't make sense to do "
27532 "this unless the logical volumes you specify are all in different volume "
27537 #: ../tools/virt-resize.pl:454
27538 msgid "B<--no-copy-boot-loader>"
27542 #: ../tools/virt-resize.pl:456
27544 "By default, virt-resize copies over some sectors at the start of the disk "
27545 "(up to the beginning of the first partition). Commonly these sectors "
27546 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27547 "in order for the guest to boot correctly."
27551 #: ../tools/virt-resize.pl:461
27553 "If you specify this flag, then this initial copy is not done. You may need "
27554 "to reinstall the boot loader in this case."
27558 #: ../tools/virt-resize.pl:469
27559 msgid "B<--no-extra-partition>"
27563 #: ../tools/virt-resize.pl:471
27565 "By default, virt-resize creates an extra partition if there is any extra, "
27566 "unused space after all resizing has happened. Use this option to prevent "
27567 "the extra partition from being created. If you do this then the extra space "
27568 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27569 "tool in the guest."
27573 #: ../tools/virt-resize.pl:477
27575 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27580 #: ../tools/virt-resize.pl:484
27581 msgid "B<--no-expand-content>"
27585 #: ../tools/virt-resize.pl:486
27587 "By default, virt-resize will try to expand the direct contents of "
27588 "partitions, if it knows how (see C<--expand> option above)."
27592 #: ../tools/virt-resize.pl:489
27594 "If you give the C<--no-expand-content> option then virt-resize will not "
27599 #: ../tools/virt-resize.pl:496
27600 msgid "B<-d> | B<--debug>"
27604 #: ../tools/virt-resize.pl:504
27605 msgid "B<-n> | B<--dryrun>"
27609 #: ../tools/virt-resize.pl:506
27610 msgid "Print a summary of what would be done, but don't do anything."
27614 #: ../tools/virt-resize.pl:512
27615 msgid "B<-q> | B<--quiet>"
27619 #: ../tools/virt-resize.pl:514
27620 msgid "Don't print the summary."
27624 #: ../tools/virt-resize.pl:522
27626 "Specify the format of the input disk image. If this flag is not given then "
27627 "it is auto-detected from the image itself."
27631 #: ../tools/virt-resize.pl:528
27633 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27634 "AND NON-SPARSE RAW FORMATS>."
27638 #: ../tools/virt-resize.pl:535
27639 msgid "B<--output-format> raw"
27643 #: ../tools/virt-resize.pl:537
27645 "Specify the format of the output disk image. If this flag is not given then "
27646 "it is auto-detected from the image itself."
27650 #: ../tools/virt-resize.pl:543
27652 "Note that you still need to create the output disk with the right format. "
27653 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27657 #: ../tools/virt-resize.pl:1419
27662 #: ../tools/virt-resize.pl:1421
27663 msgid "\"Partition 1 does not end on cylinder boundary.\""
27667 #: ../tools/virt-resize.pl:1423
27669 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27670 "means the partitions will not be aligned to the ancient CHS geometry. "
27671 "However CHS geometry is meaningless for disks manufactured since the early "
27672 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27673 "cylinders is not required by any modern operating system."
27677 #: ../tools/virt-resize.pl:1430
27678 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27682 #: ../tools/virt-resize.pl:1432
27684 "In Windows Vista and later versions, Microsoft switched to using a separate "
27685 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27686 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27687 "the boot partition. Doing so seems to break the guest completely. However "
27688 "expanding the second partition (ie. C: drive) should work."
27692 #: ../tools/virt-resize.pl:1439
27694 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27695 "NTFS partitions have been expanded. This is just a safety check and (unless "
27696 "it find errors) is nothing to worry about."
27700 #: ../tools/virt-resize.pl:1443
27701 msgid "GUEST BOOT STUCK AT \"GRUB\""
27705 #: ../tools/virt-resize.pl:1445
27707 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27708 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27709 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27710 "although we think is to do with partition alignment."
27714 #: ../tools/virt-resize.pl:1450
27717 " guestfish -i -a newdisk\n"
27718 " ><fs> cat /boot/grub/device.map\n"
27719 " # check the contents of this file are sensible or\n"
27720 " # edit the file if necessary\n"
27721 " ><fs> grub-install / /dev/vda\n"
27727 #: ../tools/virt-resize.pl:1457
27729 "For more flexible guest reconfiguration, including if you need to specify "
27730 "other parameters to grub-install, use L<virt-rescue(1)>."
27734 #: ../tools/virt-resize.pl:1460
27735 msgid "ALTERNATIVE TOOLS"
27739 #: ../tools/virt-resize.pl:1462
27741 "There are several proprietary tools for resizing partitions. We won't "
27742 "mention any here."
27746 #: ../tools/virt-resize.pl:1465
27748 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27749 "operations on disk images. They can resize and move partitions, but I don't "
27750 "think they can do anything with the contents, and they certainly don't "
27755 #: ../tools/virt-resize.pl:1470
27757 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27758 "but at a much lower level. You will probably end up hand-calculating sector "
27759 "offsets, which is something that virt-resize was designed to avoid. If you "
27760 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27765 #: ../tools/virt-resize.pl:1485
27767 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
27768 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
27769 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
27770 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27771 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27775 #: ../tools/virt-list-filesystems.pl:32
27776 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27780 #: ../tools/virt-list-filesystems.pl:36
27783 " virt-list-filesystems [--options] domname\n"
27788 #: ../tools/virt-list-filesystems.pl:38
27791 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27796 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27798 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27803 #: ../tools/virt-list-filesystems.pl:45
27805 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27806 "are contained in a virtual machine or disk image."
27810 #: ../tools/virt-list-filesystems.pl:49
27812 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27813 "functionality. For more complex cases you should look at the "
27814 "L<guestfish(1)> tool."
27818 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27819 msgid "B<-l> | B<--long>"
27823 #: ../tools/virt-list-filesystems.pl:108
27825 "With this option, C<virt-list-filesystems> displays the type of each "
27826 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27830 #: ../tools/virt-list-filesystems.pl:115
27831 msgid "B<-a> | B<--all>"
27835 #: ../tools/virt-list-filesystems.pl:117
27837 "Normally we only show mountable filesystems. If this option is given then "
27838 "swap devices are shown too."
27842 #: ../tools/virt-list-filesystems.pl:191
27844 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
27845 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
27846 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27850 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27851 msgid "Copyright (C) 2009 Red Hat Inc."
27855 #: ../tools/virt-tar.pl:33
27856 msgid "virt-tar - Extract or upload files to a virtual machine"
27860 #: ../tools/virt-tar.pl:37
27863 " virt-tar [--options] -x domname directory tarball\n"
27868 #: ../tools/virt-tar.pl:39
27871 " virt-tar [--options] -u domname tarball directory\n"
27876 #: ../tools/virt-tar.pl:41
27879 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27884 #: ../tools/virt-tar.pl:43
27887 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27892 #: ../tools/virt-tar.pl:47
27893 msgid "Download C</home> from the VM into a local tarball:"
27897 #: ../tools/virt-tar.pl:49
27900 " virt-tar -x domname /home home.tar\n"
27905 #: ../tools/virt-tar.pl:51
27908 " virt-tar -zx domname /home home.tar.gz\n"
27913 #: ../tools/virt-tar.pl:53
27914 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27918 #: ../tools/virt-tar.pl:55
27921 " virt-tar -u domname uploadstuff.tar /tmp\n"
27926 #: ../tools/virt-tar.pl:57
27929 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27934 #: ../tools/virt-tar.pl:61
27936 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27937 "virtual machines. If you do this, you risk disk corruption in the VM. "
27938 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27942 #: ../tools/virt-tar.pl:66
27944 "You can use C<-x> (extract) on live virtual machines, but you might get "
27945 "inconsistent results or errors if there is filesystem activity inside the "
27946 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27947 "work, but the only way to guarantee consistent results is if the virtual "
27948 "machine is shut down."
27952 #: ../tools/virt-tar.pl:74
27954 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27955 "parts of a guest filesystem. There are many possibilities: making backups, "
27956 "uploading data files, snooping on guest activity, fixing or customizing "
27961 #: ../tools/virt-tar.pl:79
27963 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27964 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27965 "should look at the L<guestfish(1)> tool."
27969 #: ../tools/virt-tar.pl:83
27971 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27972 "its contents (recursively) from the virtual machine into a local tarball. "
27973 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27974 "virtual machine. You cannot use these two options together."
27978 #: ../tools/virt-tar.pl:89
27980 "In addition, you may need to use the C<-z> (gZip) option to enable "
27981 "compression. When uploading, you have to specify C<-z> if the upload file "
27982 "is compressed because virt-tar won't detect this on its own."
27986 #: ../tools/virt-tar.pl:93
27988 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27989 "example it cannot do PKZip files or bzip2 compression. If you want that "
27990 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27991 "the L<libguestfs(3)> API)."
27995 #: ../tools/virt-tar.pl:151
27996 msgid "B<-x> | B<--extract> | B<--download>"
28000 #: ../tools/virt-tar.pl:153
28001 msgid "B<-u> | B<--upload>"
28005 #: ../tools/virt-tar.pl:155
28007 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28012 #: ../tools/virt-tar.pl:158
28014 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28015 "Please read the L</WARNING> section above before using this option."
28019 #: ../tools/virt-tar.pl:162
28020 msgid "You must specify exactly one of these options."
28024 #: ../tools/virt-tar.pl:168
28025 msgid "B<-z> | B<--gzip>"
28029 #: ../tools/virt-tar.pl:170
28030 msgid "Specify that the input or output tarball is gzip-compressed."
28034 #: ../tools/virt-tar.pl:283
28036 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28037 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
28038 "L<http://libguestfs.org/>."
28042 #: ../tools/virt-make-fs.pl:37
28043 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28047 #: ../tools/virt-make-fs.pl:41
28050 " virt-make-fs [--options] input.tar output.img\n"
28055 #: ../tools/virt-make-fs.pl:43
28058 " virt-make-fs [--options] input.tar.gz output.img\n"
28063 #: ../tools/virt-make-fs.pl:45
28066 " virt-make-fs [--options] directory output.img\n"
28071 #: ../tools/virt-make-fs.pl:49
28073 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28074 "archive or some files in a directory. It is similar to tools like "
28075 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
28076 "it can create common filesystem types like ext2/3 or NTFS, which can be "
28077 "useful if you want to attach these filesystems to existing virtual machines "
28078 "(eg. to import large amounts of read-only data to a VM)."
28082 #: ../tools/virt-make-fs.pl:57
28083 msgid "Basic usage is:"
28087 #: ../tools/virt-make-fs.pl:59
28090 " virt-make-fs input output\n"
28095 #: ../tools/virt-make-fs.pl:61
28097 "where C<input> is either a directory containing files that you want to add, "
28098 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28099 "C<output> is a disk image. The input type is detected automatically. The "
28100 "output disk image defaults to a raw ext2 image unless you specify extra "
28101 "flags (see L</OPTIONS> below)."
28105 #: ../tools/virt-make-fs.pl:67
28106 msgid "EXTRA SPACE"
28110 #: ../tools/virt-make-fs.pl:69
28112 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28113 "the files that it contains, but might have extra space. Depending on how "
28114 "you are going to use the output, you might think this extra space is wasted "
28115 "and want to minimize it, or you might want to leave space so that more files "
28116 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28117 "but you can use the C<--size> flag to leave space in the filesystem if you "
28122 #: ../tools/virt-make-fs.pl:77
28124 "An alternative way to leave extra space but not make the output image any "
28125 "bigger is to use an alternative disk image format (instead of the default "
28126 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28127 "image format (check your hypervisor supports this before using it). This "
28128 "allows you to choose a large C<--size> but the extra space won't actually be "
28129 "allocated in the image until you try to store something in it."
28133 #: ../tools/virt-make-fs.pl:85
28135 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28136 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
28137 "virt-make-resize to build another image from scratch."
28141 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
28146 #: ../tools/virt-make-fs.pl:91
28149 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28154 #: ../tools/virt-make-fs.pl:93
28155 msgid "FILESYSTEM TYPE"
28159 #: ../tools/virt-make-fs.pl:95
28161 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28162 "libguestfs supports can be used (but I<not> read-only formats like "
28163 "ISO9660). Here are some of the more common choices:"
28167 #: ../tools/virt-make-fs.pl:101
28172 #: ../tools/virt-make-fs.pl:103
28174 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28175 "you are not going to use the filesystem in a way that requires the journal, "
28176 "then this is just wasted overhead."
28180 #: ../tools/virt-make-fs.pl:107
28181 msgid "I<ntfs> or I<vfat>"
28185 #: ../tools/virt-make-fs.pl:109
28186 msgid "Useful if exporting data to a Windows guest."
28190 #: ../tools/virt-make-fs.pl:111
28192 "I<Note for vfat>: The tar archive or local directory must only contain files "
28193 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28194 "program running within libguestfs is unable to change the ownership of "
28195 "non-root files, since vfat itself does not support this."
28199 #: ../tools/virt-make-fs.pl:116
28204 #: ../tools/virt-make-fs.pl:118
28206 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28207 "total filesystem size."
28211 #: ../tools/virt-make-fs.pl:125
28214 " virt-make-fs --type=minix input minixfs.img\n"
28219 #: ../tools/virt-make-fs.pl:127
28220 msgid "TO PARTITION OR NOT TO PARTITION"
28224 #: ../tools/virt-make-fs.pl:129
28225 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28229 #: ../tools/virt-make-fs.pl:131
28231 "Adding a partition can make the disk image more compatible with certain "
28232 "virtualized operating systems which don't expect to see a filesystem "
28233 "directly located on a block device (Linux doesn't care and will happily "
28234 "handle both types)."
28238 #: ../tools/virt-make-fs.pl:136
28240 "On the other hand, if you have a partition table then the output image is no "
28241 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28242 "directly on a partitioned disk image. (However libguestfs tools such as "
28243 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28247 #: ../tools/virt-make-fs.pl:144
28248 msgid "Add an MBR partition:"
28252 #: ../tools/virt-make-fs.pl:146
28255 " virt-make-fs --partition -- input disk.img\n"
28260 #: ../tools/virt-make-fs.pl:148
28262 "If the output disk image could be terabyte-sized or larger, it's better to "
28263 "use an EFI/GPT-compatible partition table:"
28267 #: ../tools/virt-make-fs.pl:151
28270 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28275 #: ../tools/virt-make-fs.pl:179
28276 msgid "Enable debugging information."
28280 #: ../tools/virt-make-fs.pl:185
28281 msgid "B<--size=E<lt>NE<gt>>"
28285 #: ../tools/virt-make-fs.pl:187
28286 msgid "B<--size=+E<lt>NE<gt>>"
28290 #: ../tools/virt-make-fs.pl:189
28291 msgid "B<-s E<lt>NE<gt>>"
28295 #: ../tools/virt-make-fs.pl:191
28296 msgid "B<-s +E<lt>NE<gt>>"
28300 #: ../tools/virt-make-fs.pl:193
28301 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28305 #: ../tools/virt-make-fs.pl:196
28307 "If this option is I<not> given, then the output image will be just large "
28308 "enough to contain all the files, with not much wasted space."
28312 #: ../tools/virt-make-fs.pl:199
28314 "To choose a fixed size output disk, specify an absolute number followed by "
28315 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28316 "Petabytes or Exabytes. This must be large enough to contain all the input "
28317 "files, else you will get an error."
28321 #: ../tools/virt-make-fs.pl:204
28323 "To leave extra space, specify C<+> (plus sign) and a number followed by "
28324 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28325 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28326 "the input files, and (approximately) an extra 200 MB free space."
28330 #: ../tools/virt-make-fs.pl:210
28332 "Note that virt-make-fs estimates free space, and therefore will not produce "
28333 "filesystems containing precisely the free space requested. (It is much more "
28334 "expensive and time-consuming to produce a filesystem which has precisely the "
28335 "desired free space)."
28339 #: ../tools/virt-make-fs.pl:219
28340 msgid "B<--format=E<lt>fmtE<gt>>"
28344 #: ../tools/virt-make-fs.pl:221
28345 msgid "B<-F E<lt>fmtE<gt>>"
28349 #: ../tools/virt-make-fs.pl:223
28350 msgid "Choose the output disk image format."
28354 #: ../tools/virt-make-fs.pl:225
28355 msgid "The default is C<raw> (raw disk image)."
28359 #: ../tools/virt-make-fs.pl:227
28361 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28362 "that would really make sense here is C<qcow2>."
28366 #: ../tools/virt-make-fs.pl:234
28367 msgid "B<--type=E<lt>fsE<gt>>"
28371 #: ../tools/virt-make-fs.pl:236
28372 msgid "B<-t E<lt>fsE<gt>>"
28376 #: ../tools/virt-make-fs.pl:238
28377 msgid "Choose the output filesystem type."
28381 #: ../tools/virt-make-fs.pl:240
28382 msgid "The default is C<ext2>."
28386 #: ../tools/virt-make-fs.pl:242
28387 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
28391 #: ../tools/virt-make-fs.pl:249
28392 msgid "B<--partition>"
28396 #: ../tools/virt-make-fs.pl:251
28397 msgid "B<--partition=E<lt>parttypeE<gt>>"
28401 #: ../tools/virt-make-fs.pl:253
28403 "If specified, this flag adds an MBR partition table to the output disk "
28408 #: ../tools/virt-make-fs.pl:256
28410 "You can change the partition table type, eg. C<--partition=gpt> for large "
28415 #: ../tools/virt-make-fs.pl:259
28417 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28418 "might consider the next parameter to be the partition type. For example:"
28422 #: ../tools/virt-make-fs.pl:263
28425 " virt-make-fs --partition input.tar ...\n"
28430 #: ../tools/virt-make-fs.pl:265
28432 "would cause virt-make-fs to think you wanted to use a partition type of "
28433 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28434 "dash) between options and the input file argument:"
28438 #: ../tools/virt-make-fs.pl:269
28441 " virt-make-fs --partition -- input.tar ...\n"
28446 #: ../tools/virt-make-fs.pl:536
28448 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28449 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
28450 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28454 #: ../tools/virt-make-fs.pl:553
28457 " export LIBGUESTFS_DEBUG=1\n"
28458 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28463 #: ../tools/virt-make-fs.pl:556
28465 "Attach /tmp/virt-make-fs.log to a new bug report at "
28466 "L<https://bugzilla.redhat.com/>"
28470 #: ../tools/virt-list-partitions.pl:32
28471 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28475 #: ../tools/virt-list-partitions.pl:36
28478 " virt-list-partitions [--options] domname\n"
28483 #: ../tools/virt-list-partitions.pl:38
28486 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28491 #: ../tools/virt-list-partitions.pl:45
28493 "C<virt-list-partitions> is a command line tool to list the partitions that "
28494 "are contained in a virtual machine or disk image. It is mainly useful as a "
28495 "first step to using L<virt-resize(1)>."
28499 #: ../tools/virt-list-partitions.pl:50
28501 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28502 "functionality. For more complex cases you should look at the "
28503 "L<guestfish(1)> tool."
28507 #: ../tools/virt-list-partitions.pl:107
28508 msgid "B<-h> | B<--human-readable>"
28512 #: ../tools/virt-list-partitions.pl:109
28513 msgid "Show sizes in human-readable form (eg. \"1G\")."
28517 #: ../tools/virt-list-partitions.pl:117
28519 "With this option, C<virt-list-partitions> displays the type and size of each "
28520 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28524 #: ../tools/virt-list-partitions.pl:124
28525 msgid "B<-t> | B<--total>"
28529 #: ../tools/virt-list-partitions.pl:126
28530 msgid "Display the total size of each block device (as a separate row or rows)."
28534 #: ../tools/virt-list-partitions.pl:259
28536 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
28537 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
28538 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."