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.9\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2010-11-16 19:06+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 ../inspector/virt-inspector.pl:31 ../tools/virt-edit.pl:30 ../tools/virt-win-reg.pl:33 ../tools/virt-df.pl:32 ../tools/virt-ls.pl:30 ../tools/virt-resize.pl:38 ../tools/virt-list-filesystems.pl:28 ../tools/virt-tar.pl:29 ../tools/virt-rescue.pl:29 ../tools/virt-make-fs.pl:33 ../tools/virt-list-partitions.pl:28
25 #: ../src/guestfs.pod:3 ../fish/guestfish.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pl:33 ../tools/virt-edit.pl:32 ../tools/virt-win-reg.pl:35 ../tools/virt-df.pl:34 ../tools/virt-ls.pl:32 ../tools/virt-resize.pl:40 ../tools/virt-list-filesystems.pl:30 ../tools/virt-tar.pl:31 ../tools/virt-rescue.pl:31 ../tools/virt-make-fs.pl:35 ../tools/virt-list-partitions.pl:30
30 #: ../src/guestfs.pod:5
31 msgid "guestfs - Library for accessing and modifying virtual machine images"
35 #: ../src/guestfs.pod:7 ../fish/guestfish.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pl:37 ../tools/virt-edit.pl:36 ../tools/virt-win-reg.pl:39 ../tools/virt-df.pl:38 ../tools/virt-ls.pl:36 ../tools/virt-resize.pl:44 ../tools/virt-list-filesystems.pl:34 ../tools/virt-tar.pl:35 ../tools/virt-rescue.pl:35 ../tools/virt-make-fs.pl:39 ../tools/virt-list-partitions.pl:34
40 #: ../src/guestfs.pod:9
43 " #include <guestfs.h>\n"
48 #: ../src/guestfs.pod:11
51 " guestfs_h *g = guestfs_create ();\n"
52 " guestfs_add_drive (g, \"guest.img\");\n"
53 " guestfs_launch (g);\n"
54 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
55 " guestfs_touch (g, \"/hello\");\n"
56 " guestfs_umount (g, \"/\");\n"
57 " guestfs_sync (g);\n"
58 " guestfs_close (g);\n"
63 #: ../src/guestfs.pod:20
66 " cc prog.c -o prog -lguestfs\n"
68 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
73 #: ../src/guestfs.pod:24 ../fish/guestfish.pod:30 ../test-tool/libguestfs-test-tool.pod:11 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pl:43 ../tools/virt-edit.pl:50 ../tools/virt-win-reg.pl:63 ../tools/virt-df.pl:46 ../tools/virt-ls.pl:42 ../tools/virt-resize.pl:50 ../tools/virt-list-filesystems.pl:40 ../tools/virt-tar.pl:72 ../tools/virt-rescue.pl:51 ../tools/virt-make-fs.pl:47 ../tools/virt-list-partitions.pl:40
78 #: ../src/guestfs.pod:26
80 "Libguestfs is a library for accessing and modifying guest disk images. "
81 "Amongst the things this is good for: making batch configuration changes to "
82 "guests, getting disk used/free statistics (see also: virt-df), migrating "
83 "between virtualization systems (see also: virt-p2v), performing partial "
84 "backups, performing partial guest clones, cloning guests and changing "
85 "registry/UUID/hostname info, and much else besides."
89 #: ../src/guestfs.pod:34
91 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
92 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
93 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
98 #: ../src/guestfs.pod:39
100 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
101 "what filesystem is in each LV, etc.). It can also run commands in the "
102 "context of the guest. Also you can access filesystems over FUSE."
106 #: ../src/guestfs.pod:44
108 "Libguestfs is a library that can be linked with C and C++ management "
109 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
110 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
115 #: ../src/guestfs.pod:49
117 "You don't need to be root to use libguestfs, although obviously you do need "
118 "enough permissions to access the disk images."
122 #: ../src/guestfs.pod:52
124 "Libguestfs is a large API because it can do many things. For a gentle "
125 "introduction, please read the L</API OVERVIEW> section next."
129 #: ../src/guestfs.pod:55
134 #: ../src/guestfs.pod:57
136 "This section provides a gentler overview of the libguestfs API. We also try "
137 "to group API calls together, where that may not be obvious from reading "
138 "about the individual calls in the main section of this manual."
142 #: ../src/guestfs.pod:62
147 #: ../src/guestfs.pod:64
149 "Before you can use libguestfs calls, you have to create a handle. Then you "
150 "must add at least one disk image to the handle, followed by launching the "
151 "handle, then performing whatever operations you want, and finally closing "
152 "the handle. By convention we use the single letter C<g> for the name of the "
153 "handle variable, although of course you can use any name you want."
157 #: ../src/guestfs.pod:71
158 msgid "The general structure of all libguestfs-using programs looks like this:"
162 #: ../src/guestfs.pod:74
165 " guestfs_h *g = guestfs_create ();\n"
170 #: ../src/guestfs.pod:76
173 " /* Call guestfs_add_drive additional times if there are\n"
174 " * multiple disk images.\n"
176 " guestfs_add_drive (g, \"guest.img\");\n"
181 #: ../src/guestfs.pod:81
184 " /* Most manipulation calls won't work until you've launched\n"
185 " * the handle 'g'. You have to do this _after_ adding drives\n"
186 " * and _before_ other commands.\n"
188 " guestfs_launch (g);\n"
193 #: ../src/guestfs.pod:87
196 " /* Now you can examine what partitions, LVs etc are available.\n"
198 " char **partitions = guestfs_list_partitions (g);\n"
199 " char **logvols = guestfs_lvs (g);\n"
204 #: ../src/guestfs.pod:92
207 " /* To access a filesystem in the image, you must mount it.\n"
209 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
214 #: ../src/guestfs.pod:96
217 " /* Now you can perform filesystem actions on the guest\n"
220 " guestfs_touch (g, \"/hello\");\n"
225 #: ../src/guestfs.pod:101
228 " /* You only need to call guestfs_sync if you have made\n"
229 " * changes to the guest image. (But if you've made changes\n"
230 " * then you *must* sync). See also: guestfs_umount and\n"
231 " * guestfs_umount_all calls.\n"
233 " guestfs_sync (g);\n"
238 #: ../src/guestfs.pod:108
241 " /* Close the handle 'g'. */\n"
242 " guestfs_close (g);\n"
247 #: ../src/guestfs.pod:111
249 "The code above doesn't include any error checking. In real code you should "
250 "check return values carefully for errors. In general all functions that "
251 "return integers return C<-1> on error, and all functions that return "
252 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
253 "how to handle errors, and consult the documentation for each function call "
254 "below to see precisely how they return error indications."
258 #: ../src/guestfs.pod:119
263 #: ../src/guestfs.pod:121
265 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
266 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
267 "actual block device, or simply an empty file of zeroes that you have created "
268 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
273 #: ../src/guestfs.pod:127
275 "The call you should use in modern code for adding drives is "
276 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
277 "specifying that the format is raw, do:"
281 #: ../src/guestfs.pod:131
284 " guestfs_add_drive_opts (g, filename,\n"
285 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
291 #: ../src/guestfs.pod:135
292 msgid "You can add a disk read-only using:"
296 #: ../src/guestfs.pod:137
299 " guestfs_add_drive_opts (g, filename,\n"
300 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
301 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
307 #: ../src/guestfs.pod:142
309 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
310 "libguestfs won't modify the file."
314 #: ../src/guestfs.pod:145
316 "Be extremely cautious if the disk image is in use, eg. if it is being used "
317 "by a virtual machine. Adding it read-write will almost certainly cause disk "
318 "corruption, but adding it read-only is safe."
322 #: ../src/guestfs.pod:149
324 "You must add at least one disk image, and you may add multiple disk images. "
325 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
326 "first one you added), C</dev/sdb> (for the second one you added), etc."
330 #: ../src/guestfs.pod:154
332 "Once L</guestfs_launch> has been called you cannot add any more images. You "
333 "can call L</guestfs_list_devices> to get a list of the device names, in the "
334 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
338 #: ../src/guestfs.pod:159
343 #: ../src/guestfs.pod:161
345 "Before you can read or write files, create directories and so on in a disk "
346 "image that contains filesystems, you have to mount those filesystems using "
347 "L</guestfs_mount>. If you already know that a disk image contains (for "
348 "example) one partition with a filesystem on that partition, then you can "
353 #: ../src/guestfs.pod:167
356 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
361 #: ../src/guestfs.pod:169
363 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
364 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
365 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>)."
369 #: ../src/guestfs.pod:173
371 "If you are given a disk image and you don't know what it contains then you "
372 "have to find out. Libguestfs can do that too: use "
373 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
374 "and LVs, and either try mounting each to see what is mountable, or else "
375 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. Libguestfs also "
376 "has a set of APIs for inspection of disk images (see L</INSPECTION> below). "
377 "But you might find it easier to look at higher level programs built on top "
378 "of libguestfs, in particular L<virt-inspector(1)>."
382 #: ../src/guestfs.pod:183
384 "To mount a disk image read-only, use L</guestfs_mount_ro>. There are "
385 "several other variations of the C<guestfs_mount_*> call."
389 #: ../src/guestfs.pod:186
390 msgid "FILESYSTEM ACCESS AND MODIFICATION"
394 #: ../src/guestfs.pod:188
396 "The majority of the libguestfs API consists of fairly low-level calls for "
397 "accessing and modifying the files, directories, symlinks etc on mounted "
398 "filesystems. There are over a hundred such calls which you can find listed "
399 "in detail below in this man page, and we don't even pretend to cover them "
400 "all in this overview."
404 #: ../src/guestfs.pod:194
406 "Specify filenames as full paths, starting with C<\"/\"> and including the "
411 #: ../src/guestfs.pod:197
413 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
414 "the file called C<\"etc/passwd\"> then you could do:"
418 #: ../src/guestfs.pod:200
421 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
426 #: ../src/guestfs.pod:202
428 "This would return C<data> as a newly allocated buffer containing the full "
429 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
430 "or C<NULL> if there was an error."
434 #: ../src/guestfs.pod:206
436 "As another example, to create a top-level directory on that filesystem "
437 "called C<\"var\"> you would do:"
441 #: ../src/guestfs.pod:209
444 " guestfs_mkdir (g, \"/var\");\n"
449 #: ../src/guestfs.pod:211
450 msgid "To create a symlink you could do:"
454 #: ../src/guestfs.pod:213
457 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
458 " \"/etc/rc3.d/S30portmap\");\n"
463 #: ../src/guestfs.pod:216
465 "Libguestfs will reject attempts to use relative paths and there is no "
466 "concept of a current working directory."
470 #: ../src/guestfs.pod:219
472 "Libguestfs can return errors in many situations: for example if the "
473 "filesystem isn't writable, or if a file or directory that you requested "
474 "doesn't exist. If you are using the C API (documented here) you have to "
475 "check for those error conditions after each call. (Other language bindings "
476 "turn these errors into exceptions)."
480 #: ../src/guestfs.pod:225
482 "File writes are affected by the per-handle umask, set by calling "
483 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
487 #: ../src/guestfs.pod:228
492 #: ../src/guestfs.pod:230
494 "Libguestfs contains API calls to read, create and modify partition tables on "
499 #: ../src/guestfs.pod:233
501 "In the common case where you want to create a single partition covering the "
502 "whole disk, you should use the L</guestfs_part_disk> call:"
506 #: ../src/guestfs.pod:237
509 " const char *parttype = \"mbr\";\n"
510 " if (disk_is_larger_than_2TB)\n"
511 " parttype = \"gpt\";\n"
512 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
517 #: ../src/guestfs.pod:242
519 "Obviously this effectively wipes anything that was on that disk image "
524 #: ../src/guestfs.pod:245
529 #: ../src/guestfs.pod:247
531 "Libguestfs provides access to a large part of the LVM2 API, such as "
532 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
533 "unless you familiarize yourself with the concepts of physical volumes, "
534 "volume groups and logical volumes."
538 #: ../src/guestfs.pod:252
540 "This author strongly recommends reading the LVM HOWTO, online at "
541 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
545 #: ../src/guestfs.pod:255
550 #: ../src/guestfs.pod:257
552 "Use L</guestfs_cat> to download small, text only files. This call is "
553 "limited to files which are less than 2 MB and which cannot contain any ASCII "
554 "NUL (C<\\0>) characters. However it has a very simple to use API."
558 #: ../src/guestfs.pod:262
560 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
561 "bit data, since it returns a (pointer, size) pair. However it is still "
562 "limited to \"small\" files, less than 2 MB."
566 #: ../src/guestfs.pod:266
568 "L</guestfs_download> can be used to download any file, with no limits on "
569 "content or size (even files larger than 4 GB)."
573 #: ../src/guestfs.pod:269
574 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
578 #: ../src/guestfs.pod:272
583 #: ../src/guestfs.pod:274
585 "It's often the case that you want to write a file or files to the disk "
590 #: ../src/guestfs.pod:277
592 "To write a small file with fixed content, use L</guestfs_write>. To create "
593 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
594 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
595 "variety of other functions for creating test files, for example "
596 "L</guestfs_fill> and L</guestfs_fill_pattern>."
600 #: ../src/guestfs.pod:283
602 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
603 "file content or size (even files larger than 4 GB)."
607 #: ../src/guestfs.pod:286
608 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
612 #: ../src/guestfs.pod:288
614 "However the fastest way to upload I<large numbers of arbitrary files> is to "
615 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
616 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
617 "the drive in a predictable way (eg. adding it last after all other drives) "
618 "then you can get the device name from L</guestfs_list_devices> and mount it "
619 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
620 "sometimes non-portable between kernel versions, and they don't support "
621 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
622 "using a label or UUID, use an ISO image instead."
626 #: ../src/guestfs.pod:299
631 #: ../src/guestfs.pod:301
633 "There are various different commands for copying between files and devices "
634 "and in and out of the guest filesystem. These are summarised in the table "
639 #: ../src/guestfs.pod:307
640 msgid "B<file> to B<file>"
644 #: ../src/guestfs.pod:309
646 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
647 "directories recursively."
651 #: ../src/guestfs.pod:312
652 msgid "B<file or device> to B<file or device>"
656 #: ../src/guestfs.pod:314
658 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
659 "devices in the guest."
663 #: ../src/guestfs.pod:317
664 msgid "Example: duplicate the contents of an LV:"
668 #: ../src/guestfs.pod:319
671 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
676 #: ../src/guestfs.pod:321
678 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
679 "(C</dev/VG/Original>). To copy less than the whole source device, use "
680 "L</guestfs_copy_size>."
684 #: ../src/guestfs.pod:325
685 msgid "B<file on the host> to B<file or device>"
689 #: ../src/guestfs.pod:327
690 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
694 #: ../src/guestfs.pod:329
695 msgid "B<file or device> to B<file on the host>"
699 #: ../src/guestfs.pod:331
700 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
704 #: ../src/guestfs.pod:335
705 msgid "LISTING FILES"
709 #: ../src/guestfs.pod:337
711 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
712 "L<guestfish(1)>-equivalent command C<ll>)."
716 #: ../src/guestfs.pod:340
718 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
719 "programs, as a flat list of strings."
723 #: ../src/guestfs.pod:343
725 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
726 "directory, plus additional information about each one. It is more "
727 "equivalent to using the L<readdir(3)> call on a local filesystem."
731 #: ../src/guestfs.pod:347
733 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
738 #: ../src/guestfs.pod:350
739 msgid "RUNNING COMMANDS"
743 #: ../src/guestfs.pod:352
745 "Although libguestfs is primarily an API for manipulating files inside guest "
746 "images, we also provide some limited facilities for running commands inside "
751 #: ../src/guestfs.pod:356
752 msgid "There are many limitations to this:"
756 #: ../src/guestfs.pod:360 ../src/guestfs.pod:365 ../src/guestfs.pod:370 ../src/guestfs.pod:374 ../src/guestfs.pod:379 ../src/guestfs.pod:383 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:957 ../src/guestfs.pod:961 ../src/guestfs.pod:965 ../src/guestfs.pod:970 ../src/guestfs.pod:978 ../src/guestfs.pod:997 ../src/guestfs.pod:1005 ../src/guestfs.pod:1027 ../src/guestfs.pod:1031 ../src/guestfs.pod:1035 ../src/guestfs.pod:1039 ../src/guestfs.pod:1043 ../src/guestfs.pod:1047 ../src/guestfs.pod:1529 ../src/guestfs.pod:1534 ../src/guestfs.pod:1538 ../src/guestfs.pod:1648 ../src/guestfs.pod:1653 ../src/guestfs.pod:1657 ../src/guestfs.pod:2001 ../src/guestfs.pod:2007 ../src/guestfs.pod:2012 ../src/guestfs.pod:2018 ../src/guestfs.pod:2125 ../src/guestfs.pod:2129 ../src/guestfs.pod:2133 ../src/guestfs.pod:2137 ../src/guestfs-actions.pod:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:569 ../src/guestfs-actions.pod:577 ../src/guestfs-actions.pod:584 ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:1591 ../src/guestfs-actions.pod:1595 ../src/guestfs-actions.pod:1599 ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1611 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:1625 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1633 ../src/guestfs-actions.pod:1771 ../src/guestfs-actions.pod:1775 ../src/guestfs-actions.pod:1780 ../src/guestfs-actions.pod:1785 ../src/guestfs-actions.pod:1846 ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855 ../fish/guestfish.pod:376 ../fish/guestfish.pod:380 ../fish/guestfish.pod:384 ../fish/guestfish.pod:388 ../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 ../inspector/virt-inspector.pl:466 ../inspector/virt-inspector.pl:470 ../tools/virt-df.pl:161 ../tools/virt-df.pl:167 ../tools/virt-resize.pl:348 ../tools/virt-resize.pl:353 ../tools/virt-resize.pl:363
761 #: ../src/guestfs.pod:362
763 "The kernel version that the command runs under will be different from what "
768 #: ../src/guestfs.pod:367
770 "If the command needs to communicate with daemons, then most likely they "
775 #: ../src/guestfs.pod:372
776 msgid "The command will be running in limited memory."
780 #: ../src/guestfs.pod:376
782 "The network may not be available unless you enable it (see "
783 "L</guestfs_set_network>)."
787 #: ../src/guestfs.pod:381
788 msgid "Only supports Linux guests (not Windows, BSD, etc)."
792 #: ../src/guestfs.pod:385
793 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
797 #: ../src/guestfs.pod:390
799 "For SELinux guests, you may need to enable SELinux and load policy first. "
800 "See L</SELINUX> in this manpage."
804 #: ../src/guestfs.pod:395
806 "I<Security:> It is not safe to run commands from untrusted, possibly "
807 "malicious guests. These commands may attempt to exploit your program by "
808 "sending unexpected output. They could also try to exploit the Linux kernel "
809 "or qemu provided by the libguestfs appliance. They could use the network "
810 "provided by the libguestfs appliance to bypass ordinary network partitions "
811 "and firewalls. They could use the elevated privileges or different SELinux "
812 "context of your program to their advantage."
816 #: ../src/guestfs.pod:404
818 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
819 "(a script which runs when the guest next boots normally), and to have this "
820 "script run the commands you want in the normal context of the running guest, "
821 "network security and so on. For information about other security issues, "
826 #: ../src/guestfs.pod:412
828 "The two main API calls to run commands are L</guestfs_command> and "
829 "L</guestfs_sh> (there are also variations)."
833 #: ../src/guestfs.pod:415
835 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
836 "shell globs, redirections, etc will work."
840 #: ../src/guestfs.pod:418
841 msgid "CONFIGURATION FILES"
845 #: ../src/guestfs.pod:420
847 "To read and write configuration files in Linux guest filesystems, we "
848 "strongly recommend using Augeas. For example, Augeas understands how to "
849 "read and write, say, a Linux shadow password file or X.org configuration "
850 "file, and so avoids you having to write that code."
854 #: ../src/guestfs.pod:425
856 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
857 "document Augeas itself here because there is excellent documentation on the "
858 "L<http://augeas.net/> website."
862 #: ../src/guestfs.pod:429
864 "If you don't want to use Augeas (you fool!) then try calling "
865 "L</guestfs_read_lines> to get the file as a list of lines which you can "
870 #: ../src/guestfs.pod:433
875 #: ../src/guestfs.pod:435
877 "We support SELinux guests. To ensure that labeling happens correctly in "
878 "SELinux guests, you need to enable SELinux and load the guest's policy:"
882 #: ../src/guestfs.pod:441 ../src/guestfs.pod:1150 ../src/guestfs.pod:1281
887 #: ../src/guestfs.pod:443
888 msgid "Before launching, do:"
892 #: ../src/guestfs.pod:445
895 " guestfs_set_selinux (g, 1);\n"
900 #: ../src/guestfs.pod:447 ../src/guestfs.pod:1154 ../src/guestfs.pod:1285
905 #: ../src/guestfs.pod:449
907 "After mounting the guest's filesystem(s), load the policy. This is best "
908 "done by running the L<load_policy(8)> command in the guest itself:"
912 #: ../src/guestfs.pod:453
915 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
920 #: ../src/guestfs.pod:455
922 "(Older versions of C<load_policy> require you to specify the name of the "
927 #: ../src/guestfs.pod:458 ../src/guestfs.pod:1291
932 #: ../src/guestfs.pod:460
934 "Optionally, set the security context for the API. The correct security "
935 "context to use can only be known by inspecting the guest. As an example:"
939 #: ../src/guestfs.pod:464
942 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
947 #: ../src/guestfs.pod:468
948 msgid "This will work for running commands and editing existing files."
952 #: ../src/guestfs.pod:470
954 "When new files are created, you may need to label them explicitly, for "
955 "example by running the external command C<restorecon pathname>."
959 #: ../src/guestfs.pod:474
964 #: ../src/guestfs.pod:476
966 "Certain calls are affected by the current file mode creation mask (the "
967 "\"umask\"). In particular ones which create files or directories, such as "
968 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
969 "either the default mode that the file is created with or modifies the mode "
974 #: ../src/guestfs.pod:482
976 "The default umask is C<022>, so files are created with modes such as C<0644> "
977 "and directories with C<0755>."
981 #: ../src/guestfs.pod:485
983 "There are two ways to avoid being affected by umask. Either set umask to 0 "
984 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
985 "L</guestfs_chmod> after creating each file or directory."
989 #: ../src/guestfs.pod:489
990 msgid "For more information about umask, see L<umask(2)>."
994 #: ../src/guestfs.pod:491 ../fish/guestfish.pod:669
995 msgid "ENCRYPTED DISKS"
999 #: ../src/guestfs.pod:493
1001 "Libguestfs allows you to access Linux guests which have been encrypted using "
1002 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
1003 "standard. This includes nearly all whole disk encryption systems used by "
1004 "modern Linux guests."
1008 #: ../src/guestfs.pod:499
1010 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
1011 "returns the string C<crypto_LUKS>)."
1015 #: ../src/guestfs.pod:502
1017 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
1018 "will require the passphrase!"
1022 #: ../src/guestfs.pod:505
1024 "Opening a LUKS device creates a new device mapper device called "
1025 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
1026 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
1027 "decrypted from and encrypted to the underlying block device respectively."
1031 #: ../src/guestfs.pod:511
1033 "LVM volume groups on the device can be made visible by calling "
1034 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
1035 "volume(s) can now be mounted in the usual way."
1039 #: ../src/guestfs.pod:515
1041 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
1042 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
1043 "[\"/dev/VG\"])>. Then close the mapper device by calling "
1044 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
1045 "underlying encrypted block device)."
1049 #: ../src/guestfs.pod:522
1054 #: ../src/guestfs.pod:524
1056 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
1057 "contains operating systems. (These APIs used to be in a separate Perl-only "
1058 "library called L<Sys::Guestfs::Lib(3)> but since version 1.5.3 the most "
1059 "frequently used part of this library has been rewritten in C and moved into "
1064 #: ../src/guestfs.pod:530
1066 "Add all disks belonging to the unknown virtual machine and call "
1067 "L</guestfs_launch> in the usual way."
1071 #: ../src/guestfs.pod:533
1073 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
1074 "and certain heuristics, and returns a list of operating systems that were "
1075 "found. An empty list means none were found. A single element is the root "
1076 "filesystem of the operating system. For dual- or multi-boot guests, "
1077 "multiple roots can be returned, each one corresponding to a separate "
1078 "operating system. (Multi-boot virtual machines are extremely rare in the "
1079 "world of virtualization, but since this scenario can happen, we have built "
1080 "libguestfs to deal with it.)"
1084 #: ../src/guestfs.pod:542
1086 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
1087 "to get additional details about that operating system. For example, call "
1088 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
1089 "Windows and Linux-based operating systems respectively."
1093 #: ../src/guestfs.pod:548
1095 "Un*x-like and Linux-based operating systems usually consist of several "
1096 "filesystems which are mounted at boot time (for example, a separate boot "
1097 "partition mounted on C</boot>). The inspection rules are able to detect how "
1098 "filesystems correspond to mount points. Call "
1099 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
1100 "hash table like this example:"
1104 #: ../src/guestfs.pod:555
1107 " /boot => /dev/sda1\n"
1108 " / => /dev/vg_guest/lv_root\n"
1109 " /usr => /dev/vg_guest/lv_usr\n"
1114 #: ../src/guestfs.pod:559
1116 "The caller can then make calls to L</guestfs_mount_options> to mount the "
1117 "filesystems as suggested."
1121 #: ../src/guestfs.pod:562
1123 "Be careful to mount filesystems in the right order (eg. C</> before "
1124 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
1129 #: ../src/guestfs.pod:566
1131 "Inspection currently only works for some common operating systems. "
1132 "Contributors are welcome to send patches for other operating systems that we "
1133 "currently cannot detect."
1137 #: ../src/guestfs.pod:570
1139 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
1140 "for more details. The L</guestfs_inspect_os> function just ignores any "
1141 "encrypted devices."
1145 #: ../src/guestfs.pod:574
1147 "A note on the implementation: The call L</guestfs_inspect_os> performs "
1148 "inspection and caches the results in the guest handle. Subsequent calls to "
1149 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
1150 "re-read the disks. If you change the content of the guest disks, you can "
1151 "redo inspection by calling L</guestfs_inspect_os> again. "
1152 "(L</guestfs_inspect_list_applications> works a little differently from the "
1153 "other calls and does read the disks. See documentation for that function "
1158 #: ../src/guestfs.pod:583
1159 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
1163 #: ../src/guestfs.pod:585
1165 "Libguestfs can mount NTFS partitions. It does this using the "
1166 "L<http://www.ntfs-3g.org/> driver."
1170 #: ../src/guestfs.pod:588
1172 "DOS and Windows still use drive letters, and the filesystems are always "
1173 "treated as case insensitive by Windows itself, and therefore you might find "
1174 "a Windows configuration file referring to a path like "
1175 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
1176 "that directory might be referred to as C</WINDOWS/System32>."
1180 #: ../src/guestfs.pod:594
1182 "Drive letter mappings are outside the scope of libguestfs. You have to use "
1183 "libguestfs to read the appropriate Windows Registry and configuration files, "
1184 "to determine yourself how drives are mapped (see also L<hivex(3)> and "
1185 "L<virt-inspector(1)>)."
1189 #: ../src/guestfs.pod:599
1191 "Replacing backslash characters with forward slash characters is also outside "
1192 "the scope of libguestfs, but something that you can easily do."
1196 #: ../src/guestfs.pod:602
1198 "Where we can help is in resolving the case insensitivity of paths. For "
1199 "this, call L</guestfs_case_sensitive_path>."
1203 #: ../src/guestfs.pod:605
1205 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
1206 "files, through the library C<hivex> which is part of the libguestfs project "
1207 "although ships as a separate tarball. You have to locate and download the "
1208 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
1209 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
1210 "L<virt-win-reg(1)> for more help on this issue."
1214 #: ../src/guestfs.pod:613
1215 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
1219 #: ../src/guestfs.pod:615
1221 "Although we don't want to discourage you from using the C API, we will "
1222 "mention here that the same API is also available in other languages."
1226 #: ../src/guestfs.pod:618
1228 "The API is broadly identical in all supported languages. This means that "
1229 "the C call C<guestfs_mount(g,path)> is C<$g-E<gt>mount($path)> in Perl, "
1230 "C<g.mount(path)> in Python, and C<Guestfs.mount g path> in OCaml. In other "
1231 "words, a straightforward, predictable isomorphism between each language."
1235 #: ../src/guestfs.pod:624
1237 "Error messages are automatically transformed into exceptions if the language "
1242 #: ../src/guestfs.pod:627
1244 "We don't try to \"object orientify\" parts of the API in OO languages, "
1245 "although contributors are welcome to write higher level APIs above what we "
1246 "provide in their favourite languages if they wish."
1250 #: ../src/guestfs.pod:633
1255 #: ../src/guestfs.pod:635
1257 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
1258 "identical to the C API. C++ classes and exceptions are not used."
1262 #: ../src/guestfs.pod:639
1267 #: ../src/guestfs.pod:641
1269 "The C# bindings are highly experimental. Please read the warnings at the "
1270 "top of C<csharp/Libguestfs.cs>."
1274 #: ../src/guestfs.pod:644
1279 #: ../src/guestfs.pod:646
1281 "This is the only language binding that is working but incomplete. Only "
1282 "calls which return simple integers have been bound in Haskell, and we are "
1283 "looking for help to complete this binding."
1287 #: ../src/guestfs.pod:650
1292 #: ../src/guestfs.pod:652
1294 "Full documentation is contained in the Javadoc which is distributed with "
1299 #: ../src/guestfs.pod:655
1304 #: ../src/guestfs.pod:657
1305 msgid "For documentation see the file C<guestfs.mli>."
1309 #: ../src/guestfs.pod:659
1314 #: ../src/guestfs.pod:661
1315 msgid "For documentation see L<Sys::Guestfs(3)>."
1319 #: ../src/guestfs.pod:663
1324 #: ../src/guestfs.pod:665
1326 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
1327 "the php-libguestfs package for your distribution."
1331 #: ../src/guestfs.pod:668
1332 msgid "The PHP binding only works correctly on 64 bit machines."
1336 #: ../src/guestfs.pod:670
1341 #: ../src/guestfs.pod:672
1342 msgid "For documentation do:"
1346 #: ../src/guestfs.pod:674
1350 " >>> import guestfs\n"
1351 " >>> help (guestfs)\n"
1356 #: ../src/guestfs.pod:678
1361 #: ../src/guestfs.pod:680
1363 "Use the Guestfs module. There is no Ruby-specific documentation, but you "
1364 "can find examples written in Ruby in the libguestfs source."
1368 #: ../src/guestfs.pod:683
1369 msgid "B<shell scripts>"
1373 #: ../src/guestfs.pod:685
1374 msgid "For documentation see L<guestfish(1)>."
1378 #: ../src/guestfs.pod:689
1379 msgid "LIBGUESTFS GOTCHAS"
1383 #: ../src/guestfs.pod:691
1385 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
1386 "system [...] that works in the way it is documented but is counterintuitive "
1387 "and almost invites mistakes.\""
1391 #: ../src/guestfs.pod:695
1393 "Since we developed libguestfs and the associated tools, there are several "
1394 "things we would have designed differently, but are now stuck with for "
1395 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
1396 "release, you can expect these to change. Beware of them."
1400 #: ../src/guestfs.pod:703
1401 msgid "Autosync / forgetting to sync."
1405 #: ../src/guestfs.pod:705
1407 "When modifying a filesystem from C or another language, you B<must> unmount "
1408 "all filesystems and call L</guestfs_sync> explicitly before you close the "
1409 "libguestfs handle. You can also call:"
1413 #: ../src/guestfs.pod:709
1416 " guestfs_set_autosync (g, 1);\n"
1421 #: ../src/guestfs.pod:711
1423 "to have the unmount/sync done automatically for you when the handle 'g' is "
1424 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
1429 #: ../src/guestfs.pod:715
1431 "If you forget to do this, then it is entirely possible that your changes "
1432 "won't be written out, or will be partially written, or (very rarely) that "
1433 "you'll get disk corruption."
1437 #: ../src/guestfs.pod:719
1439 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
1440 "guestfish scripts that forget to sync will work just fine, which can make "
1441 "this very puzzling if you are trying to debug a problem."
1445 #: ../src/guestfs.pod:723
1447 "Update: Autosync is enabled by default for all API users starting from "
1448 "libguestfs 1.5.24."
1452 #: ../src/guestfs.pod:726
1453 msgid "Mount option C<-o sync> should not be the default."
1457 #: ../src/guestfs.pod:728
1459 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
1460 "However C<-o sync> does not add any reliability benefit, but does have a "
1461 "very large performance impact."
1465 #: ../src/guestfs.pod:732
1467 "The work around is to use L</guestfs_mount_options> and set the mount "
1468 "options that you actually want to use."
1472 #: ../src/guestfs.pod:735
1473 msgid "Read-only should be the default."
1477 #: ../src/guestfs.pod:737
1479 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
1480 "specify I<--rw> if you want to make changes to the image."
1484 #: ../src/guestfs.pod:740
1485 msgid "This would reduce the potential to corrupt live VM images."
1489 #: ../src/guestfs.pod:742
1491 "Note that many filesystems change the disk when you just mount and unmount, "
1492 "even if you didn't perform any writes. You need to use "
1493 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
1497 #: ../src/guestfs.pod:746
1498 msgid "guestfish command line is hard to use."
1502 #: ../src/guestfs.pod:748
1504 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
1505 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
1506 "exist, so it fails. In earlier versions of guestfish the error message was "
1507 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
1508 "we should have used C<guestfish -c command> to run commands."
1512 #: ../src/guestfs.pod:755
1513 msgid "guestfish megabyte modifiers don't work right on all commands"
1517 #: ../src/guestfs.pod:757
1519 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
1520 "other modifiers). What guestfish actually does is to multiply the number "
1521 "part by the modifier part and pass the result to the C API. However this "
1522 "doesn't work for a few APIs which aren't expecting bytes, but are already "
1523 "expecting some other unit (eg. megabytes)."
1527 #: ../src/guestfs.pod:764
1528 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
1532 #: ../src/guestfs.pod:766
1535 " lvcreate LV VG 100M\n"
1540 #: ../src/guestfs.pod:768
1542 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
1543 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
1544 "megabytes * megabytes) logical volume. The error message you get from this "
1545 "is also a little obscure."
1549 #: ../src/guestfs.pod:773
1551 "This could be fixed in the generator by specially marking parameters and "
1552 "return values which take bytes or other units."
1556 #: ../src/guestfs.pod:776
1557 msgid "Ambiguity between devices and paths"
1561 #: ../src/guestfs.pod:778
1563 "There is a subtle ambiguity in the API between a device name "
1564 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
1565 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
1569 #: ../src/guestfs.pod:783
1571 "In the current API we usually resolve this ambiguity by having two separate "
1572 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
1573 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
1574 "detecting if the path supplied begins with C</dev/>."
1578 #: ../src/guestfs.pod:789
1580 "To avoid both the ambiguity and the need to duplicate some calls, we could "
1581 "make paths/devices into structured names. One way to do this would be to "
1582 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
1583 "aspect of grub. Another way would be to use a structured type, equivalent "
1584 "to this OCaml type:"
1588 #: ../src/guestfs.pod:795
1591 " type path = Path of string | Device of int | Partition of int * int\n"
1596 #: ../src/guestfs.pod:797
1597 msgid "which would allow you to pass arguments like:"
1601 #: ../src/guestfs.pod:799
1604 " Path \"/foo/bar\"\n"
1605 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
1606 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
1607 " Path \"/dev/sdb2\" (* not a device *)\n"
1612 #: ../src/guestfs.pod:804
1614 "As you can see there are still problems to resolve even with this "
1615 "representation. Also consider how it might work in guestfish."
1619 #: ../src/guestfs.pod:809
1620 msgid "PROTOCOL LIMITS"
1624 #: ../src/guestfs.pod:811
1626 "Internally libguestfs uses a message-based protocol to pass API calls and "
1627 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
1628 "plenty more detail about this). The maximum message size used by the "
1629 "protocol is slightly less than 4 MB. For some API calls you may need to be "
1630 "aware of this limit. The API calls which may be affected are individually "
1631 "documented, with a link back to this section of the documentation."
1635 #: ../src/guestfs.pod:819
1637 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
1638 "a simple string. Because this string is at some point internally encoded as "
1639 "a message, the maximum size that it can return is slightly under 4 MB. If "
1640 "the requested file is larger than this then you will get an error."
1644 #: ../src/guestfs.pod:825
1646 "In order to transfer large files into and out of the guest filesystem, you "
1647 "need to use particular calls that support this. The sections L</UPLOADING> "
1648 "and L</DOWNLOADING> document how to do this."
1652 #: ../src/guestfs.pod:829
1654 "You might also consider mounting the disk image using our FUSE filesystem "
1655 "support (L<guestmount(1)>)."
1659 #: ../src/guestfs.pod:832
1660 msgid "KEYS AND PASSPHRASES"
1664 #: ../src/guestfs.pod:834
1666 "Certain libguestfs calls take a parameter that contains sensitive key "
1667 "material, passed in as a C string."
1671 #: ../src/guestfs.pod:837
1673 "In the future we would hope to change the libguestfs implementation so that "
1674 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
1675 "swap. However this is I<not> done at the moment, because of the complexity "
1676 "of such an implementation."
1680 #: ../src/guestfs.pod:842
1682 "Therefore you should be aware that any key parameter you pass to libguestfs "
1683 "might end up being written out to the swap partition. If this is a concern, "
1684 "scrub the swap partition or don't use libguestfs on encrypted devices."
1688 #: ../src/guestfs.pod:847
1689 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
1693 #: ../src/guestfs.pod:849
1695 "All high-level libguestfs actions are synchronous. If you want to use "
1696 "libguestfs asynchronously then you must create a thread."
1700 #: ../src/guestfs.pod:852
1702 "Only use the handle from a single thread. Either use the handle exclusively "
1703 "from one thread, or provide your own mutex so that two threads cannot issue "
1704 "calls on the same handle at the same time."
1708 #: ../src/guestfs.pod:856
1710 "See the graphical program guestfs-browser for one possible architecture for "
1711 "multithreaded programs using libvirt and libguestfs."
1715 #: ../src/guestfs.pod:859
1720 #: ../src/guestfs.pod:861
1722 "Libguestfs needs a kernel and initrd.img, which it finds by looking along an "
1727 #: ../src/guestfs.pod:864
1729 "By default it looks for these in the directory C<$libdir/guestfs> "
1730 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
1734 #: ../src/guestfs.pod:867
1736 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
1737 "to change the directories that libguestfs will search in. The value is a "
1738 "colon-separated list of paths. The current directory is I<not> searched "
1739 "unless the path contains an empty element or C<.>. For example "
1740 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
1741 "then C</usr/lib/guestfs>."
1745 #: ../src/guestfs.pod:874
1746 msgid "QEMU WRAPPERS"
1750 #: ../src/guestfs.pod:876
1752 "If you want to compile your own qemu, run qemu from a non-standard location, "
1753 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
1758 #: ../src/guestfs.pod:880
1760 "There is one important rule to remember: you I<must C<exec qemu>> as the "
1761 "last command in the shell script (so that qemu replaces the shell and "
1762 "becomes the direct child of the libguestfs-using program). If you don't do "
1763 "this, then the qemu process won't be cleaned up correctly."
1767 #: ../src/guestfs.pod:885
1769 "Here is an example of a wrapper, where I have built my own copy of qemu from "
1774 #: ../src/guestfs.pod:888
1778 " qemudir=/home/rjones/d/qemu\n"
1779 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
1785 #: ../src/guestfs.pod:892
1787 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
1788 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
1793 #: ../src/guestfs.pod:896
1796 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
1801 #: ../src/guestfs.pod:898
1803 "Note that libguestfs also calls qemu with the -help and -version options in "
1804 "order to determine features."
1808 #: ../src/guestfs.pod:901
1809 msgid "ABI GUARANTEE"
1813 #: ../src/guestfs.pod:903
1815 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
1816 "actions as outlined in this section. Although we will deprecate some "
1817 "actions, for example if they get replaced by newer calls, we will keep the "
1818 "old actions forever. This allows you the developer to program in confidence "
1819 "against the libguestfs API."
1823 #: ../src/guestfs.pod:909
1824 msgid "BLOCK DEVICE NAMING"
1828 #: ../src/guestfs.pod:911
1830 "In the kernel there is now quite a profusion of schemata for naming block "
1831 "devices (in this context, by I<block device> I mean a physical or virtual "
1832 "hard drive). The original Linux IDE driver used names starting with "
1833 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
1834 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
1835 "replacement for the old IDE driver (particularly for SATA devices) those "
1836 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
1837 "machines with paravirtualized drivers. This has created several different "
1838 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
1843 #: ../src/guestfs.pod:923
1845 "As discussed above, libguestfs uses a qemu appliance running an embedded "
1846 "Linux kernel to access block devices. We can run a variety of appliances "
1847 "based on a variety of Linux kernels."
1851 #: ../src/guestfs.pod:927
1853 "This causes a problem for libguestfs because many API calls use device or "
1854 "partition names. Working scripts and the recipe (example) scripts that we "
1855 "make available over the internet could fail if the naming scheme changes."
1859 #: ../src/guestfs.pod:932
1861 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
1862 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
1863 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
1864 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
1868 #: ../src/guestfs.pod:938
1870 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
1871 "L</guestfs_list_partitions> and similar calls return the true names of the "
1872 "devices and partitions as known to the appliance."
1876 #: ../src/guestfs.pod:943
1877 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
1881 #: ../src/guestfs.pod:945
1883 "Usually this translation is transparent. However in some (very rare) cases "
1884 "you may need to know the exact algorithm. Such cases include where you use "
1885 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
1886 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
1891 #: ../src/guestfs.pod:951
1893 "The algorithm is applied only to I<parameters> which are known to be either "
1894 "device or partition names. Return values from functions such as "
1895 "L</guestfs_list_devices> are never changed."
1899 #: ../src/guestfs.pod:959
1900 msgid "Is the string a parameter which is a device or partition name?"
1904 #: ../src/guestfs.pod:963
1905 msgid "Does the string begin with C</dev/sd>?"
1909 #: ../src/guestfs.pod:967
1911 "Does the named device exist? If so, we use that device. However if I<not> "
1912 "then we continue with this algorithm."
1916 #: ../src/guestfs.pod:972
1917 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
1921 #: ../src/guestfs.pod:974
1922 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
1926 #: ../src/guestfs.pod:976
1927 msgid "If that named device exists, use it. If not, continue."
1931 #: ../src/guestfs.pod:980
1932 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
1936 #: ../src/guestfs.pod:982
1937 msgid "If that named device exists, use it. If not, return an error."
1941 #: ../src/guestfs.pod:986
1942 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
1946 #: ../src/guestfs.pod:988
1948 "Although the standard naming scheme and automatic translation is useful for "
1949 "simple programs and guestfish scripts, for larger programs it is best not to "
1950 "rely on this mechanism."
1954 #: ../src/guestfs.pod:992
1956 "Where possible for maximum future portability programs using libguestfs "
1957 "should use these future-proof techniques:"
1961 #: ../src/guestfs.pod:999
1963 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
1964 "device names, and then use those names directly."
1968 #: ../src/guestfs.pod:1002
1969 msgid "Since those device names exist by definition, they will never be translated."
1973 #: ../src/guestfs.pod:1007
1975 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
1976 "filesystem labels."
1980 #: ../src/guestfs.pod:1012
1985 #: ../src/guestfs.pod:1014
1987 "This section discusses security implications of using libguestfs, "
1988 "particularly with untrusted or malicious guests or disk images."
1992 #: ../src/guestfs.pod:1017
1993 msgid "GENERAL SECURITY CONSIDERATIONS"
1997 #: ../src/guestfs.pod:1019
1999 "Be careful with any files or data that you download from a guest (by "
2000 "\"download\" we mean not just the L</guestfs_download> command but any "
2001 "command that reads files, filenames, directories or anything else from a "
2002 "disk image). An attacker could manipulate the data to fool your program "
2003 "into doing the wrong thing. Consider cases such as:"
2007 #: ../src/guestfs.pod:1029
2008 msgid "the data (file etc) not being present"
2012 #: ../src/guestfs.pod:1033
2013 msgid "being present but empty"
2017 #: ../src/guestfs.pod:1037
2018 msgid "being much larger than normal"
2022 #: ../src/guestfs.pod:1041
2023 msgid "containing arbitrary 8 bit data"
2027 #: ../src/guestfs.pod:1045
2028 msgid "being in an unexpected character encoding"
2032 #: ../src/guestfs.pod:1049
2033 msgid "containing homoglyphs."
2037 #: ../src/guestfs.pod:1053
2038 msgid "SECURITY OF MOUNTING FILESYSTEMS"
2042 #: ../src/guestfs.pod:1055
2044 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
2045 "(VFS) module can sometimes be escalated into exploits by deliberately "
2046 "creating a malicious, malformed filesystem. These exploits are very severe "
2047 "for two reasons. Firstly there are very many filesystem drivers in the "
2048 "kernel, and many of them are infrequently used and not much developer "
2049 "attention has been paid to the code. Linux userspace helps potential "
2050 "crackers by detecting the filesystem type and automatically choosing the "
2051 "right VFS driver, even if that filesystem type is obscure or unexpected for "
2052 "the administrator. Secondly, a kernel-level exploit is like a local root "
2053 "exploit (worse in some ways), giving immediate and total access to the "
2054 "system right down to the hardware level."
2058 #: ../src/guestfs.pod:1068
2060 "That explains why you should never mount a filesystem from an untrusted "
2061 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
2062 "inside a qemu virtual machine, usually running as a non-root user. The "
2063 "attacker would need to write a filesystem which first exploited the kernel, "
2064 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
2065 "the libguestfs protocol, and finally to be as serious as the host kernel "
2066 "exploit it would need to escalate its privileges to root. This multi-step "
2067 "escalation, performed by a static piece of data, is thought to be extremely "
2068 "hard to do, although we never say 'never' about security issues."
2072 #: ../src/guestfs.pod:1079
2074 "In any case callers can reduce the attack surface by forcing the filesystem "
2075 "type when mounting (use L</guestfs_mount_vfs>)."
2079 #: ../src/guestfs.pod:1082
2080 msgid "PROTOCOL SECURITY"
2084 #: ../src/guestfs.pod:1084
2086 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
2087 "defined upper message size. However a program that uses libguestfs must "
2088 "also take care - for example you can write a program that downloads a binary "
2089 "from a disk image and executes it locally, and no amount of protocol "
2090 "security will save you from the consequences."
2094 #: ../src/guestfs.pod:1090
2095 msgid "INSPECTION SECURITY"
2099 #: ../src/guestfs.pod:1092
2101 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
2102 "directly from the guest, and these could contain any 8 bit data. Callers "
2103 "should be careful to escape these before printing them to a structured file "
2104 "(for example, use HTML escaping if creating a web page)."
2108 #: ../src/guestfs.pod:1098
2110 "Guest configuration may be altered in unusual ways by the administrator of "
2111 "the virtual machine, and may not reflect reality (particularly for untrusted "
2112 "or actively malicious guests). For example we parse the hostname from "
2113 "configuration files like C</etc/sysconfig/network> that we find in the "
2114 "guest, but the guest administrator can easily manipulate these files to "
2115 "provide the wrong hostname."
2119 #: ../src/guestfs.pod:1106
2121 "The inspection API parses guest configuration using two external libraries: "
2122 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
2123 "designed to be robust in the face of malicious data, although denial of "
2124 "service attacks are still possible, for example with oversized configuration "
2129 #: ../src/guestfs.pod:1112
2130 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
2134 #: ../src/guestfs.pod:1114
2136 "Be very cautious about running commands from the guest. By running a "
2137 "command in the guest, you are giving CPU time to a binary that you do not "
2138 "control, under the same user account as the library, albeit wrapped in qemu "
2139 "virtualization. More information and alternatives can be found in the "
2140 "section L</RUNNING COMMANDS>."
2144 #: ../src/guestfs.pod:1120
2145 msgid "CVE-2010-3851"
2149 #: ../src/guestfs.pod:1122
2150 msgid "https://bugzilla.redhat.com/642934"
2154 #: ../src/guestfs.pod:1124
2156 "This security bug concerns the automatic disk format detection that qemu "
2157 "does on disk images."
2161 #: ../src/guestfs.pod:1127
2163 "A raw disk image is just the raw bytes, there is no header. Other disk "
2164 "images like qcow2 contain a special header. Qemu deals with this by looking "
2165 "for one of the known headers, and if none is found then assuming the disk "
2166 "image must be raw."
2170 #: ../src/guestfs.pod:1132
2172 "This allows a guest which has been given a raw disk image to write some "
2173 "other header. At next boot (or when the disk image is accessed by "
2174 "libguestfs) qemu would do autodetection and think the disk image format was, "
2175 "say, qcow2 based on the header written by the guest."
2179 #: ../src/guestfs.pod:1137
2181 "This in itself would not be a problem, but qcow2 offers many features, one "
2182 "of which is to allow a disk image to refer to another image (called the "
2183 "\"backing disk\"). It does this by placing the path to the backing disk "
2184 "into the qcow2 header. This path is not validated and could point to any "
2185 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
2186 "\"holes\" in the qcow2 disk image, which of course is completely under the "
2187 "control of the attacker."
2191 #: ../src/guestfs.pod:1145
2192 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
2196 #: ../src/guestfs.pod:1152
2197 msgid "You have enabled the network or have opened the disk in write mode."
2201 #: ../src/guestfs.pod:1156
2203 "You are also running untrusted code from the guest (see L</RUNNING "
2208 #: ../src/guestfs.pod:1161
2210 "The way to avoid this is to specify the expected disk format when adding "
2211 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
2212 "should always do this if the disk is raw format, and it's a good idea for "
2217 #: ../src/guestfs.pod:1166
2219 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
2220 "format is fetched from libvirt and passed through."
2224 #: ../src/guestfs.pod:1169
2226 "For libguestfs tools, use the I<--format> command line parameter as "
2231 #: ../src/guestfs.pod:1172
2232 msgid "CONNECTION MANAGEMENT"
2236 #: ../src/guestfs.pod:1174
2241 #: ../src/guestfs.pod:1176
2243 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
2244 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
2245 "handle and release all resources used."
2249 #: ../src/guestfs.pod:1180
2251 "For information on using multiple handles and threads, see the section "
2252 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> below."
2256 #: ../src/guestfs.pod:1183
2257 msgid "guestfs_create"
2261 #: ../src/guestfs.pod:1185
2264 " guestfs_h *guestfs_create (void);\n"
2269 #: ../src/guestfs.pod:1187
2270 msgid "Create a connection handle."
2274 #: ../src/guestfs.pod:1189
2276 "You have to call L</guestfs_add_drive_opts> (or one of the equivalent calls) "
2277 "on the handle at least once."
2281 #: ../src/guestfs.pod:1192
2283 "This function returns a non-NULL pointer to a handle on success or NULL on "
2288 #: ../src/guestfs.pod:1195
2289 msgid "After configuring the handle, you have to call L</guestfs_launch>."
2293 #: ../src/guestfs.pod:1197
2295 "You may also want to configure error handling for the handle. See L</ERROR "
2296 "HANDLING> section below."
2300 #: ../src/guestfs.pod:1200
2301 msgid "guestfs_close"
2305 #: ../src/guestfs.pod:1202
2308 " void guestfs_close (guestfs_h *g);\n"
2313 #: ../src/guestfs.pod:1204
2314 msgid "This closes the connection handle and frees up all resources used."
2318 #: ../src/guestfs.pod:1206
2319 msgid "ERROR HANDLING"
2323 #: ../src/guestfs.pod:1208
2325 "API functions can return errors. For example, almost all functions that "
2326 "return C<int> will return C<-1> to indicate an error."
2330 #: ../src/guestfs.pod:1211
2332 "Additional information is available for errors: an error message string and "
2333 "optionally an error number (errno) if the thing that failed was a system "
2338 #: ../src/guestfs.pod:1215
2340 "You can get at the additional information about the last error on the handle "
2341 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
2342 "up an error handler with L</guestfs_set_error_handler>."
2346 #: ../src/guestfs.pod:1220
2348 "When the handle is created, a default error handler is installed which "
2349 "prints the error message string to C<stderr>. For small short-running "
2350 "command line programs it is sufficient to do:"
2354 #: ../src/guestfs.pod:1224
2357 " if (guestfs_launch (g) == -1)\n"
2358 " exit (EXIT_FAILURE);\n"
2363 #: ../src/guestfs.pod:1227
2365 "since the default error handler will ensure that an error message has been "
2366 "printed to C<stderr> before the program exits."
2370 #: ../src/guestfs.pod:1230
2372 "For other programs the caller will almost certainly want to install an "
2373 "alternate error handler or do error handling in-line like this:"
2377 #: ../src/guestfs.pod:1233
2380 " g = guestfs_create ();\n"
2385 #: ../src/guestfs.pod:1235
2388 " /* This disables the default behaviour of printing errors\n"
2390 " guestfs_set_error_handler (g, NULL, NULL);\n"
2395 #: ../src/guestfs.pod:1239
2398 " if (guestfs_launch (g) == -1) {\n"
2399 " /* Examine the error message and print it etc. */\n"
2400 " char *msg = guestfs_last_error (g);\n"
2401 " int errnum = guestfs_last_errno (g);\n"
2402 " fprintf (stderr, \"%s\\n\", msg);\n"
2409 #: ../src/guestfs.pod:1247
2411 "Out of memory errors are handled differently. The default action is to call "
2412 "L<abort(3)>. If this is undesirable, then you can set a handler using "
2413 "L</guestfs_set_out_of_memory_handler>."
2417 #: ../src/guestfs.pod:1251
2419 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
2420 "because there is no handle if this happens there is no way to get additional "
2421 "error information. However L</guestfs_create> is supposed to be a "
2422 "lightweight operation which can only fail because of insufficient memory (it "
2423 "returns NULL in this case)."
2427 #: ../src/guestfs.pod:1257
2428 msgid "guestfs_last_error"
2432 #: ../src/guestfs.pod:1259
2435 " const char *guestfs_last_error (guestfs_h *g);\n"
2440 #: ../src/guestfs.pod:1261
2442 "This returns the last error message that happened on C<g>. If there has not "
2443 "been an error since the handle was created, then this returns C<NULL>."
2447 #: ../src/guestfs.pod:1265
2449 "The lifetime of the returned string is until the next error occurs, or "
2450 "L</guestfs_close> is called."
2454 #: ../src/guestfs.pod:1268
2455 msgid "guestfs_last_errno"
2459 #: ../src/guestfs.pod:1270
2462 " int guestfs_last_errno (guestfs_h *g);\n"
2467 #: ../src/guestfs.pod:1272
2468 msgid "This returns the last error number (errno) that happened on C<g>."
2472 #: ../src/guestfs.pod:1274
2473 msgid "If successful, an errno integer not equal to zero is returned."
2477 #: ../src/guestfs.pod:1276
2478 msgid "If no error, this returns 0. This call can return 0 in three situations:"
2482 #: ../src/guestfs.pod:1283
2483 msgid "There has not been any error on the handle."
2487 #: ../src/guestfs.pod:1287
2489 "There has been an error but the errno was meaningless. This corresponds to "
2490 "the case where the error did not come from a failed system call, but for "
2491 "some other reason."
2495 #: ../src/guestfs.pod:1293
2497 "There was an error from a failed system call, but for some reason the errno "
2498 "was not captured and returned. This usually indicates a bug in libguestfs."
2502 #: ../src/guestfs.pod:1299
2504 "Libguestfs tries to convert the errno from inside the applicance into a "
2505 "corresponding errno for the caller (not entirely trivial: the appliance "
2506 "might be running a completely different operating system from the library "
2507 "and error numbers are not standardized across Un*xen). If this could not be "
2508 "done, then the error is translated to C<EINVAL>. In practice this should "
2509 "only happen in very rare circumstances."
2513 #: ../src/guestfs.pod:1307
2514 msgid "guestfs_set_error_handler"
2518 #: ../src/guestfs.pod:1309
2521 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
2523 " const char *msg);\n"
2524 " void guestfs_set_error_handler (guestfs_h *g,\n"
2525 " guestfs_error_handler_cb cb,\n"
2531 #: ../src/guestfs.pod:1316
2533 "The callback C<cb> will be called if there is an error. The parameters "
2534 "passed to the callback are an opaque data pointer and the error message "
2539 #: ../src/guestfs.pod:1320
2541 "C<errno> is not passed to the callback. To get that the callback must call "
2542 "L</guestfs_last_errno>."
2546 #: ../src/guestfs.pod:1323
2548 "Note that the message string C<msg> is freed as soon as the callback "
2549 "function returns, so if you want to stash it somewhere you must make your "
2554 #: ../src/guestfs.pod:1327
2555 msgid "The default handler prints messages on C<stderr>."
2559 #: ../src/guestfs.pod:1329
2560 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
2564 #: ../src/guestfs.pod:1331
2565 msgid "guestfs_get_error_handler"
2569 #: ../src/guestfs.pod:1333
2572 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
2573 " void **opaque_rtn);\n"
2578 #: ../src/guestfs.pod:1336
2579 msgid "Returns the current error handler callback."
2583 #: ../src/guestfs.pod:1338
2584 msgid "guestfs_set_out_of_memory_handler"
2588 #: ../src/guestfs.pod:1340
2591 " typedef void (*guestfs_abort_cb) (void);\n"
2592 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
2593 " guestfs_abort_cb);\n"
2598 #: ../src/guestfs.pod:1344
2600 "The callback C<cb> will be called if there is an out of memory situation. "
2601 "I<Note this callback must not return>."
2605 #: ../src/guestfs.pod:1347
2606 msgid "The default is to call L<abort(3)>."
2610 #: ../src/guestfs.pod:1349
2611 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
2615 #: ../src/guestfs.pod:1352
2616 msgid "guestfs_get_out_of_memory_handler"
2620 #: ../src/guestfs.pod:1354
2623 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
2628 #: ../src/guestfs.pod:1356
2629 msgid "This returns the current out of memory handler."
2633 #: ../src/guestfs.pod:1358
2638 #: ../src/guestfs.pod:1360 ../fish/guestfish.pod:907
2643 #: ../src/guestfs.pod:1362
2648 #: ../src/guestfs.pod:1364
2653 #: ../src/guestfs.pod:1366
2654 msgid "AVAILABILITY"
2658 #: ../src/guestfs.pod:1368
2659 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
2663 #: ../src/guestfs.pod:1370
2665 "Using L</guestfs_available> you can test availability of the following "
2666 "groups of functions. This test queries the appliance to see if the "
2667 "appliance you are currently using supports the functionality."
2671 #: ../src/guestfs.pod:1375
2672 msgid "@AVAILABILITY@"
2676 #: ../src/guestfs.pod:1377
2677 msgid "GUESTFISH supported COMMAND"
2681 #: ../src/guestfs.pod:1379
2683 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
2684 "prints out the available groups and whether they are supported by this build "
2685 "of libguestfs. Note however that you have to do C<run> first."
2689 #: ../src/guestfs.pod:1384
2690 msgid "SINGLE CALLS AT COMPILE TIME"
2694 #: ../src/guestfs.pod:1386
2696 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
2697 "function, such as:"
2701 #: ../src/guestfs.pod:1389
2704 " #define LIBGUESTFS_HAVE_DD 1\n"
2709 #: ../src/guestfs.pod:1391
2710 msgid "if L</guestfs_dd> is available."
2714 #: ../src/guestfs.pod:1393
2716 "Before version 1.5.8, if you needed to test whether a single libguestfs "
2717 "function is available at compile time, we recommended using build tools such "
2718 "as autoconf or cmake. For example in autotools you could use:"
2722 #: ../src/guestfs.pod:1398
2725 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
2726 " AC_CHECK_FUNCS([guestfs_dd])\n"
2731 #: ../src/guestfs.pod:1401
2733 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
2738 #: ../src/guestfs.pod:1404
2739 msgid "SINGLE CALLS AT RUN TIME"
2743 #: ../src/guestfs.pod:1406
2745 "Testing at compile time doesn't guarantee that a function really exists in "
2746 "the library. The reason is that you might be dynamically linked against a "
2747 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
2748 "This situation unfortunately results in a segmentation fault, which is a "
2749 "shortcoming of the C dynamic linking system itself."
2753 #: ../src/guestfs.pod:1413
2755 "You can use L<dlopen(3)> to test if a function is available at run time, as "
2756 "in this example program (note that you still need the compile time check as "
2761 #: ../src/guestfs.pod:1417
2764 " #include <stdio.h>\n"
2765 " #include <stdlib.h>\n"
2766 " #include <unistd.h>\n"
2767 " #include <dlfcn.h>\n"
2768 " #include <guestfs.h>\n"
2773 #: ../src/guestfs.pod:1423
2778 " #ifdef LIBGUESTFS_HAVE_DD\n"
2780 " int has_function;\n"
2785 #: ../src/guestfs.pod:1429
2788 " /* Test if the function guestfs_dd is really available. */\n"
2789 " dl = dlopen (NULL, RTLD_LAZY);\n"
2791 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
2792 " exit (EXIT_FAILURE);\n"
2794 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
2800 #: ../src/guestfs.pod:1438
2803 " if (!has_function)\n"
2804 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
2806 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
2807 " /* Now it's safe to call\n"
2808 " guestfs_dd (g, \"foo\", \"bar\");\n"
2812 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
2819 #: ../src/guestfs.pod:1451
2821 "You may think the above is an awful lot of hassle, and it is. There are "
2822 "other ways outside of the C linking system to ensure that this kind of "
2823 "incompatibility never arises, such as using package versioning:"
2827 #: ../src/guestfs.pod:1456
2830 " Requires: libguestfs >= 1.0.80\n"
2835 #: ../src/guestfs.pod:1458
2836 msgid "CALLS WITH OPTIONAL ARGUMENTS"
2840 #: ../src/guestfs.pod:1460
2842 "A recent feature of the API is the introduction of calls which take optional "
2843 "arguments. In C these are declared 3 ways. The main way is as a call which "
2844 "takes variable arguments (ie. C<...>), as in this example:"
2848 #: ../src/guestfs.pod:1465
2851 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
2856 #: ../src/guestfs.pod:1467
2858 "Call this with a list of optional arguments, terminated by C<-1>. So to "
2859 "call with no optional arguments specified:"
2863 #: ../src/guestfs.pod:1470
2866 " guestfs_add_drive_opts (g, filename, -1);\n"
2871 #: ../src/guestfs.pod:1472
2872 msgid "With a single optional argument:"
2876 #: ../src/guestfs.pod:1474
2879 " guestfs_add_drive_opts (g, filename,\n"
2880 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2886 #: ../src/guestfs.pod:1478
2891 #: ../src/guestfs.pod:1480
2894 " guestfs_add_drive_opts (g, filename,\n"
2895 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
2896 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
2902 #: ../src/guestfs.pod:1485
2904 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
2909 #: ../src/guestfs.pod:1488
2910 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
2914 #: ../src/guestfs.pod:1490
2916 "The second variant has the same name with the suffix C<_va>, which works the "
2917 "same way but takes a C<va_list>. See the C manual for details. For the "
2918 "example function, this is declared:"
2922 #: ../src/guestfs.pod:1494
2925 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
2931 #: ../src/guestfs.pod:1497
2932 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
2936 #: ../src/guestfs.pod:1499
2938 "The third variant is useful where you need to construct these calls. You "
2939 "pass in a structure where you fill in the optional fields. The structure "
2940 "has a bitmask as the first element which you must set to indicate which "
2941 "fields you have filled in. For our example function the structure and call "
2946 #: ../src/guestfs.pod:1505
2949 " struct guestfs_add_drive_opts_argv {\n"
2950 " uint64_t bitmask;\n"
2952 " const char *format;\n"
2955 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
2956 " const struct guestfs_add_drive_opts_argv *optargs);\n"
2961 #: ../src/guestfs.pod:1514
2962 msgid "You could call it like this:"
2966 #: ../src/guestfs.pod:1516
2969 " struct guestfs_add_drive_opts_argv optargs = {\n"
2970 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
2971 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
2973 " .format = \"qcow2\"\n"
2979 #: ../src/guestfs.pod:1523
2982 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
2987 #: ../src/guestfs.pod:1525 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1842 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1255
2992 #: ../src/guestfs.pod:1531
2993 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
2997 #: ../src/guestfs.pod:1536
2998 msgid "You do not need to fill in all fields of the structure."
3002 #: ../src/guestfs.pod:1540
3004 "There must be a one-to-one correspondence between fields of the structure "
3005 "that are filled in, and bits set in the bitmask."
3009 #: ../src/guestfs.pod:1545
3010 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
3014 #: ../src/guestfs.pod:1547
3016 "In other languages, optional arguments are expressed in the way that is "
3017 "natural for that language. We refer you to the language-specific "
3018 "documentation for more details on that."
3022 #: ../src/guestfs.pod:1551
3023 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
3027 #: ../src/guestfs.pod:1553
3028 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
3032 #: ../src/guestfs.pod:1555
3034 "The child process generates events in some situations. Current events "
3035 "include: receiving a log message, the child process exits."
3039 #: ../src/guestfs.pod:1558
3041 "Use the C<guestfs_set_*_callback> functions to set a callback for different "
3046 #: ../src/guestfs.pod:1561
3048 "Only I<one callback of each type> can be registered for each handle. "
3049 "Calling C<guestfs_set_*_callback> again overwrites the previous callback of "
3050 "that type. Cancel all callbacks of this type by calling this function with "
3051 "C<cb> set to C<NULL>."
3055 #: ../src/guestfs.pod:1566
3056 msgid "guestfs_set_log_message_callback"
3060 #: ../src/guestfs.pod:1568
3063 " typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque,\n"
3064 " char *buf, int len);\n"
3065 " void guestfs_set_log_message_callback (guestfs_h *g,\n"
3066 " guestfs_log_message_cb cb,\n"
3072 #: ../src/guestfs.pod:1574
3074 "The callback function C<cb> will be called whenever qemu or the guest writes "
3075 "anything to the console."
3079 #: ../src/guestfs.pod:1577
3080 msgid "Use this function to capture kernel messages and similar."
3084 #: ../src/guestfs.pod:1579
3086 "Normally there is no log message handler, and log messages are just "
3091 #: ../src/guestfs.pod:1582
3092 msgid "guestfs_set_subprocess_quit_callback"
3096 #: ../src/guestfs.pod:1584
3099 " typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);\n"
3100 " void guestfs_set_subprocess_quit_callback (guestfs_h *g,\n"
3101 " guestfs_subprocess_quit_cb cb,\n"
3107 #: ../src/guestfs.pod:1589
3109 "The callback function C<cb> will be called when the child process quits, "
3110 "either asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
3111 "corresponds to a transition from any state to the CONFIG state)."
3115 #: ../src/guestfs.pod:1594
3116 msgid "guestfs_set_launch_done_callback"
3120 #: ../src/guestfs.pod:1596
3123 " typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);\n"
3124 " void guestfs_set_launch_done_callback (guestfs_h *g,\n"
3125 " guestfs_launch_done_cb cb,\n"
3131 #: ../src/guestfs.pod:1601
3133 "The callback function C<cb> will be called when the child process becomes "
3134 "ready first time after it has been launched. (This corresponds to a "
3135 "transition from LAUNCHING to the READY state)."
3139 #: ../src/guestfs.pod:1605
3140 msgid "guestfs_set_close_callback"
3144 #: ../src/guestfs.pod:1607
3147 " typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);\n"
3148 " void guestfs_set_close_callback (guestfs_h *g,\n"
3149 " guestfs_close_cb cb,\n"
3155 #: ../src/guestfs.pod:1612
3157 "The callback function C<cb> will be called while the handle is being closed "
3158 "(synchronously from L</guestfs_close>)."
3162 #: ../src/guestfs.pod:1615
3164 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
3165 "handles that are open when the program exits. This means that this callback "
3166 "might be called indirectly from L<exit(3)>, which can cause unexpected "
3167 "problems in higher-level languages (eg. if your HLL interpreter has already "
3168 "been cleaned up by the time this is called, and if your callback then jumps "
3169 "into some HLL function)."
3173 #: ../src/guestfs.pod:1623
3174 msgid "guestfs_set_progress_callback"
3178 #: ../src/guestfs.pod:1625
3181 " typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque,\n"
3182 " int proc_nr, int serial,\n"
3183 " uint64_t position, uint64_t total);\n"
3184 " void guestfs_set_progress_callback (guestfs_h *g,\n"
3185 " guestfs_progress_cb cb,\n"
3191 #: ../src/guestfs.pod:1632
3193 "Some long-running operations can generate progress messages. If this "
3194 "callback is registered, then it will be called each time a progress message "
3195 "is generated (usually two seconds after the operation started, and three "
3196 "times per second thereafter until it completes, although the frequency may "
3197 "change in future versions)."
3201 #: ../src/guestfs.pod:1638
3203 "The callback receives two numbers: C<position> and C<total>. The units of "
3204 "C<total> are not defined, although for some operations C<total> may relate "
3205 "in some way to the amount of data to be transferred (eg. in bytes or "
3206 "megabytes), and C<position> may be the portion which has been transferred."
3210 #: ../src/guestfs.pod:1644
3211 msgid "The only defined and stable parts of the API are:"
3215 #: ../src/guestfs.pod:1650
3217 "The callback can display to the user some type of progress bar or indicator "
3218 "which shows the ratio of C<position>:C<total>."
3222 #: ../src/guestfs.pod:1655
3223 msgid "0 E<lt>= C<position> E<lt>= C<total>"
3227 #: ../src/guestfs.pod:1659
3229 "If any progress notification is sent during a call, then a final progress "
3230 "notification is always sent when C<position> = C<total>."
3234 #: ../src/guestfs.pod:1662
3236 "This is to simplify caller code, so callers can easily set the progress "
3237 "indicator to \"100%\" at the end of the operation, without requiring special "
3238 "code to detect this case."
3242 #: ../src/guestfs.pod:1668
3244 "The callback also receives the procedure number and serial number of the "
3245 "call. These are only useful for debugging protocol issues, and the callback "
3246 "can normally ignore them. The callback may want to print these numbers in "
3247 "error messages or debugging messages."
3251 #: ../src/guestfs.pod:1673
3252 msgid "PRIVATE DATA AREA"
3256 #: ../src/guestfs.pod:1675
3258 "You can attach named pieces of private data to the libguestfs handle, and "
3259 "fetch them by name for the lifetime of the handle. This is called the "
3260 "private data area and is only available from the C API."
3264 #: ../src/guestfs.pod:1679
3265 msgid "To attach a named piece of data, use the following call:"
3269 #: ../src/guestfs.pod:1681
3272 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
3277 #: ../src/guestfs.pod:1683
3279 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
3280 "pointer (which can be C<NULL>). Any previous item with the same name is "
3285 #: ../src/guestfs.pod:1687
3287 "You can use any C<key> you want, but names beginning with an underscore "
3288 "character are reserved for internal libguestfs purposes (for implementing "
3289 "language bindings). It is recommended to prefix the name with some unique "
3290 "string to avoid collisions with other users."
3294 #: ../src/guestfs.pod:1692
3295 msgid "To retrieve the pointer, use:"
3299 #: ../src/guestfs.pod:1694
3302 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
3307 #: ../src/guestfs.pod:1696
3309 "This function returns C<NULL> if either no data is found associated with "
3310 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
3315 #: ../src/guestfs.pod:1700
3317 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
3318 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
3319 "all. In particular, libguestfs does I<not> try to free the data when the "
3320 "handle is closed. If the data must be freed, then the caller must either "
3321 "free it before calling L</guestfs_close> or must set up a close callback to "
3322 "do it (see L</guestfs_set_close_callback>, and note that only one callback "
3323 "can be registered for a handle)."
3327 #: ../src/guestfs.pod:1708
3329 "The private data area is implemented using a hash table, and should be "
3330 "reasonably efficient for moderate numbers of keys."
3334 #: ../src/guestfs.pod:1711 ../src/guestfs.pod:1716
3339 #: ../src/guestfs.pod:1713
3341 "<!-- old anchor for the next section --> <a "
3342 "name=\"state_machine_and_low_level_event_api\"/>"
3346 #: ../src/guestfs.pod:1718
3347 msgid "ARCHITECTURE"
3351 #: ../src/guestfs.pod:1720
3353 "Internally, libguestfs is implemented by running an appliance (a special "
3354 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
3355 "process of the main program."
3359 #: ../src/guestfs.pod:1724
3362 " ___________________\n"
3364 " | main program |\n"
3366 " | | child process / appliance\n"
3367 " | | __________________________\n"
3369 " +-------------------+ RPC | +-----------------+ |\n"
3370 " | libguestfs <--------------------> guestfsd | |\n"
3371 " | | | +-----------------+ |\n"
3372 " \\___________________/ | | Linux kernel | |\n"
3373 " | +--^--------------+ |\n"
3374 " \\_________|________________/\n"
3380 " \\______________/\n"
3385 #: ../src/guestfs.pod:1744
3387 "The library, linked to the main program, creates the child process and hence "
3388 "the appliance in the L</guestfs_launch> function."
3392 #: ../src/guestfs.pod:1747
3394 "Inside the appliance is a Linux kernel and a complete stack of userspace "
3395 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
3396 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
3397 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
3398 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
3399 "attached to the qemu process which translates device access by the "
3400 "appliance's Linux kernel into accesses to the image."
3404 #: ../src/guestfs.pod:1756
3406 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
3407 "Although the disk image you are attached to might also be used by some "
3408 "virtual machine, libguestfs doesn't know or care about this. (But you will "
3409 "care if both libguestfs's qemu process and your virtual machine are trying "
3410 "to update the disk image at the same time, since these usually results in "
3411 "massive disk corruption)."
3415 #: ../src/guestfs.pod:1763
3416 msgid "STATE MACHINE"
3420 #: ../src/guestfs.pod:1765
3421 msgid "libguestfs uses a state machine to model the child process:"
3425 #: ../src/guestfs.pod:1767
3437 " / | \\ \\ guestfs_launch\n"
3438 " / | _\\__V______\n"
3440 " / | | LAUNCHING |\n"
3441 " / | \\___________/\n"
3443 " / | guestfs_launch\n"
3445 " ______ / __|____V\n"
3446 " / \\ ------> / \\\n"
3447 " | BUSY | | READY |\n"
3448 " \\______/ <------ \\________/\n"
3453 #: ../src/guestfs.pod:1789
3455 "The normal transitions are (1) CONFIG (when the handle is created, but there "
3456 "is no child process), (2) LAUNCHING (when the child process is booting up), "
3457 "(3) alternating between READY and BUSY as commands are issued to, and "
3458 "carried out by, the child process."
3462 #: ../src/guestfs.pod:1794
3464 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
3465 "asynchronously at any time (eg. due to some internal error), and that causes "
3466 "the state to transition back to CONFIG."
3470 #: ../src/guestfs.pod:1798
3472 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
3473 "issued when in the CONFIG state."
3477 #: ../src/guestfs.pod:1801
3479 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
3480 "L</guestfs_launch> blocks until the child process is READY to accept "
3481 "commands (or until some failure or timeout). L</guestfs_launch> internally "
3482 "moves the state from CONFIG to LAUNCHING while it is running."
3486 #: ../src/guestfs.pod:1807
3488 "API actions such as L</guestfs_mount> can only be issued when in the READY "
3489 "state. These API calls block waiting for the command to be carried out "
3490 "(ie. the state to transition to BUSY and then back to READY). There are no "
3491 "non-blocking versions, and no way to issue more than one command per handle "
3496 #: ../src/guestfs.pod:1813
3498 "Finally, the child process sends asynchronous messages back to the main "
3499 "program, such as kernel log messages. You can register a callback to "
3500 "receive these messages."
3504 #: ../src/guestfs.pod:1817
3509 #: ../src/guestfs.pod:1819
3510 msgid "COMMUNICATION PROTOCOL"
3514 #: ../src/guestfs.pod:1821
3516 "Don't rely on using this protocol directly. This section documents how it "
3517 "currently works, but it may change at any time."
3521 #: ../src/guestfs.pod:1824
3523 "The protocol used to talk between the library and the daemon running inside "
3524 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
3525 "1014, RFC 1832, RFC 4506)."
3529 #: ../src/guestfs.pod:1828
3531 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
3532 "this file is automatically generated)."
3536 #: ../src/guestfs.pod:1831
3538 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
3539 "and C<FileOut> parameters, which are handled with very simple request/reply "
3540 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
3541 "parameters, which use the same request and reply messages, but they may also "
3542 "be followed by files sent using a chunked encoding."
3546 #: ../src/guestfs.pod:1838
3547 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
3551 #: ../src/guestfs.pod:1840
3552 msgid "For ordinary functions, the request message is:"
3556 #: ../src/guestfs.pod:1842
3559 " total length (header + arguments,\n"
3560 " but not including the length word itself)\n"
3561 " struct guestfs_message_header (encoded as XDR)\n"
3562 " struct guestfs_<foo>_args (encoded as XDR)\n"
3567 #: ../src/guestfs.pod:1847
3569 "The total length field allows the daemon to allocate a fixed size buffer "
3570 "into which it slurps the rest of the message. As a result, the total length "
3571 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
3572 "effective size of any request is limited to somewhere under this size."
3576 #: ../src/guestfs.pod:1853
3578 "Note also that many functions don't take any arguments, in which case the "
3579 "C<guestfs_I<foo>_args> is completely omitted."
3583 #: ../src/guestfs.pod:1856
3585 "The header contains the procedure number (C<guestfs_proc>) which is how the "
3586 "receiver knows what type of args structure to expect, or none at all."
3590 #: ../src/guestfs.pod:1860
3591 msgid "The reply message for ordinary functions is:"
3595 #: ../src/guestfs.pod:1862
3598 " total length (header + ret,\n"
3599 " but not including the length word itself)\n"
3600 " struct guestfs_message_header (encoded as XDR)\n"
3601 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3606 #: ../src/guestfs.pod:1867
3608 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
3609 "functions that return no formal return values."
3613 #: ../src/guestfs.pod:1870
3614 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
3618 #: ../src/guestfs.pod:1873
3620 "In the case of an error, a flag is set in the header, and the reply message "
3621 "is slightly changed:"
3625 #: ../src/guestfs.pod:1876
3628 " total length (header + error,\n"
3629 " but not including the length word itself)\n"
3630 " struct guestfs_message_header (encoded as XDR)\n"
3631 " struct guestfs_message_error (encoded as XDR)\n"
3636 #: ../src/guestfs.pod:1881
3638 "The C<guestfs_message_error> structure contains the error message as a "
3643 #: ../src/guestfs.pod:1884
3644 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
3648 #: ../src/guestfs.pod:1886
3650 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
3651 "The normal request message is sent (see above). However this is followed by "
3652 "a sequence of file chunks."
3656 #: ../src/guestfs.pod:1890
3659 " total length (header + arguments,\n"
3660 " but not including the length word itself,\n"
3661 " and not including the chunks)\n"
3662 " struct guestfs_message_header (encoded as XDR)\n"
3663 " struct guestfs_<foo>_args (encoded as XDR)\n"
3664 " sequence of chunks for FileIn param #0\n"
3665 " sequence of chunks for FileIn param #1 etc.\n"
3670 #: ../src/guestfs.pod:1898
3671 msgid "The \"sequence of chunks\" is:"
3675 #: ../src/guestfs.pod:1900
3678 " length of chunk (not including length word itself)\n"
3679 " struct guestfs_chunk (encoded as XDR)\n"
3680 " length of chunk\n"
3681 " struct guestfs_chunk (encoded as XDR)\n"
3683 " length of chunk\n"
3684 " struct guestfs_chunk (with data.data_len == 0)\n"
3689 #: ../src/guestfs.pod:1908
3691 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
3692 "is set in the final chunk to indicate either successful completion or early "
3697 #: ../src/guestfs.pod:1912
3699 "At time of writing there are no functions that have more than one FileIn "
3700 "parameter. However this is (theoretically) supported, by sending the "
3701 "sequence of chunks for each FileIn parameter one after another (from left to "
3706 #: ../src/guestfs.pod:1917
3708 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
3709 "transfer. The library does this by sending a chunk with a special flag set "
3710 "to indicate cancellation. When the daemon sees this, it cancels the whole "
3711 "RPC, does I<not> send any reply, and goes back to reading the next request."
3715 #: ../src/guestfs.pod:1923
3717 "The daemon may also cancel. It does this by writing a special word "
3718 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
3719 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
3720 "cancel chunk). The special word is chosen so that even if cancellation "
3721 "happens right at the end of the transfer (after the library has finished "
3722 "writing and has started listening for the reply), the \"spurious\" cancel "
3723 "flag will not be confused with the reply message."
3727 #: ../src/guestfs.pod:1932
3729 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
3730 "limit), and also files where the size is not known in advance (eg. from "
3731 "pipes or sockets). However the chunks are rather small "
3732 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
3733 "to keep much in memory."
3737 #: ../src/guestfs.pod:1938
3738 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
3742 #: ../src/guestfs.pod:1940
3744 "The protocol for FileOut parameters is exactly the same as for FileIn "
3745 "parameters, but with the roles of daemon and library reversed."
3749 #: ../src/guestfs.pod:1943
3752 " total length (header + ret,\n"
3753 " but not including the length word itself,\n"
3754 " and not including the chunks)\n"
3755 " struct guestfs_message_header (encoded as XDR)\n"
3756 " struct guestfs_<foo>_ret (encoded as XDR)\n"
3757 " sequence of chunks for FileOut param #0\n"
3758 " sequence of chunks for FileOut param #1 etc.\n"
3763 #: ../src/guestfs.pod:1951
3764 msgid "INITIAL MESSAGE"
3768 #: ../src/guestfs.pod:1953
3770 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
3771 "which indicates that the guest and daemon is alive. This is what "
3772 "L</guestfs_launch> waits for."
3776 #: ../src/guestfs.pod:1957
3777 msgid "PROGRESS NOTIFICATION MESSAGES"
3781 #: ../src/guestfs.pod:1959
3783 "The daemon may send progress notification messages at any time. These are "
3784 "distinguished by the normal length word being replaced by "
3785 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
3789 #: ../src/guestfs.pod:1963
3791 "The library turns them into progress callbacks (see "
3792 "C<guestfs_set_progress_callback>) if there is a callback registered, or "
3793 "discards them if not."
3797 #: ../src/guestfs.pod:1967
3799 "The daemon self-limits the frequency of progress messages it sends (see "
3800 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
3805 #: ../src/guestfs.pod:1971
3806 msgid "LIBGUESTFS VERSION NUMBERS"
3810 #: ../src/guestfs.pod:1973
3812 "Since April 2010, libguestfs has started to make separate development and "
3813 "stable releases, along with corresponding branches in our git repository. "
3814 "These separate releases can be identified by version number:"
3818 #: ../src/guestfs.pod:1978
3821 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
3822 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
3828 " | `-------- sub-version\n"
3830 " `------ always '1' because we don't change the ABI\n"
3835 #: ../src/guestfs.pod:1989
3836 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
3840 #: ../src/guestfs.pod:1991
3842 "As time passes we cherry pick fixes from the development branch and backport "
3843 "those into the stable branch, the effect being that the stable branch should "
3844 "get more stable and less buggy over time. So the stable releases are ideal "
3845 "for people who don't need new features but would just like the software to "
3850 #: ../src/guestfs.pod:1997
3851 msgid "Our criteria for backporting changes are:"
3855 #: ../src/guestfs.pod:2003
3857 "Documentation changes which don't affect any code are backported unless the "
3858 "documentation refers to a future feature which is not in stable."
3862 #: ../src/guestfs.pod:2009
3864 "Bug fixes which are not controversial, fix obvious problems, and have been "
3865 "well tested are backported."
3869 #: ../src/guestfs.pod:2014
3871 "Simple rearrangements of code which shouldn't affect how it works get "
3872 "backported. This is so that the code in the two branches doesn't get too "
3873 "far out of step, allowing us to backport future fixes more easily."
3877 #: ../src/guestfs.pod:2020
3879 "We I<don't> backport new features, new APIs, new tools etc, except in one "
3880 "exceptional case: the new feature is required in order to implement an "
3881 "important bug fix."
3885 #: ../src/guestfs.pod:2026
3887 "A new stable branch starts when we think the new features in development are "
3888 "substantial and compelling enough over the current stable branch to warrant "
3889 "it. When that happens we create new stable and development versions 1.N.0 "
3890 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
3891 "stable at this point, but by backporting fixes from development, that branch "
3892 "will stabilize over time."
3896 #: ../src/guestfs.pod:2034 ../fish/guestfish.pod:914 ../test-tool/libguestfs-test-tool.pod:104 ../tools/virt-edit.pl:330 ../tools/virt-rescue.pl:255
3897 msgid "ENVIRONMENT VARIABLES"
3901 #: ../src/guestfs.pod:2038 ../fish/guestfish.pod:940
3902 msgid "LIBGUESTFS_APPEND"
3906 #: ../src/guestfs.pod:2040 ../fish/guestfish.pod:942
3907 msgid "Pass additional options to the guest kernel."
3911 #: ../src/guestfs.pod:2042 ../fish/guestfish.pod:944
3912 msgid "LIBGUESTFS_DEBUG"
3916 #: ../src/guestfs.pod:2044
3918 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
3919 "effect as calling C<guestfs_set_verbose (g, 1)>."
3923 #: ../src/guestfs.pod:2047 ../fish/guestfish.pod:949
3924 msgid "LIBGUESTFS_MEMSIZE"
3928 #: ../src/guestfs.pod:2049 ../fish/guestfish.pod:951
3929 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
3933 #: ../src/guestfs.pod:2052 ../fish/guestfish.pod:954
3936 " LIBGUESTFS_MEMSIZE=700\n"
3941 #: ../src/guestfs.pod:2054 ../fish/guestfish.pod:956
3942 msgid "LIBGUESTFS_PATH"
3946 #: ../src/guestfs.pod:2056
3948 "Set the path that libguestfs uses to search for kernel and initrd.img. See "
3949 "the discussion of paths in section PATH above."
3953 #: ../src/guestfs.pod:2059 ../fish/guestfish.pod:961
3954 msgid "LIBGUESTFS_QEMU"
3958 #: ../src/guestfs.pod:2061 ../fish/guestfish.pod:963
3960 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
3961 "which was found at compile time by the configure script is used."
3965 #: ../src/guestfs.pod:2065
3966 msgid "See also L</QEMU WRAPPERS> above."
3970 #: ../src/guestfs.pod:2067 ../fish/guestfish.pod:967
3971 msgid "LIBGUESTFS_TRACE"
3975 #: ../src/guestfs.pod:2069
3977 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
3978 "effect as calling C<guestfs_set_trace (g, 1)>."
3982 #: ../src/guestfs.pod:2072 ../fish/guestfish.pod:976
3987 #: ../src/guestfs.pod:2074 ../fish/guestfish.pod:978
3988 msgid "Location of temporary directory, defaults to C</tmp>."
3992 #: ../src/guestfs.pod:2076 ../fish/guestfish.pod:980
3994 "If libguestfs was compiled to use the supermin appliance then the real "
3995 "appliance is cached in this directory, shared between all handles belonging "
3996 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
3997 "use in case C</tmp> is not large enough."
4001 #: ../src/guestfs.pod:2084 ../fish/guestfish.pod:1038 ../test-tool/libguestfs-test-tool.pod:109 ../fuse/guestmount.pod:233 ../inspector/virt-inspector.pl:452 ../tools/virt-edit.pl:350 ../tools/virt-win-reg.pl:484 ../tools/virt-df.pl:640 ../tools/virt-ls.pl:232 ../tools/virt-resize.pl:1486 ../tools/virt-list-filesystems.pl:186 ../tools/virt-tar.pl:281 ../tools/virt-rescue.pl:267 ../tools/virt-make-fs.pl:534 ../tools/virt-list-partitions.pl:254
4006 #: ../src/guestfs.pod:2086
4008 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
4009 "L<virt-edit(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
4010 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
4011 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-win-reg(1)>, L<qemu(1)>, "
4012 "L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
4016 #: ../src/guestfs.pod:2104
4018 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
4019 "L<lvm(8)>, L<disktype(1)>."
4023 #: ../src/guestfs.pod:2111 ../tools/virt-win-reg.pl:499 ../tools/virt-make-fs.pl:548
4028 #: ../src/guestfs.pod:2113
4029 msgid "To get a list of bugs against libguestfs use this link:"
4033 #: ../src/guestfs.pod:2115
4034 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
4038 #: ../src/guestfs.pod:2117
4039 msgid "To report a new bug against libguestfs use this link:"
4043 #: ../src/guestfs.pod:2119
4044 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
4048 #: ../src/guestfs.pod:2121
4049 msgid "When reporting a bug, please check:"
4053 #: ../src/guestfs.pod:2127
4054 msgid "That the bug hasn't been reported already."
4058 #: ../src/guestfs.pod:2131
4059 msgid "That you are testing a recent version."
4063 #: ../src/guestfs.pod:2135
4064 msgid "Describe the bug accurately, and give a way to reproduce it."
4068 #: ../src/guestfs.pod:2139
4070 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
4075 #: ../src/guestfs.pod:2144 ../fish/guestfish.pod:1055 ../test-tool/libguestfs-test-tool.pod:115 ../fuse/guestmount.pod:244 ../inspector/virt-inspector.pl:462
4080 #: ../src/guestfs.pod:2146 ../fish/guestfish.pod:1057 ../test-tool/libguestfs-test-tool.pod:117 ../fuse/guestmount.pod:246
4081 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4085 #: ../src/guestfs.pod:2148 ../fish/guestfish.pod:1059 ../test-tool/libguestfs-test-tool.pod:119 ../fuse/guestmount.pod:248 ../inspector/virt-inspector.pl:476 ../tools/virt-edit.pl:366 ../tools/virt-win-reg.pl:514 ../tools/virt-df.pl:653 ../tools/virt-ls.pl:247 ../tools/virt-resize.pl:1512 ../tools/virt-list-filesystems.pl:202 ../tools/virt-tar.pl:296 ../tools/virt-rescue.pl:281 ../tools/virt-make-fs.pl:563 ../tools/virt-list-partitions.pl:269
4090 #: ../src/guestfs.pod:2150 ../fish/guestfish.pod:1061 ../fuse/guestmount.pod:250
4091 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
4095 #: ../src/guestfs.pod:2153
4097 "This library is free software; you can redistribute it and/or modify it "
4098 "under the terms of the GNU Lesser General Public License as published by the "
4099 "Free Software Foundation; either version 2 of the License, or (at your "
4100 "option) any later version."
4104 #: ../src/guestfs.pod:2158
4106 "This library is distributed in the hope that it will be useful, but WITHOUT "
4107 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4108 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4113 #: ../src/guestfs.pod:2163
4115 "You should have received a copy of the GNU Lesser General Public License "
4116 "along with this library; if not, write to the Free Software Foundation, "
4117 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4121 #: ../src/guestfs-actions.pod:1
4122 msgid "guestfs_add_cdrom"
4126 #: ../src/guestfs-actions.pod:3
4130 " guestfs_add_cdrom (guestfs_h *g,\n"
4131 " const char *filename);\n"
4136 #: ../src/guestfs-actions.pod:7 ../fish/guestfish-actions.pod:5
4137 msgid "This function adds a virtual CD-ROM disk image to the guest."
4141 #: ../src/guestfs-actions.pod:9 ../fish/guestfish-actions.pod:7
4142 msgid "This is equivalent to the qemu parameter C<-cdrom filename>."
4146 #: ../src/guestfs-actions.pod:17
4148 "This call checks for the existence of C<filename>. This stops you from "
4149 "specifying other types of drive which are supported by qemu such as C<nbd:> "
4150 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
4155 #: ../src/guestfs-actions.pod:24
4157 "If you just want to add an ISO file (often you use this as an efficient way "
4158 "to transfer large files into the guest), then you should probably use "
4159 "C<guestfs_add_drive_ro> instead."
4163 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:126 ../src/guestfs-actions.pod:187 ../src/guestfs-actions.pod:224 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:279 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:408 ../src/guestfs-actions.pod:428 ../src/guestfs-actions.pod:442 ../src/guestfs-actions.pod:487 ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:533 ../src/guestfs-actions.pod:600 ../src/guestfs-actions.pod:633 ../src/guestfs-actions.pod:647 ../src/guestfs-actions.pod:662 ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:779 ../src/guestfs-actions.pod:793 ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:968 ../src/guestfs-actions.pod:988 ../src/guestfs-actions.pod:1006 ../src/guestfs-actions.pod:1090 ../src/guestfs-actions.pod:1108 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1141 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1262 ../src/guestfs-actions.pod:1287 ../src/guestfs-actions.pod:1324 ../src/guestfs-actions.pod:1430 ../src/guestfs-actions.pod:1464 ../src/guestfs-actions.pod:1682 ../src/guestfs-actions.pod:1704 ../src/guestfs-actions.pod:1791 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2357 ../src/guestfs-actions.pod:2418 ../src/guestfs-actions.pod:2453 ../src/guestfs-actions.pod:3182 ../src/guestfs-actions.pod:3197 ../src/guestfs-actions.pod:3217 ../src/guestfs-actions.pod:3342 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3369 ../src/guestfs-actions.pod:3383 ../src/guestfs-actions.pod:3398 ../src/guestfs-actions.pod:3434 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3526 ../src/guestfs-actions.pod:3543 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3589 ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3640 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:3706 ../src/guestfs-actions.pod:3742 ../src/guestfs-actions.pod:3758 ../src/guestfs-actions.pod:3771 ../src/guestfs-actions.pod:3786 ../src/guestfs-actions.pod:3803 ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3916 ../src/guestfs-actions.pod:3929 ../src/guestfs-actions.pod:3980 ../src/guestfs-actions.pod:3998 ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4032 ../src/guestfs-actions.pod:4046 ../src/guestfs-actions.pod:4060 ../src/guestfs-actions.pod:4077 ../src/guestfs-actions.pod:4092 ../src/guestfs-actions.pod:4112 ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4192 ../src/guestfs-actions.pod:4211 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4242 ../src/guestfs-actions.pod:4259 ../src/guestfs-actions.pod:4272 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4337 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4372 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4403 ../src/guestfs-actions.pod:4452 ../src/guestfs-actions.pod:4489 ../src/guestfs-actions.pod:4503 ../src/guestfs-actions.pod:4531 ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4566 ../src/guestfs-actions.pod:4700 ../src/guestfs-actions.pod:4757 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4829 ../src/guestfs-actions.pod:4895 ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:4925 ../src/guestfs-actions.pod:4939 ../src/guestfs-actions.pod:5228 ../src/guestfs-actions.pod:5247 ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5273 ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5299 ../src/guestfs-actions.pod:5313 ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5350 ../src/guestfs-actions.pod:5369 ../src/guestfs-actions.pod:5388 ../src/guestfs-actions.pod:5406 ../src/guestfs-actions.pod:5429 ../src/guestfs-actions.pod:5447 ../src/guestfs-actions.pod:5466 ../src/guestfs-actions.pod:5487 ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5523 ../src/guestfs-actions.pod:5551 ../src/guestfs-actions.pod:5575 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5618 ../src/guestfs-actions.pod:5633 ../src/guestfs-actions.pod:5648 ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5727 ../src/guestfs-actions.pod:5753 ../src/guestfs-actions.pod:5861 ../src/guestfs-actions.pod:5982 ../src/guestfs-actions.pod:5994 ../src/guestfs-actions.pod:6007 ../src/guestfs-actions.pod:6020 ../src/guestfs-actions.pod:6042 ../src/guestfs-actions.pod:6055 ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6096 ../src/guestfs-actions.pod:6155 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6188 ../src/guestfs-actions.pod:6204 ../src/guestfs-actions.pod:6221 ../src/guestfs-actions.pod:6234 ../src/guestfs-actions.pod:6254 ../src/guestfs-actions.pod:6290 ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6345 ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:6376 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6436 ../src/guestfs-actions.pod:6555 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6587 ../src/guestfs-actions.pod:6642 ../src/guestfs-actions.pod:6655 ../src/guestfs-actions.pod:6700 ../src/guestfs-actions.pod:6733 ../src/guestfs-actions.pod:6787 ../src/guestfs-actions.pod:6813 ../src/guestfs-actions.pod:6879 ../src/guestfs-actions.pod:6898 ../src/guestfs-actions.pod:6927
4164 msgid "This function returns 0 on success or -1 on error."
4168 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:240 ../src/guestfs-actions.pod:261 ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:153 ../fish/guestfish-actions.pod:167
4170 "This function is deprecated. In new code, use the C<add_drive_opts> call "
4175 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:243 ../src/guestfs-actions.pod:264 ../src/guestfs-actions.pod:1435 ../src/guestfs-actions.pod:1921 ../src/guestfs-actions.pod:1942 ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:6990 ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:156 ../fish/guestfish-actions.pod:170 ../fish/guestfish-actions.pod:951 ../fish/guestfish-actions.pod:1308 ../fish/guestfish-actions.pod:1322 ../fish/guestfish-actions.pod:4549 ../fish/guestfish-actions.pod:4646
4177 "Deprecated functions will not be removed from the API, but the fact that "
4178 "they are deprecated indicates that there are problems with correct use of "
4183 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:128 ../src/guestfs-actions.pod:1092 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:3184 ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:4339 ../src/guestfs-actions.pod:5408 ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5635 ../src/guestfs-actions.pod:6098 ../src/guestfs-actions.pod:6223 ../src/guestfs-actions.pod:6735
4184 msgid "(Added in 0.3)"
4188 #: ../src/guestfs-actions.pod:41
4189 msgid "guestfs_add_domain"
4193 #: ../src/guestfs-actions.pod:43
4197 " guestfs_add_domain (guestfs_h *g,\n"
4198 " const char *dom,\n"
4204 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:137
4206 "You may supply a list of optional arguments to this call. Use zero or more "
4207 "of the following pairs of parameters, and terminate the list with C<-1> on "
4208 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
4212 #: ../src/guestfs-actions.pod:53
4215 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
4216 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
4217 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
4222 #: ../src/guestfs-actions.pod:57
4224 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
4225 "It works by connecting to libvirt, requesting the domain and domain XML from "
4226 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
4231 #: ../src/guestfs-actions.pod:62 ../fish/guestfish-actions.pod:46
4233 "The number of disks added is returned. This operation is atomic: if an "
4234 "error is returned, then no disks are added."
4238 #: ../src/guestfs-actions.pod:65 ../fish/guestfish-actions.pod:49
4240 "This function does some minimal checks to make sure the libvirt domain is "
4241 "not running (unless C<readonly> is true). In a future version we will try "
4242 "to acquire the libvirt lock on each disk."
4246 #: ../src/guestfs-actions.pod:69 ../fish/guestfish-actions.pod:53
4248 "Disks must be accessible locally. This often means that adding disks from a "
4249 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
4250 "unless those disks are accessible via the same device path locally too."
4254 #: ../src/guestfs-actions.pod:74
4256 "The optional C<libvirturi> parameter sets the libvirt URI (see "
4257 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
4258 "default libvirt URI (or one set through an environment variable, see the "
4259 "libvirt documentation for full details). If you are using the C API "
4260 "directly then it is more flexible to create the libvirt connection object "
4261 "yourself, get the domain object, and call C<guestfs_add_libvirt_dom>."
4265 #: ../src/guestfs-actions.pod:82
4267 "The other optional parameters are passed directly through to "
4268 "C<guestfs_add_drive_opts>."
4272 #: ../src/guestfs-actions.pod:85 ../src/guestfs-actions.pod:336 ../src/guestfs-actions.pod:501 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:728 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:1307 ../src/guestfs-actions.pod:1661 ../src/guestfs-actions.pod:1864 ../src/guestfs-actions.pod:1963 ../src/guestfs-actions.pod:2003 ../src/guestfs-actions.pod:2058 ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:2344 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2651 ../src/guestfs-actions.pod:4475 ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:5009 ../src/guestfs-actions.pod:5035 ../src/guestfs-actions.pod:6331 ../src/guestfs-actions.pod:6746 ../src/guestfs-actions.pod:6759 ../src/guestfs-actions.pod:6772
4273 msgid "On error this function returns -1."
4277 #: ../src/guestfs-actions.pod:87
4278 msgid "guestfs_add_domain_va"
4282 #: ../src/guestfs-actions.pod:89
4286 " guestfs_add_domain_va (guestfs_h *g,\n"
4287 " const char *dom,\n"
4293 #: ../src/guestfs-actions.pod:94
4294 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
4298 #: ../src/guestfs-actions.pod:96 ../src/guestfs-actions.pod:107 ../src/guestfs-actions.pod:200 ../src/guestfs-actions.pod:211
4299 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
4303 #: ../src/guestfs-actions.pod:98
4304 msgid "guestfs_add_domain_argv"
4308 #: ../src/guestfs-actions.pod:100
4312 " guestfs_add_domain_argv (guestfs_h *g,\n"
4313 " const char *dom,\n"
4314 " const struct guestfs_add_domain_argv *optargs);\n"
4319 #: ../src/guestfs-actions.pod:105
4320 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
4324 #: ../src/guestfs-actions.pod:109
4325 msgid "guestfs_add_drive"
4329 #: ../src/guestfs-actions.pod:111
4333 " guestfs_add_drive (guestfs_h *g,\n"
4334 " const char *filename);\n"
4339 #: ../src/guestfs-actions.pod:115
4341 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
4342 "optional parameters, so the disk is added writable, with the format being "
4343 "detected automatically."
4347 #: ../src/guestfs-actions.pod:119
4349 "Automatic detection of the format opens you up to a potential security hole "
4350 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4351 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4352 "you should think about replacing calls to this function with calls to "
4353 "C<guestfs_add_drive_opts>, and specifying the format."
4357 #: ../src/guestfs-actions.pod:130
4358 msgid "guestfs_add_drive_opts"
4362 #: ../src/guestfs-actions.pod:132
4366 " guestfs_add_drive_opts (guestfs_h *g,\n"
4367 " const char *filename,\n"
4373 #: ../src/guestfs-actions.pod:142
4376 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
4377 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
4378 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
4383 #: ../src/guestfs-actions.pod:146 ../fish/guestfish-actions.pod:92
4385 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4386 "The first time you call this function, the disk appears as C</dev/sda>, the "
4387 "second time as C</dev/sdb>, and so on."
4391 #: ../src/guestfs-actions.pod:151 ../fish/guestfish-actions.pod:97
4393 "You don't necessarily need to be root when using libguestfs. However you "
4394 "obviously do need sufficient permissions to access the filename for whatever "
4395 "operations you want to perform (ie. read access if you just want to read the "
4396 "image or write access if you want to modify the image)."
4400 #: ../src/guestfs-actions.pod:157 ../fish/guestfish-actions.pod:103
4401 msgid "This call checks that C<filename> exists."
4405 #: ../src/guestfs-actions.pod:159 ../fish/guestfish-actions.pod:105
4406 msgid "The optional arguments are:"
4410 #: ../src/guestfs-actions.pod:163 ../fish/guestfish-actions.pod:109
4415 #: ../src/guestfs-actions.pod:165 ../fish/guestfish-actions.pod:111
4417 "If true then the image is treated as read-only. Writes are still allowed, "
4418 "but they are stored in a temporary snapshot overlay which is discarded at "
4419 "the end. The disk that you add is not modified."
4423 #: ../src/guestfs-actions.pod:169 ../fish/guestfish-actions.pod:115
4428 #: ../src/guestfs-actions.pod:171
4430 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
4431 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
4432 "Possible formats include C<raw> and C<qcow2>."
4436 #: ../src/guestfs-actions.pod:175 ../fish/guestfish-actions.pod:121
4438 "Automatic detection of the format opens you up to a potential security hole "
4439 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4440 "RHBZ#642934. Specifying the format closes this security hole."
4444 #: ../src/guestfs-actions.pod:180 ../fish/guestfish-actions.pod:126
4449 #: ../src/guestfs-actions.pod:182
4451 "This rarely-used option lets you emulate the behaviour of the deprecated "
4452 "C<guestfs_add_drive_with_if> call (q.v.)"
4456 #: ../src/guestfs-actions.pod:189
4457 msgid "(Added in 1.5.23)"
4461 #: ../src/guestfs-actions.pod:191
4462 msgid "guestfs_add_drive_opts_va"
4466 #: ../src/guestfs-actions.pod:193
4470 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
4471 " const char *filename,\n"
4477 #: ../src/guestfs-actions.pod:198
4478 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
4482 #: ../src/guestfs-actions.pod:202
4483 msgid "guestfs_add_drive_opts_argv"
4487 #: ../src/guestfs-actions.pod:204
4491 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
4492 " const char *filename,\n"
4493 " const struct guestfs_add_drive_opts_argv "
4499 #: ../src/guestfs-actions.pod:209
4500 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
4504 #: ../src/guestfs-actions.pod:213
4505 msgid "guestfs_add_drive_ro"
4509 #: ../src/guestfs-actions.pod:215
4513 " guestfs_add_drive_ro (guestfs_h *g,\n"
4514 " const char *filename);\n"
4519 #: ../src/guestfs-actions.pod:219
4521 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
4522 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
4523 "disk is added read-only, with the format being detected automatically."
4527 #: ../src/guestfs-actions.pod:226
4528 msgid "(Added in 1.0.38)"
4532 #: ../src/guestfs-actions.pod:228
4533 msgid "guestfs_add_drive_ro_with_if"
4537 #: ../src/guestfs-actions.pod:230
4541 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
4542 " const char *filename,\n"
4543 " const char *iface);\n"
4548 #: ../src/guestfs-actions.pod:235
4550 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
4551 "QEMU interface emulation to use at run time."
4555 #: ../src/guestfs-actions.pod:247 ../src/guestfs-actions.pod:268 ../src/guestfs-actions.pod:2303
4556 msgid "(Added in 1.0.84)"
4560 #: ../src/guestfs-actions.pod:249
4561 msgid "guestfs_add_drive_with_if"
4565 #: ../src/guestfs-actions.pod:251
4569 " guestfs_add_drive_with_if (guestfs_h *g,\n"
4570 " const char *filename,\n"
4571 " const char *iface);\n"
4576 #: ../src/guestfs-actions.pod:256
4578 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
4579 "QEMU interface emulation to use at run time."
4583 #: ../src/guestfs-actions.pod:270
4584 msgid "guestfs_aug_clear"
4588 #: ../src/guestfs-actions.pod:272
4592 " guestfs_aug_clear (guestfs_h *g,\n"
4593 " const char *augpath);\n"
4598 #: ../src/guestfs-actions.pod:276 ../fish/guestfish-actions.pod:178
4600 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4601 "L<augtool(1)> C<clear> command."
4605 #: ../src/guestfs-actions.pod:281 ../src/guestfs-actions.pod:2083
4606 msgid "(Added in 1.3.4)"
4610 #: ../src/guestfs-actions.pod:283
4611 msgid "guestfs_aug_close"
4615 #: ../src/guestfs-actions.pod:285
4619 " guestfs_aug_close (guestfs_h *g);\n"
4624 #: ../src/guestfs-actions.pod:288
4626 "Close the current Augeas handle and free up any resources used by it. After "
4627 "calling this, you have to call C<guestfs_aug_init> again before you can use "
4628 "any other Augeas functions."
4632 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:320 ../src/guestfs-actions.pod:338 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:410 ../src/guestfs-actions.pod:430 ../src/guestfs-actions.pod:444 ../src/guestfs-actions.pod:475 ../src/guestfs-actions.pod:489 ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517 ../src/guestfs-actions.pod:535 ../src/guestfs-actions.pod:5086
4633 msgid "(Added in 0.7)"
4637 #: ../src/guestfs-actions.pod:297
4638 msgid "guestfs_aug_defnode"
4642 #: ../src/guestfs-actions.pod:299
4645 " struct guestfs_int_bool *\n"
4646 " guestfs_aug_defnode (guestfs_h *g,\n"
4647 " const char *name,\n"
4648 " const char *expr,\n"
4649 " const char *val);\n"
4654 #: ../src/guestfs-actions.pod:305 ../fish/guestfish-actions.pod:194
4655 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4659 #: ../src/guestfs-actions.pod:308
4661 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4662 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
4663 "containing that single node."
4667 #: ../src/guestfs-actions.pod:312 ../fish/guestfish-actions.pod:201
4669 "On success this returns a pair containing the number of nodes in the "
4670 "nodeset, and a boolean flag if a node was created."
4674 #: ../src/guestfs-actions.pod:316
4676 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
4677 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
4681 #: ../src/guestfs-actions.pod:322
4682 msgid "guestfs_aug_defvar"
4686 #: ../src/guestfs-actions.pod:324
4690 " guestfs_aug_defvar (guestfs_h *g,\n"
4691 " const char *name,\n"
4692 " const char *expr);\n"
4697 #: ../src/guestfs-actions.pod:329 ../fish/guestfish-actions.pod:209
4699 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4700 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4704 #: ../src/guestfs-actions.pod:333 ../fish/guestfish-actions.pod:213
4706 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4707 "evaluates to something which is not a nodeset."
4711 #: ../src/guestfs-actions.pod:340
4712 msgid "guestfs_aug_get"
4716 #: ../src/guestfs-actions.pod:342
4720 " guestfs_aug_get (guestfs_h *g,\n"
4721 " const char *augpath);\n"
4726 #: ../src/guestfs-actions.pod:346 ../fish/guestfish-actions.pod:220
4728 "Look up the value associated with C<path>. If C<path> matches exactly one "
4729 "node, the C<value> is returned."
4733 #: ../src/guestfs-actions.pod:349 ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:867 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1176 ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:1212 ../src/guestfs-actions.pod:1341 ../src/guestfs-actions.pod:1532 ../src/guestfs-actions.pod:1644 ../src/guestfs-actions.pod:1807 ../src/guestfs-actions.pod:1824 ../src/guestfs-actions.pod:1915 ../src/guestfs-actions.pod:1936 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2268 ../src/guestfs-actions.pod:2475 ../src/guestfs-actions.pod:2556 ../src/guestfs-actions.pod:2604 ../src/guestfs-actions.pod:2712 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:2823 ../src/guestfs-actions.pod:2846 ../src/guestfs-actions.pod:3328 ../src/guestfs-actions.pod:3678 ../src/guestfs-actions.pod:3848 ../src/guestfs-actions.pod:3958 ../src/guestfs-actions.pod:4621 ../src/guestfs-actions.pod:4814 ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5211 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5790 ../src/guestfs-actions.pod:5807 ../src/guestfs-actions.pod:5831 ../src/guestfs-actions.pod:6495 ../src/guestfs-actions.pod:6514 ../src/guestfs-actions.pod:6532 ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6984
4735 "This function returns a string, or NULL on error. I<The caller must free "
4736 "the returned string after use>."
4740 #: ../src/guestfs-actions.pod:354
4741 msgid "guestfs_aug_init"
4745 #: ../src/guestfs-actions.pod:356
4749 " guestfs_aug_init (guestfs_h *g,\n"
4750 " const char *root,\n"
4756 #: ../src/guestfs-actions.pod:361 ../fish/guestfish-actions.pod:227
4758 "Create a new Augeas handle for editing configuration files. If there was "
4759 "any previous Augeas handle associated with this guestfs session, then it is "
4764 #: ../src/guestfs-actions.pod:365
4765 msgid "You must call this before using any other C<guestfs_aug_*> commands."
4769 #: ../src/guestfs-actions.pod:368 ../fish/guestfish-actions.pod:234
4770 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4774 #: ../src/guestfs-actions.pod:371 ../fish/guestfish-actions.pod:237
4776 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4777 "logical I<or> of the following integers:"
4781 #: ../src/guestfs-actions.pod:377 ../fish/guestfish-actions.pod:243
4782 msgid "C<AUG_SAVE_BACKUP> = 1"
4786 #: ../src/guestfs-actions.pod:379 ../fish/guestfish-actions.pod:245
4787 msgid "Keep the original file with a C<.augsave> extension."
4791 #: ../src/guestfs-actions.pod:381 ../fish/guestfish-actions.pod:247
4792 msgid "C<AUG_SAVE_NEWFILE> = 2"
4796 #: ../src/guestfs-actions.pod:383 ../fish/guestfish-actions.pod:249
4798 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4799 "original. Overrides C<AUG_SAVE_BACKUP>."
4803 #: ../src/guestfs-actions.pod:386 ../fish/guestfish-actions.pod:252
4804 msgid "C<AUG_TYPE_CHECK> = 4"
4808 #: ../src/guestfs-actions.pod:388 ../fish/guestfish-actions.pod:254
4809 msgid "Typecheck lenses (can be expensive)."
4813 #: ../src/guestfs-actions.pod:390 ../fish/guestfish-actions.pod:256
4814 msgid "C<AUG_NO_STDINC> = 8"
4818 #: ../src/guestfs-actions.pod:392 ../fish/guestfish-actions.pod:258
4819 msgid "Do not use standard load path for modules."
4823 #: ../src/guestfs-actions.pod:394 ../fish/guestfish-actions.pod:260
4824 msgid "C<AUG_SAVE_NOOP> = 16"
4828 #: ../src/guestfs-actions.pod:396 ../fish/guestfish-actions.pod:262
4829 msgid "Make save a no-op, just record what would have been changed."
4833 #: ../src/guestfs-actions.pod:398 ../fish/guestfish-actions.pod:264
4834 msgid "C<AUG_NO_LOAD> = 32"
4838 #: ../src/guestfs-actions.pod:400
4839 msgid "Do not load the tree in C<guestfs_aug_init>."
4843 #: ../src/guestfs-actions.pod:404
4844 msgid "To close the handle, you can call C<guestfs_aug_close>."
4848 #: ../src/guestfs-actions.pod:406 ../fish/guestfish-actions.pod:272
4849 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4853 #: ../src/guestfs-actions.pod:412
4854 msgid "guestfs_aug_insert"
4858 #: ../src/guestfs-actions.pod:414
4862 " guestfs_aug_insert (guestfs_h *g,\n"
4863 " const char *augpath,\n"
4864 " const char *label,\n"
4870 #: ../src/guestfs-actions.pod:420 ../fish/guestfish-actions.pod:278
4872 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4873 "or after C<path> (depending on the boolean flag C<before>)."
4877 #: ../src/guestfs-actions.pod:424 ../fish/guestfish-actions.pod:282
4879 "C<path> must match exactly one existing node in the tree, and C<label> must "
4880 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4884 #: ../src/guestfs-actions.pod:432
4885 msgid "guestfs_aug_load"
4889 #: ../src/guestfs-actions.pod:434
4893 " guestfs_aug_load (guestfs_h *g);\n"
4898 #: ../src/guestfs-actions.pod:437 ../fish/guestfish-actions.pod:290
4899 msgid "Load files into the tree."
4903 #: ../src/guestfs-actions.pod:439 ../fish/guestfish-actions.pod:292
4904 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4908 #: ../src/guestfs-actions.pod:446
4909 msgid "guestfs_aug_ls"
4913 #: ../src/guestfs-actions.pod:448
4917 " guestfs_aug_ls (guestfs_h *g,\n"
4918 " const char *augpath);\n"
4923 #: ../src/guestfs-actions.pod:452
4925 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
4926 "sorting the resulting nodes into alphabetical order."
4930 #: ../src/guestfs-actions.pod:455 ../src/guestfs-actions.pod:471 ../src/guestfs-actions.pod:617 ../src/guestfs-actions.pod:1065 ../src/guestfs-actions.pod:1356 ../src/guestfs-actions.pod:1375 ../src/guestfs-actions.pod:1478 ../src/guestfs-actions.pod:1497 ../src/guestfs-actions.pod:1746 ../src/guestfs-actions.pod:2148 ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:2183 ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:2250 ../src/guestfs-actions.pod:2321 ../src/guestfs-actions.pod:2370 ../src/guestfs-actions.pod:2581 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:2993 ../src/guestfs-actions.pod:3248 ../src/guestfs-actions.pod:3310 ../src/guestfs-actions.pod:3415 ../src/guestfs-actions.pod:3820 ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:5082 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5963 ../src/guestfs-actions.pod:6109 ../src/guestfs-actions.pod:6133 ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:6625 ../src/guestfs-actions.pod:6672 ../src/guestfs-actions.pod:6837 ../src/guestfs-actions.pod:6856 ../src/guestfs-actions.pod:6941 ../src/guestfs-actions.pod:6960 ../src/guestfs-actions.pod:7006 ../src/guestfs-actions.pod:7025
4932 "This function returns a NULL-terminated array of strings (like "
4933 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
4934 "strings and the array after use>."
4938 #: ../src/guestfs-actions.pod:459 ../src/guestfs-actions.pod:990 ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1413 ../src/guestfs-actions.pod:3071 ../src/guestfs-actions.pod:3102 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3711 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:3931 ../src/guestfs-actions.pod:4094 ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:5275 ../src/guestfs-actions.pod:5289 ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:5709 ../src/guestfs-actions.pod:6347 ../src/guestfs-actions.pod:6360 ../src/guestfs-actions.pod:6589 ../src/guestfs-actions.pod:6792 ../src/guestfs-actions.pod:6825
4939 msgid "(Added in 0.8)"
4943 #: ../src/guestfs-actions.pod:461
4944 msgid "guestfs_aug_match"
4948 #: ../src/guestfs-actions.pod:463
4952 " guestfs_aug_match (guestfs_h *g,\n"
4953 " const char *augpath);\n"
4958 #: ../src/guestfs-actions.pod:467 ../fish/guestfish-actions.pod:306
4960 "Returns a list of paths which match the path expression C<path>. The "
4961 "returned paths are sufficiently qualified so that they match exactly one "
4962 "node in the current tree."
4966 #: ../src/guestfs-actions.pod:477
4967 msgid "guestfs_aug_mv"
4971 #: ../src/guestfs-actions.pod:479
4975 " guestfs_aug_mv (guestfs_h *g,\n"
4976 " const char *src,\n"
4977 " const char *dest);\n"
4982 #: ../src/guestfs-actions.pod:484 ../fish/guestfish-actions.pod:314
4984 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4985 "C<dest> is overwritten if it exists."
4989 #: ../src/guestfs-actions.pod:491
4990 msgid "guestfs_aug_rm"
4994 #: ../src/guestfs-actions.pod:493
4998 " guestfs_aug_rm (guestfs_h *g,\n"
4999 " const char *augpath);\n"
5004 #: ../src/guestfs-actions.pod:497 ../fish/guestfish-actions.pod:321
5005 msgid "Remove C<path> and all of its children."
5009 #: ../src/guestfs-actions.pod:499 ../fish/guestfish-actions.pod:323
5010 msgid "On success this returns the number of entries which were removed."
5014 #: ../src/guestfs-actions.pod:505
5015 msgid "guestfs_aug_save"
5019 #: ../src/guestfs-actions.pod:507
5023 " guestfs_aug_save (guestfs_h *g);\n"
5028 #: ../src/guestfs-actions.pod:510 ../fish/guestfish-actions.pod:329
5029 msgid "This writes all pending changes to disk."
5033 #: ../src/guestfs-actions.pod:512
5035 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
5040 #: ../src/guestfs-actions.pod:519
5041 msgid "guestfs_aug_set"
5045 #: ../src/guestfs-actions.pod:521
5049 " guestfs_aug_set (guestfs_h *g,\n"
5050 " const char *augpath,\n"
5051 " const char *val);\n"
5056 #: ../src/guestfs-actions.pod:526 ../fish/guestfish-actions.pod:338
5057 msgid "Set the value associated with C<path> to C<val>."
5061 #: ../src/guestfs-actions.pod:528
5063 "In the Augeas API, it is possible to clear a node by setting the value to "
5064 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
5065 "this call. Instead you must use the C<guestfs_aug_clear> call."
5069 #: ../src/guestfs-actions.pod:537
5070 msgid "guestfs_available"
5074 #: ../src/guestfs-actions.pod:539
5078 " guestfs_available (guestfs_h *g,\n"
5079 " char *const *groups);\n"
5084 #: ../src/guestfs-actions.pod:543 ../fish/guestfish-actions.pod:349
5086 "This command is used to check the availability of some groups of "
5087 "functionality in the appliance, which not all builds of the libguestfs "
5088 "appliance will be able to provide."
5092 #: ../src/guestfs-actions.pod:547
5094 "The libguestfs groups, and the functions that those groups correspond to, "
5095 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
5096 "runtime by calling C<guestfs_available_all_groups>."
5100 #: ../src/guestfs-actions.pod:552 ../fish/guestfish-actions.pod:358
5102 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
5103 "\"augeas\"]> would check for the availability of the Linux inotify functions "
5104 "and Augeas (configuration file editing) functions."
5108 #: ../src/guestfs-actions.pod:557 ../fish/guestfish-actions.pod:363
5109 msgid "The command returns no error if I<all> requested groups are available."
5113 #: ../src/guestfs-actions.pod:559 ../fish/guestfish-actions.pod:365
5115 "It fails with an error if one or more of the requested groups is unavailable "
5120 #: ../src/guestfs-actions.pod:562 ../fish/guestfish-actions.pod:368
5122 "If an unknown group name is included in the list of groups then an error is "
5127 #: ../src/guestfs-actions.pod:565 ../fish/guestfish-actions.pod:371
5132 #: ../src/guestfs-actions.pod:571
5133 msgid "You must call C<guestfs_launch> before calling this function."
5137 #: ../src/guestfs-actions.pod:573 ../fish/guestfish-actions.pod:379
5139 "The reason is because we don't know what groups are supported by the "
5140 "appliance/daemon until it is running and can be queried."
5144 #: ../src/guestfs-actions.pod:579 ../fish/guestfish-actions.pod:385
5146 "If a group of functions is available, this does not necessarily mean that "
5147 "they will work. You still have to check for errors when calling individual "
5148 "API functions even if they are available."
5152 #: ../src/guestfs-actions.pod:586 ../fish/guestfish-actions.pod:392
5154 "It is usually the job of distro packagers to build complete functionality "
5155 "into the libguestfs appliance. Upstream libguestfs, if built from source "
5156 "with all requirements satisfied, will support everything."
5160 #: ../src/guestfs-actions.pod:593
5162 "This call was added in version C<1.0.80>. In previous versions of "
5163 "libguestfs all you could do would be to speculatively execute a command to "
5164 "find out if the daemon implemented it. See also C<guestfs_version>."
5168 #: ../src/guestfs-actions.pod:602 ../src/guestfs-actions.pod:1163
5169 msgid "(Added in 1.0.80)"
5173 #: ../src/guestfs-actions.pod:604
5174 msgid "guestfs_available_all_groups"
5178 #: ../src/guestfs-actions.pod:606
5182 " guestfs_available_all_groups (guestfs_h *g);\n"
5187 #: ../src/guestfs-actions.pod:609
5189 "This command returns a list of all optional groups that this daemon knows "
5190 "about. Note this returns both supported and unsupported groups. To find "
5191 "out which ones the daemon can actually support you have to call "
5192 "C<guestfs_available> on each member of the returned list."
5196 #: ../src/guestfs-actions.pod:615
5197 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
5201 #: ../src/guestfs-actions.pod:621
5202 msgid "(Added in 1.3.15)"
5206 #: ../src/guestfs-actions.pod:623
5207 msgid "guestfs_base64_in"
5211 #: ../src/guestfs-actions.pod:625
5215 " guestfs_base64_in (guestfs_h *g,\n"
5216 " const char *base64file,\n"
5217 " const char *filename);\n"
5222 #: ../src/guestfs-actions.pod:630 ../fish/guestfish-actions.pod:422
5223 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
5227 #: ../src/guestfs-actions.pod:635 ../src/guestfs-actions.pod:649
5228 msgid "(Added in 1.3.5)"
5232 #: ../src/guestfs-actions.pod:637
5233 msgid "guestfs_base64_out"
5237 #: ../src/guestfs-actions.pod:639
5241 " guestfs_base64_out (guestfs_h *g,\n"
5242 " const char *filename,\n"
5243 " const char *base64file);\n"
5248 #: ../src/guestfs-actions.pod:644 ../fish/guestfish-actions.pod:431
5250 "This command downloads the contents of C<filename>, writing it out to local "
5251 "file C<base64file> encoded as base64."
5255 #: ../src/guestfs-actions.pod:651
5256 msgid "guestfs_blockdev_flushbufs"
5260 #: ../src/guestfs-actions.pod:653
5264 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
5265 " const char *device);\n"
5270 #: ../src/guestfs-actions.pod:657 ../fish/guestfish-actions.pod:440
5271 msgid "This tells the kernel to flush internal buffers associated with C<device>."
5275 #: ../src/guestfs-actions.pod:660 ../src/guestfs-actions.pod:677 ../src/guestfs-actions.pod:692 ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:726 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:759 ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:791 ../src/guestfs-actions.pod:805 ../fish/guestfish-actions.pod:443 ../fish/guestfish-actions.pod:454 ../fish/guestfish-actions.pod:463 ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:485 ../fish/guestfish-actions.pod:498 ../fish/guestfish-actions.pod:506 ../fish/guestfish-actions.pod:517 ../fish/guestfish-actions.pod:525 ../fish/guestfish-actions.pod:533
5276 msgid "This uses the L<blockdev(8)> command."
5280 #: ../src/guestfs-actions.pod:664 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:712 ../src/guestfs-actions.pod:730 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:763 ../src/guestfs-actions.pod:781 ../src/guestfs-actions.pod:795 ../src/guestfs-actions.pod:809
5281 msgid "(Added in 0.9.3)"
5285 #: ../src/guestfs-actions.pod:666
5286 msgid "guestfs_blockdev_getbsz"
5290 #: ../src/guestfs-actions.pod:668
5294 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
5295 " const char *device);\n"
5300 #: ../src/guestfs-actions.pod:672 ../fish/guestfish-actions.pod:449
5301 msgid "This returns the block size of a device."
5305 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:774 ../fish/guestfish-actions.pod:451 ../fish/guestfish-actions.pod:514
5307 "(Note this is different from both I<size in blocks> and I<filesystem block "
5312 #: ../src/guestfs-actions.pod:683
5313 msgid "guestfs_blockdev_getro"
5317 #: ../src/guestfs-actions.pod:685
5321 " guestfs_blockdev_getro (guestfs_h *g,\n"
5322 " const char *device);\n"
5327 #: ../src/guestfs-actions.pod:689 ../fish/guestfish-actions.pod:460
5329 "Returns a boolean indicating if the block device is read-only (true if "
5330 "read-only, false if not)."
5334 #: ../src/guestfs-actions.pod:694 ../src/guestfs-actions.pod:1396 ../src/guestfs-actions.pod:1411 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2044 ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:3010 ../src/guestfs-actions.pod:3024 ../src/guestfs-actions.pod:3039 ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3100 ../src/guestfs-actions.pod:3114 ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3141 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3171 ../src/guestfs-actions.pod:4585
5335 msgid "This function returns a C truth value on success or -1 on error."
5339 #: ../src/guestfs-actions.pod:698
5340 msgid "guestfs_blockdev_getsize64"
5344 #: ../src/guestfs-actions.pod:700
5348 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
5349 " const char *device);\n"
5354 #: ../src/guestfs-actions.pod:704 ../fish/guestfish-actions.pod:469
5355 msgid "This returns the size of the device in bytes."
5359 #: ../src/guestfs-actions.pod:706
5360 msgid "See also C<guestfs_blockdev_getsz>."
5364 #: ../src/guestfs-actions.pod:714
5365 msgid "guestfs_blockdev_getss"
5369 #: ../src/guestfs-actions.pod:716
5373 " guestfs_blockdev_getss (guestfs_h *g,\n"
5374 " const char *device);\n"
5379 #: ../src/guestfs-actions.pod:720 ../fish/guestfish-actions.pod:479
5381 "This returns the size of sectors on a block device. Usually 512, but can be "
5382 "larger for modern devices."
5386 #: ../src/guestfs-actions.pod:723
5388 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
5393 #: ../src/guestfs-actions.pod:732
5394 msgid "guestfs_blockdev_getsz"
5398 #: ../src/guestfs-actions.pod:734
5402 " guestfs_blockdev_getsz (guestfs_h *g,\n"
5403 " const char *device);\n"
5408 #: ../src/guestfs-actions.pod:738 ../fish/guestfish-actions.pod:491
5410 "This returns the size of the device in units of 512-byte sectors (even if "
5411 "the sectorsize isn't 512 bytes ... weird)."
5415 #: ../src/guestfs-actions.pod:741
5417 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
5418 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
5422 #: ../src/guestfs-actions.pod:751
5423 msgid "guestfs_blockdev_rereadpt"
5427 #: ../src/guestfs-actions.pod:753
5431 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
5432 " const char *device);\n"
5437 #: ../src/guestfs-actions.pod:757 ../fish/guestfish-actions.pod:504
5438 msgid "Reread the partition table on C<device>."
5442 #: ../src/guestfs-actions.pod:765
5443 msgid "guestfs_blockdev_setbsz"
5447 #: ../src/guestfs-actions.pod:767
5451 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
5452 " const char *device,\n"
5453 " int blocksize);\n"
5458 #: ../src/guestfs-actions.pod:772 ../fish/guestfish-actions.pod:512
5459 msgid "This sets the block size of a device."
5463 #: ../src/guestfs-actions.pod:783
5464 msgid "guestfs_blockdev_setro"
5468 #: ../src/guestfs-actions.pod:785
5472 " guestfs_blockdev_setro (guestfs_h *g,\n"
5473 " const char *device);\n"
5478 #: ../src/guestfs-actions.pod:789 ../fish/guestfish-actions.pod:523
5479 msgid "Sets the block device named C<device> to read-only."
5483 #: ../src/guestfs-actions.pod:797
5484 msgid "guestfs_blockdev_setrw"
5488 #: ../src/guestfs-actions.pod:799
5492 " guestfs_blockdev_setrw (guestfs_h *g,\n"
5493 " const char *device);\n"
5498 #: ../src/guestfs-actions.pod:803 ../fish/guestfish-actions.pod:531
5499 msgid "Sets the block device named C<device> to read-write."
5503 #: ../src/guestfs-actions.pod:811
5504 msgid "guestfs_case_sensitive_path"
5508 #: ../src/guestfs-actions.pod:813
5512 " guestfs_case_sensitive_path (guestfs_h *g,\n"
5513 " const char *path);\n"
5518 #: ../src/guestfs-actions.pod:817 ../fish/guestfish-actions.pod:539
5520 "This can be used to resolve case insensitive paths on a filesystem which is "
5521 "case sensitive. The use case is to resolve paths which you have read from "
5522 "Windows configuration files or the Windows Registry, to the true path."
5526 #: ../src/guestfs-actions.pod:822 ../fish/guestfish-actions.pod:544
5528 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5529 "(and probably others), which is that although the underlying filesystem is "
5530 "case-insensitive, the driver exports the filesystem to Linux as "
5535 #: ../src/guestfs-actions.pod:827 ../fish/guestfish-actions.pod:549
5537 "One consequence of this is that special directories such as C<c:\\windows> "
5538 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5539 "precise details of how they were created. In Windows itself this would not "
5544 #: ../src/guestfs-actions.pod:833 ../fish/guestfish-actions.pod:555
5546 "Bug or feature? You decide: "
5547 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5551 #: ../src/guestfs-actions.pod:836 ../fish/guestfish-actions.pod:558
5553 "This function resolves the true case of each element in the path and returns "
5554 "the case-sensitive path."
5558 #: ../src/guestfs-actions.pod:839
5560 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
5561 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5562 "how the directories were originally created under Windows)."
5566 #: ../src/guestfs-actions.pod:844 ../fish/guestfish-actions.pod:566
5567 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5571 #: ../src/guestfs-actions.pod:847
5572 msgid "See also C<guestfs_realpath>."
5576 #: ../src/guestfs-actions.pod:852 ../src/guestfs-actions.pod:6517
5577 msgid "(Added in 1.0.75)"
5581 #: ../src/guestfs-actions.pod:854
5586 #: ../src/guestfs-actions.pod:856
5590 " guestfs_cat (guestfs_h *g,\n"
5591 " const char *path);\n"
5596 #: ../src/guestfs-actions.pod:860 ../src/guestfs-actions.pod:5072 ../fish/guestfish-actions.pod:575 ../fish/guestfish-actions.pod:3393
5597 msgid "Return the contents of the file named C<path>."
5601 #: ../src/guestfs-actions.pod:862
5603 "Note that this function cannot correctly handle binary files (specifically, "
5604 "files containing C<\\0> character which is treated as end of string). For "
5605 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
5606 "functions which have a more complex interface."
5610 #: ../src/guestfs-actions.pod:870 ../src/guestfs-actions.pod:1049 ../src/guestfs-actions.pod:1069 ../src/guestfs-actions.pod:1360 ../src/guestfs-actions.pod:1379 ../src/guestfs-actions.pod:1482 ../src/guestfs-actions.pod:1501 ../src/guestfs-actions.pod:1750 ../src/guestfs-actions.pod:2168 ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:2254 ../src/guestfs-actions.pod:2271 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4880 ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5037 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:5967 ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6789 ../src/guestfs-actions.pod:6815 ../src/guestfs-actions.pod:6841 ../src/guestfs-actions.pod:6860 ../src/guestfs-actions.pod:6945 ../src/guestfs-actions.pod:6964 ../src/guestfs-actions.pod:7010 ../src/guestfs-actions.pod:7029 ../fish/guestfish-actions.pod:582 ../fish/guestfish-actions.pod:717 ../fish/guestfish-actions.pod:729 ../fish/guestfish-actions.pod:905 ../fish/guestfish-actions.pod:915 ../fish/guestfish-actions.pod:982 ../fish/guestfish-actions.pod:992 ../fish/guestfish-actions.pod:1187 ../fish/guestfish-actions.pod:1462 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:1500 ../fish/guestfish-actions.pod:1515 ../fish/guestfish-actions.pod:1525 ../fish/guestfish-actions.pod:1544 ../fish/guestfish-actions.pod:3263 ../fish/guestfish-actions.pod:3278 ../fish/guestfish-actions.pod:3354 ../fish/guestfish-actions.pod:3371 ../fish/guestfish-actions.pod:3386 ../fish/guestfish-actions.pod:3969 ../fish/guestfish-actions.pod:4015 ../fish/guestfish-actions.pod:4100 ../fish/guestfish-actions.pod:4115 ../fish/guestfish-actions.pod:4525 ../fish/guestfish-actions.pod:4543 ../fish/guestfish-actions.pod:4560 ../fish/guestfish-actions.pod:4570 ../fish/guestfish-actions.pod:4618 ../fish/guestfish-actions.pod:4628 ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4667
5612 "Because of the message protocol, there is a transfer limit of somewhere "
5613 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5617 #: ../src/guestfs-actions.pod:873 ../src/guestfs-actions.pod:3252 ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3331 ../src/guestfs-actions.pod:3419 ../src/guestfs-actions.pod:3824 ../src/guestfs-actions.pod:3838 ../src/guestfs-actions.pod:4960 ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:6676 ../src/guestfs-actions.pod:6690
5618 msgid "(Added in 0.4)"
5622 #: ../src/guestfs-actions.pod:875
5623 msgid "guestfs_checksum"
5627 #: ../src/guestfs-actions.pod:877
5631 " guestfs_checksum (guestfs_h *g,\n"
5632 " const char *csumtype,\n"
5633 " const char *path);\n"
5638 #: ../src/guestfs-actions.pod:882 ../fish/guestfish-actions.pod:589
5639 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5643 #: ../src/guestfs-actions.pod:885 ../fish/guestfish-actions.pod:592
5645 "The type of checksum to compute is given by the C<csumtype> parameter which "
5646 "must have one of the following values:"
5650 #: ../src/guestfs-actions.pod:890 ../fish/guestfish-actions.pod:597
5655 #: ../src/guestfs-actions.pod:892 ../fish/guestfish-actions.pod:599
5657 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5662 #: ../src/guestfs-actions.pod:895 ../fish/guestfish-actions.pod:602
5667 #: ../src/guestfs-actions.pod:897 ../fish/guestfish-actions.pod:604
5668 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5672 #: ../src/guestfs-actions.pod:899 ../fish/guestfish-actions.pod:606
5677 #: ../src/guestfs-actions.pod:901 ../fish/guestfish-actions.pod:608
5678 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5682 #: ../src/guestfs-actions.pod:903 ../fish/guestfish-actions.pod:610
5687 #: ../src/guestfs-actions.pod:905 ../fish/guestfish-actions.pod:612
5688 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5692 #: ../src/guestfs-actions.pod:907 ../fish/guestfish-actions.pod:614
5697 #: ../src/guestfs-actions.pod:909 ../fish/guestfish-actions.pod:616
5698 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5702 #: ../src/guestfs-actions.pod:911 ../fish/guestfish-actions.pod:618
5707 #: ../src/guestfs-actions.pod:913 ../fish/guestfish-actions.pod:620
5708 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5712 #: ../src/guestfs-actions.pod:915 ../fish/guestfish-actions.pod:622
5717 #: ../src/guestfs-actions.pod:917 ../fish/guestfish-actions.pod:624
5718 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5722 #: ../src/guestfs-actions.pod:921 ../fish/guestfish-actions.pod:628
5723 msgid "The checksum is returned as a printable string."
5727 #: ../src/guestfs-actions.pod:923
5728 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
5732 #: ../src/guestfs-actions.pod:925
5733 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
5737 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:1238 ../src/guestfs-actions.pod:2060 ../src/guestfs-actions.pod:3026 ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3116 ../src/guestfs-actions.pod:3143 ../src/guestfs-actions.pod:6378
5738 msgid "(Added in 1.0.2)"
5742 #: ../src/guestfs-actions.pod:932
5743 msgid "guestfs_checksum_device"
5747 #: ../src/guestfs-actions.pod:934
5751 " guestfs_checksum_device (guestfs_h *g,\n"
5752 " const char *csumtype,\n"
5753 " const char *device);\n"
5758 #: ../src/guestfs-actions.pod:939
5760 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5761 "device named C<device>. For the types of checksums supported see the "
5762 "C<guestfs_checksum> command."
5766 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:4491 ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:4781 ../src/guestfs-actions.pod:6292 ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6702
5767 msgid "(Added in 1.3.2)"
5771 #: ../src/guestfs-actions.pod:948
5772 msgid "guestfs_checksums_out"
5776 #: ../src/guestfs-actions.pod:950
5780 " guestfs_checksums_out (guestfs_h *g,\n"
5781 " const char *csumtype,\n"
5782 " const char *directory,\n"
5783 " const char *sumsfile);\n"
5788 #: ../src/guestfs-actions.pod:956 ../fish/guestfish-actions.pod:646
5790 "This command computes the checksums of all regular files in C<directory> and "
5791 "then emits a list of those checksums to the local output file C<sumsfile>."
5795 #: ../src/guestfs-actions.pod:960 ../fish/guestfish-actions.pod:650
5797 "This can be used for verifying the integrity of a virtual machine. However "
5798 "to be properly secure you should pay attention to the output of the checksum "
5799 "command (it uses the ones from GNU coreutils). In particular when the "
5800 "filename is not printable, coreutils uses a special backslash syntax. For "
5801 "more information, see the GNU coreutils info file."
5805 #: ../src/guestfs-actions.pod:970
5806 msgid "(Added in 1.3.7)"
5810 #: ../src/guestfs-actions.pod:972
5811 msgid "guestfs_chmod"
5815 #: ../src/guestfs-actions.pod:974
5819 " guestfs_chmod (guestfs_h *g,\n"
5821 " const char *path);\n"
5826 #: ../src/guestfs-actions.pod:979 ../fish/guestfish-actions.pod:664
5828 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5833 #: ../src/guestfs-actions.pod:982 ../fish/guestfish-actions.pod:667
5835 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5836 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5841 #: ../src/guestfs-actions.pod:986 ../src/guestfs-actions.pod:4075 ../src/guestfs-actions.pod:4190 ../src/guestfs-actions.pod:4209 ../src/guestfs-actions.pod:4228 ../fish/guestfish-actions.pod:671 ../fish/guestfish-actions.pod:2753 ../fish/guestfish-actions.pod:2838 ../fish/guestfish-actions.pod:2848 ../fish/guestfish-actions.pod:2858
5842 msgid "The mode actually set is affected by the umask."
5846 #: ../src/guestfs-actions.pod:992
5847 msgid "guestfs_chown"
5851 #: ../src/guestfs-actions.pod:994
5855 " guestfs_chown (guestfs_h *g,\n"
5858 " const char *path);\n"
5863 #: ../src/guestfs-actions.pod:1000 ../fish/guestfish-actions.pod:677
5864 msgid "Change the file owner to C<owner> and group to C<group>."
5868 #: ../src/guestfs-actions.pod:1002 ../src/guestfs-actions.pod:3213 ../fish/guestfish-actions.pod:679 ../fish/guestfish-actions.pod:2231
5870 "Only numeric uid and gid are supported. If you want to use names, you will "
5871 "need to locate and parse the password file yourself (Augeas support makes "
5872 "this relatively easy)."
5876 #: ../src/guestfs-actions.pod:1010
5877 msgid "guestfs_command"
5881 #: ../src/guestfs-actions.pod:1012
5885 " guestfs_command (guestfs_h *g,\n"
5886 " char *const *arguments);\n"
5891 #: ../src/guestfs-actions.pod:1016 ../fish/guestfish-actions.pod:687
5893 "This call runs a command from the guest filesystem. The filesystem must be "
5894 "mounted, and must contain a compatible operating system (ie. something "
5895 "Linux, with the same or compatible processor architecture)."
5899 #: ../src/guestfs-actions.pod:1021
5901 "The single parameter is an argv-style list of arguments. The first element "
5902 "is the name of the program to run. Subsequent elements are parameters. The "
5903 "list must be non-empty (ie. must contain a program name). Note that the "
5904 "command runs directly, and is I<not> invoked via the shell (see "
5909 #: ../src/guestfs-actions.pod:1028 ../fish/guestfish-actions.pod:699
5910 msgid "The return value is anything printed to I<stdout> by the command."
5914 #: ../src/guestfs-actions.pod:1031 ../fish/guestfish-actions.pod:702
5916 "If the command returns a non-zero exit status, then this function returns an "
5917 "error message. The error message string is the content of I<stderr> from "
5922 #: ../src/guestfs-actions.pod:1035 ../fish/guestfish-actions.pod:706
5924 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5925 "C</bin>. If you require a program from another location, you should provide "
5926 "the full path in the first parameter."
5930 #: ../src/guestfs-actions.pod:1040 ../fish/guestfish-actions.pod:711
5932 "Shared libraries and data files required by the program must be available on "
5933 "filesystems which are mounted in the correct places. It is the caller's "
5934 "responsibility to ensure all filesystems that are needed are mounted at the "
5939 #: ../src/guestfs-actions.pod:1052 ../src/guestfs-actions.pod:1072 ../src/guestfs-actions.pod:1535
5940 msgid "(Added in 0.9.1)"
5944 #: ../src/guestfs-actions.pod:1054
5945 msgid "guestfs_command_lines"
5949 #: ../src/guestfs-actions.pod:1056
5953 " guestfs_command_lines (guestfs_h *g,\n"
5954 " char *const *arguments);\n"
5959 #: ../src/guestfs-actions.pod:1060
5961 "This is the same as C<guestfs_command>, but splits the result into a list of "
5966 #: ../src/guestfs-actions.pod:1063
5967 msgid "See also: C<guestfs_sh_lines>"
5971 #: ../src/guestfs-actions.pod:1074
5972 msgid "guestfs_config"
5976 #: ../src/guestfs-actions.pod:1076
5980 " guestfs_config (guestfs_h *g,\n"
5981 " const char *qemuparam,\n"
5982 " const char *qemuvalue);\n"
5987 #: ../src/guestfs-actions.pod:1081 ../fish/guestfish-actions.pod:736
5989 "This can be used to add arbitrary qemu command line parameters of the form "
5990 "C<-param value>. Actually it's not quite arbitrary - we prevent you from "
5991 "setting some parameters which would interfere with parameters that we use."
5995 #: ../src/guestfs-actions.pod:1086 ../fish/guestfish-actions.pod:741
5996 msgid "The first character of C<param> string must be a C<-> (dash)."
6000 #: ../src/guestfs-actions.pod:1088 ../fish/guestfish-actions.pod:743
6001 msgid "C<value> can be NULL."
6005 #: ../src/guestfs-actions.pod:1094
6006 msgid "guestfs_copy_size"
6010 #: ../src/guestfs-actions.pod:1096
6014 " guestfs_copy_size (guestfs_h *g,\n"
6015 " const char *src,\n"
6016 " const char *dest,\n"
6022 #: ../src/guestfs-actions.pod:1102 ../fish/guestfish-actions.pod:749
6024 "This command copies exactly C<size> bytes from one source device or file "
6025 "C<src> to another destination device or file C<dest>."
6029 #: ../src/guestfs-actions.pod:1105 ../fish/guestfish-actions.pod:752
6031 "Note this will fail if the source is too short or if the destination is not "
6036 #: ../src/guestfs-actions.pod:1110 ../src/guestfs-actions.pod:1233 ../src/guestfs-actions.pod:1264 ../src/guestfs-actions.pod:1684 ../src/guestfs-actions.pod:1706 ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:6900
6038 "This long-running command can generate progress notification messages so "
6039 "that the caller can display a progress bar or indicator. To receive these "
6040 "messages, the caller must register a progress callback. See "
6041 "L<guestfs(3)/guestfs_set_progress_callback>."
6045 #: ../src/guestfs-actions.pod:1115 ../src/guestfs-actions.pod:3851 ../src/guestfs-actions.pod:4987 ../src/guestfs-actions.pod:6609 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6715
6046 msgid "(Added in 1.0.87)"
6050 #: ../src/guestfs-actions.pod:1117
6055 #: ../src/guestfs-actions.pod:1119
6059 " guestfs_cp (guestfs_h *g,\n"
6060 " const char *src,\n"
6061 " const char *dest);\n"
6066 #: ../src/guestfs-actions.pod:1124 ../fish/guestfish-actions.pod:759
6068 "This copies a file from C<src> to C<dest> where C<dest> is either a "
6069 "destination filename or destination directory."
6073 #: ../src/guestfs-actions.pod:1129 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1215 ../src/guestfs-actions.pod:1289 ../src/guestfs-actions.pod:1398 ../src/guestfs-actions.pod:4454 ../src/guestfs-actions.pod:4831
6074 msgid "(Added in 1.0.18)"
6078 #: ../src/guestfs-actions.pod:1131
6079 msgid "guestfs_cp_a"
6083 #: ../src/guestfs-actions.pod:1133
6087 " guestfs_cp_a (guestfs_h *g,\n"
6088 " const char *src,\n"
6089 " const char *dest);\n"
6094 #: ../src/guestfs-actions.pod:1138 ../fish/guestfish-actions.pod:766
6096 "This copies a file or directory from C<src> to C<dest> recursively using the "
6101 #: ../src/guestfs-actions.pod:1145
6106 #: ../src/guestfs-actions.pod:1147
6110 " guestfs_dd (guestfs_h *g,\n"
6111 " const char *src,\n"
6112 " const char *dest);\n"
6117 #: ../src/guestfs-actions.pod:1152 ../fish/guestfish-actions.pod:773
6119 "This command copies from one source device or file C<src> to another "
6120 "destination device or file C<dest>. Normally you would use this to copy to "
6121 "or from a device or partition, for example to duplicate a filesystem."
6125 #: ../src/guestfs-actions.pod:1157
6127 "If the destination is a device, it must be as large or larger than the "
6128 "source file or device, otherwise the copy will fail. This command cannot do "
6129 "partial copies (see C<guestfs_copy_size>)."
6133 #: ../src/guestfs-actions.pod:1165
6138 #: ../src/guestfs-actions.pod:1167
6142 " guestfs_df (guestfs_h *g);\n"
6147 #: ../src/guestfs-actions.pod:1170 ../fish/guestfish-actions.pod:786
6148 msgid "This command runs the C<df> command to report disk space used."
6152 #: ../src/guestfs-actions.pod:1172 ../src/guestfs-actions.pod:1189 ../fish/guestfish-actions.pod:788 ../fish/guestfish-actions.pod:799
6154 "This command is mostly useful for interactive sessions. It is I<not> "
6155 "intended that you try to parse the output string. Use C<statvfs> from "
6160 #: ../src/guestfs-actions.pod:1179 ../src/guestfs-actions.pod:1196 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:3961 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:6116 ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6761 ../src/guestfs-actions.pod:6774
6161 msgid "(Added in 1.0.54)"
6165 #: ../src/guestfs-actions.pod:1181
6166 msgid "guestfs_df_h"
6170 #: ../src/guestfs-actions.pod:1183
6174 " guestfs_df_h (guestfs_h *g);\n"
6179 #: ../src/guestfs-actions.pod:1186 ../fish/guestfish-actions.pod:796
6181 "This command runs the C<df -h> command to report disk space used in "
6182 "human-readable format."
6186 #: ../src/guestfs-actions.pod:1198
6187 msgid "guestfs_dmesg"
6191 #: ../src/guestfs-actions.pod:1200
6195 " guestfs_dmesg (guestfs_h *g);\n"
6200 #: ../src/guestfs-actions.pod:1203 ../fish/guestfish-actions.pod:807
6202 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
6203 "This is sometimes useful for extended debugging of problems."
6207 #: ../src/guestfs-actions.pod:1207
6209 "Another way to get the same information is to enable verbose messages with "
6210 "C<guestfs_set_verbose> or by setting the environment variable "
6211 "C<LIBGUESTFS_DEBUG=1> before running the program."
6215 #: ../src/guestfs-actions.pod:1217
6216 msgid "guestfs_download"
6220 #: ../src/guestfs-actions.pod:1219
6224 " guestfs_download (guestfs_h *g,\n"
6225 " const char *remotefilename,\n"
6226 " const char *filename);\n"
6231 #: ../src/guestfs-actions.pod:1224 ../src/guestfs-actions.pod:1249 ../fish/guestfish-actions.pod:820 ../fish/guestfish-actions.pod:833
6233 "Download file C<remotefilename> and save it as C<filename> on the local "
6238 #: ../src/guestfs-actions.pod:1227 ../src/guestfs-actions.pod:6372 ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:4273
6239 msgid "C<filename> can also be a named pipe."
6243 #: ../src/guestfs-actions.pod:1229
6244 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
6248 #: ../src/guestfs-actions.pod:1240
6249 msgid "guestfs_download_offset"
6253 #: ../src/guestfs-actions.pod:1242
6257 " guestfs_download_offset (guestfs_h *g,\n"
6258 " const char *remotefilename,\n"
6259 " const char *filename,\n"
6260 " int64_t offset,\n"
6266 #: ../src/guestfs-actions.pod:1252 ../fish/guestfish-actions.pod:836
6268 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
6269 "region must be within the file or device)."
6273 #: ../src/guestfs-actions.pod:1255
6275 "Note that there is no limit on the amount of data that can be downloaded "
6276 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
6277 "full amount unless an error occurs."
6281 #: ../src/guestfs-actions.pod:1260
6282 msgid "See also C<guestfs_download>, C<guestfs_pread>."
6286 #: ../src/guestfs-actions.pod:1269 ../src/guestfs-actions.pod:6407
6287 msgid "(Added in 1.5.17)"
6291 #: ../src/guestfs-actions.pod:1271
6292 msgid "guestfs_drop_caches"
6296 #: ../src/guestfs-actions.pod:1273
6300 " guestfs_drop_caches (guestfs_h *g,\n"
6301 " int whattodrop);\n"
6306 #: ../src/guestfs-actions.pod:1277 ../fish/guestfish-actions.pod:852
6308 "This instructs the guest kernel to drop its page cache, and/or dentries and "
6309 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
6310 "to drop, see L<http://linux-mm.org/Drop_Caches>"
6314 #: ../src/guestfs-actions.pod:1282 ../fish/guestfish-actions.pod:857
6315 msgid "Setting C<whattodrop> to 3 should drop everything."
6319 #: ../src/guestfs-actions.pod:1284 ../fish/guestfish-actions.pod:859
6321 "This automatically calls L<sync(2)> before the operation, so that the "
6322 "maximum guest memory is freed."
6326 #: ../src/guestfs-actions.pod:1291
6331 #: ../src/guestfs-actions.pod:1293
6335 " guestfs_du (guestfs_h *g,\n"
6336 " const char *path);\n"
6341 #: ../src/guestfs-actions.pod:1297 ../fish/guestfish-actions.pod:866
6343 "This command runs the C<du -s> command to estimate file space usage for "
6348 #: ../src/guestfs-actions.pod:1300 ../fish/guestfish-actions.pod:869
6350 "C<path> can be a file or a directory. If C<path> is a directory then the "
6351 "estimate includes the contents of the directory and all subdirectories "
6356 #: ../src/guestfs-actions.pod:1304 ../fish/guestfish-actions.pod:873
6357 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
6361 #: ../src/guestfs-actions.pod:1311
6362 msgid "guestfs_e2fsck_f"
6366 #: ../src/guestfs-actions.pod:1313
6370 " guestfs_e2fsck_f (guestfs_h *g,\n"
6371 " const char *device);\n"
6376 #: ../src/guestfs-actions.pod:1317 ../fish/guestfish-actions.pod:880
6378 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
6379 "on C<device>, noninteractively (C<-p>), even if the filesystem appears to be "
6384 #: ../src/guestfs-actions.pod:1321
6386 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
6387 "Normally you should use C<guestfs_fsck>."
6391 #: ../src/guestfs-actions.pod:1326
6392 msgid "(Added in 1.0.29)"
6396 #: ../src/guestfs-actions.pod:1328
6397 msgid "guestfs_echo_daemon"
6401 #: ../src/guestfs-actions.pod:1330
6405 " guestfs_echo_daemon (guestfs_h *g,\n"
6406 " char *const *words);\n"
6411 #: ../src/guestfs-actions.pod:1334 ../fish/guestfish-actions.pod:891
6413 "This command concatenates the list of C<words> passed with single spaces "
6414 "between them and returns the resulting string."
6418 #: ../src/guestfs-actions.pod:1337 ../fish/guestfish-actions.pod:894
6419 msgid "You can use this command to test the connection through to the daemon."
6423 #: ../src/guestfs-actions.pod:1339
6424 msgid "See also C<guestfs_ping_daemon>."
6428 #: ../src/guestfs-actions.pod:1344 ../src/guestfs-actions.pod:2071 ../src/guestfs-actions.pod:5620
6429 msgid "(Added in 1.0.69)"
6433 #: ../src/guestfs-actions.pod:1346
6434 msgid "guestfs_egrep"
6438 #: ../src/guestfs-actions.pod:1348
6442 " guestfs_egrep (guestfs_h *g,\n"
6443 " const char *regex,\n"
6444 " const char *path);\n"
6449 #: ../src/guestfs-actions.pod:1353 ../fish/guestfish-actions.pod:902
6450 msgid "This calls the external C<egrep> program and returns the matching lines."
6454 #: ../src/guestfs-actions.pod:1363 ../src/guestfs-actions.pod:1382 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1485 ../src/guestfs-actions.pod:1504 ../src/guestfs-actions.pod:2171 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2359 ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2442 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:3344 ../src/guestfs-actions.pod:3358 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3385 ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5984 ../src/guestfs-actions.pod:5996 ../src/guestfs-actions.pod:6009 ../src/guestfs-actions.pod:6022 ../src/guestfs-actions.pod:6044 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6070 ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6863 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:6967 ../src/guestfs-actions.pod:7013 ../src/guestfs-actions.pod:7032
6455 msgid "(Added in 1.0.66)"
6459 #: ../src/guestfs-actions.pod:1365
6460 msgid "guestfs_egrepi"
6464 #: ../src/guestfs-actions.pod:1367
6468 " guestfs_egrepi (guestfs_h *g,\n"
6469 " const char *regex,\n"
6470 " const char *path);\n"
6475 #: ../src/guestfs-actions.pod:1372 ../fish/guestfish-actions.pod:912
6476 msgid "This calls the external C<egrep -i> program and returns the matching lines."
6480 #: ../src/guestfs-actions.pod:1384
6481 msgid "guestfs_equal"
6485 #: ../src/guestfs-actions.pod:1386
6489 " guestfs_equal (guestfs_h *g,\n"
6490 " const char *file1,\n"
6491 " const char *file2);\n"
6496 #: ../src/guestfs-actions.pod:1391 ../fish/guestfish-actions.pod:922
6498 "This compares the two files C<file1> and C<file2> and returns true if their "
6499 "content is exactly equal, or false otherwise."
6503 #: ../src/guestfs-actions.pod:1394 ../fish/guestfish-actions.pod:925
6504 msgid "The external L<cmp(1)> program is used for the comparison."
6508 #: ../src/guestfs-actions.pod:1400
6509 msgid "guestfs_exists"
6513 #: ../src/guestfs-actions.pod:1402
6517 " guestfs_exists (guestfs_h *g,\n"
6518 " const char *path);\n"
6523 #: ../src/guestfs-actions.pod:1406 ../fish/guestfish-actions.pod:931
6525 "This returns C<true> if and only if there is a file, directory (or anything) "
6526 "with the given C<path> name."
6530 #: ../src/guestfs-actions.pod:1409
6531 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
6535 #: ../src/guestfs-actions.pod:1415
6536 msgid "guestfs_fallocate"
6540 #: ../src/guestfs-actions.pod:1417
6544 " guestfs_fallocate (guestfs_h *g,\n"
6545 " const char *path,\n"
6551 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:1448 ../fish/guestfish-actions.pod:940 ../fish/guestfish-actions.pod:959
6553 "This command preallocates a file (containing zero bytes) named C<path> of "
6554 "size C<len> bytes. If the file exists already, it is overwritten."
6558 #: ../src/guestfs-actions.pod:1426 ../fish/guestfish-actions.pod:944
6560 "Do not confuse this with the guestfish-specific C<alloc> command which "
6561 "allocates a file in the host and attaches it as a device."
6565 #: ../src/guestfs-actions.pod:1432 ../fish/guestfish-actions.pod:948
6567 "This function is deprecated. In new code, use the C<fallocate64> call "
6572 #: ../src/guestfs-actions.pod:1441
6573 msgid "guestfs_fallocate64"
6577 #: ../src/guestfs-actions.pod:1443
6581 " guestfs_fallocate64 (guestfs_h *g,\n"
6582 " const char *path,\n"
6588 #: ../src/guestfs-actions.pod:1452
6590 "Note that this call allocates disk blocks for the file. To create a sparse "
6591 "file use C<guestfs_truncate_size> instead."
6595 #: ../src/guestfs-actions.pod:1455
6597 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
6598 "oversight it only allowed 30 bit lengths to be specified, effectively "
6599 "limiting the maximum size of files created through that call to 1GB."
6603 #: ../src/guestfs-actions.pod:1460 ../fish/guestfish-actions.pod:971
6605 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6606 "commands which create a file in the host and attach it as a device."
6610 #: ../src/guestfs-actions.pod:1466
6611 msgid "(Added in 1.3.17)"
6615 #: ../src/guestfs-actions.pod:1468
6616 msgid "guestfs_fgrep"
6620 #: ../src/guestfs-actions.pod:1470
6624 " guestfs_fgrep (guestfs_h *g,\n"
6625 " const char *pattern,\n"
6626 " const char *path);\n"
6631 #: ../src/guestfs-actions.pod:1475 ../fish/guestfish-actions.pod:979
6632 msgid "This calls the external C<fgrep> program and returns the matching lines."
6636 #: ../src/guestfs-actions.pod:1487
6637 msgid "guestfs_fgrepi"
6641 #: ../src/guestfs-actions.pod:1489
6645 " guestfs_fgrepi (guestfs_h *g,\n"
6646 " const char *pattern,\n"
6647 " const char *path);\n"
6652 #: ../src/guestfs-actions.pod:1494 ../fish/guestfish-actions.pod:989
6653 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6657 #: ../src/guestfs-actions.pod:1506
6658 msgid "guestfs_file"
6662 #: ../src/guestfs-actions.pod:1508
6666 " guestfs_file (guestfs_h *g,\n"
6667 " const char *path);\n"
6672 #: ../src/guestfs-actions.pod:1512 ../fish/guestfish-actions.pod:999
6674 "This call uses the standard L<file(1)> command to determine the type or "
6675 "contents of the file."
6679 #: ../src/guestfs-actions.pod:1515 ../fish/guestfish-actions.pod:1002
6681 "This call will also transparently look inside various types of compressed "
6686 #: ../src/guestfs-actions.pod:1518 ../fish/guestfish-actions.pod:1005
6688 "The exact command which runs is C<file -zb path>. Note in particular that "
6689 "the filename is not prepended to the output (the C<-b> option)."
6693 #: ../src/guestfs-actions.pod:1522
6695 "This command can also be used on C</dev/> devices (and partitions, LV "
6696 "names). You can for example use this to determine if a device contains a "
6697 "filesystem, although it's usually better to use C<guestfs_vfs_type>."
6701 #: ../src/guestfs-actions.pod:1527 ../fish/guestfish-actions.pod:1014
6703 "If the C<path> does not begin with C</dev/> then this command only works for "
6704 "the content of regular files. For other file types (directory, symbolic "
6705 "link etc) it will just return the string C<directory> etc."
6709 #: ../src/guestfs-actions.pod:1537
6710 msgid "guestfs_file_architecture"
6714 #: ../src/guestfs-actions.pod:1539
6718 " guestfs_file_architecture (guestfs_h *g,\n"
6719 " const char *filename);\n"
6724 #: ../src/guestfs-actions.pod:1543 ../fish/guestfish-actions.pod:1023
6726 "This detects the architecture of the binary C<filename>, and returns it if "
6731 #: ../src/guestfs-actions.pod:1546 ../fish/guestfish-actions.pod:1026
6732 msgid "Currently defined architectures are:"
6736 #: ../src/guestfs-actions.pod:1550 ../fish/guestfish-actions.pod:1030
6741 #: ../src/guestfs-actions.pod:1552 ../fish/guestfish-actions.pod:1032
6743 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6744 "irrespective of the precise processor requirements of the binary."
6748 #: ../src/guestfs-actions.pod:1555 ../fish/guestfish-actions.pod:1035
6753 #: ../src/guestfs-actions.pod:1557 ../fish/guestfish-actions.pod:1037
6754 msgid "64 bit x86-64."
6758 #: ../src/guestfs-actions.pod:1559 ../fish/guestfish-actions.pod:1039
6763 #: ../src/guestfs-actions.pod:1561 ../fish/guestfish-actions.pod:1041
6764 msgid "32 bit SPARC."
6768 #: ../src/guestfs-actions.pod:1563 ../fish/guestfish-actions.pod:1043
6773 #: ../src/guestfs-actions.pod:1565 ../fish/guestfish-actions.pod:1045
6774 msgid "64 bit SPARC V9 and above."
6778 #: ../src/guestfs-actions.pod:1567 ../fish/guestfish-actions.pod:1047
6783 #: ../src/guestfs-actions.pod:1569 ../fish/guestfish-actions.pod:1049
6784 msgid "Intel Itanium."
6788 #: ../src/guestfs-actions.pod:1571 ../fish/guestfish-actions.pod:1051
6793 #: ../src/guestfs-actions.pod:1573 ../fish/guestfish-actions.pod:1053
6794 msgid "32 bit Power PC."
6798 #: ../src/guestfs-actions.pod:1575 ../fish/guestfish-actions.pod:1055
6803 #: ../src/guestfs-actions.pod:1577 ../fish/guestfish-actions.pod:1057
6804 msgid "64 bit Power PC."
6808 #: ../src/guestfs-actions.pod:1581 ../fish/guestfish-actions.pod:1061
6809 msgid "Libguestfs may return other architecture strings in future."
6813 #: ../src/guestfs-actions.pod:1583 ../fish/guestfish-actions.pod:1063
6814 msgid "The function works on at least the following types of files:"
6818 #: ../src/guestfs-actions.pod:1589 ../fish/guestfish-actions.pod:1069
6819 msgid "many types of Un*x and Linux binary"
6823 #: ../src/guestfs-actions.pod:1593 ../fish/guestfish-actions.pod:1073
6824 msgid "many types of Un*x and Linux shared library"
6828 #: ../src/guestfs-actions.pod:1597 ../fish/guestfish-actions.pod:1077
6829 msgid "Windows Win32 and Win64 binaries"
6833 #: ../src/guestfs-actions.pod:1601 ../fish/guestfish-actions.pod:1081
6834 msgid "Windows Win32 and Win64 DLLs"
6838 #: ../src/guestfs-actions.pod:1603 ../fish/guestfish-actions.pod:1083
6839 msgid "Win32 binaries and DLLs return C<i386>."
6843 #: ../src/guestfs-actions.pod:1605 ../fish/guestfish-actions.pod:1085
6844 msgid "Win64 binaries and DLLs return C<x86_64>."
6848 #: ../src/guestfs-actions.pod:1609 ../fish/guestfish-actions.pod:1089
6849 msgid "Linux kernel modules"
6853 #: ../src/guestfs-actions.pod:1613 ../fish/guestfish-actions.pod:1093
6854 msgid "Linux new-style initrd images"
6858 #: ../src/guestfs-actions.pod:1617 ../fish/guestfish-actions.pod:1097
6859 msgid "some non-x86 Linux vmlinuz kernels"
6863 #: ../src/guestfs-actions.pod:1621 ../fish/guestfish-actions.pod:1101
6864 msgid "What it can't do currently:"
6868 #: ../src/guestfs-actions.pod:1627 ../fish/guestfish-actions.pod:1107
6869 msgid "static libraries (libfoo.a)"
6873 #: ../src/guestfs-actions.pod:1631 ../fish/guestfish-actions.pod:1111
6874 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6878 #: ../src/guestfs-actions.pod:1635 ../fish/guestfish-actions.pod:1115
6879 msgid "x86 Linux vmlinuz kernels"
6883 #: ../src/guestfs-actions.pod:1637 ../fish/guestfish-actions.pod:1117
6885 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6886 "compressed code, and are horribly hard to unpack. If you want to find the "
6887 "architecture of a kernel, use the architecture of the associated initrd or "
6888 "kernel module(s) instead."
6892 #: ../src/guestfs-actions.pod:1647 ../src/guestfs-actions.pod:1810 ../src/guestfs-actions.pod:1827 ../src/guestfs-actions.pod:2478 ../src/guestfs-actions.pod:2559 ../src/guestfs-actions.pod:2585 ../src/guestfs-actions.pod:2632 ../src/guestfs-actions.pod:2653 ../src/guestfs-actions.pod:2686 ../src/guestfs-actions.pod:2766 ../src/guestfs-actions.pod:2826 ../src/guestfs-actions.pod:2997 ../src/guestfs-actions.pod:3129
6893 msgid "(Added in 1.5.3)"
6897 #: ../src/guestfs-actions.pod:1649
6898 msgid "guestfs_filesize"
6902 #: ../src/guestfs-actions.pod:1651
6906 " guestfs_filesize (guestfs_h *g,\n"
6907 " const char *file);\n"
6912 #: ../src/guestfs-actions.pod:1655 ../fish/guestfish-actions.pod:1128
6913 msgid "This command returns the size of C<file> in bytes."
6917 #: ../src/guestfs-actions.pod:1657
6919 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
6920 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
6921 "devices, use C<guestfs_blockdev_getsize64>."
6925 #: ../src/guestfs-actions.pod:1663
6926 msgid "(Added in 1.0.82)"
6930 #: ../src/guestfs-actions.pod:1665
6931 msgid "guestfs_fill"
6935 #: ../src/guestfs-actions.pod:1667
6939 " guestfs_fill (guestfs_h *g,\n"
6942 " const char *path);\n"
6947 #: ../src/guestfs-actions.pod:1673 ../fish/guestfish-actions.pod:1138
6949 "This command creates a new file called C<path>. The initial content of the "
6950 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6955 #: ../src/guestfs-actions.pod:1677
6957 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6958 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
6959 "bytes use C<guestfs_fill_pattern>."
6963 #: ../src/guestfs-actions.pod:1689
6964 msgid "(Added in 1.0.79)"
6968 #: ../src/guestfs-actions.pod:1691
6969 msgid "guestfs_fill_pattern"
6973 #: ../src/guestfs-actions.pod:1693
6977 " guestfs_fill_pattern (guestfs_h *g,\n"
6978 " const char *pattern,\n"
6980 " const char *path);\n"
6985 #: ../src/guestfs-actions.pod:1699
6987 "This function is like C<guestfs_fill> except that it creates a new file of "
6988 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
6989 "pattern is truncated if necessary to ensure the length of the file is "
6990 "exactly C<len> bytes."
6994 #: ../src/guestfs-actions.pod:1711
6995 msgid "(Added in 1.3.12)"
6999 #: ../src/guestfs-actions.pod:1713
7000 msgid "guestfs_find"
7004 #: ../src/guestfs-actions.pod:1715
7008 " guestfs_find (guestfs_h *g,\n"
7009 " const char *directory);\n"
7014 #: ../src/guestfs-actions.pod:1719 ../fish/guestfish-actions.pod:1160
7016 "This command lists out all files and directories, recursively, starting at "
7017 "C<directory>. It is essentially equivalent to running the shell command "
7018 "C<find directory -print> but some post-processing happens on the output, "
7023 #: ../src/guestfs-actions.pod:1724 ../fish/guestfish-actions.pod:1165
7025 "This returns a list of strings I<without any prefix>. Thus if the directory "
7030 #: ../src/guestfs-actions.pod:1727 ../fish/guestfish-actions.pod:1168
7040 #: ../src/guestfs-actions.pod:1731
7041 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
7045 #: ../src/guestfs-actions.pod:1734 ../fish/guestfish-actions.pod:1175
7056 #: ../src/guestfs-actions.pod:1739 ../fish/guestfish-actions.pod:1180
7057 msgid "If C<directory> is not a directory, then this command returns an error."
7061 #: ../src/guestfs-actions.pod:1742 ../fish/guestfish-actions.pod:1183
7062 msgid "The returned list is sorted."
7066 #: ../src/guestfs-actions.pod:1744
7067 msgid "See also C<guestfs_find0>."
7071 #: ../src/guestfs-actions.pod:1753 ../src/guestfs-actions.pod:3788 ../src/guestfs-actions.pod:5249
7072 msgid "(Added in 1.0.27)"
7076 #: ../src/guestfs-actions.pod:1755
7077 msgid "guestfs_find0"
7081 #: ../src/guestfs-actions.pod:1757
7085 " guestfs_find0 (guestfs_h *g,\n"
7086 " const char *directory,\n"
7087 " const char *files);\n"
7092 #: ../src/guestfs-actions.pod:1762 ../fish/guestfish-actions.pod:1194
7094 "This command lists out all files and directories, recursively, starting at "
7095 "C<directory>, placing the resulting list in the external file called "
7100 #: ../src/guestfs-actions.pod:1766
7102 "This command works the same way as C<guestfs_find> with the following "
7107 #: ../src/guestfs-actions.pod:1773 ../fish/guestfish-actions.pod:1205
7108 msgid "The resulting list is written to an external file."
7112 #: ../src/guestfs-actions.pod:1777 ../fish/guestfish-actions.pod:1209
7114 "Items (filenames) in the result are separated by C<\\0> characters. See "
7115 "L<find(1)> option I<-print0>."
7119 #: ../src/guestfs-actions.pod:1782 ../fish/guestfish-actions.pod:1214
7120 msgid "This command is not limited in the number of names that it can return."
7124 #: ../src/guestfs-actions.pod:1787 ../fish/guestfish-actions.pod:1219
7125 msgid "The result list is not sorted."
7129 #: ../src/guestfs-actions.pod:1793
7130 msgid "(Added in 1.0.74)"
7134 #: ../src/guestfs-actions.pod:1795
7135 msgid "guestfs_findfs_label"
7139 #: ../src/guestfs-actions.pod:1797
7143 " guestfs_findfs_label (guestfs_h *g,\n"
7144 " const char *label);\n"
7149 #: ../src/guestfs-actions.pod:1801 ../fish/guestfish-actions.pod:1229
7151 "This command searches the filesystems and returns the one which has the "
7152 "given label. An error is returned if no such filesystem can be found."
7156 #: ../src/guestfs-actions.pod:1805
7157 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
7161 #: ../src/guestfs-actions.pod:1812
7162 msgid "guestfs_findfs_uuid"
7166 #: ../src/guestfs-actions.pod:1814
7170 " guestfs_findfs_uuid (guestfs_h *g,\n"
7171 " const char *uuid);\n"
7176 #: ../src/guestfs-actions.pod:1818 ../fish/guestfish-actions.pod:1239
7178 "This command searches the filesystems and returns the one which has the "
7179 "given UUID. An error is returned if no such filesystem can be found."
7183 #: ../src/guestfs-actions.pod:1822
7184 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
7188 #: ../src/guestfs-actions.pod:1829
7189 msgid "guestfs_fsck"
7193 #: ../src/guestfs-actions.pod:1831
7197 " guestfs_fsck (guestfs_h *g,\n"
7198 " const char *fstype,\n"
7199 " const char *device);\n"
7204 #: ../src/guestfs-actions.pod:1836 ../fish/guestfish-actions.pod:1249
7206 "This runs the filesystem checker (fsck) on C<device> which should have "
7207 "filesystem type C<fstype>."
7211 #: ../src/guestfs-actions.pod:1839 ../fish/guestfish-actions.pod:1252
7213 "The returned integer is the status. See L<fsck(8)> for the list of status "
7214 "codes from C<fsck>."
7218 #: ../src/guestfs-actions.pod:1848 ../fish/guestfish-actions.pod:1261
7219 msgid "Multiple status codes can be summed together."
7223 #: ../src/guestfs-actions.pod:1852 ../fish/guestfish-actions.pod:1265
7225 "A non-zero return code can mean \"success\", for example if errors have been "
7226 "corrected on the filesystem."
7230 #: ../src/guestfs-actions.pod:1857 ../fish/guestfish-actions.pod:1270
7231 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
7235 #: ../src/guestfs-actions.pod:1862 ../fish/guestfish-actions.pod:1275
7236 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
7240 #: ../src/guestfs-actions.pod:1866 ../src/guestfs-actions.pod:6886
7241 msgid "(Added in 1.0.16)"
7245 #: ../src/guestfs-actions.pod:1868
7246 msgid "guestfs_get_append"
7250 #: ../src/guestfs-actions.pod:1870
7254 " guestfs_get_append (guestfs_h *g);\n"
7259 #: ../src/guestfs-actions.pod:1873 ../fish/guestfish-actions.pod:1281
7261 "Return the additional kernel options which are added to the guest kernel "
7266 #: ../src/guestfs-actions.pod:1876 ../fish/guestfish-actions.pod:1284
7267 msgid "If C<NULL> then no options are added."
7271 #: ../src/guestfs-actions.pod:1878
7273 "This function returns a string which may be NULL. There is no way to return "
7274 "an error from this function. The string is owned by the guest handle and "
7275 "must I<not> be freed."
7279 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:4927 ../src/guestfs-actions.pod:5390 ../src/guestfs-actions.pod:5758 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5793 ../src/guestfs-actions.pod:5810 ../src/guestfs-actions.pod:6557 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6929
7280 msgid "(Added in 1.0.26)"
7284 #: ../src/guestfs-actions.pod:1884
7285 msgid "guestfs_get_autosync"
7289 #: ../src/guestfs-actions.pod:1886
7293 " guestfs_get_autosync (guestfs_h *g);\n"
7298 #: ../src/guestfs-actions.pod:1889 ../fish/guestfish-actions.pod:1290
7299 msgid "Get the autosync flag."
7303 #: ../src/guestfs-actions.pod:1895
7304 msgid "guestfs_get_direct"
7308 #: ../src/guestfs-actions.pod:1897
7312 " guestfs_get_direct (guestfs_h *g);\n"
7317 #: ../src/guestfs-actions.pod:1900 ../fish/guestfish-actions.pod:1296
7318 msgid "Return the direct appliance mode flag."
7322 #: ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:5431
7323 msgid "(Added in 1.0.72)"
7327 #: ../src/guestfs-actions.pod:1906
7328 msgid "guestfs_get_e2label"
7332 #: ../src/guestfs-actions.pod:1908
7336 " guestfs_get_e2label (guestfs_h *g,\n"
7337 " const char *device);\n"
7342 #: ../src/guestfs-actions.pod:1912 ../fish/guestfish-actions.pod:1302
7343 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
7347 #: ../src/guestfs-actions.pod:1918 ../fish/guestfish-actions.pod:1305
7349 "This function is deprecated. In new code, use the C<vfs_label> call "
7354 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5468
7355 msgid "(Added in 1.0.15)"
7359 #: ../src/guestfs-actions.pod:1927
7360 msgid "guestfs_get_e2uuid"
7364 #: ../src/guestfs-actions.pod:1929
7368 " guestfs_get_e2uuid (guestfs_h *g,\n"
7369 " const char *device);\n"
7374 #: ../src/guestfs-actions.pod:1933 ../fish/guestfish-actions.pod:1316
7375 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
7379 #: ../src/guestfs-actions.pod:1939 ../fish/guestfish-actions.pod:1319
7380 msgid "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
7384 #: ../src/guestfs-actions.pod:1948
7385 msgid "guestfs_get_memsize"
7389 #: ../src/guestfs-actions.pod:1950
7393 " guestfs_get_memsize (guestfs_h *g);\n"
7398 #: ../src/guestfs-actions.pod:1953 ../fish/guestfish-actions.pod:1330
7399 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
7403 #: ../src/guestfs-actions.pod:1956
7405 "If C<guestfs_set_memsize> was not called on this handle, and if "
7406 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
7407 "value for memsize."
7411 #: ../src/guestfs-actions.pod:1960 ../src/guestfs-actions.pod:2041 ../src/guestfs-actions.pod:5484 ../src/guestfs-actions.pod:5591 ../fish/guestfish-actions.pod:1337 ../fish/guestfish-actions.pod:1388 ../fish/guestfish-actions.pod:3680 ../fish/guestfish-actions.pod:3767
7412 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
7416 #: ../src/guestfs-actions.pod:1965 ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4213 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4261 ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5732 ../src/guestfs-actions.pod:6333
7417 msgid "(Added in 1.0.55)"
7421 #: ../src/guestfs-actions.pod:1967
7422 msgid "guestfs_get_network"
7426 #: ../src/guestfs-actions.pod:1969
7430 " guestfs_get_network (guestfs_h *g);\n"
7435 #: ../src/guestfs-actions.pod:1972 ../fish/guestfish-actions.pod:1344
7436 msgid "This returns the enable network flag."
7440 #: ../src/guestfs-actions.pod:1976 ../src/guestfs-actions.pod:5508
7441 msgid "(Added in 1.5.4)"
7445 #: ../src/guestfs-actions.pod:1978
7446 msgid "guestfs_get_path"
7450 #: ../src/guestfs-actions.pod:1980
7454 " guestfs_get_path (guestfs_h *g);\n"
7459 #: ../src/guestfs-actions.pod:1983 ../fish/guestfish-actions.pod:1350
7460 msgid "Return the current search path."
7464 #: ../src/guestfs-actions.pod:1985 ../fish/guestfish-actions.pod:1352
7466 "This is always non-NULL. If it wasn't set already, then this will return "
7471 #: ../src/guestfs-actions.pod:1988 ../src/guestfs-actions.pod:2017
7473 "This function returns a string, or NULL on error. The string is owned by "
7474 "the guest handle and must I<not> be freed."
7478 #: ../src/guestfs-actions.pod:1993
7479 msgid "guestfs_get_pid"
7483 #: ../src/guestfs-actions.pod:1995
7487 " guestfs_get_pid (guestfs_h *g);\n"
7492 #: ../src/guestfs-actions.pod:1998 ../fish/guestfish-actions.pod:1361
7494 "Return the process ID of the qemu subprocess. If there is no qemu "
7495 "subprocess, then this will return an error."
7499 #: ../src/guestfs-actions.pod:2001 ../fish/guestfish-actions.pod:1364
7500 msgid "This is an internal call used for debugging and testing."
7504 #: ../src/guestfs-actions.pod:2005
7505 msgid "(Added in 1.0.56)"
7509 #: ../src/guestfs-actions.pod:2007
7510 msgid "guestfs_get_qemu"
7514 #: ../src/guestfs-actions.pod:2009
7518 " guestfs_get_qemu (guestfs_h *g);\n"
7523 #: ../src/guestfs-actions.pod:2012 ../fish/guestfish-actions.pod:1370
7524 msgid "Return the current qemu binary."
7528 #: ../src/guestfs-actions.pod:2014 ../fish/guestfish-actions.pod:1372
7530 "This is always non-NULL. If it wasn't set already, then this will return "
7531 "the default qemu binary name."
7535 #: ../src/guestfs-actions.pod:2020 ../src/guestfs-actions.pod:5553
7536 msgid "(Added in 1.0.6)"
7540 #: ../src/guestfs-actions.pod:2022
7541 msgid "guestfs_get_recovery_proc"
7545 #: ../src/guestfs-actions.pod:2024
7549 " guestfs_get_recovery_proc (guestfs_h *g);\n"
7554 #: ../src/guestfs-actions.pod:2027 ../fish/guestfish-actions.pod:1379
7555 msgid "Return the recovery process enabled flag."
7559 #: ../src/guestfs-actions.pod:2031 ../src/guestfs-actions.pod:3219 ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3886 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:4857 ../src/guestfs-actions.pod:5200 ../src/guestfs-actions.pod:5577 ../src/guestfs-actions.pod:6236 ../src/guestfs-actions.pod:6256 ../src/guestfs-actions.pod:6438
7560 msgid "(Added in 1.0.77)"
7564 #: ../src/guestfs-actions.pod:2033
7565 msgid "guestfs_get_selinux"
7569 #: ../src/guestfs-actions.pod:2035
7573 " guestfs_get_selinux (guestfs_h *g);\n"
7578 #: ../src/guestfs-actions.pod:2038
7580 "This returns the current setting of the selinux flag which is passed to the "
7581 "appliance at boot time. See C<guestfs_set_selinux>."
7585 #: ../src/guestfs-actions.pod:2046 ../src/guestfs-actions.pod:2109 ../src/guestfs-actions.pod:5596 ../src/guestfs-actions.pod:5650
7586 msgid "(Added in 1.0.67)"
7590 #: ../src/guestfs-actions.pod:2048
7591 msgid "guestfs_get_state"
7595 #: ../src/guestfs-actions.pod:2050
7599 " guestfs_get_state (guestfs_h *g);\n"
7604 #: ../src/guestfs-actions.pod:2053 ../fish/guestfish-actions.pod:1395
7606 "This returns the current state as an opaque integer. This is only useful "
7607 "for printing debug and internal error messages."
7611 #: ../src/guestfs-actions.pod:2056 ../src/guestfs-actions.pod:3022 ../src/guestfs-actions.pod:3051 ../src/guestfs-actions.pod:3112 ../src/guestfs-actions.pod:3139 ../fish/guestfish-actions.pod:1398 ../fish/guestfish-actions.pod:2113 ../fish/guestfish-actions.pod:2131 ../fish/guestfish-actions.pod:2169 ../fish/guestfish-actions.pod:2185
7612 msgid "For more information on states, see L<guestfs(3)>."
7616 #: ../src/guestfs-actions.pod:2062
7617 msgid "guestfs_get_trace"
7621 #: ../src/guestfs-actions.pod:2064
7625 " guestfs_get_trace (guestfs_h *g);\n"
7630 #: ../src/guestfs-actions.pod:2067 ../fish/guestfish-actions.pod:1404
7631 msgid "Return the command trace flag."
7635 #: ../src/guestfs-actions.pod:2073
7636 msgid "guestfs_get_umask"
7640 #: ../src/guestfs-actions.pod:2075
7644 " guestfs_get_umask (guestfs_h *g);\n"
7649 #: ../src/guestfs-actions.pod:2078
7651 "Return the current umask. By default the umask is C<022> unless it has been "
7652 "set by calling C<guestfs_umask>."
7656 #: ../src/guestfs-actions.pod:2085
7657 msgid "guestfs_get_verbose"
7661 #: ../src/guestfs-actions.pod:2087
7665 " guestfs_get_verbose (guestfs_h *g);\n"
7670 #: ../src/guestfs-actions.pod:2090 ../fish/guestfish-actions.pod:1417
7671 msgid "This returns the verbose messages flag."
7675 #: ../src/guestfs-actions.pod:2096
7676 msgid "guestfs_getcon"
7680 #: ../src/guestfs-actions.pod:2098
7684 " guestfs_getcon (guestfs_h *g);\n"
7689 #: ../src/guestfs-actions.pod:2101 ../fish/guestfish-actions.pod:1423
7690 msgid "This gets the SELinux security context of the daemon."
7694 #: ../src/guestfs-actions.pod:2103
7695 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
7699 #: ../src/guestfs-actions.pod:2111
7700 msgid "guestfs_getxattrs"
7704 #: ../src/guestfs-actions.pod:2113
7707 " struct guestfs_xattr_list *\n"
7708 " guestfs_getxattrs (guestfs_h *g,\n"
7709 " const char *path);\n"
7714 #: ../src/guestfs-actions.pod:2117 ../fish/guestfish-actions.pod:1432
7715 msgid "This call lists the extended attributes of the file or directory C<path>."
7719 #: ../src/guestfs-actions.pod:2120 ../fish/guestfish-actions.pod:1435
7721 "At the system call level, this is a combination of the L<listxattr(2)> and "
7722 "L<getxattr(2)> calls."
7726 #: ../src/guestfs-actions.pod:2123
7727 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
7731 #: ../src/guestfs-actions.pod:2125 ../src/guestfs-actions.pod:3231 ../src/guestfs-actions.pod:3882
7733 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
7734 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
7738 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3235 ../src/guestfs-actions.pod:3400 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:5230 ../src/guestfs-actions.pod:5669 ../src/guestfs-actions.pod:6994
7739 msgid "(Added in 1.0.59)"
7743 #: ../src/guestfs-actions.pod:2131
7744 msgid "guestfs_glob_expand"
7748 #: ../src/guestfs-actions.pod:2133
7752 " guestfs_glob_expand (guestfs_h *g,\n"
7753 " const char *pattern);\n"
7758 #: ../src/guestfs-actions.pod:2137 ../fish/guestfish-actions.pod:1444
7760 "This command searches for all the pathnames matching C<pattern> according to "
7761 "the wildcard expansion rules used by the shell."
7765 #: ../src/guestfs-actions.pod:2141 ../fish/guestfish-actions.pod:1448
7766 msgid "If no paths match, then this returns an empty list (note: not an error)."
7770 #: ../src/guestfs-actions.pod:2144 ../fish/guestfish-actions.pod:1451
7772 "It is just a wrapper around the C L<glob(3)> function with flags "
7773 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7777 #: ../src/guestfs-actions.pod:2152 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:5851
7778 msgid "(Added in 1.0.50)"
7782 #: ../src/guestfs-actions.pod:2154
7783 msgid "guestfs_grep"
7787 #: ../src/guestfs-actions.pod:2156
7791 " guestfs_grep (guestfs_h *g,\n"
7792 " const char *regex,\n"
7793 " const char *path);\n"
7798 #: ../src/guestfs-actions.pod:2161 ../fish/guestfish-actions.pod:1459
7799 msgid "This calls the external C<grep> program and returns the matching lines."
7803 #: ../src/guestfs-actions.pod:2173
7804 msgid "guestfs_grepi"
7808 #: ../src/guestfs-actions.pod:2175
7812 " guestfs_grepi (guestfs_h *g,\n"
7813 " const char *regex,\n"
7814 " const char *path);\n"
7819 #: ../src/guestfs-actions.pod:2180 ../fish/guestfish-actions.pod:1469
7820 msgid "This calls the external C<grep -i> program and returns the matching lines."
7824 #: ../src/guestfs-actions.pod:2192
7825 msgid "guestfs_grub_install"
7829 #: ../src/guestfs-actions.pod:2194
7833 " guestfs_grub_install (guestfs_h *g,\n"
7834 " const char *root,\n"
7835 " const char *device);\n"
7840 #: ../src/guestfs-actions.pod:2199 ../fish/guestfish-actions.pod:1479
7842 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
7843 "the root directory being C<root>."
7847 #: ../src/guestfs-actions.pod:2202 ../fish/guestfish-actions.pod:1482
7849 "Note: If grub-install reports the error \"No suitable drive was found in the "
7850 "generated device map.\" it may be that you need to create a "
7851 "C</boot/grub/device.map> file first that contains the mapping between grub "
7852 "device names and Linux device names. It is usually sufficient to create a "
7857 #: ../src/guestfs-actions.pod:2209 ../fish/guestfish-actions.pod:1489
7865 #: ../src/guestfs-actions.pod:2211 ../fish/guestfish-actions.pod:1491
7866 msgid "replacing C</dev/vda> with the name of the installation device."
7870 #: ../src/guestfs-actions.pod:2215
7871 msgid "(Added in 1.0.17)"
7875 #: ../src/guestfs-actions.pod:2217
7876 msgid "guestfs_head"
7880 #: ../src/guestfs-actions.pod:2219
7884 " guestfs_head (guestfs_h *g,\n"
7885 " const char *path);\n"
7890 #: ../src/guestfs-actions.pod:2223 ../fish/guestfish-actions.pod:1497
7892 "This command returns up to the first 10 lines of a file as a list of "
7897 #: ../src/guestfs-actions.pod:2235
7898 msgid "guestfs_head_n"
7902 #: ../src/guestfs-actions.pod:2237
7906 " guestfs_head_n (guestfs_h *g,\n"
7908 " const char *path);\n"
7913 #: ../src/guestfs-actions.pod:2242 ../fish/guestfish-actions.pod:1507
7915 "If the parameter C<nrlines> is a positive number, this returns the first "
7916 "C<nrlines> lines of the file C<path>."
7920 #: ../src/guestfs-actions.pod:2245 ../fish/guestfish-actions.pod:1510
7922 "If the parameter C<nrlines> is a negative number, this returns lines from "
7923 "the file C<path>, excluding the last C<nrlines> lines."
7927 #: ../src/guestfs-actions.pod:2248 ../src/guestfs-actions.pod:6131 ../fish/guestfish-actions.pod:1513 ../fish/guestfish-actions.pod:4113
7928 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7932 #: ../src/guestfs-actions.pod:2259
7933 msgid "guestfs_hexdump"
7937 #: ../src/guestfs-actions.pod:2261
7941 " guestfs_hexdump (guestfs_h *g,\n"
7942 " const char *path);\n"
7947 #: ../src/guestfs-actions.pod:2265 ../fish/guestfish-actions.pod:1522
7949 "This runs C<hexdump -C> on the given C<path>. The result is the "
7950 "human-readable, canonical hex dump of the file."
7954 #: ../src/guestfs-actions.pod:2274 ../src/guestfs-actions.pod:5915 ../src/guestfs-actions.pod:5970
7955 msgid "(Added in 1.0.22)"
7959 #: ../src/guestfs-actions.pod:2276
7960 msgid "guestfs_initrd_cat"
7964 #: ../src/guestfs-actions.pod:2278
7968 " guestfs_initrd_cat (guestfs_h *g,\n"
7969 " const char *initrdpath,\n"
7970 " const char *filename,\n"
7971 " size_t *size_r);\n"
7976 #: ../src/guestfs-actions.pod:2284 ../fish/guestfish-actions.pod:1532
7978 "This command unpacks the file C<filename> from the initrd file called "
7979 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7984 #: ../src/guestfs-actions.pod:2288 ../fish/guestfish-actions.pod:1536
7986 "For example, in guestfish you could use the following command to examine the "
7987 "boot script (usually called C</init>) contained in a Linux initrd or "
7992 #: ../src/guestfs-actions.pod:2292 ../fish/guestfish-actions.pod:1540
7995 " initrd-cat /boot/initrd-<version>.img init\n"
8000 #: ../src/guestfs-actions.pod:2294
8001 msgid "See also C<guestfs_initrd_list>."
8005 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:4850 ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:5057
8007 "This function returns a buffer, or NULL on error. The size of the returned "
8008 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
8013 #: ../src/guestfs-actions.pod:2305
8014 msgid "guestfs_initrd_list"
8018 #: ../src/guestfs-actions.pod:2307
8022 " guestfs_initrd_list (guestfs_h *g,\n"
8023 " const char *path);\n"
8028 #: ../src/guestfs-actions.pod:2311 ../fish/guestfish-actions.pod:1551
8029 msgid "This command lists out files contained in an initrd."
8033 #: ../src/guestfs-actions.pod:2313 ../fish/guestfish-actions.pod:1553
8035 "The files are listed without any initial C</> character. The files are "
8036 "listed in the order they appear (not necessarily alphabetical). Directory "
8037 "names are listed as separate items."
8041 #: ../src/guestfs-actions.pod:2317 ../fish/guestfish-actions.pod:1557
8043 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
8044 "initrd. We I<only> support the newer initramfs format (compressed cpio "
8049 #: ../src/guestfs-actions.pod:2327
8050 msgid "guestfs_inotify_add_watch"
8054 #: ../src/guestfs-actions.pod:2329
8058 " guestfs_inotify_add_watch (guestfs_h *g,\n"
8059 " const char *path,\n"
8065 #: ../src/guestfs-actions.pod:2334 ../fish/guestfish-actions.pod:1565
8066 msgid "Watch C<path> for the events listed in C<mask>."
8070 #: ../src/guestfs-actions.pod:2336 ../fish/guestfish-actions.pod:1567
8072 "Note that if C<path> is a directory then events within that directory are "
8073 "watched, but this does I<not> happen recursively (in subdirectories)."
8077 #: ../src/guestfs-actions.pod:2340 ../fish/guestfish-actions.pod:1571
8079 "Note for non-C or non-Linux callers: the inotify events are defined by the "
8080 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
8084 #: ../src/guestfs-actions.pod:2348
8085 msgid "guestfs_inotify_close"
8089 #: ../src/guestfs-actions.pod:2350
8093 " guestfs_inotify_close (guestfs_h *g);\n"
8098 #: ../src/guestfs-actions.pod:2353 ../fish/guestfish-actions.pod:1579
8100 "This closes the inotify handle which was previously opened by inotify_init. "
8101 "It removes all watches, throws away any pending events, and deallocates all "
8106 #: ../src/guestfs-actions.pod:2361
8107 msgid "guestfs_inotify_files"
8111 #: ../src/guestfs-actions.pod:2363
8115 " guestfs_inotify_files (guestfs_h *g);\n"
8120 #: ../src/guestfs-actions.pod:2366
8122 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
8123 "returns a list of pathnames of objects that were touched. The returned "
8124 "pathnames are sorted and deduplicated."
8128 #: ../src/guestfs-actions.pod:2376
8129 msgid "guestfs_inotify_init"
8133 #: ../src/guestfs-actions.pod:2378
8137 " guestfs_inotify_init (guestfs_h *g,\n"
8138 " int maxevents);\n"
8143 #: ../src/guestfs-actions.pod:2382 ../fish/guestfish-actions.pod:1595
8145 "This command creates a new inotify handle. The inotify subsystem can be "
8146 "used to notify events which happen to objects in the guest filesystem."
8150 #: ../src/guestfs-actions.pod:2386
8152 "C<maxevents> is the maximum number of events which will be queued up between "
8153 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
8154 "passed as C<0>, then the kernel (or previously set) default is used. For "
8155 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
8156 "throws away events, but records the fact that it threw them away by setting "
8157 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
8158 "C<guestfs_inotify_read>)."
8162 #: ../src/guestfs-actions.pod:2396
8164 "Before any events are generated, you have to add some watches to the "
8165 "internal watch list. See: C<guestfs_inotify_add_watch>, "
8166 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
8170 #: ../src/guestfs-actions.pod:2402
8172 "Queued up events should be read periodically by calling "
8173 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
8174 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
8175 "often enough then you risk the internal queue overflowing."
8179 #: ../src/guestfs-actions.pod:2409
8181 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
8182 "This also removes any watches automatically."
8186 #: ../src/guestfs-actions.pod:2413 ../fish/guestfish-actions.pod:1626
8188 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
8189 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
8190 "that there is one global inotify handle per libguestfs instance."
8194 #: ../src/guestfs-actions.pod:2422
8195 msgid "guestfs_inotify_read"
8199 #: ../src/guestfs-actions.pod:2424
8202 " struct guestfs_inotify_event_list *\n"
8203 " guestfs_inotify_read (guestfs_h *g);\n"
8208 #: ../src/guestfs-actions.pod:2427 ../fish/guestfish-actions.pod:1635
8210 "Return the complete queue of events that have happened since the previous "
8215 #: ../src/guestfs-actions.pod:2430 ../fish/guestfish-actions.pod:1638
8216 msgid "If no events have happened, this returns an empty list."
8220 #: ../src/guestfs-actions.pod:2432 ../fish/guestfish-actions.pod:1640
8222 "I<Note>: In order to make sure that all events have been read, you must call "
8223 "this function repeatedly until it returns an empty list. The reason is that "
8224 "the call will read events up to the maximum appliance-to-host message size "
8225 "and leave remaining events in the queue."
8229 #: ../src/guestfs-actions.pod:2438
8231 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
8232 "there was an error. I<The caller must call "
8233 "C<guestfs_free_inotify_event_list> after use>."
8237 #: ../src/guestfs-actions.pod:2444
8238 msgid "guestfs_inotify_rm_watch"
8242 #: ../src/guestfs-actions.pod:2446
8246 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
8252 #: ../src/guestfs-actions.pod:2450
8254 "Remove a previously defined inotify watch. See "
8255 "C<guestfs_inotify_add_watch>."
8259 #: ../src/guestfs-actions.pod:2457
8260 msgid "guestfs_inspect_get_arch"
8264 #: ../src/guestfs-actions.pod:2459
8268 " guestfs_inspect_get_arch (guestfs_h *g,\n"
8269 " const char *root);\n"
8274 #: ../src/guestfs-actions.pod:2463 ../src/guestfs-actions.pod:2486 ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:2593 ../src/guestfs-actions.pod:2613 ../src/guestfs-actions.pod:2640 ../src/guestfs-actions.pod:2661 ../src/guestfs-actions.pod:2694 ../src/guestfs-actions.pod:2721 ../src/guestfs-actions.pod:2750 ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2834 ../src/guestfs-actions.pod:2857
8276 "This function should only be called with a root device string as returned by "
8277 "C<guestfs_inspect_os>."
8281 #: ../src/guestfs-actions.pod:2466
8283 "This returns the architecture of the inspected operating system. The "
8284 "possible return values are listed under C<guestfs_file_architecture>."
8288 #: ../src/guestfs-actions.pod:2470 ../fish/guestfish-actions.pod:1664
8290 "If the architecture could not be determined, then the string C<unknown> is "
8295 #: ../src/guestfs-actions.pod:2473 ../src/guestfs-actions.pod:2554 ../src/guestfs-actions.pod:2602 ../src/guestfs-actions.pod:2628 ../src/guestfs-actions.pod:2710 ../src/guestfs-actions.pod:2739 ../src/guestfs-actions.pod:2761 ../src/guestfs-actions.pod:2780 ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2844 ../src/guestfs-actions.pod:2950 ../src/guestfs-actions.pod:2989 ../fish/guestfish-actions.pod:1667 ../fish/guestfish-actions.pod:1741 ../fish/guestfish-actions.pod:1774 ../fish/guestfish-actions.pod:1795 ../fish/guestfish-actions.pod:1855 ../fish/guestfish-actions.pod:1879 ../fish/guestfish-actions.pod:1896 ../fish/guestfish-actions.pod:1909 ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1960 ../fish/guestfish-actions.pod:2059 ../fish/guestfish-actions.pod:2093
8296 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
8300 #: ../src/guestfs-actions.pod:2480
8301 msgid "guestfs_inspect_get_distro"
8305 #: ../src/guestfs-actions.pod:2482
8309 " guestfs_inspect_get_distro (guestfs_h *g,\n"
8310 " const char *root);\n"
8315 #: ../src/guestfs-actions.pod:2489 ../fish/guestfish-actions.pod:1676
8316 msgid "This returns the distro (distribution) of the inspected operating system."
8320 #: ../src/guestfs-actions.pod:2492 ../fish/guestfish-actions.pod:1679
8321 msgid "Currently defined distros are:"
8325 #: ../src/guestfs-actions.pod:2496 ../fish/guestfish-actions.pod:1683
8326 msgid "\"archlinux\""
8330 #: ../src/guestfs-actions.pod:2498 ../fish/guestfish-actions.pod:1685
8335 #: ../src/guestfs-actions.pod:2500 ../fish/guestfish-actions.pod:1687
8340 #: ../src/guestfs-actions.pod:2502 ../fish/guestfish-actions.pod:1689
8345 #: ../src/guestfs-actions.pod:2504 ../fish/guestfish-actions.pod:1691
8350 #: ../src/guestfs-actions.pod:2506 ../fish/guestfish-actions.pod:1693
8355 #: ../src/guestfs-actions.pod:2508 ../fish/guestfish-actions.pod:1695
8360 #: ../src/guestfs-actions.pod:2510 ../fish/guestfish-actions.pod:1697
8365 #: ../src/guestfs-actions.pod:2512 ../fish/guestfish-actions.pod:1699
8366 msgid "\"linuxmint\""
8370 #: ../src/guestfs-actions.pod:2514 ../fish/guestfish-actions.pod:1701
8375 #: ../src/guestfs-actions.pod:2516 ../fish/guestfish-actions.pod:1703
8376 msgid "\"mandriva\""
8380 #: ../src/guestfs-actions.pod:2518 ../fish/guestfish-actions.pod:1705
8385 #: ../src/guestfs-actions.pod:2520 ../fish/guestfish-actions.pod:1707
8390 #: ../src/guestfs-actions.pod:2522 ../fish/guestfish-actions.pod:1709
8395 #: ../src/guestfs-actions.pod:2524 ../fish/guestfish-actions.pod:1711
8400 #: ../src/guestfs-actions.pod:2526 ../fish/guestfish-actions.pod:1713
8405 #: ../src/guestfs-actions.pod:2528 ../fish/guestfish-actions.pod:1715
8406 msgid "\"redhat-based\""
8410 #: ../src/guestfs-actions.pod:2530 ../fish/guestfish-actions.pod:1717
8411 msgid "Some Red Hat-derived distro."
8415 #: ../src/guestfs-actions.pod:2532 ../fish/guestfish-actions.pod:1719
8420 #: ../src/guestfs-actions.pod:2534 ../fish/guestfish-actions.pod:1721
8421 msgid "Red Hat Enterprise Linux and some derivatives."
8425 #: ../src/guestfs-actions.pod:2536 ../fish/guestfish-actions.pod:1723
8430 #: ../src/guestfs-actions.pod:2538 ../fish/guestfish-actions.pod:1725
8435 #: ../src/guestfs-actions.pod:2540 ../src/guestfs-actions.pod:2812 ../fish/guestfish-actions.pod:1727 ../fish/guestfish-actions.pod:1935
8440 #: ../src/guestfs-actions.pod:2542 ../fish/guestfish-actions.pod:1729
8441 msgid "The distro could not be determined."
8445 #: ../src/guestfs-actions.pod:2544 ../src/guestfs-actions.pod:2804 ../fish/guestfish-actions.pod:1731 ../fish/guestfish-actions.pod:1927
8450 #: ../src/guestfs-actions.pod:2546 ../fish/guestfish-actions.pod:1733
8452 "Windows does not have distributions. This string is returned if the OS type "
8457 #: ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2818 ../fish/guestfish-actions.pod:1738 ../fish/guestfish-actions.pod:1941
8459 "Future versions of libguestfs may return other strings here. The caller "
8460 "should be prepared to handle any string."
8464 #: ../src/guestfs-actions.pod:2561
8465 msgid "guestfs_inspect_get_filesystems"
8469 #: ../src/guestfs-actions.pod:2563
8473 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
8474 " const char *root);\n"
8479 #: ../src/guestfs-actions.pod:2570 ../fish/guestfish-actions.pod:1750
8481 "This returns a list of all the filesystems that we think are associated with "
8482 "this operating system. This includes the root filesystem, other ordinary "
8483 "filesystems, and non-mounted devices like swap partitions."
8487 #: ../src/guestfs-actions.pod:2575 ../fish/guestfish-actions.pod:1755
8489 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
8490 "to be shared between operating systems."
8494 #: ../src/guestfs-actions.pod:2578
8496 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8497 "C<guestfs_inspect_get_mountpoints>."
8501 #: ../src/guestfs-actions.pod:2587
8502 msgid "guestfs_inspect_get_hostname"
8506 #: ../src/guestfs-actions.pod:2589
8510 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
8511 " const char *root);\n"
8516 #: ../src/guestfs-actions.pod:2596 ../fish/guestfish-actions.pod:1768
8518 "This function returns the hostname of the operating system as found by "
8519 "inspection of the guest's configuration files."
8523 #: ../src/guestfs-actions.pod:2599 ../fish/guestfish-actions.pod:1771
8525 "If the hostname could not be determined, then the string C<unknown> is "
8530 #: ../src/guestfs-actions.pod:2607
8531 msgid "guestfs_inspect_get_major_version"
8535 #: ../src/guestfs-actions.pod:2609
8539 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
8540 " const char *root);\n"
8545 #: ../src/guestfs-actions.pod:2616 ../fish/guestfish-actions.pod:1783
8546 msgid "This returns the major version number of the inspected operating system."
8550 #: ../src/guestfs-actions.pod:2619 ../fish/guestfish-actions.pod:1786
8552 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8553 "popular public names used by the operating system. Notably the operating "
8554 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8555 "1). You can find out the real versions corresponding to releases of Windows "
8556 "by consulting Wikipedia or MSDN."
8560 #: ../src/guestfs-actions.pod:2626 ../src/guestfs-actions.pod:2646 ../fish/guestfish-actions.pod:1793 ../fish/guestfish-actions.pod:1807
8561 msgid "If the version could not be determined, then C<0> is returned."
8565 #: ../src/guestfs-actions.pod:2634
8566 msgid "guestfs_inspect_get_minor_version"
8570 #: ../src/guestfs-actions.pod:2636
8574 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
8575 " const char *root);\n"
8580 #: ../src/guestfs-actions.pod:2643 ../fish/guestfish-actions.pod:1804
8581 msgid "This returns the minor version number of the inspected operating system."
8585 #: ../src/guestfs-actions.pod:2648
8587 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8588 "C<guestfs_inspect_get_major_version>."
8592 #: ../src/guestfs-actions.pod:2655
8593 msgid "guestfs_inspect_get_mountpoints"
8597 #: ../src/guestfs-actions.pod:2657
8601 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
8602 " const char *root);\n"
8607 #: ../src/guestfs-actions.pod:2664 ../fish/guestfish-actions.pod:1819
8609 "This returns a hash of where we think the filesystems associated with this "
8610 "operating system should be mounted. Callers should note that this is at "
8611 "best an educated guess made by reading configuration files such as "
8616 #: ../src/guestfs-actions.pod:2669 ../fish/guestfish-actions.pod:1824
8618 "Each element in the returned hashtable has a key which is the path of the "
8619 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8620 "mounted there (eg. C</dev/sda1>)."
8624 #: ../src/guestfs-actions.pod:2674 ../fish/guestfish-actions.pod:1829
8625 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8629 #: ../src/guestfs-actions.pod:2677
8631 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8632 "C<guestfs_inspect_get_filesystems>."
8636 #: ../src/guestfs-actions.pod:2680 ../src/guestfs-actions.pod:3288 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:6272
8638 "This function returns a NULL-terminated array of strings, or NULL if there "
8639 "was an error. The array of strings will always have length C<2n+1>, where "
8640 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
8641 "caller must free the strings and the array after use>."
8645 #: ../src/guestfs-actions.pod:2688
8646 msgid "guestfs_inspect_get_package_format"
8650 #: ../src/guestfs-actions.pod:2690
8654 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
8655 " const char *root);\n"
8660 #: ../src/guestfs-actions.pod:2697
8662 "This function and C<guestfs_inspect_get_package_management> return the "
8663 "package format and package management tool used by the inspected operating "
8664 "system. For example for Fedora these functions would return C<rpm> (package "
8665 "format) and C<yum> (package management)."
8669 #: ../src/guestfs-actions.pod:2703 ../fish/guestfish-actions.pod:1848
8671 "This returns the string C<unknown> if we could not determine the package "
8672 "format I<or> if the operating system does not have a real packaging system "
8677 #: ../src/guestfs-actions.pod:2707 ../fish/guestfish-actions.pod:1852
8679 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8680 "Future versions of libguestfs may return other strings."
8684 #: ../src/guestfs-actions.pod:2715
8685 msgid "guestfs_inspect_get_package_management"
8689 #: ../src/guestfs-actions.pod:2717
8693 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
8694 " const char *root);\n"
8699 #: ../src/guestfs-actions.pod:2724
8701 "C<guestfs_inspect_get_package_format> and this function return the package "
8702 "format and package management tool used by the inspected operating system. "
8703 "For example for Fedora these functions would return C<rpm> (package format) "
8704 "and C<yum> (package management)."
8708 #: ../src/guestfs-actions.pod:2730 ../fish/guestfish-actions.pod:1870
8710 "This returns the string C<unknown> if we could not determine the package "
8711 "management tool I<or> if the operating system does not have a real packaging "
8712 "system (eg. Windows)."
8716 #: ../src/guestfs-actions.pod:2734 ../fish/guestfish-actions.pod:1874
8718 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8719 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8720 "libguestfs may return other strings."
8724 #: ../src/guestfs-actions.pod:2744
8725 msgid "guestfs_inspect_get_product_name"
8729 #: ../src/guestfs-actions.pod:2746
8733 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
8734 " const char *root);\n"
8739 #: ../src/guestfs-actions.pod:2753 ../fish/guestfish-actions.pod:1888
8741 "This returns the product name of the inspected operating system. The "
8742 "product name is generally some freeform string which can be displayed to the "
8743 "user, but should not be parsed by programs."
8747 #: ../src/guestfs-actions.pod:2758 ../fish/guestfish-actions.pod:1893
8749 "If the product name could not be determined, then the string C<unknown> is "
8754 #: ../src/guestfs-actions.pod:2768
8755 msgid "guestfs_inspect_get_roots"
8759 #: ../src/guestfs-actions.pod:2770
8763 " guestfs_inspect_get_roots (guestfs_h *g);\n"
8768 #: ../src/guestfs-actions.pod:2773
8770 "This function is a convenient way to get the list of root devices, as "
8771 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
8772 "the whole inspection process."
8776 #: ../src/guestfs-actions.pod:2777
8778 "This returns an empty list if either no root devices were found or the "
8779 "caller has not called C<guestfs_inspect_os>."
8783 #: ../src/guestfs-actions.pod:2786
8784 msgid "guestfs_inspect_get_type"
8788 #: ../src/guestfs-actions.pod:2788
8792 " guestfs_inspect_get_type (guestfs_h *g,\n"
8793 " const char *root);\n"
8798 #: ../src/guestfs-actions.pod:2795 ../fish/guestfish-actions.pod:1918
8800 "This returns the type of the inspected operating system. Currently defined "
8805 #: ../src/guestfs-actions.pod:2800 ../fish/guestfish-actions.pod:1923
8810 #: ../src/guestfs-actions.pod:2802 ../fish/guestfish-actions.pod:1925
8811 msgid "Any Linux-based operating system."
8815 #: ../src/guestfs-actions.pod:2806 ../fish/guestfish-actions.pod:1929
8816 msgid "Any Microsoft Windows operating system."
8820 #: ../src/guestfs-actions.pod:2808 ../fish/guestfish-actions.pod:1931
8825 #: ../src/guestfs-actions.pod:2810 ../fish/guestfish-actions.pod:1933
8830 #: ../src/guestfs-actions.pod:2814 ../fish/guestfish-actions.pod:1937
8831 msgid "The operating system type could not be determined."
8835 #: ../src/guestfs-actions.pod:2828
8836 msgid "guestfs_inspect_get_windows_systemroot"
8840 #: ../src/guestfs-actions.pod:2830
8844 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
8845 " const char *root);\n"
8850 #: ../src/guestfs-actions.pod:2837 ../fish/guestfish-actions.pod:1953
8852 "This returns the Windows systemroot of the inspected guest. The systemroot "
8853 "is a directory path such as C</WINDOWS>."
8857 #: ../src/guestfs-actions.pod:2840 ../fish/guestfish-actions.pod:1956
8859 "This call assumes that the guest is Windows and that the systemroot could be "
8860 "determined by inspection. If this is not the case then an error is "
8865 #: ../src/guestfs-actions.pod:2849
8866 msgid "(Added in 1.5.25)"
8870 #: ../src/guestfs-actions.pod:2851
8871 msgid "guestfs_inspect_list_applications"
8875 #: ../src/guestfs-actions.pod:2853
8878 " struct guestfs_application_list *\n"
8879 " guestfs_inspect_list_applications (guestfs_h *g,\n"
8880 " const char *root);\n"
8885 #: ../src/guestfs-actions.pod:2860 ../fish/guestfish-actions.pod:1969
8886 msgid "Return the list of applications installed in the operating system."
8890 #: ../src/guestfs-actions.pod:2862
8892 "I<Note:> This call works differently from other parts of the inspection "
8893 "API. You have to call C<guestfs_inspect_os>, then "
8894 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
8895 "this. Listing applications is a significantly more difficult operation "
8896 "which requires access to the full filesystem. Also note that unlike the "
8897 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
8898 "the libguestfs handle, this call actually reads parts of the mounted "
8899 "filesystems during the call."
8903 #: ../src/guestfs-actions.pod:2872 ../fish/guestfish-actions.pod:1981
8905 "This returns an empty list if the inspection code was not able to determine "
8906 "the list of applications."
8910 #: ../src/guestfs-actions.pod:2875 ../fish/guestfish-actions.pod:1984
8911 msgid "The application structure contains the following fields:"
8915 #: ../src/guestfs-actions.pod:2879 ../fish/guestfish-actions.pod:1988
8920 #: ../src/guestfs-actions.pod:2881 ../fish/guestfish-actions.pod:1990
8922 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8923 "guests, this is the package name."
8927 #: ../src/guestfs-actions.pod:2884 ../fish/guestfish-actions.pod:1993
8928 msgid "C<app_display_name>"
8932 #: ../src/guestfs-actions.pod:2886 ../fish/guestfish-actions.pod:1995
8934 "The display name of the application, sometimes localized to the install "
8935 "language of the guest operating system."
8939 #: ../src/guestfs-actions.pod:2889 ../fish/guestfish-actions.pod:1998
8941 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8942 "to display something can use C<app_name> instead."
8946 #: ../src/guestfs-actions.pod:2892 ../fish/guestfish-actions.pod:2001
8947 msgid "C<app_epoch>"
8951 #: ../src/guestfs-actions.pod:2894 ../fish/guestfish-actions.pod:2003
8953 "For package managers which use epochs, this contains the epoch of the "
8954 "package (an integer). If unavailable, this is returned as C<0>."
8958 #: ../src/guestfs-actions.pod:2897 ../fish/guestfish-actions.pod:2006
8959 msgid "C<app_version>"
8963 #: ../src/guestfs-actions.pod:2899 ../fish/guestfish-actions.pod:2008
8965 "The version string of the application or package. If unavailable this is "
8966 "returned as an empty string C<\"\">."
8970 #: ../src/guestfs-actions.pod:2902 ../fish/guestfish-actions.pod:2011
8971 msgid "C<app_release>"
8975 #: ../src/guestfs-actions.pod:2904 ../fish/guestfish-actions.pod:2013
8977 "The release string of the application or package, for package managers that "
8978 "use this. If unavailable this is returned as an empty string C<\"\">."
8982 #: ../src/guestfs-actions.pod:2908 ../fish/guestfish-actions.pod:2017
8983 msgid "C<app_install_path>"
8987 #: ../src/guestfs-actions.pod:2910 ../fish/guestfish-actions.pod:2019
8989 "The installation path of the application (on operating systems such as "
8990 "Windows which use installation paths). This path is in the format used by "
8991 "the guest operating system, it is not a libguestfs path."
8995 #: ../src/guestfs-actions.pod:2915 ../fish/guestfish-actions.pod:2024
8996 msgid "If unavailable this is returned as an empty string C<\"\">."
9000 #: ../src/guestfs-actions.pod:2917 ../fish/guestfish-actions.pod:2026
9001 msgid "C<app_trans_path>"
9005 #: ../src/guestfs-actions.pod:2919 ../fish/guestfish-actions.pod:2028
9007 "The install path translated into a libguestfs path. If unavailable this is "
9008 "returned as an empty string C<\"\">."
9012 #: ../src/guestfs-actions.pod:2922 ../fish/guestfish-actions.pod:2031
9013 msgid "C<app_publisher>"
9017 #: ../src/guestfs-actions.pod:2924 ../fish/guestfish-actions.pod:2033
9019 "The name of the publisher of the application, for package managers that use "
9020 "this. If unavailable this is returned as an empty string C<\"\">."
9024 #: ../src/guestfs-actions.pod:2928 ../fish/guestfish-actions.pod:2037
9029 #: ../src/guestfs-actions.pod:2930 ../fish/guestfish-actions.pod:2039
9031 "The URL (eg. upstream URL) of the application. If unavailable this is "
9032 "returned as an empty string C<\"\">."
9036 #: ../src/guestfs-actions.pod:2933 ../fish/guestfish-actions.pod:2042
9037 msgid "C<app_source_package>"
9041 #: ../src/guestfs-actions.pod:2935 ../fish/guestfish-actions.pod:2044
9043 "For packaging systems which support this, the name of the source package. "
9044 "If unavailable this is returned as an empty string C<\"\">."
9048 #: ../src/guestfs-actions.pod:2938 ../fish/guestfish-actions.pod:2047
9049 msgid "C<app_summary>"
9053 #: ../src/guestfs-actions.pod:2940 ../fish/guestfish-actions.pod:2049
9055 "A short (usually one line) description of the application or package. If "
9056 "unavailable this is returned as an empty string C<\"\">."
9060 #: ../src/guestfs-actions.pod:2943 ../fish/guestfish-actions.pod:2052
9061 msgid "C<app_description>"
9065 #: ../src/guestfs-actions.pod:2945 ../fish/guestfish-actions.pod:2054
9067 "A longer description of the application or package. If unavailable this is "
9068 "returned as an empty string C<\"\">."
9072 #: ../src/guestfs-actions.pod:2952
9074 "This function returns a C<struct guestfs_application_list *>, or NULL if "
9075 "there was an error. I<The caller must call C<guestfs_free_application_list> "
9080 #: ../src/guestfs-actions.pod:2956
9081 msgid "guestfs_inspect_os"
9085 #: ../src/guestfs-actions.pod:2958
9089 " guestfs_inspect_os (guestfs_h *g);\n"
9094 #: ../src/guestfs-actions.pod:2961 ../fish/guestfish-actions.pod:2065
9096 "This function uses other libguestfs functions and certain heuristics to "
9097 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
9098 "for operating systems."
9102 #: ../src/guestfs-actions.pod:2965 ../fish/guestfish-actions.pod:2069
9103 msgid "The list returned is empty if no operating systems were found."
9107 #: ../src/guestfs-actions.pod:2967 ../fish/guestfish-actions.pod:2071
9109 "If one operating system was found, then this returns a list with a single "
9110 "element, which is the name of the root filesystem of this operating system. "
9111 "It is also possible for this function to return a list containing more than "
9112 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
9113 "element being the root filesystem of one of the operating systems."
9117 #: ../src/guestfs-actions.pod:2974
9119 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
9120 "functions in order to query further information about each operating system, "
9121 "such as the name and version."
9125 #: ../src/guestfs-actions.pod:2979
9127 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
9128 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
9129 "the contents. This should be called with no disks currently mounted. The "
9130 "function may also use Augeas, so any existing Augeas handle will be closed."
9134 #: ../src/guestfs-actions.pod:2985 ../fish/guestfish-actions.pod:2089
9136 "This function cannot decrypt encrypted disks. The caller must do that first "
9137 "(supplying the necessary keys) if the disk is encrypted."
9141 #: ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3246 ../src/guestfs-actions.pod:3308
9142 msgid "See also C<guestfs_list_filesystems>."
9146 #: ../src/guestfs-actions.pod:2999
9147 msgid "guestfs_is_blockdev"
9151 #: ../src/guestfs-actions.pod:3001
9155 " guestfs_is_blockdev (guestfs_h *g,\n"
9156 " const char *path);\n"
9161 #: ../src/guestfs-actions.pod:3005 ../fish/guestfish-actions.pod:2101
9163 "This returns C<true> if and only if there is a block device with the given "
9168 #: ../src/guestfs-actions.pod:3008 ../src/guestfs-actions.pod:3037 ../src/guestfs-actions.pod:3067 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3098 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3169
9169 msgid "See also C<guestfs_stat>."
9173 #: ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3086 ../src/guestfs-actions.pod:3158 ../src/guestfs-actions.pod:3173
9174 msgid "(Added in 1.5.10)"
9178 #: ../src/guestfs-actions.pod:3014
9179 msgid "guestfs_is_busy"
9183 #: ../src/guestfs-actions.pod:3016
9187 " guestfs_is_busy (guestfs_h *g);\n"
9192 #: ../src/guestfs-actions.pod:3019 ../fish/guestfish-actions.pod:2110
9194 "This returns true iff this handle is busy processing a command (in the "
9199 #: ../src/guestfs-actions.pod:3028
9200 msgid "guestfs_is_chardev"
9204 #: ../src/guestfs-actions.pod:3030
9208 " guestfs_is_chardev (guestfs_h *g,\n"
9209 " const char *path);\n"
9214 #: ../src/guestfs-actions.pod:3034 ../fish/guestfish-actions.pod:2119
9216 "This returns C<true> if and only if there is a character device with the "
9217 "given C<path> name."
9221 #: ../src/guestfs-actions.pod:3043
9222 msgid "guestfs_is_config"
9226 #: ../src/guestfs-actions.pod:3045
9230 " guestfs_is_config (guestfs_h *g);\n"
9235 #: ../src/guestfs-actions.pod:3048 ../fish/guestfish-actions.pod:2128
9237 "This returns true iff this handle is being configured (in the C<CONFIG> "
9242 #: ../src/guestfs-actions.pod:3057
9243 msgid "guestfs_is_dir"
9247 #: ../src/guestfs-actions.pod:3059
9251 " guestfs_is_dir (guestfs_h *g,\n"
9252 " const char *path);\n"
9257 #: ../src/guestfs-actions.pod:3063 ../fish/guestfish-actions.pod:2137
9259 "This returns C<true> if and only if there is a directory with the given "
9260 "C<path> name. Note that it returns false for other objects like files."
9264 #: ../src/guestfs-actions.pod:3073
9265 msgid "guestfs_is_fifo"
9269 #: ../src/guestfs-actions.pod:3075
9273 " guestfs_is_fifo (guestfs_h *g,\n"
9274 " const char *path);\n"
9279 #: ../src/guestfs-actions.pod:3079 ../fish/guestfish-actions.pod:2147
9281 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
9282 "given C<path> name."
9286 #: ../src/guestfs-actions.pod:3088
9287 msgid "guestfs_is_file"
9291 #: ../src/guestfs-actions.pod:3090
9295 " guestfs_is_file (guestfs_h *g,\n"
9296 " const char *path);\n"
9301 #: ../src/guestfs-actions.pod:3094 ../fish/guestfish-actions.pod:2156
9303 "This returns C<true> if and only if there is a regular file with the given "
9304 "C<path> name. Note that it returns false for other objects like "
9309 #: ../src/guestfs-actions.pod:3104
9310 msgid "guestfs_is_launching"
9314 #: ../src/guestfs-actions.pod:3106
9318 " guestfs_is_launching (guestfs_h *g);\n"
9323 #: ../src/guestfs-actions.pod:3109 ../fish/guestfish-actions.pod:2166
9325 "This returns true iff this handle is launching the subprocess (in the "
9326 "C<LAUNCHING> state)."
9330 #: ../src/guestfs-actions.pod:3118
9331 msgid "guestfs_is_lv"
9335 #: ../src/guestfs-actions.pod:3120
9339 " guestfs_is_lv (guestfs_h *g,\n"
9340 " const char *device);\n"
9345 #: ../src/guestfs-actions.pod:3124 ../fish/guestfish-actions.pod:2175
9347 "This command tests whether C<device> is a logical volume, and returns true "
9348 "iff this is the case."
9352 #: ../src/guestfs-actions.pod:3131
9353 msgid "guestfs_is_ready"
9357 #: ../src/guestfs-actions.pod:3133
9361 " guestfs_is_ready (guestfs_h *g);\n"
9366 #: ../src/guestfs-actions.pod:3136 ../fish/guestfish-actions.pod:2182
9368 "This returns true iff this handle is ready to accept commands (in the "
9373 #: ../src/guestfs-actions.pod:3145
9374 msgid "guestfs_is_socket"
9378 #: ../src/guestfs-actions.pod:3147
9382 " guestfs_is_socket (guestfs_h *g,\n"
9383 " const char *path);\n"
9388 #: ../src/guestfs-actions.pod:3151 ../fish/guestfish-actions.pod:2191
9390 "This returns C<true> if and only if there is a Unix domain socket with the "
9391 "given C<path> name."
9395 #: ../src/guestfs-actions.pod:3160
9396 msgid "guestfs_is_symlink"
9400 #: ../src/guestfs-actions.pod:3162
9404 " guestfs_is_symlink (guestfs_h *g,\n"
9405 " const char *path);\n"
9410 #: ../src/guestfs-actions.pod:3166 ../fish/guestfish-actions.pod:2200
9412 "This returns C<true> if and only if there is a symbolic link with the given "
9417 #: ../src/guestfs-actions.pod:3175
9418 msgid "guestfs_kill_subprocess"
9422 #: ../src/guestfs-actions.pod:3177
9426 " guestfs_kill_subprocess (guestfs_h *g);\n"
9431 #: ../src/guestfs-actions.pod:3180 ../fish/guestfish-actions.pod:2209
9432 msgid "This kills the qemu subprocess. You should never need to call this."
9436 #: ../src/guestfs-actions.pod:3186
9437 msgid "guestfs_launch"
9441 #: ../src/guestfs-actions.pod:3188
9445 " guestfs_launch (guestfs_h *g);\n"
9450 #: ../src/guestfs-actions.pod:3191 ../fish/guestfish-actions.pod:2217
9452 "Internally libguestfs is implemented by running a virtual machine using "
9457 #: ../src/guestfs-actions.pod:3194 ../fish/guestfish-actions.pod:2220
9459 "You should call this after configuring the handle (eg. adding drives) but "
9460 "before performing any actions."
9464 #: ../src/guestfs-actions.pod:3201
9465 msgid "guestfs_lchown"
9469 #: ../src/guestfs-actions.pod:3203
9473 " guestfs_lchown (guestfs_h *g,\n"
9476 " const char *path);\n"
9481 #: ../src/guestfs-actions.pod:3209
9483 "Change the file owner to C<owner> and group to C<group>. This is like "
9484 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
9485 "changed, not the target."
9489 #: ../src/guestfs-actions.pod:3221
9490 msgid "guestfs_lgetxattrs"
9494 #: ../src/guestfs-actions.pod:3223
9497 " struct guestfs_xattr_list *\n"
9498 " guestfs_lgetxattrs (guestfs_h *g,\n"
9499 " const char *path);\n"
9504 #: ../src/guestfs-actions.pod:3227
9506 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
9507 "then it returns the extended attributes of the link itself."
9511 #: ../src/guestfs-actions.pod:3237
9512 msgid "guestfs_list_devices"
9516 #: ../src/guestfs-actions.pod:3239
9520 " guestfs_list_devices (guestfs_h *g);\n"
9525 #: ../src/guestfs-actions.pod:3242 ../fish/guestfish-actions.pod:2247
9526 msgid "List all the block devices."
9530 #: ../src/guestfs-actions.pod:3244 ../fish/guestfish-actions.pod:2249
9531 msgid "The full block device names are returned, eg. C</dev/sda>."
9535 #: ../src/guestfs-actions.pod:3254
9536 msgid "guestfs_list_filesystems"
9540 #: ../src/guestfs-actions.pod:3256
9544 " guestfs_list_filesystems (guestfs_h *g);\n"
9549 #: ../src/guestfs-actions.pod:3259 ../fish/guestfish-actions.pod:2257
9551 "This inspection command looks for filesystems on partitions, block devices "
9552 "and logical volumes, returning a list of devices containing filesystems and "
9557 #: ../src/guestfs-actions.pod:3263 ../fish/guestfish-actions.pod:2261
9559 "The return value is a hash, where the keys are the devices containing "
9560 "filesystems, and the values are the filesystem types. For example:"
9564 #: ../src/guestfs-actions.pod:3267 ../fish/guestfish-actions.pod:2265
9567 " \"/dev/sda1\" => \"ntfs\"\n"
9568 " \"/dev/sda2\" => \"ext2\"\n"
9569 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9570 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9575 #: ../src/guestfs-actions.pod:3272 ../fish/guestfish-actions.pod:2270
9577 "The value can have the special value \"unknown\", meaning the content of the "
9578 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9582 #: ../src/guestfs-actions.pod:3276
9584 "This command runs other libguestfs commands, which might include "
9585 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
9586 "soon after launch and only when nothing is mounted."
9590 #: ../src/guestfs-actions.pod:3280
9592 "Not all of the filesystems returned will be mountable. In particular, swap "
9593 "partitions are returned in the list. Also this command does not check that "
9594 "each filesystem found is valid and mountable, and some filesystems might be "
9595 "mountable but require special options. Filesystems may not all belong to a "
9596 "single logical operating system (use C<guestfs_inspect_os> to look for "
9601 #: ../src/guestfs-actions.pod:3294 ../src/guestfs-actions.pod:4817
9602 msgid "(Added in 1.5.15)"
9606 #: ../src/guestfs-actions.pod:3296
9607 msgid "guestfs_list_partitions"
9611 #: ../src/guestfs-actions.pod:3298
9615 " guestfs_list_partitions (guestfs_h *g);\n"
9620 #: ../src/guestfs-actions.pod:3301 ../fish/guestfish-actions.pod:2290
9621 msgid "List all the partitions detected on all block devices."
9625 #: ../src/guestfs-actions.pod:3303 ../fish/guestfish-actions.pod:2292
9626 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9630 #: ../src/guestfs-actions.pod:3305
9632 "This does not return logical volumes. For that you will need to call "
9637 #: ../src/guestfs-actions.pod:3316
9642 #: ../src/guestfs-actions.pod:3318
9646 " guestfs_ll (guestfs_h *g,\n"
9647 " const char *directory);\n"
9652 #: ../src/guestfs-actions.pod:3322 ../fish/guestfish-actions.pod:2303
9654 "List the files in C<directory> (relative to the root directory, there is no "
9655 "cwd) in the format of 'ls -la'."
9659 #: ../src/guestfs-actions.pod:3325 ../fish/guestfish-actions.pod:2306
9661 "This command is mostly useful for interactive sessions. It is I<not> "
9662 "intended that you try to parse the output string."
9666 #: ../src/guestfs-actions.pod:3333
9671 #: ../src/guestfs-actions.pod:3335
9675 " guestfs_ln (guestfs_h *g,\n"
9676 " const char *target,\n"
9677 " const char *linkname);\n"
9682 #: ../src/guestfs-actions.pod:3340 ../fish/guestfish-actions.pod:2313
9683 msgid "This command creates a hard link using the C<ln> command."
9687 #: ../src/guestfs-actions.pod:3346
9688 msgid "guestfs_ln_f"
9692 #: ../src/guestfs-actions.pod:3348
9696 " guestfs_ln_f (guestfs_h *g,\n"
9697 " const char *target,\n"
9698 " const char *linkname);\n"
9703 #: ../src/guestfs-actions.pod:3353 ../fish/guestfish-actions.pod:2319
9705 "This command creates a hard link using the C<ln -f> command. The C<-f> "
9706 "option removes the link (C<linkname>) if it exists already."
9710 #: ../src/guestfs-actions.pod:3360
9711 msgid "guestfs_ln_s"
9715 #: ../src/guestfs-actions.pod:3362
9719 " guestfs_ln_s (guestfs_h *g,\n"
9720 " const char *target,\n"
9721 " const char *linkname);\n"
9726 #: ../src/guestfs-actions.pod:3367 ../fish/guestfish-actions.pod:2326
9727 msgid "This command creates a symbolic link using the C<ln -s> command."
9731 #: ../src/guestfs-actions.pod:3373
9732 msgid "guestfs_ln_sf"
9736 #: ../src/guestfs-actions.pod:3375
9740 " guestfs_ln_sf (guestfs_h *g,\n"
9741 " const char *target,\n"
9742 " const char *linkname);\n"
9747 #: ../src/guestfs-actions.pod:3380 ../fish/guestfish-actions.pod:2332
9749 "This command creates a symbolic link using the C<ln -sf> command, The C<-f> "
9750 "option removes the link (C<linkname>) if it exists already."
9754 #: ../src/guestfs-actions.pod:3387
9755 msgid "guestfs_lremovexattr"
9759 #: ../src/guestfs-actions.pod:3389
9763 " guestfs_lremovexattr (guestfs_h *g,\n"
9764 " const char *xattr,\n"
9765 " const char *path);\n"
9770 #: ../src/guestfs-actions.pod:3394
9772 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
9773 "link, then it removes an extended attribute of the link itself."
9777 #: ../src/guestfs-actions.pod:3402
9782 #: ../src/guestfs-actions.pod:3404
9786 " guestfs_ls (guestfs_h *g,\n"
9787 " const char *directory);\n"
9792 #: ../src/guestfs-actions.pod:3408 ../fish/guestfish-actions.pod:2347
9794 "List the files in C<directory> (relative to the root directory, there is no "
9795 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9800 #: ../src/guestfs-actions.pod:3412
9802 "This command is mostly useful for interactive sessions. Programs should "
9803 "probably use C<guestfs_readdir> instead."
9807 #: ../src/guestfs-actions.pod:3421
9808 msgid "guestfs_lsetxattr"
9812 #: ../src/guestfs-actions.pod:3423
9816 " guestfs_lsetxattr (guestfs_h *g,\n"
9817 " const char *xattr,\n"
9818 " const char *val,\n"
9820 " const char *path);\n"
9825 #: ../src/guestfs-actions.pod:3430
9827 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
9828 "then it sets an extended attribute of the link itself."
9832 #: ../src/guestfs-actions.pod:3438
9833 msgid "guestfs_lstat"
9837 #: ../src/guestfs-actions.pod:3440
9840 " struct guestfs_stat *\n"
9841 " guestfs_lstat (guestfs_h *g,\n"
9842 " const char *path);\n"
9847 #: ../src/guestfs-actions.pod:3444 ../src/guestfs-actions.pod:5871 ../fish/guestfish-actions.pod:2366 ../fish/guestfish-actions.pod:3948
9848 msgid "Returns file information for the given C<path>."
9852 #: ../src/guestfs-actions.pod:3446
9854 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
9855 "link, then the link is stat-ed, not the file it refers to."
9859 #: ../src/guestfs-actions.pod:3450 ../fish/guestfish-actions.pod:2372
9860 msgid "This is the same as the C<lstat(2)> system call."
9864 #: ../src/guestfs-actions.pod:3452 ../src/guestfs-actions.pod:5875
9866 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
9867 "error. I<The caller must call C<guestfs_free_stat> after use>."
9871 #: ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:5879 ../src/guestfs-actions.pod:5897 ../src/guestfs-actions.pod:6278
9872 msgid "(Added in 0.9.2)"
9876 #: ../src/guestfs-actions.pod:3458
9877 msgid "guestfs_lstatlist"
9881 #: ../src/guestfs-actions.pod:3460
9884 " struct guestfs_stat_list *\n"
9885 " guestfs_lstatlist (guestfs_h *g,\n"
9886 " const char *path,\n"
9887 " char *const *names);\n"
9892 #: ../src/guestfs-actions.pod:3465
9894 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
9895 "files, where all files are in the directory C<path>. C<names> is the list "
9896 "of files from this directory."
9900 #: ../src/guestfs-actions.pod:3469 ../fish/guestfish-actions.pod:2382
9902 "On return you get a list of stat structs, with a one-to-one correspondence "
9903 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9904 "then the C<ino> field of that structure is set to C<-1>."
9908 #: ../src/guestfs-actions.pod:3474
9910 "This call is intended for programs that want to efficiently list a directory "
9911 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
9912 "for a similarly efficient call for getting extended attributes. Very long "
9913 "directory listings might cause the protocol message size to be exceeded, "
9914 "causing this call to fail. The caller must split up such requests into "
9915 "smaller groups of names."
9919 #: ../src/guestfs-actions.pod:3482
9921 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
9922 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
9926 #: ../src/guestfs-actions.pod:3488
9927 msgid "guestfs_luks_add_key"
9931 #: ../src/guestfs-actions.pod:3490
9935 " guestfs_luks_add_key (guestfs_h *g,\n"
9936 " const char *device,\n"
9937 " const char *key,\n"
9938 " const char *newkey,\n"
9944 #: ../src/guestfs-actions.pod:3497 ../fish/guestfish-actions.pod:2399
9946 "This command adds a new key on LUKS device C<device>. C<key> is any "
9947 "existing key, and is used to access the device. C<newkey> is the new key to "
9948 "add. C<keyslot> is the key slot that will be replaced."
9952 #: ../src/guestfs-actions.pod:3502
9954 "Note that if C<keyslot> already contains a key, then this command will "
9955 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
9959 #: ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3548 ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3591 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3642
9961 "This function takes a key or passphrase parameter which could contain "
9962 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
9967 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3595
9968 msgid "(Added in 1.5.2)"
9972 #: ../src/guestfs-actions.pod:3514
9973 msgid "guestfs_luks_close"
9977 #: ../src/guestfs-actions.pod:3516
9981 " guestfs_luks_close (guestfs_h *g,\n"
9982 " const char *device);\n"
9987 #: ../src/guestfs-actions.pod:3520
9989 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
9990 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
9991 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9992 "underlying block device."
9996 #: ../src/guestfs-actions.pod:3528 ../src/guestfs-actions.pod:3627 ../src/guestfs-actions.pod:3646 ../src/guestfs-actions.pod:3696 ../src/guestfs-actions.pod:3744
9997 msgid "(Added in 1.5.1)"
10001 #: ../src/guestfs-actions.pod:3530
10002 msgid "guestfs_luks_format"
10006 #: ../src/guestfs-actions.pod:3532
10010 " guestfs_luks_format (guestfs_h *g,\n"
10011 " const char *device,\n"
10012 " const char *key,\n"
10018 #: ../src/guestfs-actions.pod:3538 ../fish/guestfish-actions.pod:2425
10020 "This command erases existing data on C<device> and formats the device as a "
10021 "LUKS encrypted device. C<key> is the initial key, which is added to key "
10022 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
10026 #: ../src/guestfs-actions.pod:3545 ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3708 ../src/guestfs-actions.pod:4568 ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5729 ../src/guestfs-actions.pod:5755 ../src/guestfs-actions.pod:6905 ../fish/guestfish-actions.pod:2433 ../fish/guestfish-actions.pod:2446 ../fish/guestfish-actions.pod:2530 ../fish/guestfish-actions.pod:3060 ../fish/guestfish-actions.pod:3567 ../fish/guestfish-actions.pod:3847 ../fish/guestfish-actions.pod:3863 ../fish/guestfish-actions.pod:3878 ../fish/guestfish-actions.pod:4593
10028 "B<This command is dangerous. Without careful use you can easily destroy all "
10033 #: ../src/guestfs-actions.pod:3554
10034 msgid "guestfs_luks_format_cipher"
10038 #: ../src/guestfs-actions.pod:3556
10042 " guestfs_luks_format_cipher (guestfs_h *g,\n"
10043 " const char *device,\n"
10044 " const char *key,\n"
10046 " const char *cipher);\n"
10051 #: ../src/guestfs-actions.pod:3563
10053 "This command is the same as C<guestfs_luks_format> but it also allows you to "
10054 "set the C<cipher> used."
10058 #: ../src/guestfs-actions.pod:3577
10059 msgid "guestfs_luks_kill_slot"
10063 #: ../src/guestfs-actions.pod:3579
10067 " guestfs_luks_kill_slot (guestfs_h *g,\n"
10068 " const char *device,\n"
10069 " const char *key,\n"
10075 #: ../src/guestfs-actions.pod:3585 ../fish/guestfish-actions.pod:2453
10077 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
10078 "device C<device>. C<key> must be one of the I<other> keys."
10082 #: ../src/guestfs-actions.pod:3597
10083 msgid "guestfs_luks_open"
10087 #: ../src/guestfs-actions.pod:3599
10091 " guestfs_luks_open (guestfs_h *g,\n"
10092 " const char *device,\n"
10093 " const char *key,\n"
10094 " const char *mapname);\n"
10099 #: ../src/guestfs-actions.pod:3605 ../fish/guestfish-actions.pod:2464
10101 "This command opens a block device which has been encrypted according to the "
10102 "Linux Unified Key Setup (LUKS) standard."
10106 #: ../src/guestfs-actions.pod:3608 ../fish/guestfish-actions.pod:2467
10107 msgid "C<device> is the encrypted block device or partition."
10111 #: ../src/guestfs-actions.pod:3610 ../fish/guestfish-actions.pod:2469
10113 "The caller must supply one of the keys associated with the LUKS block "
10114 "device, in the C<key> parameter."
10118 #: ../src/guestfs-actions.pod:3613 ../fish/guestfish-actions.pod:2472
10120 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
10121 "writes to this block device are decrypted from and encrypted to the "
10122 "underlying C<device> respectively."
10126 #: ../src/guestfs-actions.pod:3617
10128 "If this block device contains LVM volume groups, then calling "
10129 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
10134 #: ../src/guestfs-actions.pod:3629
10135 msgid "guestfs_luks_open_ro"
10139 #: ../src/guestfs-actions.pod:3631
10143 " guestfs_luks_open_ro (guestfs_h *g,\n"
10144 " const char *device,\n"
10145 " const char *key,\n"
10146 " const char *mapname);\n"
10151 #: ../src/guestfs-actions.pod:3637
10153 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
10158 #: ../src/guestfs-actions.pod:3648
10159 msgid "guestfs_lvcreate"
10163 #: ../src/guestfs-actions.pod:3650
10167 " guestfs_lvcreate (guestfs_h *g,\n"
10168 " const char *logvol,\n"
10169 " const char *volgroup,\n"
10175 #: ../src/guestfs-actions.pod:3656 ../fish/guestfish-actions.pod:2497
10177 "This creates an LVM logical volume called C<logvol> on the volume group "
10178 "C<volgroup>, with C<size> megabytes."
10182 #: ../src/guestfs-actions.pod:3663
10183 msgid "guestfs_lvm_canonical_lv_name"
10187 #: ../src/guestfs-actions.pod:3665
10191 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
10192 " const char *lvname);\n"
10197 #: ../src/guestfs-actions.pod:3669 ../fish/guestfish-actions.pod:2504
10199 "This converts alternative naming schemes for LVs that you might find to the "
10200 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
10205 #: ../src/guestfs-actions.pod:3673 ../fish/guestfish-actions.pod:2508
10207 "This command returns an error if the C<lvname> parameter does not refer to a "
10212 #: ../src/guestfs-actions.pod:3676
10213 msgid "See also C<guestfs_is_lv>."
10217 #: ../src/guestfs-actions.pod:3681
10218 msgid "(Added in 1.5.24)"
10222 #: ../src/guestfs-actions.pod:3683
10223 msgid "guestfs_lvm_clear_filter"
10227 #: ../src/guestfs-actions.pod:3685
10231 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
10236 #: ../src/guestfs-actions.pod:3688
10238 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
10239 "see every block device."
10243 #: ../src/guestfs-actions.pod:3691 ../src/guestfs-actions.pod:3733 ../fish/guestfish-actions.pod:2520 ../fish/guestfish-actions.pod:2551
10244 msgid "This command also clears the LVM cache and performs a volume group scan."
10248 #: ../src/guestfs-actions.pod:3698
10249 msgid "guestfs_lvm_remove_all"
10253 #: ../src/guestfs-actions.pod:3700
10257 " guestfs_lvm_remove_all (guestfs_h *g);\n"
10262 #: ../src/guestfs-actions.pod:3703 ../fish/guestfish-actions.pod:2527
10264 "This command removes all LVM logical volumes, volume groups and physical "
10269 #: ../src/guestfs-actions.pod:3713
10270 msgid "guestfs_lvm_set_filter"
10274 #: ../src/guestfs-actions.pod:3715
10278 " guestfs_lvm_set_filter (guestfs_h *g,\n"
10279 " char *const *devices);\n"
10284 #: ../src/guestfs-actions.pod:3719 ../fish/guestfish-actions.pod:2537
10286 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
10287 "block devices in the list C<devices>, and will ignore all other attached "
10292 #: ../src/guestfs-actions.pod:3723 ../fish/guestfish-actions.pod:2541
10294 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
10295 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
10296 "there are two types of duplication possible: either cloned PVs/VGs which "
10297 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
10298 "same name. In normal operation you cannot create this situation, but you "
10299 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
10300 "inside the LVM metadata."
10304 #: ../src/guestfs-actions.pod:3736 ../fish/guestfish-actions.pod:2554
10305 msgid "You can filter whole block devices or individual partitions."
10309 #: ../src/guestfs-actions.pod:3738 ../fish/guestfish-actions.pod:2556
10311 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10312 "filesystem), even if you are not filtering out that VG."
10316 #: ../src/guestfs-actions.pod:3746
10317 msgid "guestfs_lvremove"
10321 #: ../src/guestfs-actions.pod:3748
10325 " guestfs_lvremove (guestfs_h *g,\n"
10326 " const char *device);\n"
10331 #: ../src/guestfs-actions.pod:3752 ../fish/guestfish-actions.pod:2564
10333 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10334 "LV, such as C</dev/VG/LV>."
10338 #: ../src/guestfs-actions.pod:3755 ../fish/guestfish-actions.pod:2567
10340 "You can also remove all LVs in a volume group by specifying the VG name, "
10345 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:4914 ../src/guestfs-actions.pod:6644
10346 msgid "(Added in 1.0.13)"
10350 #: ../src/guestfs-actions.pod:3762
10351 msgid "guestfs_lvrename"
10355 #: ../src/guestfs-actions.pod:3764
10359 " guestfs_lvrename (guestfs_h *g,\n"
10360 " const char *logvol,\n"
10361 " const char *newlogvol);\n"
10366 #: ../src/guestfs-actions.pod:3769 ../fish/guestfish-actions.pod:2574
10367 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10371 #: ../src/guestfs-actions.pod:3773 ../src/guestfs-actions.pod:6657
10372 msgid "(Added in 1.0.83)"
10376 #: ../src/guestfs-actions.pod:3775
10377 msgid "guestfs_lvresize"
10381 #: ../src/guestfs-actions.pod:3777
10385 " guestfs_lvresize (guestfs_h *g,\n"
10386 " const char *device,\n"
10392 #: ../src/guestfs-actions.pod:3782 ../fish/guestfish-actions.pod:2580
10394 "This resizes (expands or shrinks) an existing LVM logical volume to "
10395 "C<mbytes>. When reducing, data in the reduced part is lost."
10399 #: ../src/guestfs-actions.pod:3790
10400 msgid "guestfs_lvresize_free"
10404 #: ../src/guestfs-actions.pod:3792
10408 " guestfs_lvresize_free (guestfs_h *g,\n"
10409 " const char *lv,\n"
10415 #: ../src/guestfs-actions.pod:3797 ../fish/guestfish-actions.pod:2588
10417 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10418 "remaining free space in the volume group. Commonly you would call this with "
10419 "pc = 100 which expands the logical volume as much as possible, using all "
10420 "remaining free space in the volume group."
10424 #: ../src/guestfs-actions.pod:3805
10425 msgid "(Added in 1.3.3)"
10429 #: ../src/guestfs-actions.pod:3807
10430 msgid "guestfs_lvs"
10434 #: ../src/guestfs-actions.pod:3809
10438 " guestfs_lvs (guestfs_h *g);\n"
10443 #: ../src/guestfs-actions.pod:3812 ../fish/guestfish-actions.pod:2598
10445 "List all the logical volumes detected. This is the equivalent of the "
10446 "L<lvs(8)> command."
10450 #: ../src/guestfs-actions.pod:3815 ../fish/guestfish-actions.pod:2601
10452 "This returns a list of the logical volume device names "
10453 "(eg. C</dev/VolGroup00/LogVol00>)."
10457 #: ../src/guestfs-actions.pod:3818
10458 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
10462 #: ../src/guestfs-actions.pod:3826
10463 msgid "guestfs_lvs_full"
10467 #: ../src/guestfs-actions.pod:3828
10470 " struct guestfs_lvm_lv_list *\n"
10471 " guestfs_lvs_full (guestfs_h *g);\n"
10476 #: ../src/guestfs-actions.pod:3831 ../fish/guestfish-actions.pod:2610
10478 "List all the logical volumes detected. This is the equivalent of the "
10479 "L<lvs(8)> command. The \"full\" version includes all fields."
10483 #: ../src/guestfs-actions.pod:3834
10485 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
10486 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
10491 #: ../src/guestfs-actions.pod:3840
10492 msgid "guestfs_lvuuid"
10496 #: ../src/guestfs-actions.pod:3842
10500 " guestfs_lvuuid (guestfs_h *g,\n"
10501 " const char *device);\n"
10506 #: ../src/guestfs-actions.pod:3846 ../fish/guestfish-actions.pod:2617
10507 msgid "This command returns the UUID of the LVM LV C<device>."
10511 #: ../src/guestfs-actions.pod:3853
10512 msgid "guestfs_lxattrlist"
10516 #: ../src/guestfs-actions.pod:3855
10519 " struct guestfs_xattr_list *\n"
10520 " guestfs_lxattrlist (guestfs_h *g,\n"
10521 " const char *path,\n"
10522 " char *const *names);\n"
10527 #: ../src/guestfs-actions.pod:3860 ../fish/guestfish-actions.pod:2623
10529 "This call allows you to get the extended attributes of multiple files, where "
10530 "all files are in the directory C<path>. C<names> is the list of files from "
10535 #: ../src/guestfs-actions.pod:3864 ../fish/guestfish-actions.pod:2627
10537 "On return you get a flat list of xattr structs which must be interpreted "
10538 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10539 "C<attrval> in this struct is zero-length to indicate there was an error "
10540 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10541 "number (the number of following attributes for this file, which could be "
10542 "C<\"0\">). Then after the first xattr struct are the zero or more "
10543 "attributes for the first named file. This repeats for the second and "
10544 "subsequent files."
10548 #: ../src/guestfs-actions.pod:3874
10550 "This call is intended for programs that want to efficiently list a directory "
10551 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
10552 "a similarly efficient call for getting standard stats. Very long directory "
10553 "listings might cause the protocol message size to be exceeded, causing this "
10554 "call to fail. The caller must split up such requests into smaller groups of "
10559 #: ../src/guestfs-actions.pod:3888
10560 msgid "guestfs_mkdir"
10564 #: ../src/guestfs-actions.pod:3890
10568 " guestfs_mkdir (guestfs_h *g,\n"
10569 " const char *path);\n"
10574 #: ../src/guestfs-actions.pod:3894 ../fish/guestfish-actions.pod:2649
10575 msgid "Create a directory named C<path>."
10579 #: ../src/guestfs-actions.pod:3900
10580 msgid "guestfs_mkdir_mode"
10584 #: ../src/guestfs-actions.pod:3902
10588 " guestfs_mkdir_mode (guestfs_h *g,\n"
10589 " const char *path,\n"
10595 #: ../src/guestfs-actions.pod:3907 ../fish/guestfish-actions.pod:2655
10597 "This command creates a directory, setting the initial permissions of the "
10598 "directory to C<mode>."
10602 #: ../src/guestfs-actions.pod:3910 ../fish/guestfish-actions.pod:2658
10604 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10605 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10610 #: ../src/guestfs-actions.pod:3914
10611 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
10615 #: ../src/guestfs-actions.pod:3920
10616 msgid "guestfs_mkdir_p"
10620 #: ../src/guestfs-actions.pod:3922
10624 " guestfs_mkdir_p (guestfs_h *g,\n"
10625 " const char *path);\n"
10630 #: ../src/guestfs-actions.pod:3926 ../fish/guestfish-actions.pod:2668
10632 "Create a directory named C<path>, creating any parent directories as "
10633 "necessary. This is like the C<mkdir -p> shell command."
10637 #: ../src/guestfs-actions.pod:3933
10638 msgid "guestfs_mkdtemp"
10642 #: ../src/guestfs-actions.pod:3935
10646 " guestfs_mkdtemp (guestfs_h *g,\n"
10647 " const char *template);\n"
10652 #: ../src/guestfs-actions.pod:3939 ../fish/guestfish-actions.pod:2675
10654 "This command creates a temporary directory. The C<template> parameter "
10655 "should be a full pathname for the temporary directory name with the final "
10656 "six characters being \"XXXXXX\"."
10660 #: ../src/guestfs-actions.pod:3944 ../fish/guestfish-actions.pod:2680
10662 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10663 "being suitable for Windows filesystems."
10667 #: ../src/guestfs-actions.pod:3947 ../fish/guestfish-actions.pod:2683
10668 msgid "The name of the temporary directory that was created is returned."
10672 #: ../src/guestfs-actions.pod:3950 ../fish/guestfish-actions.pod:2686
10673 msgid "The temporary directory is created with mode 0700 and is owned by root."
10677 #: ../src/guestfs-actions.pod:3953 ../fish/guestfish-actions.pod:2689
10679 "The caller is responsible for deleting the temporary directory and its "
10680 "contents after use."
10684 #: ../src/guestfs-actions.pod:3956 ../fish/guestfish-actions.pod:2692
10685 msgid "See also: L<mkdtemp(3)>"
10689 #: ../src/guestfs-actions.pod:3963
10690 msgid "guestfs_mke2fs_J"
10694 #: ../src/guestfs-actions.pod:3965
10698 " guestfs_mke2fs_J (guestfs_h *g,\n"
10699 " const char *fstype,\n"
10700 " int blocksize,\n"
10701 " const char *device,\n"
10702 " const char *journal);\n"
10707 #: ../src/guestfs-actions.pod:3972 ../fish/guestfish-actions.pod:2698
10709 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10710 "C<journal>. It is equivalent to the command:"
10714 #: ../src/guestfs-actions.pod:3976 ../fish/guestfish-actions.pod:2702
10717 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10722 #: ../src/guestfs-actions.pod:3978
10723 msgid "See also C<guestfs_mke2journal>."
10727 #: ../src/guestfs-actions.pod:3982 ../src/guestfs-actions.pod:4000 ../src/guestfs-actions.pod:4018 ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4048 ../src/guestfs-actions.pod:4062 ../src/guestfs-actions.pod:4114 ../src/guestfs-actions.pod:4304
10728 msgid "(Added in 1.0.68)"
10732 #: ../src/guestfs-actions.pod:3984
10733 msgid "guestfs_mke2fs_JL"
10737 #: ../src/guestfs-actions.pod:3986
10741 " guestfs_mke2fs_JL (guestfs_h *g,\n"
10742 " const char *fstype,\n"
10743 " int blocksize,\n"
10744 " const char *device,\n"
10745 " const char *label);\n"
10750 #: ../src/guestfs-actions.pod:3993 ../fish/guestfish-actions.pod:2710
10752 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10753 "the journal labeled C<label>."
10757 #: ../src/guestfs-actions.pod:3996
10758 msgid "See also C<guestfs_mke2journal_L>."
10762 #: ../src/guestfs-actions.pod:4002
10763 msgid "guestfs_mke2fs_JU"
10767 #: ../src/guestfs-actions.pod:4004
10771 " guestfs_mke2fs_JU (guestfs_h *g,\n"
10772 " const char *fstype,\n"
10773 " int blocksize,\n"
10774 " const char *device,\n"
10775 " const char *uuid);\n"
10780 #: ../src/guestfs-actions.pod:4011 ../fish/guestfish-actions.pod:2719
10782 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10783 "the journal with UUID C<uuid>."
10787 #: ../src/guestfs-actions.pod:4014
10788 msgid "See also C<guestfs_mke2journal_U>."
10792 #: ../src/guestfs-actions.pod:4020
10793 msgid "guestfs_mke2journal"
10797 #: ../src/guestfs-actions.pod:4022
10801 " guestfs_mke2journal (guestfs_h *g,\n"
10802 " int blocksize,\n"
10803 " const char *device);\n"
10808 #: ../src/guestfs-actions.pod:4027 ../fish/guestfish-actions.pod:2728
10810 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10815 #: ../src/guestfs-actions.pod:4030 ../fish/guestfish-actions.pod:2731
10818 " mke2fs -O journal_dev -b blocksize device\n"
10823 #: ../src/guestfs-actions.pod:4036
10824 msgid "guestfs_mke2journal_L"
10828 #: ../src/guestfs-actions.pod:4038
10832 " guestfs_mke2journal_L (guestfs_h *g,\n"
10833 " int blocksize,\n"
10834 " const char *label,\n"
10835 " const char *device);\n"
10840 #: ../src/guestfs-actions.pod:4044 ../fish/guestfish-actions.pod:2737
10841 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10845 #: ../src/guestfs-actions.pod:4050
10846 msgid "guestfs_mke2journal_U"
10850 #: ../src/guestfs-actions.pod:4052
10854 " guestfs_mke2journal_U (guestfs_h *g,\n"
10855 " int blocksize,\n"
10856 " const char *uuid,\n"
10857 " const char *device);\n"
10862 #: ../src/guestfs-actions.pod:4058 ../fish/guestfish-actions.pod:2743
10863 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10867 #: ../src/guestfs-actions.pod:4064
10868 msgid "guestfs_mkfifo"
10872 #: ../src/guestfs-actions.pod:4066
10876 " guestfs_mkfifo (guestfs_h *g,\n"
10878 " const char *path);\n"
10883 #: ../src/guestfs-actions.pod:4071
10885 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10886 "is just a convenient wrapper around C<guestfs_mknod>."
10890 #: ../src/guestfs-actions.pod:4081
10891 msgid "guestfs_mkfs"
10895 #: ../src/guestfs-actions.pod:4083
10899 " guestfs_mkfs (guestfs_h *g,\n"
10900 " const char *fstype,\n"
10901 " const char *device);\n"
10906 #: ../src/guestfs-actions.pod:4088 ../fish/guestfish-actions.pod:2759
10908 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10909 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10913 #: ../src/guestfs-actions.pod:4096
10914 msgid "guestfs_mkfs_b"
10918 #: ../src/guestfs-actions.pod:4098
10922 " guestfs_mkfs_b (guestfs_h *g,\n"
10923 " const char *fstype,\n"
10924 " int blocksize,\n"
10925 " const char *device);\n"
10930 #: ../src/guestfs-actions.pod:4104
10932 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
10933 "block size of the resulting filesystem. Supported block sizes depend on the "
10934 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10938 #: ../src/guestfs-actions.pod:4109 ../fish/guestfish-actions.pod:2772
10940 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10945 #: ../src/guestfs-actions.pod:4116
10946 msgid "guestfs_mkmountpoint"
10950 #: ../src/guestfs-actions.pod:4118
10954 " guestfs_mkmountpoint (guestfs_h *g,\n"
10955 " const char *exemptpath);\n"
10960 #: ../src/guestfs-actions.pod:4122
10962 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
10963 "that can be used to create extra mountpoints before mounting the first "
10968 #: ../src/guestfs-actions.pod:4126 ../fish/guestfish-actions.pod:2783
10970 "These calls are I<only> necessary in some very limited circumstances, mainly "
10971 "the case where you want to mount a mix of unrelated and/or read-only "
10972 "filesystems together."
10976 #: ../src/guestfs-actions.pod:4130 ../fish/guestfish-actions.pod:2787
10978 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10979 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10980 "inside that. You can unpack this as follows in guestfish:"
10984 #: ../src/guestfs-actions.pod:4135 ../fish/guestfish-actions.pod:2792
10987 " add-ro Fedora-11-i686-Live.iso\n"
10989 " mkmountpoint /cd\n"
10990 " mkmountpoint /sqsh\n"
10991 " mkmountpoint /ext3fs\n"
10992 " mount /dev/sda /cd\n"
10993 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10994 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10999 #: ../src/guestfs-actions.pod:4144 ../fish/guestfish-actions.pod:2801
11000 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
11004 #: ../src/guestfs-actions.pod:4146
11006 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
11007 "may get unexpected errors if you try to mix these calls. It is safest to "
11008 "manually unmount filesystems and remove mountpoints after use."
11012 #: ../src/guestfs-actions.pod:4150
11014 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
11015 "first, so for this to work for manual mountpoints, you must ensure that the "
11016 "innermost mountpoints have the longest pathnames, as in the example code "
11021 #: ../src/guestfs-actions.pod:4155 ../fish/guestfish-actions.pod:2812
11022 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
11026 #: ../src/guestfs-actions.pod:4157
11028 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
11029 "means that C<guestfs_umount_all> is called when the handle is closed which "
11030 "can also trigger these issues."
11034 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4422 ../src/guestfs-actions.pod:5315
11035 msgid "(Added in 1.0.62)"
11039 #: ../src/guestfs-actions.pod:4165
11040 msgid "guestfs_mknod"
11044 #: ../src/guestfs-actions.pod:4167
11048 " guestfs_mknod (guestfs_h *g,\n"
11052 " const char *path);\n"
11057 #: ../src/guestfs-actions.pod:4174 ../fish/guestfish-actions.pod:2822
11059 "This call creates block or character special devices, or named pipes "
11064 #: ../src/guestfs-actions.pod:4177 ../fish/guestfish-actions.pod:2825
11066 "The C<mode> parameter should be the mode, using the standard constants. "
11067 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
11068 "used when creating block and character special devices."
11072 #: ../src/guestfs-actions.pod:4182
11074 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
11075 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
11076 "regular file). These constants are available in the standard Linux header "
11077 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
11078 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
11079 "the appropriate constant for you."
11083 #: ../src/guestfs-actions.pod:4196
11084 msgid "guestfs_mknod_b"
11088 #: ../src/guestfs-actions.pod:4198
11092 " guestfs_mknod_b (guestfs_h *g,\n"
11096 " const char *path);\n"
11101 #: ../src/guestfs-actions.pod:4205
11103 "This call creates a block device node called C<path> with mode C<mode> and "
11104 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11105 "wrapper around C<guestfs_mknod>."
11109 #: ../src/guestfs-actions.pod:4215
11110 msgid "guestfs_mknod_c"
11114 #: ../src/guestfs-actions.pod:4217
11118 " guestfs_mknod_c (guestfs_h *g,\n"
11122 " const char *path);\n"
11127 #: ../src/guestfs-actions.pod:4224
11129 "This call creates a char device node called C<path> with mode C<mode> and "
11130 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
11131 "wrapper around C<guestfs_mknod>."
11135 #: ../src/guestfs-actions.pod:4234
11136 msgid "guestfs_mkswap"
11140 #: ../src/guestfs-actions.pod:4236
11144 " guestfs_mkswap (guestfs_h *g,\n"
11145 " const char *device);\n"
11150 #: ../src/guestfs-actions.pod:4240 ../fish/guestfish-actions.pod:2864
11151 msgid "Create a swap partition on C<device>."
11155 #: ../src/guestfs-actions.pod:4246
11156 msgid "guestfs_mkswap_L"
11160 #: ../src/guestfs-actions.pod:4248
11164 " guestfs_mkswap_L (guestfs_h *g,\n"
11165 " const char *label,\n"
11166 " const char *device);\n"
11171 #: ../src/guestfs-actions.pod:4253 ../fish/guestfish-actions.pod:2870
11172 msgid "Create a swap partition on C<device> with label C<label>."
11176 #: ../src/guestfs-actions.pod:4255 ../fish/guestfish-actions.pod:2872
11178 "Note that you cannot attach a swap label to a block device "
11179 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
11180 "the kernel or swap tools."
11184 #: ../src/guestfs-actions.pod:4263
11185 msgid "guestfs_mkswap_U"
11189 #: ../src/guestfs-actions.pod:4265
11193 " guestfs_mkswap_U (guestfs_h *g,\n"
11194 " const char *uuid,\n"
11195 " const char *device);\n"
11200 #: ../src/guestfs-actions.pod:4270 ../fish/guestfish-actions.pod:2880
11201 msgid "Create a swap partition on C<device> with UUID C<uuid>."
11205 #: ../src/guestfs-actions.pod:4276
11206 msgid "guestfs_mkswap_file"
11210 #: ../src/guestfs-actions.pod:4278
11214 " guestfs_mkswap_file (guestfs_h *g,\n"
11215 " const char *path);\n"
11220 #: ../src/guestfs-actions.pod:4282 ../fish/guestfish-actions.pod:2886
11221 msgid "Create a swap file."
11225 #: ../src/guestfs-actions.pod:4284
11227 "This command just writes a swap file signature to an existing file. To "
11228 "create the file itself, use something like C<guestfs_fallocate>."
11232 #: ../src/guestfs-actions.pod:4291
11233 msgid "guestfs_modprobe"
11237 #: ../src/guestfs-actions.pod:4293
11241 " guestfs_modprobe (guestfs_h *g,\n"
11242 " const char *modulename);\n"
11247 #: ../src/guestfs-actions.pod:4297 ../fish/guestfish-actions.pod:2895
11248 msgid "This loads a kernel module in the appliance."
11252 #: ../src/guestfs-actions.pod:4299 ../fish/guestfish-actions.pod:2897
11254 "The kernel module must have been whitelisted when libguestfs was built (see "
11255 "C<appliance/kmod.whitelist.in> in the source)."
11259 #: ../src/guestfs-actions.pod:4306
11260 msgid "guestfs_mount"
11264 #: ../src/guestfs-actions.pod:4308
11268 " guestfs_mount (guestfs_h *g,\n"
11269 " const char *device,\n"
11270 " const char *mountpoint);\n"
11275 #: ../src/guestfs-actions.pod:4313 ../fish/guestfish-actions.pod:2904
11277 "Mount a guest disk at a position in the filesystem. Block devices are named "
11278 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
11279 "those block devices contain partitions, they will have the usual names "
11280 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
11284 #: ../src/guestfs-actions.pod:4319 ../fish/guestfish-actions.pod:2910
11286 "The rules are the same as for L<mount(2)>: A filesystem must first be "
11287 "mounted on C</> before others can be mounted. Other filesystems can only be "
11288 "mounted on directories which already exist."
11292 #: ../src/guestfs-actions.pod:4324 ../fish/guestfish-actions.pod:2915
11294 "The mounted filesystem is writable, if we have sufficient permissions on the "
11295 "underlying device."
11299 #: ../src/guestfs-actions.pod:4327
11301 "B<Important note:> When you use this call, the filesystem options C<sync> "
11302 "and C<noatime> are set implicitly. This was originally done because we "
11303 "thought it would improve reliability, but it turns out that I<-o sync> has a "
11304 "very large negative performance impact and negligible effect on "
11305 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
11306 "in any code that needs performance, and instead use C<guestfs_mount_options> "
11307 "(use an empty string for the first parameter if you don't want any options)."
11311 #: ../src/guestfs-actions.pod:4341
11312 msgid "guestfs_mount_loop"
11316 #: ../src/guestfs-actions.pod:4343
11320 " guestfs_mount_loop (guestfs_h *g,\n"
11321 " const char *file,\n"
11322 " const char *mountpoint);\n"
11327 #: ../src/guestfs-actions.pod:4348 ../fish/guestfish-actions.pod:2932
11329 "This command lets you mount C<file> (a filesystem image in a file) on a "
11330 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11335 #: ../src/guestfs-actions.pod:4356
11336 msgid "guestfs_mount_options"
11340 #: ../src/guestfs-actions.pod:4358
11344 " guestfs_mount_options (guestfs_h *g,\n"
11345 " const char *options,\n"
11346 " const char *device,\n"
11347 " const char *mountpoint);\n"
11352 #: ../src/guestfs-actions.pod:4364
11354 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11355 "the mount options as for the L<mount(8)> I<-o> flag."
11359 #: ../src/guestfs-actions.pod:4368 ../fish/guestfish-actions.pod:2944
11361 "If the C<options> parameter is an empty string, then no options are passed "
11362 "(all options default to whatever the filesystem uses)."
11366 #: ../src/guestfs-actions.pod:4374 ../src/guestfs-actions.pod:4388 ../src/guestfs-actions.pod:4405
11367 msgid "(Added in 1.0.10)"
11371 #: ../src/guestfs-actions.pod:4376
11372 msgid "guestfs_mount_ro"
11376 #: ../src/guestfs-actions.pod:4378
11380 " guestfs_mount_ro (guestfs_h *g,\n"
11381 " const char *device,\n"
11382 " const char *mountpoint);\n"
11387 #: ../src/guestfs-actions.pod:4383
11389 "This is the same as the C<guestfs_mount> command, but it mounts the "
11390 "filesystem with the read-only (I<-o ro>) flag."
11394 #: ../src/guestfs-actions.pod:4390
11395 msgid "guestfs_mount_vfs"
11399 #: ../src/guestfs-actions.pod:4392
11403 " guestfs_mount_vfs (guestfs_h *g,\n"
11404 " const char *options,\n"
11405 " const char *vfstype,\n"
11406 " const char *device,\n"
11407 " const char *mountpoint);\n"
11412 #: ../src/guestfs-actions.pod:4399
11414 "This is the same as the C<guestfs_mount> command, but it allows you to set "
11415 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
11420 #: ../src/guestfs-actions.pod:4407
11421 msgid "guestfs_mountpoints"
11425 #: ../src/guestfs-actions.pod:4409
11429 " guestfs_mountpoints (guestfs_h *g);\n"
11434 #: ../src/guestfs-actions.pod:4412
11436 "This call is similar to C<guestfs_mounts>. That call returns a list of "
11437 "devices. This one returns a hash table (map) of device name to directory "
11438 "where the device is mounted."
11442 #: ../src/guestfs-actions.pod:4424
11443 msgid "guestfs_mounts"
11447 #: ../src/guestfs-actions.pod:4426
11451 " guestfs_mounts (guestfs_h *g);\n"
11456 #: ../src/guestfs-actions.pod:4429 ../fish/guestfish-actions.pod:2975
11458 "This returns the list of currently mounted filesystems. It returns the list "
11459 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11463 #: ../src/guestfs-actions.pod:4432 ../fish/guestfish-actions.pod:2978
11464 msgid "Some internal mounts are not shown."
11468 #: ../src/guestfs-actions.pod:4434
11469 msgid "See also: C<guestfs_mountpoints>"
11473 #: ../src/guestfs-actions.pod:4442
11478 #: ../src/guestfs-actions.pod:4444
11482 " guestfs_mv (guestfs_h *g,\n"
11483 " const char *src,\n"
11484 " const char *dest);\n"
11489 #: ../src/guestfs-actions.pod:4449 ../fish/guestfish-actions.pod:2986
11491 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11492 "destination filename or destination directory."
11496 #: ../src/guestfs-actions.pod:4456
11497 msgid "guestfs_ntfs_3g_probe"
11501 #: ../src/guestfs-actions.pod:4458
11505 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
11507 " const char *device);\n"
11512 #: ../src/guestfs-actions.pod:4463 ../fish/guestfish-actions.pod:2993
11514 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11515 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11516 "read-write, and some cannot be mounted at all)."
11520 #: ../src/guestfs-actions.pod:4467 ../fish/guestfish-actions.pod:2997
11522 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11523 "can be mounted read-write. Set it to false if you want to test if the "
11524 "volume can be mounted read-only."
11528 #: ../src/guestfs-actions.pod:4471 ../fish/guestfish-actions.pod:3001
11530 "The return value is an integer which C<0> if the operation would succeed, or "
11531 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11535 #: ../src/guestfs-actions.pod:4477
11536 msgid "(Added in 1.0.43)"
11540 #: ../src/guestfs-actions.pod:4479
11541 msgid "guestfs_ntfsresize"
11545 #: ../src/guestfs-actions.pod:4481
11549 " guestfs_ntfsresize (guestfs_h *g,\n"
11550 " const char *device);\n"
11555 #: ../src/guestfs-actions.pod:4485 ../fish/guestfish-actions.pod:3009
11557 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11558 "size of the underlying device. See also L<ntfsresize(8)>."
11562 #: ../src/guestfs-actions.pod:4493
11563 msgid "guestfs_ntfsresize_size"
11567 #: ../src/guestfs-actions.pod:4495
11571 " guestfs_ntfsresize_size (guestfs_h *g,\n"
11572 " const char *device,\n"
11573 " int64_t size);\n"
11578 #: ../src/guestfs-actions.pod:4500
11580 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
11581 "to specify the new size (in bytes) explicitly."
11585 #: ../src/guestfs-actions.pod:4505 ../src/guestfs-actions.pod:4941 ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5263
11586 msgid "(Added in 1.3.14)"
11590 #: ../src/guestfs-actions.pod:4507
11591 msgid "guestfs_part_add"
11595 #: ../src/guestfs-actions.pod:4509
11599 " guestfs_part_add (guestfs_h *g,\n"
11600 " const char *device,\n"
11601 " const char *prlogex,\n"
11602 " int64_t startsect,\n"
11603 " int64_t endsect);\n"
11608 #: ../src/guestfs-actions.pod:4516
11610 "This command adds a partition to C<device>. If there is no partition table "
11611 "on the device, call C<guestfs_part_init> first."
11615 #: ../src/guestfs-actions.pod:4519 ../fish/guestfish-actions.pod:3027
11617 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11618 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11619 "C<logical>) and C<e> (or C<extended>) partition types."
11623 #: ../src/guestfs-actions.pod:4524 ../fish/guestfish-actions.pod:3032
11625 "C<startsect> and C<endsect> are the start and end of the partition in "
11626 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11627 "from the end of the disk (C<-1> is the last sector)."
11631 #: ../src/guestfs-actions.pod:4528
11633 "Creating a partition which covers the whole disk is not so easy. Use "
11634 "C<guestfs_part_disk> to do that."
11638 #: ../src/guestfs-actions.pod:4533 ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4624 ../src/guestfs-actions.pod:4702 ../src/guestfs-actions.pod:4740 ../src/guestfs-actions.pod:4759 ../src/guestfs-actions.pod:4799
11639 msgid "(Added in 1.0.78)"
11643 #: ../src/guestfs-actions.pod:4535
11644 msgid "guestfs_part_del"
11648 #: ../src/guestfs-actions.pod:4537
11652 " guestfs_part_del (guestfs_h *g,\n"
11653 " const char *device,\n"
11659 #: ../src/guestfs-actions.pod:4542 ../fish/guestfish-actions.pod:3043
11660 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11664 #: ../src/guestfs-actions.pod:4544 ../fish/guestfish-actions.pod:3045
11666 "Note that in the case of MBR partitioning, deleting an extended partition "
11667 "also deletes any logical partitions it contains."
11671 #: ../src/guestfs-actions.pod:4552
11672 msgid "guestfs_part_disk"
11676 #: ../src/guestfs-actions.pod:4554
11680 " guestfs_part_disk (guestfs_h *g,\n"
11681 " const char *device,\n"
11682 " const char *parttype);\n"
11687 #: ../src/guestfs-actions.pod:4559
11689 "This command is simply a combination of C<guestfs_part_init> followed by "
11690 "C<guestfs_part_add> to create a single primary partition covering the whole "
11695 #: ../src/guestfs-actions.pod:4563
11697 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11698 "possible values are described in C<guestfs_part_init>."
11702 #: ../src/guestfs-actions.pod:4573
11703 msgid "guestfs_part_get_bootable"
11707 #: ../src/guestfs-actions.pod:4575
11711 " guestfs_part_get_bootable (guestfs_h *g,\n"
11712 " const char *device,\n"
11718 #: ../src/guestfs-actions.pod:4580 ../fish/guestfish-actions.pod:3067
11720 "This command returns true if the partition C<partnum> on C<device> has the "
11721 "bootable flag set."
11725 #: ../src/guestfs-actions.pod:4583
11726 msgid "See also C<guestfs_part_set_bootable>."
11730 #: ../src/guestfs-actions.pod:4589
11731 msgid "guestfs_part_get_mbr_id"
11735 #: ../src/guestfs-actions.pod:4591
11739 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
11740 " const char *device,\n"
11746 #: ../src/guestfs-actions.pod:4596 ../fish/guestfish-actions.pod:3076
11748 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11749 "partition C<partnum>."
11753 #: ../src/guestfs-actions.pod:4599 ../src/guestfs-actions.pod:4775
11755 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11756 "undefined results for other partition table types (see "
11757 "C<guestfs_part_get_parttype>)."
11761 #: ../src/guestfs-actions.pod:4607
11762 msgid "guestfs_part_get_parttype"
11766 #: ../src/guestfs-actions.pod:4609
11770 " guestfs_part_get_parttype (guestfs_h *g,\n"
11771 " const char *device);\n"
11776 #: ../src/guestfs-actions.pod:4613 ../fish/guestfish-actions.pod:3087
11778 "This command examines the partition table on C<device> and returns the "
11779 "partition table type (format) being used."
11783 #: ../src/guestfs-actions.pod:4616
11785 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11786 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11787 "possible, although unusual. See C<guestfs_part_init> for a full list."
11791 #: ../src/guestfs-actions.pod:4626
11792 msgid "guestfs_part_init"
11796 #: ../src/guestfs-actions.pod:4628
11800 " guestfs_part_init (guestfs_h *g,\n"
11801 " const char *device,\n"
11802 " const char *parttype);\n"
11807 #: ../src/guestfs-actions.pod:4633 ../fish/guestfish-actions.pod:3099
11809 "This creates an empty partition table on C<device> of one of the partition "
11810 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11811 "(for large disks)."
11815 #: ../src/guestfs-actions.pod:4637
11817 "Initially there are no partitions. Following this, you should call "
11818 "C<guestfs_part_add> for each partition required."
11822 #: ../src/guestfs-actions.pod:4640 ../fish/guestfish-actions.pod:3106
11823 msgid "Possible values for C<parttype> are:"
11827 #: ../src/guestfs-actions.pod:4644 ../fish/guestfish-actions.pod:3110
11828 msgid "B<efi> | B<gpt>"
11832 #: ../src/guestfs-actions.pod:4646 ../fish/guestfish-actions.pod:3112
11833 msgid "Intel EFI / GPT partition table."
11837 #: ../src/guestfs-actions.pod:4648 ../fish/guestfish-actions.pod:3114
11839 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11840 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11841 "the C<mbr> format."
11845 #: ../src/guestfs-actions.pod:4652 ../fish/guestfish-actions.pod:3118
11846 msgid "B<mbr> | B<msdos>"
11850 #: ../src/guestfs-actions.pod:4654 ../fish/guestfish-actions.pod:3120
11852 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11853 "Windows. This partition type will B<only> work for device sizes up to 2 "
11854 "TB. For large disks we recommend using C<gpt>."
11858 #: ../src/guestfs-actions.pod:4661 ../fish/guestfish-actions.pod:3127
11859 msgid "Other partition table types that may work but are not supported include:"
11863 #: ../src/guestfs-actions.pod:4666 ../fish/guestfish-actions.pod:3132
11868 #: ../src/guestfs-actions.pod:4668 ../fish/guestfish-actions.pod:3134
11869 msgid "AIX disk labels."
11873 #: ../src/guestfs-actions.pod:4670 ../fish/guestfish-actions.pod:3136
11874 msgid "B<amiga> | B<rdb>"
11878 #: ../src/guestfs-actions.pod:4672 ../fish/guestfish-actions.pod:3138
11879 msgid "Amiga \"Rigid Disk Block\" format."
11883 #: ../src/guestfs-actions.pod:4674 ../fish/guestfish-actions.pod:3140
11888 #: ../src/guestfs-actions.pod:4676 ../fish/guestfish-actions.pod:3142
11889 msgid "BSD disk labels."
11893 #: ../src/guestfs-actions.pod:4678 ../fish/guestfish-actions.pod:3144
11898 #: ../src/guestfs-actions.pod:4680 ../fish/guestfish-actions.pod:3146
11899 msgid "DASD, used on IBM mainframes."
11903 #: ../src/guestfs-actions.pod:4682 ../fish/guestfish-actions.pod:3148
11908 #: ../src/guestfs-actions.pod:4684 ../fish/guestfish-actions.pod:3150
11909 msgid "MIPS/SGI volumes."
11913 #: ../src/guestfs-actions.pod:4686 ../fish/guestfish-actions.pod:3152
11918 #: ../src/guestfs-actions.pod:4688 ../fish/guestfish-actions.pod:3154
11919 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11923 #: ../src/guestfs-actions.pod:4690 ../fish/guestfish-actions.pod:3156
11928 #: ../src/guestfs-actions.pod:4692 ../fish/guestfish-actions.pod:3158
11929 msgid "NEC PC-98 format, common in Japan apparently."
11933 #: ../src/guestfs-actions.pod:4694 ../fish/guestfish-actions.pod:3160
11938 #: ../src/guestfs-actions.pod:4696 ../fish/guestfish-actions.pod:3162
11939 msgid "Sun disk labels."
11943 #: ../src/guestfs-actions.pod:4704
11944 msgid "guestfs_part_list"
11948 #: ../src/guestfs-actions.pod:4706
11951 " struct guestfs_partition_list *\n"
11952 " guestfs_part_list (guestfs_h *g,\n"
11953 " const char *device);\n"
11958 #: ../src/guestfs-actions.pod:4710 ../fish/guestfish-actions.pod:3170
11960 "This command parses the partition table on C<device> and returns the list of "
11961 "partitions found."
11965 #: ../src/guestfs-actions.pod:4713 ../fish/guestfish-actions.pod:3173
11966 msgid "The fields in the returned structure are:"
11970 #: ../src/guestfs-actions.pod:4717 ../fish/guestfish-actions.pod:3177
11971 msgid "B<part_num>"
11975 #: ../src/guestfs-actions.pod:4719 ../fish/guestfish-actions.pod:3179
11976 msgid "Partition number, counting from 1."
11980 #: ../src/guestfs-actions.pod:4721 ../fish/guestfish-actions.pod:3181
11981 msgid "B<part_start>"
11985 #: ../src/guestfs-actions.pod:4723
11987 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11988 "the device's sector size, see C<guestfs_blockdev_getss>."
11992 #: ../src/guestfs-actions.pod:4726 ../fish/guestfish-actions.pod:3186
11993 msgid "B<part_end>"
11997 #: ../src/guestfs-actions.pod:4728 ../fish/guestfish-actions.pod:3188
11998 msgid "End of the partition in bytes."
12002 #: ../src/guestfs-actions.pod:4730 ../fish/guestfish-actions.pod:3190
12003 msgid "B<part_size>"
12007 #: ../src/guestfs-actions.pod:4732 ../fish/guestfish-actions.pod:3192
12008 msgid "Size of the partition in bytes."
12012 #: ../src/guestfs-actions.pod:4736
12014 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
12015 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
12020 #: ../src/guestfs-actions.pod:4742
12021 msgid "guestfs_part_set_bootable"
12025 #: ../src/guestfs-actions.pod:4744
12029 " guestfs_part_set_bootable (guestfs_h *g,\n"
12030 " const char *device,\n"
12032 " int bootable);\n"
12037 #: ../src/guestfs-actions.pod:4750 ../fish/guestfish-actions.pod:3200
12039 "This sets the bootable flag on partition numbered C<partnum> on device "
12040 "C<device>. Note that partitions are numbered from 1."
12044 #: ../src/guestfs-actions.pod:4753 ../fish/guestfish-actions.pod:3203
12046 "The bootable flag is used by some operating systems (notably Windows) to "
12047 "determine which partition to boot from. It is by no means universally "
12052 #: ../src/guestfs-actions.pod:4761
12053 msgid "guestfs_part_set_mbr_id"
12057 #: ../src/guestfs-actions.pod:4763
12061 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
12062 " const char *device,\n"
12069 #: ../src/guestfs-actions.pod:4769 ../fish/guestfish-actions.pod:3211
12071 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
12072 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
12073 "documentation are in fact hexadecimal numbers, but usually documented "
12074 "without any leading \"0x\" which might be confusing."
12078 #: ../src/guestfs-actions.pod:4783
12079 msgid "guestfs_part_set_name"
12083 #: ../src/guestfs-actions.pod:4785
12087 " guestfs_part_set_name (guestfs_h *g,\n"
12088 " const char *device,\n"
12090 " const char *name);\n"
12095 #: ../src/guestfs-actions.pod:4791 ../fish/guestfish-actions.pod:3225
12097 "This sets the partition name on partition numbered C<partnum> on device "
12098 "C<device>. Note that partitions are numbered from 1."
12102 #: ../src/guestfs-actions.pod:4794 ../fish/guestfish-actions.pod:3228
12104 "The partition name can only be set on certain types of partition table. "
12105 "This works on C<gpt> but not on C<mbr> partitions."
12109 #: ../src/guestfs-actions.pod:4801
12110 msgid "guestfs_part_to_dev"
12114 #: ../src/guestfs-actions.pod:4803
12118 " guestfs_part_to_dev (guestfs_h *g,\n"
12119 " const char *partition);\n"
12124 #: ../src/guestfs-actions.pod:4807 ../fish/guestfish-actions.pod:3235
12126 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
12127 "partition number, returning the device name (eg. \"/dev/sdb\")."
12131 #: ../src/guestfs-actions.pod:4811
12133 "The named partition must exist, for example as a string returned from "
12134 "C<guestfs_list_partitions>."
12138 #: ../src/guestfs-actions.pod:4819
12139 msgid "guestfs_ping_daemon"
12143 #: ../src/guestfs-actions.pod:4821
12147 " guestfs_ping_daemon (guestfs_h *g);\n"
12152 #: ../src/guestfs-actions.pod:4824 ../fish/guestfish-actions.pod:3246
12154 "This is a test probe into the guestfs daemon running inside the qemu "
12155 "subprocess. Calling this function checks that the daemon responds to the "
12156 "ping message, without affecting the daemon or attached block device(s) in "
12161 #: ../src/guestfs-actions.pod:4833
12162 msgid "guestfs_pread"
12166 #: ../src/guestfs-actions.pod:4835
12170 " guestfs_pread (guestfs_h *g,\n"
12171 " const char *path,\n"
12173 " int64_t offset,\n"
12174 " size_t *size_r);\n"
12179 #: ../src/guestfs-actions.pod:4842 ../fish/guestfish-actions.pod:3255
12181 "This command lets you read part of a file. It reads C<count> bytes of the "
12182 "file, starting at C<offset>, from file C<path>."
12186 #: ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4871 ../fish/guestfish-actions.pod:3258 ../fish/guestfish-actions.pod:3273
12188 "This may read fewer bytes than requested. For further details see the "
12189 "L<pread(2)> system call."
12193 #: ../src/guestfs-actions.pod:4848
12194 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
12198 #: ../src/guestfs-actions.pod:4859
12199 msgid "guestfs_pread_device"
12203 #: ../src/guestfs-actions.pod:4861
12207 " guestfs_pread_device (guestfs_h *g,\n"
12208 " const char *device,\n"
12210 " int64_t offset,\n"
12211 " size_t *size_r);\n"
12216 #: ../src/guestfs-actions.pod:4868 ../fish/guestfish-actions.pod:3270
12218 "This command lets you read part of a file. It reads C<count> bytes of "
12219 "C<device>, starting at C<offset>."
12223 #: ../src/guestfs-actions.pod:4874
12224 msgid "See also C<guestfs_pread>."
12228 #: ../src/guestfs-actions.pod:4883
12229 msgid "(Added in 1.5.21)"
12233 #: ../src/guestfs-actions.pod:4885
12234 msgid "guestfs_pvcreate"
12238 #: ../src/guestfs-actions.pod:4887
12242 " guestfs_pvcreate (guestfs_h *g,\n"
12243 " const char *device);\n"
12248 #: ../src/guestfs-actions.pod:4891 ../fish/guestfish-actions.pod:3285
12250 "This creates an LVM physical volume on the named C<device>, where C<device> "
12251 "should usually be a partition name such as C</dev/sda1>."
12255 #: ../src/guestfs-actions.pod:4899
12256 msgid "guestfs_pvremove"
12260 #: ../src/guestfs-actions.pod:4901
12264 " guestfs_pvremove (guestfs_h *g,\n"
12265 " const char *device);\n"
12270 #: ../src/guestfs-actions.pod:4905 ../fish/guestfish-actions.pod:3293
12272 "This wipes a physical volume C<device> so that LVM will no longer recognise "
12277 #: ../src/guestfs-actions.pod:4908 ../fish/guestfish-actions.pod:3296
12279 "The implementation uses the C<pvremove> command which refuses to wipe "
12280 "physical volumes that contain any volume groups, so you have to remove those "
12285 #: ../src/guestfs-actions.pod:4916
12286 msgid "guestfs_pvresize"
12290 #: ../src/guestfs-actions.pod:4918
12294 " guestfs_pvresize (guestfs_h *g,\n"
12295 " const char *device);\n"
12300 #: ../src/guestfs-actions.pod:4922 ../fish/guestfish-actions.pod:3304
12302 "This resizes (expands or shrinks) an existing LVM physical volume to match "
12303 "the new size of the underlying device."
12307 #: ../src/guestfs-actions.pod:4929
12308 msgid "guestfs_pvresize_size"
12312 #: ../src/guestfs-actions.pod:4931
12316 " guestfs_pvresize_size (guestfs_h *g,\n"
12317 " const char *device,\n"
12318 " int64_t size);\n"
12323 #: ../src/guestfs-actions.pod:4936
12325 "This command is the same as C<guestfs_pvresize> except that it allows you to "
12326 "specify the new size (in bytes) explicitly."
12330 #: ../src/guestfs-actions.pod:4943
12331 msgid "guestfs_pvs"
12335 #: ../src/guestfs-actions.pod:4945
12339 " guestfs_pvs (guestfs_h *g);\n"
12344 #: ../src/guestfs-actions.pod:4948 ../fish/guestfish-actions.pod:3318
12346 "List all the physical volumes detected. This is the equivalent of the "
12347 "L<pvs(8)> command."
12351 #: ../src/guestfs-actions.pod:4951 ../fish/guestfish-actions.pod:3321
12353 "This returns a list of just the device names that contain PVs "
12354 "(eg. C</dev/sda2>)."
12358 #: ../src/guestfs-actions.pod:4954
12359 msgid "See also C<guestfs_pvs_full>."
12363 #: ../src/guestfs-actions.pod:4962
12364 msgid "guestfs_pvs_full"
12368 #: ../src/guestfs-actions.pod:4964
12371 " struct guestfs_lvm_pv_list *\n"
12372 " guestfs_pvs_full (guestfs_h *g);\n"
12377 #: ../src/guestfs-actions.pod:4967 ../fish/guestfish-actions.pod:3330
12379 "List all the physical volumes detected. This is the equivalent of the "
12380 "L<pvs(8)> command. The \"full\" version includes all fields."
12384 #: ../src/guestfs-actions.pod:4970
12386 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
12387 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
12392 #: ../src/guestfs-actions.pod:4976
12393 msgid "guestfs_pvuuid"
12397 #: ../src/guestfs-actions.pod:4978
12401 " guestfs_pvuuid (guestfs_h *g,\n"
12402 " const char *device);\n"
12407 #: ../src/guestfs-actions.pod:4982 ../fish/guestfish-actions.pod:3337
12408 msgid "This command returns the UUID of the LVM PV C<device>."
12412 #: ../src/guestfs-actions.pod:4989
12413 msgid "guestfs_pwrite"
12417 #: ../src/guestfs-actions.pod:4991
12421 " guestfs_pwrite (guestfs_h *g,\n"
12422 " const char *path,\n"
12423 " const char *content,\n"
12424 " size_t content_size,\n"
12425 " int64_t offset);\n"
12430 #: ../src/guestfs-actions.pod:4998 ../fish/guestfish-actions.pod:3343
12432 "This command writes to part of a file. It writes the data buffer C<content> "
12433 "to the file C<path> starting at offset C<offset>."
12437 #: ../src/guestfs-actions.pod:5001 ../fish/guestfish-actions.pod:3346
12439 "This command implements the L<pwrite(2)> system call, and like that system "
12440 "call it may not write the full data requested. The return value is the "
12441 "number of bytes that were actually written to the file. This could even be "
12442 "0, although short writes are unlikely for regular files in ordinary "
12447 #: ../src/guestfs-actions.pod:5007
12448 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
12452 #: ../src/guestfs-actions.pod:5016
12453 msgid "guestfs_pwrite_device"
12457 #: ../src/guestfs-actions.pod:5018
12461 " guestfs_pwrite_device (guestfs_h *g,\n"
12462 " const char *device,\n"
12463 " const char *content,\n"
12464 " size_t content_size,\n"
12465 " int64_t offset);\n"
12470 #: ../src/guestfs-actions.pod:5025 ../fish/guestfish-actions.pod:3361
12472 "This command writes to part of a device. It writes the data buffer "
12473 "C<content> to C<device> starting at offset C<offset>."
12477 #: ../src/guestfs-actions.pod:5028 ../fish/guestfish-actions.pod:3364
12479 "This command implements the L<pwrite(2)> system call, and like that system "
12480 "call it may not write the full data requested (although short writes to disk "
12481 "devices and partitions are probably impossible with standard Linux kernels)."
12485 #: ../src/guestfs-actions.pod:5033
12486 msgid "See also C<guestfs_pwrite>."
12490 #: ../src/guestfs-actions.pod:5040
12491 msgid "(Added in 1.5.20)"
12495 #: ../src/guestfs-actions.pod:5042
12496 msgid "guestfs_read_file"
12500 #: ../src/guestfs-actions.pod:5044
12504 " guestfs_read_file (guestfs_h *g,\n"
12505 " const char *path,\n"
12506 " size_t *size_r);\n"
12511 #: ../src/guestfs-actions.pod:5049 ../fish/guestfish-actions.pod:3378
12512 msgid "This calls returns the contents of the file C<path> as a buffer."
12516 #: ../src/guestfs-actions.pod:5052
12518 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
12519 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
12520 "function is limited in the total size of file that can be handled."
12524 #: ../src/guestfs-actions.pod:5064
12525 msgid "(Added in 1.0.63)"
12529 #: ../src/guestfs-actions.pod:5066
12530 msgid "guestfs_read_lines"
12534 #: ../src/guestfs-actions.pod:5068
12538 " guestfs_read_lines (guestfs_h *g,\n"
12539 " const char *path);\n"
12544 #: ../src/guestfs-actions.pod:5074 ../fish/guestfish-actions.pod:3395
12546 "The file contents are returned as a list of lines. Trailing C<LF> and "
12547 "C<CRLF> character sequences are I<not> returned."
12551 #: ../src/guestfs-actions.pod:5077
12553 "Note that this function cannot correctly handle binary files (specifically, "
12554 "files containing C<\\0> character which is treated as end of line). For "
12555 "those you need to use the C<guestfs_read_file> function which has a more "
12556 "complex interface."
12560 #: ../src/guestfs-actions.pod:5088
12561 msgid "guestfs_readdir"
12565 #: ../src/guestfs-actions.pod:5090
12568 " struct guestfs_dirent_list *\n"
12569 " guestfs_readdir (guestfs_h *g,\n"
12570 " const char *dir);\n"
12575 #: ../src/guestfs-actions.pod:5094 ../fish/guestfish-actions.pod:3407
12576 msgid "This returns the list of directory entries in directory C<dir>."
12580 #: ../src/guestfs-actions.pod:5096 ../fish/guestfish-actions.pod:3409
12582 "All entries in the directory are returned, including C<.> and C<..>. The "
12583 "entries are I<not> sorted, but returned in the same order as the underlying "
12588 #: ../src/guestfs-actions.pod:5100 ../fish/guestfish-actions.pod:3413
12590 "Also this call returns basic file type information about each file. The "
12591 "C<ftyp> field will contain one of the following characters:"
12595 #: ../src/guestfs-actions.pod:5105 ../fish/guestfish-actions.pod:3418
12600 #: ../src/guestfs-actions.pod:5107 ../fish/guestfish-actions.pod:3420
12601 msgid "Block special"
12605 #: ../src/guestfs-actions.pod:5109 ../fish/guestfish-actions.pod:3422
12610 #: ../src/guestfs-actions.pod:5111 ../fish/guestfish-actions.pod:3424
12611 msgid "Char special"
12615 #: ../src/guestfs-actions.pod:5113 ../fish/guestfish-actions.pod:3426
12620 #: ../src/guestfs-actions.pod:5115 ../fish/guestfish-actions.pod:3428
12625 #: ../src/guestfs-actions.pod:5117 ../fish/guestfish-actions.pod:3430
12630 #: ../src/guestfs-actions.pod:5119 ../fish/guestfish-actions.pod:3432
12631 msgid "FIFO (named pipe)"
12635 #: ../src/guestfs-actions.pod:5121 ../fish/guestfish-actions.pod:3434
12640 #: ../src/guestfs-actions.pod:5123 ../fish/guestfish-actions.pod:3436
12641 msgid "Symbolic link"
12645 #: ../src/guestfs-actions.pod:5125 ../fish/guestfish-actions.pod:3438
12650 #: ../src/guestfs-actions.pod:5127 ../fish/guestfish-actions.pod:3440
12651 msgid "Regular file"
12655 #: ../src/guestfs-actions.pod:5129 ../fish/guestfish-actions.pod:3442
12660 #: ../src/guestfs-actions.pod:5131 ../fish/guestfish-actions.pod:3444
12665 #: ../src/guestfs-actions.pod:5133 ../fish/guestfish-actions.pod:3446
12670 #: ../src/guestfs-actions.pod:5135 ../fish/guestfish-actions.pod:3448
12671 msgid "Unknown file type"
12675 #: ../src/guestfs-actions.pod:5137 ../fish/guestfish-actions.pod:3450
12680 #: ../src/guestfs-actions.pod:5139 ../fish/guestfish-actions.pod:3452
12681 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12685 #: ../src/guestfs-actions.pod:5144
12687 "This function is primarily intended for use by programs. To get a simple "
12688 "list of names, use C<guestfs_ls>. To get a printable directory for human "
12689 "consumption, use C<guestfs_ll>."
12693 #: ../src/guestfs-actions.pod:5148
12695 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
12696 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
12701 #: ../src/guestfs-actions.pod:5154
12702 msgid "guestfs_readlink"
12706 #: ../src/guestfs-actions.pod:5156
12710 " guestfs_readlink (guestfs_h *g,\n"
12711 " const char *path);\n"
12716 #: ../src/guestfs-actions.pod:5160 ../fish/guestfish-actions.pod:3465
12717 msgid "This command reads the target of a symbolic link."
12721 #: ../src/guestfs-actions.pod:5167
12722 msgid "guestfs_readlinklist"
12726 #: ../src/guestfs-actions.pod:5169
12730 " guestfs_readlinklist (guestfs_h *g,\n"
12731 " const char *path,\n"
12732 " char *const *names);\n"
12737 #: ../src/guestfs-actions.pod:5174 ../fish/guestfish-actions.pod:3471
12739 "This call allows you to do a C<readlink> operation on multiple files, where "
12740 "all files are in the directory C<path>. C<names> is the list of files from "
12745 #: ../src/guestfs-actions.pod:5178 ../fish/guestfish-actions.pod:3475
12747 "On return you get a list of strings, with a one-to-one correspondence to the "
12748 "C<names> list. Each string is the value of the symbolic link."
12752 #: ../src/guestfs-actions.pod:5182 ../fish/guestfish-actions.pod:3479
12754 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12755 "result string is the empty string C<\"\">. However the whole operation is "
12756 "completed even if there were C<readlink(2)> errors, and so you can call this "
12757 "function with names where you don't know if they are symbolic links already "
12758 "(albeit slightly less efficient)."
12762 #: ../src/guestfs-actions.pod:5189 ../fish/guestfish-actions.pod:3486
12764 "This call is intended for programs that want to efficiently list a directory "
12765 "contents without making many round-trips. Very long directory listings "
12766 "might cause the protocol message size to be exceeded, causing this call to "
12767 "fail. The caller must split up such requests into smaller groups of names."
12771 #: ../src/guestfs-actions.pod:5202
12772 msgid "guestfs_realpath"
12776 #: ../src/guestfs-actions.pod:5204
12780 " guestfs_realpath (guestfs_h *g,\n"
12781 " const char *path);\n"
12786 #: ../src/guestfs-actions.pod:5208 ../fish/guestfish-actions.pod:3497
12788 "Return the canonicalized absolute pathname of C<path>. The returned path "
12789 "has no C<.>, C<..> or symbolic link path elements."
12793 #: ../src/guestfs-actions.pod:5216
12794 msgid "guestfs_removexattr"
12798 #: ../src/guestfs-actions.pod:5218
12802 " guestfs_removexattr (guestfs_h *g,\n"
12803 " const char *xattr,\n"
12804 " const char *path);\n"
12809 #: ../src/guestfs-actions.pod:5223 ../fish/guestfish-actions.pod:3504
12810 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12814 #: ../src/guestfs-actions.pod:5226
12815 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
12819 #: ../src/guestfs-actions.pod:5232
12820 msgid "guestfs_resize2fs"
12824 #: ../src/guestfs-actions.pod:5234
12828 " guestfs_resize2fs (guestfs_h *g,\n"
12829 " const char *device);\n"
12834 #: ../src/guestfs-actions.pod:5238 ../fish/guestfish-actions.pod:3513
12836 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12837 "underlying device."
12841 #: ../src/guestfs-actions.pod:5241
12843 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
12844 "C<device> before calling this command. For unknown reasons C<resize2fs> "
12845 "sometimes gives an error about this and sometimes not. In any case, it is "
12846 "always safe to call C<guestfs_e2fsck_f> before calling this function."
12850 #: ../src/guestfs-actions.pod:5251
12851 msgid "guestfs_resize2fs_size"
12855 #: ../src/guestfs-actions.pod:5253
12859 " guestfs_resize2fs_size (guestfs_h *g,\n"
12860 " const char *device,\n"
12861 " int64_t size);\n"
12866 #: ../src/guestfs-actions.pod:5258
12868 "This command is the same as C<guestfs_resize2fs> except that it allows you "
12869 "to specify the new size (in bytes) explicitly."
12873 #: ../src/guestfs-actions.pod:5265
12878 #: ../src/guestfs-actions.pod:5267
12882 " guestfs_rm (guestfs_h *g,\n"
12883 " const char *path);\n"
12888 #: ../src/guestfs-actions.pod:5271 ../fish/guestfish-actions.pod:3533
12889 msgid "Remove the single file C<path>."
12893 #: ../src/guestfs-actions.pod:5277
12894 msgid "guestfs_rm_rf"
12898 #: ../src/guestfs-actions.pod:5279
12902 " guestfs_rm_rf (guestfs_h *g,\n"
12903 " const char *path);\n"
12908 #: ../src/guestfs-actions.pod:5283 ../fish/guestfish-actions.pod:3539
12910 "Remove the file or directory C<path>, recursively removing the contents if "
12911 "its a directory. This is like the C<rm -rf> shell command."
12915 #: ../src/guestfs-actions.pod:5291
12916 msgid "guestfs_rmdir"
12920 #: ../src/guestfs-actions.pod:5293
12924 " guestfs_rmdir (guestfs_h *g,\n"
12925 " const char *path);\n"
12930 #: ../src/guestfs-actions.pod:5297 ../fish/guestfish-actions.pod:3547
12931 msgid "Remove the single directory C<path>."
12935 #: ../src/guestfs-actions.pod:5303
12936 msgid "guestfs_rmmountpoint"
12940 #: ../src/guestfs-actions.pod:5305
12944 " guestfs_rmmountpoint (guestfs_h *g,\n"
12945 " const char *exemptpath);\n"
12950 #: ../src/guestfs-actions.pod:5309
12952 "This calls removes a mountpoint that was previously created with "
12953 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
12957 #: ../src/guestfs-actions.pod:5317
12958 msgid "guestfs_scrub_device"
12962 #: ../src/guestfs-actions.pod:5319
12966 " guestfs_scrub_device (guestfs_h *g,\n"
12967 " const char *device);\n"
12972 #: ../src/guestfs-actions.pod:5323 ../fish/guestfish-actions.pod:3561
12974 "This command writes patterns over C<device> to make data retrieval more "
12979 #: ../src/guestfs-actions.pod:5326 ../src/guestfs-actions.pod:5347 ../src/guestfs-actions.pod:5366 ../fish/guestfish-actions.pod:3564 ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3592
12981 "It is an interface to the L<scrub(1)> program. See that manual page for "
12986 #: ../src/guestfs-actions.pod:5334 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5371
12987 msgid "(Added in 1.0.52)"
12991 #: ../src/guestfs-actions.pod:5336
12992 msgid "guestfs_scrub_file"
12996 #: ../src/guestfs-actions.pod:5338
13000 " guestfs_scrub_file (guestfs_h *g,\n"
13001 " const char *file);\n"
13006 #: ../src/guestfs-actions.pod:5342 ../fish/guestfish-actions.pod:3574
13008 "This command writes patterns over a file to make data retrieval more "
13013 #: ../src/guestfs-actions.pod:5345 ../fish/guestfish-actions.pod:3577
13014 msgid "The file is I<removed> after scrubbing."
13018 #: ../src/guestfs-actions.pod:5354
13019 msgid "guestfs_scrub_freespace"
13023 #: ../src/guestfs-actions.pod:5356
13027 " guestfs_scrub_freespace (guestfs_h *g,\n"
13028 " const char *dir);\n"
13033 #: ../src/guestfs-actions.pod:5360
13035 "This command creates the directory C<dir> and then fills it with files until "
13036 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
13037 "and deletes them. The intention is to scrub any free space on the partition "
13038 "containing C<dir>."
13042 #: ../src/guestfs-actions.pod:5373
13043 msgid "guestfs_set_append"
13047 #: ../src/guestfs-actions.pod:5375
13051 " guestfs_set_append (guestfs_h *g,\n"
13052 " const char *append);\n"
13057 #: ../src/guestfs-actions.pod:5379 ../fish/guestfish-actions.pod:3601
13059 "This function is used to add additional options to the guest kernel command "
13064 #: ../src/guestfs-actions.pod:5382 ../fish/guestfish-actions.pod:3604
13066 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
13067 "environment variable."
13071 #: ../src/guestfs-actions.pod:5385 ../fish/guestfish-actions.pod:3607
13073 "Setting C<append> to C<NULL> means I<no> additional options are passed "
13074 "(libguestfs always adds a few of its own)."
13078 #: ../src/guestfs-actions.pod:5392
13079 msgid "guestfs_set_autosync"
13083 #: ../src/guestfs-actions.pod:5394
13087 " guestfs_set_autosync (guestfs_h *g,\n"
13088 " int autosync);\n"
13093 #: ../src/guestfs-actions.pod:5398
13095 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
13096 "effort attempt to run C<guestfs_umount_all> followed by C<guestfs_sync> when "
13097 "the handle is closed (also if the program exits without closing handles)."
13101 #: ../src/guestfs-actions.pod:5403 ../fish/guestfish-actions.pod:3621
13103 "This is enabled by default (since libguestfs 1.5.24, previously it was "
13104 "disabled by default)."
13108 #: ../src/guestfs-actions.pod:5410
13109 msgid "guestfs_set_direct"
13113 #: ../src/guestfs-actions.pod:5412
13117 " guestfs_set_direct (guestfs_h *g,\n"
13123 #: ../src/guestfs-actions.pod:5416 ../fish/guestfish-actions.pod:3630
13125 "If the direct appliance mode flag is enabled, then stdin and stdout are "
13126 "passed directly through to the appliance once it is launched."
13130 #: ../src/guestfs-actions.pod:5420
13132 "One consequence of this is that log messages aren't caught by the library "
13133 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
13138 #: ../src/guestfs-actions.pod:5424 ../fish/guestfish-actions.pod:3638
13139 msgid "You probably don't want to use this unless you know what you are doing."
13143 #: ../src/guestfs-actions.pod:5427 ../fish/guestfish-actions.pod:3641
13144 msgid "The default is disabled."
13148 #: ../src/guestfs-actions.pod:5433
13149 msgid "guestfs_set_e2label"
13153 #: ../src/guestfs-actions.pod:5435
13157 " guestfs_set_e2label (guestfs_h *g,\n"
13158 " const char *device,\n"
13159 " const char *label);\n"
13164 #: ../src/guestfs-actions.pod:5440 ../fish/guestfish-actions.pod:3647
13166 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
13167 "C<label>. Filesystem labels are limited to 16 characters."
13171 #: ../src/guestfs-actions.pod:5444
13173 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
13174 "the existing label on a filesystem."
13178 #: ../src/guestfs-actions.pod:5451
13179 msgid "guestfs_set_e2uuid"
13183 #: ../src/guestfs-actions.pod:5453
13187 " guestfs_set_e2uuid (guestfs_h *g,\n"
13188 " const char *device,\n"
13189 " const char *uuid);\n"
13194 #: ../src/guestfs-actions.pod:5458 ../fish/guestfish-actions.pod:3658
13196 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
13197 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
13198 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
13202 #: ../src/guestfs-actions.pod:5463
13204 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
13205 "the existing UUID of a filesystem."
13209 #: ../src/guestfs-actions.pod:5470
13210 msgid "guestfs_set_memsize"
13214 #: ../src/guestfs-actions.pod:5472
13218 " guestfs_set_memsize (guestfs_h *g,\n"
13224 #: ../src/guestfs-actions.pod:5476
13226 "This sets the memory size in megabytes allocated to the qemu subprocess. "
13227 "This only has any effect if called before C<guestfs_launch>."
13231 #: ../src/guestfs-actions.pod:5480 ../fish/guestfish-actions.pod:3676
13233 "You can also change this by setting the environment variable "
13234 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
13238 #: ../src/guestfs-actions.pod:5491
13239 msgid "guestfs_set_network"
13243 #: ../src/guestfs-actions.pod:5493
13247 " guestfs_set_network (guestfs_h *g,\n"
13253 #: ../src/guestfs-actions.pod:5497 ../fish/guestfish-actions.pod:3689
13255 "If C<network> is true, then the network is enabled in the libguestfs "
13256 "appliance. The default is false."
13260 #: ../src/guestfs-actions.pod:5500 ../fish/guestfish-actions.pod:3692
13262 "This affects whether commands are able to access the network (see "
13263 "L<guestfs(3)/RUNNING COMMANDS>)."
13267 #: ../src/guestfs-actions.pod:5503
13269 "You must call this before calling C<guestfs_launch>, otherwise it has no "
13274 #: ../src/guestfs-actions.pod:5510
13275 msgid "guestfs_set_path"
13279 #: ../src/guestfs-actions.pod:5512
13283 " guestfs_set_path (guestfs_h *g,\n"
13284 " const char *searchpath);\n"
13289 #: ../src/guestfs-actions.pod:5516 ../fish/guestfish-actions.pod:3704
13290 msgid "Set the path that libguestfs searches for kernel and initrd.img."
13294 #: ../src/guestfs-actions.pod:5518 ../fish/guestfish-actions.pod:3706
13296 "The default is C<$libdir/guestfs> unless overridden by setting "
13297 "C<LIBGUESTFS_PATH> environment variable."
13301 #: ../src/guestfs-actions.pod:5521 ../fish/guestfish-actions.pod:3709
13302 msgid "Setting C<path> to C<NULL> restores the default path."
13306 #: ../src/guestfs-actions.pod:5527
13307 msgid "guestfs_set_qemu"
13311 #: ../src/guestfs-actions.pod:5529
13315 " guestfs_set_qemu (guestfs_h *g,\n"
13316 " const char *qemu);\n"
13321 #: ../src/guestfs-actions.pod:5533 ../fish/guestfish-actions.pod:3717
13322 msgid "Set the qemu binary that we will use."
13326 #: ../src/guestfs-actions.pod:5535 ../fish/guestfish-actions.pod:3719
13327 msgid "The default is chosen when the library was compiled by the configure script."
13331 #: ../src/guestfs-actions.pod:5538 ../fish/guestfish-actions.pod:3722
13333 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13338 #: ../src/guestfs-actions.pod:5541 ../fish/guestfish-actions.pod:3725
13339 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13343 #: ../src/guestfs-actions.pod:5543 ../fish/guestfish-actions.pod:3727
13345 "Note that you should call this function as early as possible after creating "
13346 "the handle. This is because some pre-launch operations depend on testing "
13347 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13348 "don't retest features, and so you might see inconsistent results. Using the "
13349 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13350 "the qemu binary at the same time as the handle is created."
13354 #: ../src/guestfs-actions.pod:5555
13355 msgid "guestfs_set_recovery_proc"
13359 #: ../src/guestfs-actions.pod:5557
13363 " guestfs_set_recovery_proc (guestfs_h *g,\n"
13364 " int recoveryproc);\n"
13369 #: ../src/guestfs-actions.pod:5561
13371 "If this is called with the parameter C<false> then C<guestfs_launch> does "
13372 "not create a recovery process. The purpose of the recovery process is to "
13373 "stop runaway qemu processes in the case where the main program aborts "
13378 #: ../src/guestfs-actions.pod:5566
13380 "This only has any effect if called before C<guestfs_launch>, and the default "
13385 #: ../src/guestfs-actions.pod:5569 ../fish/guestfish-actions.pod:3749
13387 "About the only time when you would want to disable this is if the main "
13388 "process will fork itself into the background (\"daemonize\" itself). In "
13389 "this case the recovery process thinks that the main program has disappeared "
13390 "and so kills qemu, which is not very helpful."
13394 #: ../src/guestfs-actions.pod:5579
13395 msgid "guestfs_set_selinux"
13399 #: ../src/guestfs-actions.pod:5581
13403 " guestfs_set_selinux (guestfs_h *g,\n"
13409 #: ../src/guestfs-actions.pod:5585 ../fish/guestfish-actions.pod:3761
13411 "This sets the selinux flag that is passed to the appliance at boot time. "
13412 "The default is C<selinux=0> (disabled)."
13416 #: ../src/guestfs-actions.pod:5588 ../fish/guestfish-actions.pod:3764
13418 "Note that if SELinux is enabled, it is always in Permissive mode "
13419 "(C<enforcing=0>)."
13423 #: ../src/guestfs-actions.pod:5598
13424 msgid "guestfs_set_trace"
13428 #: ../src/guestfs-actions.pod:5600
13432 " guestfs_set_trace (guestfs_h *g,\n"
13438 #: ../src/guestfs-actions.pod:5604 ../fish/guestfish-actions.pod:3776
13440 "If the command trace flag is set to 1, then commands are printed on stderr "
13441 "before they are executed in a format which is very similar to the one used "
13442 "by guestfish. In other words, you can run a program with this enabled, and "
13443 "you will get out a script which you can feed to guestfish to perform the "
13444 "same set of actions."
13448 #: ../src/guestfs-actions.pod:5611 ../fish/guestfish-actions.pod:3783
13450 "If you want to trace C API calls into libguestfs (and other libraries) then "
13451 "possibly a better way is to use the external ltrace(1) command."
13455 #: ../src/guestfs-actions.pod:5615 ../fish/guestfish-actions.pod:3787
13457 "Command traces are disabled unless the environment variable "
13458 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13462 #: ../src/guestfs-actions.pod:5622
13463 msgid "guestfs_set_verbose"
13467 #: ../src/guestfs-actions.pod:5624
13471 " guestfs_set_verbose (guestfs_h *g,\n"
13477 #: ../src/guestfs-actions.pod:5628 ../fish/guestfish-actions.pod:3796
13478 msgid "If C<verbose> is true, this turns on verbose messages (to C<stderr>)."
13482 #: ../src/guestfs-actions.pod:5630 ../fish/guestfish-actions.pod:3798
13484 "Verbose messages are disabled unless the environment variable "
13485 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13489 #: ../src/guestfs-actions.pod:5637
13490 msgid "guestfs_setcon"
13494 #: ../src/guestfs-actions.pod:5639
13498 " guestfs_setcon (guestfs_h *g,\n"
13499 " const char *context);\n"
13504 #: ../src/guestfs-actions.pod:5643 ../fish/guestfish-actions.pod:3805
13506 "This sets the SELinux security context of the daemon to the string "
13511 #: ../src/guestfs-actions.pod:5646 ../fish/guestfish-actions.pod:3808
13512 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13516 #: ../src/guestfs-actions.pod:5652
13517 msgid "guestfs_setxattr"
13521 #: ../src/guestfs-actions.pod:5654
13525 " guestfs_setxattr (guestfs_h *g,\n"
13526 " const char *xattr,\n"
13527 " const char *val,\n"
13529 " const char *path);\n"
13534 #: ../src/guestfs-actions.pod:5661 ../fish/guestfish-actions.pod:3814
13536 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13537 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13541 #: ../src/guestfs-actions.pod:5665
13542 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
13546 #: ../src/guestfs-actions.pod:5671
13547 msgid "guestfs_sfdisk"
13551 #: ../src/guestfs-actions.pod:5673
13555 " guestfs_sfdisk (guestfs_h *g,\n"
13556 " const char *device,\n"
13560 " char *const *lines);\n"
13565 #: ../src/guestfs-actions.pod:5681 ../fish/guestfish-actions.pod:3824
13567 "This is a direct interface to the L<sfdisk(8)> program for creating "
13568 "partitions on block devices."
13572 #: ../src/guestfs-actions.pod:5684 ../fish/guestfish-actions.pod:3827
13573 msgid "C<device> should be a block device, for example C</dev/sda>."
13577 #: ../src/guestfs-actions.pod:5686 ../fish/guestfish-actions.pod:3829
13579 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13580 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13581 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13582 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13583 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13584 "the kernel) cannot work out the right geometry and you will need to tell it."
13588 #: ../src/guestfs-actions.pod:5694 ../fish/guestfish-actions.pod:3837
13590 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13591 "refer to the L<sfdisk(8)> manpage."
13595 #: ../src/guestfs-actions.pod:5697 ../fish/guestfish-actions.pod:3840
13597 "To create a single partition occupying the whole disk, you would pass "
13598 "C<lines> as a single element list, when the single element being the string "
13603 #: ../src/guestfs-actions.pod:5701
13604 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
13608 #: ../src/guestfs-actions.pod:5711
13609 msgid "guestfs_sfdiskM"
13613 #: ../src/guestfs-actions.pod:5713
13617 " guestfs_sfdiskM (guestfs_h *g,\n"
13618 " const char *device,\n"
13619 " char *const *lines);\n"
13624 #: ../src/guestfs-actions.pod:5718
13626 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
13627 "partition sizes are specified in megabytes only (rounded to the nearest "
13628 "cylinder) and you don't need to specify the cyls, heads and sectors "
13629 "parameters which were rarely if ever used anyway."
13633 #: ../src/guestfs-actions.pod:5724
13635 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
13636 "C<guestfs_part_disk>"
13640 #: ../src/guestfs-actions.pod:5734
13641 msgid "guestfs_sfdisk_N"
13645 #: ../src/guestfs-actions.pod:5736
13649 " guestfs_sfdisk_N (guestfs_h *g,\n"
13650 " const char *device,\n"
13655 " const char *line);\n"
13660 #: ../src/guestfs-actions.pod:5745 ../fish/guestfish-actions.pod:3870
13662 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13663 "(note: C<n> counts from 1)."
13667 #: ../src/guestfs-actions.pod:5748
13669 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
13670 "for the cyls/heads/sectors parameters."
13674 #: ../src/guestfs-actions.pod:5751
13675 msgid "See also: C<guestfs_part_add>"
13679 #: ../src/guestfs-actions.pod:5760
13680 msgid "guestfs_sfdisk_disk_geometry"
13684 #: ../src/guestfs-actions.pod:5762
13688 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
13689 " const char *device);\n"
13694 #: ../src/guestfs-actions.pod:5766
13696 "This displays the disk geometry of C<device> read from the partition table. "
13697 "Especially in the case where the underlying block device has been resized, "
13698 "this can be different from the kernel's idea of the geometry (see "
13699 "C<guestfs_sfdisk_kernel_geometry>)."
13703 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5787 ../fish/guestfish-actions.pod:3890 ../fish/guestfish-actions.pod:3899
13704 msgid "The result is in human-readable format, and not designed to be parsed."
13708 #: ../src/guestfs-actions.pod:5779
13709 msgid "guestfs_sfdisk_kernel_geometry"
13713 #: ../src/guestfs-actions.pod:5781
13717 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
13718 " const char *device);\n"
13723 #: ../src/guestfs-actions.pod:5785 ../fish/guestfish-actions.pod:3897
13724 msgid "This displays the kernel's idea of the geometry of C<device>."
13728 #: ../src/guestfs-actions.pod:5795
13729 msgid "guestfs_sfdisk_l"
13733 #: ../src/guestfs-actions.pod:5797
13737 " guestfs_sfdisk_l (guestfs_h *g,\n"
13738 " const char *device);\n"
13743 #: ../src/guestfs-actions.pod:5801 ../fish/guestfish-actions.pod:3906
13745 "This displays the partition table on C<device>, in the human-readable output "
13746 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13750 #: ../src/guestfs-actions.pod:5805
13751 msgid "See also: C<guestfs_part_list>"
13755 #: ../src/guestfs-actions.pod:5812
13760 #: ../src/guestfs-actions.pod:5814
13764 " guestfs_sh (guestfs_h *g,\n"
13765 " const char *command);\n"
13770 #: ../src/guestfs-actions.pod:5818 ../fish/guestfish-actions.pod:3916
13772 "This call runs a command from the guest filesystem via the guest's "
13777 #: ../src/guestfs-actions.pod:5821
13778 msgid "This is like C<guestfs_command>, but passes the command to:"
13782 #: ../src/guestfs-actions.pod:5823 ../fish/guestfish-actions.pod:3921
13785 " /bin/sh -c \"command\"\n"
13790 #: ../src/guestfs-actions.pod:5825 ../fish/guestfish-actions.pod:3923
13792 "Depending on the guest's shell, this usually results in wildcards being "
13793 "expanded, shell expressions being interpolated and so on."
13797 #: ../src/guestfs-actions.pod:5829
13798 msgid "All the provisos about C<guestfs_command> apply to this call."
13802 #: ../src/guestfs-actions.pod:5836
13803 msgid "guestfs_sh_lines"
13807 #: ../src/guestfs-actions.pod:5838
13811 " guestfs_sh_lines (guestfs_h *g,\n"
13812 " const char *command);\n"
13817 #: ../src/guestfs-actions.pod:5842
13819 "This is the same as C<guestfs_sh>, but splits the result into a list of "
13824 #: ../src/guestfs-actions.pod:5845
13825 msgid "See also: C<guestfs_command_lines>"
13829 #: ../src/guestfs-actions.pod:5853
13830 msgid "guestfs_sleep"
13834 #: ../src/guestfs-actions.pod:5855
13838 " guestfs_sleep (guestfs_h *g,\n"
13844 #: ../src/guestfs-actions.pod:5859 ../fish/guestfish-actions.pod:3942
13845 msgid "Sleep for C<secs> seconds."
13849 #: ../src/guestfs-actions.pod:5863
13850 msgid "(Added in 1.0.41)"
13854 #: ../src/guestfs-actions.pod:5865 ../src/guestfs-structs.pod:109
13855 msgid "guestfs_stat"
13859 #: ../src/guestfs-actions.pod:5867
13862 " struct guestfs_stat *\n"
13863 " guestfs_stat (guestfs_h *g,\n"
13864 " const char *path);\n"
13869 #: ../src/guestfs-actions.pod:5873 ../fish/guestfish-actions.pod:3950
13870 msgid "This is the same as the C<stat(2)> system call."
13874 #: ../src/guestfs-actions.pod:5881 ../src/guestfs-structs.pod:135
13875 msgid "guestfs_statvfs"
13879 #: ../src/guestfs-actions.pod:5883
13882 " struct guestfs_statvfs *\n"
13883 " guestfs_statvfs (guestfs_h *g,\n"
13884 " const char *path);\n"
13889 #: ../src/guestfs-actions.pod:5887 ../fish/guestfish-actions.pod:3956
13891 "Returns file system statistics for any mounted file system. C<path> should "
13892 "be a file or directory in the mounted file system (typically it is the mount "
13893 "point itself, but it doesn't need to be)."
13897 #: ../src/guestfs-actions.pod:5891 ../fish/guestfish-actions.pod:3960
13898 msgid "This is the same as the C<statvfs(2)> system call."
13902 #: ../src/guestfs-actions.pod:5893
13904 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
13905 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
13909 #: ../src/guestfs-actions.pod:5899
13910 msgid "guestfs_strings"
13914 #: ../src/guestfs-actions.pod:5901
13918 " guestfs_strings (guestfs_h *g,\n"
13919 " const char *path);\n"
13924 #: ../src/guestfs-actions.pod:5905 ../fish/guestfish-actions.pod:3966
13926 "This runs the L<strings(1)> command on a file and returns the list of "
13927 "printable strings found."
13931 #: ../src/guestfs-actions.pod:5917
13932 msgid "guestfs_strings_e"
13936 #: ../src/guestfs-actions.pod:5919
13940 " guestfs_strings_e (guestfs_h *g,\n"
13941 " const char *encoding,\n"
13942 " const char *path);\n"
13947 #: ../src/guestfs-actions.pod:5924
13949 "This is like the C<guestfs_strings> command, but allows you to specify the "
13950 "encoding of strings that are looked for in the source file C<path>."
13954 #: ../src/guestfs-actions.pod:5928 ../fish/guestfish-actions.pod:3980
13955 msgid "Allowed encodings are:"
13959 #: ../src/guestfs-actions.pod:5932 ../fish/guestfish-actions.pod:3984
13964 #: ../src/guestfs-actions.pod:5934
13966 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13967 "ISO-8859-X (this is what C<guestfs_strings> uses)."
13971 #: ../src/guestfs-actions.pod:5937 ../fish/guestfish-actions.pod:3989
13976 #: ../src/guestfs-actions.pod:5939 ../fish/guestfish-actions.pod:3991
13977 msgid "Single 8-bit-byte characters."
13981 #: ../src/guestfs-actions.pod:5941 ../fish/guestfish-actions.pod:3993
13986 #: ../src/guestfs-actions.pod:5943 ../fish/guestfish-actions.pod:3995
13987 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13991 #: ../src/guestfs-actions.pod:5946 ../fish/guestfish-actions.pod:3998
13992 msgid "l (lower case letter L)"
13996 #: ../src/guestfs-actions.pod:5948 ../fish/guestfish-actions.pod:4000
13998 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13999 "examining binaries in Windows guests."
14003 #: ../src/guestfs-actions.pod:5951 ../fish/guestfish-actions.pod:4003
14008 #: ../src/guestfs-actions.pod:5953 ../fish/guestfish-actions.pod:4005
14009 msgid "32-bit big endian such as UCS-4BE."
14013 #: ../src/guestfs-actions.pod:5955 ../fish/guestfish-actions.pod:4007
14018 #: ../src/guestfs-actions.pod:5957 ../fish/guestfish-actions.pod:4009
14019 msgid "32-bit little endian such as UCS-4LE."
14023 #: ../src/guestfs-actions.pod:5961 ../fish/guestfish-actions.pod:4013
14024 msgid "The returned strings are transcoded to UTF-8."
14028 #: ../src/guestfs-actions.pod:5972
14029 msgid "guestfs_swapoff_device"
14033 #: ../src/guestfs-actions.pod:5974
14037 " guestfs_swapoff_device (guestfs_h *g,\n"
14038 " const char *device);\n"
14043 #: ../src/guestfs-actions.pod:5978
14045 "This command disables the libguestfs appliance swap device or partition "
14046 "named C<device>. See C<guestfs_swapon_device>."
14050 #: ../src/guestfs-actions.pod:5986
14051 msgid "guestfs_swapoff_file"
14055 #: ../src/guestfs-actions.pod:5988
14059 " guestfs_swapoff_file (guestfs_h *g,\n"
14060 " const char *file);\n"
14065 #: ../src/guestfs-actions.pod:5992 ../fish/guestfish-actions.pod:4030
14066 msgid "This command disables the libguestfs appliance swap on file."
14070 #: ../src/guestfs-actions.pod:5998
14071 msgid "guestfs_swapoff_label"
14075 #: ../src/guestfs-actions.pod:6000
14079 " guestfs_swapoff_label (guestfs_h *g,\n"
14080 " const char *label);\n"
14085 #: ../src/guestfs-actions.pod:6004 ../fish/guestfish-actions.pod:4036
14087 "This command disables the libguestfs appliance swap on labeled swap "
14092 #: ../src/guestfs-actions.pod:6011
14093 msgid "guestfs_swapoff_uuid"
14097 #: ../src/guestfs-actions.pod:6013
14101 " guestfs_swapoff_uuid (guestfs_h *g,\n"
14102 " const char *uuid);\n"
14107 #: ../src/guestfs-actions.pod:6017 ../fish/guestfish-actions.pod:4043
14109 "This command disables the libguestfs appliance swap partition with the given "
14114 #: ../src/guestfs-actions.pod:6024
14115 msgid "guestfs_swapon_device"
14119 #: ../src/guestfs-actions.pod:6026
14123 " guestfs_swapon_device (guestfs_h *g,\n"
14124 " const char *device);\n"
14129 #: ../src/guestfs-actions.pod:6030
14131 "This command enables the libguestfs appliance to use the swap device or "
14132 "partition named C<device>. The increased memory is made available for all "
14133 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
14137 #: ../src/guestfs-actions.pod:6035 ../fish/guestfish-actions.pod:4055
14139 "Note that you should not swap to existing guest swap partitions unless you "
14140 "know what you are doing. They may contain hibernation information, or other "
14141 "information that the guest doesn't want you to trash. You also risk leaking "
14142 "information about the host to the guest this way. Instead, attach a new "
14143 "host device to the guest and swap on that."
14147 #: ../src/guestfs-actions.pod:6046
14148 msgid "guestfs_swapon_file"
14152 #: ../src/guestfs-actions.pod:6048
14156 " guestfs_swapon_file (guestfs_h *g,\n"
14157 " const char *file);\n"
14162 #: ../src/guestfs-actions.pod:6052
14164 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
14169 #: ../src/guestfs-actions.pod:6059
14170 msgid "guestfs_swapon_label"
14174 #: ../src/guestfs-actions.pod:6061
14178 " guestfs_swapon_label (guestfs_h *g,\n"
14179 " const char *label);\n"
14184 #: ../src/guestfs-actions.pod:6065
14186 "This command enables swap to a labeled swap partition. See "
14187 "C<guestfs_swapon_device> for other notes."
14191 #: ../src/guestfs-actions.pod:6072
14192 msgid "guestfs_swapon_uuid"
14196 #: ../src/guestfs-actions.pod:6074
14200 " guestfs_swapon_uuid (guestfs_h *g,\n"
14201 " const char *uuid);\n"
14206 #: ../src/guestfs-actions.pod:6078
14208 "This command enables swap to a swap partition with the given UUID. See "
14209 "C<guestfs_swapon_device> for other notes."
14213 #: ../src/guestfs-actions.pod:6085
14214 msgid "guestfs_sync"
14218 #: ../src/guestfs-actions.pod:6087
14222 " guestfs_sync (guestfs_h *g);\n"
14227 #: ../src/guestfs-actions.pod:6090 ../fish/guestfish-actions.pod:4087
14229 "This syncs the disk, so that any writes are flushed through to the "
14230 "underlying disk image."
14234 #: ../src/guestfs-actions.pod:6093 ../fish/guestfish-actions.pod:4090
14236 "You should always call this if you have modified a disk image, before "
14237 "closing the handle."
14241 #: ../src/guestfs-actions.pod:6100
14242 msgid "guestfs_tail"
14246 #: ../src/guestfs-actions.pod:6102
14250 " guestfs_tail (guestfs_h *g,\n"
14251 " const char *path);\n"
14256 #: ../src/guestfs-actions.pod:6106 ../fish/guestfish-actions.pod:4097
14257 msgid "This command returns up to the last 10 lines of a file as a list of strings."
14261 #: ../src/guestfs-actions.pod:6118
14262 msgid "guestfs_tail_n"
14266 #: ../src/guestfs-actions.pod:6120
14270 " guestfs_tail_n (guestfs_h *g,\n"
14272 " const char *path);\n"
14277 #: ../src/guestfs-actions.pod:6125 ../fish/guestfish-actions.pod:4107
14279 "If the parameter C<nrlines> is a positive number, this returns the last "
14280 "C<nrlines> lines of the file C<path>."
14284 #: ../src/guestfs-actions.pod:6128 ../fish/guestfish-actions.pod:4110
14286 "If the parameter C<nrlines> is a negative number, this returns lines from "
14287 "the file C<path>, starting with the C<-nrlines>th line."
14291 #: ../src/guestfs-actions.pod:6142
14292 msgid "guestfs_tar_in"
14296 #: ../src/guestfs-actions.pod:6144
14300 " guestfs_tar_in (guestfs_h *g,\n"
14301 " const char *tarfile,\n"
14302 " const char *directory);\n"
14307 #: ../src/guestfs-actions.pod:6149 ../fish/guestfish-actions.pod:4122
14309 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
14310 "tar file) into C<directory>."
14314 #: ../src/guestfs-actions.pod:6152
14315 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
14319 #: ../src/guestfs-actions.pod:6157 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6190 ../src/guestfs-actions.pod:6206
14320 msgid "(Added in 1.0.3)"
14324 #: ../src/guestfs-actions.pod:6159
14325 msgid "guestfs_tar_out"
14329 #: ../src/guestfs-actions.pod:6161
14333 " guestfs_tar_out (guestfs_h *g,\n"
14334 " const char *directory,\n"
14335 " const char *tarfile);\n"
14340 #: ../src/guestfs-actions.pod:6166 ../fish/guestfish-actions.pod:4134
14342 "This command packs the contents of C<directory> and downloads it to local "
14347 #: ../src/guestfs-actions.pod:6169
14349 "To download a compressed tarball, use C<guestfs_tgz_out> or "
14350 "C<guestfs_txz_out>."
14354 #: ../src/guestfs-actions.pod:6176
14355 msgid "guestfs_tgz_in"
14359 #: ../src/guestfs-actions.pod:6178
14363 " guestfs_tgz_in (guestfs_h *g,\n"
14364 " const char *tarball,\n"
14365 " const char *directory);\n"
14370 #: ../src/guestfs-actions.pod:6183 ../fish/guestfish-actions.pod:4146
14372 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14373 "tar file) into C<directory>."
14377 #: ../src/guestfs-actions.pod:6186
14378 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
14382 #: ../src/guestfs-actions.pod:6192
14383 msgid "guestfs_tgz_out"
14387 #: ../src/guestfs-actions.pod:6194
14391 " guestfs_tgz_out (guestfs_h *g,\n"
14392 " const char *directory,\n"
14393 " const char *tarball);\n"
14398 #: ../src/guestfs-actions.pod:6199 ../fish/guestfish-actions.pod:4157
14400 "This command packs the contents of C<directory> and downloads it to local "
14405 #: ../src/guestfs-actions.pod:6202
14406 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
14410 #: ../src/guestfs-actions.pod:6208
14411 msgid "guestfs_touch"
14415 #: ../src/guestfs-actions.pod:6210
14419 " guestfs_touch (guestfs_h *g,\n"
14420 " const char *path);\n"
14425 #: ../src/guestfs-actions.pod:6214 ../fish/guestfish-actions.pod:4168
14427 "Touch acts like the L<touch(1)> command. It can be used to update the "
14428 "timestamps on a file, or, if the file does not exist, to create a new "
14429 "zero-length file."
14433 #: ../src/guestfs-actions.pod:6218 ../fish/guestfish-actions.pod:4172
14435 "This command only works on regular files, and will fail on other file types "
14436 "such as directories, symbolic links, block special etc."
14440 #: ../src/guestfs-actions.pod:6225
14441 msgid "guestfs_truncate"
14445 #: ../src/guestfs-actions.pod:6227
14449 " guestfs_truncate (guestfs_h *g,\n"
14450 " const char *path);\n"
14455 #: ../src/guestfs-actions.pod:6231 ../fish/guestfish-actions.pod:4179
14457 "This command truncates C<path> to a zero-length file. The file must exist "
14462 #: ../src/guestfs-actions.pod:6238
14463 msgid "guestfs_truncate_size"
14467 #: ../src/guestfs-actions.pod:6240
14471 " guestfs_truncate_size (guestfs_h *g,\n"
14472 " const char *path,\n"
14473 " int64_t size);\n"
14478 #: ../src/guestfs-actions.pod:6245 ../fish/guestfish-actions.pod:4186
14480 "This command truncates C<path> to size C<size> bytes. The file must exist "
14485 #: ../src/guestfs-actions.pod:6248
14487 "If the current file size is less than C<size> then the file is extended to "
14488 "the required size with zero bytes. This creates a sparse file (ie. disk "
14489 "blocks are not allocated for the file until you write to it). To create a "
14490 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
14494 #: ../src/guestfs-actions.pod:6258
14495 msgid "guestfs_tune2fs_l"
14499 #: ../src/guestfs-actions.pod:6260
14503 " guestfs_tune2fs_l (guestfs_h *g,\n"
14504 " const char *device);\n"
14509 #: ../src/guestfs-actions.pod:6264 ../fish/guestfish-actions.pod:4199
14511 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14516 #: ../src/guestfs-actions.pod:6267 ../fish/guestfish-actions.pod:4202
14518 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14519 "for more details. The list of fields returned isn't clearly defined, and "
14520 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14521 "and the filesystem itself."
14525 #: ../src/guestfs-actions.pod:6280
14526 msgid "guestfs_txz_in"
14530 #: ../src/guestfs-actions.pod:6282
14534 " guestfs_txz_in (guestfs_h *g,\n"
14535 " const char *tarball,\n"
14536 " const char *directory);\n"
14541 #: ../src/guestfs-actions.pod:6287 ../fish/guestfish-actions.pod:4211
14543 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14544 "tar file) into C<directory>."
14548 #: ../src/guestfs-actions.pod:6294
14549 msgid "guestfs_txz_out"
14553 #: ../src/guestfs-actions.pod:6296
14557 " guestfs_txz_out (guestfs_h *g,\n"
14558 " const char *directory,\n"
14559 " const char *tarball);\n"
14564 #: ../src/guestfs-actions.pod:6301 ../fish/guestfish-actions.pod:4220
14566 "This command packs the contents of C<directory> and downloads it to local "
14567 "file C<tarball> (as an xz compressed tar archive)."
14571 #: ../src/guestfs-actions.pod:6308
14572 msgid "guestfs_umask"
14576 #: ../src/guestfs-actions.pod:6310
14580 " guestfs_umask (guestfs_h *g,\n"
14586 #: ../src/guestfs-actions.pod:6314 ../fish/guestfish-actions.pod:4229
14588 "This function sets the mask used for creating new files and device nodes to "
14593 #: ../src/guestfs-actions.pod:6317 ../fish/guestfish-actions.pod:4232
14595 "Typical umask values would be C<022> which creates new files with "
14596 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14597 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14601 #: ../src/guestfs-actions.pod:6322 ../fish/guestfish-actions.pod:4237
14603 "The default umask is C<022>. This is important because it means that "
14604 "directories and device nodes will be created with C<0644> or C<0755> mode "
14605 "even if you specify C<0777>."
14609 #: ../src/guestfs-actions.pod:6326
14611 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
14612 "C<guestfs_mkdir>."
14616 #: ../src/guestfs-actions.pod:6329 ../fish/guestfish-actions.pod:4244
14617 msgid "This call returns the previous umask."
14621 #: ../src/guestfs-actions.pod:6335
14622 msgid "guestfs_umount"
14626 #: ../src/guestfs-actions.pod:6337
14630 " guestfs_umount (guestfs_h *g,\n"
14631 " const char *pathordevice);\n"
14636 #: ../src/guestfs-actions.pod:6341 ../fish/guestfish-actions.pod:4252
14638 "This unmounts the given filesystem. The filesystem may be specified either "
14639 "by its mountpoint (path) or the device which contains the filesystem."
14643 #: ../src/guestfs-actions.pod:6349
14644 msgid "guestfs_umount_all"
14648 #: ../src/guestfs-actions.pod:6351
14652 " guestfs_umount_all (guestfs_h *g);\n"
14657 #: ../src/guestfs-actions.pod:6354 ../fish/guestfish-actions.pod:4262
14658 msgid "This unmounts all mounted filesystems."
14662 #: ../src/guestfs-actions.pod:6356 ../fish/guestfish-actions.pod:4264
14663 msgid "Some internal mounts are not unmounted by this call."
14667 #: ../src/guestfs-actions.pod:6362
14668 msgid "guestfs_upload"
14672 #: ../src/guestfs-actions.pod:6364
14676 " guestfs_upload (guestfs_h *g,\n"
14677 " const char *filename,\n"
14678 " const char *remotefilename);\n"
14683 #: ../src/guestfs-actions.pod:6369 ../src/guestfs-actions.pod:6388 ../fish/guestfish-actions.pod:4270 ../fish/guestfish-actions.pod:4283
14684 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14688 #: ../src/guestfs-actions.pod:6374
14689 msgid "See also C<guestfs_download>."
14693 #: ../src/guestfs-actions.pod:6380
14694 msgid "guestfs_upload_offset"
14698 #: ../src/guestfs-actions.pod:6382
14702 " guestfs_upload_offset (guestfs_h *g,\n"
14703 " const char *filename,\n"
14704 " const char *remotefilename,\n"
14705 " int64_t offset);\n"
14710 #: ../src/guestfs-actions.pod:6391 ../fish/guestfish-actions.pod:4286
14712 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14713 "The intention is to overwrite parts of existing files or devices, although "
14714 "if a non-existant file is specified then it is created with a \"hole\" "
14715 "before C<offset>. The size of the data written is implicit in the size of "
14716 "the source C<filename>."
14720 #: ../src/guestfs-actions.pod:6398
14722 "Note that there is no limit on the amount of data that can be uploaded with "
14723 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
14724 "full amount unless an error occurs."
14728 #: ../src/guestfs-actions.pod:6403
14729 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
14733 #: ../src/guestfs-actions.pod:6409
14734 msgid "guestfs_utimens"
14738 #: ../src/guestfs-actions.pod:6411
14742 " guestfs_utimens (guestfs_h *g,\n"
14743 " const char *path,\n"
14744 " int64_t atsecs,\n"
14745 " int64_t atnsecs,\n"
14746 " int64_t mtsecs,\n"
14747 " int64_t mtnsecs);\n"
14752 #: ../src/guestfs-actions.pod:6419 ../fish/guestfish-actions.pod:4306
14753 msgid "This command sets the timestamps of a file with nanosecond precision."
14757 #: ../src/guestfs-actions.pod:6422 ../fish/guestfish-actions.pod:4309
14759 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14764 #: ../src/guestfs-actions.pod:6425 ../fish/guestfish-actions.pod:4312
14766 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14767 "nanoseconds from the epoch."
14771 #: ../src/guestfs-actions.pod:6428 ../fish/guestfish-actions.pod:4315
14773 "If the C<*nsecs> field contains the special value C<-1> then the "
14774 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14775 "ignored in this case)."
14779 #: ../src/guestfs-actions.pod:6432 ../fish/guestfish-actions.pod:4319
14781 "If the C<*nsecs> field contains the special value C<-2> then the "
14782 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14787 #: ../src/guestfs-actions.pod:6440 ../src/guestfs-structs.pod:175
14788 msgid "guestfs_version"
14792 #: ../src/guestfs-actions.pod:6442
14795 " struct guestfs_version *\n"
14796 " guestfs_version (guestfs_h *g);\n"
14801 #: ../src/guestfs-actions.pod:6445 ../fish/guestfish-actions.pod:4327
14802 msgid "Return the libguestfs version number that the program is linked against."
14806 #: ../src/guestfs-actions.pod:6448 ../fish/guestfish-actions.pod:4330
14808 "Note that because of dynamic linking this is not necessarily the version of "
14809 "libguestfs that you compiled against. You can compile the program, and then "
14810 "at runtime dynamically link against a completely different C<libguestfs.so> "
14815 #: ../src/guestfs-actions.pod:6453 ../fish/guestfish-actions.pod:4335
14817 "This call was added in version C<1.0.58>. In previous versions of "
14818 "libguestfs there was no way to get the version number. From C code you can "
14819 "use dynamic linker functions to find out if this symbol exists (if it "
14820 "doesn't, then it's an earlier version)."
14824 #: ../src/guestfs-actions.pod:6459 ../fish/guestfish-actions.pod:4341
14826 "The call returns a structure with four elements. The first three (C<major>, "
14827 "C<minor> and C<release>) are numbers and correspond to the usual version "
14828 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14829 "but may be used for distro-specific information."
14833 #: ../src/guestfs-actions.pod:6465 ../fish/guestfish-actions.pod:4347
14834 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14838 #: ../src/guestfs-actions.pod:6468 ../fish/guestfish-actions.pod:4350
14839 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14843 #: ../src/guestfs-actions.pod:6470
14845 "I<Note:> Don't use this call to test for availability of features. In "
14846 "enterprise distributions we backport features from later versions into "
14847 "earlier versions, making this an unreliable way to test for features. Use "
14848 "C<guestfs_available> instead."
14852 #: ../src/guestfs-actions.pod:6476
14854 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
14855 "error. I<The caller must call C<guestfs_free_version> after use>."
14859 #: ../src/guestfs-actions.pod:6480
14860 msgid "(Added in 1.0.58)"
14864 #: ../src/guestfs-actions.pod:6482
14865 msgid "guestfs_vfs_label"
14869 #: ../src/guestfs-actions.pod:6484
14873 " guestfs_vfs_label (guestfs_h *g,\n"
14874 " const char *device);\n"
14879 #: ../src/guestfs-actions.pod:6488 ../fish/guestfish-actions.pod:4362
14880 msgid "This returns the filesystem label of the filesystem on C<device>."
14884 #: ../src/guestfs-actions.pod:6491 ../fish/guestfish-actions.pod:4365
14885 msgid "If the filesystem is unlabeled, this returns the empty string."
14889 #: ../src/guestfs-actions.pod:6493
14890 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
14894 #: ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6535
14895 msgid "(Added in 1.3.18)"
14899 #: ../src/guestfs-actions.pod:6500
14900 msgid "guestfs_vfs_type"
14904 #: ../src/guestfs-actions.pod:6502
14908 " guestfs_vfs_type (guestfs_h *g,\n"
14909 " const char *device);\n"
14914 #: ../src/guestfs-actions.pod:6506 ../fish/guestfish-actions.pod:4373
14916 "This command gets the filesystem type corresponding to the filesystem on "
14921 #: ../src/guestfs-actions.pod:6509 ../fish/guestfish-actions.pod:4376
14923 "For most filesystems, the result is the name of the Linux VFS module which "
14924 "would be used to mount this filesystem if you mounted it without specifying "
14925 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14929 #: ../src/guestfs-actions.pod:6519
14930 msgid "guestfs_vfs_uuid"
14934 #: ../src/guestfs-actions.pod:6521
14938 " guestfs_vfs_uuid (guestfs_h *g,\n"
14939 " const char *device);\n"
14944 #: ../src/guestfs-actions.pod:6525 ../fish/guestfish-actions.pod:4385
14945 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14949 #: ../src/guestfs-actions.pod:6528 ../fish/guestfish-actions.pod:4388
14950 msgid "If the filesystem does not have a UUID, this returns the empty string."
14954 #: ../src/guestfs-actions.pod:6530
14955 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
14959 #: ../src/guestfs-actions.pod:6537
14960 msgid "guestfs_vg_activate"
14964 #: ../src/guestfs-actions.pod:6539
14968 " guestfs_vg_activate (guestfs_h *g,\n"
14970 " char *const *volgroups);\n"
14975 #: ../src/guestfs-actions.pod:6544 ../fish/guestfish-actions.pod:4396
14977 "This command activates or (if C<activate> is false) deactivates all logical "
14978 "volumes in the listed volume groups C<volgroups>. If activated, then they "
14979 "are made known to the kernel, ie. they appear as C</dev/mapper> devices. If "
14980 "deactivated, then those devices disappear."
14984 #: ../src/guestfs-actions.pod:6550 ../fish/guestfish-actions.pod:4402
14985 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14989 #: ../src/guestfs-actions.pod:6552 ../fish/guestfish-actions.pod:4404
14991 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14992 "activated or deactivated."
14996 #: ../src/guestfs-actions.pod:6559
14997 msgid "guestfs_vg_activate_all"
15001 #: ../src/guestfs-actions.pod:6561
15005 " guestfs_vg_activate_all (guestfs_h *g,\n"
15006 " int activate);\n"
15011 #: ../src/guestfs-actions.pod:6565 ../fish/guestfish-actions.pod:4411
15013 "This command activates or (if C<activate> is false) deactivates all logical "
15014 "volumes in all volume groups. If activated, then they are made known to the "
15015 "kernel, ie. they appear as C</dev/mapper> devices. If deactivated, then "
15016 "those devices disappear."
15020 #: ../src/guestfs-actions.pod:6571 ../fish/guestfish-actions.pod:4417
15021 msgid "This command is the same as running C<vgchange -a y|n>"
15025 #: ../src/guestfs-actions.pod:6577
15026 msgid "guestfs_vgcreate"
15030 #: ../src/guestfs-actions.pod:6579
15034 " guestfs_vgcreate (guestfs_h *g,\n"
15035 " const char *volgroup,\n"
15036 " char *const *physvols);\n"
15041 #: ../src/guestfs-actions.pod:6584 ../fish/guestfish-actions.pod:4423
15043 "This creates an LVM volume group called C<volgroup> from the non-empty list "
15044 "of physical volumes C<physvols>."
15048 #: ../src/guestfs-actions.pod:6591
15049 msgid "guestfs_vglvuuids"
15053 #: ../src/guestfs-actions.pod:6593
15057 " guestfs_vglvuuids (guestfs_h *g,\n"
15058 " const char *vgname);\n"
15063 #: ../src/guestfs-actions.pod:6597 ../fish/guestfish-actions.pod:4430
15065 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
15066 "volumes created in this volume group."
15070 #: ../src/guestfs-actions.pod:6600
15072 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
15073 "associate logical volumes and volume groups."
15077 #: ../src/guestfs-actions.pod:6603
15078 msgid "See also C<guestfs_vgpvuuids>."
15082 #: ../src/guestfs-actions.pod:6611
15083 msgid "guestfs_vgpvuuids"
15087 #: ../src/guestfs-actions.pod:6613
15091 " guestfs_vgpvuuids (guestfs_h *g,\n"
15092 " const char *vgname);\n"
15097 #: ../src/guestfs-actions.pod:6617 ../fish/guestfish-actions.pod:4442
15099 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
15100 "volumes that this volume group resides on."
15104 #: ../src/guestfs-actions.pod:6620
15106 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
15107 "associate physical volumes and volume groups."
15111 #: ../src/guestfs-actions.pod:6623
15112 msgid "See also C<guestfs_vglvuuids>."
15116 #: ../src/guestfs-actions.pod:6631
15117 msgid "guestfs_vgremove"
15121 #: ../src/guestfs-actions.pod:6633
15125 " guestfs_vgremove (guestfs_h *g,\n"
15126 " const char *vgname);\n"
15131 #: ../src/guestfs-actions.pod:6637 ../fish/guestfish-actions.pod:4454
15132 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
15136 #: ../src/guestfs-actions.pod:6639 ../fish/guestfish-actions.pod:4456
15137 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
15141 #: ../src/guestfs-actions.pod:6646
15142 msgid "guestfs_vgrename"
15146 #: ../src/guestfs-actions.pod:6648
15150 " guestfs_vgrename (guestfs_h *g,\n"
15151 " const char *volgroup,\n"
15152 " const char *newvolgroup);\n"
15157 #: ../src/guestfs-actions.pod:6653 ../fish/guestfish-actions.pod:4463
15158 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
15162 #: ../src/guestfs-actions.pod:6659
15163 msgid "guestfs_vgs"
15167 #: ../src/guestfs-actions.pod:6661
15171 " guestfs_vgs (guestfs_h *g);\n"
15176 #: ../src/guestfs-actions.pod:6664 ../fish/guestfish-actions.pod:4469
15178 "List all the volumes groups detected. This is the equivalent of the "
15179 "L<vgs(8)> command."
15183 #: ../src/guestfs-actions.pod:6667 ../fish/guestfish-actions.pod:4472
15185 "This returns a list of just the volume group names that were detected "
15186 "(eg. C<VolGroup00>)."
15190 #: ../src/guestfs-actions.pod:6670
15191 msgid "See also C<guestfs_vgs_full>."
15195 #: ../src/guestfs-actions.pod:6678
15196 msgid "guestfs_vgs_full"
15200 #: ../src/guestfs-actions.pod:6680
15203 " struct guestfs_lvm_vg_list *\n"
15204 " guestfs_vgs_full (guestfs_h *g);\n"
15209 #: ../src/guestfs-actions.pod:6683 ../fish/guestfish-actions.pod:4481
15211 "List all the volumes groups detected. This is the equivalent of the "
15212 "L<vgs(8)> command. The \"full\" version includes all fields."
15216 #: ../src/guestfs-actions.pod:6686
15218 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
15219 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
15224 #: ../src/guestfs-actions.pod:6692
15225 msgid "guestfs_vgscan"
15229 #: ../src/guestfs-actions.pod:6694
15233 " guestfs_vgscan (guestfs_h *g);\n"
15238 #: ../src/guestfs-actions.pod:6697 ../fish/guestfish-actions.pod:4488
15240 "This rescans all block devices and rebuilds the list of LVM physical "
15241 "volumes, volume groups and logical volumes."
15245 #: ../src/guestfs-actions.pod:6704
15246 msgid "guestfs_vguuid"
15250 #: ../src/guestfs-actions.pod:6706
15254 " guestfs_vguuid (guestfs_h *g,\n"
15255 " const char *vgname);\n"
15260 #: ../src/guestfs-actions.pod:6710 ../fish/guestfish-actions.pod:4495
15261 msgid "This command returns the UUID of the LVM VG named C<vgname>."
15265 #: ../src/guestfs-actions.pod:6717
15266 msgid "guestfs_wait_ready"
15270 #: ../src/guestfs-actions.pod:6719
15274 " guestfs_wait_ready (guestfs_h *g);\n"
15279 #: ../src/guestfs-actions.pod:6722
15280 msgid "This function is a no op."
15284 #: ../src/guestfs-actions.pod:6724
15286 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
15287 "calling C<guestfs_launch> to wait for the launch to complete. However this "
15288 "is no longer necessary because C<guestfs_launch> now does the waiting."
15292 #: ../src/guestfs-actions.pod:6729
15294 "If you see any calls to this function in code then you can just remove them, "
15295 "unless you want to retain compatibility with older versions of the API."
15299 #: ../src/guestfs-actions.pod:6737
15300 msgid "guestfs_wc_c"
15304 #: ../src/guestfs-actions.pod:6739
15308 " guestfs_wc_c (guestfs_h *g,\n"
15309 " const char *path);\n"
15314 #: ../src/guestfs-actions.pod:6743 ../fish/guestfish-actions.pod:4501
15316 "This command counts the characters in a file, using the C<wc -c> external "
15321 #: ../src/guestfs-actions.pod:6750
15322 msgid "guestfs_wc_l"
15326 #: ../src/guestfs-actions.pod:6752
15330 " guestfs_wc_l (guestfs_h *g,\n"
15331 " const char *path);\n"
15336 #: ../src/guestfs-actions.pod:6756 ../fish/guestfish-actions.pod:4508
15338 "This command counts the lines in a file, using the C<wc -l> external "
15343 #: ../src/guestfs-actions.pod:6763
15344 msgid "guestfs_wc_w"
15348 #: ../src/guestfs-actions.pod:6765
15352 " guestfs_wc_w (guestfs_h *g,\n"
15353 " const char *path);\n"
15358 #: ../src/guestfs-actions.pod:6769 ../fish/guestfish-actions.pod:4515
15360 "This command counts the words in a file, using the C<wc -w> external "
15365 #: ../src/guestfs-actions.pod:6776
15366 msgid "guestfs_write"
15370 #: ../src/guestfs-actions.pod:6778
15374 " guestfs_write (guestfs_h *g,\n"
15375 " const char *path,\n"
15376 " const char *content,\n"
15377 " size_t content_size);\n"
15382 #: ../src/guestfs-actions.pod:6784 ../fish/guestfish-actions.pod:4522
15384 "This call creates a file called C<path>. The content of the file is the "
15385 "string C<content> (which can contain any 8 bit data)."
15389 #: ../src/guestfs-actions.pod:6794
15390 msgid "guestfs_write_file"
15394 #: ../src/guestfs-actions.pod:6796
15398 " guestfs_write_file (guestfs_h *g,\n"
15399 " const char *path,\n"
15400 " const char *content,\n"
15406 #: ../src/guestfs-actions.pod:6802 ../fish/guestfish-actions.pod:4532
15408 "This call creates a file called C<path>. The contents of the file is the "
15409 "string C<content> (which can contain any 8 bit data), with length C<size>."
15413 #: ../src/guestfs-actions.pod:6806 ../fish/guestfish-actions.pod:4536
15415 "As a special case, if C<size> is C<0> then the length is calculated using "
15416 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
15420 #: ../src/guestfs-actions.pod:6810 ../fish/guestfish-actions.pod:4540
15422 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
15423 "I<not> work, even if the length is specified."
15427 #: ../src/guestfs-actions.pod:6818 ../fish/guestfish-actions.pod:4546
15428 msgid "This function is deprecated. In new code, use the C<write> call instead."
15432 #: ../src/guestfs-actions.pod:6827
15433 msgid "guestfs_zegrep"
15437 #: ../src/guestfs-actions.pod:6829
15441 " guestfs_zegrep (guestfs_h *g,\n"
15442 " const char *regex,\n"
15443 " const char *path);\n"
15448 #: ../src/guestfs-actions.pod:6834 ../fish/guestfish-actions.pod:4557
15449 msgid "This calls the external C<zegrep> program and returns the matching lines."
15453 #: ../src/guestfs-actions.pod:6846
15454 msgid "guestfs_zegrepi"
15458 #: ../src/guestfs-actions.pod:6848
15462 " guestfs_zegrepi (guestfs_h *g,\n"
15463 " const char *regex,\n"
15464 " const char *path);\n"
15469 #: ../src/guestfs-actions.pod:6853 ../fish/guestfish-actions.pod:4567
15470 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15474 #: ../src/guestfs-actions.pod:6865
15475 msgid "guestfs_zero"
15479 #: ../src/guestfs-actions.pod:6867
15483 " guestfs_zero (guestfs_h *g,\n"
15484 " const char *device);\n"
15489 #: ../src/guestfs-actions.pod:6871 ../fish/guestfish-actions.pod:4577
15490 msgid "This command writes zeroes over the first few blocks of C<device>."
15494 #: ../src/guestfs-actions.pod:6873 ../fish/guestfish-actions.pod:4579
15496 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15497 "securely wipe the device). It should be sufficient to remove any partition "
15498 "tables, filesystem superblocks and so on."
15502 #: ../src/guestfs-actions.pod:6877
15503 msgid "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>."
15507 #: ../src/guestfs-actions.pod:6888
15508 msgid "guestfs_zero_device"
15512 #: ../src/guestfs-actions.pod:6890
15516 " guestfs_zero_device (guestfs_h *g,\n"
15517 " const char *device);\n"
15522 #: ../src/guestfs-actions.pod:6894
15524 "This command writes zeroes over the entire C<device>. Compare with "
15525 "C<guestfs_zero> which just zeroes the first few blocks of a device."
15529 #: ../src/guestfs-actions.pod:6908
15530 msgid "(Added in 1.3.1)"
15534 #: ../src/guestfs-actions.pod:6910
15535 msgid "guestfs_zerofree"
15539 #: ../src/guestfs-actions.pod:6912
15543 " guestfs_zerofree (guestfs_h *g,\n"
15544 " const char *device);\n"
15549 #: ../src/guestfs-actions.pod:6916 ../fish/guestfish-actions.pod:4600
15551 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15552 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15553 "possible to compress the filesystem more effectively."
15557 #: ../src/guestfs-actions.pod:6921 ../fish/guestfish-actions.pod:4605
15558 msgid "You should B<not> run this program if the filesystem is mounted."
15562 #: ../src/guestfs-actions.pod:6924 ../fish/guestfish-actions.pod:4608
15564 "It is possible that using this program can damage the filesystem or data on "
15569 #: ../src/guestfs-actions.pod:6931
15570 msgid "guestfs_zfgrep"
15574 #: ../src/guestfs-actions.pod:6933
15578 " guestfs_zfgrep (guestfs_h *g,\n"
15579 " const char *pattern,\n"
15580 " const char *path);\n"
15585 #: ../src/guestfs-actions.pod:6938 ../fish/guestfish-actions.pod:4615
15586 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15590 #: ../src/guestfs-actions.pod:6950
15591 msgid "guestfs_zfgrepi"
15595 #: ../src/guestfs-actions.pod:6952
15599 " guestfs_zfgrepi (guestfs_h *g,\n"
15600 " const char *pattern,\n"
15601 " const char *path);\n"
15606 #: ../src/guestfs-actions.pod:6957 ../fish/guestfish-actions.pod:4625
15607 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15611 #: ../src/guestfs-actions.pod:6969
15612 msgid "guestfs_zfile"
15616 #: ../src/guestfs-actions.pod:6971
15620 " guestfs_zfile (guestfs_h *g,\n"
15621 " const char *meth,\n"
15622 " const char *path);\n"
15627 #: ../src/guestfs-actions.pod:6976 ../fish/guestfish-actions.pod:4635
15628 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15632 #: ../src/guestfs-actions.pod:6979 ../fish/guestfish-actions.pod:4638
15633 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15637 #: ../src/guestfs-actions.pod:6981
15639 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
15644 #: ../src/guestfs-actions.pod:6987 ../fish/guestfish-actions.pod:4643
15645 msgid "This function is deprecated. In new code, use the C<file> call instead."
15649 #: ../src/guestfs-actions.pod:6996
15650 msgid "guestfs_zgrep"
15654 #: ../src/guestfs-actions.pod:6998
15658 " guestfs_zgrep (guestfs_h *g,\n"
15659 " const char *regex,\n"
15660 " const char *path);\n"
15665 #: ../src/guestfs-actions.pod:7003 ../fish/guestfish-actions.pod:4654
15666 msgid "This calls the external C<zgrep> program and returns the matching lines."
15670 #: ../src/guestfs-actions.pod:7015
15671 msgid "guestfs_zgrepi"
15675 #: ../src/guestfs-actions.pod:7017
15679 " guestfs_zgrepi (guestfs_h *g,\n"
15680 " const char *regex,\n"
15681 " const char *path);\n"
15686 #: ../src/guestfs-actions.pod:7022 ../fish/guestfish-actions.pod:4664
15687 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15691 #: ../src/guestfs-availability.pod:3
15696 #: ../src/guestfs-availability.pod:5
15698 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
15699 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
15700 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
15701 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
15702 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
15706 #: ../src/guestfs-availability.pod:21
15711 #: ../src/guestfs-availability.pod:23
15713 "The following functions: L</guestfs_inotify_add_watch> "
15714 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
15715 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
15719 #: ../src/guestfs-availability.pod:31
15720 msgid "B<linuxfsuuid>"
15724 #: ../src/guestfs-availability.pod:33
15726 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
15727 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
15731 #: ../src/guestfs-availability.pod:40
15732 msgid "B<linuxmodules>"
15736 #: ../src/guestfs-availability.pod:42
15737 msgid "The following functions: L</guestfs_modprobe>"
15741 #: ../src/guestfs-availability.pod:45
15742 msgid "B<linuxxattrs>"
15746 #: ../src/guestfs-availability.pod:47
15748 "The following functions: L</guestfs_getxattrs> L</guestfs_lgetxattrs> "
15749 "L</guestfs_lremovexattr> L</guestfs_lsetxattr> L</guestfs_lxattrlist> "
15750 "L</guestfs_removexattr> L</guestfs_setxattr>"
15754 #: ../src/guestfs-availability.pod:56
15759 #: ../src/guestfs-availability.pod:58
15761 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
15762 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
15763 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
15767 #: ../src/guestfs-availability.pod:67
15772 #: ../src/guestfs-availability.pod:69
15774 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
15775 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
15776 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
15777 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
15778 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
15779 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
15780 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
15781 "L</guestfs_vgs_full>"
15785 #: ../src/guestfs-availability.pod:92
15790 #: ../src/guestfs-availability.pod:94
15792 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
15793 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
15797 #: ../src/guestfs-availability.pod:100
15802 #: ../src/guestfs-availability.pod:102
15803 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
15807 #: ../src/guestfs-availability.pod:105
15808 msgid "B<ntfsprogs>"
15812 #: ../src/guestfs-availability.pod:107
15813 msgid "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_size>"
15817 #: ../src/guestfs-availability.pod:111
15818 msgid "B<realpath>"
15822 #: ../src/guestfs-availability.pod:113
15823 msgid "The following functions: L</guestfs_realpath>"
15827 #: ../src/guestfs-availability.pod:116
15832 #: ../src/guestfs-availability.pod:118
15834 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
15835 "L</guestfs_scrub_freespace>"
15839 #: ../src/guestfs-availability.pod:123
15844 #: ../src/guestfs-availability.pod:125
15845 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
15849 #: ../src/guestfs-availability.pod:129
15854 #: ../src/guestfs-availability.pod:131
15855 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
15859 #: ../src/guestfs-availability.pod:135
15860 msgid "B<zerofree>"
15864 #: ../src/guestfs-availability.pod:137
15865 msgid "The following functions: L</guestfs_zerofree>"
15869 #: ../src/guestfs-structs.pod:1
15870 msgid "guestfs_int_bool"
15874 #: ../src/guestfs-structs.pod:3
15877 " struct guestfs_int_bool {\n"
15885 #: ../src/guestfs-structs.pod:8
15888 " struct guestfs_int_bool_list {\n"
15889 " uint32_t len; /* Number of elements in list. */\n"
15890 " struct guestfs_int_bool *val; /* Elements. */\n"
15896 #: ../src/guestfs-structs.pod:13
15899 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
15900 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
15905 #: ../src/guestfs-structs.pod:16
15906 msgid "guestfs_lvm_pv"
15910 #: ../src/guestfs-structs.pod:18
15913 " struct guestfs_lvm_pv {\n"
15914 " char *pv_name;\n"
15915 " /* The next field is NOT nul-terminated, be careful when printing it: "
15917 " char pv_uuid[32];\n"
15919 " uint64_t pv_size;\n"
15920 " uint64_t dev_size;\n"
15921 " uint64_t pv_free;\n"
15922 " uint64_t pv_used;\n"
15923 " char *pv_attr;\n"
15924 " int64_t pv_pe_count;\n"
15925 " int64_t pv_pe_alloc_count;\n"
15926 " char *pv_tags;\n"
15927 " uint64_t pe_start;\n"
15928 " int64_t pv_mda_count;\n"
15929 " uint64_t pv_mda_free;\n"
15935 #: ../src/guestfs-structs.pod:36
15938 " struct guestfs_lvm_pv_list {\n"
15939 " uint32_t len; /* Number of elements in list. */\n"
15940 " struct guestfs_lvm_pv *val; /* Elements. */\n"
15946 #: ../src/guestfs-structs.pod:41
15949 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
15950 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
15955 #: ../src/guestfs-structs.pod:44
15956 msgid "guestfs_lvm_vg"
15960 #: ../src/guestfs-structs.pod:46
15963 " struct guestfs_lvm_vg {\n"
15964 " char *vg_name;\n"
15965 " /* The next field is NOT nul-terminated, be careful when printing it: "
15967 " char vg_uuid[32];\n"
15969 " char *vg_attr;\n"
15970 " uint64_t vg_size;\n"
15971 " uint64_t vg_free;\n"
15972 " char *vg_sysid;\n"
15973 " uint64_t vg_extent_size;\n"
15974 " int64_t vg_extent_count;\n"
15975 " int64_t vg_free_count;\n"
15976 " int64_t max_lv;\n"
15977 " int64_t max_pv;\n"
15978 " int64_t pv_count;\n"
15979 " int64_t lv_count;\n"
15980 " int64_t snap_count;\n"
15981 " int64_t vg_seqno;\n"
15982 " char *vg_tags;\n"
15983 " int64_t vg_mda_count;\n"
15984 " uint64_t vg_mda_free;\n"
15990 #: ../src/guestfs-structs.pod:69
15993 " struct guestfs_lvm_vg_list {\n"
15994 " uint32_t len; /* Number of elements in list. */\n"
15995 " struct guestfs_lvm_vg *val; /* Elements. */\n"
16001 #: ../src/guestfs-structs.pod:74
16004 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
16005 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
16010 #: ../src/guestfs-structs.pod:77
16011 msgid "guestfs_lvm_lv"
16015 #: ../src/guestfs-structs.pod:79
16018 " struct guestfs_lvm_lv {\n"
16019 " char *lv_name;\n"
16020 " /* The next field is NOT nul-terminated, be careful when printing it: "
16022 " char lv_uuid[32];\n"
16023 " char *lv_attr;\n"
16024 " int64_t lv_major;\n"
16025 " int64_t lv_minor;\n"
16026 " int64_t lv_kernel_major;\n"
16027 " int64_t lv_kernel_minor;\n"
16028 " uint64_t lv_size;\n"
16029 " int64_t seg_count;\n"
16031 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16032 " float snap_percent;\n"
16033 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
16034 " float copy_percent;\n"
16035 " char *move_pv;\n"
16036 " char *lv_tags;\n"
16037 " char *mirror_log;\n"
16038 " char *modules;\n"
16044 #: ../src/guestfs-structs.pod:101
16047 " struct guestfs_lvm_lv_list {\n"
16048 " uint32_t len; /* Number of elements in list. */\n"
16049 " struct guestfs_lvm_lv *val; /* Elements. */\n"
16055 #: ../src/guestfs-structs.pod:106
16058 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
16059 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
16064 #: ../src/guestfs-structs.pod:111
16067 " struct guestfs_stat {\n"
16071 " int64_t nlink;\n"
16076 " int64_t blksize;\n"
16077 " int64_t blocks;\n"
16078 " int64_t atime;\n"
16079 " int64_t mtime;\n"
16080 " int64_t ctime;\n"
16086 #: ../src/guestfs-structs.pod:127
16089 " struct guestfs_stat_list {\n"
16090 " uint32_t len; /* Number of elements in list. */\n"
16091 " struct guestfs_stat *val; /* Elements. */\n"
16097 #: ../src/guestfs-structs.pod:132
16100 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
16101 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
16106 #: ../src/guestfs-structs.pod:137
16109 " struct guestfs_statvfs {\n"
16110 " int64_t bsize;\n"
16111 " int64_t frsize;\n"
16112 " int64_t blocks;\n"
16113 " int64_t bfree;\n"
16114 " int64_t bavail;\n"
16115 " int64_t files;\n"
16116 " int64_t ffree;\n"
16117 " int64_t favail;\n"
16120 " int64_t namemax;\n"
16126 #: ../src/guestfs-structs.pod:151
16129 " struct guestfs_statvfs_list {\n"
16130 " uint32_t len; /* Number of elements in list. */\n"
16131 " struct guestfs_statvfs *val; /* Elements. */\n"
16137 #: ../src/guestfs-structs.pod:156
16140 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
16141 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
16146 #: ../src/guestfs-structs.pod:159
16147 msgid "guestfs_dirent"
16151 #: ../src/guestfs-structs.pod:161
16154 " struct guestfs_dirent {\n"
16163 #: ../src/guestfs-structs.pod:167
16166 " struct guestfs_dirent_list {\n"
16167 " uint32_t len; /* Number of elements in list. */\n"
16168 " struct guestfs_dirent *val; /* Elements. */\n"
16174 #: ../src/guestfs-structs.pod:172
16177 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
16178 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
16183 #: ../src/guestfs-structs.pod:177
16186 " struct guestfs_version {\n"
16187 " int64_t major;\n"
16188 " int64_t minor;\n"
16189 " int64_t release;\n"
16196 #: ../src/guestfs-structs.pod:184
16199 " struct guestfs_version_list {\n"
16200 " uint32_t len; /* Number of elements in list. */\n"
16201 " struct guestfs_version *val; /* Elements. */\n"
16207 #: ../src/guestfs-structs.pod:189
16210 " void guestfs_free_version (struct guestfs_free_version *);\n"
16211 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
16216 #: ../src/guestfs-structs.pod:192
16217 msgid "guestfs_xattr"
16221 #: ../src/guestfs-structs.pod:194
16224 " struct guestfs_xattr {\n"
16225 " char *attrname;\n"
16226 " /* The next two fields describe a byte array. */\n"
16227 " uint32_t attrval_len;\n"
16228 " char *attrval;\n"
16234 #: ../src/guestfs-structs.pod:201
16237 " struct guestfs_xattr_list {\n"
16238 " uint32_t len; /* Number of elements in list. */\n"
16239 " struct guestfs_xattr *val; /* Elements. */\n"
16245 #: ../src/guestfs-structs.pod:206
16248 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
16249 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
16254 #: ../src/guestfs-structs.pod:209
16255 msgid "guestfs_inotify_event"
16259 #: ../src/guestfs-structs.pod:211
16262 " struct guestfs_inotify_event {\n"
16263 " int64_t in_wd;\n"
16264 " uint32_t in_mask;\n"
16265 " uint32_t in_cookie;\n"
16266 " char *in_name;\n"
16272 #: ../src/guestfs-structs.pod:218
16275 " struct guestfs_inotify_event_list {\n"
16276 " uint32_t len; /* Number of elements in list. */\n"
16277 " struct guestfs_inotify_event *val; /* Elements. */\n"
16283 #: ../src/guestfs-structs.pod:223
16286 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
16287 " void guestfs_free_inotify_event_list (struct "
16288 "guestfs_free_inotify_event_list *);\n"
16293 #: ../src/guestfs-structs.pod:226
16294 msgid "guestfs_partition"
16298 #: ../src/guestfs-structs.pod:228
16301 " struct guestfs_partition {\n"
16302 " int32_t part_num;\n"
16303 " uint64_t part_start;\n"
16304 " uint64_t part_end;\n"
16305 " uint64_t part_size;\n"
16311 #: ../src/guestfs-structs.pod:235
16314 " struct guestfs_partition_list {\n"
16315 " uint32_t len; /* Number of elements in list. */\n"
16316 " struct guestfs_partition *val; /* Elements. */\n"
16322 #: ../src/guestfs-structs.pod:240
16325 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
16326 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
16331 #: ../src/guestfs-structs.pod:243
16332 msgid "guestfs_application"
16336 #: ../src/guestfs-structs.pod:245
16339 " struct guestfs_application {\n"
16340 " char *app_name;\n"
16341 " char *app_display_name;\n"
16342 " int32_t app_epoch;\n"
16343 " char *app_version;\n"
16344 " char *app_release;\n"
16345 " char *app_install_path;\n"
16346 " char *app_trans_path;\n"
16347 " char *app_publisher;\n"
16348 " char *app_url;\n"
16349 " char *app_source_package;\n"
16350 " char *app_summary;\n"
16351 " char *app_description;\n"
16357 #: ../src/guestfs-structs.pod:260
16360 " struct guestfs_application_list {\n"
16361 " uint32_t len; /* Number of elements in list. */\n"
16362 " struct guestfs_application *val; /* Elements. */\n"
16368 #: ../src/guestfs-structs.pod:265
16371 " void guestfs_free_application (struct guestfs_free_application *);\n"
16372 " void guestfs_free_application_list (struct guestfs_free_application_list "
16378 #: ../fish/guestfish.pod:5
16379 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
16383 #: ../fish/guestfish.pod:9
16386 " guestfish [--options] [commands]\n"
16391 #: ../fish/guestfish.pod:11
16399 #: ../fish/guestfish.pod:13
16402 " guestfish [--ro|--rw] -a disk.img\n"
16407 #: ../fish/guestfish.pod:15
16410 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
16415 #: ../fish/guestfish.pod:17
16418 " guestfish -d libvirt-domain\n"
16423 #: ../fish/guestfish.pod:19
16426 " guestfish [--ro|--rw] -a disk.img -i\n"
16431 #: ../fish/guestfish.pod:21
16434 " guestfish -d libvirt-domain -i\n"
16439 #: ../fish/guestfish.pod:23 ../fuse/guestmount.pod:15 ../tools/virt-edit.pl:44 ../tools/virt-win-reg.pl:51 ../tools/virt-tar.pl:59 ../tools/virt-rescue.pl:41
16444 #: ../fish/guestfish.pod:25
16446 "Using guestfish in read/write mode on live virtual machines can be "
16447 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
16448 "option to use guestfish safely if the disk image or virtual machine might be "
16453 #: ../fish/guestfish.pod:32
16455 "Guestfish is a shell and command-line tool for examining and modifying "
16456 "virtual machine filesystems. It uses libguestfs and exposes all of the "
16457 "functionality of the guestfs API, see L<guestfs(3)>."
16461 #: ../fish/guestfish.pod:36
16463 "Guestfish gives you structured access to the libguestfs API, from shell "
16464 "scripts or the command line or interactively. If you want to rescue a "
16465 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
16470 #: ../fish/guestfish.pod:41 ../fish/guestfish.pod:846 ../fuse/guestmount.pod:39 ../tools/virt-edit.pl:58 ../tools/virt-resize.pl:66 ../tools/virt-tar.pl:45
16475 #: ../fish/guestfish.pod:43
16476 msgid "As an interactive shell"
16480 #: ../fish/guestfish.pod:45
16488 #: ../fish/guestfish.pod:47
16491 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
16492 " editing virtual machine filesystems.\n"
16497 #: ../fish/guestfish.pod:50
16500 " Type: 'help' for a list of commands\n"
16501 " 'man' to read the manual\n"
16502 " 'quit' to quit the shell\n"
16507 #: ../fish/guestfish.pod:54
16510 " ><fs> add-ro disk.img\n"
16512 " ><fs> list-filesystems\n"
16513 " /dev/sda1: ext4\n"
16514 " /dev/vg_guest/lv_root: ext4\n"
16515 " /dev/vg_guest/lv_swap: swap\n"
16516 " ><fs> mount /dev/vg_guest/lv_root /\n"
16517 " ><fs> cat /etc/fstab\n"
16519 " # Created by anaconda\n"
16526 #: ../fish/guestfish.pod:67
16527 msgid "From shell scripts"
16531 #: ../fish/guestfish.pod:69
16532 msgid "Create a new C</etc/motd> file in a guest or disk image:"
16536 #: ../fish/guestfish.pod:71
16539 " guestfish <<_EOF_\n"
16542 " mount /dev/vg_guest/lv_root /\n"
16543 " write /etc/motd \"Welcome, new users\"\n"
16549 #: ../fish/guestfish.pod:78
16550 msgid "List the LVM logical volumes in a disk image:"
16554 #: ../fish/guestfish.pod:80
16557 " guestfish -a disk.img --ro <<_EOF_\n"
16565 #: ../fish/guestfish.pod:85
16566 msgid "List all the filesystems in a disk image:"
16570 #: ../fish/guestfish.pod:87
16573 " guestfish -a disk.img --ro <<_EOF_\n"
16575 " list-filesystems\n"
16581 #: ../fish/guestfish.pod:92
16582 msgid "On one command line"
16586 #: ../fish/guestfish.pod:94
16587 msgid "Update C</etc/resolv.conf> in a guest:"
16591 #: ../fish/guestfish.pod:96
16595 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
16596 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
16601 #: ../fish/guestfish.pod:100
16602 msgid "Edit C</boot/grub/grub.conf> interactively:"
16606 #: ../fish/guestfish.pod:102
16609 " guestfish --rw --add disk.img \\\n"
16610 " --mount /dev/vg_guest/lv_root \\\n"
16611 " --mount /dev/sda1:/boot \\\n"
16612 " edit /boot/grub/grub.conf\n"
16617 #: ../fish/guestfish.pod:107
16618 msgid "Mount disks automatically"
16622 #: ../fish/guestfish.pod:109
16624 "Use the I<-i> option to automatically mount the disks from a virtual "
16629 #: ../fish/guestfish.pod:112
16632 " guestfish --ro -a disk.img -i cat /etc/group\n"
16637 #: ../fish/guestfish.pod:114
16640 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16645 #: ../fish/guestfish.pod:116
16646 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16650 #: ../fish/guestfish.pod:118
16653 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16658 #: ../fish/guestfish.pod:120
16659 msgid "As a script interpreter"
16663 #: ../fish/guestfish.pod:122
16664 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16668 #: ../fish/guestfish.pod:124
16671 " #!/usr/bin/guestfish -f\n"
16672 " sparse test1.img 100M\n"
16674 " part-disk /dev/sda mbr\n"
16675 " mkfs ext2 /dev/sda1\n"
16680 #: ../fish/guestfish.pod:130
16681 msgid "Start with a prepared disk"
16685 #: ../fish/guestfish.pod:132
16687 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16688 "single ext2-formatted partition:"
16692 #: ../fish/guestfish.pod:135
16695 " guestfish -N fs\n"
16700 #: ../fish/guestfish.pod:137
16701 msgid "To list what is available do:"
16705 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:837
16708 " guestfish -N help | less\n"
16713 #: ../fish/guestfish.pod:141
16714 msgid "Remote control"
16718 #: ../fish/guestfish.pod:143
16721 " eval \"`guestfish --listen`\"\n"
16722 " guestfish --remote add-ro disk.img\n"
16723 " guestfish --remote run\n"
16724 " guestfish --remote lvs\n"
16729 #: ../fish/guestfish.pod:148 ../test-tool/libguestfs-test-tool.pod:37 ../fuse/guestmount.pod:73 ../inspector/virt-inspector.pl:68 ../tools/virt-edit.pl:72 ../tools/virt-win-reg.pl:171 ../tools/virt-df.pl:71 ../tools/virt-ls.pl:78 ../tools/virt-resize.pl:257 ../tools/virt-list-filesystems.pl:50 ../tools/virt-tar.pl:98 ../tools/virt-rescue.pl:103 ../tools/virt-make-fs.pl:153 ../tools/virt-list-partitions.pl:51
16734 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:131 ../inspector/virt-inspector.pl:76 ../tools/virt-edit.pl:80 ../tools/virt-win-reg.pl:179 ../tools/virt-df.pl:79 ../tools/virt-ls.pl:86 ../tools/virt-resize.pl:265 ../tools/virt-list-filesystems.pl:58 ../tools/virt-tar.pl:106 ../tools/virt-rescue.pl:111 ../tools/virt-make-fs.pl:161 ../tools/virt-list-partitions.pl:59
16739 #: ../fish/guestfish.pod:154
16740 msgid "Displays general help on options."
16744 #: ../fish/guestfish.pod:156
16745 msgid "B<-h> | B<--cmd-help>"
16749 #: ../fish/guestfish.pod:158
16750 msgid "Lists all available guestfish commands."
16754 #: ../fish/guestfish.pod:160
16755 msgid "B<-h cmd> | B<--cmd-help cmd>"
16759 #: ../fish/guestfish.pod:162
16760 msgid "Displays detailed help on a single command C<cmd>."
16764 #: ../fish/guestfish.pod:164 ../fuse/guestmount.pod:77
16765 msgid "B<-a image> | B<--add image>"
16769 #: ../fish/guestfish.pod:166
16770 msgid "Add a block device or virtual machine image to the shell."
16774 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:81
16776 "The format of the disk image is auto-detected. To override this and force a "
16777 "particular format use the I<--format=..> option."
16781 #: ../fish/guestfish.pod:171 ../fuse/guestmount.pod:84
16782 msgid "B<-c URI> | B<--connect URI>"
16786 #: ../fish/guestfish.pod:173 ../fuse/guestmount.pod:86
16788 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16789 "URI to use. The default is to use the default libvirt connection."
16793 #: ../fish/guestfish.pod:177
16798 #: ../fish/guestfish.pod:179
16800 "If using the I<--listen> option and a csh-like shell, use this option. See "
16801 "section L</REMOTE CONTROL AND CSH> below."
16805 #: ../fish/guestfish.pod:182 ../fuse/guestmount.pod:90
16806 msgid "B<-d libvirt-domain> | B<--domain libvirt-domain>"
16810 #: ../fish/guestfish.pod:184 ../fuse/guestmount.pod:92
16812 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16813 "used, then any libvirt domain can be used. However in write mode, only "
16814 "libvirt domains which are shut down can be named here."
16818 #: ../fish/guestfish.pod:188
16819 msgid "B<-D> | B<--no-dest-paths>"
16823 #: ../fish/guestfish.pod:190
16825 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16826 "to hit the tab key to complete paths on the guest filesystem, but this "
16827 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16828 "allow this feature to be disabled."
16832 #: ../fish/guestfish.pod:195 ../fuse/guestmount.pod:108
16833 msgid "B<--echo-keys>"
16837 #: ../fish/guestfish.pod:197 ../fuse/guestmount.pod:110
16839 "When prompting for keys and passphrases, guestfish normally turns echoing "
16840 "off so you cannot see what you are typing. If you are not worried about "
16841 "Tempest attacks and there is no one else in the room you can specify this "
16842 "flag to see what you are typing."
16846 #: ../fish/guestfish.pod:202
16847 msgid "B<-f file> | B<--file file>"
16851 #: ../fish/guestfish.pod:204
16852 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16856 #: ../fish/guestfish.pod:207
16859 " #!/usr/bin/guestfish -f\n"
16864 #: ../fish/guestfish.pod:209 ../fuse/guestmount.pod:115
16865 msgid "B<--format=raw|qcow2|..> | B<--format>"
16869 #: ../fish/guestfish.pod:211 ../fuse/guestmount.pod:117
16871 "The default for the I<-a> option is to auto-detect the format of the disk "
16872 "image. Using this forces the disk format for I<-a> options which follow on "
16873 "the command line. Using I<--format> with no argument switches back to "
16874 "auto-detection for subsequent I<-a> options."
16878 #: ../fish/guestfish.pod:216 ../fish/guestfish.pod:543 ../inspector/virt-inspector.pl:431
16879 msgid "For example:"
16883 #: ../fish/guestfish.pod:218
16886 " guestfish --format=raw -a disk.img\n"
16891 #: ../fish/guestfish.pod:220
16892 msgid "forces raw format (no auto-detection) for C<disk.img>."
16896 #: ../fish/guestfish.pod:222
16899 " guestfish --format=raw -a disk.img --format -a another.img\n"
16904 #: ../fish/guestfish.pod:224
16906 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
16907 "auto-detection for C<another.img>."
16911 #: ../fish/guestfish.pod:227
16913 "If you have untrusted raw-format guest disk images, you should use this "
16914 "option to specify the disk format. This avoids a possible security problem "
16915 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16919 #: ../fish/guestfish.pod:232 ../fuse/guestmount.pod:135
16920 msgid "B<-i> | B<--inspector>"
16924 #: ../fish/guestfish.pod:234 ../fuse/guestmount.pod:137
16926 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16927 "system and mount filesystems as they would be mounted on the real virtual "
16932 #: ../fish/guestfish.pod:238
16933 msgid "Typical usage is either:"
16937 #: ../fish/guestfish.pod:240
16940 " guestfish -d myguest -i\n"
16945 #: ../fish/guestfish.pod:242
16946 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16950 #: ../fish/guestfish.pod:244
16953 " guestfish --ro -d myguest -i\n"
16958 #: ../fish/guestfish.pod:246
16959 msgid "(for active domains, readonly), or specify the block device directly:"
16963 #: ../fish/guestfish.pod:248
16966 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16971 #: ../fish/guestfish.pod:250
16973 "Note that the command line syntax changed slightly over older versions of "
16974 "guestfish. You can still use the old syntax:"
16978 #: ../fish/guestfish.pod:253
16981 " guestfish [--ro] -i disk.img\n"
16986 #: ../fish/guestfish.pod:255
16989 " guestfish [--ro] -i libvirt-domain\n"
16994 #: ../fish/guestfish.pod:257 ../fuse/guestmount.pod:141
16995 msgid "B<--keys-from-stdin>"
16999 #: ../fish/guestfish.pod:259 ../fuse/guestmount.pod:143
17001 "Read key or passphrase parameters from stdin. The default is to try to read "
17002 "passphrases from the user by opening C</dev/tty>."
17006 #: ../fish/guestfish.pod:262
17007 msgid "B<--listen>"
17011 #: ../fish/guestfish.pod:264
17013 "Fork into the background and listen for remote commands. See section "
17014 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
17018 #: ../fish/guestfish.pod:267
17019 msgid "B<-m dev[:mountpoint]> | B<--mount dev[:mountpoint]>"
17023 #: ../fish/guestfish.pod:269
17024 msgid "Mount the named partition or logical volume on the given mountpoint."
17028 #: ../fish/guestfish.pod:271
17029 msgid "If the mountpoint is omitted, it defaults to C</>."
17033 #: ../fish/guestfish.pod:273
17034 msgid "You have to mount something on C</> before most commands will work."
17038 #: ../fish/guestfish.pod:275
17040 "If any I<-m> or I<--mount> options are given, the guest is automatically "
17045 #: ../fish/guestfish.pod:278
17047 "If you don't know what filesystems a disk image contains, you can either run "
17048 "guestfish without this option, then list the partitions and LVs available "
17049 "(see L</list-partitions> and L</lvs> commands), or you can use the "
17050 "L<virt-list-filesystems(1)> program."
17054 #: ../fish/guestfish.pod:283 ../fuse/guestmount.pod:154
17055 msgid "B<-n> | B<--no-sync>"
17059 #: ../fish/guestfish.pod:285
17061 "Disable autosync. This is enabled by default. See the discussion of "
17062 "autosync in the L<guestfs(3)> manpage."
17066 #: ../fish/guestfish.pod:288
17067 msgid "B<-N type> | B<--new type> | B<-N help>"
17071 #: ../fish/guestfish.pod:290
17073 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
17074 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
17075 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
17080 #: ../fish/guestfish.pod:295
17081 msgid "B<--progress-bars>"
17085 #: ../fish/guestfish.pod:297
17086 msgid "Enable progress bars, even when guestfish is used non-interactively."
17090 #: ../fish/guestfish.pod:299
17092 "Progress bars are enabled by default when guestfish is used as an "
17093 "interactive shell."
17097 #: ../fish/guestfish.pod:302
17098 msgid "B<--no-progress-bars>"
17102 #: ../fish/guestfish.pod:304
17103 msgid "Disable progress bars."
17107 #: ../fish/guestfish.pod:306
17108 msgid "B<--remote[=pid]>"
17112 #: ../fish/guestfish.pod:308
17114 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
17115 "CONTROL GUESTFISH OVER A SOCKET> below."
17119 #: ../fish/guestfish.pod:311 ../fuse/guestmount.pod:196
17120 msgid "B<-r> | B<--ro>"
17124 #: ../fish/guestfish.pod:313
17126 "This changes the I<-a> and I<-m> options so that disks are added and mounts "
17127 "are done read-only (see L<guestfs(3)/guestfs_mount_ro>)."
17131 #: ../fish/guestfish.pod:316 ../tools/virt-rescue.pl:187
17133 "The option must always be used if the disk image or virtual machine might be "
17134 "running, and is generally recommended in cases where you don't need write "
17135 "access to the disk."
17139 #: ../fish/guestfish.pod:320
17141 "Note that prepared disk images created with I<-N> are not affected by the "
17146 #: ../fish/guestfish.pod:323
17147 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
17151 #: ../fish/guestfish.pod:325 ../fuse/guestmount.pod:208 ../tools/virt-rescue.pl:195
17152 msgid "B<--selinux>"
17156 #: ../fish/guestfish.pod:327
17157 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
17161 #: ../fish/guestfish.pod:329 ../fuse/guestmount.pod:212
17162 msgid "B<-v> | B<--verbose>"
17166 #: ../fish/guestfish.pod:331
17168 "Enable very verbose messages. This is particularly useful if you find a "
17173 #: ../fish/guestfish.pod:334 ../fuse/guestmount.pod:216
17174 msgid "B<-V> | B<--version>"
17178 #: ../fish/guestfish.pod:336
17179 msgid "Display the guestfish / libguestfs version number and exit."
17183 #: ../fish/guestfish.pod:338 ../fuse/guestmount.pod:220
17184 msgid "B<-w> | B<--rw>"
17188 #: ../fish/guestfish.pod:340
17190 "This option does nothing at the moment. See L</OPENING DISKS FOR READ AND "
17195 #: ../fish/guestfish.pod:343
17200 #: ../fish/guestfish.pod:345
17201 msgid "Echo each command before executing it."
17205 #: ../fish/guestfish.pod:349
17206 msgid "COMMANDS ON COMMAND LINE"
17210 #: ../fish/guestfish.pod:351
17211 msgid "Any additional (non-option) arguments are treated as commands to execute."
17215 #: ../fish/guestfish.pod:354
17217 "Commands to execute should be separated by a colon (C<:>), where the colon "
17218 "is a separate parameter. Thus:"
17222 #: ../fish/guestfish.pod:357
17225 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
17230 #: ../fish/guestfish.pod:359
17232 "If there are no additional arguments, then we enter a shell, either an "
17233 "interactive shell with a prompt (if the input is a terminal) or a "
17234 "non-interactive shell."
17238 #: ../fish/guestfish.pod:363
17240 "In either command line mode or non-interactive shell, the first command that "
17241 "gives an error causes the whole shell to exit. In interactive mode (with a "
17242 "prompt) if a command fails, you can continue to enter commands."
17246 #: ../fish/guestfish.pod:368
17247 msgid "USING launch (OR run)"
17251 #: ../fish/guestfish.pod:370
17253 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
17254 "then launch it, then mount any disks you need, and finally issue "
17255 "actions/commands. So the general order of the day is:"
17259 #: ../fish/guestfish.pod:378
17260 msgid "add or -a/--add"
17264 #: ../fish/guestfish.pod:382
17265 msgid "launch (aka run)"
17269 #: ../fish/guestfish.pod:386
17270 msgid "mount or -m/--mount"
17274 #: ../fish/guestfish.pod:390
17275 msgid "any other commands"
17279 #: ../fish/guestfish.pod:394
17281 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
17282 "guest before mounting or performing any other commands."
17286 #: ../fish/guestfish.pod:397
17288 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
17289 "I<--new> options were given then C<run> is done automatically, simply "
17290 "because guestfish can't perform the action you asked for without doing this."
17294 #: ../fish/guestfish.pod:402
17295 msgid "OPENING DISKS FOR READ AND WRITE"
17299 #: ../fish/guestfish.pod:404
17301 "The guestfish (and L<guestmount(1)>) options I<--ro> and I<--rw> affect "
17302 "whether the other command line options I<-a>, I<-c>, I<-d>, I<-i> and I<-m> "
17303 "open disk images read-only or for writing."
17307 #: ../fish/guestfish.pod:408
17309 "In libguestfs E<lt> 1.6.2, guestfish and guestmount defaulted to opening "
17310 "disk images supplied on the command line for write. To open a disk image "
17311 "read-only you have to do I<-a image --ro>."
17315 #: ../fish/guestfish.pod:412
17317 "This matters: If you accidentally open a live VM disk image writable then "
17318 "you will cause irreversible disk corruption."
17322 #: ../fish/guestfish.pod:415
17324 "By libguestfs 1.8 we intend to change the default the other way. Disk "
17325 "images will be opened read-only. You will have to either specify "
17326 "I<guestfish --rw> or change a configuration file in order to get write "
17327 "access for disk images specified by those other command line options."
17331 #: ../fish/guestfish.pod:420
17333 "This version of guestfish has a I<--rw> option which does nothing (it is "
17334 "already the default). However it is highly recommended that you use this "
17335 "option to indicate that guestfish needs write access, and to prepare your "
17336 "scripts for the day when this option will be required for write access."
17340 #: ../fish/guestfish.pod:426
17342 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
17343 "other libguestfs program apart from guestfish and guestmount."
17347 #: ../fish/guestfish.pod:429
17352 #: ../fish/guestfish.pod:431
17354 "You can quote ordinary parameters using either single or double quotes. For "
17359 #: ../fish/guestfish.pod:434
17362 " add \"file with a space.img\"\n"
17367 #: ../fish/guestfish.pod:436
17370 " rm '/file name'\n"
17375 #: ../fish/guestfish.pod:438
17383 #: ../fish/guestfish.pod:440
17385 "A few commands require a list of strings to be passed. For these, use a "
17386 "whitespace-separated list, enclosed in quotes. Strings containing "
17387 "whitespace to be passed through must be enclosed in single quotes. A "
17388 "literal single quote must be escaped with a backslash."
17392 #: ../fish/guestfish.pod:445
17395 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
17396 " command \"/bin/echo 'foo bar'\"\n"
17397 " command \"/bin/echo \\'foo\\'\"\n"
17402 #: ../fish/guestfish.pod:449
17403 msgid "OPTIONAL ARGUMENTS"
17407 #: ../fish/guestfish.pod:451
17409 "Some commands take optional arguments. These arguments appear in this "
17410 "documentation as C<[argname:..]>. You can use them as in these examples:"
17414 #: ../fish/guestfish.pod:455
17417 " add-drive-opts filename\n"
17422 #: ../fish/guestfish.pod:457
17425 " add-drive-opts filename readonly:true\n"
17430 #: ../fish/guestfish.pod:459
17433 " add-drive-opts filename format:qcow2 readonly:false\n"
17438 #: ../fish/guestfish.pod:461
17440 "Each optional argument can appear at most once. All optional arguments must "
17441 "appear after the required ones."
17445 #: ../fish/guestfish.pod:464
17450 #: ../fish/guestfish.pod:466
17451 msgid "This section applies to all commands which can take integers as parameters."
17455 #: ../fish/guestfish.pod:469
17456 msgid "SIZE SUFFIX"
17460 #: ../fish/guestfish.pod:471
17462 "When the command takes a parameter measured in bytes, you can use one of the "
17463 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17467 #: ../fish/guestfish.pod:477
17468 msgid "B<k> or B<K> or B<KiB>"
17472 #: ../fish/guestfish.pod:479
17473 msgid "The size in kilobytes (multiplied by 1024)."
17477 #: ../fish/guestfish.pod:481
17482 #: ../fish/guestfish.pod:483
17483 msgid "The size in SI 1000 byte units."
17487 #: ../fish/guestfish.pod:485
17488 msgid "B<M> or B<MiB>"
17492 #: ../fish/guestfish.pod:487
17493 msgid "The size in megabytes (multiplied by 1048576)."
17497 #: ../fish/guestfish.pod:489
17502 #: ../fish/guestfish.pod:491
17503 msgid "The size in SI 1000000 byte units."
17507 #: ../fish/guestfish.pod:493
17508 msgid "B<G> or B<GiB>"
17512 #: ../fish/guestfish.pod:495
17513 msgid "The size in gigabytes (multiplied by 2**30)."
17517 #: ../fish/guestfish.pod:497
17522 #: ../fish/guestfish.pod:499
17523 msgid "The size in SI 10**9 byte units."
17527 #: ../fish/guestfish.pod:501
17528 msgid "B<T> or B<TiB>"
17532 #: ../fish/guestfish.pod:503
17533 msgid "The size in terabytes (multiplied by 2**40)."
17537 #: ../fish/guestfish.pod:505
17542 #: ../fish/guestfish.pod:507
17543 msgid "The size in SI 10**12 byte units."
17547 #: ../fish/guestfish.pod:509
17548 msgid "B<P> or B<PiB>"
17552 #: ../fish/guestfish.pod:511
17553 msgid "The size in petabytes (multiplied by 2**50)."
17557 #: ../fish/guestfish.pod:513
17562 #: ../fish/guestfish.pod:515
17563 msgid "The size in SI 10**15 byte units."
17567 #: ../fish/guestfish.pod:517
17568 msgid "B<E> or B<EiB>"
17572 #: ../fish/guestfish.pod:519
17573 msgid "The size in exabytes (multiplied by 2**60)."
17577 #: ../fish/guestfish.pod:521
17582 #: ../fish/guestfish.pod:523
17583 msgid "The size in SI 10**18 byte units."
17587 #: ../fish/guestfish.pod:525
17588 msgid "B<Z> or B<ZiB>"
17592 #: ../fish/guestfish.pod:527
17593 msgid "The size in zettabytes (multiplied by 2**70)."
17597 #: ../fish/guestfish.pod:529
17602 #: ../fish/guestfish.pod:531
17603 msgid "The size in SI 10**21 byte units."
17607 #: ../fish/guestfish.pod:533
17608 msgid "B<Y> or B<YiB>"
17612 #: ../fish/guestfish.pod:535
17613 msgid "The size in yottabytes (multiplied by 2**80)."
17617 #: ../fish/guestfish.pod:537
17622 #: ../fish/guestfish.pod:539
17623 msgid "The size in SI 10**24 byte units."
17627 #: ../fish/guestfish.pod:545
17630 " truncate-size /file 1G\n"
17635 #: ../fish/guestfish.pod:547
17636 msgid "would truncate the file to 1 gigabyte."
17640 #: ../fish/guestfish.pod:549
17642 "Be careful because a few commands take sizes in kilobytes or megabytes "
17643 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17644 "Adding a suffix will probably not do what you expect."
17648 #: ../fish/guestfish.pod:553
17649 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17653 #: ../fish/guestfish.pod:555
17655 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17656 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17660 #: ../fish/guestfish.pod:558
17663 " 1234 decimal number 1234\n"
17664 " 02322 octal number, equivalent to decimal 1234\n"
17665 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17670 #: ../fish/guestfish.pod:562
17672 "When using the C<chmod> command, you almost always want to specify an octal "
17673 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17674 "L<chmod(1)> program):"
17678 #: ../fish/guestfish.pod:566
17681 " chmod 0777 /public # OK\n"
17682 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17687 #: ../fish/guestfish.pod:569
17689 "Commands that return numbers usually print them in decimal, but some "
17690 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17691 "octal, preceeded by C<0>)."
17695 #: ../fish/guestfish.pod:573
17696 msgid "WILDCARDS AND GLOBBING"
17700 #: ../fish/guestfish.pod:575
17702 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17703 "(globbing) by default. So for example the following will not do what you "
17708 #: ../fish/guestfish.pod:579
17716 #: ../fish/guestfish.pod:581
17718 "Assuming you don't have a directory called literally C</home/*> then the "
17719 "above command will return an error."
17723 #: ../fish/guestfish.pod:584
17724 msgid "To perform wildcard expansion, use the C<glob> command."
17728 #: ../fish/guestfish.pod:586
17731 " glob rm-rf /home/*\n"
17736 #: ../fish/guestfish.pod:588
17738 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17739 "many times), equivalent to:"
17743 #: ../fish/guestfish.pod:591
17746 " rm-rf /home/jim\n"
17747 " rm-rf /home/joe\n"
17748 " rm-rf /home/mary\n"
17753 #: ../fish/guestfish.pod:595
17754 msgid "C<glob> only works on simple guest paths and not on device names."
17758 #: ../fish/guestfish.pod:597
17760 "If you have several parameters, each containing a wildcard, then glob will "
17761 "perform a Cartesian product."
17765 #: ../fish/guestfish.pod:600
17770 #: ../fish/guestfish.pod:602
17772 "Any line which starts with a I<#> character is treated as a comment and "
17773 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17774 "a command. For example:"
17778 #: ../fish/guestfish.pod:606
17781 " # this is a comment\n"
17782 " # this is a comment\n"
17783 " foo # NOT a comment\n"
17788 #: ../fish/guestfish.pod:610
17789 msgid "Blank lines are also ignored."
17793 #: ../fish/guestfish.pod:612
17794 msgid "RUNNING COMMANDS LOCALLY"
17798 #: ../fish/guestfish.pod:614
17800 "Any line which starts with a I<!> character is treated as a command sent to "
17801 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17805 #: ../fish/guestfish.pod:618
17809 " tgz-out /remote local/remote-data.tar.gz\n"
17814 #: ../fish/guestfish.pod:621
17816 "will create a directory C<local> on the host, and then export the contents "
17817 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17818 "(See C<tgz-out>)."
17822 #: ../fish/guestfish.pod:625
17824 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17825 "effect, due to the way that subprocesses work in Unix."
17829 #: ../fish/guestfish.pod:628
17834 #: ../fish/guestfish.pod:630
17836 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17837 "command (a guestfish command) to the second command (any host command). For "
17842 #: ../fish/guestfish.pod:634
17845 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17850 #: ../fish/guestfish.pod:636
17852 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17853 "program). The above command would list all accounts in the guest filesystem "
17854 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17858 #: ../fish/guestfish.pod:641
17861 " hexdump /bin/ls | head\n"
17862 " list-devices | tail -1\n"
17863 " tgz-out / - | tar ztf -\n"
17868 #: ../fish/guestfish.pod:645
17870 "The space before the pipe symbol is required, any space after the pipe "
17871 "symbol is optional. Everything after the pipe symbol is just passed "
17872 "straight to the host shell, so it can contain redirections, globs and "
17873 "anything else that makes sense on the host side."
17877 #: ../fish/guestfish.pod:650
17879 "To use a literal argument which begins with a pipe symbol, you have to quote "
17884 #: ../fish/guestfish.pod:653
17892 #: ../fish/guestfish.pod:655
17893 msgid "HOME DIRECTORIES"
17897 #: ../fish/guestfish.pod:657
17899 "If a parameter starts with the character C<~> then the tilde may be expanded "
17900 "as a home directory path (either C<~> for the current user's home directory, "
17901 "or C<~user> for another user)."
17905 #: ../fish/guestfish.pod:661
17907 "Note that home directory expansion happens for users known I<on the host>, "
17908 "not in the guest filesystem."
17912 #: ../fish/guestfish.pod:664
17914 "To use a literal argument which begins with a tilde, you have to quote it, "
17919 #: ../fish/guestfish.pod:667
17927 #: ../fish/guestfish.pod:671
17929 "Libguestfs has some support for Linux guests encrypted according to the "
17930 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17931 "disk encryption systems used by modern Linux guests. Currently only "
17932 "LVM-on-LUKS is supported."
17936 #: ../fish/guestfish.pod:676
17937 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17941 #: ../fish/guestfish.pod:678
17944 " ><fs> vfs-type /dev/sda2\n"
17950 #: ../fish/guestfish.pod:681
17952 "Then open those devices using L</luks-open>. This creates a device-mapper "
17953 "device called C</dev/mapper/luksdev>."
17957 #: ../fish/guestfish.pod:684
17960 " ><fs> luks-open /dev/sda2 luksdev\n"
17961 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17966 #: ../fish/guestfish.pod:687
17968 "Finally you have to tell LVM to scan for volume groups on the newly created "
17973 #: ../fish/guestfish.pod:690
17977 " vg-activate-all true\n"
17982 #: ../fish/guestfish.pod:693
17983 msgid "The logical volume(s) can now be mounted in the usual way."
17987 #: ../fish/guestfish.pod:695
17989 "Before closing a LUKS device you must unmount any logical volumes on it and "
17990 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17991 "one. Then you can close the mapper device:"
17995 #: ../fish/guestfish.pod:699
17998 " vg-activate false /dev/VG\n"
17999 " luks-close /dev/mapper/luksdev\n"
18004 #: ../fish/guestfish.pod:702
18005 msgid "WINDOWS PATHS"
18009 #: ../fish/guestfish.pod:704
18011 "If a path is prefixed with C<win:> then you can use Windows-style paths "
18012 "(with some limitations). The following commands are equivalent:"
18016 #: ../fish/guestfish.pod:707
18019 " file /WINDOWS/system32/config/system.LOG\n"
18024 #: ../fish/guestfish.pod:709
18027 " file win:/windows/system32/config/system.log\n"
18032 #: ../fish/guestfish.pod:711
18035 " file win:\\windows\\system32\\config\\system.log\n"
18040 #: ../fish/guestfish.pod:713
18043 " file WIN:C:\\Windows\\SYSTEM32\\conFIG\\SYSTEM.LOG\n"
18048 #: ../fish/guestfish.pod:715
18050 "This syntax implicitly calls C<case-sensitive-path> (q.v.) so it also "
18051 "handles case insensitivity like Windows would. This only works in argument "
18052 "positions that expect a path."
18056 #: ../fish/guestfish.pod:719
18057 msgid "UPLOADING AND DOWNLOADING FILES"
18061 #: ../fish/guestfish.pod:721
18063 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
18064 "others which upload from or download to a local file, you can use the "
18065 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
18069 #: ../fish/guestfish.pod:725
18077 #: ../fish/guestfish.pod:727
18078 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
18082 #: ../fish/guestfish.pod:730
18085 " tar-out /etc - | tar tf -\n"
18090 #: ../fish/guestfish.pod:732
18092 "writes the tarball to stdout and then pipes that into the external \"tar\" "
18093 "command (see L</PIPES>)."
18097 #: ../fish/guestfish.pod:735
18099 "When using C<-> to read from stdin, the input is read up to the end of "
18100 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
18101 "some arbitrary end marker:"
18105 #: ../fish/guestfish.pod:739
18108 " upload -<<END /foo\n"
18117 #: ../fish/guestfish.pod:745
18119 "Any string of characters can be used instead of C<END>. The end marker must "
18120 "appear on a line of its own, without any preceeding or following characters "
18121 "(not even spaces)."
18125 #: ../fish/guestfish.pod:749
18127 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
18128 "upload local files (so-called \"FileIn\" parameters in the generator)."
18132 #: ../fish/guestfish.pod:752
18133 msgid "EXIT ON ERROR BEHAVIOUR"
18137 #: ../fish/guestfish.pod:754
18139 "By default, guestfish will ignore any errors when in interactive mode "
18140 "(ie. taking commands from a human over a tty), and will exit on the first "
18141 "error in non-interactive mode (scripts, commands given on the command line)."
18145 #: ../fish/guestfish.pod:759
18147 "If you prefix a command with a I<-> character, then that command will not "
18148 "cause guestfish to exit, even if that (one) command returns an error."
18152 #: ../fish/guestfish.pod:763
18153 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
18157 #: ../fish/guestfish.pod:765
18159 "Guestfish can be remote-controlled over a socket. This is useful "
18160 "particularly in shell scripts where you want to make several different "
18161 "changes to a filesystem, but you don't want the overhead of starting up a "
18162 "guestfish process each time."
18166 #: ../fish/guestfish.pod:770
18167 msgid "Start a guestfish server process using:"
18171 #: ../fish/guestfish.pod:772
18174 " eval \"`guestfish --listen`\"\n"
18179 #: ../fish/guestfish.pod:774
18180 msgid "and then send it commands by doing:"
18184 #: ../fish/guestfish.pod:776
18187 " guestfish --remote cmd [...]\n"
18192 #: ../fish/guestfish.pod:778
18193 msgid "To cause the server to exit, send it the exit command:"
18197 #: ../fish/guestfish.pod:780
18200 " guestfish --remote exit\n"
18205 #: ../fish/guestfish.pod:782
18207 "Note that the server will normally exit if there is an error in a command. "
18208 "You can change this in the usual way. See section L</EXIT ON ERROR "
18213 #: ../fish/guestfish.pod:786
18214 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
18218 #: ../fish/guestfish.pod:788
18220 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
18221 "is how the I<--remote> option knows where to send the commands. You can "
18222 "have several guestfish listener processes running using:"
18226 #: ../fish/guestfish.pod:792
18229 " eval \"`guestfish --listen`\"\n"
18230 " pid1=$GUESTFISH_PID\n"
18231 " eval \"`guestfish --listen`\"\n"
18232 " pid2=$GUESTFISH_PID\n"
18234 " guestfish --remote=$pid1 cmd\n"
18235 " guestfish --remote=$pid2 cmd\n"
18240 #: ../fish/guestfish.pod:800
18241 msgid "REMOTE CONTROL AND CSH"
18245 #: ../fish/guestfish.pod:802
18247 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
18252 #: ../fish/guestfish.pod:805
18255 " eval \"`guestfish --listen --csh`\"\n"
18260 #: ../fish/guestfish.pod:807
18261 msgid "REMOTE CONTROL DETAILS"
18265 #: ../fish/guestfish.pod:809
18267 "Remote control happens over a Unix domain socket called "
18268 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
18269 "of the process, and C<$PID> is the process ID of the server."
18273 #: ../fish/guestfish.pod:813
18274 msgid "Guestfish client and server versions must match exactly."
18278 #: ../fish/guestfish.pod:815
18279 msgid "PREPARED DISK IMAGES"
18283 #: ../fish/guestfish.pod:817
18285 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
18286 "preformatted disk images that guestfish can make for you to save typing. "
18287 "This is particularly useful for testing purposes. This option is used "
18288 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
18289 "can be mixed with I<-a>)."
18293 #: ../fish/guestfish.pod:823
18295 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
18296 "the second and so on. Existing files in the current directory are "
18301 #: ../fish/guestfish.pod:827
18303 "The type briefly describes how the disk should be sized, partitioned, how "
18304 "filesystem(s) should be created, and how content should be added. "
18305 "Optionally the type can be followed by extra parameters, separated by C<:> "
18306 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
18307 "sparsely-allocated disk, containing a single partition, with the partition "
18308 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
18309 "on a 1GB disk instead."
18313 #: ../fish/guestfish.pod:835
18314 msgid "To list the available types and any extra parameters they take, run:"
18318 #: ../fish/guestfish.pod:839
18320 "Note that the prepared filesystem is not mounted. You would usually have to "
18321 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
18325 #: ../fish/guestfish.pod:843
18327 "If any I<-N> or I<--new> options are given, the guest is automatically "
18332 #: ../fish/guestfish.pod:848
18333 msgid "Create a 100MB disk with an ext4-formatted partition:"
18337 #: ../fish/guestfish.pod:850
18340 " guestfish -N fs:ext4\n"
18345 #: ../fish/guestfish.pod:852
18346 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18350 #: ../fish/guestfish.pod:854
18353 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18358 #: ../fish/guestfish.pod:856
18359 msgid "Create a blank 200MB disk:"
18363 #: ../fish/guestfish.pod:858
18366 " guestfish -N disk:200M\n"
18371 #: ../fish/guestfish.pod:860
18372 msgid "PROGRESS BARS"
18376 #: ../fish/guestfish.pod:862
18378 "Some (not all) long-running commands send progress notification messages as "
18379 "they are running. Guestfish turns these messages into progress bars."
18383 #: ../fish/guestfish.pod:866
18385 "When a command that supports progress bars takes longer than two seconds to "
18386 "run, and if progress bars are enabled, then you will see one appearing below "
18391 #: ../fish/guestfish.pod:870
18394 " ><fs> copy-size /large-file /another-file 2048M\n"
18395 " / 10% [#####-----------------------------------------] 00:30\n"
18400 #: ../fish/guestfish.pod:873
18402 "The spinner on the left hand side moves round once for every progress "
18403 "notification received from the backend. This is a (reasonably) golden "
18404 "assurance that the command is \"doing something\" even if the progress bar "
18405 "is not moving, because the command is able to send the progress "
18406 "notifications. When the bar reaches 100% and the command finishes, the "
18407 "spinner disappears."
18411 #: ../fish/guestfish.pod:880
18413 "Progress bars are enabled by default when guestfish is used interactively. "
18414 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18415 "and you can disable them completely using I<--no-progress-bars>."
18419 #: ../fish/guestfish.pod:885
18420 msgid "GUESTFISH COMMANDS"
18424 #: ../fish/guestfish.pod:887
18426 "The commands in this section are guestfish convenience commands, in other "
18427 "words, they are not part of the L<guestfs(3)> API."
18431 #: ../fish/guestfish.pod:890
18436 #: ../fish/guestfish.pod:892
18445 #: ../fish/guestfish.pod:895
18446 msgid "Without any parameter, this provides general help."
18450 #: ../fish/guestfish.pod:897
18451 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18455 #: ../fish/guestfish.pod:899
18456 msgid "quit | exit"
18460 #: ../fish/guestfish.pod:901
18461 msgid "This exits guestfish. You can also use C<^D> key."
18465 #: ../fish/guestfish.pod:903
18466 msgid "@FISH_COMMANDS@"
18470 #: ../fish/guestfish.pod:905
18475 #: ../fish/guestfish.pod:909 ../test-tool/libguestfs-test-tool.pod:83
18480 #: ../fish/guestfish.pod:911
18482 "guestfish returns 0 if the commands completed without error, or 1 if there "
18487 #: ../fish/guestfish.pod:918
18492 #: ../fish/guestfish.pod:920
18494 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18499 #: ../fish/guestfish.pod:923
18500 msgid "GUESTFISH_PID"
18504 #: ../fish/guestfish.pod:925
18506 "Used with the I<--remote> option to specify the remote guestfish process to "
18507 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18511 #: ../fish/guestfish.pod:929
18516 #: ../fish/guestfish.pod:931
18518 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18519 "not specified, the external L<hexedit(1)> program is used."
18523 #: ../fish/guestfish.pod:935
18528 #: ../fish/guestfish.pod:937
18530 "If compiled with GNU readline support, various files in the home directory "
18531 "can be used. See L</FILES>."
18535 #: ../fish/guestfish.pod:946
18537 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18538 "effect as using the B<-v> option."
18542 #: ../fish/guestfish.pod:958
18544 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18545 "the discussion of paths in L<guestfs(3)>."
18549 #: ../fish/guestfish.pod:969
18550 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18554 #: ../fish/guestfish.pod:971
18559 #: ../fish/guestfish.pod:973
18561 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18566 #: ../fish/guestfish.pod:988 ../test-tool/libguestfs-test-tool.pod:88
18571 #: ../fish/guestfish.pod:992
18572 msgid "$HOME/.guestfish"
18576 #: ../fish/guestfish.pod:994
18578 "If compiled with GNU readline support, then the command history is saved in "
18583 #: ../fish/guestfish.pod:997
18584 msgid "$HOME/.inputrc"
18588 #: ../fish/guestfish.pod:999
18589 msgid "/etc/inputrc"
18593 #: ../fish/guestfish.pod:1001
18595 "If compiled with GNU readline support, then these files can be used to "
18596 "configure readline. For further information, please see "
18597 "L<readline(3)/INITIALIZATION FILE>."
18601 #: ../fish/guestfish.pod:1005
18602 msgid "To write rules which only apply to guestfish, use:"
18606 #: ../fish/guestfish.pod:1007
18616 #: ../fish/guestfish.pod:1011
18618 "Variables that you can set in inputrc that change the behaviour of guestfish "
18619 "in useful ways include:"
18623 #: ../fish/guestfish.pod:1016
18624 msgid "completion-ignore-case (default: on)"
18628 #: ../fish/guestfish.pod:1018
18630 "By default, guestfish will ignore case when tab-completing paths on the "
18635 #: ../fish/guestfish.pod:1021
18638 " set completion-ignore-case off\n"
18643 #: ../fish/guestfish.pod:1023
18644 msgid "to make guestfish case sensitive."
18648 #: ../fish/guestfish.pod:1027
18653 #: ../fish/guestfish.pod:1029
18654 msgid "test2.img (etc)"
18658 #: ../fish/guestfish.pod:1031
18660 "When using the C<-N> or C<--new> option, the prepared disk or filesystem "
18661 "will be created in the file C<test1.img> in the current directory. The "
18662 "second use of C<-N> will use C<test2.img> and so on. Any existing file with "
18663 "the same name will be overwritten."
18667 #: ../fish/guestfish.pod:1040
18669 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-df(1)>, "
18670 "L<virt-edit(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, "
18671 "L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)>, "
18672 "L<virt-tar(1)>, L<virt-win-reg(1)>, L<hexedit(1)>."
18676 #: ../fish/guestfish.pod:1064 ../test-tool/libguestfs-test-tool.pod:124 ../fuse/guestmount.pod:253 ../inspector/virt-inspector.pl:480 ../tools/virt-edit.pl:370 ../tools/virt-win-reg.pl:518 ../tools/virt-df.pl:657 ../tools/virt-ls.pl:251 ../tools/virt-resize.pl:1516 ../tools/virt-list-filesystems.pl:206 ../tools/virt-tar.pl:300 ../tools/virt-rescue.pl:285 ../tools/virt-make-fs.pl:567 ../tools/virt-list-partitions.pl:273
18678 "This program is free software; you can redistribute it and/or modify it "
18679 "under the terms of the GNU General Public License as published by the Free "
18680 "Software Foundation; either version 2 of the License, or (at your option) "
18681 "any later version."
18685 #: ../fish/guestfish.pod:1069 ../test-tool/libguestfs-test-tool.pod:129 ../fuse/guestmount.pod:258 ../inspector/virt-inspector.pl:485 ../tools/virt-edit.pl:375 ../tools/virt-win-reg.pl:523 ../tools/virt-df.pl:662 ../tools/virt-ls.pl:256 ../tools/virt-resize.pl:1521 ../tools/virt-list-filesystems.pl:211 ../tools/virt-tar.pl:305 ../tools/virt-rescue.pl:290 ../tools/virt-make-fs.pl:572 ../tools/virt-list-partitions.pl:278
18687 "This program is distributed in the hope that it will be useful, but WITHOUT "
18688 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
18689 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
18694 #: ../fish/guestfish.pod:1074 ../test-tool/libguestfs-test-tool.pod:134 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pl:490 ../tools/virt-edit.pl:380 ../tools/virt-win-reg.pl:528 ../tools/virt-df.pl:667 ../tools/virt-ls.pl:261 ../tools/virt-resize.pl:1526 ../tools/virt-list-filesystems.pl:216 ../tools/virt-tar.pl:310 ../tools/virt-rescue.pl:295 ../tools/virt-make-fs.pl:577 ../tools/virt-list-partitions.pl:283
18696 "You should have received a copy of the GNU General Public License along with "
18697 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
18698 "Ave, Cambridge, MA 02139, USA."
18702 #: ../fish/guestfish-actions.pod:1
18707 #: ../fish/guestfish-actions.pod:3
18710 " add-cdrom filename\n"
18715 #: ../fish/guestfish-actions.pod:15
18717 "This call checks for the existence of C<filename>. This stops you from "
18718 "specifying other types of drive which are supported by qemu such as C<nbd:> "
18719 "and C<http:> URLs. To specify those, use the general L</config> call "
18724 #: ../fish/guestfish-actions.pod:22
18726 "If you just want to add an ISO file (often you use this as an efficient way "
18727 "to transfer large files into the guest), then you should probably use "
18728 "L</add-drive-ro> instead."
18732 #: ../fish/guestfish-actions.pod:35
18737 #: ../fish/guestfish-actions.pod:37
18742 #: ../fish/guestfish-actions.pod:39
18745 " add-domain dom [libvirturi:..] [readonly:..] [iface:..]\n"
18750 #: ../fish/guestfish-actions.pod:41
18752 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
18753 "It works by connecting to libvirt, requesting the domain and domain XML from "
18754 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
18758 #: ../fish/guestfish-actions.pod:58
18760 "The optional C<libvirturi> parameter sets the libvirt URI (see "
18761 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
18762 "default libvirt URI (or one set through an environment variable, see the "
18763 "libvirt documentation for full details). If you are using the C API "
18764 "directly then it is more flexible to create the libvirt connection object "
18765 "yourself, get the domain object, and call L</add-libvirt-dom>."
18769 #: ../fish/guestfish-actions.pod:66
18771 "The other optional parameters are passed directly through to "
18772 "L</add-drive-opts>."
18776 #: ../fish/guestfish-actions.pod:69 ../fish/guestfish-actions.pod:133
18778 "This command has one or more optional arguments. See L</OPTIONAL "
18783 #: ../fish/guestfish-actions.pod:71
18788 #: ../fish/guestfish-actions.pod:73
18791 " add-drive filename\n"
18796 #: ../fish/guestfish-actions.pod:75
18798 "This function is the equivalent of calling L</add-drive-opts> with no "
18799 "optional parameters, so the disk is added writable, with the format being "
18800 "detected automatically."
18804 #: ../fish/guestfish-actions.pod:79
18806 "Automatic detection of the format opens you up to a potential security hole "
18807 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
18808 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
18809 "you should think about replacing calls to this function with calls to "
18810 "L</add-drive-opts>, and specifying the format."
18814 #: ../fish/guestfish-actions.pod:86
18815 msgid "add-drive-opts"
18819 #: ../fish/guestfish-actions.pod:88
18824 #: ../fish/guestfish-actions.pod:90
18827 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
18832 #: ../fish/guestfish-actions.pod:117
18834 "This forces the image format. If you omit this (or use L</add-drive> or "
18835 "L</add-drive-ro>) then the format is automatically detected. Possible "
18836 "formats include C<raw> and C<qcow2>."
18840 #: ../fish/guestfish-actions.pod:128
18842 "This rarely-used option lets you emulate the behaviour of the deprecated "
18843 "L</add-drive-with-if> call (q.v.)"
18847 #: ../fish/guestfish-actions.pod:135
18848 msgid "add-drive-ro"
18852 #: ../fish/guestfish-actions.pod:137
18857 #: ../fish/guestfish-actions.pod:139
18860 " add-drive-ro filename\n"
18865 #: ../fish/guestfish-actions.pod:141
18867 "This function is the equivalent of calling L</add-drive-opts> with the "
18868 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
18869 "is added read-only, with the format being detected automatically."
18873 #: ../fish/guestfish-actions.pod:146
18874 msgid "add-drive-ro-with-if"
18878 #: ../fish/guestfish-actions.pod:148
18881 " add-drive-ro-with-if filename iface\n"
18886 #: ../fish/guestfish-actions.pod:150
18888 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
18889 "interface emulation to use at run time."
18893 #: ../fish/guestfish-actions.pod:160
18894 msgid "add-drive-with-if"
18898 #: ../fish/guestfish-actions.pod:162
18901 " add-drive-with-if filename iface\n"
18906 #: ../fish/guestfish-actions.pod:164
18908 "This is the same as L</add-drive> but it allows you to specify the QEMU "
18909 "interface emulation to use at run time."
18913 #: ../fish/guestfish-actions.pod:174
18918 #: ../fish/guestfish-actions.pod:176
18921 " aug-clear augpath\n"
18926 #: ../fish/guestfish-actions.pod:181
18931 #: ../fish/guestfish-actions.pod:183
18939 #: ../fish/guestfish-actions.pod:185
18941 "Close the current Augeas handle and free up any resources used by it. After "
18942 "calling this, you have to call L</aug-init> again before you can use any "
18943 "other Augeas functions."
18947 #: ../fish/guestfish-actions.pod:190
18948 msgid "aug-defnode"
18952 #: ../fish/guestfish-actions.pod:192
18955 " aug-defnode name expr val\n"
18960 #: ../fish/guestfish-actions.pod:197
18962 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
18963 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
18964 "containing that single node."
18968 #: ../fish/guestfish-actions.pod:205
18973 #: ../fish/guestfish-actions.pod:207
18976 " aug-defvar name expr\n"
18981 #: ../fish/guestfish-actions.pod:216
18986 #: ../fish/guestfish-actions.pod:218
18989 " aug-get augpath\n"
18994 #: ../fish/guestfish-actions.pod:223
18999 #: ../fish/guestfish-actions.pod:225
19002 " aug-init root flags\n"
19007 #: ../fish/guestfish-actions.pod:231
19008 msgid "You must call this before using any other L</aug-*> commands."
19012 #: ../fish/guestfish-actions.pod:266
19013 msgid "Do not load the tree in L</aug-init>."
19017 #: ../fish/guestfish-actions.pod:270
19018 msgid "To close the handle, you can call L</aug-close>."
19022 #: ../fish/guestfish-actions.pod:274
19027 #: ../fish/guestfish-actions.pod:276
19030 " aug-insert augpath label true|false\n"
19035 #: ../fish/guestfish-actions.pod:286
19040 #: ../fish/guestfish-actions.pod:288
19048 #: ../fish/guestfish-actions.pod:295
19053 #: ../fish/guestfish-actions.pod:297
19056 " aug-ls augpath\n"
19061 #: ../fish/guestfish-actions.pod:299
19063 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
19064 "resulting nodes into alphabetical order."
19068 #: ../fish/guestfish-actions.pod:302
19073 #: ../fish/guestfish-actions.pod:304
19076 " aug-match augpath\n"
19081 #: ../fish/guestfish-actions.pod:310
19086 #: ../fish/guestfish-actions.pod:312
19089 " aug-mv src dest\n"
19094 #: ../fish/guestfish-actions.pod:317
19099 #: ../fish/guestfish-actions.pod:319
19102 " aug-rm augpath\n"
19107 #: ../fish/guestfish-actions.pod:325
19112 #: ../fish/guestfish-actions.pod:327
19120 #: ../fish/guestfish-actions.pod:331
19122 "The flags which were passed to L</aug-init> affect exactly how files are "
19127 #: ../fish/guestfish-actions.pod:334
19132 #: ../fish/guestfish-actions.pod:336
19135 " aug-set augpath val\n"
19140 #: ../fish/guestfish-actions.pod:340
19142 "In the Augeas API, it is possible to clear a node by setting the value to "
19143 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
19144 "this call. Instead you must use the L</aug-clear> call."
19148 #: ../fish/guestfish-actions.pod:345
19153 #: ../fish/guestfish-actions.pod:347
19156 " available 'groups ...'\n"
19161 #: ../fish/guestfish-actions.pod:353
19163 "The libguestfs groups, and the functions that those groups correspond to, "
19164 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
19165 "runtime by calling L</available-all-groups>."
19169 #: ../fish/guestfish-actions.pod:377
19170 msgid "You must call L</launch> before calling this function."
19174 #: ../fish/guestfish-actions.pod:399
19176 "This call was added in version C<1.0.80>. In previous versions of "
19177 "libguestfs all you could do would be to speculatively execute a command to "
19178 "find out if the daemon implemented it. See also L</version>."
19182 #: ../fish/guestfish-actions.pod:406
19183 msgid "available-all-groups"
19187 #: ../fish/guestfish-actions.pod:408
19190 " available-all-groups\n"
19195 #: ../fish/guestfish-actions.pod:410
19197 "This command returns a list of all optional groups that this daemon knows "
19198 "about. Note this returns both supported and unsupported groups. To find "
19199 "out which ones the daemon can actually support you have to call "
19200 "L</available> on each member of the returned list."
19204 #: ../fish/guestfish-actions.pod:416
19205 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
19209 #: ../fish/guestfish-actions.pod:418
19214 #: ../fish/guestfish-actions.pod:420
19217 " base64-in (base64file|-) filename\n"
19222 #: ../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
19223 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
19227 #: ../fish/guestfish-actions.pod:427
19232 #: ../fish/guestfish-actions.pod:429
19235 " base64-out filename (base64file|-)\n"
19240 #: ../fish/guestfish-actions.pod:436
19241 msgid "blockdev-flushbufs"
19245 #: ../fish/guestfish-actions.pod:438
19248 " blockdev-flushbufs device\n"
19253 #: ../fish/guestfish-actions.pod:445
19254 msgid "blockdev-getbsz"
19258 #: ../fish/guestfish-actions.pod:447
19261 " blockdev-getbsz device\n"
19266 #: ../fish/guestfish-actions.pod:456
19267 msgid "blockdev-getro"
19271 #: ../fish/guestfish-actions.pod:458
19274 " blockdev-getro device\n"
19279 #: ../fish/guestfish-actions.pod:465
19280 msgid "blockdev-getsize64"
19284 #: ../fish/guestfish-actions.pod:467
19287 " blockdev-getsize64 device\n"
19292 #: ../fish/guestfish-actions.pod:471
19293 msgid "See also L</blockdev-getsz>."
19297 #: ../fish/guestfish-actions.pod:475
19298 msgid "blockdev-getss"
19302 #: ../fish/guestfish-actions.pod:477
19305 " blockdev-getss device\n"
19310 #: ../fish/guestfish-actions.pod:482
19311 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
19315 #: ../fish/guestfish-actions.pod:487
19316 msgid "blockdev-getsz"
19320 #: ../fish/guestfish-actions.pod:489
19323 " blockdev-getsz device\n"
19328 #: ../fish/guestfish-actions.pod:494
19330 "See also L</blockdev-getss> for the real sector size of the device, and "
19331 "L</blockdev-getsize64> for the more useful I<size in bytes>."
19335 #: ../fish/guestfish-actions.pod:500
19336 msgid "blockdev-rereadpt"
19340 #: ../fish/guestfish-actions.pod:502
19343 " blockdev-rereadpt device\n"
19348 #: ../fish/guestfish-actions.pod:508
19349 msgid "blockdev-setbsz"
19353 #: ../fish/guestfish-actions.pod:510
19356 " blockdev-setbsz device blocksize\n"
19361 #: ../fish/guestfish-actions.pod:519
19362 msgid "blockdev-setro"
19366 #: ../fish/guestfish-actions.pod:521
19369 " blockdev-setro device\n"
19374 #: ../fish/guestfish-actions.pod:527
19375 msgid "blockdev-setrw"
19379 #: ../fish/guestfish-actions.pod:529
19382 " blockdev-setrw device\n"
19387 #: ../fish/guestfish-actions.pod:535
19388 msgid "case-sensitive-path"
19392 #: ../fish/guestfish-actions.pod:537
19395 " case-sensitive-path path\n"
19400 #: ../fish/guestfish-actions.pod:561
19402 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
19403 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
19404 "how the directories were originally created under Windows)."
19408 #: ../fish/guestfish-actions.pod:569
19409 msgid "See also L</realpath>."
19413 #: ../fish/guestfish-actions.pod:571
19418 #: ../fish/guestfish-actions.pod:573
19426 #: ../fish/guestfish-actions.pod:577
19428 "Note that this function cannot correctly handle binary files (specifically, "
19429 "files containing C<\\0> character which is treated as end of string). For "
19430 "those you need to use the L</read-file> or L</download> functions which have "
19431 "a more complex interface."
19435 #: ../fish/guestfish-actions.pod:585
19440 #: ../fish/guestfish-actions.pod:587
19443 " checksum csumtype path\n"
19448 #: ../fish/guestfish-actions.pod:630
19449 msgid "To get the checksum for a device, use L</checksum-device>."
19453 #: ../fish/guestfish-actions.pod:632
19454 msgid "To get the checksums for many files, use L</checksums-out>."
19458 #: ../fish/guestfish-actions.pod:634
19459 msgid "checksum-device"
19463 #: ../fish/guestfish-actions.pod:636
19466 " checksum-device csumtype device\n"
19471 #: ../fish/guestfish-actions.pod:638
19473 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
19474 "device named C<device>. For the types of checksums supported see the "
19475 "L</checksum> command."
19479 #: ../fish/guestfish-actions.pod:642
19480 msgid "checksums-out"
19484 #: ../fish/guestfish-actions.pod:644
19487 " checksums-out csumtype directory (sumsfile|-)\n"
19492 #: ../fish/guestfish-actions.pod:660
19497 #: ../fish/guestfish-actions.pod:662
19500 " chmod mode path\n"
19505 #: ../fish/guestfish-actions.pod:673
19510 #: ../fish/guestfish-actions.pod:675
19513 " chown owner group path\n"
19518 #: ../fish/guestfish-actions.pod:683
19523 #: ../fish/guestfish-actions.pod:685
19526 " command 'arguments ...'\n"
19531 #: ../fish/guestfish-actions.pod:692
19533 "The single parameter is an argv-style list of arguments. The first element "
19534 "is the name of the program to run. Subsequent elements are parameters. The "
19535 "list must be non-empty (ie. must contain a program name). Note that the "
19536 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
19540 #: ../fish/guestfish-actions.pod:720
19541 msgid "command-lines"
19545 #: ../fish/guestfish-actions.pod:722
19548 " command-lines 'arguments ...'\n"
19553 #: ../fish/guestfish-actions.pod:724
19554 msgid "This is the same as L</command>, but splits the result into a list of lines."
19558 #: ../fish/guestfish-actions.pod:727
19559 msgid "See also: L</sh-lines>"
19563 #: ../fish/guestfish-actions.pod:732
19568 #: ../fish/guestfish-actions.pod:734
19571 " config qemuparam qemuvalue\n"
19576 #: ../fish/guestfish-actions.pod:745
19581 #: ../fish/guestfish-actions.pod:747
19584 " copy-size src dest size\n"
19589 #: ../fish/guestfish-actions.pod:755
19594 #: ../fish/guestfish-actions.pod:757
19602 #: ../fish/guestfish-actions.pod:762
19607 #: ../fish/guestfish-actions.pod:764
19615 #: ../fish/guestfish-actions.pod:769
19620 #: ../fish/guestfish-actions.pod:771
19628 #: ../fish/guestfish-actions.pod:778
19630 "If the destination is a device, it must be as large or larger than the "
19631 "source file or device, otherwise the copy will fail. This command cannot do "
19632 "partial copies (see L</copy-size>)."
19636 #: ../fish/guestfish-actions.pod:782
19641 #: ../fish/guestfish-actions.pod:784
19649 #: ../fish/guestfish-actions.pod:792
19654 #: ../fish/guestfish-actions.pod:794
19662 #: ../fish/guestfish-actions.pod:803
19667 #: ../fish/guestfish-actions.pod:805
19675 #: ../fish/guestfish-actions.pod:811
19677 "Another way to get the same information is to enable verbose messages with "
19678 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
19679 "before running the program."
19683 #: ../fish/guestfish-actions.pod:816
19688 #: ../fish/guestfish-actions.pod:818
19691 " download remotefilename (filename|-)\n"
19696 #: ../fish/guestfish-actions.pod:825
19697 msgid "See also L</upload>, L</cat>."
19701 #: ../fish/guestfish-actions.pod:829
19702 msgid "download-offset"
19706 #: ../fish/guestfish-actions.pod:831
19709 " download-offset remotefilename (filename|-) offset size\n"
19714 #: ../fish/guestfish-actions.pod:839
19716 "Note that there is no limit on the amount of data that can be downloaded "
19717 "with this call, unlike with L</pread>, and this call always reads the full "
19718 "amount unless an error occurs."
19722 #: ../fish/guestfish-actions.pod:844
19723 msgid "See also L</download>, L</pread>."
19727 #: ../fish/guestfish-actions.pod:848
19728 msgid "drop-caches"
19732 #: ../fish/guestfish-actions.pod:850
19735 " drop-caches whattodrop\n"
19740 #: ../fish/guestfish-actions.pod:862
19745 #: ../fish/guestfish-actions.pod:864
19753 #: ../fish/guestfish-actions.pod:876
19758 #: ../fish/guestfish-actions.pod:878
19761 " e2fsck-f device\n"
19766 #: ../fish/guestfish-actions.pod:884
19768 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
19769 "should use L</fsck>."
19773 #: ../fish/guestfish-actions.pod:887
19774 msgid "echo-daemon"
19778 #: ../fish/guestfish-actions.pod:889
19781 " echo-daemon 'words ...'\n"
19786 #: ../fish/guestfish-actions.pod:896
19787 msgid "See also L</ping-daemon>."
19791 #: ../fish/guestfish-actions.pod:898
19796 #: ../fish/guestfish-actions.pod:900
19799 " egrep regex path\n"
19804 #: ../fish/guestfish-actions.pod:908
19809 #: ../fish/guestfish-actions.pod:910
19812 " egrepi regex path\n"
19817 #: ../fish/guestfish-actions.pod:918
19822 #: ../fish/guestfish-actions.pod:920
19825 " equal file1 file2\n"
19830 #: ../fish/guestfish-actions.pod:927
19835 #: ../fish/guestfish-actions.pod:929
19843 #: ../fish/guestfish-actions.pod:934
19844 msgid "See also L</is-file>, L</is-dir>, L</stat>."
19848 #: ../fish/guestfish-actions.pod:936
19853 #: ../fish/guestfish-actions.pod:938
19856 " fallocate path len\n"
19861 #: ../fish/guestfish-actions.pod:955
19862 msgid "fallocate64"
19866 #: ../fish/guestfish-actions.pod:957
19869 " fallocate64 path len\n"
19874 #: ../fish/guestfish-actions.pod:963
19876 "Note that this call allocates disk blocks for the file. To create a sparse "
19877 "file use L</truncate-size> instead."
19881 #: ../fish/guestfish-actions.pod:966
19883 "The deprecated call L</fallocate> does the same, but owing to an oversight "
19884 "it only allowed 30 bit lengths to be specified, effectively limiting the "
19885 "maximum size of files created through that call to 1GB."
19889 #: ../fish/guestfish-actions.pod:975
19894 #: ../fish/guestfish-actions.pod:977
19897 " fgrep pattern path\n"
19902 #: ../fish/guestfish-actions.pod:985
19907 #: ../fish/guestfish-actions.pod:987
19910 " fgrepi pattern path\n"
19915 #: ../fish/guestfish-actions.pod:995
19920 #: ../fish/guestfish-actions.pod:997
19928 #: ../fish/guestfish-actions.pod:1009
19930 "This command can also be used on C</dev/> devices (and partitions, LV "
19931 "names). You can for example use this to determine if a device contains a "
19932 "filesystem, although it's usually better to use L</vfs-type>."
19936 #: ../fish/guestfish-actions.pod:1019
19937 msgid "file-architecture"
19941 #: ../fish/guestfish-actions.pod:1021
19944 " file-architecture filename\n"
19949 #: ../fish/guestfish-actions.pod:1124
19954 #: ../fish/guestfish-actions.pod:1126
19962 #: ../fish/guestfish-actions.pod:1130
19964 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
19965 "L</is-file> etc. To get the size of block devices, use "
19966 "L</blockdev-getsize64>."
19970 #: ../fish/guestfish-actions.pod:1134
19975 #: ../fish/guestfish-actions.pod:1136
19978 " fill c len path\n"
19983 #: ../fish/guestfish-actions.pod:1142
19985 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
19986 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
19987 "L</fill-pattern>."
19991 #: ../fish/guestfish-actions.pod:1147
19992 msgid "fill-pattern"
19996 #: ../fish/guestfish-actions.pod:1149
19999 " fill-pattern pattern len path\n"
20004 #: ../fish/guestfish-actions.pod:1151
20006 "This function is like L</fill> except that it creates a new file of length "
20007 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
20008 "is truncated if necessary to ensure the length of the file is exactly C<len> "
20013 #: ../fish/guestfish-actions.pod:1156
20018 #: ../fish/guestfish-actions.pod:1158
20021 " find directory\n"
20026 #: ../fish/guestfish-actions.pod:1172
20027 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
20031 #: ../fish/guestfish-actions.pod:1185
20032 msgid "See also L</find0>."
20036 #: ../fish/guestfish-actions.pod:1190
20041 #: ../fish/guestfish-actions.pod:1192
20044 " find0 directory (files|-)\n"
20049 #: ../fish/guestfish-actions.pod:1198
20050 msgid "This command works the same way as L</find> with the following exceptions:"
20054 #: ../fish/guestfish-actions.pod:1225
20055 msgid "findfs-label"
20059 #: ../fish/guestfish-actions.pod:1227
20062 " findfs-label label\n"
20067 #: ../fish/guestfish-actions.pod:1233
20068 msgid "To find the label of a filesystem, use L</vfs-label>."
20072 #: ../fish/guestfish-actions.pod:1235
20073 msgid "findfs-uuid"
20077 #: ../fish/guestfish-actions.pod:1237
20080 " findfs-uuid uuid\n"
20085 #: ../fish/guestfish-actions.pod:1243
20086 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
20090 #: ../fish/guestfish-actions.pod:1245
20095 #: ../fish/guestfish-actions.pod:1247
20098 " fsck fstype device\n"
20103 #: ../fish/guestfish-actions.pod:1277
20108 #: ../fish/guestfish-actions.pod:1279
20116 #: ../fish/guestfish-actions.pod:1286
20117 msgid "get-autosync"
20121 #: ../fish/guestfish-actions.pod:1288
20129 #: ../fish/guestfish-actions.pod:1292
20134 #: ../fish/guestfish-actions.pod:1294
20142 #: ../fish/guestfish-actions.pod:1298
20143 msgid "get-e2label"
20147 #: ../fish/guestfish-actions.pod:1300
20150 " get-e2label device\n"
20155 #: ../fish/guestfish-actions.pod:1312
20160 #: ../fish/guestfish-actions.pod:1314
20163 " get-e2uuid device\n"
20168 #: ../fish/guestfish-actions.pod:1326
20169 msgid "get-memsize"
20173 #: ../fish/guestfish-actions.pod:1328
20181 #: ../fish/guestfish-actions.pod:1333
20183 "If L</set-memsize> was not called on this handle, and if "
20184 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
20185 "value for memsize."
20189 #: ../fish/guestfish-actions.pod:1340
20190 msgid "get-network"
20194 #: ../fish/guestfish-actions.pod:1342
20202 #: ../fish/guestfish-actions.pod:1346
20207 #: ../fish/guestfish-actions.pod:1348
20215 #: ../fish/guestfish-actions.pod:1355
20220 #: ../fish/guestfish-actions.pod:1357
20225 #: ../fish/guestfish-actions.pod:1359
20233 #: ../fish/guestfish-actions.pod:1366
20238 #: ../fish/guestfish-actions.pod:1368
20246 #: ../fish/guestfish-actions.pod:1375
20247 msgid "get-recovery-proc"
20251 #: ../fish/guestfish-actions.pod:1377
20254 " get-recovery-proc\n"
20259 #: ../fish/guestfish-actions.pod:1381
20260 msgid "get-selinux"
20264 #: ../fish/guestfish-actions.pod:1383
20272 #: ../fish/guestfish-actions.pod:1385
20274 "This returns the current setting of the selinux flag which is passed to the "
20275 "appliance at boot time. See L</set-selinux>."
20279 #: ../fish/guestfish-actions.pod:1391
20284 #: ../fish/guestfish-actions.pod:1393
20292 #: ../fish/guestfish-actions.pod:1400
20297 #: ../fish/guestfish-actions.pod:1402
20305 #: ../fish/guestfish-actions.pod:1406
20310 #: ../fish/guestfish-actions.pod:1408
20318 #: ../fish/guestfish-actions.pod:1410
20320 "Return the current umask. By default the umask is C<022> unless it has been "
20321 "set by calling L</umask>."
20325 #: ../fish/guestfish-actions.pod:1413
20326 msgid "get-verbose"
20330 #: ../fish/guestfish-actions.pod:1415
20338 #: ../fish/guestfish-actions.pod:1419
20343 #: ../fish/guestfish-actions.pod:1421
20351 #: ../fish/guestfish-actions.pod:1425
20352 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
20356 #: ../fish/guestfish-actions.pod:1428
20361 #: ../fish/guestfish-actions.pod:1430
20364 " getxattrs path\n"
20369 #: ../fish/guestfish-actions.pod:1438
20370 msgid "See also: L</lgetxattrs>, L<attr(5)>."
20374 #: ../fish/guestfish-actions.pod:1440
20375 msgid "glob-expand"
20379 #: ../fish/guestfish-actions.pod:1442
20382 " glob-expand pattern\n"
20387 #: ../fish/guestfish-actions.pod:1455
20392 #: ../fish/guestfish-actions.pod:1457
20395 " grep regex path\n"
20400 #: ../fish/guestfish-actions.pod:1465
20405 #: ../fish/guestfish-actions.pod:1467
20408 " grepi regex path\n"
20413 #: ../fish/guestfish-actions.pod:1475
20414 msgid "grub-install"
20418 #: ../fish/guestfish-actions.pod:1477
20421 " grub-install root device\n"
20426 #: ../fish/guestfish-actions.pod:1493
20431 #: ../fish/guestfish-actions.pod:1495
20439 #: ../fish/guestfish-actions.pod:1503
20444 #: ../fish/guestfish-actions.pod:1505
20447 " head-n nrlines path\n"
20452 #: ../fish/guestfish-actions.pod:1518
20457 #: ../fish/guestfish-actions.pod:1520
20465 #: ../fish/guestfish-actions.pod:1528
20470 #: ../fish/guestfish-actions.pod:1530
20473 " initrd-cat initrdpath filename\n"
20478 #: ../fish/guestfish-actions.pod:1542
20479 msgid "See also L</initrd-list>."
20483 #: ../fish/guestfish-actions.pod:1547
20484 msgid "initrd-list"
20488 #: ../fish/guestfish-actions.pod:1549
20491 " initrd-list path\n"
20496 #: ../fish/guestfish-actions.pod:1561
20497 msgid "inotify-add-watch"
20501 #: ../fish/guestfish-actions.pod:1563
20504 " inotify-add-watch path mask\n"
20509 #: ../fish/guestfish-actions.pod:1575
20510 msgid "inotify-close"
20514 #: ../fish/guestfish-actions.pod:1577
20522 #: ../fish/guestfish-actions.pod:1583
20523 msgid "inotify-files"
20527 #: ../fish/guestfish-actions.pod:1585
20535 #: ../fish/guestfish-actions.pod:1587
20537 "This function is a helpful wrapper around L</inotify-read> which just "
20538 "returns a list of pathnames of objects that were touched. The returned "
20539 "pathnames are sorted and deduplicated."
20543 #: ../fish/guestfish-actions.pod:1591
20544 msgid "inotify-init"
20548 #: ../fish/guestfish-actions.pod:1593
20551 " inotify-init maxevents\n"
20556 #: ../fish/guestfish-actions.pod:1599
20558 "C<maxevents> is the maximum number of events which will be queued up between "
20559 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
20560 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
20561 "default was 16384 events. Beyond this limit, the kernel throws away events, "
20562 "but records the fact that it threw them away by setting a flag "
20563 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
20567 #: ../fish/guestfish-actions.pod:1609
20569 "Before any events are generated, you have to add some watches to the "
20570 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
20571 "L</inotify-watch-all>."
20575 #: ../fish/guestfish-actions.pod:1615
20577 "Queued up events should be read periodically by calling L</inotify-read> (or "
20578 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
20579 "If you don't read the events out often enough then you risk the internal "
20580 "queue overflowing."
20584 #: ../fish/guestfish-actions.pod:1622
20586 "The handle should be closed after use by calling L</inotify-close>. This "
20587 "also removes any watches automatically."
20591 #: ../fish/guestfish-actions.pod:1631
20592 msgid "inotify-read"
20596 #: ../fish/guestfish-actions.pod:1633
20604 #: ../fish/guestfish-actions.pod:1646
20605 msgid "inotify-rm-watch"
20609 #: ../fish/guestfish-actions.pod:1648
20612 " inotify-rm-watch wd\n"
20617 #: ../fish/guestfish-actions.pod:1650
20618 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
20622 #: ../fish/guestfish-actions.pod:1653
20623 msgid "inspect-get-arch"
20627 #: ../fish/guestfish-actions.pod:1655
20630 " inspect-get-arch root\n"
20635 #: ../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
20637 "This function should only be called with a root device string as returned by "
20642 #: ../fish/guestfish-actions.pod:1660
20644 "This returns the architecture of the inspected operating system. The "
20645 "possible return values are listed under L</file-architecture>."
20649 #: ../fish/guestfish-actions.pod:1669
20650 msgid "inspect-get-distro"
20654 #: ../fish/guestfish-actions.pod:1671
20657 " inspect-get-distro root\n"
20662 #: ../fish/guestfish-actions.pod:1743
20663 msgid "inspect-get-filesystems"
20667 #: ../fish/guestfish-actions.pod:1745
20670 " inspect-get-filesystems root\n"
20675 #: ../fish/guestfish-actions.pod:1758
20677 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20678 "L</inspect-get-mountpoints>."
20682 #: ../fish/guestfish-actions.pod:1761
20683 msgid "inspect-get-hostname"
20687 #: ../fish/guestfish-actions.pod:1763
20690 " inspect-get-hostname root\n"
20695 #: ../fish/guestfish-actions.pod:1776
20696 msgid "inspect-get-major-version"
20700 #: ../fish/guestfish-actions.pod:1778
20703 " inspect-get-major-version root\n"
20708 #: ../fish/guestfish-actions.pod:1797
20709 msgid "inspect-get-minor-version"
20713 #: ../fish/guestfish-actions.pod:1799
20716 " inspect-get-minor-version root\n"
20721 #: ../fish/guestfish-actions.pod:1809
20723 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20724 "L</inspect-get-major-version>."
20728 #: ../fish/guestfish-actions.pod:1812
20729 msgid "inspect-get-mountpoints"
20733 #: ../fish/guestfish-actions.pod:1814
20736 " inspect-get-mountpoints root\n"
20741 #: ../fish/guestfish-actions.pod:1832
20743 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
20744 "L</inspect-get-filesystems>."
20748 #: ../fish/guestfish-actions.pod:1835
20749 msgid "inspect-get-package-format"
20753 #: ../fish/guestfish-actions.pod:1837
20756 " inspect-get-package-format root\n"
20761 #: ../fish/guestfish-actions.pod:1842
20763 "This function and L</inspect-get-package-management> return the package "
20764 "format and package management tool used by the inspected operating system. "
20765 "For example for Fedora these functions would return C<rpm> (package format) "
20766 "and C<yum> (package management)."
20770 #: ../fish/guestfish-actions.pod:1857
20771 msgid "inspect-get-package-management"
20775 #: ../fish/guestfish-actions.pod:1859
20778 " inspect-get-package-management root\n"
20783 #: ../fish/guestfish-actions.pod:1864
20785 "L</inspect-get-package-format> and this function return the package format "
20786 "and package management tool used by the inspected operating system. For "
20787 "example for Fedora these functions would return C<rpm> (package format) and "
20788 "C<yum> (package management)."
20792 #: ../fish/guestfish-actions.pod:1881
20793 msgid "inspect-get-product-name"
20797 #: ../fish/guestfish-actions.pod:1883
20800 " inspect-get-product-name root\n"
20805 #: ../fish/guestfish-actions.pod:1898
20806 msgid "inspect-get-roots"
20810 #: ../fish/guestfish-actions.pod:1900
20813 " inspect-get-roots\n"
20818 #: ../fish/guestfish-actions.pod:1902
20820 "This function is a convenient way to get the list of root devices, as "
20821 "returned from a previous call to L</inspect-os>, but without redoing the "
20822 "whole inspection process."
20826 #: ../fish/guestfish-actions.pod:1906
20828 "This returns an empty list if either no root devices were found or the "
20829 "caller has not called L</inspect-os>."
20833 #: ../fish/guestfish-actions.pod:1911
20834 msgid "inspect-get-type"
20838 #: ../fish/guestfish-actions.pod:1913
20841 " inspect-get-type root\n"
20846 #: ../fish/guestfish-actions.pod:1946
20847 msgid "inspect-get-windows-systemroot"
20851 #: ../fish/guestfish-actions.pod:1948
20854 " inspect-get-windows-systemroot root\n"
20859 #: ../fish/guestfish-actions.pod:1962
20860 msgid "inspect-list-applications"
20864 #: ../fish/guestfish-actions.pod:1964
20867 " inspect-list-applications root\n"
20872 #: ../fish/guestfish-actions.pod:1971
20874 "I<Note:> This call works differently from other parts of the inspection "
20875 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
20876 "then mount up the disks, before calling this. Listing applications is a "
20877 "significantly more difficult operation which requires access to the full "
20878 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
20879 "are just returning data cached in the libguestfs handle, this call actually "
20880 "reads parts of the mounted filesystems during the call."
20884 #: ../fish/guestfish-actions.pod:2061
20889 #: ../fish/guestfish-actions.pod:2063
20897 #: ../fish/guestfish-actions.pod:2078
20899 "You can pass the root string(s) returned to other L</inspect-get-*> "
20900 "functions in order to query further information about each operating system, "
20901 "such as the name and version."
20905 #: ../fish/guestfish-actions.pod:2083
20907 "This function uses other libguestfs features such as L</mount-ro> and "
20908 "L</umount-all> in order to mount and unmount filesystems and look at the "
20909 "contents. This should be called with no disks currently mounted. The "
20910 "function may also use Augeas, so any existing Augeas handle will be closed."
20914 #: ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2251 ../fish/guestfish-actions.pod:2297
20915 msgid "See also L</list-filesystems>."
20919 #: ../fish/guestfish-actions.pod:2097
20920 msgid "is-blockdev"
20924 #: ../fish/guestfish-actions.pod:2099
20927 " is-blockdev path\n"
20932 #: ../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
20933 msgid "See also L</stat>."
20937 #: ../fish/guestfish-actions.pod:2106
20942 #: ../fish/guestfish-actions.pod:2108
20950 #: ../fish/guestfish-actions.pod:2115
20955 #: ../fish/guestfish-actions.pod:2117
20958 " is-chardev path\n"
20963 #: ../fish/guestfish-actions.pod:2124
20968 #: ../fish/guestfish-actions.pod:2126
20976 #: ../fish/guestfish-actions.pod:2133
20981 #: ../fish/guestfish-actions.pod:2135
20989 #: ../fish/guestfish-actions.pod:2143
20994 #: ../fish/guestfish-actions.pod:2145
21002 #: ../fish/guestfish-actions.pod:2152
21007 #: ../fish/guestfish-actions.pod:2154
21015 #: ../fish/guestfish-actions.pod:2162
21016 msgid "is-launching"
21020 #: ../fish/guestfish-actions.pod:2164
21028 #: ../fish/guestfish-actions.pod:2171
21033 #: ../fish/guestfish-actions.pod:2173
21041 #: ../fish/guestfish-actions.pod:2178
21046 #: ../fish/guestfish-actions.pod:2180
21054 #: ../fish/guestfish-actions.pod:2187
21059 #: ../fish/guestfish-actions.pod:2189
21062 " is-socket path\n"
21067 #: ../fish/guestfish-actions.pod:2196
21072 #: ../fish/guestfish-actions.pod:2198
21075 " is-symlink path\n"
21080 #: ../fish/guestfish-actions.pod:2205
21081 msgid "kill-subprocess"
21085 #: ../fish/guestfish-actions.pod:2207
21088 " kill-subprocess\n"
21093 #: ../fish/guestfish-actions.pod:2211
21098 #: ../fish/guestfish-actions.pod:2213
21103 #: ../fish/guestfish-actions.pod:2215
21111 #: ../fish/guestfish-actions.pod:2223
21116 #: ../fish/guestfish-actions.pod:2225
21119 " lchown owner group path\n"
21124 #: ../fish/guestfish-actions.pod:2227
21126 "Change the file owner to C<owner> and group to C<group>. This is like "
21127 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
21132 #: ../fish/guestfish-actions.pod:2235
21137 #: ../fish/guestfish-actions.pod:2237
21140 " lgetxattrs path\n"
21145 #: ../fish/guestfish-actions.pod:2239
21147 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
21148 "it returns the extended attributes of the link itself."
21152 #: ../fish/guestfish-actions.pod:2243
21153 msgid "list-devices"
21157 #: ../fish/guestfish-actions.pod:2245
21165 #: ../fish/guestfish-actions.pod:2253
21166 msgid "list-filesystems"
21170 #: ../fish/guestfish-actions.pod:2255
21173 " list-filesystems\n"
21178 #: ../fish/guestfish-actions.pod:2274
21180 "This command runs other libguestfs commands, which might include L</mount> "
21181 "and L</umount>, and therefore you should use this soon after launch and only "
21182 "when nothing is mounted."
21186 #: ../fish/guestfish-actions.pod:2278
21188 "Not all of the filesystems returned will be mountable. In particular, swap "
21189 "partitions are returned in the list. Also this command does not check that "
21190 "each filesystem found is valid and mountable, and some filesystems might be "
21191 "mountable but require special options. Filesystems may not all belong to a "
21192 "single logical operating system (use L</inspect-os> to look for OSes)."
21196 #: ../fish/guestfish-actions.pod:2286
21197 msgid "list-partitions"
21201 #: ../fish/guestfish-actions.pod:2288
21204 " list-partitions\n"
21209 #: ../fish/guestfish-actions.pod:2294
21211 "This does not return logical volumes. For that you will need to call "
21216 #: ../fish/guestfish-actions.pod:2299
21221 #: ../fish/guestfish-actions.pod:2301
21229 #: ../fish/guestfish-actions.pod:2309
21234 #: ../fish/guestfish-actions.pod:2311
21237 " ln target linkname\n"
21242 #: ../fish/guestfish-actions.pod:2315
21247 #: ../fish/guestfish-actions.pod:2317
21250 " ln-f target linkname\n"
21255 #: ../fish/guestfish-actions.pod:2322
21260 #: ../fish/guestfish-actions.pod:2324
21263 " ln-s target linkname\n"
21268 #: ../fish/guestfish-actions.pod:2328
21273 #: ../fish/guestfish-actions.pod:2330
21276 " ln-sf target linkname\n"
21281 #: ../fish/guestfish-actions.pod:2335
21282 msgid "lremovexattr"
21286 #: ../fish/guestfish-actions.pod:2337
21289 " lremovexattr xattr path\n"
21294 #: ../fish/guestfish-actions.pod:2339
21296 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
21297 "it removes an extended attribute of the link itself."
21301 #: ../fish/guestfish-actions.pod:2343
21306 #: ../fish/guestfish-actions.pod:2345
21314 #: ../fish/guestfish-actions.pod:2351
21316 "This command is mostly useful for interactive sessions. Programs should "
21317 "probably use L</readdir> instead."
21321 #: ../fish/guestfish-actions.pod:2354
21326 #: ../fish/guestfish-actions.pod:2356
21329 " lsetxattr xattr val vallen path\n"
21334 #: ../fish/guestfish-actions.pod:2358
21336 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
21337 "sets an extended attribute of the link itself."
21341 #: ../fish/guestfish-actions.pod:2362
21346 #: ../fish/guestfish-actions.pod:2364
21354 #: ../fish/guestfish-actions.pod:2368
21356 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
21357 "the link is stat-ed, not the file it refers to."
21361 #: ../fish/guestfish-actions.pod:2374
21366 #: ../fish/guestfish-actions.pod:2376
21369 " lstatlist path 'names ...'\n"
21374 #: ../fish/guestfish-actions.pod:2378
21376 "This call allows you to perform the L</lstat> operation on multiple files, "
21377 "where all files are in the directory C<path>. C<names> is the list of files "
21378 "from this directory."
21382 #: ../fish/guestfish-actions.pod:2387
21384 "This call is intended for programs that want to efficiently list a directory "
21385 "contents without making many round-trips. See also L</lxattrlist> for a "
21386 "similarly efficient call for getting extended attributes. Very long "
21387 "directory listings might cause the protocol message size to be exceeded, "
21388 "causing this call to fail. The caller must split up such requests into "
21389 "smaller groups of names."
21393 #: ../fish/guestfish-actions.pod:2395
21394 msgid "luks-add-key"
21398 #: ../fish/guestfish-actions.pod:2397
21401 " luks-add-key device keyslot\n"
21406 #: ../fish/guestfish-actions.pod:2404
21408 "Note that if C<keyslot> already contains a key, then this command will "
21409 "fail. You have to use L</luks-kill-slot> first to remove that key."
21413 #: ../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
21415 "This command has one or more key or passphrase parameters. Guestfish will "
21416 "prompt for these separately."
21420 #: ../fish/guestfish-actions.pod:2411
21425 #: ../fish/guestfish-actions.pod:2413
21428 " luks-close device\n"
21433 #: ../fish/guestfish-actions.pod:2415
21435 "This closes a LUKS device that was created earlier by L</luks-open> or "
21436 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
21437 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
21438 "underlying block device."
21442 #: ../fish/guestfish-actions.pod:2421
21443 msgid "luks-format"
21447 #: ../fish/guestfish-actions.pod:2423
21450 " luks-format device keyslot\n"
21455 #: ../fish/guestfish-actions.pod:2436
21456 msgid "luks-format-cipher"
21460 #: ../fish/guestfish-actions.pod:2438
21463 " luks-format-cipher device keyslot cipher\n"
21468 #: ../fish/guestfish-actions.pod:2440
21470 "This command is the same as L</luks-format> but it also allows you to set "
21471 "the C<cipher> used."
21475 #: ../fish/guestfish-actions.pod:2449
21476 msgid "luks-kill-slot"
21480 #: ../fish/guestfish-actions.pod:2451
21483 " luks-kill-slot device keyslot\n"
21488 #: ../fish/guestfish-actions.pod:2460
21493 #: ../fish/guestfish-actions.pod:2462
21496 " luks-open device mapname\n"
21501 #: ../fish/guestfish-actions.pod:2476
21503 "If this block device contains LVM volume groups, then calling L</vgscan> "
21504 "followed by L</vg-activate-all> will make them visible."
21508 #: ../fish/guestfish-actions.pod:2483
21509 msgid "luks-open-ro"
21513 #: ../fish/guestfish-actions.pod:2485
21516 " luks-open-ro device mapname\n"
21521 #: ../fish/guestfish-actions.pod:2487
21523 "This is the same as L</luks-open> except that a read-only mapping is "
21528 #: ../fish/guestfish-actions.pod:2493
21533 #: ../fish/guestfish-actions.pod:2495
21536 " lvcreate logvol volgroup mbytes\n"
21541 #: ../fish/guestfish-actions.pod:2500
21542 msgid "lvm-canonical-lv-name"
21546 #: ../fish/guestfish-actions.pod:2502
21549 " lvm-canonical-lv-name lvname\n"
21554 #: ../fish/guestfish-actions.pod:2511
21555 msgid "See also L</is-lv>."
21559 #: ../fish/guestfish-actions.pod:2513
21560 msgid "lvm-clear-filter"
21564 #: ../fish/guestfish-actions.pod:2515
21567 " lvm-clear-filter\n"
21572 #: ../fish/guestfish-actions.pod:2517
21574 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
21579 #: ../fish/guestfish-actions.pod:2523
21580 msgid "lvm-remove-all"
21584 #: ../fish/guestfish-actions.pod:2525
21587 " lvm-remove-all\n"
21592 #: ../fish/guestfish-actions.pod:2533
21593 msgid "lvm-set-filter"
21597 #: ../fish/guestfish-actions.pod:2535
21600 " lvm-set-filter 'devices ...'\n"
21605 #: ../fish/guestfish-actions.pod:2560
21610 #: ../fish/guestfish-actions.pod:2562
21613 " lvremove device\n"
21618 #: ../fish/guestfish-actions.pod:2570
21623 #: ../fish/guestfish-actions.pod:2572
21626 " lvrename logvol newlogvol\n"
21631 #: ../fish/guestfish-actions.pod:2576
21636 #: ../fish/guestfish-actions.pod:2578
21639 " lvresize device mbytes\n"
21644 #: ../fish/guestfish-actions.pod:2584
21645 msgid "lvresize-free"
21649 #: ../fish/guestfish-actions.pod:2586
21652 " lvresize-free lv percent\n"
21657 #: ../fish/guestfish-actions.pod:2594
21662 #: ../fish/guestfish-actions.pod:2596
21670 #: ../fish/guestfish-actions.pod:2604
21671 msgid "See also L</lvs-full>, L</list-filesystems>."
21675 #: ../fish/guestfish-actions.pod:2606
21680 #: ../fish/guestfish-actions.pod:2608
21688 #: ../fish/guestfish-actions.pod:2613
21693 #: ../fish/guestfish-actions.pod:2615
21701 #: ../fish/guestfish-actions.pod:2619
21706 #: ../fish/guestfish-actions.pod:2621
21709 " lxattrlist path 'names ...'\n"
21714 #: ../fish/guestfish-actions.pod:2637
21716 "This call is intended for programs that want to efficiently list a directory "
21717 "contents without making many round-trips. See also L</lstatlist> for a "
21718 "similarly efficient call for getting standard stats. Very long directory "
21719 "listings might cause the protocol message size to be exceeded, causing this "
21720 "call to fail. The caller must split up such requests into smaller groups of "
21725 #: ../fish/guestfish-actions.pod:2645
21730 #: ../fish/guestfish-actions.pod:2647
21738 #: ../fish/guestfish-actions.pod:2651
21743 #: ../fish/guestfish-actions.pod:2653
21746 " mkdir-mode path mode\n"
21751 #: ../fish/guestfish-actions.pod:2662
21752 msgid "See also L</mkdir>, L</umask>"
21756 #: ../fish/guestfish-actions.pod:2664
21761 #: ../fish/guestfish-actions.pod:2666
21769 #: ../fish/guestfish-actions.pod:2671
21774 #: ../fish/guestfish-actions.pod:2673
21777 " mkdtemp template\n"
21782 #: ../fish/guestfish-actions.pod:2694
21787 #: ../fish/guestfish-actions.pod:2696
21790 " mke2fs-J fstype blocksize device journal\n"
21795 #: ../fish/guestfish-actions.pod:2704
21796 msgid "See also L</mke2journal>."
21800 #: ../fish/guestfish-actions.pod:2706
21805 #: ../fish/guestfish-actions.pod:2708
21808 " mke2fs-JL fstype blocksize device label\n"
21813 #: ../fish/guestfish-actions.pod:2713
21814 msgid "See also L</mke2journal-L>."
21818 #: ../fish/guestfish-actions.pod:2715
21823 #: ../fish/guestfish-actions.pod:2717
21826 " mke2fs-JU fstype blocksize device uuid\n"
21831 #: ../fish/guestfish-actions.pod:2722
21832 msgid "See also L</mke2journal-U>."
21836 #: ../fish/guestfish-actions.pod:2724
21837 msgid "mke2journal"
21841 #: ../fish/guestfish-actions.pod:2726
21844 " mke2journal blocksize device\n"
21849 #: ../fish/guestfish-actions.pod:2733
21850 msgid "mke2journal-L"
21854 #: ../fish/guestfish-actions.pod:2735
21857 " mke2journal-L blocksize label device\n"
21862 #: ../fish/guestfish-actions.pod:2739
21863 msgid "mke2journal-U"
21867 #: ../fish/guestfish-actions.pod:2741
21870 " mke2journal-U blocksize uuid device\n"
21875 #: ../fish/guestfish-actions.pod:2745
21880 #: ../fish/guestfish-actions.pod:2747
21883 " mkfifo mode path\n"
21888 #: ../fish/guestfish-actions.pod:2749
21890 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
21891 "is just a convenient wrapper around L</mknod>."
21895 #: ../fish/guestfish-actions.pod:2755
21900 #: ../fish/guestfish-actions.pod:2757
21903 " mkfs fstype device\n"
21908 #: ../fish/guestfish-actions.pod:2763
21913 #: ../fish/guestfish-actions.pod:2765
21916 " mkfs-b fstype blocksize device\n"
21921 #: ../fish/guestfish-actions.pod:2767
21923 "This call is similar to L</mkfs>, but it allows you to control the block "
21924 "size of the resulting filesystem. Supported block sizes depend on the "
21925 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
21929 #: ../fish/guestfish-actions.pod:2775
21930 msgid "mkmountpoint"
21934 #: ../fish/guestfish-actions.pod:2777
21937 " mkmountpoint exemptpath\n"
21942 #: ../fish/guestfish-actions.pod:2779
21944 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
21945 "to create extra mountpoints before mounting the first filesystem."
21949 #: ../fish/guestfish-actions.pod:2803
21951 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
21952 "unexpected errors if you try to mix these calls. It is safest to manually "
21953 "unmount filesystems and remove mountpoints after use."
21957 #: ../fish/guestfish-actions.pod:2807
21959 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
21960 "for this to work for manual mountpoints, you must ensure that the innermost "
21961 "mountpoints have the longest pathnames, as in the example code above."
21965 #: ../fish/guestfish-actions.pod:2814
21967 "Autosync [see L</set-autosync>, this is set by default on handles] means "
21968 "that L</umount-all> is called when the handle is closed which can also "
21969 "trigger these issues."
21973 #: ../fish/guestfish-actions.pod:2818
21978 #: ../fish/guestfish-actions.pod:2820
21981 " mknod mode devmajor devminor path\n"
21986 #: ../fish/guestfish-actions.pod:2830
21988 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
21989 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
21990 "regular file). These constants are available in the standard Linux header "
21991 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
21992 "wrappers around this command which bitwise OR in the appropriate constant "
21997 #: ../fish/guestfish-actions.pod:2840
22002 #: ../fish/guestfish-actions.pod:2842
22005 " mknod-b mode devmajor devminor path\n"
22010 #: ../fish/guestfish-actions.pod:2844
22012 "This call creates a block device node called C<path> with mode C<mode> and "
22013 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22014 "wrapper around L</mknod>."
22018 #: ../fish/guestfish-actions.pod:2850
22023 #: ../fish/guestfish-actions.pod:2852
22026 " mknod-c mode devmajor devminor path\n"
22031 #: ../fish/guestfish-actions.pod:2854
22033 "This call creates a char device node called C<path> with mode C<mode> and "
22034 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
22035 "wrapper around L</mknod>."
22039 #: ../fish/guestfish-actions.pod:2860
22044 #: ../fish/guestfish-actions.pod:2862
22052 #: ../fish/guestfish-actions.pod:2866
22057 #: ../fish/guestfish-actions.pod:2868
22060 " mkswap-L label device\n"
22065 #: ../fish/guestfish-actions.pod:2876
22070 #: ../fish/guestfish-actions.pod:2878
22073 " mkswap-U uuid device\n"
22078 #: ../fish/guestfish-actions.pod:2882
22079 msgid "mkswap-file"
22083 #: ../fish/guestfish-actions.pod:2884
22086 " mkswap-file path\n"
22091 #: ../fish/guestfish-actions.pod:2888
22093 "This command just writes a swap file signature to an existing file. To "
22094 "create the file itself, use something like L</fallocate>."
22098 #: ../fish/guestfish-actions.pod:2891
22103 #: ../fish/guestfish-actions.pod:2893
22106 " modprobe modulename\n"
22111 #: ../fish/guestfish-actions.pod:2900
22116 #: ../fish/guestfish-actions.pod:2902
22119 " mount device mountpoint\n"
22124 #: ../fish/guestfish-actions.pod:2918
22126 "B<Important note:> When you use this call, the filesystem options C<sync> "
22127 "and C<noatime> are set implicitly. This was originally done because we "
22128 "thought it would improve reliability, but it turns out that I<-o sync> has a "
22129 "very large negative performance impact and negligible effect on "
22130 "reliability. Therefore we recommend that you avoid using L</mount> in any "
22131 "code that needs performance, and instead use L</mount-options> (use an empty "
22132 "string for the first parameter if you don't want any options)."
22136 #: ../fish/guestfish-actions.pod:2928
22141 #: ../fish/guestfish-actions.pod:2930
22144 " mount-loop file mountpoint\n"
22149 #: ../fish/guestfish-actions.pod:2936
22150 msgid "mount-options"
22154 #: ../fish/guestfish-actions.pod:2938
22157 " mount-options options device mountpoint\n"
22162 #: ../fish/guestfish-actions.pod:2940
22164 "This is the same as the L</mount> command, but it allows you to set the "
22165 "mount options as for the L<mount(8)> I<-o> flag."
22169 #: ../fish/guestfish-actions.pod:2948
22174 #: ../fish/guestfish-actions.pod:2950
22177 " mount-ro device mountpoint\n"
22182 #: ../fish/guestfish-actions.pod:2952
22184 "This is the same as the L</mount> command, but it mounts the filesystem with "
22185 "the read-only (I<-o ro>) flag."
22189 #: ../fish/guestfish-actions.pod:2955
22194 #: ../fish/guestfish-actions.pod:2957
22197 " mount-vfs options vfstype device mountpoint\n"
22202 #: ../fish/guestfish-actions.pod:2959
22204 "This is the same as the L</mount> command, but it allows you to set both the "
22205 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
22209 #: ../fish/guestfish-actions.pod:2963
22210 msgid "mountpoints"
22214 #: ../fish/guestfish-actions.pod:2965
22222 #: ../fish/guestfish-actions.pod:2967
22224 "This call is similar to L</mounts>. That call returns a list of devices. "
22225 "This one returns a hash table (map) of device name to directory where the "
22226 "device is mounted."
22230 #: ../fish/guestfish-actions.pod:2971
22235 #: ../fish/guestfish-actions.pod:2973
22243 #: ../fish/guestfish-actions.pod:2980
22244 msgid "See also: L</mountpoints>"
22248 #: ../fish/guestfish-actions.pod:2982
22253 #: ../fish/guestfish-actions.pod:2984
22261 #: ../fish/guestfish-actions.pod:2989
22262 msgid "ntfs-3g-probe"
22266 #: ../fish/guestfish-actions.pod:2991
22269 " ntfs-3g-probe true|false device\n"
22274 #: ../fish/guestfish-actions.pod:3005
22279 #: ../fish/guestfish-actions.pod:3007
22282 " ntfsresize device\n"
22287 #: ../fish/guestfish-actions.pod:3013
22288 msgid "ntfsresize-size"
22292 #: ../fish/guestfish-actions.pod:3015
22295 " ntfsresize-size device size\n"
22300 #: ../fish/guestfish-actions.pod:3017
22302 "This command is the same as L</ntfsresize> except that it allows you to "
22303 "specify the new size (in bytes) explicitly."
22307 #: ../fish/guestfish-actions.pod:3020
22312 #: ../fish/guestfish-actions.pod:3022
22315 " part-add device prlogex startsect endsect\n"
22320 #: ../fish/guestfish-actions.pod:3024
22322 "This command adds a partition to C<device>. If there is no partition table "
22323 "on the device, call L</part-init> first."
22327 #: ../fish/guestfish-actions.pod:3036
22329 "Creating a partition which covers the whole disk is not so easy. Use "
22330 "L</part-disk> to do that."
22334 #: ../fish/guestfish-actions.pod:3039
22339 #: ../fish/guestfish-actions.pod:3041
22342 " part-del device partnum\n"
22347 #: ../fish/guestfish-actions.pod:3049
22352 #: ../fish/guestfish-actions.pod:3051
22355 " part-disk device parttype\n"
22360 #: ../fish/guestfish-actions.pod:3053
22362 "This command is simply a combination of L</part-init> followed by "
22363 "L</part-add> to create a single primary partition covering the whole disk."
22367 #: ../fish/guestfish-actions.pod:3057
22369 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
22370 "possible values are described in L</part-init>."
22374 #: ../fish/guestfish-actions.pod:3063
22375 msgid "part-get-bootable"
22379 #: ../fish/guestfish-actions.pod:3065
22382 " part-get-bootable device partnum\n"
22387 #: ../fish/guestfish-actions.pod:3070
22388 msgid "See also L</part-set-bootable>."
22392 #: ../fish/guestfish-actions.pod:3072
22393 msgid "part-get-mbr-id"
22397 #: ../fish/guestfish-actions.pod:3074
22400 " part-get-mbr-id device partnum\n"
22405 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3217
22407 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
22408 "undefined results for other partition table types (see "
22409 "L</part-get-parttype>)."
22413 #: ../fish/guestfish-actions.pod:3083
22414 msgid "part-get-parttype"
22418 #: ../fish/guestfish-actions.pod:3085
22421 " part-get-parttype device\n"
22426 #: ../fish/guestfish-actions.pod:3090
22428 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
22429 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
22430 "possible, although unusual. See L</part-init> for a full list."
22434 #: ../fish/guestfish-actions.pod:3095
22439 #: ../fish/guestfish-actions.pod:3097
22442 " part-init device parttype\n"
22447 #: ../fish/guestfish-actions.pod:3103
22449 "Initially there are no partitions. Following this, you should call "
22450 "L</part-add> for each partition required."
22454 #: ../fish/guestfish-actions.pod:3166
22459 #: ../fish/guestfish-actions.pod:3168
22462 " part-list device\n"
22467 #: ../fish/guestfish-actions.pod:3183
22469 "Start of the partition I<in bytes>. To get sectors you have to divide by "
22470 "the device's sector size, see L</blockdev-getss>."
22474 #: ../fish/guestfish-actions.pod:3196
22475 msgid "part-set-bootable"
22479 #: ../fish/guestfish-actions.pod:3198
22482 " part-set-bootable device partnum true|false\n"
22487 #: ../fish/guestfish-actions.pod:3207
22488 msgid "part-set-mbr-id"
22492 #: ../fish/guestfish-actions.pod:3209
22495 " part-set-mbr-id device partnum idbyte\n"
22500 #: ../fish/guestfish-actions.pod:3221
22501 msgid "part-set-name"
22505 #: ../fish/guestfish-actions.pod:3223
22508 " part-set-name device partnum name\n"
22513 #: ../fish/guestfish-actions.pod:3231
22514 msgid "part-to-dev"
22518 #: ../fish/guestfish-actions.pod:3233
22521 " part-to-dev partition\n"
22526 #: ../fish/guestfish-actions.pod:3239
22528 "The named partition must exist, for example as a string returned from "
22529 "L</list-partitions>."
22533 #: ../fish/guestfish-actions.pod:3242
22534 msgid "ping-daemon"
22538 #: ../fish/guestfish-actions.pod:3244
22546 #: ../fish/guestfish-actions.pod:3251
22551 #: ../fish/guestfish-actions.pod:3253
22554 " pread path count offset\n"
22559 #: ../fish/guestfish-actions.pod:3261
22560 msgid "See also L</pwrite>, L</pread-device>."
22564 #: ../fish/guestfish-actions.pod:3266
22565 msgid "pread-device"
22569 #: ../fish/guestfish-actions.pod:3268
22572 " pread-device device count offset\n"
22577 #: ../fish/guestfish-actions.pod:3276
22578 msgid "See also L</pread>."
22582 #: ../fish/guestfish-actions.pod:3281
22587 #: ../fish/guestfish-actions.pod:3283
22590 " pvcreate device\n"
22595 #: ../fish/guestfish-actions.pod:3289
22600 #: ../fish/guestfish-actions.pod:3291
22603 " pvremove device\n"
22608 #: ../fish/guestfish-actions.pod:3300
22613 #: ../fish/guestfish-actions.pod:3302
22616 " pvresize device\n"
22621 #: ../fish/guestfish-actions.pod:3307
22622 msgid "pvresize-size"
22626 #: ../fish/guestfish-actions.pod:3309
22629 " pvresize-size device size\n"
22634 #: ../fish/guestfish-actions.pod:3311
22636 "This command is the same as L</pvresize> except that it allows you to "
22637 "specify the new size (in bytes) explicitly."
22641 #: ../fish/guestfish-actions.pod:3314
22646 #: ../fish/guestfish-actions.pod:3316
22654 #: ../fish/guestfish-actions.pod:3324
22655 msgid "See also L</pvs-full>."
22659 #: ../fish/guestfish-actions.pod:3326
22664 #: ../fish/guestfish-actions.pod:3328
22672 #: ../fish/guestfish-actions.pod:3333
22677 #: ../fish/guestfish-actions.pod:3335
22685 #: ../fish/guestfish-actions.pod:3339
22690 #: ../fish/guestfish-actions.pod:3341
22693 " pwrite path content offset\n"
22698 #: ../fish/guestfish-actions.pod:3352
22699 msgid "See also L</pread>, L</pwrite-device>."
22703 #: ../fish/guestfish-actions.pod:3357
22704 msgid "pwrite-device"
22708 #: ../fish/guestfish-actions.pod:3359
22711 " pwrite-device device content offset\n"
22716 #: ../fish/guestfish-actions.pod:3369
22717 msgid "See also L</pwrite>."
22721 #: ../fish/guestfish-actions.pod:3374
22726 #: ../fish/guestfish-actions.pod:3376
22729 " read-file path\n"
22734 #: ../fish/guestfish-actions.pod:3381
22736 "Unlike L</cat>, this function can correctly handle files that contain "
22737 "embedded ASCII NUL characters. However unlike L</download>, this function "
22738 "is limited in the total size of file that can be handled."
22742 #: ../fish/guestfish-actions.pod:3389
22747 #: ../fish/guestfish-actions.pod:3391
22750 " read-lines path\n"
22755 #: ../fish/guestfish-actions.pod:3398
22757 "Note that this function cannot correctly handle binary files (specifically, "
22758 "files containing C<\\0> character which is treated as end of line). For "
22759 "those you need to use the L</read-file> function which has a more complex "
22764 #: ../fish/guestfish-actions.pod:3403
22769 #: ../fish/guestfish-actions.pod:3405
22777 #: ../fish/guestfish-actions.pod:3457
22779 "This function is primarily intended for use by programs. To get a simple "
22780 "list of names, use L</ls>. To get a printable directory for human "
22781 "consumption, use L</ll>."
22785 #: ../fish/guestfish-actions.pod:3461
22790 #: ../fish/guestfish-actions.pod:3463
22798 #: ../fish/guestfish-actions.pod:3467
22799 msgid "readlinklist"
22803 #: ../fish/guestfish-actions.pod:3469
22806 " readlinklist path 'names ...'\n"
22811 #: ../fish/guestfish-actions.pod:3493
22816 #: ../fish/guestfish-actions.pod:3495
22824 #: ../fish/guestfish-actions.pod:3500
22825 msgid "removexattr"
22829 #: ../fish/guestfish-actions.pod:3502
22832 " removexattr xattr path\n"
22837 #: ../fish/guestfish-actions.pod:3507
22838 msgid "See also: L</lremovexattr>, L<attr(5)>."
22842 #: ../fish/guestfish-actions.pod:3509
22847 #: ../fish/guestfish-actions.pod:3511
22850 " resize2fs device\n"
22855 #: ../fish/guestfish-actions.pod:3516
22857 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
22858 "before calling this command. For unknown reasons C<resize2fs> sometimes "
22859 "gives an error about this and sometimes not. In any case, it is always safe "
22860 "to call L</e2fsck-f> before calling this function."
22864 #: ../fish/guestfish-actions.pod:3522
22865 msgid "resize2fs-size"
22869 #: ../fish/guestfish-actions.pod:3524
22872 " resize2fs-size device size\n"
22877 #: ../fish/guestfish-actions.pod:3526
22879 "This command is the same as L</resize2fs> except that it allows you to "
22880 "specify the new size (in bytes) explicitly."
22884 #: ../fish/guestfish-actions.pod:3529
22889 #: ../fish/guestfish-actions.pod:3531
22897 #: ../fish/guestfish-actions.pod:3535
22902 #: ../fish/guestfish-actions.pod:3537
22910 #: ../fish/guestfish-actions.pod:3543
22915 #: ../fish/guestfish-actions.pod:3545
22923 #: ../fish/guestfish-actions.pod:3549
22924 msgid "rmmountpoint"
22928 #: ../fish/guestfish-actions.pod:3551
22931 " rmmountpoint exemptpath\n"
22936 #: ../fish/guestfish-actions.pod:3553
22938 "This calls removes a mountpoint that was previously created with "
22939 "L</mkmountpoint>. See L</mkmountpoint> for full details."
22943 #: ../fish/guestfish-actions.pod:3557
22944 msgid "scrub-device"
22948 #: ../fish/guestfish-actions.pod:3559
22951 " scrub-device device\n"
22956 #: ../fish/guestfish-actions.pod:3570
22961 #: ../fish/guestfish-actions.pod:3572
22964 " scrub-file file\n"
22969 #: ../fish/guestfish-actions.pod:3582
22970 msgid "scrub-freespace"
22974 #: ../fish/guestfish-actions.pod:3584
22977 " scrub-freespace dir\n"
22982 #: ../fish/guestfish-actions.pod:3586
22984 "This command creates the directory C<dir> and then fills it with files until "
22985 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
22986 "deletes them. The intention is to scrub any free space on the partition "
22987 "containing C<dir>."
22991 #: ../fish/guestfish-actions.pod:3595
22996 #: ../fish/guestfish-actions.pod:3597
23001 #: ../fish/guestfish-actions.pod:3599
23004 " set-append append\n"
23009 #: ../fish/guestfish-actions.pod:3610
23010 msgid "set-autosync"
23014 #: ../fish/guestfish-actions.pod:3612
23019 #: ../fish/guestfish-actions.pod:3614
23022 " set-autosync true|false\n"
23027 #: ../fish/guestfish-actions.pod:3616
23029 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
23030 "effort attempt to run L</umount-all> followed by L</sync> when the handle is "
23031 "closed (also if the program exits without closing handles)."
23035 #: ../fish/guestfish-actions.pod:3624
23040 #: ../fish/guestfish-actions.pod:3626
23045 #: ../fish/guestfish-actions.pod:3628
23048 " set-direct true|false\n"
23053 #: ../fish/guestfish-actions.pod:3634
23055 "One consequence of this is that log messages aren't caught by the library "
23056 "and handled by L</set-log-message-callback>, but go straight to stdout."
23060 #: ../fish/guestfish-actions.pod:3643
23061 msgid "set-e2label"
23065 #: ../fish/guestfish-actions.pod:3645
23068 " set-e2label device label\n"
23073 #: ../fish/guestfish-actions.pod:3651
23075 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
23076 "label on a filesystem."
23080 #: ../fish/guestfish-actions.pod:3654
23085 #: ../fish/guestfish-actions.pod:3656
23088 " set-e2uuid device uuid\n"
23093 #: ../fish/guestfish-actions.pod:3663
23095 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
23096 "UUID of a filesystem."
23100 #: ../fish/guestfish-actions.pod:3666
23101 msgid "set-memsize"
23105 #: ../fish/guestfish-actions.pod:3668
23110 #: ../fish/guestfish-actions.pod:3670
23113 " set-memsize memsize\n"
23118 #: ../fish/guestfish-actions.pod:3672
23120 "This sets the memory size in megabytes allocated to the qemu subprocess. "
23121 "This only has any effect if called before L</launch>."
23125 #: ../fish/guestfish-actions.pod:3683
23126 msgid "set-network"
23130 #: ../fish/guestfish-actions.pod:3685
23135 #: ../fish/guestfish-actions.pod:3687
23138 " set-network true|false\n"
23143 #: ../fish/guestfish-actions.pod:3695
23144 msgid "You must call this before calling L</launch>, otherwise it has no effect."
23148 #: ../fish/guestfish-actions.pod:3698
23153 #: ../fish/guestfish-actions.pod:3700
23158 #: ../fish/guestfish-actions.pod:3702
23161 " set-path searchpath\n"
23166 #: ../fish/guestfish-actions.pod:3711
23171 #: ../fish/guestfish-actions.pod:3713
23176 #: ../fish/guestfish-actions.pod:3715
23184 #: ../fish/guestfish-actions.pod:3735
23185 msgid "set-recovery-proc"
23189 #: ../fish/guestfish-actions.pod:3737
23190 msgid "recovery-proc"
23194 #: ../fish/guestfish-actions.pod:3739
23197 " set-recovery-proc true|false\n"
23202 #: ../fish/guestfish-actions.pod:3741
23204 "If this is called with the parameter C<false> then L</launch> does not "
23205 "create a recovery process. The purpose of the recovery process is to stop "
23206 "runaway qemu processes in the case where the main program aborts abruptly."
23210 #: ../fish/guestfish-actions.pod:3746
23212 "This only has any effect if called before L</launch>, and the default is "
23217 #: ../fish/guestfish-actions.pod:3755
23218 msgid "set-selinux"
23222 #: ../fish/guestfish-actions.pod:3757
23227 #: ../fish/guestfish-actions.pod:3759
23230 " set-selinux true|false\n"
23235 #: ../fish/guestfish-actions.pod:3770
23240 #: ../fish/guestfish-actions.pod:3772
23245 #: ../fish/guestfish-actions.pod:3774
23248 " set-trace true|false\n"
23253 #: ../fish/guestfish-actions.pod:3790
23254 msgid "set-verbose"
23258 #: ../fish/guestfish-actions.pod:3792
23263 #: ../fish/guestfish-actions.pod:3794
23266 " set-verbose true|false\n"
23271 #: ../fish/guestfish-actions.pod:3801
23276 #: ../fish/guestfish-actions.pod:3803
23279 " setcon context\n"
23284 #: ../fish/guestfish-actions.pod:3810
23289 #: ../fish/guestfish-actions.pod:3812
23292 " setxattr xattr val vallen path\n"
23297 #: ../fish/guestfish-actions.pod:3818
23298 msgid "See also: L</lsetxattr>, L<attr(5)>."
23302 #: ../fish/guestfish-actions.pod:3820
23307 #: ../fish/guestfish-actions.pod:3822
23310 " sfdisk device cyls heads sectors 'lines ...'\n"
23315 #: ../fish/guestfish-actions.pod:3844
23316 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
23320 #: ../fish/guestfish-actions.pod:3850
23325 #: ../fish/guestfish-actions.pod:3852
23328 " sfdiskM device 'lines ...'\n"
23333 #: ../fish/guestfish-actions.pod:3854
23335 "This is a simplified interface to the L</sfdisk> command, where partition "
23336 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
23337 "you don't need to specify the cyls, heads and sectors parameters which were "
23338 "rarely if ever used anyway."
23342 #: ../fish/guestfish-actions.pod:3860
23343 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
23347 #: ../fish/guestfish-actions.pod:3866
23352 #: ../fish/guestfish-actions.pod:3868
23355 " sfdisk-N device partnum cyls heads sectors line\n"
23360 #: ../fish/guestfish-actions.pod:3873
23362 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
23363 "cyls/heads/sectors parameters."
23367 #: ../fish/guestfish-actions.pod:3876
23368 msgid "See also: L</part-add>"
23372 #: ../fish/guestfish-actions.pod:3881
23373 msgid "sfdisk-disk-geometry"
23377 #: ../fish/guestfish-actions.pod:3883
23380 " sfdisk-disk-geometry device\n"
23385 #: ../fish/guestfish-actions.pod:3885
23387 "This displays the disk geometry of C<device> read from the partition table. "
23388 "Especially in the case where the underlying block device has been resized, "
23389 "this can be different from the kernel's idea of the geometry (see "
23390 "L</sfdisk-kernel-geometry>)."
23394 #: ../fish/guestfish-actions.pod:3893
23395 msgid "sfdisk-kernel-geometry"
23399 #: ../fish/guestfish-actions.pod:3895
23402 " sfdisk-kernel-geometry device\n"
23407 #: ../fish/guestfish-actions.pod:3902
23412 #: ../fish/guestfish-actions.pod:3904
23415 " sfdisk-l device\n"
23420 #: ../fish/guestfish-actions.pod:3910
23421 msgid "See also: L</part-list>"
23425 #: ../fish/guestfish-actions.pod:3912
23430 #: ../fish/guestfish-actions.pod:3914
23438 #: ../fish/guestfish-actions.pod:3919
23439 msgid "This is like L</command>, but passes the command to:"
23443 #: ../fish/guestfish-actions.pod:3927
23444 msgid "All the provisos about L</command> apply to this call."
23448 #: ../fish/guestfish-actions.pod:3929
23453 #: ../fish/guestfish-actions.pod:3931
23456 " sh-lines command\n"
23461 #: ../fish/guestfish-actions.pod:3933
23462 msgid "This is the same as L</sh>, but splits the result into a list of lines."
23466 #: ../fish/guestfish-actions.pod:3936
23467 msgid "See also: L</command-lines>"
23471 #: ../fish/guestfish-actions.pod:3938
23476 #: ../fish/guestfish-actions.pod:3940
23484 #: ../fish/guestfish-actions.pod:3944
23489 #: ../fish/guestfish-actions.pod:3946
23497 #: ../fish/guestfish-actions.pod:3952
23502 #: ../fish/guestfish-actions.pod:3954
23510 #: ../fish/guestfish-actions.pod:3962
23515 #: ../fish/guestfish-actions.pod:3964
23523 #: ../fish/guestfish-actions.pod:3972
23528 #: ../fish/guestfish-actions.pod:3974
23531 " strings-e encoding path\n"
23536 #: ../fish/guestfish-actions.pod:3976
23538 "This is like the L</strings> command, but allows you to specify the encoding "
23539 "of strings that are looked for in the source file C<path>."
23543 #: ../fish/guestfish-actions.pod:3986
23545 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
23546 "ISO-8859-X (this is what L</strings> uses)."
23550 #: ../fish/guestfish-actions.pod:4018
23551 msgid "swapoff-device"
23555 #: ../fish/guestfish-actions.pod:4020
23558 " swapoff-device device\n"
23563 #: ../fish/guestfish-actions.pod:4022
23565 "This command disables the libguestfs appliance swap device or partition "
23566 "named C<device>. See L</swapon-device>."
23570 #: ../fish/guestfish-actions.pod:4026
23571 msgid "swapoff-file"
23575 #: ../fish/guestfish-actions.pod:4028
23578 " swapoff-file file\n"
23583 #: ../fish/guestfish-actions.pod:4032
23584 msgid "swapoff-label"
23588 #: ../fish/guestfish-actions.pod:4034
23591 " swapoff-label label\n"
23596 #: ../fish/guestfish-actions.pod:4039
23597 msgid "swapoff-uuid"
23601 #: ../fish/guestfish-actions.pod:4041
23604 " swapoff-uuid uuid\n"
23609 #: ../fish/guestfish-actions.pod:4046
23610 msgid "swapon-device"
23614 #: ../fish/guestfish-actions.pod:4048
23617 " swapon-device device\n"
23622 #: ../fish/guestfish-actions.pod:4050
23624 "This command enables the libguestfs appliance to use the swap device or "
23625 "partition named C<device>. The increased memory is made available for all "
23626 "commands, for example those run using L</command> or L</sh>."
23630 #: ../fish/guestfish-actions.pod:4062
23631 msgid "swapon-file"
23635 #: ../fish/guestfish-actions.pod:4064
23638 " swapon-file file\n"
23643 #: ../fish/guestfish-actions.pod:4066
23644 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
23648 #: ../fish/guestfish-actions.pod:4069
23649 msgid "swapon-label"
23653 #: ../fish/guestfish-actions.pod:4071
23656 " swapon-label label\n"
23661 #: ../fish/guestfish-actions.pod:4073
23663 "This command enables swap to a labeled swap partition. See "
23664 "L</swapon-device> for other notes."
23668 #: ../fish/guestfish-actions.pod:4076
23669 msgid "swapon-uuid"
23673 #: ../fish/guestfish-actions.pod:4078
23676 " swapon-uuid uuid\n"
23681 #: ../fish/guestfish-actions.pod:4080
23683 "This command enables swap to a swap partition with the given UUID. See "
23684 "L</swapon-device> for other notes."
23688 #: ../fish/guestfish-actions.pod:4083
23693 #: ../fish/guestfish-actions.pod:4085
23701 #: ../fish/guestfish-actions.pod:4093
23706 #: ../fish/guestfish-actions.pod:4095
23714 #: ../fish/guestfish-actions.pod:4103
23719 #: ../fish/guestfish-actions.pod:4105
23722 " tail-n nrlines path\n"
23727 #: ../fish/guestfish-actions.pod:4118
23732 #: ../fish/guestfish-actions.pod:4120
23735 " tar-in (tarfile|-) directory\n"
23740 #: ../fish/guestfish-actions.pod:4125
23741 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
23745 #: ../fish/guestfish-actions.pod:4130
23750 #: ../fish/guestfish-actions.pod:4132
23753 " tar-out directory (tarfile|-)\n"
23758 #: ../fish/guestfish-actions.pod:4137
23759 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
23763 #: ../fish/guestfish-actions.pod:4142
23768 #: ../fish/guestfish-actions.pod:4144
23771 " tgz-in (tarball|-) directory\n"
23776 #: ../fish/guestfish-actions.pod:4149
23777 msgid "To upload an uncompressed tarball, use L</tar-in>."
23781 #: ../fish/guestfish-actions.pod:4153
23786 #: ../fish/guestfish-actions.pod:4155
23789 " tgz-out directory (tarball|-)\n"
23794 #: ../fish/guestfish-actions.pod:4160
23795 msgid "To download an uncompressed tarball, use L</tar-out>."
23799 #: ../fish/guestfish-actions.pod:4164
23804 #: ../fish/guestfish-actions.pod:4166
23812 #: ../fish/guestfish-actions.pod:4175
23817 #: ../fish/guestfish-actions.pod:4177
23825 #: ../fish/guestfish-actions.pod:4182
23826 msgid "truncate-size"
23830 #: ../fish/guestfish-actions.pod:4184
23833 " truncate-size path size\n"
23838 #: ../fish/guestfish-actions.pod:4189
23840 "If the current file size is less than C<size> then the file is extended to "
23841 "the required size with zero bytes. This creates a sparse file (ie. disk "
23842 "blocks are not allocated for the file until you write to it). To create a "
23843 "non-sparse file of zeroes, use L</fallocate64> instead."
23847 #: ../fish/guestfish-actions.pod:4195
23852 #: ../fish/guestfish-actions.pod:4197
23855 " tune2fs-l device\n"
23860 #: ../fish/guestfish-actions.pod:4207
23865 #: ../fish/guestfish-actions.pod:4209
23868 " txz-in (tarball|-) directory\n"
23873 #: ../fish/guestfish-actions.pod:4216
23878 #: ../fish/guestfish-actions.pod:4218
23881 " txz-out directory (tarball|-)\n"
23886 #: ../fish/guestfish-actions.pod:4225
23891 #: ../fish/guestfish-actions.pod:4227
23899 #: ../fish/guestfish-actions.pod:4241
23900 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
23904 #: ../fish/guestfish-actions.pod:4246
23909 #: ../fish/guestfish-actions.pod:4248
23914 #: ../fish/guestfish-actions.pod:4250
23917 " umount pathordevice\n"
23922 #: ../fish/guestfish-actions.pod:4256
23927 #: ../fish/guestfish-actions.pod:4258
23928 msgid "unmount-all"
23932 #: ../fish/guestfish-actions.pod:4260
23940 #: ../fish/guestfish-actions.pod:4266
23945 #: ../fish/guestfish-actions.pod:4268
23948 " upload (filename|-) remotefilename\n"
23953 #: ../fish/guestfish-actions.pod:4275
23954 msgid "See also L</download>."
23958 #: ../fish/guestfish-actions.pod:4279
23959 msgid "upload-offset"
23963 #: ../fish/guestfish-actions.pod:4281
23966 " upload-offset (filename|-) remotefilename offset\n"
23971 #: ../fish/guestfish-actions.pod:4293
23973 "Note that there is no limit on the amount of data that can be uploaded with "
23974 "this call, unlike with L</pwrite>, and this call always writes the full "
23975 "amount unless an error occurs."
23979 #: ../fish/guestfish-actions.pod:4298
23980 msgid "See also L</upload>, L</pwrite>."
23984 #: ../fish/guestfish-actions.pod:4302
23989 #: ../fish/guestfish-actions.pod:4304
23992 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
23997 #: ../fish/guestfish-actions.pod:4323
24002 #: ../fish/guestfish-actions.pod:4325
24010 #: ../fish/guestfish-actions.pod:4352
24012 "I<Note:> Don't use this call to test for availability of features. In "
24013 "enterprise distributions we backport features from later versions into "
24014 "earlier versions, making this an unreliable way to test for features. Use "
24015 "L</available> instead."
24019 #: ../fish/guestfish-actions.pod:4358
24024 #: ../fish/guestfish-actions.pod:4360
24027 " vfs-label device\n"
24032 #: ../fish/guestfish-actions.pod:4367
24033 msgid "To find a filesystem from the label, use L</findfs-label>."
24037 #: ../fish/guestfish-actions.pod:4369
24042 #: ../fish/guestfish-actions.pod:4371
24045 " vfs-type device\n"
24050 #: ../fish/guestfish-actions.pod:4381
24055 #: ../fish/guestfish-actions.pod:4383
24058 " vfs-uuid device\n"
24063 #: ../fish/guestfish-actions.pod:4390
24064 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
24068 #: ../fish/guestfish-actions.pod:4392
24069 msgid "vg-activate"
24073 #: ../fish/guestfish-actions.pod:4394
24076 " vg-activate true|false 'volgroups ...'\n"
24081 #: ../fish/guestfish-actions.pod:4407
24082 msgid "vg-activate-all"
24086 #: ../fish/guestfish-actions.pod:4409
24089 " vg-activate-all true|false\n"
24094 #: ../fish/guestfish-actions.pod:4419
24099 #: ../fish/guestfish-actions.pod:4421
24102 " vgcreate volgroup 'physvols ...'\n"
24107 #: ../fish/guestfish-actions.pod:4426
24112 #: ../fish/guestfish-actions.pod:4428
24115 " vglvuuids vgname\n"
24120 #: ../fish/guestfish-actions.pod:4433
24122 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
24123 "logical volumes and volume groups."
24127 #: ../fish/guestfish-actions.pod:4436
24128 msgid "See also L</vgpvuuids>."
24132 #: ../fish/guestfish-actions.pod:4438
24137 #: ../fish/guestfish-actions.pod:4440
24140 " vgpvuuids vgname\n"
24145 #: ../fish/guestfish-actions.pod:4445
24147 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
24148 "physical volumes and volume groups."
24152 #: ../fish/guestfish-actions.pod:4448
24153 msgid "See also L</vglvuuids>."
24157 #: ../fish/guestfish-actions.pod:4450
24162 #: ../fish/guestfish-actions.pod:4452
24165 " vgremove vgname\n"
24170 #: ../fish/guestfish-actions.pod:4459
24175 #: ../fish/guestfish-actions.pod:4461
24178 " vgrename volgroup newvolgroup\n"
24183 #: ../fish/guestfish-actions.pod:4465
24188 #: ../fish/guestfish-actions.pod:4467
24196 #: ../fish/guestfish-actions.pod:4475
24197 msgid "See also L</vgs-full>."
24201 #: ../fish/guestfish-actions.pod:4477
24206 #: ../fish/guestfish-actions.pod:4479
24214 #: ../fish/guestfish-actions.pod:4484
24219 #: ../fish/guestfish-actions.pod:4486
24227 #: ../fish/guestfish-actions.pod:4491
24232 #: ../fish/guestfish-actions.pod:4493
24240 #: ../fish/guestfish-actions.pod:4497
24245 #: ../fish/guestfish-actions.pod:4499
24253 #: ../fish/guestfish-actions.pod:4504
24258 #: ../fish/guestfish-actions.pod:4506
24266 #: ../fish/guestfish-actions.pod:4511
24271 #: ../fish/guestfish-actions.pod:4513
24279 #: ../fish/guestfish-actions.pod:4518
24284 #: ../fish/guestfish-actions.pod:4520
24287 " write path content\n"
24292 #: ../fish/guestfish-actions.pod:4528
24297 #: ../fish/guestfish-actions.pod:4530
24300 " write-file path content size\n"
24305 #: ../fish/guestfish-actions.pod:4553
24310 #: ../fish/guestfish-actions.pod:4555
24313 " zegrep regex path\n"
24318 #: ../fish/guestfish-actions.pod:4563
24323 #: ../fish/guestfish-actions.pod:4565
24326 " zegrepi regex path\n"
24331 #: ../fish/guestfish-actions.pod:4573
24336 #: ../fish/guestfish-actions.pod:4575
24344 #: ../fish/guestfish-actions.pod:4583
24345 msgid "See also: L</zero-device>, L</scrub-device>."
24349 #: ../fish/guestfish-actions.pod:4585
24350 msgid "zero-device"
24354 #: ../fish/guestfish-actions.pod:4587
24357 " zero-device device\n"
24362 #: ../fish/guestfish-actions.pod:4589
24364 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
24365 "which just zeroes the first few blocks of a device."
24369 #: ../fish/guestfish-actions.pod:4596
24374 #: ../fish/guestfish-actions.pod:4598
24377 " zerofree device\n"
24382 #: ../fish/guestfish-actions.pod:4611
24387 #: ../fish/guestfish-actions.pod:4613
24390 " zfgrep pattern path\n"
24395 #: ../fish/guestfish-actions.pod:4621
24400 #: ../fish/guestfish-actions.pod:4623
24403 " zfgrepi pattern path\n"
24408 #: ../fish/guestfish-actions.pod:4631
24413 #: ../fish/guestfish-actions.pod:4633
24416 " zfile meth path\n"
24421 #: ../fish/guestfish-actions.pod:4640
24422 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
24426 #: ../fish/guestfish-actions.pod:4650
24431 #: ../fish/guestfish-actions.pod:4652
24434 " zgrep regex path\n"
24439 #: ../fish/guestfish-actions.pod:4660
24444 #: ../fish/guestfish-actions.pod:4662
24447 " zgrepi regex path\n"
24452 #: ../fish/guestfish-commands.pod:1
24457 #: ../fish/guestfish-commands.pod:3
24462 #: ../fish/guestfish-commands.pod:5
24465 " alloc filename size\n"
24470 #: ../fish/guestfish-commands.pod:7
24472 "This creates an empty (zeroed) file of the given size, and then adds so it "
24473 "can be further examined."
24477 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:168
24478 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
24482 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:170
24483 msgid "Size can be specified using standard suffixes, eg. C<1M>."
24487 #: ../fish/guestfish-commands.pod:14
24489 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
24490 "image, see L</PREPARED DISK IMAGES>."
24494 #: ../fish/guestfish-commands.pod:17
24499 #: ../fish/guestfish-commands.pod:19
24502 " copy-in local [local ...] /remotedir\n"
24507 #: ../fish/guestfish-commands.pod:21
24509 "C<copy-in> copies local files or directories recursively into the disk "
24510 "image, placing them in the directory called C</remotedir> (which must "
24511 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
24512 "other commands as necessary."
24516 #: ../fish/guestfish-commands.pod:26
24518 "Multiple local files and directories can be specified, but the last "
24519 "parameter must always be a remote directory. Wildcards cannot be used."
24523 #: ../fish/guestfish-commands.pod:30
24528 #: ../fish/guestfish-commands.pod:32
24531 " copy-out remote [remote ...] localdir\n"
24536 #: ../fish/guestfish-commands.pod:34
24538 "C<copy-out> copies remote files or directories recursively out of the disk "
24539 "image, placing them on the host disk in a local directory called C<localdir> "
24540 "(which must exist). This guestfish meta-command turns into a sequence of "
24541 "L</download>, L</tar-out> and other commands as necessary."
24545 #: ../fish/guestfish-commands.pod:40
24547 "Multiple remote files and directories can be specified, but the last "
24548 "parameter must always be a local directory. To download to the current "
24549 "directory, use C<.> as in:"
24553 #: ../fish/guestfish-commands.pod:44
24556 " copy-out /home .\n"
24561 #: ../fish/guestfish-commands.pod:46
24563 "Wildcards cannot be used in the ordinary command, but you can use them with "
24564 "the help of L</glob> like this:"
24568 #: ../fish/guestfish-commands.pod:49
24571 " glob copy-out /home/* .\n"
24576 #: ../fish/guestfish-commands.pod:51
24581 #: ../fish/guestfish-commands.pod:53
24584 " echo [params ...]\n"
24589 #: ../fish/guestfish-commands.pod:55
24590 msgid "This echos the parameters to the terminal."
24594 #: ../fish/guestfish-commands.pod:57
24599 #: ../fish/guestfish-commands.pod:59
24604 #: ../fish/guestfish-commands.pod:61
24609 #: ../fish/guestfish-commands.pod:63
24617 #: ../fish/guestfish-commands.pod:65
24619 "This is used to edit a file. It downloads the file, edits it locally using "
24620 "your editor, then uploads the result."
24624 #: ../fish/guestfish-commands.pod:68
24626 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
24627 "or C<emacs> you will get those corresponding editors."
24631 #: ../fish/guestfish-commands.pod:72
24636 #: ../fish/guestfish-commands.pod:74
24639 " glob command args...\n"
24644 #: ../fish/guestfish-commands.pod:76
24646 "Expand wildcards in any paths in the args list, and run C<command> "
24647 "repeatedly on each matching path."
24651 #: ../fish/guestfish-commands.pod:79
24652 msgid "See L</WILDCARDS AND GLOBBING>."
24656 #: ../fish/guestfish-commands.pod:81
24661 #: ../fish/guestfish-commands.pod:83
24664 " hexedit <filename|device>\n"
24665 " hexedit <filename|device> <max>\n"
24666 " hexedit <filename|device> <start> <max>\n"
24671 #: ../fish/guestfish-commands.pod:87
24673 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
24678 #: ../fish/guestfish-commands.pod:90
24680 "This command works by downloading potentially the whole file or device, "
24681 "editing it locally, then uploading it. If the file or device is large, you "
24682 "have to specify which part you wish to edit by using C<max> and/or C<start> "
24683 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
24684 "usual modifiers allowed such as C<1M> (1 megabyte)."
24688 #: ../fish/guestfish-commands.pod:97
24689 msgid "For example to edit the first few sectors of a disk you might do:"
24693 #: ../fish/guestfish-commands.pod:100
24696 " hexedit /dev/sda 1M\n"
24701 #: ../fish/guestfish-commands.pod:102
24703 "which would allow you to edit anywhere within the first megabyte of the "
24708 #: ../fish/guestfish-commands.pod:105
24709 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
24713 #: ../fish/guestfish-commands.pod:107
24716 " hexedit /dev/sda1 0x400 0x400\n"
24721 #: ../fish/guestfish-commands.pod:109
24722 msgid "(assuming the superblock is in the standard location)."
24726 #: ../fish/guestfish-commands.pod:111
24728 "This command requires the external L<hexedit(1)> program. You can specify "
24729 "another program to use by setting the C<HEXEDITOR> environment variable."
24733 #: ../fish/guestfish-commands.pod:115
24734 msgid "See also L</hexdump>."
24738 #: ../fish/guestfish-commands.pod:117
24743 #: ../fish/guestfish-commands.pod:119
24751 #: ../fish/guestfish-commands.pod:121
24752 msgid "Change the local directory, ie. the current directory of guestfish itself."
24756 #: ../fish/guestfish-commands.pod:124
24757 msgid "Note that C<!cd> won't do what you might expect."
24761 #: ../fish/guestfish-commands.pod:126
24766 #: ../fish/guestfish-commands.pod:128
24771 #: ../fish/guestfish-commands.pod:130
24779 #: ../fish/guestfish-commands.pod:132
24780 msgid "Opens the manual page for guestfish."
24784 #: ../fish/guestfish-commands.pod:134
24789 #: ../fish/guestfish-commands.pod:136
24794 #: ../fish/guestfish-commands.pod:138
24802 #: ../fish/guestfish-commands.pod:140
24810 #: ../fish/guestfish-commands.pod:142
24811 msgid "This is used to view a file."
24815 #: ../fish/guestfish-commands.pod:144
24817 "The default viewer is C<$PAGER>. However if you use the alternate command "
24818 "C<less> you will get the C<less> command specifically."
24822 #: ../fish/guestfish-commands.pod:147
24827 #: ../fish/guestfish-commands.pod:149
24835 #: ../fish/guestfish-commands.pod:151
24837 "Close and reopen the libguestfs handle. It is not necessary to use this "
24838 "normally, because the handle is closed properly when guestfish exits. "
24839 "However this is occasionally useful for testing."
24843 #: ../fish/guestfish-commands.pod:155
24848 #: ../fish/guestfish-commands.pod:157
24851 " sparse filename size\n"
24856 #: ../fish/guestfish-commands.pod:159
24858 "This creates an empty sparse file of the given size, and then adds so it can "
24859 "be further examined."
24863 #: ../fish/guestfish-commands.pod:162
24865 "In all respects it works the same as the L</alloc> command, except that the "
24866 "image file is allocated sparsely, which means that disk blocks are not "
24867 "assigned to the file until they are needed. Sparse disk files only use "
24868 "space when written to, but they are slower and there is a danger you could "
24869 "run out of real disk space during a write operation."
24873 #: ../fish/guestfish-commands.pod:172
24878 #: ../fish/guestfish-commands.pod:174
24886 #: ../fish/guestfish-commands.pod:176
24888 "This command returns a list of the optional groups known to the daemon, and "
24889 "indicates which ones are supported by this build of the libguestfs "
24894 #: ../fish/guestfish-commands.pod:180
24895 msgid "See also L<guestfs(3)/AVAILABILITY>."
24899 #: ../fish/guestfish-commands.pod:182
24904 #: ../fish/guestfish-commands.pod:184
24907 " time command args...\n"
24912 #: ../fish/guestfish-commands.pod:186
24914 "Run the command as usual, but print the elapsed time afterwards. This can "
24915 "be useful for benchmarking operations."
24919 #: ../test-tool/libguestfs-test-tool.pod:5
24920 msgid "libguestfs-test-tool - End user tests for libguestfs"
24924 #: ../test-tool/libguestfs-test-tool.pod:9
24927 " libguestfs-test-tool [--options]\n"
24932 #: ../test-tool/libguestfs-test-tool.pod:13
24934 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
24935 "and developers, to allow them to check basic libguestfs functionality is "
24936 "working. This is needed because libguestfs occasionally breaks for reasons "
24937 "beyond our control: usually because of changes in the underlying qemu or "
24938 "kernel packages, or the host environment."
24942 #: ../test-tool/libguestfs-test-tool.pod:20
24943 msgid "If you suspect a problem in libguestfs, then just run:"
24947 #: ../test-tool/libguestfs-test-tool.pod:22
24950 " libguestfs-test-tool\n"
24955 #: ../test-tool/libguestfs-test-tool.pod:24
24956 msgid "It will print lots of diagnostic messages."
24960 #: ../test-tool/libguestfs-test-tool.pod:26
24961 msgid "If it runs to completion successfully, you will see this near the end:"
24965 #: ../test-tool/libguestfs-test-tool.pod:28
24968 " ===== TEST FINISHED OK =====\n"
24973 #: ../test-tool/libguestfs-test-tool.pod:30
24974 msgid "and the test tool will exit with code 0."
24978 #: ../test-tool/libguestfs-test-tool.pod:32
24980 "If it fails (and/or exits with non-zero error code), please paste the "
24981 "B<complete, unedited> output of the test tool into a bug report. More "
24982 "information about reporting bugs can be found on the "
24983 "L<http://libguestfs.org/> website."
24987 #: ../test-tool/libguestfs-test-tool.pod:41
24992 #: ../test-tool/libguestfs-test-tool.pod:43
24993 msgid "Display short usage information and exit."
24997 #: ../test-tool/libguestfs-test-tool.pod:45
24998 msgid "I<--helper /path/to/libguestfs-test-tool-helper>"
25002 #: ../test-tool/libguestfs-test-tool.pod:47
25004 "Pass an alternate name for the helper program. libguestfs-test-tool will "
25005 "normally look in the C<$libexec> directory that was configured when the tool "
25010 #: ../test-tool/libguestfs-test-tool.pod:51
25011 msgid "I<--qemu qemu_binary>"
25015 #: ../test-tool/libguestfs-test-tool.pod:53
25017 "If you have downloaded another qemu binary, point this option at the full "
25018 "path of the binary to try it."
25022 #: ../test-tool/libguestfs-test-tool.pod:56
25023 msgid "I<--qemudir qemu_source_dir>"
25027 #: ../test-tool/libguestfs-test-tool.pod:58
25029 "If you have compiled qemu from source, point this option at the source "
25030 "directory to try it."
25034 #: ../test-tool/libguestfs-test-tool.pod:61
25035 msgid "I<--timeout N>"
25039 #: ../test-tool/libguestfs-test-tool.pod:63
25041 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
25042 "does not usually need to be adjusted unless your machine is very slow."
25046 #: ../test-tool/libguestfs-test-tool.pod:69
25047 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
25051 #: ../test-tool/libguestfs-test-tool.pod:71
25053 "If you have compiled another version of qemu from source and would like to "
25054 "try that, then you can use the I<--qemudir> option to point to the qemu "
25055 "source directory."
25059 #: ../test-tool/libguestfs-test-tool.pod:75
25061 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
25062 "option to point to the binary."
25066 #: ../test-tool/libguestfs-test-tool.pod:78
25068 "When using an alternate qemu with libguestfs, usually you would need to "
25069 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
25070 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
25071 "when you use either of the I<--qemudir> or I<--qemu> options."
25075 #: ../test-tool/libguestfs-test-tool.pod:85
25077 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
25078 "I<1> if there was an error."
25082 #: ../test-tool/libguestfs-test-tool.pod:92
25083 msgid "/usr/libexec/libguestfs-test-tool-helper"
25087 #: ../test-tool/libguestfs-test-tool.pod:94
25089 "This helper program is run inside the appliance and provides additional "
25094 #: ../test-tool/libguestfs-test-tool.pod:97
25095 msgid "/usr/bin/mkisofs"
25099 #: ../test-tool/libguestfs-test-tool.pod:99
25101 "The C<mkisofs> command is required in order to construct a CD-ROM ISO file "
25102 "which is used as part of the tests."
25106 #: ../test-tool/libguestfs-test-tool.pod:106
25108 "For the full list of environment variables which may affect libguestfs, "
25109 "please see the L<guestfs(3)> manual page."
25113 #: ../test-tool/libguestfs-test-tool.pod:111
25114 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
25118 #: ../test-tool/libguestfs-test-tool.pod:121
25119 msgid "Copyright (C) 2009 Red Hat Inc. L<http://libguestfs.org/>"
25123 #: ../fuse/guestmount.pod:5
25124 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
25128 #: ../fuse/guestmount.pod:9
25131 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
25136 #: ../fuse/guestmount.pod:11
25139 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
25144 #: ../fuse/guestmount.pod:13
25147 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
25152 #: ../fuse/guestmount.pod:17
25154 "You must I<not> use C<guestmount> in read-write mode on live virtual "
25155 "machines. If you do this, you risk disk corruption in the VM."
25159 #: ../fuse/guestmount.pod:22
25161 "The guestmount program can be used to mount virtual machine filesystems and "
25162 "other disk images on the host. It uses libguestfs for access to the guest "
25163 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
25164 "a mountable device."
25168 #: ../fuse/guestmount.pod:27
25170 "Along with other options, you have to give at least one device (I<-a> "
25171 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
25172 "option) or use the I<-i> inspection option. How this works is better "
25173 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
25178 #: ../fuse/guestmount.pod:33
25180 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
25181 "by you, and the filesystem will not be visible to any other users unless you "
25182 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
25183 "the filesystem, use the C<fusermount -u> command."
25187 #: ../fuse/guestmount.pod:41
25189 "For a typical Windows guest which has its main filesystem on the first "
25194 #: ../fuse/guestmount.pod:44
25197 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
25202 #: ../fuse/guestmount.pod:46
25204 "For a typical Linux guest which has a /boot filesystem on the first "
25205 "partition, and the root filesystem on a logical volume:"
25209 #: ../fuse/guestmount.pod:49
25212 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
25217 #: ../fuse/guestmount.pod:51
25218 msgid "To get libguestfs to detect guest mountpoints for you:"
25222 #: ../fuse/guestmount.pod:53
25225 " guestmount -a guest.img -i --ro /mnt\n"
25230 #: ../fuse/guestmount.pod:55
25231 msgid "For a libvirt guest called \"Guest\" you could do:"
25235 #: ../fuse/guestmount.pod:57
25238 " guestmount -d Guest -i --ro /mnt\n"
25243 #: ../fuse/guestmount.pod:59
25245 "If you don't know what filesystems are contained in a guest or disk image, "
25246 "use L<virt-list-filesystems(1)> first:"
25250 #: ../fuse/guestmount.pod:62
25253 " virt-list-filesystems MyGuest\n"
25258 #: ../fuse/guestmount.pod:64
25260 "If you want to trace the libguestfs calls but without excessive debugging "
25261 "information, we recommend:"
25265 #: ../fuse/guestmount.pod:67
25268 " guestmount [...] --trace /mnt\n"
25273 #: ../fuse/guestmount.pod:69
25274 msgid "If you want to debug the program, we recommend:"
25278 #: ../fuse/guestmount.pod:71
25281 " guestmount [...] --trace --verbose /mnt\n"
25286 #: ../fuse/guestmount.pod:79
25287 msgid "Add a block device or virtual machine image."
25291 #: ../fuse/guestmount.pod:96
25292 msgid "B<--dir-cache-timeout N>"
25296 #: ../fuse/guestmount.pod:98
25298 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
25299 "seconds. The readdir cache [actually, there are several semi-independent "
25300 "caches] is populated after a readdir(2) call with the stat and extended "
25301 "attributes of the files in the directory, in anticipation that they will be "
25302 "requested soon after."
25306 #: ../fuse/guestmount.pod:104
25308 "There is also a different attribute cache implemented by FUSE (see the FUSE "
25309 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
25310 "requests, only cache existing ones."
25314 #: ../fuse/guestmount.pod:122
25316 "If you have untrusted raw-format guest disk images, you should use this "
25317 "option to specify the disk format. This avoids a possible security problem "
25318 "with malicious guests (CVE-2010-3851). See also "
25319 "L<guestfs(3)/guestfs_add_drive_opts>."
25323 #: ../fuse/guestmount.pod:127
25324 msgid "B<--fuse-help>"
25328 #: ../fuse/guestmount.pod:129
25329 msgid "Display help on special FUSE options (see I<-o> below)."
25333 #: ../fuse/guestmount.pod:133
25334 msgid "Display brief help and exit."
25338 #: ../fuse/guestmount.pod:146
25339 msgid "B<-m dev[:mnt]> | B<--mount dev[:mnt]>"
25343 #: ../fuse/guestmount.pod:148
25345 "Mount the named partition or logical volume on the given mountpoint B<in the "
25346 "guest> (this has nothing to do with mountpoints in the host)."
25350 #: ../fuse/guestmount.pod:151
25352 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
25353 "something on C</>."
25357 #: ../fuse/guestmount.pod:156
25359 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
25360 "unmounted. If you specify this option, then we don't attempt to sync the "
25361 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
25365 #: ../fuse/guestmount.pod:161
25366 msgid "B<-o option> | B<--option option>"
25370 #: ../fuse/guestmount.pod:163
25371 msgid "Pass extra options to FUSE."
25375 #: ../fuse/guestmount.pod:165
25377 "To get a list of all the extra options supported by FUSE, use the command "
25378 "below. Note that only the FUSE I<-o> options can be passed, and only some "
25379 "of them are a good idea."
25383 #: ../fuse/guestmount.pod:169
25386 " guestmount --fuse-help\n"
25391 #: ../fuse/guestmount.pod:171
25392 msgid "Some potentially useful FUSE options:"
25396 #: ../fuse/guestmount.pod:175
25397 msgid "B<-o allow_other>"
25401 #: ../fuse/guestmount.pod:177
25402 msgid "Allow other users to see the filesystem."
25406 #: ../fuse/guestmount.pod:179
25407 msgid "B<-o attr_timeout=N>"
25411 #: ../fuse/guestmount.pod:181
25412 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
25416 #: ../fuse/guestmount.pod:183
25417 msgid "B<-o kernel_cache>"
25421 #: ../fuse/guestmount.pod:185
25423 "Allow the kernel to cache files (reduces the number of reads that have to go "
25424 "through the L<guestfs(3)> API). This is generally a good idea if you can "
25425 "afford the extra memory usage."
25429 #: ../fuse/guestmount.pod:189
25430 msgid "B<-o uid=N> B<-o gid=N>"
25434 #: ../fuse/guestmount.pod:191
25436 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
25437 "the chosen values."
25441 #: ../fuse/guestmount.pod:198
25443 "Add devices and mount everything read-only. Also disallow writes and make "
25444 "the disk appear read-only to FUSE."
25448 #: ../fuse/guestmount.pod:201
25450 "This is highly recommended if you are not going to edit the guest disk. If "
25451 "the guest is running and this option is I<not> supplied, then there is a "
25452 "strong risk of disk corruption in the guest. We try to prevent this from "
25453 "happening, but it is not always possible."
25457 #: ../fuse/guestmount.pod:206
25458 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
25462 #: ../fuse/guestmount.pod:210
25463 msgid "Enable SELinux support for the guest."
25467 #: ../fuse/guestmount.pod:214
25468 msgid "Enable verbose messages from underlying libguestfs."
25472 #: ../fuse/guestmount.pod:218
25473 msgid "Display the program version and exit."
25477 #: ../fuse/guestmount.pod:222
25479 "This option does nothing at the moment. See L<guestfish(1)/OPENING DISKS "
25480 "FOR READ AND WRITE>."
25484 #: ../fuse/guestmount.pod:225
25485 msgid "B<-x> | B<--trace>"
25489 #: ../fuse/guestmount.pod:227
25490 msgid "Trace libguestfs calls."
25494 #: ../fuse/guestmount.pod:229
25495 msgid "This also stops the daemon from forking into the background."
25499 #: ../fuse/guestmount.pod:235
25501 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
25502 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
25503 "L<http://fuse.sf.net/>."
25507 #: ../inspector/virt-inspector.pl:35
25509 "virt-inspector - Display operating system version and other information "
25510 "about a virtual machine"
25514 #: ../inspector/virt-inspector.pl:39
25517 " virt-inspector [--connect URI] domname\n"
25522 #: ../inspector/virt-inspector.pl:41
25525 " virt-inspector guest.img [guest.img ...]\n"
25530 #: ../inspector/virt-inspector.pl:45
25532 "B<virt-inspector> examines a virtual machine or disk image and tries to "
25533 "determine the version of the operating system and other information about "
25534 "the virtual machine."
25538 #: ../inspector/virt-inspector.pl:49
25539 msgid "Virt-inspector produces XML output for feeding into other programs."
25543 #: ../inspector/virt-inspector.pl:51
25545 "In the normal usage, use C<virt-inspector domname> where C<domname> is the "
25546 "libvirt domain (see: C<virsh list --all>)."
25550 #: ../inspector/virt-inspector.pl:54
25552 "You can also run virt-inspector directly on disk images from a single "
25553 "virtual machine. Use C<virt-inspector guest.img>. In rare cases a domain "
25554 "has several block devices, in which case you should list them one after "
25555 "another, with the first corresponding to the guest's C</dev/sda>, the second "
25556 "to the guest's C</dev/sdb> and so on."
25560 #: ../inspector/virt-inspector.pl:60
25562 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
25563 "inspect several virtual machines, you have to run virt-inspector several "
25564 "times (for example, from a shell script for-loop)."
25568 #: ../inspector/virt-inspector.pl:65
25570 "Because virt-inspector needs direct access to guest images, it won't "
25571 "normally work over remote libvirt connections."
25575 #: ../inspector/virt-inspector.pl:78 ../tools/virt-edit.pl:82 ../tools/virt-win-reg.pl:181 ../tools/virt-df.pl:81 ../tools/virt-ls.pl:88 ../tools/virt-list-filesystems.pl:60 ../tools/virt-tar.pl:108 ../tools/virt-rescue.pl:113 ../tools/virt-make-fs.pl:163 ../tools/virt-list-partitions.pl:61
25576 msgid "Display brief help."
25580 #: ../inspector/virt-inspector.pl:84 ../tools/virt-edit.pl:88 ../tools/virt-win-reg.pl:187 ../tools/virt-df.pl:87 ../tools/virt-ls.pl:94 ../tools/virt-resize.pl:273 ../tools/virt-list-filesystems.pl:66 ../tools/virt-tar.pl:114 ../tools/virt-rescue.pl:119 ../tools/virt-make-fs.pl:169 ../tools/virt-list-partitions.pl:67
25581 msgid "B<--version>"
25585 #: ../inspector/virt-inspector.pl:86 ../tools/virt-edit.pl:90 ../tools/virt-win-reg.pl:189 ../tools/virt-df.pl:89 ../tools/virt-ls.pl:96 ../tools/virt-resize.pl:275 ../tools/virt-list-filesystems.pl:68 ../tools/virt-tar.pl:116 ../tools/virt-rescue.pl:121 ../tools/virt-make-fs.pl:171 ../tools/virt-list-partitions.pl:69
25586 msgid "Display version number and exit."
25590 #: ../inspector/virt-inspector.pl:92 ../tools/virt-edit.pl:112 ../tools/virt-win-reg.pl:203 ../tools/virt-df.pl:95 ../tools/virt-ls.pl:102 ../tools/virt-list-filesystems.pl:74 ../tools/virt-tar.pl:122 ../tools/virt-rescue.pl:135 ../tools/virt-list-partitions.pl:75
25591 msgid "B<--connect URI> | B<-c URI>"
25595 #: ../inspector/virt-inspector.pl:94 ../tools/virt-edit.pl:114 ../tools/virt-win-reg.pl:205 ../tools/virt-df.pl:97 ../tools/virt-ls.pl:104 ../tools/virt-list-filesystems.pl:76 ../tools/virt-tar.pl:124 ../tools/virt-rescue.pl:137 ../tools/virt-list-partitions.pl:77
25597 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
25598 "to the default libvirt hypervisor."
25602 #: ../inspector/virt-inspector.pl:97
25604 "Libvirt is only used if you specify a C<domname> on the command line. If "
25605 "you specify guest block devices directly, then libvirt is not used at all."
25609 #: ../inspector/virt-inspector.pl:105 ../tools/virt-edit.pl:124 ../tools/virt-win-reg.pl:215 ../tools/virt-df.pl:117 ../tools/virt-ls.pl:114 ../tools/virt-resize.pl:523 ../tools/virt-list-filesystems.pl:86 ../tools/virt-tar.pl:134 ../tools/virt-rescue.pl:147 ../tools/virt-list-partitions.pl:87
25610 msgid "B<--format> raw"
25614 #: ../inspector/virt-inspector.pl:107 ../tools/virt-edit.pl:126 ../tools/virt-win-reg.pl:217 ../tools/virt-df.pl:119 ../tools/virt-ls.pl:116 ../tools/virt-list-filesystems.pl:88 ../tools/virt-tar.pl:136 ../tools/virt-rescue.pl:149 ../tools/virt-list-partitions.pl:89
25616 "Specify the format of disk images given on the command line. If this is "
25617 "omitted then the format is autodetected from the content of the disk image."
25621 #: ../inspector/virt-inspector.pl:111 ../tools/virt-edit.pl:130 ../tools/virt-win-reg.pl:221 ../tools/virt-df.pl:123 ../tools/virt-ls.pl:120 ../tools/virt-list-filesystems.pl:92 ../tools/virt-tar.pl:140 ../tools/virt-rescue.pl:153 ../tools/virt-list-partitions.pl:93
25623 "If disk images are requested from libvirt, then this program asks libvirt "
25624 "for this information. In this case, the value of the format parameter is "
25629 #: ../inspector/virt-inspector.pl:115 ../tools/virt-edit.pl:134 ../tools/virt-win-reg.pl:225 ../tools/virt-df.pl:127 ../tools/virt-ls.pl:124 ../tools/virt-resize.pl:528 ../tools/virt-resize.pl:543 ../tools/virt-list-filesystems.pl:96 ../tools/virt-tar.pl:144 ../tools/virt-rescue.pl:157 ../tools/virt-list-partitions.pl:97
25631 "If working with untrusted raw-format guest disk images, you should ensure "
25632 "the format is always specified."
25636 #: ../inspector/virt-inspector.pl:149
25641 #: ../inspector/virt-inspector.pl:151
25643 "The virt-inspector XML is described precisely in a RELAX NG schema which is "
25644 "supplied with libguestfs. This section is just an overview."
25648 #: ../inspector/virt-inspector.pl:154
25650 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
25651 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
25652 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
25653 "which is vanishingly rare in real world VMs."
25657 #: ../inspector/virt-inspector.pl:159
25658 msgid "E<lt>operatingsystemE<gt>"
25662 #: ../inspector/virt-inspector.pl:161
25664 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
25665 "describe the operating system, its architecture, the descriptive \"product "
25666 "name\" string, the type of OS and so on, as in this example:"
25670 #: ../inspector/virt-inspector.pl:165
25673 " <operatingsystems>\n"
25674 " <operatingsystem>\n"
25675 " <root>/dev/sda2</root>\n"
25676 " <name>windows</name>\n"
25677 " <arch>i386</arch>\n"
25678 " <distro>windows</distro>\n"
25679 " <product_name>Windows 7 Enterprise</product_name>\n"
25680 " <major_version>6</major_version>\n"
25681 " <minor_version>1</minor_version>\n"
25682 " <windows_systemroot>/Windows</windows_systemroot>\n"
25687 #: ../inspector/virt-inspector.pl:176
25689 "These fields are derived from the libguestfs inspection API, and you can "
25690 "find more details in L<guestfs(3)/INSPECTION>."
25694 #: ../inspector/virt-inspector.pl:179
25696 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
25697 "of view of libguestfs (block devices may have completely different names "
25698 "inside the VM itself)."
25702 #: ../inspector/virt-inspector.pl:246
25703 msgid "E<lt>mountpointsE<gt>"
25707 #: ../inspector/virt-inspector.pl:248
25709 "Un*x-like guests typically have multiple filesystems which are mounted at "
25710 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
25711 "element which looks like this:"
25715 #: ../inspector/virt-inspector.pl:252
25718 " <operatingsystems>\n"
25719 " <operatingsystem>\n"
25722 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
25723 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
25724 " </mountpoints>\n"
25729 #: ../inspector/virt-inspector.pl:260
25731 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
25732 "and may have completely different names inside the guest. Only mountable "
25733 "filesystems appear in this list, not things like swap devices."
25737 #: ../inspector/virt-inspector.pl:282
25738 msgid "E<lt>filesystemsE<gt>"
25742 #: ../inspector/virt-inspector.pl:284
25744 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
25745 "filesystems belonging to the guest, including swap and empty partitions. "
25746 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
25747 "this OS or shared by this OS and other OSes)."
25751 #: ../inspector/virt-inspector.pl:289
25752 msgid "You might see something like this:"
25756 #: ../inspector/virt-inspector.pl:291
25759 " <operatingsystems>\n"
25760 " <operatingsystem>\n"
25763 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25764 " <type>ext4</type>\n"
25765 " <label>Fedora-13-x86_64</label>\n"
25766 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
25772 #: ../inspector/virt-inspector.pl:301
25774 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
25775 "the label, and the UUID."
25779 #: ../inspector/virt-inspector.pl:343
25780 msgid "E<lt>applicationsE<gt>"
25784 #: ../inspector/virt-inspector.pl:345
25786 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
25787 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
25788 "machine. At the moment we are only able to list RPMs and Debian packages "
25789 "installed, but in future we will support other Linux distros and Windows."
25793 #: ../inspector/virt-inspector.pl:351
25795 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
25796 "Typical values would be C<rpm> and C<deb>."
25800 #: ../inspector/virt-inspector.pl:354
25802 "E<lt>package_managementE<gt>, if present, describes the package manager. "
25803 "Typical values include C<yum>, C<up2date> and C<apt>"
25807 #: ../inspector/virt-inspector.pl:357
25808 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
25812 #: ../inspector/virt-inspector.pl:360
25815 " <operatingsystems>\n"
25816 " <operatingsystem>\n"
25818 " <applications>\n"
25820 " <name>coreutils</name>\n"
25821 " <version>8.5</version>\n"
25822 " <release>1</release>\n"
25823 " </application>\n"
25828 #: ../inspector/virt-inspector.pl:370
25830 "The version and release fields may not be available for some types guests. "
25831 "Other fields are possible, see "
25832 "L<guestfs(3)/guestfs_inspect_list_applications>."
25836 #: ../inspector/virt-inspector.pl:426
25837 msgid "USING XPATH"
25841 #: ../inspector/virt-inspector.pl:428
25843 "You can use the XPath query language, and/or the xpath tool, in order to "
25844 "select parts of the XML."
25848 #: ../inspector/virt-inspector.pl:433
25851 " $ virt-inspector Guest | xpath //filesystems\n"
25852 " Found 1 nodes:\n"
25855 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
25856 " <type>ext4</type>\n"
25862 #: ../inspector/virt-inspector.pl:441
25865 " $ virt-inspector Guest | \\\n"
25866 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
25867 " Query didn't return a nodeset. Value: ext4\n"
25872 #: ../inspector/virt-inspector.pl:445 ../tools/virt-edit.pl:343 ../tools/virt-win-reg.pl:141 ../tools/virt-win-reg.pl:477 ../tools/virt-df.pl:633 ../tools/virt-ls.pl:225 ../tools/virt-resize.pl:1479 ../tools/virt-list-filesystems.pl:179 ../tools/virt-tar.pl:274 ../tools/virt-rescue.pl:260 ../tools/virt-make-fs.pl:527 ../tools/virt-list-partitions.pl:247
25873 msgid "SHELL QUOTING"
25877 #: ../inspector/virt-inspector.pl:447 ../tools/virt-edit.pl:345 ../tools/virt-win-reg.pl:479 ../tools/virt-df.pl:635 ../tools/virt-ls.pl:227 ../tools/virt-resize.pl:1481 ../tools/virt-list-filesystems.pl:181 ../tools/virt-tar.pl:276 ../tools/virt-rescue.pl:262 ../tools/virt-make-fs.pl:529 ../tools/virt-list-partitions.pl:249
25879 "Libvirt guest names can contain arbitrary characters, some of which have "
25880 "meaning to the shell such as C<#> and space. You may need to quote or "
25881 "escape these characters on the command line. See the shell manual page "
25882 "L<sh(1)> for details."
25886 #: ../inspector/virt-inspector.pl:454
25888 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
25889 "L<Sys::Virt(3)>, L<http://www.w3.org/TR/xpath/>, L<http://libguestfs.org/>."
25893 #: ../inspector/virt-inspector.pl:468 ../tools/virt-edit.pl:364 ../tools/virt-win-reg.pl:512 ../tools/virt-df.pl:651 ../tools/virt-ls.pl:245 ../tools/virt-resize.pl:1510 ../tools/virt-list-filesystems.pl:200 ../tools/virt-tar.pl:294 ../tools/virt-rescue.pl:279 ../tools/virt-make-fs.pl:561 ../tools/virt-list-partitions.pl:267
25894 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
25898 #: ../inspector/virt-inspector.pl:472
25899 msgid "Matthew Booth L<mbooth@redhat.com>"
25903 #: ../inspector/virt-inspector.pl:478 ../tools/virt-win-reg.pl:516 ../tools/virt-resize.pl:1514 ../tools/virt-make-fs.pl:565
25904 msgid "Copyright (C) 2010 Red Hat Inc."
25908 #: ../tools/virt-edit.pl:34
25909 msgid "virt-edit - Edit a file in a virtual machine"
25913 #: ../tools/virt-edit.pl:38
25916 " virt-edit [--options] domname file\n"
25921 #: ../tools/virt-edit.pl:40
25924 " virt-edit [--options] disk.img [disk.img ...] file\n"
25929 #: ../tools/virt-edit.pl:42
25932 " virt-edit [domname|disk.img] file -e 'expr'\n"
25937 #: ../tools/virt-edit.pl:46
25939 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
25940 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
25941 "doing this, but doesn't catch all cases."
25945 #: ../tools/virt-edit.pl:52
25947 "C<virt-edit> is a command line tool to edit C<file> where C<file> exists in "
25948 "the named virtual machine (or disk image)."
25952 #: ../tools/virt-edit.pl:55
25954 "If you want to just view a file, use L<virt-cat(1)>. For more complex cases "
25955 "you should look at the L<guestfish(1)> tool."
25959 #: ../tools/virt-edit.pl:60
25960 msgid "Edit the named files interactively:"
25964 #: ../tools/virt-edit.pl:62
25967 " virt-edit mydomain /boot/grub/grub.conf\n"
25972 #: ../tools/virt-edit.pl:64
25975 " virt-edit mydomain /etc/passwd\n"
25980 #: ../tools/virt-edit.pl:66
25982 "You can also edit files non-interactively (see L</NON-INTERACTIVE EDITING> "
25983 "below). To change the init default level to 5:"
25987 #: ../tools/virt-edit.pl:70
25990 " virt-edit mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
25995 #: ../tools/virt-edit.pl:96
25996 msgid "B<--backup extension> | B<-b extension>"
26000 #: ../tools/virt-edit.pl:98
26002 "Create a backup of the original file I<in the guest disk image>. The backup "
26003 "has the original filename with C<extension> added."
26007 #: ../tools/virt-edit.pl:101
26009 "Usually the first character of C<extension> would be a dot C<.> so you would "
26014 #: ../tools/virt-edit.pl:104
26017 " virt-edit -b .orig [etc]\n"
26022 #: ../tools/virt-edit.pl:106
26023 msgid "By default, no backup file is made."
26027 #: ../tools/virt-edit.pl:117 ../tools/virt-win-reg.pl:208 ../tools/virt-df.pl:100 ../tools/virt-ls.pl:107 ../tools/virt-list-filesystems.pl:79 ../tools/virt-tar.pl:127 ../tools/virt-rescue.pl:140 ../tools/virt-list-partitions.pl:80
26029 "If you specify guest block devices directly, then libvirt is not used at "
26034 #: ../tools/virt-edit.pl:141
26035 msgid "B<--expr EXPR> | B<-e EXPR>"
26039 #: ../tools/virt-edit.pl:143
26041 "Instead of launching the external editor, non-interactively apply the Perl "
26042 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
26047 #: ../tools/virt-edit.pl:147
26049 "Be careful to properly quote the expression to prevent it from being altered "
26054 #: ../tools/virt-edit.pl:268
26055 msgid "NON-INTERACTIVE EDITING"
26059 #: ../tools/virt-edit.pl:270
26061 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
26062 "administrator can interactively edit the file."
26066 #: ../tools/virt-edit.pl:273
26068 "There are two ways also to use C<virt-edit> from scripts in order to make "
26069 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
26070 "like this, it's less error-prone to write scripts directly using the "
26071 "libguestfs API and Augeas for configuration file editing.)"
26075 #: ../tools/virt-edit.pl:279
26077 "The first method is to temporarily set C<$EDITOR> to any script or program "
26078 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
26079 "update C<tmpfile> in place however it likes."
26083 #: ../tools/virt-edit.pl:283
26085 "The second method is to use the C<-e> parameter of C<virt-edit> to run a "
26086 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
26087 "instances of C<foo> with C<bar> in a file:"
26091 #: ../tools/virt-edit.pl:287
26094 " virt-edit domname filename -e 's/foo/bar/'\n"
26099 #: ../tools/virt-edit.pl:289
26101 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
26102 "For example to delete root's password you could do:"
26106 #: ../tools/virt-edit.pl:292
26109 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
26114 #: ../tools/virt-edit.pl:294
26116 "What really happens is that the snippet is evaluated as a Perl expression "
26117 "for each line of the file. The line, including the final C<\\n>, is passed "
26118 "in C<$_> and the expression should update C<$_> or leave it unchanged."
26122 #: ../tools/virt-edit.pl:299
26124 "To delete a line, set C<$_> to the empty string. For example, to delete the "
26125 "C<apache> user account from the password file you can do:"
26129 #: ../tools/virt-edit.pl:302
26132 " virt-edit mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
26137 #: ../tools/virt-edit.pl:304
26139 "To insert a line, prepend or append it to C<$_>. However appending lines to "
26140 "the end of the file is rather difficult this way since there is no concept "
26141 "of \"last line of the file\" - your expression just doesn't get called "
26142 "again. You might want to use the first method (setting C<$EDITOR>) if you "
26147 #: ../tools/virt-edit.pl:310
26149 "The variable C<$lineno> contains the current line number. As is "
26150 "traditional, the first line in the file is number C<1>."
26154 #: ../tools/virt-edit.pl:313
26156 "The return value from the expression is ignored, but the expression may call "
26157 "C<die> in order to abort the whole program, leaving the original file "
26162 #: ../tools/virt-edit.pl:317
26164 "Remember when matching the end of a line that C<$_> may contain the final "
26165 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
26166 "newline then neither of these. Thus to match or substitute some text at the "
26167 "end of a line, use this regular expression:"
26171 #: ../tools/virt-edit.pl:322
26174 " /some text(\\r?\\n)?$/\n"
26179 #: ../tools/virt-edit.pl:324
26181 "Alternately, use the perl C<chomp> function, being careful not to chomp "
26182 "C<$_> itself (since that would remove all newlines from the file):"
26186 #: ../tools/virt-edit.pl:328
26189 " my $m = $_; chomp $m; $m =~ /some text$/\n"
26194 #: ../tools/virt-edit.pl:334
26199 #: ../tools/virt-edit.pl:336
26201 "If set, this string is used as the editor. It may contain arguments, "
26202 "eg. C<\"emacs -nw\">"
26206 #: ../tools/virt-edit.pl:339
26207 msgid "If not set, C<vi> is used."
26211 #: ../tools/virt-edit.pl:352
26213 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26214 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>, "
26215 "L<perl(1)>, L<perlre(1)>."
26219 #: ../tools/virt-edit.pl:362 ../tools/virt-win-reg.pl:510 ../tools/virt-df.pl:649 ../tools/virt-ls.pl:243 ../tools/virt-resize.pl:1508 ../tools/virt-list-filesystems.pl:198 ../tools/virt-tar.pl:292 ../tools/virt-rescue.pl:277 ../tools/virt-make-fs.pl:559 ../tools/virt-list-partitions.pl:265
26224 #: ../tools/virt-edit.pl:368 ../tools/virt-df.pl:655 ../tools/virt-rescue.pl:283 ../tools/virt-list-partitions.pl:271
26225 msgid "Copyright (C) 2009-2010 Red Hat Inc."
26229 #: ../tools/virt-win-reg.pl:37
26231 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
26236 #: ../tools/virt-win-reg.pl:41
26239 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
26244 #: ../tools/virt-win-reg.pl:43
26247 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
26252 #: ../tools/virt-win-reg.pl:45
26255 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
26260 #: ../tools/virt-win-reg.pl:47
26263 " virt-win-reg --merge domname [input.reg ...]\n"
26268 #: ../tools/virt-win-reg.pl:49
26271 " virt-win-reg [--options] disk.img ... # instead of domname\n"
26276 #: ../tools/virt-win-reg.pl:53
26278 "You must I<not> use C<virt-win-reg> with the C<--merge> option on live "
26279 "virtual machines. If you do this, you I<will> get irreversible disk "
26280 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
26281 "but doesn't catch all cases."
26285 #: ../tools/virt-win-reg.pl:58
26287 "Modifying the Windows Registry is an inherently risky operation. The format "
26288 "is deliberately obscure and undocumented, and Registry changes can leave the "
26289 "system unbootable. Therefore when using the C<--merge> option, make sure "
26290 "you have a reliable backup first."
26294 #: ../tools/virt-win-reg.pl:65
26296 "This program can export and merge Windows Registry entries from a Windows "
26301 #: ../tools/virt-win-reg.pl:68
26303 "The first parameter is the libvirt guest name or the raw disk image of a "
26308 #: ../tools/virt-win-reg.pl:71
26310 "If C<--merge> is I<not> specified, then the chosen registry key is "
26311 "displayed/exported (recursively). For example:"
26315 #: ../tools/virt-win-reg.pl:74
26318 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
26323 #: ../tools/virt-win-reg.pl:76
26324 msgid "You can also display single values from within registry keys, for example:"
26328 #: ../tools/virt-win-reg.pl:79
26331 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
26332 " $ virt-win-reg Windows7 $cvkey ProductName\n"
26333 " Windows 7 Enterprise\n"
26338 #: ../tools/virt-win-reg.pl:83
26340 "With C<--merge>, you can merge a textual regedit file into the Windows "
26345 #: ../tools/virt-win-reg.pl:86
26348 " $ virt-win-reg --merge Windows7 changes.reg\n"
26353 #: ../tools/virt-win-reg.pl:88
26354 msgid "SUPPORTED SYSTEMS"
26358 #: ../tools/virt-win-reg.pl:90
26360 "The program currently supports Windows NT-derived guests starting with "
26361 "Windows XP through to at least Windows 7."
26365 #: ../tools/virt-win-reg.pl:93
26367 "Registry support is done for C<HKEY_LOCAL_MACHINE\\SAM>, "
26368 "C<HKEY_LOCAL_MACHINE\\SECURITY>, C<HKEY_LOCAL_MACHINE\\SOFTWARE>, "
26369 "C<HKEY_LOCAL_MACHINE\\SYSTEM> and C<HKEY_USERS\\.DEFAULT>."
26373 #: ../tools/virt-win-reg.pl:97
26375 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
26380 #: ../tools/virt-win-reg.pl:100
26382 "C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are B<not> supported at this "
26387 #: ../tools/virt-win-reg.pl:103
26392 #: ../tools/virt-win-reg.pl:105
26394 "This program is only meant for simple access to the registry. If you want "
26395 "to do complicated things with the registry, we suggest you download the "
26396 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
26397 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
26398 "L<hivexregedit(1)>."
26402 #: ../tools/virt-win-reg.pl:111
26407 #: ../tools/virt-win-reg.pl:113
26409 "C<virt-win-reg> expects that regedit files have already been reencoded in "
26410 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
26411 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
26412 "with Windows-style line endings, you may need to reencode the whole file "
26413 "before or after processing."
26417 #: ../tools/virt-win-reg.pl:119
26419 "To reencode a file from Windows format to Linux (before processing it with "
26420 "the C<--merge> option), you would do something like this:"
26424 #: ../tools/virt-win-reg.pl:122
26427 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
26432 #: ../tools/virt-win-reg.pl:124
26434 "To go in the opposite direction, after exporting and before sending the file "
26435 "to a Windows user, do something like this:"
26439 #: ../tools/virt-win-reg.pl:127
26442 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
26447 #: ../tools/virt-win-reg.pl:129
26448 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
26452 #: ../tools/virt-win-reg.pl:131
26454 "If you are unsure about the current encoding, use the L<file(1)> command. "
26455 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
26456 "Windows-style (CRLF) line endings, like this:"
26460 #: ../tools/virt-win-reg.pl:135
26463 " $ file software.reg\n"
26464 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
26465 " with CRLF line terminators\n"
26470 #: ../tools/virt-win-reg.pl:139
26471 msgid "This file would need conversion before you could C<--merge> it."
26475 #: ../tools/virt-win-reg.pl:143
26477 "Be careful when passing parameters containing C<\\> (backslash) in the "
26478 "shell. Usually you will have to use 'single quotes' or double backslashes "
26479 "(but not both) to protect them from the shell."
26483 #: ../tools/virt-win-reg.pl:147
26484 msgid "Paths and value names are case-insensitive."
26488 #: ../tools/virt-win-reg.pl:149
26489 msgid "CurrentControlSet etc."
26493 #: ../tools/virt-win-reg.pl:151
26495 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
26496 "Registry at the level of the hive file, and therefore you cannot modify "
26501 #: ../tools/virt-win-reg.pl:155
26503 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
26504 "circumstances it might refer to another control set. The way to find out is "
26505 "to look at the C<HKLM\\SYSTEM\\Select> key:"
26509 #: ../tools/virt-win-reg.pl:159
26512 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
26513 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
26514 " \"Current\"=dword:00000001\n"
26515 " \"Default\"=dword:00000001\n"
26516 " \"Failed\"=dword:00000000\n"
26517 " \"LastKnownGood\"=dword:00000002\n"
26522 #: ../tools/virt-win-reg.pl:166
26523 msgid "\"Current\" is the one which Windows will choose when it boots."
26527 #: ../tools/virt-win-reg.pl:168
26528 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
26532 #: ../tools/virt-win-reg.pl:195 ../tools/virt-make-fs.pl:177
26537 #: ../tools/virt-win-reg.pl:197 ../tools/virt-resize.pl:501
26538 msgid "Enable debugging messages."
26542 #: ../tools/virt-win-reg.pl:232
26547 #: ../tools/virt-win-reg.pl:234
26549 "In merge mode, this merges a textual regedit file into the Windows Registry "
26550 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
26551 "displays or exports Registry entries instead."
26555 #: ../tools/virt-win-reg.pl:238
26557 "Note that C<--merge> is I<unsafe> to use on live virtual machines, and will "
26558 "result in disk corruption. However exporting (without this flag) is always "
26563 #: ../tools/virt-win-reg.pl:246
26564 msgid "B<--encoding> UTF-16LE|ASCII"
26568 #: ../tools/virt-win-reg.pl:248
26570 "When merging (only), you may need to specify the encoding for strings to be "
26571 "used in the hive file. This is explained in detail in "
26572 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
26576 #: ../tools/virt-win-reg.pl:252
26578 "The default is to use UTF-16LE, which should work with recent versions of "
26583 #: ../tools/virt-win-reg.pl:486
26585 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
26586 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
26587 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
26588 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26592 #: ../tools/virt-win-reg.pl:501 ../tools/virt-make-fs.pl:550
26594 "When reporting bugs, please enable debugging and capture the I<complete> "
26599 #: ../tools/virt-win-reg.pl:504
26602 " export LIBGUESTFS_DEBUG=1\n"
26603 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
26608 #: ../tools/virt-win-reg.pl:507
26610 "Attach /tmp/virt-win-reg.log to a new bug report at "
26611 "L<https://bugzilla.redhat.com/>"
26615 #: ../tools/virt-df.pl:36
26616 msgid "virt-df - Display free space on virtual filesystems"
26620 #: ../tools/virt-df.pl:40
26623 " virt-df [--options]\n"
26628 #: ../tools/virt-df.pl:42
26631 " virt-df [--options] domname\n"
26636 #: ../tools/virt-df.pl:44
26639 " virt-df [--options] disk.img [disk.img ...]\n"
26644 #: ../tools/virt-df.pl:48
26646 "C<virt-df> is a command line tool to display free space on virtual machine "
26647 "filesystems. Unlike other tools, it doesn't just display the amount of "
26648 "space allocated to a virtual machine, but can look inside the virtual "
26649 "machine to see how much space is really being used."
26653 #: ../tools/virt-df.pl:53
26655 "It is like the L<df(1)> command, but for virtual machines, except that it "
26656 "also works for Windows virtual machines."
26660 #: ../tools/virt-df.pl:56
26662 "If used without any arguments, C<virt-df> checks with libvirt to get a list "
26663 "of all active and inactive guests, and performs a C<df>-type operation on "
26664 "each one in turn, printing out the results."
26668 #: ../tools/virt-df.pl:60
26670 "If used with any argument(s), C<virt-df> performs a C<df>-type operation on "
26671 "either the single named libvirt domain, or on the disk image(s) listed on "
26672 "the command line (which must all belong to a single VM). In this mode (with "
26673 "arguments), C<virt-df> will I<only work for a single guest>. If you want to "
26674 "run on multiple guests, then you have to invoke C<virt-df> multiple times."
26678 #: ../tools/virt-df.pl:67
26680 "Use the C<--csv> option to get a format which can be easily parsed by other "
26681 "programs. Other options are mostly similar to standard C<df> options. See "
26682 "below for the complete list."
26686 #: ../tools/virt-df.pl:107
26691 #: ../tools/virt-df.pl:109
26693 "Write out the results in CSV format (comma-separated values). This format "
26694 "can be imported easily into databases and spreadsheets, but read L</NOTE "
26695 "ABOUT CSV FORMAT> below."
26699 #: ../tools/virt-df.pl:134
26700 msgid "B<--human-readable> | B<-h>"
26704 #: ../tools/virt-df.pl:136
26705 msgid "Print sizes in human-readable format."
26709 #: ../tools/virt-df.pl:138
26710 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
26714 #: ../tools/virt-df.pl:144
26715 msgid "B<--inodes> | B<-i>"
26719 #: ../tools/virt-df.pl:146
26720 msgid "Print inodes instead of blocks."
26724 #: ../tools/virt-df.pl:152
26725 msgid "B<--one-per-guest>"
26729 #: ../tools/virt-df.pl:154
26731 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
26732 "disks from several guests to a single libguestfs appliance."
26736 #: ../tools/virt-df.pl:157
26737 msgid "You might use this option in the following circumstances:"
26741 #: ../tools/virt-df.pl:163
26743 "If you think an untrusted guest might actively try to exploit the libguestfs "
26744 "appliance kernel, then this prevents one guest from interfering with the "
26745 "stats printed for another guest."
26749 #: ../tools/virt-df.pl:169
26751 "If the kernel has a bug which stops it from accessing a filesystem in one "
26752 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
26753 "and report stats for further guests."
26757 #: ../tools/virt-df.pl:180
26762 #: ../tools/virt-df.pl:182
26764 "Print UUIDs instead of names. This is useful for following a guest even "
26765 "when the guest is migrated or renamed, or when two guests happen to have the "
26770 #: ../tools/virt-df.pl:186
26772 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
26773 "images, we still print the disk image name even when this option is "
26778 #: ../tools/virt-df.pl:609
26779 msgid "NOTE ABOUT CSV FORMAT"
26783 #: ../tools/virt-df.pl:611
26785 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
26786 "should be easy to parse, but it is definitely not easy to parse."
26790 #: ../tools/virt-df.pl:614
26792 "Myth: Just split fields at commas. Reality: This does I<not> work "
26793 "reliably. This example has two columns:"
26797 #: ../tools/virt-df.pl:617
26800 " \"foo,bar\",baz\n"
26805 #: ../tools/virt-df.pl:619
26807 "Myth: Read the file one line at a time. Reality: This does I<not> work "
26808 "reliably. This example has one row:"
26812 #: ../tools/virt-df.pl:622
26821 #: ../tools/virt-df.pl:625
26823 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
26824 "packaged in major Linux distributions)."
26828 #: ../tools/virt-df.pl:628
26830 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
26831 "or Python's built-in csv library)."
26835 #: ../tools/virt-df.pl:631
26836 msgid "Most spreadsheets and databases can import CSV directly."
26840 #: ../tools/virt-df.pl:642
26842 "L<guestfs(3)>, L<guestfish(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
26843 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
26847 #: ../tools/virt-ls.pl:34
26848 msgid "virt-ls - List files in a virtual machine"
26852 #: ../tools/virt-ls.pl:38
26855 " virt-ls [--options] domname directory\n"
26860 #: ../tools/virt-ls.pl:40
26863 " virt-ls [--options] disk.img [disk.img ...] directory\n"
26868 #: ../tools/virt-ls.pl:44
26870 "C<virt-ls> is a command line tool to list the names of files in a directory "
26871 "inside a virtual machine or disk image."
26875 #: ../tools/virt-ls.pl:47
26877 "C<virt-ls> is just a simple wrapper around L<libguestfs(3)> functionality. "
26878 "For more complex cases you should look at the L<guestfish(1)> tool."
26882 #: ../tools/virt-ls.pl:51
26884 "C<virt-ls> can be used in one of three modes: simple, long and recursive. A "
26885 "simple listing is like the ordinary L<ls(1)> command:"
26889 #: ../tools/virt-ls.pl:54
26892 " $ virt-ls myguest /\n"
26900 #: ../tools/virt-ls.pl:59
26901 msgid "With the C<-l> (C<--long>) option, C<virt-ls> shows more detail:"
26905 #: ../tools/virt-ls.pl:61
26908 " $ virt-ls -l myguest /\n"
26910 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
26911 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
26917 #: ../tools/virt-ls.pl:67
26919 "With the C<-R> (C<--recursive>) option, C<virt-ls> lists the names of files "
26920 "and directories recursively:"
26924 #: ../tools/virt-ls.pl:70
26927 " $ virt-ls -R myguest /tmp\n"
26935 #: ../tools/virt-ls.pl:75
26937 "You I<cannot> combine these options. To do more complicated things, use "
26942 #: ../tools/virt-ls.pl:131 ../tools/virt-list-filesystems.pl:103 ../tools/virt-list-partitions.pl:112
26943 msgid "B<-l> | B<--long>"
26947 #: ../tools/virt-ls.pl:133
26948 msgid "B<-R> | B<--recursive>"
26952 #: ../tools/virt-ls.pl:135
26954 "Select the mode. With neither of these options, C<virt-ls> produces a "
26955 "simple, flat list of the files in the named directory."
26959 #: ../tools/virt-ls.pl:138
26961 "C<virt-ls -l> produces a \"long listing\", which shows more detail (just "
26962 "like the plain C<ls -l> command)."
26966 #: ../tools/virt-ls.pl:141
26968 "C<virt-ls -R> produces a recursive list of files starting at the named "
26969 "directory. See the documentation for L<guestfs(3)/guestfs_find> for precise "
26974 #: ../tools/virt-ls.pl:145
26975 msgid "You cannot combine these options."
26979 #: ../tools/virt-ls.pl:234
26981 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
26982 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
26983 "L<http://libguestfs.org/>."
26987 #: ../tools/virt-ls.pl:249 ../tools/virt-list-filesystems.pl:204 ../tools/virt-tar.pl:298
26988 msgid "Copyright (C) 2009 Red Hat Inc."
26992 #: ../tools/virt-resize.pl:42
26993 msgid "virt-resize - Resize a virtual machine disk"
26997 #: ../tools/virt-resize.pl:46
27000 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
27001 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
27002 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
27007 #: ../tools/virt-resize.pl:52
27009 "Virt-resize is a tool which can resize a virtual machine disk, making it "
27010 "larger or smaller overall, and resizing or deleting any partitions contained "
27015 #: ../tools/virt-resize.pl:56
27017 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
27018 "not> be used on live virtual machines - for consistent results, shut the "
27019 "virtual machine down before resizing it."
27023 #: ../tools/virt-resize.pl:60
27025 "If you are not familiar with the associated tools: "
27026 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)> and L<virt-df(1)>, "
27027 "we recommend you go and read those manual pages first."
27031 #: ../tools/virt-resize.pl:68
27033 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
27034 "fill the extra 5GB of space."
27038 #: ../tools/virt-resize.pl:71
27041 " truncate -r olddisk newdisk; truncate -s +5G newdisk\n"
27042 " virt-list-partitions -lht olddisk\n"
27043 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
27044 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
27049 #: ../tools/virt-resize.pl:76
27051 "As above, but make the /boot partition 200MB bigger, while giving the "
27052 "remaining space to /dev/sda2:"
27056 #: ../tools/virt-resize.pl:79
27059 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 olddisk newdisk\n"
27064 #: ../tools/virt-resize.pl:81
27065 msgid "As above, but the output format will be uncompressed qcow2:"
27069 #: ../tools/virt-resize.pl:83
27072 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
27073 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
27078 #: ../tools/virt-resize.pl:86
27079 msgid "DETAILED USAGE"
27083 #: ../tools/virt-resize.pl:88
27084 msgid "EXPANDING A VIRTUAL MACHINE DISK"
27088 #: ../tools/virt-resize.pl:92
27089 msgid "1. Shut down the virtual machine"
27093 #: ../tools/virt-resize.pl:94
27094 msgid "2. Locate input disk image"
27098 #: ../tools/virt-resize.pl:96
27100 "Locate the input disk image (ie. the file or device on the host containing "
27101 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
27102 "dumpxml> like this to find the disk image name:"
27106 #: ../tools/virt-resize.pl:100
27109 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
27110 " Found 1 nodes:\n"
27112 " <source dev=\"/dev/vg/lv_guest\" />\n"
27117 #: ../tools/virt-resize.pl:105
27118 msgid "3. Look at current sizing"
27122 #: ../tools/virt-resize.pl:107
27123 msgid "Use L<virt-list-partitions(1)> to display the current partitions and sizes:"
27127 #: ../tools/virt-resize.pl:110
27130 " # virt-list-partitions -lht /dev/vg/lv_guest\n"
27131 " /dev/sda1 ext3 101.9M\n"
27132 " /dev/sda2 pv 7.9G\n"
27133 " /dev/sda device 8.0G\n"
27138 #: ../tools/virt-resize.pl:115
27140 "(This example is a virtual machine with an 8 GB disk which we would like to "
27141 "expand up to 10 GB)."
27145 #: ../tools/virt-resize.pl:118
27146 msgid "4. Create output disk"
27150 #: ../tools/virt-resize.pl:120
27152 "Virt-resize cannot do in-place disk modifications. You have to have space "
27153 "to store the resized output disk."
27157 #: ../tools/virt-resize.pl:123
27158 msgid "To store the resized disk image in a file, create a file of a suitable size:"
27162 #: ../tools/virt-resize.pl:126
27165 " # rm -f outdisk\n"
27166 " # truncate -s 10G outdisk\n"
27171 #: ../tools/virt-resize.pl:129
27172 msgid "Or use L<lvcreate(1)> to create a logical volume:"
27176 #: ../tools/virt-resize.pl:131
27179 " # lvcreate -L 10G -n lv_name vg_name\n"
27184 #: ../tools/virt-resize.pl:133
27185 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
27189 #: ../tools/virt-resize.pl:135
27192 " # virsh pool-list\n"
27193 " # virsh vol-create-as poolname newvol 10G\n"
27198 #: ../tools/virt-resize.pl:138
27203 #: ../tools/virt-resize.pl:140
27205 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
27206 "file) and the output disk. The output disk is the one created in the "
27211 #: ../tools/virt-resize.pl:144
27214 " # virt-resize indisk outdisk\n"
27219 #: ../tools/virt-resize.pl:146
27221 "This command just copies disk image C<indisk> to disk image C<outdisk> "
27222 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
27223 "larger, then an extra, empty partition is created at the end of the disk "
27224 "covering the extra space. If C<outdisk> is smaller, then it will give an "
27229 #: ../tools/virt-resize.pl:152
27231 "More realistically you'd want to expand existing partitions in the disk "
27232 "image by passing extra options (for the full list see the L</OPTIONS> "
27237 #: ../tools/virt-resize.pl:156
27239 "L</--expand> is the most useful option. It expands the named partition "
27240 "within the disk to fill any extra space:"
27244 #: ../tools/virt-resize.pl:159
27247 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
27252 #: ../tools/virt-resize.pl:161
27254 "(In this case, an extra partition is I<not> created at the end of the disk, "
27255 "because there will be no unused space)."
27259 #: ../tools/virt-resize.pl:164
27261 "L</--resize> is the other commonly used option. The following would "
27262 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
27263 "rest of the available space:"
27267 #: ../tools/virt-resize.pl:168
27270 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
27271 " indisk outdisk\n"
27276 #: ../tools/virt-resize.pl:171
27278 "If the expanded partition in the image contains a filesystem or LVM PV, then "
27279 "if virt-resize knows how, it will resize the contents, the equivalent of "
27280 "calling a command such as L<pvresize(8)>, L<resize2fs(8)> or "
27281 "L<ntfsresize(8)>. However virt-resize does not know how to resize some "
27282 "filesystems, so you would have to online resize them after booting the "
27283 "guest. And virt-resize also does not resize anything inside an LVM PV, it "
27284 "just resizes the PV itself and leaves the user to resize any LVs inside that "
27289 #: ../tools/virt-resize.pl:180
27290 msgid "Other options are covered below."
27294 #: ../tools/virt-resize.pl:182
27299 #: ../tools/virt-resize.pl:184
27300 msgid "Thoroughly test the new disk image I<before> discarding the old one."
27304 #: ../tools/virt-resize.pl:186
27305 msgid "If you are using libvirt, edit the XML to point at the new disk:"
27309 #: ../tools/virt-resize.pl:188
27312 " # virsh edit guestname\n"
27317 #: ../tools/virt-resize.pl:190
27319 "Change E<lt>source ...E<gt>, see "
27320 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
27324 #: ../tools/virt-resize.pl:193
27325 msgid "Then start up the domain with the new, resized disk:"
27329 #: ../tools/virt-resize.pl:195
27332 " # virsh start guestname\n"
27337 #: ../tools/virt-resize.pl:197
27339 "and check that it still works. See also the L</NOTES> section below for "
27340 "additional information."
27344 #: ../tools/virt-resize.pl:200
27345 msgid "7. Resize LVs etc inside the guest"
27349 #: ../tools/virt-resize.pl:202
27350 msgid "(This can also be done offline using L<guestfish(1)>)"
27354 #: ../tools/virt-resize.pl:204
27356 "Once the guest has booted you should see the new space available, at least "
27357 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
27358 "may need to resize LVs inside PVs, and also resize filesystem types that "
27359 "virt-resize does not know how to expand."
27363 #: ../tools/virt-resize.pl:211
27364 msgid "SHRINKING A VIRTUAL MACHINE DISK"
27368 #: ../tools/virt-resize.pl:213
27370 "Shrinking is somewhat more complex than expanding, and only an overview is "
27375 #: ../tools/virt-resize.pl:216
27377 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
27378 "filesystems). The user has to shrink content before passing the disk image "
27379 "to virt-resize, and virt-resize will check that the content has been shrunk "
27384 #: ../tools/virt-resize.pl:221
27385 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
27389 #: ../tools/virt-resize.pl:223
27391 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
27392 "steps 3 and 4 above to allocate a new disk image."
27396 #: ../tools/virt-resize.pl:226
27397 msgid "Then run virt-resize with any of the C<--shrink> and/or C<--resize> options."
27401 #: ../tools/virt-resize.pl:229
27402 msgid "IGNORING OR DELETING PARTITIONS"
27406 #: ../tools/virt-resize.pl:231
27408 "virt-resize also gives a convenient way to ignore or delete partitions when "
27409 "copying from the input disk to the output disk. Ignoring a partition speeds "
27410 "up the copy where you don't care about the existing contents of a "
27411 "partition. Deleting a partition removes it completely, but note that it "
27412 "also renumbers any partitions after the one which is deleted, which can "
27413 "leave some guests unbootable."
27417 #: ../tools/virt-resize.pl:238
27418 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
27422 #: ../tools/virt-resize.pl:240
27424 "If the input disk is in qcow2 format, then you may prefer that the output is "
27425 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
27426 "the fly. The output format is simply determined by the format of the empty "
27427 "output container that you provide. Thus to create qcow2 output, use:"
27431 #: ../tools/virt-resize.pl:246
27434 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
27439 #: ../tools/virt-resize.pl:248
27440 msgid "instead of the truncate command (use C<-c> for a compressed disk)."
27444 #: ../tools/virt-resize.pl:250
27445 msgid "Similarly, to get non-sparse raw output use:"
27449 #: ../tools/virt-resize.pl:252
27452 " fallocate -l size outdisk\n"
27457 #: ../tools/virt-resize.pl:254
27459 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
27460 "if=/dev/zero of=outdisk bs=1M count=..>)"
27464 #: ../tools/virt-resize.pl:267
27465 msgid "Display help."
27469 #: ../tools/virt-resize.pl:281
27470 msgid "B<--resize part=size>"
27474 #: ../tools/virt-resize.pl:283
27476 "Resize the named partition (expanding or shrinking it) so that it has the "
27481 #: ../tools/virt-resize.pl:286
27483 "C<size> can be expressed as an absolute number followed by b/K/M/G/T/P/E to "
27484 "mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Petabytes or "
27485 "Exabytes; or as a percentage of the current size; or as a relative number or "
27486 "percentage. For example:"
27490 #: ../tools/virt-resize.pl:291
27493 " --resize /dev/sda2=10G\n"
27498 #: ../tools/virt-resize.pl:293
27501 " --resize /dev/sda4=90%\n"
27506 #: ../tools/virt-resize.pl:295
27509 " --resize /dev/sda2=+1G\n"
27514 #: ../tools/virt-resize.pl:297
27517 " --resize /dev/sda2=-200M\n"
27522 #: ../tools/virt-resize.pl:299
27525 " --resize /dev/sda1=+128K\n"
27530 #: ../tools/virt-resize.pl:301
27533 " --resize /dev/sda1=+10%\n"
27538 #: ../tools/virt-resize.pl:303
27541 " --resize /dev/sda1=-10%\n"
27546 #: ../tools/virt-resize.pl:305
27548 "You can increase the size of any partition. Virt-resize will expand the "
27549 "direct content of the partition if it knows how (see C<--expand> below)."
27553 #: ../tools/virt-resize.pl:309
27555 "You can only I<decrease> the size of partitions that contain filesystems or "
27556 "PVs which have already been shrunk. Virt-resize will check this has been "
27557 "done before proceeding, or else will print an error (see also "
27558 "C<--resize-force>)."
27562 #: ../tools/virt-resize.pl:314 ../tools/virt-resize.pl:406 ../tools/virt-resize.pl:423
27563 msgid "You can give this option multiple times."
27567 #: ../tools/virt-resize.pl:320
27568 msgid "B<--resize-force part=size>"
27572 #: ../tools/virt-resize.pl:322
27574 "This is the same as C<--resize> except that it will let you decrease the "
27575 "size of any partition. Generally this means you will lose any data which "
27576 "was at the end of the partition you shrink, but you may not care about that "
27577 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
27578 "as a swap partition)."
27582 #: ../tools/virt-resize.pl:328
27583 msgid "See also the C<--ignore> option."
27587 #: ../tools/virt-resize.pl:334
27588 msgid "B<--expand part>"
27592 #: ../tools/virt-resize.pl:336
27594 "Expand the named partition so it uses up all extra space (space left over "
27595 "after any other resize changes that you request have been done)."
27599 #: ../tools/virt-resize.pl:339
27601 "If virt-resize knows how, it will expand the direct content of the "
27602 "partition. For example, if the partition is an LVM PV, it will expand the "
27603 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
27604 "content it doesn't know about alone."
27608 #: ../tools/virt-resize.pl:344
27609 msgid "Currently virt-resize can resize:"
27613 #: ../tools/virt-resize.pl:350
27615 "ext2, ext3 and ext4 filesystems when they are contained directly inside a "
27620 #: ../tools/virt-resize.pl:355
27622 "NTFS filesystems contained directly in a partition, if libguestfs was "
27623 "compiled with support for NTFS."
27627 #: ../tools/virt-resize.pl:358
27629 "The filesystem must have been shut down consistently last time it was used. "
27630 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
27631 "consistency check, so at the first boot after resizing Windows will check "
27636 #: ../tools/virt-resize.pl:365
27638 "LVM PVs (physical volumes). However virt-resize does I<not> resize anything "
27639 "inside the PV. The user will have to resize LVs as desired."
27643 #: ../tools/virt-resize.pl:371 ../tools/virt-resize.pl:393
27644 msgid "Note that you cannot use C<--expand> and C<--shrink> together."
27648 #: ../tools/virt-resize.pl:377
27649 msgid "B<--shrink part>"
27653 #: ../tools/virt-resize.pl:379
27655 "Shrink the named partition until the overall disk image fits in the "
27656 "destination. The named partition B<must> contain a filesystem or PV which "
27657 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
27658 "online tools). Virt-resize will check this and give an error if it has not "
27663 #: ../tools/virt-resize.pl:385
27665 "The amount by which the overall disk must be shrunk (after carrying out all "
27666 "other operations requested by the user) is called the \"deficit\". For "
27667 "example, a straight copy (assume no other operations) from a 5GB disk image "
27668 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
27669 "would give an error unless the user specified a partition to shrink and that "
27670 "partition had more than a gigabyte of free space."
27674 #: ../tools/virt-resize.pl:399
27675 msgid "B<--ignore part>"
27679 #: ../tools/virt-resize.pl:401
27681 "Ignore the named partition. Effectively this means the partition is "
27682 "allocated on the destination disk, but the content is not copied across from "
27683 "the source disk. The content of the partition will be blank (all zero "
27688 #: ../tools/virt-resize.pl:412
27689 msgid "B<--delete part>"
27693 #: ../tools/virt-resize.pl:414
27695 "Delete the named partition. It would be more accurate to describe this as "
27696 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
27697 "the original disk image is left intact."
27701 #: ../tools/virt-resize.pl:418
27703 "Note that when you delete a partition, then anything contained in the "
27704 "partition is also deleted. Furthermore, this causes any partitions that "
27705 "come after to be I<renumbered>, which can easily make your guest unbootable."
27709 #: ../tools/virt-resize.pl:429
27710 msgid "B<--LV-expand logvol>"
27714 #: ../tools/virt-resize.pl:431
27716 "This takes the logical volume and, as a final step, expands it to fill all "
27717 "the space available in its volume group. A typical usage, assuming a Linux "
27718 "guest with a single PV C</dev/sda2> and a root device called "
27719 "C</dev/vg_guest/lv_root> would be:"
27723 #: ../tools/virt-resize.pl:436
27726 " virt-resize indisk outdisk \\\n"
27727 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
27732 #: ../tools/virt-resize.pl:439
27734 "This would first expand the partition (and PV), and then expand the root "
27735 "device to fill the extra space in the PV."
27739 #: ../tools/virt-resize.pl:442
27741 "The contents of the LV are also resized if virt-resize knows how to do "
27742 "that. You can stop virt-resize from trying to expand the content by using "
27743 "the option C<--no-expand-content>."
27747 #: ../tools/virt-resize.pl:446
27748 msgid "Use L<virt-list-filesystems(1)> to list the filesystems in the guest."
27752 #: ../tools/virt-resize.pl:449
27754 "You can give this option multiple times, I<but> it doesn't make sense to do "
27755 "this unless the logical volumes you specify are all in different volume "
27760 #: ../tools/virt-resize.pl:457
27761 msgid "B<--no-copy-boot-loader>"
27765 #: ../tools/virt-resize.pl:459
27767 "By default, virt-resize copies over some sectors at the start of the disk "
27768 "(up to the beginning of the first partition). Commonly these sectors "
27769 "contain the Master Boot Record (MBR) and the boot loader, and are required "
27770 "in order for the guest to boot correctly."
27774 #: ../tools/virt-resize.pl:464
27776 "If you specify this flag, then this initial copy is not done. You may need "
27777 "to reinstall the boot loader in this case."
27781 #: ../tools/virt-resize.pl:472
27782 msgid "B<--no-extra-partition>"
27786 #: ../tools/virt-resize.pl:474
27788 "By default, virt-resize creates an extra partition if there is any extra, "
27789 "unused space after all resizing has happened. Use this option to prevent "
27790 "the extra partition from being created. If you do this then the extra space "
27791 "will be inaccessible until you run fdisk, parted, or some other partitioning "
27792 "tool in the guest."
27796 #: ../tools/virt-resize.pl:480
27798 "Note that if the surplus space is smaller than 10 MB, no extra partition "
27803 #: ../tools/virt-resize.pl:487
27804 msgid "B<--no-expand-content>"
27808 #: ../tools/virt-resize.pl:489
27810 "By default, virt-resize will try to expand the direct contents of "
27811 "partitions, if it knows how (see C<--expand> option above)."
27815 #: ../tools/virt-resize.pl:492
27817 "If you give the C<--no-expand-content> option then virt-resize will not "
27822 #: ../tools/virt-resize.pl:499
27823 msgid "B<-d> | B<--debug>"
27827 #: ../tools/virt-resize.pl:507
27828 msgid "B<-n> | B<--dryrun>"
27832 #: ../tools/virt-resize.pl:509
27833 msgid "Print a summary of what would be done, but don't do anything."
27837 #: ../tools/virt-resize.pl:515
27838 msgid "B<-q> | B<--quiet>"
27842 #: ../tools/virt-resize.pl:517
27843 msgid "Don't print the summary."
27847 #: ../tools/virt-resize.pl:525
27849 "Specify the format of the input disk image. If this flag is not given then "
27850 "it is auto-detected from the image itself."
27854 #: ../tools/virt-resize.pl:531
27856 "Note that this option I<does not> affect the output format. See L</QCOW2 "
27857 "AND NON-SPARSE RAW FORMATS>."
27861 #: ../tools/virt-resize.pl:538
27862 msgid "B<--output-format> raw"
27866 #: ../tools/virt-resize.pl:540
27868 "Specify the format of the output disk image. If this flag is not given then "
27869 "it is auto-detected from the image itself."
27873 #: ../tools/virt-resize.pl:546
27875 "Note that you still need to create the output disk with the right format. "
27876 "See L</QCOW2 AND NON-SPARSE RAW FORMATS>."
27880 #: ../tools/virt-resize.pl:1422 ../tools/virt-rescue.pl:90
27885 #: ../tools/virt-resize.pl:1424
27886 msgid "\"Partition 1 does not end on cylinder boundary.\""
27890 #: ../tools/virt-resize.pl:1426
27892 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
27893 "means the partitions will not be aligned to the ancient CHS geometry. "
27894 "However CHS geometry is meaningless for disks manufactured since the early "
27895 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
27896 "cylinders is not required by any modern operating system."
27900 #: ../tools/virt-resize.pl:1433
27901 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
27905 #: ../tools/virt-resize.pl:1435
27907 "In Windows Vista and later versions, Microsoft switched to using a separate "
27908 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
27909 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
27910 "the boot partition. Doing so seems to break the guest completely. However "
27911 "expanding the second partition (ie. C: drive) should work."
27915 #: ../tools/virt-resize.pl:1442
27917 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
27918 "NTFS partitions have been expanded. This is just a safety check and (unless "
27919 "it find errors) is nothing to worry about."
27923 #: ../tools/virt-resize.pl:1446
27924 msgid "GUEST BOOT STUCK AT \"GRUB\""
27928 #: ../tools/virt-resize.pl:1448
27930 "If a Linux guest does not boot after resizing, and the boot is stuck after "
27931 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
27932 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
27933 "although we think is to do with partition alignment."
27937 #: ../tools/virt-resize.pl:1453
27940 " guestfish -i -a newdisk\n"
27941 " ><fs> cat /boot/grub/device.map\n"
27942 " # check the contents of this file are sensible or\n"
27943 " # edit the file if necessary\n"
27944 " ><fs> grub-install / /dev/vda\n"
27950 #: ../tools/virt-resize.pl:1460
27952 "For more flexible guest reconfiguration, including if you need to specify "
27953 "other parameters to grub-install, use L<virt-rescue(1)>."
27957 #: ../tools/virt-resize.pl:1463
27958 msgid "ALTERNATIVE TOOLS"
27962 #: ../tools/virt-resize.pl:1465
27964 "There are several proprietary tools for resizing partitions. We won't "
27965 "mention any here."
27969 #: ../tools/virt-resize.pl:1468
27971 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
27972 "operations on disk images. They can resize and move partitions, but I don't "
27973 "think they can do anything with the contents, and they certainly don't "
27978 #: ../tools/virt-resize.pl:1473
27980 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
27981 "but at a much lower level. You will probably end up hand-calculating sector "
27982 "offsets, which is something that virt-resize was designed to avoid. If you "
27983 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
27988 #: ../tools/virt-resize.pl:1488
27990 "L<virt-list-partitions(1)>, L<virt-list-filesystems(1)>, L<virt-df(1)>, "
27991 "L<guestfs(3)>, L<guestfish(1)>, L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, "
27992 "L<resize2fs(8)>, L<ntfsresize(8)>, L<virsh(1)>, L<parted(8)>, "
27993 "L<truncate(1)>, L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, "
27994 "L<virt-rescue(1)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
27998 #: ../tools/virt-list-filesystems.pl:32
27999 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
28003 #: ../tools/virt-list-filesystems.pl:36
28006 " virt-list-filesystems [--options] domname\n"
28011 #: ../tools/virt-list-filesystems.pl:38
28014 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
28019 #: ../tools/virt-list-filesystems.pl:42
28021 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
28022 "are contained in a virtual machine or disk image."
28026 #: ../tools/virt-list-filesystems.pl:46
28028 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
28029 "functionality. For more complex cases you should look at the "
28030 "L<guestfish(1)> tool."
28034 #: ../tools/virt-list-filesystems.pl:105
28036 "With this option, C<virt-list-filesystems> displays the type of each "
28037 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
28041 #: ../tools/virt-list-filesystems.pl:112
28042 msgid "B<-a> | B<--all>"
28046 #: ../tools/virt-list-filesystems.pl:114
28048 "Normally we only show mountable filesystems. If this option is given then "
28049 "swap devices are shown too."
28053 #: ../tools/virt-list-filesystems.pl:188
28055 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
28056 "L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28057 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28061 #: ../tools/virt-tar.pl:33
28062 msgid "virt-tar - Extract or upload files to a virtual machine"
28066 #: ../tools/virt-tar.pl:37
28069 " virt-tar [--options] -x domname directory tarball\n"
28074 #: ../tools/virt-tar.pl:39
28077 " virt-tar [--options] -u domname tarball directory\n"
28082 #: ../tools/virt-tar.pl:41
28085 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
28090 #: ../tools/virt-tar.pl:43
28093 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
28098 #: ../tools/virt-tar.pl:47
28099 msgid "Download C</home> from the VM into a local tarball:"
28103 #: ../tools/virt-tar.pl:49
28106 " virt-tar -x domname /home home.tar\n"
28111 #: ../tools/virt-tar.pl:51
28114 " virt-tar -zx domname /home home.tar.gz\n"
28119 #: ../tools/virt-tar.pl:53
28120 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
28124 #: ../tools/virt-tar.pl:55
28127 " virt-tar -u domname uploadstuff.tar /tmp\n"
28132 #: ../tools/virt-tar.pl:57
28135 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
28140 #: ../tools/virt-tar.pl:61
28142 "You must I<not> use C<virt-tar> with the C<-u> option (upload) on live "
28143 "virtual machines. If you do this, you risk disk corruption in the VM. "
28144 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
28148 #: ../tools/virt-tar.pl:66
28150 "You can use C<-x> (extract) on live virtual machines, but you might get "
28151 "inconsistent results or errors if there is filesystem activity inside the "
28152 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
28153 "work, but the only way to guarantee consistent results is if the virtual "
28154 "machine is shut down."
28158 #: ../tools/virt-tar.pl:74
28160 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
28161 "parts of a guest filesystem. There are many possibilities: making backups, "
28162 "uploading data files, snooping on guest activity, fixing or customizing "
28167 #: ../tools/virt-tar.pl:79
28169 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
28170 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
28171 "should look at the L<guestfish(1)> tool."
28175 #: ../tools/virt-tar.pl:83
28177 "There are two modes of operation: C<-x> (eXtract) downloads a directory and "
28178 "its contents (recursively) from the virtual machine into a local tarball. "
28179 "C<-u> uploads from a local tarball, unpacking it into a directory inside the "
28180 "virtual machine. You cannot use these two options together."
28184 #: ../tools/virt-tar.pl:89
28186 "In addition, you may need to use the C<-z> (gZip) option to enable "
28187 "compression. When uploading, you have to specify C<-z> if the upload file "
28188 "is compressed because virt-tar won't detect this on its own."
28192 #: ../tools/virt-tar.pl:93
28194 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
28195 "example it cannot do PKZip files or bzip2 compression. If you want that "
28196 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
28197 "the L<libguestfs(3)> API)."
28201 #: ../tools/virt-tar.pl:151
28202 msgid "B<-x> | B<--extract> | B<--download>"
28206 #: ../tools/virt-tar.pl:153
28207 msgid "B<-u> | B<--upload>"
28211 #: ../tools/virt-tar.pl:155
28213 "Use C<-x> to extract (download) a directory from a virtual machine to a "
28218 #: ../tools/virt-tar.pl:158
28220 "Use C<-u> to upload and unpack from a local tarball into a virtual machine. "
28221 "Please read the L</WARNING> section above before using this option."
28225 #: ../tools/virt-tar.pl:162
28226 msgid "You must specify exactly one of these options."
28230 #: ../tools/virt-tar.pl:168
28231 msgid "B<-z> | B<--gzip>"
28235 #: ../tools/virt-tar.pl:170
28236 msgid "Specify that the input or output tarball is gzip-compressed."
28240 #: ../tools/virt-tar.pl:283
28242 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
28243 "L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
28244 "L<http://libguestfs.org/>."
28248 #: ../tools/virt-rescue.pl:33
28249 msgid "virt-rescue - Run a rescue shell on a virtual machine"
28253 #: ../tools/virt-rescue.pl:37
28256 " virt-rescue [--options] domname\n"
28261 #: ../tools/virt-rescue.pl:39
28264 " virt-rescue [--options] disk.img [disk.img ...]\n"
28269 #: ../tools/virt-rescue.pl:43
28271 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
28272 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
28273 "you from doing this, but doesn't catch all cases."
28277 #: ../tools/virt-rescue.pl:47
28279 "However if you use the I<--ro> (read only) option, then you can attach a "
28280 "shell to a live virtual machine. The results might be strange or "
28281 "inconsistent at times but you won't get disk corruption."
28285 #: ../tools/virt-rescue.pl:53
28287 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
28288 "need for a CD. virt-rescue gives you a rescue shell and some simple "
28289 "recovery tools which you can use to examine or rescue a virtual machine or "
28294 #: ../tools/virt-rescue.pl:58
28296 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
28297 "on disk image(s):"
28301 #: ../tools/virt-rescue.pl:61
28304 " virt-rescue GuestName\n"
28309 #: ../tools/virt-rescue.pl:63
28312 " virt-rescue --ro /path/to/disk.img\n"
28317 #: ../tools/virt-rescue.pl:65
28320 " virt-rescue /dev/sdc\n"
28325 #: ../tools/virt-rescue.pl:67
28326 msgid "For live VMs you I<must> use the --ro option."
28330 #: ../tools/virt-rescue.pl:69
28332 "When you run virt-rescue on a virtual machine or disk image, you are placed "
28333 "in an interactive bash shell where you can use many ordinary Linux "
28334 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
28335 "appliance. You must mount the virtual machine's filesystems by hand. There "
28336 "is an empty directory called C</sysroot> where you can mount filesystems."
28340 #: ../tools/virt-rescue.pl:76
28342 "In the example below, we list logical volumes, then choose one to mount "
28343 "under C</sysroot>:"
28347 #: ../tools/virt-rescue.pl:79
28351 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
28352 " lv_root vg_f11x64 -wi-a- 8.83G\n"
28353 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
28354 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
28355 " ><rescue> ls /sysroot\n"
28360 #: ../tools/virt-rescue.pl:86
28362 "If you don't know what filesystems are available on the virtual machine then "
28363 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
28367 #: ../tools/virt-rescue.pl:92
28369 "Virt-rescue can be used on I<any> disk image file or device, not just a "
28370 "virtual machine. For example you can use it on a blank file if you want to "
28371 "partition that file (although we would recommend using L<guestfish(1)> "
28372 "instead as it is more suitable for this purpose). You can even use "
28373 "virt-rescue on things like SD cards."
28377 #: ../tools/virt-rescue.pl:98
28379 "This tool is just designed for quick interactive hacking on a virtual "
28380 "machine. For more structured access to a virtual machine disk image, you "
28381 "should use L<guestfs(3)>. To get a structured shell that you can use to "
28382 "make scripted changes to guests, use L<guestfish(1)>."
28386 #: ../tools/virt-rescue.pl:127
28387 msgid "B<--append kernelopts>"
28391 #: ../tools/virt-rescue.pl:129
28392 msgid "Pass additional options to the rescue kernel."
28396 #: ../tools/virt-rescue.pl:164
28397 msgid "B<--memsize MB> | B<-m MB>"
28401 #: ../tools/virt-rescue.pl:166
28403 "Change the amount of memory allocated to the rescue system. The default is "
28404 "set by libguestfs and is small but adequate for running system tools. The "
28405 "occasional program might need more memory. The parameter is specified in "
28410 #: ../tools/virt-rescue.pl:175
28411 msgid "B<--network MB>"
28415 #: ../tools/virt-rescue.pl:177
28416 msgid "Enable QEMU user networking in the guest."
28420 #: ../tools/virt-rescue.pl:183
28421 msgid "B<--ro> | B<-r>"
28425 #: ../tools/virt-rescue.pl:185
28426 msgid "Open the image read-only."
28430 #: ../tools/virt-rescue.pl:197
28432 "Enable SELinux in the rescue appliance. You should read "
28433 "L<guestfs(3)/SELINUX> before using this option."
28437 #: ../tools/virt-rescue.pl:257
28439 "Several environment variables affect virt-rescue. See "
28440 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
28444 #: ../tools/virt-rescue.pl:269
28446 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
28447 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
28451 #: ../tools/virt-make-fs.pl:37
28452 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
28456 #: ../tools/virt-make-fs.pl:41
28459 " virt-make-fs [--options] input.tar output.img\n"
28464 #: ../tools/virt-make-fs.pl:43
28467 " virt-make-fs [--options] input.tar.gz output.img\n"
28472 #: ../tools/virt-make-fs.pl:45
28475 " virt-make-fs [--options] directory output.img\n"
28480 #: ../tools/virt-make-fs.pl:49
28482 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
28483 "archive or some files in a directory. It is similar to tools like "
28484 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
28485 "it can create common filesystem types like ext2/3 or NTFS, which can be "
28486 "useful if you want to attach these filesystems to existing virtual machines "
28487 "(eg. to import large amounts of read-only data to a VM)."
28491 #: ../tools/virt-make-fs.pl:57
28492 msgid "Basic usage is:"
28496 #: ../tools/virt-make-fs.pl:59
28499 " virt-make-fs input output\n"
28504 #: ../tools/virt-make-fs.pl:61
28506 "where C<input> is either a directory containing files that you want to add, "
28507 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
28508 "C<output> is a disk image. The input type is detected automatically. The "
28509 "output disk image defaults to a raw ext2 image unless you specify extra "
28510 "flags (see L</OPTIONS> below)."
28514 #: ../tools/virt-make-fs.pl:67
28515 msgid "EXTRA SPACE"
28519 #: ../tools/virt-make-fs.pl:69
28521 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
28522 "the files that it contains, but might have extra space. Depending on how "
28523 "you are going to use the output, you might think this extra space is wasted "
28524 "and want to minimize it, or you might want to leave space so that more files "
28525 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
28526 "but you can use the C<--size> flag to leave space in the filesystem if you "
28531 #: ../tools/virt-make-fs.pl:77
28533 "An alternative way to leave extra space but not make the output image any "
28534 "bigger is to use an alternative disk image format (instead of the default "
28535 "\"raw\" format). Using C<--format=qcow2> will use the native QEmu/KVM qcow2 "
28536 "image format (check your hypervisor supports this before using it). This "
28537 "allows you to choose a large C<--size> but the extra space won't actually be "
28538 "allocated in the image until you try to store something in it."
28542 #: ../tools/virt-make-fs.pl:85
28544 "Don't forget that you can also use local commands including L<resize2fs(8)> "
28545 "and L<virt-resize(1)> to resize existing filesystems, or rerun "
28546 "virt-make-resize to build another image from scratch."
28550 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
28555 #: ../tools/virt-make-fs.pl:91
28558 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
28563 #: ../tools/virt-make-fs.pl:93
28564 msgid "FILESYSTEM TYPE"
28568 #: ../tools/virt-make-fs.pl:95
28570 "The default filesystem type is C<ext2>. Just about any filesystem type that "
28571 "libguestfs supports can be used (but I<not> read-only formats like "
28572 "ISO9660). Here are some of the more common choices:"
28576 #: ../tools/virt-make-fs.pl:101
28581 #: ../tools/virt-make-fs.pl:103
28583 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
28584 "you are not going to use the filesystem in a way that requires the journal, "
28585 "then this is just wasted overhead."
28589 #: ../tools/virt-make-fs.pl:107
28590 msgid "I<ntfs> or I<vfat>"
28594 #: ../tools/virt-make-fs.pl:109
28595 msgid "Useful if exporting data to a Windows guest."
28599 #: ../tools/virt-make-fs.pl:111
28601 "I<Note for vfat>: The tar archive or local directory must only contain files "
28602 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
28603 "program running within libguestfs is unable to change the ownership of "
28604 "non-root files, since vfat itself does not support this."
28608 #: ../tools/virt-make-fs.pl:116
28613 #: ../tools/virt-make-fs.pl:118
28615 "Lower overhead than C<ext2>, but certain limitations on filename length and "
28616 "total filesystem size."
28620 #: ../tools/virt-make-fs.pl:125
28623 " virt-make-fs --type=minix input minixfs.img\n"
28628 #: ../tools/virt-make-fs.pl:127
28629 msgid "TO PARTITION OR NOT TO PARTITION"
28633 #: ../tools/virt-make-fs.pl:129
28634 msgid "Optionally virt-make-fs can add a partition table to the output disk."
28638 #: ../tools/virt-make-fs.pl:131
28640 "Adding a partition can make the disk image more compatible with certain "
28641 "virtualized operating systems which don't expect to see a filesystem "
28642 "directly located on a block device (Linux doesn't care and will happily "
28643 "handle both types)."
28647 #: ../tools/virt-make-fs.pl:136
28649 "On the other hand, if you have a partition table then the output image is no "
28650 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
28651 "directly on a partitioned disk image. (However libguestfs tools such as "
28652 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
28656 #: ../tools/virt-make-fs.pl:144
28657 msgid "Add an MBR partition:"
28661 #: ../tools/virt-make-fs.pl:146
28664 " virt-make-fs --partition -- input disk.img\n"
28669 #: ../tools/virt-make-fs.pl:148
28671 "If the output disk image could be terabyte-sized or larger, it's better to "
28672 "use an EFI/GPT-compatible partition table:"
28676 #: ../tools/virt-make-fs.pl:151
28679 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
28684 #: ../tools/virt-make-fs.pl:179
28685 msgid "Enable debugging information."
28689 #: ../tools/virt-make-fs.pl:185
28690 msgid "B<--size=E<lt>NE<gt>>"
28694 #: ../tools/virt-make-fs.pl:187
28695 msgid "B<--size=+E<lt>NE<gt>>"
28699 #: ../tools/virt-make-fs.pl:189
28700 msgid "B<-s E<lt>NE<gt>>"
28704 #: ../tools/virt-make-fs.pl:191
28705 msgid "B<-s +E<lt>NE<gt>>"
28709 #: ../tools/virt-make-fs.pl:193
28710 msgid "Use the C<--size> (or C<-s>) option to choose the size of the output image."
28714 #: ../tools/virt-make-fs.pl:196
28716 "If this option is I<not> given, then the output image will be just large "
28717 "enough to contain all the files, with not much wasted space."
28721 #: ../tools/virt-make-fs.pl:199
28723 "To choose a fixed size output disk, specify an absolute number followed by "
28724 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28725 "Petabytes or Exabytes. This must be large enough to contain all the input "
28726 "files, else you will get an error."
28730 #: ../tools/virt-make-fs.pl:204
28732 "To leave extra space, specify C<+> (plus sign) and a number followed by "
28733 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
28734 "Petabytes or Exabytes. For example: C<--size=+200M> means enough space for "
28735 "the input files, and (approximately) an extra 200 MB free space."
28739 #: ../tools/virt-make-fs.pl:210
28741 "Note that virt-make-fs estimates free space, and therefore will not produce "
28742 "filesystems containing precisely the free space requested. (It is much more "
28743 "expensive and time-consuming to produce a filesystem which has precisely the "
28744 "desired free space)."
28748 #: ../tools/virt-make-fs.pl:219
28749 msgid "B<--format=E<lt>fmtE<gt>>"
28753 #: ../tools/virt-make-fs.pl:221
28754 msgid "B<-F E<lt>fmtE<gt>>"
28758 #: ../tools/virt-make-fs.pl:223
28759 msgid "Choose the output disk image format."
28763 #: ../tools/virt-make-fs.pl:225
28764 msgid "The default is C<raw> (raw disk image)."
28768 #: ../tools/virt-make-fs.pl:227
28770 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
28771 "that would really make sense here is C<qcow2>."
28775 #: ../tools/virt-make-fs.pl:234
28776 msgid "B<--type=E<lt>fsE<gt>>"
28780 #: ../tools/virt-make-fs.pl:236
28781 msgid "B<-t E<lt>fsE<gt>>"
28785 #: ../tools/virt-make-fs.pl:238
28786 msgid "Choose the output filesystem type."
28790 #: ../tools/virt-make-fs.pl:240
28791 msgid "The default is C<ext2>."
28795 #: ../tools/virt-make-fs.pl:242
28796 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
28800 #: ../tools/virt-make-fs.pl:249
28801 msgid "B<--partition>"
28805 #: ../tools/virt-make-fs.pl:251
28806 msgid "B<--partition=E<lt>parttypeE<gt>>"
28810 #: ../tools/virt-make-fs.pl:253
28812 "If specified, this flag adds an MBR partition table to the output disk "
28817 #: ../tools/virt-make-fs.pl:256
28819 "You can change the partition table type, eg. C<--partition=gpt> for large "
28824 #: ../tools/virt-make-fs.pl:259
28826 "Note that if you just use a lonesome C<--partition>, the Perl option parser "
28827 "might consider the next parameter to be the partition type. For example:"
28831 #: ../tools/virt-make-fs.pl:263
28834 " virt-make-fs --partition input.tar ...\n"
28839 #: ../tools/virt-make-fs.pl:265
28841 "would cause virt-make-fs to think you wanted to use a partition type of "
28842 "C<input.tar> which is completely wrong. To avoid this, use C<--> (a double "
28843 "dash) between options and the input file argument:"
28847 #: ../tools/virt-make-fs.pl:269
28850 " virt-make-fs --partition -- input.tar ...\n"
28855 #: ../tools/virt-make-fs.pl:536
28857 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<mkisofs(1)>, "
28858 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
28859 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
28863 #: ../tools/virt-make-fs.pl:553
28866 " export LIBGUESTFS_DEBUG=1\n"
28867 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
28872 #: ../tools/virt-make-fs.pl:556
28874 "Attach /tmp/virt-make-fs.log to a new bug report at "
28875 "L<https://bugzilla.redhat.com/>"
28879 #: ../tools/virt-list-partitions.pl:32
28880 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
28884 #: ../tools/virt-list-partitions.pl:36
28887 " virt-list-partitions [--options] domname\n"
28892 #: ../tools/virt-list-partitions.pl:38
28895 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
28900 #: ../tools/virt-list-partitions.pl:42
28902 "C<virt-list-partitions> is a command line tool to list the partitions that "
28903 "are contained in a virtual machine or disk image. It is mainly useful as a "
28904 "first step to using L<virt-resize(1)>."
28908 #: ../tools/virt-list-partitions.pl:47
28910 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
28911 "functionality. For more complex cases you should look at the "
28912 "L<guestfish(1)> tool."
28916 #: ../tools/virt-list-partitions.pl:104
28917 msgid "B<-h> | B<--human-readable>"
28921 #: ../tools/virt-list-partitions.pl:106
28922 msgid "Show sizes in human-readable form (eg. \"1G\")."
28926 #: ../tools/virt-list-partitions.pl:114
28928 "With this option, C<virt-list-partitions> displays the type and size of each "
28929 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
28933 #: ../tools/virt-list-partitions.pl:121
28934 msgid "B<-t> | B<--total>"
28938 #: ../tools/virt-list-partitions.pl:123
28939 msgid "Display the total size of each block device (as a separate row or rows)."
28943 #: ../tools/virt-list-partitions.pl:256
28945 "L<guestfs(3)>, L<guestfish(1)>, L<virt-list-filesystems(1)>, "
28946 "L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
28947 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."