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.17\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-30 15:00+0000\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=utf-8\n"
17 "Content-Transfer-Encoding: ENCODING"
20 #: ../src/guestfs.pod:1 ../fish/guestfish.pod:1 ../test-tool/libguestfs-test-tool.pod:1 ../fuse/guestmount.pod:1 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
40 #: ../src/guestfs.pod:9
43 " #include <guestfs.h>\n"
48 #: ../src/guestfs.pod:11
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_sync (g);\n"
58 " guestfs_close (g);\n"
63 #: ../src/guestfs.pod:20
66 " cc prog.c -o prog -lguestfs\n"
68 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
73 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
78 #: ../src/guestfs.pod:26
80 "Libguestfs is a library for accessing and modifying guest disk images. "
81 "Amongst the things this is good for: making batch configuration changes to "
82 "guests, getting disk used/free statistics (see also: virt-df), migrating "
83 "between virtualization systems (see also: virt-p2v), performing partial "
84 "backups, performing partial guest clones, cloning guests and changing "
85 "registry/UUID/hostname info, and much else besides."
89 #: ../src/guestfs.pod:34
91 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
92 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
93 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
98 #: ../src/guestfs.pod:39
100 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
101 "what filesystem is in each LV, etc.). It can also run commands in the "
102 "context of the guest. Also you can access filesystems over FUSE."
106 #: ../src/guestfs.pod:44
108 "Libguestfs is a library that can be linked with C and C++ management "
109 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
110 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
115 #: ../src/guestfs.pod:49
117 "You don't need to be root to use libguestfs, although obviously you do need "
118 "enough permissions to access the disk images."
122 #: ../src/guestfs.pod:52
124 "Libguestfs is a large API because it can do many things. For a gentle "
125 "introduction, please read the L</API OVERVIEW> section next."
129 #: ../src/guestfs.pod:55
131 "There are also some example programs in the L<guestfs-examples(3)> manual "
136 #: ../src/guestfs.pod:58
141 #: ../src/guestfs.pod:60
143 "This section provides a gentler overview of the libguestfs API. We also try "
144 "to group API calls together, where that may not be obvious from reading "
145 "about the individual calls in the main section of this manual."
149 #: ../src/guestfs.pod:65
154 #: ../src/guestfs.pod:67
156 "Before you can use libguestfs calls, you have to create a handle. Then you "
157 "must add at least one disk image to the handle, followed by launching the "
158 "handle, then performing whatever operations you want, and finally closing "
159 "the handle. By convention we use the single letter C<g> for the name of the "
160 "handle variable, although of course you can use any name you want."
164 #: ../src/guestfs.pod:74
165 msgid "The general structure of all libguestfs-using programs looks like this:"
169 #: ../src/guestfs.pod:77
172 " guestfs_h *g = guestfs_create ();\n"
177 #: ../src/guestfs.pod:79
180 " /* Call guestfs_add_drive additional times if there are\n"
181 " * multiple disk images.\n"
183 " guestfs_add_drive (g, \"guest.img\");\n"
188 #: ../src/guestfs.pod:84
191 " /* Most manipulation calls won't work until you've launched\n"
192 " * the handle 'g'. You have to do this _after_ adding drives\n"
193 " * and _before_ other commands.\n"
195 " guestfs_launch (g);\n"
200 #: ../src/guestfs.pod:90
203 " /* Now you can examine what partitions, LVs etc are available.\n"
205 " char **partitions = guestfs_list_partitions (g);\n"
206 " char **logvols = guestfs_lvs (g);\n"
211 #: ../src/guestfs.pod:95
214 " /* To access a filesystem in the image, you must mount it.\n"
216 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
221 #: ../src/guestfs.pod:99
224 " /* Now you can perform filesystem actions on the guest\n"
227 " guestfs_touch (g, \"/hello\");\n"
232 #: ../src/guestfs.pod:104
235 " /* You only need to call guestfs_sync if you have made\n"
236 " * changes to the guest image. (But if you've made changes\n"
237 " * then you *must* sync). See also: guestfs_umount and\n"
238 " * guestfs_umount_all calls.\n"
240 " guestfs_sync (g);\n"
245 #: ../src/guestfs.pod:111
248 " /* Close the handle 'g'. */\n"
249 " guestfs_close (g);\n"
254 #: ../src/guestfs.pod:114
256 "The code above doesn't include any error checking. In real code you should "
257 "check return values carefully for errors. In general all functions that "
258 "return integers return C<-1> on error, and all functions that return "
259 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
260 "how to handle errors, and consult the documentation for each function call "
261 "below to see precisely how they return error indications."
265 #: ../src/guestfs.pod:122
270 #: ../src/guestfs.pod:124
272 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
273 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
274 "actual block device, or simply an empty file of zeroes that you have created "
275 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
280 #: ../src/guestfs.pod:130
282 "The call you should use in modern code for adding drives is "
283 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
284 "specifying that the format is raw, do:"
288 #: ../src/guestfs.pod:134
291 " guestfs_add_drive_opts (g, filename,\n"
292 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
298 #: ../src/guestfs.pod:138
299 msgid "You can add a disk read-only using:"
303 #: ../src/guestfs.pod:140
306 " guestfs_add_drive_opts (g, filename,\n"
307 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
308 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
314 #: ../src/guestfs.pod:145
316 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
317 "libguestfs won't modify the file."
321 #: ../src/guestfs.pod:148
323 "Be extremely cautious if the disk image is in use, eg. if it is being used "
324 "by a virtual machine. Adding it read-write will almost certainly cause disk "
325 "corruption, but adding it read-only is safe."
329 #: ../src/guestfs.pod:152
331 "You must add at least one disk image, and you may add multiple disk images. "
332 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
333 "first one you added), C</dev/sdb> (for the second one you added), etc."
337 #: ../src/guestfs.pod:157
339 "Once L</guestfs_launch> has been called you cannot add any more images. You "
340 "can call L</guestfs_list_devices> to get a list of the device names, in the "
341 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
345 #: ../src/guestfs.pod:162
350 #: ../src/guestfs.pod:164
352 "Before you can read or write files, create directories and so on in a disk "
353 "image that contains filesystems, you have to mount those filesystems using "
354 "L</guestfs_mount>. If you already know that a disk image contains (for "
355 "example) one partition with a filesystem on that partition, then you can "
360 #: ../src/guestfs.pod:170
363 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
368 #: ../src/guestfs.pod:172
370 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
371 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
372 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
376 #: ../src/guestfs.pod:176
378 "If you are given a disk image and you don't know what it contains then you "
379 "have to find out. Libguestfs can do that too: use "
380 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
381 "and LVs, and either try mounting each to see what is mountable, or else "
382 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also "
383 "has a set of APIs for inspection of disk images (see L</INSPECTION> below). "
384 "But you might find it easier to look at higher level programs built on top "
385 "of libguestfs, in particular L<virt-inspector(1)>."
389 #: ../src/guestfs.pod:186
391 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
392 "several other variations of the C<guestfs_mount_*> call."
396 #: ../src/guestfs.pod:189
397 msgid "FILESYSTEM ACCESS AND MODIFICATION"
401 #: ../src/guestfs.pod:191
403 "The majority of the libguestfs API consists of fairly low-level calls for "
404 "accessing and modifying the files, directories, symlinks etc on mounted "
405 "filesystems. There are over a hundred such calls which you can find listed "
406 "in detail below in this man page, and we don't even pretend to cover them "
407 "all in this overview."
411 #: ../src/guestfs.pod:197
413 "Specify filenames as full paths, starting with C<\"/\"> and including the "
418 #: ../src/guestfs.pod:200
420 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
421 "the file called C<\"etc/passwd\"> then you could do:"
425 #: ../src/guestfs.pod:203
428 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
433 #: ../src/guestfs.pod:205
435 "This would return C<data> as a newly allocated buffer containing the full "
436 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
437 "or C<NULL> if there was an error."
441 #: ../src/guestfs.pod:209
443 "As another example, to create a top-level directory on that filesystem "
444 "called C<\"var\"> you would do:"
448 #: ../src/guestfs.pod:212
451 " guestfs_mkdir (g, \"/var\");\n"
456 #: ../src/guestfs.pod:214
457 msgid "To create a symlink you could do:"
461 #: ../src/guestfs.pod:216
464 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
465 " \"/etc/rc3.d/S30portmap\");\n"
470 #: ../src/guestfs.pod:219
472 "Libguestfs will reject attempts to use relative paths and there is no "
473 "concept of a current working directory."
477 #: ../src/guestfs.pod:222
479 "Libguestfs can return errors in many situations: for example if the "
480 "filesystem isn't writable, or if a file or directory that you requested "
481 "doesn't exist. If you are using the C API (documented here) you have to "
482 "check for those error conditions after each call. (Other language bindings "
483 "turn these errors into exceptions)."
487 #: ../src/guestfs.pod:228
489 "File writes are affected by the per-handle umask, set by calling "
490 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
494 #: ../src/guestfs.pod:231
499 #: ../src/guestfs.pod:233
501 "Libguestfs contains API calls to read, create and modify partition tables on "
506 #: ../src/guestfs.pod:236
508 "In the common case where you want to create a single partition covering the "
509 "whole disk, you should use the L</guestfs_part_disk> call:"
513 #: ../src/guestfs.pod:240
516 " const char *parttype = \"mbr\";\n"
517 " if (disk_is_larger_than_2TB)\n"
518 " parttype = \"gpt\";\n"
519 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
524 #: ../src/guestfs.pod:245
526 "Obviously this effectively wipes anything that was on that disk image "
531 #: ../src/guestfs.pod:248
536 #: ../src/guestfs.pod:250
538 "Libguestfs provides access to a large part of the LVM2 API, such as "
539 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
540 "unless you familiarize yourself with the concepts of physical volumes, "
541 "volume groups and logical volumes."
545 #: ../src/guestfs.pod:255
547 "This author strongly recommends reading the LVM HOWTO, online at "
548 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
552 #: ../src/guestfs.pod:258
557 #: ../src/guestfs.pod:260
559 "Use L</guestfs_cat> to download small, text only files. This call is "
560 "limited to files which are less than 2 MB and which cannot contain any ASCII "
561 "NUL (C<\\0>) characters. However it has a very simple to use API."
565 #: ../src/guestfs.pod:265
567 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
568 "bit data, since it returns a (pointer, size) pair. However it is still "
569 "limited to \"small\" files, less than 2 MB."
573 #: ../src/guestfs.pod:269
575 "L</guestfs_download> can be used to download any file, with no limits on "
576 "content or size (even files larger than 4 GB)."
580 #: ../src/guestfs.pod:272
581 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
585 #: ../src/guestfs.pod:275
590 #: ../src/guestfs.pod:277
592 "It's often the case that you want to write a file or files to the disk "
597 #: ../src/guestfs.pod:280
599 "To write a small file with fixed content, use L</guestfs_write>. To create "
600 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
601 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
602 "variety of other functions for creating test files, for example "
603 "L</guestfs_fill> and L</guestfs_fill_pattern>."
607 #: ../src/guestfs.pod:286
609 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
610 "file content or size (even files larger than 4 GB)."
614 #: ../src/guestfs.pod:289
615 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
619 #: ../src/guestfs.pod:291
621 "However the fastest way to upload I<large numbers of arbitrary files> is to "
622 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
623 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
624 "the drive in a predictable way (eg. adding it last after all other drives) "
625 "then you can get the device name from L</guestfs_list_devices> and mount it "
626 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
627 "sometimes non-portable between kernel versions, and they don't support "
628 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
629 "using a label or UUID, use an ISO image instead."
633 #: ../src/guestfs.pod:302
638 #: ../src/guestfs.pod:304
640 "There are various different commands for copying between files and devices "
641 "and in and out of the guest filesystem. These are summarised in the table "
646 #: ../src/guestfs.pod:310
647 msgid "B<file> to B<file>"
651 #: ../src/guestfs.pod:312
653 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
654 "directories recursively."
658 #: ../src/guestfs.pod:315
659 msgid "B<file or device> to B<file or device>"
663 #: ../src/guestfs.pod:317
665 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
666 "devices in the guest."
670 #: ../src/guestfs.pod:320
671 msgid "Example: duplicate the contents of an LV:"
675 #: ../src/guestfs.pod:322
678 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
683 #: ../src/guestfs.pod:324
685 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
686 "(C</dev/VG/Original>). To copy less than the whole source device, use "
687 "L</guestfs_copy_size>."
691 #: ../src/guestfs.pod:328
692 msgid "B<file on the host> to B<file or device>"
696 #: ../src/guestfs.pod:330
697 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
701 #: ../src/guestfs.pod:332
702 msgid "B<file or device> to B<file on the host>"
706 #: ../src/guestfs.pod:334
707 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
711 #: ../src/guestfs.pod:338
712 msgid "LISTING FILES"
716 #: ../src/guestfs.pod:340
718 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
719 "L<guestfish(1)>-equivalent command C<ll>)."
723 #: ../src/guestfs.pod:343
725 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
726 "programs, as a flat list of strings."
730 #: ../src/guestfs.pod:346
732 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
733 "directory, plus additional information about each one. It is more "
734 "equivalent to using the L<readdir(3)> call on a local filesystem."
738 #: ../src/guestfs.pod:350
740 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
745 #: ../src/guestfs.pod:353
746 msgid "RUNNING COMMANDS"
750 #: ../src/guestfs.pod:355
752 "Although libguestfs is primarily an API for manipulating files inside guest "
753 "images, we also provide some limited facilities for running commands inside "
758 #: ../src/guestfs.pod:359
759 msgid "There are many limitations to this:"
763 #: ../src/guestfs.pod:363 ../src/guestfs.pod:368 ../src/guestfs.pod:373 ../src/guestfs.pod:377 ../src/guestfs.pod:382 ../src/guestfs.pod:386 ../src/guestfs.pod:391 ../src/guestfs.pod:396 ../src/guestfs.pod:955 ../src/guestfs.pod:959 ../src/guestfs.pod:963 ../src/guestfs.pod:968 ../src/guestfs.pod:976 ../src/guestfs.pod:995 ../src/guestfs.pod:1003 ../src/guestfs.pod:1025 ../src/guestfs.pod:1029 ../src/guestfs.pod:1033 ../src/guestfs.pod:1037 ../src/guestfs.pod:1041 ../src/guestfs.pod:1045 ../src/guestfs.pod:1527 ../src/guestfs.pod:1532 ../src/guestfs.pod:1536 ../src/guestfs.pod:1646 ../src/guestfs.pod:1651 ../src/guestfs.pod:1655 ../src/guestfs.pod:1999 ../src/guestfs.pod:2005 ../src/guestfs.pod:2010 ../src/guestfs.pod:2016 ../src/guestfs.pod:2128 ../src/guestfs.pod:2132 ../src/guestfs.pod:2136 ../src/guestfs.pod:2140 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:571 ../src/guestfs-actions.pod:579 ../src/guestfs-actions.pod:586 ../src/guestfs-actions.pod:593 ../src/guestfs-actions.pod:1589 ../src/guestfs-actions.pod:1593 ../src/guestfs-actions.pod:1597 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:1609 ../src/guestfs-actions.pod:1613 ../src/guestfs-actions.pod:1617 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1631 ../src/guestfs-actions.pod:1635 ../src/guestfs-actions.pod:1773 ../src/guestfs-actions.pod:1777 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1787 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:1852 ../src/guestfs-actions.pod:1857 ../fish/guestfish.pod:377 ../fish/guestfish.pod:381 ../fish/guestfish.pod:385 ../fish/guestfish.pod:389 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:375 ../fish/guestfish-actions.pod:383 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:397 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1071 ../fish/guestfish-actions.pod:1075 ../fish/guestfish-actions.pod:1079 ../fish/guestfish-actions.pod:1087 ../fish/guestfish-actions.pod:1091 ../fish/guestfish-actions.pod:1095 ../fish/guestfish-actions.pod:1105 ../fish/guestfish-actions.pod:1109 ../fish/guestfish-actions.pod:1113 ../fish/guestfish-actions.pod:1203 ../fish/guestfish-actions.pod:1207 ../fish/guestfish-actions.pod:1212 ../fish/guestfish-actions.pod:1217 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1263 ../fish/guestfish-actions.pod:1268 ../tools/virt-resize.pl:345 ../tools/virt-resize.pl:350 ../tools/virt-resize.pl:360
768 #: ../src/guestfs.pod:365
770 "The kernel version that the command runs under will be different from what "
775 #: ../src/guestfs.pod:370
777 "If the command needs to communicate with daemons, then most likely they "
782 #: ../src/guestfs.pod:375
783 msgid "The command will be running in limited memory."
787 #: ../src/guestfs.pod:379
789 "The network may not be available unless you enable it (see "
790 "L</guestfs_set_network>)."
794 #: ../src/guestfs.pod:384
795 msgid "Only supports Linux guests (not Windows, BSD, etc)."
799 #: ../src/guestfs.pod:388
800 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
804 #: ../src/guestfs.pod:393
806 "For SELinux guests, you may need to enable SELinux and load policy first. "
807 "See L</SELINUX> in this manpage."
811 #: ../src/guestfs.pod:398
813 "I<Security:> It is not safe to run commands from untrusted, possibly "
814 "malicious guests. These commands may attempt to exploit your program by "
815 "sending unexpected output. They could also try to exploit the Linux kernel "
816 "or qemu provided by the libguestfs appliance. They could use the network "
817 "provided by the libguestfs appliance to bypass ordinary network partitions "
818 "and firewalls. They could use the elevated privileges or different SELinux "
819 "context of your program to their advantage."
823 #: ../src/guestfs.pod:407
825 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
826 "(a script which runs when the guest next boots normally), and to have this "
827 "script run the commands you want in the normal context of the running guest, "
828 "network security and so on. For information about other security issues, "
833 #: ../src/guestfs.pod:415
835 "The two main API calls to run commands are L</guestfs_command> and "
836 "L</guestfs_sh> (there are also variations)."
840 #: ../src/guestfs.pod:418
842 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
843 "shell globs, redirections, etc will work."
847 #: ../src/guestfs.pod:421
848 msgid "CONFIGURATION FILES"
852 #: ../src/guestfs.pod:423
854 "To read and write configuration files in Linux guest filesystems, we "
855 "strongly recommend using Augeas. For example, Augeas understands how to "
856 "read and write, say, a Linux shadow password file or X.org configuration "
857 "file, and so avoids you having to write that code."
861 #: ../src/guestfs.pod:428
863 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
864 "document Augeas itself here because there is excellent documentation on the "
865 "L<http://augeas.net/> website."
869 #: ../src/guestfs.pod:432
871 "If you don't want to use Augeas (you fool!) then try calling "
872 "L</guestfs_read_lines> to get the file as a list of lines which you can "
877 #: ../src/guestfs.pod:436
882 #: ../src/guestfs.pod:438
884 "We support SELinux guests. To ensure that labeling happens correctly in "
885 "SELinux guests, you need to enable SELinux and load the guest's policy:"
889 #: ../src/guestfs.pod:444 ../src/guestfs.pod:1148 ../src/guestfs.pod:1279
894 #: ../src/guestfs.pod:446
895 msgid "Before launching, do:"
899 #: ../src/guestfs.pod:448
902 " guestfs_set_selinux (g, 1);\n"
907 #: ../src/guestfs.pod:450 ../src/guestfs.pod:1152 ../src/guestfs.pod:1283
912 #: ../src/guestfs.pod:452
914 "After mounting the guest's filesystem(s), load the policy. This is best "
915 "done by running the L<load_policy(8)> command in the guest itself:"
919 #: ../src/guestfs.pod:456
922 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
927 #: ../src/guestfs.pod:458
929 "(Older versions of C<load_policy> require you to specify the name of the "
934 #: ../src/guestfs.pod:461 ../src/guestfs.pod:1289
939 #: ../src/guestfs.pod:463
941 "Optionally, set the security context for the API. The correct security "
942 "context to use can only be known by inspecting the guest. As an example:"
946 #: ../src/guestfs.pod:467
949 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
954 #: ../src/guestfs.pod:471
955 msgid "This will work for running commands and editing existing files."
959 #: ../src/guestfs.pod:473
961 "When new files are created, you may need to label them explicitly, for "
962 "example by running the external command C<restorecon pathname>."
966 #: ../src/guestfs.pod:477
971 #: ../src/guestfs.pod:479
973 "Certain calls are affected by the current file mode creation mask (the "
974 "\"umask\"). In particular ones which create files or directories, such as "
975 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
976 "either the default mode that the file is created with or modifies the mode "
981 #: ../src/guestfs.pod:485
983 "The default umask is C<022>, so files are created with modes such as C<0644> "
984 "and directories with C<0755>."
988 #: ../src/guestfs.pod:488
990 "There are two ways to avoid being affected by umask. Either set umask to 0 "
991 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
992 "L</guestfs_chmod> after creating each file or directory."
996 #: ../src/guestfs.pod:492
997 msgid "For more information about umask, see L<umask(2)>."
1001 #: ../src/guestfs.pod:494 ../fish/guestfish.pod:670
1002 msgid "ENCRYPTED DISKS"
1006 #: ../src/guestfs.pod:496
1008 "Libguestfs allows you to access Linux guests which have been encrypted using "
1009 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1010 "standard. This includes nearly all whole disk encryption systems used by "
1011 "modern Linux guests."
1015 #: ../src/guestfs.pod:502
1017 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1018 "returns the string C<crypto_LUKS>)."
1022 #: ../src/guestfs.pod:505
1024 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1025 "will require the passphrase!"
1029 #: ../src/guestfs.pod:508
1031 "Opening a LUKS device creates a new device mapper device called "
1032 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1033 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1034 "decrypted from and encrypted to the underlying block device respectively."
1038 #: ../src/guestfs.pod:514
1040 "LVM volume groups on the device can be made visible by calling "
1041 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1042 "volume(s) can now be mounted in the usual way."
1046 #: ../src/guestfs.pod:518
1048 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1049 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1050 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1051 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1052 "underlying encrypted block device)."
1056 #: ../src/guestfs.pod:525
1061 #: ../src/guestfs.pod:527
1063 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1064 "contains operating systems. (These APIs used to be in a separate Perl-only "
1065 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1066 "frequently used part of this library has been rewritten in C and moved into "
1071 #: ../src/guestfs.pod:533
1073 "Add all disks belonging to the unknown virtual machine and call "
1074 "L</guestfs_launch> in the usual way."
1078 #: ../src/guestfs.pod:536
1080 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1081 "and certain heuristics, and returns a list of operating systems that were "
1082 "found. An empty list means none were found. A single element is the root "
1083 "filesystem of the operating system. For dual- or multi-boot guests, "
1084 "multiple roots can be returned, each one corresponding to a separate "
1085 "operating system. (Multi-boot virtual machines are extremely rare in the "
1086 "world of virtualization, but since this scenario can happen, we have built "
1087 "libguestfs to deal with it.)"
1091 #: ../src/guestfs.pod:545
1093 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1094 "to get additional details about that operating system. For example, call "
1095 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1096 "Windows and Linux-based operating systems respectively."
1100 #: ../src/guestfs.pod:551
1102 "Un*x-like and Linux-based operating systems usually consist of several "
1103 "filesystems which are mounted at boot time (for example, a separate boot "
1104 "partition mounted on C</boot>). The inspection rules are able to detect how "
1105 "filesystems correspond to mount points. Call "
1106 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1107 "hash table like this example:"
1111 #: ../src/guestfs.pod:558
1114 " /boot => /dev/sda1\n"
1115 " / => /dev/vg_guest/lv_root\n"
1116 " /usr => /dev/vg_guest/lv_usr\n"
1121 #: ../src/guestfs.pod:562
1123 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1124 "filesystems as suggested."
1128 #: ../src/guestfs.pod:565
1130 "Be careful to mount filesystems in the right order (eg. C</> before "
1131 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1136 #: ../src/guestfs.pod:569
1138 "Inspection currently only works for some common operating systems. "
1139 "Contributors are welcome to send patches for other operating systems that we "
1140 "currently cannot detect."
1144 #: ../src/guestfs.pod:573
1146 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1147 "for more details. The L</guestfs_inspect_os> function just ignores any "
1148 "encrypted devices."
1152 #: ../src/guestfs.pod:577
1154 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1155 "inspection and caches the results in the guest handle. Subsequent calls to "
1156 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1157 "re-read the disks. If you change the content of the guest disks, you can "
1158 "redo inspection by calling L</guestfs_inspect_os> again. "
1159 "(L</guestfs_inspect_list_applications> works a little differently from the "
1160 "other calls and does read the disks. See documentation for that function "
1165 #: ../src/guestfs.pod:586
1166 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1170 #: ../src/guestfs.pod:588
1172 "Libguestfs can mount NTFS partitions. It does this using the "
1173 "L<http://www.ntfs-3g.org/> driver."
1177 #: ../src/guestfs.pod:591
1179 "DOS and Windows still use drive letters, and the filesystems are always "
1180 "treated as case insensitive by Windows itself, and therefore you might find "
1181 "a Windows configuration file referring to a path like "
1182 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1183 "that directory might be referred to as C</WINDOWS/System32>."
1187 #: ../src/guestfs.pod:597
1189 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1190 "libguestfs to read the appropriate Windows Registry and configuration files, "
1191 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1192 "L<virt-inspector(1)>)."
1196 #: ../src/guestfs.pod:602
1198 "Replacing backslash characters with forward slash characters is also outside "
1199 "the scope of libguestfs, but something that you can easily do."
1203 #: ../src/guestfs.pod:605
1205 "Where we can help is in resolving the case insensitivity of paths. For "
1206 "this, call L</guestfs_case_sensitive_path>."
1210 #: ../src/guestfs.pod:608
1212 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1213 "files, through the library C<hivex> which is part of the libguestfs project "
1214 "although ships as a separate tarball. You have to locate and download the "
1215 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1216 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1217 "L<virt-win-reg(1)> for more help on this issue."
1221 #: ../src/guestfs.pod:616
1222 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1226 #: ../src/guestfs.pod:618
1228 "Although we don't want to discourage you from using the C API, we will "
1229 "mention here that the same API is also available in other languages."
1233 #: ../src/guestfs.pod:621
1235 "The API is broadly identical in all supported languages. This means that "
1236 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1237 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1238 "words, a straightforward, predictable isomorphism between each language."
1242 #: ../src/guestfs.pod:627
1244 "Error messages are automatically transformed into exceptions if the language "
1249 #: ../src/guestfs.pod:630
1251 "We don't try to \"object orientify\" parts of the API in OO languages, "
1252 "although contributors are welcome to write higher level APIs above what we "
1253 "provide in their favourite languages if they wish."
1257 #: ../src/guestfs.pod:636
1262 #: ../src/guestfs.pod:638
1264 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1265 "identical to the C API. C++ classes and exceptions are not used."
1269 #: ../src/guestfs.pod:642
1274 #: ../src/guestfs.pod:644
1276 "The C# bindings are highly experimental. Please read the warnings at the "
1277 "top of C<csharp/Libguestfs.cs>."
1281 #: ../src/guestfs.pod:647
1286 #: ../src/guestfs.pod:649
1288 "This is the only language binding that is working but incomplete. Only "
1289 "calls which return simple integers have been bound in Haskell, and we are "
1290 "looking for help to complete this binding."
1294 #: ../src/guestfs.pod:653
1299 #: ../src/guestfs.pod:655
1301 "Full documentation is contained in the Javadoc which is distributed with "
1306 #: ../src/guestfs.pod:658
1311 #: ../src/guestfs.pod:660
1312 msgid "For documentation see L<guestfs-ocaml(3)>."
1316 #: ../src/guestfs.pod:662
1321 #: ../src/guestfs.pod:664
1322 msgid "For documentation see L<Sys::Guestfs(3)>."
1326 #: ../src/guestfs.pod:666
1331 #: ../src/guestfs.pod:668
1333 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1334 "the php-libguestfs package for your distribution."
1338 #: ../src/guestfs.pod:671
1339 msgid "The PHP binding only works correctly on 64 bit machines."
1343 #: ../src/guestfs.pod:673
1348 #: ../src/guestfs.pod:675
1349 msgid "For documentation see L<guestfs-python(3)>."
1353 #: ../src/guestfs.pod:677
1358 #: ../src/guestfs.pod:679
1359 msgid "For documentation see L<guestfs-ruby(3)>."
1363 #: ../src/guestfs.pod:681
1364 msgid "B<shell scripts>"
1368 #: ../src/guestfs.pod:683
1369 msgid "For documentation see L<guestfish(1)>."
1373 #: ../src/guestfs.pod:687
1374 msgid "LIBGUESTFS GOTCHAS"
1378 #: ../src/guestfs.pod:689
1380 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1381 "system [...] that works in the way it is documented but is counterintuitive "
1382 "and almost invites mistakes.\""
1386 #: ../src/guestfs.pod:693
1388 "Since we developed libguestfs and the associated tools, there are several "
1389 "things we would have designed differently, but are now stuck with for "
1390 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1391 "release, you can expect these to change. Beware of them."
1395 #: ../src/guestfs.pod:701
1396 msgid "Autosync / forgetting to sync."
1400 #: ../src/guestfs.pod:703
1402 "When modifying a filesystem from C or another language, you B<must> unmount "
1403 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1404 "libguestfs handle. You can also call:"
1408 #: ../src/guestfs.pod:707
1411 " guestfs_set_autosync (g, 1);\n"
1416 #: ../src/guestfs.pod:709
1418 "to have the unmount/sync done automatically for you when the handle 'g' is "
1419 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1424 #: ../src/guestfs.pod:713
1426 "If you forget to do this, then it is entirely possible that your changes "
1427 "won't be written out, or will be partially written, or (very rarely) that "
1428 "you'll get disk corruption."
1432 #: ../src/guestfs.pod:717
1434 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1435 "guestfish scripts that forget to sync will work just fine, which can make "
1436 "this very puzzling if you are trying to debug a problem."
1440 #: ../src/guestfs.pod:721
1442 "Update: Autosync is enabled by default for all API users starting from "
1443 "libguestfs 1.5.24."
1447 #: ../src/guestfs.pod:724
1448 msgid "Mount option C<-o sync> should not be the default."
1452 #: ../src/guestfs.pod:726
1454 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1455 "However C<-o sync> does not add any reliability benefit, but does have a "
1456 "very large performance impact."
1460 #: ../src/guestfs.pod:730
1462 "The work around is to use L</guestfs_mount_options> and set the mount "
1463 "options that you actually want to use."
1467 #: ../src/guestfs.pod:733
1468 msgid "Read-only should be the default."
1472 #: ../src/guestfs.pod:735
1474 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1475 "specify I<--rw> if you want to make changes to the image."
1479 #: ../src/guestfs.pod:738
1480 msgid "This would reduce the potential to corrupt live VM images."
1484 #: ../src/guestfs.pod:740
1486 "Note that many filesystems change the disk when you just mount and unmount, "
1487 "even if you didn't perform any writes. You need to use "
1488 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1492 #: ../src/guestfs.pod:744
1493 msgid "guestfish command line is hard to use."
1497 #: ../src/guestfs.pod:746
1499 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1500 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1501 "exist, so it fails. In earlier versions of guestfish the error message was "
1502 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1503 "we should have used C<guestfish -c command> to run commands."
1507 #: ../src/guestfs.pod:753
1508 msgid "guestfish megabyte modifiers don't work right on all commands"
1512 #: ../src/guestfs.pod:755
1514 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1515 "other modifiers). What guestfish actually does is to multiply the number "
1516 "part by the modifier part and pass the result to the C API. However this "
1517 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1518 "expecting some other unit (eg. megabytes)."
1522 #: ../src/guestfs.pod:762
1523 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1527 #: ../src/guestfs.pod:764
1530 " lvcreate LV VG 100M\n"
1535 #: ../src/guestfs.pod:766
1537 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1538 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1539 "megabytes * megabytes) logical volume. The error message you get from this "
1540 "is also a little obscure."
1544 #: ../src/guestfs.pod:771
1546 "This could be fixed in the generator by specially marking parameters and "
1547 "return values which take bytes or other units."
1551 #: ../src/guestfs.pod:774
1552 msgid "Ambiguity between devices and paths"
1556 #: ../src/guestfs.pod:776
1558 "There is a subtle ambiguity in the API between a device name "
1559 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1560 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1564 #: ../src/guestfs.pod:781
1566 "In the current API we usually resolve this ambiguity by having two separate "
1567 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1568 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1569 "detecting if the path supplied begins with C</dev/>."
1573 #: ../src/guestfs.pod:787
1575 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1576 "make paths/devices into structured names. One way to do this would be to "
1577 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1578 "aspect of grub. Another way would be to use a structured type, equivalent "
1579 "to this OCaml type:"
1583 #: ../src/guestfs.pod:793
1586 " type path = Path of string | Device of int | Partition of int * int\n"
1591 #: ../src/guestfs.pod:795
1592 msgid "which would allow you to pass arguments like:"
1596 #: ../src/guestfs.pod:797
1599 " Path \"/foo/bar\"\n"
1600 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1601 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1602 " Path \"/dev/sdb2\" (* not a device *)\n"
1607 #: ../src/guestfs.pod:802
1609 "As you can see there are still problems to resolve even with this "
1610 "representation. Also consider how it might work in guestfish."
1614 #: ../src/guestfs.pod:807
1615 msgid "PROTOCOL LIMITS"
1619 #: ../src/guestfs.pod:809
1621 "Internally libguestfs uses a message-based protocol to pass API calls and "
1622 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1623 "plenty more detail about this). The maximum message size used by the "
1624 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1625 "aware of this limit. The API calls which may be affected are individually "
1626 "documented, with a link back to this section of the documentation."
1630 #: ../src/guestfs.pod:817
1632 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1633 "a simple string. Because this string is at some point internally encoded as "
1634 "a message, the maximum size that it can return is slightly under 4 MB. If "
1635 "the requested file is larger than this then you will get an error."
1639 #: ../src/guestfs.pod:823
1641 "In order to transfer large files into and out of the guest filesystem, you "
1642 "need to use particular calls that support this. The sections L</UPLOADING> "
1643 "and L</DOWNLOADING> document how to do this."
1647 #: ../src/guestfs.pod:827
1649 "You might also consider mounting the disk image using our FUSE filesystem "
1650 "support (L<guestmount(1)>)."
1654 #: ../src/guestfs.pod:830
1655 msgid "KEYS AND PASSPHRASES"
1659 #: ../src/guestfs.pod:832
1661 "Certain libguestfs calls take a parameter that contains sensitive key "
1662 "material, passed in as a C string."
1666 #: ../src/guestfs.pod:835
1668 "In the future we would hope to change the libguestfs implementation so that "
1669 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1670 "swap. However this is I<not> done at the moment, because of the complexity "
1671 "of such an implementation."
1675 #: ../src/guestfs.pod:840
1677 "Therefore you should be aware that any key parameter you pass to libguestfs "
1678 "might end up being written out to the swap partition. If this is a concern, "
1679 "scrub the swap partition or don't use libguestfs on encrypted devices."
1683 #: ../src/guestfs.pod:845
1684 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1688 #: ../src/guestfs.pod:847
1690 "All high-level libguestfs actions are synchronous. If you want to use "
1691 "libguestfs asynchronously then you must create a thread."
1695 #: ../src/guestfs.pod:850
1697 "Only use the handle from a single thread. Either use the handle exclusively "
1698 "from one thread, or provide your own mutex so that two threads cannot issue "
1699 "calls on the same handle at the same time."
1703 #: ../src/guestfs.pod:854
1705 "See the graphical program guestfs-browser for one possible architecture for "
1706 "multithreaded programs using libvirt and libguestfs."
1710 #: ../src/guestfs.pod:857
1715 #: ../src/guestfs.pod:859
1717 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1722 #: ../src/guestfs.pod:862
1724 "By default it looks for these in the directory C<$libdir/guestfs> "
1725 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1729 #: ../src/guestfs.pod:865
1731 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1732 "to change the directories that libguestfs will search in. The value is a "
1733 "colon-separated list of paths. The current directory is I<not> searched "
1734 "unless the path contains an empty element or C<.>. For example "
1735 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1736 "then C</usr/lib/guestfs>."
1740 #: ../src/guestfs.pod:872
1741 msgid "QEMU WRAPPERS"
1745 #: ../src/guestfs.pod:874
1747 "If you want to compile your own qemu, run qemu from a non-standard location, "
1748 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1753 #: ../src/guestfs.pod:878
1755 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1756 "last command in the shell script (so that qemu replaces the shell and "
1757 "becomes the direct child of the libguestfs-using program). If you don't do "
1758 "this, then the qemu process won't be cleaned up correctly."
1762 #: ../src/guestfs.pod:883
1764 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1769 #: ../src/guestfs.pod:886
1773 " qemudir=/home/rjones/d/qemu\n"
1774 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1780 #: ../src/guestfs.pod:890
1782 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1783 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1788 #: ../src/guestfs.pod:894
1791 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1796 #: ../src/guestfs.pod:896
1798 "Note that libguestfs also calls qemu with the -help and -version options in "
1799 "order to determine features."
1803 #: ../src/guestfs.pod:899
1804 msgid "ABI GUARANTEE"
1808 #: ../src/guestfs.pod:901
1810 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1811 "actions as outlined in this section. Although we will deprecate some "
1812 "actions, for example if they get replaced by newer calls, we will keep the "
1813 "old actions forever. This allows you the developer to program in confidence "
1814 "against the libguestfs API."
1818 #: ../src/guestfs.pod:907
1819 msgid "BLOCK DEVICE NAMING"
1823 #: ../src/guestfs.pod:909
1825 "In the kernel there is now quite a profusion of schemata for naming block "
1826 "devices (in this context, by I<block device> I mean a physical or virtual "
1827 "hard drive). The original Linux IDE driver used names starting with "
1828 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1829 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1830 "replacement for the old IDE driver (particularly for SATA devices) those "
1831 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1832 "machines with paravirtualized drivers. This has created several different "
1833 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1838 #: ../src/guestfs.pod:921
1840 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1841 "Linux kernel to access block devices. We can run a variety of appliances "
1842 "based on a variety of Linux kernels."
1846 #: ../src/guestfs.pod:925
1848 "This causes a problem for libguestfs because many API calls use device or "
1849 "partition names. Working scripts and the recipe (example) scripts that we "
1850 "make available over the internet could fail if the naming scheme changes."
1854 #: ../src/guestfs.pod:930
1856 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1857 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1858 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1859 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1863 #: ../src/guestfs.pod:936
1865 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1866 "L</guestfs_list_partitions> and similar calls return the true names of the "
1867 "devices and partitions as known to the appliance."
1871 #: ../src/guestfs.pod:941
1872 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1876 #: ../src/guestfs.pod:943
1878 "Usually this translation is transparent. However in some (very rare) cases "
1879 "you may need to know the exact algorithm. Such cases include where you use "
1880 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1881 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1886 #: ../src/guestfs.pod:949
1888 "The algorithm is applied only to I<parameters> which are known to be either "
1889 "device or partition names. Return values from functions such as "
1890 "L</guestfs_list_devices> are never changed."
1894 #: ../src/guestfs.pod:957
1895 msgid "Is the string a parameter which is a device or partition name?"
1899 #: ../src/guestfs.pod:961
1900 msgid "Does the string begin with C</dev/sd>?"
1904 #: ../src/guestfs.pod:965
1906 "Does the named device exist? If so, we use that device. However if I<not> "
1907 "then we continue with this algorithm."
1911 #: ../src/guestfs.pod:970
1912 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1916 #: ../src/guestfs.pod:972
1917 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1921 #: ../src/guestfs.pod:974
1922 msgid "If that named device exists, use it. If not, continue."
1926 #: ../src/guestfs.pod:978
1927 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1931 #: ../src/guestfs.pod:980
1932 msgid "If that named device exists, use it. If not, return an error."
1936 #: ../src/guestfs.pod:984
1937 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1941 #: ../src/guestfs.pod:986
1943 "Although the standard naming scheme and automatic translation is useful for "
1944 "simple programs and guestfish scripts, for larger programs it is best not to "
1945 "rely on this mechanism."
1949 #: ../src/guestfs.pod:990
1951 "Where possible for maximum future portability programs using libguestfs "
1952 "should use these future-proof techniques:"
1956 #: ../src/guestfs.pod:997
1958 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
1959 "device names, and then use those names directly."
1963 #: ../src/guestfs.pod:1000
1964 msgid "Since those device names exist by definition, they will never be translated."
1968 #: ../src/guestfs.pod:1005
1970 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
1971 "filesystem labels."
1975 #: ../src/guestfs.pod:1010
1980 #: ../src/guestfs.pod:1012
1982 "This section discusses security implications of using libguestfs, "
1983 "particularly with untrusted or malicious guests or disk images."
1987 #: ../src/guestfs.pod:1015
1988 msgid "GENERAL SECURITY CONSIDERATIONS"
1992 #: ../src/guestfs.pod:1017
1994 "Be careful with any files or data that you download from a guest (by "
1995 "\"download\" we mean not just the L</guestfs_download> command but any "
1996 "command that reads files, filenames, directories or anything else from a "
1997 "disk image). An attacker could manipulate the data to fool your program "
1998 "into doing the wrong thing. Consider cases such as:"
2002 #: ../src/guestfs.pod:1027
2003 msgid "the data (file etc) not being present"
2007 #: ../src/guestfs.pod:1031
2008 msgid "being present but empty"
2012 #: ../src/guestfs.pod:1035
2013 msgid "being much larger than normal"
2017 #: ../src/guestfs.pod:1039
2018 msgid "containing arbitrary 8 bit data"
2022 #: ../src/guestfs.pod:1043
2023 msgid "being in an unexpected character encoding"
2027 #: ../src/guestfs.pod:1047
2028 msgid "containing homoglyphs."
2032 #: ../src/guestfs.pod:1051
2033 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2037 #: ../src/guestfs.pod:1053
2039 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2040 "(VFS) module can sometimes be escalated into exploits by deliberately "
2041 "creating a malicious, malformed filesystem. These exploits are very severe "
2042 "for two reasons. Firstly there are very many filesystem drivers in the "
2043 "kernel, and many of them are infrequently used and not much developer "
2044 "attention has been paid to the code. Linux userspace helps potential "
2045 "crackers by detecting the filesystem type and automatically choosing the "
2046 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2047 "the administrator. Secondly, a kernel-level exploit is like a local root "
2048 "exploit (worse in some ways), giving immediate and total access to the "
2049 "system right down to the hardware level."
2053 #: ../src/guestfs.pod:1066
2055 "That explains why you should never mount a filesystem from an untrusted "
2056 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2057 "inside a qemu virtual machine, usually running as a non-root user. The "
2058 "attacker would need to write a filesystem which first exploited the kernel, "
2059 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2060 "the libguestfs protocol, and finally to be as serious as the host kernel "
2061 "exploit it would need to escalate its privileges to root. This multi-step "
2062 "escalation, performed by a static piece of data, is thought to be extremely "
2063 "hard to do, although we never say 'never' about security issues."
2067 #: ../src/guestfs.pod:1077
2069 "In any case callers can reduce the attack surface by forcing the filesystem "
2070 "type when mounting (use L</guestfs_mount_vfs>)."
2074 #: ../src/guestfs.pod:1080
2075 msgid "PROTOCOL SECURITY"
2079 #: ../src/guestfs.pod:1082
2081 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2082 "defined upper message size. However a program that uses libguestfs must "
2083 "also take care - for example you can write a program that downloads a binary "
2084 "from a disk image and executes it locally, and no amount of protocol "
2085 "security will save you from the consequences."
2089 #: ../src/guestfs.pod:1088
2090 msgid "INSPECTION SECURITY"
2094 #: ../src/guestfs.pod:1090
2096 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2097 "directly from the guest, and these could contain any 8 bit data. Callers "
2098 "should be careful to escape these before printing them to a structured file "
2099 "(for example, use HTML escaping if creating a web page)."
2103 #: ../src/guestfs.pod:1096
2105 "Guest configuration may be altered in unusual ways by the administrator of "
2106 "the virtual machine, and may not reflect reality (particularly for untrusted "
2107 "or actively malicious guests). For example we parse the hostname from "
2108 "configuration files like C</etc/sysconfig/network> that we find in the "
2109 "guest, but the guest administrator can easily manipulate these files to "
2110 "provide the wrong hostname."
2114 #: ../src/guestfs.pod:1104
2116 "The inspection API parses guest configuration using two external libraries: "
2117 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2118 "designed to be robust in the face of malicious data, although denial of "
2119 "service attacks are still possible, for example with oversized configuration "
2124 #: ../src/guestfs.pod:1110
2125 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2129 #: ../src/guestfs.pod:1112
2131 "Be very cautious about running commands from the guest. By running a "
2132 "command in the guest, you are giving CPU time to a binary that you do not "
2133 "control, under the same user account as the library, albeit wrapped in qemu "
2134 "virtualization. More information and alternatives can be found in the "
2135 "section L</RUNNING COMMANDS>."
2139 #: ../src/guestfs.pod:1118
2140 msgid "CVE-2010-3851"
2144 #: ../src/guestfs.pod:1120
2145 msgid "https://bugzilla.redhat.com/642934"
2149 #: ../src/guestfs.pod:1122
2151 "This security bug concerns the automatic disk format detection that qemu "
2152 "does on disk images."
2156 #: ../src/guestfs.pod:1125
2158 "A raw disk image is just the raw bytes, there is no header. Other disk "
2159 "images like qcow2 contain a special header. Qemu deals with this by looking "
2160 "for one of the known headers, and if none is found then assuming the disk "
2161 "image must be raw."
2165 #: ../src/guestfs.pod:1130
2167 "This allows a guest which has been given a raw disk image to write some "
2168 "other header. At next boot (or when the disk image is accessed by "
2169 "libguestfs) qemu would do autodetection and think the disk image format was, "
2170 "say, qcow2 based on the header written by the guest."
2174 #: ../src/guestfs.pod:1135
2176 "This in itself would not be a problem, but qcow2 offers many features, one "
2177 "of which is to allow a disk image to refer to another image (called the "
2178 "\"backing disk\"). It does this by placing the path to the backing disk "
2179 "into the qcow2 header. This path is not validated and could point to any "
2180 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2181 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2182 "control of the attacker."
2186 #: ../src/guestfs.pod:1143
2187 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2191 #: ../src/guestfs.pod:1150
2192 msgid "You have enabled the network or have opened the disk in write mode."
2196 #: ../src/guestfs.pod:1154
2198 "You are also running untrusted code from the guest (see L</RUNNING "
2203 #: ../src/guestfs.pod:1159
2205 "The way to avoid this is to specify the expected disk format when adding "
2206 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2207 "should always do this if the disk is raw format, and it's a good idea for "
2212 #: ../src/guestfs.pod:1164
2214 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2215 "format is fetched from libvirt and passed through."
2219 #: ../src/guestfs.pod:1167
2221 "For libguestfs tools, use the I<--format> command line parameter as "
2226 #: ../src/guestfs.pod:1170
2227 msgid "CONNECTION MANAGEMENT"
2231 #: ../src/guestfs.pod:1172
2236 #: ../src/guestfs.pod:1174
2238 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2239 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2240 "handle and release all resources used."
2244 #: ../src/guestfs.pod:1178
2246 "For information on using multiple handles and threads, see the section "
2247 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2251 #: ../src/guestfs.pod:1181
2252 msgid "guestfs_create"
2256 #: ../src/guestfs.pod:1183
2259 " guestfs_h *guestfs_create (void);\n"
2264 #: ../src/guestfs.pod:1185
2265 msgid "Create a connection handle."
2269 #: ../src/guestfs.pod:1187
2271 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2272 "on the handle at least once."
2276 #: ../src/guestfs.pod:1190
2278 "This function returns a non-NULL pointer to a handle on success or NULL on "
2283 #: ../src/guestfs.pod:1193
2284 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2288 #: ../src/guestfs.pod:1195
2290 "You may also want to configure error handling for the handle. See L</ERROR "
2291 "HANDLING> section below."
2295 #: ../src/guestfs.pod:1198
2296 msgid "guestfs_close"
2300 #: ../src/guestfs.pod:1200
2303 " void guestfs_close (guestfs_h *g);\n"
2308 #: ../src/guestfs.pod:1202
2309 msgid "This closes the connection handle and frees up all resources used."
2313 #: ../src/guestfs.pod:1204
2314 msgid "ERROR HANDLING"
2318 #: ../src/guestfs.pod:1206
2320 "API functions can return errors. For example, almost all functions that "
2321 "return C<int> will return C<-1> to indicate an error."
2325 #: ../src/guestfs.pod:1209
2327 "Additional information is available for errors: an error message string and "
2328 "optionally an error number (errno) if the thing that failed was a system "
2333 #: ../src/guestfs.pod:1213
2335 "You can get at the additional information about the last error on the handle "
2336 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2337 "up an error handler with L</guestfs_set_error_handler>."
2341 #: ../src/guestfs.pod:1218
2343 "When the handle is created, a default error handler is installed which "
2344 "prints the error message string to C<stderr>. For small short-running "
2345 "command line programs it is sufficient to do:"
2349 #: ../src/guestfs.pod:1222
2352 " if (guestfs_launch (g) == -1)\n"
2353 " exit (EXIT_FAILURE);\n"
2358 #: ../src/guestfs.pod:1225
2360 "since the default error handler will ensure that an error message has been "
2361 "printed to C<stderr> before the program exits."
2365 #: ../src/guestfs.pod:1228
2367 "For other programs the caller will almost certainly want to install an "
2368 "alternate error handler or do error handling in-line like this:"
2372 #: ../src/guestfs.pod:1231
2375 " g = guestfs_create ();\n"
2380 #: ../src/guestfs.pod:1233
2383 " /* This disables the default behaviour of printing errors\n"
2385 " guestfs_set_error_handler (g, NULL, NULL);\n"
2390 #: ../src/guestfs.pod:1237
2393 " if (guestfs_launch (g) == -1) {\n"
2394 " /* Examine the error message and print it etc. */\n"
2395 " char *msg = guestfs_last_error (g);\n"
2396 " int errnum = guestfs_last_errno (g);\n"
2397 " fprintf (stderr, \"%s\\n\", msg);\n"
2404 #: ../src/guestfs.pod:1245
2406 "Out of memory errors are handled differently. The default action is to call "
2407 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2408 "L</guestfs_set_out_of_memory_handler>."
2412 #: ../src/guestfs.pod:1249
2414 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2415 "because there is no handle if this happens there is no way to get additional "
2416 "error information. However L</guestfs_create> is supposed to be a "
2417 "lightweight operation which can only fail because of insufficient memory (it "
2418 "returns NULL in this case)."
2422 #: ../src/guestfs.pod:1255
2423 msgid "guestfs_last_error"
2427 #: ../src/guestfs.pod:1257
2430 " const char *guestfs_last_error (guestfs_h *g);\n"
2435 #: ../src/guestfs.pod:1259
2437 "This returns the last error message that happened on C<g>. If there has not "
2438 "been an error since the handle was created, then this returns C<NULL>."
2442 #: ../src/guestfs.pod:1263
2444 "The lifetime of the returned string is until the next error occurs, or "
2445 "L</guestfs_close> is called."
2449 #: ../src/guestfs.pod:1266
2450 msgid "guestfs_last_errno"
2454 #: ../src/guestfs.pod:1268
2457 " int guestfs_last_errno (guestfs_h *g);\n"
2462 #: ../src/guestfs.pod:1270
2463 msgid "This returns the last error number (errno) that happened on C<g>."
2467 #: ../src/guestfs.pod:1272
2468 msgid "If successful, an errno integer not equal to zero is returned."
2472 #: ../src/guestfs.pod:1274
2473 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2477 #: ../src/guestfs.pod:1281
2478 msgid "There has not been any error on the handle."
2482 #: ../src/guestfs.pod:1285
2484 "There has been an error but the errno was meaningless. This corresponds to "
2485 "the case where the error did not come from a failed system call, but for "
2486 "some other reason."
2490 #: ../src/guestfs.pod:1291
2492 "There was an error from a failed system call, but for some reason the errno "
2493 "was not captured and returned. This usually indicates a bug in libguestfs."
2497 #: ../src/guestfs.pod:1297
2499 "Libguestfs tries to convert the errno from inside the applicance into a "
2500 "corresponding errno for the caller (not entirely trivial: the appliance "
2501 "might be running a completely different operating system from the library "
2502 "and error numbers are not standardized across Un*xen). If this could not be "
2503 "done, then the error is translated to C<EINVAL>. In practice this should "
2504 "only happen in very rare circumstances."
2508 #: ../src/guestfs.pod:1305
2509 msgid "guestfs_set_error_handler"
2513 #: ../src/guestfs.pod:1307
2516 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2518 " const char *msg);\n"
2519 " void guestfs_set_error_handler (guestfs_h *g,\n"
2520 " guestfs_error_handler_cb cb,\n"
2526 #: ../src/guestfs.pod:1314
2528 "The callback C<cb> will be called if there is an error. The parameters "
2529 "passed to the callback are an opaque data pointer and the error message "
2534 #: ../src/guestfs.pod:1318
2536 "C<errno> is not passed to the callback. To get that the callback must call "
2537 "L</guestfs_last_errno>."
2541 #: ../src/guestfs.pod:1321
2543 "Note that the message string C<msg> is freed as soon as the callback "
2544 "function returns, so if you want to stash it somewhere you must make your "
2549 #: ../src/guestfs.pod:1325
2550 msgid "The default handler prints messages on C<stderr>."
2554 #: ../src/guestfs.pod:1327
2555 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2559 #: ../src/guestfs.pod:1329
2560 msgid "guestfs_get_error_handler"
2564 #: ../src/guestfs.pod:1331
2567 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2568 " void **opaque_rtn);\n"
2573 #: ../src/guestfs.pod:1334
2574 msgid "Returns the current error handler callback."
2578 #: ../src/guestfs.pod:1336
2579 msgid "guestfs_set_out_of_memory_handler"
2583 #: ../src/guestfs.pod:1338
2586 " typedef void (*guestfs_abort_cb) (void);\n"
2587 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2588 " guestfs_abort_cb);\n"
2593 #: ../src/guestfs.pod:1342
2595 "The callback C<cb> will be called if there is an out of memory situation. "
2596 "I<Note this callback must not return>."
2600 #: ../src/guestfs.pod:1345
2601 msgid "The default is to call L<abort(3)>."
2605 #: ../src/guestfs.pod:1347
2606 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2610 #: ../src/guestfs.pod:1350
2611 msgid "guestfs_get_out_of_memory_handler"
2615 #: ../src/guestfs.pod:1352
2618 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2623 #: ../src/guestfs.pod:1354
2624 msgid "This returns the current out of memory handler."
2628 #: ../src/guestfs.pod:1356
2633 #: ../src/guestfs.pod:1358 ../fish/guestfish.pod:908
2638 #: ../src/guestfs.pod:1360
2643 #: ../src/guestfs.pod:1362
2648 #: ../src/guestfs.pod:1364
2649 msgid "AVAILABILITY"
2653 #: ../src/guestfs.pod:1366
2654 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2658 #: ../src/guestfs.pod:1368
2660 "Using L</guestfs_available> you can test availability of the following "
2661 "groups of functions. This test queries the appliance to see if the "
2662 "appliance you are currently using supports the functionality."
2666 #: ../src/guestfs.pod:1373
2667 msgid "@AVAILABILITY@"
2671 #: ../src/guestfs.pod:1375
2672 msgid "GUESTFISH supported COMMAND"
2676 #: ../src/guestfs.pod:1377
2678 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2679 "prints out the available groups and whether they are supported by this build "
2680 "of libguestfs. Note however that you have to do C<run> first."
2684 #: ../src/guestfs.pod:1382
2685 msgid "SINGLE CALLS AT COMPILE TIME"
2689 #: ../src/guestfs.pod:1384
2691 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2692 "function, such as:"
2696 #: ../src/guestfs.pod:1387
2699 " #define LIBGUESTFS_HAVE_DD 1\n"
2704 #: ../src/guestfs.pod:1389
2705 msgid "if L</guestfs_dd> is available."
2709 #: ../src/guestfs.pod:1391
2711 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2712 "function is available at compile time, we recommended using build tools such "
2713 "as autoconf or cmake. For example in autotools you could use:"
2717 #: ../src/guestfs.pod:1396
2720 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2721 " AC_CHECK_FUNCS([guestfs_dd])\n"
2726 #: ../src/guestfs.pod:1399
2728 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2733 #: ../src/guestfs.pod:1402
2734 msgid "SINGLE CALLS AT RUN TIME"
2738 #: ../src/guestfs.pod:1404
2740 "Testing at compile time doesn't guarantee that a function really exists in "
2741 "the library. The reason is that you might be dynamically linked against a "
2742 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2743 "This situation unfortunately results in a segmentation fault, which is a "
2744 "shortcoming of the C dynamic linking system itself."
2748 #: ../src/guestfs.pod:1411
2750 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2751 "in this example program (note that you still need the compile time check as "
2756 #: ../src/guestfs.pod:1415
2759 " #include <stdio.h>\n"
2760 " #include <stdlib.h>\n"
2761 " #include <unistd.h>\n"
2762 " #include <dlfcn.h>\n"
2763 " #include <guestfs.h>\n"
2768 #: ../src/guestfs.pod:1421
2773 " #ifdef LIBGUESTFS_HAVE_DD\n"
2775 " int has_function;\n"
2780 #: ../src/guestfs.pod:1427
2783 " /* Test if the function guestfs_dd is really available. */\n"
2784 " dl = dlopen (NULL, RTLD_LAZY);\n"
2786 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2787 " exit (EXIT_FAILURE);\n"
2789 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2795 #: ../src/guestfs.pod:1436
2798 " if (!has_function)\n"
2799 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2801 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2802 " /* Now it's safe to call\n"
2803 " guestfs_dd (g, \"foo\", \"bar\");\n"
2807 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2814 #: ../src/guestfs.pod:1449
2816 "You may think the above is an awful lot of hassle, and it is. There are "
2817 "other ways outside of the C linking system to ensure that this kind of "
2818 "incompatibility never arises, such as using package versioning:"
2822 #: ../src/guestfs.pod:1454
2825 " Requires: libguestfs >= 1.0.80\n"
2830 #: ../src/guestfs.pod:1456
2831 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2835 #: ../src/guestfs.pod:1458
2837 "A recent feature of the API is the introduction of calls which take optional "
2838 "arguments. In C these are declared 3 ways. The main way is as a call which "
2839 "takes variable arguments (ie. C<...>), as in this example:"
2843 #: ../src/guestfs.pod:1463
2846 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2851 #: ../src/guestfs.pod:1465
2853 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2854 "call with no optional arguments specified:"
2858 #: ../src/guestfs.pod:1468
2861 " guestfs_add_drive_opts (g, filename, -1);\n"
2866 #: ../src/guestfs.pod:1470
2867 msgid "With a single optional argument:"
2871 #: ../src/guestfs.pod:1472
2874 " guestfs_add_drive_opts (g, filename,\n"
2875 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2881 #: ../src/guestfs.pod:1476
2886 #: ../src/guestfs.pod:1478
2889 " guestfs_add_drive_opts (g, filename,\n"
2890 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2891 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2897 #: ../src/guestfs.pod:1483
2899 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2904 #: ../src/guestfs.pod:1486
2905 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2909 #: ../src/guestfs.pod:1488
2911 "The second variant has the same name with the suffix C<_va>, which works the "
2912 "same way but takes a C<va_list>. See the C manual for details. For the "
2913 "example function, this is declared:"
2917 #: ../src/guestfs.pod:1492
2920 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2926 #: ../src/guestfs.pod:1495
2927 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2931 #: ../src/guestfs.pod:1497
2933 "The third variant is useful where you need to construct these calls. You "
2934 "pass in a structure where you fill in the optional fields. The structure "
2935 "has a bitmask as the first element which you must set to indicate which "
2936 "fields you have filled in. For our example function the structure and call "
2941 #: ../src/guestfs.pod:1503
2944 " struct guestfs_add_drive_opts_argv {\n"
2945 " uint64_t bitmask;\n"
2947 " const char *format;\n"
2950 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2951 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2956 #: ../src/guestfs.pod:1512
2957 msgid "You could call it like this:"
2961 #: ../src/guestfs.pod:1514
2964 " struct guestfs_add_drive_opts_argv optargs = {\n"
2965 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2966 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2968 " .format = \"qcow2\"\n"
2974 #: ../src/guestfs.pod:1521
2977 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2982 #: ../src/guestfs.pod:1523 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1844 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
2987 #: ../src/guestfs.pod:1529
2988 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2992 #: ../src/guestfs.pod:1534
2993 msgid "You do not need to fill in all fields of the structure."
2997 #: ../src/guestfs.pod:1538
2999 "There must be a one-to-one correspondence between fields of the structure "
3000 "that are filled in, and bits set in the bitmask."
3004 #: ../src/guestfs.pod:1543
3005 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3009 #: ../src/guestfs.pod:1545
3011 "In other languages, optional arguments are expressed in the way that is "
3012 "natural for that language. We refer you to the language-specific "
3013 "documentation for more details on that."
3017 #: ../src/guestfs.pod:1549
3018 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3022 #: ../src/guestfs.pod:1551
3023 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3027 #: ../src/guestfs.pod:1553
3029 "The child process generates events in some situations. Current events "
3030 "include: receiving a log message, the child process exits."
3034 #: ../src/guestfs.pod:1556
3036 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3041 #: ../src/guestfs.pod:1559
3043 "Only I<one callback of each type> can be registered for each handle. "
3044 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3045 "that type. Cancel all callbacks of this type by calling this function with "
3046 "C<cb> set to C<NULL>."
3050 #: ../src/guestfs.pod:1564
3051 msgid "guestfs_set_log_message_callback"
3055 #: ../src/guestfs.pod:1566
3058 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3059 " char *buf, int len);\n"
3060 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3061 " guestfs_log_message_cb cb,\n"
3067 #: ../src/guestfs.pod:1572
3069 "The callback function C<cb> will be called whenever qemu or the guest writes "
3070 "anything to the console."
3074 #: ../src/guestfs.pod:1575
3075 msgid "Use this function to capture kernel messages and similar."
3079 #: ../src/guestfs.pod:1577
3081 "Normally there is no log message handler, and log messages are just "
3086 #: ../src/guestfs.pod:1580
3087 msgid "guestfs_set_subprocess_quit_callback"
3091 #: ../src/guestfs.pod:1582
3094 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3095 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3096 " guestfs_subprocess_quit_cb cb,\n"
3102 #: ../src/guestfs.pod:1587
3104 "The callback function C<cb> will be called when the child process quits, "
3105 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3106 "corresponds to a transition from any state to the CONFIG state)."
3110 #: ../src/guestfs.pod:1592
3111 msgid "guestfs_set_launch_done_callback"
3115 #: ../src/guestfs.pod:1594
3118 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3119 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3120 " guestfs_launch_done_cb cb,\n"
3126 #: ../src/guestfs.pod:1599
3128 "The callback function C<cb> will be called when the child process becomes "
3129 "ready first time after it has been launched. (This corresponds to a "
3130 "transition from LAUNCHING to the READY state)."
3134 #: ../src/guestfs.pod:1603
3135 msgid "guestfs_set_close_callback"
3139 #: ../src/guestfs.pod:1605
3142 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3143 " void guestfs_set_close_callback (guestfs_h *g,\n"
3144 " guestfs_close_cb cb,\n"
3150 #: ../src/guestfs.pod:1610
3152 "The callback function C<cb> will be called while the handle is being closed "
3153 "(synchronously from L</guestfs_close>)."
3157 #: ../src/guestfs.pod:1613
3159 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3160 "handles that are open when the program exits. This means that this callback "
3161 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3162 "problems in higher-level languages (eg. if your HLL interpreter has already "
3163 "been cleaned up by the time this is called, and if your callback then jumps "
3164 "into some HLL function)."
3168 #: ../src/guestfs.pod:1621
3169 msgid "guestfs_set_progress_callback"
3173 #: ../src/guestfs.pod:1623
3176 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3177 " int proc_nr, int serial,\n"
3178 " uint64_t position, uint64_t total);\n"
3179 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3180 " guestfs_progress_cb cb,\n"
3186 #: ../src/guestfs.pod:1630
3188 "Some long-running operations can generate progress messages. If this "
3189 "callback is registered, then it will be called each time a progress message "
3190 "is generated (usually two seconds after the operation started, and three "
3191 "times per second thereafter until it completes, although the frequency may "
3192 "change in future versions)."
3196 #: ../src/guestfs.pod:1636
3198 "The callback receives two numbers: C<position> and C<total>. The units of "
3199 "C<total> are not defined, although for some operations C<total> may relate "
3200 "in some way to the amount of data to be transferred (eg. in bytes or "
3201 "megabytes), and C<position> may be the portion which has been transferred."
3205 #: ../src/guestfs.pod:1642
3206 msgid "The only defined and stable parts of the API are:"
3210 #: ../src/guestfs.pod:1648
3212 "The callback can display to the user some type of progress bar or indicator "
3213 "which shows the ratio of C<position>:C<total>."
3217 #: ../src/guestfs.pod:1653
3218 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3222 #: ../src/guestfs.pod:1657
3224 "If any progress notification is sent during a call, then a final progress "
3225 "notification is always sent when C<position> = C<total>."
3229 #: ../src/guestfs.pod:1660
3231 "This is to simplify caller code, so callers can easily set the progress "
3232 "indicator to \"100%\" at the end of the operation, without requiring special "
3233 "code to detect this case."
3237 #: ../src/guestfs.pod:1666
3239 "The callback also receives the procedure number and serial number of the "
3240 "call. These are only useful for debugging protocol issues, and the callback "
3241 "can normally ignore them. The callback may want to print these numbers in "
3242 "error messages or debugging messages."
3246 #: ../src/guestfs.pod:1671
3247 msgid "PRIVATE DATA AREA"
3251 #: ../src/guestfs.pod:1673
3253 "You can attach named pieces of private data to the libguestfs handle, and "
3254 "fetch them by name for the lifetime of the handle. This is called the "
3255 "private data area and is only available from the C API."
3259 #: ../src/guestfs.pod:1677
3260 msgid "To attach a named piece of data, use the following call:"
3264 #: ../src/guestfs.pod:1679
3267 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3272 #: ../src/guestfs.pod:1681
3274 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3275 "pointer (which can be C<NULL>). Any previous item with the same name is "
3280 #: ../src/guestfs.pod:1685
3282 "You can use any C<key> you want, but names beginning with an underscore "
3283 "character are reserved for internal libguestfs purposes (for implementing "
3284 "language bindings). It is recommended to prefix the name with some unique "
3285 "string to avoid collisions with other users."
3289 #: ../src/guestfs.pod:1690
3290 msgid "To retrieve the pointer, use:"
3294 #: ../src/guestfs.pod:1692
3297 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3302 #: ../src/guestfs.pod:1694
3304 "This function returns C<NULL> if either no data is found associated with "
3305 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3310 #: ../src/guestfs.pod:1698
3312 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3313 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3314 "all. In particular, libguestfs does I<not> try to free the data when the "
3315 "handle is closed. If the data must be freed, then the caller must either "
3316 "free it before calling L</guestfs_close> or must set up a close callback to "
3317 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3318 "can be registered for a handle)."
3322 #: ../src/guestfs.pod:1706
3324 "The private data area is implemented using a hash table, and should be "
3325 "reasonably efficient for moderate numbers of keys."
3329 #: ../src/guestfs.pod:1709 ../src/guestfs.pod:1714
3334 #: ../src/guestfs.pod:1711
3336 "<!-- old anchor for the next section --> <a "
3337 "name=\"state_machine_and_low_level_event_api\"/>"
3341 #: ../src/guestfs.pod:1716
3342 msgid "ARCHITECTURE"
3346 #: ../src/guestfs.pod:1718
3348 "Internally, libguestfs is implemented by running an appliance (a special "
3349 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3350 "process of the main program."
3354 #: ../src/guestfs.pod:1722
3357 " ___________________\n"
3359 " | main program |\n"
3361 " | | child process / appliance\n"
3362 " | | __________________________\n"
3364 " +-------------------+ RPC | +-----------------+ |\n"
3365 " | libguestfs <--------------------> guestfsd | |\n"
3366 " | | | +-----------------+ |\n"
3367 " \\___________________/ | | Linux kernel | |\n"
3368 " | +--^--------------+ |\n"
3369 " \\_________|________________/\n"
3375 " \\______________/\n"
3380 #: ../src/guestfs.pod:1742
3382 "The library, linked to the main program, creates the child process and hence "
3383 "the appliance in the L</guestfs_launch> function."
3387 #: ../src/guestfs.pod:1745
3389 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3390 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3391 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3392 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3393 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3394 "attached to the qemu process which translates device access by the "
3395 "appliance's Linux kernel into accesses to the image."
3399 #: ../src/guestfs.pod:1754
3401 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3402 "Although the disk image you are attached to might also be used by some "
3403 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3404 "care if both libguestfs's qemu process and your virtual machine are trying "
3405 "to update the disk image at the same time, since these usually results in "
3406 "massive disk corruption)."
3410 #: ../src/guestfs.pod:1761
3411 msgid "STATE MACHINE"
3415 #: ../src/guestfs.pod:1763
3416 msgid "libguestfs uses a state machine to model the child process:"
3420 #: ../src/guestfs.pod:1765
3432 " / | \\ \\ guestfs_launch\n"
3433 " / | _\\__V______\n"
3435 " / | | LAUNCHING |\n"
3436 " / | \\___________/\n"
3438 " / | guestfs_launch\n"
3440 " ______ / __|____V\n"
3441 " / \\ ------> / \\\n"
3442 " | BUSY | | READY |\n"
3443 " \\______/ <------ \\________/\n"
3448 #: ../src/guestfs.pod:1787
3450 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3451 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3452 "(3) alternating between READY and BUSY as commands are issued to, and "
3453 "carried out by, the child process."
3457 #: ../src/guestfs.pod:1792
3459 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3460 "asynchronously at any time (eg. due to some internal error), and that causes "
3461 "the state to transition back to CONFIG."
3465 #: ../src/guestfs.pod:1796
3467 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3468 "issued when in the CONFIG state."
3472 #: ../src/guestfs.pod:1799
3474 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3475 "L</guestfs_launch> blocks until the child process is READY to accept "
3476 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3477 "moves the state from CONFIG to LAUNCHING while it is running."
3481 #: ../src/guestfs.pod:1805
3483 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3484 "state. These API calls block waiting for the command to be carried out "
3485 "(ie. the state to transition to BUSY and then back to READY). There are no "
3486 "non-blocking versions, and no way to issue more than one command per handle "
3491 #: ../src/guestfs.pod:1811
3493 "Finally, the child process sends asynchronous messages back to the main "
3494 "program, such as kernel log messages. You can register a callback to "
3495 "receive these messages."
3499 #: ../src/guestfs.pod:1815
3504 #: ../src/guestfs.pod:1817
3505 msgid "COMMUNICATION PROTOCOL"
3509 #: ../src/guestfs.pod:1819
3511 "Don't rely on using this protocol directly. This section documents how it "
3512 "currently works, but it may change at any time."
3516 #: ../src/guestfs.pod:1822
3518 "The protocol used to talk between the library and the daemon running inside "
3519 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3520 "1014, RFC 1832, RFC 4506)."
3524 #: ../src/guestfs.pod:1826
3526 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3527 "this file is automatically generated)."
3531 #: ../src/guestfs.pod:1829
3533 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3534 "and C<FileOut> parameters, which are handled with very simple request/reply "
3535 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3536 "parameters, which use the same request and reply messages, but they may also "
3537 "be followed by files sent using a chunked encoding."
3541 #: ../src/guestfs.pod:1836
3542 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3546 #: ../src/guestfs.pod:1838
3547 msgid "For ordinary functions, the request message is:"
3551 #: ../src/guestfs.pod:1840
3554 " total length (header + arguments,\n"
3555 " but not including the length word itself)\n"
3556 " struct guestfs_message_header (encoded as XDR)\n"
3557 " struct guestfs_<foo>_args (encoded as XDR)\n"
3562 #: ../src/guestfs.pod:1845
3564 "The total length field allows the daemon to allocate a fixed size buffer "
3565 "into which it slurps the rest of the message. As a result, the total length "
3566 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3567 "effective size of any request is limited to somewhere under this size."
3571 #: ../src/guestfs.pod:1851
3573 "Note also that many functions don't take any arguments, in which case the "
3574 "C<guestfs_I<foo>_args> is completely omitted."
3578 #: ../src/guestfs.pod:1854
3580 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3581 "receiver knows what type of args structure to expect, or none at all."
3585 #: ../src/guestfs.pod:1858
3586 msgid "The reply message for ordinary functions is:"
3590 #: ../src/guestfs.pod:1860
3593 " total length (header + ret,\n"
3594 " but not including the length word itself)\n"
3595 " struct guestfs_message_header (encoded as XDR)\n"
3596 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3601 #: ../src/guestfs.pod:1865
3603 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3604 "functions that return no formal return values."
3608 #: ../src/guestfs.pod:1868
3609 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3613 #: ../src/guestfs.pod:1871
3615 "In the case of an error, a flag is set in the header, and the reply message "
3616 "is slightly changed:"
3620 #: ../src/guestfs.pod:1874
3623 " total length (header + error,\n"
3624 " but not including the length word itself)\n"
3625 " struct guestfs_message_header (encoded as XDR)\n"
3626 " struct guestfs_message_error (encoded as XDR)\n"
3631 #: ../src/guestfs.pod:1879
3633 "The C<guestfs_message_error> structure contains the error message as a "
3638 #: ../src/guestfs.pod:1882
3639 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3643 #: ../src/guestfs.pod:1884
3645 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3646 "The normal request message is sent (see above). However this is followed by "
3647 "a sequence of file chunks."
3651 #: ../src/guestfs.pod:1888
3654 " total length (header + arguments,\n"
3655 " but not including the length word itself,\n"
3656 " and not including the chunks)\n"
3657 " struct guestfs_message_header (encoded as XDR)\n"
3658 " struct guestfs_<foo>_args (encoded as XDR)\n"
3659 " sequence of chunks for FileIn param #0\n"
3660 " sequence of chunks for FileIn param #1 etc.\n"
3665 #: ../src/guestfs.pod:1896
3666 msgid "The \"sequence of chunks\" is:"
3670 #: ../src/guestfs.pod:1898
3673 " length of chunk (not including length word itself)\n"
3674 " struct guestfs_chunk (encoded as XDR)\n"
3675 " length of chunk\n"
3676 " struct guestfs_chunk (encoded as XDR)\n"
3678 " length of chunk\n"
3679 " struct guestfs_chunk (with data.data_len == 0)\n"
3684 #: ../src/guestfs.pod:1906
3686 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3687 "is set in the final chunk to indicate either successful completion or early "
3692 #: ../src/guestfs.pod:1910
3694 "At time of writing there are no functions that have more than one FileIn "
3695 "parameter. However this is (theoretically) supported, by sending the "
3696 "sequence of chunks for each FileIn parameter one after another (from left to "
3701 #: ../src/guestfs.pod:1915
3703 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3704 "transfer. The library does this by sending a chunk with a special flag set "
3705 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3706 "RPC, does I<not> send any reply, and goes back to reading the next request."
3710 #: ../src/guestfs.pod:1921
3712 "The daemon may also cancel. It does this by writing a special word "
3713 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3714 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3715 "cancel chunk). The special word is chosen so that even if cancellation "
3716 "happens right at the end of the transfer (after the library has finished "
3717 "writing and has started listening for the reply), the \"spurious\" cancel "
3718 "flag will not be confused with the reply message."
3722 #: ../src/guestfs.pod:1930
3724 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3725 "limit), and also files where the size is not known in advance (eg. from "
3726 "pipes or sockets). However the chunks are rather small "
3727 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3728 "to keep much in memory."
3732 #: ../src/guestfs.pod:1936
3733 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3737 #: ../src/guestfs.pod:1938
3739 "The protocol for FileOut parameters is exactly the same as for FileIn "
3740 "parameters, but with the roles of daemon and library reversed."
3744 #: ../src/guestfs.pod:1941
3747 " total length (header + ret,\n"
3748 " but not including the length word itself,\n"
3749 " and not including the chunks)\n"
3750 " struct guestfs_message_header (encoded as XDR)\n"
3751 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3752 " sequence of chunks for FileOut param #0\n"
3753 " sequence of chunks for FileOut param #1 etc.\n"
3758 #: ../src/guestfs.pod:1949
3759 msgid "INITIAL MESSAGE"
3763 #: ../src/guestfs.pod:1951
3765 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3766 "which indicates that the guest and daemon is alive. This is what "
3767 "L</guestfs_launch> waits for."
3771 #: ../src/guestfs.pod:1955
3772 msgid "PROGRESS NOTIFICATION MESSAGES"
3776 #: ../src/guestfs.pod:1957
3778 "The daemon may send progress notification messages at any time. These are "
3779 "distinguished by the normal length word being replaced by "
3780 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3784 #: ../src/guestfs.pod:1961
3786 "The library turns them into progress callbacks (see "
3787 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3788 "discards them if not."
3792 #: ../src/guestfs.pod:1965
3794 "The daemon self-limits the frequency of progress messages it sends (see "
3795 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3800 #: ../src/guestfs.pod:1969
3801 msgid "LIBGUESTFS VERSION NUMBERS"
3805 #: ../src/guestfs.pod:1971
3807 "Since April 2010, libguestfs has started to make separate development and "
3808 "stable releases, along with corresponding branches in our git repository. "
3809 "These separate releases can be identified by version number:"
3813 #: ../src/guestfs.pod:1976
3816 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3817 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3823 " | `-------- sub-version\n"
3825 " `------ always '1' because we don't change the ABI\n"
3830 #: ../src/guestfs.pod:1987
3831 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3835 #: ../src/guestfs.pod:1989
3837 "As time passes we cherry pick fixes from the development branch and backport "
3838 "those into the stable branch, the effect being that the stable branch should "
3839 "get more stable and less buggy over time. So the stable releases are ideal "
3840 "for people who don't need new features but would just like the software to "
3845 #: ../src/guestfs.pod:1995
3846 msgid "Our criteria for backporting changes are:"
3850 #: ../src/guestfs.pod:2001
3852 "Documentation changes which don't affect any code are backported unless the "
3853 "documentation refers to a future feature which is not in stable."
3857 #: ../src/guestfs.pod:2007
3859 "Bug fixes which are not controversial, fix obvious problems, and have been "
3860 "well tested are backported."
3864 #: ../src/guestfs.pod:2012
3866 "Simple rearrangements of code which shouldn't affect how it works get "
3867 "backported. This is so that the code in the two branches doesn't get too "
3868 "far out of step, allowing us to backport future fixes more easily."
3872 #: ../src/guestfs.pod:2018
3874 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3875 "exceptional case: the new feature is required in order to implement an "
3876 "important bug fix."
3880 #: ../src/guestfs.pod:2024
3882 "A new stable branch starts when we think the new features in development are "
3883 "substantial and compelling enough over the current stable branch to warrant "
3884 "it. When that happens we create new stable and development versions 1.N.0 "
3885 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3886 "stable at this point, but by backporting fixes from development, that branch "
3887 "will stabilize over time."
3891 #: ../src/guestfs.pod:2032 ../fish/guestfish.pod:915 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330
3892 msgid "ENVIRONMENT VARIABLES"
3896 #: ../src/guestfs.pod:2036 ../fish/guestfish.pod:941
3897 msgid "LIBGUESTFS_APPEND"
3901 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:943
3902 msgid "Pass additional options to the guest kernel."
3906 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:945
3907 msgid "LIBGUESTFS_DEBUG"
3911 #: ../src/guestfs.pod:2042
3913 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3914 "effect as calling C<guestfs_set_verbose (g, 1)>."
3918 #: ../src/guestfs.pod:2045 ../fish/guestfish.pod:950
3919 msgid "LIBGUESTFS_MEMSIZE"
3923 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:952
3924 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3928 #: ../src/guestfs.pod:2050 ../fish/guestfish.pod:955
3931 " LIBGUESTFS_MEMSIZE=700\n"
3936 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:957
3937 msgid "LIBGUESTFS_PATH"
3941 #: ../src/guestfs.pod:2054
3943 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3944 "the discussion of paths in section PATH above."
3948 #: ../src/guestfs.pod:2057 ../fish/guestfish.pod:962
3949 msgid "LIBGUESTFS_QEMU"
3953 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:964
3955 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3956 "which was found at compile time by the configure script is used."
3960 #: ../src/guestfs.pod:2063
3961 msgid "See also L</QEMU WRAPPERS> above."
3965 #: ../src/guestfs.pod:2065 ../fish/guestfish.pod:968
3966 msgid "LIBGUESTFS_TRACE"
3970 #: ../src/guestfs.pod:2067
3972 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3973 "effect as calling C<guestfs_set_trace (g, 1)>."
3977 #: ../src/guestfs.pod:2070 ../fish/guestfish.pod:977
3982 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:979
3983 msgid "Location of temporary directory, defaults to C</tmp>."
3987 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:981
3989 "If libguestfs was compiled to use the supermin appliance then the real "
3990 "appliance is cached in this directory, shared between all handles belonging "
3991 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3992 "use in case C</tmp> is not large enough."
3996 #: ../src/guestfs.pod:2082 ../fish/guestfish.pod:1039 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-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
4001 #: ../src/guestfs.pod:2084
4003 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
4004 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
4005 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
4006 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4007 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4008 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4009 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4013 #: ../src/guestfs.pod:2107
4015 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4016 "L<lvm(8)>, L<disktype(1)>."
4020 #: ../src/guestfs.pod:2114 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
4025 #: ../src/guestfs.pod:2116
4026 msgid "To get a list of bugs against libguestfs use this link:"
4030 #: ../src/guestfs.pod:2118
4031 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4035 #: ../src/guestfs.pod:2120
4036 msgid "To report a new bug against libguestfs use this link:"
4040 #: ../src/guestfs.pod:2122
4041 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4045 #: ../src/guestfs.pod:2124
4046 msgid "When reporting a bug, please check:"
4050 #: ../src/guestfs.pod:2130
4051 msgid "That the bug hasn't been reported already."
4055 #: ../src/guestfs.pod:2134
4056 msgid "That you are testing a recent version."
4060 #: ../src/guestfs.pod:2138
4061 msgid "Describe the bug accurately, and give a way to reproduce it."
4065 #: ../src/guestfs.pod:2142
4067 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4072 #: ../src/guestfs.pod:2147 ../fish/guestfish.pod:1058 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244
4077 #: ../src/guestfs.pod:2149 ../fish/guestfish.pod:1060 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4078 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4082 #: ../src/guestfs.pod:2151 ../fish/guestfish.pod:1062 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-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
4087 #: ../src/guestfs.pod:2153 ../fish/guestfish.pod:1064 ../fuse/guestmount.pod:250
4088 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4092 #: ../src/guestfs.pod:2156
4094 "This library is free software; you can redistribute it and/or modify it "
4095 "under the terms of the GNU Lesser General Public License as published by the "
4096 "Free Software Foundation; either version 2 of the License, or (at your "
4097 "option) any later version."
4101 #: ../src/guestfs.pod:2161
4103 "This library is distributed in the hope that it will be useful, but WITHOUT "
4104 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4105 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4110 #: ../src/guestfs.pod:2166
4112 "You should have received a copy of the GNU Lesser General Public License "
4113 "along with this library; if not, write to the Free Software Foundation, "
4114 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4118 #: ../src/guestfs-actions.pod:1
4119 msgid "guestfs_add_cdrom"
4123 #: ../src/guestfs-actions.pod:3
4127 " guestfs_add_cdrom (guestfs_h *g,\n"
4128 " const char *filename);\n"
4133 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4134 msgid "This function adds a virtual CD-ROM disk image to the guest."
4138 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4139 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4143 #: ../src/guestfs-actions.pod:17
4145 "This call checks for the existence of C<filename>. This stops you from "
4146 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4147 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4152 #: ../src/guestfs-actions.pod:24
4154 "If you just want to add an ISO file (often you use this as an efficient way "
4155 "to transfer large files into the guest), then you should probably use "
4156 "C<guestfs_add_drive_ro> instead."
4160 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod: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:4173 ../src/guestfs-actions.pod:4204 ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4254 ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:4299 ../src/guestfs-actions.pod:4314 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4384 ../src/guestfs-actions.pod:4398 ../src/guestfs-actions.pod:4415 ../src/guestfs-actions.pod:4464 ../src/guestfs-actions.pod:4501 ../src/guestfs-actions.pod:4515 ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4560 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4769 ../src/guestfs-actions.pod:4791 ../src/guestfs-actions.pod:4809 ../src/guestfs-actions.pod:4841 ../src/guestfs-actions.pod:4907 ../src/guestfs-actions.pod:4924 ../src/guestfs-actions.pod:4937 ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:5240 ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5299 ../src/guestfs-actions.pod:5311 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5341 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5381 ../src/guestfs-actions.pod:5400 ../src/guestfs-actions.pod:5418 ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5499 ../src/guestfs-actions.pod:5518 ../src/guestfs-actions.pod:5535 ../src/guestfs-actions.pod:5563 ../src/guestfs-actions.pod:5587 ../src/guestfs-actions.pod:5606 ../src/guestfs-actions.pod:5630 ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5679 ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:5765 ../src/guestfs-actions.pod:5873 ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6006 ../src/guestfs-actions.pod:6019 ../src/guestfs-actions.pod:6032 ../src/guestfs-actions.pod:6054 ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6080 ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6167 ../src/guestfs-actions.pod:6184 ../src/guestfs-actions.pod:6200 ../src/guestfs-actions.pod:6216 ../src/guestfs-actions.pod:6233 ../src/guestfs-actions.pod:6246 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6302 ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6357 ../src/guestfs-actions.pod:6370 ../src/guestfs-actions.pod:6388 ../src/guestfs-actions.pod:6417 ../src/guestfs-actions.pod:6448 ../src/guestfs-actions.pod:6567 ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6667 ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:6799 ../src/guestfs-actions.pod:6825 ../src/guestfs-actions.pod:6891 ../src/guestfs-actions.pod:6910 ../src/guestfs-actions.pod:6939
4161 msgid "This function returns 0 on success or -1 on error."
4165 #: ../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
4167 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4172 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod: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:6833 ../src/guestfs-actions.pod:7002 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4174 "Deprecated functions will not be removed from the API, but the fact that "
4175 "they are deprecated indicates that there are problems with correct use of "
4180 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod: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:4351 ../src/guestfs-actions.pod:5420 ../src/guestfs-actions.pod:5537 ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6235 ../src/guestfs-actions.pod:6747
4181 msgid "(Added in 0.3)"
4185 #: ../src/guestfs-actions.pod:41
4186 msgid "guestfs_add_domain"
4190 #: ../src/guestfs-actions.pod:43
4194 " guestfs_add_domain (guestfs_h *g,\n"
4195 " const char *dom,\n"
4201 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:139
4203 "You may supply a list of optional arguments to this call. Use zero or more "
4204 "of the following pairs of parameters, and terminate the list with C<-1> on "
4205 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4209 #: ../src/guestfs-actions.pod:53
4212 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4213 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4214 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4219 #: ../src/guestfs-actions.pod:57
4221 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4222 "It works by connecting to libvirt, requesting the domain and domain XML from "
4223 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4228 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4230 "The number of disks added is returned. This operation is atomic: if an "
4231 "error is returned, then no disks are added."
4235 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4237 "This function does some minimal checks to make sure the libvirt domain is "
4238 "not running (unless C<readonly> is true). In a future version we will try "
4239 "to acquire the libvirt lock on each disk."
4243 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4245 "Disks must be accessible locally. This often means that adding disks from a "
4246 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4247 "unless those disks are accessible via the same device path locally too."
4251 #: ../src/guestfs-actions.pod:74
4253 "The optional C<libvirturi> parameter sets the libvirt URI (see "
4254 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
4255 "default libvirt URI (or one set through an environment variable, see the "
4256 "libvirt documentation for full details). If you are using the C API "
4257 "directly then it is more flexible to create the libvirt connection object "
4258 "yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
4262 #: ../src/guestfs-actions.pod:82
4264 "The other optional parameters are passed directly through to "
4265 "C<guestfs_add_drive_opts>."
4269 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod: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:4487 ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:5047 ../src/guestfs-actions.pod:6343 ../src/guestfs-actions.pod:6758 ../src/guestfs-actions.pod:6771 ../src/guestfs-actions.pod:6784
4270 msgid "On error this function returns -1."
4274 #: ../src/guestfs-actions.pod:87
4275 msgid "(Added in 1.7.4)"
4279 #: ../src/guestfs-actions.pod:89
4280 msgid "guestfs_add_domain_va"
4284 #: ../src/guestfs-actions.pod:91
4288 " guestfs_add_domain_va (guestfs_h *g,\n"
4289 " const char *dom,\n"
4295 #: ../src/guestfs-actions.pod:96
4296 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4300 #: ../src/guestfs-actions.pod:98 ../src/guestfs-actions.pod:109 ../src/guestfs-actions.pod:202 ../src/guestfs-actions.pod:213
4301 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4305 #: ../src/guestfs-actions.pod:100
4306 msgid "guestfs_add_domain_argv"
4310 #: ../src/guestfs-actions.pod:102
4314 " guestfs_add_domain_argv (guestfs_h *g,\n"
4315 " const char *dom,\n"
4316 " const struct guestfs_add_domain_argv *optargs);\n"
4321 #: ../src/guestfs-actions.pod:107
4322 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4326 #: ../src/guestfs-actions.pod:111
4327 msgid "guestfs_add_drive"
4331 #: ../src/guestfs-actions.pod:113
4335 " guestfs_add_drive (guestfs_h *g,\n"
4336 " const char *filename);\n"
4341 #: ../src/guestfs-actions.pod:117
4343 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4344 "optional parameters, so the disk is added writable, with the format being "
4345 "detected automatically."
4349 #: ../src/guestfs-actions.pod:121
4351 "Automatic detection of the format opens you up to a potential security hole "
4352 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4353 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4354 "you should think about replacing calls to this function with calls to "
4355 "C<guestfs_add_drive_opts>, and specifying the format."
4359 #: ../src/guestfs-actions.pod:132
4360 msgid "guestfs_add_drive_opts"
4364 #: ../src/guestfs-actions.pod:134
4368 " guestfs_add_drive_opts (guestfs_h *g,\n"
4369 " const char *filename,\n"
4375 #: ../src/guestfs-actions.pod:144
4378 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4379 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4380 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4385 #: ../src/guestfs-actions.pod:148 ../fish/guestfish-actions.pod:92
4387 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4388 "The first time you call this function, the disk appears as C</dev/sda>, the "
4389 "second time as C</dev/sdb>, and so on."
4393 #: ../src/guestfs-actions.pod:153 ../fish/guestfish-actions.pod:97
4395 "You don't necessarily need to be root when using libguestfs. However you "
4396 "obviously do need sufficient permissions to access the filename for whatever "
4397 "operations you want to perform (ie. read access if you just want to read the "
4398 "image or write access if you want to modify the image)."
4402 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:103
4403 msgid "This call checks that C<filename> exists."
4407 #: ../src/guestfs-actions.pod:161 ../fish/guestfish-actions.pod:105
4408 msgid "The optional arguments are:"
4412 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:109
4417 #: ../src/guestfs-actions.pod:167 ../fish/guestfish-actions.pod:111
4419 "If true then the image is treated as read-only. Writes are still allowed, "
4420 "but they are stored in a temporary snapshot overlay which is discarded at "
4421 "the end. The disk that you add is not modified."
4425 #: ../src/guestfs-actions.pod:171 ../fish/guestfish-actions.pod:115
4430 #: ../src/guestfs-actions.pod:173
4432 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4433 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4434 "Possible formats include C<raw> and C<qcow2>."
4438 #: ../src/guestfs-actions.pod:177 ../fish/guestfish-actions.pod:121
4440 "Automatic detection of the format opens you up to a potential security hole "
4441 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4442 "RHBZ#642934. Specifying the format closes this security hole."
4446 #: ../src/guestfs-actions.pod:182 ../fish/guestfish-actions.pod:126
4451 #: ../src/guestfs-actions.pod:184
4453 "This rarely-used option lets you emulate the behaviour of the deprecated "
4454 "C<guestfs_add_drive_with_if> call (q.v.)"
4458 #: ../src/guestfs-actions.pod:191
4459 msgid "(Added in 1.5.23)"
4463 #: ../src/guestfs-actions.pod:193
4464 msgid "guestfs_add_drive_opts_va"
4468 #: ../src/guestfs-actions.pod:195
4472 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4473 " const char *filename,\n"
4479 #: ../src/guestfs-actions.pod:200
4480 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4484 #: ../src/guestfs-actions.pod:204
4485 msgid "guestfs_add_drive_opts_argv"
4489 #: ../src/guestfs-actions.pod:206
4493 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4494 " const char *filename,\n"
4495 " const struct guestfs_add_drive_opts_argv "
4501 #: ../src/guestfs-actions.pod:211
4502 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4506 #: ../src/guestfs-actions.pod:215
4507 msgid "guestfs_add_drive_ro"
4511 #: ../src/guestfs-actions.pod:217
4515 " guestfs_add_drive_ro (guestfs_h *g,\n"
4516 " const char *filename);\n"
4521 #: ../src/guestfs-actions.pod:221
4523 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4524 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4525 "disk is added read-only, with the format being detected automatically."
4529 #: ../src/guestfs-actions.pod:228
4530 msgid "(Added in 1.0.38)"
4534 #: ../src/guestfs-actions.pod:230
4535 msgid "guestfs_add_drive_ro_with_if"
4539 #: ../src/guestfs-actions.pod:232
4543 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4544 " const char *filename,\n"
4545 " const char *iface);\n"
4550 #: ../src/guestfs-actions.pod:237
4552 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4553 "QEMU interface emulation to use at run time."
4557 #: ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270 ../src/guestfs-actions.pod:2305
4558 msgid "(Added in 1.0.84)"
4562 #: ../src/guestfs-actions.pod:251
4563 msgid "guestfs_add_drive_with_if"
4567 #: ../src/guestfs-actions.pod:253
4571 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4572 " const char *filename,\n"
4573 " const char *iface);\n"
4578 #: ../src/guestfs-actions.pod:258
4580 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4581 "QEMU interface emulation to use at run time."
4585 #: ../src/guestfs-actions.pod:272
4586 msgid "guestfs_aug_clear"
4590 #: ../src/guestfs-actions.pod:274
4594 " guestfs_aug_clear (guestfs_h *g,\n"
4595 " const char *augpath);\n"
4600 #: ../src/guestfs-actions.pod:278 ../fish/guestfish-actions.pod:178
4602 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4603 "L<augtool(1)> C<clear> command."
4607 #: ../src/guestfs-actions.pod:283 ../src/guestfs-actions.pod:2085
4608 msgid "(Added in 1.3.4)"
4612 #: ../src/guestfs-actions.pod:285
4613 msgid "guestfs_aug_close"
4617 #: ../src/guestfs-actions.pod:287
4621 " guestfs_aug_close (guestfs_h *g);\n"
4626 #: ../src/guestfs-actions.pod:290
4628 "Close the current Augeas handle and free up any resources used by it. After "
4629 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4630 "any other Augeas functions."
4634 #: ../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:5098
4635 msgid "(Added in 0.7)"
4639 #: ../src/guestfs-actions.pod:299
4640 msgid "guestfs_aug_defnode"
4644 #: ../src/guestfs-actions.pod:301
4647 " struct guestfs_int_bool *\n"
4648 " guestfs_aug_defnode (guestfs_h *g,\n"
4649 " const char *name,\n"
4650 " const char *expr,\n"
4651 " const char *val);\n"
4656 #: ../src/guestfs-actions.pod:307 ../fish/guestfish-actions.pod:194
4657 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4661 #: ../src/guestfs-actions.pod:310
4663 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4664 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4665 "containing that single node."
4669 #: ../src/guestfs-actions.pod:314 ../fish/guestfish-actions.pod:201
4671 "On success this returns a pair containing the number of nodes in the "
4672 "nodeset, and a boolean flag if a node was created."
4676 #: ../src/guestfs-actions.pod:318
4678 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4679 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4683 #: ../src/guestfs-actions.pod:324
4684 msgid "guestfs_aug_defvar"
4688 #: ../src/guestfs-actions.pod:326
4692 " guestfs_aug_defvar (guestfs_h *g,\n"
4693 " const char *name,\n"
4694 " const char *expr);\n"
4699 #: ../src/guestfs-actions.pod:331 ../fish/guestfish-actions.pod:209
4701 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4702 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4706 #: ../src/guestfs-actions.pod:335 ../fish/guestfish-actions.pod:213
4708 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4709 "evaluates to something which is not a nodeset."
4713 #: ../src/guestfs-actions.pod:342
4714 msgid "guestfs_aug_get"
4718 #: ../src/guestfs-actions.pod:344
4722 " guestfs_aug_get (guestfs_h *g,\n"
4723 " const char *augpath);\n"
4728 #: ../src/guestfs-actions.pod:348 ../fish/guestfish-actions.pod:220
4730 "Look up the value associated with C<path>. If C<path> matches exactly one "
4731 "node, the C<value> is returned."
4735 #: ../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:4633 ../src/guestfs-actions.pod:4826 ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5174 ../src/guestfs-actions.pod:5223 ../src/guestfs-actions.pod:5786 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5819 ../src/guestfs-actions.pod:5843 ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6996
4737 "This function returns a string, or NULL on error. I<The caller must free "
4738 "the returned string after use>."
4742 #: ../src/guestfs-actions.pod:356
4743 msgid "guestfs_aug_init"
4747 #: ../src/guestfs-actions.pod:358
4751 " guestfs_aug_init (guestfs_h *g,\n"
4752 " const char *root,\n"
4758 #: ../src/guestfs-actions.pod:363 ../fish/guestfish-actions.pod:227
4760 "Create a new Augeas handle for editing configuration files. If there was "
4761 "any previous Augeas handle associated with this guestfs session, then it is "
4766 #: ../src/guestfs-actions.pod:367
4767 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4771 #: ../src/guestfs-actions.pod:370 ../fish/guestfish-actions.pod:234
4772 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4776 #: ../src/guestfs-actions.pod:373 ../fish/guestfish-actions.pod:237
4778 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4779 "logical I<or> of the following integers:"
4783 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:243
4784 msgid "C<AUG_SAVE_BACKUP> = 1"
4788 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:245
4789 msgid "Keep the original file with a C<.augsave> extension."
4793 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:247
4794 msgid "C<AUG_SAVE_NEWFILE> = 2"
4798 #: ../src/guestfs-actions.pod:385 ../fish/guestfish-actions.pod:249
4800 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4801 "original. Overrides C<AUG_SAVE_BACKUP>."
4805 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:252
4806 msgid "C<AUG_TYPE_CHECK> = 4"
4810 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:254
4811 msgid "Typecheck lenses (can be expensive)."
4815 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:256
4816 msgid "C<AUG_NO_STDINC> = 8"
4820 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:258
4821 msgid "Do not use standard load path for modules."
4825 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:260
4826 msgid "C<AUG_SAVE_NOOP> = 16"
4830 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:262
4831 msgid "Make save a no-op, just record what would have been changed."
4835 #: ../src/guestfs-actions.pod:400 ../fish/guestfish-actions.pod:264
4836 msgid "C<AUG_NO_LOAD> = 32"
4840 #: ../src/guestfs-actions.pod:402
4841 msgid "Do not load the tree in C<guestfs_aug_init>."
4845 #: ../src/guestfs-actions.pod:406
4846 msgid "To close the handle, you can call C<guestfs_aug_close>."
4850 #: ../src/guestfs-actions.pod:408 ../fish/guestfish-actions.pod:272
4851 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4855 #: ../src/guestfs-actions.pod:414
4856 msgid "guestfs_aug_insert"
4860 #: ../src/guestfs-actions.pod:416
4864 " guestfs_aug_insert (guestfs_h *g,\n"
4865 " const char *augpath,\n"
4866 " const char *label,\n"
4872 #: ../src/guestfs-actions.pod:422 ../fish/guestfish-actions.pod:278
4874 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4875 "or after C<path> (depending on the boolean flag C<before>)."
4879 #: ../src/guestfs-actions.pod:426 ../fish/guestfish-actions.pod:282
4881 "C<path> must match exactly one existing node in the tree, and C<label> must "
4882 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4886 #: ../src/guestfs-actions.pod:434
4887 msgid "guestfs_aug_load"
4891 #: ../src/guestfs-actions.pod:436
4895 " guestfs_aug_load (guestfs_h *g);\n"
4900 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:290
4901 msgid "Load files into the tree."
4905 #: ../src/guestfs-actions.pod:441 ../fish/guestfish-actions.pod:292
4906 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4910 #: ../src/guestfs-actions.pod:448
4911 msgid "guestfs_aug_ls"
4915 #: ../src/guestfs-actions.pod:450
4919 " guestfs_aug_ls (guestfs_h *g,\n"
4920 " const char *augpath);\n"
4925 #: ../src/guestfs-actions.pod:454
4927 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4928 "sorting the resulting nodes into alphabetical order."
4932 #: ../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:4448 ../src/guestfs-actions.pod:4968 ../src/guestfs-actions.pod:5094 ../src/guestfs-actions.pod:5208 ../src/guestfs-actions.pod:5859 ../src/guestfs-actions.pod:5920 ../src/guestfs-actions.pod:5975 ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:6145 ../src/guestfs-actions.pod:6617 ../src/guestfs-actions.pod:6637 ../src/guestfs-actions.pod:6684 ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6868 ../src/guestfs-actions.pod:6953 ../src/guestfs-actions.pod:6972 ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7037
4934 "This function returns a NULL-terminated array of strings (like "
4935 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4936 "strings and the array after use>."
4940 #: ../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:4452 ../src/guestfs-actions.pod:4909 ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6372 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6837
4941 msgid "(Added in 0.8)"
4945 #: ../src/guestfs-actions.pod:463
4946 msgid "guestfs_aug_match"
4950 #: ../src/guestfs-actions.pod:465
4954 " guestfs_aug_match (guestfs_h *g,\n"
4955 " const char *augpath);\n"
4960 #: ../src/guestfs-actions.pod:469 ../fish/guestfish-actions.pod:306
4962 "Returns a list of paths which match the path expression C<path>. The "
4963 "returned paths are sufficiently qualified so that they match exactly one "
4964 "node in the current tree."
4968 #: ../src/guestfs-actions.pod:479
4969 msgid "guestfs_aug_mv"
4973 #: ../src/guestfs-actions.pod:481
4977 " guestfs_aug_mv (guestfs_h *g,\n"
4978 " const char *src,\n"
4979 " const char *dest);\n"
4984 #: ../src/guestfs-actions.pod:486 ../fish/guestfish-actions.pod:314
4986 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4987 "C<dest> is overwritten if it exists."
4991 #: ../src/guestfs-actions.pod:493
4992 msgid "guestfs_aug_rm"
4996 #: ../src/guestfs-actions.pod:495
5000 " guestfs_aug_rm (guestfs_h *g,\n"
5001 " const char *augpath);\n"
5006 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:321
5007 msgid "Remove C<path> and all of its children."
5011 #: ../src/guestfs-actions.pod:501 ../fish/guestfish-actions.pod:323
5012 msgid "On success this returns the number of entries which were removed."
5016 #: ../src/guestfs-actions.pod:507
5017 msgid "guestfs_aug_save"
5021 #: ../src/guestfs-actions.pod:509
5025 " guestfs_aug_save (guestfs_h *g);\n"
5030 #: ../src/guestfs-actions.pod:512 ../fish/guestfish-actions.pod:329
5031 msgid "This writes all pending changes to disk."
5035 #: ../src/guestfs-actions.pod:514
5037 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5042 #: ../src/guestfs-actions.pod:521
5043 msgid "guestfs_aug_set"
5047 #: ../src/guestfs-actions.pod:523
5051 " guestfs_aug_set (guestfs_h *g,\n"
5052 " const char *augpath,\n"
5053 " const char *val);\n"
5058 #: ../src/guestfs-actions.pod:528 ../fish/guestfish-actions.pod:338
5059 msgid "Set the value associated with C<path> to C<val>."
5063 #: ../src/guestfs-actions.pod:530
5065 "In the Augeas API, it is possible to clear a node by setting the value to "
5066 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5067 "this call. Instead you must use the C<guestfs_aug_clear> call."
5071 #: ../src/guestfs-actions.pod:539
5072 msgid "guestfs_available"
5076 #: ../src/guestfs-actions.pod:541
5080 " guestfs_available (guestfs_h *g,\n"
5081 " char *const *groups);\n"
5086 #: ../src/guestfs-actions.pod:545 ../fish/guestfish-actions.pod:349
5088 "This command is used to check the availability of some groups of "
5089 "functionality in the appliance, which not all builds of the libguestfs "
5090 "appliance will be able to provide."
5094 #: ../src/guestfs-actions.pod:549
5096 "The libguestfs groups, and the functions that those groups correspond to, "
5097 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5098 "runtime by calling C<guestfs_available_all_groups>."
5102 #: ../src/guestfs-actions.pod:554 ../fish/guestfish-actions.pod:358
5104 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5105 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5106 "and Augeas (configuration file editing) functions."
5110 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:363
5111 msgid "The command returns no error if I<all> requested groups are available."
5115 #: ../src/guestfs-actions.pod:561 ../fish/guestfish-actions.pod:365
5117 "It fails with an error if one or more of the requested groups is unavailable "
5122 #: ../src/guestfs-actions.pod:564 ../fish/guestfish-actions.pod:368
5124 "If an unknown group name is included in the list of groups then an error is "
5129 #: ../src/guestfs-actions.pod:567 ../fish/guestfish-actions.pod:371
5134 #: ../src/guestfs-actions.pod:573
5135 msgid "You must call C<guestfs_launch> before calling this function."
5139 #: ../src/guestfs-actions.pod:575 ../fish/guestfish-actions.pod:379
5141 "The reason is because we don't know what groups are supported by the "
5142 "appliance/daemon until it is running and can be queried."
5146 #: ../src/guestfs-actions.pod:581 ../fish/guestfish-actions.pod:385
5148 "If a group of functions is available, this does not necessarily mean that "
5149 "they will work. You still have to check for errors when calling individual "
5150 "API functions even if they are available."
5154 #: ../src/guestfs-actions.pod:588 ../fish/guestfish-actions.pod:392
5156 "It is usually the job of distro packagers to build complete functionality "
5157 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5158 "with all requirements satisfied, will support everything."
5162 #: ../src/guestfs-actions.pod:595
5164 "This call was added in version C<1.0.80>. In previous versions of "
5165 "libguestfs all you could do would be to speculatively execute a command to "
5166 "find out if the daemon implemented it. See also C<guestfs_version>."
5170 #: ../src/guestfs-actions.pod:604 ../src/guestfs-actions.pod:1165
5171 msgid "(Added in 1.0.80)"
5175 #: ../src/guestfs-actions.pod:606
5176 msgid "guestfs_available_all_groups"
5180 #: ../src/guestfs-actions.pod:608
5184 " guestfs_available_all_groups (guestfs_h *g);\n"
5189 #: ../src/guestfs-actions.pod:611
5191 "This command returns a list of all optional groups that this daemon knows "
5192 "about. Note this returns both supported and unsupported groups. To find "
5193 "out which ones the daemon can actually support you have to call "
5194 "C<guestfs_available> on each member of the returned list."
5198 #: ../src/guestfs-actions.pod:617
5199 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5203 #: ../src/guestfs-actions.pod:623
5204 msgid "(Added in 1.3.15)"
5208 #: ../src/guestfs-actions.pod:625
5209 msgid "guestfs_base64_in"
5213 #: ../src/guestfs-actions.pod:627
5217 " guestfs_base64_in (guestfs_h *g,\n"
5218 " const char *base64file,\n"
5219 " const char *filename);\n"
5224 #: ../src/guestfs-actions.pod:632 ../fish/guestfish-actions.pod:422
5225 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
5229 #: ../src/guestfs-actions.pod:637 ../src/guestfs-actions.pod:651
5230 msgid "(Added in 1.3.5)"
5234 #: ../src/guestfs-actions.pod:639
5235 msgid "guestfs_base64_out"
5239 #: ../src/guestfs-actions.pod:641
5243 " guestfs_base64_out (guestfs_h *g,\n"
5244 " const char *filename,\n"
5245 " const char *base64file);\n"
5250 #: ../src/guestfs-actions.pod:646 ../fish/guestfish-actions.pod:431
5252 "This command downloads the contents of C<filename>, writing it out to local "
5253 "file C<base64file> encoded as base64."
5257 #: ../src/guestfs-actions.pod:653
5258 msgid "guestfs_blockdev_flushbufs"
5262 #: ../src/guestfs-actions.pod:655
5266 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5267 " const char *device);\n"
5272 #: ../src/guestfs-actions.pod:659 ../fish/guestfish-actions.pod:440
5273 msgid "This tells the kernel to flush internal buffers associated with C<device>."
5277 #: ../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
5278 msgid "This uses the L<blockdev(8)> command."
5282 #: ../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
5283 msgid "(Added in 0.9.3)"
5287 #: ../src/guestfs-actions.pod:668
5288 msgid "guestfs_blockdev_getbsz"
5292 #: ../src/guestfs-actions.pod:670
5296 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5297 " const char *device);\n"
5302 #: ../src/guestfs-actions.pod:674 ../fish/guestfish-actions.pod:449
5303 msgid "This returns the block size of a device."
5307 #: ../src/guestfs-actions.pod:676 ../src/guestfs-actions.pod:776 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5309 "(Note this is different from both I<size in blocks> and I<filesystem block "
5314 #: ../src/guestfs-actions.pod:685
5315 msgid "guestfs_blockdev_getro"
5319 #: ../src/guestfs-actions.pod:687
5323 " guestfs_blockdev_getro (guestfs_h *g,\n"
5324 " const char *device);\n"
5329 #: ../src/guestfs-actions.pod:691 ../fish/guestfish-actions.pod:460
5331 "Returns a boolean indicating if the block device is read-only (true if "
5332 "read-only, false if not)."
5336 #: ../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:4597
5337 msgid "This function returns a C truth value on success or -1 on error."
5341 #: ../src/guestfs-actions.pod:700
5342 msgid "guestfs_blockdev_getsize64"
5346 #: ../src/guestfs-actions.pod:702
5350 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5351 " const char *device);\n"
5356 #: ../src/guestfs-actions.pod:706 ../fish/guestfish-actions.pod:469
5357 msgid "This returns the size of the device in bytes."
5361 #: ../src/guestfs-actions.pod:708
5362 msgid "See also C<guestfs_blockdev_getsz>."
5366 #: ../src/guestfs-actions.pod:716
5367 msgid "guestfs_blockdev_getss"
5371 #: ../src/guestfs-actions.pod:718
5375 " guestfs_blockdev_getss (guestfs_h *g,\n"
5376 " const char *device);\n"
5381 #: ../src/guestfs-actions.pod:722 ../fish/guestfish-actions.pod:479
5383 "This returns the size of sectors on a block device. Usually 512, but can be "
5384 "larger for modern devices."
5388 #: ../src/guestfs-actions.pod:725
5390 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5395 #: ../src/guestfs-actions.pod:734
5396 msgid "guestfs_blockdev_getsz"
5400 #: ../src/guestfs-actions.pod:736
5404 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5405 " const char *device);\n"
5410 #: ../src/guestfs-actions.pod:740 ../fish/guestfish-actions.pod:491
5412 "This returns the size of the device in units of 512-byte sectors (even if "
5413 "the sectorsize isn't 512 bytes ... weird)."
5417 #: ../src/guestfs-actions.pod:743
5419 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5420 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5424 #: ../src/guestfs-actions.pod:753
5425 msgid "guestfs_blockdev_rereadpt"
5429 #: ../src/guestfs-actions.pod:755
5433 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5434 " const char *device);\n"
5439 #: ../src/guestfs-actions.pod:759 ../fish/guestfish-actions.pod:504
5440 msgid "Reread the partition table on C<device>."
5444 #: ../src/guestfs-actions.pod:767
5445 msgid "guestfs_blockdev_setbsz"
5449 #: ../src/guestfs-actions.pod:769
5453 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5454 " const char *device,\n"
5455 " int blocksize);\n"
5460 #: ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:512
5461 msgid "This sets the block size of a device."
5465 #: ../src/guestfs-actions.pod:785
5466 msgid "guestfs_blockdev_setro"
5470 #: ../src/guestfs-actions.pod:787
5474 " guestfs_blockdev_setro (guestfs_h *g,\n"
5475 " const char *device);\n"
5480 #: ../src/guestfs-actions.pod:791 ../fish/guestfish-actions.pod:523
5481 msgid "Sets the block device named C<device> to read-only."
5485 #: ../src/guestfs-actions.pod:799
5486 msgid "guestfs_blockdev_setrw"
5490 #: ../src/guestfs-actions.pod:801
5494 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5495 " const char *device);\n"
5500 #: ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:531
5501 msgid "Sets the block device named C<device> to read-write."
5505 #: ../src/guestfs-actions.pod:813
5506 msgid "guestfs_case_sensitive_path"
5510 #: ../src/guestfs-actions.pod:815
5514 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5515 " const char *path);\n"
5520 #: ../src/guestfs-actions.pod:819 ../fish/guestfish-actions.pod:539
5522 "This can be used to resolve case insensitive paths on a filesystem which is "
5523 "case sensitive. The use case is to resolve paths which you have read from "
5524 "Windows configuration files or the Windows Registry, to the true path."
5528 #: ../src/guestfs-actions.pod:824 ../fish/guestfish-actions.pod:544
5530 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5531 "(and probably others), which is that although the underlying filesystem is "
5532 "case-insensitive, the driver exports the filesystem to Linux as "
5537 #: ../src/guestfs-actions.pod:829 ../fish/guestfish-actions.pod:549
5539 "One consequence of this is that special directories such as C<c:\\windows> "
5540 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5541 "precise details of how they were created. In Windows itself this would not "
5546 #: ../src/guestfs-actions.pod:835 ../fish/guestfish-actions.pod:555
5548 "Bug or feature? You decide: "
5549 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5553 #: ../src/guestfs-actions.pod:838 ../fish/guestfish-actions.pod:558
5555 "This function resolves the true case of each element in the path and returns "
5556 "the case-sensitive path."
5560 #: ../src/guestfs-actions.pod:841
5562 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5563 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5564 "how the directories were originally created under Windows)."
5568 #: ../src/guestfs-actions.pod:846 ../fish/guestfish-actions.pod:566
5569 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5573 #: ../src/guestfs-actions.pod:849
5574 msgid "See also C<guestfs_realpath>."
5578 #: ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:6529
5579 msgid "(Added in 1.0.75)"
5583 #: ../src/guestfs-actions.pod:856
5588 #: ../src/guestfs-actions.pod:858
5592 " guestfs_cat (guestfs_h *g,\n"
5593 " const char *path);\n"
5598 #: ../src/guestfs-actions.pod:862 ../src/guestfs-actions.pod:5084 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5599 msgid "Return the contents of the file named C<path>."
5603 #: ../src/guestfs-actions.pod:864
5605 "Note that this function cannot correctly handle binary files (specifically, "
5606 "files containing C<\\0> character which is treated as end of string). For "
5607 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5608 "functions which have a more complex interface."
5612 #: ../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:4866 ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:5023 ../src/guestfs-actions.pod:5049 ../src/guestfs-actions.pod:5073 ../src/guestfs-actions.pod:5924 ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:6149 ../src/guestfs-actions.pod:6801 ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6853 ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7041 ../fish/guestfish-actions.pod:582 ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729 ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263 ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354 ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386 ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115 ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543 ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628 ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5614 "Because of the message protocol, there is a transfer limit of somewhere "
5615 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5619 #: ../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:4972 ../src/guestfs-actions.pod:4986 ../src/guestfs-actions.pod:6688 ../src/guestfs-actions.pod:6702
5620 msgid "(Added in 0.4)"
5624 #: ../src/guestfs-actions.pod:877
5625 msgid "guestfs_checksum"
5629 #: ../src/guestfs-actions.pod:879
5633 " guestfs_checksum (guestfs_h *g,\n"
5634 " const char *csumtype,\n"
5635 " const char *path);\n"
5640 #: ../src/guestfs-actions.pod:884 ../fish/guestfish-actions.pod:589
5641 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5645 #: ../src/guestfs-actions.pod:887 ../fish/guestfish-actions.pod:592
5647 "The type of checksum to compute is given by the C<csumtype> parameter which "
5648 "must have one of the following values:"
5652 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:597
5657 #: ../src/guestfs-actions.pod:894 ../fish/guestfish-actions.pod:599
5659 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5664 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:602
5669 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:604
5670 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5674 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:606
5679 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:608
5680 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5684 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:610
5689 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:612
5690 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5694 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:614
5699 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:616
5700 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5704 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:618
5709 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:620
5710 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5714 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:622
5719 #: ../src/guestfs-actions.pod:919 ../fish/guestfish-actions.pod:624
5720 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5724 #: ../src/guestfs-actions.pod:923 ../fish/guestfish-actions.pod:628
5725 msgid "The checksum is returned as a printable string."
5729 #: ../src/guestfs-actions.pod:925
5730 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5734 #: ../src/guestfs-actions.pod:927
5735 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5739 #: ../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:6390
5740 msgid "(Added in 1.0.2)"
5744 #: ../src/guestfs-actions.pod:934
5745 msgid "guestfs_checksum_device"
5749 #: ../src/guestfs-actions.pod:936
5753 " guestfs_checksum_device (guestfs_h *g,\n"
5754 " const char *csumtype,\n"
5755 " const char *device);\n"
5760 #: ../src/guestfs-actions.pod:941
5762 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5763 "device named C<device>. For the types of checksums supported see the "
5764 "C<guestfs_checksum> command."
5768 #: ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6318 ../src/guestfs-actions.pod:6714
5769 msgid "(Added in 1.3.2)"
5773 #: ../src/guestfs-actions.pod:950
5774 msgid "guestfs_checksums_out"
5778 #: ../src/guestfs-actions.pod:952
5782 " guestfs_checksums_out (guestfs_h *g,\n"
5783 " const char *csumtype,\n"
5784 " const char *directory,\n"
5785 " const char *sumsfile);\n"
5790 #: ../src/guestfs-actions.pod:958 ../fish/guestfish-actions.pod:646
5792 "This command computes the checksums of all regular files in C<directory> and "
5793 "then emits a list of those checksums to the local output file C<sumsfile>."
5797 #: ../src/guestfs-actions.pod:962 ../fish/guestfish-actions.pod:650
5799 "This can be used for verifying the integrity of a virtual machine. However "
5800 "to be properly secure you should pay attention to the output of the checksum "
5801 "command (it uses the ones from GNU coreutils). In particular when the "
5802 "filename is not printable, coreutils uses a special backslash syntax. For "
5803 "more information, see the GNU coreutils info file."
5807 #: ../src/guestfs-actions.pod:972
5808 msgid "(Added in 1.3.7)"
5812 #: ../src/guestfs-actions.pod:974
5813 msgid "guestfs_chmod"
5817 #: ../src/guestfs-actions.pod:976
5821 " guestfs_chmod (guestfs_h *g,\n"
5823 " const char *path);\n"
5828 #: ../src/guestfs-actions.pod:981 ../fish/guestfish-actions.pod:664
5830 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5835 #: ../src/guestfs-actions.pod:984 ../fish/guestfish-actions.pod:667
5837 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5838 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5843 #: ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838 ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
5844 msgid "The mode actually set is affected by the umask."
5848 #: ../src/guestfs-actions.pod:994
5849 msgid "guestfs_chown"
5853 #: ../src/guestfs-actions.pod:996
5857 " guestfs_chown (guestfs_h *g,\n"
5860 " const char *path);\n"
5865 #: ../src/guestfs-actions.pod:1002 ../fish/guestfish-actions.pod:677
5866 msgid "Change the file owner to C<owner> and group to C<group>."
5870 #: ../src/guestfs-actions.pod:1004 ../src/guestfs-actions.pod:3225 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
5872 "Only numeric uid and gid are supported. If you want to use names, you will "
5873 "need to locate and parse the password file yourself (Augeas support makes "
5874 "this relatively easy)."
5878 #: ../src/guestfs-actions.pod:1012
5879 msgid "guestfs_command"
5883 #: ../src/guestfs-actions.pod:1014
5887 " guestfs_command (guestfs_h *g,\n"
5888 " char *const *arguments);\n"
5893 #: ../src/guestfs-actions.pod:1018 ../fish/guestfish-actions.pod:687
5895 "This call runs a command from the guest filesystem. The filesystem must be "
5896 "mounted, and must contain a compatible operating system (ie. something "
5897 "Linux, with the same or compatible processor architecture)."
5901 #: ../src/guestfs-actions.pod:1023
5903 "The single parameter is an argv-style list of arguments. The first element "
5904 "is the name of the program to run. Subsequent elements are parameters. The "
5905 "list must be non-empty (ie. must contain a program name). Note that the "
5906 "command runs directly, and is I<not> invoked via the shell (see "
5911 #: ../src/guestfs-actions.pod:1030 ../fish/guestfish-actions.pod:699
5912 msgid "The return value is anything printed to I<stdout> by the command."
5916 #: ../src/guestfs-actions.pod:1033 ../fish/guestfish-actions.pod:702
5918 "If the command returns a non-zero exit status, then this function returns an "
5919 "error message. The error message string is the content of I<stderr> from "
5924 #: ../src/guestfs-actions.pod:1037 ../fish/guestfish-actions.pod:706
5926 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5927 "C</bin>. If you require a program from another location, you should provide "
5928 "the full path in the first parameter."
5932 #: ../src/guestfs-actions.pod:1042 ../fish/guestfish-actions.pod:711
5934 "Shared libraries and data files required by the program must be available on "
5935 "filesystems which are mounted in the correct places. It is the caller's "
5936 "responsibility to ensure all filesystems that are needed are mounted at the "
5941 #: ../src/guestfs-actions.pod:1054 ../src/guestfs-actions.pod:1074 ../src/guestfs-actions.pod:1537
5942 msgid "(Added in 0.9.1)"
5946 #: ../src/guestfs-actions.pod:1056
5947 msgid "guestfs_command_lines"
5951 #: ../src/guestfs-actions.pod:1058
5955 " guestfs_command_lines (guestfs_h *g,\n"
5956 " char *const *arguments);\n"
5961 #: ../src/guestfs-actions.pod:1062
5963 "This is the same as C<guestfs_command>, but splits the result into a list of "
5968 #: ../src/guestfs-actions.pod:1065
5969 msgid "See also: C<guestfs_sh_lines>"
5973 #: ../src/guestfs-actions.pod:1076
5974 msgid "guestfs_config"
5978 #: ../src/guestfs-actions.pod:1078
5982 " guestfs_config (guestfs_h *g,\n"
5983 " const char *qemuparam,\n"
5984 " const char *qemuvalue);\n"
5989 #: ../src/guestfs-actions.pod:1083 ../fish/guestfish-actions.pod:736
5991 "This can be used to add arbitrary qemu command line parameters of the form "
5992 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5993 "setting some parameters which would interfere with parameters that we use."
5997 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:741
5998 msgid "The first character of C<param> string must be a C<-> (dash)."
6002 #: ../src/guestfs-actions.pod:1090 ../fish/guestfish-actions.pod:743
6003 msgid "C<value> can be NULL."
6007 #: ../src/guestfs-actions.pod:1096
6008 msgid "guestfs_copy_size"
6012 #: ../src/guestfs-actions.pod:1098
6016 " guestfs_copy_size (guestfs_h *g,\n"
6017 " const char *src,\n"
6018 " const char *dest,\n"
6024 #: ../src/guestfs-actions.pod:1104 ../fish/guestfish-actions.pod:749
6026 "This command copies exactly C<size> bytes from one source device or file "
6027 "C<src> to another destination device or file C<dest>."
6031 #: ../src/guestfs-actions.pod:1107 ../fish/guestfish-actions.pod:752
6033 "Note this will fail if the source is too short or if the destination is not "
6038 #: ../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:6893 ../src/guestfs-actions.pod:6912
6040 "This long-running command can generate progress notification messages so "
6041 "that the caller can display a progress bar or indicator. To receive these "
6042 "messages, the caller must register a progress callback. See "
6043 "L<guestfs(3)/guestfs_set_progress_callback>."
6047 #: ../src/guestfs-actions.pod:1117 ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:4999 ../src/guestfs-actions.pod:6621 ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6727
6048 msgid "(Added in 1.0.87)"
6052 #: ../src/guestfs-actions.pod:1119
6057 #: ../src/guestfs-actions.pod:1121
6061 " guestfs_cp (guestfs_h *g,\n"
6062 " const char *src,\n"
6063 " const char *dest);\n"
6068 #: ../src/guestfs-actions.pod:1126 ../fish/guestfish-actions.pod:759
6070 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6071 "destination filename or destination directory."
6075 #: ../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:4466 ../src/guestfs-actions.pod:4843
6076 msgid "(Added in 1.0.18)"
6080 #: ../src/guestfs-actions.pod:1133
6081 msgid "guestfs_cp_a"
6085 #: ../src/guestfs-actions.pod:1135
6089 " guestfs_cp_a (guestfs_h *g,\n"
6090 " const char *src,\n"
6091 " const char *dest);\n"
6096 #: ../src/guestfs-actions.pod:1140 ../fish/guestfish-actions.pod:766
6098 "This copies a file or directory from C<src> to C<dest> recursively using the "
6103 #: ../src/guestfs-actions.pod:1147
6108 #: ../src/guestfs-actions.pod:1149
6112 " guestfs_dd (guestfs_h *g,\n"
6113 " const char *src,\n"
6114 " const char *dest);\n"
6119 #: ../src/guestfs-actions.pod:1154 ../fish/guestfish-actions.pod:773
6121 "This command copies from one source device or file C<src> to another "
6122 "destination device or file C<dest>. Normally you would use this to copy to "
6123 "or from a device or partition, for example to duplicate a filesystem."
6127 #: ../src/guestfs-actions.pod:1159
6129 "If the destination is a device, it must be as large or larger than the "
6130 "source file or device, otherwise the copy will fail. This command cannot do "
6131 "partial copies (see C<guestfs_copy_size>)."
6135 #: ../src/guestfs-actions.pod:1167
6140 #: ../src/guestfs-actions.pod:1169
6144 " guestfs_df (guestfs_h *g);\n"
6149 #: ../src/guestfs-actions.pod:1172 ../fish/guestfish-actions.pod:786
6150 msgid "This command runs the C<df> command to report disk space used."
6154 #: ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1191 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6156 "This command is mostly useful for interactive sessions. It is I<not> "
6157 "intended that you try to parse the output string. Use C<statvfs> from "
6162 #: ../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:4366 ../src/guestfs-actions.pod:6128 ../src/guestfs-actions.pod:6152 ../src/guestfs-actions.pod:6760 ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6786
6163 msgid "(Added in 1.0.54)"
6167 #: ../src/guestfs-actions.pod:1183
6168 msgid "guestfs_df_h"
6172 #: ../src/guestfs-actions.pod:1185
6176 " guestfs_df_h (guestfs_h *g);\n"
6181 #: ../src/guestfs-actions.pod:1188 ../fish/guestfish-actions.pod:796
6183 "This command runs the C<df -h> command to report disk space used in "
6184 "human-readable format."
6188 #: ../src/guestfs-actions.pod:1200
6189 msgid "guestfs_dmesg"
6193 #: ../src/guestfs-actions.pod:1202
6197 " guestfs_dmesg (guestfs_h *g);\n"
6202 #: ../src/guestfs-actions.pod:1205 ../fish/guestfish-actions.pod:807
6204 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6205 "This is sometimes useful for extended debugging of problems."
6209 #: ../src/guestfs-actions.pod:1209
6211 "Another way to get the same information is to enable verbose messages with "
6212 "C<guestfs_set_verbose> or by setting the environment variable "
6213 "C<LIBGUESTFS_DEBUG=1> before running the program."
6217 #: ../src/guestfs-actions.pod:1219
6218 msgid "guestfs_download"
6222 #: ../src/guestfs-actions.pod:1221
6226 " guestfs_download (guestfs_h *g,\n"
6227 " const char *remotefilename,\n"
6228 " const char *filename);\n"
6233 #: ../src/guestfs-actions.pod:1226 ../src/guestfs-actions.pod:1251 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6235 "Download file C<remotefilename> and save it as C<filename> on the local "
6240 #: ../src/guestfs-actions.pod:1229 ../src/guestfs-actions.pod:6384 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6241 msgid "C<filename> can also be a named pipe."
6245 #: ../src/guestfs-actions.pod:1231
6246 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6250 #: ../src/guestfs-actions.pod:1242
6251 msgid "guestfs_download_offset"
6255 #: ../src/guestfs-actions.pod:1244
6259 " guestfs_download_offset (guestfs_h *g,\n"
6260 " const char *remotefilename,\n"
6261 " const char *filename,\n"
6262 " int64_t offset,\n"
6268 #: ../src/guestfs-actions.pod:1254 ../fish/guestfish-actions.pod:836
6270 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6271 "region must be within the file or device)."
6275 #: ../src/guestfs-actions.pod:1257
6277 "Note that there is no limit on the amount of data that can be downloaded "
6278 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6279 "full amount unless an error occurs."
6283 #: ../src/guestfs-actions.pod:1262
6284 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6288 #: ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:6419
6289 msgid "(Added in 1.5.17)"
6293 #: ../src/guestfs-actions.pod:1273
6294 msgid "guestfs_drop_caches"
6298 #: ../src/guestfs-actions.pod:1275
6302 " guestfs_drop_caches (guestfs_h *g,\n"
6303 " int whattodrop);\n"
6308 #: ../src/guestfs-actions.pod:1279 ../fish/guestfish-actions.pod:852
6310 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6311 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6312 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6316 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:857
6317 msgid "Setting C<whattodrop> to 3 should drop everything."
6321 #: ../src/guestfs-actions.pod:1286 ../fish/guestfish-actions.pod:859
6323 "This automatically calls L<sync(2)> before the operation, so that the "
6324 "maximum guest memory is freed."
6328 #: ../src/guestfs-actions.pod:1293
6333 #: ../src/guestfs-actions.pod:1295
6337 " guestfs_du (guestfs_h *g,\n"
6338 " const char *path);\n"
6343 #: ../src/guestfs-actions.pod:1299 ../fish/guestfish-actions.pod:866
6345 "This command runs the C<du -s> command to estimate file space usage for "
6350 #: ../src/guestfs-actions.pod:1302 ../fish/guestfish-actions.pod:869
6352 "C<path> can be a file or a directory. If C<path> is a directory then the "
6353 "estimate includes the contents of the directory and all subdirectories "
6358 #: ../src/guestfs-actions.pod:1306 ../fish/guestfish-actions.pod:873
6359 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6363 #: ../src/guestfs-actions.pod:1313
6364 msgid "guestfs_e2fsck_f"
6368 #: ../src/guestfs-actions.pod:1315
6372 " guestfs_e2fsck_f (guestfs_h *g,\n"
6373 " const char *device);\n"
6378 #: ../src/guestfs-actions.pod:1319 ../fish/guestfish-actions.pod:880
6380 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6381 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6386 #: ../src/guestfs-actions.pod:1323
6388 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6389 "Normally you should use C<guestfs_fsck>."
6393 #: ../src/guestfs-actions.pod:1328
6394 msgid "(Added in 1.0.29)"
6398 #: ../src/guestfs-actions.pod:1330
6399 msgid "guestfs_echo_daemon"
6403 #: ../src/guestfs-actions.pod:1332
6407 " guestfs_echo_daemon (guestfs_h *g,\n"
6408 " char *const *words);\n"
6413 #: ../src/guestfs-actions.pod:1336 ../fish/guestfish-actions.pod:891
6415 "This command concatenates the list of C<words> passed with single spaces "
6416 "between them and returns the resulting string."
6420 #: ../src/guestfs-actions.pod:1339 ../fish/guestfish-actions.pod:894
6421 msgid "You can use this command to test the connection through to the daemon."
6425 #: ../src/guestfs-actions.pod:1341
6426 msgid "See also C<guestfs_ping_daemon>."
6430 #: ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:2073 ../src/guestfs-actions.pod:5632
6431 msgid "(Added in 1.0.69)"
6435 #: ../src/guestfs-actions.pod:1348
6436 msgid "guestfs_egrep"
6440 #: ../src/guestfs-actions.pod:1350
6444 " guestfs_egrep (guestfs_h *g,\n"
6445 " const char *regex,\n"
6446 " const char *path);\n"
6451 #: ../src/guestfs-actions.pod:1355 ../fish/guestfish-actions.pod:902
6452 msgid "This calls the external C<egrep> program and returns the matching lines."
6456 #: ../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:4301 ../src/guestfs-actions.pod:5177 ../src/guestfs-actions.pod:5226 ../src/guestfs-actions.pod:5996 ../src/guestfs-actions.pod:6008 ../src/guestfs-actions.pod:6021 ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:6056 ../src/guestfs-actions.pod:6069 ../src/guestfs-actions.pod:6082 ../src/guestfs-actions.pod:6095 ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6875 ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:6979 ../src/guestfs-actions.pod:7025 ../src/guestfs-actions.pod:7044
6457 msgid "(Added in 1.0.66)"
6461 #: ../src/guestfs-actions.pod:1367
6462 msgid "guestfs_egrepi"
6466 #: ../src/guestfs-actions.pod:1369
6470 " guestfs_egrepi (guestfs_h *g,\n"
6471 " const char *regex,\n"
6472 " const char *path);\n"
6477 #: ../src/guestfs-actions.pod:1374 ../fish/guestfish-actions.pod:912
6478 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6482 #: ../src/guestfs-actions.pod:1386
6483 msgid "guestfs_equal"
6487 #: ../src/guestfs-actions.pod:1388
6491 " guestfs_equal (guestfs_h *g,\n"
6492 " const char *file1,\n"
6493 " const char *file2);\n"
6498 #: ../src/guestfs-actions.pod:1393 ../fish/guestfish-actions.pod:922
6500 "This compares the two files C<file1> and C<file2> and returns true if their "
6501 "content is exactly equal, or false otherwise."
6505 #: ../src/guestfs-actions.pod:1396 ../fish/guestfish-actions.pod:925
6506 msgid "The external L<cmp(1)> program is used for the comparison."
6510 #: ../src/guestfs-actions.pod:1402
6511 msgid "guestfs_exists"
6515 #: ../src/guestfs-actions.pod:1404
6519 " guestfs_exists (guestfs_h *g,\n"
6520 " const char *path);\n"
6525 #: ../src/guestfs-actions.pod:1408 ../fish/guestfish-actions.pod:931
6527 "This returns C<true> if and only if there is a file, directory (or anything) "
6528 "with the given C<path> name."
6532 #: ../src/guestfs-actions.pod:1411
6533 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6537 #: ../src/guestfs-actions.pod:1417
6538 msgid "guestfs_fallocate"
6542 #: ../src/guestfs-actions.pod:1419
6546 " guestfs_fallocate (guestfs_h *g,\n"
6547 " const char *path,\n"
6553 #: ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1450 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6555 "This command preallocates a file (containing zero bytes) named C<path> of "
6556 "size C<len> bytes. If the file exists already, it is overwritten."
6560 #: ../src/guestfs-actions.pod:1428 ../fish/guestfish-actions.pod:944
6562 "Do not confuse this with the guestfish-specific C<alloc> command which "
6563 "allocates a file in the host and attaches it as a device."
6567 #: ../src/guestfs-actions.pod:1434 ../fish/guestfish-actions.pod:948
6569 "This function is deprecated. In new code, use the C<fallocate64> call "
6574 #: ../src/guestfs-actions.pod:1443
6575 msgid "guestfs_fallocate64"
6579 #: ../src/guestfs-actions.pod:1445
6583 " guestfs_fallocate64 (guestfs_h *g,\n"
6584 " const char *path,\n"
6590 #: ../src/guestfs-actions.pod:1454
6592 "Note that this call allocates disk blocks for the file. To create a sparse "
6593 "file use C<guestfs_truncate_size> instead."
6597 #: ../src/guestfs-actions.pod:1457
6599 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6600 "oversight it only allowed 30 bit lengths to be specified, effectively "
6601 "limiting the maximum size of files created through that call to 1GB."
6605 #: ../src/guestfs-actions.pod:1462 ../fish/guestfish-actions.pod:971
6607 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6608 "commands which create a file in the host and attach it as a device."
6612 #: ../src/guestfs-actions.pod:1468
6613 msgid "(Added in 1.3.17)"
6617 #: ../src/guestfs-actions.pod:1470
6618 msgid "guestfs_fgrep"
6622 #: ../src/guestfs-actions.pod:1472
6626 " guestfs_fgrep (guestfs_h *g,\n"
6627 " const char *pattern,\n"
6628 " const char *path);\n"
6633 #: ../src/guestfs-actions.pod:1477 ../fish/guestfish-actions.pod:979
6634 msgid "This calls the external C<fgrep> program and returns the matching lines."
6638 #: ../src/guestfs-actions.pod:1489
6639 msgid "guestfs_fgrepi"
6643 #: ../src/guestfs-actions.pod:1491
6647 " guestfs_fgrepi (guestfs_h *g,\n"
6648 " const char *pattern,\n"
6649 " const char *path);\n"
6654 #: ../src/guestfs-actions.pod:1496 ../fish/guestfish-actions.pod:989
6655 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6659 #: ../src/guestfs-actions.pod:1508
6660 msgid "guestfs_file"
6664 #: ../src/guestfs-actions.pod:1510
6668 " guestfs_file (guestfs_h *g,\n"
6669 " const char *path);\n"
6674 #: ../src/guestfs-actions.pod:1514 ../fish/guestfish-actions.pod:999
6676 "This call uses the standard L<file(1)> command to determine the type or "
6677 "contents of the file."
6681 #: ../src/guestfs-actions.pod:1517 ../fish/guestfish-actions.pod:1002
6683 "This call will also transparently look inside various types of compressed "
6688 #: ../src/guestfs-actions.pod:1520 ../fish/guestfish-actions.pod:1005
6690 "The exact command which runs is C<file -zb path>. Note in particular that "
6691 "the filename is not prepended to the output (the C<-b> option)."
6695 #: ../src/guestfs-actions.pod:1524
6697 "This command can also be used on C</dev/> devices (and partitions, LV "
6698 "names). You can for example use this to determine if a device contains a "
6699 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6703 #: ../src/guestfs-actions.pod:1529 ../fish/guestfish-actions.pod:1014
6705 "If the C<path> does not begin with C</dev/> then this command only works for "
6706 "the content of regular files. For other file types (directory, symbolic "
6707 "link etc) it will just return the string C<directory> etc."
6711 #: ../src/guestfs-actions.pod:1539
6712 msgid "guestfs_file_architecture"
6716 #: ../src/guestfs-actions.pod:1541
6720 " guestfs_file_architecture (guestfs_h *g,\n"
6721 " const char *filename);\n"
6726 #: ../src/guestfs-actions.pod:1545 ../fish/guestfish-actions.pod:1023
6728 "This detects the architecture of the binary C<filename>, and returns it if "
6733 #: ../src/guestfs-actions.pod:1548 ../fish/guestfish-actions.pod:1026
6734 msgid "Currently defined architectures are:"
6738 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1030
6743 #: ../src/guestfs-actions.pod:1554 ../fish/guestfish-actions.pod:1032
6745 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6746 "irrespective of the precise processor requirements of the binary."
6750 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1035
6755 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1037
6756 msgid "64 bit x86-64."
6760 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1039
6765 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1041
6766 msgid "32 bit SPARC."
6770 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1043
6775 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1045
6776 msgid "64 bit SPARC V9 and above."
6780 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1047
6785 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1049
6786 msgid "Intel Itanium."
6790 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1051
6795 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1053
6796 msgid "32 bit Power PC."
6800 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1055
6805 #: ../src/guestfs-actions.pod:1579 ../fish/guestfish-actions.pod:1057
6806 msgid "64 bit Power PC."
6810 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1061
6811 msgid "Libguestfs may return other architecture strings in future."
6815 #: ../src/guestfs-actions.pod:1585 ../fish/guestfish-actions.pod:1063
6816 msgid "The function works on at least the following types of files:"
6820 #: ../src/guestfs-actions.pod:1591 ../fish/guestfish-actions.pod:1069
6821 msgid "many types of Un*x and Linux binary"
6825 #: ../src/guestfs-actions.pod:1595 ../fish/guestfish-actions.pod:1073
6826 msgid "many types of Un*x and Linux shared library"
6830 #: ../src/guestfs-actions.pod:1599 ../fish/guestfish-actions.pod:1077
6831 msgid "Windows Win32 and Win64 binaries"
6835 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1081
6836 msgid "Windows Win32 and Win64 DLLs"
6840 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1083
6841 msgid "Win32 binaries and DLLs return C<i386>."
6845 #: ../src/guestfs-actions.pod:1607 ../fish/guestfish-actions.pod:1085
6846 msgid "Win64 binaries and DLLs return C<x86_64>."
6850 #: ../src/guestfs-actions.pod:1611 ../fish/guestfish-actions.pod:1089
6851 msgid "Linux kernel modules"
6855 #: ../src/guestfs-actions.pod:1615 ../fish/guestfish-actions.pod:1093
6856 msgid "Linux new-style initrd images"
6860 #: ../src/guestfs-actions.pod:1619 ../fish/guestfish-actions.pod:1097
6861 msgid "some non-x86 Linux vmlinuz kernels"
6865 #: ../src/guestfs-actions.pod:1623 ../fish/guestfish-actions.pod:1101
6866 msgid "What it can't do currently:"
6870 #: ../src/guestfs-actions.pod:1629 ../fish/guestfish-actions.pod:1107
6871 msgid "static libraries (libfoo.a)"
6875 #: ../src/guestfs-actions.pod:1633 ../fish/guestfish-actions.pod:1111
6876 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6880 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1115
6881 msgid "x86 Linux vmlinuz kernels"
6885 #: ../src/guestfs-actions.pod:1639 ../fish/guestfish-actions.pod:1117
6887 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6888 "compressed code, and are horribly hard to unpack. If you want to find the "
6889 "architecture of a kernel, use the architecture of the associated initrd or "
6890 "kernel module(s) instead."
6894 #: ../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
6895 msgid "(Added in 1.5.3)"
6899 #: ../src/guestfs-actions.pod:1651
6900 msgid "guestfs_filesize"
6904 #: ../src/guestfs-actions.pod:1653
6908 " guestfs_filesize (guestfs_h *g,\n"
6909 " const char *file);\n"
6914 #: ../src/guestfs-actions.pod:1657 ../fish/guestfish-actions.pod:1128
6915 msgid "This command returns the size of C<file> in bytes."
6919 #: ../src/guestfs-actions.pod:1659
6921 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6922 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6923 "devices, use C<guestfs_blockdev_getsize64>."
6927 #: ../src/guestfs-actions.pod:1665
6928 msgid "(Added in 1.0.82)"
6932 #: ../src/guestfs-actions.pod:1667
6933 msgid "guestfs_fill"
6937 #: ../src/guestfs-actions.pod:1669
6941 " guestfs_fill (guestfs_h *g,\n"
6944 " const char *path);\n"
6949 #: ../src/guestfs-actions.pod:1675 ../fish/guestfish-actions.pod:1138
6951 "This command creates a new file called C<path>. The initial content of the "
6952 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6957 #: ../src/guestfs-actions.pod:1679
6959 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6960 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6961 "bytes use C<guestfs_fill_pattern>."
6965 #: ../src/guestfs-actions.pod:1691
6966 msgid "(Added in 1.0.79)"
6970 #: ../src/guestfs-actions.pod:1693
6971 msgid "guestfs_fill_pattern"
6975 #: ../src/guestfs-actions.pod:1695
6979 " guestfs_fill_pattern (guestfs_h *g,\n"
6980 " const char *pattern,\n"
6982 " const char *path);\n"
6987 #: ../src/guestfs-actions.pod:1701
6989 "This function is like C<guestfs_fill> except that it creates a new file of "
6990 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6991 "pattern is truncated if necessary to ensure the length of the file is "
6992 "exactly C<len> bytes."
6996 #: ../src/guestfs-actions.pod:1713
6997 msgid "(Added in 1.3.12)"
7001 #: ../src/guestfs-actions.pod:1715
7002 msgid "guestfs_find"
7006 #: ../src/guestfs-actions.pod:1717
7010 " guestfs_find (guestfs_h *g,\n"
7011 " const char *directory);\n"
7016 #: ../src/guestfs-actions.pod:1721 ../fish/guestfish-actions.pod:1160
7018 "This command lists out all files and directories, recursively, starting at "
7019 "C<directory>. It is essentially equivalent to running the shell command "
7020 "C<find directory -print> but some post-processing happens on the output, "
7025 #: ../src/guestfs-actions.pod:1726 ../fish/guestfish-actions.pod:1165
7027 "This returns a list of strings I<without any prefix>. Thus if the directory "
7032 #: ../src/guestfs-actions.pod:1729 ../fish/guestfish-actions.pod:1168
7042 #: ../src/guestfs-actions.pod:1733
7043 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7047 #: ../src/guestfs-actions.pod:1736 ../fish/guestfish-actions.pod:1175
7058 #: ../src/guestfs-actions.pod:1741 ../fish/guestfish-actions.pod:1180
7059 msgid "If C<directory> is not a directory, then this command returns an error."
7063 #: ../src/guestfs-actions.pod:1744 ../fish/guestfish-actions.pod:1183
7064 msgid "The returned list is sorted."
7068 #: ../src/guestfs-actions.pod:1746
7069 msgid "See also C<guestfs_find0>."
7073 #: ../src/guestfs-actions.pod:1755 ../src/guestfs-actions.pod:3800 ../src/guestfs-actions.pod:5261
7074 msgid "(Added in 1.0.27)"
7078 #: ../src/guestfs-actions.pod:1757
7079 msgid "guestfs_find0"
7083 #: ../src/guestfs-actions.pod:1759
7087 " guestfs_find0 (guestfs_h *g,\n"
7088 " const char *directory,\n"
7089 " const char *files);\n"
7094 #: ../src/guestfs-actions.pod:1764 ../fish/guestfish-actions.pod:1194
7096 "This command lists out all files and directories, recursively, starting at "
7097 "C<directory>, placing the resulting list in the external file called "
7102 #: ../src/guestfs-actions.pod:1768
7104 "This command works the same way as C<guestfs_find> with the following "
7109 #: ../src/guestfs-actions.pod:1775 ../fish/guestfish-actions.pod:1205
7110 msgid "The resulting list is written to an external file."
7114 #: ../src/guestfs-actions.pod:1779 ../fish/guestfish-actions.pod:1209
7116 "Items (filenames) in the result are separated by C<\\0> characters. See "
7117 "L<find(1)> option I<-print0>."
7121 #: ../src/guestfs-actions.pod:1784 ../fish/guestfish-actions.pod:1214
7122 msgid "This command is not limited in the number of names that it can return."
7126 #: ../src/guestfs-actions.pod:1789 ../fish/guestfish-actions.pod:1219
7127 msgid "The result list is not sorted."
7131 #: ../src/guestfs-actions.pod:1795
7132 msgid "(Added in 1.0.74)"
7136 #: ../src/guestfs-actions.pod:1797
7137 msgid "guestfs_findfs_label"
7141 #: ../src/guestfs-actions.pod:1799
7145 " guestfs_findfs_label (guestfs_h *g,\n"
7146 " const char *label);\n"
7151 #: ../src/guestfs-actions.pod:1803 ../fish/guestfish-actions.pod:1229
7153 "This command searches the filesystems and returns the one which has the "
7154 "given label. An error is returned if no such filesystem can be found."
7158 #: ../src/guestfs-actions.pod:1807
7159 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7163 #: ../src/guestfs-actions.pod:1814
7164 msgid "guestfs_findfs_uuid"
7168 #: ../src/guestfs-actions.pod:1816
7172 " guestfs_findfs_uuid (guestfs_h *g,\n"
7173 " const char *uuid);\n"
7178 #: ../src/guestfs-actions.pod:1820 ../fish/guestfish-actions.pod:1239
7180 "This command searches the filesystems and returns the one which has the "
7181 "given UUID. An error is returned if no such filesystem can be found."
7185 #: ../src/guestfs-actions.pod:1824
7186 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7190 #: ../src/guestfs-actions.pod:1831
7191 msgid "guestfs_fsck"
7195 #: ../src/guestfs-actions.pod:1833
7199 " guestfs_fsck (guestfs_h *g,\n"
7200 " const char *fstype,\n"
7201 " const char *device);\n"
7206 #: ../src/guestfs-actions.pod:1838 ../fish/guestfish-actions.pod:1249
7208 "This runs the filesystem checker (fsck) on C<device> which should have "
7209 "filesystem type C<fstype>."
7213 #: ../src/guestfs-actions.pod:1841 ../fish/guestfish-actions.pod:1252
7215 "The returned integer is the status. See L<fsck(8)> for the list of status "
7216 "codes from C<fsck>."
7220 #: ../src/guestfs-actions.pod:1850 ../fish/guestfish-actions.pod:1261
7221 msgid "Multiple status codes can be summed together."
7225 #: ../src/guestfs-actions.pod:1854 ../fish/guestfish-actions.pod:1265
7227 "A non-zero return code can mean \"success\", for example if errors have been "
7228 "corrected on the filesystem."
7232 #: ../src/guestfs-actions.pod:1859 ../fish/guestfish-actions.pod:1270
7233 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7237 #: ../src/guestfs-actions.pod:1864 ../fish/guestfish-actions.pod:1275
7238 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7242 #: ../src/guestfs-actions.pod:1868 ../src/guestfs-actions.pod:6898
7243 msgid "(Added in 1.0.16)"
7247 #: ../src/guestfs-actions.pod:1870
7248 msgid "guestfs_get_append"
7252 #: ../src/guestfs-actions.pod:1872
7256 " guestfs_get_append (guestfs_h *g);\n"
7261 #: ../src/guestfs-actions.pod:1875 ../fish/guestfish-actions.pod:1281
7263 "Return the additional kernel options which are added to the guest kernel "
7268 #: ../src/guestfs-actions.pod:1878 ../fish/guestfish-actions.pod:1284
7269 msgid "If C<NULL> then no options are added."
7273 #: ../src/guestfs-actions.pod:1880
7275 "This function returns a string which may be NULL. There is no way to return "
7276 "an error from this function. The string is owned by the guest handle and "
7277 "must I<not> be freed."
7281 #: ../src/guestfs-actions.pod:1884 ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5770 ../src/guestfs-actions.pod:5789 ../src/guestfs-actions.pod:5805 ../src/guestfs-actions.pod:5822 ../src/guestfs-actions.pod:6569 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6941
7282 msgid "(Added in 1.0.26)"
7286 #: ../src/guestfs-actions.pod:1886
7287 msgid "guestfs_get_autosync"
7291 #: ../src/guestfs-actions.pod:1888
7295 " guestfs_get_autosync (guestfs_h *g);\n"
7300 #: ../src/guestfs-actions.pod:1891 ../fish/guestfish-actions.pod:1290
7301 msgid "Get the autosync flag."
7305 #: ../src/guestfs-actions.pod:1897
7306 msgid "guestfs_get_direct"
7310 #: ../src/guestfs-actions.pod:1899
7314 " guestfs_get_direct (guestfs_h *g);\n"
7319 #: ../src/guestfs-actions.pod:1902 ../fish/guestfish-actions.pod:1296
7320 msgid "Return the direct appliance mode flag."
7324 #: ../src/guestfs-actions.pod:1906 ../src/guestfs-actions.pod:5443
7325 msgid "(Added in 1.0.72)"
7329 #: ../src/guestfs-actions.pod:1908
7330 msgid "guestfs_get_e2label"
7334 #: ../src/guestfs-actions.pod:1910
7338 " guestfs_get_e2label (guestfs_h *g,\n"
7339 " const char *device);\n"
7344 #: ../src/guestfs-actions.pod:1914 ../fish/guestfish-actions.pod:1302
7345 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7349 #: ../src/guestfs-actions.pod:1920 ../fish/guestfish-actions.pod:1305
7351 "This function is deprecated. In new code, use the C<vfs_label> call "
7356 #: ../src/guestfs-actions.pod:1927 ../src/guestfs-actions.pod:1948 ../src/guestfs-actions.pod:5461 ../src/guestfs-actions.pod:5480
7357 msgid "(Added in 1.0.15)"
7361 #: ../src/guestfs-actions.pod:1929
7362 msgid "guestfs_get_e2uuid"
7366 #: ../src/guestfs-actions.pod:1931
7370 " guestfs_get_e2uuid (guestfs_h *g,\n"
7371 " const char *device);\n"
7376 #: ../src/guestfs-actions.pod:1935 ../fish/guestfish-actions.pod:1316
7377 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7381 #: ../src/guestfs-actions.pod:1941 ../fish/guestfish-actions.pod:1319
7382 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7386 #: ../src/guestfs-actions.pod:1950
7387 msgid "guestfs_get_memsize"
7391 #: ../src/guestfs-actions.pod:1952
7395 " guestfs_get_memsize (guestfs_h *g);\n"
7400 #: ../src/guestfs-actions.pod:1955 ../fish/guestfish-actions.pod:1330
7401 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7405 #: ../src/guestfs-actions.pod:1958
7407 "If C<guestfs_set_memsize> was not called on this handle, and if "
7408 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7409 "value for memsize."
7413 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:2043 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5603 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7414 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7418 #: ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:4206 ../src/guestfs-actions.pod:4225 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4256 ../src/guestfs-actions.pod:4273 ../src/guestfs-actions.pod:4286 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5501 ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:6345
7419 msgid "(Added in 1.0.55)"
7423 #: ../src/guestfs-actions.pod:1969
7424 msgid "guestfs_get_network"
7428 #: ../src/guestfs-actions.pod:1971
7432 " guestfs_get_network (guestfs_h *g);\n"
7437 #: ../src/guestfs-actions.pod:1974 ../fish/guestfish-actions.pod:1344
7438 msgid "This returns the enable network flag."
7442 #: ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:5520
7443 msgid "(Added in 1.5.4)"
7447 #: ../src/guestfs-actions.pod:1980
7448 msgid "guestfs_get_path"
7452 #: ../src/guestfs-actions.pod:1982
7456 " guestfs_get_path (guestfs_h *g);\n"
7461 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1350
7462 msgid "Return the current search path."
7466 #: ../src/guestfs-actions.pod:1987 ../fish/guestfish-actions.pod:1352
7468 "This is always non-NULL. If it wasn't set already, then this will return "
7473 #: ../src/guestfs-actions.pod:1990 ../src/guestfs-actions.pod:2019
7475 "This function returns a string, or NULL on error. The string is owned by "
7476 "the guest handle and must I<not> be freed."
7480 #: ../src/guestfs-actions.pod:1995
7481 msgid "guestfs_get_pid"
7485 #: ../src/guestfs-actions.pod:1997
7489 " guestfs_get_pid (guestfs_h *g);\n"
7494 #: ../src/guestfs-actions.pod:2000 ../fish/guestfish-actions.pod:1361
7496 "Return the process ID of the qemu subprocess. If there is no qemu "
7497 "subprocess, then this will return an error."
7501 #: ../src/guestfs-actions.pod:2003 ../fish/guestfish-actions.pod:1364
7502 msgid "This is an internal call used for debugging and testing."
7506 #: ../src/guestfs-actions.pod:2007
7507 msgid "(Added in 1.0.56)"
7511 #: ../src/guestfs-actions.pod:2009
7512 msgid "guestfs_get_qemu"
7516 #: ../src/guestfs-actions.pod:2011
7520 " guestfs_get_qemu (guestfs_h *g);\n"
7525 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1370
7526 msgid "Return the current qemu binary."
7530 #: ../src/guestfs-actions.pod:2016 ../fish/guestfish-actions.pod:1372
7532 "This is always non-NULL. If it wasn't set already, then this will return "
7533 "the default qemu binary name."
7537 #: ../src/guestfs-actions.pod:2022 ../src/guestfs-actions.pod:5565
7538 msgid "(Added in 1.0.6)"
7542 #: ../src/guestfs-actions.pod:2024
7543 msgid "guestfs_get_recovery_proc"
7547 #: ../src/guestfs-actions.pod:2026
7551 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7556 #: ../src/guestfs-actions.pod:2029 ../fish/guestfish-actions.pod:1379
7557 msgid "Return the recovery process enabled flag."
7561 #: ../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:4869 ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5589 ../src/guestfs-actions.pod:6248 ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6450
7562 msgid "(Added in 1.0.77)"
7566 #: ../src/guestfs-actions.pod:2035
7567 msgid "guestfs_get_selinux"
7571 #: ../src/guestfs-actions.pod:2037
7575 " guestfs_get_selinux (guestfs_h *g);\n"
7580 #: ../src/guestfs-actions.pod:2040
7582 "This returns the current setting of the selinux flag which is passed to the "
7583 "appliance at boot time. See C<guestfs_set_selinux>."
7587 #: ../src/guestfs-actions.pod:2048 ../src/guestfs-actions.pod:2111 ../src/guestfs-actions.pod:5608 ../src/guestfs-actions.pod:5662
7588 msgid "(Added in 1.0.67)"
7592 #: ../src/guestfs-actions.pod:2050
7593 msgid "guestfs_get_state"
7597 #: ../src/guestfs-actions.pod:2052
7601 " guestfs_get_state (guestfs_h *g);\n"
7606 #: ../src/guestfs-actions.pod:2055 ../fish/guestfish-actions.pod:1395
7608 "This returns the current state as an opaque integer. This is only useful "
7609 "for printing debug and internal error messages."
7613 #: ../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
7614 msgid "For more information on states, see L<guestfs(3)>."
7618 #: ../src/guestfs-actions.pod:2064
7619 msgid "guestfs_get_trace"
7623 #: ../src/guestfs-actions.pod:2066
7627 " guestfs_get_trace (guestfs_h *g);\n"
7632 #: ../src/guestfs-actions.pod:2069 ../fish/guestfish-actions.pod:1404
7633 msgid "Return the command trace flag."
7637 #: ../src/guestfs-actions.pod:2075
7638 msgid "guestfs_get_umask"
7642 #: ../src/guestfs-actions.pod:2077
7646 " guestfs_get_umask (guestfs_h *g);\n"
7651 #: ../src/guestfs-actions.pod:2080
7653 "Return the current umask. By default the umask is C<022> unless it has been "
7654 "set by calling C<guestfs_umask>."
7658 #: ../src/guestfs-actions.pod:2087
7659 msgid "guestfs_get_verbose"
7663 #: ../src/guestfs-actions.pod:2089
7667 " guestfs_get_verbose (guestfs_h *g);\n"
7672 #: ../src/guestfs-actions.pod:2092 ../fish/guestfish-actions.pod:1417
7673 msgid "This returns the verbose messages flag."
7677 #: ../src/guestfs-actions.pod:2098
7678 msgid "guestfs_getcon"
7682 #: ../src/guestfs-actions.pod:2100
7686 " guestfs_getcon (guestfs_h *g);\n"
7691 #: ../src/guestfs-actions.pod:2103 ../fish/guestfish-actions.pod:1423
7692 msgid "This gets the SELinux security context of the daemon."
7696 #: ../src/guestfs-actions.pod:2105
7697 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7701 #: ../src/guestfs-actions.pod:2113
7702 msgid "guestfs_getxattrs"
7706 #: ../src/guestfs-actions.pod:2115
7709 " struct guestfs_xattr_list *\n"
7710 " guestfs_getxattrs (guestfs_h *g,\n"
7711 " const char *path);\n"
7716 #: ../src/guestfs-actions.pod:2119 ../fish/guestfish-actions.pod:1432
7717 msgid "This call lists the extended attributes of the file or directory C<path>."
7721 #: ../src/guestfs-actions.pod:2122 ../fish/guestfish-actions.pod:1435
7723 "At the system call level, this is a combination of the L<listxattr(2)> and "
7724 "L<getxattr(2)> calls."
7728 #: ../src/guestfs-actions.pod:2125
7729 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7733 #: ../src/guestfs-actions.pod:2127 ../src/guestfs-actions.pod:3243 ../src/guestfs-actions.pod:3894
7735 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7736 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7740 #: ../src/guestfs-actions.pod:2131 ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3412 ../src/guestfs-actions.pod:3448 ../src/guestfs-actions.pod:5242 ../src/guestfs-actions.pod:5681 ../src/guestfs-actions.pod:7006
7741 msgid "(Added in 1.0.59)"
7745 #: ../src/guestfs-actions.pod:2133
7746 msgid "guestfs_glob_expand"
7750 #: ../src/guestfs-actions.pod:2135
7754 " guestfs_glob_expand (guestfs_h *g,\n"
7755 " const char *pattern);\n"
7760 #: ../src/guestfs-actions.pod:2139 ../fish/guestfish-actions.pod:1444
7762 "This command searches for all the pathnames matching C<pattern> according to "
7763 "the wildcard expansion rules used by the shell."
7767 #: ../src/guestfs-actions.pod:2143 ../fish/guestfish-actions.pod:1448
7768 msgid "If no paths match, then this returns an empty list (note: not an error)."
7772 #: ../src/guestfs-actions.pod:2146 ../fish/guestfish-actions.pod:1451
7774 "It is just a wrapper around the C L<glob(3)> function with flags "
7775 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7779 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:5846 ../src/guestfs-actions.pod:5863
7780 msgid "(Added in 1.0.50)"
7784 #: ../src/guestfs-actions.pod:2156
7785 msgid "guestfs_grep"
7789 #: ../src/guestfs-actions.pod:2158
7793 " guestfs_grep (guestfs_h *g,\n"
7794 " const char *regex,\n"
7795 " const char *path);\n"
7800 #: ../src/guestfs-actions.pod:2163 ../fish/guestfish-actions.pod:1459
7801 msgid "This calls the external C<grep> program and returns the matching lines."
7805 #: ../src/guestfs-actions.pod:2175
7806 msgid "guestfs_grepi"
7810 #: ../src/guestfs-actions.pod:2177
7814 " guestfs_grepi (guestfs_h *g,\n"
7815 " const char *regex,\n"
7816 " const char *path);\n"
7821 #: ../src/guestfs-actions.pod:2182 ../fish/guestfish-actions.pod:1469
7822 msgid "This calls the external C<grep -i> program and returns the matching lines."
7826 #: ../src/guestfs-actions.pod:2194
7827 msgid "guestfs_grub_install"
7831 #: ../src/guestfs-actions.pod:2196
7835 " guestfs_grub_install (guestfs_h *g,\n"
7836 " const char *root,\n"
7837 " const char *device);\n"
7842 #: ../src/guestfs-actions.pod:2201 ../fish/guestfish-actions.pod:1479
7844 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7845 "the root directory being C<root>."
7849 #: ../src/guestfs-actions.pod:2204 ../fish/guestfish-actions.pod:1482
7851 "Note: If grub-install reports the error \"No suitable drive was found in the "
7852 "generated device map.\" it may be that you need to create a "
7853 "C</boot/grub/device.map> file first that contains the mapping between grub "
7854 "device names and Linux device names. It is usually sufficient to create a "
7859 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1489
7867 #: ../src/guestfs-actions.pod:2213 ../fish/guestfish-actions.pod:1491
7868 msgid "replacing C</dev/vda> with the name of the installation device."
7872 #: ../src/guestfs-actions.pod:2217
7873 msgid "(Added in 1.0.17)"
7877 #: ../src/guestfs-actions.pod:2219
7878 msgid "guestfs_head"
7882 #: ../src/guestfs-actions.pod:2221
7886 " guestfs_head (guestfs_h *g,\n"
7887 " const char *path);\n"
7892 #: ../src/guestfs-actions.pod:2225 ../fish/guestfish-actions.pod:1497
7894 "This command returns up to the first 10 lines of a file as a list of "
7899 #: ../src/guestfs-actions.pod:2237
7900 msgid "guestfs_head_n"
7904 #: ../src/guestfs-actions.pod:2239
7908 " guestfs_head_n (guestfs_h *g,\n"
7910 " const char *path);\n"
7915 #: ../src/guestfs-actions.pod:2244 ../fish/guestfish-actions.pod:1507
7917 "If the parameter C<nrlines> is a positive number, this returns the first "
7918 "C<nrlines> lines of the file C<path>."
7922 #: ../src/guestfs-actions.pod:2247 ../fish/guestfish-actions.pod:1510
7924 "If the parameter C<nrlines> is a negative number, this returns lines from "
7925 "the file C<path>, excluding the last C<nrlines> lines."
7929 #: ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:6143 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
7930 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7934 #: ../src/guestfs-actions.pod:2261
7935 msgid "guestfs_hexdump"
7939 #: ../src/guestfs-actions.pod:2263
7943 " guestfs_hexdump (guestfs_h *g,\n"
7944 " const char *path);\n"
7949 #: ../src/guestfs-actions.pod:2267 ../fish/guestfish-actions.pod:1522
7951 "This runs C<hexdump -C> on the given C<path>. The result is the "
7952 "human-readable, canonical hex dump of the file."
7956 #: ../src/guestfs-actions.pod:2276 ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:5982
7957 msgid "(Added in 1.0.22)"
7961 #: ../src/guestfs-actions.pod:2278
7962 msgid "guestfs_initrd_cat"
7966 #: ../src/guestfs-actions.pod:2280
7970 " guestfs_initrd_cat (guestfs_h *g,\n"
7971 " const char *initrdpath,\n"
7972 " const char *filename,\n"
7973 " size_t *size_r);\n"
7978 #: ../src/guestfs-actions.pod:2286 ../fish/guestfish-actions.pod:1532
7980 "This command unpacks the file C<filename> from the initrd file called "
7981 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7986 #: ../src/guestfs-actions.pod:2290 ../fish/guestfish-actions.pod:1536
7988 "For example, in guestfish you could use the following command to examine the "
7989 "boot script (usually called C</init>) contained in a Linux initrd or "
7994 #: ../src/guestfs-actions.pod:2294 ../fish/guestfish-actions.pod:1540
7997 " initrd-cat /boot/initrd-<version>.img init\n"
8002 #: ../src/guestfs-actions.pod:2296
8003 msgid "See also C<guestfs_initrd_list>."
8007 #: ../src/guestfs-actions.pod:2298 ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4888 ../src/guestfs-actions.pod:5069
8009 "This function returns a buffer, or NULL on error. The size of the returned "
8010 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8015 #: ../src/guestfs-actions.pod:2307
8016 msgid "guestfs_initrd_list"
8020 #: ../src/guestfs-actions.pod:2309
8024 " guestfs_initrd_list (guestfs_h *g,\n"
8025 " const char *path);\n"
8030 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1551
8031 msgid "This command lists out files contained in an initrd."
8035 #: ../src/guestfs-actions.pod:2315 ../fish/guestfish-actions.pod:1553
8037 "The files are listed without any initial C</> character. The files are "
8038 "listed in the order they appear (not necessarily alphabetical). Directory "
8039 "names are listed as separate items."
8043 #: ../src/guestfs-actions.pod:2319 ../fish/guestfish-actions.pod:1557
8045 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8046 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8051 #: ../src/guestfs-actions.pod:2329
8052 msgid "guestfs_inotify_add_watch"
8056 #: ../src/guestfs-actions.pod:2331
8060 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8061 " const char *path,\n"
8067 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1565
8068 msgid "Watch C<path> for the events listed in C<mask>."
8072 #: ../src/guestfs-actions.pod:2338 ../fish/guestfish-actions.pod:1567
8074 "Note that if C<path> is a directory then events within that directory are "
8075 "watched, but this does I<not> happen recursively (in subdirectories)."
8079 #: ../src/guestfs-actions.pod:2342 ../fish/guestfish-actions.pod:1571
8081 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8082 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8086 #: ../src/guestfs-actions.pod:2350
8087 msgid "guestfs_inotify_close"
8091 #: ../src/guestfs-actions.pod:2352
8095 " guestfs_inotify_close (guestfs_h *g);\n"
8100 #: ../src/guestfs-actions.pod:2355 ../fish/guestfish-actions.pod:1579
8102 "This closes the inotify handle which was previously opened by inotify_init. "
8103 "It removes all watches, throws away any pending events, and deallocates all "
8108 #: ../src/guestfs-actions.pod:2363
8109 msgid "guestfs_inotify_files"
8113 #: ../src/guestfs-actions.pod:2365
8117 " guestfs_inotify_files (guestfs_h *g);\n"
8122 #: ../src/guestfs-actions.pod:2368
8124 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8125 "returns a list of pathnames of objects that were touched. The returned "
8126 "pathnames are sorted and deduplicated."
8130 #: ../src/guestfs-actions.pod:2378
8131 msgid "guestfs_inotify_init"
8135 #: ../src/guestfs-actions.pod:2380
8139 " guestfs_inotify_init (guestfs_h *g,\n"
8140 " int maxevents);\n"
8145 #: ../src/guestfs-actions.pod:2384 ../fish/guestfish-actions.pod:1595
8147 "This command creates a new inotify handle. The inotify subsystem can be "
8148 "used to notify events which happen to objects in the guest filesystem."
8152 #: ../src/guestfs-actions.pod:2388
8154 "C<maxevents> is the maximum number of events which will be queued up between "
8155 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8156 "passed as C<0>, then the kernel (or previously set) default is used. For "
8157 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8158 "throws away events, but records the fact that it threw them away by setting "
8159 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8160 "C<guestfs_inotify_read>)."
8164 #: ../src/guestfs-actions.pod:2398
8166 "Before any events are generated, you have to add some watches to the "
8167 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8168 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8172 #: ../src/guestfs-actions.pod:2404
8174 "Queued up events should be read periodically by calling "
8175 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8176 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8177 "often enough then you risk the internal queue overflowing."
8181 #: ../src/guestfs-actions.pod:2411
8183 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8184 "This also removes any watches automatically."
8188 #: ../src/guestfs-actions.pod:2415 ../fish/guestfish-actions.pod:1626
8190 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8191 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8192 "that there is one global inotify handle per libguestfs instance."
8196 #: ../src/guestfs-actions.pod:2424
8197 msgid "guestfs_inotify_read"
8201 #: ../src/guestfs-actions.pod:2426
8204 " struct guestfs_inotify_event_list *\n"
8205 " guestfs_inotify_read (guestfs_h *g);\n"
8210 #: ../src/guestfs-actions.pod:2429 ../fish/guestfish-actions.pod:1635
8212 "Return the complete queue of events that have happened since the previous "
8217 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1638
8218 msgid "If no events have happened, this returns an empty list."
8222 #: ../src/guestfs-actions.pod:2434 ../fish/guestfish-actions.pod:1640
8224 "I<Note>: In order to make sure that all events have been read, you must call "
8225 "this function repeatedly until it returns an empty list. The reason is that "
8226 "the call will read events up to the maximum appliance-to-host message size "
8227 "and leave remaining events in the queue."
8231 #: ../src/guestfs-actions.pod:2440
8233 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8234 "there was an error. I<The caller must call "
8235 "C<guestfs_free_inotify_event_list> after use>."
8239 #: ../src/guestfs-actions.pod:2446
8240 msgid "guestfs_inotify_rm_watch"
8244 #: ../src/guestfs-actions.pod:2448
8248 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8254 #: ../src/guestfs-actions.pod:2452
8256 "Remove a previously defined inotify watch. See "
8257 "C<guestfs_inotify_add_watch>."
8261 #: ../src/guestfs-actions.pod:2459
8262 msgid "guestfs_inspect_get_arch"
8266 #: ../src/guestfs-actions.pod:2461
8270 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8271 " const char *root);\n"
8276 #: ../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
8278 "This function should only be called with a root device string as returned by "
8279 "C<guestfs_inspect_os>."
8283 #: ../src/guestfs-actions.pod:2468
8285 "This returns the architecture of the inspected operating system. The "
8286 "possible return values are listed under C<guestfs_file_architecture>."
8290 #: ../src/guestfs-actions.pod:2472 ../fish/guestfish-actions.pod:1664
8292 "If the architecture could not be determined, then the string C<unknown> is "
8297 #: ../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
8298 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8302 #: ../src/guestfs-actions.pod:2482
8303 msgid "guestfs_inspect_get_distro"
8307 #: ../src/guestfs-actions.pod:2484
8311 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8312 " const char *root);\n"
8317 #: ../src/guestfs-actions.pod:2491 ../fish/guestfish-actions.pod:1676
8318 msgid "This returns the distro (distribution) of the inspected operating system."
8322 #: ../src/guestfs-actions.pod:2494 ../fish/guestfish-actions.pod:1679
8323 msgid "Currently defined distros are:"
8327 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1683
8328 msgid "\"archlinux\""
8332 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1685
8337 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1687
8342 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1689
8347 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1691
8352 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1693
8357 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1695
8362 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1697
8367 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1699
8368 msgid "\"linuxmint\""
8372 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1701
8377 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1703
8378 msgid "\"mandriva\""
8382 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1705
8387 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1707
8392 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1709
8397 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1711
8402 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1713
8407 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1715
8408 msgid "\"redhat-based\""
8412 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1717
8413 msgid "Some Red Hat-derived distro."
8417 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1719
8422 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1721
8423 msgid "Red Hat Enterprise Linux and some derivatives."
8427 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1723
8432 #: ../src/guestfs-actions.pod:2540 ../fish/guestfish-actions.pod:1725
8437 #: ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2822 ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8442 #: ../src/guestfs-actions.pod:2544 ../fish/guestfish-actions.pod:1729
8443 msgid "The distro could not be determined."
8447 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8452 #: ../src/guestfs-actions.pod:2548 ../fish/guestfish-actions.pod:1733
8454 "Windows does not have distributions. This string is returned if the OS type "
8459 #: ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2828 ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8461 "Future versions of libguestfs may return other strings here. The caller "
8462 "should be prepared to handle any string."
8466 #: ../src/guestfs-actions.pod:2563
8467 msgid "guestfs_inspect_get_filesystems"
8471 #: ../src/guestfs-actions.pod:2565
8475 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8476 " const char *root);\n"
8481 #: ../src/guestfs-actions.pod:2572 ../fish/guestfish-actions.pod:1750
8483 "This returns a list of all the filesystems that we think are associated with "
8484 "this operating system. This includes the root filesystem, other ordinary "
8485 "filesystems, and non-mounted devices like swap partitions."
8489 #: ../src/guestfs-actions.pod:2577 ../fish/guestfish-actions.pod:1755
8491 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8492 "to be shared between operating systems."
8496 #: ../src/guestfs-actions.pod:2580
8498 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8499 "C<guestfs_inspect_get_mountpoints>."
8503 #: ../src/guestfs-actions.pod:2589
8504 msgid "guestfs_inspect_get_hostname"
8508 #: ../src/guestfs-actions.pod:2591
8512 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8513 " const char *root);\n"
8518 #: ../src/guestfs-actions.pod:2598 ../fish/guestfish-actions.pod:1768
8520 "This function returns the hostname of the operating system as found by "
8521 "inspection of the guest's configuration files."
8525 #: ../src/guestfs-actions.pod:2601 ../fish/guestfish-actions.pod:1771
8527 "If the hostname could not be determined, then the string C<unknown> is "
8532 #: ../src/guestfs-actions.pod:2609
8533 msgid "(Added in 1.7.9)"
8537 #: ../src/guestfs-actions.pod:2611
8538 msgid "guestfs_inspect_get_major_version"
8542 #: ../src/guestfs-actions.pod:2613
8546 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8547 " const char *root);\n"
8552 #: ../src/guestfs-actions.pod:2620 ../fish/guestfish-actions.pod:1783
8553 msgid "This returns the major version number of the inspected operating system."
8557 #: ../src/guestfs-actions.pod:2623 ../fish/guestfish-actions.pod:1786
8559 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8560 "popular public names used by the operating system. Notably the operating "
8561 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8562 "1). You can find out the real versions corresponding to releases of Windows "
8563 "by consulting Wikipedia or MSDN."
8567 #: ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2650 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8568 msgid "If the version could not be determined, then C<0> is returned."
8572 #: ../src/guestfs-actions.pod:2638
8573 msgid "guestfs_inspect_get_minor_version"
8577 #: ../src/guestfs-actions.pod:2640
8581 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8582 " const char *root);\n"
8587 #: ../src/guestfs-actions.pod:2647 ../fish/guestfish-actions.pod:1804
8588 msgid "This returns the minor version number of the inspected operating system."
8592 #: ../src/guestfs-actions.pod:2652
8594 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8595 "C<guestfs_inspect_get_major_version>."
8599 #: ../src/guestfs-actions.pod:2659
8600 msgid "guestfs_inspect_get_mountpoints"
8604 #: ../src/guestfs-actions.pod:2661
8608 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8609 " const char *root);\n"
8614 #: ../src/guestfs-actions.pod:2668 ../fish/guestfish-actions.pod:1819
8616 "This returns a hash of where we think the filesystems associated with this "
8617 "operating system should be mounted. Callers should note that this is at "
8618 "best an educated guess made by reading configuration files such as "
8623 #: ../src/guestfs-actions.pod:2673 ../fish/guestfish-actions.pod:1824
8625 "Each element in the returned hashtable has a key which is the path of the "
8626 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8627 "mounted there (eg. C</dev/sda1>)."
8631 #: ../src/guestfs-actions.pod:2678 ../fish/guestfish-actions.pod:1829
8632 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8636 #: ../src/guestfs-actions.pod:2681
8638 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8639 "C<guestfs_inspect_get_filesystems>."
8643 #: ../src/guestfs-actions.pod:2684 ../src/guestfs-actions.pod:3300 ../src/guestfs-actions.pod:4428 ../src/guestfs-actions.pod:6284
8645 "This function returns a NULL-terminated array of strings, or NULL if there "
8646 "was an error. The array of strings will always have length C<2n+1>, where "
8647 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8648 "caller must free the strings and the array after use>."
8652 #: ../src/guestfs-actions.pod:2692
8653 msgid "guestfs_inspect_get_package_format"
8657 #: ../src/guestfs-actions.pod:2694
8661 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8662 " const char *root);\n"
8667 #: ../src/guestfs-actions.pod:2701
8669 "This function and C<guestfs_inspect_get_package_management> return the "
8670 "package format and package management tool used by the inspected operating "
8671 "system. For example for Fedora these functions would return C<rpm> (package "
8672 "format) and C<yum> (package management)."
8676 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1848
8678 "This returns the string C<unknown> if we could not determine the package "
8679 "format I<or> if the operating system does not have a real packaging system "
8684 #: ../src/guestfs-actions.pod:2711 ../fish/guestfish-actions.pod:1852
8686 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8687 "Future versions of libguestfs may return other strings."
8691 #: ../src/guestfs-actions.pod:2719 ../src/guestfs-actions.pod:2750
8692 msgid "(Added in 1.7.5)"
8696 #: ../src/guestfs-actions.pod:2721
8697 msgid "guestfs_inspect_get_package_management"
8701 #: ../src/guestfs-actions.pod:2723
8705 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8706 " const char *root);\n"
8711 #: ../src/guestfs-actions.pod:2730
8713 "C<guestfs_inspect_get_package_format> and this function return the package "
8714 "format and package management tool used by the inspected operating system. "
8715 "For example for Fedora these functions would return C<rpm> (package format) "
8716 "and C<yum> (package management)."
8720 #: ../src/guestfs-actions.pod:2736 ../fish/guestfish-actions.pod:1870
8722 "This returns the string C<unknown> if we could not determine the package "
8723 "management tool I<or> if the operating system does not have a real packaging "
8724 "system (eg. Windows)."
8728 #: ../src/guestfs-actions.pod:2740 ../fish/guestfish-actions.pod:1874
8730 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8731 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8732 "libguestfs may return other strings."
8736 #: ../src/guestfs-actions.pod:2752
8737 msgid "guestfs_inspect_get_product_name"
8741 #: ../src/guestfs-actions.pod:2754
8745 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8746 " const char *root);\n"
8751 #: ../src/guestfs-actions.pod:2761 ../fish/guestfish-actions.pod:1888
8753 "This returns the product name of the inspected operating system. The "
8754 "product name is generally some freeform string which can be displayed to the "
8755 "user, but should not be parsed by programs."
8759 #: ../src/guestfs-actions.pod:2766 ../fish/guestfish-actions.pod:1893
8761 "If the product name could not be determined, then the string C<unknown> is "
8766 #: ../src/guestfs-actions.pod:2776
8767 msgid "guestfs_inspect_get_roots"
8771 #: ../src/guestfs-actions.pod:2778
8775 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8780 #: ../src/guestfs-actions.pod:2781
8782 "This function is a convenient way to get the list of root devices, as "
8783 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8784 "the whole inspection process."
8788 #: ../src/guestfs-actions.pod:2785
8790 "This returns an empty list if either no root devices were found or the "
8791 "caller has not called C<guestfs_inspect_os>."
8795 #: ../src/guestfs-actions.pod:2794
8796 msgid "(Added in 1.7.3)"
8800 #: ../src/guestfs-actions.pod:2796
8801 msgid "guestfs_inspect_get_type"
8805 #: ../src/guestfs-actions.pod:2798
8809 " guestfs_inspect_get_type (guestfs_h *g,\n"
8810 " const char *root);\n"
8815 #: ../src/guestfs-actions.pod:2805 ../fish/guestfish-actions.pod:1918
8817 "This returns the type of the inspected operating system. Currently defined "
8822 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1923
8827 #: ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1925
8828 msgid "Any Linux-based operating system."
8832 #: ../src/guestfs-actions.pod:2816 ../fish/guestfish-actions.pod:1929
8833 msgid "Any Microsoft Windows operating system."
8837 #: ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1931
8842 #: ../src/guestfs-actions.pod:2820 ../fish/guestfish-actions.pod:1933
8847 #: ../src/guestfs-actions.pod:2824 ../fish/guestfish-actions.pod:1937
8848 msgid "The operating system type could not be determined."
8852 #: ../src/guestfs-actions.pod:2838
8853 msgid "guestfs_inspect_get_windows_systemroot"
8857 #: ../src/guestfs-actions.pod:2840
8861 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8862 " const char *root);\n"
8867 #: ../src/guestfs-actions.pod:2847 ../fish/guestfish-actions.pod:1953
8869 "This returns the Windows systemroot of the inspected guest. The systemroot "
8870 "is a directory path such as C</WINDOWS>."
8874 #: ../src/guestfs-actions.pod:2850 ../fish/guestfish-actions.pod:1956
8876 "This call assumes that the guest is Windows and that the systemroot could be "
8877 "determined by inspection. If this is not the case then an error is "
8882 #: ../src/guestfs-actions.pod:2859
8883 msgid "(Added in 1.5.25)"
8887 #: ../src/guestfs-actions.pod:2861
8888 msgid "guestfs_inspect_list_applications"
8892 #: ../src/guestfs-actions.pod:2863
8895 " struct guestfs_application_list *\n"
8896 " guestfs_inspect_list_applications (guestfs_h *g,\n"
8897 " const char *root);\n"
8902 #: ../src/guestfs-actions.pod:2870 ../fish/guestfish-actions.pod:1969
8903 msgid "Return the list of applications installed in the operating system."
8907 #: ../src/guestfs-actions.pod:2872
8909 "I<Note:> This call works differently from other parts of the inspection "
8910 "API. You have to call C<guestfs_inspect_os>, then "
8911 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
8912 "this. Listing applications is a significantly more difficult operation "
8913 "which requires access to the full filesystem. Also note that unlike the "
8914 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
8915 "the libguestfs handle, this call actually reads parts of the mounted "
8916 "filesystems during the call."
8920 #: ../src/guestfs-actions.pod:2882 ../fish/guestfish-actions.pod:1981
8922 "This returns an empty list if the inspection code was not able to determine "
8923 "the list of applications."
8927 #: ../src/guestfs-actions.pod:2885 ../fish/guestfish-actions.pod:1984
8928 msgid "The application structure contains the following fields:"
8932 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1988
8937 #: ../src/guestfs-actions.pod:2891 ../fish/guestfish-actions.pod:1990
8939 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8940 "guests, this is the package name."
8944 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:1993
8945 msgid "C<app_display_name>"
8949 #: ../src/guestfs-actions.pod:2896 ../fish/guestfish-actions.pod:1995
8951 "The display name of the application, sometimes localized to the install "
8952 "language of the guest operating system."
8956 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:1998
8958 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8959 "to display something can use C<app_name> instead."
8963 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2001
8964 msgid "C<app_epoch>"
8968 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2003
8970 "For package managers which use epochs, this contains the epoch of the "
8971 "package (an integer). If unavailable, this is returned as C<0>."
8975 #: ../src/guestfs-actions.pod:2907 ../fish/guestfish-actions.pod:2006
8976 msgid "C<app_version>"
8980 #: ../src/guestfs-actions.pod:2909 ../fish/guestfish-actions.pod:2008
8982 "The version string of the application or package. If unavailable this is "
8983 "returned as an empty string C<\"\">."
8987 #: ../src/guestfs-actions.pod:2912 ../fish/guestfish-actions.pod:2011
8988 msgid "C<app_release>"
8992 #: ../src/guestfs-actions.pod:2914 ../fish/guestfish-actions.pod:2013
8994 "The release string of the application or package, for package managers that "
8995 "use this. If unavailable this is returned as an empty string C<\"\">."
8999 #: ../src/guestfs-actions.pod:2918 ../fish/guestfish-actions.pod:2017
9000 msgid "C<app_install_path>"
9004 #: ../src/guestfs-actions.pod:2920 ../fish/guestfish-actions.pod:2019
9006 "The installation path of the application (on operating systems such as "
9007 "Windows which use installation paths). This path is in the format used by "
9008 "the guest operating system, it is not a libguestfs path."
9012 #: ../src/guestfs-actions.pod:2925 ../fish/guestfish-actions.pod:2024
9013 msgid "If unavailable this is returned as an empty string C<\"\">."
9017 #: ../src/guestfs-actions.pod:2927 ../fish/guestfish-actions.pod:2026
9018 msgid "C<app_trans_path>"
9022 #: ../src/guestfs-actions.pod:2929 ../fish/guestfish-actions.pod:2028
9024 "The install path translated into a libguestfs path. If unavailable this is "
9025 "returned as an empty string C<\"\">."
9029 #: ../src/guestfs-actions.pod:2932 ../fish/guestfish-actions.pod:2031
9030 msgid "C<app_publisher>"
9034 #: ../src/guestfs-actions.pod:2934 ../fish/guestfish-actions.pod:2033
9036 "The name of the publisher of the application, for package managers that use "
9037 "this. If unavailable this is returned as an empty string C<\"\">."
9041 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2037
9046 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2039
9048 "The URL (eg. upstream URL) of the application. If unavailable this is "
9049 "returned as an empty string C<\"\">."
9053 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2042
9054 msgid "C<app_source_package>"
9058 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2044
9060 "For packaging systems which support this, the name of the source package. "
9061 "If unavailable this is returned as an empty string C<\"\">."
9065 #: ../src/guestfs-actions.pod:2948 ../fish/guestfish-actions.pod:2047
9066 msgid "C<app_summary>"
9070 #: ../src/guestfs-actions.pod:2950 ../fish/guestfish-actions.pod:2049
9072 "A short (usually one line) description of the application or package. If "
9073 "unavailable this is returned as an empty string C<\"\">."
9077 #: ../src/guestfs-actions.pod:2953 ../fish/guestfish-actions.pod:2052
9078 msgid "C<app_description>"
9082 #: ../src/guestfs-actions.pod:2955 ../fish/guestfish-actions.pod:2054
9084 "A longer description of the application or package. If unavailable this is "
9085 "returned as an empty string C<\"\">."
9089 #: ../src/guestfs-actions.pod:2962
9091 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9092 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9097 #: ../src/guestfs-actions.pod:2966
9098 msgid "(Added in 1.7.8)"
9102 #: ../src/guestfs-actions.pod:2968
9103 msgid "guestfs_inspect_os"
9107 #: ../src/guestfs-actions.pod:2970
9111 " guestfs_inspect_os (guestfs_h *g);\n"
9116 #: ../src/guestfs-actions.pod:2973 ../fish/guestfish-actions.pod:2065
9118 "This function uses other libguestfs functions and certain heuristics to "
9119 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9120 "for operating systems."
9124 #: ../src/guestfs-actions.pod:2977 ../fish/guestfish-actions.pod:2069
9125 msgid "The list returned is empty if no operating systems were found."
9129 #: ../src/guestfs-actions.pod:2979 ../fish/guestfish-actions.pod:2071
9131 "If one operating system was found, then this returns a list with a single "
9132 "element, which is the name of the root filesystem of this operating system. "
9133 "It is also possible for this function to return a list containing more than "
9134 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9135 "element being the root filesystem of one of the operating systems."
9139 #: ../src/guestfs-actions.pod:2986
9141 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9142 "functions in order to query further information about each operating system, "
9143 "such as the name and version."
9147 #: ../src/guestfs-actions.pod:2991
9149 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9150 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9151 "the contents. This should be called with no disks currently mounted. The "
9152 "function may also use Augeas, so any existing Augeas handle will be closed."
9156 #: ../src/guestfs-actions.pod:2997 ../fish/guestfish-actions.pod:2089
9158 "This function cannot decrypt encrypted disks. The caller must do that first "
9159 "(supplying the necessary keys) if the disk is encrypted."
9163 #: ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3320
9164 msgid "See also C<guestfs_list_filesystems>."
9168 #: ../src/guestfs-actions.pod:3011
9169 msgid "guestfs_is_blockdev"
9173 #: ../src/guestfs-actions.pod:3013
9177 " guestfs_is_blockdev (guestfs_h *g,\n"
9178 " const char *path);\n"
9183 #: ../src/guestfs-actions.pod:3017 ../fish/guestfish-actions.pod:2101
9185 "This returns C<true> if and only if there is a block device with the given "
9190 #: ../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
9191 msgid "See also C<guestfs_stat>."
9195 #: ../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
9196 msgid "(Added in 1.5.10)"
9200 #: ../src/guestfs-actions.pod:3026
9201 msgid "guestfs_is_busy"
9205 #: ../src/guestfs-actions.pod:3028
9209 " guestfs_is_busy (guestfs_h *g);\n"
9214 #: ../src/guestfs-actions.pod:3031 ../fish/guestfish-actions.pod:2110
9216 "This returns true iff this handle is busy processing a command (in the "
9221 #: ../src/guestfs-actions.pod:3040
9222 msgid "guestfs_is_chardev"
9226 #: ../src/guestfs-actions.pod:3042
9230 " guestfs_is_chardev (guestfs_h *g,\n"
9231 " const char *path);\n"
9236 #: ../src/guestfs-actions.pod:3046 ../fish/guestfish-actions.pod:2119
9238 "This returns C<true> if and only if there is a character device with the "
9239 "given C<path> name."
9243 #: ../src/guestfs-actions.pod:3055
9244 msgid "guestfs_is_config"
9248 #: ../src/guestfs-actions.pod:3057
9252 " guestfs_is_config (guestfs_h *g);\n"
9257 #: ../src/guestfs-actions.pod:3060 ../fish/guestfish-actions.pod:2128
9259 "This returns true iff this handle is being configured (in the C<CONFIG> "
9264 #: ../src/guestfs-actions.pod:3069
9265 msgid "guestfs_is_dir"
9269 #: ../src/guestfs-actions.pod:3071
9273 " guestfs_is_dir (guestfs_h *g,\n"
9274 " const char *path);\n"
9279 #: ../src/guestfs-actions.pod:3075 ../fish/guestfish-actions.pod:2137
9281 "This returns C<true> if and only if there is a directory with the given "
9282 "C<path> name. Note that it returns false for other objects like files."
9286 #: ../src/guestfs-actions.pod:3085
9287 msgid "guestfs_is_fifo"
9291 #: ../src/guestfs-actions.pod:3087
9295 " guestfs_is_fifo (guestfs_h *g,\n"
9296 " const char *path);\n"
9301 #: ../src/guestfs-actions.pod:3091 ../fish/guestfish-actions.pod:2147
9303 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9304 "given C<path> name."
9308 #: ../src/guestfs-actions.pod:3100
9309 msgid "guestfs_is_file"
9313 #: ../src/guestfs-actions.pod:3102
9317 " guestfs_is_file (guestfs_h *g,\n"
9318 " const char *path);\n"
9323 #: ../src/guestfs-actions.pod:3106 ../fish/guestfish-actions.pod:2156
9325 "This returns C<true> if and only if there is a regular file with the given "
9326 "C<path> name. Note that it returns false for other objects like "
9331 #: ../src/guestfs-actions.pod:3116
9332 msgid "guestfs_is_launching"
9336 #: ../src/guestfs-actions.pod:3118
9340 " guestfs_is_launching (guestfs_h *g);\n"
9345 #: ../src/guestfs-actions.pod:3121 ../fish/guestfish-actions.pod:2166
9347 "This returns true iff this handle is launching the subprocess (in the "
9348 "C<LAUNCHING> state)."
9352 #: ../src/guestfs-actions.pod:3130
9353 msgid "guestfs_is_lv"
9357 #: ../src/guestfs-actions.pod:3132
9361 " guestfs_is_lv (guestfs_h *g,\n"
9362 " const char *device);\n"
9367 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2175
9369 "This command tests whether C<device> is a logical volume, and returns true "
9370 "iff this is the case."
9374 #: ../src/guestfs-actions.pod:3143
9375 msgid "guestfs_is_ready"
9379 #: ../src/guestfs-actions.pod:3145
9383 " guestfs_is_ready (guestfs_h *g);\n"
9388 #: ../src/guestfs-actions.pod:3148 ../fish/guestfish-actions.pod:2182
9390 "This returns true iff this handle is ready to accept commands (in the "
9395 #: ../src/guestfs-actions.pod:3157
9396 msgid "guestfs_is_socket"
9400 #: ../src/guestfs-actions.pod:3159
9404 " guestfs_is_socket (guestfs_h *g,\n"
9405 " const char *path);\n"
9410 #: ../src/guestfs-actions.pod:3163 ../fish/guestfish-actions.pod:2191
9412 "This returns C<true> if and only if there is a Unix domain socket with the "
9413 "given C<path> name."
9417 #: ../src/guestfs-actions.pod:3172
9418 msgid "guestfs_is_symlink"
9422 #: ../src/guestfs-actions.pod:3174
9426 " guestfs_is_symlink (guestfs_h *g,\n"
9427 " const char *path);\n"
9432 #: ../src/guestfs-actions.pod:3178 ../fish/guestfish-actions.pod:2200
9434 "This returns C<true> if and only if there is a symbolic link with the given "
9439 #: ../src/guestfs-actions.pod:3187
9440 msgid "guestfs_kill_subprocess"
9444 #: ../src/guestfs-actions.pod:3189
9448 " guestfs_kill_subprocess (guestfs_h *g);\n"
9453 #: ../src/guestfs-actions.pod:3192 ../fish/guestfish-actions.pod:2209
9454 msgid "This kills the qemu subprocess. You should never need to call this."
9458 #: ../src/guestfs-actions.pod:3198
9459 msgid "guestfs_launch"
9463 #: ../src/guestfs-actions.pod:3200
9467 " guestfs_launch (guestfs_h *g);\n"
9472 #: ../src/guestfs-actions.pod:3203 ../fish/guestfish-actions.pod:2217
9474 "Internally libguestfs is implemented by running a virtual machine using "
9479 #: ../src/guestfs-actions.pod:3206 ../fish/guestfish-actions.pod:2220
9481 "You should call this after configuring the handle (eg. adding drives) but "
9482 "before performing any actions."
9486 #: ../src/guestfs-actions.pod:3213
9487 msgid "guestfs_lchown"
9491 #: ../src/guestfs-actions.pod:3215
9495 " guestfs_lchown (guestfs_h *g,\n"
9498 " const char *path);\n"
9503 #: ../src/guestfs-actions.pod:3221
9505 "Change the file owner to C<owner> and group to C<group>. This is like "
9506 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9507 "changed, not the target."
9511 #: ../src/guestfs-actions.pod:3233
9512 msgid "guestfs_lgetxattrs"
9516 #: ../src/guestfs-actions.pod:3235
9519 " struct guestfs_xattr_list *\n"
9520 " guestfs_lgetxattrs (guestfs_h *g,\n"
9521 " const char *path);\n"
9526 #: ../src/guestfs-actions.pod:3239
9528 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9529 "then it returns the extended attributes of the link itself."
9533 #: ../src/guestfs-actions.pod:3249
9534 msgid "guestfs_list_devices"
9538 #: ../src/guestfs-actions.pod:3251
9542 " guestfs_list_devices (guestfs_h *g);\n"
9547 #: ../src/guestfs-actions.pod:3254 ../fish/guestfish-actions.pod:2247
9548 msgid "List all the block devices."
9552 #: ../src/guestfs-actions.pod:3256 ../fish/guestfish-actions.pod:2249
9553 msgid "The full block device names are returned, eg. C</dev/sda>."
9557 #: ../src/guestfs-actions.pod:3266
9558 msgid "guestfs_list_filesystems"
9562 #: ../src/guestfs-actions.pod:3268
9566 " guestfs_list_filesystems (guestfs_h *g);\n"
9571 #: ../src/guestfs-actions.pod:3271 ../fish/guestfish-actions.pod:2257
9573 "This inspection command looks for filesystems on partitions, block devices "
9574 "and logical volumes, returning a list of devices containing filesystems and "
9579 #: ../src/guestfs-actions.pod:3275 ../fish/guestfish-actions.pod:2261
9581 "The return value is a hash, where the keys are the devices containing "
9582 "filesystems, and the values are the filesystem types. For example:"
9586 #: ../src/guestfs-actions.pod:3279 ../fish/guestfish-actions.pod:2265
9589 " \"/dev/sda1\" => \"ntfs\"\n"
9590 " \"/dev/sda2\" => \"ext2\"\n"
9591 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9592 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9597 #: ../src/guestfs-actions.pod:3284 ../fish/guestfish-actions.pod:2270
9599 "The value can have the special value \"unknown\", meaning the content of the "
9600 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9604 #: ../src/guestfs-actions.pod:3288
9606 "This command runs other libguestfs commands, which might include "
9607 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9608 "soon after launch and only when nothing is mounted."
9612 #: ../src/guestfs-actions.pod:3292
9614 "Not all of the filesystems returned will be mountable. In particular, swap "
9615 "partitions are returned in the list. Also this command does not check that "
9616 "each filesystem found is valid and mountable, and some filesystems might be "
9617 "mountable but require special options. Filesystems may not all belong to a "
9618 "single logical operating system (use C<guestfs_inspect_os> to look for "
9623 #: ../src/guestfs-actions.pod:3306 ../src/guestfs-actions.pod:4829
9624 msgid "(Added in 1.5.15)"
9628 #: ../src/guestfs-actions.pod:3308
9629 msgid "guestfs_list_partitions"
9633 #: ../src/guestfs-actions.pod:3310
9637 " guestfs_list_partitions (guestfs_h *g);\n"
9642 #: ../src/guestfs-actions.pod:3313 ../fish/guestfish-actions.pod:2290
9643 msgid "List all the partitions detected on all block devices."
9647 #: ../src/guestfs-actions.pod:3315 ../fish/guestfish-actions.pod:2292
9648 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9652 #: ../src/guestfs-actions.pod:3317
9654 "This does not return logical volumes. For that you will need to call "
9659 #: ../src/guestfs-actions.pod:3328
9664 #: ../src/guestfs-actions.pod:3330
9668 " guestfs_ll (guestfs_h *g,\n"
9669 " const char *directory);\n"
9674 #: ../src/guestfs-actions.pod:3334 ../fish/guestfish-actions.pod:2303
9676 "List the files in C<directory> (relative to the root directory, there is no "
9677 "cwd) in the format of 'ls -la'."
9681 #: ../src/guestfs-actions.pod:3337 ../fish/guestfish-actions.pod:2306
9683 "This command is mostly useful for interactive sessions. It is I<not> "
9684 "intended that you try to parse the output string."
9688 #: ../src/guestfs-actions.pod:3345
9693 #: ../src/guestfs-actions.pod:3347
9697 " guestfs_ln (guestfs_h *g,\n"
9698 " const char *target,\n"
9699 " const char *linkname);\n"
9704 #: ../src/guestfs-actions.pod:3352 ../fish/guestfish-actions.pod:2313
9705 msgid "This command creates a hard link using the C<ln> command."
9709 #: ../src/guestfs-actions.pod:3358
9710 msgid "guestfs_ln_f"
9714 #: ../src/guestfs-actions.pod:3360
9718 " guestfs_ln_f (guestfs_h *g,\n"
9719 " const char *target,\n"
9720 " const char *linkname);\n"
9725 #: ../src/guestfs-actions.pod:3365 ../fish/guestfish-actions.pod:2319
9727 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9728 "option removes the link (C<linkname>) if it exists already."
9732 #: ../src/guestfs-actions.pod:3372
9733 msgid "guestfs_ln_s"
9737 #: ../src/guestfs-actions.pod:3374
9741 " guestfs_ln_s (guestfs_h *g,\n"
9742 " const char *target,\n"
9743 " const char *linkname);\n"
9748 #: ../src/guestfs-actions.pod:3379 ../fish/guestfish-actions.pod:2326
9749 msgid "This command creates a symbolic link using the C<ln -s> command."
9753 #: ../src/guestfs-actions.pod:3385
9754 msgid "guestfs_ln_sf"
9758 #: ../src/guestfs-actions.pod:3387
9762 " guestfs_ln_sf (guestfs_h *g,\n"
9763 " const char *target,\n"
9764 " const char *linkname);\n"
9769 #: ../src/guestfs-actions.pod:3392 ../fish/guestfish-actions.pod:2332
9771 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9772 "option removes the link (C<linkname>) if it exists already."
9776 #: ../src/guestfs-actions.pod:3399
9777 msgid "guestfs_lremovexattr"
9781 #: ../src/guestfs-actions.pod:3401
9785 " guestfs_lremovexattr (guestfs_h *g,\n"
9786 " const char *xattr,\n"
9787 " const char *path);\n"
9792 #: ../src/guestfs-actions.pod:3406
9794 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9795 "link, then it removes an extended attribute of the link itself."
9799 #: ../src/guestfs-actions.pod:3414
9804 #: ../src/guestfs-actions.pod:3416
9808 " guestfs_ls (guestfs_h *g,\n"
9809 " const char *directory);\n"
9814 #: ../src/guestfs-actions.pod:3420 ../fish/guestfish-actions.pod:2347
9816 "List the files in C<directory> (relative to the root directory, there is no "
9817 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9822 #: ../src/guestfs-actions.pod:3424
9824 "This command is mostly useful for interactive sessions. Programs should "
9825 "probably use C<guestfs_readdir> instead."
9829 #: ../src/guestfs-actions.pod:3433
9830 msgid "guestfs_lsetxattr"
9834 #: ../src/guestfs-actions.pod:3435
9838 " guestfs_lsetxattr (guestfs_h *g,\n"
9839 " const char *xattr,\n"
9840 " const char *val,\n"
9842 " const char *path);\n"
9847 #: ../src/guestfs-actions.pod:3442
9849 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9850 "then it sets an extended attribute of the link itself."
9854 #: ../src/guestfs-actions.pod:3450
9855 msgid "guestfs_lstat"
9859 #: ../src/guestfs-actions.pod:3452
9862 " struct guestfs_stat *\n"
9863 " guestfs_lstat (guestfs_h *g,\n"
9864 " const char *path);\n"
9869 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5883 ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
9870 msgid "Returns file information for the given C<path>."
9874 #: ../src/guestfs-actions.pod:3458
9876 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9877 "link, then the link is stat-ed, not the file it refers to."
9881 #: ../src/guestfs-actions.pod:3462 ../fish/guestfish-actions.pod:2372
9882 msgid "This is the same as the C<lstat(2)> system call."
9886 #: ../src/guestfs-actions.pod:3464 ../src/guestfs-actions.pod:5887
9888 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9889 "error. I<The caller must call C<guestfs_free_stat> after use>."
9893 #: ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:5891 ../src/guestfs-actions.pod:5909 ../src/guestfs-actions.pod:6290
9894 msgid "(Added in 0.9.2)"
9898 #: ../src/guestfs-actions.pod:3470
9899 msgid "guestfs_lstatlist"
9903 #: ../src/guestfs-actions.pod:3472
9906 " struct guestfs_stat_list *\n"
9907 " guestfs_lstatlist (guestfs_h *g,\n"
9908 " const char *path,\n"
9909 " char *const *names);\n"
9914 #: ../src/guestfs-actions.pod:3477
9916 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9917 "files, where all files are in the directory C<path>. C<names> is the list "
9918 "of files from this directory."
9922 #: ../src/guestfs-actions.pod:3481 ../fish/guestfish-actions.pod:2382
9924 "On return you get a list of stat structs, with a one-to-one correspondence "
9925 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9926 "then the C<ino> field of that structure is set to C<-1>."
9930 #: ../src/guestfs-actions.pod:3486
9932 "This call is intended for programs that want to efficiently list a directory "
9933 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9934 "for a similarly efficient call for getting extended attributes. Very long "
9935 "directory listings might cause the protocol message size to be exceeded, "
9936 "causing this call to fail. The caller must split up such requests into "
9937 "smaller groups of names."
9941 #: ../src/guestfs-actions.pod:3494
9943 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9944 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9948 #: ../src/guestfs-actions.pod:3500
9949 msgid "guestfs_luks_add_key"
9953 #: ../src/guestfs-actions.pod:3502
9957 " guestfs_luks_add_key (guestfs_h *g,\n"
9958 " const char *device,\n"
9959 " const char *key,\n"
9960 " const char *newkey,\n"
9966 #: ../src/guestfs-actions.pod:3509 ../fish/guestfish-actions.pod:2399
9968 "This command adds a new key on LUKS device C<device>. C<key> is any "
9969 "existing key, and is used to access the device. C<newkey> is the new key to "
9970 "add. C<keyslot> is the key slot that will be replaced."
9974 #: ../src/guestfs-actions.pod:3514
9976 "Note that if C<keyslot> already contains a key, then this command will "
9977 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9981 #: ../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
9983 "This function takes a key or passphrase parameter which could contain "
9984 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9989 #: ../src/guestfs-actions.pod:3524 ../src/guestfs-actions.pod:3564 ../src/guestfs-actions.pod:3587 ../src/guestfs-actions.pod:3607
9990 msgid "(Added in 1.5.2)"
9994 #: ../src/guestfs-actions.pod:3526
9995 msgid "guestfs_luks_close"
9999 #: ../src/guestfs-actions.pod:3528
10003 " guestfs_luks_close (guestfs_h *g,\n"
10004 " const char *device);\n"
10009 #: ../src/guestfs-actions.pod:3532
10011 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
10012 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
10013 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
10014 "underlying block device."
10018 #: ../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
10019 msgid "(Added in 1.5.1)"
10023 #: ../src/guestfs-actions.pod:3542
10024 msgid "guestfs_luks_format"
10028 #: ../src/guestfs-actions.pod:3544
10032 " guestfs_luks_format (guestfs_h *g,\n"
10033 " const char *device,\n"
10034 " const char *key,\n"
10040 #: ../src/guestfs-actions.pod:3550 ../fish/guestfish-actions.pod:2425
10042 "This command erases existing data on C<device> and formats the device as a "
10043 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10044 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10048 #: ../src/guestfs-actions.pod:3557 ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3720 ../src/guestfs-actions.pod:4580 ../src/guestfs-actions.pod:5343 ../src/guestfs-actions.pod:5718 ../src/guestfs-actions.pod:5741 ../src/guestfs-actions.pod:5767 ../src/guestfs-actions.pod:6917 ../fish/guestfish-actions.pod:2433 ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567 ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10050 "B<This command is dangerous. Without careful use you can easily destroy all "
10055 #: ../src/guestfs-actions.pod:3566
10056 msgid "guestfs_luks_format_cipher"
10060 #: ../src/guestfs-actions.pod:3568
10064 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10065 " const char *device,\n"
10066 " const char *key,\n"
10068 " const char *cipher);\n"
10073 #: ../src/guestfs-actions.pod:3575
10075 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10076 "set the C<cipher> used."
10080 #: ../src/guestfs-actions.pod:3589
10081 msgid "guestfs_luks_kill_slot"
10085 #: ../src/guestfs-actions.pod:3591
10089 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10090 " const char *device,\n"
10091 " const char *key,\n"
10097 #: ../src/guestfs-actions.pod:3597 ../fish/guestfish-actions.pod:2453
10099 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10100 "device C<device>. C<key> must be one of the I<other> keys."
10104 #: ../src/guestfs-actions.pod:3609
10105 msgid "guestfs_luks_open"
10109 #: ../src/guestfs-actions.pod:3611
10113 " guestfs_luks_open (guestfs_h *g,\n"
10114 " const char *device,\n"
10115 " const char *key,\n"
10116 " const char *mapname);\n"
10121 #: ../src/guestfs-actions.pod:3617 ../fish/guestfish-actions.pod:2464
10123 "This command opens a block device which has been encrypted according to the "
10124 "Linux Unified Key Setup (LUKS) standard."
10128 #: ../src/guestfs-actions.pod:3620 ../fish/guestfish-actions.pod:2467
10129 msgid "C<device> is the encrypted block device or partition."
10133 #: ../src/guestfs-actions.pod:3622 ../fish/guestfish-actions.pod:2469
10135 "The caller must supply one of the keys associated with the LUKS block "
10136 "device, in the C<key> parameter."
10140 #: ../src/guestfs-actions.pod:3625 ../fish/guestfish-actions.pod:2472
10142 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10143 "writes to this block device are decrypted from and encrypted to the "
10144 "underlying C<device> respectively."
10148 #: ../src/guestfs-actions.pod:3629
10150 "If this block device contains LVM volume groups, then calling "
10151 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10156 #: ../src/guestfs-actions.pod:3641
10157 msgid "guestfs_luks_open_ro"
10161 #: ../src/guestfs-actions.pod:3643
10165 " guestfs_luks_open_ro (guestfs_h *g,\n"
10166 " const char *device,\n"
10167 " const char *key,\n"
10168 " const char *mapname);\n"
10173 #: ../src/guestfs-actions.pod:3649
10175 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10180 #: ../src/guestfs-actions.pod:3660
10181 msgid "guestfs_lvcreate"
10185 #: ../src/guestfs-actions.pod:3662
10189 " guestfs_lvcreate (guestfs_h *g,\n"
10190 " const char *logvol,\n"
10191 " const char *volgroup,\n"
10197 #: ../src/guestfs-actions.pod:3668 ../fish/guestfish-actions.pod:2497
10199 "This creates an LVM logical volume called C<logvol> on the volume group "
10200 "C<volgroup>, with C<size> megabytes."
10204 #: ../src/guestfs-actions.pod:3675
10205 msgid "guestfs_lvm_canonical_lv_name"
10209 #: ../src/guestfs-actions.pod:3677
10213 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10214 " const char *lvname);\n"
10219 #: ../src/guestfs-actions.pod:3681 ../fish/guestfish-actions.pod:2504
10221 "This converts alternative naming schemes for LVs that you might find to the "
10222 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
10227 #: ../src/guestfs-actions.pod:3685 ../fish/guestfish-actions.pod:2508
10229 "This command returns an error if the C<lvname> parameter does not refer to a "
10234 #: ../src/guestfs-actions.pod:3688
10235 msgid "See also C<guestfs_is_lv>."
10239 #: ../src/guestfs-actions.pod:3693
10240 msgid "(Added in 1.5.24)"
10244 #: ../src/guestfs-actions.pod:3695
10245 msgid "guestfs_lvm_clear_filter"
10249 #: ../src/guestfs-actions.pod:3697
10253 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10258 #: ../src/guestfs-actions.pod:3700
10260 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10261 "see every block device."
10265 #: ../src/guestfs-actions.pod:3703 ../src/guestfs-actions.pod:3745 ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10266 msgid "This command also clears the LVM cache and performs a volume group scan."
10270 #: ../src/guestfs-actions.pod:3710
10271 msgid "guestfs_lvm_remove_all"
10275 #: ../src/guestfs-actions.pod:3712
10279 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10284 #: ../src/guestfs-actions.pod:3715 ../fish/guestfish-actions.pod:2527
10286 "This command removes all LVM logical volumes, volume groups and physical "
10291 #: ../src/guestfs-actions.pod:3725
10292 msgid "guestfs_lvm_set_filter"
10296 #: ../src/guestfs-actions.pod:3727
10300 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10301 " char *const *devices);\n"
10306 #: ../src/guestfs-actions.pod:3731 ../fish/guestfish-actions.pod:2537
10308 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10309 "block devices in the list C<devices>, and will ignore all other attached "
10314 #: ../src/guestfs-actions.pod:3735 ../fish/guestfish-actions.pod:2541
10316 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10317 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10318 "there are two types of duplication possible: either cloned PVs/VGs which "
10319 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10320 "same name. In normal operation you cannot create this situation, but you "
10321 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10322 "inside the LVM metadata."
10326 #: ../src/guestfs-actions.pod:3748 ../fish/guestfish-actions.pod:2554
10327 msgid "You can filter whole block devices or individual partitions."
10331 #: ../src/guestfs-actions.pod:3750 ../fish/guestfish-actions.pod:2556
10333 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10334 "filesystem), even if you are not filtering out that VG."
10338 #: ../src/guestfs-actions.pod:3758
10339 msgid "guestfs_lvremove"
10343 #: ../src/guestfs-actions.pod:3760
10347 " guestfs_lvremove (guestfs_h *g,\n"
10348 " const char *device);\n"
10353 #: ../src/guestfs-actions.pod:3764 ../fish/guestfish-actions.pod:2564
10355 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10356 "LV, such as C</dev/VG/LV>."
10360 #: ../src/guestfs-actions.pod:3767 ../fish/guestfish-actions.pod:2567
10362 "You can also remove all LVs in a volume group by specifying the VG name, "
10367 #: ../src/guestfs-actions.pod:3772 ../src/guestfs-actions.pod:4926 ../src/guestfs-actions.pod:6656
10368 msgid "(Added in 1.0.13)"
10372 #: ../src/guestfs-actions.pod:3774
10373 msgid "guestfs_lvrename"
10377 #: ../src/guestfs-actions.pod:3776
10381 " guestfs_lvrename (guestfs_h *g,\n"
10382 " const char *logvol,\n"
10383 " const char *newlogvol);\n"
10388 #: ../src/guestfs-actions.pod:3781 ../fish/guestfish-actions.pod:2574
10389 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10393 #: ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:6669
10394 msgid "(Added in 1.0.83)"
10398 #: ../src/guestfs-actions.pod:3787
10399 msgid "guestfs_lvresize"
10403 #: ../src/guestfs-actions.pod:3789
10407 " guestfs_lvresize (guestfs_h *g,\n"
10408 " const char *device,\n"
10414 #: ../src/guestfs-actions.pod:3794 ../fish/guestfish-actions.pod:2580
10416 "This resizes (expands or shrinks) an existing LVM logical volume to "
10417 "C<mbytes>. When reducing, data in the reduced part is lost."
10421 #: ../src/guestfs-actions.pod:3802
10422 msgid "guestfs_lvresize_free"
10426 #: ../src/guestfs-actions.pod:3804
10430 " guestfs_lvresize_free (guestfs_h *g,\n"
10431 " const char *lv,\n"
10437 #: ../src/guestfs-actions.pod:3809 ../fish/guestfish-actions.pod:2588
10439 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10440 "remaining free space in the volume group. Commonly you would call this with "
10441 "pc = 100 which expands the logical volume as much as possible, using all "
10442 "remaining free space in the volume group."
10446 #: ../src/guestfs-actions.pod:3817
10447 msgid "(Added in 1.3.3)"
10451 #: ../src/guestfs-actions.pod:3819
10452 msgid "guestfs_lvs"
10456 #: ../src/guestfs-actions.pod:3821
10460 " guestfs_lvs (guestfs_h *g);\n"
10465 #: ../src/guestfs-actions.pod:3824 ../fish/guestfish-actions.pod:2598
10467 "List all the logical volumes detected. This is the equivalent of the "
10468 "L<lvs(8)> command."
10472 #: ../src/guestfs-actions.pod:3827 ../fish/guestfish-actions.pod:2601
10474 "This returns a list of the logical volume device names "
10475 "(eg. C</dev/VolGroup00/LogVol00>)."
10479 #: ../src/guestfs-actions.pod:3830
10480 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10484 #: ../src/guestfs-actions.pod:3838
10485 msgid "guestfs_lvs_full"
10489 #: ../src/guestfs-actions.pod:3840
10492 " struct guestfs_lvm_lv_list *\n"
10493 " guestfs_lvs_full (guestfs_h *g);\n"
10498 #: ../src/guestfs-actions.pod:3843 ../fish/guestfish-actions.pod:2610
10500 "List all the logical volumes detected. This is the equivalent of the "
10501 "L<lvs(8)> command. The \"full\" version includes all fields."
10505 #: ../src/guestfs-actions.pod:3846
10507 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10508 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
10513 #: ../src/guestfs-actions.pod:3852
10514 msgid "guestfs_lvuuid"
10518 #: ../src/guestfs-actions.pod:3854
10522 " guestfs_lvuuid (guestfs_h *g,\n"
10523 " const char *device);\n"
10528 #: ../src/guestfs-actions.pod:3858 ../fish/guestfish-actions.pod:2617
10529 msgid "This command returns the UUID of the LVM LV C<device>."
10533 #: ../src/guestfs-actions.pod:3865
10534 msgid "guestfs_lxattrlist"
10538 #: ../src/guestfs-actions.pod:3867
10541 " struct guestfs_xattr_list *\n"
10542 " guestfs_lxattrlist (guestfs_h *g,\n"
10543 " const char *path,\n"
10544 " char *const *names);\n"
10549 #: ../src/guestfs-actions.pod:3872 ../fish/guestfish-actions.pod:2623
10551 "This call allows you to get the extended attributes of multiple files, where "
10552 "all files are in the directory C<path>. C<names> is the list of files from "
10557 #: ../src/guestfs-actions.pod:3876 ../fish/guestfish-actions.pod:2627
10559 "On return you get a flat list of xattr structs which must be interpreted "
10560 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10561 "C<attrval> in this struct is zero-length to indicate there was an error "
10562 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10563 "number (the number of following attributes for this file, which could be "
10564 "C<\"0\">). Then after the first xattr struct are the zero or more "
10565 "attributes for the first named file. This repeats for the second and "
10566 "subsequent files."
10570 #: ../src/guestfs-actions.pod:3886
10572 "This call is intended for programs that want to efficiently list a directory "
10573 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10574 "a similarly efficient call for getting standard stats. Very long directory "
10575 "listings might cause the protocol message size to be exceeded, causing this "
10576 "call to fail. The caller must split up such requests into smaller groups of "
10581 #: ../src/guestfs-actions.pod:3900
10582 msgid "guestfs_mkdir"
10586 #: ../src/guestfs-actions.pod:3902
10590 " guestfs_mkdir (guestfs_h *g,\n"
10591 " const char *path);\n"
10596 #: ../src/guestfs-actions.pod:3906 ../fish/guestfish-actions.pod:2649
10597 msgid "Create a directory named C<path>."
10601 #: ../src/guestfs-actions.pod:3912
10602 msgid "guestfs_mkdir_mode"
10606 #: ../src/guestfs-actions.pod:3914
10610 " guestfs_mkdir_mode (guestfs_h *g,\n"
10611 " const char *path,\n"
10617 #: ../src/guestfs-actions.pod:3919 ../fish/guestfish-actions.pod:2655
10619 "This command creates a directory, setting the initial permissions of the "
10620 "directory to C<mode>."
10624 #: ../src/guestfs-actions.pod:3922 ../fish/guestfish-actions.pod:2658
10626 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10627 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10632 #: ../src/guestfs-actions.pod:3926
10633 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10637 #: ../src/guestfs-actions.pod:3932
10638 msgid "guestfs_mkdir_p"
10642 #: ../src/guestfs-actions.pod:3934
10646 " guestfs_mkdir_p (guestfs_h *g,\n"
10647 " const char *path);\n"
10652 #: ../src/guestfs-actions.pod:3938 ../fish/guestfish-actions.pod:2668
10654 "Create a directory named C<path>, creating any parent directories as "
10655 "necessary. This is like the C<mkdir -p> shell command."
10659 #: ../src/guestfs-actions.pod:3945
10660 msgid "guestfs_mkdtemp"
10664 #: ../src/guestfs-actions.pod:3947
10668 " guestfs_mkdtemp (guestfs_h *g,\n"
10669 " const char *template);\n"
10674 #: ../src/guestfs-actions.pod:3951 ../fish/guestfish-actions.pod:2675
10676 "This command creates a temporary directory. The C<template> parameter "
10677 "should be a full pathname for the temporary directory name with the final "
10678 "six characters being \"XXXXXX\"."
10682 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2680
10684 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10685 "being suitable for Windows filesystems."
10689 #: ../src/guestfs-actions.pod:3959 ../fish/guestfish-actions.pod:2683
10690 msgid "The name of the temporary directory that was created is returned."
10694 #: ../src/guestfs-actions.pod:3962 ../fish/guestfish-actions.pod:2686
10695 msgid "The temporary directory is created with mode 0700 and is owned by root."
10699 #: ../src/guestfs-actions.pod:3965 ../fish/guestfish-actions.pod:2689
10701 "The caller is responsible for deleting the temporary directory and its "
10702 "contents after use."
10706 #: ../src/guestfs-actions.pod:3968 ../fish/guestfish-actions.pod:2692
10707 msgid "See also: L<mkdtemp(3)>"
10711 #: ../src/guestfs-actions.pod:3975
10712 msgid "guestfs_mke2fs_J"
10716 #: ../src/guestfs-actions.pod:3977
10720 " guestfs_mke2fs_J (guestfs_h *g,\n"
10721 " const char *fstype,\n"
10722 " int blocksize,\n"
10723 " const char *device,\n"
10724 " const char *journal);\n"
10729 #: ../src/guestfs-actions.pod:3984 ../fish/guestfish-actions.pod:2698
10731 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10732 "C<journal>. It is equivalent to the command:"
10736 #: ../src/guestfs-actions.pod:3988 ../fish/guestfish-actions.pod:2702
10739 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10744 #: ../src/guestfs-actions.pod:3990
10745 msgid "See also C<guestfs_mke2journal>."
10749 #: ../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:4126 ../src/guestfs-actions.pod:4316
10750 msgid "(Added in 1.0.68)"
10754 #: ../src/guestfs-actions.pod:3996
10755 msgid "guestfs_mke2fs_JL"
10759 #: ../src/guestfs-actions.pod:3998
10763 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10764 " const char *fstype,\n"
10765 " int blocksize,\n"
10766 " const char *device,\n"
10767 " const char *label);\n"
10772 #: ../src/guestfs-actions.pod:4005 ../fish/guestfish-actions.pod:2710
10774 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10775 "the journal labeled C<label>."
10779 #: ../src/guestfs-actions.pod:4008
10780 msgid "See also C<guestfs_mke2journal_L>."
10784 #: ../src/guestfs-actions.pod:4014
10785 msgid "guestfs_mke2fs_JU"
10789 #: ../src/guestfs-actions.pod:4016
10793 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10794 " const char *fstype,\n"
10795 " int blocksize,\n"
10796 " const char *device,\n"
10797 " const char *uuid);\n"
10802 #: ../src/guestfs-actions.pod:4023 ../fish/guestfish-actions.pod:2719
10804 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10805 "the journal with UUID C<uuid>."
10809 #: ../src/guestfs-actions.pod:4026
10810 msgid "See also C<guestfs_mke2journal_U>."
10814 #: ../src/guestfs-actions.pod:4032
10815 msgid "guestfs_mke2journal"
10819 #: ../src/guestfs-actions.pod:4034
10823 " guestfs_mke2journal (guestfs_h *g,\n"
10824 " int blocksize,\n"
10825 " const char *device);\n"
10830 #: ../src/guestfs-actions.pod:4039 ../fish/guestfish-actions.pod:2728
10832 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10837 #: ../src/guestfs-actions.pod:4042 ../fish/guestfish-actions.pod:2731
10840 " mke2fs -O journal_dev -b blocksize device\n"
10845 #: ../src/guestfs-actions.pod:4048
10846 msgid "guestfs_mke2journal_L"
10850 #: ../src/guestfs-actions.pod:4050
10854 " guestfs_mke2journal_L (guestfs_h *g,\n"
10855 " int blocksize,\n"
10856 " const char *label,\n"
10857 " const char *device);\n"
10862 #: ../src/guestfs-actions.pod:4056 ../fish/guestfish-actions.pod:2737
10863 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10867 #: ../src/guestfs-actions.pod:4062
10868 msgid "guestfs_mke2journal_U"
10872 #: ../src/guestfs-actions.pod:4064
10876 " guestfs_mke2journal_U (guestfs_h *g,\n"
10877 " int blocksize,\n"
10878 " const char *uuid,\n"
10879 " const char *device);\n"
10884 #: ../src/guestfs-actions.pod:4070 ../fish/guestfish-actions.pod:2743
10885 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10889 #: ../src/guestfs-actions.pod:4076
10890 msgid "guestfs_mkfifo"
10894 #: ../src/guestfs-actions.pod:4078
10898 " guestfs_mkfifo (guestfs_h *g,\n"
10900 " const char *path);\n"
10905 #: ../src/guestfs-actions.pod:4083
10907 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10908 "is just a convenient wrapper around C<guestfs_mknod>."
10912 #: ../src/guestfs-actions.pod:4093
10913 msgid "guestfs_mkfs"
10917 #: ../src/guestfs-actions.pod:4095
10921 " guestfs_mkfs (guestfs_h *g,\n"
10922 " const char *fstype,\n"
10923 " const char *device);\n"
10928 #: ../src/guestfs-actions.pod:4100 ../fish/guestfish-actions.pod:2759
10930 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10931 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10935 #: ../src/guestfs-actions.pod:4108
10936 msgid "guestfs_mkfs_b"
10940 #: ../src/guestfs-actions.pod:4110
10944 " guestfs_mkfs_b (guestfs_h *g,\n"
10945 " const char *fstype,\n"
10946 " int blocksize,\n"
10947 " const char *device);\n"
10952 #: ../src/guestfs-actions.pod:4116
10954 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10955 "block size of the resulting filesystem. Supported block sizes depend on the "
10956 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10960 #: ../src/guestfs-actions.pod:4121 ../fish/guestfish-actions.pod:2772
10962 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10967 #: ../src/guestfs-actions.pod:4128
10968 msgid "guestfs_mkmountpoint"
10972 #: ../src/guestfs-actions.pod:4130
10976 " guestfs_mkmountpoint (guestfs_h *g,\n"
10977 " const char *exemptpath);\n"
10982 #: ../src/guestfs-actions.pod:4134
10984 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10985 "that can be used to create extra mountpoints before mounting the first "
10990 #: ../src/guestfs-actions.pod:4138 ../fish/guestfish-actions.pod:2783
10992 "These calls are I<only> necessary in some very limited circumstances, mainly "
10993 "the case where you want to mount a mix of unrelated and/or read-only "
10994 "filesystems together."
10998 #: ../src/guestfs-actions.pod:4142 ../fish/guestfish-actions.pod:2787
11000 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
11001 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
11002 "inside that. You can unpack this as follows in guestfish:"
11006 #: ../src/guestfs-actions.pod:4147 ../fish/guestfish-actions.pod:2792
11009 " add-ro Fedora-11-i686-Live.iso\n"
11011 " mkmountpoint /cd\n"
11012 " mkmountpoint /sqsh\n"
11013 " mkmountpoint /ext3fs\n"
11014 " mount /dev/sda /cd\n"
11015 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
11016 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
11021 #: ../src/guestfs-actions.pod:4156 ../fish/guestfish-actions.pod:2801
11022 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11026 #: ../src/guestfs-actions.pod:4158
11028 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11029 "may get unexpected errors if you try to mix these calls. It is safest to "
11030 "manually unmount filesystems and remove mountpoints after use."
11034 #: ../src/guestfs-actions.pod:4162
11036 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11037 "first, so for this to work for manual mountpoints, you must ensure that the "
11038 "innermost mountpoints have the longest pathnames, as in the example code "
11043 #: ../src/guestfs-actions.pod:4167 ../fish/guestfish-actions.pod:2812
11044 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11048 #: ../src/guestfs-actions.pod:4169
11050 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11051 "means that C<guestfs_umount_all> is called when the handle is closed which "
11052 "can also trigger these issues."
11056 #: ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:5327
11057 msgid "(Added in 1.0.62)"
11061 #: ../src/guestfs-actions.pod:4177
11062 msgid "guestfs_mknod"
11066 #: ../src/guestfs-actions.pod:4179
11070 " guestfs_mknod (guestfs_h *g,\n"
11074 " const char *path);\n"
11079 #: ../src/guestfs-actions.pod:4186 ../fish/guestfish-actions.pod:2822
11081 "This call creates block or character special devices, or named pipes "
11086 #: ../src/guestfs-actions.pod:4189 ../fish/guestfish-actions.pod:2825
11088 "The C<mode> parameter should be the mode, using the standard constants. "
11089 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11090 "used when creating block and character special devices."
11094 #: ../src/guestfs-actions.pod:4194
11096 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11097 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11098 "regular file). These constants are available in the standard Linux header "
11099 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11100 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11101 "the appropriate constant for you."
11105 #: ../src/guestfs-actions.pod:4208
11106 msgid "guestfs_mknod_b"
11110 #: ../src/guestfs-actions.pod:4210
11114 " guestfs_mknod_b (guestfs_h *g,\n"
11118 " const char *path);\n"
11123 #: ../src/guestfs-actions.pod:4217
11125 "This call creates a block device node called C<path> with mode C<mode> and "
11126 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11127 "wrapper around C<guestfs_mknod>."
11131 #: ../src/guestfs-actions.pod:4227
11132 msgid "guestfs_mknod_c"
11136 #: ../src/guestfs-actions.pod:4229
11140 " guestfs_mknod_c (guestfs_h *g,\n"
11144 " const char *path);\n"
11149 #: ../src/guestfs-actions.pod:4236
11151 "This call creates a char device node called C<path> with mode C<mode> and "
11152 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11153 "wrapper around C<guestfs_mknod>."
11157 #: ../src/guestfs-actions.pod:4246
11158 msgid "guestfs_mkswap"
11162 #: ../src/guestfs-actions.pod:4248
11166 " guestfs_mkswap (guestfs_h *g,\n"
11167 " const char *device);\n"
11172 #: ../src/guestfs-actions.pod:4252 ../fish/guestfish-actions.pod:2864
11173 msgid "Create a swap partition on C<device>."
11177 #: ../src/guestfs-actions.pod:4258
11178 msgid "guestfs_mkswap_L"
11182 #: ../src/guestfs-actions.pod:4260
11186 " guestfs_mkswap_L (guestfs_h *g,\n"
11187 " const char *label,\n"
11188 " const char *device);\n"
11193 #: ../src/guestfs-actions.pod:4265 ../fish/guestfish-actions.pod:2870
11194 msgid "Create a swap partition on C<device> with label C<label>."
11198 #: ../src/guestfs-actions.pod:4267 ../fish/guestfish-actions.pod:2872
11200 "Note that you cannot attach a swap label to a block device "
11201 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
11202 "the kernel or swap tools."
11206 #: ../src/guestfs-actions.pod:4275
11207 msgid "guestfs_mkswap_U"
11211 #: ../src/guestfs-actions.pod:4277
11215 " guestfs_mkswap_U (guestfs_h *g,\n"
11216 " const char *uuid,\n"
11217 " const char *device);\n"
11222 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2880
11223 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11227 #: ../src/guestfs-actions.pod:4288
11228 msgid "guestfs_mkswap_file"
11232 #: ../src/guestfs-actions.pod:4290
11236 " guestfs_mkswap_file (guestfs_h *g,\n"
11237 " const char *path);\n"
11242 #: ../src/guestfs-actions.pod:4294 ../fish/guestfish-actions.pod:2886
11243 msgid "Create a swap file."
11247 #: ../src/guestfs-actions.pod:4296
11249 "This command just writes a swap file signature to an existing file. To "
11250 "create the file itself, use something like C<guestfs_fallocate>."
11254 #: ../src/guestfs-actions.pod:4303
11255 msgid "guestfs_modprobe"
11259 #: ../src/guestfs-actions.pod:4305
11263 " guestfs_modprobe (guestfs_h *g,\n"
11264 " const char *modulename);\n"
11269 #: ../src/guestfs-actions.pod:4309 ../fish/guestfish-actions.pod:2895
11270 msgid "This loads a kernel module in the appliance."
11274 #: ../src/guestfs-actions.pod:4311 ../fish/guestfish-actions.pod:2897
11276 "The kernel module must have been whitelisted when libguestfs was built (see "
11277 "C<appliance/kmod.whitelist.in> in the source)."
11281 #: ../src/guestfs-actions.pod:4318
11282 msgid "guestfs_mount"
11286 #: ../src/guestfs-actions.pod:4320
11290 " guestfs_mount (guestfs_h *g,\n"
11291 " const char *device,\n"
11292 " const char *mountpoint);\n"
11297 #: ../src/guestfs-actions.pod:4325 ../fish/guestfish-actions.pod:2904
11299 "Mount a guest disk at a position in the filesystem. Block devices are named "
11300 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11301 "those block devices contain partitions, they will have the usual names "
11302 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11306 #: ../src/guestfs-actions.pod:4331 ../fish/guestfish-actions.pod:2910
11308 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11309 "mounted on C</> before others can be mounted. Other filesystems can only be "
11310 "mounted on directories which already exist."
11314 #: ../src/guestfs-actions.pod:4336 ../fish/guestfish-actions.pod:2915
11316 "The mounted filesystem is writable, if we have sufficient permissions on the "
11317 "underlying device."
11321 #: ../src/guestfs-actions.pod:4339
11323 "B<Important note:> When you use this call, the filesystem options C<sync> "
11324 "and C<noatime> are set implicitly. This was originally done because we "
11325 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11326 "very large negative performance impact and negligible effect on "
11327 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11328 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11329 "(use an empty string for the first parameter if you don't want any options)."
11333 #: ../src/guestfs-actions.pod:4353
11334 msgid "guestfs_mount_loop"
11338 #: ../src/guestfs-actions.pod:4355
11342 " guestfs_mount_loop (guestfs_h *g,\n"
11343 " const char *file,\n"
11344 " const char *mountpoint);\n"
11349 #: ../src/guestfs-actions.pod:4360 ../fish/guestfish-actions.pod:2932
11351 "This command lets you mount C<file> (a filesystem image in a file) on a "
11352 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11357 #: ../src/guestfs-actions.pod:4368
11358 msgid "guestfs_mount_options"
11362 #: ../src/guestfs-actions.pod:4370
11366 " guestfs_mount_options (guestfs_h *g,\n"
11367 " const char *options,\n"
11368 " const char *device,\n"
11369 " const char *mountpoint);\n"
11374 #: ../src/guestfs-actions.pod:4376
11376 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11377 "the mount options as for the L<mount(8)> I<-o> flag."
11381 #: ../src/guestfs-actions.pod:4380 ../fish/guestfish-actions.pod:2944
11383 "If the C<options> parameter is an empty string, then no options are passed "
11384 "(all options default to whatever the filesystem uses)."
11388 #: ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4417
11389 msgid "(Added in 1.0.10)"
11393 #: ../src/guestfs-actions.pod:4388
11394 msgid "guestfs_mount_ro"
11398 #: ../src/guestfs-actions.pod:4390
11402 " guestfs_mount_ro (guestfs_h *g,\n"
11403 " const char *device,\n"
11404 " const char *mountpoint);\n"
11409 #: ../src/guestfs-actions.pod:4395
11411 "This is the same as the C<guestfs_mount> command, but it mounts the "
11412 "filesystem with the read-only (I<-o ro>) flag."
11416 #: ../src/guestfs-actions.pod:4402
11417 msgid "guestfs_mount_vfs"
11421 #: ../src/guestfs-actions.pod:4404
11425 " guestfs_mount_vfs (guestfs_h *g,\n"
11426 " const char *options,\n"
11427 " const char *vfstype,\n"
11428 " const char *device,\n"
11429 " const char *mountpoint);\n"
11434 #: ../src/guestfs-actions.pod:4411
11436 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11437 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
11442 #: ../src/guestfs-actions.pod:4419
11443 msgid "guestfs_mountpoints"
11447 #: ../src/guestfs-actions.pod:4421
11451 " guestfs_mountpoints (guestfs_h *g);\n"
11456 #: ../src/guestfs-actions.pod:4424
11458 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11459 "devices. This one returns a hash table (map) of device name to directory "
11460 "where the device is mounted."
11464 #: ../src/guestfs-actions.pod:4436
11465 msgid "guestfs_mounts"
11469 #: ../src/guestfs-actions.pod:4438
11473 " guestfs_mounts (guestfs_h *g);\n"
11478 #: ../src/guestfs-actions.pod:4441 ../fish/guestfish-actions.pod:2975
11480 "This returns the list of currently mounted filesystems. It returns the list "
11481 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11485 #: ../src/guestfs-actions.pod:4444 ../fish/guestfish-actions.pod:2978
11486 msgid "Some internal mounts are not shown."
11490 #: ../src/guestfs-actions.pod:4446
11491 msgid "See also: C<guestfs_mountpoints>"
11495 #: ../src/guestfs-actions.pod:4454
11500 #: ../src/guestfs-actions.pod:4456
11504 " guestfs_mv (guestfs_h *g,\n"
11505 " const char *src,\n"
11506 " const char *dest);\n"
11511 #: ../src/guestfs-actions.pod:4461 ../fish/guestfish-actions.pod:2986
11513 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11514 "destination filename or destination directory."
11518 #: ../src/guestfs-actions.pod:4468
11519 msgid "guestfs_ntfs_3g_probe"
11523 #: ../src/guestfs-actions.pod:4470
11527 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11529 " const char *device);\n"
11534 #: ../src/guestfs-actions.pod:4475 ../fish/guestfish-actions.pod:2993
11536 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11537 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11538 "read-write, and some cannot be mounted at all)."
11542 #: ../src/guestfs-actions.pod:4479 ../fish/guestfish-actions.pod:2997
11544 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11545 "can be mounted read-write. Set it to false if you want to test if the "
11546 "volume can be mounted read-only."
11550 #: ../src/guestfs-actions.pod:4483 ../fish/guestfish-actions.pod:3001
11552 "The return value is an integer which C<0> if the operation would succeed, or "
11553 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11557 #: ../src/guestfs-actions.pod:4489
11558 msgid "(Added in 1.0.43)"
11562 #: ../src/guestfs-actions.pod:4491
11563 msgid "guestfs_ntfsresize"
11567 #: ../src/guestfs-actions.pod:4493
11571 " guestfs_ntfsresize (guestfs_h *g,\n"
11572 " const char *device);\n"
11577 #: ../src/guestfs-actions.pod:4497 ../fish/guestfish-actions.pod:3009
11579 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11580 "size of the underlying device. See also L<ntfsresize(8)>."
11584 #: ../src/guestfs-actions.pod:4505
11585 msgid "guestfs_ntfsresize_size"
11589 #: ../src/guestfs-actions.pod:4507
11593 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11594 " const char *device,\n"
11595 " int64_t size);\n"
11600 #: ../src/guestfs-actions.pod:4512
11602 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11603 "to specify the new size (in bytes) explicitly."
11607 #: ../src/guestfs-actions.pod:4517 ../src/guestfs-actions.pod:4953 ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:5275
11608 msgid "(Added in 1.3.14)"
11612 #: ../src/guestfs-actions.pod:4519
11613 msgid "guestfs_part_add"
11617 #: ../src/guestfs-actions.pod:4521
11621 " guestfs_part_add (guestfs_h *g,\n"
11622 " const char *device,\n"
11623 " const char *prlogex,\n"
11624 " int64_t startsect,\n"
11625 " int64_t endsect);\n"
11630 #: ../src/guestfs-actions.pod:4528
11632 "This command adds a partition to C<device>. If there is no partition table "
11633 "on the device, call C<guestfs_part_init> first."
11637 #: ../src/guestfs-actions.pod:4531 ../fish/guestfish-actions.pod:3027
11639 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11640 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11641 "C<logical>) and C<e> (or C<extended>) partition types."
11645 #: ../src/guestfs-actions.pod:4536 ../fish/guestfish-actions.pod:3032
11647 "C<startsect> and C<endsect> are the start and end of the partition in "
11648 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11649 "from the end of the disk (C<-1> is the last sector)."
11653 #: ../src/guestfs-actions.pod:4540
11655 "Creating a partition which covers the whole disk is not so easy. Use "
11656 "C<guestfs_part_disk> to do that."
11660 #: ../src/guestfs-actions.pod:4545 ../src/guestfs-actions.pod:4583 ../src/guestfs-actions.pod:4636 ../src/guestfs-actions.pod:4714 ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:4771 ../src/guestfs-actions.pod:4811
11661 msgid "(Added in 1.0.78)"
11665 #: ../src/guestfs-actions.pod:4547
11666 msgid "guestfs_part_del"
11670 #: ../src/guestfs-actions.pod:4549
11674 " guestfs_part_del (guestfs_h *g,\n"
11675 " const char *device,\n"
11681 #: ../src/guestfs-actions.pod:4554 ../fish/guestfish-actions.pod:3043
11682 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11686 #: ../src/guestfs-actions.pod:4556 ../fish/guestfish-actions.pod:3045
11688 "Note that in the case of MBR partitioning, deleting an extended partition "
11689 "also deletes any logical partitions it contains."
11693 #: ../src/guestfs-actions.pod:4564
11694 msgid "guestfs_part_disk"
11698 #: ../src/guestfs-actions.pod:4566
11702 " guestfs_part_disk (guestfs_h *g,\n"
11703 " const char *device,\n"
11704 " const char *parttype);\n"
11709 #: ../src/guestfs-actions.pod:4571
11711 "This command is simply a combination of C<guestfs_part_init> followed by "
11712 "C<guestfs_part_add> to create a single primary partition covering the whole "
11717 #: ../src/guestfs-actions.pod:4575
11719 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11720 "possible values are described in C<guestfs_part_init>."
11724 #: ../src/guestfs-actions.pod:4585
11725 msgid "guestfs_part_get_bootable"
11729 #: ../src/guestfs-actions.pod:4587
11733 " guestfs_part_get_bootable (guestfs_h *g,\n"
11734 " const char *device,\n"
11740 #: ../src/guestfs-actions.pod:4592 ../fish/guestfish-actions.pod:3067
11742 "This command returns true if the partition C<partnum> on C<device> has the "
11743 "bootable flag set."
11747 #: ../src/guestfs-actions.pod:4595
11748 msgid "See also C<guestfs_part_set_bootable>."
11752 #: ../src/guestfs-actions.pod:4601
11753 msgid "guestfs_part_get_mbr_id"
11757 #: ../src/guestfs-actions.pod:4603
11761 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11762 " const char *device,\n"
11768 #: ../src/guestfs-actions.pod:4608 ../fish/guestfish-actions.pod:3076
11770 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11771 "partition C<partnum>."
11775 #: ../src/guestfs-actions.pod:4611 ../src/guestfs-actions.pod:4787
11777 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11778 "undefined results for other partition table types (see "
11779 "C<guestfs_part_get_parttype>)."
11783 #: ../src/guestfs-actions.pod:4619
11784 msgid "guestfs_part_get_parttype"
11788 #: ../src/guestfs-actions.pod:4621
11792 " guestfs_part_get_parttype (guestfs_h *g,\n"
11793 " const char *device);\n"
11798 #: ../src/guestfs-actions.pod:4625 ../fish/guestfish-actions.pod:3087
11800 "This command examines the partition table on C<device> and returns the "
11801 "partition table type (format) being used."
11805 #: ../src/guestfs-actions.pod:4628
11807 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11808 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11809 "possible, although unusual. See C<guestfs_part_init> for a full list."
11813 #: ../src/guestfs-actions.pod:4638
11814 msgid "guestfs_part_init"
11818 #: ../src/guestfs-actions.pod:4640
11822 " guestfs_part_init (guestfs_h *g,\n"
11823 " const char *device,\n"
11824 " const char *parttype);\n"
11829 #: ../src/guestfs-actions.pod:4645 ../fish/guestfish-actions.pod:3099
11831 "This creates an empty partition table on C<device> of one of the partition "
11832 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11833 "(for large disks)."
11837 #: ../src/guestfs-actions.pod:4649
11839 "Initially there are no partitions. Following this, you should call "
11840 "C<guestfs_part_add> for each partition required."
11844 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3106
11845 msgid "Possible values for C<parttype> are:"
11849 #: ../src/guestfs-actions.pod:4656 ../fish/guestfish-actions.pod:3110
11850 msgid "B<efi> | B<gpt>"
11854 #: ../src/guestfs-actions.pod:4658 ../fish/guestfish-actions.pod:3112
11855 msgid "Intel EFI / GPT partition table."
11859 #: ../src/guestfs-actions.pod:4660 ../fish/guestfish-actions.pod:3114
11861 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11862 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11863 "the C<mbr> format."
11867 #: ../src/guestfs-actions.pod:4664 ../fish/guestfish-actions.pod:3118
11868 msgid "B<mbr> | B<msdos>"
11872 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3120
11874 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11875 "Windows. This partition type will B<only> work for device sizes up to 2 "
11876 "TB. For large disks we recommend using C<gpt>."
11880 #: ../src/guestfs-actions.pod:4673 ../fish/guestfish-actions.pod:3127
11881 msgid "Other partition table types that may work but are not supported include:"
11885 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3132
11890 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3134
11891 msgid "AIX disk labels."
11895 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3136
11896 msgid "B<amiga> | B<rdb>"
11900 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3138
11901 msgid "Amiga \"Rigid Disk Block\" format."
11905 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3140
11910 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3142
11911 msgid "BSD disk labels."
11915 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3144
11920 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3146
11921 msgid "DASD, used on IBM mainframes."
11925 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3148
11930 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3150
11931 msgid "MIPS/SGI volumes."
11935 #: ../src/guestfs-actions.pod:4698 ../fish/guestfish-actions.pod:3152
11940 #: ../src/guestfs-actions.pod:4700 ../fish/guestfish-actions.pod:3154
11941 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11945 #: ../src/guestfs-actions.pod:4702 ../fish/guestfish-actions.pod:3156
11950 #: ../src/guestfs-actions.pod:4704 ../fish/guestfish-actions.pod:3158
11951 msgid "NEC PC-98 format, common in Japan apparently."
11955 #: ../src/guestfs-actions.pod:4706 ../fish/guestfish-actions.pod:3160
11960 #: ../src/guestfs-actions.pod:4708 ../fish/guestfish-actions.pod:3162
11961 msgid "Sun disk labels."
11965 #: ../src/guestfs-actions.pod:4716
11966 msgid "guestfs_part_list"
11970 #: ../src/guestfs-actions.pod:4718
11973 " struct guestfs_partition_list *\n"
11974 " guestfs_part_list (guestfs_h *g,\n"
11975 " const char *device);\n"
11980 #: ../src/guestfs-actions.pod:4722 ../fish/guestfish-actions.pod:3170
11982 "This command parses the partition table on C<device> and returns the list of "
11983 "partitions found."
11987 #: ../src/guestfs-actions.pod:4725 ../fish/guestfish-actions.pod:3173
11988 msgid "The fields in the returned structure are:"
11992 #: ../src/guestfs-actions.pod:4729 ../fish/guestfish-actions.pod:3177
11993 msgid "B<part_num>"
11997 #: ../src/guestfs-actions.pod:4731 ../fish/guestfish-actions.pod:3179
11998 msgid "Partition number, counting from 1."
12002 #: ../src/guestfs-actions.pod:4733 ../fish/guestfish-actions.pod:3181
12003 msgid "B<part_start>"
12007 #: ../src/guestfs-actions.pod:4735
12009 "Start of the partition I<in bytes>. To get sectors you have to divide by "
12010 "the device's sector size, see C<guestfs_blockdev_getss>."
12014 #: ../src/guestfs-actions.pod:4738 ../fish/guestfish-actions.pod:3186
12015 msgid "B<part_end>"
12019 #: ../src/guestfs-actions.pod:4740 ../fish/guestfish-actions.pod:3188
12020 msgid "End of the partition in bytes."
12024 #: ../src/guestfs-actions.pod:4742 ../fish/guestfish-actions.pod:3190
12025 msgid "B<part_size>"
12029 #: ../src/guestfs-actions.pod:4744 ../fish/guestfish-actions.pod:3192
12030 msgid "Size of the partition in bytes."
12034 #: ../src/guestfs-actions.pod:4748
12036 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12037 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12042 #: ../src/guestfs-actions.pod:4754
12043 msgid "guestfs_part_set_bootable"
12047 #: ../src/guestfs-actions.pod:4756
12051 " guestfs_part_set_bootable (guestfs_h *g,\n"
12052 " const char *device,\n"
12054 " int bootable);\n"
12059 #: ../src/guestfs-actions.pod:4762 ../fish/guestfish-actions.pod:3200
12061 "This sets the bootable flag on partition numbered C<partnum> on device "
12062 "C<device>. Note that partitions are numbered from 1."
12066 #: ../src/guestfs-actions.pod:4765 ../fish/guestfish-actions.pod:3203
12068 "The bootable flag is used by some operating systems (notably Windows) to "
12069 "determine which partition to boot from. It is by no means universally "
12074 #: ../src/guestfs-actions.pod:4773
12075 msgid "guestfs_part_set_mbr_id"
12079 #: ../src/guestfs-actions.pod:4775
12083 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12084 " const char *device,\n"
12091 #: ../src/guestfs-actions.pod:4781 ../fish/guestfish-actions.pod:3211
12093 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12094 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12095 "documentation are in fact hexadecimal numbers, but usually documented "
12096 "without any leading \"0x\" which might be confusing."
12100 #: ../src/guestfs-actions.pod:4795
12101 msgid "guestfs_part_set_name"
12105 #: ../src/guestfs-actions.pod:4797
12109 " guestfs_part_set_name (guestfs_h *g,\n"
12110 " const char *device,\n"
12112 " const char *name);\n"
12117 #: ../src/guestfs-actions.pod:4803 ../fish/guestfish-actions.pod:3225
12119 "This sets the partition name on partition numbered C<partnum> on device "
12120 "C<device>. Note that partitions are numbered from 1."
12124 #: ../src/guestfs-actions.pod:4806 ../fish/guestfish-actions.pod:3228
12126 "The partition name can only be set on certain types of partition table. "
12127 "This works on C<gpt> but not on C<mbr> partitions."
12131 #: ../src/guestfs-actions.pod:4813
12132 msgid "guestfs_part_to_dev"
12136 #: ../src/guestfs-actions.pod:4815
12140 " guestfs_part_to_dev (guestfs_h *g,\n"
12141 " const char *partition);\n"
12146 #: ../src/guestfs-actions.pod:4819 ../fish/guestfish-actions.pod:3235
12148 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12149 "partition number, returning the device name (eg. \"/dev/sdb\")."
12153 #: ../src/guestfs-actions.pod:4823
12155 "The named partition must exist, for example as a string returned from "
12156 "C<guestfs_list_partitions>."
12160 #: ../src/guestfs-actions.pod:4831
12161 msgid "guestfs_ping_daemon"
12165 #: ../src/guestfs-actions.pod:4833
12169 " guestfs_ping_daemon (guestfs_h *g);\n"
12174 #: ../src/guestfs-actions.pod:4836 ../fish/guestfish-actions.pod:3246
12176 "This is a test probe into the guestfs daemon running inside the qemu "
12177 "subprocess. Calling this function checks that the daemon responds to the "
12178 "ping message, without affecting the daemon or attached block device(s) in "
12183 #: ../src/guestfs-actions.pod:4845
12184 msgid "guestfs_pread"
12188 #: ../src/guestfs-actions.pod:4847
12192 " guestfs_pread (guestfs_h *g,\n"
12193 " const char *path,\n"
12195 " int64_t offset,\n"
12196 " size_t *size_r);\n"
12201 #: ../src/guestfs-actions.pod:4854 ../fish/guestfish-actions.pod:3255
12203 "This command lets you read part of a file. It reads C<count> bytes of the "
12204 "file, starting at C<offset>, from file C<path>."
12208 #: ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:4883 ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12210 "This may read fewer bytes than requested. For further details see the "
12211 "L<pread(2)> system call."
12215 #: ../src/guestfs-actions.pod:4860
12216 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12220 #: ../src/guestfs-actions.pod:4871
12221 msgid "guestfs_pread_device"
12225 #: ../src/guestfs-actions.pod:4873
12229 " guestfs_pread_device (guestfs_h *g,\n"
12230 " const char *device,\n"
12232 " int64_t offset,\n"
12233 " size_t *size_r);\n"
12238 #: ../src/guestfs-actions.pod:4880 ../fish/guestfish-actions.pod:3270
12240 "This command lets you read part of a file. It reads C<count> bytes of "
12241 "C<device>, starting at C<offset>."
12245 #: ../src/guestfs-actions.pod:4886
12246 msgid "See also C<guestfs_pread>."
12250 #: ../src/guestfs-actions.pod:4895
12251 msgid "(Added in 1.5.21)"
12255 #: ../src/guestfs-actions.pod:4897
12256 msgid "guestfs_pvcreate"
12260 #: ../src/guestfs-actions.pod:4899
12264 " guestfs_pvcreate (guestfs_h *g,\n"
12265 " const char *device);\n"
12270 #: ../src/guestfs-actions.pod:4903 ../fish/guestfish-actions.pod:3285
12272 "This creates an LVM physical volume on the named C<device>, where C<device> "
12273 "should usually be a partition name such as C</dev/sda1>."
12277 #: ../src/guestfs-actions.pod:4911
12278 msgid "guestfs_pvremove"
12282 #: ../src/guestfs-actions.pod:4913
12286 " guestfs_pvremove (guestfs_h *g,\n"
12287 " const char *device);\n"
12292 #: ../src/guestfs-actions.pod:4917 ../fish/guestfish-actions.pod:3293
12294 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12299 #: ../src/guestfs-actions.pod:4920 ../fish/guestfish-actions.pod:3296
12301 "The implementation uses the C<pvremove> command which refuses to wipe "
12302 "physical volumes that contain any volume groups, so you have to remove those "
12307 #: ../src/guestfs-actions.pod:4928
12308 msgid "guestfs_pvresize"
12312 #: ../src/guestfs-actions.pod:4930
12316 " guestfs_pvresize (guestfs_h *g,\n"
12317 " const char *device);\n"
12322 #: ../src/guestfs-actions.pod:4934 ../fish/guestfish-actions.pod:3304
12324 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12325 "the new size of the underlying device."
12329 #: ../src/guestfs-actions.pod:4941
12330 msgid "guestfs_pvresize_size"
12334 #: ../src/guestfs-actions.pod:4943
12338 " guestfs_pvresize_size (guestfs_h *g,\n"
12339 " const char *device,\n"
12340 " int64_t size);\n"
12345 #: ../src/guestfs-actions.pod:4948
12347 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12348 "specify the new size (in bytes) explicitly."
12352 #: ../src/guestfs-actions.pod:4955
12353 msgid "guestfs_pvs"
12357 #: ../src/guestfs-actions.pod:4957
12361 " guestfs_pvs (guestfs_h *g);\n"
12366 #: ../src/guestfs-actions.pod:4960 ../fish/guestfish-actions.pod:3318
12368 "List all the physical volumes detected. This is the equivalent of the "
12369 "L<pvs(8)> command."
12373 #: ../src/guestfs-actions.pod:4963 ../fish/guestfish-actions.pod:3321
12375 "This returns a list of just the device names that contain PVs "
12376 "(eg. C</dev/sda2>)."
12380 #: ../src/guestfs-actions.pod:4966
12381 msgid "See also C<guestfs_pvs_full>."
12385 #: ../src/guestfs-actions.pod:4974
12386 msgid "guestfs_pvs_full"
12390 #: ../src/guestfs-actions.pod:4976
12393 " struct guestfs_lvm_pv_list *\n"
12394 " guestfs_pvs_full (guestfs_h *g);\n"
12399 #: ../src/guestfs-actions.pod:4979 ../fish/guestfish-actions.pod:3330
12401 "List all the physical volumes detected. This is the equivalent of the "
12402 "L<pvs(8)> command. The \"full\" version includes all fields."
12406 #: ../src/guestfs-actions.pod:4982
12408 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12409 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
12414 #: ../src/guestfs-actions.pod:4988
12415 msgid "guestfs_pvuuid"
12419 #: ../src/guestfs-actions.pod:4990
12423 " guestfs_pvuuid (guestfs_h *g,\n"
12424 " const char *device);\n"
12429 #: ../src/guestfs-actions.pod:4994 ../fish/guestfish-actions.pod:3337
12430 msgid "This command returns the UUID of the LVM PV C<device>."
12434 #: ../src/guestfs-actions.pod:5001
12435 msgid "guestfs_pwrite"
12439 #: ../src/guestfs-actions.pod:5003
12443 " guestfs_pwrite (guestfs_h *g,\n"
12444 " const char *path,\n"
12445 " const char *content,\n"
12446 " size_t content_size,\n"
12447 " int64_t offset);\n"
12452 #: ../src/guestfs-actions.pod:5010 ../fish/guestfish-actions.pod:3343
12454 "This command writes to part of a file. It writes the data buffer C<content> "
12455 "to the file C<path> starting at offset C<offset>."
12459 #: ../src/guestfs-actions.pod:5013 ../fish/guestfish-actions.pod:3346
12461 "This command implements the L<pwrite(2)> system call, and like that system "
12462 "call it may not write the full data requested. The return value is the "
12463 "number of bytes that were actually written to the file. This could even be "
12464 "0, although short writes are unlikely for regular files in ordinary "
12469 #: ../src/guestfs-actions.pod:5019
12470 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12474 #: ../src/guestfs-actions.pod:5028
12475 msgid "guestfs_pwrite_device"
12479 #: ../src/guestfs-actions.pod:5030
12483 " guestfs_pwrite_device (guestfs_h *g,\n"
12484 " const char *device,\n"
12485 " const char *content,\n"
12486 " size_t content_size,\n"
12487 " int64_t offset);\n"
12492 #: ../src/guestfs-actions.pod:5037 ../fish/guestfish-actions.pod:3361
12494 "This command writes to part of a device. It writes the data buffer "
12495 "C<content> to C<device> starting at offset C<offset>."
12499 #: ../src/guestfs-actions.pod:5040 ../fish/guestfish-actions.pod:3364
12501 "This command implements the L<pwrite(2)> system call, and like that system "
12502 "call it may not write the full data requested (although short writes to disk "
12503 "devices and partitions are probably impossible with standard Linux kernels)."
12507 #: ../src/guestfs-actions.pod:5045
12508 msgid "See also C<guestfs_pwrite>."
12512 #: ../src/guestfs-actions.pod:5052
12513 msgid "(Added in 1.5.20)"
12517 #: ../src/guestfs-actions.pod:5054
12518 msgid "guestfs_read_file"
12522 #: ../src/guestfs-actions.pod:5056
12526 " guestfs_read_file (guestfs_h *g,\n"
12527 " const char *path,\n"
12528 " size_t *size_r);\n"
12533 #: ../src/guestfs-actions.pod:5061 ../fish/guestfish-actions.pod:3378
12534 msgid "This calls returns the contents of the file C<path> as a buffer."
12538 #: ../src/guestfs-actions.pod:5064
12540 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12541 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12542 "function is limited in the total size of file that can be handled."
12546 #: ../src/guestfs-actions.pod:5076
12547 msgid "(Added in 1.0.63)"
12551 #: ../src/guestfs-actions.pod:5078
12552 msgid "guestfs_read_lines"
12556 #: ../src/guestfs-actions.pod:5080
12560 " guestfs_read_lines (guestfs_h *g,\n"
12561 " const char *path);\n"
12566 #: ../src/guestfs-actions.pod:5086 ../fish/guestfish-actions.pod:3395
12568 "The file contents are returned as a list of lines. Trailing C<LF> and "
12569 "C<CRLF> character sequences are I<not> returned."
12573 #: ../src/guestfs-actions.pod:5089
12575 "Note that this function cannot correctly handle binary files (specifically, "
12576 "files containing C<\\0> character which is treated as end of line). For "
12577 "those you need to use the C<guestfs_read_file> function which has a more "
12578 "complex interface."
12582 #: ../src/guestfs-actions.pod:5100
12583 msgid "guestfs_readdir"
12587 #: ../src/guestfs-actions.pod:5102
12590 " struct guestfs_dirent_list *\n"
12591 " guestfs_readdir (guestfs_h *g,\n"
12592 " const char *dir);\n"
12597 #: ../src/guestfs-actions.pod:5106 ../fish/guestfish-actions.pod:3407
12598 msgid "This returns the list of directory entries in directory C<dir>."
12602 #: ../src/guestfs-actions.pod:5108 ../fish/guestfish-actions.pod:3409
12604 "All entries in the directory are returned, including C<.> and C<..>. The "
12605 "entries are I<not> sorted, but returned in the same order as the underlying "
12610 #: ../src/guestfs-actions.pod:5112 ../fish/guestfish-actions.pod:3413
12612 "Also this call returns basic file type information about each file. The "
12613 "C<ftyp> field will contain one of the following characters:"
12617 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3418
12622 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3420
12623 msgid "Block special"
12627 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3422
12632 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3424
12633 msgid "Char special"
12637 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3426
12642 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3428
12647 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3430
12652 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3432
12653 msgid "FIFO (named pipe)"
12657 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3434
12662 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3436
12663 msgid "Symbolic link"
12667 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3438
12672 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3440
12673 msgid "Regular file"
12677 #: ../src/guestfs-actions.pod:5141 ../fish/guestfish-actions.pod:3442
12682 #: ../src/guestfs-actions.pod:5143 ../fish/guestfish-actions.pod:3444
12687 #: ../src/guestfs-actions.pod:5145 ../fish/guestfish-actions.pod:3446
12692 #: ../src/guestfs-actions.pod:5147 ../fish/guestfish-actions.pod:3448
12693 msgid "Unknown file type"
12697 #: ../src/guestfs-actions.pod:5149 ../fish/guestfish-actions.pod:3450
12702 #: ../src/guestfs-actions.pod:5151 ../fish/guestfish-actions.pod:3452
12703 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12707 #: ../src/guestfs-actions.pod:5156
12709 "This function is primarily intended for use by programs. To get a simple "
12710 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12711 "consumption, use C<guestfs_ll>."
12715 #: ../src/guestfs-actions.pod:5160
12717 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12718 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
12723 #: ../src/guestfs-actions.pod:5166
12724 msgid "guestfs_readlink"
12728 #: ../src/guestfs-actions.pod:5168
12732 " guestfs_readlink (guestfs_h *g,\n"
12733 " const char *path);\n"
12738 #: ../src/guestfs-actions.pod:5172 ../fish/guestfish-actions.pod:3465
12739 msgid "This command reads the target of a symbolic link."
12743 #: ../src/guestfs-actions.pod:5179
12744 msgid "guestfs_readlinklist"
12748 #: ../src/guestfs-actions.pod:5181
12752 " guestfs_readlinklist (guestfs_h *g,\n"
12753 " const char *path,\n"
12754 " char *const *names);\n"
12759 #: ../src/guestfs-actions.pod:5186 ../fish/guestfish-actions.pod:3471
12761 "This call allows you to do a C<readlink> operation on multiple files, where "
12762 "all files are in the directory C<path>. C<names> is the list of files from "
12767 #: ../src/guestfs-actions.pod:5190 ../fish/guestfish-actions.pod:3475
12769 "On return you get a list of strings, with a one-to-one correspondence to the "
12770 "C<names> list. Each string is the value of the symbolic link."
12774 #: ../src/guestfs-actions.pod:5194 ../fish/guestfish-actions.pod:3479
12776 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12777 "result string is the empty string C<\"\">. However the whole operation is "
12778 "completed even if there were C<readlink(2)> errors, and so you can call this "
12779 "function with names where you don't know if they are symbolic links already "
12780 "(albeit slightly less efficient)."
12784 #: ../src/guestfs-actions.pod:5201 ../fish/guestfish-actions.pod:3486
12786 "This call is intended for programs that want to efficiently list a directory "
12787 "contents without making many round-trips. Very long directory listings "
12788 "might cause the protocol message size to be exceeded, causing this call to "
12789 "fail. The caller must split up such requests into smaller groups of names."
12793 #: ../src/guestfs-actions.pod:5214
12794 msgid "guestfs_realpath"
12798 #: ../src/guestfs-actions.pod:5216
12802 " guestfs_realpath (guestfs_h *g,\n"
12803 " const char *path);\n"
12808 #: ../src/guestfs-actions.pod:5220 ../fish/guestfish-actions.pod:3497
12810 "Return the canonicalized absolute pathname of C<path>. The returned path "
12811 "has no C<.>, C<..> or symbolic link path elements."
12815 #: ../src/guestfs-actions.pod:5228
12816 msgid "guestfs_removexattr"
12820 #: ../src/guestfs-actions.pod:5230
12824 " guestfs_removexattr (guestfs_h *g,\n"
12825 " const char *xattr,\n"
12826 " const char *path);\n"
12831 #: ../src/guestfs-actions.pod:5235 ../fish/guestfish-actions.pod:3504
12832 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12836 #: ../src/guestfs-actions.pod:5238
12837 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12841 #: ../src/guestfs-actions.pod:5244
12842 msgid "guestfs_resize2fs"
12846 #: ../src/guestfs-actions.pod:5246
12850 " guestfs_resize2fs (guestfs_h *g,\n"
12851 " const char *device);\n"
12856 #: ../src/guestfs-actions.pod:5250 ../fish/guestfish-actions.pod:3513
12858 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12859 "underlying device."
12863 #: ../src/guestfs-actions.pod:5253
12865 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12866 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12867 "sometimes gives an error about this and sometimes not. In any case, it is "
12868 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12872 #: ../src/guestfs-actions.pod:5263
12873 msgid "guestfs_resize2fs_size"
12877 #: ../src/guestfs-actions.pod:5265
12881 " guestfs_resize2fs_size (guestfs_h *g,\n"
12882 " const char *device,\n"
12883 " int64_t size);\n"
12888 #: ../src/guestfs-actions.pod:5270
12890 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12891 "to specify the new size (in bytes) explicitly."
12895 #: ../src/guestfs-actions.pod:5277
12900 #: ../src/guestfs-actions.pod:5279
12904 " guestfs_rm (guestfs_h *g,\n"
12905 " const char *path);\n"
12910 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3533
12911 msgid "Remove the single file C<path>."
12915 #: ../src/guestfs-actions.pod:5289
12916 msgid "guestfs_rm_rf"
12920 #: ../src/guestfs-actions.pod:5291
12924 " guestfs_rm_rf (guestfs_h *g,\n"
12925 " const char *path);\n"
12930 #: ../src/guestfs-actions.pod:5295 ../fish/guestfish-actions.pod:3539
12932 "Remove the file or directory C<path>, recursively removing the contents if "
12933 "its a directory. This is like the C<rm -rf> shell command."
12937 #: ../src/guestfs-actions.pod:5303
12938 msgid "guestfs_rmdir"
12942 #: ../src/guestfs-actions.pod:5305
12946 " guestfs_rmdir (guestfs_h *g,\n"
12947 " const char *path);\n"
12952 #: ../src/guestfs-actions.pod:5309 ../fish/guestfish-actions.pod:3547
12953 msgid "Remove the single directory C<path>."
12957 #: ../src/guestfs-actions.pod:5315
12958 msgid "guestfs_rmmountpoint"
12962 #: ../src/guestfs-actions.pod:5317
12966 " guestfs_rmmountpoint (guestfs_h *g,\n"
12967 " const char *exemptpath);\n"
12972 #: ../src/guestfs-actions.pod:5321
12974 "This calls removes a mountpoint that was previously created with "
12975 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12979 #: ../src/guestfs-actions.pod:5329
12980 msgid "guestfs_scrub_device"
12984 #: ../src/guestfs-actions.pod:5331
12988 " guestfs_scrub_device (guestfs_h *g,\n"
12989 " const char *device);\n"
12994 #: ../src/guestfs-actions.pod:5335 ../fish/guestfish-actions.pod:3561
12996 "This command writes patterns over C<device> to make data retrieval more "
13001 #: ../src/guestfs-actions.pod:5338 ../src/guestfs-actions.pod:5359 ../src/guestfs-actions.pod:5378 ../fish/guestfish-actions.pod:3564 ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
13003 "It is an interface to the L<scrub(1)> program. See that manual page for "
13008 #: ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:5383
13009 msgid "(Added in 1.0.52)"
13013 #: ../src/guestfs-actions.pod:5348
13014 msgid "guestfs_scrub_file"
13018 #: ../src/guestfs-actions.pod:5350
13022 " guestfs_scrub_file (guestfs_h *g,\n"
13023 " const char *file);\n"
13028 #: ../src/guestfs-actions.pod:5354 ../fish/guestfish-actions.pod:3574
13030 "This command writes patterns over a file to make data retrieval more "
13035 #: ../src/guestfs-actions.pod:5357 ../fish/guestfish-actions.pod:3577
13036 msgid "The file is I<removed> after scrubbing."
13040 #: ../src/guestfs-actions.pod:5366
13041 msgid "guestfs_scrub_freespace"
13045 #: ../src/guestfs-actions.pod:5368
13049 " guestfs_scrub_freespace (guestfs_h *g,\n"
13050 " const char *dir);\n"
13055 #: ../src/guestfs-actions.pod:5372
13057 "This command creates the directory C<dir> and then fills it with files until "
13058 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13059 "and deletes them. The intention is to scrub any free space on the partition "
13060 "containing C<dir>."
13064 #: ../src/guestfs-actions.pod:5385
13065 msgid "guestfs_set_append"
13069 #: ../src/guestfs-actions.pod:5387
13073 " guestfs_set_append (guestfs_h *g,\n"
13074 " const char *append);\n"
13079 #: ../src/guestfs-actions.pod:5391 ../fish/guestfish-actions.pod:3601
13081 "This function is used to add additional options to the guest kernel command "
13086 #: ../src/guestfs-actions.pod:5394 ../fish/guestfish-actions.pod:3604
13088 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13089 "environment variable."
13093 #: ../src/guestfs-actions.pod:5397 ../fish/guestfish-actions.pod:3607
13095 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13096 "(libguestfs always adds a few of its own)."
13100 #: ../src/guestfs-actions.pod:5404
13101 msgid "guestfs_set_autosync"
13105 #: ../src/guestfs-actions.pod:5406
13109 " guestfs_set_autosync (guestfs_h *g,\n"
13110 " int autosync);\n"
13115 #: ../src/guestfs-actions.pod:5410
13117 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13118 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13119 "the handle is closed (also if the program exits without closing handles)."
13123 #: ../src/guestfs-actions.pod:5415 ../fish/guestfish-actions.pod:3621
13125 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13126 "disabled by default)."
13130 #: ../src/guestfs-actions.pod:5422
13131 msgid "guestfs_set_direct"
13135 #: ../src/guestfs-actions.pod:5424
13139 " guestfs_set_direct (guestfs_h *g,\n"
13145 #: ../src/guestfs-actions.pod:5428 ../fish/guestfish-actions.pod:3630
13147 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13148 "passed directly through to the appliance once it is launched."
13152 #: ../src/guestfs-actions.pod:5432
13154 "One consequence of this is that log messages aren't caught by the library "
13155 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13160 #: ../src/guestfs-actions.pod:5436 ../fish/guestfish-actions.pod:3638
13161 msgid "You probably don't want to use this unless you know what you are doing."
13165 #: ../src/guestfs-actions.pod:5439 ../fish/guestfish-actions.pod:3641
13166 msgid "The default is disabled."
13170 #: ../src/guestfs-actions.pod:5445
13171 msgid "guestfs_set_e2label"
13175 #: ../src/guestfs-actions.pod:5447
13179 " guestfs_set_e2label (guestfs_h *g,\n"
13180 " const char *device,\n"
13181 " const char *label);\n"
13186 #: ../src/guestfs-actions.pod:5452 ../fish/guestfish-actions.pod:3647
13188 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13189 "C<label>. Filesystem labels are limited to 16 characters."
13193 #: ../src/guestfs-actions.pod:5456
13195 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13196 "the existing label on a filesystem."
13200 #: ../src/guestfs-actions.pod:5463
13201 msgid "guestfs_set_e2uuid"
13205 #: ../src/guestfs-actions.pod:5465
13209 " guestfs_set_e2uuid (guestfs_h *g,\n"
13210 " const char *device,\n"
13211 " const char *uuid);\n"
13216 #: ../src/guestfs-actions.pod:5470 ../fish/guestfish-actions.pod:3658
13218 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13219 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13220 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13224 #: ../src/guestfs-actions.pod:5475
13226 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13227 "the existing UUID of a filesystem."
13231 #: ../src/guestfs-actions.pod:5482
13232 msgid "guestfs_set_memsize"
13236 #: ../src/guestfs-actions.pod:5484
13240 " guestfs_set_memsize (guestfs_h *g,\n"
13246 #: ../src/guestfs-actions.pod:5488
13248 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13249 "This only has any effect if called before C<guestfs_launch>."
13253 #: ../src/guestfs-actions.pod:5492 ../fish/guestfish-actions.pod:3676
13255 "You can also change this by setting the environment variable "
13256 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13260 #: ../src/guestfs-actions.pod:5503
13261 msgid "guestfs_set_network"
13265 #: ../src/guestfs-actions.pod:5505
13269 " guestfs_set_network (guestfs_h *g,\n"
13275 #: ../src/guestfs-actions.pod:5509 ../fish/guestfish-actions.pod:3689
13277 "If C<network> is true, then the network is enabled in the libguestfs "
13278 "appliance. The default is false."
13282 #: ../src/guestfs-actions.pod:5512 ../fish/guestfish-actions.pod:3692
13284 "This affects whether commands are able to access the network (see "
13285 "L<guestfs(3)/RUNNING COMMANDS>)."
13289 #: ../src/guestfs-actions.pod:5515
13291 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13296 #: ../src/guestfs-actions.pod:5522
13297 msgid "guestfs_set_path"
13301 #: ../src/guestfs-actions.pod:5524
13305 " guestfs_set_path (guestfs_h *g,\n"
13306 " const char *searchpath);\n"
13311 #: ../src/guestfs-actions.pod:5528 ../fish/guestfish-actions.pod:3704
13312 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13316 #: ../src/guestfs-actions.pod:5530 ../fish/guestfish-actions.pod:3706
13318 "The default is C<$libdir/guestfs> unless overridden by setting "
13319 "C<LIBGUESTFS_PATH> environment variable."
13323 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3709
13324 msgid "Setting C<path> to C<NULL> restores the default path."
13328 #: ../src/guestfs-actions.pod:5539
13329 msgid "guestfs_set_qemu"
13333 #: ../src/guestfs-actions.pod:5541
13337 " guestfs_set_qemu (guestfs_h *g,\n"
13338 " const char *qemu);\n"
13343 #: ../src/guestfs-actions.pod:5545 ../fish/guestfish-actions.pod:3717
13344 msgid "Set the qemu binary that we will use."
13348 #: ../src/guestfs-actions.pod:5547 ../fish/guestfish-actions.pod:3719
13349 msgid "The default is chosen when the library was compiled by the configure script."
13353 #: ../src/guestfs-actions.pod:5550 ../fish/guestfish-actions.pod:3722
13355 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13360 #: ../src/guestfs-actions.pod:5553 ../fish/guestfish-actions.pod:3725
13361 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13365 #: ../src/guestfs-actions.pod:5555 ../fish/guestfish-actions.pod:3727
13367 "Note that you should call this function as early as possible after creating "
13368 "the handle. This is because some pre-launch operations depend on testing "
13369 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13370 "don't retest features, and so you might see inconsistent results. Using the "
13371 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13372 "the qemu binary at the same time as the handle is created."
13376 #: ../src/guestfs-actions.pod:5567
13377 msgid "guestfs_set_recovery_proc"
13381 #: ../src/guestfs-actions.pod:5569
13385 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13386 " int recoveryproc);\n"
13391 #: ../src/guestfs-actions.pod:5573
13393 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13394 "not create a recovery process. The purpose of the recovery process is to "
13395 "stop runaway qemu processes in the case where the main program aborts "
13400 #: ../src/guestfs-actions.pod:5578
13402 "This only has any effect if called before C<guestfs_launch>, and the default "
13407 #: ../src/guestfs-actions.pod:5581 ../fish/guestfish-actions.pod:3749
13409 "About the only time when you would want to disable this is if the main "
13410 "process will fork itself into the background (\"daemonize\" itself). In "
13411 "this case the recovery process thinks that the main program has disappeared "
13412 "and so kills qemu, which is not very helpful."
13416 #: ../src/guestfs-actions.pod:5591
13417 msgid "guestfs_set_selinux"
13421 #: ../src/guestfs-actions.pod:5593
13425 " guestfs_set_selinux (guestfs_h *g,\n"
13431 #: ../src/guestfs-actions.pod:5597 ../fish/guestfish-actions.pod:3761
13433 "This sets the selinux flag that is passed to the appliance at boot time. "
13434 "The default is C<selinux=0> (disabled)."
13438 #: ../src/guestfs-actions.pod:5600 ../fish/guestfish-actions.pod:3764
13440 "Note that if SELinux is enabled, it is always in Permissive mode "
13441 "(C<enforcing=0>)."
13445 #: ../src/guestfs-actions.pod:5610
13446 msgid "guestfs_set_trace"
13450 #: ../src/guestfs-actions.pod:5612
13454 " guestfs_set_trace (guestfs_h *g,\n"
13460 #: ../src/guestfs-actions.pod:5616 ../fish/guestfish-actions.pod:3776
13462 "If the command trace flag is set to 1, then commands are printed on stderr "
13463 "before they are executed in a format which is very similar to the one used "
13464 "by guestfish. In other words, you can run a program with this enabled, and "
13465 "you will get out a script which you can feed to guestfish to perform the "
13466 "same set of actions."
13470 #: ../src/guestfs-actions.pod:5623 ../fish/guestfish-actions.pod:3783
13472 "If you want to trace C API calls into libguestfs (and other libraries) then "
13473 "possibly a better way is to use the external ltrace(1) command."
13477 #: ../src/guestfs-actions.pod:5627 ../fish/guestfish-actions.pod:3787
13479 "Command traces are disabled unless the environment variable "
13480 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13484 #: ../src/guestfs-actions.pod:5634
13485 msgid "guestfs_set_verbose"
13489 #: ../src/guestfs-actions.pod:5636
13493 " guestfs_set_verbose (guestfs_h *g,\n"
13499 #: ../src/guestfs-actions.pod:5640 ../fish/guestfish-actions.pod:3796
13500 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13504 #: ../src/guestfs-actions.pod:5642 ../fish/guestfish-actions.pod:3798
13506 "Verbose messages are disabled unless the environment variable "
13507 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13511 #: ../src/guestfs-actions.pod:5649
13512 msgid "guestfs_setcon"
13516 #: ../src/guestfs-actions.pod:5651
13520 " guestfs_setcon (guestfs_h *g,\n"
13521 " const char *context);\n"
13526 #: ../src/guestfs-actions.pod:5655 ../fish/guestfish-actions.pod:3805
13528 "This sets the SELinux security context of the daemon to the string "
13533 #: ../src/guestfs-actions.pod:5658 ../fish/guestfish-actions.pod:3808
13534 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13538 #: ../src/guestfs-actions.pod:5664
13539 msgid "guestfs_setxattr"
13543 #: ../src/guestfs-actions.pod:5666
13547 " guestfs_setxattr (guestfs_h *g,\n"
13548 " const char *xattr,\n"
13549 " const char *val,\n"
13551 " const char *path);\n"
13556 #: ../src/guestfs-actions.pod:5673 ../fish/guestfish-actions.pod:3814
13558 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13559 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13563 #: ../src/guestfs-actions.pod:5677
13564 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13568 #: ../src/guestfs-actions.pod:5683
13569 msgid "guestfs_sfdisk"
13573 #: ../src/guestfs-actions.pod:5685
13577 " guestfs_sfdisk (guestfs_h *g,\n"
13578 " const char *device,\n"
13582 " char *const *lines);\n"
13587 #: ../src/guestfs-actions.pod:5693 ../fish/guestfish-actions.pod:3824
13589 "This is a direct interface to the L<sfdisk(8)> program for creating "
13590 "partitions on block devices."
13594 #: ../src/guestfs-actions.pod:5696 ../fish/guestfish-actions.pod:3827
13595 msgid "C<device> should be a block device, for example C</dev/sda>."
13599 #: ../src/guestfs-actions.pod:5698 ../fish/guestfish-actions.pod:3829
13601 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13602 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13603 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13604 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13605 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13606 "the kernel) cannot work out the right geometry and you will need to tell it."
13610 #: ../src/guestfs-actions.pod:5706 ../fish/guestfish-actions.pod:3837
13612 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13613 "refer to the L<sfdisk(8)> manpage."
13617 #: ../src/guestfs-actions.pod:5709 ../fish/guestfish-actions.pod:3840
13619 "To create a single partition occupying the whole disk, you would pass "
13620 "C<lines> as a single element list, when the single element being the string "
13625 #: ../src/guestfs-actions.pod:5713
13626 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13630 #: ../src/guestfs-actions.pod:5723
13631 msgid "guestfs_sfdiskM"
13635 #: ../src/guestfs-actions.pod:5725
13639 " guestfs_sfdiskM (guestfs_h *g,\n"
13640 " const char *device,\n"
13641 " char *const *lines);\n"
13646 #: ../src/guestfs-actions.pod:5730
13648 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13649 "partition sizes are specified in megabytes only (rounded to the nearest "
13650 "cylinder) and you don't need to specify the cyls, heads and sectors "
13651 "parameters which were rarely if ever used anyway."
13655 #: ../src/guestfs-actions.pod:5736
13657 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13658 "C<guestfs_part_disk>"
13662 #: ../src/guestfs-actions.pod:5746
13663 msgid "guestfs_sfdisk_N"
13667 #: ../src/guestfs-actions.pod:5748
13671 " guestfs_sfdisk_N (guestfs_h *g,\n"
13672 " const char *device,\n"
13677 " const char *line);\n"
13682 #: ../src/guestfs-actions.pod:5757 ../fish/guestfish-actions.pod:3870
13684 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13685 "(note: C<n> counts from 1)."
13689 #: ../src/guestfs-actions.pod:5760
13691 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13692 "for the cyls/heads/sectors parameters."
13696 #: ../src/guestfs-actions.pod:5763
13697 msgid "See also: C<guestfs_part_add>"
13701 #: ../src/guestfs-actions.pod:5772
13702 msgid "guestfs_sfdisk_disk_geometry"
13706 #: ../src/guestfs-actions.pod:5774
13710 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13711 " const char *device);\n"
13716 #: ../src/guestfs-actions.pod:5778
13718 "This displays the disk geometry of C<device> read from the partition table. "
13719 "Especially in the case where the underlying block device has been resized, "
13720 "this can be different from the kernel's idea of the geometry (see "
13721 "C<guestfs_sfdisk_kernel_geometry>)."
13725 #: ../src/guestfs-actions.pod:5783 ../src/guestfs-actions.pod:5799 ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
13726 msgid "The result is in human-readable format, and not designed to be parsed."
13730 #: ../src/guestfs-actions.pod:5791
13731 msgid "guestfs_sfdisk_kernel_geometry"
13735 #: ../src/guestfs-actions.pod:5793
13739 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13740 " const char *device);\n"
13745 #: ../src/guestfs-actions.pod:5797 ../fish/guestfish-actions.pod:3897
13746 msgid "This displays the kernel's idea of the geometry of C<device>."
13750 #: ../src/guestfs-actions.pod:5807
13751 msgid "guestfs_sfdisk_l"
13755 #: ../src/guestfs-actions.pod:5809
13759 " guestfs_sfdisk_l (guestfs_h *g,\n"
13760 " const char *device);\n"
13765 #: ../src/guestfs-actions.pod:5813 ../fish/guestfish-actions.pod:3906
13767 "This displays the partition table on C<device>, in the human-readable output "
13768 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13772 #: ../src/guestfs-actions.pod:5817
13773 msgid "See also: C<guestfs_part_list>"
13777 #: ../src/guestfs-actions.pod:5824
13782 #: ../src/guestfs-actions.pod:5826
13786 " guestfs_sh (guestfs_h *g,\n"
13787 " const char *command);\n"
13792 #: ../src/guestfs-actions.pod:5830 ../fish/guestfish-actions.pod:3916
13794 "This call runs a command from the guest filesystem via the guest's "
13799 #: ../src/guestfs-actions.pod:5833
13800 msgid "This is like C<guestfs_command>, but passes the command to:"
13804 #: ../src/guestfs-actions.pod:5835 ../fish/guestfish-actions.pod:3921
13807 " /bin/sh -c \"command\"\n"
13812 #: ../src/guestfs-actions.pod:5837 ../fish/guestfish-actions.pod:3923
13814 "Depending on the guest's shell, this usually results in wildcards being "
13815 "expanded, shell expressions being interpolated and so on."
13819 #: ../src/guestfs-actions.pod:5841
13820 msgid "All the provisos about C<guestfs_command> apply to this call."
13824 #: ../src/guestfs-actions.pod:5848
13825 msgid "guestfs_sh_lines"
13829 #: ../src/guestfs-actions.pod:5850
13833 " guestfs_sh_lines (guestfs_h *g,\n"
13834 " const char *command);\n"
13839 #: ../src/guestfs-actions.pod:5854
13841 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13846 #: ../src/guestfs-actions.pod:5857
13847 msgid "See also: C<guestfs_command_lines>"
13851 #: ../src/guestfs-actions.pod:5865
13852 msgid "guestfs_sleep"
13856 #: ../src/guestfs-actions.pod:5867
13860 " guestfs_sleep (guestfs_h *g,\n"
13866 #: ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:3942
13867 msgid "Sleep for C<secs> seconds."
13871 #: ../src/guestfs-actions.pod:5875
13872 msgid "(Added in 1.0.41)"
13876 #: ../src/guestfs-actions.pod:5877 ../src/guestfs-structs.pod:109
13877 msgid "guestfs_stat"
13881 #: ../src/guestfs-actions.pod:5879
13884 " struct guestfs_stat *\n"
13885 " guestfs_stat (guestfs_h *g,\n"
13886 " const char *path);\n"
13891 #: ../src/guestfs-actions.pod:5885 ../fish/guestfish-actions.pod:3950
13892 msgid "This is the same as the C<stat(2)> system call."
13896 #: ../src/guestfs-actions.pod:5893 ../src/guestfs-structs.pod:135
13897 msgid "guestfs_statvfs"
13901 #: ../src/guestfs-actions.pod:5895
13904 " struct guestfs_statvfs *\n"
13905 " guestfs_statvfs (guestfs_h *g,\n"
13906 " const char *path);\n"
13911 #: ../src/guestfs-actions.pod:5899 ../fish/guestfish-actions.pod:3956
13913 "Returns file system statistics for any mounted file system. C<path> should "
13914 "be a file or directory in the mounted file system (typically it is the mount "
13915 "point itself, but it doesn't need to be)."
13919 #: ../src/guestfs-actions.pod:5903 ../fish/guestfish-actions.pod:3960
13920 msgid "This is the same as the C<statvfs(2)> system call."
13924 #: ../src/guestfs-actions.pod:5905
13926 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13927 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13931 #: ../src/guestfs-actions.pod:5911
13932 msgid "guestfs_strings"
13936 #: ../src/guestfs-actions.pod:5913
13940 " guestfs_strings (guestfs_h *g,\n"
13941 " const char *path);\n"
13946 #: ../src/guestfs-actions.pod:5917 ../fish/guestfish-actions.pod:3966
13948 "This runs the L<strings(1)> command on a file and returns the list of "
13949 "printable strings found."
13953 #: ../src/guestfs-actions.pod:5929
13954 msgid "guestfs_strings_e"
13958 #: ../src/guestfs-actions.pod:5931
13962 " guestfs_strings_e (guestfs_h *g,\n"
13963 " const char *encoding,\n"
13964 " const char *path);\n"
13969 #: ../src/guestfs-actions.pod:5936
13971 "This is like the C<guestfs_strings> command, but allows you to specify the "
13972 "encoding of strings that are looked for in the source file C<path>."
13976 #: ../src/guestfs-actions.pod:5940 ../fish/guestfish-actions.pod:3980
13977 msgid "Allowed encodings are:"
13981 #: ../src/guestfs-actions.pod:5944 ../fish/guestfish-actions.pod:3984
13986 #: ../src/guestfs-actions.pod:5946
13988 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13989 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13993 #: ../src/guestfs-actions.pod:5949 ../fish/guestfish-actions.pod:3989
13998 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:3991
13999 msgid "Single 8-bit-byte characters."
14003 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:3993
14008 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:3995
14009 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
14013 #: ../src/guestfs-actions.pod:5958 ../fish/guestfish-actions.pod:3998
14014 msgid "l (lower case letter L)"
14018 #: ../src/guestfs-actions.pod:5960 ../fish/guestfish-actions.pod:4000
14020 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
14021 "examining binaries in Windows guests."
14025 #: ../src/guestfs-actions.pod:5963 ../fish/guestfish-actions.pod:4003
14030 #: ../src/guestfs-actions.pod:5965 ../fish/guestfish-actions.pod:4005
14031 msgid "32-bit big endian such as UCS-4BE."
14035 #: ../src/guestfs-actions.pod:5967 ../fish/guestfish-actions.pod:4007
14040 #: ../src/guestfs-actions.pod:5969 ../fish/guestfish-actions.pod:4009
14041 msgid "32-bit little endian such as UCS-4LE."
14045 #: ../src/guestfs-actions.pod:5973 ../fish/guestfish-actions.pod:4013
14046 msgid "The returned strings are transcoded to UTF-8."
14050 #: ../src/guestfs-actions.pod:5984
14051 msgid "guestfs_swapoff_device"
14055 #: ../src/guestfs-actions.pod:5986
14059 " guestfs_swapoff_device (guestfs_h *g,\n"
14060 " const char *device);\n"
14065 #: ../src/guestfs-actions.pod:5990
14067 "This command disables the libguestfs appliance swap device or partition "
14068 "named C<device>. See C<guestfs_swapon_device>."
14072 #: ../src/guestfs-actions.pod:5998
14073 msgid "guestfs_swapoff_file"
14077 #: ../src/guestfs-actions.pod:6000
14081 " guestfs_swapoff_file (guestfs_h *g,\n"
14082 " const char *file);\n"
14087 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4030
14088 msgid "This command disables the libguestfs appliance swap on file."
14092 #: ../src/guestfs-actions.pod:6010
14093 msgid "guestfs_swapoff_label"
14097 #: ../src/guestfs-actions.pod:6012
14101 " guestfs_swapoff_label (guestfs_h *g,\n"
14102 " const char *label);\n"
14107 #: ../src/guestfs-actions.pod:6016 ../fish/guestfish-actions.pod:4036
14109 "This command disables the libguestfs appliance swap on labeled swap "
14114 #: ../src/guestfs-actions.pod:6023
14115 msgid "guestfs_swapoff_uuid"
14119 #: ../src/guestfs-actions.pod:6025
14123 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14124 " const char *uuid);\n"
14129 #: ../src/guestfs-actions.pod:6029 ../fish/guestfish-actions.pod:4043
14131 "This command disables the libguestfs appliance swap partition with the given "
14136 #: ../src/guestfs-actions.pod:6036
14137 msgid "guestfs_swapon_device"
14141 #: ../src/guestfs-actions.pod:6038
14145 " guestfs_swapon_device (guestfs_h *g,\n"
14146 " const char *device);\n"
14151 #: ../src/guestfs-actions.pod:6042
14153 "This command enables the libguestfs appliance to use the swap device or "
14154 "partition named C<device>. The increased memory is made available for all "
14155 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14159 #: ../src/guestfs-actions.pod:6047 ../fish/guestfish-actions.pod:4055
14161 "Note that you should not swap to existing guest swap partitions unless you "
14162 "know what you are doing. They may contain hibernation information, or other "
14163 "information that the guest doesn't want you to trash. You also risk leaking "
14164 "information about the host to the guest this way. Instead, attach a new "
14165 "host device to the guest and swap on that."
14169 #: ../src/guestfs-actions.pod:6058
14170 msgid "guestfs_swapon_file"
14174 #: ../src/guestfs-actions.pod:6060
14178 " guestfs_swapon_file (guestfs_h *g,\n"
14179 " const char *file);\n"
14184 #: ../src/guestfs-actions.pod:6064
14186 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14191 #: ../src/guestfs-actions.pod:6071
14192 msgid "guestfs_swapon_label"
14196 #: ../src/guestfs-actions.pod:6073
14200 " guestfs_swapon_label (guestfs_h *g,\n"
14201 " const char *label);\n"
14206 #: ../src/guestfs-actions.pod:6077
14208 "This command enables swap to a labeled swap partition. See "
14209 "C<guestfs_swapon_device> for other notes."
14213 #: ../src/guestfs-actions.pod:6084
14214 msgid "guestfs_swapon_uuid"
14218 #: ../src/guestfs-actions.pod:6086
14222 " guestfs_swapon_uuid (guestfs_h *g,\n"
14223 " const char *uuid);\n"
14228 #: ../src/guestfs-actions.pod:6090
14230 "This command enables swap to a swap partition with the given UUID. See "
14231 "C<guestfs_swapon_device> for other notes."
14235 #: ../src/guestfs-actions.pod:6097
14236 msgid "guestfs_sync"
14240 #: ../src/guestfs-actions.pod:6099
14244 " guestfs_sync (guestfs_h *g);\n"
14249 #: ../src/guestfs-actions.pod:6102 ../fish/guestfish-actions.pod:4087
14251 "This syncs the disk, so that any writes are flushed through to the "
14252 "underlying disk image."
14256 #: ../src/guestfs-actions.pod:6105 ../fish/guestfish-actions.pod:4090
14258 "You should always call this if you have modified a disk image, before "
14259 "closing the handle."
14263 #: ../src/guestfs-actions.pod:6112
14264 msgid "guestfs_tail"
14268 #: ../src/guestfs-actions.pod:6114
14272 " guestfs_tail (guestfs_h *g,\n"
14273 " const char *path);\n"
14278 #: ../src/guestfs-actions.pod:6118 ../fish/guestfish-actions.pod:4097
14279 msgid "This command returns up to the last 10 lines of a file as a list of strings."
14283 #: ../src/guestfs-actions.pod:6130
14284 msgid "guestfs_tail_n"
14288 #: ../src/guestfs-actions.pod:6132
14292 " guestfs_tail_n (guestfs_h *g,\n"
14294 " const char *path);\n"
14299 #: ../src/guestfs-actions.pod:6137 ../fish/guestfish-actions.pod:4107
14301 "If the parameter C<nrlines> is a positive number, this returns the last "
14302 "C<nrlines> lines of the file C<path>."
14306 #: ../src/guestfs-actions.pod:6140 ../fish/guestfish-actions.pod:4110
14308 "If the parameter C<nrlines> is a negative number, this returns lines from "
14309 "the file C<path>, starting with the C<-nrlines>th line."
14313 #: ../src/guestfs-actions.pod:6154
14314 msgid "guestfs_tar_in"
14318 #: ../src/guestfs-actions.pod:6156
14322 " guestfs_tar_in (guestfs_h *g,\n"
14323 " const char *tarfile,\n"
14324 " const char *directory);\n"
14329 #: ../src/guestfs-actions.pod:6161 ../fish/guestfish-actions.pod:4122
14331 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14332 "tar file) into C<directory>."
14336 #: ../src/guestfs-actions.pod:6164
14337 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14341 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6186 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6218
14342 msgid "(Added in 1.0.3)"
14346 #: ../src/guestfs-actions.pod:6171
14347 msgid "guestfs_tar_out"
14351 #: ../src/guestfs-actions.pod:6173
14355 " guestfs_tar_out (guestfs_h *g,\n"
14356 " const char *directory,\n"
14357 " const char *tarfile);\n"
14362 #: ../src/guestfs-actions.pod:6178 ../fish/guestfish-actions.pod:4134
14364 "This command packs the contents of C<directory> and downloads it to local "
14369 #: ../src/guestfs-actions.pod:6181
14371 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14372 "C<guestfs_txz_out>."
14376 #: ../src/guestfs-actions.pod:6188
14377 msgid "guestfs_tgz_in"
14381 #: ../src/guestfs-actions.pod:6190
14385 " guestfs_tgz_in (guestfs_h *g,\n"
14386 " const char *tarball,\n"
14387 " const char *directory);\n"
14392 #: ../src/guestfs-actions.pod:6195 ../fish/guestfish-actions.pod:4146
14394 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14395 "tar file) into C<directory>."
14399 #: ../src/guestfs-actions.pod:6198
14400 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14404 #: ../src/guestfs-actions.pod:6204
14405 msgid "guestfs_tgz_out"
14409 #: ../src/guestfs-actions.pod:6206
14413 " guestfs_tgz_out (guestfs_h *g,\n"
14414 " const char *directory,\n"
14415 " const char *tarball);\n"
14420 #: ../src/guestfs-actions.pod:6211 ../fish/guestfish-actions.pod:4157
14422 "This command packs the contents of C<directory> and downloads it to local "
14427 #: ../src/guestfs-actions.pod:6214
14428 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14432 #: ../src/guestfs-actions.pod:6220
14433 msgid "guestfs_touch"
14437 #: ../src/guestfs-actions.pod:6222
14441 " guestfs_touch (guestfs_h *g,\n"
14442 " const char *path);\n"
14447 #: ../src/guestfs-actions.pod:6226 ../fish/guestfish-actions.pod:4168
14449 "Touch acts like the L<touch(1)> command. It can be used to update the "
14450 "timestamps on a file, or, if the file does not exist, to create a new "
14451 "zero-length file."
14455 #: ../src/guestfs-actions.pod:6230 ../fish/guestfish-actions.pod:4172
14457 "This command only works on regular files, and will fail on other file types "
14458 "such as directories, symbolic links, block special etc."
14462 #: ../src/guestfs-actions.pod:6237
14463 msgid "guestfs_truncate"
14467 #: ../src/guestfs-actions.pod:6239
14471 " guestfs_truncate (guestfs_h *g,\n"
14472 " const char *path);\n"
14477 #: ../src/guestfs-actions.pod:6243 ../fish/guestfish-actions.pod:4179
14479 "This command truncates C<path> to a zero-length file. The file must exist "
14484 #: ../src/guestfs-actions.pod:6250
14485 msgid "guestfs_truncate_size"
14489 #: ../src/guestfs-actions.pod:6252
14493 " guestfs_truncate_size (guestfs_h *g,\n"
14494 " const char *path,\n"
14495 " int64_t size);\n"
14500 #: ../src/guestfs-actions.pod:6257 ../fish/guestfish-actions.pod:4186
14502 "This command truncates C<path> to size C<size> bytes. The file must exist "
14507 #: ../src/guestfs-actions.pod:6260
14509 "If the current file size is less than C<size> then the file is extended to "
14510 "the required size with zero bytes. This creates a sparse file (ie. disk "
14511 "blocks are not allocated for the file until you write to it). To create a "
14512 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14516 #: ../src/guestfs-actions.pod:6270
14517 msgid "guestfs_tune2fs_l"
14521 #: ../src/guestfs-actions.pod:6272
14525 " guestfs_tune2fs_l (guestfs_h *g,\n"
14526 " const char *device);\n"
14531 #: ../src/guestfs-actions.pod:6276 ../fish/guestfish-actions.pod:4199
14533 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14538 #: ../src/guestfs-actions.pod:6279 ../fish/guestfish-actions.pod:4202
14540 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14541 "for more details. The list of fields returned isn't clearly defined, and "
14542 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14543 "and the filesystem itself."
14547 #: ../src/guestfs-actions.pod:6292
14548 msgid "guestfs_txz_in"
14552 #: ../src/guestfs-actions.pod:6294
14556 " guestfs_txz_in (guestfs_h *g,\n"
14557 " const char *tarball,\n"
14558 " const char *directory);\n"
14563 #: ../src/guestfs-actions.pod:6299 ../fish/guestfish-actions.pod:4211
14565 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14566 "tar file) into C<directory>."
14570 #: ../src/guestfs-actions.pod:6306
14571 msgid "guestfs_txz_out"
14575 #: ../src/guestfs-actions.pod:6308
14579 " guestfs_txz_out (guestfs_h *g,\n"
14580 " const char *directory,\n"
14581 " const char *tarball);\n"
14586 #: ../src/guestfs-actions.pod:6313 ../fish/guestfish-actions.pod:4220
14588 "This command packs the contents of C<directory> and downloads it to local "
14589 "file C<tarball> (as an xz compressed tar archive)."
14593 #: ../src/guestfs-actions.pod:6320
14594 msgid "guestfs_umask"
14598 #: ../src/guestfs-actions.pod:6322
14602 " guestfs_umask (guestfs_h *g,\n"
14608 #: ../src/guestfs-actions.pod:6326 ../fish/guestfish-actions.pod:4229
14610 "This function sets the mask used for creating new files and device nodes to "
14615 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4232
14617 "Typical umask values would be C<022> which creates new files with "
14618 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14619 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14623 #: ../src/guestfs-actions.pod:6334 ../fish/guestfish-actions.pod:4237
14625 "The default umask is C<022>. This is important because it means that "
14626 "directories and device nodes will be created with C<0644> or C<0755> mode "
14627 "even if you specify C<0777>."
14631 #: ../src/guestfs-actions.pod:6338
14633 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14634 "C<guestfs_mkdir>."
14638 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4244
14639 msgid "This call returns the previous umask."
14643 #: ../src/guestfs-actions.pod:6347
14644 msgid "guestfs_umount"
14648 #: ../src/guestfs-actions.pod:6349
14652 " guestfs_umount (guestfs_h *g,\n"
14653 " const char *pathordevice);\n"
14658 #: ../src/guestfs-actions.pod:6353 ../fish/guestfish-actions.pod:4252
14660 "This unmounts the given filesystem. The filesystem may be specified either "
14661 "by its mountpoint (path) or the device which contains the filesystem."
14665 #: ../src/guestfs-actions.pod:6361
14666 msgid "guestfs_umount_all"
14670 #: ../src/guestfs-actions.pod:6363
14674 " guestfs_umount_all (guestfs_h *g);\n"
14679 #: ../src/guestfs-actions.pod:6366 ../fish/guestfish-actions.pod:4262
14680 msgid "This unmounts all mounted filesystems."
14684 #: ../src/guestfs-actions.pod:6368 ../fish/guestfish-actions.pod:4264
14685 msgid "Some internal mounts are not unmounted by this call."
14689 #: ../src/guestfs-actions.pod:6374
14690 msgid "guestfs_upload"
14694 #: ../src/guestfs-actions.pod:6376
14698 " guestfs_upload (guestfs_h *g,\n"
14699 " const char *filename,\n"
14700 " const char *remotefilename);\n"
14705 #: ../src/guestfs-actions.pod:6381 ../src/guestfs-actions.pod:6400 ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
14706 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14710 #: ../src/guestfs-actions.pod:6386
14711 msgid "See also C<guestfs_download>."
14715 #: ../src/guestfs-actions.pod:6392
14716 msgid "guestfs_upload_offset"
14720 #: ../src/guestfs-actions.pod:6394
14724 " guestfs_upload_offset (guestfs_h *g,\n"
14725 " const char *filename,\n"
14726 " const char *remotefilename,\n"
14727 " int64_t offset);\n"
14732 #: ../src/guestfs-actions.pod:6403 ../fish/guestfish-actions.pod:4286
14734 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14735 "The intention is to overwrite parts of existing files or devices, although "
14736 "if a non-existant file is specified then it is created with a \"hole\" "
14737 "before C<offset>. The size of the data written is implicit in the size of "
14738 "the source C<filename>."
14742 #: ../src/guestfs-actions.pod:6410
14744 "Note that there is no limit on the amount of data that can be uploaded with "
14745 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14746 "full amount unless an error occurs."
14750 #: ../src/guestfs-actions.pod:6415
14751 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14755 #: ../src/guestfs-actions.pod:6421
14756 msgid "guestfs_utimens"
14760 #: ../src/guestfs-actions.pod:6423
14764 " guestfs_utimens (guestfs_h *g,\n"
14765 " const char *path,\n"
14766 " int64_t atsecs,\n"
14767 " int64_t atnsecs,\n"
14768 " int64_t mtsecs,\n"
14769 " int64_t mtnsecs);\n"
14774 #: ../src/guestfs-actions.pod:6431 ../fish/guestfish-actions.pod:4306
14775 msgid "This command sets the timestamps of a file with nanosecond precision."
14779 #: ../src/guestfs-actions.pod:6434 ../fish/guestfish-actions.pod:4309
14781 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14786 #: ../src/guestfs-actions.pod:6437 ../fish/guestfish-actions.pod:4312
14788 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14789 "nanoseconds from the epoch."
14793 #: ../src/guestfs-actions.pod:6440 ../fish/guestfish-actions.pod:4315
14795 "If the C<*nsecs> field contains the special value C<-1> then the "
14796 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14797 "ignored in this case)."
14801 #: ../src/guestfs-actions.pod:6444 ../fish/guestfish-actions.pod:4319
14803 "If the C<*nsecs> field contains the special value C<-2> then the "
14804 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14809 #: ../src/guestfs-actions.pod:6452 ../src/guestfs-structs.pod:175
14810 msgid "guestfs_version"
14814 #: ../src/guestfs-actions.pod:6454
14817 " struct guestfs_version *\n"
14818 " guestfs_version (guestfs_h *g);\n"
14823 #: ../src/guestfs-actions.pod:6457 ../fish/guestfish-actions.pod:4327
14824 msgid "Return the libguestfs version number that the program is linked against."
14828 #: ../src/guestfs-actions.pod:6460 ../fish/guestfish-actions.pod:4330
14830 "Note that because of dynamic linking this is not necessarily the version of "
14831 "libguestfs that you compiled against. You can compile the program, and then "
14832 "at runtime dynamically link against a completely different C<libguestfs.so> "
14837 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4335
14839 "This call was added in version C<1.0.58>. In previous versions of "
14840 "libguestfs there was no way to get the version number. From C code you can "
14841 "use dynamic linker functions to find out if this symbol exists (if it "
14842 "doesn't, then it's an earlier version)."
14846 #: ../src/guestfs-actions.pod:6471 ../fish/guestfish-actions.pod:4341
14848 "The call returns a structure with four elements. The first three (C<major>, "
14849 "C<minor> and C<release>) are numbers and correspond to the usual version "
14850 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14851 "but may be used for distro-specific information."
14855 #: ../src/guestfs-actions.pod:6477 ../fish/guestfish-actions.pod:4347
14856 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14860 #: ../src/guestfs-actions.pod:6480 ../fish/guestfish-actions.pod:4350
14861 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14865 #: ../src/guestfs-actions.pod:6482
14867 "I<Note:> Don't use this call to test for availability of features. In "
14868 "enterprise distributions we backport features from later versions into "
14869 "earlier versions, making this an unreliable way to test for features. Use "
14870 "C<guestfs_available> instead."
14874 #: ../src/guestfs-actions.pod:6488
14876 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14877 "error. I<The caller must call C<guestfs_free_version> after use>."
14881 #: ../src/guestfs-actions.pod:6492
14882 msgid "(Added in 1.0.58)"
14886 #: ../src/guestfs-actions.pod:6494
14887 msgid "guestfs_vfs_label"
14891 #: ../src/guestfs-actions.pod:6496
14895 " guestfs_vfs_label (guestfs_h *g,\n"
14896 " const char *device);\n"
14901 #: ../src/guestfs-actions.pod:6500 ../fish/guestfish-actions.pod:4362
14902 msgid "This returns the filesystem label of the filesystem on C<device>."
14906 #: ../src/guestfs-actions.pod:6503 ../fish/guestfish-actions.pod:4365
14907 msgid "If the filesystem is unlabeled, this returns the empty string."
14911 #: ../src/guestfs-actions.pod:6505
14912 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14916 #: ../src/guestfs-actions.pod:6510 ../src/guestfs-actions.pod:6547
14917 msgid "(Added in 1.3.18)"
14921 #: ../src/guestfs-actions.pod:6512
14922 msgid "guestfs_vfs_type"
14926 #: ../src/guestfs-actions.pod:6514
14930 " guestfs_vfs_type (guestfs_h *g,\n"
14931 " const char *device);\n"
14936 #: ../src/guestfs-actions.pod:6518 ../fish/guestfish-actions.pod:4373
14938 "This command gets the filesystem type corresponding to the filesystem on "
14943 #: ../src/guestfs-actions.pod:6521 ../fish/guestfish-actions.pod:4376
14945 "For most filesystems, the result is the name of the Linux VFS module which "
14946 "would be used to mount this filesystem if you mounted it without specifying "
14947 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14951 #: ../src/guestfs-actions.pod:6531
14952 msgid "guestfs_vfs_uuid"
14956 #: ../src/guestfs-actions.pod:6533
14960 " guestfs_vfs_uuid (guestfs_h *g,\n"
14961 " const char *device);\n"
14966 #: ../src/guestfs-actions.pod:6537 ../fish/guestfish-actions.pod:4385
14967 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14971 #: ../src/guestfs-actions.pod:6540 ../fish/guestfish-actions.pod:4388
14972 msgid "If the filesystem does not have a UUID, this returns the empty string."
14976 #: ../src/guestfs-actions.pod:6542
14977 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14981 #: ../src/guestfs-actions.pod:6549
14982 msgid "guestfs_vg_activate"
14986 #: ../src/guestfs-actions.pod:6551
14990 " guestfs_vg_activate (guestfs_h *g,\n"
14992 " char *const *volgroups);\n"
14997 #: ../src/guestfs-actions.pod:6556 ../fish/guestfish-actions.pod:4396
14999 "This command activates or (if C<activate> is false) deactivates all logical "
15000 "volumes in the listed volume groups C<volgroups>. If activated, then they "
15001 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
15002 "deactivated, then those devices disappear."
15006 #: ../src/guestfs-actions.pod:6562 ../fish/guestfish-actions.pod:4402
15007 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
15011 #: ../src/guestfs-actions.pod:6564 ../fish/guestfish-actions.pod:4404
15013 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
15014 "activated or deactivated."
15018 #: ../src/guestfs-actions.pod:6571
15019 msgid "guestfs_vg_activate_all"
15023 #: ../src/guestfs-actions.pod:6573
15027 " guestfs_vg_activate_all (guestfs_h *g,\n"
15028 " int activate);\n"
15033 #: ../src/guestfs-actions.pod:6577 ../fish/guestfish-actions.pod:4411
15035 "This command activates or (if C<activate> is false) deactivates all logical "
15036 "volumes in all volume groups. If activated, then they are made known to the "
15037 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15038 "those devices disappear."
15042 #: ../src/guestfs-actions.pod:6583 ../fish/guestfish-actions.pod:4417
15043 msgid "This command is the same as running C<vgchange -a y|n>"
15047 #: ../src/guestfs-actions.pod:6589
15048 msgid "guestfs_vgcreate"
15052 #: ../src/guestfs-actions.pod:6591
15056 " guestfs_vgcreate (guestfs_h *g,\n"
15057 " const char *volgroup,\n"
15058 " char *const *physvols);\n"
15063 #: ../src/guestfs-actions.pod:6596 ../fish/guestfish-actions.pod:4423
15065 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15066 "of physical volumes C<physvols>."
15070 #: ../src/guestfs-actions.pod:6603
15071 msgid "guestfs_vglvuuids"
15075 #: ../src/guestfs-actions.pod:6605
15079 " guestfs_vglvuuids (guestfs_h *g,\n"
15080 " const char *vgname);\n"
15085 #: ../src/guestfs-actions.pod:6609 ../fish/guestfish-actions.pod:4430
15087 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15088 "volumes created in this volume group."
15092 #: ../src/guestfs-actions.pod:6612
15094 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15095 "associate logical volumes and volume groups."
15099 #: ../src/guestfs-actions.pod:6615
15100 msgid "See also C<guestfs_vgpvuuids>."
15104 #: ../src/guestfs-actions.pod:6623
15105 msgid "guestfs_vgpvuuids"
15109 #: ../src/guestfs-actions.pod:6625
15113 " guestfs_vgpvuuids (guestfs_h *g,\n"
15114 " const char *vgname);\n"
15119 #: ../src/guestfs-actions.pod:6629 ../fish/guestfish-actions.pod:4442
15121 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15122 "volumes that this volume group resides on."
15126 #: ../src/guestfs-actions.pod:6632
15128 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15129 "associate physical volumes and volume groups."
15133 #: ../src/guestfs-actions.pod:6635
15134 msgid "See also C<guestfs_vglvuuids>."
15138 #: ../src/guestfs-actions.pod:6643
15139 msgid "guestfs_vgremove"
15143 #: ../src/guestfs-actions.pod:6645
15147 " guestfs_vgremove (guestfs_h *g,\n"
15148 " const char *vgname);\n"
15153 #: ../src/guestfs-actions.pod:6649 ../fish/guestfish-actions.pod:4454
15154 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15158 #: ../src/guestfs-actions.pod:6651 ../fish/guestfish-actions.pod:4456
15159 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
15163 #: ../src/guestfs-actions.pod:6658
15164 msgid "guestfs_vgrename"
15168 #: ../src/guestfs-actions.pod:6660
15172 " guestfs_vgrename (guestfs_h *g,\n"
15173 " const char *volgroup,\n"
15174 " const char *newvolgroup);\n"
15179 #: ../src/guestfs-actions.pod:6665 ../fish/guestfish-actions.pod:4463
15180 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15184 #: ../src/guestfs-actions.pod:6671
15185 msgid "guestfs_vgs"
15189 #: ../src/guestfs-actions.pod:6673
15193 " guestfs_vgs (guestfs_h *g);\n"
15198 #: ../src/guestfs-actions.pod:6676 ../fish/guestfish-actions.pod:4469
15200 "List all the volumes groups detected. This is the equivalent of the "
15201 "L<vgs(8)> command."
15205 #: ../src/guestfs-actions.pod:6679 ../fish/guestfish-actions.pod:4472
15207 "This returns a list of just the volume group names that were detected "
15208 "(eg. C<VolGroup00>)."
15212 #: ../src/guestfs-actions.pod:6682
15213 msgid "See also C<guestfs_vgs_full>."
15217 #: ../src/guestfs-actions.pod:6690
15218 msgid "guestfs_vgs_full"
15222 #: ../src/guestfs-actions.pod:6692
15225 " struct guestfs_lvm_vg_list *\n"
15226 " guestfs_vgs_full (guestfs_h *g);\n"
15231 #: ../src/guestfs-actions.pod:6695 ../fish/guestfish-actions.pod:4481
15233 "List all the volumes groups detected. This is the equivalent of the "
15234 "L<vgs(8)> command. The \"full\" version includes all fields."
15238 #: ../src/guestfs-actions.pod:6698
15240 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15241 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
15246 #: ../src/guestfs-actions.pod:6704
15247 msgid "guestfs_vgscan"
15251 #: ../src/guestfs-actions.pod:6706
15255 " guestfs_vgscan (guestfs_h *g);\n"
15260 #: ../src/guestfs-actions.pod:6709 ../fish/guestfish-actions.pod:4488
15262 "This rescans all block devices and rebuilds the list of LVM physical "
15263 "volumes, volume groups and logical volumes."
15267 #: ../src/guestfs-actions.pod:6716
15268 msgid "guestfs_vguuid"
15272 #: ../src/guestfs-actions.pod:6718
15276 " guestfs_vguuid (guestfs_h *g,\n"
15277 " const char *vgname);\n"
15282 #: ../src/guestfs-actions.pod:6722 ../fish/guestfish-actions.pod:4495
15283 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15287 #: ../src/guestfs-actions.pod:6729
15288 msgid "guestfs_wait_ready"
15292 #: ../src/guestfs-actions.pod:6731
15296 " guestfs_wait_ready (guestfs_h *g);\n"
15301 #: ../src/guestfs-actions.pod:6734
15302 msgid "This function is a no op."
15306 #: ../src/guestfs-actions.pod:6736
15308 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15309 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15310 "is no longer necessary because C<guestfs_launch> now does the waiting."
15314 #: ../src/guestfs-actions.pod:6741
15316 "If you see any calls to this function in code then you can just remove them, "
15317 "unless you want to retain compatibility with older versions of the API."
15321 #: ../src/guestfs-actions.pod:6749
15322 msgid "guestfs_wc_c"
15326 #: ../src/guestfs-actions.pod:6751
15330 " guestfs_wc_c (guestfs_h *g,\n"
15331 " const char *path);\n"
15336 #: ../src/guestfs-actions.pod:6755 ../fish/guestfish-actions.pod:4501
15338 "This command counts the characters in a file, using the C<wc -c> external "
15343 #: ../src/guestfs-actions.pod:6762
15344 msgid "guestfs_wc_l"
15348 #: ../src/guestfs-actions.pod:6764
15352 " guestfs_wc_l (guestfs_h *g,\n"
15353 " const char *path);\n"
15358 #: ../src/guestfs-actions.pod:6768 ../fish/guestfish-actions.pod:4508
15360 "This command counts the lines in a file, using the C<wc -l> external "
15365 #: ../src/guestfs-actions.pod:6775
15366 msgid "guestfs_wc_w"
15370 #: ../src/guestfs-actions.pod:6777
15374 " guestfs_wc_w (guestfs_h *g,\n"
15375 " const char *path);\n"
15380 #: ../src/guestfs-actions.pod:6781 ../fish/guestfish-actions.pod:4515
15382 "This command counts the words in a file, using the C<wc -w> external "
15387 #: ../src/guestfs-actions.pod:6788
15388 msgid "guestfs_write"
15392 #: ../src/guestfs-actions.pod:6790
15396 " guestfs_write (guestfs_h *g,\n"
15397 " const char *path,\n"
15398 " const char *content,\n"
15399 " size_t content_size);\n"
15404 #: ../src/guestfs-actions.pod:6796 ../fish/guestfish-actions.pod:4522
15406 "This call creates a file called C<path>. The content of the file is the "
15407 "string C<content> (which can contain any 8 bit data)."
15411 #: ../src/guestfs-actions.pod:6806
15412 msgid "guestfs_write_file"
15416 #: ../src/guestfs-actions.pod:6808
15420 " guestfs_write_file (guestfs_h *g,\n"
15421 " const char *path,\n"
15422 " const char *content,\n"
15428 #: ../src/guestfs-actions.pod:6814 ../fish/guestfish-actions.pod:4532
15430 "This call creates a file called C<path>. The contents of the file is the "
15431 "string C<content> (which can contain any 8 bit data), with length C<size>."
15435 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4536
15437 "As a special case, if C<size> is C<0> then the length is calculated using "
15438 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15442 #: ../src/guestfs-actions.pod:6822 ../fish/guestfish-actions.pod:4540
15444 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15445 "I<not> work, even if the length is specified."
15449 #: ../src/guestfs-actions.pod:6830 ../fish/guestfish-actions.pod:4546
15450 msgid "This function is deprecated. In new code, use the C<write> call instead."
15454 #: ../src/guestfs-actions.pod:6839
15455 msgid "guestfs_zegrep"
15459 #: ../src/guestfs-actions.pod:6841
15463 " guestfs_zegrep (guestfs_h *g,\n"
15464 " const char *regex,\n"
15465 " const char *path);\n"
15470 #: ../src/guestfs-actions.pod:6846 ../fish/guestfish-actions.pod:4557
15471 msgid "This calls the external C<zegrep> program and returns the matching lines."
15475 #: ../src/guestfs-actions.pod:6858
15476 msgid "guestfs_zegrepi"
15480 #: ../src/guestfs-actions.pod:6860
15484 " guestfs_zegrepi (guestfs_h *g,\n"
15485 " const char *regex,\n"
15486 " const char *path);\n"
15491 #: ../src/guestfs-actions.pod:6865 ../fish/guestfish-actions.pod:4567
15492 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15496 #: ../src/guestfs-actions.pod:6877
15497 msgid "guestfs_zero"
15501 #: ../src/guestfs-actions.pod:6879
15505 " guestfs_zero (guestfs_h *g,\n"
15506 " const char *device);\n"
15511 #: ../src/guestfs-actions.pod:6883 ../fish/guestfish-actions.pod:4577
15512 msgid "This command writes zeroes over the first few blocks of C<device>."
15516 #: ../src/guestfs-actions.pod:6885 ../fish/guestfish-actions.pod:4579
15518 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15519 "securely wipe the device). It should be sufficient to remove any partition "
15520 "tables, filesystem superblocks and so on."
15524 #: ../src/guestfs-actions.pod:6889
15525 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15529 #: ../src/guestfs-actions.pod:6900
15530 msgid "guestfs_zero_device"
15534 #: ../src/guestfs-actions.pod:6902
15538 " guestfs_zero_device (guestfs_h *g,\n"
15539 " const char *device);\n"
15544 #: ../src/guestfs-actions.pod:6906
15546 "This command writes zeroes over the entire C<device>. Compare with "
15547 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15551 #: ../src/guestfs-actions.pod:6920
15552 msgid "(Added in 1.3.1)"
15556 #: ../src/guestfs-actions.pod:6922
15557 msgid "guestfs_zerofree"
15561 #: ../src/guestfs-actions.pod:6924
15565 " guestfs_zerofree (guestfs_h *g,\n"
15566 " const char *device);\n"
15571 #: ../src/guestfs-actions.pod:6928 ../fish/guestfish-actions.pod:4600
15573 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15574 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15575 "possible to compress the filesystem more effectively."
15579 #: ../src/guestfs-actions.pod:6933 ../fish/guestfish-actions.pod:4605
15580 msgid "You should B<not> run this program if the filesystem is mounted."
15584 #: ../src/guestfs-actions.pod:6936 ../fish/guestfish-actions.pod:4608
15586 "It is possible that using this program can damage the filesystem or data on "
15591 #: ../src/guestfs-actions.pod:6943
15592 msgid "guestfs_zfgrep"
15596 #: ../src/guestfs-actions.pod:6945
15600 " guestfs_zfgrep (guestfs_h *g,\n"
15601 " const char *pattern,\n"
15602 " const char *path);\n"
15607 #: ../src/guestfs-actions.pod:6950 ../fish/guestfish-actions.pod:4615
15608 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15612 #: ../src/guestfs-actions.pod:6962
15613 msgid "guestfs_zfgrepi"
15617 #: ../src/guestfs-actions.pod:6964
15621 " guestfs_zfgrepi (guestfs_h *g,\n"
15622 " const char *pattern,\n"
15623 " const char *path);\n"
15628 #: ../src/guestfs-actions.pod:6969 ../fish/guestfish-actions.pod:4625
15629 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15633 #: ../src/guestfs-actions.pod:6981
15634 msgid "guestfs_zfile"
15638 #: ../src/guestfs-actions.pod:6983
15642 " guestfs_zfile (guestfs_h *g,\n"
15643 " const char *meth,\n"
15644 " const char *path);\n"
15649 #: ../src/guestfs-actions.pod:6988 ../fish/guestfish-actions.pod:4635
15650 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15654 #: ../src/guestfs-actions.pod:6991 ../fish/guestfish-actions.pod:4638
15655 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15659 #: ../src/guestfs-actions.pod:6993
15661 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15666 #: ../src/guestfs-actions.pod:6999 ../fish/guestfish-actions.pod:4643
15667 msgid "This function is deprecated. In new code, use the C<file> call instead."
15671 #: ../src/guestfs-actions.pod:7008
15672 msgid "guestfs_zgrep"
15676 #: ../src/guestfs-actions.pod:7010
15680 " guestfs_zgrep (guestfs_h *g,\n"
15681 " const char *regex,\n"
15682 " const char *path);\n"
15687 #: ../src/guestfs-actions.pod:7015 ../fish/guestfish-actions.pod:4654
15688 msgid "This calls the external C<zgrep> program and returns the matching lines."
15692 #: ../src/guestfs-actions.pod:7027
15693 msgid "guestfs_zgrepi"
15697 #: ../src/guestfs-actions.pod:7029
15701 " guestfs_zgrepi (guestfs_h *g,\n"
15702 " const char *regex,\n"
15703 " const char *path);\n"
15708 #: ../src/guestfs-actions.pod:7034 ../fish/guestfish-actions.pod:4664
15709 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15713 #: ../src/guestfs-availability.pod:3
15718 #: ../src/guestfs-availability.pod:5
15720 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15721 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15722 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15723 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15724 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15728 #: ../src/guestfs-availability.pod:21
15733 #: ../src/guestfs-availability.pod:23
15735 "The following functions: L</guestfs_inotify_add_watch> "
15736 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15737 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15741 #: ../src/guestfs-availability.pod:31
15742 msgid "B<linuxfsuuid>"
15746 #: ../src/guestfs-availability.pod:33
15748 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15749 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15753 #: ../src/guestfs-availability.pod:40
15754 msgid "B<linuxmodules>"
15758 #: ../src/guestfs-availability.pod:42
15759 msgid "The following functions: L</guestfs_modprobe>"
15763 #: ../src/guestfs-availability.pod:45
15764 msgid "B<linuxxattrs>"
15768 #: ../src/guestfs-availability.pod:47
15770 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15771 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15772 "L</guestfs_removexattr> L</guestfs_setxattr>"
15776 #: ../src/guestfs-availability.pod:56
15781 #: ../src/guestfs-availability.pod:58
15783 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15784 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15785 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15789 #: ../src/guestfs-availability.pod:67
15794 #: ../src/guestfs-availability.pod:69
15796 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15797 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15798 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15799 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15800 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15801 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15802 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15803 "L</guestfs_vgs_full>"
15807 #: ../src/guestfs-availability.pod:92
15812 #: ../src/guestfs-availability.pod:94
15814 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15815 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15819 #: ../src/guestfs-availability.pod:100
15824 #: ../src/guestfs-availability.pod:102
15825 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15829 #: ../src/guestfs-availability.pod:105
15830 msgid "B<ntfsprogs>"
15834 #: ../src/guestfs-availability.pod:107
15835 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15839 #: ../src/guestfs-availability.pod:111
15840 msgid "B<realpath>"
15844 #: ../src/guestfs-availability.pod:113
15845 msgid "The following functions: L</guestfs_realpath>"
15849 #: ../src/guestfs-availability.pod:116
15854 #: ../src/guestfs-availability.pod:118
15856 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15857 "L</guestfs_scrub_freespace>"
15861 #: ../src/guestfs-availability.pod:123
15866 #: ../src/guestfs-availability.pod:125
15867 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15871 #: ../src/guestfs-availability.pod:129
15876 #: ../src/guestfs-availability.pod:131
15877 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15881 #: ../src/guestfs-availability.pod:135
15882 msgid "B<zerofree>"
15886 #: ../src/guestfs-availability.pod:137
15887 msgid "The following functions: L</guestfs_zerofree>"
15891 #: ../src/guestfs-structs.pod:1
15892 msgid "guestfs_int_bool"
15896 #: ../src/guestfs-structs.pod:3
15899 " struct guestfs_int_bool {\n"
15907 #: ../src/guestfs-structs.pod:8
15910 " struct guestfs_int_bool_list {\n"
15911 " uint32_t len; /* Number of elements in list. */\n"
15912 " struct guestfs_int_bool *val; /* Elements. */\n"
15918 #: ../src/guestfs-structs.pod:13
15921 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15922 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15927 #: ../src/guestfs-structs.pod:16
15928 msgid "guestfs_lvm_pv"
15932 #: ../src/guestfs-structs.pod:18
15935 " struct guestfs_lvm_pv {\n"
15936 " char *pv_name;\n"
15937 " /* The next field is NOT nul-terminated, be careful when printing it: "
15939 " char pv_uuid[32];\n"
15941 " uint64_t pv_size;\n"
15942 " uint64_t dev_size;\n"
15943 " uint64_t pv_free;\n"
15944 " uint64_t pv_used;\n"
15945 " char *pv_attr;\n"
15946 " int64_t pv_pe_count;\n"
15947 " int64_t pv_pe_alloc_count;\n"
15948 " char *pv_tags;\n"
15949 " uint64_t pe_start;\n"
15950 " int64_t pv_mda_count;\n"
15951 " uint64_t pv_mda_free;\n"
15957 #: ../src/guestfs-structs.pod:36
15960 " struct guestfs_lvm_pv_list {\n"
15961 " uint32_t len; /* Number of elements in list. */\n"
15962 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15968 #: ../src/guestfs-structs.pod:41
15971 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15972 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15977 #: ../src/guestfs-structs.pod:44
15978 msgid "guestfs_lvm_vg"
15982 #: ../src/guestfs-structs.pod:46
15985 " struct guestfs_lvm_vg {\n"
15986 " char *vg_name;\n"
15987 " /* The next field is NOT nul-terminated, be careful when printing it: "
15989 " char vg_uuid[32];\n"
15991 " char *vg_attr;\n"
15992 " uint64_t vg_size;\n"
15993 " uint64_t vg_free;\n"
15994 " char *vg_sysid;\n"
15995 " uint64_t vg_extent_size;\n"
15996 " int64_t vg_extent_count;\n"
15997 " int64_t vg_free_count;\n"
15998 " int64_t max_lv;\n"
15999 " int64_t max_pv;\n"
16000 " int64_t pv_count;\n"
16001 " int64_t lv_count;\n"
16002 " int64_t snap_count;\n"
16003 " int64_t vg_seqno;\n"
16004 " char *vg_tags;\n"
16005 " int64_t vg_mda_count;\n"
16006 " uint64_t vg_mda_free;\n"
16012 #: ../src/guestfs-structs.pod:69
16015 " struct guestfs_lvm_vg_list {\n"
16016 " uint32_t len; /* Number of elements in list. */\n"
16017 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16023 #: ../src/guestfs-structs.pod:74
16026 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16027 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16032 #: ../src/guestfs-structs.pod:77
16033 msgid "guestfs_lvm_lv"
16037 #: ../src/guestfs-structs.pod:79
16040 " struct guestfs_lvm_lv {\n"
16041 " char *lv_name;\n"
16042 " /* The next field is NOT nul-terminated, be careful when printing it: "
16044 " char lv_uuid[32];\n"
16045 " char *lv_attr;\n"
16046 " int64_t lv_major;\n"
16047 " int64_t lv_minor;\n"
16048 " int64_t lv_kernel_major;\n"
16049 " int64_t lv_kernel_minor;\n"
16050 " uint64_t lv_size;\n"
16051 " int64_t seg_count;\n"
16053 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16054 " float snap_percent;\n"
16055 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16056 " float copy_percent;\n"
16057 " char *move_pv;\n"
16058 " char *lv_tags;\n"
16059 " char *mirror_log;\n"
16060 " char *modules;\n"
16066 #: ../src/guestfs-structs.pod:101
16069 " struct guestfs_lvm_lv_list {\n"
16070 " uint32_t len; /* Number of elements in list. */\n"
16071 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16077 #: ../src/guestfs-structs.pod:106
16080 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16081 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16086 #: ../src/guestfs-structs.pod:111
16089 " struct guestfs_stat {\n"
16093 " int64_t nlink;\n"
16098 " int64_t blksize;\n"
16099 " int64_t blocks;\n"
16100 " int64_t atime;\n"
16101 " int64_t mtime;\n"
16102 " int64_t ctime;\n"
16108 #: ../src/guestfs-structs.pod:127
16111 " struct guestfs_stat_list {\n"
16112 " uint32_t len; /* Number of elements in list. */\n"
16113 " struct guestfs_stat *val; /* Elements. */\n"
16119 #: ../src/guestfs-structs.pod:132
16122 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16123 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16128 #: ../src/guestfs-structs.pod:137
16131 " struct guestfs_statvfs {\n"
16132 " int64_t bsize;\n"
16133 " int64_t frsize;\n"
16134 " int64_t blocks;\n"
16135 " int64_t bfree;\n"
16136 " int64_t bavail;\n"
16137 " int64_t files;\n"
16138 " int64_t ffree;\n"
16139 " int64_t favail;\n"
16142 " int64_t namemax;\n"
16148 #: ../src/guestfs-structs.pod:151
16151 " struct guestfs_statvfs_list {\n"
16152 " uint32_t len; /* Number of elements in list. */\n"
16153 " struct guestfs_statvfs *val; /* Elements. */\n"
16159 #: ../src/guestfs-structs.pod:156
16162 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16163 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16168 #: ../src/guestfs-structs.pod:159
16169 msgid "guestfs_dirent"
16173 #: ../src/guestfs-structs.pod:161
16176 " struct guestfs_dirent {\n"
16185 #: ../src/guestfs-structs.pod:167
16188 " struct guestfs_dirent_list {\n"
16189 " uint32_t len; /* Number of elements in list. */\n"
16190 " struct guestfs_dirent *val; /* Elements. */\n"
16196 #: ../src/guestfs-structs.pod:172
16199 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16200 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16205 #: ../src/guestfs-structs.pod:177
16208 " struct guestfs_version {\n"
16209 " int64_t major;\n"
16210 " int64_t minor;\n"
16211 " int64_t release;\n"
16218 #: ../src/guestfs-structs.pod:184
16221 " struct guestfs_version_list {\n"
16222 " uint32_t len; /* Number of elements in list. */\n"
16223 " struct guestfs_version *val; /* Elements. */\n"
16229 #: ../src/guestfs-structs.pod:189
16232 " void guestfs_free_version (struct guestfs_free_version *);\n"
16233 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16238 #: ../src/guestfs-structs.pod:192
16239 msgid "guestfs_xattr"
16243 #: ../src/guestfs-structs.pod:194
16246 " struct guestfs_xattr {\n"
16247 " char *attrname;\n"
16248 " /* The next two fields describe a byte array. */\n"
16249 " uint32_t attrval_len;\n"
16250 " char *attrval;\n"
16256 #: ../src/guestfs-structs.pod:201
16259 " struct guestfs_xattr_list {\n"
16260 " uint32_t len; /* Number of elements in list. */\n"
16261 " struct guestfs_xattr *val; /* Elements. */\n"
16267 #: ../src/guestfs-structs.pod:206
16270 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16271 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16276 #: ../src/guestfs-structs.pod:209
16277 msgid "guestfs_inotify_event"
16281 #: ../src/guestfs-structs.pod:211
16284 " struct guestfs_inotify_event {\n"
16285 " int64_t in_wd;\n"
16286 " uint32_t in_mask;\n"
16287 " uint32_t in_cookie;\n"
16288 " char *in_name;\n"
16294 #: ../src/guestfs-structs.pod:218
16297 " struct guestfs_inotify_event_list {\n"
16298 " uint32_t len; /* Number of elements in list. */\n"
16299 " struct guestfs_inotify_event *val; /* Elements. */\n"
16305 #: ../src/guestfs-structs.pod:223
16308 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16309 " void guestfs_free_inotify_event_list (struct "
16310 "guestfs_free_inotify_event_list *);\n"
16315 #: ../src/guestfs-structs.pod:226
16316 msgid "guestfs_partition"
16320 #: ../src/guestfs-structs.pod:228
16323 " struct guestfs_partition {\n"
16324 " int32_t part_num;\n"
16325 " uint64_t part_start;\n"
16326 " uint64_t part_end;\n"
16327 " uint64_t part_size;\n"
16333 #: ../src/guestfs-structs.pod:235
16336 " struct guestfs_partition_list {\n"
16337 " uint32_t len; /* Number of elements in list. */\n"
16338 " struct guestfs_partition *val; /* Elements. */\n"
16344 #: ../src/guestfs-structs.pod:240
16347 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16348 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16353 #: ../src/guestfs-structs.pod:243
16354 msgid "guestfs_application"
16358 #: ../src/guestfs-structs.pod:245
16361 " struct guestfs_application {\n"
16362 " char *app_name;\n"
16363 " char *app_display_name;\n"
16364 " int32_t app_epoch;\n"
16365 " char *app_version;\n"
16366 " char *app_release;\n"
16367 " char *app_install_path;\n"
16368 " char *app_trans_path;\n"
16369 " char *app_publisher;\n"
16370 " char *app_url;\n"
16371 " char *app_source_package;\n"
16372 " char *app_summary;\n"
16373 " char *app_description;\n"
16379 #: ../src/guestfs-structs.pod:260
16382 " struct guestfs_application_list {\n"
16383 " uint32_t len; /* Number of elements in list. */\n"
16384 " struct guestfs_application *val; /* Elements. */\n"
16390 #: ../src/guestfs-structs.pod:265
16393 " void guestfs_free_application (struct guestfs_free_application *);\n"
16394 " void guestfs_free_application_list (struct guestfs_free_application_list "
16400 #: ../fish/guestfish.pod:5
16401 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16405 #: ../fish/guestfish.pod:9
16408 " guestfish [--options] [commands]\n"
16413 #: ../fish/guestfish.pod:11
16421 #: ../fish/guestfish.pod:13
16424 " guestfish [--ro|--rw] -a disk.img\n"
16429 #: ../fish/guestfish.pod:15
16432 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16437 #: ../fish/guestfish.pod:17
16440 " guestfish -d libvirt-domain\n"
16445 #: ../fish/guestfish.pod:19
16448 " guestfish [--ro|--rw] -a disk.img -i\n"
16453 #: ../fish/guestfish.pod:21
16456 " guestfish -d libvirt-domain -i\n"
16461 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59
16466 #: ../fish/guestfish.pod:25
16468 "Using guestfish in read/write mode on live virtual machines can be "
16469 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16470 "option to use guestfish safely if the disk image or virtual machine might be "
16475 #: ../fish/guestfish.pod:32
16477 "Guestfish is a shell and command-line tool for examining and modifying "
16478 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16479 "functionality of the guestfs API, see L<guestfs(3)>."
16483 #: ../fish/guestfish.pod:36
16485 "Guestfish gives you structured access to the libguestfs API, from shell "
16486 "scripts or the command line or interactively. If you want to rescue a "
16487 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16492 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:847 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:64 ../tools/virt-tar.pl:45
16497 #: ../fish/guestfish.pod:43
16498 msgid "As an interactive shell"
16502 #: ../fish/guestfish.pod:45
16510 #: ../fish/guestfish.pod:47
16513 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16514 " editing virtual machine filesystems.\n"
16519 #: ../fish/guestfish.pod:50
16522 " Type: 'help' for a list of commands\n"
16523 " 'man' to read the manual\n"
16524 " 'quit' to quit the shell\n"
16529 #: ../fish/guestfish.pod:54
16532 " ><fs> add-ro disk.img\n"
16534 " ><fs> list-filesystems\n"
16535 " /dev/sda1: ext4\n"
16536 " /dev/vg_guest/lv_root: ext4\n"
16537 " /dev/vg_guest/lv_swap: swap\n"
16538 " ><fs> mount /dev/vg_guest/lv_root /\n"
16539 " ><fs> cat /etc/fstab\n"
16541 " # Created by anaconda\n"
16548 #: ../fish/guestfish.pod:67
16549 msgid "From shell scripts"
16553 #: ../fish/guestfish.pod:69
16554 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16558 #: ../fish/guestfish.pod:71
16561 " guestfish <<_EOF_\n"
16564 " mount /dev/vg_guest/lv_root /\n"
16565 " write /etc/motd \"Welcome, new users\"\n"
16571 #: ../fish/guestfish.pod:78
16572 msgid "List the LVM logical volumes in a disk image:"
16576 #: ../fish/guestfish.pod:80
16579 " guestfish -a disk.img --ro <<_EOF_\n"
16587 #: ../fish/guestfish.pod:85
16588 msgid "List all the filesystems in a disk image:"
16592 #: ../fish/guestfish.pod:87
16595 " guestfish -a disk.img --ro <<_EOF_\n"
16597 " list-filesystems\n"
16603 #: ../fish/guestfish.pod:92
16604 msgid "On one command line"
16608 #: ../fish/guestfish.pod:94
16609 msgid "Update C</etc/resolv.conf> in a guest:"
16613 #: ../fish/guestfish.pod:96
16617 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16618 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16623 #: ../fish/guestfish.pod:100
16624 msgid "Edit C</boot/grub/grub.conf> interactively:"
16628 #: ../fish/guestfish.pod:102
16631 " guestfish --rw --add disk.img \\\n"
16632 " --mount /dev/vg_guest/lv_root \\\n"
16633 " --mount /dev/sda1:/boot \\\n"
16634 " edit /boot/grub/grub.conf\n"
16639 #: ../fish/guestfish.pod:107
16640 msgid "Mount disks automatically"
16644 #: ../fish/guestfish.pod:109
16646 "Use the I<-i> option to automatically mount the disks from a virtual "
16651 #: ../fish/guestfish.pod:112
16654 " guestfish --ro -a disk.img -i cat /etc/group\n"
16659 #: ../fish/guestfish.pod:114
16662 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16667 #: ../fish/guestfish.pod:116
16668 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16672 #: ../fish/guestfish.pod:118
16675 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16680 #: ../fish/guestfish.pod:120
16681 msgid "As a script interpreter"
16685 #: ../fish/guestfish.pod:122
16686 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16690 #: ../fish/guestfish.pod:124
16693 " #!/usr/bin/guestfish -f\n"
16694 " sparse test1.img 100M\n"
16696 " part-disk /dev/sda mbr\n"
16697 " mkfs ext2 /dev/sda1\n"
16702 #: ../fish/guestfish.pod:130
16703 msgid "Start with a prepared disk"
16707 #: ../fish/guestfish.pod:132
16709 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16710 "single ext2-formatted partition:"
16714 #: ../fish/guestfish.pod:135
16717 " guestfish -N fs\n"
16722 #: ../fish/guestfish.pod:137
16723 msgid "To list what is available do:"
16727 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:838
16730 " guestfish -N help | less\n"
16735 #: ../fish/guestfish.pod:141
16736 msgid "Remote control"
16740 #: ../fish/guestfish.pod:143
16743 " eval \"`guestfish --listen`\"\n"
16744 " guestfish --remote add-ro disk.img\n"
16745 " guestfish --remote run\n"
16746 " guestfish --remote lvs\n"
16751 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171 ../tools/virt-resize.pl:254 ../tools/virt-list-filesystems.pl:53 ../tools/virt-tar.pl:98 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:54
16756 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179 ../tools/virt-resize.pl:262 ../tools/virt-list-filesystems.pl:61 ../tools/virt-tar.pl:106 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:62
16761 #: ../fish/guestfish.pod:154
16762 msgid "Displays general help on options."
16766 #: ../fish/guestfish.pod:156
16767 msgid "B<-h> | B<--cmd-help>"
16771 #: ../fish/guestfish.pod:158
16772 msgid "Lists all available guestfish commands."
16776 #: ../fish/guestfish.pod:160
16777 msgid "B<-h cmd> | B<--cmd-help cmd>"
16781 #: ../fish/guestfish.pod:162
16782 msgid "Displays detailed help on a single command C<cmd>."
16786 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16787 msgid "B<-a image> | B<--add image>"
16791 #: ../fish/guestfish.pod:166
16792 msgid "Add a block device or virtual machine image to the shell."
16796 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16798 "The format of the disk image is auto-detected. To override this and force a "
16799 "particular format use the I<--format=..> option."
16803 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16804 msgid "B<-c URI> | B<--connect URI>"
16808 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16810 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16811 "URI to use. The default is to use the default libvirt connection."
16815 #: ../fish/guestfish.pod:177
16820 #: ../fish/guestfish.pod:179
16822 "If using the I<--listen> option and a csh-like shell, use this option. See "
16823 "section L</REMOTE CONTROL AND CSH> below."
16827 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16828 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16832 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16834 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16835 "used, then any libvirt domain can be used. However in write mode, only "
16836 "libvirt domains which are shut down can be named here."
16840 #: ../fish/guestfish.pod:188
16841 msgid "B<-D> | B<--no-dest-paths>"
16845 #: ../fish/guestfish.pod:190
16847 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16848 "to hit the tab key to complete paths on the guest filesystem, but this "
16849 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16850 "allow this feature to be disabled."
16854 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16855 msgid "B<--echo-keys>"
16859 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16861 "When prompting for keys and passphrases, guestfish normally turns echoing "
16862 "off so you cannot see what you are typing. If you are not worried about "
16863 "Tempest attacks and there is no one else in the room you can specify this "
16864 "flag to see what you are typing."
16868 #: ../fish/guestfish.pod:202
16869 msgid "B<-f file> | B<--file file>"
16873 #: ../fish/guestfish.pod:204
16874 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16878 #: ../fish/guestfish.pod:207
16881 " #!/usr/bin/guestfish -f\n"
16886 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16887 msgid "B<--format=raw|qcow2|..> | B<--format>"
16891 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16893 "The default for the I<-a> option is to auto-detect the format of the disk "
16894 "image. Using this forces the disk format for I<-a> options which follow on "
16895 "the command line. Using I<--format> with no argument switches back to "
16896 "auto-detection for subsequent I<-a> options."
16900 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:544
16901 msgid "For example:"
16905 #: ../fish/guestfish.pod:218
16908 " guestfish --format=raw -a disk.img\n"
16913 #: ../fish/guestfish.pod:220
16914 msgid "forces raw format (no auto-detection) for C<disk.img>."
16918 #: ../fish/guestfish.pod:222
16921 " guestfish --format=raw -a disk.img --format -a another.img\n"
16926 #: ../fish/guestfish.pod:224
16928 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
16929 "auto-detection for C<another.img>."
16933 #: ../fish/guestfish.pod:227
16935 "If you have untrusted raw-format guest disk images, you should use this "
16936 "option to specify the disk format. This avoids a possible security problem "
16937 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16941 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16942 msgid "B<-i> | B<--inspector>"
16946 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16948 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16949 "system and mount filesystems as they would be mounted on the real virtual "
16954 #: ../fish/guestfish.pod:238
16955 msgid "Typical usage is either:"
16959 #: ../fish/guestfish.pod:240
16962 " guestfish -d myguest -i\n"
16967 #: ../fish/guestfish.pod:242
16968 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16972 #: ../fish/guestfish.pod:244
16975 " guestfish --ro -d myguest -i\n"
16980 #: ../fish/guestfish.pod:246
16981 msgid "(for active domains, readonly), or specify the block device directly:"
16985 #: ../fish/guestfish.pod:248
16988 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16993 #: ../fish/guestfish.pod:250
16995 "Note that the command line syntax changed slightly over older versions of "
16996 "guestfish. You can still use the old syntax:"
17000 #: ../fish/guestfish.pod:253
17003 " guestfish [--ro] -i disk.img\n"
17008 #: ../fish/guestfish.pod:255
17011 " guestfish [--ro] -i libvirt-domain\n"
17016 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
17017 msgid "B<--keys-from-stdin>"
17021 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17023 "Read key or passphrase parameters from stdin. The default is to try to read "
17024 "passphrases from the user by opening C</dev/tty>."
17028 #: ../fish/guestfish.pod:262
17029 msgid "B<--listen>"
17033 #: ../fish/guestfish.pod:264
17035 "Fork into the background and listen for remote commands. See section "
17036 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17040 #: ../fish/guestfish.pod:267
17041 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17045 #: ../fish/guestfish.pod:269
17046 msgid "Mount the named partition or logical volume on the given mountpoint."
17050 #: ../fish/guestfish.pod:271
17051 msgid "If the mountpoint is omitted, it defaults to C</>."
17055 #: ../fish/guestfish.pod:273
17056 msgid "You have to mount something on C</> before most commands will work."
17060 #: ../fish/guestfish.pod:275
17062 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17067 #: ../fish/guestfish.pod:278
17069 "If you don't know what filesystems a disk image contains, you can either run "
17070 "guestfish without this option, then list the partitions, filesystems and LVs "
17071 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
17072 "commands), or you can use the L<virt-filesystems(1)> program."
17076 #: ../fish/guestfish.pod:284 ../fuse/guestmount.pod:154
17077 msgid "B<-n> | B<--no-sync>"
17081 #: ../fish/guestfish.pod:286
17083 "Disable autosync. This is enabled by default. See the discussion of "
17084 "autosync in the L<guestfs(3)> manpage."
17088 #: ../fish/guestfish.pod:289
17089 msgid "B<-N type> | B<--new type> | B<-N help>"
17093 #: ../fish/guestfish.pod:291
17095 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17096 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17097 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17102 #: ../fish/guestfish.pod:296
17103 msgid "B<--progress-bars>"
17107 #: ../fish/guestfish.pod:298
17108 msgid "Enable progress bars, even when guestfish is used non-interactively."
17112 #: ../fish/guestfish.pod:300
17114 "Progress bars are enabled by default when guestfish is used as an "
17115 "interactive shell."
17119 #: ../fish/guestfish.pod:303
17120 msgid "B<--no-progress-bars>"
17124 #: ../fish/guestfish.pod:305
17125 msgid "Disable progress bars."
17129 #: ../fish/guestfish.pod:307
17130 msgid "B<--remote[=pid]>"
17134 #: ../fish/guestfish.pod:309
17136 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17137 "CONTROL GUESTFISH OVER A SOCKET> below."
17141 #: ../fish/guestfish.pod:312 ../fuse/guestmount.pod:196
17142 msgid "B<-r> | B<--ro>"
17146 #: ../fish/guestfish.pod:314
17148 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17149 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17153 #: ../fish/guestfish.pod:317
17155 "The option must always be used if the disk image or virtual machine might be "
17156 "running, and is generally recommended in cases where you don't need write "
17157 "access to the disk."
17161 #: ../fish/guestfish.pod:321
17163 "Note that prepared disk images created with I<-N> are not affected by the "
17168 #: ../fish/guestfish.pod:324
17169 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17173 #: ../fish/guestfish.pod:326 ../fuse/guestmount.pod:208
17174 msgid "B<--selinux>"
17178 #: ../fish/guestfish.pod:328
17179 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17183 #: ../fish/guestfish.pod:330 ../fuse/guestmount.pod:212
17184 msgid "B<-v> | B<--verbose>"
17188 #: ../fish/guestfish.pod:332
17190 "Enable very verbose messages. This is particularly useful if you find a "
17195 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:216
17196 msgid "B<-V> | B<--version>"
17200 #: ../fish/guestfish.pod:337
17201 msgid "Display the guestfish / libguestfs version number and exit."
17205 #: ../fish/guestfish.pod:339 ../fuse/guestmount.pod:220
17206 msgid "B<-w> | B<--rw>"
17210 #: ../fish/guestfish.pod:341
17212 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17217 #: ../fish/guestfish.pod:344
17222 #: ../fish/guestfish.pod:346
17223 msgid "Echo each command before executing it."
17227 #: ../fish/guestfish.pod:350
17228 msgid "COMMANDS ON COMMAND LINE"
17232 #: ../fish/guestfish.pod:352
17233 msgid "Any additional (non-option) arguments are treated as commands to execute."
17237 #: ../fish/guestfish.pod:355
17239 "Commands to execute should be separated by a colon (C<:>), where the colon "
17240 "is a separate parameter. Thus:"
17244 #: ../fish/guestfish.pod:358
17247 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17252 #: ../fish/guestfish.pod:360
17254 "If there are no additional arguments, then we enter a shell, either an "
17255 "interactive shell with a prompt (if the input is a terminal) or a "
17256 "non-interactive shell."
17260 #: ../fish/guestfish.pod:364
17262 "In either command line mode or non-interactive shell, the first command that "
17263 "gives an error causes the whole shell to exit. In interactive mode (with a "
17264 "prompt) if a command fails, you can continue to enter commands."
17268 #: ../fish/guestfish.pod:369
17269 msgid "USING launch (OR run)"
17273 #: ../fish/guestfish.pod:371
17275 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17276 "then launch it, then mount any disks you need, and finally issue "
17277 "actions/commands. So the general order of the day is:"
17281 #: ../fish/guestfish.pod:379
17282 msgid "add or -a/--add"
17286 #: ../fish/guestfish.pod:383
17287 msgid "launch (aka run)"
17291 #: ../fish/guestfish.pod:387
17292 msgid "mount or -m/--mount"
17296 #: ../fish/guestfish.pod:391
17297 msgid "any other commands"
17301 #: ../fish/guestfish.pod:395
17303 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17304 "guest before mounting or performing any other commands."
17308 #: ../fish/guestfish.pod:398
17310 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17311 "I<--new> options were given then C<run> is done automatically, simply "
17312 "because guestfish can't perform the action you asked for without doing this."
17316 #: ../fish/guestfish.pod:403
17317 msgid "OPENING DISKS FOR READ AND WRITE"
17321 #: ../fish/guestfish.pod:405
17323 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17324 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17325 "open disk images read-only or for writing."
17329 #: ../fish/guestfish.pod:409
17331 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17332 "disk images supplied on the command line for write. To open a disk image "
17333 "read-only you have to do I<-a image --ro>."
17337 #: ../fish/guestfish.pod:413
17339 "This matters: If you accidentally open a live VM disk image writable then "
17340 "you will cause irreversible disk corruption."
17344 #: ../fish/guestfish.pod:416
17346 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17347 "images will be opened read-only. You will have to either specify "
17348 "I<guestfish --rw> or change a configuration file in order to get write "
17349 "access for disk images specified by those other command line options."
17353 #: ../fish/guestfish.pod:421
17355 "This version of guestfish has a I<--rw> option which does nothing (it is "
17356 "already the default). However it is highly recommended that you use this "
17357 "option to indicate that guestfish needs write access, and to prepare your "
17358 "scripts for the day when this option will be required for write access."
17362 #: ../fish/guestfish.pod:427
17364 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17365 "other libguestfs program apart from guestfish and guestmount."
17369 #: ../fish/guestfish.pod:430
17374 #: ../fish/guestfish.pod:432
17376 "You can quote ordinary parameters using either single or double quotes. For "
17381 #: ../fish/guestfish.pod:435
17384 " add \"file with a space.img\"\n"
17389 #: ../fish/guestfish.pod:437
17392 " rm '/file name'\n"
17397 #: ../fish/guestfish.pod:439
17405 #: ../fish/guestfish.pod:441
17407 "A few commands require a list of strings to be passed. For these, use a "
17408 "whitespace-separated list, enclosed in quotes. Strings containing "
17409 "whitespace to be passed through must be enclosed in single quotes. A "
17410 "literal single quote must be escaped with a backslash."
17414 #: ../fish/guestfish.pod:446
17417 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17418 " command \"/bin/echo 'foo bar'\"\n"
17419 " command \"/bin/echo \\'foo\\'\"\n"
17424 #: ../fish/guestfish.pod:450
17425 msgid "OPTIONAL ARGUMENTS"
17429 #: ../fish/guestfish.pod:452
17431 "Some commands take optional arguments. These arguments appear in this "
17432 "documentation as C<[argname:..]>. You can use them as in these examples:"
17436 #: ../fish/guestfish.pod:456
17439 " add-drive-opts filename\n"
17444 #: ../fish/guestfish.pod:458
17447 " add-drive-opts filename readonly:true\n"
17452 #: ../fish/guestfish.pod:460
17455 " add-drive-opts filename format:qcow2 readonly:false\n"
17460 #: ../fish/guestfish.pod:462
17462 "Each optional argument can appear at most once. All optional arguments must "
17463 "appear after the required ones."
17467 #: ../fish/guestfish.pod:465
17472 #: ../fish/guestfish.pod:467
17473 msgid "This section applies to all commands which can take integers as parameters."
17477 #: ../fish/guestfish.pod:470
17478 msgid "SIZE SUFFIX"
17482 #: ../fish/guestfish.pod:472
17484 "When the command takes a parameter measured in bytes, you can use one of the "
17485 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17489 #: ../fish/guestfish.pod:478
17490 msgid "B<k> or B<K> or B<KiB>"
17494 #: ../fish/guestfish.pod:480
17495 msgid "The size in kilobytes (multiplied by 1024)."
17499 #: ../fish/guestfish.pod:482
17504 #: ../fish/guestfish.pod:484
17505 msgid "The size in SI 1000 byte units."
17509 #: ../fish/guestfish.pod:486
17510 msgid "B<M> or B<MiB>"
17514 #: ../fish/guestfish.pod:488
17515 msgid "The size in megabytes (multiplied by 1048576)."
17519 #: ../fish/guestfish.pod:490
17524 #: ../fish/guestfish.pod:492
17525 msgid "The size in SI 1000000 byte units."
17529 #: ../fish/guestfish.pod:494
17530 msgid "B<G> or B<GiB>"
17534 #: ../fish/guestfish.pod:496
17535 msgid "The size in gigabytes (multiplied by 2**30)."
17539 #: ../fish/guestfish.pod:498
17544 #: ../fish/guestfish.pod:500
17545 msgid "The size in SI 10**9 byte units."
17549 #: ../fish/guestfish.pod:502
17550 msgid "B<T> or B<TiB>"
17554 #: ../fish/guestfish.pod:504
17555 msgid "The size in terabytes (multiplied by 2**40)."
17559 #: ../fish/guestfish.pod:506
17564 #: ../fish/guestfish.pod:508
17565 msgid "The size in SI 10**12 byte units."
17569 #: ../fish/guestfish.pod:510
17570 msgid "B<P> or B<PiB>"
17574 #: ../fish/guestfish.pod:512
17575 msgid "The size in petabytes (multiplied by 2**50)."
17579 #: ../fish/guestfish.pod:514
17584 #: ../fish/guestfish.pod:516
17585 msgid "The size in SI 10**15 byte units."
17589 #: ../fish/guestfish.pod:518
17590 msgid "B<E> or B<EiB>"
17594 #: ../fish/guestfish.pod:520
17595 msgid "The size in exabytes (multiplied by 2**60)."
17599 #: ../fish/guestfish.pod:522
17604 #: ../fish/guestfish.pod:524
17605 msgid "The size in SI 10**18 byte units."
17609 #: ../fish/guestfish.pod:526
17610 msgid "B<Z> or B<ZiB>"
17614 #: ../fish/guestfish.pod:528
17615 msgid "The size in zettabytes (multiplied by 2**70)."
17619 #: ../fish/guestfish.pod:530
17624 #: ../fish/guestfish.pod:532
17625 msgid "The size in SI 10**21 byte units."
17629 #: ../fish/guestfish.pod:534
17630 msgid "B<Y> or B<YiB>"
17634 #: ../fish/guestfish.pod:536
17635 msgid "The size in yottabytes (multiplied by 2**80)."
17639 #: ../fish/guestfish.pod:538
17644 #: ../fish/guestfish.pod:540
17645 msgid "The size in SI 10**24 byte units."
17649 #: ../fish/guestfish.pod:546
17652 " truncate-size /file 1G\n"
17657 #: ../fish/guestfish.pod:548
17658 msgid "would truncate the file to 1 gigabyte."
17662 #: ../fish/guestfish.pod:550
17664 "Be careful because a few commands take sizes in kilobytes or megabytes "
17665 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17666 "Adding a suffix will probably not do what you expect."
17670 #: ../fish/guestfish.pod:554
17671 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17675 #: ../fish/guestfish.pod:556
17677 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17678 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17682 #: ../fish/guestfish.pod:559
17685 " 1234 decimal number 1234\n"
17686 " 02322 octal number, equivalent to decimal 1234\n"
17687 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17692 #: ../fish/guestfish.pod:563
17694 "When using the C<chmod> command, you almost always want to specify an octal "
17695 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17696 "L<chmod(1)> program):"
17700 #: ../fish/guestfish.pod:567
17703 " chmod 0777 /public # OK\n"
17704 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17709 #: ../fish/guestfish.pod:570
17711 "Commands that return numbers usually print them in decimal, but some "
17712 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17713 "octal, preceeded by C<0>)."
17717 #: ../fish/guestfish.pod:574
17718 msgid "WILDCARDS AND GLOBBING"
17722 #: ../fish/guestfish.pod:576
17724 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17725 "(globbing) by default. So for example the following will not do what you "
17730 #: ../fish/guestfish.pod:580
17738 #: ../fish/guestfish.pod:582
17740 "Assuming you don't have a directory called literally C</home/*> then the "
17741 "above command will return an error."
17745 #: ../fish/guestfish.pod:585
17746 msgid "To perform wildcard expansion, use the C<glob> command."
17750 #: ../fish/guestfish.pod:587
17753 " glob rm-rf /home/*\n"
17758 #: ../fish/guestfish.pod:589
17760 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17761 "many times), equivalent to:"
17765 #: ../fish/guestfish.pod:592
17768 " rm-rf /home/jim\n"
17769 " rm-rf /home/joe\n"
17770 " rm-rf /home/mary\n"
17775 #: ../fish/guestfish.pod:596
17776 msgid "C<glob> only works on simple guest paths and not on device names."
17780 #: ../fish/guestfish.pod:598
17782 "If you have several parameters, each containing a wildcard, then glob will "
17783 "perform a Cartesian product."
17787 #: ../fish/guestfish.pod:601
17792 #: ../fish/guestfish.pod:603
17794 "Any line which starts with a I<#> character is treated as a comment and "
17795 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17796 "a command. For example:"
17800 #: ../fish/guestfish.pod:607
17803 " # this is a comment\n"
17804 " # this is a comment\n"
17805 " foo # NOT a comment\n"
17810 #: ../fish/guestfish.pod:611
17811 msgid "Blank lines are also ignored."
17815 #: ../fish/guestfish.pod:613
17816 msgid "RUNNING COMMANDS LOCALLY"
17820 #: ../fish/guestfish.pod:615
17822 "Any line which starts with a I<!> character is treated as a command sent to "
17823 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17827 #: ../fish/guestfish.pod:619
17831 " tgz-out /remote local/remote-data.tar.gz\n"
17836 #: ../fish/guestfish.pod:622
17838 "will create a directory C<local> on the host, and then export the contents "
17839 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17840 "(See C<tgz-out>)."
17844 #: ../fish/guestfish.pod:626
17846 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17847 "effect, due to the way that subprocesses work in Unix."
17851 #: ../fish/guestfish.pod:629
17856 #: ../fish/guestfish.pod:631
17858 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17859 "command (a guestfish command) to the second command (any host command). For "
17864 #: ../fish/guestfish.pod:635
17867 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17872 #: ../fish/guestfish.pod:637
17874 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17875 "program). The above command would list all accounts in the guest filesystem "
17876 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17880 #: ../fish/guestfish.pod:642
17883 " hexdump /bin/ls | head\n"
17884 " list-devices | tail -1\n"
17885 " tgz-out / - | tar ztf -\n"
17890 #: ../fish/guestfish.pod:646
17892 "The space before the pipe symbol is required, any space after the pipe "
17893 "symbol is optional. Everything after the pipe symbol is just passed "
17894 "straight to the host shell, so it can contain redirections, globs and "
17895 "anything else that makes sense on the host side."
17899 #: ../fish/guestfish.pod:651
17901 "To use a literal argument which begins with a pipe symbol, you have to quote "
17906 #: ../fish/guestfish.pod:654
17914 #: ../fish/guestfish.pod:656
17915 msgid "HOME DIRECTORIES"
17919 #: ../fish/guestfish.pod:658
17921 "If a parameter starts with the character C<~> then the tilde may be expanded "
17922 "as a home directory path (either C<~> for the current user's home directory, "
17923 "or C<~user> for another user)."
17927 #: ../fish/guestfish.pod:662
17929 "Note that home directory expansion happens for users known I<on the host>, "
17930 "not in the guest filesystem."
17934 #: ../fish/guestfish.pod:665
17936 "To use a literal argument which begins with a tilde, you have to quote it, "
17941 #: ../fish/guestfish.pod:668
17949 #: ../fish/guestfish.pod:672
17951 "Libguestfs has some support for Linux guests encrypted according to the "
17952 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17953 "disk encryption systems used by modern Linux guests. Currently only "
17954 "LVM-on-LUKS is supported."
17958 #: ../fish/guestfish.pod:677
17959 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17963 #: ../fish/guestfish.pod:679
17966 " ><fs> vfs-type /dev/sda2\n"
17972 #: ../fish/guestfish.pod:682
17974 "Then open those devices using L</luks-open>. This creates a device-mapper "
17975 "device called C</dev/mapper/luksdev>."
17979 #: ../fish/guestfish.pod:685
17982 " ><fs> luks-open /dev/sda2 luksdev\n"
17983 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17988 #: ../fish/guestfish.pod:688
17990 "Finally you have to tell LVM to scan for volume groups on the newly created "
17995 #: ../fish/guestfish.pod:691
17999 " vg-activate-all true\n"
18004 #: ../fish/guestfish.pod:694
18005 msgid "The logical volume(s) can now be mounted in the usual way."
18009 #: ../fish/guestfish.pod:696
18011 "Before closing a LUKS device you must unmount any logical volumes on it and "
18012 "deactivate the volume groups by calling C<vg-activate false VG> on each "
18013 "one. Then you can close the mapper device:"
18017 #: ../fish/guestfish.pod:700
18020 " vg-activate false /dev/VG\n"
18021 " luks-close /dev/mapper/luksdev\n"
18026 #: ../fish/guestfish.pod:703
18027 msgid "WINDOWS PATHS"
18031 #: ../fish/guestfish.pod:705
18033 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18034 "(with some limitations). The following commands are equivalent:"
18038 #: ../fish/guestfish.pod:708
18041 " file /WINDOWS/system32/config/system.LOG\n"
18046 #: ../fish/guestfish.pod:710
18049 " file win:/windows/system32/config/system.log\n"
18054 #: ../fish/guestfish.pod:712
18057 " file win:\\windows\\system32\\config\\system.log\n"
18062 #: ../fish/guestfish.pod:714
18065 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18070 #: ../fish/guestfish.pod:716
18072 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18073 "handles case insensitivity like Windows would. This only works in argument "
18074 "positions that expect a path."
18078 #: ../fish/guestfish.pod:720
18079 msgid "UPLOADING AND DOWNLOADING FILES"
18083 #: ../fish/guestfish.pod:722
18085 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18086 "others which upload from or download to a local file, you can use the "
18087 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18091 #: ../fish/guestfish.pod:726
18099 #: ../fish/guestfish.pod:728
18100 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
18104 #: ../fish/guestfish.pod:731
18107 " tar-out /etc - | tar tf -\n"
18112 #: ../fish/guestfish.pod:733
18114 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18115 "command (see L</PIPES>)."
18119 #: ../fish/guestfish.pod:736
18121 "When using C<-> to read from stdin, the input is read up to the end of "
18122 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18123 "some arbitrary end marker:"
18127 #: ../fish/guestfish.pod:740
18130 " upload -<<END /foo\n"
18139 #: ../fish/guestfish.pod:746
18141 "Any string of characters can be used instead of C<END>. The end marker must "
18142 "appear on a line of its own, without any preceeding or following characters "
18143 "(not even spaces)."
18147 #: ../fish/guestfish.pod:750
18149 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18150 "upload local files (so-called \"FileIn\" parameters in the generator)."
18154 #: ../fish/guestfish.pod:753
18155 msgid "EXIT ON ERROR BEHAVIOUR"
18159 #: ../fish/guestfish.pod:755
18161 "By default, guestfish will ignore any errors when in interactive mode "
18162 "(ie. taking commands from a human over a tty), and will exit on the first "
18163 "error in non-interactive mode (scripts, commands given on the command line)."
18167 #: ../fish/guestfish.pod:760
18169 "If you prefix a command with a I<-> character, then that command will not "
18170 "cause guestfish to exit, even if that (one) command returns an error."
18174 #: ../fish/guestfish.pod:764
18175 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18179 #: ../fish/guestfish.pod:766
18181 "Guestfish can be remote-controlled over a socket. This is useful "
18182 "particularly in shell scripts where you want to make several different "
18183 "changes to a filesystem, but you don't want the overhead of starting up a "
18184 "guestfish process each time."
18188 #: ../fish/guestfish.pod:771
18189 msgid "Start a guestfish server process using:"
18193 #: ../fish/guestfish.pod:773
18196 " eval \"`guestfish --listen`\"\n"
18201 #: ../fish/guestfish.pod:775
18202 msgid "and then send it commands by doing:"
18206 #: ../fish/guestfish.pod:777
18209 " guestfish --remote cmd [...]\n"
18214 #: ../fish/guestfish.pod:779
18215 msgid "To cause the server to exit, send it the exit command:"
18219 #: ../fish/guestfish.pod:781
18222 " guestfish --remote exit\n"
18227 #: ../fish/guestfish.pod:783
18229 "Note that the server will normally exit if there is an error in a command. "
18230 "You can change this in the usual way. See section L</EXIT ON ERROR "
18235 #: ../fish/guestfish.pod:787
18236 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18240 #: ../fish/guestfish.pod:789
18242 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18243 "is how the I<--remote> option knows where to send the commands. You can "
18244 "have several guestfish listener processes running using:"
18248 #: ../fish/guestfish.pod:793
18251 " eval \"`guestfish --listen`\"\n"
18252 " pid1=$GUESTFISH_PID\n"
18253 " eval \"`guestfish --listen`\"\n"
18254 " pid2=$GUESTFISH_PID\n"
18256 " guestfish --remote=$pid1 cmd\n"
18257 " guestfish --remote=$pid2 cmd\n"
18262 #: ../fish/guestfish.pod:801
18263 msgid "REMOTE CONTROL AND CSH"
18267 #: ../fish/guestfish.pod:803
18269 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18274 #: ../fish/guestfish.pod:806
18277 " eval \"`guestfish --listen --csh`\"\n"
18282 #: ../fish/guestfish.pod:808
18283 msgid "REMOTE CONTROL DETAILS"
18287 #: ../fish/guestfish.pod:810
18289 "Remote control happens over a Unix domain socket called "
18290 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
18291 "of the process, and C<$PID> is the process ID of the server."
18295 #: ../fish/guestfish.pod:814
18296 msgid "Guestfish client and server versions must match exactly."
18300 #: ../fish/guestfish.pod:816
18301 msgid "PREPARED DISK IMAGES"
18305 #: ../fish/guestfish.pod:818
18307 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18308 "preformatted disk images that guestfish can make for you to save typing. "
18309 "This is particularly useful for testing purposes. This option is used "
18310 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18311 "can be mixed with I<-a>)."
18315 #: ../fish/guestfish.pod:824
18317 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18318 "the second and so on. Existing files in the current directory are "
18323 #: ../fish/guestfish.pod:828
18325 "The type briefly describes how the disk should be sized, partitioned, how "
18326 "filesystem(s) should be created, and how content should be added. "
18327 "Optionally the type can be followed by extra parameters, separated by C<:> "
18328 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
18329 "sparsely-allocated disk, containing a single partition, with the partition "
18330 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
18331 "on a 1GB disk instead."
18335 #: ../fish/guestfish.pod:836
18336 msgid "To list the available types and any extra parameters they take, run:"
18340 #: ../fish/guestfish.pod:840
18342 "Note that the prepared filesystem is not mounted. You would usually have to "
18343 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18347 #: ../fish/guestfish.pod:844
18349 "If any I<-N> or I<--new> options are given, the guest is automatically "
18354 #: ../fish/guestfish.pod:849
18355 msgid "Create a 100MB disk with an ext4-formatted partition:"
18359 #: ../fish/guestfish.pod:851
18362 " guestfish -N fs:ext4\n"
18367 #: ../fish/guestfish.pod:853
18368 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18372 #: ../fish/guestfish.pod:855
18375 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18380 #: ../fish/guestfish.pod:857
18381 msgid "Create a blank 200MB disk:"
18385 #: ../fish/guestfish.pod:859
18388 " guestfish -N disk:200M\n"
18393 #: ../fish/guestfish.pod:861
18394 msgid "PROGRESS BARS"
18398 #: ../fish/guestfish.pod:863
18400 "Some (not all) long-running commands send progress notification messages as "
18401 "they are running. Guestfish turns these messages into progress bars."
18405 #: ../fish/guestfish.pod:867
18407 "When a command that supports progress bars takes longer than two seconds to "
18408 "run, and if progress bars are enabled, then you will see one appearing below "
18413 #: ../fish/guestfish.pod:871
18416 " ><fs> copy-size /large-file /another-file 2048M\n"
18417 " / 10% [#####-----------------------------------------] 00:30\n"
18422 #: ../fish/guestfish.pod:874
18424 "The spinner on the left hand side moves round once for every progress "
18425 "notification received from the backend. This is a (reasonably) golden "
18426 "assurance that the command is \"doing something\" even if the progress bar "
18427 "is not moving, because the command is able to send the progress "
18428 "notifications. When the bar reaches 100% and the command finishes, the "
18429 "spinner disappears."
18433 #: ../fish/guestfish.pod:881
18435 "Progress bars are enabled by default when guestfish is used interactively. "
18436 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18437 "and you can disable them completely using I<--no-progress-bars>."
18441 #: ../fish/guestfish.pod:886
18442 msgid "GUESTFISH COMMANDS"
18446 #: ../fish/guestfish.pod:888
18448 "The commands in this section are guestfish convenience commands, in other "
18449 "words, they are not part of the L<guestfs(3)> API."
18453 #: ../fish/guestfish.pod:891
18458 #: ../fish/guestfish.pod:893
18467 #: ../fish/guestfish.pod:896
18468 msgid "Without any parameter, this provides general help."
18472 #: ../fish/guestfish.pod:898
18473 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18477 #: ../fish/guestfish.pod:900
18478 msgid "quit | exit"
18482 #: ../fish/guestfish.pod:902
18483 msgid "This exits guestfish. You can also use C<^D> key."
18487 #: ../fish/guestfish.pod:904
18488 msgid "@FISH_COMMANDS@"
18492 #: ../fish/guestfish.pod:906
18497 #: ../fish/guestfish.pod:910 ../test-tool/libguestfs-test-tool.pod:83
18502 #: ../fish/guestfish.pod:912
18504 "guestfish returns 0 if the commands completed without error, or 1 if there "
18509 #: ../fish/guestfish.pod:919
18514 #: ../fish/guestfish.pod:921
18516 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18521 #: ../fish/guestfish.pod:924
18522 msgid "GUESTFISH_PID"
18526 #: ../fish/guestfish.pod:926
18528 "Used with the I<--remote> option to specify the remote guestfish process to "
18529 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18533 #: ../fish/guestfish.pod:930
18538 #: ../fish/guestfish.pod:932
18540 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18541 "not specified, the external L<hexedit(1)> program is used."
18545 #: ../fish/guestfish.pod:936
18550 #: ../fish/guestfish.pod:938
18552 "If compiled with GNU readline support, various files in the home directory "
18553 "can be used. See L</FILES>."
18557 #: ../fish/guestfish.pod:947
18559 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18560 "effect as using the B<-v> option."
18564 #: ../fish/guestfish.pod:959
18566 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18567 "the discussion of paths in L<guestfs(3)>."
18571 #: ../fish/guestfish.pod:970
18572 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18576 #: ../fish/guestfish.pod:972
18581 #: ../fish/guestfish.pod:974
18583 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18588 #: ../fish/guestfish.pod:989 ../test-tool/libguestfs-test-tool.pod:88
18593 #: ../fish/guestfish.pod:993
18594 msgid "$HOME/.guestfish"
18598 #: ../fish/guestfish.pod:995
18600 "If compiled with GNU readline support, then the command history is saved in "
18605 #: ../fish/guestfish.pod:998
18606 msgid "$HOME/.inputrc"
18610 #: ../fish/guestfish.pod:1000
18611 msgid "/etc/inputrc"
18615 #: ../fish/guestfish.pod:1002
18617 "If compiled with GNU readline support, then these files can be used to "
18618 "configure readline. For further information, please see "
18619 "L<readline(3)/INITIALIZATION FILE>."
18623 #: ../fish/guestfish.pod:1006
18624 msgid "To write rules which only apply to guestfish, use:"
18628 #: ../fish/guestfish.pod:1008
18638 #: ../fish/guestfish.pod:1012
18640 "Variables that you can set in inputrc that change the behaviour of guestfish "
18641 "in useful ways include:"
18645 #: ../fish/guestfish.pod:1017
18646 msgid "completion-ignore-case (default: on)"
18650 #: ../fish/guestfish.pod:1019
18652 "By default, guestfish will ignore case when tab-completing paths on the "
18657 #: ../fish/guestfish.pod:1022
18660 " set completion-ignore-case off\n"
18665 #: ../fish/guestfish.pod:1024
18666 msgid "to make guestfish case sensitive."
18670 #: ../fish/guestfish.pod:1028
18675 #: ../fish/guestfish.pod:1030
18676 msgid "test2.img (etc)"
18680 #: ../fish/guestfish.pod:1032
18682 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18683 "will be created in the file C<test1.img> in the current directory. The "
18684 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18685 "the same name will be overwritten."
18689 #: ../fish/guestfish.pod:1041
18691 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18692 "L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)>, "
18693 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
18694 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, "
18695 "L<virt-win-reg(1)>, L<hexedit(1)>."
18699 #: ../fish/guestfish.pod:1067 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:210 ../tools/virt-tar.pl:300 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:277
18701 "This program is free software; you can redistribute it and/or modify it "
18702 "under the terms of the GNU General Public License as published by the Free "
18703 "Software Foundation; either version 2 of the License, or (at your option) "
18704 "any later version."
18708 #: ../fish/guestfish.pod:1072 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523 ../tools/virt-resize.pl:1517 ../tools/virt-list-filesystems.pl:215 ../tools/virt-tar.pl:305 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:282
18710 "This program is distributed in the hope that it will be useful, but WITHOUT "
18711 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18712 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18717 #: ../fish/guestfish.pod:1077 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528 ../tools/virt-resize.pl:1522 ../tools/virt-list-filesystems.pl:220 ../tools/virt-tar.pl:310 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:287
18719 "You should have received a copy of the GNU General Public License along with "
18720 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18721 "Ave, Cambridge, MA 02139, USA."
18725 #: ../fish/guestfish-actions.pod:1
18730 #: ../fish/guestfish-actions.pod:3
18733 " add-cdrom filename\n"
18738 #: ../fish/guestfish-actions.pod:15
18740 "This call checks for the existence of C<filename>. This stops you from "
18741 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18742 "and C<http:> URLs. To specify those, use the general L</config> call "
18747 #: ../fish/guestfish-actions.pod:22
18749 "If you just want to add an ISO file (often you use this as an efficient way "
18750 "to transfer large files into the guest), then you should probably use "
18751 "L</add-drive-ro> instead."
18755 #: ../fish/guestfish-actions.pod:35
18760 #: ../fish/guestfish-actions.pod:37
18765 #: ../fish/guestfish-actions.pod:39
18768 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18773 #: ../fish/guestfish-actions.pod:41
18775 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18776 "It works by connecting to libvirt, requesting the domain and domain XML from "
18777 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18781 #: ../fish/guestfish-actions.pod:58
18783 "The optional C<libvirturi> parameter sets the libvirt URI (see "
18784 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
18785 "default libvirt URI (or one set through an environment variable, see the "
18786 "libvirt documentation for full details). If you are using the C API "
18787 "directly then it is more flexible to create the libvirt connection object "
18788 "yourself, get the domain object, and call L</add-libvirt-dom>."
18792 #: ../fish/guestfish-actions.pod:66
18794 "The other optional parameters are passed directly through to "
18795 "L</add-drive-opts>."
18799 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
18801 "This command has one or more optional arguments. See L</OPTIONAL "
18806 #: ../fish/guestfish-actions.pod:71
18811 #: ../fish/guestfish-actions.pod:73
18814 " add-drive filename\n"
18819 #: ../fish/guestfish-actions.pod:75
18821 "This function is the equivalent of calling L</add-drive-opts> with no "
18822 "optional parameters, so the disk is added writable, with the format being "
18823 "detected automatically."
18827 #: ../fish/guestfish-actions.pod:79
18829 "Automatic detection of the format opens you up to a potential security hole "
18830 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18831 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18832 "you should think about replacing calls to this function with calls to "
18833 "L</add-drive-opts>, and specifying the format."
18837 #: ../fish/guestfish-actions.pod:86
18838 msgid "add-drive-opts"
18842 #: ../fish/guestfish-actions.pod:88
18847 #: ../fish/guestfish-actions.pod:90
18850 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18855 #: ../fish/guestfish-actions.pod:117
18857 "This forces the image format. If you omit this (or use L</add-drive> or "
18858 "L</add-drive-ro>) then the format is automatically detected. Possible "
18859 "formats include C<raw> and C<qcow2>."
18863 #: ../fish/guestfish-actions.pod:128
18865 "This rarely-used option lets you emulate the behaviour of the deprecated "
18866 "L</add-drive-with-if> call (q.v.)"
18870 #: ../fish/guestfish-actions.pod:135
18871 msgid "add-drive-ro"
18875 #: ../fish/guestfish-actions.pod:137
18880 #: ../fish/guestfish-actions.pod:139
18883 " add-drive-ro filename\n"
18888 #: ../fish/guestfish-actions.pod:141
18890 "This function is the equivalent of calling L</add-drive-opts> with the "
18891 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18892 "is added read-only, with the format being detected automatically."
18896 #: ../fish/guestfish-actions.pod:146
18897 msgid "add-drive-ro-with-if"
18901 #: ../fish/guestfish-actions.pod:148
18904 " add-drive-ro-with-if filename iface\n"
18909 #: ../fish/guestfish-actions.pod:150
18911 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18912 "interface emulation to use at run time."
18916 #: ../fish/guestfish-actions.pod:160
18917 msgid "add-drive-with-if"
18921 #: ../fish/guestfish-actions.pod:162
18924 " add-drive-with-if filename iface\n"
18929 #: ../fish/guestfish-actions.pod:164
18931 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18932 "interface emulation to use at run time."
18936 #: ../fish/guestfish-actions.pod:174
18941 #: ../fish/guestfish-actions.pod:176
18944 " aug-clear augpath\n"
18949 #: ../fish/guestfish-actions.pod:181
18954 #: ../fish/guestfish-actions.pod:183
18962 #: ../fish/guestfish-actions.pod:185
18964 "Close the current Augeas handle and free up any resources used by it. After "
18965 "calling this, you have to call L</aug-init> again before you can use any "
18966 "other Augeas functions."
18970 #: ../fish/guestfish-actions.pod:190
18971 msgid "aug-defnode"
18975 #: ../fish/guestfish-actions.pod:192
18978 " aug-defnode name expr val\n"
18983 #: ../fish/guestfish-actions.pod:197
18985 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18986 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18987 "containing that single node."
18991 #: ../fish/guestfish-actions.pod:205
18996 #: ../fish/guestfish-actions.pod:207
18999 " aug-defvar name expr\n"
19004 #: ../fish/guestfish-actions.pod:216
19009 #: ../fish/guestfish-actions.pod:218
19012 " aug-get augpath\n"
19017 #: ../fish/guestfish-actions.pod:223
19022 #: ../fish/guestfish-actions.pod:225
19025 " aug-init root flags\n"
19030 #: ../fish/guestfish-actions.pod:231
19031 msgid "You must call this before using any other L</aug-*> commands."
19035 #: ../fish/guestfish-actions.pod:266
19036 msgid "Do not load the tree in L</aug-init>."
19040 #: ../fish/guestfish-actions.pod:270
19041 msgid "To close the handle, you can call L</aug-close>."
19045 #: ../fish/guestfish-actions.pod:274
19050 #: ../fish/guestfish-actions.pod:276
19053 " aug-insert augpath label true|false\n"
19058 #: ../fish/guestfish-actions.pod:286
19063 #: ../fish/guestfish-actions.pod:288
19071 #: ../fish/guestfish-actions.pod:295
19076 #: ../fish/guestfish-actions.pod:297
19079 " aug-ls augpath\n"
19084 #: ../fish/guestfish-actions.pod:299
19086 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19087 "resulting nodes into alphabetical order."
19091 #: ../fish/guestfish-actions.pod:302
19096 #: ../fish/guestfish-actions.pod:304
19099 " aug-match augpath\n"
19104 #: ../fish/guestfish-actions.pod:310
19109 #: ../fish/guestfish-actions.pod:312
19112 " aug-mv src dest\n"
19117 #: ../fish/guestfish-actions.pod:317
19122 #: ../fish/guestfish-actions.pod:319
19125 " aug-rm augpath\n"
19130 #: ../fish/guestfish-actions.pod:325
19135 #: ../fish/guestfish-actions.pod:327
19143 #: ../fish/guestfish-actions.pod:331
19145 "The flags which were passed to L</aug-init> affect exactly how files are "
19150 #: ../fish/guestfish-actions.pod:334
19155 #: ../fish/guestfish-actions.pod:336
19158 " aug-set augpath val\n"
19163 #: ../fish/guestfish-actions.pod:340
19165 "In the Augeas API, it is possible to clear a node by setting the value to "
19166 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19167 "this call. Instead you must use the L</aug-clear> call."
19171 #: ../fish/guestfish-actions.pod:345
19176 #: ../fish/guestfish-actions.pod:347
19179 " available 'groups ...'\n"
19184 #: ../fish/guestfish-actions.pod:353
19186 "The libguestfs groups, and the functions that those groups correspond to, "
19187 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19188 "runtime by calling L</available-all-groups>."
19192 #: ../fish/guestfish-actions.pod:377
19193 msgid "You must call L</launch> before calling this function."
19197 #: ../fish/guestfish-actions.pod:399
19199 "This call was added in version C<1.0.80>. In previous versions of "
19200 "libguestfs all you could do would be to speculatively execute a command to "
19201 "find out if the daemon implemented it. See also L</version>."
19205 #: ../fish/guestfish-actions.pod:406
19206 msgid "available-all-groups"
19210 #: ../fish/guestfish-actions.pod:408
19213 " available-all-groups\n"
19218 #: ../fish/guestfish-actions.pod:410
19220 "This command returns a list of all optional groups that this daemon knows "
19221 "about. Note this returns both supported and unsupported groups. To find "
19222 "out which ones the daemon can actually support you have to call "
19223 "L</available> on each member of the returned list."
19227 #: ../fish/guestfish-actions.pod:416
19228 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19232 #: ../fish/guestfish-actions.pod:418
19237 #: ../fish/guestfish-actions.pod:420
19240 " base64-in (base64file|-) filename\n"
19245 #: ../fish/guestfish-actions.pod:425 ../fish/guestfish-actions.pod:434 ../fish/guestfish-actions.pod:658 ../fish/guestfish-actions.pod:827 ../fish/guestfish-actions.pod:846 ../fish/guestfish-actions.pod:1223 ../fish/guestfish-actions.pod:4128 ../fish/guestfish-actions.pod:4140 ../fish/guestfish-actions.pod:4151 ../fish/guestfish-actions.pod:4162 ../fish/guestfish-actions.pod:4214 ../fish/guestfish-actions.pod:4223 ../fish/guestfish-actions.pod:4277 ../fish/guestfish-actions.pod:4300
19246 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19250 #: ../fish/guestfish-actions.pod:427
19255 #: ../fish/guestfish-actions.pod:429
19258 " base64-out filename (base64file|-)\n"
19263 #: ../fish/guestfish-actions.pod:436
19264 msgid "blockdev-flushbufs"
19268 #: ../fish/guestfish-actions.pod:438
19271 " blockdev-flushbufs device\n"
19276 #: ../fish/guestfish-actions.pod:445
19277 msgid "blockdev-getbsz"
19281 #: ../fish/guestfish-actions.pod:447
19284 " blockdev-getbsz device\n"
19289 #: ../fish/guestfish-actions.pod:456
19290 msgid "blockdev-getro"
19294 #: ../fish/guestfish-actions.pod:458
19297 " blockdev-getro device\n"
19302 #: ../fish/guestfish-actions.pod:465
19303 msgid "blockdev-getsize64"
19307 #: ../fish/guestfish-actions.pod:467
19310 " blockdev-getsize64 device\n"
19315 #: ../fish/guestfish-actions.pod:471
19316 msgid "See also L</blockdev-getsz>."
19320 #: ../fish/guestfish-actions.pod:475
19321 msgid "blockdev-getss"
19325 #: ../fish/guestfish-actions.pod:477
19328 " blockdev-getss device\n"
19333 #: ../fish/guestfish-actions.pod:482
19334 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19338 #: ../fish/guestfish-actions.pod:487
19339 msgid "blockdev-getsz"
19343 #: ../fish/guestfish-actions.pod:489
19346 " blockdev-getsz device\n"
19351 #: ../fish/guestfish-actions.pod:494
19353 "See also L</blockdev-getss> for the real sector size of the device, and "
19354 "L</blockdev-getsize64> for the more useful I<size in bytes>."
19358 #: ../fish/guestfish-actions.pod:500
19359 msgid "blockdev-rereadpt"
19363 #: ../fish/guestfish-actions.pod:502
19366 " blockdev-rereadpt device\n"
19371 #: ../fish/guestfish-actions.pod:508
19372 msgid "blockdev-setbsz"
19376 #: ../fish/guestfish-actions.pod:510
19379 " blockdev-setbsz device blocksize\n"
19384 #: ../fish/guestfish-actions.pod:519
19385 msgid "blockdev-setro"
19389 #: ../fish/guestfish-actions.pod:521
19392 " blockdev-setro device\n"
19397 #: ../fish/guestfish-actions.pod:527
19398 msgid "blockdev-setrw"
19402 #: ../fish/guestfish-actions.pod:529
19405 " blockdev-setrw device\n"
19410 #: ../fish/guestfish-actions.pod:535
19411 msgid "case-sensitive-path"
19415 #: ../fish/guestfish-actions.pod:537
19418 " case-sensitive-path path\n"
19423 #: ../fish/guestfish-actions.pod:561
19425 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
19426 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
19427 "how the directories were originally created under Windows)."
19431 #: ../fish/guestfish-actions.pod:569
19432 msgid "See also L</realpath>."
19436 #: ../fish/guestfish-actions.pod:571
19441 #: ../fish/guestfish-actions.pod:573
19449 #: ../fish/guestfish-actions.pod:577
19451 "Note that this function cannot correctly handle binary files (specifically, "
19452 "files containing C<\\0> character which is treated as end of string). For "
19453 "those you need to use the L</read-file> or L</download> functions which have "
19454 "a more complex interface."
19458 #: ../fish/guestfish-actions.pod:585
19463 #: ../fish/guestfish-actions.pod:587
19466 " checksum csumtype path\n"
19471 #: ../fish/guestfish-actions.pod:630
19472 msgid "To get the checksum for a device, use L</checksum-device>."
19476 #: ../fish/guestfish-actions.pod:632
19477 msgid "To get the checksums for many files, use L</checksums-out>."
19481 #: ../fish/guestfish-actions.pod:634
19482 msgid "checksum-device"
19486 #: ../fish/guestfish-actions.pod:636
19489 " checksum-device csumtype device\n"
19494 #: ../fish/guestfish-actions.pod:638
19496 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19497 "device named C<device>. For the types of checksums supported see the "
19498 "L</checksum> command."
19502 #: ../fish/guestfish-actions.pod:642
19503 msgid "checksums-out"
19507 #: ../fish/guestfish-actions.pod:644
19510 " checksums-out csumtype directory (sumsfile|-)\n"
19515 #: ../fish/guestfish-actions.pod:660
19520 #: ../fish/guestfish-actions.pod:662
19523 " chmod mode path\n"
19528 #: ../fish/guestfish-actions.pod:673
19533 #: ../fish/guestfish-actions.pod:675
19536 " chown owner group path\n"
19541 #: ../fish/guestfish-actions.pod:683
19546 #: ../fish/guestfish-actions.pod:685
19549 " command 'arguments ...'\n"
19554 #: ../fish/guestfish-actions.pod:692
19556 "The single parameter is an argv-style list of arguments. The first element "
19557 "is the name of the program to run. Subsequent elements are parameters. The "
19558 "list must be non-empty (ie. must contain a program name). Note that the "
19559 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19563 #: ../fish/guestfish-actions.pod:720
19564 msgid "command-lines"
19568 #: ../fish/guestfish-actions.pod:722
19571 " command-lines 'arguments ...'\n"
19576 #: ../fish/guestfish-actions.pod:724
19577 msgid "This is the same as L</command>, but splits the result into a list of lines."
19581 #: ../fish/guestfish-actions.pod:727
19582 msgid "See also: L</sh-lines>"
19586 #: ../fish/guestfish-actions.pod:732
19591 #: ../fish/guestfish-actions.pod:734
19594 " config qemuparam qemuvalue\n"
19599 #: ../fish/guestfish-actions.pod:745
19604 #: ../fish/guestfish-actions.pod:747
19607 " copy-size src dest size\n"
19612 #: ../fish/guestfish-actions.pod:755
19617 #: ../fish/guestfish-actions.pod:757
19625 #: ../fish/guestfish-actions.pod:762
19630 #: ../fish/guestfish-actions.pod:764
19638 #: ../fish/guestfish-actions.pod:769
19643 #: ../fish/guestfish-actions.pod:771
19651 #: ../fish/guestfish-actions.pod:778
19653 "If the destination is a device, it must be as large or larger than the "
19654 "source file or device, otherwise the copy will fail. This command cannot do "
19655 "partial copies (see L</copy-size>)."
19659 #: ../fish/guestfish-actions.pod:782
19664 #: ../fish/guestfish-actions.pod:784
19672 #: ../fish/guestfish-actions.pod:792
19677 #: ../fish/guestfish-actions.pod:794
19685 #: ../fish/guestfish-actions.pod:803
19690 #: ../fish/guestfish-actions.pod:805
19698 #: ../fish/guestfish-actions.pod:811
19700 "Another way to get the same information is to enable verbose messages with "
19701 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19702 "before running the program."
19706 #: ../fish/guestfish-actions.pod:816
19711 #: ../fish/guestfish-actions.pod:818
19714 " download remotefilename (filename|-)\n"
19719 #: ../fish/guestfish-actions.pod:825
19720 msgid "See also L</upload>, L</cat>."
19724 #: ../fish/guestfish-actions.pod:829
19725 msgid "download-offset"
19729 #: ../fish/guestfish-actions.pod:831
19732 " download-offset remotefilename (filename|-) offset size\n"
19737 #: ../fish/guestfish-actions.pod:839
19739 "Note that there is no limit on the amount of data that can be downloaded "
19740 "with this call, unlike with L</pread>, and this call always reads the full "
19741 "amount unless an error occurs."
19745 #: ../fish/guestfish-actions.pod:844
19746 msgid "See also L</download>, L</pread>."
19750 #: ../fish/guestfish-actions.pod:848
19751 msgid "drop-caches"
19755 #: ../fish/guestfish-actions.pod:850
19758 " drop-caches whattodrop\n"
19763 #: ../fish/guestfish-actions.pod:862
19768 #: ../fish/guestfish-actions.pod:864
19776 #: ../fish/guestfish-actions.pod:876
19781 #: ../fish/guestfish-actions.pod:878
19784 " e2fsck-f device\n"
19789 #: ../fish/guestfish-actions.pod:884
19791 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19792 "should use L</fsck>."
19796 #: ../fish/guestfish-actions.pod:887
19797 msgid "echo-daemon"
19801 #: ../fish/guestfish-actions.pod:889
19804 " echo-daemon 'words ...'\n"
19809 #: ../fish/guestfish-actions.pod:896
19810 msgid "See also L</ping-daemon>."
19814 #: ../fish/guestfish-actions.pod:898
19819 #: ../fish/guestfish-actions.pod:900
19822 " egrep regex path\n"
19827 #: ../fish/guestfish-actions.pod:908
19832 #: ../fish/guestfish-actions.pod:910
19835 " egrepi regex path\n"
19840 #: ../fish/guestfish-actions.pod:918
19845 #: ../fish/guestfish-actions.pod:920
19848 " equal file1 file2\n"
19853 #: ../fish/guestfish-actions.pod:927
19858 #: ../fish/guestfish-actions.pod:929
19866 #: ../fish/guestfish-actions.pod:934
19867 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19871 #: ../fish/guestfish-actions.pod:936
19876 #: ../fish/guestfish-actions.pod:938
19879 " fallocate path len\n"
19884 #: ../fish/guestfish-actions.pod:955
19885 msgid "fallocate64"
19889 #: ../fish/guestfish-actions.pod:957
19892 " fallocate64 path len\n"
19897 #: ../fish/guestfish-actions.pod:963
19899 "Note that this call allocates disk blocks for the file. To create a sparse "
19900 "file use L</truncate-size> instead."
19904 #: ../fish/guestfish-actions.pod:966
19906 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19907 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19908 "maximum size of files created through that call to 1GB."
19912 #: ../fish/guestfish-actions.pod:975
19917 #: ../fish/guestfish-actions.pod:977
19920 " fgrep pattern path\n"
19925 #: ../fish/guestfish-actions.pod:985
19930 #: ../fish/guestfish-actions.pod:987
19933 " fgrepi pattern path\n"
19938 #: ../fish/guestfish-actions.pod:995
19943 #: ../fish/guestfish-actions.pod:997
19951 #: ../fish/guestfish-actions.pod:1009
19953 "This command can also be used on C</dev/> devices (and partitions, LV "
19954 "names). You can for example use this to determine if a device contains a "
19955 "filesystem, although it's usually better to use L</vfs-type>."
19959 #: ../fish/guestfish-actions.pod:1019
19960 msgid "file-architecture"
19964 #: ../fish/guestfish-actions.pod:1021
19967 " file-architecture filename\n"
19972 #: ../fish/guestfish-actions.pod:1124
19977 #: ../fish/guestfish-actions.pod:1126
19985 #: ../fish/guestfish-actions.pod:1130
19987 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
19988 "L</is-file> etc. To get the size of block devices, use "
19989 "L</blockdev-getsize64>."
19993 #: ../fish/guestfish-actions.pod:1134
19998 #: ../fish/guestfish-actions.pod:1136
20001 " fill c len path\n"
20006 #: ../fish/guestfish-actions.pod:1142
20008 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
20009 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
20010 "L</fill-pattern>."
20014 #: ../fish/guestfish-actions.pod:1147
20015 msgid "fill-pattern"
20019 #: ../fish/guestfish-actions.pod:1149
20022 " fill-pattern pattern len path\n"
20027 #: ../fish/guestfish-actions.pod:1151
20029 "This function is like L</fill> except that it creates a new file of length "
20030 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20031 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20036 #: ../fish/guestfish-actions.pod:1156
20041 #: ../fish/guestfish-actions.pod:1158
20044 " find directory\n"
20049 #: ../fish/guestfish-actions.pod:1172
20050 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20054 #: ../fish/guestfish-actions.pod:1185
20055 msgid "See also L</find0>."
20059 #: ../fish/guestfish-actions.pod:1190
20064 #: ../fish/guestfish-actions.pod:1192
20067 " find0 directory (files|-)\n"
20072 #: ../fish/guestfish-actions.pod:1198
20073 msgid "This command works the same way as L</find> with the following exceptions:"
20077 #: ../fish/guestfish-actions.pod:1225
20078 msgid "findfs-label"
20082 #: ../fish/guestfish-actions.pod:1227
20085 " findfs-label label\n"
20090 #: ../fish/guestfish-actions.pod:1233
20091 msgid "To find the label of a filesystem, use L</vfs-label>."
20095 #: ../fish/guestfish-actions.pod:1235
20096 msgid "findfs-uuid"
20100 #: ../fish/guestfish-actions.pod:1237
20103 " findfs-uuid uuid\n"
20108 #: ../fish/guestfish-actions.pod:1243
20109 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20113 #: ../fish/guestfish-actions.pod:1245
20118 #: ../fish/guestfish-actions.pod:1247
20121 " fsck fstype device\n"
20126 #: ../fish/guestfish-actions.pod:1277
20131 #: ../fish/guestfish-actions.pod:1279
20139 #: ../fish/guestfish-actions.pod:1286
20140 msgid "get-autosync"
20144 #: ../fish/guestfish-actions.pod:1288
20152 #: ../fish/guestfish-actions.pod:1292
20157 #: ../fish/guestfish-actions.pod:1294
20165 #: ../fish/guestfish-actions.pod:1298
20166 msgid "get-e2label"
20170 #: ../fish/guestfish-actions.pod:1300
20173 " get-e2label device\n"
20178 #: ../fish/guestfish-actions.pod:1312
20183 #: ../fish/guestfish-actions.pod:1314
20186 " get-e2uuid device\n"
20191 #: ../fish/guestfish-actions.pod:1326
20192 msgid "get-memsize"
20196 #: ../fish/guestfish-actions.pod:1328
20204 #: ../fish/guestfish-actions.pod:1333
20206 "If L</set-memsize> was not called on this handle, and if "
20207 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20208 "value for memsize."
20212 #: ../fish/guestfish-actions.pod:1340
20213 msgid "get-network"
20217 #: ../fish/guestfish-actions.pod:1342
20225 #: ../fish/guestfish-actions.pod:1346
20230 #: ../fish/guestfish-actions.pod:1348
20238 #: ../fish/guestfish-actions.pod:1355
20243 #: ../fish/guestfish-actions.pod:1357
20248 #: ../fish/guestfish-actions.pod:1359
20256 #: ../fish/guestfish-actions.pod:1366
20261 #: ../fish/guestfish-actions.pod:1368
20269 #: ../fish/guestfish-actions.pod:1375
20270 msgid "get-recovery-proc"
20274 #: ../fish/guestfish-actions.pod:1377
20277 " get-recovery-proc\n"
20282 #: ../fish/guestfish-actions.pod:1381
20283 msgid "get-selinux"
20287 #: ../fish/guestfish-actions.pod:1383
20295 #: ../fish/guestfish-actions.pod:1385
20297 "This returns the current setting of the selinux flag which is passed to the "
20298 "appliance at boot time. See L</set-selinux>."
20302 #: ../fish/guestfish-actions.pod:1391
20307 #: ../fish/guestfish-actions.pod:1393
20315 #: ../fish/guestfish-actions.pod:1400
20320 #: ../fish/guestfish-actions.pod:1402
20328 #: ../fish/guestfish-actions.pod:1406
20333 #: ../fish/guestfish-actions.pod:1408
20341 #: ../fish/guestfish-actions.pod:1410
20343 "Return the current umask. By default the umask is C<022> unless it has been "
20344 "set by calling L</umask>."
20348 #: ../fish/guestfish-actions.pod:1413
20349 msgid "get-verbose"
20353 #: ../fish/guestfish-actions.pod:1415
20361 #: ../fish/guestfish-actions.pod:1419
20366 #: ../fish/guestfish-actions.pod:1421
20374 #: ../fish/guestfish-actions.pod:1425
20375 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20379 #: ../fish/guestfish-actions.pod:1428
20384 #: ../fish/guestfish-actions.pod:1430
20387 " getxattrs path\n"
20392 #: ../fish/guestfish-actions.pod:1438
20393 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20397 #: ../fish/guestfish-actions.pod:1440
20398 msgid "glob-expand"
20402 #: ../fish/guestfish-actions.pod:1442
20405 " glob-expand pattern\n"
20410 #: ../fish/guestfish-actions.pod:1455
20415 #: ../fish/guestfish-actions.pod:1457
20418 " grep regex path\n"
20423 #: ../fish/guestfish-actions.pod:1465
20428 #: ../fish/guestfish-actions.pod:1467
20431 " grepi regex path\n"
20436 #: ../fish/guestfish-actions.pod:1475
20437 msgid "grub-install"
20441 #: ../fish/guestfish-actions.pod:1477
20444 " grub-install root device\n"
20449 #: ../fish/guestfish-actions.pod:1493
20454 #: ../fish/guestfish-actions.pod:1495
20462 #: ../fish/guestfish-actions.pod:1503
20467 #: ../fish/guestfish-actions.pod:1505
20470 " head-n nrlines path\n"
20475 #: ../fish/guestfish-actions.pod:1518
20480 #: ../fish/guestfish-actions.pod:1520
20488 #: ../fish/guestfish-actions.pod:1528
20493 #: ../fish/guestfish-actions.pod:1530
20496 " initrd-cat initrdpath filename\n"
20501 #: ../fish/guestfish-actions.pod:1542
20502 msgid "See also L</initrd-list>."
20506 #: ../fish/guestfish-actions.pod:1547
20507 msgid "initrd-list"
20511 #: ../fish/guestfish-actions.pod:1549
20514 " initrd-list path\n"
20519 #: ../fish/guestfish-actions.pod:1561
20520 msgid "inotify-add-watch"
20524 #: ../fish/guestfish-actions.pod:1563
20527 " inotify-add-watch path mask\n"
20532 #: ../fish/guestfish-actions.pod:1575
20533 msgid "inotify-close"
20537 #: ../fish/guestfish-actions.pod:1577
20545 #: ../fish/guestfish-actions.pod:1583
20546 msgid "inotify-files"
20550 #: ../fish/guestfish-actions.pod:1585
20558 #: ../fish/guestfish-actions.pod:1587
20560 "This function is a helpful wrapper around L</inotify-read> which just "
20561 "returns a list of pathnames of objects that were touched. The returned "
20562 "pathnames are sorted and deduplicated."
20566 #: ../fish/guestfish-actions.pod:1591
20567 msgid "inotify-init"
20571 #: ../fish/guestfish-actions.pod:1593
20574 " inotify-init maxevents\n"
20579 #: ../fish/guestfish-actions.pod:1599
20581 "C<maxevents> is the maximum number of events which will be queued up between "
20582 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20583 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20584 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20585 "but records the fact that it threw them away by setting a flag "
20586 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20590 #: ../fish/guestfish-actions.pod:1609
20592 "Before any events are generated, you have to add some watches to the "
20593 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20594 "L</inotify-watch-all>."
20598 #: ../fish/guestfish-actions.pod:1615
20600 "Queued up events should be read periodically by calling L</inotify-read> (or "
20601 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20602 "If you don't read the events out often enough then you risk the internal "
20603 "queue overflowing."
20607 #: ../fish/guestfish-actions.pod:1622
20609 "The handle should be closed after use by calling L</inotify-close>. This "
20610 "also removes any watches automatically."
20614 #: ../fish/guestfish-actions.pod:1631
20615 msgid "inotify-read"
20619 #: ../fish/guestfish-actions.pod:1633
20627 #: ../fish/guestfish-actions.pod:1646
20628 msgid "inotify-rm-watch"
20632 #: ../fish/guestfish-actions.pod:1648
20635 " inotify-rm-watch wd\n"
20640 #: ../fish/guestfish-actions.pod:1650
20641 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20645 #: ../fish/guestfish-actions.pod:1653
20646 msgid "inspect-get-arch"
20650 #: ../fish/guestfish-actions.pod:1655
20653 " inspect-get-arch root\n"
20658 #: ../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
20660 "This function should only be called with a root device string as returned by "
20665 #: ../fish/guestfish-actions.pod:1660
20667 "This returns the architecture of the inspected operating system. The "
20668 "possible return values are listed under L</file-architecture>."
20672 #: ../fish/guestfish-actions.pod:1669
20673 msgid "inspect-get-distro"
20677 #: ../fish/guestfish-actions.pod:1671
20680 " inspect-get-distro root\n"
20685 #: ../fish/guestfish-actions.pod:1743
20686 msgid "inspect-get-filesystems"
20690 #: ../fish/guestfish-actions.pod:1745
20693 " inspect-get-filesystems root\n"
20698 #: ../fish/guestfish-actions.pod:1758
20700 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20701 "L</inspect-get-mountpoints>."
20705 #: ../fish/guestfish-actions.pod:1761
20706 msgid "inspect-get-hostname"
20710 #: ../fish/guestfish-actions.pod:1763
20713 " inspect-get-hostname root\n"
20718 #: ../fish/guestfish-actions.pod:1776
20719 msgid "inspect-get-major-version"
20723 #: ../fish/guestfish-actions.pod:1778
20726 " inspect-get-major-version root\n"
20731 #: ../fish/guestfish-actions.pod:1797
20732 msgid "inspect-get-minor-version"
20736 #: ../fish/guestfish-actions.pod:1799
20739 " inspect-get-minor-version root\n"
20744 #: ../fish/guestfish-actions.pod:1809
20746 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20747 "L</inspect-get-major-version>."
20751 #: ../fish/guestfish-actions.pod:1812
20752 msgid "inspect-get-mountpoints"
20756 #: ../fish/guestfish-actions.pod:1814
20759 " inspect-get-mountpoints root\n"
20764 #: ../fish/guestfish-actions.pod:1832
20766 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20767 "L</inspect-get-filesystems>."
20771 #: ../fish/guestfish-actions.pod:1835
20772 msgid "inspect-get-package-format"
20776 #: ../fish/guestfish-actions.pod:1837
20779 " inspect-get-package-format root\n"
20784 #: ../fish/guestfish-actions.pod:1842
20786 "This function and L</inspect-get-package-management> return the package "
20787 "format and package management tool used by the inspected operating system. "
20788 "For example for Fedora these functions would return C<rpm> (package format) "
20789 "and C<yum> (package management)."
20793 #: ../fish/guestfish-actions.pod:1857
20794 msgid "inspect-get-package-management"
20798 #: ../fish/guestfish-actions.pod:1859
20801 " inspect-get-package-management root\n"
20806 #: ../fish/guestfish-actions.pod:1864
20808 "L</inspect-get-package-format> and this function return the package format "
20809 "and package management tool used by the inspected operating system. For "
20810 "example for Fedora these functions would return C<rpm> (package format) and "
20811 "C<yum> (package management)."
20815 #: ../fish/guestfish-actions.pod:1881
20816 msgid "inspect-get-product-name"
20820 #: ../fish/guestfish-actions.pod:1883
20823 " inspect-get-product-name root\n"
20828 #: ../fish/guestfish-actions.pod:1898
20829 msgid "inspect-get-roots"
20833 #: ../fish/guestfish-actions.pod:1900
20836 " inspect-get-roots\n"
20841 #: ../fish/guestfish-actions.pod:1902
20843 "This function is a convenient way to get the list of root devices, as "
20844 "returned from a previous call to L</inspect-os>, but without redoing the "
20845 "whole inspection process."
20849 #: ../fish/guestfish-actions.pod:1906
20851 "This returns an empty list if either no root devices were found or the "
20852 "caller has not called L</inspect-os>."
20856 #: ../fish/guestfish-actions.pod:1911
20857 msgid "inspect-get-type"
20861 #: ../fish/guestfish-actions.pod:1913
20864 " inspect-get-type root\n"
20869 #: ../fish/guestfish-actions.pod:1946
20870 msgid "inspect-get-windows-systemroot"
20874 #: ../fish/guestfish-actions.pod:1948
20877 " inspect-get-windows-systemroot root\n"
20882 #: ../fish/guestfish-actions.pod:1962
20883 msgid "inspect-list-applications"
20887 #: ../fish/guestfish-actions.pod:1964
20890 " inspect-list-applications root\n"
20895 #: ../fish/guestfish-actions.pod:1971
20897 "I<Note:> This call works differently from other parts of the inspection "
20898 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
20899 "then mount up the disks, before calling this. Listing applications is a "
20900 "significantly more difficult operation which requires access to the full "
20901 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
20902 "are just returning data cached in the libguestfs handle, this call actually "
20903 "reads parts of the mounted filesystems during the call."
20907 #: ../fish/guestfish-actions.pod:2061
20912 #: ../fish/guestfish-actions.pod:2063
20920 #: ../fish/guestfish-actions.pod:2078
20922 "You can pass the root string(s) returned to other L</inspect-get-*> "
20923 "functions in order to query further information about each operating system, "
20924 "such as the name and version."
20928 #: ../fish/guestfish-actions.pod:2083
20930 "This function uses other libguestfs features such as L</mount-ro> and "
20931 "L</umount-all> in order to mount and unmount filesystems and look at the "
20932 "contents. This should be called with no disks currently mounted. The "
20933 "function may also use Augeas, so any existing Augeas handle will be closed."
20937 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2297
20938 msgid "See also L</list-filesystems>."
20942 #: ../fish/guestfish-actions.pod:2097
20943 msgid "is-blockdev"
20947 #: ../fish/guestfish-actions.pod:2099
20950 " is-blockdev path\n"
20955 #: ../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
20956 msgid "See also L</stat>."
20960 #: ../fish/guestfish-actions.pod:2106
20965 #: ../fish/guestfish-actions.pod:2108
20973 #: ../fish/guestfish-actions.pod:2115
20978 #: ../fish/guestfish-actions.pod:2117
20981 " is-chardev path\n"
20986 #: ../fish/guestfish-actions.pod:2124
20991 #: ../fish/guestfish-actions.pod:2126
20999 #: ../fish/guestfish-actions.pod:2133
21004 #: ../fish/guestfish-actions.pod:2135
21012 #: ../fish/guestfish-actions.pod:2143
21017 #: ../fish/guestfish-actions.pod:2145
21025 #: ../fish/guestfish-actions.pod:2152
21030 #: ../fish/guestfish-actions.pod:2154
21038 #: ../fish/guestfish-actions.pod:2162
21039 msgid "is-launching"
21043 #: ../fish/guestfish-actions.pod:2164
21051 #: ../fish/guestfish-actions.pod:2171
21056 #: ../fish/guestfish-actions.pod:2173
21064 #: ../fish/guestfish-actions.pod:2178
21069 #: ../fish/guestfish-actions.pod:2180
21077 #: ../fish/guestfish-actions.pod:2187
21082 #: ../fish/guestfish-actions.pod:2189
21085 " is-socket path\n"
21090 #: ../fish/guestfish-actions.pod:2196
21095 #: ../fish/guestfish-actions.pod:2198
21098 " is-symlink path\n"
21103 #: ../fish/guestfish-actions.pod:2205
21104 msgid "kill-subprocess"
21108 #: ../fish/guestfish-actions.pod:2207
21111 " kill-subprocess\n"
21116 #: ../fish/guestfish-actions.pod:2211
21121 #: ../fish/guestfish-actions.pod:2213
21126 #: ../fish/guestfish-actions.pod:2215
21134 #: ../fish/guestfish-actions.pod:2223
21139 #: ../fish/guestfish-actions.pod:2225
21142 " lchown owner group path\n"
21147 #: ../fish/guestfish-actions.pod:2227
21149 "Change the file owner to C<owner> and group to C<group>. This is like "
21150 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
21155 #: ../fish/guestfish-actions.pod:2235
21160 #: ../fish/guestfish-actions.pod:2237
21163 " lgetxattrs path\n"
21168 #: ../fish/guestfish-actions.pod:2239
21170 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21171 "it returns the extended attributes of the link itself."
21175 #: ../fish/guestfish-actions.pod:2243
21176 msgid "list-devices"
21180 #: ../fish/guestfish-actions.pod:2245
21188 #: ../fish/guestfish-actions.pod:2253
21189 msgid "list-filesystems"
21193 #: ../fish/guestfish-actions.pod:2255
21196 " list-filesystems\n"
21201 #: ../fish/guestfish-actions.pod:2274
21203 "This command runs other libguestfs commands, which might include L</mount> "
21204 "and L</umount>, and therefore you should use this soon after launch and only "
21205 "when nothing is mounted."
21209 #: ../fish/guestfish-actions.pod:2278
21211 "Not all of the filesystems returned will be mountable. In particular, swap "
21212 "partitions are returned in the list. Also this command does not check that "
21213 "each filesystem found is valid and mountable, and some filesystems might be "
21214 "mountable but require special options. Filesystems may not all belong to a "
21215 "single logical operating system (use L</inspect-os> to look for OSes)."
21219 #: ../fish/guestfish-actions.pod:2286
21220 msgid "list-partitions"
21224 #: ../fish/guestfish-actions.pod:2288
21227 " list-partitions\n"
21232 #: ../fish/guestfish-actions.pod:2294
21234 "This does not return logical volumes. For that you will need to call "
21239 #: ../fish/guestfish-actions.pod:2299
21244 #: ../fish/guestfish-actions.pod:2301
21252 #: ../fish/guestfish-actions.pod:2309
21257 #: ../fish/guestfish-actions.pod:2311
21260 " ln target linkname\n"
21265 #: ../fish/guestfish-actions.pod:2315
21270 #: ../fish/guestfish-actions.pod:2317
21273 " ln-f target linkname\n"
21278 #: ../fish/guestfish-actions.pod:2322
21283 #: ../fish/guestfish-actions.pod:2324
21286 " ln-s target linkname\n"
21291 #: ../fish/guestfish-actions.pod:2328
21296 #: ../fish/guestfish-actions.pod:2330
21299 " ln-sf target linkname\n"
21304 #: ../fish/guestfish-actions.pod:2335
21305 msgid "lremovexattr"
21309 #: ../fish/guestfish-actions.pod:2337
21312 " lremovexattr xattr path\n"
21317 #: ../fish/guestfish-actions.pod:2339
21319 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21320 "it removes an extended attribute of the link itself."
21324 #: ../fish/guestfish-actions.pod:2343
21329 #: ../fish/guestfish-actions.pod:2345
21337 #: ../fish/guestfish-actions.pod:2351
21339 "This command is mostly useful for interactive sessions. Programs should "
21340 "probably use L</readdir> instead."
21344 #: ../fish/guestfish-actions.pod:2354
21349 #: ../fish/guestfish-actions.pod:2356
21352 " lsetxattr xattr val vallen path\n"
21357 #: ../fish/guestfish-actions.pod:2358
21359 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21360 "sets an extended attribute of the link itself."
21364 #: ../fish/guestfish-actions.pod:2362
21369 #: ../fish/guestfish-actions.pod:2364
21377 #: ../fish/guestfish-actions.pod:2368
21379 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21380 "the link is stat-ed, not the file it refers to."
21384 #: ../fish/guestfish-actions.pod:2374
21389 #: ../fish/guestfish-actions.pod:2376
21392 " lstatlist path 'names ...'\n"
21397 #: ../fish/guestfish-actions.pod:2378
21399 "This call allows you to perform the L</lstat> operation on multiple files, "
21400 "where all files are in the directory C<path>. C<names> is the list of files "
21401 "from this directory."
21405 #: ../fish/guestfish-actions.pod:2387
21407 "This call is intended for programs that want to efficiently list a directory "
21408 "contents without making many round-trips. See also L</lxattrlist> for a "
21409 "similarly efficient call for getting extended attributes. Very long "
21410 "directory listings might cause the protocol message size to be exceeded, "
21411 "causing this call to fail. The caller must split up such requests into "
21412 "smaller groups of names."
21416 #: ../fish/guestfish-actions.pod:2395
21417 msgid "luks-add-key"
21421 #: ../fish/guestfish-actions.pod:2397
21424 " luks-add-key device keyslot\n"
21429 #: ../fish/guestfish-actions.pod:2404
21431 "Note that if C<keyslot> already contains a key, then this command will "
21432 "fail. You have to use L</luks-kill-slot> first to remove that key."
21436 #: ../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
21438 "This command has one or more key or passphrase parameters. Guestfish will "
21439 "prompt for these separately."
21443 #: ../fish/guestfish-actions.pod:2411
21448 #: ../fish/guestfish-actions.pod:2413
21451 " luks-close device\n"
21456 #: ../fish/guestfish-actions.pod:2415
21458 "This closes a LUKS device that was created earlier by L</luks-open> or "
21459 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
21460 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
21461 "underlying block device."
21465 #: ../fish/guestfish-actions.pod:2421
21466 msgid "luks-format"
21470 #: ../fish/guestfish-actions.pod:2423
21473 " luks-format device keyslot\n"
21478 #: ../fish/guestfish-actions.pod:2436
21479 msgid "luks-format-cipher"
21483 #: ../fish/guestfish-actions.pod:2438
21486 " luks-format-cipher device keyslot cipher\n"
21491 #: ../fish/guestfish-actions.pod:2440
21493 "This command is the same as L</luks-format> but it also allows you to set "
21494 "the C<cipher> used."
21498 #: ../fish/guestfish-actions.pod:2449
21499 msgid "luks-kill-slot"
21503 #: ../fish/guestfish-actions.pod:2451
21506 " luks-kill-slot device keyslot\n"
21511 #: ../fish/guestfish-actions.pod:2460
21516 #: ../fish/guestfish-actions.pod:2462
21519 " luks-open device mapname\n"
21524 #: ../fish/guestfish-actions.pod:2476
21526 "If this block device contains LVM volume groups, then calling L</vgscan> "
21527 "followed by L</vg-activate-all> will make them visible."
21531 #: ../fish/guestfish-actions.pod:2483
21532 msgid "luks-open-ro"
21536 #: ../fish/guestfish-actions.pod:2485
21539 " luks-open-ro device mapname\n"
21544 #: ../fish/guestfish-actions.pod:2487
21546 "This is the same as L</luks-open> except that a read-only mapping is "
21551 #: ../fish/guestfish-actions.pod:2493
21556 #: ../fish/guestfish-actions.pod:2495
21559 " lvcreate logvol volgroup mbytes\n"
21564 #: ../fish/guestfish-actions.pod:2500
21565 msgid "lvm-canonical-lv-name"
21569 #: ../fish/guestfish-actions.pod:2502
21572 " lvm-canonical-lv-name lvname\n"
21577 #: ../fish/guestfish-actions.pod:2511
21578 msgid "See also L</is-lv>."
21582 #: ../fish/guestfish-actions.pod:2513
21583 msgid "lvm-clear-filter"
21587 #: ../fish/guestfish-actions.pod:2515
21590 " lvm-clear-filter\n"
21595 #: ../fish/guestfish-actions.pod:2517
21597 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21602 #: ../fish/guestfish-actions.pod:2523
21603 msgid "lvm-remove-all"
21607 #: ../fish/guestfish-actions.pod:2525
21610 " lvm-remove-all\n"
21615 #: ../fish/guestfish-actions.pod:2533
21616 msgid "lvm-set-filter"
21620 #: ../fish/guestfish-actions.pod:2535
21623 " lvm-set-filter 'devices ...'\n"
21628 #: ../fish/guestfish-actions.pod:2560
21633 #: ../fish/guestfish-actions.pod:2562
21636 " lvremove device\n"
21641 #: ../fish/guestfish-actions.pod:2570
21646 #: ../fish/guestfish-actions.pod:2572
21649 " lvrename logvol newlogvol\n"
21654 #: ../fish/guestfish-actions.pod:2576
21659 #: ../fish/guestfish-actions.pod:2578
21662 " lvresize device mbytes\n"
21667 #: ../fish/guestfish-actions.pod:2584
21668 msgid "lvresize-free"
21672 #: ../fish/guestfish-actions.pod:2586
21675 " lvresize-free lv percent\n"
21680 #: ../fish/guestfish-actions.pod:2594
21685 #: ../fish/guestfish-actions.pod:2596
21693 #: ../fish/guestfish-actions.pod:2604
21694 msgid "See also L</lvs-full>, L</list-filesystems>."
21698 #: ../fish/guestfish-actions.pod:2606
21703 #: ../fish/guestfish-actions.pod:2608
21711 #: ../fish/guestfish-actions.pod:2613
21716 #: ../fish/guestfish-actions.pod:2615
21724 #: ../fish/guestfish-actions.pod:2619
21729 #: ../fish/guestfish-actions.pod:2621
21732 " lxattrlist path 'names ...'\n"
21737 #: ../fish/guestfish-actions.pod:2637
21739 "This call is intended for programs that want to efficiently list a directory "
21740 "contents without making many round-trips. See also L</lstatlist> for a "
21741 "similarly efficient call for getting standard stats. Very long directory "
21742 "listings might cause the protocol message size to be exceeded, causing this "
21743 "call to fail. The caller must split up such requests into smaller groups of "
21748 #: ../fish/guestfish-actions.pod:2645
21753 #: ../fish/guestfish-actions.pod:2647
21761 #: ../fish/guestfish-actions.pod:2651
21766 #: ../fish/guestfish-actions.pod:2653
21769 " mkdir-mode path mode\n"
21774 #: ../fish/guestfish-actions.pod:2662
21775 msgid "See also L</mkdir>, L</umask>"
21779 #: ../fish/guestfish-actions.pod:2664
21784 #: ../fish/guestfish-actions.pod:2666
21792 #: ../fish/guestfish-actions.pod:2671
21797 #: ../fish/guestfish-actions.pod:2673
21800 " mkdtemp template\n"
21805 #: ../fish/guestfish-actions.pod:2694
21810 #: ../fish/guestfish-actions.pod:2696
21813 " mke2fs-J fstype blocksize device journal\n"
21818 #: ../fish/guestfish-actions.pod:2704
21819 msgid "See also L</mke2journal>."
21823 #: ../fish/guestfish-actions.pod:2706
21828 #: ../fish/guestfish-actions.pod:2708
21831 " mke2fs-JL fstype blocksize device label\n"
21836 #: ../fish/guestfish-actions.pod:2713
21837 msgid "See also L</mke2journal-L>."
21841 #: ../fish/guestfish-actions.pod:2715
21846 #: ../fish/guestfish-actions.pod:2717
21849 " mke2fs-JU fstype blocksize device uuid\n"
21854 #: ../fish/guestfish-actions.pod:2722
21855 msgid "See also L</mke2journal-U>."
21859 #: ../fish/guestfish-actions.pod:2724
21860 msgid "mke2journal"
21864 #: ../fish/guestfish-actions.pod:2726
21867 " mke2journal blocksize device\n"
21872 #: ../fish/guestfish-actions.pod:2733
21873 msgid "mke2journal-L"
21877 #: ../fish/guestfish-actions.pod:2735
21880 " mke2journal-L blocksize label device\n"
21885 #: ../fish/guestfish-actions.pod:2739
21886 msgid "mke2journal-U"
21890 #: ../fish/guestfish-actions.pod:2741
21893 " mke2journal-U blocksize uuid device\n"
21898 #: ../fish/guestfish-actions.pod:2745
21903 #: ../fish/guestfish-actions.pod:2747
21906 " mkfifo mode path\n"
21911 #: ../fish/guestfish-actions.pod:2749
21913 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21914 "is just a convenient wrapper around L</mknod>."
21918 #: ../fish/guestfish-actions.pod:2755
21923 #: ../fish/guestfish-actions.pod:2757
21926 " mkfs fstype device\n"
21931 #: ../fish/guestfish-actions.pod:2763
21936 #: ../fish/guestfish-actions.pod:2765
21939 " mkfs-b fstype blocksize device\n"
21944 #: ../fish/guestfish-actions.pod:2767
21946 "This call is similar to L</mkfs>, but it allows you to control the block "
21947 "size of the resulting filesystem. Supported block sizes depend on the "
21948 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21952 #: ../fish/guestfish-actions.pod:2775
21953 msgid "mkmountpoint"
21957 #: ../fish/guestfish-actions.pod:2777
21960 " mkmountpoint exemptpath\n"
21965 #: ../fish/guestfish-actions.pod:2779
21967 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21968 "to create extra mountpoints before mounting the first filesystem."
21972 #: ../fish/guestfish-actions.pod:2803
21974 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21975 "unexpected errors if you try to mix these calls. It is safest to manually "
21976 "unmount filesystems and remove mountpoints after use."
21980 #: ../fish/guestfish-actions.pod:2807
21982 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21983 "for this to work for manual mountpoints, you must ensure that the innermost "
21984 "mountpoints have the longest pathnames, as in the example code above."
21988 #: ../fish/guestfish-actions.pod:2814
21990 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21991 "that L</umount-all> is called when the handle is closed which can also "
21992 "trigger these issues."
21996 #: ../fish/guestfish-actions.pod:2818
22001 #: ../fish/guestfish-actions.pod:2820
22004 " mknod mode devmajor devminor path\n"
22009 #: ../fish/guestfish-actions.pod:2830
22011 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
22012 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
22013 "regular file). These constants are available in the standard Linux header "
22014 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
22015 "wrappers around this command which bitwise OR in the appropriate constant "
22020 #: ../fish/guestfish-actions.pod:2840
22025 #: ../fish/guestfish-actions.pod:2842
22028 " mknod-b mode devmajor devminor path\n"
22033 #: ../fish/guestfish-actions.pod:2844
22035 "This call creates a block device node called C<path> with mode C<mode> and "
22036 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22037 "wrapper around L</mknod>."
22041 #: ../fish/guestfish-actions.pod:2850
22046 #: ../fish/guestfish-actions.pod:2852
22049 " mknod-c mode devmajor devminor path\n"
22054 #: ../fish/guestfish-actions.pod:2854
22056 "This call creates a char device node called C<path> with mode C<mode> and "
22057 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22058 "wrapper around L</mknod>."
22062 #: ../fish/guestfish-actions.pod:2860
22067 #: ../fish/guestfish-actions.pod:2862
22075 #: ../fish/guestfish-actions.pod:2866
22080 #: ../fish/guestfish-actions.pod:2868
22083 " mkswap-L label device\n"
22088 #: ../fish/guestfish-actions.pod:2876
22093 #: ../fish/guestfish-actions.pod:2878
22096 " mkswap-U uuid device\n"
22101 #: ../fish/guestfish-actions.pod:2882
22102 msgid "mkswap-file"
22106 #: ../fish/guestfish-actions.pod:2884
22109 " mkswap-file path\n"
22114 #: ../fish/guestfish-actions.pod:2888
22116 "This command just writes a swap file signature to an existing file. To "
22117 "create the file itself, use something like L</fallocate>."
22121 #: ../fish/guestfish-actions.pod:2891
22126 #: ../fish/guestfish-actions.pod:2893
22129 " modprobe modulename\n"
22134 #: ../fish/guestfish-actions.pod:2900
22139 #: ../fish/guestfish-actions.pod:2902
22142 " mount device mountpoint\n"
22147 #: ../fish/guestfish-actions.pod:2918
22149 "B<Important note:> When you use this call, the filesystem options C<sync> "
22150 "and C<noatime> are set implicitly. This was originally done because we "
22151 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22152 "very large negative performance impact and negligible effect on "
22153 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22154 "code that needs performance, and instead use L</mount-options> (use an empty "
22155 "string for the first parameter if you don't want any options)."
22159 #: ../fish/guestfish-actions.pod:2928
22164 #: ../fish/guestfish-actions.pod:2930
22167 " mount-loop file mountpoint\n"
22172 #: ../fish/guestfish-actions.pod:2936
22173 msgid "mount-options"
22177 #: ../fish/guestfish-actions.pod:2938
22180 " mount-options options device mountpoint\n"
22185 #: ../fish/guestfish-actions.pod:2940
22187 "This is the same as the L</mount> command, but it allows you to set the "
22188 "mount options as for the L<mount(8)> I<-o> flag."
22192 #: ../fish/guestfish-actions.pod:2948
22197 #: ../fish/guestfish-actions.pod:2950
22200 " mount-ro device mountpoint\n"
22205 #: ../fish/guestfish-actions.pod:2952
22207 "This is the same as the L</mount> command, but it mounts the filesystem with "
22208 "the read-only (I<-o ro>) flag."
22212 #: ../fish/guestfish-actions.pod:2955
22217 #: ../fish/guestfish-actions.pod:2957
22220 " mount-vfs options vfstype device mountpoint\n"
22225 #: ../fish/guestfish-actions.pod:2959
22227 "This is the same as the L</mount> command, but it allows you to set both the "
22228 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22232 #: ../fish/guestfish-actions.pod:2963
22233 msgid "mountpoints"
22237 #: ../fish/guestfish-actions.pod:2965
22245 #: ../fish/guestfish-actions.pod:2967
22247 "This call is similar to L</mounts>. That call returns a list of devices. "
22248 "This one returns a hash table (map) of device name to directory where the "
22249 "device is mounted."
22253 #: ../fish/guestfish-actions.pod:2971
22258 #: ../fish/guestfish-actions.pod:2973
22266 #: ../fish/guestfish-actions.pod:2980
22267 msgid "See also: L</mountpoints>"
22271 #: ../fish/guestfish-actions.pod:2982
22276 #: ../fish/guestfish-actions.pod:2984
22284 #: ../fish/guestfish-actions.pod:2989
22285 msgid "ntfs-3g-probe"
22289 #: ../fish/guestfish-actions.pod:2991
22292 " ntfs-3g-probe true|false device\n"
22297 #: ../fish/guestfish-actions.pod:3005
22302 #: ../fish/guestfish-actions.pod:3007
22305 " ntfsresize device\n"
22310 #: ../fish/guestfish-actions.pod:3013
22311 msgid "ntfsresize-size"
22315 #: ../fish/guestfish-actions.pod:3015
22318 " ntfsresize-size device size\n"
22323 #: ../fish/guestfish-actions.pod:3017
22325 "This command is the same as L</ntfsresize> except that it allows you to "
22326 "specify the new size (in bytes) explicitly."
22330 #: ../fish/guestfish-actions.pod:3020
22335 #: ../fish/guestfish-actions.pod:3022
22338 " part-add device prlogex startsect endsect\n"
22343 #: ../fish/guestfish-actions.pod:3024
22345 "This command adds a partition to C<device>. If there is no partition table "
22346 "on the device, call L</part-init> first."
22350 #: ../fish/guestfish-actions.pod:3036
22352 "Creating a partition which covers the whole disk is not so easy. Use "
22353 "L</part-disk> to do that."
22357 #: ../fish/guestfish-actions.pod:3039
22362 #: ../fish/guestfish-actions.pod:3041
22365 " part-del device partnum\n"
22370 #: ../fish/guestfish-actions.pod:3049
22375 #: ../fish/guestfish-actions.pod:3051
22378 " part-disk device parttype\n"
22383 #: ../fish/guestfish-actions.pod:3053
22385 "This command is simply a combination of L</part-init> followed by "
22386 "L</part-add> to create a single primary partition covering the whole disk."
22390 #: ../fish/guestfish-actions.pod:3057
22392 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22393 "possible values are described in L</part-init>."
22397 #: ../fish/guestfish-actions.pod:3063
22398 msgid "part-get-bootable"
22402 #: ../fish/guestfish-actions.pod:3065
22405 " part-get-bootable device partnum\n"
22410 #: ../fish/guestfish-actions.pod:3070
22411 msgid "See also L</part-set-bootable>."
22415 #: ../fish/guestfish-actions.pod:3072
22416 msgid "part-get-mbr-id"
22420 #: ../fish/guestfish-actions.pod:3074
22423 " part-get-mbr-id device partnum\n"
22428 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22430 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22431 "undefined results for other partition table types (see "
22432 "L</part-get-parttype>)."
22436 #: ../fish/guestfish-actions.pod:3083
22437 msgid "part-get-parttype"
22441 #: ../fish/guestfish-actions.pod:3085
22444 " part-get-parttype device\n"
22449 #: ../fish/guestfish-actions.pod:3090
22451 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22452 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22453 "possible, although unusual. See L</part-init> for a full list."
22457 #: ../fish/guestfish-actions.pod:3095
22462 #: ../fish/guestfish-actions.pod:3097
22465 " part-init device parttype\n"
22470 #: ../fish/guestfish-actions.pod:3103
22472 "Initially there are no partitions. Following this, you should call "
22473 "L</part-add> for each partition required."
22477 #: ../fish/guestfish-actions.pod:3166
22482 #: ../fish/guestfish-actions.pod:3168
22485 " part-list device\n"
22490 #: ../fish/guestfish-actions.pod:3183
22492 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22493 "the device's sector size, see L</blockdev-getss>."
22497 #: ../fish/guestfish-actions.pod:3196
22498 msgid "part-set-bootable"
22502 #: ../fish/guestfish-actions.pod:3198
22505 " part-set-bootable device partnum true|false\n"
22510 #: ../fish/guestfish-actions.pod:3207
22511 msgid "part-set-mbr-id"
22515 #: ../fish/guestfish-actions.pod:3209
22518 " part-set-mbr-id device partnum idbyte\n"
22523 #: ../fish/guestfish-actions.pod:3221
22524 msgid "part-set-name"
22528 #: ../fish/guestfish-actions.pod:3223
22531 " part-set-name device partnum name\n"
22536 #: ../fish/guestfish-actions.pod:3231
22537 msgid "part-to-dev"
22541 #: ../fish/guestfish-actions.pod:3233
22544 " part-to-dev partition\n"
22549 #: ../fish/guestfish-actions.pod:3239
22551 "The named partition must exist, for example as a string returned from "
22552 "L</list-partitions>."
22556 #: ../fish/guestfish-actions.pod:3242
22557 msgid "ping-daemon"
22561 #: ../fish/guestfish-actions.pod:3244
22569 #: ../fish/guestfish-actions.pod:3251
22574 #: ../fish/guestfish-actions.pod:3253
22577 " pread path count offset\n"
22582 #: ../fish/guestfish-actions.pod:3261
22583 msgid "See also L</pwrite>, L</pread-device>."
22587 #: ../fish/guestfish-actions.pod:3266
22588 msgid "pread-device"
22592 #: ../fish/guestfish-actions.pod:3268
22595 " pread-device device count offset\n"
22600 #: ../fish/guestfish-actions.pod:3276
22601 msgid "See also L</pread>."
22605 #: ../fish/guestfish-actions.pod:3281
22610 #: ../fish/guestfish-actions.pod:3283
22613 " pvcreate device\n"
22618 #: ../fish/guestfish-actions.pod:3289
22623 #: ../fish/guestfish-actions.pod:3291
22626 " pvremove device\n"
22631 #: ../fish/guestfish-actions.pod:3300
22636 #: ../fish/guestfish-actions.pod:3302
22639 " pvresize device\n"
22644 #: ../fish/guestfish-actions.pod:3307
22645 msgid "pvresize-size"
22649 #: ../fish/guestfish-actions.pod:3309
22652 " pvresize-size device size\n"
22657 #: ../fish/guestfish-actions.pod:3311
22659 "This command is the same as L</pvresize> except that it allows you to "
22660 "specify the new size (in bytes) explicitly."
22664 #: ../fish/guestfish-actions.pod:3314
22669 #: ../fish/guestfish-actions.pod:3316
22677 #: ../fish/guestfish-actions.pod:3324
22678 msgid "See also L</pvs-full>."
22682 #: ../fish/guestfish-actions.pod:3326
22687 #: ../fish/guestfish-actions.pod:3328
22695 #: ../fish/guestfish-actions.pod:3333
22700 #: ../fish/guestfish-actions.pod:3335
22708 #: ../fish/guestfish-actions.pod:3339
22713 #: ../fish/guestfish-actions.pod:3341
22716 " pwrite path content offset\n"
22721 #: ../fish/guestfish-actions.pod:3352
22722 msgid "See also L</pread>, L</pwrite-device>."
22726 #: ../fish/guestfish-actions.pod:3357
22727 msgid "pwrite-device"
22731 #: ../fish/guestfish-actions.pod:3359
22734 " pwrite-device device content offset\n"
22739 #: ../fish/guestfish-actions.pod:3369
22740 msgid "See also L</pwrite>."
22744 #: ../fish/guestfish-actions.pod:3374
22749 #: ../fish/guestfish-actions.pod:3376
22752 " read-file path\n"
22757 #: ../fish/guestfish-actions.pod:3381
22759 "Unlike L</cat>, this function can correctly handle files that contain "
22760 "embedded ASCII NUL characters. However unlike L</download>, this function "
22761 "is limited in the total size of file that can be handled."
22765 #: ../fish/guestfish-actions.pod:3389
22770 #: ../fish/guestfish-actions.pod:3391
22773 " read-lines path\n"
22778 #: ../fish/guestfish-actions.pod:3398
22780 "Note that this function cannot correctly handle binary files (specifically, "
22781 "files containing C<\\0> character which is treated as end of line). For "
22782 "those you need to use the L</read-file> function which has a more complex "
22787 #: ../fish/guestfish-actions.pod:3403
22792 #: ../fish/guestfish-actions.pod:3405
22800 #: ../fish/guestfish-actions.pod:3457
22802 "This function is primarily intended for use by programs. To get a simple "
22803 "list of names, use L</ls>. To get a printable directory for human "
22804 "consumption, use L</ll>."
22808 #: ../fish/guestfish-actions.pod:3461
22813 #: ../fish/guestfish-actions.pod:3463
22821 #: ../fish/guestfish-actions.pod:3467
22822 msgid "readlinklist"
22826 #: ../fish/guestfish-actions.pod:3469
22829 " readlinklist path 'names ...'\n"
22834 #: ../fish/guestfish-actions.pod:3493
22839 #: ../fish/guestfish-actions.pod:3495
22847 #: ../fish/guestfish-actions.pod:3500
22848 msgid "removexattr"
22852 #: ../fish/guestfish-actions.pod:3502
22855 " removexattr xattr path\n"
22860 #: ../fish/guestfish-actions.pod:3507
22861 msgid "See also: L</lremovexattr>, L<attr(5)>."
22865 #: ../fish/guestfish-actions.pod:3509
22870 #: ../fish/guestfish-actions.pod:3511
22873 " resize2fs device\n"
22878 #: ../fish/guestfish-actions.pod:3516
22880 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22881 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22882 "gives an error about this and sometimes not. In any case, it is always safe "
22883 "to call L</e2fsck-f> before calling this function."
22887 #: ../fish/guestfish-actions.pod:3522
22888 msgid "resize2fs-size"
22892 #: ../fish/guestfish-actions.pod:3524
22895 " resize2fs-size device size\n"
22900 #: ../fish/guestfish-actions.pod:3526
22902 "This command is the same as L</resize2fs> except that it allows you to "
22903 "specify the new size (in bytes) explicitly."
22907 #: ../fish/guestfish-actions.pod:3529
22912 #: ../fish/guestfish-actions.pod:3531
22920 #: ../fish/guestfish-actions.pod:3535
22925 #: ../fish/guestfish-actions.pod:3537
22933 #: ../fish/guestfish-actions.pod:3543
22938 #: ../fish/guestfish-actions.pod:3545
22946 #: ../fish/guestfish-actions.pod:3549
22947 msgid "rmmountpoint"
22951 #: ../fish/guestfish-actions.pod:3551
22954 " rmmountpoint exemptpath\n"
22959 #: ../fish/guestfish-actions.pod:3553
22961 "This calls removes a mountpoint that was previously created with "
22962 "L</mkmountpoint>. See L</mkmountpoint> for full details."
22966 #: ../fish/guestfish-actions.pod:3557
22967 msgid "scrub-device"
22971 #: ../fish/guestfish-actions.pod:3559
22974 " scrub-device device\n"
22979 #: ../fish/guestfish-actions.pod:3570
22984 #: ../fish/guestfish-actions.pod:3572
22987 " scrub-file file\n"
22992 #: ../fish/guestfish-actions.pod:3582
22993 msgid "scrub-freespace"
22997 #: ../fish/guestfish-actions.pod:3584
23000 " scrub-freespace dir\n"
23005 #: ../fish/guestfish-actions.pod:3586
23007 "This command creates the directory C<dir> and then fills it with files until "
23008 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
23009 "deletes them. The intention is to scrub any free space on the partition "
23010 "containing C<dir>."
23014 #: ../fish/guestfish-actions.pod:3595
23019 #: ../fish/guestfish-actions.pod:3597
23024 #: ../fish/guestfish-actions.pod:3599
23027 " set-append append\n"
23032 #: ../fish/guestfish-actions.pod:3610
23033 msgid "set-autosync"
23037 #: ../fish/guestfish-actions.pod:3612
23042 #: ../fish/guestfish-actions.pod:3614
23045 " set-autosync true|false\n"
23050 #: ../fish/guestfish-actions.pod:3616
23052 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23053 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23054 "closed (also if the program exits without closing handles)."
23058 #: ../fish/guestfish-actions.pod:3624
23063 #: ../fish/guestfish-actions.pod:3626
23068 #: ../fish/guestfish-actions.pod:3628
23071 " set-direct true|false\n"
23076 #: ../fish/guestfish-actions.pod:3634
23078 "One consequence of this is that log messages aren't caught by the library "
23079 "and handled by L</set-log-message-callback>, but go straight to stdout."
23083 #: ../fish/guestfish-actions.pod:3643
23084 msgid "set-e2label"
23088 #: ../fish/guestfish-actions.pod:3645
23091 " set-e2label device label\n"
23096 #: ../fish/guestfish-actions.pod:3651
23098 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23099 "label on a filesystem."
23103 #: ../fish/guestfish-actions.pod:3654
23108 #: ../fish/guestfish-actions.pod:3656
23111 " set-e2uuid device uuid\n"
23116 #: ../fish/guestfish-actions.pod:3663
23118 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23119 "UUID of a filesystem."
23123 #: ../fish/guestfish-actions.pod:3666
23124 msgid "set-memsize"
23128 #: ../fish/guestfish-actions.pod:3668
23133 #: ../fish/guestfish-actions.pod:3670
23136 " set-memsize memsize\n"
23141 #: ../fish/guestfish-actions.pod:3672
23143 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23144 "This only has any effect if called before L</launch>."
23148 #: ../fish/guestfish-actions.pod:3683
23149 msgid "set-network"
23153 #: ../fish/guestfish-actions.pod:3685
23158 #: ../fish/guestfish-actions.pod:3687
23161 " set-network true|false\n"
23166 #: ../fish/guestfish-actions.pod:3695
23167 msgid "You must call this before calling L</launch>, otherwise it has no effect."
23171 #: ../fish/guestfish-actions.pod:3698
23176 #: ../fish/guestfish-actions.pod:3700
23181 #: ../fish/guestfish-actions.pod:3702
23184 " set-path searchpath\n"
23189 #: ../fish/guestfish-actions.pod:3711
23194 #: ../fish/guestfish-actions.pod:3713
23199 #: ../fish/guestfish-actions.pod:3715
23207 #: ../fish/guestfish-actions.pod:3735
23208 msgid "set-recovery-proc"
23212 #: ../fish/guestfish-actions.pod:3737
23213 msgid "recovery-proc"
23217 #: ../fish/guestfish-actions.pod:3739
23220 " set-recovery-proc true|false\n"
23225 #: ../fish/guestfish-actions.pod:3741
23227 "If this is called with the parameter C<false> then L</launch> does not "
23228 "create a recovery process. The purpose of the recovery process is to stop "
23229 "runaway qemu processes in the case where the main program aborts abruptly."
23233 #: ../fish/guestfish-actions.pod:3746
23235 "This only has any effect if called before L</launch>, and the default is "
23240 #: ../fish/guestfish-actions.pod:3755
23241 msgid "set-selinux"
23245 #: ../fish/guestfish-actions.pod:3757
23250 #: ../fish/guestfish-actions.pod:3759
23253 " set-selinux true|false\n"
23258 #: ../fish/guestfish-actions.pod:3770
23263 #: ../fish/guestfish-actions.pod:3772
23268 #: ../fish/guestfish-actions.pod:3774
23271 " set-trace true|false\n"
23276 #: ../fish/guestfish-actions.pod:3790
23277 msgid "set-verbose"
23281 #: ../fish/guestfish-actions.pod:3792
23286 #: ../fish/guestfish-actions.pod:3794
23289 " set-verbose true|false\n"
23294 #: ../fish/guestfish-actions.pod:3801
23299 #: ../fish/guestfish-actions.pod:3803
23302 " setcon context\n"
23307 #: ../fish/guestfish-actions.pod:3810
23312 #: ../fish/guestfish-actions.pod:3812
23315 " setxattr xattr val vallen path\n"
23320 #: ../fish/guestfish-actions.pod:3818
23321 msgid "See also: L</lsetxattr>, L<attr(5)>."
23325 #: ../fish/guestfish-actions.pod:3820
23330 #: ../fish/guestfish-actions.pod:3822
23333 " sfdisk device cyls heads sectors 'lines ...'\n"
23338 #: ../fish/guestfish-actions.pod:3844
23339 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23343 #: ../fish/guestfish-actions.pod:3850
23348 #: ../fish/guestfish-actions.pod:3852
23351 " sfdiskM device 'lines ...'\n"
23356 #: ../fish/guestfish-actions.pod:3854
23358 "This is a simplified interface to the L</sfdisk> command, where partition "
23359 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23360 "you don't need to specify the cyls, heads and sectors parameters which were "
23361 "rarely if ever used anyway."
23365 #: ../fish/guestfish-actions.pod:3860
23366 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23370 #: ../fish/guestfish-actions.pod:3866
23375 #: ../fish/guestfish-actions.pod:3868
23378 " sfdisk-N device partnum cyls heads sectors line\n"
23383 #: ../fish/guestfish-actions.pod:3873
23385 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23386 "cyls/heads/sectors parameters."
23390 #: ../fish/guestfish-actions.pod:3876
23391 msgid "See also: L</part-add>"
23395 #: ../fish/guestfish-actions.pod:3881
23396 msgid "sfdisk-disk-geometry"
23400 #: ../fish/guestfish-actions.pod:3883
23403 " sfdisk-disk-geometry device\n"
23408 #: ../fish/guestfish-actions.pod:3885
23410 "This displays the disk geometry of C<device> read from the partition table. "
23411 "Especially in the case where the underlying block device has been resized, "
23412 "this can be different from the kernel's idea of the geometry (see "
23413 "L</sfdisk-kernel-geometry>)."
23417 #: ../fish/guestfish-actions.pod:3893
23418 msgid "sfdisk-kernel-geometry"
23422 #: ../fish/guestfish-actions.pod:3895
23425 " sfdisk-kernel-geometry device\n"
23430 #: ../fish/guestfish-actions.pod:3902
23435 #: ../fish/guestfish-actions.pod:3904
23438 " sfdisk-l device\n"
23443 #: ../fish/guestfish-actions.pod:3910
23444 msgid "See also: L</part-list>"
23448 #: ../fish/guestfish-actions.pod:3912
23453 #: ../fish/guestfish-actions.pod:3914
23461 #: ../fish/guestfish-actions.pod:3919
23462 msgid "This is like L</command>, but passes the command to:"
23466 #: ../fish/guestfish-actions.pod:3927
23467 msgid "All the provisos about L</command> apply to this call."
23471 #: ../fish/guestfish-actions.pod:3929
23476 #: ../fish/guestfish-actions.pod:3931
23479 " sh-lines command\n"
23484 #: ../fish/guestfish-actions.pod:3933
23485 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23489 #: ../fish/guestfish-actions.pod:3936
23490 msgid "See also: L</command-lines>"
23494 #: ../fish/guestfish-actions.pod:3938
23499 #: ../fish/guestfish-actions.pod:3940
23507 #: ../fish/guestfish-actions.pod:3944
23512 #: ../fish/guestfish-actions.pod:3946
23520 #: ../fish/guestfish-actions.pod:3952
23525 #: ../fish/guestfish-actions.pod:3954
23533 #: ../fish/guestfish-actions.pod:3962
23538 #: ../fish/guestfish-actions.pod:3964
23546 #: ../fish/guestfish-actions.pod:3972
23551 #: ../fish/guestfish-actions.pod:3974
23554 " strings-e encoding path\n"
23559 #: ../fish/guestfish-actions.pod:3976
23561 "This is like the L</strings> command, but allows you to specify the encoding "
23562 "of strings that are looked for in the source file C<path>."
23566 #: ../fish/guestfish-actions.pod:3986
23568 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23569 "ISO-8859-X (this is what L</strings> uses)."
23573 #: ../fish/guestfish-actions.pod:4018
23574 msgid "swapoff-device"
23578 #: ../fish/guestfish-actions.pod:4020
23581 " swapoff-device device\n"
23586 #: ../fish/guestfish-actions.pod:4022
23588 "This command disables the libguestfs appliance swap device or partition "
23589 "named C<device>. See L</swapon-device>."
23593 #: ../fish/guestfish-actions.pod:4026
23594 msgid "swapoff-file"
23598 #: ../fish/guestfish-actions.pod:4028
23601 " swapoff-file file\n"
23606 #: ../fish/guestfish-actions.pod:4032
23607 msgid "swapoff-label"
23611 #: ../fish/guestfish-actions.pod:4034
23614 " swapoff-label label\n"
23619 #: ../fish/guestfish-actions.pod:4039
23620 msgid "swapoff-uuid"
23624 #: ../fish/guestfish-actions.pod:4041
23627 " swapoff-uuid uuid\n"
23632 #: ../fish/guestfish-actions.pod:4046
23633 msgid "swapon-device"
23637 #: ../fish/guestfish-actions.pod:4048
23640 " swapon-device device\n"
23645 #: ../fish/guestfish-actions.pod:4050
23647 "This command enables the libguestfs appliance to use the swap device or "
23648 "partition named C<device>. The increased memory is made available for all "
23649 "commands, for example those run using L</command> or L</sh>."
23653 #: ../fish/guestfish-actions.pod:4062
23654 msgid "swapon-file"
23658 #: ../fish/guestfish-actions.pod:4064
23661 " swapon-file file\n"
23666 #: ../fish/guestfish-actions.pod:4066
23667 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
23671 #: ../fish/guestfish-actions.pod:4069
23672 msgid "swapon-label"
23676 #: ../fish/guestfish-actions.pod:4071
23679 " swapon-label label\n"
23684 #: ../fish/guestfish-actions.pod:4073
23686 "This command enables swap to a labeled swap partition. See "
23687 "L</swapon-device> for other notes."
23691 #: ../fish/guestfish-actions.pod:4076
23692 msgid "swapon-uuid"
23696 #: ../fish/guestfish-actions.pod:4078
23699 " swapon-uuid uuid\n"
23704 #: ../fish/guestfish-actions.pod:4080
23706 "This command enables swap to a swap partition with the given UUID. See "
23707 "L</swapon-device> for other notes."
23711 #: ../fish/guestfish-actions.pod:4083
23716 #: ../fish/guestfish-actions.pod:4085
23724 #: ../fish/guestfish-actions.pod:4093
23729 #: ../fish/guestfish-actions.pod:4095
23737 #: ../fish/guestfish-actions.pod:4103
23742 #: ../fish/guestfish-actions.pod:4105
23745 " tail-n nrlines path\n"
23750 #: ../fish/guestfish-actions.pod:4118
23755 #: ../fish/guestfish-actions.pod:4120
23758 " tar-in (tarfile|-) directory\n"
23763 #: ../fish/guestfish-actions.pod:4125
23764 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23768 #: ../fish/guestfish-actions.pod:4130
23773 #: ../fish/guestfish-actions.pod:4132
23776 " tar-out directory (tarfile|-)\n"
23781 #: ../fish/guestfish-actions.pod:4137
23782 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23786 #: ../fish/guestfish-actions.pod:4142
23791 #: ../fish/guestfish-actions.pod:4144
23794 " tgz-in (tarball|-) directory\n"
23799 #: ../fish/guestfish-actions.pod:4149
23800 msgid "To upload an uncompressed tarball, use L</tar-in>."
23804 #: ../fish/guestfish-actions.pod:4153
23809 #: ../fish/guestfish-actions.pod:4155
23812 " tgz-out directory (tarball|-)\n"
23817 #: ../fish/guestfish-actions.pod:4160
23818 msgid "To download an uncompressed tarball, use L</tar-out>."
23822 #: ../fish/guestfish-actions.pod:4164
23827 #: ../fish/guestfish-actions.pod:4166
23835 #: ../fish/guestfish-actions.pod:4175
23840 #: ../fish/guestfish-actions.pod:4177
23848 #: ../fish/guestfish-actions.pod:4182
23849 msgid "truncate-size"
23853 #: ../fish/guestfish-actions.pod:4184
23856 " truncate-size path size\n"
23861 #: ../fish/guestfish-actions.pod:4189
23863 "If the current file size is less than C<size> then the file is extended to "
23864 "the required size with zero bytes. This creates a sparse file (ie. disk "
23865 "blocks are not allocated for the file until you write to it). To create a "
23866 "non-sparse file of zeroes, use L</fallocate64> instead."
23870 #: ../fish/guestfish-actions.pod:4195
23875 #: ../fish/guestfish-actions.pod:4197
23878 " tune2fs-l device\n"
23883 #: ../fish/guestfish-actions.pod:4207
23888 #: ../fish/guestfish-actions.pod:4209
23891 " txz-in (tarball|-) directory\n"
23896 #: ../fish/guestfish-actions.pod:4216
23901 #: ../fish/guestfish-actions.pod:4218
23904 " txz-out directory (tarball|-)\n"
23909 #: ../fish/guestfish-actions.pod:4225
23914 #: ../fish/guestfish-actions.pod:4227
23922 #: ../fish/guestfish-actions.pod:4241
23923 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23927 #: ../fish/guestfish-actions.pod:4246
23932 #: ../fish/guestfish-actions.pod:4248
23937 #: ../fish/guestfish-actions.pod:4250
23940 " umount pathordevice\n"
23945 #: ../fish/guestfish-actions.pod:4256
23950 #: ../fish/guestfish-actions.pod:4258
23951 msgid "unmount-all"
23955 #: ../fish/guestfish-actions.pod:4260
23963 #: ../fish/guestfish-actions.pod:4266
23968 #: ../fish/guestfish-actions.pod:4268
23971 " upload (filename|-) remotefilename\n"
23976 #: ../fish/guestfish-actions.pod:4275
23977 msgid "See also L</download>."
23981 #: ../fish/guestfish-actions.pod:4279
23982 msgid "upload-offset"
23986 #: ../fish/guestfish-actions.pod:4281
23989 " upload-offset (filename|-) remotefilename offset\n"
23994 #: ../fish/guestfish-actions.pod:4293
23996 "Note that there is no limit on the amount of data that can be uploaded with "
23997 "this call, unlike with L</pwrite>, and this call always writes the full "
23998 "amount unless an error occurs."
24002 #: ../fish/guestfish-actions.pod:4298
24003 msgid "See also L</upload>, L</pwrite>."
24007 #: ../fish/guestfish-actions.pod:4302
24012 #: ../fish/guestfish-actions.pod:4304
24015 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
24020 #: ../fish/guestfish-actions.pod:4323
24025 #: ../fish/guestfish-actions.pod:4325
24033 #: ../fish/guestfish-actions.pod:4352
24035 "I<Note:> Don't use this call to test for availability of features. In "
24036 "enterprise distributions we backport features from later versions into "
24037 "earlier versions, making this an unreliable way to test for features. Use "
24038 "L</available> instead."
24042 #: ../fish/guestfish-actions.pod:4358
24047 #: ../fish/guestfish-actions.pod:4360
24050 " vfs-label device\n"
24055 #: ../fish/guestfish-actions.pod:4367
24056 msgid "To find a filesystem from the label, use L</findfs-label>."
24060 #: ../fish/guestfish-actions.pod:4369
24065 #: ../fish/guestfish-actions.pod:4371
24068 " vfs-type device\n"
24073 #: ../fish/guestfish-actions.pod:4381
24078 #: ../fish/guestfish-actions.pod:4383
24081 " vfs-uuid device\n"
24086 #: ../fish/guestfish-actions.pod:4390
24087 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24091 #: ../fish/guestfish-actions.pod:4392
24092 msgid "vg-activate"
24096 #: ../fish/guestfish-actions.pod:4394
24099 " vg-activate true|false 'volgroups ...'\n"
24104 #: ../fish/guestfish-actions.pod:4407
24105 msgid "vg-activate-all"
24109 #: ../fish/guestfish-actions.pod:4409
24112 " vg-activate-all true|false\n"
24117 #: ../fish/guestfish-actions.pod:4419
24122 #: ../fish/guestfish-actions.pod:4421
24125 " vgcreate volgroup 'physvols ...'\n"
24130 #: ../fish/guestfish-actions.pod:4426
24135 #: ../fish/guestfish-actions.pod:4428
24138 " vglvuuids vgname\n"
24143 #: ../fish/guestfish-actions.pod:4433
24145 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24146 "logical volumes and volume groups."
24150 #: ../fish/guestfish-actions.pod:4436
24151 msgid "See also L</vgpvuuids>."
24155 #: ../fish/guestfish-actions.pod:4438
24160 #: ../fish/guestfish-actions.pod:4440
24163 " vgpvuuids vgname\n"
24168 #: ../fish/guestfish-actions.pod:4445
24170 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24171 "physical volumes and volume groups."
24175 #: ../fish/guestfish-actions.pod:4448
24176 msgid "See also L</vglvuuids>."
24180 #: ../fish/guestfish-actions.pod:4450
24185 #: ../fish/guestfish-actions.pod:4452
24188 " vgremove vgname\n"
24193 #: ../fish/guestfish-actions.pod:4459
24198 #: ../fish/guestfish-actions.pod:4461
24201 " vgrename volgroup newvolgroup\n"
24206 #: ../fish/guestfish-actions.pod:4465
24211 #: ../fish/guestfish-actions.pod:4467
24219 #: ../fish/guestfish-actions.pod:4475
24220 msgid "See also L</vgs-full>."
24224 #: ../fish/guestfish-actions.pod:4477
24229 #: ../fish/guestfish-actions.pod:4479
24237 #: ../fish/guestfish-actions.pod:4484
24242 #: ../fish/guestfish-actions.pod:4486
24250 #: ../fish/guestfish-actions.pod:4491
24255 #: ../fish/guestfish-actions.pod:4493
24263 #: ../fish/guestfish-actions.pod:4497
24268 #: ../fish/guestfish-actions.pod:4499
24276 #: ../fish/guestfish-actions.pod:4504
24281 #: ../fish/guestfish-actions.pod:4506
24289 #: ../fish/guestfish-actions.pod:4511
24294 #: ../fish/guestfish-actions.pod:4513
24302 #: ../fish/guestfish-actions.pod:4518
24307 #: ../fish/guestfish-actions.pod:4520
24310 " write path content\n"
24315 #: ../fish/guestfish-actions.pod:4528
24320 #: ../fish/guestfish-actions.pod:4530
24323 " write-file path content size\n"
24328 #: ../fish/guestfish-actions.pod:4553
24333 #: ../fish/guestfish-actions.pod:4555
24336 " zegrep regex path\n"
24341 #: ../fish/guestfish-actions.pod:4563
24346 #: ../fish/guestfish-actions.pod:4565
24349 " zegrepi regex path\n"
24354 #: ../fish/guestfish-actions.pod:4573
24359 #: ../fish/guestfish-actions.pod:4575
24367 #: ../fish/guestfish-actions.pod:4583
24368 msgid "See also: L</zero-device>, L</scrub-device>."
24372 #: ../fish/guestfish-actions.pod:4585
24373 msgid "zero-device"
24377 #: ../fish/guestfish-actions.pod:4587
24380 " zero-device device\n"
24385 #: ../fish/guestfish-actions.pod:4589
24387 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24388 "which just zeroes the first few blocks of a device."
24392 #: ../fish/guestfish-actions.pod:4596
24397 #: ../fish/guestfish-actions.pod:4598
24400 " zerofree device\n"
24405 #: ../fish/guestfish-actions.pod:4611
24410 #: ../fish/guestfish-actions.pod:4613
24413 " zfgrep pattern path\n"
24418 #: ../fish/guestfish-actions.pod:4621
24423 #: ../fish/guestfish-actions.pod:4623
24426 " zfgrepi pattern path\n"
24431 #: ../fish/guestfish-actions.pod:4631
24436 #: ../fish/guestfish-actions.pod:4633
24439 " zfile meth path\n"
24444 #: ../fish/guestfish-actions.pod:4640
24445 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
24449 #: ../fish/guestfish-actions.pod:4650
24454 #: ../fish/guestfish-actions.pod:4652
24457 " zgrep regex path\n"
24462 #: ../fish/guestfish-actions.pod:4660
24467 #: ../fish/guestfish-actions.pod:4662
24470 " zgrepi regex path\n"
24475 #: ../fish/guestfish-commands.pod:1
24480 #: ../fish/guestfish-commands.pod:3
24485 #: ../fish/guestfish-commands.pod:5
24488 " alloc filename size\n"
24493 #: ../fish/guestfish-commands.pod:7
24495 "This creates an empty (zeroed) file of the given size, and then adds so it "
24496 "can be further examined."
24500 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24501 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24505 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24506 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24510 #: ../fish/guestfish-commands.pod:14
24512 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24513 "image, see L</PREPARED DISK IMAGES>."
24517 #: ../fish/guestfish-commands.pod:17
24522 #: ../fish/guestfish-commands.pod:19
24525 " copy-in local [local ...] /remotedir\n"
24530 #: ../fish/guestfish-commands.pod:21
24532 "C<copy-in> copies local files or directories recursively into the disk "
24533 "image, placing them in the directory called C</remotedir> (which must "
24534 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24535 "other commands as necessary."
24539 #: ../fish/guestfish-commands.pod:26
24541 "Multiple local files and directories can be specified, but the last "
24542 "parameter must always be a remote directory. Wildcards cannot be used."
24546 #: ../fish/guestfish-commands.pod:30
24551 #: ../fish/guestfish-commands.pod:32
24554 " copy-out remote [remote ...] localdir\n"
24559 #: ../fish/guestfish-commands.pod:34
24561 "C<copy-out> copies remote files or directories recursively out of the disk "
24562 "image, placing them on the host disk in a local directory called C<localdir> "
24563 "(which must exist). This guestfish meta-command turns into a sequence of "
24564 "L</download>, L</tar-out> and other commands as necessary."
24568 #: ../fish/guestfish-commands.pod:40
24570 "Multiple remote files and directories can be specified, but the last "
24571 "parameter must always be a local directory. To download to the current "
24572 "directory, use C<.> as in:"
24576 #: ../fish/guestfish-commands.pod:44
24579 " copy-out /home .\n"
24584 #: ../fish/guestfish-commands.pod:46
24586 "Wildcards cannot be used in the ordinary command, but you can use them with "
24587 "the help of L</glob> like this:"
24591 #: ../fish/guestfish-commands.pod:49
24594 " glob copy-out /home/* .\n"
24599 #: ../fish/guestfish-commands.pod:51
24604 #: ../fish/guestfish-commands.pod:53
24607 " echo [params ...]\n"
24612 #: ../fish/guestfish-commands.pod:55
24613 msgid "This echos the parameters to the terminal."
24617 #: ../fish/guestfish-commands.pod:57
24622 #: ../fish/guestfish-commands.pod:59
24627 #: ../fish/guestfish-commands.pod:61
24632 #: ../fish/guestfish-commands.pod:63
24640 #: ../fish/guestfish-commands.pod:65
24642 "This is used to edit a file. It downloads the file, edits it locally using "
24643 "your editor, then uploads the result."
24647 #: ../fish/guestfish-commands.pod:68
24649 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24650 "or C<emacs> you will get those corresponding editors."
24654 #: ../fish/guestfish-commands.pod:72
24659 #: ../fish/guestfish-commands.pod:74
24662 " glob command args...\n"
24667 #: ../fish/guestfish-commands.pod:76
24669 "Expand wildcards in any paths in the args list, and run C<command> "
24670 "repeatedly on each matching path."
24674 #: ../fish/guestfish-commands.pod:79
24675 msgid "See L</WILDCARDS AND GLOBBING>."
24679 #: ../fish/guestfish-commands.pod:81
24684 #: ../fish/guestfish-commands.pod:83
24687 " hexedit <filename|device>\n"
24688 " hexedit <filename|device> <max>\n"
24689 " hexedit <filename|device> <start> <max>\n"
24694 #: ../fish/guestfish-commands.pod:87
24696 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24701 #: ../fish/guestfish-commands.pod:90
24703 "This command works by downloading potentially the whole file or device, "
24704 "editing it locally, then uploading it. If the file or device is large, you "
24705 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24706 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24707 "usual modifiers allowed such as C<1M> (1 megabyte)."
24711 #: ../fish/guestfish-commands.pod:97
24712 msgid "For example to edit the first few sectors of a disk you might do:"
24716 #: ../fish/guestfish-commands.pod:100
24719 " hexedit /dev/sda 1M\n"
24724 #: ../fish/guestfish-commands.pod:102
24726 "which would allow you to edit anywhere within the first megabyte of the "
24731 #: ../fish/guestfish-commands.pod:105
24732 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24736 #: ../fish/guestfish-commands.pod:107
24739 " hexedit /dev/sda1 0x400 0x400\n"
24744 #: ../fish/guestfish-commands.pod:109
24745 msgid "(assuming the superblock is in the standard location)."
24749 #: ../fish/guestfish-commands.pod:111
24751 "This command requires the external L<hexedit(1)> program. You can specify "
24752 "another program to use by setting the C<HEXEDITOR> environment variable."
24756 #: ../fish/guestfish-commands.pod:115
24757 msgid "See also L</hexdump>."
24761 #: ../fish/guestfish-commands.pod:117
24766 #: ../fish/guestfish-commands.pod:119
24774 #: ../fish/guestfish-commands.pod:121
24775 msgid "Change the local directory, ie. the current directory of guestfish itself."
24779 #: ../fish/guestfish-commands.pod:124
24780 msgid "Note that C<!cd> won't do what you might expect."
24784 #: ../fish/guestfish-commands.pod:126
24789 #: ../fish/guestfish-commands.pod:128
24794 #: ../fish/guestfish-commands.pod:130
24802 #: ../fish/guestfish-commands.pod:132
24803 msgid "Opens the manual page for guestfish."
24807 #: ../fish/guestfish-commands.pod:134
24812 #: ../fish/guestfish-commands.pod:136
24817 #: ../fish/guestfish-commands.pod:138
24825 #: ../fish/guestfish-commands.pod:140
24833 #: ../fish/guestfish-commands.pod:142
24834 msgid "This is used to view a file."
24838 #: ../fish/guestfish-commands.pod:144
24840 "The default viewer is C<$PAGER>. However if you use the alternate command "
24841 "C<less> you will get the C<less> command specifically."
24845 #: ../fish/guestfish-commands.pod:147
24850 #: ../fish/guestfish-commands.pod:149
24858 #: ../fish/guestfish-commands.pod:151
24860 "Close and reopen the libguestfs handle. It is not necessary to use this "
24861 "normally, because the handle is closed properly when guestfish exits. "
24862 "However this is occasionally useful for testing."
24866 #: ../fish/guestfish-commands.pod:155
24871 #: ../fish/guestfish-commands.pod:157
24874 " sparse filename size\n"
24879 #: ../fish/guestfish-commands.pod:159
24881 "This creates an empty sparse file of the given size, and then adds so it can "
24882 "be further examined."
24886 #: ../fish/guestfish-commands.pod:162
24888 "In all respects it works the same as the L</alloc> command, except that the "
24889 "image file is allocated sparsely, which means that disk blocks are not "
24890 "assigned to the file until they are needed. Sparse disk files only use "
24891 "space when written to, but they are slower and there is a danger you could "
24892 "run out of real disk space during a write operation."
24896 #: ../fish/guestfish-commands.pod:172
24901 #: ../fish/guestfish-commands.pod:174
24909 #: ../fish/guestfish-commands.pod:176
24911 "This command returns a list of the optional groups known to the daemon, and "
24912 "indicates which ones are supported by this build of the libguestfs "
24917 #: ../fish/guestfish-commands.pod:180
24918 msgid "See also L<guestfs(3)/AVAILABILITY>."
24922 #: ../fish/guestfish-commands.pod:182
24927 #: ../fish/guestfish-commands.pod:184
24930 " time command args...\n"
24935 #: ../fish/guestfish-commands.pod:186
24937 "Run the command as usual, but print the elapsed time afterwards. This can "
24938 "be useful for benchmarking operations."
24942 #: ../test-tool/libguestfs-test-tool.pod:5
24943 msgid "libguestfs-test-tool - End user tests for libguestfs"
24947 #: ../test-tool/libguestfs-test-tool.pod:9
24950 " libguestfs-test-tool [--options]\n"
24955 #: ../test-tool/libguestfs-test-tool.pod:13
24957 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24958 "and developers, to allow them to check basic libguestfs functionality is "
24959 "working. This is needed because libguestfs occasionally breaks for reasons "
24960 "beyond our control: usually because of changes in the underlying qemu or "
24961 "kernel packages, or the host environment."
24965 #: ../test-tool/libguestfs-test-tool.pod:20
24966 msgid "If you suspect a problem in libguestfs, then just run:"
24970 #: ../test-tool/libguestfs-test-tool.pod:22
24973 " libguestfs-test-tool\n"
24978 #: ../test-tool/libguestfs-test-tool.pod:24
24979 msgid "It will print lots of diagnostic messages."
24983 #: ../test-tool/libguestfs-test-tool.pod:26
24984 msgid "If it runs to completion successfully, you will see this near the end:"
24988 #: ../test-tool/libguestfs-test-tool.pod:28
24991 " ===== TEST FINISHED OK =====\n"
24996 #: ../test-tool/libguestfs-test-tool.pod:30
24997 msgid "and the test tool will exit with code 0."
25001 #: ../test-tool/libguestfs-test-tool.pod:32
25003 "If it fails (and/or exits with non-zero error code), please paste the "
25004 "B<complete, unedited> output of the test tool into a bug report. More "
25005 "information about reporting bugs can be found on the "
25006 "L<http://libguestfs.org/> website."
25010 #: ../test-tool/libguestfs-test-tool.pod:41
25015 #: ../test-tool/libguestfs-test-tool.pod:43
25016 msgid "Display short usage information and exit."
25020 #: ../test-tool/libguestfs-test-tool.pod:45
25021 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25025 #: ../test-tool/libguestfs-test-tool.pod:47
25027 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25028 "normally look in the C<$libexec> directory that was configured when the tool "
25033 #: ../test-tool/libguestfs-test-tool.pod:51
25034 msgid "I<--qemu qemu_binary>"
25038 #: ../test-tool/libguestfs-test-tool.pod:53
25040 "If you have downloaded another qemu binary, point this option at the full "
25041 "path of the binary to try it."
25045 #: ../test-tool/libguestfs-test-tool.pod:56
25046 msgid "I<--qemudir qemu_source_dir>"
25050 #: ../test-tool/libguestfs-test-tool.pod:58
25052 "If you have compiled qemu from source, point this option at the source "
25053 "directory to try it."
25057 #: ../test-tool/libguestfs-test-tool.pod:61
25058 msgid "I<--timeout N>"
25062 #: ../test-tool/libguestfs-test-tool.pod:63
25064 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25065 "does not usually need to be adjusted unless your machine is very slow."
25069 #: ../test-tool/libguestfs-test-tool.pod:69
25070 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25074 #: ../test-tool/libguestfs-test-tool.pod:71
25076 "If you have compiled another version of qemu from source and would like to "
25077 "try that, then you can use the I<--qemudir> option to point to the qemu "
25078 "source directory."
25082 #: ../test-tool/libguestfs-test-tool.pod:75
25084 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25085 "option to point to the binary."
25089 #: ../test-tool/libguestfs-test-tool.pod:78
25091 "When using an alternate qemu with libguestfs, usually you would need to "
25092 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
25093 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
25094 "when you use either of the I<--qemudir> or I<--qemu> options."
25098 #: ../test-tool/libguestfs-test-tool.pod:85
25100 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25101 "I<1> if there was an error."
25105 #: ../test-tool/libguestfs-test-tool.pod:92
25106 msgid "/usr/libexec/libguestfs-test-tool-helper"
25110 #: ../test-tool/libguestfs-test-tool.pod:94
25112 "This helper program is run inside the appliance and provides additional "
25117 #: ../test-tool/libguestfs-test-tool.pod:97
25118 msgid "/usr/bin/mkisofs"
25122 #: ../test-tool/libguestfs-test-tool.pod:99
25124 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25125 "which is used as part of the tests."
25129 #: ../test-tool/libguestfs-test-tool.pod:106
25131 "For the full list of environment variables which may affect libguestfs, "
25132 "please see the L<guestfs(3)> manual page."
25136 #: ../test-tool/libguestfs-test-tool.pod:111
25137 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25141 #: ../test-tool/libguestfs-test-tool.pod:121
25142 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25146 #: ../fuse/guestmount.pod:5
25147 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25151 #: ../fuse/guestmount.pod:9
25154 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25159 #: ../fuse/guestmount.pod:11
25162 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25167 #: ../fuse/guestmount.pod:13
25170 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25175 #: ../fuse/guestmount.pod:17
25177 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25178 "machines. If you do this, you risk disk corruption in the VM."
25182 #: ../fuse/guestmount.pod:22
25184 "The guestmount program can be used to mount virtual machine filesystems and "
25185 "other disk images on the host. It uses libguestfs for access to the guest "
25186 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25187 "a mountable device."
25191 #: ../fuse/guestmount.pod:27
25193 "Along with other options, you have to give at least one device (I<-a> "
25194 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25195 "option) or use the I<-i> inspection option. How this works is better "
25196 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25201 #: ../fuse/guestmount.pod:33
25203 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25204 "by you, and the filesystem will not be visible to any other users unless you "
25205 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25206 "the filesystem, use the C<fusermount -u> command."
25210 #: ../fuse/guestmount.pod:41
25212 "For a typical Windows guest which has its main filesystem on the first "
25217 #: ../fuse/guestmount.pod:44
25220 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25225 #: ../fuse/guestmount.pod:46
25227 "For a typical Linux guest which has a /boot filesystem on the first "
25228 "partition, and the root filesystem on a logical volume:"
25232 #: ../fuse/guestmount.pod:49
25235 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25240 #: ../fuse/guestmount.pod:51
25241 msgid "To get libguestfs to detect guest mountpoints for you:"
25245 #: ../fuse/guestmount.pod:53
25248 " guestmount -a guest.img -i --ro /mnt\n"
25253 #: ../fuse/guestmount.pod:55
25254 msgid "For a libvirt guest called \"Guest\" you could do:"
25258 #: ../fuse/guestmount.pod:57
25261 " guestmount -d Guest -i --ro /mnt\n"
25266 #: ../fuse/guestmount.pod:59
25268 "If you don't know what filesystems are contained in a guest or disk image, "
25269 "use L<virt-filesystems(1)> first:"
25273 #: ../fuse/guestmount.pod:62
25276 " virt-filesystems MyGuest\n"
25281 #: ../fuse/guestmount.pod:64
25283 "If you want to trace the libguestfs calls but without excessive debugging "
25284 "information, we recommend:"
25288 #: ../fuse/guestmount.pod:67
25291 " guestmount [...] --trace /mnt\n"
25296 #: ../fuse/guestmount.pod:69
25297 msgid "If you want to debug the program, we recommend:"
25301 #: ../fuse/guestmount.pod:71
25304 " guestmount [...] --trace --verbose /mnt\n"
25309 #: ../fuse/guestmount.pod:79
25310 msgid "Add a block device or virtual machine image."
25314 #: ../fuse/guestmount.pod:96
25315 msgid "B<--dir-cache-timeout N>"
25319 #: ../fuse/guestmount.pod:98
25321 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25322 "seconds. The readdir cache [actually, there are several semi-independent "
25323 "caches] is populated after a readdir(2) call with the stat and extended "
25324 "attributes of the files in the directory, in anticipation that they will be "
25325 "requested soon after."
25329 #: ../fuse/guestmount.pod:104
25331 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25332 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25333 "requests, only cache existing ones."
25337 #: ../fuse/guestmount.pod:122
25339 "If you have untrusted raw-format guest disk images, you should use this "
25340 "option to specify the disk format. This avoids a possible security problem "
25341 "with malicious guests (CVE-2010-3851). See also "
25342 "L<guestfs(3)/guestfs_add_drive_opts>."
25346 #: ../fuse/guestmount.pod:127
25347 msgid "B<--fuse-help>"
25351 #: ../fuse/guestmount.pod:129
25352 msgid "Display help on special FUSE options (see I<-o> below)."
25356 #: ../fuse/guestmount.pod:133
25357 msgid "Display brief help and exit."
25361 #: ../fuse/guestmount.pod:146
25362 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25366 #: ../fuse/guestmount.pod:148
25368 "Mount the named partition or logical volume on the given mountpoint B<in the "
25369 "guest> (this has nothing to do with mountpoints in the host)."
25373 #: ../fuse/guestmount.pod:151
25375 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25376 "something on C</>."
25380 #: ../fuse/guestmount.pod:156
25382 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25383 "unmounted. If you specify this option, then we don't attempt to sync the "
25384 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25388 #: ../fuse/guestmount.pod:161
25389 msgid "B<-o option> | B<--option option>"
25393 #: ../fuse/guestmount.pod:163
25394 msgid "Pass extra options to FUSE."
25398 #: ../fuse/guestmount.pod:165
25400 "To get a list of all the extra options supported by FUSE, use the command "
25401 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25402 "of them are a good idea."
25406 #: ../fuse/guestmount.pod:169
25409 " guestmount --fuse-help\n"
25414 #: ../fuse/guestmount.pod:171
25415 msgid "Some potentially useful FUSE options:"
25419 #: ../fuse/guestmount.pod:175
25420 msgid "B<-o allow_other>"
25424 #: ../fuse/guestmount.pod:177
25425 msgid "Allow other users to see the filesystem."
25429 #: ../fuse/guestmount.pod:179
25430 msgid "B<-o attr_timeout=N>"
25434 #: ../fuse/guestmount.pod:181
25435 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25439 #: ../fuse/guestmount.pod:183
25440 msgid "B<-o kernel_cache>"
25444 #: ../fuse/guestmount.pod:185
25446 "Allow the kernel to cache files (reduces the number of reads that have to go "
25447 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25448 "afford the extra memory usage."
25452 #: ../fuse/guestmount.pod:189
25453 msgid "B<-o uid=N> B<-o gid=N>"
25457 #: ../fuse/guestmount.pod:191
25459 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25460 "the chosen values."
25464 #: ../fuse/guestmount.pod:198
25466 "Add devices and mount everything read-only. Also disallow writes and make "
25467 "the disk appear read-only to FUSE."
25471 #: ../fuse/guestmount.pod:201
25473 "This is highly recommended if you are not going to edit the guest disk. If "
25474 "the guest is running and this option is I<not> supplied, then there is a "
25475 "strong risk of disk corruption in the guest. We try to prevent this from "
25476 "happening, but it is not always possible."
25480 #: ../fuse/guestmount.pod:206
25481 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25485 #: ../fuse/guestmount.pod:210
25486 msgid "Enable SELinux support for the guest."
25490 #: ../fuse/guestmount.pod:214
25491 msgid "Enable verbose messages from underlying libguestfs."
25495 #: ../fuse/guestmount.pod:218
25496 msgid "Display the program version and exit."
25500 #: ../fuse/guestmount.pod:222
25502 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25503 "FOR READ AND WRITE>."
25507 #: ../fuse/guestmount.pod:225
25508 msgid "B<-x> | B<--trace>"
25512 #: ../fuse/guestmount.pod:227
25513 msgid "Trace libguestfs calls."
25517 #: ../fuse/guestmount.pod:229
25518 msgid "This also stops the daemon from forking into the background."
25522 #: ../fuse/guestmount.pod:235
25524 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25525 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
25526 "L<http://fuse.sf.net/>."
25530 #: ../tools/virt-edit.pl:34
25531 msgid "virt-edit - Edit a file in a virtual machine"
25535 #: ../tools/virt-edit.pl:38
25538 " virt-edit [--options] domname file\n"
25543 #: ../tools/virt-edit.pl:40
25546 " virt-edit [--options] disk.img [disk.img ...] file\n"
25551 #: ../tools/virt-edit.pl:42
25554 " virt-edit [domname|disk.img] file -e 'expr'\n"
25559 #: ../tools/virt-edit.pl:46
25561 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25562 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25563 "doing this, but doesn't catch all cases."
25567 #: ../tools/virt-edit.pl:52
25569 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25570 "the named virtual machine (or disk image)."
25574 #: ../tools/virt-edit.pl:55
25576 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25577 "you should look at the L<guestfish(1)> tool."
25581 #: ../tools/virt-edit.pl:60
25582 msgid "Edit the named files interactively:"
25586 #: ../tools/virt-edit.pl:62
25589 " virt-edit mydomain /boot/grub/grub.conf\n"
25594 #: ../tools/virt-edit.pl:64
25597 " virt-edit mydomain /etc/passwd\n"
25602 #: ../tools/virt-edit.pl:66
25604 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25605 "below). To change the init default level to 5:"
25609 #: ../tools/virt-edit.pl:70
25612 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25617 #: ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181 ../tools/virt-list-filesystems.pl:63 ../tools/virt-tar.pl:108 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:64
25618 msgid "Display brief help."
25622 #: ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187 ../tools/virt-resize.pl:270 ../tools/virt-list-filesystems.pl:69 ../tools/virt-tar.pl:114 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:70
25623 msgid "B<--version>"
25627 #: ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189 ../tools/virt-resize.pl:272 ../tools/virt-list-filesystems.pl:71 ../tools/virt-tar.pl:116 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:72
25628 msgid "Display version number and exit."
25632 #: ../tools/virt-edit.pl:96
25633 msgid "B<--backup extension> | B<-b extension>"
25637 #: ../tools/virt-edit.pl:98
25639 "Create a backup of the original file I<in the guest disk image>. The backup "
25640 "has the original filename with C<extension> added."
25644 #: ../tools/virt-edit.pl:101
25646 "Usually the first character of C<extension> would be a dot C<.> so you would "
25651 #: ../tools/virt-edit.pl:104
25654 " virt-edit -b .orig [etc]\n"
25659 #: ../tools/virt-edit.pl:106
25660 msgid "By default, no backup file is made."
25664 #: ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203 ../tools/virt-list-filesystems.pl:77 ../tools/virt-tar.pl:122 ../tools/virt-list-partitions.pl:78
25665 msgid "B<--connect URI> | B<-c URI>"
25669 #: ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:124 ../tools/virt-list-partitions.pl:80
25671 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25672 "to the default libvirt hypervisor."
25676 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208 ../tools/virt-list-filesystems.pl:82 ../tools/virt-tar.pl:127 ../tools/virt-list-partitions.pl:83
25678 "If you specify guest block devices directly, then libvirt is not used at "
25683 #: ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215 ../tools/virt-resize.pl:520 ../tools/virt-list-filesystems.pl:89 ../tools/virt-tar.pl:134 ../tools/virt-list-partitions.pl:90
25684 msgid "B<--format> raw"
25688 #: ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217 ../tools/virt-list-filesystems.pl:91 ../tools/virt-tar.pl:136 ../tools/virt-list-partitions.pl:92
25690 "Specify the format of disk images given on the command line. If this is "
25691 "omitted then the format is autodetected from the content of the disk image."
25695 #: ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221 ../tools/virt-list-filesystems.pl:95 ../tools/virt-tar.pl:140 ../tools/virt-list-partitions.pl:96
25697 "If disk images are requested from libvirt, then this program asks libvirt "
25698 "for this information. In this case, the value of the format parameter is "
25703 #: ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225 ../tools/virt-resize.pl:525 ../tools/virt-resize.pl:540 ../tools/virt-list-filesystems.pl:99 ../tools/virt-tar.pl:144 ../tools/virt-list-partitions.pl:100
25705 "If working with untrusted raw-format guest disk images, you should ensure "
25706 "the format is always specified."
25710 #: ../tools/virt-edit.pl:141
25711 msgid "B<--expr EXPR> | B<-e EXPR>"
25715 #: ../tools/virt-edit.pl:143
25717 "Instead of launching the external editor, non-interactively apply the Perl "
25718 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
25723 #: ../tools/virt-edit.pl:147
25725 "Be careful to properly quote the expression to prevent it from being altered "
25730 #: ../tools/virt-edit.pl:268
25731 msgid "NON-INTERACTIVE EDITING"
25735 #: ../tools/virt-edit.pl:270
25737 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
25738 "administrator can interactively edit the file."
25742 #: ../tools/virt-edit.pl:273
25744 "There are two ways also to use C<virt-edit> from scripts in order to make "
25745 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
25746 "like this, it's less error-prone to write scripts directly using the "
25747 "libguestfs API and Augeas for configuration file editing.)"
25751 #: ../tools/virt-edit.pl:279
25753 "The first method is to temporarily set C<$EDITOR> to any script or program "
25754 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
25755 "update C<tmpfile> in place however it likes."
25759 #: ../tools/virt-edit.pl:283
25761 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
25762 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
25763 "instances of C<foo> with C<bar> in a file:"
25767 #: ../tools/virt-edit.pl:287
25770 " virt-edit domname filename -e 's/foo/bar/'\n"
25775 #: ../tools/virt-edit.pl:289
25777 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
25778 "For example to delete root's password you could do:"
25782 #: ../tools/virt-edit.pl:292
25785 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
25790 #: ../tools/virt-edit.pl:294
25792 "What really happens is that the snippet is evaluated as a Perl expression "
25793 "for each line of the file. The line, including the final C<\\n>, is passed "
25794 "in C<$_> and the expression should update C<$_> or leave it unchanged."
25798 #: ../tools/virt-edit.pl:299
25800 "To delete a line, set C<$_> to the empty string. For example, to delete the "
25801 "C<apache> user account from the password file you can do:"
25805 #: ../tools/virt-edit.pl:302
25808 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
25813 #: ../tools/virt-edit.pl:304
25815 "To insert a line, prepend or append it to C<$_>. However appending lines to "
25816 "the end of the file is rather difficult this way since there is no concept "
25817 "of \"last line of the file\" - your expression just doesn't get called "
25818 "again. You might want to use the first method (setting C<$EDITOR>) if you "
25823 #: ../tools/virt-edit.pl:310
25825 "The variable C<$lineno> contains the current line number. As is "
25826 "traditional, the first line in the file is number C<1>."
25830 #: ../tools/virt-edit.pl:313
25832 "The return value from the expression is ignored, but the expression may call "
25833 "C<die> in order to abort the whole program, leaving the original file "
25838 #: ../tools/virt-edit.pl:317
25840 "Remember when matching the end of a line that C<$_> may contain the final "
25841 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
25842 "newline then neither of these. Thus to match or substitute some text at the "
25843 "end of a line, use this regular expression:"
25847 #: ../tools/virt-edit.pl:322
25850 " /some text(\\r?\\n)?$/\n"
25855 #: ../tools/virt-edit.pl:324
25857 "Alternately, use the perl C<chomp> function, being careful not to chomp "
25858 "C<$_> itself (since that would remove all newlines from the file):"
25862 #: ../tools/virt-edit.pl:328
25865 " my $m = $_; chomp $m; $m =~ /some text$/\n"
25870 #: ../tools/virt-edit.pl:334
25875 #: ../tools/virt-edit.pl:336
25877 "If set, this string is used as the editor. It may contain arguments, "
25878 "eg. C<\"emacs -nw\">"
25882 #: ../tools/virt-edit.pl:339
25883 msgid "If not set, C<vi> is used."
25887 #: ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477 ../tools/virt-resize.pl:1476 ../tools/virt-list-filesystems.pl:182 ../tools/virt-tar.pl:274 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:250
25888 msgid "SHELL QUOTING"
25892 #: ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479 ../tools/virt-resize.pl:1478 ../tools/virt-list-filesystems.pl:184 ../tools/virt-tar.pl:276 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:252
25894 "Libvirt guest names can contain arbitrary characters, some of which have "
25895 "meaning to the shell such as C<#> and space. You may need to quote or "
25896 "escape these characters on the command line. See the shell manual page "
25897 "L<sh(1)> for details."
25901 #: ../tools/virt-edit.pl:352
25903 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
25904 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
25905 "L<perl(1)>, L<perlre(1)>."
25909 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510 ../tools/virt-resize.pl:1504 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:292 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:269
25914 #: ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512 ../tools/virt-resize.pl:1506 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:294 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:271
25915 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25919 #: ../tools/virt-edit.pl:368 ../tools/virt-list-partitions.pl:275
25920 msgid "Copyright (C) 2009-2010 Red Hat Inc."
25924 #: ../tools/virt-win-reg.pl:37
25926 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
25931 #: ../tools/virt-win-reg.pl:41
25934 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
25939 #: ../tools/virt-win-reg.pl:43
25942 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
25947 #: ../tools/virt-win-reg.pl:45
25950 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
25955 #: ../tools/virt-win-reg.pl:47
25958 " virt-win-reg --merge domname [input.reg ...]\n"
25963 #: ../tools/virt-win-reg.pl:49
25966 " virt-win-reg [--options] disk.img ... # instead of domname\n"
25971 #: ../tools/virt-win-reg.pl:53
25973 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
25974 "virtual machines. If you do this, you I<will> get irreversible disk "
25975 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
25976 "but doesn't catch all cases."
25980 #: ../tools/virt-win-reg.pl:58
25982 "Modifying the Windows Registry is an inherently risky operation. The format "
25983 "is deliberately obscure and undocumented, and Registry changes can leave the "
25984 "system unbootable. Therefore when using the C<--merge> option, make sure "
25985 "you have a reliable backup first."
25989 #: ../tools/virt-win-reg.pl:65
25991 "This program can export and merge Windows Registry entries from a Windows "
25996 #: ../tools/virt-win-reg.pl:68
25998 "The first parameter is the libvirt guest name or the raw disk image of a "
26003 #: ../tools/virt-win-reg.pl:71
26005 "If C<--merge> is I<not> specified, then the chosen registry key is "
26006 "displayed/exported (recursively). For example:"
26010 #: ../tools/virt-win-reg.pl:74
26013 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26018 #: ../tools/virt-win-reg.pl:76
26019 msgid "You can also display single values from within registry keys, for example:"
26023 #: ../tools/virt-win-reg.pl:79
26026 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26027 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26028 " Windows 7 Enterprise\n"
26033 #: ../tools/virt-win-reg.pl:83
26035 "With C<--merge>, you can merge a textual regedit file into the Windows "
26040 #: ../tools/virt-win-reg.pl:86
26043 " $ virt-win-reg --merge Windows7 changes.reg\n"
26048 #: ../tools/virt-win-reg.pl:88
26049 msgid "SUPPORTED SYSTEMS"
26053 #: ../tools/virt-win-reg.pl:90
26055 "The program currently supports Windows NT-derived guests starting with "
26056 "Windows XP through to at least Windows 7."
26060 #: ../tools/virt-win-reg.pl:93
26062 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
26063 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
26064 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
26068 #: ../tools/virt-win-reg.pl:97
26070 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26075 #: ../tools/virt-win-reg.pl:100
26077 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26082 #: ../tools/virt-win-reg.pl:103
26087 #: ../tools/virt-win-reg.pl:105
26089 "This program is only meant for simple access to the registry. If you want "
26090 "to do complicated things with the registry, we suggest you download the "
26091 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26092 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26093 "L<hivexregedit(1)>."
26097 #: ../tools/virt-win-reg.pl:111
26102 #: ../tools/virt-win-reg.pl:113
26104 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26105 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
26106 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
26107 "with Windows-style line endings, you may need to reencode the whole file "
26108 "before or after processing."
26112 #: ../tools/virt-win-reg.pl:119
26114 "To reencode a file from Windows format to Linux (before processing it with "
26115 "the C<--merge> option), you would do something like this:"
26119 #: ../tools/virt-win-reg.pl:122
26122 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26127 #: ../tools/virt-win-reg.pl:124
26129 "To go in the opposite direction, after exporting and before sending the file "
26130 "to a Windows user, do something like this:"
26134 #: ../tools/virt-win-reg.pl:127
26137 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26142 #: ../tools/virt-win-reg.pl:129
26143 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26147 #: ../tools/virt-win-reg.pl:131
26149 "If you are unsure about the current encoding, use the L<file(1)> command. "
26150 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
26151 "Windows-style (CRLF) line endings, like this:"
26155 #: ../tools/virt-win-reg.pl:135
26158 " $ file software.reg\n"
26159 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26160 " with CRLF line terminators\n"
26165 #: ../tools/virt-win-reg.pl:139
26166 msgid "This file would need conversion before you could C<--merge> it."
26170 #: ../tools/virt-win-reg.pl:143
26172 "Be careful when passing parameters containing C<\\> (backslash) in the "
26173 "shell. Usually you will have to use 'single quotes' or double backslashes "
26174 "(but not both) to protect them from the shell."
26178 #: ../tools/virt-win-reg.pl:147
26179 msgid "Paths and value names are case-insensitive."
26183 #: ../tools/virt-win-reg.pl:149
26184 msgid "CurrentControlSet etc."
26188 #: ../tools/virt-win-reg.pl:151
26190 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26191 "Registry at the level of the hive file, and therefore you cannot modify "
26196 #: ../tools/virt-win-reg.pl:155
26198 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26199 "circumstances it might refer to another control set. The way to find out is "
26200 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26204 #: ../tools/virt-win-reg.pl:159
26207 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26208 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26209 " \"Current\"=dword:00000001\n"
26210 " \"Default\"=dword:00000001\n"
26211 " \"Failed\"=dword:00000000\n"
26212 " \"LastKnownGood\"=dword:00000002\n"
26217 #: ../tools/virt-win-reg.pl:166
26218 msgid "\"Current\" is the one which Windows will choose when it boots."
26222 #: ../tools/virt-win-reg.pl:168
26223 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
26227 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26232 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:498
26233 msgid "Enable debugging messages."
26237 #: ../tools/virt-win-reg.pl:232
26242 #: ../tools/virt-win-reg.pl:234
26244 "In merge mode, this merges a textual regedit file into the Windows Registry "
26245 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26246 "displays or exports Registry entries instead."
26250 #: ../tools/virt-win-reg.pl:238
26252 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26253 "result in disk corruption. However exporting (without this flag) is always "
26258 #: ../tools/virt-win-reg.pl:246
26259 msgid "B<--encoding> UTF-16LE|ASCII"
26263 #: ../tools/virt-win-reg.pl:248
26265 "When merging (only), you may need to specify the encoding for strings to be "
26266 "used in the hive file. This is explained in detail in "
26267 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
26271 #: ../tools/virt-win-reg.pl:252
26273 "The default is to use UTF-16LE, which should work with recent versions of "
26278 #: ../tools/virt-win-reg.pl:486
26280 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
26281 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26282 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
26283 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26287 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26289 "When reporting bugs, please enable debugging and capture the I<complete> "
26294 #: ../tools/virt-win-reg.pl:504
26297 " export LIBGUESTFS_DEBUG=1\n"
26298 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26303 #: ../tools/virt-win-reg.pl:507
26305 "Attach /tmp/virt-win-reg.log to a new bug report at "
26306 "L<https://bugzilla.redhat.com/>"
26310 #: ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1510 ../tools/virt-make-fs.pl:565
26311 msgid "Copyright (C) 2010 Red Hat Inc."
26315 #: ../tools/virt-resize.pl:42
26316 msgid "virt-resize - Resize a virtual machine disk"
26320 #: ../tools/virt-resize.pl:46
26323 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
26324 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
26325 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
26330 #: ../tools/virt-resize.pl:52
26332 "Virt-resize is a tool which can resize a virtual machine disk, making it "
26333 "larger or smaller overall, and resizing or deleting any partitions contained "
26338 #: ../tools/virt-resize.pl:56
26340 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
26341 "not> be used on live virtual machines - for consistent results, shut the "
26342 "virtual machine down before resizing it."
26346 #: ../tools/virt-resize.pl:60
26348 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
26349 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
26353 #: ../tools/virt-resize.pl:66
26355 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
26356 "fill the extra 5GB of space."
26360 #: ../tools/virt-resize.pl:69
26363 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
26364 " virt-filesystems --long --h --all -a olddisk\n"
26365 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
26366 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
26371 #: ../tools/virt-resize.pl:74
26373 "As above, but make the /boot partition 200MB bigger, while giving the "
26374 "remaining space to /dev/sda2:"
26378 #: ../tools/virt-resize.pl:77
26381 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
26386 #: ../tools/virt-resize.pl:79
26387 msgid "As above, but the output format will be uncompressed qcow2:"
26391 #: ../tools/virt-resize.pl:81
26394 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
26395 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
26400 #: ../tools/virt-resize.pl:84
26401 msgid "DETAILED USAGE"
26405 #: ../tools/virt-resize.pl:86
26406 msgid "EXPANDING A VIRTUAL MACHINE DISK"
26410 #: ../tools/virt-resize.pl:90
26411 msgid "1. Shut down the virtual machine"
26415 #: ../tools/virt-resize.pl:92
26416 msgid "2. Locate input disk image"
26420 #: ../tools/virt-resize.pl:94
26422 "Locate the input disk image (ie. the file or device on the host containing "
26423 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
26424 "dumpxml> like this to find the disk image name:"
26428 #: ../tools/virt-resize.pl:98
26431 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
26432 " Found 1 nodes:\n"
26434 " <source dev=\"/dev/vg/lv_guest\" />\n"
26439 #: ../tools/virt-resize.pl:103
26440 msgid "3. Look at current sizing"
26444 #: ../tools/virt-resize.pl:105
26445 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
26449 #: ../tools/virt-resize.pl:108
26452 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
26453 " Name Type Size Parent\n"
26454 " /dev/sda1 partition 101M /dev/sda\n"
26455 " /dev/sda2 partition 7.9G /dev/sda\n"
26456 " /dev/sda device 8.0G -\n"
26461 #: ../tools/virt-resize.pl:114
26463 "(This example is a virtual machine with an 8 GB disk which we would like to "
26464 "expand up to 10 GB)."
26468 #: ../tools/virt-resize.pl:117
26469 msgid "4. Create output disk"
26473 #: ../tools/virt-resize.pl:119
26475 "Virt-resize cannot do in-place disk modifications. You have to have space "
26476 "to store the resized output disk."
26480 #: ../tools/virt-resize.pl:122
26481 msgid "To store the resized disk image in a file, create a file of a suitable size:"
26485 #: ../tools/virt-resize.pl:125
26488 " # rm -f outdisk\n"
26489 " # truncate -s 10G outdisk\n"
26494 #: ../tools/virt-resize.pl:128
26495 msgid "Or use L<lvcreate(1)> to create a logical volume:"
26499 #: ../tools/virt-resize.pl:130
26502 " # lvcreate -L 10G -n lv_name vg_name\n"
26507 #: ../tools/virt-resize.pl:132
26508 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
26512 #: ../tools/virt-resize.pl:134
26515 " # virsh pool-list\n"
26516 " # virsh vol-create-as poolname newvol 10G\n"
26521 #: ../tools/virt-resize.pl:137
26526 #: ../tools/virt-resize.pl:139
26528 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
26529 "file) and the output disk. The output disk is the one created in the "
26534 #: ../tools/virt-resize.pl:143
26537 " # virt-resize indisk outdisk\n"
26542 #: ../tools/virt-resize.pl:145
26544 "This command just copies disk image C<indisk> to disk image C<outdisk> "
26545 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
26546 "larger, then an extra, empty partition is created at the end of the disk "
26547 "covering the extra space. If C<outdisk> is smaller, then it will give an "
26552 #: ../tools/virt-resize.pl:151
26554 "More realistically you'd want to expand existing partitions in the disk "
26555 "image by passing extra options (for the full list see the L</OPTIONS> "
26560 #: ../tools/virt-resize.pl:155
26562 "L</--expand> is the most useful option. It expands the named partition "
26563 "within the disk to fill any extra space:"
26567 #: ../tools/virt-resize.pl:158
26570 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
26575 #: ../tools/virt-resize.pl:160
26577 "(In this case, an extra partition is I<not> created at the end of the disk, "
26578 "because there will be no unused space)."
26582 #: ../tools/virt-resize.pl:163
26584 "L</--resize> is the other commonly used option. The following would "
26585 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
26586 "rest of the available space:"
26590 #: ../tools/virt-resize.pl:167
26593 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
26594 " indisk outdisk\n"
26599 #: ../tools/virt-resize.pl:170
26601 "If the expanded partition in the image contains a filesystem or LVM PV, then "
26602 "if virt-resize knows how, it will resize the contents, the equivalent of "
26603 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
26604 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
26605 "filesystems, so you would have to online resize them after booting the "
26610 #: ../tools/virt-resize.pl:177
26611 msgid "Other options are covered below."
26615 #: ../tools/virt-resize.pl:179
26620 #: ../tools/virt-resize.pl:181
26621 msgid "Thoroughly test the new disk image I<before> discarding the old one."
26625 #: ../tools/virt-resize.pl:183
26626 msgid "If you are using libvirt, edit the XML to point at the new disk:"
26630 #: ../tools/virt-resize.pl:185
26633 " # virsh edit guestname\n"
26638 #: ../tools/virt-resize.pl:187
26640 "Change E<lt>source ...E<gt>, see "
26641 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
26645 #: ../tools/virt-resize.pl:190
26646 msgid "Then start up the domain with the new, resized disk:"
26650 #: ../tools/virt-resize.pl:192
26653 " # virsh start guestname\n"
26658 #: ../tools/virt-resize.pl:194
26660 "and check that it still works. See also the L</NOTES> section below for "
26661 "additional information."
26665 #: ../tools/virt-resize.pl:197
26666 msgid "7. Resize LVs etc inside the guest"
26670 #: ../tools/virt-resize.pl:199
26671 msgid "(This can also be done offline using L<guestfish(1)>)"
26675 #: ../tools/virt-resize.pl:201
26677 "Once the guest has booted you should see the new space available, at least "
26678 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26679 "may need to resize LVs inside PVs, and also resize filesystem types that "
26680 "virt-resize does not know how to expand."
26684 #: ../tools/virt-resize.pl:208
26685 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26689 #: ../tools/virt-resize.pl:210
26691 "Shrinking is somewhat more complex than expanding, and only an overview is "
26696 #: ../tools/virt-resize.pl:213
26698 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26699 "filesystems). The user has to shrink content before passing the disk image "
26700 "to virt-resize, and virt-resize will check that the content has been shrunk "
26705 #: ../tools/virt-resize.pl:218
26706 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26710 #: ../tools/virt-resize.pl:220
26712 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26713 "steps 3 and 4 above to allocate a new disk image."
26717 #: ../tools/virt-resize.pl:223
26718 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
26722 #: ../tools/virt-resize.pl:226
26723 msgid "IGNORING OR DELETING PARTITIONS"
26727 #: ../tools/virt-resize.pl:228
26729 "virt-resize also gives a convenient way to ignore or delete partitions when "
26730 "copying from the input disk to the output disk. Ignoring a partition speeds "
26731 "up the copy where you don't care about the existing contents of a "
26732 "partition. Deleting a partition removes it completely, but note that it "
26733 "also renumbers any partitions after the one which is deleted, which can "
26734 "leave some guests unbootable."
26738 #: ../tools/virt-resize.pl:235
26739 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26743 #: ../tools/virt-resize.pl:237
26745 "If the input disk is in qcow2 format, then you may prefer that the output is "
26746 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26747 "the fly. The output format is simply determined by the format of the empty "
26748 "output container that you provide. Thus to create qcow2 output, use:"
26752 #: ../tools/virt-resize.pl:243
26755 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26760 #: ../tools/virt-resize.pl:245
26761 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
26765 #: ../tools/virt-resize.pl:247
26766 msgid "Similarly, to get non-sparse raw output use:"
26770 #: ../tools/virt-resize.pl:249
26773 " fallocate -l size outdisk\n"
26778 #: ../tools/virt-resize.pl:251
26780 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
26781 "if=/dev/zero of=outdisk bs=1M count=..>)"
26785 #: ../tools/virt-resize.pl:264
26786 msgid "Display help."
26790 #: ../tools/virt-resize.pl:278
26791 msgid "B<--resize part=size>"
26795 #: ../tools/virt-resize.pl:280
26797 "Resize the named partition (expanding or shrinking it) so that it has the "
26802 #: ../tools/virt-resize.pl:283
26804 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
26805 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
26806 "Exabytes; or as a percentage of the current size; or as a relative number or "
26807 "percentage. For example:"
26811 #: ../tools/virt-resize.pl:288
26814 " --resize /dev/sda2=10G\n"
26819 #: ../tools/virt-resize.pl:290
26822 " --resize /dev/sda4=90%\n"
26827 #: ../tools/virt-resize.pl:292
26830 " --resize /dev/sda2=+1G\n"
26835 #: ../tools/virt-resize.pl:294
26838 " --resize /dev/sda2=-200M\n"
26843 #: ../tools/virt-resize.pl:296
26846 " --resize /dev/sda1=+128K\n"
26851 #: ../tools/virt-resize.pl:298
26854 " --resize /dev/sda1=+10%\n"
26859 #: ../tools/virt-resize.pl:300
26862 " --resize /dev/sda1=-10%\n"
26867 #: ../tools/virt-resize.pl:302
26869 "You can increase the size of any partition. Virt-resize will expand the "
26870 "direct content of the partition if it knows how (see C<--expand> below)."
26874 #: ../tools/virt-resize.pl:306
26876 "You can only I<decrease> the size of partitions that contain filesystems or "
26877 "PVs which have already been shrunk. Virt-resize will check this has been "
26878 "done before proceeding, or else will print an error (see also "
26879 "C<--resize-force>)."
26883 #: ../tools/virt-resize.pl:311 ../tools/virt-resize.pl:403 ../tools/virt-resize.pl:420
26884 msgid "You can give this option multiple times."
26888 #: ../tools/virt-resize.pl:317
26889 msgid "B<--resize-force part=size>"
26893 #: ../tools/virt-resize.pl:319
26895 "This is the same as C<--resize> except that it will let you decrease the "
26896 "size of any partition. Generally this means you will lose any data which "
26897 "was at the end of the partition you shrink, but you may not care about that "
26898 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26899 "as a swap partition)."
26903 #: ../tools/virt-resize.pl:325
26904 msgid "See also the C<--ignore> option."
26908 #: ../tools/virt-resize.pl:331
26909 msgid "B<--expand part>"
26913 #: ../tools/virt-resize.pl:333
26915 "Expand the named partition so it uses up all extra space (space left over "
26916 "after any other resize changes that you request have been done)."
26920 #: ../tools/virt-resize.pl:336
26922 "If virt-resize knows how, it will expand the direct content of the "
26923 "partition. For example, if the partition is an LVM PV, it will expand the "
26924 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26925 "content it doesn't know about alone."
26929 #: ../tools/virt-resize.pl:341
26930 msgid "Currently virt-resize can resize:"
26934 #: ../tools/virt-resize.pl:347
26936 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
26941 #: ../tools/virt-resize.pl:352
26943 "NTFS filesystems contained directly in a partition, if libguestfs was "
26944 "compiled with support for NTFS."
26948 #: ../tools/virt-resize.pl:355
26950 "The filesystem must have been shut down consistently last time it was used. "
26951 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26952 "consistency check, so at the first boot after resizing Windows will check "
26957 #: ../tools/virt-resize.pl:362
26959 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
26960 "inside the PV, but see the C<--LV-expand> option. The user could also "
26961 "resize LVs as desired after boot."
26965 #: ../tools/virt-resize.pl:368 ../tools/virt-resize.pl:390
26966 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
26970 #: ../tools/virt-resize.pl:374
26971 msgid "B<--shrink part>"
26975 #: ../tools/virt-resize.pl:376
26977 "Shrink the named partition until the overall disk image fits in the "
26978 "destination. The named partition B<must> contain a filesystem or PV which "
26979 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26980 "online tools). Virt-resize will check this and give an error if it has not "
26985 #: ../tools/virt-resize.pl:382
26987 "The amount by which the overall disk must be shrunk (after carrying out all "
26988 "other operations requested by the user) is called the \"deficit\". For "
26989 "example, a straight copy (assume no other operations) from a 5GB disk image "
26990 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26991 "would give an error unless the user specified a partition to shrink and that "
26992 "partition had more than a gigabyte of free space."
26996 #: ../tools/virt-resize.pl:396
26997 msgid "B<--ignore part>"
27001 #: ../tools/virt-resize.pl:398
27003 "Ignore the named partition. Effectively this means the partition is "
27004 "allocated on the destination disk, but the content is not copied across from "
27005 "the source disk. The content of the partition will be blank (all zero "
27010 #: ../tools/virt-resize.pl:409
27011 msgid "B<--delete part>"
27015 #: ../tools/virt-resize.pl:411
27017 "Delete the named partition. It would be more accurate to describe this as "
27018 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27019 "the original disk image is left intact."
27023 #: ../tools/virt-resize.pl:415
27025 "Note that when you delete a partition, then anything contained in the "
27026 "partition is also deleted. Furthermore, this causes any partitions that "
27027 "come after to be I<renumbered>, which can easily make your guest unbootable."
27031 #: ../tools/virt-resize.pl:426
27032 msgid "B<--LV-expand logvol>"
27036 #: ../tools/virt-resize.pl:428
27038 "This takes the logical volume and, as a final step, expands it to fill all "
27039 "the space available in its volume group. A typical usage, assuming a Linux "
27040 "guest with a single PV C</dev/sda2> and a root device called "
27041 "C</dev/vg_guest/lv_root> would be:"
27045 #: ../tools/virt-resize.pl:433
27048 " virt-resize indisk outdisk \\\n"
27049 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27054 #: ../tools/virt-resize.pl:436
27056 "This would first expand the partition (and PV), and then expand the root "
27057 "device to fill the extra space in the PV."
27061 #: ../tools/virt-resize.pl:439
27063 "The contents of the LV are also resized if virt-resize knows how to do "
27064 "that. You can stop virt-resize from trying to expand the content by using "
27065 "the option C<--no-expand-content>."
27069 #: ../tools/virt-resize.pl:443
27070 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
27074 #: ../tools/virt-resize.pl:446
27076 "You can give this option multiple times, I<but> it doesn't make sense to do "
27077 "this unless the logical volumes you specify are all in different volume "
27082 #: ../tools/virt-resize.pl:454
27083 msgid "B<--no-copy-boot-loader>"
27087 #: ../tools/virt-resize.pl:456
27089 "By default, virt-resize copies over some sectors at the start of the disk "
27090 "(up to the beginning of the first partition). Commonly these sectors "
27091 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27092 "in order for the guest to boot correctly."
27096 #: ../tools/virt-resize.pl:461
27098 "If you specify this flag, then this initial copy is not done. You may need "
27099 "to reinstall the boot loader in this case."
27103 #: ../tools/virt-resize.pl:469
27104 msgid "B<--no-extra-partition>"
27108 #: ../tools/virt-resize.pl:471
27110 "By default, virt-resize creates an extra partition if there is any extra, "
27111 "unused space after all resizing has happened. Use this option to prevent "
27112 "the extra partition from being created. If you do this then the extra space "
27113 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27114 "tool in the guest."
27118 #: ../tools/virt-resize.pl:477
27120 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27125 #: ../tools/virt-resize.pl:484
27126 msgid "B<--no-expand-content>"
27130 #: ../tools/virt-resize.pl:486
27132 "By default, virt-resize will try to expand the direct contents of "
27133 "partitions, if it knows how (see C<--expand> option above)."
27137 #: ../tools/virt-resize.pl:489
27139 "If you give the C<--no-expand-content> option then virt-resize will not "
27144 #: ../tools/virt-resize.pl:496
27145 msgid "B<-d> | B<--debug>"
27149 #: ../tools/virt-resize.pl:504
27150 msgid "B<-n> | B<--dryrun>"
27154 #: ../tools/virt-resize.pl:506
27155 msgid "Print a summary of what would be done, but don't do anything."
27159 #: ../tools/virt-resize.pl:512
27160 msgid "B<-q> | B<--quiet>"
27164 #: ../tools/virt-resize.pl:514
27165 msgid "Don't print the summary."
27169 #: ../tools/virt-resize.pl:522
27171 "Specify the format of the input disk image. If this flag is not given then "
27172 "it is auto-detected from the image itself."
27176 #: ../tools/virt-resize.pl:528
27178 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27179 "AND NON-SPARSE RAW FORMATS>."
27183 #: ../tools/virt-resize.pl:535
27184 msgid "B<--output-format> raw"
27188 #: ../tools/virt-resize.pl:537
27190 "Specify the format of the output disk image. If this flag is not given then "
27191 "it is auto-detected from the image itself."
27195 #: ../tools/virt-resize.pl:543
27197 "Note that you still need to create the output disk with the right format. "
27198 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27202 #: ../tools/virt-resize.pl:1419
27207 #: ../tools/virt-resize.pl:1421
27208 msgid "\"Partition 1 does not end on cylinder boundary.\""
27212 #: ../tools/virt-resize.pl:1423
27214 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27215 "means the partitions will not be aligned to the ancient CHS geometry. "
27216 "However CHS geometry is meaningless for disks manufactured since the early "
27217 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27218 "cylinders is not required by any modern operating system."
27222 #: ../tools/virt-resize.pl:1430
27223 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27227 #: ../tools/virt-resize.pl:1432
27229 "In Windows Vista and later versions, Microsoft switched to using a separate "
27230 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27231 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27232 "the boot partition. Doing so seems to break the guest completely. However "
27233 "expanding the second partition (ie. C: drive) should work."
27237 #: ../tools/virt-resize.pl:1439
27239 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27240 "NTFS partitions have been expanded. This is just a safety check and (unless "
27241 "it find errors) is nothing to worry about."
27245 #: ../tools/virt-resize.pl:1443
27246 msgid "GUEST BOOT STUCK AT \"GRUB\""
27250 #: ../tools/virt-resize.pl:1445
27252 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27253 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27254 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27255 "although we think is to do with partition alignment."
27259 #: ../tools/virt-resize.pl:1450
27262 " guestfish -i -a newdisk\n"
27263 " ><fs> cat /boot/grub/device.map\n"
27264 " # check the contents of this file are sensible or\n"
27265 " # edit the file if necessary\n"
27266 " ><fs> grub-install / /dev/vda\n"
27272 #: ../tools/virt-resize.pl:1457
27274 "For more flexible guest reconfiguration, including if you need to specify "
27275 "other parameters to grub-install, use L<virt-rescue(1)>."
27279 #: ../tools/virt-resize.pl:1460
27280 msgid "ALTERNATIVE TOOLS"
27284 #: ../tools/virt-resize.pl:1462
27286 "There are several proprietary tools for resizing partitions. We won't "
27287 "mention any here."
27291 #: ../tools/virt-resize.pl:1465
27293 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27294 "operations on disk images. They can resize and move partitions, but I don't "
27295 "think they can do anything with the contents, and they certainly don't "
27300 #: ../tools/virt-resize.pl:1470
27302 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27303 "but at a much lower level. You will probably end up hand-calculating sector "
27304 "offsets, which is something that virt-resize was designed to avoid. If you "
27305 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27310 #: ../tools/virt-resize.pl:1485
27312 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
27313 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
27314 "L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
27315 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
27316 "L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27320 #: ../tools/virt-list-filesystems.pl:32
27321 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
27325 #: ../tools/virt-list-filesystems.pl:36
27328 " virt-list-filesystems [--options] domname\n"
27333 #: ../tools/virt-list-filesystems.pl:38
27336 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
27341 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
27343 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
27348 #: ../tools/virt-list-filesystems.pl:45
27350 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
27351 "are contained in a virtual machine or disk image."
27355 #: ../tools/virt-list-filesystems.pl:49
27357 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
27358 "functionality. For more complex cases you should look at the "
27359 "L<guestfish(1)> tool."
27363 #: ../tools/virt-list-filesystems.pl:106 ../tools/virt-list-partitions.pl:115
27364 msgid "B<-l> | B<--long>"
27368 #: ../tools/virt-list-filesystems.pl:108
27370 "With this option, C<virt-list-filesystems> displays the type of each "
27371 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
27375 #: ../tools/virt-list-filesystems.pl:115
27376 msgid "B<-a> | B<--all>"
27380 #: ../tools/virt-list-filesystems.pl:117
27382 "Normally we only show mountable filesystems. If this option is given then "
27383 "swap devices are shown too."
27387 #: ../tools/virt-list-filesystems.pl:191
27389 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
27390 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
27391 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
27395 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-tar.pl:298
27396 msgid "Copyright (C) 2009 Red Hat Inc."
27400 #: ../tools/virt-tar.pl:33
27401 msgid "virt-tar - Extract or upload files to a virtual machine"
27405 #: ../tools/virt-tar.pl:37
27408 " virt-tar [--options] -x domname directory tarball\n"
27413 #: ../tools/virt-tar.pl:39
27416 " virt-tar [--options] -u domname tarball directory\n"
27421 #: ../tools/virt-tar.pl:41
27424 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
27429 #: ../tools/virt-tar.pl:43
27432 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
27437 #: ../tools/virt-tar.pl:47
27438 msgid "Download C</home> from the VM into a local tarball:"
27442 #: ../tools/virt-tar.pl:49
27445 " virt-tar -x domname /home home.tar\n"
27450 #: ../tools/virt-tar.pl:51
27453 " virt-tar -zx domname /home home.tar.gz\n"
27458 #: ../tools/virt-tar.pl:53
27459 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
27463 #: ../tools/virt-tar.pl:55
27466 " virt-tar -u domname uploadstuff.tar /tmp\n"
27471 #: ../tools/virt-tar.pl:57
27474 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
27479 #: ../tools/virt-tar.pl:61
27481 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
27482 "virtual machines. If you do this, you risk disk corruption in the VM. "
27483 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
27487 #: ../tools/virt-tar.pl:66
27489 "You can use C<-x> (extract) on live virtual machines, but you might get "
27490 "inconsistent results or errors if there is filesystem activity inside the "
27491 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
27492 "work, but the only way to guarantee consistent results is if the virtual "
27493 "machine is shut down."
27497 #: ../tools/virt-tar.pl:74
27499 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
27500 "parts of a guest filesystem. There are many possibilities: making backups, "
27501 "uploading data files, snooping on guest activity, fixing or customizing "
27506 #: ../tools/virt-tar.pl:79
27508 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
27509 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
27510 "should look at the L<guestfish(1)> tool."
27514 #: ../tools/virt-tar.pl:83
27516 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
27517 "its contents (recursively) from the virtual machine into a local tarball. "
27518 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
27519 "virtual machine. You cannot use these two options together."
27523 #: ../tools/virt-tar.pl:89
27525 "In addition, you may need to use the C<-z> (gZip) option to enable "
27526 "compression. When uploading, you have to specify C<-z> if the upload file "
27527 "is compressed because virt-tar won't detect this on its own."
27531 #: ../tools/virt-tar.pl:93
27533 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
27534 "example it cannot do PKZip files or bzip2 compression. If you want that "
27535 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
27536 "the L<libguestfs(3)> API)."
27540 #: ../tools/virt-tar.pl:151
27541 msgid "B<-x> | B<--extract> | B<--download>"
27545 #: ../tools/virt-tar.pl:153
27546 msgid "B<-u> | B<--upload>"
27550 #: ../tools/virt-tar.pl:155
27552 "Use C<-x> to extract (download) a directory from a virtual machine to a "
27557 #: ../tools/virt-tar.pl:158
27559 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
27560 "Please read the L</WARNING> section above before using this option."
27564 #: ../tools/virt-tar.pl:162
27565 msgid "You must specify exactly one of these options."
27569 #: ../tools/virt-tar.pl:168
27570 msgid "B<-z> | B<--gzip>"
27574 #: ../tools/virt-tar.pl:170
27575 msgid "Specify that the input or output tarball is gzip-compressed."
27579 #: ../tools/virt-tar.pl:283
27581 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
27582 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
27583 "L<http://libguestfs.org/>."
27587 #: ../tools/virt-make-fs.pl:37
27588 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
27592 #: ../tools/virt-make-fs.pl:41
27595 " virt-make-fs [--options] input.tar output.img\n"
27600 #: ../tools/virt-make-fs.pl:43
27603 " virt-make-fs [--options] input.tar.gz output.img\n"
27608 #: ../tools/virt-make-fs.pl:45
27611 " virt-make-fs [--options] directory output.img\n"
27616 #: ../tools/virt-make-fs.pl:49
27618 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
27619 "archive or some files in a directory. It is similar to tools like "
27620 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
27621 "it can create common filesystem types like ext2/3 or NTFS, which can be "
27622 "useful if you want to attach these filesystems to existing virtual machines "
27623 "(eg. to import large amounts of read-only data to a VM)."
27627 #: ../tools/virt-make-fs.pl:57
27628 msgid "Basic usage is:"
27632 #: ../tools/virt-make-fs.pl:59
27635 " virt-make-fs input output\n"
27640 #: ../tools/virt-make-fs.pl:61
27642 "where C<input> is either a directory containing files that you want to add, "
27643 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
27644 "C<output> is a disk image. The input type is detected automatically. The "
27645 "output disk image defaults to a raw ext2 image unless you specify extra "
27646 "flags (see L</OPTIONS> below)."
27650 #: ../tools/virt-make-fs.pl:67
27651 msgid "EXTRA SPACE"
27655 #: ../tools/virt-make-fs.pl:69
27657 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
27658 "the files that it contains, but might have extra space. Depending on how "
27659 "you are going to use the output, you might think this extra space is wasted "
27660 "and want to minimize it, or you might want to leave space so that more files "
27661 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
27662 "but you can use the C<--size> flag to leave space in the filesystem if you "
27667 #: ../tools/virt-make-fs.pl:77
27669 "An alternative way to leave extra space but not make the output image any "
27670 "bigger is to use an alternative disk image format (instead of the default "
27671 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
27672 "image format (check your hypervisor supports this before using it). This "
27673 "allows you to choose a large C<--size> but the extra space won't actually be "
27674 "allocated in the image until you try to store something in it."
27678 #: ../tools/virt-make-fs.pl:85
27680 "Don't forget that you can also use local commands including L<resize2fs(8)> "
27681 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
27682 "virt-make-resize to build another image from scratch."
27686 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
27691 #: ../tools/virt-make-fs.pl:91
27694 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
27699 #: ../tools/virt-make-fs.pl:93
27700 msgid "FILESYSTEM TYPE"
27704 #: ../tools/virt-make-fs.pl:95
27706 "The default filesystem type is C<ext2>. Just about any filesystem type that "
27707 "libguestfs supports can be used (but I<not> read-only formats like "
27708 "ISO9660). Here are some of the more common choices:"
27712 #: ../tools/virt-make-fs.pl:101
27717 #: ../tools/virt-make-fs.pl:103
27719 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
27720 "you are not going to use the filesystem in a way that requires the journal, "
27721 "then this is just wasted overhead."
27725 #: ../tools/virt-make-fs.pl:107
27726 msgid "I<ntfs> or I<vfat>"
27730 #: ../tools/virt-make-fs.pl:109
27731 msgid "Useful if exporting data to a Windows guest."
27735 #: ../tools/virt-make-fs.pl:111
27737 "I<Note for vfat>: The tar archive or local directory must only contain files "
27738 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
27739 "program running within libguestfs is unable to change the ownership of "
27740 "non-root files, since vfat itself does not support this."
27744 #: ../tools/virt-make-fs.pl:116
27749 #: ../tools/virt-make-fs.pl:118
27751 "Lower overhead than C<ext2>, but certain limitations on filename length and "
27752 "total filesystem size."
27756 #: ../tools/virt-make-fs.pl:125
27759 " virt-make-fs --type=minix input minixfs.img\n"
27764 #: ../tools/virt-make-fs.pl:127
27765 msgid "TO PARTITION OR NOT TO PARTITION"
27769 #: ../tools/virt-make-fs.pl:129
27770 msgid "Optionally virt-make-fs can add a partition table to the output disk."
27774 #: ../tools/virt-make-fs.pl:131
27776 "Adding a partition can make the disk image more compatible with certain "
27777 "virtualized operating systems which don't expect to see a filesystem "
27778 "directly located on a block device (Linux doesn't care and will happily "
27779 "handle both types)."
27783 #: ../tools/virt-make-fs.pl:136
27785 "On the other hand, if you have a partition table then the output image is no "
27786 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
27787 "directly on a partitioned disk image. (However libguestfs tools such as "
27788 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
27792 #: ../tools/virt-make-fs.pl:144
27793 msgid "Add an MBR partition:"
27797 #: ../tools/virt-make-fs.pl:146
27800 " virt-make-fs --partition -- input disk.img\n"
27805 #: ../tools/virt-make-fs.pl:148
27807 "If the output disk image could be terabyte-sized or larger, it's better to "
27808 "use an EFI/GPT-compatible partition table:"
27812 #: ../tools/virt-make-fs.pl:151
27815 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
27820 #: ../tools/virt-make-fs.pl:179
27821 msgid "Enable debugging information."
27825 #: ../tools/virt-make-fs.pl:185
27826 msgid "B<--size=E<lt>NE<gt>>"
27830 #: ../tools/virt-make-fs.pl:187
27831 msgid "B<--size=+E<lt>NE<gt>>"
27835 #: ../tools/virt-make-fs.pl:189
27836 msgid "B<-s E<lt>NE<gt>>"
27840 #: ../tools/virt-make-fs.pl:191
27841 msgid "B<-s +E<lt>NE<gt>>"
27845 #: ../tools/virt-make-fs.pl:193
27846 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
27850 #: ../tools/virt-make-fs.pl:196
27852 "If this option is I<not> given, then the output image will be just large "
27853 "enough to contain all the files, with not much wasted space."
27857 #: ../tools/virt-make-fs.pl:199
27859 "To choose a fixed size output disk, specify an absolute number followed by "
27860 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27861 "Petabytes or Exabytes. This must be large enough to contain all the input "
27862 "files, else you will get an error."
27866 #: ../tools/virt-make-fs.pl:204
27868 "To leave extra space, specify C<+> (plus sign) and a number followed by "
27869 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
27870 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
27871 "the input files, and (approximately) an extra 200 MB free space."
27875 #: ../tools/virt-make-fs.pl:210
27877 "Note that virt-make-fs estimates free space, and therefore will not produce "
27878 "filesystems containing precisely the free space requested. (It is much more "
27879 "expensive and time-consuming to produce a filesystem which has precisely the "
27880 "desired free space)."
27884 #: ../tools/virt-make-fs.pl:219
27885 msgid "B<--format=E<lt>fmtE<gt>>"
27889 #: ../tools/virt-make-fs.pl:221
27890 msgid "B<-F E<lt>fmtE<gt>>"
27894 #: ../tools/virt-make-fs.pl:223
27895 msgid "Choose the output disk image format."
27899 #: ../tools/virt-make-fs.pl:225
27900 msgid "The default is C<raw> (raw disk image)."
27904 #: ../tools/virt-make-fs.pl:227
27906 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
27907 "that would really make sense here is C<qcow2>."
27911 #: ../tools/virt-make-fs.pl:234
27912 msgid "B<--type=E<lt>fsE<gt>>"
27916 #: ../tools/virt-make-fs.pl:236
27917 msgid "B<-t E<lt>fsE<gt>>"
27921 #: ../tools/virt-make-fs.pl:238
27922 msgid "Choose the output filesystem type."
27926 #: ../tools/virt-make-fs.pl:240
27927 msgid "The default is C<ext2>."
27931 #: ../tools/virt-make-fs.pl:242
27932 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
27936 #: ../tools/virt-make-fs.pl:249
27937 msgid "B<--partition>"
27941 #: ../tools/virt-make-fs.pl:251
27942 msgid "B<--partition=E<lt>parttypeE<gt>>"
27946 #: ../tools/virt-make-fs.pl:253
27948 "If specified, this flag adds an MBR partition table to the output disk "
27953 #: ../tools/virt-make-fs.pl:256
27955 "You can change the partition table type, eg. C<--partition=gpt> for large "
27960 #: ../tools/virt-make-fs.pl:259
27962 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
27963 "might consider the next parameter to be the partition type. For example:"
27967 #: ../tools/virt-make-fs.pl:263
27970 " virt-make-fs --partition input.tar ...\n"
27975 #: ../tools/virt-make-fs.pl:265
27977 "would cause virt-make-fs to think you wanted to use a partition type of "
27978 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
27979 "dash) between options and the input file argument:"
27983 #: ../tools/virt-make-fs.pl:269
27986 " virt-make-fs --partition -- input.tar ...\n"
27991 #: ../tools/virt-make-fs.pl:536
27993 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
27994 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
27995 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27999 #: ../tools/virt-make-fs.pl:553
28002 " export LIBGUESTFS_DEBUG=1\n"
28003 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28008 #: ../tools/virt-make-fs.pl:556
28010 "Attach /tmp/virt-make-fs.log to a new bug report at "
28011 "L<https://bugzilla.redhat.com/>"
28015 #: ../tools/virt-list-partitions.pl:32
28016 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28020 #: ../tools/virt-list-partitions.pl:36
28023 " virt-list-partitions [--options] domname\n"
28028 #: ../tools/virt-list-partitions.pl:38
28031 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28036 #: ../tools/virt-list-partitions.pl:45
28038 "C<virt-list-partitions> is a command line tool to list the partitions that "
28039 "are contained in a virtual machine or disk image. It is mainly useful as a "
28040 "first step to using L<virt-resize(1)>."
28044 #: ../tools/virt-list-partitions.pl:50
28046 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28047 "functionality. For more complex cases you should look at the "
28048 "L<guestfish(1)> tool."
28052 #: ../tools/virt-list-partitions.pl:107
28053 msgid "B<-h> | B<--human-readable>"
28057 #: ../tools/virt-list-partitions.pl:109
28058 msgid "Show sizes in human-readable form (eg. \"1G\")."
28062 #: ../tools/virt-list-partitions.pl:117
28064 "With this option, C<virt-list-partitions> displays the type and size of each "
28065 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28069 #: ../tools/virt-list-partitions.pl:124
28070 msgid "B<-t> | B<--total>"
28074 #: ../tools/virt-list-partitions.pl:126
28075 msgid "Display the total size of each block device (as a separate row or rows)."
28079 #: ../tools/virt-list-partitions.pl:259
28081 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
28082 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
28083 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."